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);
55 unsigned int revision:7; /* 0 */
56 unsigned int ignore_colour:1; /* 7 */
57 unsigned int colour:24; /* 8 */
58 unsigned int width:16; /* 32 */
59 unsigned int height:16; /* 48 */
60 unsigned int user_visible:1; /* 64 */
61 unsigned int dock:1; /* 65 */
62 unsigned int lid:1; /* 66 */
63 unsigned int panel:3; /* 67 */
64 unsigned int vertical_pos:2; /* 70 */
65 unsigned int horizontal_pos:2; /* 72 */
66 unsigned int shape:4; /* 74 */
67 unsigned int group_orientation:1; /* 78 */
68 unsigned int group_token:8; /* 79 */
69 unsigned int group_position:8; /* 87 */
70 unsigned int bay:1; /* 95 */
71 unsigned int ejectable:1; /* 96 */
72 unsigned int ospm_eject_required:1; /* 97 */
73 unsigned int cabinet_number:8; /* 98 */
74 unsigned int card_cage_number:8; /* 106 */
75 unsigned int reference:1; /* 114 */
76 unsigned int rotation:4; /* 115 */
77 unsigned int order:5; /* 119 */
78 unsigned int reserved:4; /* 124 */
79 unsigned int vertical_offset:16; /* 128 */
80 unsigned int horizontal_offset:16; /* 144 */
81 } __attribute__((__packed__));
84 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld *pld);
87 #include <linux/proc_fs.h>
89 #define ACPI_BUS_FILE_ROOT "acpi"
90 extern struct proc_dir_entry *acpi_root_dir;
92 enum acpi_bus_removal_type {
93 ACPI_BUS_REMOVAL_NORMAL = 0,
94 ACPI_BUS_REMOVAL_EJECT,
95 ACPI_BUS_REMOVAL_SUPRISE,
96 ACPI_BUS_REMOVAL_TYPE_COUNT
99 enum acpi_bus_device_type {
100 ACPI_BUS_TYPE_DEVICE = 0,
102 ACPI_BUS_TYPE_PROCESSOR,
103 ACPI_BUS_TYPE_THERMAL,
104 ACPI_BUS_TYPE_POWER_BUTTON,
105 ACPI_BUS_TYPE_SLEEP_BUTTON,
106 ACPI_BUS_DEVICE_TYPE_COUNT
117 typedef int (*acpi_op_add) (struct acpi_device * device);
118 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
119 typedef int (*acpi_op_start) (struct acpi_device * device);
120 typedef int (*acpi_op_bind) (struct acpi_device * device);
121 typedef int (*acpi_op_unbind) (struct acpi_device * device);
122 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
124 struct acpi_bus_ops {
129 struct acpi_device_ops {
131 acpi_op_remove remove;
134 acpi_op_unbind unbind;
135 acpi_op_notify notify;
138 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
143 const struct acpi_device_id *ids; /* Supported Hardware IDs */
145 struct acpi_device_ops ops;
146 struct device_driver drv;
147 struct module *owner;
157 struct acpi_device_status {
162 u32 battery_present:1;
168 struct acpi_device_flags {
169 u32 dynamic_status:1;
174 u32 suprise_removal_ok:1;
175 u32 power_manageable:1;
176 u32 performance_manageable:1;
182 struct acpi_device_dir {
183 struct proc_dir_entry *entry;
186 #define acpi_device_dir(d) ((d)->dir.entry)
190 typedef char acpi_bus_id[8];
191 typedef unsigned long acpi_bus_address;
192 typedef char acpi_device_name[40];
193 typedef char acpi_device_class[20];
195 struct acpi_hardware_id {
196 struct list_head list;
200 struct acpi_device_pnp {
201 acpi_bus_id bus_id; /* Object name */
202 acpi_bus_address bus_address; /* _ADR */
203 char *unique_id; /* _UID */
204 struct list_head ids; /* _HID and _CIDs */
205 acpi_device_name device_name; /* Driver-determined */
206 acpi_device_class device_class; /* " */
209 #define acpi_device_bid(d) ((d)->pnp.bus_id)
210 #define acpi_device_adr(d) ((d)->pnp.bus_address)
211 const char *acpi_device_hid(struct acpi_device *device);
212 #define acpi_device_name(d) ((d)->pnp.device_name)
213 #define acpi_device_class(d) ((d)->pnp.device_class)
215 /* Power Management */
217 struct acpi_device_power_flags {
218 u32 explicit_get:1; /* _PSC present? */
219 u32 power_resources:1; /* Power resources */
220 u32 inrush_current:1; /* Serialize Dx->D0 */
221 u32 power_removed:1; /* Optimize Dx->D0 */
225 struct acpi_device_power_state {
228 u8 explicit_set:1; /* _PSx present? */
231 int power; /* % Power (compared to D0) */
232 int latency; /* Dx->D0 time (microseconds) */
233 struct acpi_handle_list resources; /* Power resources referenced */
236 struct acpi_device_power {
237 int state; /* Current state */
238 struct acpi_device_power_flags flags;
239 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
242 /* Performance Management */
244 struct acpi_device_perf_flags {
248 struct acpi_device_perf_state {
253 u8 power; /* % Power (compared to P0) */
254 u8 performance; /* % Performance ( " ) */
255 int latency; /* Px->P0 time (microseconds) */
258 struct acpi_device_perf {
260 struct acpi_device_perf_flags flags;
262 struct acpi_device_perf_state *states;
265 /* Wakeup Management */
266 struct acpi_device_wakeup_flags {
267 u8 valid:1; /* Can successfully enable wakeup? */
268 u8 run_wake:1; /* Run-Wake GPE devices */
269 u8 notifier_present:1; /* Wake-up notify handler has been installed */
272 struct acpi_device_wakeup {
273 acpi_handle gpe_device;
276 struct acpi_handle_list resources;
277 struct acpi_device_wakeup_flags flags;
285 acpi_handle handle; /* no handle for fixed hardware */
286 struct acpi_device *parent;
287 struct list_head children;
288 struct list_head node;
289 struct list_head wakeup_list;
290 struct acpi_device_status status;
291 struct acpi_device_flags flags;
292 struct acpi_device_pnp pnp;
293 struct acpi_device_power power;
294 struct acpi_device_wakeup wakeup;
295 struct acpi_device_perf performance;
296 struct acpi_device_dir dir;
297 struct acpi_device_ops ops;
298 struct acpi_driver *driver;
301 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
302 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
305 static inline void *acpi_driver_data(struct acpi_device *d)
307 return d->driver_data;
310 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
311 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
313 /* acpi_device.dev.bus == &acpi_bus_type */
314 extern struct bus_type acpi_bus_type;
321 struct acpi_bus_event {
322 struct list_head node;
323 acpi_device_class device_class;
329 extern struct kobject *acpi_kobj;
330 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
331 void acpi_bus_private_data_handler(acpi_handle, void *);
332 int acpi_bus_get_private_data(acpi_handle, void **);
333 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
334 extern int register_acpi_notifier(struct notifier_block *);
335 extern int unregister_acpi_notifier(struct notifier_block *);
337 extern int register_acpi_bus_notifier(struct notifier_block *nb);
338 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
343 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
344 void acpi_bus_data_handler(acpi_handle handle, void *context);
345 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
346 unsigned long long *sta);
347 int acpi_bus_get_status(struct acpi_device *device);
348 int acpi_bus_set_power(acpi_handle handle, int state);
349 int acpi_bus_update_power(acpi_handle handle, int *state_p);
350 bool acpi_bus_power_manageable(acpi_handle handle);
351 bool acpi_bus_can_wakeup(acpi_handle handle);
352 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
353 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
354 #ifdef CONFIG_ACPI_PROC_EVENT
355 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
356 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
357 int acpi_bus_receive_event(struct acpi_bus_event *event);
359 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
362 int acpi_bus_register_driver(struct acpi_driver *driver);
363 void acpi_bus_unregister_driver(struct acpi_driver *driver);
364 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
365 acpi_handle handle, int type);
366 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
367 int acpi_bus_start(struct acpi_device *device);
368 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
369 int acpi_match_device_ids(struct acpi_device *device,
370 const struct acpi_device_id *ids);
371 int acpi_create_dir(struct acpi_device *);
372 void acpi_remove_dir(struct acpi_device *);
375 * Bind physical devices with ACPI devices
377 struct acpi_bus_type {
378 struct list_head list;
379 struct bus_type *bus;
380 /* For general devices under the bus */
381 int (*find_device) (struct device *, acpi_handle *);
382 /* For bridges, such as PCI root bridge, IDE controller */
383 int (*find_bridge) (struct device *, acpi_handle *);
385 int register_acpi_bus_type(struct acpi_bus_type *);
386 int unregister_acpi_bus_type(struct acpi_bus_type *);
387 struct device *acpi_get_physical_device(acpi_handle);
389 struct acpi_pci_root {
390 struct list_head node;
391 struct acpi_device * device;
392 struct acpi_pci_id id;
395 struct resource secondary; /* downstream bus range */
397 u32 osc_support_set; /* _OSC state of support bits */
398 u32 osc_control_set; /* _OSC state of control bits */
399 phys_addr_t mcfg_addr;
403 acpi_handle acpi_get_child(acpi_handle, u64);
404 int acpi_is_root_bridge(acpi_handle);
405 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
406 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
407 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
409 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
410 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
413 int acpi_pm_device_sleep_state(struct device *, int *, int);
415 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
419 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
423 #ifdef CONFIG_PM_SLEEP
424 int acpi_pm_device_run_wake(struct device *, bool);
425 int acpi_pm_device_sleep_wake(struct device *, bool);
427 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
431 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
437 #else /* CONFIG_ACPI */
439 static inline int register_acpi_bus_type(void *bus) { return 0; }
440 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
442 #endif /* CONFIG_ACPI */
444 #endif /*__ACPI_BUS_H__*/