xref: /freebsd/share/man/man9/OF_child.9 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\"
2.\" Copyright (c) 2018 Oleksandr Tymoshenko <gonzo@FreeBSD.org>
3.\"
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd April 9, 2018
27.Dt OF_CHILD 9
28.Os
29.Sh NAME
30.Nm OF_child ,
31.Nm OF_parent ,
32.Nm OF_peer
33.Nd navigate device tree
34.Sh SYNOPSIS
35.In dev/ofw/ofw_bus.h
36.In dev/ofw/ofw_bus_subr.h
37.Ft phandle_t
38.Fn OF_child "phandle_t node"
39.Ft phandle_t
40.Fn OF_parent "phandle_t node"
41.Ft phandle_t
42.Fn OF_peer "phandle_t node"
43.Sh DESCRIPTION
44.Fn OF_child
45returns the phandle value of the first child of the
46.Fa node .
47Zero is returned if there are no child nodes.
48.Pp
49.Fn OF_parent
50returns the phandle for the parent of the
51.Fa node .
52Zero is returned if
53.Fa node
54is the root node.
55.Pp
56.Fn OF_peer
57returns the phandle value of the next sibling of the
58.Fa node .
59Zero is returned if there is no sibling node.
60.Sh EXAMPLES
61.Bd -literal
62phandle_t node, child;
63 ...
64for (child = OF_child(node); child != 0; child = OF_peer(child) {
65	...
66}
67.Ed
68.Sh SEE ALSO
69.Xr OF_finddevice 9
70.Sh AUTHORS
71.An -nosplit
72This manual page was written by
73.An Oleksandr Tymoshenko Aq Mt gonzo@FreeBSD.org .
74