2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #ifndef __ACPI_BUS_H__
27 #define __ACPI_BUS_H__
29 #include <linux/kobject.h>
31 #include <acpi/acpi.h>
33 #define PREFIX "ACPI: "
35 /* TBD: Make dynamic */
36 #define ACPI_MAX_HANDLES 10
37 struct acpi_handle_list {
39 acpi_handle handles[ACPI_MAX_HANDLES];
45 acpi_extract_package (
46 union acpi_object *package,
47 struct acpi_buffer *format,
48 struct acpi_buffer *buffer);
50 acpi_evaluate_integer (
53 struct acpi_object_list *arguments,
56 acpi_evaluate_reference (
59 struct acpi_object_list *arguments,
60 struct acpi_handle_list *list);
63 #ifdef CONFIG_ACPI_BUS
65 #include <linux/proc_fs.h>
67 #define ACPI_BUS_FILE_ROOT "acpi"
68 extern struct proc_dir_entry *acpi_root_dir;
69 extern FADT_DESCRIPTOR acpi_fadt;
71 enum acpi_bus_removal_type {
72 ACPI_BUS_REMOVAL_NORMAL = 0,
73 ACPI_BUS_REMOVAL_EJECT,
74 ACPI_BUS_REMOVAL_SUPRISE,
75 ACPI_BUS_REMOVAL_TYPE_COUNT
78 enum acpi_bus_device_type {
79 ACPI_BUS_TYPE_DEVICE = 0,
81 ACPI_BUS_TYPE_PROCESSOR,
82 ACPI_BUS_TYPE_THERMAL,
84 ACPI_BUS_TYPE_POWER_BUTTON,
85 ACPI_BUS_TYPE_SLEEP_BUTTON,
86 ACPI_BUS_DEVICE_TYPE_COUNT
98 typedef int (*acpi_op_add) (struct acpi_device *device);
99 typedef int (*acpi_op_remove) (struct acpi_device *device, int type);
100 typedef int (*acpi_op_lock) (struct acpi_device *device, int type);
101 typedef int (*acpi_op_start) (struct acpi_device *device);
102 typedef int (*acpi_op_stop) (struct acpi_device *device, int type);
103 typedef int (*acpi_op_suspend) (struct acpi_device *device, int state);
104 typedef int (*acpi_op_resume) (struct acpi_device *device, int state);
105 typedef int (*acpi_op_scan) (struct acpi_device *device);
106 typedef int (*acpi_op_bind) (struct acpi_device *device);
108 struct acpi_device_ops {
110 acpi_op_remove remove;
114 acpi_op_suspend suspend;
115 acpi_op_resume resume;
121 struct list_head node;
125 char *ids; /* Supported Hardware IDs */
126 struct acpi_device_ops ops;
136 struct acpi_device_status {
141 u32 battery_present:1;
148 struct acpi_device_flags {
149 u32 dynamic_status:1;
151 u32 compatible_ids:1;
157 u32 suprise_removal_ok:1;
158 u32 power_manageable:1;
159 u32 performance_manageable:1;
160 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
167 struct acpi_device_dir {
168 struct proc_dir_entry *entry;
171 #define acpi_device_dir(d) ((d)->dir.entry)
176 typedef char acpi_bus_id[5];
177 typedef unsigned long acpi_bus_address;
178 typedef char acpi_hardware_id[9];
179 typedef char acpi_unique_id[9];
180 typedef char acpi_device_name[40];
181 typedef char acpi_device_class[20];
183 struct acpi_device_pnp {
184 acpi_bus_id bus_id; /* Object name */
185 acpi_bus_address bus_address; /* _ADR */
186 acpi_hardware_id hardware_id; /* _HID */
187 struct acpi_compatible_id_list *cid_list; /* _CIDs */
188 acpi_unique_id unique_id; /* _UID */
189 acpi_device_name device_name; /* Driver-determined */
190 acpi_device_class device_class; /* " */
193 #define acpi_device_bid(d) ((d)->pnp.bus_id)
194 #define acpi_device_adr(d) ((d)->pnp.bus_address)
195 #define acpi_device_hid(d) ((d)->pnp.hardware_id)
196 #define acpi_device_uid(d) ((d)->pnp.unique_id)
197 #define acpi_device_name(d) ((d)->pnp.device_name)
198 #define acpi_device_class(d) ((d)->pnp.device_class)
201 /* Power Management */
203 struct acpi_device_power_flags {
204 u32 explicit_get:1; /* _PSC present? */
205 u32 power_resources:1; /* Power resources */
206 u32 inrush_current:1; /* Serialize Dx->D0 */
207 u32 power_removed:1; /* Optimize Dx->D0 */
211 struct acpi_device_power_state {
214 u8 explicit_set:1; /* _PSx present? */
217 int power; /* % Power (compared to D0) */
218 int latency; /* Dx->D0 time (microseconds) */
219 struct acpi_handle_list resources; /* Power resources referenced */
222 struct acpi_device_power {
223 int state; /* Current state */
224 struct acpi_device_power_flags flags;
225 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
229 /* Performance Management */
231 struct acpi_device_perf_flags {
235 struct acpi_device_perf_state {
240 u8 power; /* % Power (compared to P0) */
241 u8 performance; /* % Performance ( " ) */
242 int latency; /* Px->P0 time (microseconds) */
245 struct acpi_device_perf {
247 struct acpi_device_perf_flags flags;
249 struct acpi_device_perf_state *states;
252 /* Wakeup Management */
253 struct acpi_device_wakeup_flags {
254 u8 valid:1; /* Can successfully enable wakeup? */
255 u8 run_wake:1; /* Run-Wake GPE devices */
258 struct acpi_device_wakeup_state {
263 struct acpi_device_wakeup {
264 acpi_handle gpe_device;
265 acpi_integer gpe_number;;
266 acpi_integer sleep_state;
267 struct acpi_handle_list resources;
268 struct acpi_device_wakeup_state state;
269 struct acpi_device_wakeup_flags flags;
276 struct acpi_device *parent;
277 struct list_head children;
278 struct list_head node;
279 struct list_head wakeup_list;
280 struct list_head g_list;
281 struct acpi_device_status status;
282 struct acpi_device_flags flags;
283 struct acpi_device_pnp pnp;
284 struct acpi_device_power power;
285 struct acpi_device_wakeup wakeup;
286 struct acpi_device_perf performance;
287 struct acpi_device_dir dir;
288 struct acpi_device_ops ops;
289 struct acpi_driver *driver;
294 #define acpi_driver_data(d) ((d)->driver_data)
302 struct acpi_bus_event {
303 struct list_head node;
304 acpi_device_class device_class;
310 extern struct subsystem acpi_subsys;
316 int acpi_bus_get_device(acpi_handle, struct acpi_device **device);
317 int acpi_bus_get_status (struct acpi_device *device);
318 int acpi_bus_get_power (acpi_handle handle, int *state);
319 int acpi_bus_set_power (acpi_handle handle, int state);
320 int acpi_bus_generate_event (struct acpi_device *device, u8 type, int data);
321 int acpi_bus_receive_event (struct acpi_bus_event *event);
322 int acpi_bus_register_driver (struct acpi_driver *driver);
323 int acpi_bus_unregister_driver (struct acpi_driver *driver);
325 int acpi_create_dir(struct acpi_device *);
326 void acpi_remove_dir(struct acpi_device *);
328 #endif /*CONFIG_ACPI_BUS*/
330 #endif /*__ACPI_BUS_H__*/