1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
4 *
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 */
8
9#ifndef __ACPI_BUS_H__
10#define __ACPI_BUS_H__
11
12#include <linux/device.h>
13#include <linux/property.h>
14
15struct acpi_handle_list {
16 u32 count;
17 acpi_handle* handles;
18};
19
20/* acpi_utils.h */
21acpi_status
22acpi_extract_package(union acpi_object *package,
23 struct acpi_buffer *format, struct acpi_buffer *buffer);
24acpi_status
25acpi_evaluate_integer(acpi_handle handle,
26 acpi_string pathname,
27 struct acpi_object_list *arguments, unsigned long long *data);
28acpi_status
29acpi_evaluate_reference(acpi_handle handle,
30 acpi_string pathname,
31 struct acpi_object_list *arguments,
32 struct acpi_handle_list *list);
33bool acpi_handle_list_equal(struct acpi_handle_list *list1,
34 struct acpi_handle_list *list2);
35void acpi_handle_list_replace(struct acpi_handle_list *dst,
36 struct acpi_handle_list *src);
37void acpi_handle_list_free(struct acpi_handle_list *list);
38acpi_status
39acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
40 struct acpi_buffer *status_buf);
41
42acpi_status
43acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
44
45bool acpi_has_method(acpi_handle handle, char *name);
46acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
47 u64 arg);
48acpi_status acpi_evaluate_ej0(acpi_handle handle);
49acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
50acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function);
51bool acpi_ata_match(acpi_handle handle);
52bool acpi_bay_match(acpi_handle handle);
53bool acpi_dock_match(acpi_handle handle);
54
55bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
56union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
57 u64 rev, u64 func, union acpi_object *argv4);
58#ifdef CONFIG_ACPI
59static inline union acpi_object *
60acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
61 u64 func, union acpi_object *argv4,
62 acpi_object_type type)
63{
64 union acpi_object *obj;
65
66 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
67 if (obj && obj->type != type) {
68 ACPI_FREE(obj);
69 obj = NULL;
70 }
71
72 return obj;
73}
74#endif
75
76#define ACPI_INIT_DSM_ARGV4(cnt, eles) \
77 { \
78 .package.type = ACPI_TYPE_PACKAGE, \
79 .package.count = (cnt), \
80 .package.elements = (eles) \
81 }
82
83bool acpi_dev_found(const char *hid);
84bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
85bool acpi_reduced_hardware(void);
86
87#ifdef CONFIG_ACPI
88
89struct proc_dir_entry;
90
91#define ACPI_BUS_FILE_ROOT "acpi"
92extern struct proc_dir_entry *acpi_root_dir;
93
94enum acpi_bus_device_type {
95 ACPI_BUS_TYPE_DEVICE = 0,
96 ACPI_BUS_TYPE_POWER,
97 ACPI_BUS_TYPE_PROCESSOR,
98 ACPI_BUS_TYPE_THERMAL,
99 ACPI_BUS_TYPE_POWER_BUTTON,
100 ACPI_BUS_TYPE_SLEEP_BUTTON,
101 ACPI_BUS_TYPE_ECDT_EC,
102 ACPI_BUS_DEVICE_TYPE_COUNT
103};
104
105struct acpi_driver;
106struct acpi_device;
107
108/*
109 * ACPI Scan Handler
110 * -----------------
111 */
112
113struct acpi_hotplug_profile {
114 struct kobject kobj;
115 int (*scan_dependent)(struct acpi_device *adev);
116 void (*notify_online)(struct acpi_device *adev);
117 bool enabled:1;
118 bool demand_offline:1;
119};
120
121static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
122 struct kobject *kobj)
123{
124 return container_of(kobj, struct acpi_hotplug_profile, kobj);
125}
126
127struct acpi_scan_handler {
128 const struct acpi_device_id *ids;
129 struct list_head list_node;
130 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
131 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
132 void (*detach)(struct acpi_device *dev);
133 void (*bind)(struct device *phys_dev);
134 void (*unbind)(struct device *phys_dev);
135 struct acpi_hotplug_profile hotplug;
136};
137
138/*
139 * ACPI Hotplug Context
140 * --------------------
141 */
142
143struct acpi_hotplug_context {
144 struct acpi_device *self;
145 int (*notify)(struct acpi_device *, u32);
146 void (*uevent)(struct acpi_device *, u32);
147 void (*fixup)(struct acpi_device *);
148};
149
150/*
151 * ACPI Driver
152 * -----------
153 */
154
155typedef int (*acpi_op_add) (struct acpi_device * device);
156typedef void (*acpi_op_remove) (struct acpi_device *device);
157typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
158
159struct acpi_device_ops {
160 acpi_op_add add;
161 acpi_op_remove remove;
162 acpi_op_notify notify;
163};
164
165#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
166
167struct acpi_driver {
168 char name[80];
169 char class[80];
170 const struct acpi_device_id *ids; /* Supported Hardware IDs */
171 unsigned int flags;
172 struct acpi_device_ops ops;
173 struct device_driver drv;
174 struct module *owner;
175};
176
177/*
178 * ACPI Device
179 * -----------
180 */
181
182/* Status (_STA) */
183
184struct acpi_device_status {
185 u32 present:1;
186 u32 enabled:1;
187 u32 show_in_ui:1;
188 u32 functional:1;
189 u32 battery_present:1;
190 u32 reserved:27;
191};
192
193/* Flags */
194
195struct acpi_device_flags {
196 u32 dynamic_status:1;
197 u32 removable:1;
198 u32 ejectable:1;
199 u32 power_manageable:1;
200 u32 match_driver:1;
201 u32 initialized:1;
202 u32 visited:1;
203 u32 hotplug_notify:1;
204 u32 is_dock_station:1;
205 u32 of_compatible_ok:1;
206 u32 coherent_dma:1;
207 u32 cca_seen:1;
208 u32 enumeration_by_parent:1;
209 u32 honor_deps:1;
210 u32 reserved:18;
211};
212
213/* File System */
214
215struct acpi_device_dir {
216 struct proc_dir_entry *entry;
217};
218
219#define acpi_device_dir(d) ((d)->dir.entry)
220
221/* Plug and Play */
222
223typedef char acpi_bus_id[8];
224typedef u64 acpi_bus_address;
225typedef char acpi_device_name[40];
226typedef char acpi_device_class[20];
227
228struct acpi_hardware_id {
229 struct list_head list;
230 const char *id;
231};
232
233struct acpi_pnp_type {
234 u32 hardware_id:1;
235 u32 bus_address:1;
236 u32 platform_id:1;
237 u32 backlight:1;
238 u32 reserved:28;
239};
240
241struct acpi_device_pnp {
242 acpi_bus_id bus_id; /* Object name */
243 int instance_no; /* Instance number of this object */
244 struct acpi_pnp_type type; /* ID type */
245 acpi_bus_address bus_address; /* _ADR */
246 char *unique_id; /* _UID */
247 struct list_head ids; /* _HID and _CIDs */
248 acpi_device_name device_name; /* Driver-determined */
249 acpi_device_class device_class; /* " */
250 union acpi_object *str_obj; /* unicode string for _STR method */
251};
252
253#define acpi_device_bid(d) ((d)->pnp.bus_id)
254#define acpi_device_adr(d) ((d)->pnp.bus_address)
255const char *acpi_device_hid(struct acpi_device *device);
256#define acpi_device_uid(d) ((d)->pnp.unique_id)
257#define acpi_device_name(d) ((d)->pnp.device_name)
258#define acpi_device_class(d) ((d)->pnp.device_class)
259
260/* Power Management */
261
262struct acpi_device_power_flags {
263 u32 explicit_get:1; /* _PSC present? */
264 u32 power_resources:1; /* Power resources */
265 u32 inrush_current:1; /* Serialize Dx->D0 */
266 u32 power_removed:1; /* Optimize Dx->D0 */
267 u32 ignore_parent:1; /* Power is independent of parent power state */
268 u32 dsw_present:1; /* _DSW present? */
269 u32 reserved:26;
270};
271
272struct acpi_device_power_state {
273 struct {
274 u8 valid:1;
275 u8 explicit_set:1; /* _PSx present? */
276 u8 reserved:6;
277 } flags;
278 int power; /* % Power (compared to D0) */
279 int latency; /* Dx->D0 time (microseconds) */
280 struct list_head resources; /* Power resources referenced */
281};
282
283struct acpi_device_power {
284 int state; /* Current state */
285 struct acpi_device_power_flags flags;
286 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
287 u8 state_for_enumeration; /* Deepest power state for enumeration */
288};
289
290struct acpi_dep_data {
291 struct list_head node;
292 acpi_handle supplier;
293 acpi_handle consumer;
294 bool honor_dep;
295 bool met;
296 bool free_when_met;
297};
298
299/* Performance Management */
300
301struct acpi_device_perf_flags {
302 u8 reserved:8;
303};
304
305struct acpi_device_perf_state {
306 struct {
307 u8 valid:1;
308 u8 reserved:7;
309 } flags;
310 u8 power; /* % Power (compared to P0) */
311 u8 performance; /* % Performance ( " ) */
312 int latency; /* Px->P0 time (microseconds) */
313};
314
315struct acpi_device_perf {
316 int state;
317 struct acpi_device_perf_flags flags;
318 int state_count;
319 struct acpi_device_perf_state *states;
320};
321
322/* Wakeup Management */
323struct acpi_device_wakeup_flags {
324 u8 valid:1; /* Can successfully enable wakeup? */
325 u8 notifier_present:1; /* Wake-up notify handler has been installed */
326};
327
328struct acpi_device_wakeup_context {
329 void (*func)(struct acpi_device_wakeup_context *context);
330 struct device *dev;
331};
332
333struct acpi_device_wakeup {
334 acpi_handle gpe_device;
335 u64 gpe_number;
336 u64 sleep_state;
337 struct list_head resources;
338 struct acpi_device_wakeup_flags flags;
339 struct acpi_device_wakeup_context context;
340 struct wakeup_source *ws;
341 int prepare_count;
342 int enable_count;
343};
344
345struct acpi_device_physical_node {
346 unsigned int node_id;
347 struct list_head node;
348 struct device *dev;
349 bool put_online:1;
350};
351
352struct acpi_device_properties {
353 const guid_t *guid;
354 union acpi_object *properties;
355 struct list_head list;
356 void **bufs;
357};
358
359/* ACPI Device Specific Data (_DSD) */
360struct acpi_device_data {
361 const union acpi_object *pointer;
362 struct list_head properties;
363 const union acpi_object *of_compatible;
364 struct list_head subnodes;
365};
366
367struct acpi_gpio_mapping;
368
369/* Device */
370struct acpi_device {
371 u32 pld_crc;
372 int device_type;
373 acpi_handle handle; /* no handle for fixed hardware */
374 struct fwnode_handle fwnode;
375 struct list_head wakeup_list;
376 struct list_head del_list;
377 struct acpi_device_status status;
378 struct acpi_device_flags flags;
379 struct acpi_device_pnp pnp;
380 struct acpi_device_power power;
381 struct acpi_device_wakeup wakeup;
382 struct acpi_device_perf performance;
383 struct acpi_device_dir dir;
384 struct acpi_device_data data;
385 struct acpi_scan_handler *handler;
386 struct acpi_hotplug_context *hp;
387 const struct acpi_gpio_mapping *driver_gpios;
388 void *driver_data;
389 struct device dev;
390 unsigned int physical_node_count;
391 unsigned int dep_unmet;
392 struct list_head physical_node_list;
393 struct mutex physical_node_lock;
394 void (*remove)(struct acpi_device *);
395};
396
397/* Non-device subnode */
398struct acpi_data_node {
399 const char *name;
400 acpi_handle handle;
401 struct fwnode_handle fwnode;
402 struct fwnode_handle *parent;
403 struct acpi_device_data data;
404 struct list_head sibling;
405 struct kobject kobj;
406 struct completion kobj_done;
407};
408
409extern const struct fwnode_operations acpi_device_fwnode_ops;
410extern const struct fwnode_operations acpi_data_fwnode_ops;
411extern const struct fwnode_operations acpi_static_fwnode_ops;
412
413bool is_acpi_device_node(const struct fwnode_handle *fwnode);
414bool is_acpi_data_node(const struct fwnode_handle *fwnode);
415
416static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
417{
418 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
419}
420
421#define to_acpi_device_node(__fwnode) \
422 ({ \
423 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
424 \
425 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
426 container_of(__to_acpi_device_node_fwnode, \
427 struct acpi_device, fwnode) : \
428 NULL; \
429 })
430
431#define to_acpi_data_node(__fwnode) \
432 ({ \
433 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
434 \
435 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
436 container_of(__to_acpi_data_node_fwnode, \
437 struct acpi_data_node, fwnode) : \
438 NULL; \
439 })
440
441static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
442{
443 return !IS_ERR_OR_NULL(ptr: fwnode) &&
444 fwnode->ops == &acpi_static_fwnode_ops;
445}
446
447static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
448 const char *name)
449{
450 return is_acpi_data_node(fwnode) ?
451 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
452}
453
454static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
455{
456 return &adev->fwnode;
457}
458
459static inline void *acpi_driver_data(struct acpi_device *d)
460{
461 return d->driver_data;
462}
463
464#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
465#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
466
467static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev)
468{
469 if (adev->dev.parent)
470 return to_acpi_device(adev->dev.parent);
471
472 return NULL;
473}
474
475static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
476{
477 *((u32 *)&adev->status) = sta;
478}
479
480static inline void acpi_set_hp_context(struct acpi_device *adev,
481 struct acpi_hotplug_context *hp)
482{
483 hp->self = adev;
484 adev->hp = hp;
485}
486
487void acpi_initialize_hp_context(struct acpi_device *adev,
488 struct acpi_hotplug_context *hp,
489 int (*notify)(struct acpi_device *, u32),
490 void (*uevent)(struct acpi_device *, u32));
491
492/* acpi_device.dev.bus == &acpi_bus_type */
493extern struct bus_type acpi_bus_type;
494
495int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
496int acpi_dev_for_each_child(struct acpi_device *adev,
497 int (*fn)(struct acpi_device *, void *), void *data);
498int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
499 int (*fn)(struct acpi_device *, void *),
500 void *data);
501
502/*
503 * Events
504 * ------
505 */
506
507struct acpi_bus_event {
508 struct list_head node;
509 acpi_device_class device_class;
510 acpi_bus_id bus_id;
511 u32 type;
512 u32 data;
513};
514
515extern struct kobject *acpi_kobj;
516extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
517void acpi_bus_private_data_handler(acpi_handle, void *);
518int acpi_bus_get_private_data(acpi_handle, void **);
519int acpi_bus_attach_private_data(acpi_handle, void *);
520void acpi_bus_detach_private_data(acpi_handle);
521int acpi_dev_install_notify_handler(struct acpi_device *adev,
522 u32 handler_type,
523 acpi_notify_handler handler, void *context);
524void acpi_dev_remove_notify_handler(struct acpi_device *adev,
525 u32 handler_type,
526 acpi_notify_handler handler);
527extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
528extern int register_acpi_notifier(struct notifier_block *);
529extern int unregister_acpi_notifier(struct notifier_block *);
530
531/*
532 * External Functions
533 */
534
535acpi_status acpi_bus_get_status_handle(acpi_handle handle,
536 unsigned long long *sta);
537int acpi_bus_get_status(struct acpi_device *device);
538
539int acpi_bus_set_power(acpi_handle handle, int state);
540const char *acpi_power_state_string(int state);
541int acpi_device_set_power(struct acpi_device *device, int state);
542int acpi_bus_init_power(struct acpi_device *device);
543int acpi_device_fix_up_power(struct acpi_device *device);
544void acpi_device_fix_up_power_extended(struct acpi_device *adev);
545int acpi_bus_update_power(acpi_handle handle, int *state_p);
546int acpi_device_update_power(struct acpi_device *device, int *state_p);
547bool acpi_bus_power_manageable(acpi_handle handle);
548void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
549u8 acpi_dev_power_state_for_wake(struct acpi_device *adev);
550int acpi_device_power_add_dependent(struct acpi_device *adev,
551 struct device *dev);
552void acpi_device_power_remove_dependent(struct acpi_device *adev,
553 struct device *dev);
554
555#ifdef CONFIG_PM
556bool acpi_bus_can_wakeup(acpi_handle handle);
557#else
558static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
559#endif
560
561void acpi_scan_lock_acquire(void);
562void acpi_scan_lock_release(void);
563void acpi_lock_hp_context(void);
564void acpi_unlock_hp_context(void);
565int acpi_scan_add_handler(struct acpi_scan_handler *handler);
566int acpi_bus_register_driver(struct acpi_driver *driver);
567void acpi_bus_unregister_driver(struct acpi_driver *driver);
568int acpi_bus_scan(acpi_handle handle);
569void acpi_bus_trim(struct acpi_device *start);
570acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
571int acpi_match_device_ids(struct acpi_device *device,
572 const struct acpi_device_id *ids);
573void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
574 char *modalias, size_t len);
575
576static inline bool acpi_device_enumerated(struct acpi_device *adev)
577{
578 return adev && adev->flags.initialized && adev->flags.visited;
579}
580
581/**
582 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
583 * @__acpi_driver: acpi_driver struct
584 *
585 * Helper macro for ACPI drivers which do not do anything special in module
586 * init/exit. This eliminates a lot of boilerplate. Each module may only
587 * use this macro once, and calling it replaces module_init() and module_exit()
588 */
589#define module_acpi_driver(__acpi_driver) \
590 module_driver(__acpi_driver, acpi_bus_register_driver, \
591 acpi_bus_unregister_driver)
592
593/*
594 * Bind physical devices with ACPI devices
595 */
596struct acpi_bus_type {
597 struct list_head list;
598 const char *name;
599 bool (*match)(struct device *dev);
600 struct acpi_device * (*find_companion)(struct device *);
601 void (*setup)(struct device *);
602};
603int register_acpi_bus_type(struct acpi_bus_type *);
604int unregister_acpi_bus_type(struct acpi_bus_type *);
605int acpi_bind_one(struct device *dev, struct acpi_device *adev);
606int acpi_unbind_one(struct device *dev);
607
608enum acpi_bridge_type {
609 ACPI_BRIDGE_TYPE_PCIE = 1,
610 ACPI_BRIDGE_TYPE_CXL,
611};
612
613struct acpi_pci_root {
614 struct acpi_device * device;
615 struct pci_bus *bus;
616 u16 segment;
617 int bridge_type;
618 struct resource secondary; /* downstream bus range */
619
620 u32 osc_support_set; /* _OSC state of support bits */
621 u32 osc_control_set; /* _OSC state of control bits */
622 u32 osc_ext_support_set; /* _OSC state of extended support bits */
623 u32 osc_ext_control_set; /* _OSC state of extended control bits */
624 phys_addr_t mcfg_addr;
625};
626
627/* helper */
628
629bool acpi_dma_supported(const struct acpi_device *adev);
630enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
631int acpi_iommu_fwspec_init(struct device *dev, u32 id,
632 struct fwnode_handle *fwnode,
633 const struct iommu_ops *ops);
634int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map);
635int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
636 const u32 *input_id);
637static inline int acpi_dma_configure(struct device *dev,
638 enum dev_dma_attr attr)
639{
640 return acpi_dma_configure_id(dev, attr, NULL);
641}
642struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
643 u64 address, bool check_children);
644struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
645 acpi_bus_address adr);
646int acpi_is_root_bridge(acpi_handle);
647struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
648
649int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
650int acpi_disable_wakeup_device_power(struct acpi_device *dev);
651
652#ifdef CONFIG_X86
653bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
654bool acpi_quirk_skip_acpi_ac_and_battery(void);
655int acpi_install_cmos_rtc_space_handler(acpi_handle handle);
656void acpi_remove_cmos_rtc_space_handler(acpi_handle handle);
657#else
658static inline bool acpi_device_override_status(struct acpi_device *adev,
659 unsigned long long *status)
660{
661 return false;
662}
663static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
664{
665 return false;
666}
667static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle)
668{
669 return 1;
670}
671static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle)
672{
673}
674#endif
675
676#if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
677bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
678int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
679bool acpi_quirk_skip_gpio_event_handlers(void);
680#else
681static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
682{
683 return false;
684}
685static inline int
686acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
687{
688 *skip = false;
689 return 0;
690}
691static inline bool acpi_quirk_skip_gpio_event_handlers(void)
692{
693 return false;
694}
695#endif
696
697#ifdef CONFIG_PM
698void acpi_pm_wakeup_event(struct device *dev);
699acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
700 void (*func)(struct acpi_device_wakeup_context *context));
701acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
702bool acpi_pm_device_can_wakeup(struct device *dev);
703int acpi_pm_device_sleep_state(struct device *, int *, int);
704int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
705#else
706static inline void acpi_pm_wakeup_event(struct device *dev)
707{
708}
709static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
710 struct device *dev,
711 void (*func)(struct acpi_device_wakeup_context *context))
712{
713 return AE_SUPPORT;
714}
715static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
716{
717 return AE_SUPPORT;
718}
719static inline bool acpi_pm_device_can_wakeup(struct device *dev)
720{
721 return false;
722}
723static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
724{
725 if (p)
726 *p = ACPI_STATE_D0;
727
728 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
729 m : ACPI_STATE_D0;
730}
731static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
732{
733 return -ENODEV;
734}
735#endif
736
737#ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
738bool acpi_sleep_state_supported(u8 sleep_state);
739#else
740static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
741#endif
742
743#ifdef CONFIG_ACPI_SLEEP
744u32 acpi_target_system_state(void);
745#else
746static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
747#endif
748
749static inline bool acpi_device_power_manageable(struct acpi_device *adev)
750{
751 return adev->flags.power_manageable;
752}
753
754static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
755{
756 return adev->wakeup.flags.valid;
757}
758
759static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
760{
761 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
762 ((acpi_gbl_FADT.header.revision < 6) &&
763 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
764}
765
766bool acpi_dev_uid_match(struct acpi_device *adev, const char *uid2);
767bool acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2);
768int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer);
769
770void acpi_dev_clear_dependencies(struct acpi_device *supplier);
771bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
772struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
773 struct acpi_device *start);
774
775/**
776 * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a
777 * given supplier
778 * @supplier: Pointer to the supplier's ACPI device
779 * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL
780 */
781#define for_each_acpi_consumer_dev(supplier, consumer) \
782 for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \
783 consumer; \
784 consumer = acpi_dev_get_next_consumer_dev(supplier, consumer))
785
786struct acpi_device *
787acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
788struct acpi_device *
789acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
790
791/**
792 * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
793 * @adev: pointer to the matching ACPI device, NULL at the end of the loop
794 * @hid: Hardware ID of the device.
795 * @uid: Unique ID of the device, pass NULL to not check _UID
796 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
797 *
798 * The caller is responsible for invoking acpi_dev_put() on the returned device.
799 */
800#define for_each_acpi_dev_match(adev, hid, uid, hrv) \
801 for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \
802 adev; \
803 adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
804
805static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
806{
807 return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
808}
809
810static inline void acpi_dev_put(struct acpi_device *adev)
811{
812 if (adev)
813 put_device(dev: &adev->dev);
814}
815
816struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
817struct acpi_device *acpi_get_acpi_dev(acpi_handle handle);
818
819static inline void acpi_put_acpi_dev(struct acpi_device *adev)
820{
821 acpi_dev_put(adev);
822}
823#else /* CONFIG_ACPI */
824
825static inline int register_acpi_bus_type(void *bus) { return 0; }
826static inline int unregister_acpi_bus_type(void *bus) { return 0; }
827
828#endif /* CONFIG_ACPI */
829
830#endif /*__ACPI_BUS_H__*/
831

source code of linux/include/acpi/acpi_bus.h