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/device.h>
31 #include <acpi/acpi.h>
33 /* TBD: Make dynamic */
34 #define ACPI_MAX_HANDLES 10
35 struct acpi_handle_list {
37 acpi_handle handles[ACPI_MAX_HANDLES];
42 acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer);
45 acpi_evaluate_integer(acpi_handle handle,
47 struct acpi_object_list *arguments, unsigned long long *data);
49 acpi_evaluate_reference(acpi_handle handle,
51 struct acpi_object_list *arguments,
52 struct acpi_handle_list *list);
56 #include <linux/proc_fs.h>
58 #define ACPI_BUS_FILE_ROOT "acpi"
59 extern struct proc_dir_entry *acpi_root_dir;
61 enum acpi_bus_removal_type {
62 ACPI_BUS_REMOVAL_NORMAL = 0,
63 ACPI_BUS_REMOVAL_EJECT,
64 ACPI_BUS_REMOVAL_SUPRISE,
65 ACPI_BUS_REMOVAL_TYPE_COUNT
68 enum acpi_bus_device_type {
69 ACPI_BUS_TYPE_DEVICE = 0,
71 ACPI_BUS_TYPE_PROCESSOR,
72 ACPI_BUS_TYPE_THERMAL,
73 ACPI_BUS_TYPE_POWER_BUTTON,
74 ACPI_BUS_TYPE_SLEEP_BUTTON,
75 ACPI_BUS_DEVICE_TYPE_COUNT
86 typedef int (*acpi_op_add) (struct acpi_device * device);
87 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
88 typedef int (*acpi_op_start) (struct acpi_device * device);
89 typedef int (*acpi_op_suspend) (struct acpi_device * device,
91 typedef int (*acpi_op_resume) (struct acpi_device * device);
92 typedef int (*acpi_op_bind) (struct acpi_device * device);
93 typedef int (*acpi_op_unbind) (struct acpi_device * device);
94 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
101 struct acpi_device_ops {
103 acpi_op_remove remove;
105 acpi_op_suspend suspend;
106 acpi_op_resume resume;
108 acpi_op_unbind unbind;
109 acpi_op_notify notify;
112 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
117 const struct acpi_device_id *ids; /* Supported Hardware IDs */
119 struct acpi_device_ops ops;
120 struct device_driver drv;
121 struct module *owner;
131 struct acpi_device_status {
136 u32 battery_present:1;
142 struct acpi_device_flags {
143 u32 dynamic_status:1;
145 u32 compatible_ids:1;
151 u32 suprise_removal_ok:1;
152 u32 power_manageable:1;
153 u32 performance_manageable:1;
154 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
155 u32 force_power_state:1;
161 struct acpi_device_dir {
162 struct proc_dir_entry *entry;
165 #define acpi_device_dir(d) ((d)->dir.entry)
169 typedef char acpi_bus_id[8];
170 typedef unsigned long acpi_bus_address;
171 typedef char acpi_device_name[40];
172 typedef char acpi_device_class[20];
174 struct acpi_hardware_id {
175 struct list_head list;
179 struct acpi_device_pnp {
180 acpi_bus_id bus_id; /* Object name */
181 acpi_bus_address bus_address; /* _ADR */
182 char *unique_id; /* _UID */
183 struct list_head ids; /* _HID and _CIDs */
184 acpi_device_name device_name; /* Driver-determined */
185 acpi_device_class device_class; /* " */
188 #define acpi_device_bid(d) ((d)->pnp.bus_id)
189 #define acpi_device_adr(d) ((d)->pnp.bus_address)
190 char *acpi_device_hid(struct acpi_device *device);
191 #define acpi_device_uid(d) ((d)->pnp.unique_id)
192 #define acpi_device_name(d) ((d)->pnp.device_name)
193 #define acpi_device_class(d) ((d)->pnp.device_class)
195 /* Power Management */
197 struct acpi_device_power_flags {
198 u32 explicit_get:1; /* _PSC present? */
199 u32 power_resources:1; /* Power resources */
200 u32 inrush_current:1; /* Serialize Dx->D0 */
201 u32 power_removed:1; /* Optimize Dx->D0 */
205 struct acpi_device_power_state {
208 u8 explicit_set:1; /* _PSx present? */
211 int power; /* % Power (compared to D0) */
212 int latency; /* Dx->D0 time (microseconds) */
213 struct acpi_handle_list resources; /* Power resources referenced */
216 struct acpi_device_power {
217 int state; /* Current state */
218 struct acpi_device_power_flags flags;
219 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
222 /* Performance Management */
224 struct acpi_device_perf_flags {
228 struct acpi_device_perf_state {
233 u8 power; /* % Power (compared to P0) */
234 u8 performance; /* % Performance ( " ) */
235 int latency; /* Px->P0 time (microseconds) */
238 struct acpi_device_perf {
240 struct acpi_device_perf_flags flags;
242 struct acpi_device_perf_state *states;
245 /* Wakeup Management */
246 struct acpi_device_wakeup_flags {
247 u8 valid:1; /* Can successfully enable wakeup? */
248 u8 run_wake:1; /* Run-Wake GPE devices */
251 struct acpi_device_wakeup_state {
255 struct acpi_device_wakeup {
256 acpi_handle gpe_device;
257 acpi_integer gpe_number;
258 acpi_integer sleep_state;
259 struct acpi_handle_list resources;
260 struct acpi_device_wakeup_state state;
261 struct acpi_device_wakeup_flags flags;
269 acpi_handle handle; /* no handle for fixed hardware */
270 struct acpi_device *parent;
271 struct list_head children;
272 struct list_head node;
273 struct list_head wakeup_list;
274 struct acpi_device_status status;
275 struct acpi_device_flags flags;
276 struct acpi_device_pnp pnp;
277 struct acpi_device_power power;
278 struct acpi_device_wakeup wakeup;
279 struct acpi_device_perf performance;
280 struct acpi_device_dir dir;
281 struct acpi_device_ops ops;
282 struct acpi_driver *driver;
285 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
286 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
289 static inline void *acpi_driver_data(struct acpi_device *d)
291 return d->driver_data;
294 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
295 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
297 /* acpi_device.dev.bus == &acpi_bus_type */
298 extern struct bus_type acpi_bus_type;
305 struct acpi_bus_event {
306 struct list_head node;
307 acpi_device_class device_class;
313 extern struct kobject *acpi_kobj;
314 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
315 void acpi_bus_private_data_handler(acpi_handle, void *);
316 int acpi_bus_get_private_data(acpi_handle, void **);
317 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
318 extern int register_acpi_notifier(struct notifier_block *);
319 extern int unregister_acpi_notifier(struct notifier_block *);
321 extern int register_acpi_bus_notifier(struct notifier_block *nb);
322 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
327 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
328 void acpi_bus_data_handler(acpi_handle handle, void *context);
329 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
330 unsigned long long *sta);
331 int acpi_bus_get_status(struct acpi_device *device);
332 int acpi_bus_get_power(acpi_handle handle, int *state);
333 int acpi_bus_set_power(acpi_handle handle, int state);
334 bool acpi_bus_power_manageable(acpi_handle handle);
335 bool acpi_bus_can_wakeup(acpi_handle handle);
336 #ifdef CONFIG_ACPI_PROC_EVENT
337 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
338 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
339 int acpi_bus_receive_event(struct acpi_bus_event *event);
341 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
344 int acpi_bus_register_driver(struct acpi_driver *driver);
345 void acpi_bus_unregister_driver(struct acpi_driver *driver);
346 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
347 acpi_handle handle, int type);
348 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
349 int acpi_bus_start(struct acpi_device *device);
350 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
351 int acpi_match_device_ids(struct acpi_device *device,
352 const struct acpi_device_id *ids);
353 int acpi_create_dir(struct acpi_device *);
354 void acpi_remove_dir(struct acpi_device *);
357 * Bind physical devices with ACPI devices
359 struct acpi_bus_type {
360 struct list_head list;
361 struct bus_type *bus;
362 /* For general devices under the bus */
363 int (*find_device) (struct device *, acpi_handle *);
364 /* For bridges, such as PCI root bridge, IDE controller */
365 int (*find_bridge) (struct device *, acpi_handle *);
367 int register_acpi_bus_type(struct acpi_bus_type *);
368 int unregister_acpi_bus_type(struct acpi_bus_type *);
369 struct device *acpi_get_physical_device(acpi_handle);
371 struct acpi_pci_root {
372 struct list_head node;
373 struct acpi_device * device;
374 struct acpi_pci_id id;
379 u32 osc_support_set; /* _OSC state of support bits */
380 u32 osc_control_set; /* _OSC state of control bits */
381 u32 osc_control_qry; /* the latest _OSC query result */
383 u32 osc_queried:1; /* has _OSC control been queried? */
387 acpi_handle acpi_get_child(acpi_handle, acpi_integer);
388 int acpi_is_root_bridge(acpi_handle);
389 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
390 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
391 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
393 #ifdef CONFIG_PM_SLEEP
394 int acpi_pm_device_sleep_state(struct device *, int *);
395 int acpi_pm_device_sleep_wake(struct device *, bool);
396 #else /* !CONFIG_PM_SLEEP */
397 static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
401 return ACPI_STATE_D3;
403 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
407 #endif /* !CONFIG_PM_SLEEP */
409 #endif /* CONFIG_ACPI */
411 #endif /*__ACPI_BUS_H__*/