share/man/man9/device.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: src/share/man/man9/device.9,v 1.7.2.4 2001/08/17 13:08:54 ru Exp $
  30 .\"
  31 .Dd June 16, 1998
  32 .Dt DEVICE 9
  33 .Os
  34 .Sh NAME
  35 .Nm device
  36 .Nd an abstract representation of a device
  37 .Sh SYNOPSIS
  38 .Vt typedef struct device *device_t ;
  39 .Sh DESCRIPTION
  40 The device object represents a piece of hardware attached to the
  41 system such as an expansion card, the bus which that card is plugged
  42 into, disk drives attached to the expansion card etc.
  43 The system defines one device,
  44 .Dv root_bus
  45 and all other devices are created dynamically during
  46 autoconfiguration.  Normally devices representing toplevel busses in
  47 the system (ISA, PCI etc.) will be attached directly to
  48 .Dv root_bus
  49 and other devices will be added as children of their relevant bus.
  50 .Pp
  51 The devices in a system form a tree.
  52 All devices except
  53 .Dv root_bus
  54 have a parent (see
  55 .Xr device_get_parent 9 ) .
  56 In addition, any device can have children attached to it (see
  57 .Xr device_add_child 9 ,
  58 .Xr device_add_child_ordered 9 ,
  59 .Xr device_find_child 9 ,
  60 .Xr device_get_children 9 ,
  61 and
  62 .Xr device_delete_child 9 ) .
  63 .Pp
  64 A device which has been successfully probed and attached to the
  65 system will also have a driver (see
  66 .Xr device_get_driver 9
  67 and
  68 .Xr driver 9 )
  69 and a devclass (see
  70 .Xr device_get_devclass 9
  71 and
  72 .Xr devclass 9 ) .
  73 Various other attributes of the device include a unit number (see
  74 .Xr device_get_unit 9 ) ,
  75 verbose description (normally supplied by the driver, see
  76 .Xr device_set_desc 9
  77 and
  78 .Xr device_get_desc 9 ) ,
  79 a set of bus-specific variables (see
  80 .Xr device_get_ivars 9 )
  81 and a set of driver-specific variables (see
  82 .Xr device_get_softc 9 ) .
  83 .Pp
  84 Devices can be in one of several states:
  85 .Bl -tag -width DS_NOTPRESENT
  86 .It Ar DS_NOTPRESENT
  87 the device has not been probed for existence or the probe failed
  88 .It Ar DS_ALIVE
  89 the device probe succeeded but not yet attached
  90 .It Ar DS_ATTACHED
  91 the device has been successfully attached
  92 .It Ar DS_BUSY
  93 the device is currently open
  94 .El
  95 .Pp
  96 The current state of the device can be determined by calling
  97 .Xr device_get_state 9 .
  98 .Sh SEE ALSO
  99 .Xr devclass 9 ,
 100 .Xr driver 9
 101 .Sh AUTHORS
 102 This man page was written by
 103 .An Doug Rabson .