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 #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
56 #
57 # Default implementation for acpi_id_probe().
58 #
59 CODE {
60 static char *
61 acpi_generic_id_probe(device_t bus, device_t dev, char **ids)
62 {
63 return (NULL);
64 }
65 };
66
67 #
68 # Check a device for a match in a list of ID strings. The strings can be
69 # EISA PNP IDs or ACPI _HID/_CID values.
70 #
71 # device_t bus: parent bus for the device
72 #
73 # device_t dev: device being considered
74 #
75 # char **ids: array of ID strings to consider
76 #
77 # Returns: ID string matched or NULL if no match
78 #
79 METHOD char * id_probe {
80 device_t bus;
81 device_t dev;
82 char **ids;
83 } DEFAULT acpi_generic_id_probe;
84
85 #
86 # Evaluate an ACPI method or object, given its path.
87 #
88 # device_t bus: parent bus for the device
89 #
90 # device_t dev: evaluate the object relative to this device's handle.
91 # Specify NULL to begin the search at the ACPI root.
92 #
93 # ACPI_STRING pathname: absolute or relative path to this object
94 #
95 # ACPI_OBJECT_LIST *parameters: array of arguments to pass to the object.
96 # Specify NULL if there are none.
97 #
98 # ACPI_BUFFER *ret: the result (if any) of the evaluation
99 # Specify NULL if there is none.
100 #
101 # Returns: AE_OK or an error value
102 #
103 METHOD ACPI_STATUS evaluate_object {
104 device_t bus;
105 device_t dev;
106 ACPI_STRING pathname;
107 ACPI_OBJECT_LIST *parameters;
108 ACPI_BUFFER *ret;
109 };
110
111 #
112 # Get the highest power state (D0-D3) that is usable for a device when
113 # suspending/resuming. If a bus calls this when suspending a device, it
114 # must also call it when resuming.
115 #
116 # device_t bus: parent bus for the device
117 #
118 # device_t dev: check this device's appropriate power state
119 #
120 # int *dstate: if successful, contains the highest valid sleep state
121 #
122 # Returns: 0 on success, ESRCH if device has no special state, or
123 # some other error value.
124 #
125 METHOD int pwr_for_sleep {
126 device_t bus;
127 device_t dev;
128 int *dstate;
129 };
130
131 #
132 # Rescan a subtree and optionally reattach devices to handles. Users
133 # specify a callback that is called for each ACPI_HANDLE of type Device
134 # that is a child of "dev".
135 #
136 # device_t bus: parent bus for the device
137 #
138 # device_t dev: begin the scan starting with this device's handle.
139 # Specify NULL to begin the scan at the ACPI root.
140 #
141 # int max_depth: number of levels to traverse (i.e., 1 means just the
142 # immediate children.
143 #
144 # acpi_scan_cb_t user_fn: called for each child handle
145 #
146 # void *arg: argument to pass to the callback function
147 #
148 # Returns: AE_OK or an error value, based on the callback return value
149 #
150 METHOD ACPI_STATUS scan_children {
151 device_t bus;
152 device_t dev;
153 int max_depth;
154 acpi_scan_cb_t user_fn;
155 void *arg;
156 };
157
158 #
159 # Query a given driver for its supported feature(s). This should be
160 # called by the parent bus before the driver is probed.
161 #
162 # driver_t *driver: child driver
163 #
164 # u_int *features: returned bitmask of all supported features
165 #
166 STATICMETHOD int get_features {
167 driver_t *driver;
168 u_int *features;
169 };
Cache object: 169515be7ad22320fa61d0b226716559
|