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_bif; 57 struct acpi_bst; 58}; 59 60# 61# Default implementation for acpi_id_probe(). 62# 63CODE { 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# Returns: ID string matched or NULL if no match 82# 83METHOD char * id_probe { 84 device_t bus; 85 device_t dev; 86 char **ids; 87} DEFAULT acpi_generic_id_probe; 88 89# 90# Evaluate an ACPI method or object, given its path. 91# 92# device_t bus: parent bus for the device 93# 94# device_t dev: evaluate the object relative to this device's handle. 95# Specify NULL to begin the search at the ACPI root. 96# 97# ACPI_STRING pathname: absolute or relative path to this object 98# 99# ACPI_OBJECT_LIST *parameters: array of arguments to pass to the object. 100# Specify NULL if there are none. 101# 102# ACPI_BUFFER *ret: the result (if any) of the evaluation 103# Specify NULL if there is none. 104# 105# Returns: AE_OK or an error value 106# 107METHOD ACPI_STATUS evaluate_object { 108 device_t bus; 109 device_t dev; 110 ACPI_STRING pathname; 111 ACPI_OBJECT_LIST *parameters; 112 ACPI_BUFFER *ret; 113}; 114 115# 116# Get the highest power state (D0-D3) that is usable for a device when 117# suspending/resuming. If a bus calls this when suspending a device, it 118# must also call it when resuming. 119# 120# device_t bus: parent bus for the device 121# 122# device_t dev: check this device's appropriate power state 123# 124# int *dstate: if successful, contains the highest valid sleep state 125# 126# Returns: 0 on success or some other error value. 127# 128METHOD 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# 153METHOD 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# 169STATICMETHOD 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# UINT64 *val: Location to store read value 180# int width: Size of area to read in bytes 181# 182METHOD int ec_read { 183 device_t dev; 184 u_int addr; 185 UINT64 *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# UINT64 val: Value to write 195# int width: Size of value to write in bytes 196# 197METHOD int ec_write { 198 device_t dev; 199 u_int addr; 200 UINT64 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# 210METHOD 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# 221METHOD int batt_get_status { 222 device_t dev; 223 struct acpi_bst *bst; 224}; 225