share/man/man9/ofw_bus_status_okay.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2018 Oleksandr Tymoshenko
   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 April 8, 2018
  32 .Dt ofw_bus_status_okay 9
  33 .Os
  34 .Sh NAME
  35 .Nm ofw_bus_get_status ,
  36 .Nm ofw_bus_status_okay ,
  37 .Nm ofw_bus_node_status_okay
  38 .Nd check status of the device tree node
  39 .Sh SYNOPSIS
  40 .In dev/ofw/openfirm.h
  41 .In dev/ofw/ofw_bus.h
  42 .In dev/ofw/ofw_bus_subr.h
  43 .Ft const char *
  44 .Fn ofw_bus_get_status "device_t dev"
  45 .Ft int
  46 .Fn ofw_bus_status_okay "device_t dev"
  47 .Ft int
  48 .Fn ofw_bus_node_status_okay "phandle_t node"
  49 .Sh DESCRIPTION
  50 The "status" property of the device tree node indicates whether the device is
  51 enabled or not.
  52 Multiple hardware versions might be built using the same base System-on-Chip
  53 but with a different set of blocks enabled.
  54 It is common to use  SoC device tree and only enable/disable device nodes for
  55 the derivative boards.
  56 The device tree node is considered enabled only if it has "status" property
  57 with the value set to either "ok" or "okay".
  58 .Pp
  59 .Fn ofw_bus_get_status
  60 returns the value of the "status" property of the device tree node associated with the device
  61 .Fa dev .
  62 If the node does not have "status" property or there is no node associated with
  63 the device the function returns NULL.
  64 .Pp
  65 .Fn ofw_bus_status_okay
  66 returns 1 if the device tree node associated with the device
  67 .Fa dev
  68 has "status" property and its value is either "ok" or "okay".
  69 .Pp
  70 .Fn ofw_bus_node_status_okay
  71 returns 1 if the device tree node
  72 .Fa node
  73 has "status" property and its value is either "ok" or "okay".
  74 .Sh AUTHORS
  75 This manual page was written by
  76 .An Oleksandr Tymoshenko .