xref: /dragonfly/share/man/man9/BUS_ADD_CHILD.9 (revision 92fc8b5c)
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: src/share/man/man9/BUS_ADD_CHILD.9,v 1.4 2005/01/21 08:36:40 ru Exp $
30.\"
31.Dd December 20, 2009
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 parent" "device_t child" "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.
47Please see
48.Xr device_add_child 9
49for more details.
50The interface is similar to
51.Xr device_add_child 9
52however, the bus'
53.Fn BUS_ADD_CHILD
54is called.
55.Pp
56Busses implementing
57.Fn BUS_ADD_CHILD
58should insert the device into the tree using
59.Xr device_add_child 9
60before adding things such as their own ivars and resource lists to the device.
61.Sh RETURN VALUES
62The
63.Fn BUS_ADD_CHILD
64method returns
65.Vt device_t
66added to the tree, or
67.Dv NULL .
68.Sh SEE ALSO
69.Xr device 9 ,
70.Xr device_add_child 9 ,
71.Xr driver 9
72.Sh AUTHORS
73This manual page was written by
74.An M. Warner Losh .
75