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