sys/dev/acpica/acpi_if.m

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