xref: /freebsd/share/man/man9/BUS_ADD_CHILD.9 (revision 243e928310d073338c5ec089f0dce238a80b9866)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2004 M. Warner Losh.
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd October 28, 2015
32.Dt BUS_ADD_CHILD 9
33.Os
34.Sh NAME
35.Nm BUS_ADD_CHILD
36.Nd "add a device node to the tree with a given priority"
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/bus.h
40.Ft int
41.Fn BUS_ADD_CHILD "device_t dev" "int order" "const char *name" "int unit"
42.Sh DESCRIPTION
43The
44.Fn BUS_ADD_CHILD
45method
46is used by the driver identify routine to add devices to the tree.
47It can also be used to add children to buses that implement this
48routine in other contexts, although the behavior is bus specific.
49Please see
50.Xr device_add_child 9
51for more details.
52The interface is the same as
53.Xr device_add_child 9
54however, the bus'
55.Fn BUS_ADD_CHILD
56is called.
57.Pp
58Buses implementing
59.Fn BUS_ADD_CHILD
60should insert the device into the tree using
61.Xr device_add_child 9
62before adding things such as their own ivars and resource lists to the device.
63.Fn BUS_ADD_CHILD
64is not called by
65.Xr device_add_child 9 .
66.Fn BUS_ADD_CHILD
67instead calls
68.Xr device_add_child 9 .
69.Pp
70A panic will result when called for a bus that does not implement
71.Fn BUS_ADD_CHILD .
72Some buses require a special bus-specific routine to be called instead
73of
74.Fn BUS_ADD_CHILD .
75.Sh RETURN VALUES
76The
77.Fn BUS_ADD_CHILD
78method returns
79.Vt device_t
80added to the tree, or
81.Dv NULL
82to indicate failure.
83.Sh SEE ALSO
84.Xr device 9 ,
85.Xr device_add_child 9 ,
86.Xr driver 9
87.Sh AUTHORS
88This manual page was written by
89.An M. Warner Losh .
90