xref: /freebsd/share/man/man9/devclass_get_devices.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1cefd51ecSDoug Rabson.\" -*- nroff -*-
2cefd51ecSDoug Rabson.\"
3cefd51ecSDoug Rabson.\" Copyright (c) 1998 Doug Rabson
4cefd51ecSDoug Rabson.\"
5cefd51ecSDoug Rabson.\" All rights reserved.
6cefd51ecSDoug Rabson.\"
7cefd51ecSDoug Rabson.\" This program is free software.
8cefd51ecSDoug Rabson.\"
9cefd51ecSDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10cefd51ecSDoug Rabson.\" modification, are permitted provided that the following conditions
11cefd51ecSDoug Rabson.\" are met:
12cefd51ecSDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13cefd51ecSDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14cefd51ecSDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15cefd51ecSDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16cefd51ecSDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17cefd51ecSDoug Rabson.\"
18cefd51ecSDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19cefd51ecSDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20cefd51ecSDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21cefd51ecSDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22cefd51ecSDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23cefd51ecSDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24cefd51ecSDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25cefd51ecSDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26cefd51ecSDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27cefd51ecSDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28cefd51ecSDoug Rabson.\"
2996ab794bSNate Lawson.Dd May 19, 2005
30def37e7cSMike Pritchard.Dt DEVCLASS_GET_DEVICES 9
313d45e180SRuslan Ermilov.Os
32cefd51ecSDoug Rabson.Sh NAME
33cefd51ecSDoug Rabson.Nm devclass_get_devices
34cefd51ecSDoug Rabson.Nd get a list of devices in a devclass
35cefd51ecSDoug Rabson.Sh SYNOPSIS
3632eef9aeSRuslan Ermilov.In sys/param.h
3732eef9aeSRuslan Ermilov.In sys/bus.h
38cefd51ecSDoug Rabson.Ft int
393b00e9bdSBruce Evans.Fn devclass_get_devices "devclass_t dc" "device_t **devlistp" "int *devcountp"
40cefd51ecSDoug Rabson.Sh DESCRIPTION
41cefd51ecSDoug RabsonRetrieve a list of all device instances currently in the devclass and
42cefd51ecSDoug Rabsonreturn the list in
43cefd51ecSDoug Rabson.Fa *devlistp
44cefd51ecSDoug Rabsonand the count in
45cefd51ecSDoug Rabson.Fa *devcountp .
46cefd51ecSDoug RabsonThe memory allocated for the list should be freed using
4796ab794bSNate Lawson.Fn free "*devlistp" "M_TEMP" ,
4896ab794bSNate Lawsoneven if
4996ab794bSNate Lawson.Fa *devcountp
5096ab794bSNate Lawsonis 0.
51cefd51ecSDoug Rabson.Sh RETURN VALUES
52cefd51ecSDoug RabsonZero is returned on success, otherwise an appropriate error is returned.
53cefd51ecSDoug Rabson.Sh SEE ALSO
54cefd51ecSDoug Rabson.Xr devclass 9 ,
55cefd51ecSDoug Rabson.Xr device 9
56cefd51ecSDoug Rabson.Sh AUTHORS
57571dba6eSHiten PandyaThis manual page was written by
58cefd51ecSDoug Rabson.An Doug Rabson .
59