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 /* TBD: Make dynamic */
32 #define ACPI_MAX_HANDLES 10
33 struct acpi_handle_list
{
35 acpi_handle handles
[ACPI_MAX_HANDLES
];
40 acpi_extract_package(union acpi_object
*package
,
41 struct acpi_buffer
*format
, struct acpi_buffer
*buffer
);
43 acpi_evaluate_integer(acpi_handle handle
,
45 struct acpi_object_list
*arguments
, unsigned long long *data
);
47 acpi_evaluate_reference(acpi_handle handle
,
49 struct acpi_object_list
*arguments
,
50 struct acpi_handle_list
*list
);
52 acpi_evaluate_ost(acpi_handle handle
, u32 source_event
, u32 status_code
,
53 struct acpi_buffer
*status_buf
);
56 acpi_get_physical_device_location(acpi_handle handle
, struct acpi_pld_info
**pld
);
58 bool acpi_has_method(acpi_handle handle
, char *name
);
59 acpi_status
acpi_execute_simple_method(acpi_handle handle
, char *method
,
61 acpi_status
acpi_evaluate_ej0(acpi_handle handle
);
62 acpi_status
acpi_evaluate_lck(acpi_handle handle
, int lock
);
63 bool acpi_ata_match(acpi_handle handle
);
64 bool acpi_bay_match(acpi_handle handle
);
65 bool acpi_dock_match(acpi_handle handle
);
67 bool acpi_check_dsm(acpi_handle handle
, const u8
*uuid
, int rev
, u64 funcs
);
68 union acpi_object
*acpi_evaluate_dsm(acpi_handle handle
, const u8
*uuid
,
69 int rev
, int func
, union acpi_object
*argv4
);
71 static inline union acpi_object
*
72 acpi_evaluate_dsm_typed(acpi_handle handle
, const u8
*uuid
, int rev
, int func
,
73 union acpi_object
*argv4
, acpi_object_type type
)
75 union acpi_object
*obj
;
77 obj
= acpi_evaluate_dsm(handle
, uuid
, rev
, func
, argv4
);
78 if (obj
&& obj
->type
!= type
) {
86 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
88 .package.type = ACPI_TYPE_PACKAGE, \
89 .package.count = (cnt), \
90 .package.elements = (eles) \
95 #include <linux/proc_fs.h>
97 #define ACPI_BUS_FILE_ROOT "acpi"
98 extern struct proc_dir_entry
*acpi_root_dir
;
100 enum acpi_bus_device_type
{
101 ACPI_BUS_TYPE_DEVICE
= 0,
103 ACPI_BUS_TYPE_PROCESSOR
,
104 ACPI_BUS_TYPE_THERMAL
,
105 ACPI_BUS_TYPE_POWER_BUTTON
,
106 ACPI_BUS_TYPE_SLEEP_BUTTON
,
107 ACPI_BUS_DEVICE_TYPE_COUNT
118 struct acpi_hotplug_profile
{
120 int (*scan_dependent
)(struct acpi_device
*adev
);
122 bool demand_offline
:1;
125 static inline struct acpi_hotplug_profile
*to_acpi_hotplug_profile(
126 struct kobject
*kobj
)
128 return container_of(kobj
, struct acpi_hotplug_profile
, kobj
);
131 struct acpi_scan_handler
{
132 const struct acpi_device_id
*ids
;
133 struct list_head list_node
;
134 bool (*match
)(char *idstr
, const struct acpi_device_id
**matchid
);
135 int (*attach
)(struct acpi_device
*dev
, const struct acpi_device_id
*id
);
136 void (*detach
)(struct acpi_device
*dev
);
137 void (*bind
)(struct device
*phys_dev
);
138 void (*unbind
)(struct device
*phys_dev
);
139 struct acpi_hotplug_profile hotplug
;
143 * ACPI Hotplug Context
144 * --------------------
147 struct acpi_hotplug_context
{
148 struct acpi_device
*self
;
149 int (*notify
)(struct acpi_device
*, u32
);
150 void (*uevent
)(struct acpi_device
*, u32
);
151 void (*fixup
)(struct acpi_device
*);
159 typedef int (*acpi_op_add
) (struct acpi_device
* device
);
160 typedef int (*acpi_op_remove
) (struct acpi_device
* device
);
161 typedef void (*acpi_op_notify
) (struct acpi_device
* device
, u32 event
);
163 struct acpi_device_ops
{
165 acpi_op_remove remove
;
166 acpi_op_notify notify
;
169 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
174 const struct acpi_device_id
*ids
; /* Supported Hardware IDs */
176 struct acpi_device_ops ops
;
177 struct device_driver drv
;
178 struct module
*owner
;
188 struct acpi_device_status
{
193 u32 battery_present
:1;
199 struct acpi_device_flags
{
200 u32 dynamic_status
:1;
203 u32 power_manageable
:1;
208 u32 hotplug_notify
:1;
209 u32 is_dock_station
:1;
215 struct acpi_device_dir
{
216 struct proc_dir_entry
*entry
;
219 #define acpi_device_dir(d) ((d)->dir.entry)
223 typedef char acpi_bus_id
[8];
224 typedef unsigned long acpi_bus_address
;
225 typedef char acpi_device_name
[40];
226 typedef char acpi_device_class
[20];
228 struct acpi_hardware_id
{
229 struct list_head list
;
233 struct acpi_pnp_type
{
240 struct acpi_device_pnp
{
241 acpi_bus_id bus_id
; /* Object name */
242 struct acpi_pnp_type type
; /* ID type */
243 acpi_bus_address bus_address
; /* _ADR */
244 char *unique_id
; /* _UID */
245 struct list_head ids
; /* _HID and _CIDs */
246 acpi_device_name device_name
; /* Driver-determined */
247 acpi_device_class device_class
; /* " */
248 union acpi_object
*str_obj
; /* unicode string for _STR method */
249 unsigned long sun
; /* _SUN */
252 #define acpi_device_bid(d) ((d)->pnp.bus_id)
253 #define acpi_device_adr(d) ((d)->pnp.bus_address)
254 const char *acpi_device_hid(struct acpi_device
*device
);
255 #define acpi_device_name(d) ((d)->pnp.device_name)
256 #define acpi_device_class(d) ((d)->pnp.device_class)
258 /* Power Management */
260 struct acpi_device_power_flags
{
261 u32 explicit_get
:1; /* _PSC present? */
262 u32 power_resources
:1; /* Power resources */
263 u32 inrush_current
:1; /* Serialize Dx->D0 */
264 u32 power_removed
:1; /* Optimize Dx->D0 */
265 u32 ignore_parent
:1; /* Power is independent of parent power state */
266 u32 dsw_present
:1; /* _DSW present? */
270 struct acpi_device_power_state
{
274 u8 explicit_set
:1; /* _PSx present? */
277 int power
; /* % Power (compared to D0) */
278 int latency
; /* Dx->D0 time (microseconds) */
279 struct list_head resources
; /* Power resources referenced */
282 struct acpi_device_power
{
283 int state
; /* Current state */
284 struct acpi_device_power_flags flags
;
285 struct acpi_device_power_state states
[ACPI_D_STATE_COUNT
]; /* Power states (D0-D3Cold) */
288 /* Performance Management */
290 struct acpi_device_perf_flags
{
294 struct acpi_device_perf_state
{
299 u8 power
; /* % Power (compared to P0) */
300 u8 performance
; /* % Performance ( " ) */
301 int latency
; /* Px->P0 time (microseconds) */
304 struct acpi_device_perf
{
306 struct acpi_device_perf_flags flags
;
308 struct acpi_device_perf_state
*states
;
311 /* Wakeup Management */
312 struct acpi_device_wakeup_flags
{
313 u8 valid
:1; /* Can successfully enable wakeup? */
314 u8 run_wake
:1; /* Run-Wake GPE devices */
315 u8 notifier_present
:1; /* Wake-up notify handler has been installed */
318 struct acpi_device_wakeup
{
319 acpi_handle gpe_device
;
322 struct list_head resources
;
323 struct acpi_device_wakeup_flags flags
;
327 struct acpi_device_physical_node
{
328 unsigned int node_id
;
329 struct list_head node
;
337 acpi_handle handle
; /* no handle for fixed hardware */
338 struct acpi_device
*parent
;
339 struct list_head children
;
340 struct list_head node
;
341 struct list_head wakeup_list
;
342 struct list_head del_list
;
343 struct acpi_device_status status
;
344 struct acpi_device_flags flags
;
345 struct acpi_device_pnp pnp
;
346 struct acpi_device_power power
;
347 struct acpi_device_wakeup wakeup
;
348 struct acpi_device_perf performance
;
349 struct acpi_device_dir dir
;
350 struct acpi_scan_handler
*handler
;
351 struct acpi_hotplug_context
*hp
;
352 struct acpi_driver
*driver
;
355 unsigned int physical_node_count
;
356 struct list_head physical_node_list
;
357 struct mutex physical_node_lock
;
358 void (*remove
)(struct acpi_device
*);
361 static inline void *acpi_driver_data(struct acpi_device
*d
)
363 return d
->driver_data
;
366 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
367 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
369 static inline void acpi_set_device_status(struct acpi_device
*adev
, u32 sta
)
371 *((u32
*)&adev
->status
) = sta
;
374 static inline void acpi_set_hp_context(struct acpi_device
*adev
,
375 struct acpi_hotplug_context
*hp
,
376 int (*notify
)(struct acpi_device
*, u32
),
377 void (*uevent
)(struct acpi_device
*, u32
),
378 void (*fixup
)(struct acpi_device
*))
387 void acpi_initialize_hp_context(struct acpi_device
*adev
,
388 struct acpi_hotplug_context
*hp
,
389 int (*notify
)(struct acpi_device
*, u32
),
390 void (*uevent
)(struct acpi_device
*, u32
));
392 /* acpi_device.dev.bus == &acpi_bus_type */
393 extern struct bus_type acpi_bus_type
;
400 struct acpi_bus_event
{
401 struct list_head node
;
402 acpi_device_class device_class
;
408 extern struct kobject
*acpi_kobj
;
409 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8
, int);
410 void acpi_bus_private_data_handler(acpi_handle
, void *);
411 int acpi_bus_get_private_data(acpi_handle
, void **);
412 int acpi_bus_attach_private_data(acpi_handle
, void *);
413 void acpi_bus_detach_private_data(acpi_handle
);
414 void acpi_bus_no_hotplug(acpi_handle handle
);
415 extern int acpi_notifier_call_chain(struct acpi_device
*, u32
, u32
);
416 extern int register_acpi_notifier(struct notifier_block
*);
417 extern int unregister_acpi_notifier(struct notifier_block
*);
423 int acpi_bus_get_device(acpi_handle handle
, struct acpi_device
**device
);
424 struct acpi_device
*acpi_bus_get_acpi_device(acpi_handle handle
);
425 void acpi_bus_put_acpi_device(struct acpi_device
*adev
);
426 acpi_status
acpi_bus_get_status_handle(acpi_handle handle
,
427 unsigned long long *sta
);
428 int acpi_bus_get_status(struct acpi_device
*device
);
430 int acpi_bus_set_power(acpi_handle handle
, int state
);
431 const char *acpi_power_state_string(int state
);
432 int acpi_device_get_power(struct acpi_device
*device
, int *state
);
433 int acpi_device_set_power(struct acpi_device
*device
, int state
);
434 int acpi_bus_init_power(struct acpi_device
*device
);
435 int acpi_device_fix_up_power(struct acpi_device
*device
);
436 int acpi_bus_update_power(acpi_handle handle
, int *state_p
);
437 bool acpi_bus_power_manageable(acpi_handle handle
);
440 bool acpi_bus_can_wakeup(acpi_handle handle
);
442 static inline bool acpi_bus_can_wakeup(acpi_handle handle
) { return false; }
445 void acpi_scan_lock_acquire(void);
446 void acpi_scan_lock_release(void);
447 void acpi_lock_hp_context(void);
448 void acpi_unlock_hp_context(void);
449 int acpi_scan_add_handler(struct acpi_scan_handler
*handler
);
450 int acpi_bus_register_driver(struct acpi_driver
*driver
);
451 void acpi_bus_unregister_driver(struct acpi_driver
*driver
);
452 int acpi_bus_scan(acpi_handle handle
);
453 void acpi_bus_trim(struct acpi_device
*start
);
454 acpi_status
acpi_bus_get_ejd(acpi_handle handle
, acpi_handle
* ejd
);
455 int acpi_match_device_ids(struct acpi_device
*device
,
456 const struct acpi_device_id
*ids
);
457 int acpi_create_dir(struct acpi_device
*);
458 void acpi_remove_dir(struct acpi_device
*);
460 static inline bool acpi_device_enumerated(struct acpi_device
*adev
)
462 return adev
&& adev
->flags
.initialized
&& adev
->flags
.visited
;
466 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
467 * @__acpi_driver: acpi_driver struct
469 * Helper macro for ACPI drivers which do not do anything special in module
470 * init/exit. This eliminates a lot of boilerplate. Each module may only
471 * use this macro once, and calling it replaces module_init() and module_exit()
473 #define module_acpi_driver(__acpi_driver) \
474 module_driver(__acpi_driver, acpi_bus_register_driver, \
475 acpi_bus_unregister_driver)
478 * Bind physical devices with ACPI devices
480 struct acpi_bus_type
{
481 struct list_head list
;
483 bool (*match
)(struct device
*dev
);
484 struct acpi_device
* (*find_companion
)(struct device
*);
485 void (*setup
)(struct device
*);
486 void (*cleanup
)(struct device
*);
488 int register_acpi_bus_type(struct acpi_bus_type
*);
489 int unregister_acpi_bus_type(struct acpi_bus_type
*);
491 struct acpi_pci_root
{
492 struct acpi_device
* device
;
495 struct resource secondary
; /* downstream bus range */
497 u32 osc_support_set
; /* _OSC state of support bits */
498 u32 osc_control_set
; /* _OSC state of control bits */
499 phys_addr_t mcfg_addr
;
504 struct acpi_device
*acpi_find_child_device(struct acpi_device
*parent
,
505 u64 address
, bool check_children
);
506 int acpi_is_root_bridge(acpi_handle
);
507 struct acpi_pci_root
*acpi_pci_find_root(acpi_handle handle
);
509 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int state
);
510 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
);
513 acpi_status
acpi_add_pm_notifier(struct acpi_device
*adev
,
514 acpi_notify_handler handler
, void *context
);
515 acpi_status
acpi_remove_pm_notifier(struct acpi_device
*adev
,
516 acpi_notify_handler handler
);
517 int acpi_pm_device_sleep_state(struct device
*, int *, int);
519 static inline acpi_status
acpi_add_pm_notifier(struct acpi_device
*adev
,
520 acpi_notify_handler handler
,
525 static inline acpi_status
acpi_remove_pm_notifier(struct acpi_device
*adev
,
526 acpi_notify_handler handler
)
530 static inline int acpi_pm_device_sleep_state(struct device
*d
, int *p
, int m
)
535 return (m
>= ACPI_STATE_D0
&& m
<= ACPI_STATE_D3_COLD
) ?
540 #ifdef CONFIG_PM_RUNTIME
541 int __acpi_device_run_wake(struct acpi_device
*, bool);
542 int acpi_pm_device_run_wake(struct device
*, bool);
544 static inline int __acpi_device_run_wake(struct acpi_device
*adev
, bool en
)
548 static inline int acpi_pm_device_run_wake(struct device
*dev
, bool enable
)
554 #ifdef CONFIG_PM_SLEEP
555 int __acpi_device_sleep_wake(struct acpi_device
*, u32
, bool);
556 int acpi_pm_device_sleep_wake(struct device
*, bool);
558 static inline int __acpi_device_sleep_wake(struct acpi_device
*adev
,
559 u32 target_state
, bool enable
)
563 static inline int acpi_pm_device_sleep_wake(struct device
*dev
, bool enable
)
569 #ifdef CONFIG_ACPI_SLEEP
570 u32
acpi_target_system_state(void);
572 static inline u32
acpi_target_system_state(void) { return ACPI_STATE_S0
; }
575 static inline bool acpi_device_power_manageable(struct acpi_device
*adev
)
577 return adev
->flags
.power_manageable
;
580 static inline bool acpi_device_can_wakeup(struct acpi_device
*adev
)
582 return adev
->wakeup
.flags
.valid
;
585 static inline bool acpi_device_can_poweroff(struct acpi_device
*adev
)
587 return adev
->power
.states
[ACPI_STATE_D3_COLD
].flags
.os_accessible
;
590 #else /* CONFIG_ACPI */
592 static inline int register_acpi_bus_type(void *bus
) { return 0; }
593 static inline int unregister_acpi_bus_type(void *bus
) { return 0; }
595 #endif /* CONFIG_ACPI */
597 #endif /*__ACPI_BUS_H__*/