Merge branch 'release' of git://git.kernel.org/pub/scm/linux/kernel/git/lenb/linux
[linux-drm-fsl-dcu.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 acpi_status
54 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
55                         u32 status_code, struct acpi_buffer *status_buf);
56
57 struct acpi_pld {
58         unsigned int revision:7; /* 0 */
59         unsigned int ignore_colour:1; /* 7 */
60         unsigned int colour:24; /* 8 */
61         unsigned int width:16; /* 32 */
62         unsigned int height:16; /* 48 */
63         unsigned int user_visible:1; /* 64 */
64         unsigned int dock:1; /* 65 */
65         unsigned int lid:1; /* 66 */
66         unsigned int panel:3; /* 67 */
67         unsigned int vertical_pos:2; /* 70 */
68         unsigned int horizontal_pos:2; /* 72 */
69         unsigned int shape:4; /* 74 */
70         unsigned int group_orientation:1; /* 78 */
71         unsigned int group_token:8; /* 79 */
72         unsigned int group_position:8; /* 87 */
73         unsigned int bay:1; /* 95 */
74         unsigned int ejectable:1; /* 96 */
75         unsigned int ospm_eject_required:1; /* 97 */
76         unsigned int cabinet_number:8; /* 98 */
77         unsigned int card_cage_number:8; /* 106 */
78         unsigned int reference:1; /* 114 */
79         unsigned int rotation:4; /* 115 */
80         unsigned int order:5; /* 119 */
81         unsigned int reserved:4; /* 124 */
82         unsigned int vertical_offset:16; /* 128 */
83         unsigned int horizontal_offset:16; /* 144 */
84 } __attribute__((__packed__));
85
86 acpi_status
87 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld *pld);
88 #ifdef CONFIG_ACPI
89
90 #include <linux/proc_fs.h>
91
92 #define ACPI_BUS_FILE_ROOT      "acpi"
93 extern struct proc_dir_entry *acpi_root_dir;
94
95 enum acpi_bus_removal_type {
96         ACPI_BUS_REMOVAL_NORMAL = 0,
97         ACPI_BUS_REMOVAL_EJECT,
98         ACPI_BUS_REMOVAL_SUPRISE,
99         ACPI_BUS_REMOVAL_TYPE_COUNT
100 };
101
102 enum acpi_bus_device_type {
103         ACPI_BUS_TYPE_DEVICE = 0,
104         ACPI_BUS_TYPE_POWER,
105         ACPI_BUS_TYPE_PROCESSOR,
106         ACPI_BUS_TYPE_THERMAL,
107         ACPI_BUS_TYPE_POWER_BUTTON,
108         ACPI_BUS_TYPE_SLEEP_BUTTON,
109         ACPI_BUS_DEVICE_TYPE_COUNT
110 };
111
112 struct acpi_driver;
113 struct acpi_device;
114
115 /*
116  * ACPI Driver
117  * -----------
118  */
119
120 typedef int (*acpi_op_add) (struct acpi_device * device);
121 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
122 typedef int (*acpi_op_start) (struct acpi_device * device);
123 typedef int (*acpi_op_bind) (struct acpi_device * device);
124 typedef int (*acpi_op_unbind) (struct acpi_device * device);
125 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
126
127 struct acpi_bus_ops {
128         u32 acpi_op_add:1;
129         u32 acpi_op_start:1;
130 };
131
132 struct acpi_device_ops {
133         acpi_op_add add;
134         acpi_op_remove remove;
135         acpi_op_start start;
136         acpi_op_bind bind;
137         acpi_op_unbind unbind;
138         acpi_op_notify notify;
139 };
140
141 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
142
143 struct acpi_driver {
144         char name[80];
145         char class[80];
146         const struct acpi_device_id *ids; /* Supported Hardware IDs */
147         unsigned int flags;
148         struct acpi_device_ops ops;
149         struct device_driver drv;
150         struct module *owner;
151 };
152
153 /*
154  * ACPI Device
155  * -----------
156  */
157
158 /* Status (_STA) */
159
160 struct acpi_device_status {
161         u32 present:1;
162         u32 enabled:1;
163         u32 show_in_ui:1;
164         u32 functional:1;
165         u32 battery_present:1;
166         u32 reserved:27;
167 };
168
169 /* Flags */
170
171 struct acpi_device_flags {
172         u32 dynamic_status:1;
173         u32 bus_address:1;
174         u32 removable:1;
175         u32 ejectable:1;
176         u32 lockable:1;
177         u32 suprise_removal_ok:1;
178         u32 power_manageable:1;
179         u32 performance_manageable:1;
180         u32 eject_pending:1;
181         u32 reserved:23;
182 };
183
184 /* File System */
185
186 struct acpi_device_dir {
187         struct proc_dir_entry *entry;
188 };
189
190 #define acpi_device_dir(d)      ((d)->dir.entry)
191
192 /* Plug and Play */
193
194 typedef char acpi_bus_id[8];
195 typedef unsigned long acpi_bus_address;
196 typedef char acpi_device_name[40];
197 typedef char acpi_device_class[20];
198
199 struct acpi_hardware_id {
200         struct list_head list;
201         char *id;
202 };
203
204 struct acpi_device_pnp {
205         acpi_bus_id bus_id;     /* Object name */
206         acpi_bus_address bus_address;   /* _ADR */
207         char *unique_id;        /* _UID */
208         struct list_head ids;           /* _HID and _CIDs */
209         acpi_device_name device_name;   /* Driver-determined */
210         acpi_device_class device_class; /*        "          */
211 };
212
213 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
214 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
215 const char *acpi_device_hid(struct acpi_device *device);
216 #define acpi_device_name(d)     ((d)->pnp.device_name)
217 #define acpi_device_class(d)    ((d)->pnp.device_class)
218
219 /* Power Management */
220
221 struct acpi_device_power_flags {
222         u32 explicit_get:1;     /* _PSC present? */
223         u32 power_resources:1;  /* Power resources */
224         u32 inrush_current:1;   /* Serialize Dx->D0 */
225         u32 power_removed:1;    /* Optimize Dx->D0 */
226         u32 reserved:28;
227 };
228
229 struct acpi_device_power_state {
230         struct {
231                 u8 valid:1;
232                 u8 explicit_set:1;      /* _PSx present? */
233                 u8 reserved:6;
234         } flags;
235         int power;              /* % Power (compared to D0) */
236         int latency;            /* Dx->D0 time (microseconds) */
237         struct acpi_handle_list resources;      /* Power resources referenced */
238 };
239
240 struct acpi_device_power {
241         int state;              /* Current state */
242         struct acpi_device_power_flags flags;
243         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
244 };
245
246 /* Performance Management */
247
248 struct acpi_device_perf_flags {
249         u8 reserved:8;
250 };
251
252 struct acpi_device_perf_state {
253         struct {
254                 u8 valid:1;
255                 u8 reserved:7;
256         } flags;
257         u8 power;               /* % Power (compared to P0) */
258         u8 performance;         /* % Performance (    "   ) */
259         int latency;            /* Px->P0 time (microseconds) */
260 };
261
262 struct acpi_device_perf {
263         int state;
264         struct acpi_device_perf_flags flags;
265         int state_count;
266         struct acpi_device_perf_state *states;
267 };
268
269 /* Wakeup Management */
270 struct acpi_device_wakeup_flags {
271         u8 valid:1;             /* Can successfully enable wakeup? */
272         u8 run_wake:1;          /* Run-Wake GPE devices */
273         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
274 };
275
276 struct acpi_device_wakeup {
277         acpi_handle gpe_device;
278         u64 gpe_number;
279         u64 sleep_state;
280         struct acpi_handle_list resources;
281         struct acpi_device_wakeup_flags flags;
282         int prepare_count;
283 };
284
285 /* Device */
286
287 struct acpi_device {
288         int device_type;
289         acpi_handle handle;             /* no handle for fixed hardware */
290         struct acpi_device *parent;
291         struct list_head children;
292         struct list_head node;
293         struct list_head wakeup_list;
294         struct acpi_device_status status;
295         struct acpi_device_flags flags;
296         struct acpi_device_pnp pnp;
297         struct acpi_device_power power;
298         struct acpi_device_wakeup wakeup;
299         struct acpi_device_perf performance;
300         struct acpi_device_dir dir;
301         struct acpi_device_ops ops;
302         struct acpi_driver *driver;
303         void *driver_data;
304         struct device dev;
305         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
306         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
307 };
308
309 static inline void *acpi_driver_data(struct acpi_device *d)
310 {
311         return d->driver_data;
312 }
313
314 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
315 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
316
317 /* acpi_device.dev.bus == &acpi_bus_type */
318 extern struct bus_type acpi_bus_type;
319
320 /*
321  * Events
322  * ------
323  */
324
325 struct acpi_bus_event {
326         struct list_head node;
327         acpi_device_class device_class;
328         acpi_bus_id bus_id;
329         u32 type;
330         u32 data;
331 };
332
333 struct acpi_eject_event {
334         acpi_handle     handle;
335         u32             event;
336 };
337
338 extern struct kobject *acpi_kobj;
339 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
340 void acpi_bus_private_data_handler(acpi_handle, void *);
341 int acpi_bus_get_private_data(acpi_handle, void **);
342 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
343 extern int register_acpi_notifier(struct notifier_block *);
344 extern int unregister_acpi_notifier(struct notifier_block *);
345
346 extern int register_acpi_bus_notifier(struct notifier_block *nb);
347 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
348 /*
349  * External Functions
350  */
351
352 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
353 void acpi_bus_data_handler(acpi_handle handle, void *context);
354 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
355                                        unsigned long long *sta);
356 int acpi_bus_get_status(struct acpi_device *device);
357 int acpi_bus_set_power(acpi_handle handle, int state);
358 int acpi_bus_update_power(acpi_handle handle, int *state_p);
359 bool acpi_bus_power_manageable(acpi_handle handle);
360 bool acpi_bus_can_wakeup(acpi_handle handle);
361 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
362 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
363 #ifdef CONFIG_ACPI_PROC_EVENT
364 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
365 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
366 int acpi_bus_receive_event(struct acpi_bus_event *event);
367 #else
368 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
369         { return 0; }
370 #endif
371 int acpi_bus_register_driver(struct acpi_driver *driver);
372 void acpi_bus_unregister_driver(struct acpi_driver *driver);
373 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
374                  acpi_handle handle, int type);
375 void acpi_bus_hot_remove_device(void *context);
376 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
377 int acpi_bus_start(struct acpi_device *device);
378 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
379 int acpi_match_device_ids(struct acpi_device *device,
380                           const struct acpi_device_id *ids);
381 int acpi_create_dir(struct acpi_device *);
382 void acpi_remove_dir(struct acpi_device *);
383
384 /*
385  * Bind physical devices with ACPI devices
386  */
387 struct acpi_bus_type {
388         struct list_head list;
389         struct bus_type *bus;
390         /* For general devices under the bus */
391         int (*find_device) (struct device *, acpi_handle *);
392         /* For bridges, such as PCI root bridge, IDE controller */
393         int (*find_bridge) (struct device *, acpi_handle *);
394 };
395 int register_acpi_bus_type(struct acpi_bus_type *);
396 int unregister_acpi_bus_type(struct acpi_bus_type *);
397 struct device *acpi_get_physical_device(acpi_handle);
398
399 struct acpi_pci_root {
400         struct list_head node;
401         struct acpi_device * device;
402         struct acpi_pci_id id;
403         struct pci_bus *bus;
404         u16 segment;
405         struct resource secondary;      /* downstream bus range */
406
407         u32 osc_support_set;    /* _OSC state of support bits */
408         u32 osc_control_set;    /* _OSC state of control bits */
409         phys_addr_t mcfg_addr;
410 };
411
412 /* helper */
413 acpi_handle acpi_get_child(acpi_handle, u64);
414 int acpi_is_root_bridge(acpi_handle);
415 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
416 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
417 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
418
419 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
420 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
421
422 #ifdef CONFIG_PM
423 int acpi_pm_device_sleep_state(struct device *, int *, int);
424 #else
425 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
426 {
427         if (p)
428                 *p = ACPI_STATE_D0;
429         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
430 }
431 #endif
432
433 #ifdef CONFIG_PM_SLEEP
434 int acpi_pm_device_run_wake(struct device *, bool);
435 int acpi_pm_device_sleep_wake(struct device *, bool);
436 #else
437 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
438 {
439         return -ENODEV;
440 }
441 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
442 {
443         return -ENODEV;
444 }
445 #endif
446
447 #else   /* CONFIG_ACPI */
448
449 static inline int register_acpi_bus_type(void *bus) { return 0; }
450 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
451
452 #endif                          /* CONFIG_ACPI */
453
454 #endif /*__ACPI_BUS_H__*/