xref: /freebsd/share/man/man9/OF_package_to_path.9 (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
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.\" $FreeBSD$
27.\"
28.Dd April 9, 2018
29.Dt OF_PACKAGE_TO_PATH 9
30.Os
31.Sh NAME
32.Nm OF_package_to_path
33.Nd get fully qualified path to a device tree node
34.Sh SYNOPSIS
35.In dev/ofw/ofw_bus.h
36.In dev/ofw/ofw_bus_subr.h
37.Ft ssize_t
38.Fn OF_package_to_path "phandle_t node" "char *buf" "size_t len"
39.Sh DESCRIPTION
40.Pp
41.Fn OF_package_to_path
42copies at most
43.Fa len
44bytes of the fully qualified path to the device tree node
45.Fa node
46into the memory specified by
47.Fa buf .
48The function returns the number of bytes copied or -1 in case of the error.
49.Sh SEE ALSO
50.Xr OF_finddevice 9
51.Sh AUTHORS
52.An -nosplit
53This manual page was written by
54.An Oleksandr Tymoshenko Aq Mt gonzo@FreeBSD.org .
55