xref: /freebsd/share/man/man9/device_find_child.9 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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 February 8, 2005
32.Dt DEVICE_FIND_CHILD 9
33.Os
34.Sh NAME
35.Nm device_find_child
36.Nd search for a child of a device
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/bus.h
40.Ft device_t
41.Fn device_find_child "device_t dev" "const char *classname" "int unit"
42.Sh DESCRIPTION
43This function looks for a specific child of
44.Dv dev
45with the given
46.Fa classname
47and
48.Fa unit .
49If
50.Fa unit
51is \-1, it returns the first child of
52.Fa dev
53with a matching
54.Fa classname
55(that is, the one with the lowest unit).
56.Sh RETURN VALUES
57If it exists, the child device is returned, otherwise NULL.
58.Sh SEE ALSO
59.Xr device_add_child 9
60.Sh AUTHORS
61This manual page was written by
62.An Doug Rabson .
63