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);
81 bool acpi_reduced_hardware(void);
85 struct proc_dir_entry;
87 #define ACPI_BUS_FILE_ROOT "acpi"
88 extern struct proc_dir_entry *acpi_root_dir;
90 enum acpi_bus_device_type {
91 ACPI_BUS_TYPE_DEVICE = 0,
93 ACPI_BUS_TYPE_PROCESSOR,
94 ACPI_BUS_TYPE_THERMAL,
95 ACPI_BUS_TYPE_POWER_BUTTON,
96 ACPI_BUS_TYPE_SLEEP_BUTTON,
97 ACPI_BUS_TYPE_ECDT_EC,
98 ACPI_BUS_DEVICE_TYPE_COUNT
109 struct acpi_hotplug_profile {
111 int (*scan_dependent)(struct acpi_device *adev);
112 void (*notify_online)(struct acpi_device *adev);
114 bool demand_offline:1;
117 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
118 struct kobject *kobj)
120 return container_of(kobj, struct acpi_hotplug_profile, kobj);
123 struct acpi_scan_handler {
124 const struct acpi_device_id *ids;
125 struct list_head list_node;
126 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
127 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
128 void (*detach)(struct acpi_device *dev);
129 void (*bind)(struct device *phys_dev);
130 void (*unbind)(struct device *phys_dev);
131 struct acpi_hotplug_profile hotplug;
135 * ACPI Hotplug Context
136 * --------------------
139 struct acpi_hotplug_context {
140 struct acpi_device *self;
141 int (*notify)(struct acpi_device *, u32);
142 void (*uevent)(struct acpi_device *, u32);
143 void (*fixup)(struct acpi_device *);
151 typedef int (*acpi_op_add) (struct acpi_device * device);
152 typedef int (*acpi_op_remove) (struct acpi_device * device);
153 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
155 struct acpi_device_ops {
157 acpi_op_remove remove;
158 acpi_op_notify notify;
161 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
166 const struct acpi_device_id *ids; /* Supported Hardware IDs */
168 struct acpi_device_ops ops;
169 struct device_driver drv;
170 struct module *owner;
180 struct acpi_device_status {
185 u32 battery_present:1;
191 struct acpi_device_flags {
192 u32 dynamic_status:1;
195 u32 power_manageable:1;
199 u32 hotplug_notify:1;
200 u32 is_dock_station:1;
201 u32 of_compatible_ok:1;
204 u32 enumeration_by_parent:1;
211 struct acpi_device_dir {
212 struct proc_dir_entry *entry;
215 #define acpi_device_dir(d) ((d)->dir.entry)
219 typedef char acpi_bus_id[8];
220 typedef u64 acpi_bus_address;
221 typedef char acpi_device_name[40];
222 typedef char acpi_device_class[20];
224 struct acpi_hardware_id {
225 struct list_head list;
229 struct acpi_pnp_type {
236 struct acpi_device_pnp {
237 acpi_bus_id bus_id; /* Object name */
238 int instance_no; /* Instance number of this object */
239 struct acpi_pnp_type type; /* ID type */
240 acpi_bus_address bus_address; /* _ADR */
241 char *unique_id; /* _UID */
242 struct list_head ids; /* _HID and _CIDs */
243 acpi_device_name device_name; /* Driver-determined */
244 acpi_device_class device_class; /* " */
245 union acpi_object *str_obj; /* unicode string for _STR method */
248 #define acpi_device_bid(d) ((d)->pnp.bus_id)
249 #define acpi_device_adr(d) ((d)->pnp.bus_address)
250 const char *acpi_device_hid(struct acpi_device *device);
251 #define acpi_device_uid(d) ((d)->pnp.unique_id)
252 #define acpi_device_name(d) ((d)->pnp.device_name)
253 #define acpi_device_class(d) ((d)->pnp.device_class)
255 /* Power Management */
257 struct acpi_device_power_flags {
258 u32 explicit_get:1; /* _PSC present? */
259 u32 power_resources:1; /* Power resources */
260 u32 inrush_current:1; /* Serialize Dx->D0 */
261 u32 power_removed:1; /* Optimize Dx->D0 */
262 u32 ignore_parent:1; /* Power is independent of parent power state */
263 u32 dsw_present:1; /* _DSW present? */
267 struct acpi_device_power_state {
270 u8 explicit_set:1; /* _PSx present? */
273 int power; /* % Power (compared to D0) */
274 int latency; /* Dx->D0 time (microseconds) */
275 struct list_head resources; /* Power resources referenced */
278 struct acpi_device_power {
279 int state; /* Current state */
280 struct acpi_device_power_flags flags;
281 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
282 u8 state_for_enumeration; /* Deepest power state for enumeration */
285 struct acpi_dep_data {
286 struct list_head node;
287 acpi_handle supplier;
288 acpi_handle consumer;
292 /* Performance Management */
294 struct acpi_device_perf_flags {
298 struct acpi_device_perf_state {
303 u8 power; /* % Power (compared to P0) */
304 u8 performance; /* % Performance ( " ) */
305 int latency; /* Px->P0 time (microseconds) */
308 struct acpi_device_perf {
310 struct acpi_device_perf_flags flags;
312 struct acpi_device_perf_state *states;
315 /* Wakeup Management */
316 struct acpi_device_wakeup_flags {
317 u8 valid:1; /* Can successfully enable wakeup? */
318 u8 notifier_present:1; /* Wake-up notify handler has been installed */
321 struct acpi_device_wakeup_context {
322 void (*func)(struct acpi_device_wakeup_context *context);
326 struct acpi_device_wakeup {
327 acpi_handle gpe_device;
330 struct list_head resources;
331 struct acpi_device_wakeup_flags flags;
332 struct acpi_device_wakeup_context context;
333 struct wakeup_source *ws;
338 struct acpi_device_physical_node {
339 unsigned int node_id;
340 struct list_head node;
345 struct acpi_device_properties {
347 const union acpi_object *properties;
348 struct list_head list;
351 /* ACPI Device Specific Data (_DSD) */
352 struct acpi_device_data {
353 const union acpi_object *pointer;
354 struct list_head properties;
355 const union acpi_object *of_compatible;
356 struct list_head subnodes;
359 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;
483 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
484 int acpi_dev_for_each_child(struct acpi_device *adev,
485 int (*fn)(struct acpi_device *, void *), void *data);
492 struct acpi_bus_event {
493 struct list_head node;
494 acpi_device_class device_class;
500 extern struct kobject *acpi_kobj;
501 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
502 void acpi_bus_private_data_handler(acpi_handle, void *);
503 int acpi_bus_get_private_data(acpi_handle, void **);
504 int acpi_bus_attach_private_data(acpi_handle, void *);
505 void acpi_bus_detach_private_data(acpi_handle);
506 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
507 extern int register_acpi_notifier(struct notifier_block *);
508 extern int unregister_acpi_notifier(struct notifier_block *);
514 struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
515 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
516 unsigned long long *sta);
517 int acpi_bus_get_status(struct acpi_device *device);
519 int acpi_bus_set_power(acpi_handle handle, int state);
520 const char *acpi_power_state_string(int state);
521 int acpi_device_set_power(struct acpi_device *device, int state);
522 int acpi_bus_init_power(struct acpi_device *device);
523 int acpi_device_fix_up_power(struct acpi_device *device);
524 int acpi_bus_update_power(acpi_handle handle, int *state_p);
525 int acpi_device_update_power(struct acpi_device *device, int *state_p);
526 bool acpi_bus_power_manageable(acpi_handle handle);
527 void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
528 int acpi_device_power_add_dependent(struct acpi_device *adev,
530 void acpi_device_power_remove_dependent(struct acpi_device *adev,
534 bool acpi_bus_can_wakeup(acpi_handle handle);
536 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
539 void acpi_scan_lock_acquire(void);
540 void acpi_scan_lock_release(void);
541 void acpi_lock_hp_context(void);
542 void acpi_unlock_hp_context(void);
543 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
544 int acpi_bus_register_driver(struct acpi_driver *driver);
545 void acpi_bus_unregister_driver(struct acpi_driver *driver);
546 int acpi_bus_scan(acpi_handle handle);
547 void acpi_bus_trim(struct acpi_device *start);
548 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
549 int acpi_match_device_ids(struct acpi_device *device,
550 const struct acpi_device_id *ids);
551 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
552 char *modalias, size_t len);
553 int acpi_create_dir(struct acpi_device *);
554 void acpi_remove_dir(struct acpi_device *);
556 static inline bool acpi_device_enumerated(struct acpi_device *adev)
558 return adev && adev->flags.initialized && adev->flags.visited;
562 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
563 * @__acpi_driver: acpi_driver struct
565 * Helper macro for ACPI drivers which do not do anything special in module
566 * init/exit. This eliminates a lot of boilerplate. Each module may only
567 * use this macro once, and calling it replaces module_init() and module_exit()
569 #define module_acpi_driver(__acpi_driver) \
570 module_driver(__acpi_driver, acpi_bus_register_driver, \
571 acpi_bus_unregister_driver)
574 * Bind physical devices with ACPI devices
576 struct acpi_bus_type {
577 struct list_head list;
579 bool (*match)(struct device *dev);
580 struct acpi_device * (*find_companion)(struct device *);
581 void (*setup)(struct device *);
583 int register_acpi_bus_type(struct acpi_bus_type *);
584 int unregister_acpi_bus_type(struct acpi_bus_type *);
585 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
586 int acpi_unbind_one(struct device *dev);
588 enum acpi_bridge_type {
589 ACPI_BRIDGE_TYPE_PCIE = 1,
590 ACPI_BRIDGE_TYPE_CXL,
593 struct acpi_pci_root {
594 struct acpi_device * device;
598 struct resource secondary; /* downstream bus range */
600 u32 osc_support_set; /* _OSC state of support bits */
601 u32 osc_control_set; /* _OSC state of control bits */
602 u32 osc_ext_support_set; /* _OSC state of extended support bits */
603 u32 osc_ext_control_set; /* _OSC state of extended control bits */
604 phys_addr_t mcfg_addr;
609 bool acpi_dma_supported(const struct acpi_device *adev);
610 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
611 int acpi_iommu_fwspec_init(struct device *dev, u32 id,
612 struct fwnode_handle *fwnode,
613 const struct iommu_ops *ops);
614 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
616 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
617 const u32 *input_id);
618 static inline int acpi_dma_configure(struct device *dev,
619 enum dev_dma_attr attr)
621 return acpi_dma_configure_id(dev, attr, NULL);
623 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
624 u64 address, bool check_children);
625 int acpi_is_root_bridge(acpi_handle);
626 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
628 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
629 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
632 bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
633 bool acpi_quirk_skip_acpi_ac_and_battery(void);
635 static inline bool acpi_device_override_status(struct acpi_device *adev,
636 unsigned long long *status)
640 static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
646 #if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
647 bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
648 int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
650 static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
655 acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
663 void acpi_pm_wakeup_event(struct device *dev);
664 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
665 void (*func)(struct acpi_device_wakeup_context *context));
666 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
667 bool acpi_pm_device_can_wakeup(struct device *dev);
668 int acpi_pm_device_sleep_state(struct device *, int *, int);
669 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
671 static inline void acpi_pm_wakeup_event(struct device *dev)
674 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
676 void (*func)(struct acpi_device_wakeup_context *context))
680 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
684 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
688 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
693 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
696 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
702 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
703 bool acpi_sleep_state_supported(u8 sleep_state);
705 static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
708 #ifdef CONFIG_ACPI_SLEEP
709 u32 acpi_target_system_state(void);
711 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
714 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
716 return adev->flags.power_manageable;
719 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
721 return adev->wakeup.flags.valid;
724 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
726 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
727 ((acpi_gbl_FADT.header.revision < 6) &&
728 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
731 bool acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2);
733 void acpi_dev_clear_dependencies(struct acpi_device *supplier);
734 bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
735 struct acpi_device *acpi_dev_get_first_consumer_dev(struct acpi_device *supplier);
737 acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
739 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
742 * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
743 * @adev: pointer to the matching ACPI device, NULL at the end of the loop
744 * @hid: Hardware ID of the device.
745 * @uid: Unique ID of the device, pass NULL to not check _UID
746 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
748 * The caller is responsible for invoking acpi_dev_put() on the returned device.
750 #define for_each_acpi_dev_match(adev, hid, uid, hrv) \
751 for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \
753 adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
755 static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
757 return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
760 static inline void acpi_dev_put(struct acpi_device *adev)
763 put_device(&adev->dev);
766 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
768 static inline void acpi_bus_put_acpi_device(struct acpi_device *adev)
772 #else /* CONFIG_ACPI */
774 static inline int register_acpi_bus_type(void *bus) { return 0; }
775 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
777 #endif /* CONFIG_ACPI */
779 #endif /*__ACPI_BUS_H__*/