1
2
3
4
5
6
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
16#define ACPI_MAX_HANDLES 10
17struct acpi_handle_list {
18 u32 count;
19 acpi_handle handles[ACPI_MAX_HANDLES];
20};
21
22
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
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
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
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
163
164struct acpi_driver {
165 char name[80];
166 char class[80];
167 const struct acpi_device_id *ids;
168 unsigned int flags;
169 struct acpi_device_ops ops;
170 struct device_driver drv;
171 struct module *owner;
172};
173
174
175
176
177
178
179
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
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
210
211struct acpi_device_dir {
212 struct proc_dir_entry *entry;
213};
214
215#define acpi_device_dir(d) ((d)->dir.entry)
216
217
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;
238 struct acpi_pnp_type type;
239 acpi_bus_address bus_address;
240 char *unique_id;
241 struct list_head ids;
242 acpi_device_name device_name;
243 acpi_device_class device_class;
244 union acpi_object *str_obj;
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
255
256struct acpi_device_power_flags {
257 u32 explicit_get:1;
258 u32 power_resources:1;
259 u32 inrush_current:1;
260 u32 power_removed:1;
261 u32 ignore_parent:1;
262 u32 dsw_present:1;
263 u32 reserved:26;
264};
265
266struct acpi_device_power_state {
267 struct {
268 u8 valid:1;
269 u8 explicit_set:1;
270 u8 reserved:6;
271 } flags;
272 int power;
273 int latency;
274 struct list_head resources;
275};
276
277struct acpi_device_power {
278 int state;
279 struct acpi_device_power_flags flags;
280 struct acpi_device_power_state states[ACPI_D_STATE_COUNT];
281};
282
283
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;
295 u8 performance;
296 int latency;
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
307struct acpi_device_wakeup_flags {
308 u8 valid:1;
309 u8 notifier_present:1;
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
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
353struct acpi_device {
354 int device_type;
355 acpi_handle handle;
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
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
471extern struct bus_type acpi_bus_type;
472
473
474
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
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_get_power(struct acpi_device *device, int *state);
510int acpi_device_set_power(struct acpi_device *device, int state);
511int acpi_bus_init_power(struct acpi_device *device);
512int acpi_device_fix_up_power(struct acpi_device *device);
513int acpi_bus_update_power(acpi_handle handle, int *state_p);
514int acpi_device_update_power(struct acpi_device *device, int *state_p);
515bool acpi_bus_power_manageable(acpi_handle handle);
516
517#ifdef CONFIG_PM
518bool acpi_bus_can_wakeup(acpi_handle handle);
519#else
520static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
521#endif
522
523void acpi_scan_lock_acquire(void);
524void acpi_scan_lock_release(void);
525void acpi_lock_hp_context(void);
526void acpi_unlock_hp_context(void);
527int acpi_scan_add_handler(struct acpi_scan_handler *handler);
528int acpi_bus_register_driver(struct acpi_driver *driver);
529void acpi_bus_unregister_driver(struct acpi_driver *driver);
530int acpi_bus_scan(acpi_handle handle);
531void acpi_bus_trim(struct acpi_device *start);
532acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
533int acpi_match_device_ids(struct acpi_device *device,
534 const struct acpi_device_id *ids);
535void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
536 char *modalias, size_t len);
537int acpi_create_dir(struct acpi_device *);
538void acpi_remove_dir(struct acpi_device *);
539
540static inline bool acpi_device_enumerated(struct acpi_device *adev)
541{
542 return adev && adev->flags.initialized && adev->flags.visited;
543}
544
545
546
547
548
549
550
551
552
553#define module_acpi_driver(__acpi_driver) \
554 module_driver(__acpi_driver, acpi_bus_register_driver, \
555 acpi_bus_unregister_driver)
556
557
558
559
560struct acpi_bus_type {
561 struct list_head list;
562 const char *name;
563 bool (*match)(struct device *dev);
564 struct acpi_device * (*find_companion)(struct device *);
565 void (*setup)(struct device *);
566 void (*cleanup)(struct device *);
567};
568int register_acpi_bus_type(struct acpi_bus_type *);
569int unregister_acpi_bus_type(struct acpi_bus_type *);
570int acpi_bind_one(struct device *dev, struct acpi_device *adev);
571int acpi_unbind_one(struct device *dev);
572
573struct acpi_pci_root {
574 struct acpi_device * device;
575 struct pci_bus *bus;
576 u16 segment;
577 struct resource secondary;
578
579 u32 osc_support_set;
580 u32 osc_control_set;
581 phys_addr_t mcfg_addr;
582};
583
584
585
586bool acpi_dma_supported(struct acpi_device *adev);
587enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
588int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
589 u64 *size);
590int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
591
592struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
593 u64 address, bool check_children);
594int acpi_is_root_bridge(acpi_handle);
595struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
596
597int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
598int acpi_disable_wakeup_device_power(struct acpi_device *dev);
599
600#ifdef CONFIG_X86
601bool acpi_device_always_present(struct acpi_device *adev);
602#else
603static inline bool acpi_device_always_present(struct acpi_device *adev)
604{
605 return false;
606}
607#endif
608
609#ifdef CONFIG_PM
610void acpi_pm_wakeup_event(struct device *dev);
611acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
612 void (*func)(struct acpi_device_wakeup_context *context));
613acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
614bool acpi_pm_device_can_wakeup(struct device *dev);
615int acpi_pm_device_sleep_state(struct device *, int *, int);
616int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
617int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable);
618#else
619static inline void acpi_pm_wakeup_event(struct device *dev)
620{
621}
622static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
623 struct device *dev,
624 void (*func)(struct acpi_device_wakeup_context *context))
625{
626 return AE_SUPPORT;
627}
628static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
629{
630 return AE_SUPPORT;
631}
632static inline bool acpi_pm_device_can_wakeup(struct device *dev)
633{
634 return false;
635}
636static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
637{
638 if (p)
639 *p = ACPI_STATE_D0;
640
641 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
642 m : ACPI_STATE_D0;
643}
644static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
645{
646 return -ENODEV;
647}
648static inline int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable)
649{
650 return -ENODEV;
651}
652#endif
653
654#ifdef CONFIG_ACPI_SLEEP
655u32 acpi_target_system_state(void);
656#else
657static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
658#endif
659
660static inline bool acpi_device_power_manageable(struct acpi_device *adev)
661{
662 return adev->flags.power_manageable;
663}
664
665static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
666{
667 return adev->wakeup.flags.valid;
668}
669
670static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
671{
672 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
673 ((acpi_gbl_FADT.header.revision < 6) &&
674 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
675}
676
677static inline void acpi_dev_put(struct acpi_device *adev)
678{
679 put_device(&adev->dev);
680}
681#else
682
683static inline int register_acpi_bus_type(void *bus) { return 0; }
684static inline int unregister_acpi_bus_type(void *bus) { return 0; }
685
686#endif
687
688#endif
689