1.\" -*- nroff -*- 2.\" 3.\" Copyright (c) 1998 Doug Rabson 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 June 16, 1998 32.Dt DEVICE_ADD_CHILD 9 33.Os FreeBSD 34.Sh NAME 35.Nm device_add_child , 36.Nm device_add_child_ordered 37.Nd add a new device as a child of an existing device 38.Sh SYNOPSIS 39.Fd #include <sys/param.h> 40.Fd #include <sys/bus.h> 41.Ft int 42.Fn bus_add_child "device_t dev" "const char *name" "int unit" "void *ivars" 43.Ft int 44.Fn bus_add_child_ordered "device_t dev" "int order" "const char *name" "int unit" "void *ivars" 45.Sh DESCRIPTION 46.Pp 47Create a new child device of 48.Fa dev . 49The 50.Fa name 51and 52.Fa unit 53arguments specify the name and unit number of the device. 54If the name is unknown then the caller should pass 55.Dv NULL . 56If the unit is unknown then the caller should pass 57.Dv -1 58and the system will choose the next available unit number. 59If there is any bus-specific data associated with the new child device 60(i.e. port numbers, irq settings etc.) then this should be supplied as 61the 62.Fa ivars 63argument. 64.Pp 65The name of the device is used to determine which drivers might be 66appropriate for the device. If a name is specified then only drivers 67of that name are probed. If no name is given then all drivers for the 68owning bus are probed. 69.Pp 70This allows busses which can uniquely identify device instances (such 71as PCI) to allow each driver to check each device instance for a 72match. For busses which rely on supplied probe hints where only one 73driver can have a change of probing the device, the driver name should 74specified as the device name. 75.Pp 76Normally unit numbers will be chosen automatically by the system and a 77unit number of 78.Dv -1 79should be given. 80When a specific unit number is desired (e.g. for wiring a particular 81piece of hardware to a pre-configured unit number), that unit should 82be passed. If the specified unit number is already allocated, a new 83unit will be allocated and a diagnostic message printed. 84.Pp 85If the devices attached to a bus must be probed in a specific order 86(e.g. for the ISA bus some devices are sensitive to failed probe attempts 87of unrelated drivers and therefore must be probed first), 88the 89.Fa order 90argument of 91.Xr device_add_child_ordered 9 92should be used to specify a partial ordering. 93The new device will be added before any existing device with a greater 94order. 95If 96.Xr device_add_child 9 97is used, then the new child will be added as if its order was zero. 98.Sh RETURN VALUES 99The new device if successful, NULL otherwise. 100.Sh SEE ALSO 101.Xr device 9 102.Sh AUTHORS 103This man page was written by 104.An Doug Rabson . 105