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);
54 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
55 u32 status_code, struct acpi_buffer *status_buf);
58 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
61 #include <linux/proc_fs.h>
63 #define ACPI_BUS_FILE_ROOT "acpi"
64 extern struct proc_dir_entry *acpi_root_dir;
66 enum acpi_bus_removal_type {
67 ACPI_BUS_REMOVAL_NORMAL = 0,
68 ACPI_BUS_REMOVAL_EJECT,
69 ACPI_BUS_REMOVAL_SUPRISE,
70 ACPI_BUS_REMOVAL_TYPE_COUNT
73 enum acpi_bus_device_type {
74 ACPI_BUS_TYPE_DEVICE = 0,
76 ACPI_BUS_TYPE_PROCESSOR,
77 ACPI_BUS_TYPE_THERMAL,
78 ACPI_BUS_TYPE_POWER_BUTTON,
79 ACPI_BUS_TYPE_SLEEP_BUTTON,
80 ACPI_BUS_DEVICE_TYPE_COUNT
91 typedef int (*acpi_op_add) (struct acpi_device * device);
92 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
93 typedef int (*acpi_op_start) (struct acpi_device * device);
94 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
96 struct acpi_device_ops {
98 acpi_op_remove remove;
100 acpi_op_notify notify;
103 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
108 const struct acpi_device_id *ids; /* Supported Hardware IDs */
110 struct acpi_device_ops ops;
111 struct device_driver drv;
112 struct module *owner;
122 struct acpi_device_status {
127 u32 battery_present:1;
133 struct acpi_device_flags {
134 u32 dynamic_status:1;
138 u32 suprise_removal_ok:1;
139 u32 power_manageable:1;
140 u32 performance_manageable:1;
148 struct acpi_device_dir {
149 struct proc_dir_entry *entry;
152 #define acpi_device_dir(d) ((d)->dir.entry)
156 typedef char acpi_bus_id[8];
157 typedef unsigned long acpi_bus_address;
158 typedef char acpi_device_name[40];
159 typedef char acpi_device_class[20];
161 struct acpi_hardware_id {
162 struct list_head list;
166 struct acpi_device_pnp {
167 acpi_bus_id bus_id; /* Object name */
168 acpi_bus_address bus_address; /* _ADR */
169 char *unique_id; /* _UID */
170 struct list_head ids; /* _HID and _CIDs */
171 acpi_device_name device_name; /* Driver-determined */
172 acpi_device_class device_class; /* " */
173 union acpi_object *str_obj; /* unicode string for _STR method */
174 unsigned long sun; /* _SUN */
177 #define acpi_device_bid(d) ((d)->pnp.bus_id)
178 #define acpi_device_adr(d) ((d)->pnp.bus_address)
179 const char *acpi_device_hid(struct acpi_device *device);
180 #define acpi_device_name(d) ((d)->pnp.device_name)
181 #define acpi_device_class(d) ((d)->pnp.device_class)
183 /* Power Management */
185 struct acpi_device_power_flags {
186 u32 explicit_get:1; /* _PSC present? */
187 u32 power_resources:1; /* Power resources */
188 u32 inrush_current:1; /* Serialize Dx->D0 */
189 u32 power_removed:1; /* Optimize Dx->D0 */
193 struct acpi_device_power_state {
197 u8 explicit_set:1; /* _PSx present? */
200 int power; /* % Power (compared to D0) */
201 int latency; /* Dx->D0 time (microseconds) */
202 struct acpi_handle_list resources; /* Power resources referenced */
205 struct acpi_device_power {
206 int state; /* Current state */
207 struct acpi_device_power_flags flags;
208 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
211 /* Performance Management */
213 struct acpi_device_perf_flags {
217 struct acpi_device_perf_state {
222 u8 power; /* % Power (compared to P0) */
223 u8 performance; /* % Performance ( " ) */
224 int latency; /* Px->P0 time (microseconds) */
227 struct acpi_device_perf {
229 struct acpi_device_perf_flags flags;
231 struct acpi_device_perf_state *states;
234 /* Wakeup Management */
235 struct acpi_device_wakeup_flags {
236 u8 valid:1; /* Can successfully enable wakeup? */
237 u8 run_wake:1; /* Run-Wake GPE devices */
238 u8 notifier_present:1; /* Wake-up notify handler has been installed */
241 struct acpi_device_wakeup {
242 acpi_handle gpe_device;
245 struct acpi_handle_list resources;
246 struct acpi_device_wakeup_flags flags;
250 struct acpi_device_physical_node {
252 struct list_head node;
256 /* set maximum of physical nodes to 32 for expansibility */
257 #define ACPI_MAX_PHYSICAL_NODE 32
262 acpi_handle handle; /* no handle for fixed hardware */
263 struct acpi_device *parent;
264 struct list_head children;
265 struct list_head node;
266 struct list_head wakeup_list;
267 struct acpi_device_status status;
268 struct acpi_device_flags flags;
269 struct acpi_device_pnp pnp;
270 struct acpi_device_power power;
271 struct acpi_device_wakeup wakeup;
272 struct acpi_device_perf performance;
273 struct acpi_device_dir dir;
274 struct acpi_driver *driver;
277 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
278 u8 physical_node_count;
279 struct list_head physical_node_list;
280 struct mutex physical_node_lock;
281 DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
284 static inline void *acpi_driver_data(struct acpi_device *d)
286 return d->driver_data;
289 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
290 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
292 /* acpi_device.dev.bus == &acpi_bus_type */
293 extern struct bus_type acpi_bus_type;
300 struct acpi_bus_event {
301 struct list_head node;
302 acpi_device_class device_class;
308 struct acpi_eject_event {
309 struct acpi_device *device;
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_set_power(acpi_handle handle, int state);
333 int acpi_device_set_power(struct acpi_device *device, int state);
334 int acpi_bus_update_power(acpi_handle handle, int *state_p);
335 bool acpi_bus_power_manageable(acpi_handle handle);
336 bool acpi_bus_can_wakeup(acpi_handle handle);
337 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
338 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
339 #ifdef CONFIG_ACPI_PROC_EVENT
340 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
341 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
342 int acpi_bus_receive_event(struct acpi_bus_event *event);
344 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
347 int acpi_bus_register_driver(struct acpi_driver *driver);
348 void acpi_bus_unregister_driver(struct acpi_driver *driver);
349 int acpi_bus_scan(acpi_handle handle);
350 void acpi_bus_hot_remove_device(void *context);
351 void acpi_bus_trim(struct acpi_device *start);
352 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
353 int acpi_match_device_ids(struct acpi_device *device,
354 const struct acpi_device_id *ids);
355 int acpi_create_dir(struct acpi_device *);
356 void acpi_remove_dir(struct acpi_device *);
360 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
361 * @__acpi_driver: acpi_driver struct
363 * Helper macro for ACPI drivers which do not do anything special in module
364 * init/exit. This eliminates a lot of boilerplate. Each module may only
365 * use this macro once, and calling it replaces module_init() and module_exit()
367 #define module_acpi_driver(__acpi_driver) \
368 module_driver(__acpi_driver, acpi_bus_register_driver, \
369 acpi_bus_unregister_driver)
372 * Bind physical devices with ACPI devices
374 struct acpi_bus_type {
375 struct list_head list;
376 struct bus_type *bus;
377 /* For general devices under the bus */
378 int (*find_device) (struct device *, acpi_handle *);
379 /* For bridges, such as PCI root bridge, IDE controller */
380 int (*find_bridge) (struct device *, acpi_handle *);
381 void (*setup)(struct device *);
382 void (*cleanup)(struct device *);
384 int register_acpi_bus_type(struct acpi_bus_type *);
385 int unregister_acpi_bus_type(struct acpi_bus_type *);
387 struct acpi_pci_root {
388 struct list_head node;
389 struct acpi_device * device;
392 struct resource secondary; /* downstream bus range */
394 u32 osc_support_set; /* _OSC state of support bits */
395 u32 osc_control_set; /* _OSC state of control bits */
396 phys_addr_t mcfg_addr;
400 acpi_handle acpi_get_child(acpi_handle, u64);
401 int acpi_is_root_bridge(acpi_handle);
402 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
403 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
404 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))
406 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
407 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
410 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
411 acpi_notify_handler handler, void *context);
412 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
413 acpi_notify_handler handler);
414 int acpi_device_power_state(struct device *dev, struct acpi_device *adev,
415 u32 target_state, int d_max_in, int *d_min_p);
416 int acpi_pm_device_sleep_state(struct device *, int *, int);
418 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
419 acpi_notify_handler handler,
424 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
425 acpi_notify_handler handler)
429 static inline int __acpi_device_power_state(int m, int *p)
433 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
435 static inline int acpi_device_power_state(struct device *dev,
436 struct acpi_device *adev,
437 u32 target_state, int d_max_in,
440 return __acpi_device_power_state(d_max_in, d_min_p);
442 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
444 return __acpi_device_power_state(m, p);
448 #ifdef CONFIG_PM_RUNTIME
449 int __acpi_device_run_wake(struct acpi_device *, bool);
450 int acpi_pm_device_run_wake(struct device *, bool);
452 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
456 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
462 #ifdef CONFIG_PM_SLEEP
463 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
464 int acpi_pm_device_sleep_wake(struct device *, bool);
466 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
467 u32 target_state, bool enable)
471 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
477 #ifdef CONFIG_ACPI_SLEEP
478 u32 acpi_target_system_state(void);
480 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
483 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
485 return adev->flags.power_manageable;
488 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
490 return adev->wakeup.flags.valid;
493 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
495 return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
498 #else /* CONFIG_ACPI */
500 static inline int register_acpi_bus_type(void *bus) { return 0; }
501 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
503 #endif /* CONFIG_ACPI */
505 #endif /*__ACPI_BUS_H__*/