sys/dev/acpica5/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 # $DragonFly: src/sys/dev/acpica5/acpi_if.m,v 1.3 2008/09/29 06:59:45 hasso Exp $
  27 #
  28
  29 #include <sys/bus.h>
  30 #include <sys/types.h>
  31 #include "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 # Query a given driver for its supported feature(s).  This should be
  90 # called by the parent bus before the driver is probed.
  91 #
  92 # driver_t *driver:  child driver
  93 #
  94 # u_int *features:  returned bitmask of all supported features
  95 #
  96 STATICMETHOD int get_features {
  97         driver_t        *driver;
  98         u_int           *features;
  99 };
 100
 101 #
 102 # Read embedded controller (EC) address space
 103 #
 104 # device_t dev:  EC device
 105 # u_int addr:  Address to read from in EC space
 106 # ACPI_INTEGER *val:  Location to store read value
 107 # int width:  Size of area to read in bytes
 108 #
 109 METHOD int ec_read {
 110         device_t        dev;
 111         u_int           addr;
 112         ACPI_INTEGER    *val;
 113         int             width;
 114 };
 115
 116 #
 117 # Write embedded controller (EC) address space
 118 #
 119 # device_t dev:  EC device
 120 # u_int addr:  Address to write to in EC space
 121 # ACPI_INTEGER val:  Value to write
 122 # int width:  Size of value to write in bytes
 123 #
 124 METHOD int ec_write {
 125         device_t        dev;
 126         u_int           addr;
 127         ACPI_INTEGER    val;
 128         int             width;
 129 };
 130
 131 #
 132 # Get battery information (_BIF format)
 133 #
 134 # device_t dev:  Battery device
 135 # struct acpi_bif *bif:  Pointer to storage for _BIF results
 136 #
 137 METHOD int batt_get_info {
 138         device_t        dev;
 139         struct acpi_bif *bif;
 140 };
 141
 142 #
 143 # Get battery status (_BST format)
 144 #
 145 # device_t dev:  Battery device
 146 # struct acpi_bst *bst:  Pointer to storage for _BST results
 147 #
 148 METHOD int batt_get_status {
 149         device_t        dev;
 150         struct acpi_bst *bst;
 151 };
 152