xref: /freebsd/share/man/man9/device_get_children.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.Dd August 23, 2008
30.Dt DEVICE_GET_CHILDREN 9
31.Os
32.Sh NAME
33.Nm device_get_children
34.Nd get a list of devices connected to a device
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/bus.h
38.Ft int
39.Fn device_get_children "device_t dev" "device_t **devlistp" "int *devcountp"
40.Sh DESCRIPTION
41Retrieve a list of all device instances currently connected to
42.Pa dev
43and return the list in
44.Fa *devlistp
45and the count in
46.Fa *devcountp .
47The memory allocated for the list should be freed using
48.Fn free "*devlistp" "M_TEMP" .
49.Fa devlistp
50and
51.Fa devcountp
52are not changed when an error is returned.
53.Sh RETURN VALUES
54Zero is returned on success, otherwise an appropriate error is returned.
55.Sh SEE ALSO
56.Xr devclass 9 ,
57.Xr device 9
58.Sh AUTHORS
59This manual page was written by
60.An Doug Rabson .
61