1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
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 bool acpi_ata_match(acpi_handle handle);
48 bool acpi_bay_match(acpi_handle handle);
49 bool acpi_dock_match(acpi_handle handle);
51 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
52 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
53 u64 rev, u64 func, union acpi_object *argv4);
55 static inline union acpi_object *
56 acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
57 u64 func, union acpi_object *argv4,
58 acpi_object_type type)
60 union acpi_object *obj;
62 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
63 if (obj && obj->type != type) {
71 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
73 .package.type = ACPI_TYPE_PACKAGE, \
74 .package.count = (cnt), \
75 .package.elements = (eles) \
78 bool acpi_dev_found(const char *hid);
79 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
82 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
86 #include <linux/proc_fs.h>
88 #define ACPI_BUS_FILE_ROOT "acpi"
89 extern struct proc_dir_entry *acpi_root_dir;
91 enum acpi_bus_device_type {
92 ACPI_BUS_TYPE_DEVICE = 0,
94 ACPI_BUS_TYPE_PROCESSOR,
95 ACPI_BUS_TYPE_THERMAL,
96 ACPI_BUS_TYPE_POWER_BUTTON,
97 ACPI_BUS_TYPE_SLEEP_BUTTON,
98 ACPI_BUS_TYPE_ECDT_EC,
99 ACPI_BUS_DEVICE_TYPE_COUNT
110 struct acpi_hotplug_profile {
112 int (*scan_dependent)(struct acpi_device *adev);
113 void (*notify_online)(struct acpi_device *adev);
115 bool demand_offline:1;
118 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
119 struct kobject *kobj)
121 return container_of(kobj, struct acpi_hotplug_profile, kobj);
124 struct acpi_scan_handler {
125 const struct acpi_device_id *ids;
126 struct list_head list_node;
127 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
128 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
129 void (*detach)(struct acpi_device *dev);
130 void (*bind)(struct device *phys_dev);
131 void (*unbind)(struct device *phys_dev);
132 struct acpi_hotplug_profile hotplug;
136 * ACPI Hotplug Context
137 * --------------------
140 struct acpi_hotplug_context {
141 struct acpi_device *self;
142 int (*notify)(struct acpi_device *, u32);
143 void (*uevent)(struct acpi_device *, u32);
144 void (*fixup)(struct acpi_device *);
152 typedef int (*acpi_op_add) (struct acpi_device * device);
153 typedef int (*acpi_op_remove) (struct acpi_device * device);
154 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
156 struct acpi_device_ops {
158 acpi_op_remove remove;
159 acpi_op_notify notify;
162 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
167 const struct acpi_device_id *ids; /* Supported Hardware IDs */
169 struct acpi_device_ops ops;
170 struct device_driver drv;
171 struct module *owner;
181 struct acpi_device_status {
186 u32 battery_present:1;
192 struct acpi_device_flags {
193 u32 dynamic_status:1;
196 u32 power_manageable:1;
200 u32 hotplug_notify:1;
201 u32 is_dock_station:1;
202 u32 of_compatible_ok:1;
205 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 struct acpi_pnp_type type; /* ID type */
239 acpi_bus_address bus_address; /* _ADR */
240 char *unique_id; /* _UID */
241 struct list_head ids; /* _HID and _CIDs */
242 acpi_device_name device_name; /* Driver-determined */
243 acpi_device_class device_class; /* " */
244 union acpi_object *str_obj; /* unicode string for _STR method */
247 #define acpi_device_bid(d) ((d)->pnp.bus_id)
248 #define acpi_device_adr(d) ((d)->pnp.bus_address)
249 const char *acpi_device_hid(struct acpi_device *device);
250 #define acpi_device_uid(d) ((d)->pnp.unique_id)
251 #define acpi_device_name(d) ((d)->pnp.device_name)
252 #define acpi_device_class(d) ((d)->pnp.device_class)
254 /* Power Management */
256 struct acpi_device_power_flags {
257 u32 explicit_get:1; /* _PSC present? */
258 u32 power_resources:1; /* Power resources */
259 u32 inrush_current:1; /* Serialize Dx->D0 */
260 u32 power_removed:1; /* Optimize Dx->D0 */
261 u32 ignore_parent:1; /* Power is independent of parent power state */
262 u32 dsw_present:1; /* _DSW present? */
266 struct acpi_device_power_state {
269 u8 explicit_set:1; /* _PSx present? */
272 int power; /* % Power (compared to D0) */
273 int latency; /* Dx->D0 time (microseconds) */
274 struct list_head resources; /* Power resources referenced */
277 struct acpi_device_power {
278 int state; /* Current state */
279 struct acpi_device_power_flags flags;
280 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
283 /* Performance Management */
285 struct acpi_device_perf_flags {
289 struct acpi_device_perf_state {
294 u8 power; /* % Power (compared to P0) */
295 u8 performance; /* % Performance ( " ) */
296 int latency; /* Px->P0 time (microseconds) */
299 struct acpi_device_perf {
301 struct acpi_device_perf_flags flags;
303 struct acpi_device_perf_state *states;
306 /* Wakeup Management */
307 struct acpi_device_wakeup_flags {
308 u8 valid:1; /* Can successfully enable wakeup? */
309 u8 notifier_present:1; /* Wake-up notify handler has been installed */
312 struct acpi_device_wakeup_context {
313 void (*func)(struct acpi_device_wakeup_context *context);
317 struct acpi_device_wakeup {
318 acpi_handle gpe_device;
321 struct list_head resources;
322 struct acpi_device_wakeup_flags flags;
323 struct acpi_device_wakeup_context context;
324 struct wakeup_source *ws;
329 struct acpi_device_physical_node {
330 unsigned int node_id;
331 struct list_head node;
336 struct acpi_device_properties {
338 const union acpi_object *properties;
339 struct list_head list;
342 /* ACPI Device Specific Data (_DSD) */
343 struct acpi_device_data {
344 const union acpi_object *pointer;
345 struct list_head properties;
346 const union acpi_object *of_compatible;
347 struct list_head subnodes;
350 struct acpi_gpio_mapping;
355 acpi_handle handle; /* no handle for fixed hardware */
356 struct fwnode_handle fwnode;
357 struct acpi_device *parent;
358 struct list_head children;
359 struct list_head node;
360 struct list_head wakeup_list;
361 struct list_head del_list;
362 struct acpi_device_status status;
363 struct acpi_device_flags flags;
364 struct acpi_device_pnp pnp;
365 struct acpi_device_power power;
366 struct acpi_device_wakeup wakeup;
367 struct acpi_device_perf performance;
368 struct acpi_device_dir dir;
369 struct acpi_device_data data;
370 struct acpi_scan_handler *handler;
371 struct acpi_hotplug_context *hp;
372 struct acpi_driver *driver;
373 const struct acpi_gpio_mapping *driver_gpios;
376 unsigned int physical_node_count;
377 unsigned int dep_unmet;
378 struct list_head physical_node_list;
379 struct mutex physical_node_lock;
380 void (*remove)(struct acpi_device *);
383 /* Non-device subnode */
384 struct acpi_data_node {
387 struct fwnode_handle fwnode;
388 struct fwnode_handle *parent;
389 struct acpi_device_data data;
390 struct list_head sibling;
392 struct completion kobj_done;
395 extern const struct fwnode_operations acpi_device_fwnode_ops;
396 extern const struct fwnode_operations acpi_data_fwnode_ops;
397 extern const struct fwnode_operations acpi_static_fwnode_ops;
399 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
400 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
402 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
404 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
407 #define to_acpi_device_node(__fwnode) \
409 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
411 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
412 container_of(__to_acpi_device_node_fwnode, \
413 struct acpi_device, fwnode) : \
417 #define to_acpi_data_node(__fwnode) \
419 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
421 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
422 container_of(__to_acpi_data_node_fwnode, \
423 struct acpi_data_node, fwnode) : \
427 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
429 return !IS_ERR_OR_NULL(fwnode) &&
430 fwnode->ops == &acpi_static_fwnode_ops;
433 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
436 return is_acpi_data_node(fwnode) ?
437 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
440 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
442 return &adev->fwnode;
445 static inline void *acpi_driver_data(struct acpi_device *d)
447 return d->driver_data;
450 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
451 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
453 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
455 *((u32 *)&adev->status) = sta;
458 static inline void acpi_set_hp_context(struct acpi_device *adev,
459 struct acpi_hotplug_context *hp)
465 void acpi_initialize_hp_context(struct acpi_device *adev,
466 struct acpi_hotplug_context *hp,
467 int (*notify)(struct acpi_device *, u32),
468 void (*uevent)(struct acpi_device *, u32));
470 /* acpi_device.dev.bus == &acpi_bus_type */
471 extern struct bus_type acpi_bus_type;
478 struct acpi_bus_event {
479 struct list_head node;
480 acpi_device_class device_class;
486 extern struct kobject *acpi_kobj;
487 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
488 void acpi_bus_private_data_handler(acpi_handle, void *);
489 int acpi_bus_get_private_data(acpi_handle, void **);
490 int acpi_bus_attach_private_data(acpi_handle, void *);
491 void acpi_bus_detach_private_data(acpi_handle);
492 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
493 extern int register_acpi_notifier(struct notifier_block *);
494 extern int unregister_acpi_notifier(struct notifier_block *);
500 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
501 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
502 void acpi_bus_put_acpi_device(struct acpi_device *adev);
503 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
504 unsigned long long *sta);
505 int acpi_bus_get_status(struct acpi_device *device);
507 int acpi_bus_set_power(acpi_handle handle, int state);
508 const char *acpi_power_state_string(int state);
509 int acpi_device_set_power(struct acpi_device *device, int state);
510 int acpi_bus_init_power(struct acpi_device *device);
511 int acpi_device_fix_up_power(struct acpi_device *device);
512 int acpi_bus_update_power(acpi_handle handle, int *state_p);
513 int acpi_device_update_power(struct acpi_device *device, int *state_p);
514 bool acpi_bus_power_manageable(acpi_handle handle);
515 int acpi_device_power_add_dependent(struct acpi_device *adev,
517 void acpi_device_power_remove_dependent(struct acpi_device *adev,
521 bool acpi_bus_can_wakeup(acpi_handle handle);
523 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
526 void acpi_scan_lock_acquire(void);
527 void acpi_scan_lock_release(void);
528 void acpi_lock_hp_context(void);
529 void acpi_unlock_hp_context(void);
530 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
531 int acpi_bus_register_driver(struct acpi_driver *driver);
532 void acpi_bus_unregister_driver(struct acpi_driver *driver);
533 int acpi_bus_scan(acpi_handle handle);
534 void acpi_bus_trim(struct acpi_device *start);
535 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
536 int acpi_match_device_ids(struct acpi_device *device,
537 const struct acpi_device_id *ids);
538 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
539 char *modalias, size_t len);
540 int acpi_create_dir(struct acpi_device *);
541 void acpi_remove_dir(struct acpi_device *);
543 static inline bool acpi_device_enumerated(struct acpi_device *adev)
545 return adev && adev->flags.initialized && adev->flags.visited;
549 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
550 * @__acpi_driver: acpi_driver struct
552 * Helper macro for ACPI drivers which do not do anything special in module
553 * init/exit. This eliminates a lot of boilerplate. Each module may only
554 * use this macro once, and calling it replaces module_init() and module_exit()
556 #define module_acpi_driver(__acpi_driver) \
557 module_driver(__acpi_driver, acpi_bus_register_driver, \
558 acpi_bus_unregister_driver)
561 * Bind physical devices with ACPI devices
563 struct acpi_bus_type {
564 struct list_head list;
566 bool (*match)(struct device *dev);
567 struct acpi_device * (*find_companion)(struct device *);
568 void (*setup)(struct device *);
569 void (*cleanup)(struct device *);
571 int register_acpi_bus_type(struct acpi_bus_type *);
572 int unregister_acpi_bus_type(struct acpi_bus_type *);
573 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
574 int acpi_unbind_one(struct device *dev);
576 struct acpi_pci_root {
577 struct acpi_device * device;
580 struct resource secondary; /* downstream bus range */
582 u32 osc_support_set; /* _OSC state of support bits */
583 u32 osc_control_set; /* _OSC state of control bits */
584 phys_addr_t mcfg_addr;
589 bool acpi_dma_supported(struct acpi_device *adev);
590 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
591 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
593 int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
595 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
596 u64 address, bool check_children);
597 int acpi_is_root_bridge(acpi_handle);
598 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
600 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
601 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
604 bool acpi_device_always_present(struct acpi_device *adev);
606 static inline bool acpi_device_always_present(struct acpi_device *adev)
613 void acpi_pm_wakeup_event(struct device *dev);
614 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
615 void (*func)(struct acpi_device_wakeup_context *context));
616 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
617 bool acpi_pm_device_can_wakeup(struct device *dev);
618 int acpi_pm_device_sleep_state(struct device *, int *, int);
619 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
620 int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable);
622 static inline void acpi_pm_wakeup_event(struct device *dev)
625 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
627 void (*func)(struct acpi_device_wakeup_context *context))
631 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
635 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
639 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
644 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
647 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
651 static inline int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable)
657 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
658 bool acpi_sleep_state_supported(u8 sleep_state);
660 static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
663 #ifdef CONFIG_ACPI_SLEEP
664 u32 acpi_target_system_state(void);
666 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
669 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
671 return adev->flags.power_manageable;
674 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
676 return adev->wakeup.flags.valid;
679 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
681 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
682 ((acpi_gbl_FADT.header.revision < 6) &&
683 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
686 static inline void acpi_dev_put(struct acpi_device *adev)
688 put_device(&adev->dev);
690 #else /* CONFIG_ACPI */
692 static inline int register_acpi_bus_type(void *bus) { return 0; }
693 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
695 #endif /* CONFIG_ACPI */
697 #endif /*__ACPI_BUS_H__*/