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 u8 *uuid, u64 rev, u64 funcs);
65 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid,
66 u64 rev, u64 func, union acpi_object *argv4);
68 static inline union acpi_object *
69 acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, u64 rev, u64 func,
70 union acpi_object *argv4, acpi_object_type type)
72 union acpi_object *obj;
74 obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4);
75 if (obj && obj->type != type) {
83 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \
85 .package.type = ACPI_TYPE_PACKAGE, \
86 .package.count = (cnt), \
87 .package.elements = (eles) \
90 bool acpi_dev_found(const char *hid);
91 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
95 #include <linux/proc_fs.h>
97 #define ACPI_BUS_FILE_ROOT "acpi"
98 extern struct proc_dir_entry *acpi_root_dir;
100 enum acpi_bus_device_type {
101 ACPI_BUS_TYPE_DEVICE = 0,
103 ACPI_BUS_TYPE_PROCESSOR,
104 ACPI_BUS_TYPE_THERMAL,
105 ACPI_BUS_TYPE_POWER_BUTTON,
106 ACPI_BUS_TYPE_SLEEP_BUTTON,
107 ACPI_BUS_DEVICE_TYPE_COUNT
118 struct acpi_hotplug_profile {
120 int (*scan_dependent)(struct acpi_device *adev);
121 void (*notify_online)(struct acpi_device *adev);
123 bool demand_offline:1;
126 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
127 struct kobject *kobj)
129 return container_of(kobj, struct acpi_hotplug_profile, kobj);
132 struct acpi_scan_handler {
133 const struct acpi_device_id *ids;
134 struct list_head list_node;
135 bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
136 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
137 void (*detach)(struct acpi_device *dev);
138 void (*bind)(struct device *phys_dev);
139 void (*unbind)(struct device *phys_dev);
140 struct acpi_hotplug_profile hotplug;
144 * ACPI Hotplug Context
145 * --------------------
148 struct acpi_hotplug_context {
149 struct acpi_device *self;
150 int (*notify)(struct acpi_device *, u32);
151 void (*uevent)(struct acpi_device *, u32);
152 void (*fixup)(struct acpi_device *);
160 typedef int (*acpi_op_add) (struct acpi_device * device);
161 typedef int (*acpi_op_remove) (struct acpi_device * device);
162 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
164 struct acpi_device_ops {
166 acpi_op_remove remove;
167 acpi_op_notify notify;
170 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
175 const struct acpi_device_id *ids; /* Supported Hardware IDs */
177 struct acpi_device_ops ops;
178 struct device_driver drv;
179 struct module *owner;
189 struct acpi_device_status {
194 u32 battery_present:1;
200 struct acpi_device_flags {
201 u32 dynamic_status:1;
204 u32 power_manageable:1;
208 u32 hotplug_notify:1;
209 u32 is_dock_station:1;
210 u32 of_compatible_ok:1;
218 struct acpi_device_dir {
219 struct proc_dir_entry *entry;
222 #define acpi_device_dir(d) ((d)->dir.entry)
226 typedef char acpi_bus_id[8];
227 typedef unsigned long acpi_bus_address;
228 typedef char acpi_device_name[40];
229 typedef char acpi_device_class[20];
231 struct acpi_hardware_id {
232 struct list_head list;
236 struct acpi_pnp_type {
243 struct acpi_device_pnp {
244 acpi_bus_id bus_id; /* Object name */
245 struct acpi_pnp_type type; /* ID type */
246 acpi_bus_address bus_address; /* _ADR */
247 char *unique_id; /* _UID */
248 struct list_head ids; /* _HID and _CIDs */
249 acpi_device_name device_name; /* Driver-determined */
250 acpi_device_class device_class; /* " */
251 union acpi_object *str_obj; /* unicode string for _STR method */
254 #define acpi_device_bid(d) ((d)->pnp.bus_id)
255 #define acpi_device_adr(d) ((d)->pnp.bus_address)
256 const char *acpi_device_hid(struct acpi_device *device);
257 #define acpi_device_uid(d) ((d)->pnp.unique_id)
258 #define acpi_device_name(d) ((d)->pnp.device_name)
259 #define acpi_device_class(d) ((d)->pnp.device_class)
261 /* Power Management */
263 struct acpi_device_power_flags {
264 u32 explicit_get:1; /* _PSC present? */
265 u32 power_resources:1; /* Power resources */
266 u32 inrush_current:1; /* Serialize Dx->D0 */
267 u32 power_removed:1; /* Optimize Dx->D0 */
268 u32 ignore_parent:1; /* Power is independent of parent power state */
269 u32 dsw_present:1; /* _DSW present? */
273 struct acpi_device_power_state {
276 u8 explicit_set:1; /* _PSx present? */
279 int power; /* % Power (compared to D0) */
280 int latency; /* Dx->D0 time (microseconds) */
281 struct list_head resources; /* Power resources referenced */
284 struct acpi_device_power {
285 int state; /* Current state */
286 struct acpi_device_power_flags flags;
287 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
290 /* Performance Management */
292 struct acpi_device_perf_flags {
296 struct acpi_device_perf_state {
301 u8 power; /* % Power (compared to P0) */
302 u8 performance; /* % Performance ( " ) */
303 int latency; /* Px->P0 time (microseconds) */
306 struct acpi_device_perf {
308 struct acpi_device_perf_flags flags;
310 struct acpi_device_perf_state *states;
313 /* Wakeup Management */
314 struct acpi_device_wakeup_flags {
315 u8 valid:1; /* Can successfully enable wakeup? */
316 u8 run_wake:1; /* Run-Wake GPE devices */
317 u8 notifier_present:1; /* Wake-up notify handler has been installed */
318 u8 enabled:1; /* Enabled for wakeup */
321 struct acpi_device_wakeup_context {
322 struct work_struct work;
326 struct acpi_device_wakeup {
327 acpi_handle gpe_device;
330 struct list_head resources;
331 struct acpi_device_wakeup_flags flags;
332 struct acpi_device_wakeup_context context;
333 struct wakeup_source *ws;
337 struct acpi_device_physical_node {
338 unsigned int node_id;
339 struct list_head node;
344 /* ACPI Device Specific Data (_DSD) */
345 struct acpi_device_data {
346 const union acpi_object *pointer;
347 const union acpi_object *properties;
348 const union acpi_object *of_compatible;
349 struct list_head subnodes;
352 struct acpi_gpio_mapping;
357 acpi_handle handle; /* no handle for fixed hardware */
358 struct fwnode_handle fwnode;
359 struct acpi_device *parent;
360 struct list_head children;
361 struct list_head node;
362 struct list_head wakeup_list;
363 struct list_head del_list;
364 struct acpi_device_status status;
365 struct acpi_device_flags flags;
366 struct acpi_device_pnp pnp;
367 struct acpi_device_power power;
368 struct acpi_device_wakeup wakeup;
369 struct acpi_device_perf performance;
370 struct acpi_device_dir dir;
371 struct acpi_device_data data;
372 struct acpi_scan_handler *handler;
373 struct acpi_hotplug_context *hp;
374 struct acpi_driver *driver;
375 const struct acpi_gpio_mapping *driver_gpios;
378 unsigned int physical_node_count;
379 unsigned int dep_unmet;
380 struct list_head physical_node_list;
381 struct mutex physical_node_lock;
382 void (*remove)(struct acpi_device *);
385 /* Non-device subnode */
386 struct acpi_data_node {
389 struct fwnode_handle fwnode;
390 struct acpi_device_data data;
391 struct list_head sibling;
393 struct completion kobj_done;
396 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
398 return !IS_ERR_OR_NULL(fwnode) && (fwnode->type == FWNODE_ACPI
399 || fwnode->type == FWNODE_ACPI_DATA);
402 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
404 return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_ACPI;
407 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
409 return is_acpi_device_node(fwnode) ?
410 container_of(fwnode, struct acpi_device, fwnode) : NULL;
413 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
415 return fwnode && fwnode->type == FWNODE_ACPI_DATA;
418 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
420 return is_acpi_data_node(fwnode) ?
421 container_of(fwnode, struct acpi_data_node, fwnode) : NULL;
424 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
427 return is_acpi_data_node(fwnode) ?
428 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
431 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
433 return &adev->fwnode;
436 static inline void *acpi_driver_data(struct acpi_device *d)
438 return d->driver_data;
441 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
442 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
444 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
446 *((u32 *)&adev->status) = sta;
449 static inline void acpi_set_hp_context(struct acpi_device *adev,
450 struct acpi_hotplug_context *hp)
456 void acpi_initialize_hp_context(struct acpi_device *adev,
457 struct acpi_hotplug_context *hp,
458 int (*notify)(struct acpi_device *, u32),
459 void (*uevent)(struct acpi_device *, u32));
461 /* acpi_device.dev.bus == &acpi_bus_type */
462 extern struct bus_type acpi_bus_type;
469 struct acpi_bus_event {
470 struct list_head node;
471 acpi_device_class device_class;
477 extern struct kobject *acpi_kobj;
478 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
479 void acpi_bus_private_data_handler(acpi_handle, void *);
480 int acpi_bus_get_private_data(acpi_handle, void **);
481 int acpi_bus_attach_private_data(acpi_handle, void *);
482 void acpi_bus_detach_private_data(acpi_handle);
483 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
484 extern int register_acpi_notifier(struct notifier_block *);
485 extern int unregister_acpi_notifier(struct notifier_block *);
491 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
492 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
493 void acpi_bus_put_acpi_device(struct acpi_device *adev);
494 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
495 unsigned long long *sta);
496 int acpi_bus_get_status(struct acpi_device *device);
498 int acpi_bus_set_power(acpi_handle handle, int state);
499 const char *acpi_power_state_string(int state);
500 int acpi_device_get_power(struct acpi_device *device, int *state);
501 int acpi_device_set_power(struct acpi_device *device, int state);
502 int acpi_bus_init_power(struct acpi_device *device);
503 int acpi_device_fix_up_power(struct acpi_device *device);
504 int acpi_bus_update_power(acpi_handle handle, int *state_p);
505 int acpi_device_update_power(struct acpi_device *device, int *state_p);
506 bool acpi_bus_power_manageable(acpi_handle handle);
509 bool acpi_bus_can_wakeup(acpi_handle handle);
511 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
514 void acpi_scan_lock_acquire(void);
515 void acpi_scan_lock_release(void);
516 void acpi_lock_hp_context(void);
517 void acpi_unlock_hp_context(void);
518 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
519 int acpi_bus_register_driver(struct acpi_driver *driver);
520 void acpi_bus_unregister_driver(struct acpi_driver *driver);
521 int acpi_bus_scan(acpi_handle handle);
522 void acpi_bus_trim(struct acpi_device *start);
523 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
524 int acpi_match_device_ids(struct acpi_device *device,
525 const struct acpi_device_id *ids);
526 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
527 char *modalias, size_t len);
528 int acpi_create_dir(struct acpi_device *);
529 void acpi_remove_dir(struct acpi_device *);
531 static inline bool acpi_device_enumerated(struct acpi_device *adev)
533 return adev && adev->flags.initialized && adev->flags.visited;
537 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
538 * @__acpi_driver: acpi_driver struct
540 * Helper macro for ACPI drivers which do not do anything special in module
541 * init/exit. This eliminates a lot of boilerplate. Each module may only
542 * use this macro once, and calling it replaces module_init() and module_exit()
544 #define module_acpi_driver(__acpi_driver) \
545 module_driver(__acpi_driver, acpi_bus_register_driver, \
546 acpi_bus_unregister_driver)
549 * Bind physical devices with ACPI devices
551 struct acpi_bus_type {
552 struct list_head list;
554 bool (*match)(struct device *dev);
555 struct acpi_device * (*find_companion)(struct device *);
556 void (*setup)(struct device *);
557 void (*cleanup)(struct device *);
559 int register_acpi_bus_type(struct acpi_bus_type *);
560 int unregister_acpi_bus_type(struct acpi_bus_type *);
561 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
562 int acpi_unbind_one(struct device *dev);
564 struct acpi_pci_root {
565 struct acpi_device * device;
568 struct resource secondary; /* downstream bus range */
570 u32 osc_support_set; /* _OSC state of support bits */
571 u32 osc_control_set; /* _OSC state of control bits */
572 phys_addr_t mcfg_addr;
577 bool acpi_dma_supported(struct acpi_device *adev);
578 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
579 void acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
580 void acpi_dma_deconfigure(struct device *dev);
582 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
583 u64 address, bool check_children);
584 int acpi_is_root_bridge(acpi_handle);
585 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
587 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
588 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
591 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
592 void (*work_func)(struct work_struct *work));
593 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
594 int acpi_pm_device_sleep_state(struct device *, int *, int);
595 int acpi_pm_device_run_wake(struct device *, bool);
597 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
599 void (*work_func)(struct work_struct *work))
603 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
607 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
612 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
615 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
621 #ifdef CONFIG_PM_SLEEP
622 int acpi_pm_device_sleep_wake(struct device *, bool);
624 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
630 #ifdef CONFIG_ACPI_SLEEP
631 u32 acpi_target_system_state(void);
633 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
636 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
638 return adev->flags.power_manageable;
641 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
643 return adev->wakeup.flags.valid;
646 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
648 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
649 ((acpi_gbl_FADT.header.revision < 6) &&
650 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
653 #else /* CONFIG_ACPI */
655 static inline int register_acpi_bus_type(void *bus) { return 0; }
656 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
658 #endif /* CONFIG_ACPI */
660 #endif /*__ACPI_BUS_H__*/