Merge branch 'i2c/for-4.12' of git://git.kernel.org/pub/scm/linux/kernel/git/wsa...
[sfrench/cifs-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  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20  */
21
22 #ifndef __ACPI_BUS_H__
23 #define __ACPI_BUS_H__
24
25 #include <linux/device.h>
26 #include <linux/property.h>
27
28 /* TBD: Make dynamic */
29 #define ACPI_MAX_HANDLES        10
30 struct acpi_handle_list {
31         u32 count;
32         acpi_handle handles[ACPI_MAX_HANDLES];
33 };
34
35 /* acpi_utils.h */
36 acpi_status
37 acpi_extract_package(union acpi_object *package,
38                      struct acpi_buffer *format, struct acpi_buffer *buffer);
39 acpi_status
40 acpi_evaluate_integer(acpi_handle handle,
41                       acpi_string pathname,
42                       struct acpi_object_list *arguments, unsigned long long *data);
43 acpi_status
44 acpi_evaluate_reference(acpi_handle handle,
45                         acpi_string pathname,
46                         struct acpi_object_list *arguments,
47                         struct acpi_handle_list *list);
48 acpi_status
49 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
50                   struct acpi_buffer *status_buf);
51
52 acpi_status
53 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
54
55 bool acpi_has_method(acpi_handle handle, char *name);
56 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
57                                        u64 arg);
58 acpi_status acpi_evaluate_ej0(acpi_handle handle);
59 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
60 bool acpi_ata_match(acpi_handle handle);
61 bool acpi_bay_match(acpi_handle handle);
62 bool acpi_dock_match(acpi_handle handle);
63
64 bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, u64 rev, u64 funcs);
65 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid,
66                         u64 rev, u64 func, union acpi_object *argv4);
67
68 static inline union acpi_object *
69 acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, u64 rev, u64 func,
70                         union acpi_object *argv4, acpi_object_type type)
71 {
72         union acpi_object *obj;
73
74         obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4);
75         if (obj && obj->type != type) {
76                 ACPI_FREE(obj);
77                 obj = NULL;
78         }
79
80         return obj;
81 }
82
83 #define ACPI_INIT_DSM_ARGV4(cnt, eles)                  \
84         {                                               \
85           .package.type = ACPI_TYPE_PACKAGE,            \
86           .package.count = (cnt),                       \
87           .package.elements = (eles)                    \
88         }
89
90 bool acpi_dev_found(const char *hid);
91 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
92
93 #ifdef CONFIG_ACPI
94
95 #include <linux/proc_fs.h>
96
97 #define ACPI_BUS_FILE_ROOT      "acpi"
98 extern struct proc_dir_entry *acpi_root_dir;
99
100 enum acpi_bus_device_type {
101         ACPI_BUS_TYPE_DEVICE = 0,
102         ACPI_BUS_TYPE_POWER,
103         ACPI_BUS_TYPE_PROCESSOR,
104         ACPI_BUS_TYPE_THERMAL,
105         ACPI_BUS_TYPE_POWER_BUTTON,
106         ACPI_BUS_TYPE_SLEEP_BUTTON,
107         ACPI_BUS_DEVICE_TYPE_COUNT
108 };
109
110 struct acpi_driver;
111 struct acpi_device;
112
113 /*
114  * ACPI Scan Handler
115  * -----------------
116  */
117
118 struct acpi_hotplug_profile {
119         struct kobject kobj;
120         int (*scan_dependent)(struct acpi_device *adev);
121         void (*notify_online)(struct acpi_device *adev);
122         bool enabled:1;
123         bool demand_offline:1;
124 };
125
126 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
127                                                 struct kobject *kobj)
128 {
129         return container_of(kobj, struct acpi_hotplug_profile, kobj);
130 }
131
132 struct acpi_scan_handler {
133         const struct acpi_device_id *ids;
134         struct list_head list_node;
135         bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
136         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
137         void (*detach)(struct acpi_device *dev);
138         void (*bind)(struct device *phys_dev);
139         void (*unbind)(struct device *phys_dev);
140         struct acpi_hotplug_profile hotplug;
141 };
142
143 /*
144  * ACPI Hotplug Context
145  * --------------------
146  */
147
148 struct acpi_hotplug_context {
149         struct acpi_device *self;
150         int (*notify)(struct acpi_device *, u32);
151         void (*uevent)(struct acpi_device *, u32);
152         void (*fixup)(struct acpi_device *);
153 };
154
155 /*
156  * ACPI Driver
157  * -----------
158  */
159
160 typedef int (*acpi_op_add) (struct acpi_device * device);
161 typedef int (*acpi_op_remove) (struct acpi_device * device);
162 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
163
164 struct acpi_device_ops {
165         acpi_op_add add;
166         acpi_op_remove remove;
167         acpi_op_notify notify;
168 };
169
170 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
171
172 struct acpi_driver {
173         char name[80];
174         char class[80];
175         const struct acpi_device_id *ids; /* Supported Hardware IDs */
176         unsigned int flags;
177         struct acpi_device_ops ops;
178         struct device_driver drv;
179         struct module *owner;
180 };
181
182 /*
183  * ACPI Device
184  * -----------
185  */
186
187 /* Status (_STA) */
188
189 struct acpi_device_status {
190         u32 present:1;
191         u32 enabled:1;
192         u32 show_in_ui:1;
193         u32 functional:1;
194         u32 battery_present:1;
195         u32 reserved:27;
196 };
197
198 /* Flags */
199
200 struct acpi_device_flags {
201         u32 dynamic_status:1;
202         u32 removable:1;
203         u32 ejectable:1;
204         u32 power_manageable:1;
205         u32 match_driver:1;
206         u32 initialized:1;
207         u32 visited:1;
208         u32 hotplug_notify:1;
209         u32 is_dock_station:1;
210         u32 of_compatible_ok:1;
211         u32 coherent_dma:1;
212         u32 cca_seen:1;
213         u32 reserved:20;
214 };
215
216 /* File System */
217
218 struct acpi_device_dir {
219         struct proc_dir_entry *entry;
220 };
221
222 #define acpi_device_dir(d)      ((d)->dir.entry)
223
224 /* Plug and Play */
225
226 typedef char acpi_bus_id[8];
227 typedef unsigned long acpi_bus_address;
228 typedef char acpi_device_name[40];
229 typedef char acpi_device_class[20];
230
231 struct acpi_hardware_id {
232         struct list_head list;
233         const char *id;
234 };
235
236 struct acpi_pnp_type {
237         u32 hardware_id:1;
238         u32 bus_address:1;
239         u32 platform_id:1;
240         u32 reserved:29;
241 };
242
243 struct acpi_device_pnp {
244         acpi_bus_id bus_id;             /* Object name */
245         struct acpi_pnp_type type;      /* ID type */
246         acpi_bus_address bus_address;   /* _ADR */
247         char *unique_id;                /* _UID */
248         struct list_head ids;           /* _HID and _CIDs */
249         acpi_device_name device_name;   /* Driver-determined */
250         acpi_device_class device_class; /*        "          */
251         union acpi_object *str_obj;     /* unicode string for _STR method */
252 };
253
254 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
255 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
256 const char *acpi_device_hid(struct acpi_device *device);
257 #define acpi_device_uid(d)      ((d)->pnp.unique_id)
258 #define acpi_device_name(d)     ((d)->pnp.device_name)
259 #define acpi_device_class(d)    ((d)->pnp.device_class)
260
261 /* Power Management */
262
263 struct acpi_device_power_flags {
264         u32 explicit_get:1;     /* _PSC present? */
265         u32 power_resources:1;  /* Power resources */
266         u32 inrush_current:1;   /* Serialize Dx->D0 */
267         u32 power_removed:1;    /* Optimize Dx->D0 */
268         u32 ignore_parent:1;    /* Power is independent of parent power state */
269         u32 dsw_present:1;      /* _DSW present? */
270         u32 reserved:26;
271 };
272
273 struct acpi_device_power_state {
274         struct {
275                 u8 valid:1;
276                 u8 explicit_set:1;      /* _PSx present? */
277                 u8 reserved:6;
278         } flags;
279         int power;              /* % Power (compared to D0) */
280         int latency;            /* Dx->D0 time (microseconds) */
281         struct list_head resources;     /* Power resources referenced */
282 };
283
284 struct acpi_device_power {
285         int state;              /* Current state */
286         struct acpi_device_power_flags flags;
287         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
288 };
289
290 /* Performance Management */
291
292 struct acpi_device_perf_flags {
293         u8 reserved:8;
294 };
295
296 struct acpi_device_perf_state {
297         struct {
298                 u8 valid:1;
299                 u8 reserved:7;
300         } flags;
301         u8 power;               /* % Power (compared to P0) */
302         u8 performance;         /* % Performance (    "   ) */
303         int latency;            /* Px->P0 time (microseconds) */
304 };
305
306 struct acpi_device_perf {
307         int state;
308         struct acpi_device_perf_flags flags;
309         int state_count;
310         struct acpi_device_perf_state *states;
311 };
312
313 /* Wakeup Management */
314 struct acpi_device_wakeup_flags {
315         u8 valid:1;             /* Can successfully enable wakeup? */
316         u8 run_wake:1;          /* Run-Wake GPE devices */
317         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
318         u8 enabled:1;           /* Enabled for wakeup */
319 };
320
321 struct acpi_device_wakeup_context {
322         struct work_struct work;
323         struct device *dev;
324 };
325
326 struct acpi_device_wakeup {
327         acpi_handle gpe_device;
328         u64 gpe_number;
329         u64 sleep_state;
330         struct list_head resources;
331         struct acpi_device_wakeup_flags flags;
332         struct acpi_device_wakeup_context context;
333         struct wakeup_source *ws;
334         int prepare_count;
335 };
336
337 struct acpi_device_physical_node {
338         unsigned int node_id;
339         struct list_head node;
340         struct device *dev;
341         bool put_online:1;
342 };
343
344 /* ACPI Device Specific Data (_DSD) */
345 struct acpi_device_data {
346         const union acpi_object *pointer;
347         const union acpi_object *properties;
348         const union acpi_object *of_compatible;
349         struct list_head subnodes;
350 };
351
352 struct acpi_gpio_mapping;
353
354 /* Device */
355 struct acpi_device {
356         int device_type;
357         acpi_handle handle;             /* no handle for fixed hardware */
358         struct fwnode_handle fwnode;
359         struct acpi_device *parent;
360         struct list_head children;
361         struct list_head node;
362         struct list_head wakeup_list;
363         struct list_head del_list;
364         struct acpi_device_status status;
365         struct acpi_device_flags flags;
366         struct acpi_device_pnp pnp;
367         struct acpi_device_power power;
368         struct acpi_device_wakeup wakeup;
369         struct acpi_device_perf performance;
370         struct acpi_device_dir dir;
371         struct acpi_device_data data;
372         struct acpi_scan_handler *handler;
373         struct acpi_hotplug_context *hp;
374         struct acpi_driver *driver;
375         const struct acpi_gpio_mapping *driver_gpios;
376         void *driver_data;
377         struct device dev;
378         unsigned int physical_node_count;
379         unsigned int dep_unmet;
380         struct list_head physical_node_list;
381         struct mutex physical_node_lock;
382         void (*remove)(struct acpi_device *);
383 };
384
385 /* Non-device subnode */
386 struct acpi_data_node {
387         const char *name;
388         acpi_handle handle;
389         struct fwnode_handle fwnode;
390         struct fwnode_handle *parent;
391         struct acpi_device_data data;
392         struct list_head sibling;
393         struct kobject kobj;
394         struct completion kobj_done;
395 };
396
397 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
398 {
399         return !IS_ERR_OR_NULL(fwnode) && (fwnode->type == FWNODE_ACPI
400                 || fwnode->type == FWNODE_ACPI_DATA);
401 }
402
403 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
404 {
405         return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_ACPI;
406 }
407
408 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
409 {
410         return is_acpi_device_node(fwnode) ?
411                 container_of(fwnode, struct acpi_device, fwnode) : NULL;
412 }
413
414 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
415 {
416         return fwnode && fwnode->type == FWNODE_ACPI_DATA;
417 }
418
419 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
420 {
421         return is_acpi_data_node(fwnode) ?
422                 container_of(fwnode, struct acpi_data_node, fwnode) : NULL;
423 }
424
425 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
426                                         const char *name)
427 {
428         return is_acpi_data_node(fwnode) ?
429                 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
430 }
431
432 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
433 {
434         return &adev->fwnode;
435 }
436
437 static inline void *acpi_driver_data(struct acpi_device *d)
438 {
439         return d->driver_data;
440 }
441
442 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
443 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
444
445 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
446 {
447         *((u32 *)&adev->status) = sta;
448 }
449
450 static inline void acpi_set_hp_context(struct acpi_device *adev,
451                                        struct acpi_hotplug_context *hp)
452 {
453         hp->self = adev;
454         adev->hp = hp;
455 }
456
457 void acpi_initialize_hp_context(struct acpi_device *adev,
458                                 struct acpi_hotplug_context *hp,
459                                 int (*notify)(struct acpi_device *, u32),
460                                 void (*uevent)(struct acpi_device *, u32));
461
462 /* acpi_device.dev.bus == &acpi_bus_type */
463 extern struct bus_type acpi_bus_type;
464
465 /*
466  * Events
467  * ------
468  */
469
470 struct acpi_bus_event {
471         struct list_head node;
472         acpi_device_class device_class;
473         acpi_bus_id bus_id;
474         u32 type;
475         u32 data;
476 };
477
478 extern struct kobject *acpi_kobj;
479 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
480 void acpi_bus_private_data_handler(acpi_handle, void *);
481 int acpi_bus_get_private_data(acpi_handle, void **);
482 int acpi_bus_attach_private_data(acpi_handle, void *);
483 void acpi_bus_detach_private_data(acpi_handle);
484 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
485 extern int register_acpi_notifier(struct notifier_block *);
486 extern int unregister_acpi_notifier(struct notifier_block *);
487
488 /*
489  * External Functions
490  */
491
492 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
493 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
494 void acpi_bus_put_acpi_device(struct acpi_device *adev);
495 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
496                                        unsigned long long *sta);
497 int acpi_bus_get_status(struct acpi_device *device);
498
499 int acpi_bus_set_power(acpi_handle handle, int state);
500 const char *acpi_power_state_string(int state);
501 int acpi_device_get_power(struct acpi_device *device, int *state);
502 int acpi_device_set_power(struct acpi_device *device, int state);
503 int acpi_bus_init_power(struct acpi_device *device);
504 int acpi_device_fix_up_power(struct acpi_device *device);
505 int acpi_bus_update_power(acpi_handle handle, int *state_p);
506 int acpi_device_update_power(struct acpi_device *device, int *state_p);
507 bool acpi_bus_power_manageable(acpi_handle handle);
508
509 #ifdef CONFIG_PM
510 bool acpi_bus_can_wakeup(acpi_handle handle);
511 #else
512 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
513 #endif
514
515 void acpi_scan_lock_acquire(void);
516 void acpi_scan_lock_release(void);
517 void acpi_lock_hp_context(void);
518 void acpi_unlock_hp_context(void);
519 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
520 int acpi_bus_register_driver(struct acpi_driver *driver);
521 void acpi_bus_unregister_driver(struct acpi_driver *driver);
522 int acpi_bus_scan(acpi_handle handle);
523 void acpi_bus_trim(struct acpi_device *start);
524 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
525 int acpi_match_device_ids(struct acpi_device *device,
526                           const struct acpi_device_id *ids);
527 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
528                        char *modalias, size_t len);
529 int acpi_create_dir(struct acpi_device *);
530 void acpi_remove_dir(struct acpi_device *);
531
532 static inline bool acpi_device_enumerated(struct acpi_device *adev)
533 {
534         return adev && adev->flags.initialized && adev->flags.visited;
535 }
536
537 /**
538  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
539  * @__acpi_driver: acpi_driver struct
540  *
541  * Helper macro for ACPI drivers which do not do anything special in module
542  * init/exit. This eliminates a lot of boilerplate. Each module may only
543  * use this macro once, and calling it replaces module_init() and module_exit()
544  */
545 #define module_acpi_driver(__acpi_driver) \
546         module_driver(__acpi_driver, acpi_bus_register_driver, \
547                       acpi_bus_unregister_driver)
548
549 /*
550  * Bind physical devices with ACPI devices
551  */
552 struct acpi_bus_type {
553         struct list_head list;
554         const char *name;
555         bool (*match)(struct device *dev);
556         struct acpi_device * (*find_companion)(struct device *);
557         void (*setup)(struct device *);
558         void (*cleanup)(struct device *);
559 };
560 int register_acpi_bus_type(struct acpi_bus_type *);
561 int unregister_acpi_bus_type(struct acpi_bus_type *);
562 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
563 int acpi_unbind_one(struct device *dev);
564
565 struct acpi_pci_root {
566         struct acpi_device * device;
567         struct pci_bus *bus;
568         u16 segment;
569         struct resource secondary;      /* downstream bus range */
570
571         u32 osc_support_set;    /* _OSC state of support bits */
572         u32 osc_control_set;    /* _OSC state of control bits */
573         phys_addr_t mcfg_addr;
574 };
575
576 /* helper */
577
578 bool acpi_dma_supported(struct acpi_device *adev);
579 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
580 void acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
581 void acpi_dma_deconfigure(struct device *dev);
582
583 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
584                                            u64 address, bool check_children);
585 int acpi_is_root_bridge(acpi_handle);
586 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
587
588 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
589 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
590
591 #ifdef CONFIG_PM
592 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
593                                  void (*work_func)(struct work_struct *work));
594 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
595 int acpi_pm_device_sleep_state(struct device *, int *, int);
596 int acpi_pm_device_run_wake(struct device *, bool);
597 #else
598 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
599                                                struct device *dev,
600                                                void (*work_func)(struct work_struct *work))
601 {
602         return AE_SUPPORT;
603 }
604 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
605 {
606         return AE_SUPPORT;
607 }
608 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
609 {
610         if (p)
611                 *p = ACPI_STATE_D0;
612
613         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
614                 m : ACPI_STATE_D0;
615 }
616 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
617 {
618         return -ENODEV;
619 }
620 #endif
621
622 #ifdef CONFIG_PM_SLEEP
623 int acpi_pm_device_sleep_wake(struct device *, bool);
624 #else
625 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
626 {
627         return -ENODEV;
628 }
629 #endif
630
631 #ifdef CONFIG_ACPI_SLEEP
632 u32 acpi_target_system_state(void);
633 #else
634 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
635 #endif
636
637 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
638 {
639         return adev->flags.power_manageable;
640 }
641
642 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
643 {
644         return adev->wakeup.flags.valid;
645 }
646
647 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
648 {
649         return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
650                 ((acpi_gbl_FADT.header.revision < 6) &&
651                 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
652 }
653
654 #else   /* CONFIG_ACPI */
655
656 static inline int register_acpi_bus_type(void *bus) { return 0; }
657 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
658
659 #endif                          /* CONFIG_ACPI */
660
661 #endif /*__ACPI_BUS_H__*/