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