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 struct acpi_handle_list {
22 acpi_extract_package(union acpi_object *package,
23 struct acpi_buffer *format, struct acpi_buffer *buffer);
25 acpi_evaluate_integer(acpi_handle handle,
27 struct acpi_object_list *arguments, unsigned long long *data);
28 bool acpi_evaluate_reference(acpi_handle handle, acpi_string pathname,
29 struct acpi_object_list *arguments,
30 struct acpi_handle_list *list);
31 bool acpi_handle_list_equal(struct acpi_handle_list *list1,
32 struct acpi_handle_list *list2);
33 void acpi_handle_list_replace(struct acpi_handle_list *dst,
34 struct acpi_handle_list *src);
35 void acpi_handle_list_free(struct acpi_handle_list *list);
36 bool acpi_device_dep(acpi_handle target, acpi_handle match);
38 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
39 struct acpi_buffer *status_buf);
42 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
44 bool acpi_has_method(acpi_handle handle, char *name);
45 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
47 acpi_status acpi_evaluate_ej0(acpi_handle handle);
48 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
49 acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function);
50 bool acpi_ata_match(acpi_handle handle);
51 bool acpi_bay_match(acpi_handle handle);
52 bool acpi_dock_match(acpi_handle handle);
54 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
55 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
56 u64 rev, u64 func, union acpi_object *argv4);
58 static inline union acpi_object *
59 acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
60 u64 func, union acpi_object *argv4,
61 acpi_object_type type)
63 union acpi_object *obj;
65 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
66 if (obj && obj->type != type) {
75 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
77 .package.type = ACPI_TYPE_PACKAGE, \
78 .package.count = (cnt), \
79 .package.elements = (eles) \
82 bool acpi_dev_found(const char *hid);
83 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
84 bool acpi_reduced_hardware(void);
88 struct proc_dir_entry;
90 #define ACPI_BUS_FILE_ROOT "acpi"
91 extern struct proc_dir_entry *acpi_root_dir;
93 enum acpi_bus_device_type {
94 ACPI_BUS_TYPE_DEVICE = 0,
96 ACPI_BUS_TYPE_PROCESSOR,
97 ACPI_BUS_TYPE_THERMAL,
98 ACPI_BUS_TYPE_POWER_BUTTON,
99 ACPI_BUS_TYPE_SLEEP_BUTTON,
100 ACPI_BUS_TYPE_ECDT_EC,
101 ACPI_BUS_DEVICE_TYPE_COUNT
112 struct acpi_hotplug_profile {
114 int (*scan_dependent)(struct acpi_device *adev);
115 void (*notify_online)(struct acpi_device *adev);
117 bool demand_offline:1;
120 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
121 struct kobject *kobj)
123 return container_of(kobj, struct acpi_hotplug_profile, kobj);
126 struct acpi_scan_handler {
127 const struct acpi_device_id *ids;
128 struct list_head list_node;
129 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
130 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
131 void (*detach)(struct acpi_device *dev);
132 void (*bind)(struct device *phys_dev);
133 void (*unbind)(struct device *phys_dev);
134 struct acpi_hotplug_profile hotplug;
138 * ACPI Hotplug Context
139 * --------------------
142 struct acpi_hotplug_context {
143 struct acpi_device *self;
144 int (*notify)(struct acpi_device *, u32);
145 void (*uevent)(struct acpi_device *, u32);
146 void (*fixup)(struct acpi_device *);
154 typedef int (*acpi_op_add) (struct acpi_device * device);
155 typedef void (*acpi_op_remove) (struct acpi_device *device);
156 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
158 struct acpi_device_ops {
160 acpi_op_remove remove;
161 acpi_op_notify notify;
164 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
169 const struct acpi_device_id *ids; /* Supported Hardware IDs */
171 struct acpi_device_ops ops;
172 struct device_driver drv;
173 struct module *owner;
183 struct acpi_device_status {
188 u32 battery_present:1;
194 struct acpi_device_flags {
195 u32 dynamic_status:1;
198 u32 power_manageable:1;
202 u32 hotplug_notify:1;
203 u32 is_dock_station:1;
204 u32 of_compatible_ok:1;
207 u32 enumeration_by_parent:1;
214 struct acpi_device_dir {
215 struct proc_dir_entry *entry;
218 #define acpi_device_dir(d) ((d)->dir.entry)
222 typedef char acpi_bus_id[8];
223 typedef u64 acpi_bus_address;
224 typedef char acpi_device_name[40];
225 typedef char acpi_device_class[20];
227 struct acpi_hardware_id {
228 struct list_head list;
232 struct acpi_pnp_type {
240 struct acpi_device_pnp {
241 acpi_bus_id bus_id; /* Object name */
242 int instance_no; /* Instance number of this object */
243 struct acpi_pnp_type type; /* ID type */
244 acpi_bus_address bus_address; /* _ADR */
245 char *unique_id; /* _UID */
246 struct list_head ids; /* _HID and _CIDs */
247 acpi_device_name device_name; /* Driver-determined */
248 acpi_device_class device_class; /* " */
249 union acpi_object *str_obj; /* unicode string for _STR method */
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_uid(d) ((d)->pnp.unique_id)
256 #define acpi_device_name(d) ((d)->pnp.device_name)
257 #define acpi_device_class(d) ((d)->pnp.device_class)
259 /* Power Management */
261 struct acpi_device_power_flags {
262 u32 explicit_get:1; /* _PSC present? */
263 u32 power_resources:1; /* Power resources */
264 u32 inrush_current:1; /* Serialize Dx->D0 */
265 u32 power_removed:1; /* Optimize Dx->D0 */
266 u32 ignore_parent:1; /* Power is independent of parent power state */
267 u32 dsw_present:1; /* _DSW present? */
271 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) */
286 u8 state_for_enumeration; /* Deepest power state for enumeration */
289 struct acpi_dep_data {
290 struct list_head node;
291 acpi_handle supplier;
292 acpi_handle consumer;
298 /* Performance Management */
300 struct acpi_device_perf_flags {
304 struct acpi_device_perf_state {
309 u8 power; /* % Power (compared to P0) */
310 u8 performance; /* % Performance ( " ) */
311 int latency; /* Px->P0 time (microseconds) */
314 struct acpi_device_perf {
316 struct acpi_device_perf_flags flags;
318 struct acpi_device_perf_state *states;
321 /* Wakeup Management */
322 struct acpi_device_wakeup_flags {
323 u8 valid:1; /* Can successfully enable wakeup? */
324 u8 notifier_present:1; /* Wake-up notify handler has been installed */
327 struct acpi_device_wakeup_context {
328 void (*func)(struct acpi_device_wakeup_context *context);
332 struct acpi_device_wakeup {
333 acpi_handle gpe_device;
336 struct list_head resources;
337 struct acpi_device_wakeup_flags flags;
338 struct acpi_device_wakeup_context context;
339 struct wakeup_source *ws;
344 struct acpi_device_physical_node {
345 unsigned int node_id;
346 struct list_head node;
351 struct acpi_device_properties {
353 union acpi_object *properties;
354 struct list_head list;
358 /* ACPI Device Specific Data (_DSD) */
359 struct acpi_device_data {
360 const union acpi_object *pointer;
361 struct list_head properties;
362 const union acpi_object *of_compatible;
363 struct list_head subnodes;
366 struct acpi_gpio_mapping;
368 #define ACPI_DEVICE_SWNODE_ROOT 0
371 * The maximum expected number of CSI-2 data lanes.
373 * This number is not expected to ever have to be equal to or greater than the
374 * number of bits in an unsigned long variable, but if it needs to be increased
375 * above that limit, code will need to be adjusted accordingly.
377 #define ACPI_DEVICE_CSI2_DATA_LANES 8
379 #define ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH 8
381 enum acpi_device_swnode_dev_props {
382 ACPI_DEVICE_SWNODE_DEV_ROTATION,
383 ACPI_DEVICE_SWNODE_DEV_CLOCK_FREQUENCY,
384 ACPI_DEVICE_SWNODE_DEV_LED_MAX_MICROAMP,
385 ACPI_DEVICE_SWNODE_DEV_FLASH_MAX_MICROAMP,
386 ACPI_DEVICE_SWNODE_DEV_FLASH_MAX_TIMEOUT_US,
387 ACPI_DEVICE_SWNODE_DEV_NUM_OF,
388 ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES
391 enum acpi_device_swnode_port_props {
392 ACPI_DEVICE_SWNODE_PORT_REG,
393 ACPI_DEVICE_SWNODE_PORT_NUM_OF,
394 ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES
397 enum acpi_device_swnode_ep_props {
398 ACPI_DEVICE_SWNODE_EP_REMOTE_EP,
399 ACPI_DEVICE_SWNODE_EP_BUS_TYPE,
400 ACPI_DEVICE_SWNODE_EP_REG,
401 ACPI_DEVICE_SWNODE_EP_CLOCK_LANES,
402 ACPI_DEVICE_SWNODE_EP_DATA_LANES,
403 ACPI_DEVICE_SWNODE_EP_LANE_POLARITIES,
405 ACPI_DEVICE_SWNODE_EP_LINK_FREQUENCIES,
406 ACPI_DEVICE_SWNODE_EP_NUM_OF,
407 ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES
411 * Each device has a root software node plus two times as many nodes as the
412 * number of CSI-2 ports.
414 #define ACPI_DEVICE_SWNODE_PORT(port) (2 * (port) + 1)
415 #define ACPI_DEVICE_SWNODE_EP(endpoint) \
416 (ACPI_DEVICE_SWNODE_PORT(endpoint) + 1)
419 * struct acpi_device_software_node_port - MIPI DisCo for Imaging CSI-2 port
420 * @port_name: Port name.
421 * @data_lanes: "data-lanes" property values.
422 * @lane_polarities: "lane-polarities" property values.
423 * @link_frequencies: "link_frequencies" property values.
424 * @port_nr: Port number.
425 * @crs_crs2_local: _CRS CSI2 record present (i.e. this is a transmitter one).
426 * @port_props: Port properties.
427 * @ep_props: Endpoint properties.
428 * @remote_ep: Reference to the remote endpoint.
430 struct acpi_device_software_node_port {
431 char port_name[ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH + 1];
432 u32 data_lanes[ACPI_DEVICE_CSI2_DATA_LANES];
433 u32 lane_polarities[ACPI_DEVICE_CSI2_DATA_LANES + 1 /* clock lane */];
434 u64 link_frequencies[ACPI_DEVICE_CSI2_DATA_LANES];
435 unsigned int port_nr;
438 struct property_entry port_props[ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES];
439 struct property_entry ep_props[ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES];
441 struct software_node_ref_args remote_ep[1];
445 * struct acpi_device_software_nodes - Software nodes for an ACPI device
446 * @dev_props: Device properties.
447 * @nodes: Software nodes for root as well as ports and endpoints.
448 * @nodeprts: Array of software node pointers, for (un)registering them.
449 * @ports: Information related to each port and endpoint within a port.
450 * @num_ports: The number of ports.
452 struct acpi_device_software_nodes {
453 struct property_entry dev_props[ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES];
454 struct software_node *nodes;
455 const struct software_node **nodeptrs;
456 struct acpi_device_software_node_port *ports;
457 unsigned int num_ports;
464 acpi_handle handle; /* no handle for fixed hardware */
465 struct fwnode_handle fwnode;
466 struct list_head wakeup_list;
467 struct list_head del_list;
468 struct acpi_device_status status;
469 struct acpi_device_flags flags;
470 struct acpi_device_pnp pnp;
471 struct acpi_device_power power;
472 struct acpi_device_wakeup wakeup;
473 struct acpi_device_perf performance;
474 struct acpi_device_dir dir;
475 struct acpi_device_data data;
476 struct acpi_scan_handler *handler;
477 struct acpi_hotplug_context *hp;
478 struct acpi_device_software_nodes *swnodes;
479 const struct acpi_gpio_mapping *driver_gpios;
482 unsigned int physical_node_count;
483 unsigned int dep_unmet;
484 struct list_head physical_node_list;
485 struct mutex physical_node_lock;
486 void (*remove)(struct acpi_device *);
489 /* Non-device subnode */
490 struct acpi_data_node {
493 struct fwnode_handle fwnode;
494 struct fwnode_handle *parent;
495 struct acpi_device_data data;
496 struct list_head sibling;
498 struct completion kobj_done;
501 extern const struct fwnode_operations acpi_device_fwnode_ops;
502 extern const struct fwnode_operations acpi_data_fwnode_ops;
503 extern const struct fwnode_operations acpi_static_fwnode_ops;
505 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
506 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
508 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
510 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
513 #define to_acpi_device_node(__fwnode) \
515 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
517 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
518 container_of(__to_acpi_device_node_fwnode, \
519 struct acpi_device, fwnode) : \
523 #define to_acpi_data_node(__fwnode) \
525 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
527 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
528 container_of(__to_acpi_data_node_fwnode, \
529 struct acpi_data_node, fwnode) : \
533 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
535 return !IS_ERR_OR_NULL(fwnode) &&
536 fwnode->ops == &acpi_static_fwnode_ops;
539 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
542 return is_acpi_data_node(fwnode) ?
543 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
546 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
548 return &adev->fwnode;
551 static inline void *acpi_driver_data(struct acpi_device *d)
553 return d->driver_data;
556 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
557 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
559 static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev)
561 if (adev->dev.parent)
562 return to_acpi_device(adev->dev.parent);
567 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
569 *((u32 *)&adev->status) = sta;
572 static inline void acpi_set_hp_context(struct acpi_device *adev,
573 struct acpi_hotplug_context *hp)
579 void acpi_initialize_hp_context(struct acpi_device *adev,
580 struct acpi_hotplug_context *hp,
581 int (*notify)(struct acpi_device *, u32),
582 void (*uevent)(struct acpi_device *, u32));
584 /* acpi_device.dev.bus == &acpi_bus_type */
585 extern struct bus_type acpi_bus_type;
587 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
588 int acpi_dev_for_each_child(struct acpi_device *adev,
589 int (*fn)(struct acpi_device *, void *), void *data);
590 int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
591 int (*fn)(struct acpi_device *, void *),
599 struct acpi_bus_event {
600 struct list_head node;
601 acpi_device_class device_class;
607 extern struct kobject *acpi_kobj;
608 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
609 void acpi_bus_private_data_handler(acpi_handle, void *);
610 int acpi_bus_get_private_data(acpi_handle, void **);
611 int acpi_bus_attach_private_data(acpi_handle, void *);
612 void acpi_bus_detach_private_data(acpi_handle);
613 int acpi_dev_install_notify_handler(struct acpi_device *adev,
615 acpi_notify_handler handler, void *context);
616 void acpi_dev_remove_notify_handler(struct acpi_device *adev,
618 acpi_notify_handler handler);
619 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
620 extern int register_acpi_notifier(struct notifier_block *);
621 extern int unregister_acpi_notifier(struct notifier_block *);
627 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
628 unsigned long long *sta);
629 int acpi_bus_get_status(struct acpi_device *device);
631 int acpi_bus_set_power(acpi_handle handle, int state);
632 const char *acpi_power_state_string(int state);
633 int acpi_device_set_power(struct acpi_device *device, int state);
634 int acpi_bus_init_power(struct acpi_device *device);
635 int acpi_device_fix_up_power(struct acpi_device *device);
636 void acpi_device_fix_up_power_extended(struct acpi_device *adev);
637 void acpi_device_fix_up_power_children(struct acpi_device *adev);
638 int acpi_bus_update_power(acpi_handle handle, int *state_p);
639 int acpi_device_update_power(struct acpi_device *device, int *state_p);
640 bool acpi_bus_power_manageable(acpi_handle handle);
641 void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
642 u8 acpi_dev_power_state_for_wake(struct acpi_device *adev);
643 int acpi_device_power_add_dependent(struct acpi_device *adev,
645 void acpi_device_power_remove_dependent(struct acpi_device *adev,
649 bool acpi_bus_can_wakeup(acpi_handle handle);
651 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
654 void acpi_scan_lock_acquire(void);
655 void acpi_scan_lock_release(void);
656 void acpi_lock_hp_context(void);
657 void acpi_unlock_hp_context(void);
658 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
659 int acpi_bus_register_driver(struct acpi_driver *driver);
660 void acpi_bus_unregister_driver(struct acpi_driver *driver);
661 int acpi_bus_scan(acpi_handle handle);
662 void acpi_bus_trim(struct acpi_device *start);
663 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
664 int acpi_match_device_ids(struct acpi_device *device,
665 const struct acpi_device_id *ids);
666 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
667 char *modalias, size_t len);
669 static inline bool acpi_device_enumerated(struct acpi_device *adev)
671 return adev && adev->flags.initialized && adev->flags.visited;
675 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
676 * @__acpi_driver: acpi_driver struct
678 * Helper macro for ACPI drivers which do not do anything special in module
679 * init/exit. This eliminates a lot of boilerplate. Each module may only
680 * use this macro once, and calling it replaces module_init() and module_exit()
682 #define module_acpi_driver(__acpi_driver) \
683 module_driver(__acpi_driver, acpi_bus_register_driver, \
684 acpi_bus_unregister_driver)
687 * Bind physical devices with ACPI devices
689 struct acpi_bus_type {
690 struct list_head list;
692 bool (*match)(struct device *dev);
693 struct acpi_device * (*find_companion)(struct device *);
694 void (*setup)(struct device *);
696 int register_acpi_bus_type(struct acpi_bus_type *);
697 int unregister_acpi_bus_type(struct acpi_bus_type *);
698 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
699 int acpi_unbind_one(struct device *dev);
701 enum acpi_bridge_type {
702 ACPI_BRIDGE_TYPE_PCIE = 1,
703 ACPI_BRIDGE_TYPE_CXL,
706 struct acpi_pci_root {
707 struct acpi_device * device;
711 struct resource secondary; /* downstream bus range */
713 u32 osc_support_set; /* _OSC state of support bits */
714 u32 osc_control_set; /* _OSC state of control bits */
715 u32 osc_ext_support_set; /* _OSC state of extended support bits */
716 u32 osc_ext_control_set; /* _OSC state of extended control bits */
717 phys_addr_t mcfg_addr;
724 bool acpi_dma_supported(const struct acpi_device *adev);
725 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
726 int acpi_iommu_fwspec_init(struct device *dev, u32 id,
727 struct fwnode_handle *fwnode,
728 const struct iommu_ops *ops);
729 int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map);
730 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
731 const u32 *input_id);
732 static inline int acpi_dma_configure(struct device *dev,
733 enum dev_dma_attr attr)
735 return acpi_dma_configure_id(dev, attr, NULL);
737 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
738 u64 address, bool check_children);
739 struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
740 acpi_bus_address adr);
741 int acpi_is_root_bridge(acpi_handle);
742 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
744 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
745 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
748 bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
749 bool acpi_quirk_skip_acpi_ac_and_battery(void);
750 int acpi_install_cmos_rtc_space_handler(acpi_handle handle);
751 void acpi_remove_cmos_rtc_space_handler(acpi_handle handle);
753 static inline bool acpi_device_override_status(struct acpi_device *adev,
754 unsigned long long *status)
758 static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
762 static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle)
766 static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle)
771 #if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
772 bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
773 int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
774 bool acpi_quirk_skip_gpio_event_handlers(void);
776 static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
781 acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
786 static inline bool acpi_quirk_skip_gpio_event_handlers(void)
793 void acpi_pm_wakeup_event(struct device *dev);
794 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
795 void (*func)(struct acpi_device_wakeup_context *context));
796 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
797 bool acpi_pm_device_can_wakeup(struct device *dev);
798 int acpi_pm_device_sleep_state(struct device *, int *, int);
799 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
801 static inline void acpi_pm_wakeup_event(struct device *dev)
804 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
806 void (*func)(struct acpi_device_wakeup_context *context))
810 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
814 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
818 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
823 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
826 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
832 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
833 bool acpi_sleep_state_supported(u8 sleep_state);
835 static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
838 #ifdef CONFIG_ACPI_SLEEP
839 u32 acpi_target_system_state(void);
841 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
844 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
846 return adev->flags.power_manageable;
849 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
851 return adev->wakeup.flags.valid;
854 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
856 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
857 ((acpi_gbl_FADT.header.revision < 6) &&
858 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
861 int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer);
863 static inline bool acpi_dev_hid_match(struct acpi_device *adev, const char *hid2)
865 const char *hid1 = acpi_device_hid(adev);
867 return hid1 && hid2 && !strcmp(hid1, hid2);
870 static inline bool acpi_str_uid_match(struct acpi_device *adev, const char *uid2)
872 const char *uid1 = acpi_device_uid(adev);
874 return uid1 && uid2 && !strcmp(uid1, uid2);
877 static inline bool acpi_int_uid_match(struct acpi_device *adev, u64 uid2)
881 return !acpi_dev_uid_to_integer(adev, &uid1) && uid1 == uid2;
884 #define TYPE_ENTRY(type, x) \
888 #define ACPI_STR_TYPES(match) \
889 TYPE_ENTRY(unsigned char *, match), \
890 TYPE_ENTRY(signed char *, match), \
891 TYPE_ENTRY(char *, match), \
892 TYPE_ENTRY(void *, match)
895 * acpi_dev_uid_match - Match device by supplied UID
896 * @adev: ACPI device to match.
897 * @uid2: Unique ID of the device.
899 * Matches UID in @adev with given @uid2.
901 * Returns: %true if matches, %false otherwise.
903 #define acpi_dev_uid_match(adev, uid2) \
905 /* Treat @uid2 as a string for acpi string types */ \
906 ACPI_STR_TYPES(acpi_str_uid_match), \
907 /* Treat as an integer otherwise */ \
908 default: acpi_int_uid_match)(adev, uid2)
911 * acpi_dev_hid_uid_match - Match device by supplied HID and UID
912 * @adev: ACPI device to match.
913 * @hid2: Hardware ID of the device.
914 * @uid2: Unique ID of the device, pass 0 or NULL to not check _UID.
916 * Matches HID and UID in @adev with given @hid2 and @uid2. Absence of @uid2
917 * will be treated as a match. If user wants to validate @uid2, it should be
918 * done before calling this function.
920 * Returns: %true if matches or @uid2 is 0 or NULL, %false otherwise.
922 #define acpi_dev_hid_uid_match(adev, hid2, uid2) \
923 (acpi_dev_hid_match(adev, hid2) && \
924 (!(uid2) || acpi_dev_uid_match(adev, uid2)))
926 void acpi_dev_clear_dependencies(struct acpi_device *supplier);
927 bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
928 struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
929 struct acpi_device *start);
932 * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a
934 * @supplier: Pointer to the supplier's ACPI device
935 * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL
937 #define for_each_acpi_consumer_dev(supplier, consumer) \
938 for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \
940 consumer = acpi_dev_get_next_consumer_dev(supplier, consumer))
943 acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
945 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
948 * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
949 * @adev: pointer to the matching ACPI device, NULL at the end of the loop
950 * @hid: Hardware ID of the device.
951 * @uid: Unique ID of the device, pass NULL to not check _UID
952 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
954 * The caller is responsible for invoking acpi_dev_put() on the returned device.
956 #define for_each_acpi_dev_match(adev, hid, uid, hrv) \
957 for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \
959 adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
961 static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
963 return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
966 static inline void acpi_dev_put(struct acpi_device *adev)
969 put_device(&adev->dev);
972 struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
973 struct acpi_device *acpi_get_acpi_dev(acpi_handle handle);
975 static inline void acpi_put_acpi_dev(struct acpi_device *adev)
979 #else /* CONFIG_ACPI */
981 static inline int register_acpi_bus_type(void *bus) { return 0; }
982 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
984 #endif /* CONFIG_ACPI */
986 #endif /*__ACPI_BUS_H__*/