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