share/man/man9/OF_finddevice.9

   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_FINDDEVICE 9
  30 .Os
  31 .Sh NAME
  32 .Nm OF_finddevice
  33 .Nd find node in 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_finddevice "const char *path"
  39 .Sh DESCRIPTION
  40 .Pp
  41 .Fn OF_finddevice
  42 returns the phandle for the node specified by the
  43 .Fa path .
  44 Returns -1 if the path cannot be found in the tree.
  45 .Sh CAVEATS
  46 The return value should only be checked with equality
  47 operators (equal to, not equal to) and not relational comparison
  48 (less than, greater than ).
  49 There is a discrepancy between IEEE 1275 standard and
  50 .Fx Ns 's
  51 internal representation of a phandle: IEEE 1275
  52 requires the return value of this function to be -1 if the path
  53 is not found.
  54 But phandle_t is an unsigned type, so it cannot
  55 be relationally compared with -1 or 0, this comparison
  56 is always true or always false.
  57 .Sh EXAMPLES
  58 .Bd -literal
  59     phandle_t root, i2c;
  60
  61     root = OF_finddevice("/");
  62     i2c = OF_finddevice("/soc/axi/i2c@a0e0000");
  63     if (i2c != -1) {
  64         ...
  65     }
  66 .Ed
  67 .Sh SEE ALSO
  68 .Xr OF_child 9
  69 .Xr OF_parent 9
  70 .Xr OF_peer 9
  71 .Sh AUTHORS
  72 .An -nosplit
  73 This manual page was written by
  74 .An Oleksandr Tymoshenko Aq Mt gonzo@FreeBSD.org .