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.2 2008/09/05 10:28:35 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 # Default implementation for acpi_id_probe().
  37 #
  38 CODE {
  39         static char *
  40         acpi_generic_id_probe(device_t bus, device_t dev, char **ids)
  41         {
  42                 return (NULL);
  43         }
  44 };
  45
  46 #
  47 # Check a device for a match in a list of ID strings.  The strings can be
  48 # EISA PNP IDs or ACPI _HID/_CID values.
  49 #
  50 # device_t bus:  parent bus for the device
  51 #
  52 # device_t dev:  device being considered
  53 #
  54 # char **ids:  array of ID strings to consider
  55 #
  56 # Returns:  ID string matched or NULL if no match
  57 #
  58 METHOD char * id_probe {
  59         device_t        bus;
  60         device_t        dev;
  61         char            **ids;
  62 } DEFAULT acpi_generic_id_probe;
  63
  64 #
  65 # Query a given driver for its supported feature(s).  This should be
  66 # called by the parent bus before the driver is probed.
  67 #
  68 # driver_t *driver:  child driver
  69 #
  70 # u_int *features:  returned bitmask of all supported features
  71 #
  72 STATICMETHOD int get_features {
  73         driver_t        *driver;
  74         u_int           *features;
  75 };
  76
  77 #
  78 # Read embedded controller (EC) address space
  79 #
  80 # device_t dev:  EC device
  81 # u_int addr:  Address to read from in EC space
  82 # ACPI_INTEGER *val:  Location to store read value
  83 # int width:  Size of area to read in bytes
  84 #
  85 METHOD int ec_read {
  86         device_t        dev;
  87         u_int           addr;
  88         ACPI_INTEGER    *val;
  89         int             width;
  90 };
  91
  92 #
  93 # Write embedded controller (EC) address space
  94 #
  95 # device_t dev:  EC device
  96 # u_int addr:  Address to write to in EC space
  97 # ACPI_INTEGER val:  Value to write
  98 # int width:  Size of value to write in bytes
  99 #
 100 METHOD int ec_write {
 101         device_t        dev;
 102         u_int           addr;
 103         ACPI_INTEGER    val;
 104         int             width;
 105 };