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 #define PREFIX "ACPI: "
35 /* TBD: Make dynamic */
36 #define ACPI_MAX_HANDLES 10
37 struct acpi_handle_list {
39 acpi_handle handles[ACPI_MAX_HANDLES];
44 acpi_extract_package(union acpi_object *package,
45 struct acpi_buffer *format, struct acpi_buffer *buffer);
47 acpi_evaluate_integer(acpi_handle handle,
49 struct acpi_object_list *arguments, unsigned long long *data);
51 acpi_evaluate_reference(acpi_handle handle,
53 struct acpi_object_list *arguments,
54 struct acpi_handle_list *list);
58 #include <linux/proc_fs.h>
60 #define ACPI_BUS_FILE_ROOT "acpi"
61 extern struct proc_dir_entry *acpi_root_dir;
63 enum acpi_bus_removal_type {
64 ACPI_BUS_REMOVAL_NORMAL = 0,
65 ACPI_BUS_REMOVAL_EJECT,
66 ACPI_BUS_REMOVAL_SUPRISE,
67 ACPI_BUS_REMOVAL_TYPE_COUNT
70 enum acpi_bus_device_type {
71 ACPI_BUS_TYPE_DEVICE = 0,
73 ACPI_BUS_TYPE_PROCESSOR,
74 ACPI_BUS_TYPE_THERMAL,
76 ACPI_BUS_TYPE_POWER_BUTTON,
77 ACPI_BUS_TYPE_SLEEP_BUTTON,
78 ACPI_BUS_DEVICE_TYPE_COUNT
89 typedef int (*acpi_op_add) (struct acpi_device * device);
90 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
91 typedef int (*acpi_op_start) (struct acpi_device * device);
92 typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
93 typedef int (*acpi_op_suspend) (struct acpi_device * device,
95 typedef int (*acpi_op_resume) (struct acpi_device * device);
96 typedef int (*acpi_op_bind) (struct acpi_device * device);
97 typedef int (*acpi_op_unbind) (struct acpi_device * device);
104 struct acpi_device_ops {
106 acpi_op_remove remove;
109 acpi_op_suspend suspend;
110 acpi_op_resume resume;
112 acpi_op_unbind unbind;
118 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;
145 u32 compatible_ids:1;
151 u32 suprise_removal_ok:1;
152 u32 power_manageable:1;
153 u32 performance_manageable:1;
154 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
155 u32 force_power_state:1;
161 struct acpi_device_dir {
162 struct proc_dir_entry *entry;
165 #define acpi_device_dir(d) ((d)->dir.entry)
169 typedef char acpi_bus_id[5];
170 typedef unsigned long acpi_bus_address;
171 typedef char acpi_hardware_id[15];
172 typedef char acpi_unique_id[9];
173 typedef char acpi_device_name[40];
174 typedef char acpi_device_class[20];
176 struct acpi_device_pnp {
177 acpi_bus_id bus_id; /* Object name */
178 acpi_bus_address bus_address; /* _ADR */
179 acpi_hardware_id hardware_id; /* _HID */
180 struct acpi_compatible_id_list *cid_list; /* _CIDs */
181 acpi_unique_id unique_id; /* _UID */
182 acpi_device_name device_name; /* Driver-determined */
183 acpi_device_class device_class; /* " */
186 #define acpi_device_bid(d) ((d)->pnp.bus_id)
187 #define acpi_device_adr(d) ((d)->pnp.bus_address)
188 #define acpi_device_hid(d) ((d)->pnp.hardware_id)
189 #define acpi_device_uid(d) ((d)->pnp.unique_id)
190 #define acpi_device_name(d) ((d)->pnp.device_name)
191 #define acpi_device_class(d) ((d)->pnp.device_class)
193 /* Power Management */
195 struct acpi_device_power_flags {
196 u32 explicit_get:1; /* _PSC present? */
197 u32 power_resources:1; /* Power resources */
198 u32 inrush_current:1; /* Serialize Dx->D0 */
199 u32 power_removed:1; /* Optimize Dx->D0 */
203 struct acpi_device_power_state {
206 u8 explicit_set:1; /* _PSx present? */
209 int power; /* % Power (compared to D0) */
210 int latency; /* Dx->D0 time (microseconds) */
211 struct acpi_handle_list resources; /* Power resources referenced */
214 struct acpi_device_power {
215 int state; /* Current state */
216 struct acpi_device_power_flags flags;
217 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
220 /* Performance Management */
222 struct acpi_device_perf_flags {
226 struct acpi_device_perf_state {
231 u8 power; /* % Power (compared to P0) */
232 u8 performance; /* % Performance ( " ) */
233 int latency; /* Px->P0 time (microseconds) */
236 struct acpi_device_perf {
238 struct acpi_device_perf_flags flags;
240 struct acpi_device_perf_state *states;
243 /* Wakeup Management */
244 struct acpi_device_wakeup_flags {
245 u8 valid:1; /* Can successfully enable wakeup? */
246 u8 prepared:1; /* Has the wake-up capability been enabled? */
247 u8 run_wake:1; /* Run-Wake GPE devices */
250 struct acpi_device_wakeup_state {
254 struct acpi_device_wakeup {
255 acpi_handle gpe_device;
256 acpi_integer gpe_number;
257 acpi_integer sleep_state;
258 struct acpi_handle_list resources;
259 struct acpi_device_wakeup_state state;
260 struct acpi_device_wakeup_flags flags;
267 struct acpi_device *parent;
268 struct list_head children;
269 struct list_head node;
270 struct list_head wakeup_list;
271 struct list_head g_list;
272 struct acpi_device_status status;
273 struct acpi_device_flags flags;
274 struct acpi_device_pnp pnp;
275 struct acpi_device_power power;
276 struct acpi_device_wakeup wakeup;
277 struct acpi_device_perf performance;
278 struct acpi_device_dir dir;
279 struct acpi_device_ops ops;
280 struct acpi_driver *driver;
283 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
284 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
287 static inline void *acpi_driver_data(struct acpi_device *d)
289 return d->driver_data;
292 #define to_acpi_device(d) container_of(d, struct acpi_device, dev)
293 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
295 /* acpi_device.dev.bus == &acpi_bus_type */
296 extern struct bus_type acpi_bus_type;
303 struct acpi_bus_event {
304 struct list_head node;
305 acpi_device_class device_class;
311 extern struct kobject *acpi_kobj;
312 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
313 void acpi_bus_private_data_handler(acpi_handle, u32, void *);
314 int acpi_bus_get_private_data(acpi_handle, void **);
315 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
316 extern int register_acpi_notifier(struct notifier_block *);
317 extern int unregister_acpi_notifier(struct notifier_block *);
319 extern int register_acpi_bus_notifier(struct notifier_block *nb);
320 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
325 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
326 void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
327 int acpi_bus_get_status(struct acpi_device *device);
328 int acpi_bus_get_power(acpi_handle handle, int *state);
329 int acpi_bus_set_power(acpi_handle handle, int state);
330 bool acpi_bus_power_manageable(acpi_handle handle);
331 bool acpi_bus_can_wakeup(acpi_handle handle);
332 #ifdef CONFIG_ACPI_PROC_EVENT
333 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
334 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
335 int acpi_bus_receive_event(struct acpi_bus_event *event);
337 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
340 int acpi_bus_register_driver(struct acpi_driver *driver);
341 void acpi_bus_unregister_driver(struct acpi_driver *driver);
342 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
343 acpi_handle handle, int type);
344 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
345 int acpi_bus_start(struct acpi_device *device);
346 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
347 int acpi_match_device_ids(struct acpi_device *device,
348 const struct acpi_device_id *ids);
349 int acpi_create_dir(struct acpi_device *);
350 void acpi_remove_dir(struct acpi_device *);
353 * Bind physical devices with ACPI devices
355 #include <linux/device.h>
356 struct acpi_bus_type {
357 struct list_head list;
358 struct bus_type *bus;
359 /* For general devices under the bus */
360 int (*find_device) (struct device *, acpi_handle *);
361 /* For bridges, such as PCI root bridge, IDE controller */
362 int (*find_bridge) (struct device *, acpi_handle *);
364 int register_acpi_bus_type(struct acpi_bus_type *);
365 int unregister_acpi_bus_type(struct acpi_bus_type *);
366 struct device *acpi_get_physical_device(acpi_handle);
367 struct device *acpi_get_physical_pci_device(acpi_handle);
370 acpi_handle acpi_get_child(acpi_handle, acpi_integer);
371 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
372 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
374 #ifdef CONFIG_PM_SLEEP
375 int acpi_pm_device_sleep_state(struct device *, int *);
376 int acpi_pm_device_sleep_wake(struct device *, bool);
377 #else /* !CONFIG_PM_SLEEP */
378 static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
382 return ACPI_STATE_D3;
384 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
388 #endif /* !CONFIG_PM_SLEEP */
390 #endif /* CONFIG_ACPI */
392 #endif /*__ACPI_BUS_H__*/