]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - include/acpi/acpi_bus.h
powerpc: Add new cache geometry aux vectors
[karo-tx-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  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
92 #ifdef CONFIG_ACPI
93
94 #include <linux/proc_fs.h>
95
96 #define ACPI_BUS_FILE_ROOT      "acpi"
97 extern struct proc_dir_entry *acpi_root_dir;
98
99 enum acpi_bus_device_type {
100         ACPI_BUS_TYPE_DEVICE = 0,
101         ACPI_BUS_TYPE_POWER,
102         ACPI_BUS_TYPE_PROCESSOR,
103         ACPI_BUS_TYPE_THERMAL,
104         ACPI_BUS_TYPE_POWER_BUTTON,
105         ACPI_BUS_TYPE_SLEEP_BUTTON,
106         ACPI_BUS_DEVICE_TYPE_COUNT
107 };
108
109 struct acpi_driver;
110 struct acpi_device;
111
112 /*
113  * ACPI Scan Handler
114  * -----------------
115  */
116
117 struct acpi_hotplug_profile {
118         struct kobject kobj;
119         int (*scan_dependent)(struct acpi_device *adev);
120         void (*notify_online)(struct acpi_device *adev);
121         bool enabled:1;
122         bool demand_offline:1;
123 };
124
125 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
126                                                 struct kobject *kobj)
127 {
128         return container_of(kobj, struct acpi_hotplug_profile, kobj);
129 }
130
131 struct acpi_scan_handler {
132         const struct acpi_device_id *ids;
133         struct list_head list_node;
134         bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
135         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
136         void (*detach)(struct acpi_device *dev);
137         void (*bind)(struct device *phys_dev);
138         void (*unbind)(struct device *phys_dev);
139         struct acpi_hotplug_profile hotplug;
140 };
141
142 /*
143  * ACPI Hotplug Context
144  * --------------------
145  */
146
147 struct acpi_hotplug_context {
148         struct acpi_device *self;
149         int (*notify)(struct acpi_device *, u32);
150         void (*uevent)(struct acpi_device *, u32);
151         void (*fixup)(struct acpi_device *);
152 };
153
154 /*
155  * ACPI Driver
156  * -----------
157  */
158
159 typedef int (*acpi_op_add) (struct acpi_device * device);
160 typedef int (*acpi_op_remove) (struct acpi_device * device);
161 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
162
163 struct acpi_device_ops {
164         acpi_op_add add;
165         acpi_op_remove remove;
166         acpi_op_notify notify;
167 };
168
169 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
170
171 struct acpi_driver {
172         char name[80];
173         char class[80];
174         const struct acpi_device_id *ids; /* Supported Hardware IDs */
175         unsigned int flags;
176         struct acpi_device_ops ops;
177         struct device_driver drv;
178         struct module *owner;
179 };
180
181 /*
182  * ACPI Device
183  * -----------
184  */
185
186 /* Status (_STA) */
187
188 struct acpi_device_status {
189         u32 present:1;
190         u32 enabled:1;
191         u32 show_in_ui:1;
192         u32 functional:1;
193         u32 battery_present:1;
194         u32 reserved:27;
195 };
196
197 /* Flags */
198
199 struct acpi_device_flags {
200         u32 dynamic_status:1;
201         u32 removable:1;
202         u32 ejectable:1;
203         u32 power_manageable:1;
204         u32 match_driver:1;
205         u32 initialized:1;
206         u32 visited:1;
207         u32 hotplug_notify:1;
208         u32 is_dock_station:1;
209         u32 of_compatible_ok:1;
210         u32 coherent_dma:1;
211         u32 cca_seen:1;
212         u32 reserved:20;
213 };
214
215 /* File System */
216
217 struct acpi_device_dir {
218         struct proc_dir_entry *entry;
219 };
220
221 #define acpi_device_dir(d)      ((d)->dir.entry)
222
223 /* Plug and Play */
224
225 typedef char acpi_bus_id[8];
226 typedef unsigned long acpi_bus_address;
227 typedef char acpi_device_name[40];
228 typedef char acpi_device_class[20];
229
230 struct acpi_hardware_id {
231         struct list_head list;
232         const char *id;
233 };
234
235 struct acpi_pnp_type {
236         u32 hardware_id:1;
237         u32 bus_address:1;
238         u32 platform_id:1;
239         u32 reserved:29;
240 };
241
242 struct acpi_device_pnp {
243         acpi_bus_id bus_id;             /* Object name */
244         struct acpi_pnp_type type;      /* ID type */
245         acpi_bus_address bus_address;   /* _ADR */
246         char *unique_id;                /* _UID */
247         struct list_head ids;           /* _HID and _CIDs */
248         acpi_device_name device_name;   /* Driver-determined */
249         acpi_device_class device_class; /*        "          */
250         union acpi_object *str_obj;     /* unicode string for _STR method */
251 };
252
253 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
254 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
255 const char *acpi_device_hid(struct acpi_device *device);
256 #define acpi_device_uid(d)      ((d)->pnp.unique_id)
257 #define acpi_device_name(d)     ((d)->pnp.device_name)
258 #define acpi_device_class(d)    ((d)->pnp.device_class)
259
260 /* Power Management */
261
262 struct acpi_device_power_flags {
263         u32 explicit_get:1;     /* _PSC present? */
264         u32 power_resources:1;  /* Power resources */
265         u32 inrush_current:1;   /* Serialize Dx->D0 */
266         u32 power_removed:1;    /* Optimize Dx->D0 */
267         u32 ignore_parent:1;    /* Power is independent of parent power state */
268         u32 dsw_present:1;      /* _DSW present? */
269         u32 reserved:26;
270 };
271
272 struct acpi_device_power_state {
273         struct {
274                 u8 valid:1;
275                 u8 explicit_set:1;      /* _PSx present? */
276                 u8 reserved:6;
277         } flags;
278         int power;              /* % Power (compared to D0) */
279         int latency;            /* Dx->D0 time (microseconds) */
280         struct list_head resources;     /* Power resources referenced */
281 };
282
283 struct acpi_device_power {
284         int state;              /* Current state */
285         struct acpi_device_power_flags flags;
286         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
287 };
288
289 /* Performance Management */
290
291 struct acpi_device_perf_flags {
292         u8 reserved:8;
293 };
294
295 struct acpi_device_perf_state {
296         struct {
297                 u8 valid:1;
298                 u8 reserved:7;
299         } flags;
300         u8 power;               /* % Power (compared to P0) */
301         u8 performance;         /* % Performance (    "   ) */
302         int latency;            /* Px->P0 time (microseconds) */
303 };
304
305 struct acpi_device_perf {
306         int state;
307         struct acpi_device_perf_flags flags;
308         int state_count;
309         struct acpi_device_perf_state *states;
310 };
311
312 /* Wakeup Management */
313 struct acpi_device_wakeup_flags {
314         u8 valid:1;             /* Can successfully enable wakeup? */
315         u8 run_wake:1;          /* Run-Wake GPE devices */
316         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
317         u8 enabled:1;           /* Enabled for wakeup */
318 };
319
320 struct acpi_device_wakeup_context {
321         struct work_struct work;
322         struct device *dev;
323 };
324
325 struct acpi_device_wakeup {
326         acpi_handle gpe_device;
327         u64 gpe_number;
328         u64 sleep_state;
329         struct list_head resources;
330         struct acpi_device_wakeup_flags flags;
331         struct acpi_device_wakeup_context context;
332         struct wakeup_source *ws;
333         int prepare_count;
334 };
335
336 struct acpi_device_physical_node {
337         unsigned int node_id;
338         struct list_head node;
339         struct device *dev;
340         bool put_online:1;
341 };
342
343 /* ACPI Device Specific Data (_DSD) */
344 struct acpi_device_data {
345         const union acpi_object *pointer;
346         const union acpi_object *properties;
347         const union acpi_object *of_compatible;
348         struct list_head subnodes;
349 };
350
351 struct acpi_gpio_mapping;
352
353 /* Device */
354 struct acpi_device {
355         int device_type;
356         acpi_handle handle;             /* no handle for fixed hardware */
357         struct fwnode_handle fwnode;
358         struct acpi_device *parent;
359         struct list_head children;
360         struct list_head node;
361         struct list_head wakeup_list;
362         struct list_head del_list;
363         struct acpi_device_status status;
364         struct acpi_device_flags flags;
365         struct acpi_device_pnp pnp;
366         struct acpi_device_power power;
367         struct acpi_device_wakeup wakeup;
368         struct acpi_device_perf performance;
369         struct acpi_device_dir dir;
370         struct acpi_device_data data;
371         struct acpi_scan_handler *handler;
372         struct acpi_hotplug_context *hp;
373         struct acpi_driver *driver;
374         const struct acpi_gpio_mapping *driver_gpios;
375         void *driver_data;
376         struct device dev;
377         unsigned int physical_node_count;
378         unsigned int dep_unmet;
379         struct list_head physical_node_list;
380         struct mutex physical_node_lock;
381         void (*remove)(struct acpi_device *);
382 };
383
384 /* Non-device subnode */
385 struct acpi_data_node {
386         const char *name;
387         acpi_handle handle;
388         struct fwnode_handle fwnode;
389         struct acpi_device_data data;
390         struct list_head sibling;
391         struct kobject kobj;
392         struct completion kobj_done;
393 };
394
395 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
396 {
397         return !IS_ERR_OR_NULL(fwnode) && (fwnode->type == FWNODE_ACPI
398                 || fwnode->type == FWNODE_ACPI_DATA);
399 }
400
401 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
402 {
403         return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_ACPI;
404 }
405
406 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
407 {
408         return is_acpi_device_node(fwnode) ?
409                 container_of(fwnode, struct acpi_device, fwnode) : NULL;
410 }
411
412 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
413 {
414         return fwnode && fwnode->type == FWNODE_ACPI_DATA;
415 }
416
417 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
418 {
419         return is_acpi_data_node(fwnode) ?
420                 container_of(fwnode, struct acpi_data_node, fwnode) : NULL;
421 }
422
423 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
424                                         const char *name)
425 {
426         return is_acpi_data_node(fwnode) ?
427                 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
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 bool acpi_dma_supported(struct acpi_device *adev);
575 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
576 void acpi_dma_configure(struct device *dev, enum dev_dma_attr attr);
577 void acpi_dma_deconfigure(struct device *dev);
578
579 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
580                                            u64 address, bool check_children);
581 int acpi_is_root_bridge(acpi_handle);
582 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
583
584 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
585 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
586
587 #ifdef CONFIG_PM
588 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
589                                  void (*work_func)(struct work_struct *work));
590 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
591 int acpi_pm_device_sleep_state(struct device *, int *, int);
592 int acpi_pm_device_run_wake(struct device *, bool);
593 #else
594 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
595                                                struct device *dev,
596                                                void (*work_func)(struct work_struct *work))
597 {
598         return AE_SUPPORT;
599 }
600 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
601 {
602         return AE_SUPPORT;
603 }
604 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
605 {
606         if (p)
607                 *p = ACPI_STATE_D0;
608
609         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
610                 m : ACPI_STATE_D0;
611 }
612 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
613 {
614         return -ENODEV;
615 }
616 #endif
617
618 #ifdef CONFIG_PM_SLEEP
619 int acpi_pm_device_sleep_wake(struct device *, bool);
620 #else
621 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
622 {
623         return -ENODEV;
624 }
625 #endif
626
627 #ifdef CONFIG_ACPI_SLEEP
628 u32 acpi_target_system_state(void);
629 #else
630 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
631 #endif
632
633 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
634 {
635         return adev->flags.power_manageable;
636 }
637
638 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
639 {
640         return adev->wakeup.flags.valid;
641 }
642
643 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
644 {
645         return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
646                 ((acpi_gbl_FADT.header.revision < 6) &&
647                 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
648 }
649
650 #else   /* CONFIG_ACPI */
651
652 static inline int register_acpi_bus_type(void *bus) { return 0; }
653 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
654
655 #endif                          /* CONFIG_ACPI */
656
657 #endif /*__ACPI_BUS_H__*/