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