share/man/man9/device_get_state.9

   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 June 16, 1998
  32 .Dt DEVICE_GET_STATE 9
  33 .Os FreeBSD
  34 .Sh NAME
  35 .Nm device_get_state ,
  36 .Nm device_busy ,
  37 .Nm device_unbusy ,
  38 .Nm device_is_alive
  39 .Nd manipulate device state
  40 .Sh SYNOPSIS
  41 .Fd #include <sys/param.h>
  42 .Fd #include <sys/bus.h>
  43 .Ft device_state_t
  44 .Fn device_get_state "device_t dev"
  45 .Ft void
  46 .Fn device_busy "device_t dev"
  47 .Ft void
  48 .Fn device_unbusy "device_t dev"
  49 .Ft int
  50 .Fn device_is_alive "device_t dev"
  51 .Sh DESCRIPTION
  52 .Pp
  53 The current state of a device is accessed by calling
  54 .Xr device_get_state 9
  55 which returns
  56 .Dv DS_NOTPRESENT ,
  57 .Dv DS_ALIVE ,
  58 .Dv DS_ATTACHED
  59 or
  60 .Dv DS_BUSY
  61 (described in
  62 .Xr device 9 ) .
  63 To test see if a device was successfully probed, call
  64 .Xr device_is_alive 9
  65 which simply returns if the state is greater or equal to
  66 .Dv DS_ALIVE .
  67 .Pp
  68 Each device has a busy count which is incremented when
  69 .Xr device_busy 9
  70 is called and decremented when
  71 .Xr device_unbusy 9
  72 is called.  Both routines return an error if the device state is less
  73 than
  74 .Dv DS_ATTACHED .
  75 .Pp
  76 When
  77 .Xr device_busy 9
  78 is called on a device in the
  79 .Dv DS_ATTACHED
  80 state, the device changes to the
  81 .Dv DS_BUSY
  82 state.
  83 When
  84 .Xr device_unbusy 9
  85 is called and after decrementing, the busy count for the device is
  86 zero, the device changes to the
  87 .Dv DS_ATTACHED
  88 state.
  89 .Sh SEE ALSO
  90 .Xr device 9
  91 .Sh AUTHORS
  92 This man page was written by
  93 .An Doug Rabson .