ACPICA: Remove duplicate prototypes from header
[linux-2.6-block.git] / include / acpi / acpi_bus.h
CommitLineData
1da177e4
LT
1/*
2 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
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.
13 *
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.
18 *
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.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#ifndef __ACPI_BUS_H__
27#define __ACPI_BUS_H__
28
5b327265 29#include <linux/device.h>
1da177e4
LT
30
31#include <acpi/acpi.h>
32
33#define PREFIX "ACPI: "
34
35/* TBD: Make dynamic */
36#define ACPI_MAX_HANDLES 10
37struct acpi_handle_list {
4be44fcd
LB
38 u32 count;
39 acpi_handle handles[ACPI_MAX_HANDLES];
1da177e4
LT
40};
41
1da177e4
LT
42/* acpi_utils.h */
43acpi_status
4be44fcd
LB
44acpi_extract_package(union acpi_object *package,
45 struct acpi_buffer *format, struct acpi_buffer *buffer);
1da177e4 46acpi_status
4be44fcd
LB
47acpi_evaluate_integer(acpi_handle handle,
48 acpi_string pathname,
27663c58 49 struct acpi_object_list *arguments, unsigned long long *data);
1da177e4 50acpi_status
4be44fcd
LB
51acpi_evaluate_reference(acpi_handle handle,
52 acpi_string pathname,
53 struct acpi_object_list *arguments,
54 struct acpi_handle_list *list);
1da177e4 55
76f58584 56#ifdef CONFIG_ACPI
1da177e4
LT
57
58#include <linux/proc_fs.h>
59
60#define ACPI_BUS_FILE_ROOT "acpi"
4be44fcd 61extern struct proc_dir_entry *acpi_root_dir;
1da177e4
LT
62
63enum acpi_bus_removal_type {
4be44fcd 64 ACPI_BUS_REMOVAL_NORMAL = 0,
1da177e4
LT
65 ACPI_BUS_REMOVAL_EJECT,
66 ACPI_BUS_REMOVAL_SUPRISE,
67 ACPI_BUS_REMOVAL_TYPE_COUNT
68};
69
70enum acpi_bus_device_type {
4be44fcd 71 ACPI_BUS_TYPE_DEVICE = 0,
1da177e4
LT
72 ACPI_BUS_TYPE_POWER,
73 ACPI_BUS_TYPE_PROCESSOR,
74 ACPI_BUS_TYPE_THERMAL,
75 ACPI_BUS_TYPE_SYSTEM,
76 ACPI_BUS_TYPE_POWER_BUTTON,
77 ACPI_BUS_TYPE_SLEEP_BUTTON,
78 ACPI_BUS_DEVICE_TYPE_COUNT
79};
80
81struct acpi_driver;
82struct acpi_device;
83
1da177e4
LT
84/*
85 * ACPI Driver
86 * -----------
87 */
88
4be44fcd
LB
89typedef int (*acpi_op_add) (struct acpi_device * device);
90typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
4be44fcd
LB
91typedef int (*acpi_op_start) (struct acpi_device * device);
92typedef int (*acpi_op_stop) (struct acpi_device * device, int type);
fd350943
LB
93typedef int (*acpi_op_suspend) (struct acpi_device * device,
94 pm_message_t state);
5d9464a4 95typedef int (*acpi_op_resume) (struct acpi_device * device);
4be44fcd
LB
96typedef int (*acpi_op_bind) (struct acpi_device * device);
97typedef int (*acpi_op_unbind) (struct acpi_device * device);
46ec8598 98typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
1da177e4 99
3fb02738 100struct acpi_bus_ops {
4be44fcd 101 u32 acpi_op_add:1;
4be44fcd 102 u32 acpi_op_start:1;
3fb02738
RS
103};
104
1da177e4 105struct acpi_device_ops {
4be44fcd
LB
106 acpi_op_add add;
107 acpi_op_remove remove;
4be44fcd
LB
108 acpi_op_start start;
109 acpi_op_stop stop;
110 acpi_op_suspend suspend;
111 acpi_op_resume resume;
4be44fcd
LB
112 acpi_op_bind bind;
113 acpi_op_unbind unbind;
46ec8598 114 acpi_op_notify notify;
1da177e4
LT
115};
116
6d278131
BH
117#define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */
118
1da177e4 119struct acpi_driver {
4be44fcd
LB
120 char name[80];
121 char class[80];
8c8eb78f 122 const struct acpi_device_id *ids; /* Supported Hardware IDs */
6d278131 123 unsigned int flags;
4be44fcd 124 struct acpi_device_ops ops;
d43ec68e 125 struct device_driver drv;
1890a97a 126 struct module *owner;
1da177e4
LT
127};
128
129/*
130 * ACPI Device
131 * -----------
132 */
133
134/* Status (_STA) */
135
136struct acpi_device_status {
4be44fcd
LB
137 u32 present:1;
138 u32 enabled:1;
139 u32 show_in_ui:1;
140 u32 functional:1;
141 u32 battery_present:1;
142 u32 reserved:27;
1da177e4
LT
143};
144
1da177e4
LT
145/* Flags */
146
147struct acpi_device_flags {
4be44fcd
LB
148 u32 dynamic_status:1;
149 u32 hardware_id:1;
150 u32 compatible_ids:1;
151 u32 bus_address:1;
152 u32 unique_id:1;
153 u32 removable:1;
154 u32 ejectable:1;
155 u32 lockable:1;
156 u32 suprise_removal_ok:1;
157 u32 power_manageable:1;
158 u32 performance_manageable:1;
159 u32 wake_capable:1; /* Wakeup(_PRW) supported? */
ec68373c
LB
160 u32 force_power_state:1;
161 u32 reserved:19;
1da177e4
LT
162};
163
1da177e4
LT
164/* File System */
165
166struct acpi_device_dir {
4be44fcd 167 struct proc_dir_entry *entry;
1da177e4
LT
168};
169
170#define acpi_device_dir(d) ((d)->dir.entry)
171
1da177e4
LT
172/* Plug and Play */
173
24c5c4c2 174typedef char acpi_bus_id[8];
4be44fcd 175typedef unsigned long acpi_bus_address;
bb095854 176typedef char acpi_hardware_id[15];
4be44fcd
LB
177typedef char acpi_unique_id[9];
178typedef char acpi_device_name[40];
179typedef char acpi_device_class[20];
1da177e4
LT
180
181struct acpi_device_pnp {
4be44fcd
LB
182 acpi_bus_id bus_id; /* Object name */
183 acpi_bus_address bus_address; /* _ADR */
184 acpi_hardware_id hardware_id; /* _HID */
185 struct acpi_compatible_id_list *cid_list; /* _CIDs */
186 acpi_unique_id unique_id; /* _UID */
187 acpi_device_name device_name; /* Driver-determined */
188 acpi_device_class device_class; /* " */
1da177e4
LT
189};
190
191#define acpi_device_bid(d) ((d)->pnp.bus_id)
192#define acpi_device_adr(d) ((d)->pnp.bus_address)
193#define acpi_device_hid(d) ((d)->pnp.hardware_id)
194#define acpi_device_uid(d) ((d)->pnp.unique_id)
195#define acpi_device_name(d) ((d)->pnp.device_name)
196#define acpi_device_class(d) ((d)->pnp.device_class)
197
1da177e4
LT
198/* Power Management */
199
200struct acpi_device_power_flags {
4be44fcd
LB
201 u32 explicit_get:1; /* _PSC present? */
202 u32 power_resources:1; /* Power resources */
203 u32 inrush_current:1; /* Serialize Dx->D0 */
204 u32 power_removed:1; /* Optimize Dx->D0 */
205 u32 reserved:28;
1da177e4
LT
206};
207
208struct acpi_device_power_state {
209 struct {
4be44fcd
LB
210 u8 valid:1;
211 u8 explicit_set:1; /* _PSx present? */
212 u8 reserved:6;
213 } flags;
214 int power; /* % Power (compared to D0) */
215 int latency; /* Dx->D0 time (microseconds) */
216 struct acpi_handle_list resources; /* Power resources referenced */
1da177e4
LT
217};
218
219struct acpi_device_power {
4be44fcd 220 int state; /* Current state */
1da177e4 221 struct acpi_device_power_flags flags;
4be44fcd 222 struct acpi_device_power_state states[4]; /* Power states (D0-D3) */
1da177e4
LT
223};
224
1da177e4
LT
225/* Performance Management */
226
227struct acpi_device_perf_flags {
4be44fcd 228 u8 reserved:8;
1da177e4
LT
229};
230
231struct acpi_device_perf_state {
232 struct {
4be44fcd
LB
233 u8 valid:1;
234 u8 reserved:7;
235 } flags;
236 u8 power; /* % Power (compared to P0) */
237 u8 performance; /* % Performance ( " ) */
238 int latency; /* Px->P0 time (microseconds) */
1da177e4
LT
239};
240
241struct acpi_device_perf {
4be44fcd 242 int state;
1da177e4 243 struct acpi_device_perf_flags flags;
4be44fcd 244 int state_count;
1da177e4
LT
245 struct acpi_device_perf_state *states;
246};
247
248/* Wakeup Management */
249struct acpi_device_wakeup_flags {
4be44fcd 250 u8 valid:1; /* Can successfully enable wakeup? */
0af4b8c4 251 u8 prepared:1; /* Has the wake-up capability been enabled? */
4be44fcd 252 u8 run_wake:1; /* Run-Wake GPE devices */
1da177e4
LT
253};
254
255struct acpi_device_wakeup_state {
4be44fcd 256 u8 enabled:1;
1da177e4
LT
257};
258
259struct acpi_device_wakeup {
4be44fcd 260 acpi_handle gpe_device;
53b3531b 261 acpi_integer gpe_number;
4be44fcd
LB
262 acpi_integer sleep_state;
263 struct acpi_handle_list resources;
264 struct acpi_device_wakeup_state state;
265 struct acpi_device_wakeup_flags flags;
1da177e4
LT
266};
267
268/* Device */
269
270struct acpi_device {
4be44fcd
LB
271 acpi_handle handle;
272 struct acpi_device *parent;
273 struct list_head children;
274 struct list_head node;
275 struct list_head wakeup_list;
1da177e4
LT
276 struct acpi_device_status status;
277 struct acpi_device_flags flags;
4be44fcd 278 struct acpi_device_pnp pnp;
1da177e4
LT
279 struct acpi_device_power power;
280 struct acpi_device_wakeup wakeup;
4be44fcd
LB
281 struct acpi_device_perf performance;
282 struct acpi_device_dir dir;
283 struct acpi_device_ops ops;
284 struct acpi_driver *driver;
285 void *driver_data;
5b327265 286 struct device dev;
c4168bff 287 struct acpi_bus_ops bus_ops; /* workaround for different code path for hotplug */
fd350943 288 enum acpi_bus_removal_type removal_type; /* indicate for different removal type */
1da177e4
LT
289};
290
db89b4f0
PM
291static inline void *acpi_driver_data(struct acpi_device *d)
292{
293 return d->driver_data;
294}
295
d43ec68e
PM
296#define to_acpi_device(d) container_of(d, struct acpi_device, dev)
297#define to_acpi_driver(d) container_of(d, struct acpi_driver, drv)
1da177e4 298
55955aad
DB
299/* acpi_device.dev.bus == &acpi_bus_type */
300extern struct bus_type acpi_bus_type;
301
1da177e4
LT
302/*
303 * Events
304 * ------
305 */
306
307struct acpi_bus_event {
4be44fcd
LB
308 struct list_head node;
309 acpi_device_class device_class;
310 acpi_bus_id bus_id;
311 u32 type;
312 u32 data;
1da177e4
LT
313};
314
99e0d2fc 315extern struct kobject *acpi_kobj;
962ce8ca 316extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
20733939
ZR
317void acpi_bus_private_data_handler(acpi_handle, u32, void *);
318int acpi_bus_get_private_data(acpi_handle, void **);
9ee85241
ZR
319extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
320extern int register_acpi_notifier(struct notifier_block *);
321extern int unregister_acpi_notifier(struct notifier_block *);
6bd00a61
SL
322
323extern int register_acpi_bus_notifier(struct notifier_block *nb);
324extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
1da177e4
LT
325/*
326 * External Functions
327 */
328
329int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
330void acpi_bus_data_handler(acpi_handle handle, u32 function, void *context);
4be44fcd
LB
331int acpi_bus_get_status(struct acpi_device *device);
332int acpi_bus_get_power(acpi_handle handle, int *state);
333int acpi_bus_set_power(acpi_handle handle, int state);
3737b2b1 334bool acpi_bus_power_manageable(acpi_handle handle);
eb9d0fe4 335bool acpi_bus_can_wakeup(acpi_handle handle);
14e04fb3
LB
336#ifdef CONFIG_ACPI_PROC_EVENT
337int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
8db85d4c 338int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
4be44fcd 339int acpi_bus_receive_event(struct acpi_bus_event *event);
14e04fb3
LB
340#else
341static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
342 { return 0; }
343#endif
4be44fcd 344int acpi_bus_register_driver(struct acpi_driver *driver);
06ea8e08 345void acpi_bus_unregister_driver(struct acpi_driver *driver);
4be44fcd
LB
346int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
347 acpi_handle handle, int type);
ceaba663 348int acpi_bus_trim(struct acpi_device *start, int rmdevice);
4be44fcd 349int acpi_bus_start(struct acpi_device *device);
fd350943 350acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
8c8eb78f
TR
351int acpi_match_device_ids(struct acpi_device *device,
352 const struct acpi_device_id *ids);
1da177e4
LT
353int acpi_create_dir(struct acpi_device *);
354void acpi_remove_dir(struct acpi_device *);
355
4e10d12a
DSL
356/*
357 * Bind physical devices with ACPI devices
358 */
359#include <linux/device.h>
360struct acpi_bus_type {
4be44fcd
LB
361 struct list_head list;
362 struct bus_type *bus;
363 /* For general devices under the bus */
364 int (*find_device) (struct device *, acpi_handle *);
4e10d12a 365 /* For bridges, such as PCI root bridge, IDE controller */
4be44fcd 366 int (*find_bridge) (struct device *, acpi_handle *);
4e10d12a
DSL
367};
368int register_acpi_bus_type(struct acpi_bus_type *);
369int unregister_acpi_bus_type(struct acpi_bus_type *);
370struct device *acpi_get_physical_device(acpi_handle);
22c13f9d 371
4e10d12a
DSL
372/* helper */
373acpi_handle acpi_get_child(acpi_handle, acpi_integer);
27558203 374int acpi_is_root_bridge(acpi_handle);
4e10d12a 375acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
465ae641 376#define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
4e10d12a 377
296699de 378#ifdef CONFIG_PM_SLEEP
06166780 379int acpi_pm_device_sleep_state(struct device *, int *);
eb9d0fe4 380int acpi_pm_device_sleep_wake(struct device *, bool);
296699de 381#else /* !CONFIG_PM_SLEEP */
06166780 382static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
296699de
RW
383{
384 if (p)
385 *p = ACPI_STATE_D0;
386 return ACPI_STATE_D3;
387}
f7a1b860
DH
388static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
389{
390 return -ENODEV;
391}
296699de 392#endif /* !CONFIG_PM_SLEEP */
fd4aff1a 393
fd350943 394#endif /* CONFIG_ACPI */
1da177e4
LT
395
396#endif /*__ACPI_BUS_H__*/