ACPI / PM: Move device power management functions to device_pm.c
[linux-3.10.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 acpi_status
58 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
59 #ifdef CONFIG_ACPI
60
61 #include <linux/proc_fs.h>
62
63 #define ACPI_BUS_FILE_ROOT      "acpi"
64 extern struct proc_dir_entry *acpi_root_dir;
65
66 enum acpi_bus_removal_type {
67         ACPI_BUS_REMOVAL_NORMAL = 0,
68         ACPI_BUS_REMOVAL_EJECT,
69         ACPI_BUS_REMOVAL_SUPRISE,
70         ACPI_BUS_REMOVAL_TYPE_COUNT
71 };
72
73 enum acpi_bus_device_type {
74         ACPI_BUS_TYPE_DEVICE = 0,
75         ACPI_BUS_TYPE_POWER,
76         ACPI_BUS_TYPE_PROCESSOR,
77         ACPI_BUS_TYPE_THERMAL,
78         ACPI_BUS_TYPE_POWER_BUTTON,
79         ACPI_BUS_TYPE_SLEEP_BUTTON,
80         ACPI_BUS_DEVICE_TYPE_COUNT
81 };
82
83 struct acpi_driver;
84 struct acpi_device;
85
86 /*
87  * ACPI Driver
88  * -----------
89  */
90
91 typedef int (*acpi_op_add) (struct acpi_device * device);
92 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
93 typedef int (*acpi_op_start) (struct acpi_device * device);
94 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
95
96 struct acpi_device_ops {
97         acpi_op_add add;
98         acpi_op_remove remove;
99         acpi_op_start start;
100         acpi_op_notify notify;
101 };
102
103 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
104
105 struct acpi_driver {
106         char name[80];
107         char class[80];
108         const struct acpi_device_id *ids; /* Supported Hardware IDs */
109         unsigned int flags;
110         struct acpi_device_ops ops;
111         struct device_driver drv;
112         struct module *owner;
113 };
114
115 /*
116  * ACPI Device
117  * -----------
118  */
119
120 /* Status (_STA) */
121
122 struct acpi_device_status {
123         u32 present:1;
124         u32 enabled:1;
125         u32 show_in_ui:1;
126         u32 functional:1;
127         u32 battery_present:1;
128         u32 reserved:27;
129 };
130
131 /* Flags */
132
133 struct acpi_device_flags {
134         u32 dynamic_status:1;
135         u32 bus_address:1;
136         u32 removable:1;
137         u32 ejectable:1;
138         u32 suprise_removal_ok:1;
139         u32 power_manageable:1;
140         u32 performance_manageable:1;
141         u32 eject_pending:1;
142         u32 match_driver:1;
143         u32 reserved:23;
144 };
145
146 /* File System */
147
148 struct acpi_device_dir {
149         struct proc_dir_entry *entry;
150 };
151
152 #define acpi_device_dir(d)      ((d)->dir.entry)
153
154 /* Plug and Play */
155
156 typedef char acpi_bus_id[8];
157 typedef unsigned long acpi_bus_address;
158 typedef char acpi_device_name[40];
159 typedef char acpi_device_class[20];
160
161 struct acpi_hardware_id {
162         struct list_head list;
163         char *id;
164 };
165
166 struct acpi_device_pnp {
167         acpi_bus_id bus_id;     /* Object name */
168         acpi_bus_address bus_address;   /* _ADR */
169         char *unique_id;        /* _UID */
170         struct list_head ids;           /* _HID and _CIDs */
171         acpi_device_name device_name;   /* Driver-determined */
172         acpi_device_class device_class; /*        "          */
173         union acpi_object *str_obj;     /* unicode string for _STR method */
174         unsigned long sun;              /* _SUN */
175 };
176
177 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
178 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
179 const char *acpi_device_hid(struct acpi_device *device);
180 #define acpi_device_name(d)     ((d)->pnp.device_name)
181 #define acpi_device_class(d)    ((d)->pnp.device_class)
182
183 /* Power Management */
184
185 struct acpi_device_power_flags {
186         u32 explicit_get:1;     /* _PSC present? */
187         u32 power_resources:1;  /* Power resources */
188         u32 inrush_current:1;   /* Serialize Dx->D0 */
189         u32 power_removed:1;    /* Optimize Dx->D0 */
190         u32 reserved:28;
191 };
192
193 struct acpi_device_power_state {
194         struct {
195                 u8 valid:1;
196                 u8 os_accessible:1;
197                 u8 explicit_set:1;      /* _PSx present? */
198                 u8 reserved:6;
199         } flags;
200         int power;              /* % Power (compared to D0) */
201         int latency;            /* Dx->D0 time (microseconds) */
202         struct list_head resources;     /* Power resources referenced */
203 };
204
205 struct acpi_device_power {
206         int state;              /* Current state */
207         struct acpi_device_power_flags flags;
208         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
209 };
210
211 /* Performance Management */
212
213 struct acpi_device_perf_flags {
214         u8 reserved:8;
215 };
216
217 struct acpi_device_perf_state {
218         struct {
219                 u8 valid:1;
220                 u8 reserved:7;
221         } flags;
222         u8 power;               /* % Power (compared to P0) */
223         u8 performance;         /* % Performance (    "   ) */
224         int latency;            /* Px->P0 time (microseconds) */
225 };
226
227 struct acpi_device_perf {
228         int state;
229         struct acpi_device_perf_flags flags;
230         int state_count;
231         struct acpi_device_perf_state *states;
232 };
233
234 /* Wakeup Management */
235 struct acpi_device_wakeup_flags {
236         u8 valid:1;             /* Can successfully enable wakeup? */
237         u8 run_wake:1;          /* Run-Wake GPE devices */
238         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
239 };
240
241 struct acpi_device_wakeup {
242         acpi_handle gpe_device;
243         u64 gpe_number;
244         u64 sleep_state;
245         struct list_head resources;
246         struct acpi_device_wakeup_flags flags;
247         int prepare_count;
248 };
249
250 struct acpi_device_physical_node {
251         u8 node_id;
252         struct list_head node;
253         struct device *dev;
254 };
255
256 /* set maximum of physical nodes to 32 for expansibility */
257 #define ACPI_MAX_PHYSICAL_NODE  32
258
259 /* Device */
260 struct acpi_device {
261         int device_type;
262         acpi_handle handle;             /* no handle for fixed hardware */
263         struct acpi_device *parent;
264         struct list_head children;
265         struct list_head node;
266         struct list_head wakeup_list;
267         struct acpi_device_status status;
268         struct acpi_device_flags flags;
269         struct acpi_device_pnp pnp;
270         struct acpi_device_power power;
271         struct acpi_device_wakeup wakeup;
272         struct acpi_device_perf performance;
273         struct acpi_device_dir dir;
274         struct acpi_driver *driver;
275         void *driver_data;
276         struct device dev;
277         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
278         u8 physical_node_count;
279         struct list_head physical_node_list;
280         struct mutex physical_node_lock;
281         DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
282         struct list_head power_dependent;
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 struct acpi_eject_event {
310         struct acpi_device      *device;
311         u32             event;
312 };
313
314 extern struct kobject *acpi_kobj;
315 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
316 void acpi_bus_private_data_handler(acpi_handle, void *);
317 int acpi_bus_get_private_data(acpi_handle, void **);
318 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
319 extern int register_acpi_notifier(struct notifier_block *);
320 extern int unregister_acpi_notifier(struct notifier_block *);
321
322 extern int register_acpi_bus_notifier(struct notifier_block *nb);
323 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
324 /*
325  * External Functions
326  */
327
328 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
329 void acpi_bus_data_handler(acpi_handle handle, void *context);
330 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
331                                        unsigned long long *sta);
332 int acpi_bus_get_status(struct acpi_device *device);
333
334 #ifdef CONFIG_PM
335 int acpi_bus_set_power(acpi_handle handle, int state);
336 const char *acpi_power_state_string(int state);
337 int acpi_device_get_power(struct acpi_device *device, int *state);
338 int acpi_device_set_power(struct acpi_device *device, int state);
339 int acpi_bus_init_power(struct acpi_device *device);
340 int acpi_bus_update_power(acpi_handle handle, int *state_p);
341 bool acpi_bus_power_manageable(acpi_handle handle);
342 bool acpi_bus_can_wakeup(acpi_handle handle);
343 #else /* !CONFIG_PM */
344 static inline int acpi_bus_set_power(acpi_handle handle, int state)
345 {
346         return 0;
347 }
348 static inline const char *acpi_power_state_string(int state)
349 {
350         return "D0";
351 }
352 static inline int acpi_device_get_power(struct acpi_device *device, int *state)
353 {
354         return 0;
355 }
356 static inline int acpi_device_set_power(struct acpi_device *device, int state)
357 {
358         return 0;
359 }
360 static inline int acpi_bus_init_power(struct acpi_device *device)
361 {
362         return 0;
363 }
364 static inline int acpi_bus_update_power(acpi_handle handle, int *state_p)
365 {
366         return 0;
367 }
368 static inline bool acpi_bus_power_manageable(acpi_handle handle)
369 {
370         return false;
371 }
372 static inline bool acpi_bus_can_wakeup(acpi_handle handle)
373 {
374         return false;
375 }
376 #endif /* !CONFIG_PM */
377
378 #ifdef CONFIG_ACPI_PROC_EVENT
379 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
380 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
381 int acpi_bus_receive_event(struct acpi_bus_event *event);
382 #else
383 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
384         { return 0; }
385 #endif
386 int acpi_bus_register_driver(struct acpi_driver *driver);
387 void acpi_bus_unregister_driver(struct acpi_driver *driver);
388 int acpi_bus_add(acpi_handle handle);
389 void acpi_bus_hot_remove_device(void *context);
390 int acpi_bus_trim(struct acpi_device *start);
391 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
392 int acpi_match_device_ids(struct acpi_device *device,
393                           const struct acpi_device_id *ids);
394 int acpi_create_dir(struct acpi_device *);
395 void acpi_remove_dir(struct acpi_device *);
396
397
398 /**
399  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
400  * @__acpi_driver: acpi_driver struct
401  *
402  * Helper macro for ACPI drivers which do not do anything special in module
403  * init/exit. This eliminates a lot of boilerplate. Each module may only
404  * use this macro once, and calling it replaces module_init() and module_exit()
405  */
406 #define module_acpi_driver(__acpi_driver) \
407         module_driver(__acpi_driver, acpi_bus_register_driver, \
408                       acpi_bus_unregister_driver)
409
410 /*
411  * Bind physical devices with ACPI devices
412  */
413 struct acpi_bus_type {
414         struct list_head list;
415         struct bus_type *bus;
416         /* For general devices under the bus */
417         int (*find_device) (struct device *, acpi_handle *);
418         /* For bridges, such as PCI root bridge, IDE controller */
419         int (*find_bridge) (struct device *, acpi_handle *);
420         void (*setup)(struct device *);
421         void (*cleanup)(struct device *);
422 };
423 int register_acpi_bus_type(struct acpi_bus_type *);
424 int unregister_acpi_bus_type(struct acpi_bus_type *);
425
426 struct acpi_pci_root {
427         struct list_head node;
428         struct acpi_device * device;
429         struct pci_bus *bus;
430         u16 segment;
431         struct resource secondary;      /* downstream bus range */
432
433         u32 osc_support_set;    /* _OSC state of support bits */
434         u32 osc_control_set;    /* _OSC state of control bits */
435         phys_addr_t mcfg_addr;
436 };
437
438 /* helper */
439 acpi_handle acpi_get_child(acpi_handle, u64);
440 int acpi_is_root_bridge(acpi_handle);
441 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
442 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
443 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))
444
445 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
446 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
447
448 #ifdef CONFIG_PM
449 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
450                                  acpi_notify_handler handler, void *context);
451 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
452                                     acpi_notify_handler handler);
453 int acpi_device_power_state(struct device *dev, struct acpi_device *adev,
454                             u32 target_state, int d_max_in, int *d_min_p);
455 int acpi_pm_device_sleep_state(struct device *, int *, int);
456 void acpi_dev_pm_add_dependent(acpi_handle handle, struct device *depdev);
457 void acpi_dev_pm_remove_dependent(acpi_handle handle, struct device *depdev);
458 #else
459 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
460                                                acpi_notify_handler handler,
461                                                void *context)
462 {
463         return AE_SUPPORT;
464 }
465 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
466                                                   acpi_notify_handler handler)
467 {
468         return AE_SUPPORT;
469 }
470 static inline int __acpi_device_power_state(int m, int *p)
471 {
472         if (p)
473                 *p = ACPI_STATE_D0;
474         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
475 }
476 static inline int acpi_device_power_state(struct device *dev,
477                                           struct acpi_device *adev,
478                                           u32 target_state, int d_max_in,
479                                           int *d_min_p)
480 {
481         return __acpi_device_power_state(d_max_in, d_min_p);
482 }
483 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
484 {
485         return __acpi_device_power_state(m, p);
486 }
487 static inline void acpi_dev_pm_add_dependent(acpi_handle handle,
488                                              struct device *depdev) {}
489 static inline void acpi_dev_pm_remove_dependent(acpi_handle handle,
490                                                 struct device *depdev) {}
491 #endif
492
493 #ifdef CONFIG_PM_RUNTIME
494 int __acpi_device_run_wake(struct acpi_device *, bool);
495 int acpi_pm_device_run_wake(struct device *, bool);
496 #else
497 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
498 {
499         return -ENODEV;
500 }
501 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
502 {
503         return -ENODEV;
504 }
505 #endif
506
507 #ifdef CONFIG_PM_SLEEP
508 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
509 int acpi_pm_device_sleep_wake(struct device *, bool);
510 #else
511 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
512                                            u32 target_state, bool enable)
513 {
514         return -ENODEV;
515 }
516 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
517 {
518         return -ENODEV;
519 }
520 #endif
521
522 #ifdef CONFIG_ACPI_SLEEP
523 u32 acpi_target_system_state(void);
524 #else
525 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
526 #endif
527
528 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
529 {
530         return adev->flags.power_manageable;
531 }
532
533 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
534 {
535         return adev->wakeup.flags.valid;
536 }
537
538 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
539 {
540         return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
541 }
542
543 #else   /* CONFIG_ACPI */
544
545 static inline int register_acpi_bus_type(void *bus) { return 0; }
546 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
547
548 #endif                          /* CONFIG_ACPI */
549
550 #endif /*__ACPI_BUS_H__*/