Commit | Line | Data |
---|---|---|
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 | |
17 | struct 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 */ |
23 | acpi_status | |
4be44fcd LB |
24 | acpi_extract_package(union acpi_object *package, |
25 | struct acpi_buffer *format, struct acpi_buffer *buffer); | |
1da177e4 | 26 | acpi_status |
4be44fcd LB |
27 | acpi_evaluate_integer(acpi_handle handle, |
28 | acpi_string pathname, | |
27663c58 | 29 | struct acpi_object_list *arguments, unsigned long long *data); |
1da177e4 | 30 | acpi_status |
4be44fcd LB |
31 | acpi_evaluate_reference(acpi_handle handle, |
32 | acpi_string pathname, | |
33 | struct acpi_object_list *arguments, | |
34 | struct acpi_handle_list *list); | |
275c58d7 | 35 | acpi_status |
05730c19 JL |
36 | acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code, |
37 | struct acpi_buffer *status_buf); | |
1da177e4 | 38 | |
38ac0f1b | 39 | acpi_status |
8ede06ab | 40 | acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); |
952c63e9 JL |
41 | |
42 | bool acpi_has_method(acpi_handle handle, char *name); | |
0db98202 JL |
43 | acpi_status acpi_execute_simple_method(acpi_handle handle, char *method, |
44 | u64 arg); | |
7d2421f8 JL |
45 | acpi_status acpi_evaluate_ej0(acpi_handle handle); |
46 | acpi_status acpi_evaluate_lck(acpi_handle handle, int lock); | |
132565d8 | 47 | acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function); |
ebf4df8d JL |
48 | bool acpi_ata_match(acpi_handle handle); |
49 | bool acpi_bay_match(acpi_handle handle); | |
50 | bool acpi_dock_match(acpi_handle handle); | |
952c63e9 | 51 | |
94116f81 AS |
52 | bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs); |
53 | union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, | |
c7e16e52 | 54 | u64 rev, u64 func, union acpi_object *argv4); |
2c5a06e5 | 55 | #ifdef CONFIG_ACPI |
a65ac520 | 56 | static inline union acpi_object * |
94116f81 AS |
57 | acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev, |
58 | u64 func, union acpi_object *argv4, | |
59 | acpi_object_type type) | |
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 | 80 | bool acpi_dev_found(const char *hid); |
8661423e | 81 | bool acpi_dev_present(const char *hid, const char *uid, s64 hrv); |
8eb99e9a | 82 | bool acpi_reduced_hardware(void); |
2d12b6b3 | 83 | |
76f58584 | 84 | #ifdef CONFIG_ACPI |
1da177e4 | 85 | |
df23e2be | 86 | struct proc_dir_entry; |
1da177e4 LT |
87 | |
88 | #define ACPI_BUS_FILE_ROOT "acpi" | |
4be44fcd | 89 | extern struct proc_dir_entry *acpi_root_dir; |
1da177e4 | 90 | |
1da177e4 | 91 | enum 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 | ||
102 | struct acpi_driver; | |
103 | struct acpi_device; | |
104 | ||
ca589f94 RW |
105 | /* |
106 | * ACPI Scan Handler | |
107 | * ----------------- | |
108 | */ | |
109 | ||
a33ec399 | 110 | struct 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 |
118 | static 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 |
124 | struct 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 | ||
140 | struct 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 | 152 | typedef int (*acpi_op_add) (struct acpi_device * device); |
6c0eb5ba | 153 | typedef void (*acpi_op_remove) (struct acpi_device *device); |
46ec8598 | 154 | typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); |
1da177e4 LT |
155 | |
156 | struct 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 | 164 | struct 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 | ||
181 | struct 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 | ||
192 | struct 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 | ||
212 | struct 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 | 220 | typedef char acpi_bus_id[8]; |
ca6f998c | 221 | typedef u64 acpi_bus_address; |
4be44fcd LB |
222 | typedef char acpi_device_name[40]; |
223 | typedef char acpi_device_class[20]; | |
1da177e4 | 224 | |
7f47fa6c BH |
225 | struct acpi_hardware_id { |
226 | struct list_head list; | |
844142c3 | 227 | const char *id; |
7f47fa6c BH |
228 | }; |
229 | ||
d4e1a692 TK |
230 | struct 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 | 238 | struct 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 | 252 | const 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 | ||
259 | struct 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 | ||
269 | struct 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 | ||
280 | struct 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 |
287 | struct acpi_dep_data { |
288 | struct list_head node; | |
289 | acpi_handle supplier; | |
290 | acpi_handle consumer; | |
9d9bcae4 | 291 | bool honor_dep; |
3ba12d8d RW |
292 | bool met; |
293 | bool free_when_met; | |
a9e10e58 DS |
294 | }; |
295 | ||
1da177e4 LT |
296 | /* Performance Management */ |
297 | ||
298 | struct acpi_device_perf_flags { | |
4be44fcd | 299 | u8 reserved:8; |
1da177e4 LT |
300 | }; |
301 | ||
302 | struct acpi_device_perf_state { | |
303 | struct { | |
4be44fcd LB |
304 | u8 valid:1; |
305 | u8 reserved:7; | |
306 | } flags; | |
307 | u8 power; /* % Power (compared to P0) */ | |
308 | u8 performance; /* % Performance ( " ) */ | |
309 | int latency; /* Px->P0 time (microseconds) */ | |
1da177e4 LT |
310 | }; |
311 | ||
312 | struct acpi_device_perf { | |
4be44fcd | 313 | int state; |
1da177e4 | 314 | struct acpi_device_perf_flags flags; |
4be44fcd | 315 | int state_count; |
1da177e4 LT |
316 | struct acpi_device_perf_state *states; |
317 | }; | |
318 | ||
319 | /* Wakeup Management */ | |
320 | struct acpi_device_wakeup_flags { | |
4be44fcd | 321 | u8 valid:1; /* Can successfully enable wakeup? */ |
b67ea761 | 322 | u8 notifier_present:1; /* Wake-up notify handler has been installed */ |
1da177e4 LT |
323 | }; |
324 | ||
c072530f | 325 | struct acpi_device_wakeup_context { |
64fd1c70 | 326 | void (*func)(struct acpi_device_wakeup_context *context); |
c072530f RW |
327 | struct device *dev; |
328 | }; | |
329 | ||
1da177e4 | 330 | struct acpi_device_wakeup { |
4be44fcd | 331 | acpi_handle gpe_device; |
439913ff LM |
332 | u64 gpe_number; |
333 | u64 sleep_state; | |
993cbe59 | 334 | struct list_head resources; |
4be44fcd | 335 | struct acpi_device_wakeup_flags flags; |
c072530f RW |
336 | struct acpi_device_wakeup_context context; |
337 | struct wakeup_source *ws; | |
9b83ccd2 | 338 | int prepare_count; |
99d8845e | 339 | int enable_count; |
1da177e4 LT |
340 | }; |
341 | ||
1033f904 | 342 | struct acpi_device_physical_node { |
007ccfcf | 343 | unsigned int node_id; |
1033f904 LT |
344 | struct list_head node; |
345 | struct device *dev; | |
683058e3 | 346 | bool put_online:1; |
1033f904 | 347 | }; |
1da177e4 | 348 | |
5f5e4890 MW |
349 | struct acpi_device_properties { |
350 | const guid_t *guid; | |
103e10c6 | 351 | union acpi_object *properties; |
5f5e4890 | 352 | struct list_head list; |
103e10c6 | 353 | void **bufs; |
5f5e4890 MW |
354 | }; |
355 | ||
ffdcd955 MW |
356 | /* ACPI Device Specific Data (_DSD) */ |
357 | struct acpi_device_data { | |
358 | const union acpi_object *pointer; | |
5f5e4890 | 359 | struct list_head properties; |
733e6251 | 360 | const union acpi_object *of_compatible; |
445b0eb0 | 361 | struct list_head subnodes; |
ffdcd955 MW |
362 | }; |
363 | ||
f028d524 RW |
364 | struct acpi_gpio_mapping; |
365 | ||
1033f904 | 366 | /* Device */ |
1da177e4 | 367 | struct acpi_device { |
882c982d | 368 | u32 pld_crc; |
caaa6efb BH |
369 | int device_type; |
370 | acpi_handle handle; /* no handle for fixed hardware */ | |
8a0662d9 | 371 | struct fwnode_handle fwnode; |
4be44fcd | 372 | struct list_head wakeup_list; |
d783156e | 373 | struct list_head del_list; |
1da177e4 LT |
374 | struct acpi_device_status status; |
375 | struct acpi_device_flags flags; | |
4be44fcd | 376 | struct acpi_device_pnp pnp; |
1da177e4 LT |
377 | struct acpi_device_power power; |
378 | struct acpi_device_wakeup wakeup; | |
4be44fcd LB |
379 | struct acpi_device_perf performance; |
380 | struct acpi_device_dir dir; | |
ffdcd955 | 381 | struct acpi_device_data data; |
ca589f94 | 382 | struct acpi_scan_handler *handler; |
3c2cc7ff | 383 | struct acpi_hotplug_context *hp; |
f028d524 | 384 | const struct acpi_gpio_mapping *driver_gpios; |
4be44fcd | 385 | void *driver_data; |
5b327265 | 386 | struct device dev; |
007ccfcf | 387 | unsigned int physical_node_count; |
40e7fcb1 | 388 | unsigned int dep_unmet; |
1033f904 LT |
389 | struct list_head physical_node_list; |
390 | struct mutex physical_node_lock; | |
b1c0f99b | 391 | void (*remove)(struct acpi_device *); |
1da177e4 LT |
392 | }; |
393 | ||
445b0eb0 RW |
394 | /* Non-device subnode */ |
395 | struct acpi_data_node { | |
396 | const char *name; | |
263b4c1a | 397 | acpi_handle handle; |
445b0eb0 | 398 | struct fwnode_handle fwnode; |
dfa672fb | 399 | struct fwnode_handle *parent; |
445b0eb0 RW |
400 | struct acpi_device_data data; |
401 | struct list_head sibling; | |
263b4c1a RW |
402 | struct kobject kobj; |
403 | struct completion kobj_done; | |
445b0eb0 RW |
404 | }; |
405 | ||
db3e50f3 SA |
406 | extern const struct fwnode_operations acpi_device_fwnode_ops; |
407 | extern const struct fwnode_operations acpi_data_fwnode_ops; | |
408 | extern const struct fwnode_operations acpi_static_fwnode_ops; | |
3a7a2ab8 | 409 | |
9e987b70 JH |
410 | bool is_acpi_device_node(const struct fwnode_handle *fwnode); |
411 | bool is_acpi_data_node(const struct fwnode_handle *fwnode); | |
8a0662d9 | 412 | |
9e987b70 | 413 | static inline bool is_acpi_node(const struct fwnode_handle *fwnode) |
8a0662d9 | 414 | { |
9e987b70 | 415 | return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode)); |
8a0662d9 RW |
416 | } |
417 | ||
8b9d6802 SA |
418 | #define to_acpi_device_node(__fwnode) \ |
419 | ({ \ | |
420 | typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \ | |
421 | \ | |
422 | is_acpi_device_node(__to_acpi_device_node_fwnode) ? \ | |
423 | container_of(__to_acpi_device_node_fwnode, \ | |
424 | struct acpi_device, fwnode) : \ | |
425 | NULL; \ | |
426 | }) | |
427 | ||
8b9d6802 SA |
428 | #define to_acpi_data_node(__fwnode) \ |
429 | ({ \ | |
430 | typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \ | |
431 | \ | |
432 | is_acpi_data_node(__to_acpi_data_node_fwnode) ? \ | |
433 | container_of(__to_acpi_data_node_fwnode, \ | |
434 | struct acpi_data_node, fwnode) : \ | |
435 | NULL; \ | |
436 | }) | |
437 | ||
438 | static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode) | |
3a7a2ab8 | 439 | { |
db3e50f3 SA |
440 | return !IS_ERR_OR_NULL(fwnode) && |
441 | fwnode->ops == &acpi_static_fwnode_ops; | |
3a7a2ab8 RW |
442 | } |
443 | ||
8b9d6802 | 444 | static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode, |
613e9721 AT |
445 | const char *name) |
446 | { | |
447 | return is_acpi_data_node(fwnode) ? | |
448 | (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false; | |
449 | } | |
450 | ||
8a0662d9 RW |
451 | static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) |
452 | { | |
453 | return &adev->fwnode; | |
454 | } | |
455 | ||
db89b4f0 PM |
456 | static inline void *acpi_driver_data(struct acpi_device *d) |
457 | { | |
458 | return d->driver_data; | |
459 | } | |
460 | ||
d43ec68e PM |
461 | #define to_acpi_device(d) container_of(d, struct acpi_device, dev) |
462 | #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) | |
1da177e4 | 463 | |
62fcb99b RW |
464 | static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev) |
465 | { | |
466 | if (adev->dev.parent) | |
467 | return to_acpi_device(adev->dev.parent); | |
468 | ||
469 | return NULL; | |
470 | } | |
471 | ||
25db115b RW |
472 | static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) |
473 | { | |
474 | *((u32 *)&adev->status) = sta; | |
475 | } | |
476 | ||
3c2cc7ff | 477 | static inline void acpi_set_hp_context(struct acpi_device *adev, |
ba574dc8 | 478 | struct acpi_hotplug_context *hp) |
3c2cc7ff RW |
479 | { |
480 | hp->self = adev; | |
3c2cc7ff RW |
481 | adev->hp = hp; |
482 | } | |
483 | ||
5d513205 RW |
484 | void acpi_initialize_hp_context(struct acpi_device *adev, |
485 | struct acpi_hotplug_context *hp, | |
486 | int (*notify)(struct acpi_device *, u32), | |
487 | void (*uevent)(struct acpi_device *, u32)); | |
488 | ||
55955aad DB |
489 | /* acpi_device.dev.bus == &acpi_bus_type */ |
490 | extern struct bus_type acpi_bus_type; | |
491 | ||
3c36fe93 | 492 | int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data); |
cf6ba075 | 493 | int acpi_dev_for_each_child(struct acpi_device *adev, |
10fa1b2c | 494 | int (*fn)(struct acpi_device *, void *), void *data); |
ff32e599 RW |
495 | int acpi_dev_for_each_child_reverse(struct acpi_device *adev, |
496 | int (*fn)(struct acpi_device *, void *), | |
497 | void *data); | |
3c36fe93 | 498 | |
1da177e4 LT |
499 | /* |
500 | * Events | |
501 | * ------ | |
502 | */ | |
503 | ||
504 | struct acpi_bus_event { | |
4be44fcd LB |
505 | struct list_head node; |
506 | acpi_device_class device_class; | |
507 | acpi_bus_id bus_id; | |
508 | u32 type; | |
509 | u32 data; | |
1da177e4 LT |
510 | }; |
511 | ||
99e0d2fc | 512 | extern struct kobject *acpi_kobj; |
962ce8ca | 513 | extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); |
8e4319c4 | 514 | void acpi_bus_private_data_handler(acpi_handle, void *); |
20733939 | 515 | int acpi_bus_get_private_data(acpi_handle, void **); |
72013795 LT |
516 | int acpi_bus_attach_private_data(acpi_handle, void *); |
517 | void acpi_bus_detach_private_data(acpi_handle); | |
c542ce36 MW |
518 | int acpi_dev_install_notify_handler(struct acpi_device *adev, |
519 | u32 handler_type, | |
520 | acpi_notify_handler handler); | |
521 | void acpi_dev_remove_notify_handler(struct acpi_device *adev, | |
522 | u32 handler_type, | |
523 | acpi_notify_handler handler); | |
9ee85241 ZR |
524 | extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); |
525 | extern int register_acpi_notifier(struct notifier_block *); | |
526 | extern int unregister_acpi_notifier(struct notifier_block *); | |
6bd00a61 | 527 | |
1da177e4 LT |
528 | /* |
529 | * External Functions | |
530 | */ | |
531 | ||
402ac536 BH |
532 | acpi_status acpi_bus_get_status_handle(acpi_handle handle, |
533 | unsigned long long *sta); | |
4be44fcd | 534 | int acpi_bus_get_status(struct acpi_device *device); |
9ce4e607 | 535 | |
4be44fcd | 536 | int acpi_bus_set_power(acpi_handle handle, int state); |
96bfd3ce | 537 | const char *acpi_power_state_string(int state); |
078eb126 | 538 | int acpi_device_set_power(struct acpi_device *device, int state); |
9ce4e607 | 539 | int acpi_bus_init_power(struct acpi_device *device); |
b9e95fc6 | 540 | int acpi_device_fix_up_power(struct acpi_device *device); |
a22f18bd | 541 | void acpi_device_fix_up_power_extended(struct acpi_device *adev); |
25eed407 | 542 | int acpi_bus_update_power(acpi_handle handle, int *state_p); |
2bb3a2bf | 543 | int acpi_device_update_power(struct acpi_device *device, int *state_p); |
3737b2b1 | 544 | bool acpi_bus_power_manageable(acpi_handle handle); |
b7dd6298 | 545 | void acpi_dev_power_up_children_with_adr(struct acpi_device *adev); |
8133844a | 546 | u8 acpi_dev_power_state_for_wake(struct acpi_device *adev); |
4533771c MW |
547 | int acpi_device_power_add_dependent(struct acpi_device *adev, |
548 | struct device *dev); | |
549 | void acpi_device_power_remove_dependent(struct acpi_device *adev, | |
550 | struct device *dev); | |
ec4602a9 RW |
551 | |
552 | #ifdef CONFIG_PM | |
eb9d0fe4 | 553 | bool acpi_bus_can_wakeup(acpi_handle handle); |
ec4602a9 RW |
554 | #else |
555 | static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } | |
556 | #endif | |
9ce4e607 | 557 | |
3757b948 RW |
558 | void acpi_scan_lock_acquire(void); |
559 | void acpi_scan_lock_release(void); | |
e525506f RW |
560 | void acpi_lock_hp_context(void); |
561 | void acpi_unlock_hp_context(void); | |
ca589f94 | 562 | int acpi_scan_add_handler(struct acpi_scan_handler *handler); |
4be44fcd | 563 | int acpi_bus_register_driver(struct acpi_driver *driver); |
06ea8e08 | 564 | void acpi_bus_unregister_driver(struct acpi_driver *driver); |
b8bd759a | 565 | int acpi_bus_scan(acpi_handle handle); |
bfee26db | 566 | void acpi_bus_trim(struct acpi_device *start); |
fd350943 | 567 | acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); |
8c8eb78f TR |
568 | int acpi_match_device_ids(struct acpi_device *device, |
569 | const struct acpi_device_id *ids); | |
51ede5d9 DD |
570 | void acpi_set_modalias(struct acpi_device *adev, const char *default_id, |
571 | char *modalias, size_t len); | |
1da177e4 | 572 | |
202317a5 RW |
573 | static inline bool acpi_device_enumerated(struct acpi_device *adev) |
574 | { | |
575 | return adev && adev->flags.initialized && adev->flags.visited; | |
576 | } | |
577 | ||
0d2cf8f5 MW |
578 | /** |
579 | * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver | |
580 | * @__acpi_driver: acpi_driver struct | |
581 | * | |
582 | * Helper macro for ACPI drivers which do not do anything special in module | |
583 | * init/exit. This eliminates a lot of boilerplate. Each module may only | |
584 | * use this macro once, and calling it replaces module_init() and module_exit() | |
585 | */ | |
586 | #define module_acpi_driver(__acpi_driver) \ | |
587 | module_driver(__acpi_driver, acpi_bus_register_driver, \ | |
588 | acpi_bus_unregister_driver) | |
589 | ||
4e10d12a DSL |
590 | /* |
591 | * Bind physical devices with ACPI devices | |
592 | */ | |
4e10d12a | 593 | struct acpi_bus_type { |
4be44fcd | 594 | struct list_head list; |
53540098 RW |
595 | const char *name; |
596 | bool (*match)(struct device *dev); | |
e3f02c52 | 597 | struct acpi_device * (*find_companion)(struct device *); |
11909ca1 | 598 | void (*setup)(struct device *); |
4e10d12a DSL |
599 | }; |
600 | int register_acpi_bus_type(struct acpi_bus_type *); | |
601 | int unregister_acpi_bus_type(struct acpi_bus_type *); | |
f1b1dc84 ZR |
602 | int acpi_bind_one(struct device *dev, struct acpi_device *adev); |
603 | int acpi_unbind_one(struct device *dev); | |
22c13f9d | 604 | |
241d26bc DW |
605 | enum acpi_bridge_type { |
606 | ACPI_BRIDGE_TYPE_PCIE = 1, | |
607 | ACPI_BRIDGE_TYPE_CXL, | |
608 | }; | |
609 | ||
76d56de5 | 610 | struct acpi_pci_root { |
76d56de5 | 611 | struct acpi_device * device; |
76d56de5 AC |
612 | struct pci_bus *bus; |
613 | u16 segment; | |
241d26bc | 614 | int bridge_type; |
6ad95513 | 615 | struct resource secondary; /* downstream bus range */ |
76d56de5 | 616 | |
56368029 VV |
617 | u32 osc_support_set; /* _OSC state of support bits */ |
618 | u32 osc_control_set; /* _OSC state of control bits */ | |
619 | u32 osc_ext_support_set; /* _OSC state of extended support bits */ | |
620 | u32 osc_ext_control_set; /* _OSC state of extended control bits */ | |
f4b57a3b | 621 | phys_addr_t mcfg_addr; |
76d56de5 AC |
622 | }; |
623 | ||
4e10d12a | 624 | /* helper */ |
d9fef0c4 | 625 | |
3d7c821c | 626 | bool acpi_dma_supported(const struct acpi_device *adev); |
b84f196d | 627 | enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev); |
11a8c5e3 JPB |
628 | int acpi_iommu_fwspec_init(struct device *dev, u32 id, |
629 | struct fwnode_handle *fwnode, | |
630 | const struct iommu_ops *ops); | |
bf2ee8d0 | 631 | int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map); |
b8e069a2 LP |
632 | int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr, |
633 | const u32 *input_id); | |
634 | static inline int acpi_dma_configure(struct device *dev, | |
635 | enum dev_dma_attr attr) | |
636 | { | |
637 | return acpi_dma_configure_id(dev, attr, NULL); | |
638 | } | |
d9fef0c4 RW |
639 | struct acpi_device *acpi_find_child_device(struct acpi_device *parent, |
640 | u64 address, bool check_children); | |
2f6fe93f RW |
641 | struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev, |
642 | acpi_bus_address adr); | |
27558203 | 643 | int acpi_is_root_bridge(acpi_handle); |
76d56de5 | 644 | struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); |
4e10d12a | 645 | |
b67ea761 RW |
646 | int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); |
647 | int acpi_disable_wakeup_device_power(struct acpi_device *dev); | |
648 | ||
b7ecf663 | 649 | #ifdef CONFIG_X86 |
1a68b346 | 650 | bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status); |
57a18322 | 651 | bool acpi_quirk_skip_acpi_ac_and_battery(void); |
596ca52a ZR |
652 | int acpi_install_cmos_rtc_space_handler(acpi_handle handle); |
653 | void acpi_remove_cmos_rtc_space_handler(acpi_handle handle); | |
b7ecf663 | 654 | #else |
1a68b346 HG |
655 | static inline bool acpi_device_override_status(struct acpi_device *adev, |
656 | unsigned long long *status) | |
b7ecf663 HG |
657 | { |
658 | return false; | |
659 | } | |
57a18322 HG |
660 | static inline bool acpi_quirk_skip_acpi_ac_and_battery(void) |
661 | { | |
662 | return false; | |
663 | } | |
596ca52a ZR |
664 | static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle) |
665 | { | |
666 | return 1; | |
667 | } | |
668 | static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle) | |
669 | { | |
670 | } | |
b7ecf663 HG |
671 | #endif |
672 | ||
35f9e773 HG |
673 | #if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS) |
674 | bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev); | |
675 | int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip); | |
5adc4093 | 676 | bool acpi_quirk_skip_gpio_event_handlers(void); |
35f9e773 HG |
677 | #else |
678 | static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev) | |
679 | { | |
680 | return false; | |
681 | } | |
682 | static inline int | |
683 | acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip) | |
684 | { | |
685 | *skip = false; | |
686 | return 0; | |
687 | } | |
5adc4093 HG |
688 | static inline bool acpi_quirk_skip_gpio_event_handlers(void) |
689 | { | |
690 | return false; | |
691 | } | |
b7ecf663 HG |
692 | #endif |
693 | ||
aa338601 | 694 | #ifdef CONFIG_PM |
33e4f80e | 695 | void acpi_pm_wakeup_event(struct device *dev); |
c072530f | 696 | acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, |
64fd1c70 | 697 | void (*func)(struct acpi_device_wakeup_context *context)); |
c072530f | 698 | acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); |
8370c2dc | 699 | bool acpi_pm_device_can_wakeup(struct device *dev); |
ee85f543 | 700 | int acpi_pm_device_sleep_state(struct device *, int *, int); |
4d183d04 | 701 | int acpi_pm_set_device_wakeup(struct device *dev, bool enable); |
761afb86 | 702 | #else |
33e4f80e RW |
703 | static inline void acpi_pm_wakeup_event(struct device *dev) |
704 | { | |
705 | } | |
ec2cd81c | 706 | static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, |
c072530f | 707 | struct device *dev, |
33e4f80e | 708 | void (*func)(struct acpi_device_wakeup_context *context)) |
ec2cd81c RW |
709 | { |
710 | return AE_SUPPORT; | |
711 | } | |
c072530f | 712 | static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) |
ec2cd81c RW |
713 | { |
714 | return AE_SUPPORT; | |
715 | } | |
8370c2dc RW |
716 | static inline bool acpi_pm_device_can_wakeup(struct device *dev) |
717 | { | |
718 | return false; | |
719 | } | |
b25c77ef | 720 | static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) |
296699de RW |
721 | { |
722 | if (p) | |
723 | *p = ACPI_STATE_D0; | |
b25c77ef | 724 | |
8ad928d5 RW |
725 | return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? |
726 | m : ACPI_STATE_D0; | |
296699de | 727 | } |
4d183d04 | 728 | static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable) |
f7a1b860 DH |
729 | { |
730 | return -ENODEV; | |
731 | } | |
761afb86 | 732 | #endif |
fd4aff1a | 733 | |
ad5a449b DC |
734 | #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT |
735 | bool acpi_sleep_state_supported(u8 sleep_state); | |
736 | #else | |
737 | static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; } | |
738 | #endif | |
739 | ||
99926a8c DR |
740 | #ifdef CONFIG_ACPI_SLEEP |
741 | u32 acpi_target_system_state(void); | |
742 | #else | |
743 | static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } | |
744 | #endif | |
745 | ||
078eb126 RW |
746 | static inline bool acpi_device_power_manageable(struct acpi_device *adev) |
747 | { | |
748 | return adev->flags.power_manageable; | |
749 | } | |
750 | ||
751 | static inline bool acpi_device_can_wakeup(struct acpi_device *adev) | |
752 | { | |
753 | return adev->wakeup.flags.valid; | |
754 | } | |
755 | ||
1399dfcd AL |
756 | static inline bool acpi_device_can_poweroff(struct acpi_device *adev) |
757 | { | |
cd7f84c0 KX |
758 | return adev->power.states[ACPI_STATE_D3_COLD].flags.valid || |
759 | ((acpi_gbl_FADT.header.revision < 6) && | |
760 | adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set); | |
1399dfcd AL |
761 | } |
762 | ||
35009c80 | 763 | bool acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2); |
5db72fdb | 764 | int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer); |
35009c80 | 765 | |
a9e10e58 | 766 | void acpi_dev_clear_dependencies(struct acpi_device *supplier); |
9d9bcae4 | 767 | bool acpi_dev_ready_for_enumeration(const struct acpi_device *device); |
cca8a7ef DS |
768 | struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier, |
769 | struct acpi_device *start); | |
770 | ||
62c8bc0d DS |
771 | /** |
772 | * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a | |
773 | * given supplier | |
774 | * @supplier: Pointer to the supplier's ACPI device | |
775 | * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL | |
776 | */ | |
777 | #define for_each_acpi_consumer_dev(supplier, consumer) \ | |
778 | for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \ | |
779 | consumer; \ | |
780 | consumer = acpi_dev_get_next_consumer_dev(supplier, consumer)) | |
781 | ||
bf263f64 DS |
782 | struct acpi_device * |
783 | acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv); | |
a814dcc2 AS |
784 | struct acpi_device * |
785 | acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv); | |
786 | ||
81eeb2f5 AS |
787 | /** |
788 | * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria | |
789 | * @adev: pointer to the matching ACPI device, NULL at the end of the loop | |
790 | * @hid: Hardware ID of the device. | |
791 | * @uid: Unique ID of the device, pass NULL to not check _UID | |
792 | * @hrv: Hardware Revision of the device, pass -1 to not check _HRV | |
793 | * | |
794 | * The caller is responsible for invoking acpi_dev_put() on the returned device. | |
81eeb2f5 | 795 | */ |
bf263f64 DS |
796 | #define for_each_acpi_dev_match(adev, hid, uid, hrv) \ |
797 | for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \ | |
798 | adev; \ | |
799 | adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv)) | |
800 | ||
4cbaba4e AS |
801 | static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev) |
802 | { | |
803 | return adev ? to_acpi_device(get_device(&adev->dev)) : NULL; | |
804 | } | |
805 | ||
fe066621 Y |
806 | static inline void acpi_dev_put(struct acpi_device *adev) |
807 | { | |
fc68f42a LT |
808 | if (adev) |
809 | put_device(&adev->dev); | |
fe066621 | 810 | } |
2d079514 | 811 | |
45e9aa1f RW |
812 | struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle); |
813 | struct acpi_device *acpi_get_acpi_dev(acpi_handle handle); | |
2d079514 | 814 | |
45e9aa1f | 815 | static inline void acpi_put_acpi_dev(struct acpi_device *adev) |
2d079514 RW |
816 | { |
817 | acpi_dev_put(adev); | |
818 | } | |
66886d6f MG |
819 | #else /* CONFIG_ACPI */ |
820 | ||
7ae30986 LB |
821 | static inline int register_acpi_bus_type(void *bus) { return 0; } |
822 | static inline int unregister_acpi_bus_type(void *bus) { return 0; } | |
66886d6f | 823 | |
fd350943 | 824 | #endif /* CONFIG_ACPI */ |
1da177e4 LT |
825 | |
826 | #endif /*__ACPI_BUS_H__*/ |