sys/kern/device_if.m

   1 #
   2 # Copyright (c) 1998 Doug Rabson
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions
   7 # are met:
   8 # 1. Redistributions of source code must retain the above copyright
   9 #    notice, this list of conditions and the following disclaimer.
  10 # 2. Redistributions in binary form must reproduce the above copyright
  11 #    notice, this list of conditions and the following disclaimer in the
  12 #    documentation and/or other materials provided with the distribution.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 # SUCH DAMAGE.
  25 #
  26 # $FreeBSD: src/sys/kern/device_if.m,v 1.7.2.1 2001/07/24 09:49:41 dd Exp $
  27 # $DragonFly: src/sys/kern/device_if.m,v 1.2 2003/06/17 04:28:41 dillon Exp $
  28 #
  29
  30 INTERFACE device;
  31
  32 #
  33 # Default implementations of some methods.
  34 #
  35 CODE {
  36         static int null_shutdown(device_t dev)
  37         {
  38             return 0;
  39         }
  40
  41         static int null_suspend(device_t dev)
  42         {
  43             return 0;
  44         }
  45
  46         static int null_resume(device_t dev)
  47         {
  48             return 0;
  49         }
  50 };
  51
  52 #
  53 # Probe to see if the device is present.  Return 0 if the device exists,
  54 # ENXIO if it cannot be found. If some other error happens during the
  55 # probe (such as a memory allocation failure), an appropriate error code
  56 # should be returned. For cases where more than one driver matches a
  57 # device, a priority value can be returned.  In this case, success codes
  58 # are values less than or equal to zero with the highest value representing
  59 # the best match.  Failure codes are represented by positive values and
  60 # the regular unix error codes should be used for the purpose.
  61
  62 # If a driver returns a success code which is less than zero, it must
  63 # not assume that it will be the same driver which is attached to the
  64 # device. In particular, it must not assume that any values stored in
  65 # the softc structure will be available for its attach method and any
  66 # resources allocated during probe must be released and re-allocated
  67 # if the attach method is called.  If a success code of zero is
  68 # returned, the driver can assume that it will be the one attached.
  69 #
  70 # Devices which implement busses should use this method to probe for
  71 # the existence of devices attached to the bus and add them as
  72 # children.  If this is combined with the use of bus_generic_attach,
  73 # the child devices will be automatically probed and attached.
  74 #
  75 METHOD int probe {
  76         device_t dev;
  77 };
  78
  79 #
  80 # Called by a parent bus to add new devices to the bus.
  81 #
  82 STATICMETHOD void identify {
  83         driver_t *driver;
  84         device_t parent;
  85 };
  86
  87 #
  88 # Attach a device to the system.  The probe method will have been
  89 # called and will have indicated that the device exists.  This routine
  90 # should initialise the hardware and allocate other system resources.
  91 # Returns 0 on success.
  92 #
  93 METHOD int attach {
  94         device_t dev;
  95 };
  96
  97 #
  98 # Detach a device.  This can be called if the user is replacing the
  99 # driver software or if a device is about to be physically removed
 100 # from the system (e.g. for pccard devices).  Returns 0 on success.
 101 #
 102 METHOD int detach {
 103         device_t dev;
 104 };
 105
 106 #
 107 # This is called during system shutdown to allow the driver to put the
 108 # hardware into a consistent state for rebooting the computer.
 109 #
 110 METHOD int shutdown {
 111         device_t dev;
 112 } DEFAULT null_shutdown;
 113
 114 #
 115 # This is called by the power-management subsystem when a suspend has been
 116 # requested by the user or by some automatic mechanism.  This gives
 117 # drivers a chance to veto the suspend or save their configuration before
 118 # power is removed.
 119 #
 120 METHOD int suspend {
 121         device_t dev;
 122 } DEFAULT null_suspend;
 123
 124 METHOD int resume {
 125         device_t dev;
 126 } DEFAULT null_resume;