2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 #ifndef __ACPI_BUS_H__
23 #define __ACPI_BUS_H__
25 #include <linux/device.h>
26 #include <linux/property.h>
28 /* TBD: Make dynamic */
29 #define ACPI_MAX_HANDLES 10
30 struct acpi_handle_list {
32 acpi_handle handles[ACPI_MAX_HANDLES];
37 acpi_extract_package(union acpi_object *package,
38 struct acpi_buffer *format, struct acpi_buffer *buffer);
40 acpi_evaluate_integer(acpi_handle handle,
42 struct acpi_object_list *arguments, unsigned long long *data);
44 acpi_evaluate_reference(acpi_handle handle,
46 struct acpi_object_list *arguments,
47 struct acpi_handle_list *list);
49 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
50 struct acpi_buffer *status_buf);
53 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
55 bool acpi_has_method(acpi_handle handle, char *name);
56 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
58 acpi_status acpi_evaluate_ej0(acpi_handle handle);
59 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
60 bool acpi_ata_match(acpi_handle handle);
61 bool acpi_bay_match(acpi_handle handle);
62 bool acpi_dock_match(acpi_handle handle);
64 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
65 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
66 u64 rev, u64 func, union acpi_object *argv4);
68 static inline union acpi_object *
69 acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
70 u64 func, union acpi_object *argv4,
71 acpi_object_type type)
73 union acpi_object *obj;
75 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
76 if (obj && obj->type != type) {
84 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
86 .package.type = ACPI_TYPE_PACKAGE, \
87 .package.count = (cnt), \
88 .package.elements = (eles) \
91 bool acpi_dev_found(const char *hid);
92 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
95 acpi_dev_get_first_match_name(const char *hid, const char *uid, s64 hrv);
99 #include <linux/proc_fs.h>
101 #define ACPI_BUS_FILE_ROOT "acpi"
102 extern struct proc_dir_entry *acpi_root_dir;
104 enum acpi_bus_device_type {
105 ACPI_BUS_TYPE_DEVICE = 0,
107 ACPI_BUS_TYPE_PROCESSOR,
108 ACPI_BUS_TYPE_THERMAL,
109 ACPI_BUS_TYPE_POWER_BUTTON,
110 ACPI_BUS_TYPE_SLEEP_BUTTON,
111 ACPI_BUS_TYPE_ECDT_EC,
112 ACPI_BUS_DEVICE_TYPE_COUNT
123 struct acpi_hotplug_profile {
125 int (*scan_dependent)(struct acpi_device *adev);
126 void (*notify_online)(struct acpi_device *adev);
128 bool demand_offline:1;
131 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
132 struct kobject *kobj)
134 return container_of(kobj, struct acpi_hotplug_profile, kobj);
137 struct acpi_scan_handler {
138 const struct acpi_device_id *ids;
139 struct list_head list_node;
140 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
141 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
142 void (*detach)(struct acpi_device *dev);
143 void (*bind)(struct device *phys_dev);
144 void (*unbind)(struct device *phys_dev);
145 struct acpi_hotplug_profile hotplug;
149 * ACPI Hotplug Context
150 * --------------------
153 struct acpi_hotplug_context {
154 struct acpi_device *self;
155 int (*notify)(struct acpi_device *, u32);
156 void (*uevent)(struct acpi_device *, u32);
157 void (*fixup)(struct acpi_device *);
165 typedef int (*acpi_op_add) (struct acpi_device * device);
166 typedef int (*acpi_op_remove) (struct acpi_device * device);
167 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
169 struct acpi_device_ops {
171 acpi_op_remove remove;
172 acpi_op_notify notify;
175 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
180 const struct acpi_device_id *ids; /* Supported Hardware IDs */
182 struct acpi_device_ops ops;
183 struct device_driver drv;
184 struct module *owner;
194 struct acpi_device_status {
199 u32 battery_present:1;
205 struct acpi_device_flags {
206 u32 dynamic_status:1;
209 u32 power_manageable:1;
213 u32 hotplug_notify:1;
214 u32 is_dock_station:1;
215 u32 of_compatible_ok:1;
218 u32 enumeration_by_parent:1;
224 struct acpi_device_dir {
225 struct proc_dir_entry *entry;
228 #define acpi_device_dir(d) ((d)->dir.entry)
232 typedef char acpi_bus_id[8];
233 typedef unsigned long acpi_bus_address;
234 typedef char acpi_device_name[40];
235 typedef char acpi_device_class[20];
237 struct acpi_hardware_id {
238 struct list_head list;
242 struct acpi_pnp_type {
249 struct acpi_device_pnp {
250 acpi_bus_id bus_id; /* Object name */
251 int instance_no; /* Instance number of this object */
252 struct acpi_pnp_type type; /* ID type */
253 acpi_bus_address bus_address; /* _ADR */
254 char *unique_id; /* _UID */
255 struct list_head ids; /* _HID and _CIDs */
256 acpi_device_name device_name; /* Driver-determined */
257 acpi_device_class device_class; /* " */
258 union acpi_object *str_obj; /* unicode string for _STR method */
261 #define acpi_device_bid(d) ((d)->pnp.bus_id)
262 #define acpi_device_adr(d) ((d)->pnp.bus_address)
263 const char *acpi_device_hid(struct acpi_device *device);
264 #define acpi_device_uid(d) ((d)->pnp.unique_id)
265 #define acpi_device_name(d) ((d)->pnp.device_name)
266 #define acpi_device_class(d) ((d)->pnp.device_class)
268 /* Power Management */
270 struct acpi_device_power_flags {
271 u32 explicit_get:1; /* _PSC present? */
272 u32 power_resources:1; /* Power resources */
273 u32 inrush_current:1; /* Serialize Dx->D0 */
274 u32 power_removed:1; /* Optimize Dx->D0 */
275 u32 ignore_parent:1; /* Power is independent of parent power state */
276 u32 dsw_present:1; /* _DSW present? */
280 struct acpi_device_power_state {
283 u8 explicit_set:1; /* _PSx present? */
286 int power; /* % Power (compared to D0) */
287 int latency; /* Dx->D0 time (microseconds) */
288 struct list_head resources; /* Power resources referenced */
291 struct acpi_device_power {
292 int state; /* Current state */
293 struct acpi_device_power_flags flags;
294 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
297 /* Performance Management */
299 struct acpi_device_perf_flags {
303 struct acpi_device_perf_state {
308 u8 power; /* % Power (compared to P0) */
309 u8 performance; /* % Performance ( " ) */
310 int latency; /* Px->P0 time (microseconds) */
313 struct acpi_device_perf {
315 struct acpi_device_perf_flags flags;
317 struct acpi_device_perf_state *states;
320 /* Wakeup Management */
321 struct acpi_device_wakeup_flags {
322 u8 valid:1; /* Can successfully enable wakeup? */
323 u8 notifier_present:1; /* Wake-up notify handler has been installed */
326 struct acpi_device_wakeup_context {
327 void (*func)(struct acpi_device_wakeup_context *context);
331 struct acpi_device_wakeup {
332 acpi_handle gpe_device;
335 struct list_head resources;
336 struct acpi_device_wakeup_flags flags;
337 struct acpi_device_wakeup_context context;
338 struct wakeup_source *ws;
343 struct acpi_device_physical_node {
344 unsigned int node_id;
345 struct list_head node;
350 /* ACPI Device Specific Data (_DSD) */
351 struct acpi_device_data {
352 const union acpi_object *pointer;
353 const union acpi_object *properties;
354 const union acpi_object *of_compatible;
355 struct list_head subnodes;
358 struct acpi_gpio_mapping;
363 acpi_handle handle; /* no handle for fixed hardware */
364 struct fwnode_handle fwnode;
365 struct acpi_device *parent;
366 struct list_head children;
367 struct list_head node;
368 struct list_head wakeup_list;
369 struct list_head del_list;
370 struct acpi_device_status status;
371 struct acpi_device_flags flags;
372 struct acpi_device_pnp pnp;
373 struct acpi_device_power power;
374 struct acpi_device_wakeup wakeup;
375 struct acpi_device_perf performance;
376 struct acpi_device_dir dir;
377 struct acpi_device_data data;
378 struct acpi_scan_handler *handler;
379 struct acpi_hotplug_context *hp;
380 struct acpi_driver *driver;
381 const struct acpi_gpio_mapping *driver_gpios;
384 unsigned int physical_node_count;
385 unsigned int dep_unmet;
386 struct list_head physical_node_list;
387 struct mutex physical_node_lock;
388 void (*remove)(struct acpi_device *);
391 /* Non-device subnode */
392 struct acpi_data_node {
395 struct fwnode_handle fwnode;
396 struct fwnode_handle *parent;
397 struct acpi_device_data data;
398 struct list_head sibling;
400 struct completion kobj_done;
403 extern const struct fwnode_operations acpi_device_fwnode_ops;
404 extern const struct fwnode_operations acpi_data_fwnode_ops;
405 extern const struct fwnode_operations acpi_static_fwnode_ops;
407 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
408 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
410 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
412 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
415 #define to_acpi_device_node(__fwnode) \
417 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
419 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
420 container_of(__to_acpi_device_node_fwnode, \
421 struct acpi_device, fwnode) : \
425 #define to_acpi_data_node(__fwnode) \
427 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
429 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
430 container_of(__to_acpi_data_node_fwnode, \
431 struct acpi_data_node, fwnode) : \
435 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
437 return !IS_ERR_OR_NULL(fwnode) &&
438 fwnode->ops == &acpi_static_fwnode_ops;
441 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
444 return is_acpi_data_node(fwnode) ?
445 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
448 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
450 return &adev->fwnode;
453 static inline void *acpi_driver_data(struct acpi_device *d)
455 return d->driver_data;
458 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
459 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
461 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
463 *((u32 *)&adev->status) = sta;
466 static inline void acpi_set_hp_context(struct acpi_device *adev,
467 struct acpi_hotplug_context *hp)
473 void acpi_initialize_hp_context(struct acpi_device *adev,
474 struct acpi_hotplug_context *hp,
475 int (*notify)(struct acpi_device *, u32),
476 void (*uevent)(struct acpi_device *, u32));
478 /* acpi_device.dev.bus == &acpi_bus_type */
479 extern struct bus_type acpi_bus_type;
486 struct acpi_bus_event {
487 struct list_head node;
488 acpi_device_class device_class;
494 extern struct kobject *acpi_kobj;
495 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
496 void acpi_bus_private_data_handler(acpi_handle, void *);
497 int acpi_bus_get_private_data(acpi_handle, void **);
498 int acpi_bus_attach_private_data(acpi_handle, void *);
499 void acpi_bus_detach_private_data(acpi_handle);
500 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
501 extern int register_acpi_notifier(struct notifier_block *);
502 extern int unregister_acpi_notifier(struct notifier_block *);
508 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
509 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
510 void acpi_bus_put_acpi_device(struct acpi_device *adev);
511 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
512 unsigned long long *sta);
513 int acpi_bus_get_status(struct acpi_device *device);
515 int acpi_bus_set_power(acpi_handle handle, int state);
516 const char *acpi_power_state_string(int state);
517 int acpi_device_get_power(struct acpi_device *device, int *state);
518 int acpi_device_set_power(struct acpi_device *device, int state);
519 int acpi_bus_init_power(struct acpi_device *device);
520 int acpi_device_fix_up_power(struct acpi_device *device);
521 int acpi_bus_update_power(acpi_handle handle, int *state_p);
522 int acpi_device_update_power(struct acpi_device *device, int *state_p);
523 bool acpi_bus_power_manageable(acpi_handle handle);
526 bool acpi_bus_can_wakeup(acpi_handle handle);
528 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
531 void acpi_scan_lock_acquire(void);
532 void acpi_scan_lock_release(void);
533 void acpi_lock_hp_context(void);
534 void acpi_unlock_hp_context(void);
535 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
536 int acpi_bus_register_driver(struct acpi_driver *driver);
537 void acpi_bus_unregister_driver(struct acpi_driver *driver);
538 int acpi_bus_scan(acpi_handle handle);
539 void acpi_bus_trim(struct acpi_device *start);
540 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
541 int acpi_match_device_ids(struct acpi_device *device,
542 const struct acpi_device_id *ids);
543 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
544 char *modalias, size_t len);
545 int acpi_create_dir(struct acpi_device *);
546 void acpi_remove_dir(struct acpi_device *);
548 static inline bool acpi_device_enumerated(struct acpi_device *adev)
550 return adev && adev->flags.initialized && adev->flags.visited;
554 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
555 * @__acpi_driver: acpi_driver struct
557 * Helper macro for ACPI drivers which do not do anything special in module
558 * init/exit. This eliminates a lot of boilerplate. Each module may only
559 * use this macro once, and calling it replaces module_init() and module_exit()
561 #define module_acpi_driver(__acpi_driver) \
562 module_driver(__acpi_driver, acpi_bus_register_driver, \
563 acpi_bus_unregister_driver)
566 * Bind physical devices with ACPI devices
568 struct acpi_bus_type {
569 struct list_head list;
571 bool (*match)(struct device *dev);
572 struct acpi_device * (*find_companion)(struct device *);
573 void (*setup)(struct device *);
574 void (*cleanup)(struct device *);
576 int register_acpi_bus_type(struct acpi_bus_type *);
577 int unregister_acpi_bus_type(struct acpi_bus_type *);
578 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
579 int acpi_unbind_one(struct device *dev);
581 struct acpi_pci_root {
582 struct acpi_device * device;
585 struct resource secondary; /* downstream bus range */
587 u32 osc_support_set; /* _OSC state of support bits */
588 u32 osc_control_set; /* _OSC state of control bits */
589 phys_addr_t mcfg_addr;
594 bool acpi_dma_supported(struct acpi_device *adev);
595 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
596 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
598 int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
599 void acpi_dma_deconfigure(struct device *dev);
601 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
602 u64 address, bool check_children);
603 int acpi_is_root_bridge(acpi_handle);
604 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
606 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
607 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
610 bool acpi_device_always_present(struct acpi_device *adev);
612 static inline bool acpi_device_always_present(struct acpi_device *adev)
619 void acpi_pm_wakeup_event(struct device *dev);
620 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
621 void (*func)(struct acpi_device_wakeup_context *context));
622 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
623 bool acpi_pm_device_can_wakeup(struct device *dev);
624 int acpi_pm_device_sleep_state(struct device *, int *, int);
625 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
627 static inline void acpi_pm_wakeup_event(struct device *dev)
630 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
632 void (*func)(struct acpi_device_wakeup_context *context))
636 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
640 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
644 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
649 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
652 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
658 #ifdef CONFIG_ACPI_SLEEP
659 u32 acpi_target_system_state(void);
661 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
664 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
666 return adev->flags.power_manageable;
669 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
671 return adev->wakeup.flags.valid;
674 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
676 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
677 ((acpi_gbl_FADT.header.revision < 6) &&
678 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
681 #else /* CONFIG_ACPI */
683 static inline int register_acpi_bus_type(void *bus) { return 0; }
684 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
686 #endif /* CONFIG_ACPI */
688 #endif /*__ACPI_BUS_H__*/