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