/share/man/man9/BUS_ADD_CHILD.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 74 lines · 74 code · 0 blank · 0 comment · 0 complexity · 0840886fdb8fe3b453184ef686196afd MD5 · raw file 

    

  1. .\" -*- nroff -*-
    2. 

  2. .\"
    3. 

  3. .\" Copyright (c) 2004 M. Warner Losh.
    4. 

  4. .\"
    5. 

  5. .\" All rights reserved.
    6. 

  6. .\"
    7. 

  7. .\" This program is free software.
    8. 

  8. .\"
    9. 

  9. .\" Redistribution and use in source and binary forms, with or without
    10. 

  10. .\" modification, are permitted provided that the following conditions
    11. 

  11. .\" are met:
    12. 

  12. .\" 1. Redistributions of source code must retain the above copyright
    13. 

  13. .\"    notice, this list of conditions and the following disclaimer.
    14. 

  14. .\" 2. Redistributions in binary form must reproduce the above copyright
    15. 

  15. .\"    notice, this list of conditions and the following disclaimer in the
    16. 

  16. .\"    documentation and/or other materials provided with the distribution.
    17. 

  17. .\"
    18. 

  18. .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
    19. 

  19. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    20. 

  20. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    21. 

  21. .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
    22. 

  22. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    23. 

  23. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    24. 

  24. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    25. 

  25. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    26. 

  26. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    27. 

  27. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    28. 

  28. .\"
    29. 

  29. .\" $FreeBSD$
    30. 

  30. .\"
    31. 

  31. .Dd May 13, 2004
    32. 

  32. .Dt BUS_ADD_CHILD 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm BUS_ADD_CHILD
    36. 

  36. .Nd "add a device node to the tree with a given priority"
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/bus.h
    40. 

  40. .Ft int
    41. 

  41. .Fn BUS_ADD_CHILD "device_t dev" "int order" "const char *name" "int unit"
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. The
    44. 

  44. .Fn BUS_ADD_CHILD
    45. 

  45. method
    46. 

  46. is used by the driver identify routine to add devices to the tree.
    47. 

  47. Please see
    48. 

  48. .Xr device_add_child 9
    49. 

  49. for more details.
    50. 

  50. The interface is the same as
    51. 

  51. .Xr device_add_child 9
    52. 

  52. however, the bus'
    53. 

  53. .Fn BUS_ADD_CHILD
    54. 

  54. is called.
    55. 

  55. .Pp
    56. 

  56. Busses implementing
    57. 

  57. .Fn BUS_ADD_CHILD
    58. 

  58. should insert the device into the tree using
    59. 

  59. .Xr device_add_child 9
    60. 

  60. before adding things such as their own ivars and resource lists to the device.
    61. 

  61. .Sh RETURN VALUES
    62. 

  62. The
    63. 

  63. .Fn BUS_ADD_CHILD
    64. 

  64. method returns
    65. 

  65. .Vt device_t
    66. 

  66. added to the tree, or
    67. 

  67. .Dv NULL .
    68. 

  68. .Sh SEE ALSO
    69. 

  69. .Xr device 9 ,
    70. 

  70. .Xr device_add_child 9 ,
    71. 

  71. .Xr driver 9
    72. 

  72. .Sh AUTHORS
    73. 

  73. This manual page was written by
    74. 

  74. .An M. Warner Losh .
    75.