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 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
61 #include <linux/proc_fs.h>
63 #define ACPI_BUS_FILE_ROOT "acpi"
64 extern struct proc_dir_entry *acpi_root_dir;
66 enum acpi_bus_removal_type {
67 ACPI_BUS_REMOVAL_NORMAL = 0,
68 ACPI_BUS_REMOVAL_EJECT,
69 ACPI_BUS_REMOVAL_SUPRISE,
70 ACPI_BUS_REMOVAL_TYPE_COUNT
73 enum acpi_bus_device_type {
74 ACPI_BUS_TYPE_DEVICE = 0,
76 ACPI_BUS_TYPE_PROCESSOR,
77 ACPI_BUS_TYPE_THERMAL,
78 ACPI_BUS_TYPE_POWER_BUTTON,
79 ACPI_BUS_TYPE_SLEEP_BUTTON,
80 ACPI_BUS_DEVICE_TYPE_COUNT
91 typedef int (*acpi_op_add) (struct acpi_device * device);
92 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
93 typedef int (*acpi_op_start) (struct acpi_device * device);
94 typedef int (*acpi_op_bind) (struct acpi_device * device);
95 typedef int (*acpi_op_unbind) (struct acpi_device * device);
96 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
103 struct acpi_device_ops {
105 acpi_op_remove remove;
108 acpi_op_unbind unbind;
109 acpi_op_notify notify;
112 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
117 const struct acpi_device_id *ids; /* Supported Hardware IDs */
119 struct acpi_device_ops ops;
120 struct device_driver drv;
121 struct module *owner;
131 struct acpi_device_status {
136 u32 battery_present:1;
142 struct acpi_device_flags {
143 u32 dynamic_status:1;
148 u32 suprise_removal_ok:1;
149 u32 power_manageable:1;
150 u32 performance_manageable:1;
157 struct acpi_device_dir {
158 struct proc_dir_entry *entry;
161 #define acpi_device_dir(d) ((d)->dir.entry)
165 typedef char acpi_bus_id[8];
166 typedef unsigned long acpi_bus_address;
167 typedef char acpi_device_name[40];
168 typedef char acpi_device_class[20];
170 struct acpi_hardware_id {
171 struct list_head list;
175 struct acpi_device_pnp {
176 acpi_bus_id bus_id; /* Object name */
177 acpi_bus_address bus_address; /* _ADR */
178 char *unique_id; /* _UID */
179 struct list_head ids; /* _HID and _CIDs */
180 acpi_device_name device_name; /* Driver-determined */
181 acpi_device_class device_class; /* " */
184 #define acpi_device_bid(d) ((d)->pnp.bus_id)
185 #define acpi_device_adr(d) ((d)->pnp.bus_address)
186 const char *acpi_device_hid(struct acpi_device *device);
187 #define acpi_device_name(d) ((d)->pnp.device_name)
188 #define acpi_device_class(d) ((d)->pnp.device_class)
190 /* Power Management */
192 struct acpi_device_power_flags {
193 u32 explicit_get:1; /* _PSC present? */
194 u32 power_resources:1; /* Power resources */
195 u32 inrush_current:1; /* Serialize Dx->D0 */
196 u32 power_removed:1; /* Optimize Dx->D0 */
200 struct acpi_device_power_state {
203 u8 explicit_set:1; /* _PSx present? */
206 int power; /* % Power (compared to D0) */
207 int latency; /* Dx->D0 time (microseconds) */
208 struct acpi_handle_list resources; /* Power resources referenced */
211 struct acpi_device_power {
212 int state; /* Current state */
213 struct acpi_device_power_flags flags;
214 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */
217 /* Performance Management */
219 struct acpi_device_perf_flags {
223 struct acpi_device_perf_state {
228 u8 power; /* % Power (compared to P0) */
229 u8 performance; /* % Performance ( " ) */
230 int latency; /* Px->P0 time (microseconds) */
233 struct acpi_device_perf {
235 struct acpi_device_perf_flags flags;
237 struct acpi_device_perf_state *states;
240 /* Wakeup Management */
241 struct acpi_device_wakeup_flags {
242 u8 valid:1; /* Can successfully enable wakeup? */
243 u8 run_wake:1; /* Run-Wake GPE devices */
244 u8 notifier_present:1; /* Wake-up notify handler has been installed */
247 struct acpi_device_wakeup {
248 acpi_handle gpe_device;
251 struct acpi_handle_list resources;
252 struct acpi_device_wakeup_flags flags;
260 acpi_handle handle; /* no handle for fixed hardware */
261 struct acpi_device *parent;
262 struct list_head children;
263 struct list_head node;
264 struct list_head wakeup_list;
265 struct acpi_device_status status;
266 struct acpi_device_flags flags;
267 struct acpi_device_pnp pnp;
268 struct acpi_device_power power;
269 struct acpi_device_wakeup wakeup;
270 struct acpi_device_perf performance;
271 struct acpi_device_dir dir;
272 struct acpi_device_ops ops;
273 struct acpi_driver *driver;
276 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
277 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
280 static inline void *acpi_driver_data(struct acpi_device *d)
282 return d->driver_data;
285 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
286 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
288 /* acpi_device.dev.bus == &acpi_bus_type */
289 extern struct bus_type acpi_bus_type;
296 struct acpi_bus_event {
297 struct list_head node;
298 acpi_device_class device_class;
304 struct acpi_eject_event {
309 extern struct kobject *acpi_kobj;
310 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
311 void acpi_bus_private_data_handler(acpi_handle, void *);
312 int acpi_bus_get_private_data(acpi_handle, void **);
313 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
314 extern int register_acpi_notifier(struct notifier_block *);
315 extern int unregister_acpi_notifier(struct notifier_block *);
317 extern int register_acpi_bus_notifier(struct notifier_block *nb);
318 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
323 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
324 void acpi_bus_data_handler(acpi_handle handle, void *context);
325 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
326 unsigned long long *sta);
327 int acpi_bus_get_status(struct acpi_device *device);
328 int acpi_bus_set_power(acpi_handle handle, int state);
329 int acpi_bus_update_power(acpi_handle handle, int *state_p);
330 bool acpi_bus_power_manageable(acpi_handle handle);
331 bool acpi_bus_can_wakeup(acpi_handle handle);
332 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
333 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
334 #ifdef CONFIG_ACPI_PROC_EVENT
335 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
336 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
337 int acpi_bus_receive_event(struct acpi_bus_event *event);
339 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
342 int acpi_bus_register_driver(struct acpi_driver *driver);
343 void acpi_bus_unregister_driver(struct acpi_driver *driver);
344 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
345 acpi_handle handle, int type);
346 void acpi_bus_hot_remove_device(void *context);
347 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
348 int acpi_bus_start(struct acpi_device *device);
349 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
350 int acpi_match_device_ids(struct acpi_device *device,
351 const struct acpi_device_id *ids);
352 int acpi_create_dir(struct acpi_device *);
353 void acpi_remove_dir(struct acpi_device *);
356 * Bind physical devices with ACPI devices
358 struct acpi_bus_type {
359 struct list_head list;
360 struct bus_type *bus;
361 /* For general devices under the bus */
362 int (*find_device) (struct device *, acpi_handle *);
363 /* For bridges, such as PCI root bridge, IDE controller */
364 int (*find_bridge) (struct device *, acpi_handle *);
366 int register_acpi_bus_type(struct acpi_bus_type *);
367 int unregister_acpi_bus_type(struct acpi_bus_type *);
368 struct device *acpi_get_physical_device(acpi_handle);
370 struct acpi_pci_root {
371 struct list_head node;
372 struct acpi_device * device;
373 struct acpi_pci_id id;
376 struct resource secondary; /* downstream bus range */
378 u32 osc_support_set; /* _OSC state of support bits */
379 u32 osc_control_set; /* _OSC state of control bits */
380 phys_addr_t mcfg_addr;
384 acpi_handle acpi_get_child(acpi_handle, u64);
385 int acpi_is_root_bridge(acpi_handle);
386 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
387 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
388 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
390 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
391 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
394 int acpi_pm_device_sleep_state(struct device *, int *, int);
396 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
400 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
404 #ifdef CONFIG_PM_SLEEP
405 int acpi_pm_device_run_wake(struct device *, bool);
406 int acpi_pm_device_sleep_wake(struct device *, bool);
408 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
412 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
418 #else /* CONFIG_ACPI */
420 static inline int register_acpi_bus_type(void *bus) { return 0; }
421 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
423 #endif /* CONFIG_ACPI */
425 #endif /*__ACPI_BUS_H__*/