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 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #ifndef __ACPI_BUS_H__
27 #define __ACPI_BUS_H__
29 #include <linux/device.h>
31 #include <acpi/acpi.h>
33 /* TBD: Make dynamic */
34 #define ACPI_MAX_HANDLES 10
35 struct acpi_handle_list {
37 acpi_handle handles[ACPI_MAX_HANDLES];
42 acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer);
45 acpi_evaluate_integer(acpi_handle handle,
47 struct acpi_object_list *arguments, unsigned long long *data);
49 acpi_evaluate_reference(acpi_handle handle,
51 struct acpi_object_list *arguments,
52 struct acpi_handle_list *list);
54 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
55 u32 status_code, struct acpi_buffer *status_buf);
58 unsigned int revision:7; /* 0 */
59 unsigned int ignore_colour:1; /* 7 */
60 unsigned int colour:24; /* 8 */
61 unsigned int width:16; /* 32 */
62 unsigned int height:16; /* 48 */
63 unsigned int user_visible:1; /* 64 */
64 unsigned int dock:1; /* 65 */
65 unsigned int lid:1; /* 66 */
66 unsigned int panel:3; /* 67 */
67 unsigned int vertical_pos:2; /* 70 */
68 unsigned int horizontal_pos:2; /* 72 */
69 unsigned int shape:4; /* 74 */
70 unsigned int group_orientation:1; /* 78 */
71 unsigned int group_token:8; /* 79 */
72 unsigned int group_position:8; /* 87 */
73 unsigned int bay:1; /* 95 */
74 unsigned int ejectable:1; /* 96 */
75 unsigned int ospm_eject_required:1; /* 97 */
76 unsigned int cabinet_number:8; /* 98 */
77 unsigned int card_cage_number:8; /* 106 */
78 unsigned int reference:1; /* 114 */
79 unsigned int rotation:4; /* 115 */
80 unsigned int order:5; /* 119 */
81 unsigned int reserved:4; /* 124 */
82 unsigned int vertical_offset:16; /* 128 */
83 unsigned int horizontal_offset:16; /* 144 */
84 } __attribute__((__packed__));
87 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld *pld);
90 #include <linux/proc_fs.h>
92 #define ACPI_BUS_FILE_ROOT "acpi"
93 extern struct proc_dir_entry *acpi_root_dir;
95 enum acpi_bus_removal_type {
96 ACPI_BUS_REMOVAL_NORMAL = 0,
97 ACPI_BUS_REMOVAL_EJECT,
98 ACPI_BUS_REMOVAL_SUPRISE,
99 ACPI_BUS_REMOVAL_TYPE_COUNT
102 enum acpi_bus_device_type {
103 ACPI_BUS_TYPE_DEVICE = 0,
105 ACPI_BUS_TYPE_PROCESSOR,
106 ACPI_BUS_TYPE_THERMAL,
107 ACPI_BUS_TYPE_POWER_BUTTON,
108 ACPI_BUS_TYPE_SLEEP_BUTTON,
109 ACPI_BUS_DEVICE_TYPE_COUNT
120 typedef int (*acpi_op_add) (struct acpi_device * device);
121 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
122 typedef int (*acpi_op_start) (struct acpi_device * device);
123 typedef int (*acpi_op_bind) (struct acpi_device * device);
124 typedef int (*acpi_op_unbind) (struct acpi_device * device);
125 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
127 struct acpi_bus_ops {
132 struct acpi_device_ops {
134 acpi_op_remove remove;
137 acpi_op_unbind unbind;
138 acpi_op_notify notify;
141 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
146 const struct acpi_device_id *ids; /* Supported Hardware IDs */
148 struct acpi_device_ops ops;
149 struct device_driver drv;
150 struct module *owner;
160 struct acpi_device_status {
165 u32 battery_present:1;
171 struct acpi_device_flags {
172 u32 dynamic_status:1;
177 u32 suprise_removal_ok:1;
178 u32 power_manageable:1;
179 u32 performance_manageable:1;
186 struct acpi_device_dir {
187 struct proc_dir_entry *entry;
190 #define acpi_device_dir(d) ((d)->dir.entry)
194 typedef char acpi_bus_id[8];
195 typedef unsigned long acpi_bus_address;
196 typedef char acpi_device_name[40];
197 typedef char acpi_device_class[20];
199 struct acpi_hardware_id {
200 struct list_head list;
204 struct acpi_device_pnp {
205 acpi_bus_id bus_id; /* Object name */
206 acpi_bus_address bus_address; /* _ADR */
207 char *unique_id; /* _UID */
208 struct list_head ids; /* _HID and _CIDs */
209 acpi_device_name device_name; /* Driver-determined */
210 acpi_device_class device_class; /* " */
213 #define acpi_device_bid(d) ((d)->pnp.bus_id)
214 #define acpi_device_adr(d) ((d)->pnp.bus_address)
215 const char *acpi_device_hid(struct acpi_device *device);
216 #define acpi_device_name(d) ((d)->pnp.device_name)
217 #define acpi_device_class(d) ((d)->pnp.device_class)
219 /* Power Management */
221 struct acpi_device_power_flags {
222 u32 explicit_get:1; /* _PSC present? */
223 u32 power_resources:1; /* Power resources */
224 u32 inrush_current:1; /* Serialize Dx->D0 */
225 u32 power_removed:1; /* Optimize Dx->D0 */
229 struct acpi_device_power_state {
232 u8 explicit_set:1; /* _PSx present? */
235 int power; /* % Power (compared to D0) */
236 int latency; /* Dx->D0 time (microseconds) */
237 struct acpi_handle_list resources; /* Power resources referenced */
240 struct acpi_device_power {
241 int state; /* Current state */
242 struct acpi_device_power_flags flags;
243 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
246 /* Performance Management */
248 struct acpi_device_perf_flags {
252 struct acpi_device_perf_state {
257 u8 power; /* % Power (compared to P0) */
258 u8 performance; /* % Performance ( " ) */
259 int latency; /* Px->P0 time (microseconds) */
262 struct acpi_device_perf {
264 struct acpi_device_perf_flags flags;
266 struct acpi_device_perf_state *states;
269 /* Wakeup Management */
270 struct acpi_device_wakeup_flags {
271 u8 valid:1; /* Can successfully enable wakeup? */
272 u8 run_wake:1; /* Run-Wake GPE devices */
273 u8 notifier_present:1; /* Wake-up notify handler has been installed */
276 struct acpi_device_wakeup {
277 acpi_handle gpe_device;
280 struct acpi_handle_list resources;
281 struct acpi_device_wakeup_flags flags;
285 struct acpi_device_physical_node {
287 struct list_head node;
291 /* set maximum of physical nodes to 32 for expansibility */
292 #define ACPI_MAX_PHYSICAL_NODE 32
297 acpi_handle handle; /* no handle for fixed hardware */
298 struct acpi_device *parent;
299 struct list_head children;
300 struct list_head node;
301 struct list_head wakeup_list;
302 struct acpi_device_status status;
303 struct acpi_device_flags flags;
304 struct acpi_device_pnp pnp;
305 struct acpi_device_power power;
306 struct acpi_device_wakeup wakeup;
307 struct acpi_device_perf performance;
308 struct acpi_device_dir dir;
309 struct acpi_device_ops ops;
310 struct acpi_driver *driver;
313 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
314 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
315 u8 physical_node_count;
316 struct list_head physical_node_list;
317 struct mutex physical_node_lock;
318 DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
321 static inline void *acpi_driver_data(struct acpi_device *d)
323 return d->driver_data;
326 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
327 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
329 /* acpi_device.dev.bus == &acpi_bus_type */
330 extern struct bus_type acpi_bus_type;
337 struct acpi_bus_event {
338 struct list_head node;
339 acpi_device_class device_class;
345 struct acpi_eject_event {
350 extern struct kobject *acpi_kobj;
351 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
352 void acpi_bus_private_data_handler(acpi_handle, void *);
353 int acpi_bus_get_private_data(acpi_handle, void **);
354 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
355 extern int register_acpi_notifier(struct notifier_block *);
356 extern int unregister_acpi_notifier(struct notifier_block *);
358 extern int register_acpi_bus_notifier(struct notifier_block *nb);
359 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
364 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
365 void acpi_bus_data_handler(acpi_handle handle, void *context);
366 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
367 unsigned long long *sta);
368 int acpi_bus_get_status(struct acpi_device *device);
369 int acpi_bus_set_power(acpi_handle handle, int state);
370 int acpi_bus_update_power(acpi_handle handle, int *state_p);
371 bool acpi_bus_power_manageable(acpi_handle handle);
372 bool acpi_bus_can_wakeup(acpi_handle handle);
373 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
374 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
375 #ifdef CONFIG_ACPI_PROC_EVENT
376 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
377 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
378 int acpi_bus_receive_event(struct acpi_bus_event *event);
380 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
383 int acpi_bus_register_driver(struct acpi_driver *driver);
384 void acpi_bus_unregister_driver(struct acpi_driver *driver);
385 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
386 acpi_handle handle, int type);
387 void acpi_bus_hot_remove_device(void *context);
388 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
389 int acpi_bus_start(struct acpi_device *device);
390 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
391 int acpi_match_device_ids(struct acpi_device *device,
392 const struct acpi_device_id *ids);
393 int acpi_create_dir(struct acpi_device *);
394 void acpi_remove_dir(struct acpi_device *);
397 * Bind physical devices with ACPI devices
399 struct acpi_bus_type {
400 struct list_head list;
401 struct bus_type *bus;
402 /* For general devices under the bus */
403 int (*find_device) (struct device *, acpi_handle *);
404 /* For bridges, such as PCI root bridge, IDE controller */
405 int (*find_bridge) (struct device *, acpi_handle *);
407 int register_acpi_bus_type(struct acpi_bus_type *);
408 int unregister_acpi_bus_type(struct acpi_bus_type *);
410 struct acpi_pci_root {
411 struct list_head node;
412 struct acpi_device * device;
413 struct acpi_pci_id id;
416 struct resource secondary; /* downstream bus range */
418 u32 osc_support_set; /* _OSC state of support bits */
419 u32 osc_control_set; /* _OSC state of control bits */
420 phys_addr_t mcfg_addr;
424 acpi_handle acpi_get_child(acpi_handle, u64);
425 int acpi_is_root_bridge(acpi_handle);
426 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
427 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
428 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
430 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
431 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
434 int acpi_pm_device_sleep_state(struct device *, int *, int);
436 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
440 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
444 #ifdef CONFIG_PM_SLEEP
445 int acpi_pm_device_run_wake(struct device *, bool);
446 int acpi_pm_device_sleep_wake(struct device *, bool);
448 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
452 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
458 #else /* CONFIG_ACPI */
460 static inline int register_acpi_bus_type(void *bus) { return 0; }
461 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
463 #endif /* CONFIG_ACPI */
465 #endif /*__ACPI_BUS_H__*/