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