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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 #ifndef __ACPI_BUS_H__
23 #define __ACPI_BUS_H__
25 #include <linux/device.h>
26 #include <linux/property.h>
28 /* TBD: Make dynamic */
29 #define ACPI_MAX_HANDLES 10
30 struct acpi_handle_list
{
32 acpi_handle handles
[ACPI_MAX_HANDLES
];
37 acpi_extract_package(union acpi_object
*package
,
38 struct acpi_buffer
*format
, struct acpi_buffer
*buffer
);
40 acpi_evaluate_integer(acpi_handle handle
,
42 struct acpi_object_list
*arguments
, unsigned long long *data
);
44 acpi_evaluate_reference(acpi_handle handle
,
46 struct acpi_object_list
*arguments
,
47 struct acpi_handle_list
*list
);
49 acpi_evaluate_ost(acpi_handle handle
, u32 source_event
, u32 status_code
,
50 struct acpi_buffer
*status_buf
);
53 acpi_get_physical_device_location(acpi_handle handle
, struct acpi_pld_info
**pld
);
55 bool acpi_has_method(acpi_handle handle
, char *name
);
56 acpi_status
acpi_execute_simple_method(acpi_handle handle
, char *method
,
58 acpi_status
acpi_evaluate_ej0(acpi_handle handle
);
59 acpi_status
acpi_evaluate_lck(acpi_handle handle
, int lock
);
60 bool acpi_ata_match(acpi_handle handle
);
61 bool acpi_bay_match(acpi_handle handle
);
62 bool acpi_dock_match(acpi_handle handle
);
64 bool acpi_check_dsm(acpi_handle handle
, const guid_t
*guid
, u64 rev
, u64 funcs
);
65 union acpi_object
*acpi_evaluate_dsm(acpi_handle handle
, const guid_t
*guid
,
66 u64 rev
, u64 func
, union acpi_object
*argv4
);
68 static inline union acpi_object
*
69 acpi_evaluate_dsm_typed(acpi_handle handle
, const guid_t
*guid
, u64 rev
,
70 u64 func
, union acpi_object
*argv4
,
71 acpi_object_type type
)
73 union acpi_object
*obj
;
75 obj
= acpi_evaluate_dsm(handle
, guid
, rev
, func
, argv4
);
76 if (obj
&& obj
->type
!= type
) {
84 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
86 .package.type = ACPI_TYPE_PACKAGE, \
87 .package.count = (cnt), \
88 .package.elements = (eles) \
91 bool acpi_dev_found(const char *hid
);
92 bool acpi_dev_present(const char *hid
, const char *uid
, s64 hrv
);
96 #include <linux/proc_fs.h>
98 #define ACPI_BUS_FILE_ROOT "acpi"
99 extern struct proc_dir_entry
*acpi_root_dir
;
101 enum acpi_bus_device_type
{
102 ACPI_BUS_TYPE_DEVICE
= 0,
104 ACPI_BUS_TYPE_PROCESSOR
,
105 ACPI_BUS_TYPE_THERMAL
,
106 ACPI_BUS_TYPE_POWER_BUTTON
,
107 ACPI_BUS_TYPE_SLEEP_BUTTON
,
108 ACPI_BUS_TYPE_ECDT_EC
,
109 ACPI_BUS_DEVICE_TYPE_COUNT
120 struct acpi_hotplug_profile
{
122 int (*scan_dependent
)(struct acpi_device
*adev
);
123 void (*notify_online
)(struct acpi_device
*adev
);
125 bool demand_offline
:1;
128 static inline struct acpi_hotplug_profile
*to_acpi_hotplug_profile(
129 struct kobject
*kobj
)
131 return container_of(kobj
, struct acpi_hotplug_profile
, kobj
);
134 struct acpi_scan_handler
{
135 const struct acpi_device_id
*ids
;
136 struct list_head list_node
;
137 bool (*match
)(const char *idstr
, const struct acpi_device_id
**matchid
);
138 int (*attach
)(struct acpi_device
*dev
, const struct acpi_device_id
*id
);
139 void (*detach
)(struct acpi_device
*dev
);
140 void (*bind
)(struct device
*phys_dev
);
141 void (*unbind
)(struct device
*phys_dev
);
142 struct acpi_hotplug_profile hotplug
;
146 * ACPI Hotplug Context
147 * --------------------
150 struct acpi_hotplug_context
{
151 struct acpi_device
*self
;
152 int (*notify
)(struct acpi_device
*, u32
);
153 void (*uevent
)(struct acpi_device
*, u32
);
154 void (*fixup
)(struct acpi_device
*);
162 typedef int (*acpi_op_add
) (struct acpi_device
* device
);
163 typedef int (*acpi_op_remove
) (struct acpi_device
* device
);
164 typedef void (*acpi_op_notify
) (struct acpi_device
* device
, u32 event
);
166 struct acpi_device_ops
{
168 acpi_op_remove remove
;
169 acpi_op_notify notify
;
172 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
177 const struct acpi_device_id
*ids
; /* Supported Hardware IDs */
179 struct acpi_device_ops ops
;
180 struct device_driver drv
;
181 struct module
*owner
;
191 struct acpi_device_status
{
196 u32 battery_present
:1;
202 struct acpi_device_flags
{
203 u32 dynamic_status
:1;
206 u32 power_manageable
:1;
210 u32 hotplug_notify
:1;
211 u32 is_dock_station
:1;
212 u32 of_compatible_ok
:1;
215 u32 enumeration_by_parent
:1;
221 struct acpi_device_dir
{
222 struct proc_dir_entry
*entry
;
225 #define acpi_device_dir(d) ((d)->dir.entry)
229 typedef char acpi_bus_id
[8];
230 typedef unsigned long acpi_bus_address
;
231 typedef char acpi_device_name
[40];
232 typedef char acpi_device_class
[20];
234 struct acpi_hardware_id
{
235 struct list_head list
;
239 struct acpi_pnp_type
{
246 struct acpi_device_pnp
{
247 acpi_bus_id bus_id
; /* Object name */
248 struct acpi_pnp_type type
; /* ID type */
249 acpi_bus_address bus_address
; /* _ADR */
250 char *unique_id
; /* _UID */
251 struct list_head ids
; /* _HID and _CIDs */
252 acpi_device_name device_name
; /* Driver-determined */
253 acpi_device_class device_class
; /* " */
254 union acpi_object
*str_obj
; /* unicode string for _STR method */
257 #define acpi_device_bid(d) ((d)->pnp.bus_id)
258 #define acpi_device_adr(d) ((d)->pnp.bus_address)
259 const char *acpi_device_hid(struct acpi_device
*device
);
260 #define acpi_device_uid(d) ((d)->pnp.unique_id)
261 #define acpi_device_name(d) ((d)->pnp.device_name)
262 #define acpi_device_class(d) ((d)->pnp.device_class)
264 /* Power Management */
266 struct acpi_device_power_flags
{
267 u32 explicit_get
:1; /* _PSC present? */
268 u32 power_resources
:1; /* Power resources */
269 u32 inrush_current
:1; /* Serialize Dx->D0 */
270 u32 power_removed
:1; /* Optimize Dx->D0 */
271 u32 ignore_parent
:1; /* Power is independent of parent power state */
272 u32 dsw_present
:1; /* _DSW present? */
276 struct acpi_device_power_state
{
279 u8 explicit_set
:1; /* _PSx present? */
282 int power
; /* % Power (compared to D0) */
283 int latency
; /* Dx->D0 time (microseconds) */
284 struct list_head resources
; /* Power resources referenced */
287 struct acpi_device_power
{
288 int state
; /* Current state */
289 struct acpi_device_power_flags flags
;
290 struct acpi_device_power_state states
[ACPI_D_STATE_COUNT
]; /* Power states (D0-D3Cold) */
293 /* Performance Management */
295 struct acpi_device_perf_flags
{
299 struct acpi_device_perf_state
{
304 u8 power
; /* % Power (compared to P0) */
305 u8 performance
; /* % Performance ( " ) */
306 int latency
; /* Px->P0 time (microseconds) */
309 struct acpi_device_perf
{
311 struct acpi_device_perf_flags flags
;
313 struct acpi_device_perf_state
*states
;
316 /* Wakeup Management */
317 struct acpi_device_wakeup_flags
{
318 u8 valid
:1; /* Can successfully enable wakeup? */
319 u8 notifier_present
:1; /* Wake-up notify handler has been installed */
322 struct acpi_device_wakeup_context
{
323 void (*func
)(struct acpi_device_wakeup_context
*context
);
327 struct acpi_device_wakeup
{
328 acpi_handle gpe_device
;
331 struct list_head resources
;
332 struct acpi_device_wakeup_flags flags
;
333 struct acpi_device_wakeup_context context
;
334 struct wakeup_source
*ws
;
339 struct acpi_device_physical_node
{
340 unsigned int node_id
;
341 struct list_head node
;
346 struct acpi_device_properties
{
348 const union acpi_object
*properties
;
349 struct list_head list
;
352 /* ACPI Device Specific Data (_DSD) */
353 struct acpi_device_data
{
354 const union acpi_object
*pointer
;
355 struct list_head properties
;
356 const union acpi_object
*of_compatible
;
357 struct list_head subnodes
;
360 struct acpi_gpio_mapping
;
365 acpi_handle handle
; /* no handle for fixed hardware */
366 struct fwnode_handle fwnode
;
367 struct acpi_device
*parent
;
368 struct list_head children
;
369 struct list_head node
;
370 struct list_head wakeup_list
;
371 struct list_head del_list
;
372 struct acpi_device_status status
;
373 struct acpi_device_flags flags
;
374 struct acpi_device_pnp pnp
;
375 struct acpi_device_power power
;
376 struct acpi_device_wakeup wakeup
;
377 struct acpi_device_perf performance
;
378 struct acpi_device_dir dir
;
379 struct acpi_device_data data
;
380 struct acpi_scan_handler
*handler
;
381 struct acpi_hotplug_context
*hp
;
382 struct acpi_driver
*driver
;
383 const struct acpi_gpio_mapping
*driver_gpios
;
386 unsigned int physical_node_count
;
387 unsigned int dep_unmet
;
388 struct list_head physical_node_list
;
389 struct mutex physical_node_lock
;
390 void (*remove
)(struct acpi_device
*);
393 /* Non-device subnode */
394 struct acpi_data_node
{
397 struct fwnode_handle fwnode
;
398 struct fwnode_handle
*parent
;
399 struct acpi_device_data data
;
400 struct list_head sibling
;
402 struct completion kobj_done
;
405 extern const struct fwnode_operations acpi_device_fwnode_ops
;
406 extern const struct fwnode_operations acpi_data_fwnode_ops
;
407 extern const struct fwnode_operations acpi_static_fwnode_ops
;
409 bool is_acpi_device_node(const struct fwnode_handle
*fwnode
);
410 bool is_acpi_data_node(const struct fwnode_handle
*fwnode
);
412 static inline bool is_acpi_node(const struct fwnode_handle
*fwnode
)
414 return (is_acpi_device_node(fwnode
) || is_acpi_data_node(fwnode
));
417 #define to_acpi_device_node(__fwnode) \
419 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
421 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
422 container_of(__to_acpi_device_node_fwnode, \
423 struct acpi_device, fwnode) : \
427 #define to_acpi_data_node(__fwnode) \
429 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
431 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
432 container_of(__to_acpi_data_node_fwnode, \
433 struct acpi_data_node, fwnode) : \
437 static inline bool is_acpi_static_node(const struct fwnode_handle
*fwnode
)
439 return !IS_ERR_OR_NULL(fwnode
) &&
440 fwnode
->ops
== &acpi_static_fwnode_ops
;
443 static inline bool acpi_data_node_match(const struct fwnode_handle
*fwnode
,
446 return is_acpi_data_node(fwnode
) ?
447 (!strcmp(to_acpi_data_node(fwnode
)->name
, name
)) : false;
450 static inline struct fwnode_handle
*acpi_fwnode_handle(struct acpi_device
*adev
)
452 return &adev
->fwnode
;
455 static inline void *acpi_driver_data(struct acpi_device
*d
)
457 return d
->driver_data
;
460 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
461 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
463 static inline void acpi_set_device_status(struct acpi_device
*adev
, u32 sta
)
465 *((u32
*)&adev
->status
) = sta
;
468 static inline void acpi_set_hp_context(struct acpi_device
*adev
,
469 struct acpi_hotplug_context
*hp
)
475 void acpi_initialize_hp_context(struct acpi_device
*adev
,
476 struct acpi_hotplug_context
*hp
,
477 int (*notify
)(struct acpi_device
*, u32
),
478 void (*uevent
)(struct acpi_device
*, u32
));
480 /* acpi_device.dev.bus == &acpi_bus_type */
481 extern struct bus_type acpi_bus_type
;
488 struct acpi_bus_event
{
489 struct list_head node
;
490 acpi_device_class device_class
;
496 extern struct kobject
*acpi_kobj
;
497 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8
, int);
498 void acpi_bus_private_data_handler(acpi_handle
, void *);
499 int acpi_bus_get_private_data(acpi_handle
, void **);
500 int acpi_bus_attach_private_data(acpi_handle
, void *);
501 void acpi_bus_detach_private_data(acpi_handle
);
502 extern int acpi_notifier_call_chain(struct acpi_device
*, u32
, u32
);
503 extern int register_acpi_notifier(struct notifier_block
*);
504 extern int unregister_acpi_notifier(struct notifier_block
*);
510 int acpi_bus_get_device(acpi_handle handle
, struct acpi_device
**device
);
511 struct acpi_device
*acpi_bus_get_acpi_device(acpi_handle handle
);
512 void acpi_bus_put_acpi_device(struct acpi_device
*adev
);
513 acpi_status
acpi_bus_get_status_handle(acpi_handle handle
,
514 unsigned long long *sta
);
515 int acpi_bus_get_status(struct acpi_device
*device
);
517 int acpi_bus_set_power(acpi_handle handle
, int state
);
518 const char *acpi_power_state_string(int state
);
519 int acpi_device_get_power(struct acpi_device
*device
, int *state
);
520 int acpi_device_set_power(struct acpi_device
*device
, int state
);
521 int acpi_bus_init_power(struct acpi_device
*device
);
522 int acpi_device_fix_up_power(struct acpi_device
*device
);
523 int acpi_bus_update_power(acpi_handle handle
, int *state_p
);
524 int acpi_device_update_power(struct acpi_device
*device
, int *state_p
);
525 bool acpi_bus_power_manageable(acpi_handle handle
);
528 bool acpi_bus_can_wakeup(acpi_handle handle
);
530 static inline bool acpi_bus_can_wakeup(acpi_handle handle
) { return false; }
533 void acpi_scan_lock_acquire(void);
534 void acpi_scan_lock_release(void);
535 void acpi_lock_hp_context(void);
536 void acpi_unlock_hp_context(void);
537 int acpi_scan_add_handler(struct acpi_scan_handler
*handler
);
538 int acpi_bus_register_driver(struct acpi_driver
*driver
);
539 void acpi_bus_unregister_driver(struct acpi_driver
*driver
);
540 int acpi_bus_scan(acpi_handle handle
);
541 void acpi_bus_trim(struct acpi_device
*start
);
542 acpi_status
acpi_bus_get_ejd(acpi_handle handle
, acpi_handle
* ejd
);
543 int acpi_match_device_ids(struct acpi_device
*device
,
544 const struct acpi_device_id
*ids
);
545 void acpi_set_modalias(struct acpi_device
*adev
, const char *default_id
,
546 char *modalias
, size_t len
);
547 int acpi_create_dir(struct acpi_device
*);
548 void acpi_remove_dir(struct acpi_device
*);
550 static inline bool acpi_device_enumerated(struct acpi_device
*adev
)
552 return adev
&& adev
->flags
.initialized
&& adev
->flags
.visited
;
556 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
557 * @__acpi_driver: acpi_driver struct
559 * Helper macro for ACPI drivers which do not do anything special in module
560 * init/exit. This eliminates a lot of boilerplate. Each module may only
561 * use this macro once, and calling it replaces module_init() and module_exit()
563 #define module_acpi_driver(__acpi_driver) \
564 module_driver(__acpi_driver, acpi_bus_register_driver, \
565 acpi_bus_unregister_driver)
568 * Bind physical devices with ACPI devices
570 struct acpi_bus_type
{
571 struct list_head list
;
573 bool (*match
)(struct device
*dev
);
574 struct acpi_device
* (*find_companion
)(struct device
*);
575 void (*setup
)(struct device
*);
576 void (*cleanup
)(struct device
*);
578 int register_acpi_bus_type(struct acpi_bus_type
*);
579 int unregister_acpi_bus_type(struct acpi_bus_type
*);
580 int acpi_bind_one(struct device
*dev
, struct acpi_device
*adev
);
581 int acpi_unbind_one(struct device
*dev
);
583 struct acpi_pci_root
{
584 struct acpi_device
* device
;
587 struct resource secondary
; /* downstream bus range */
589 u32 osc_support_set
; /* _OSC state of support bits */
590 u32 osc_control_set
; /* _OSC state of control bits */
591 phys_addr_t mcfg_addr
;
596 bool acpi_dma_supported(struct acpi_device
*adev
);
597 enum dev_dma_attr
acpi_get_dma_attr(struct acpi_device
*adev
);
598 int acpi_dma_get_range(struct device
*dev
, u64
*dma_addr
, u64
*offset
,
600 int acpi_dma_configure(struct device
*dev
, enum dev_dma_attr attr
);
601 void acpi_dma_deconfigure(struct device
*dev
);
603 struct acpi_device
*acpi_find_child_device(struct acpi_device
*parent
,
604 u64 address
, bool check_children
);
605 int acpi_is_root_bridge(acpi_handle
);
606 struct acpi_pci_root
*acpi_pci_find_root(acpi_handle handle
);
608 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int state
);
609 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
);
612 bool acpi_device_always_present(struct acpi_device
*adev
);
614 static inline bool acpi_device_always_present(struct acpi_device
*adev
)
621 void acpi_pm_wakeup_event(struct device
*dev
);
622 acpi_status
acpi_add_pm_notifier(struct acpi_device
*adev
, struct device
*dev
,
623 void (*func
)(struct acpi_device_wakeup_context
*context
));
624 acpi_status
acpi_remove_pm_notifier(struct acpi_device
*adev
);
625 bool acpi_pm_device_can_wakeup(struct device
*dev
);
626 int acpi_pm_device_sleep_state(struct device
*, int *, int);
627 int acpi_pm_set_device_wakeup(struct device
*dev
, bool enable
);
628 int acpi_pm_set_bridge_wakeup(struct device
*dev
, bool enable
);
630 static inline void acpi_pm_wakeup_event(struct device
*dev
)
633 static inline acpi_status
acpi_add_pm_notifier(struct acpi_device
*adev
,
635 void (*func
)(struct acpi_device_wakeup_context
*context
))
639 static inline acpi_status
acpi_remove_pm_notifier(struct acpi_device
*adev
)
643 static inline bool acpi_pm_device_can_wakeup(struct device
*dev
)
647 static inline int acpi_pm_device_sleep_state(struct device
*d
, int *p
, int m
)
652 return (m
>= ACPI_STATE_D0
&& m
<= ACPI_STATE_D3_COLD
) ?
655 static inline int acpi_pm_set_device_wakeup(struct device
*dev
, bool enable
)
659 static inline int acpi_pm_set_bridge_wakeup(struct device
*dev
, bool enable
)
665 #ifdef CONFIG_ACPI_SLEEP
666 u32
acpi_target_system_state(void);
668 static inline u32
acpi_target_system_state(void) { return ACPI_STATE_S0
; }
671 static inline bool acpi_device_power_manageable(struct acpi_device
*adev
)
673 return adev
->flags
.power_manageable
;
676 static inline bool acpi_device_can_wakeup(struct acpi_device
*adev
)
678 return adev
->wakeup
.flags
.valid
;
681 static inline bool acpi_device_can_poweroff(struct acpi_device
*adev
)
683 return adev
->power
.states
[ACPI_STATE_D3_COLD
].flags
.valid
||
684 ((acpi_gbl_FADT
.header
.revision
< 6) &&
685 adev
->power
.states
[ACPI_STATE_D3_HOT
].flags
.explicit_set
);
688 #else /* CONFIG_ACPI */
690 static inline int register_acpi_bus_type(void *bus
) { return 0; }
691 static inline int unregister_acpi_bus_type(void *bus
) { return 0; }
693 #endif /* CONFIG_ACPI */
695 #endif /*__ACPI_BUS_H__*/