1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
10 #define __ACPI_BUS_H__
12 #include <linux/device.h>
13 #include <linux/property.h>
15 /* TBD: Make dynamic */
16 #define ACPI_MAX_HANDLES 10
17 struct acpi_handle_list
{
19 acpi_handle handles
[ACPI_MAX_HANDLES
];
24 acpi_extract_package(union acpi_object
*package
,
25 struct acpi_buffer
*format
, struct acpi_buffer
*buffer
);
27 acpi_evaluate_integer(acpi_handle handle
,
29 struct acpi_object_list
*arguments
, unsigned long long *data
);
31 acpi_evaluate_reference(acpi_handle handle
,
33 struct acpi_object_list
*arguments
,
34 struct acpi_handle_list
*list
);
36 acpi_evaluate_ost(acpi_handle handle
, u32 source_event
, u32 status_code
,
37 struct acpi_buffer
*status_buf
);
40 acpi_get_physical_device_location(acpi_handle handle
, struct acpi_pld_info
**pld
);
42 bool acpi_has_method(acpi_handle handle
, char *name
);
43 acpi_status
acpi_execute_simple_method(acpi_handle handle
, char *method
,
45 acpi_status
acpi_evaluate_ej0(acpi_handle handle
);
46 acpi_status
acpi_evaluate_lck(acpi_handle handle
, int lock
);
47 acpi_status
acpi_evaluate_reg(acpi_handle handle
, u8 space_id
, u32 function
);
48 bool acpi_ata_match(acpi_handle handle
);
49 bool acpi_bay_match(acpi_handle handle
);
50 bool acpi_dock_match(acpi_handle handle
);
52 bool acpi_check_dsm(acpi_handle handle
, const guid_t
*guid
, u64 rev
, u64 funcs
);
53 union acpi_object
*acpi_evaluate_dsm(acpi_handle handle
, const guid_t
*guid
,
54 u64 rev
, u64 func
, union acpi_object
*argv4
);
56 static inline union acpi_object
*
57 acpi_evaluate_dsm_typed(acpi_handle handle
, const guid_t
*guid
, u64 rev
,
58 u64 func
, union acpi_object
*argv4
,
59 acpi_object_type type
)
61 union acpi_object
*obj
;
63 obj
= acpi_evaluate_dsm(handle
, guid
, rev
, func
, argv4
);
64 if (obj
&& obj
->type
!= type
) {
72 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
74 .package.type = ACPI_TYPE_PACKAGE, \
75 .package.count = (cnt), \
76 .package.elements = (eles) \
79 bool acpi_dev_found(const char *hid
);
80 bool acpi_dev_present(const char *hid
, const char *uid
, s64 hrv
);
84 struct proc_dir_entry
;
86 #define ACPI_BUS_FILE_ROOT "acpi"
87 extern struct proc_dir_entry
*acpi_root_dir
;
89 enum acpi_bus_device_type
{
90 ACPI_BUS_TYPE_DEVICE
= 0,
92 ACPI_BUS_TYPE_PROCESSOR
,
93 ACPI_BUS_TYPE_THERMAL
,
94 ACPI_BUS_TYPE_POWER_BUTTON
,
95 ACPI_BUS_TYPE_SLEEP_BUTTON
,
96 ACPI_BUS_TYPE_ECDT_EC
,
97 ACPI_BUS_DEVICE_TYPE_COUNT
108 struct acpi_hotplug_profile
{
110 int (*scan_dependent
)(struct acpi_device
*adev
);
111 void (*notify_online
)(struct acpi_device
*adev
);
113 bool demand_offline
:1;
116 static inline struct acpi_hotplug_profile
*to_acpi_hotplug_profile(
117 struct kobject
*kobj
)
119 return container_of(kobj
, struct acpi_hotplug_profile
, kobj
);
122 struct acpi_scan_handler
{
123 const struct acpi_device_id
*ids
;
124 struct list_head list_node
;
125 bool (*match
)(const char *idstr
, const struct acpi_device_id
**matchid
);
126 int (*attach
)(struct acpi_device
*dev
, const struct acpi_device_id
*id
);
127 void (*detach
)(struct acpi_device
*dev
);
128 void (*bind
)(struct device
*phys_dev
);
129 void (*unbind
)(struct device
*phys_dev
);
130 struct acpi_hotplug_profile hotplug
;
134 * ACPI Hotplug Context
135 * --------------------
138 struct acpi_hotplug_context
{
139 struct acpi_device
*self
;
140 int (*notify
)(struct acpi_device
*, u32
);
141 void (*uevent
)(struct acpi_device
*, u32
);
142 void (*fixup
)(struct acpi_device
*);
150 typedef int (*acpi_op_add
) (struct acpi_device
* device
);
151 typedef int (*acpi_op_remove
) (struct acpi_device
* device
);
152 typedef void (*acpi_op_notify
) (struct acpi_device
* device
, u32 event
);
154 struct acpi_device_ops
{
156 acpi_op_remove remove
;
157 acpi_op_notify notify
;
160 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
165 const struct acpi_device_id
*ids
; /* Supported Hardware IDs */
167 struct acpi_device_ops ops
;
168 struct device_driver drv
;
169 struct module
*owner
;
179 struct acpi_device_status
{
184 u32 battery_present
:1;
190 struct acpi_device_flags
{
191 u32 dynamic_status
:1;
194 u32 power_manageable
:1;
198 u32 hotplug_notify
:1;
199 u32 is_dock_station
:1;
200 u32 of_compatible_ok
:1;
203 u32 enumeration_by_parent
:1;
209 struct acpi_device_dir
{
210 struct proc_dir_entry
*entry
;
213 #define acpi_device_dir(d) ((d)->dir.entry)
217 typedef char acpi_bus_id
[8];
218 typedef u64 acpi_bus_address
;
219 typedef char acpi_device_name
[40];
220 typedef char acpi_device_class
[20];
222 struct acpi_hardware_id
{
223 struct list_head list
;
227 struct acpi_pnp_type
{
234 struct acpi_device_pnp
{
235 acpi_bus_id bus_id
; /* Object name */
236 struct acpi_pnp_type type
; /* ID type */
237 acpi_bus_address bus_address
; /* _ADR */
238 char *unique_id
; /* _UID */
239 struct list_head ids
; /* _HID and _CIDs */
240 acpi_device_name device_name
; /* Driver-determined */
241 acpi_device_class device_class
; /* " */
242 union acpi_object
*str_obj
; /* unicode string for _STR method */
245 #define acpi_device_bid(d) ((d)->pnp.bus_id)
246 #define acpi_device_adr(d) ((d)->pnp.bus_address)
247 const char *acpi_device_hid(struct acpi_device
*device
);
248 #define acpi_device_uid(d) ((d)->pnp.unique_id)
249 #define acpi_device_name(d) ((d)->pnp.device_name)
250 #define acpi_device_class(d) ((d)->pnp.device_class)
252 /* Power Management */
254 struct acpi_device_power_flags
{
255 u32 explicit_get
:1; /* _PSC present? */
256 u32 power_resources
:1; /* Power resources */
257 u32 inrush_current
:1; /* Serialize Dx->D0 */
258 u32 power_removed
:1; /* Optimize Dx->D0 */
259 u32 ignore_parent
:1; /* Power is independent of parent power state */
260 u32 dsw_present
:1; /* _DSW present? */
264 struct acpi_device_power_state
{
267 u8 explicit_set
:1; /* _PSx present? */
270 int power
; /* % Power (compared to D0) */
271 int latency
; /* Dx->D0 time (microseconds) */
272 struct list_head resources
; /* Power resources referenced */
275 struct acpi_device_power
{
276 int state
; /* Current state */
277 struct acpi_device_power_flags flags
;
278 struct acpi_device_power_state states
[ACPI_D_STATE_COUNT
]; /* Power states (D0-D3Cold) */
281 /* Performance Management */
283 struct acpi_device_perf_flags
{
287 struct acpi_device_perf_state
{
292 u8 power
; /* % Power (compared to P0) */
293 u8 performance
; /* % Performance ( " ) */
294 int latency
; /* Px->P0 time (microseconds) */
297 struct acpi_device_perf
{
299 struct acpi_device_perf_flags flags
;
301 struct acpi_device_perf_state
*states
;
304 /* Wakeup Management */
305 struct acpi_device_wakeup_flags
{
306 u8 valid
:1; /* Can successfully enable wakeup? */
307 u8 notifier_present
:1; /* Wake-up notify handler has been installed */
310 struct acpi_device_wakeup_context
{
311 void (*func
)(struct acpi_device_wakeup_context
*context
);
315 struct acpi_device_wakeup
{
316 acpi_handle gpe_device
;
319 struct list_head resources
;
320 struct acpi_device_wakeup_flags flags
;
321 struct acpi_device_wakeup_context context
;
322 struct wakeup_source
*ws
;
327 struct acpi_device_physical_node
{
328 unsigned int node_id
;
329 struct list_head node
;
334 struct acpi_device_properties
{
336 const union acpi_object
*properties
;
337 struct list_head list
;
340 /* ACPI Device Specific Data (_DSD) */
341 struct acpi_device_data
{
342 const union acpi_object
*pointer
;
343 struct list_head properties
;
344 const union acpi_object
*of_compatible
;
345 struct list_head subnodes
;
348 struct acpi_gpio_mapping
;
353 acpi_handle handle
; /* no handle for fixed hardware */
354 struct fwnode_handle fwnode
;
355 struct acpi_device
*parent
;
356 struct list_head children
;
357 struct list_head node
;
358 struct list_head wakeup_list
;
359 struct list_head del_list
;
360 struct acpi_device_status status
;
361 struct acpi_device_flags flags
;
362 struct acpi_device_pnp pnp
;
363 struct acpi_device_power power
;
364 struct acpi_device_wakeup wakeup
;
365 struct acpi_device_perf performance
;
366 struct acpi_device_dir dir
;
367 struct acpi_device_data data
;
368 struct acpi_scan_handler
*handler
;
369 struct acpi_hotplug_context
*hp
;
370 struct acpi_driver
*driver
;
371 const struct acpi_gpio_mapping
*driver_gpios
;
374 unsigned int physical_node_count
;
375 unsigned int dep_unmet
;
376 struct list_head physical_node_list
;
377 struct mutex physical_node_lock
;
378 void (*remove
)(struct acpi_device
*);
381 /* Non-device subnode */
382 struct acpi_data_node
{
385 struct fwnode_handle fwnode
;
386 struct fwnode_handle
*parent
;
387 struct acpi_device_data data
;
388 struct list_head sibling
;
390 struct completion kobj_done
;
393 extern const struct fwnode_operations acpi_device_fwnode_ops
;
394 extern const struct fwnode_operations acpi_data_fwnode_ops
;
395 extern const struct fwnode_operations acpi_static_fwnode_ops
;
397 bool is_acpi_device_node(const struct fwnode_handle
*fwnode
);
398 bool is_acpi_data_node(const struct fwnode_handle
*fwnode
);
400 static inline bool is_acpi_node(const struct fwnode_handle
*fwnode
)
402 return (is_acpi_device_node(fwnode
) || is_acpi_data_node(fwnode
));
405 #define to_acpi_device_node(__fwnode) \
407 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
409 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
410 container_of(__to_acpi_device_node_fwnode, \
411 struct acpi_device, fwnode) : \
415 #define to_acpi_data_node(__fwnode) \
417 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
419 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
420 container_of(__to_acpi_data_node_fwnode, \
421 struct acpi_data_node, fwnode) : \
425 static inline bool is_acpi_static_node(const struct fwnode_handle
*fwnode
)
427 return !IS_ERR_OR_NULL(fwnode
) &&
428 fwnode
->ops
== &acpi_static_fwnode_ops
;
431 static inline bool acpi_data_node_match(const struct fwnode_handle
*fwnode
,
434 return is_acpi_data_node(fwnode
) ?
435 (!strcmp(to_acpi_data_node(fwnode
)->name
, name
)) : false;
438 static inline struct fwnode_handle
*acpi_fwnode_handle(struct acpi_device
*adev
)
440 return &adev
->fwnode
;
443 static inline void *acpi_driver_data(struct acpi_device
*d
)
445 return d
->driver_data
;
448 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
449 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
451 static inline void acpi_set_device_status(struct acpi_device
*adev
, u32 sta
)
453 *((u32
*)&adev
->status
) = sta
;
456 static inline void acpi_set_hp_context(struct acpi_device
*adev
,
457 struct acpi_hotplug_context
*hp
)
463 void acpi_initialize_hp_context(struct acpi_device
*adev
,
464 struct acpi_hotplug_context
*hp
,
465 int (*notify
)(struct acpi_device
*, u32
),
466 void (*uevent
)(struct acpi_device
*, u32
));
468 /* acpi_device.dev.bus == &acpi_bus_type */
469 extern struct bus_type acpi_bus_type
;
476 struct acpi_bus_event
{
477 struct list_head node
;
478 acpi_device_class device_class
;
484 extern struct kobject
*acpi_kobj
;
485 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8
, int);
486 void acpi_bus_private_data_handler(acpi_handle
, void *);
487 int acpi_bus_get_private_data(acpi_handle
, void **);
488 int acpi_bus_attach_private_data(acpi_handle
, void *);
489 void acpi_bus_detach_private_data(acpi_handle
);
490 extern int acpi_notifier_call_chain(struct acpi_device
*, u32
, u32
);
491 extern int register_acpi_notifier(struct notifier_block
*);
492 extern int unregister_acpi_notifier(struct notifier_block
*);
498 int acpi_bus_get_device(acpi_handle handle
, struct acpi_device
**device
);
499 struct acpi_device
*acpi_bus_get_acpi_device(acpi_handle handle
);
500 void acpi_bus_put_acpi_device(struct acpi_device
*adev
);
501 acpi_status
acpi_bus_get_status_handle(acpi_handle handle
,
502 unsigned long long *sta
);
503 int acpi_bus_get_status(struct acpi_device
*device
);
505 int acpi_bus_set_power(acpi_handle handle
, int state
);
506 const char *acpi_power_state_string(int state
);
507 int acpi_device_set_power(struct acpi_device
*device
, int state
);
508 int acpi_bus_init_power(struct acpi_device
*device
);
509 int acpi_device_fix_up_power(struct acpi_device
*device
);
510 int acpi_bus_update_power(acpi_handle handle
, int *state_p
);
511 int acpi_device_update_power(struct acpi_device
*device
, int *state_p
);
512 bool acpi_bus_power_manageable(acpi_handle handle
);
513 int acpi_device_power_add_dependent(struct acpi_device
*adev
,
515 void acpi_device_power_remove_dependent(struct acpi_device
*adev
,
519 bool acpi_bus_can_wakeup(acpi_handle handle
);
521 static inline bool acpi_bus_can_wakeup(acpi_handle handle
) { return false; }
524 void acpi_scan_lock_acquire(void);
525 void acpi_scan_lock_release(void);
526 void acpi_lock_hp_context(void);
527 void acpi_unlock_hp_context(void);
528 int acpi_scan_add_handler(struct acpi_scan_handler
*handler
);
529 int acpi_bus_register_driver(struct acpi_driver
*driver
);
530 void acpi_bus_unregister_driver(struct acpi_driver
*driver
);
531 int acpi_bus_scan(acpi_handle handle
);
532 void acpi_bus_trim(struct acpi_device
*start
);
533 acpi_status
acpi_bus_get_ejd(acpi_handle handle
, acpi_handle
* ejd
);
534 int acpi_match_device_ids(struct acpi_device
*device
,
535 const struct acpi_device_id
*ids
);
536 void acpi_set_modalias(struct acpi_device
*adev
, const char *default_id
,
537 char *modalias
, size_t len
);
538 int acpi_create_dir(struct acpi_device
*);
539 void acpi_remove_dir(struct acpi_device
*);
541 static inline bool acpi_device_enumerated(struct acpi_device
*adev
)
543 return adev
&& adev
->flags
.initialized
&& adev
->flags
.visited
;
547 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
548 * @__acpi_driver: acpi_driver struct
550 * Helper macro for ACPI drivers which do not do anything special in module
551 * init/exit. This eliminates a lot of boilerplate. Each module may only
552 * use this macro once, and calling it replaces module_init() and module_exit()
554 #define module_acpi_driver(__acpi_driver) \
555 module_driver(__acpi_driver, acpi_bus_register_driver, \
556 acpi_bus_unregister_driver)
559 * Bind physical devices with ACPI devices
561 struct acpi_bus_type
{
562 struct list_head list
;
564 bool (*match
)(struct device
*dev
);
565 struct acpi_device
* (*find_companion
)(struct device
*);
566 void (*setup
)(struct device
*);
567 void (*cleanup
)(struct device
*);
569 int register_acpi_bus_type(struct acpi_bus_type
*);
570 int unregister_acpi_bus_type(struct acpi_bus_type
*);
571 int acpi_bind_one(struct device
*dev
, struct acpi_device
*adev
);
572 int acpi_unbind_one(struct device
*dev
);
574 struct acpi_pci_root
{
575 struct acpi_device
* device
;
578 struct resource secondary
; /* downstream bus range */
580 u32 osc_support_set
; /* _OSC state of support bits */
581 u32 osc_control_set
; /* _OSC state of control bits */
582 phys_addr_t mcfg_addr
;
587 bool acpi_dma_supported(struct acpi_device
*adev
);
588 enum dev_dma_attr
acpi_get_dma_attr(struct acpi_device
*adev
);
589 int acpi_dma_get_range(struct device
*dev
, u64
*dma_addr
, u64
*offset
,
591 int acpi_dma_configure_id(struct device
*dev
, enum dev_dma_attr attr
,
592 const u32
*input_id
);
593 static inline int acpi_dma_configure(struct device
*dev
,
594 enum dev_dma_attr attr
)
596 return acpi_dma_configure_id(dev
, attr
, NULL
);
598 struct acpi_device
*acpi_find_child_device(struct acpi_device
*parent
,
599 u64 address
, bool check_children
);
600 int acpi_is_root_bridge(acpi_handle
);
601 struct acpi_pci_root
*acpi_pci_find_root(acpi_handle handle
);
603 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int state
);
604 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
);
607 bool acpi_device_always_present(struct acpi_device
*adev
);
609 static inline bool acpi_device_always_present(struct acpi_device
*adev
)
616 void acpi_pm_wakeup_event(struct device
*dev
);
617 acpi_status
acpi_add_pm_notifier(struct acpi_device
*adev
, struct device
*dev
,
618 void (*func
)(struct acpi_device_wakeup_context
*context
));
619 acpi_status
acpi_remove_pm_notifier(struct acpi_device
*adev
);
620 bool acpi_pm_device_can_wakeup(struct device
*dev
);
621 int acpi_pm_device_sleep_state(struct device
*, int *, int);
622 int acpi_pm_set_device_wakeup(struct device
*dev
, bool enable
);
624 static inline void acpi_pm_wakeup_event(struct device
*dev
)
627 static inline acpi_status
acpi_add_pm_notifier(struct acpi_device
*adev
,
629 void (*func
)(struct acpi_device_wakeup_context
*context
))
633 static inline acpi_status
acpi_remove_pm_notifier(struct acpi_device
*adev
)
637 static inline bool acpi_pm_device_can_wakeup(struct device
*dev
)
641 static inline int acpi_pm_device_sleep_state(struct device
*d
, int *p
, int m
)
646 return (m
>= ACPI_STATE_D0
&& m
<= ACPI_STATE_D3_COLD
) ?
649 static inline int acpi_pm_set_device_wakeup(struct device
*dev
, bool enable
)
655 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
656 bool acpi_sleep_state_supported(u8 sleep_state
);
658 static inline bool acpi_sleep_state_supported(u8 sleep_state
) { return false; }
661 #ifdef CONFIG_ACPI_SLEEP
662 u32
acpi_target_system_state(void);
664 static inline u32
acpi_target_system_state(void) { return ACPI_STATE_S0
; }
667 static inline bool acpi_device_power_manageable(struct acpi_device
*adev
)
669 return adev
->flags
.power_manageable
;
672 static inline bool acpi_device_can_wakeup(struct acpi_device
*adev
)
674 return adev
->wakeup
.flags
.valid
;
677 static inline bool acpi_device_can_poweroff(struct acpi_device
*adev
)
679 return adev
->power
.states
[ACPI_STATE_D3_COLD
].flags
.valid
||
680 ((acpi_gbl_FADT
.header
.revision
< 6) &&
681 adev
->power
.states
[ACPI_STATE_D3_HOT
].flags
.explicit_set
);
684 bool acpi_dev_hid_uid_match(struct acpi_device
*adev
, const char *hid2
, const char *uid2
);
687 acpi_dev_get_first_match_dev(const char *hid
, const char *uid
, s64 hrv
);
689 static inline void acpi_dev_put(struct acpi_device
*adev
)
691 put_device(&adev
->dev
);
693 #else /* CONFIG_ACPI */
695 static inline int register_acpi_bus_type(void *bus
) { return 0; }
696 static inline int unregister_acpi_bus_type(void *bus
) { return 0; }
698 #endif /* CONFIG_ACPI */
700 #endif /*__ACPI_BUS_H__*/