From fa930a7361486cbeb8025ced358fa4305c4cbc17 Mon Sep 17 00:00:00 2001 From: Nick Hibma Date: Thu, 2 Dec 1999 16:34:09 +0000 Subject: [PATCH] Add the device_get_children(9) man page. --- share/man/man9/Makefile | 3 +- share/man/man9/device.9 | 1 + share/man/man9/device_get_children.9 | 59 ++++++++++++++++++++++++++++ 3 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 share/man/man9/device_get_children.9 diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index a6730de431d4..eca341574c79 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -20,7 +20,8 @@ MAN9= MD5.9 \ vget.9 vnode.9 vput.9 vref.9 vrele.9 vslock.9 MAN9+= device.9 device_add_child.9 device_delete_child.9 device_enable.9 \ - device_find_child.9 device_get_devclass.9 device_get_driver.9 \ + device_find_child.9 device_get_children.9 \ + device_get_devclass.9 device_get_driver.9 \ device_get_ivars.9 device_get_softc.9 device_get_state.9 \ device_get_unit.9 device_probe_and_attach.9 device_quiet.9 \ device_set_desc.9 device_set_flags.9 driver.9 \ diff --git a/share/man/man9/device.9 b/share/man/man9/device.9 index dae14d217edc..0251016e277c 100644 --- a/share/man/man9/device.9 +++ b/share/man/man9/device.9 @@ -57,6 +57,7 @@ In addition, any device can have children attached to it (see .Xr device_add_child 9 , .Xr device_add_child_ordered 9 , .Xr device_find_child 9 , +.Xr device_get_children 9 , and .Xr device_delete_child 9 ). .Pp diff --git a/share/man/man9/device_get_children.9 b/share/man/man9/device_get_children.9 new file mode 100644 index 000000000000..189384866448 --- /dev/null +++ b/share/man/man9/device_get_children.9 @@ -0,0 +1,59 @@ +.\" -*- nroff -*- +.\" +.\" Copyright (c) 1998 Doug Rabson +.\" +.\" All rights reserved. +.\" +.\" This program is free software. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd December 1, 1999 +.Dt DEVICE_GET_CHILDREN 9 +.Os FreeBSD +.Sh NAME +.Nm device_get_children +.Nd get a list of devices connected to a device +.Sh SYNOPSIS +.Fd #include +.Fd #include +.Ft int +.Fn device_get_children "device_t dev" "device_t **devlistp" "int *devcountp" +.Sh DESCRIPTION +.Pp +Retrieve a list of all device instances currently connected to +.Pa dev +and return the list in +.Fa *devlistp +and the count in +.Fa *devcountp . +The memory allocated for the list should be freed using +.Fn free "*devlistp" "M_TEMP" . +.Sh RETURN VALUES +Zero is returned on success, otherwise an appropriate error is returned. +.Sh SEE ALSO +.Xr devclass 9 , +.Xr device 9 +.Sh AUTHORS +This man page was written by +.An Doug Rabson .