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);
96 #include <linux/proc_fs.h>
98 #define ACPI_BUS_FILE_ROOT "acpi"
99 extern struct proc_dir_entry *acpi_root_dir;
101 enum acpi_bus_device_type {
102 ACPI_BUS_TYPE_DEVICE = 0,
104 ACPI_BUS_TYPE_PROCESSOR,
105 ACPI_BUS_TYPE_THERMAL,
106 ACPI_BUS_TYPE_POWER_BUTTON,
107 ACPI_BUS_TYPE_SLEEP_BUTTON,
108 ACPI_BUS_TYPE_ECDT_EC,
109 ACPI_BUS_DEVICE_TYPE_COUNT
120 struct acpi_hotplug_profile {
122 int (*scan_dependent)(struct acpi_device *adev);
123 void (*notify_online)(struct acpi_device *adev);
125 bool demand_offline:1;
128 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
129 struct kobject *kobj)
131 return container_of(kobj, struct acpi_hotplug_profile, kobj);
134 struct acpi_scan_handler {
135 const struct acpi_device_id *ids;
136 struct list_head list_node;
137 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
138 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
139 void (*detach)(struct acpi_device *dev);
140 void (*bind)(struct device *phys_dev);
141 void (*unbind)(struct device *phys_dev);
142 struct acpi_hotplug_profile hotplug;
146 * ACPI Hotplug Context
147 * --------------------
150 struct acpi_hotplug_context {
151 struct acpi_device *self;
152 int (*notify)(struct acpi_device *, u32);
153 void (*uevent)(struct acpi_device *, u32);
154 void (*fixup)(struct acpi_device *);
162 typedef int (*acpi_op_add) (struct acpi_device * device);
163 typedef int (*acpi_op_remove) (struct acpi_device * device);
164 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
166 struct acpi_device_ops {
168 acpi_op_remove remove;
169 acpi_op_notify notify;
172 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
177 const struct acpi_device_id *ids; /* Supported Hardware IDs */
179 struct acpi_device_ops ops;
180 struct device_driver drv;
181 struct module *owner;
191 struct acpi_device_status {
196 u32 battery_present:1;
202 struct acpi_device_flags {
203 u32 dynamic_status:1;
206 u32 power_manageable:1;
210 u32 hotplug_notify:1;
211 u32 is_dock_station:1;
212 u32 of_compatible_ok:1;
221 struct acpi_device_dir {
222 struct proc_dir_entry *entry;
225 #define acpi_device_dir(d) ((d)->dir.entry)
229 typedef char acpi_bus_id[8];
230 typedef unsigned long acpi_bus_address;
231 typedef char acpi_device_name[40];
232 typedef char acpi_device_class[20];
234 struct acpi_hardware_id {
235 struct list_head list;
239 struct acpi_pnp_type {
246 struct acpi_device_pnp {
247 acpi_bus_id bus_id; /* Object name */
248 int instance_no; /* Instance number of this object */
249 struct acpi_pnp_type type; /* ID type */
250 acpi_bus_address bus_address; /* _ADR */
251 char *unique_id; /* _UID */
252 struct list_head ids; /* _HID and _CIDs */
253 acpi_device_name device_name; /* Driver-determined */
254 acpi_device_class device_class; /* " */
255 union acpi_object *str_obj; /* unicode string for _STR method */
258 #define acpi_device_bid(d) ((d)->pnp.bus_id)
259 #define acpi_device_adr(d) ((d)->pnp.bus_address)
260 const char *acpi_device_hid(struct acpi_device *device);
261 #define acpi_device_uid(d) ((d)->pnp.unique_id)
262 #define acpi_device_name(d) ((d)->pnp.device_name)
263 #define acpi_device_class(d) ((d)->pnp.device_class)
265 /* Power Management */
267 struct acpi_device_power_flags {
268 u32 explicit_get:1; /* _PSC present? */
269 u32 power_resources:1; /* Power resources */
270 u32 inrush_current:1; /* Serialize Dx->D0 */
271 u32 power_removed:1; /* Optimize Dx->D0 */
272 u32 ignore_parent:1; /* Power is independent of parent power state */
273 u32 dsw_present:1; /* _DSW present? */
277 struct acpi_device_power_state {
280 u8 explicit_set:1; /* _PSx present? */
283 int power; /* % Power (compared to D0) */
284 int latency; /* Dx->D0 time (microseconds) */
285 struct list_head resources; /* Power resources referenced */
288 struct acpi_device_power {
289 int state; /* Current state */
290 struct acpi_device_power_flags flags;
291 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
294 /* Performance Management */
296 struct acpi_device_perf_flags {
300 struct acpi_device_perf_state {
305 u8 power; /* % Power (compared to P0) */
306 u8 performance; /* % Performance ( " ) */
307 int latency; /* Px->P0 time (microseconds) */
310 struct acpi_device_perf {
312 struct acpi_device_perf_flags flags;
314 struct acpi_device_perf_state *states;
317 /* Wakeup Management */
318 struct acpi_device_wakeup_flags {
319 u8 valid:1; /* Can successfully enable wakeup? */
320 u8 notifier_present:1; /* Wake-up notify handler has been installed */
323 struct acpi_device_wakeup_context {
324 void (*func)(struct acpi_device_wakeup_context *context);
328 struct acpi_device_wakeup {
329 acpi_handle gpe_device;
332 struct list_head resources;
333 struct acpi_device_wakeup_flags flags;
334 struct acpi_device_wakeup_context context;
335 struct wakeup_source *ws;
340 struct acpi_device_physical_node {
341 unsigned int node_id;
342 struct list_head node;
347 /* ACPI Device Specific Data (_DSD) */
348 struct acpi_device_data {
349 const union acpi_object *pointer;
350 const union acpi_object *properties;
351 const union acpi_object *of_compatible;
352 struct list_head subnodes;
355 struct acpi_gpio_mapping;
360 acpi_handle handle; /* no handle for fixed hardware */
361 struct fwnode_handle fwnode;
362 struct acpi_device *parent;
363 struct list_head children;
364 struct list_head node;
365 struct list_head wakeup_list;
366 struct list_head del_list;
367 struct acpi_device_status status;
368 struct acpi_device_flags flags;
369 struct acpi_device_pnp pnp;
370 struct acpi_device_power power;
371 struct acpi_device_wakeup wakeup;
372 struct acpi_device_perf performance;
373 struct acpi_device_dir dir;
374 struct acpi_device_data data;
375 struct acpi_scan_handler *handler;
376 struct acpi_hotplug_context *hp;
377 struct acpi_driver *driver;
378 const struct acpi_gpio_mapping *driver_gpios;
381 unsigned int physical_node_count;
382 unsigned int dep_unmet;
383 struct list_head physical_node_list;
384 struct mutex physical_node_lock;
385 void (*remove)(struct acpi_device *);
388 /* Non-device subnode */
389 struct acpi_data_node {
392 struct fwnode_handle fwnode;
393 struct fwnode_handle *parent;
394 struct acpi_device_data data;
395 struct list_head sibling;
397 struct completion kobj_done;
400 extern const struct fwnode_operations acpi_device_fwnode_ops;
401 extern const struct fwnode_operations acpi_data_fwnode_ops;
402 extern const struct fwnode_operations acpi_static_fwnode_ops;
404 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
405 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
407 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
409 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
412 #define to_acpi_device_node(__fwnode) \
414 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
416 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \
417 container_of(__to_acpi_device_node_fwnode, \
418 struct acpi_device, fwnode) : \
422 #define to_acpi_data_node(__fwnode) \
424 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
426 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \
427 container_of(__to_acpi_data_node_fwnode, \
428 struct acpi_data_node, fwnode) : \
432 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
434 return !IS_ERR_OR_NULL(fwnode) &&
435 fwnode->ops == &acpi_static_fwnode_ops;
438 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
441 return is_acpi_data_node(fwnode) ?
442 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
445 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
447 return &adev->fwnode;
450 static inline void *acpi_driver_data(struct acpi_device *d)
452 return d->driver_data;
455 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
456 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
458 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
460 *((u32 *)&adev->status) = sta;
463 static inline void acpi_set_hp_context(struct acpi_device *adev,
464 struct acpi_hotplug_context *hp)
470 void acpi_initialize_hp_context(struct acpi_device *adev,
471 struct acpi_hotplug_context *hp,
472 int (*notify)(struct acpi_device *, u32),
473 void (*uevent)(struct acpi_device *, u32));
475 /* acpi_device.dev.bus == &acpi_bus_type */
476 extern struct bus_type acpi_bus_type;
483 struct acpi_bus_event {
484 struct list_head node;
485 acpi_device_class device_class;
491 extern struct kobject *acpi_kobj;
492 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
493 void acpi_bus_private_data_handler(acpi_handle, void *);
494 int acpi_bus_get_private_data(acpi_handle, void **);
495 int acpi_bus_attach_private_data(acpi_handle, void *);
496 void acpi_bus_detach_private_data(acpi_handle);
497 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
498 extern int register_acpi_notifier(struct notifier_block *);
499 extern int unregister_acpi_notifier(struct notifier_block *);
505 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
506 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
507 void acpi_bus_put_acpi_device(struct acpi_device *adev);
508 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
509 unsigned long long *sta);
510 int acpi_bus_get_status(struct acpi_device *device);
512 int acpi_bus_set_power(acpi_handle handle, int state);
513 const char *acpi_power_state_string(int state);
514 int acpi_device_get_power(struct acpi_device *device, int *state);
515 int acpi_device_set_power(struct acpi_device *device, int state);
516 int acpi_bus_init_power(struct acpi_device *device);
517 int acpi_device_fix_up_power(struct acpi_device *device);
518 int acpi_bus_update_power(acpi_handle handle, int *state_p);
519 int acpi_device_update_power(struct acpi_device *device, int *state_p);
520 bool acpi_bus_power_manageable(acpi_handle handle);
523 bool acpi_bus_can_wakeup(acpi_handle handle);
525 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
528 void acpi_scan_lock_acquire(void);
529 void acpi_scan_lock_release(void);
530 void acpi_lock_hp_context(void);
531 void acpi_unlock_hp_context(void);
532 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
533 int acpi_bus_register_driver(struct acpi_driver *driver);
534 void acpi_bus_unregister_driver(struct acpi_driver *driver);
535 int acpi_bus_scan(acpi_handle handle);
536 void acpi_bus_trim(struct acpi_device *start);
537 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
538 int acpi_match_device_ids(struct acpi_device *device,
539 const struct acpi_device_id *ids);
540 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
541 char *modalias, size_t len);
542 int acpi_create_dir(struct acpi_device *);
543 void acpi_remove_dir(struct acpi_device *);
545 static inline bool acpi_device_enumerated(struct acpi_device *adev)
547 return adev && adev->flags.initialized && adev->flags.visited;
551 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
552 * @__acpi_driver: acpi_driver struct
554 * Helper macro for ACPI drivers which do not do anything special in module
555 * init/exit. This eliminates a lot of boilerplate. Each module may only
556 * use this macro once, and calling it replaces module_init() and module_exit()
558 #define module_acpi_driver(__acpi_driver) \
559 module_driver(__acpi_driver, acpi_bus_register_driver, \
560 acpi_bus_unregister_driver)
563 * Bind physical devices with ACPI devices
565 struct acpi_bus_type {
566 struct list_head list;
568 bool (*match)(struct device *dev);
569 struct acpi_device * (*find_companion)(struct device *);
570 void (*setup)(struct device *);
571 void (*cleanup)(struct device *);
573 int register_acpi_bus_type(struct acpi_bus_type *);
574 int unregister_acpi_bus_type(struct acpi_bus_type *);
575 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
576 int acpi_unbind_one(struct device *dev);
578 struct acpi_pci_root {
579 struct acpi_device * device;
582 struct resource secondary; /* downstream bus range */
584 u32 osc_support_set; /* _OSC state of support bits */
585 u32 osc_control_set; /* _OSC state of control bits */
586 phys_addr_t mcfg_addr;
591 bool acpi_dma_supported(struct acpi_device *adev);
592 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
593 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
595 int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
596 void acpi_dma_deconfigure(struct device *dev);
598 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
599 u64 address, bool check_children);
600 int acpi_is_root_bridge(acpi_handle);
601 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
603 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
604 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
607 bool acpi_device_always_present(struct acpi_device *adev);
609 static inline bool acpi_device_always_present(struct acpi_device *adev)
616 void acpi_pm_wakeup_event(struct device *dev);
617 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
618 void (*func)(struct acpi_device_wakeup_context *context));
619 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
620 bool acpi_pm_device_can_wakeup(struct device *dev);
621 int acpi_pm_device_sleep_state(struct device *, int *, int);
622 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
624 static inline void acpi_pm_wakeup_event(struct device *dev)
627 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
629 void (*func)(struct acpi_device_wakeup_context *context))
633 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
637 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
641 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
646 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
649 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
655 #ifdef CONFIG_ACPI_SLEEP
656 u32 acpi_target_system_state(void);
658 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
661 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
663 return adev->flags.power_manageable;
666 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
668 return adev->wakeup.flags.valid;
671 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
673 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
674 ((acpi_gbl_FADT.header.revision < 6) &&
675 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
678 #else /* CONFIG_ACPI */
680 static inline int register_acpi_bus_type(void *bus) { return 0; }
681 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
683 #endif /* CONFIG_ACPI */
685 #endif /*__ACPI_BUS_H__*/