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