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