The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/acpica/acpi_if.m

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 #-
    2 # Copyright (c) 2004 Nate Lawson
    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$
   27 #
   28 
   29 #include <sys/bus.h>
   30 #include <sys/types.h>
   31 #include <contrib/dev/acpica/acpi.h>
   32 
   33 INTERFACE acpi;
   34 
   35 #
   36 # Callback function for each child handle traversed in acpi_scan_children().
   37 #
   38 # ACPI_HANDLE h:  current child device being considered
   39 #
   40 # device_t *dev:  pointer to the child's original device_t or NULL if there
   41 #   was none.  The callback should store a new device in *dev if it has
   42 #   created one.  The method implementation will automatically clean up the
   43 #   previous device and properly associate the current ACPI_HANDLE with it.
   44 #
   45 # level:  current level being scanned
   46 #
   47 # void *arg:  argument passed in original call to acpi_scan_children()
   48 #
   49 # Returns:  AE_OK if the scan should continue, otherwise an error
   50 #
   51 HEADER {
   52         typedef ACPI_STATUS (*acpi_scan_cb_t)(ACPI_HANDLE h, device_t *dev,
   53             int level, void *arg);
   54 
   55         struct acpi_bif;
   56         struct acpi_bst;
   57 };
   58 
   59 #
   60 # Default implementation for acpi_id_probe().
   61 #
   62 CODE {
   63         static char *
   64         acpi_generic_id_probe(device_t bus, device_t dev, char **ids)
   65         {
   66                 return (NULL);
   67         }
   68 };
   69 
   70 #
   71 # Check a device for a match in a list of ID strings.  The strings can be
   72 # EISA PNP IDs or ACPI _HID/_CID values.
   73 #
   74 # device_t bus:  parent bus for the device
   75 #
   76 # device_t dev:  device being considered
   77 #
   78 # char **ids:  array of ID strings to consider
   79 #
   80 # Returns:  ID string matched or NULL if no match
   81 #
   82 METHOD char * id_probe {
   83         device_t        bus;
   84         device_t        dev;
   85         char            **ids;
   86 } DEFAULT acpi_generic_id_probe;
   87 
   88 #
   89 # Evaluate an ACPI method or object, given its path.
   90 #
   91 # device_t bus:  parent bus for the device
   92 #
   93 # device_t dev:  evaluate the object relative to this device's handle.
   94 #   Specify NULL to begin the search at the ACPI root.
   95 #
   96 # ACPI_STRING pathname:  absolute or relative path to this object
   97 #
   98 # ACPI_OBJECT_LIST *parameters:  array of arguments to pass to the object.
   99 #   Specify NULL if there are none.
  100 #
  101 # ACPI_BUFFER *ret:  the result (if any) of the evaluation
  102 #   Specify NULL if there is none.
  103 #
  104 # Returns:  AE_OK or an error value
  105 #
  106 METHOD ACPI_STATUS evaluate_object {
  107         device_t        bus;
  108         device_t        dev;
  109         ACPI_STRING     pathname;
  110         ACPI_OBJECT_LIST *parameters;
  111         ACPI_BUFFER     *ret;
  112 };
  113 
  114 #
  115 # Get the highest power state (D0-D3) that is usable for a device when
  116 # suspending/resuming.  If a bus calls this when suspending a device, it
  117 # must also call it when resuming.
  118 #
  119 # device_t bus:  parent bus for the device
  120 #
  121 # device_t dev:  check this device's appropriate power state
  122 #
  123 # int *dstate:  if successful, contains the highest valid sleep state
  124 #
  125 # Returns:  0 on success, ESRCH if device has no special state, or
  126 #   some other error value.
  127 #
  128 METHOD int pwr_for_sleep {
  129         device_t        bus;
  130         device_t        dev;
  131         int             *dstate;
  132 };
  133 
  134 #
  135 # Rescan a subtree and optionally reattach devices to handles.  Users
  136 # specify a callback that is called for each ACPI_HANDLE of type Device
  137 # that is a child of "dev".
  138 #
  139 # device_t bus:  parent bus for the device
  140 #
  141 # device_t dev:  begin the scan starting with this device's handle.
  142 #   Specify NULL to begin the scan at the ACPI root.
  143 # 
  144 # int max_depth:  number of levels to traverse (i.e., 1 means just the
  145 #   immediate children.
  146 #
  147 # acpi_scan_cb_t user_fn:  called for each child handle
  148 #
  149 # void *arg:  argument to pass to the callback function
  150 #
  151 # Returns:  AE_OK or an error value, based on the callback return value
  152 #
  153 METHOD ACPI_STATUS scan_children {
  154         device_t        bus;
  155         device_t        dev;
  156         int             max_depth;
  157         acpi_scan_cb_t  user_fn;
  158         void            *arg;
  159 };
  160 
  161 #
  162 # Query a given driver for its supported feature(s).  This should be
  163 # called by the parent bus before the driver is probed.
  164 #
  165 # driver_t *driver:  child driver
  166 #
  167 # u_int *features:  returned bitmask of all supported features
  168 #
  169 STATICMETHOD int get_features {
  170         driver_t        *driver;
  171         u_int           *features;
  172 };
  173 
  174 #
  175 # Read embedded controller (EC) address space
  176 #
  177 # device_t dev:  EC device
  178 # u_int addr:  Address to read from in EC space
  179 # ACPI_INTEGER *val:  Location to store read value
  180 # int width:  Size of area to read in bytes
  181 #
  182 METHOD int ec_read {
  183         device_t        dev;
  184         u_int           addr;
  185         ACPI_INTEGER    *val;
  186         int             width;
  187 };
  188 
  189 #
  190 # Write embedded controller (EC) address space
  191 #
  192 # device_t dev:  EC device
  193 # u_int addr:  Address to write to in EC space
  194 # ACPI_INTEGER val:  Value to write
  195 # int width:  Size of value to write in bytes
  196 #
  197 METHOD int ec_write {
  198         device_t        dev;
  199         u_int           addr;
  200         ACPI_INTEGER    val;
  201         int             width;
  202 };
  203 
  204 #
  205 # Get battery information (_BIF format)
  206 #
  207 # device_t dev:  Battery device
  208 # struct acpi_bif *bif:  Pointer to storage for _BIF results
  209 #
  210 METHOD int batt_get_info {
  211         device_t        dev;
  212         struct acpi_bif *bif;
  213 };
  214 
  215 #
  216 # Get battery status (_BST format)
  217 #
  218 # device_t dev:  Battery device
  219 # struct acpi_bst *bst:  Pointer to storage for _BST results
  220 #
  221 METHOD int batt_get_status {
  222         device_t        dev;
  223         struct acpi_bst *bst;
  224 };

Cache object: a4cc99d7fb7127a99d58849202ca7746


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.