f097c0a2718e564732c62a6d43bb601f94ae21e8
[linux-2.6-block.git] / include / linux / acpi.h
1 /*
2  * acpi.h - ACPI Interface
3  *
4  * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
5  *
6  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  */
24
25 #ifndef _LINUX_ACPI_H
26 #define _LINUX_ACPI_H
27
28 #include <linux/errno.h>
29 #include <linux/ioport.h>       /* for struct resource */
30 #include <linux/resource_ext.h>
31 #include <linux/device.h>
32 #include <linux/property.h>
33
34 #ifndef _LINUX
35 #define _LINUX
36 #endif
37 #include <acpi/acpi.h>
38
39 #ifdef  CONFIG_ACPI
40
41 #include <linux/list.h>
42 #include <linux/mod_devicetable.h>
43 #include <linux/dynamic_debug.h>
44
45 #include <acpi/acpi_bus.h>
46 #include <acpi/acpi_drivers.h>
47 #include <acpi/acpi_numa.h>
48 #include <acpi/acpi_io.h>
49 #include <asm/acpi.h>
50
51 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
52 {
53         return adev ? adev->handle : NULL;
54 }
55
56 #define ACPI_COMPANION(dev)             acpi_node((dev)->fwnode)
57 #define ACPI_COMPANION_SET(dev, adev)   set_primary_fwnode(dev, (adev) ? \
58         acpi_fwnode_handle(adev) : NULL)
59 #define ACPI_HANDLE(dev)                acpi_device_handle(ACPI_COMPANION(dev))
60
61 static inline bool has_acpi_companion(struct device *dev)
62 {
63         return is_acpi_node(dev->fwnode);
64 }
65
66 static inline void acpi_preset_companion(struct device *dev,
67                                          struct acpi_device *parent, u64 addr)
68 {
69         ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
70 }
71
72 static inline const char *acpi_dev_name(struct acpi_device *adev)
73 {
74         return dev_name(&adev->dev);
75 }
76
77 enum acpi_irq_model_id {
78         ACPI_IRQ_MODEL_PIC = 0,
79         ACPI_IRQ_MODEL_IOAPIC,
80         ACPI_IRQ_MODEL_IOSAPIC,
81         ACPI_IRQ_MODEL_PLATFORM,
82         ACPI_IRQ_MODEL_GIC,
83         ACPI_IRQ_MODEL_COUNT
84 };
85
86 extern enum acpi_irq_model_id   acpi_irq_model;
87
88 enum acpi_interrupt_id {
89         ACPI_INTERRUPT_PMI      = 1,
90         ACPI_INTERRUPT_INIT,
91         ACPI_INTERRUPT_CPEI,
92         ACPI_INTERRUPT_COUNT
93 };
94
95 #define ACPI_SPACE_MEM          0
96
97 enum acpi_address_range_id {
98         ACPI_ADDRESS_RANGE_MEMORY = 1,
99         ACPI_ADDRESS_RANGE_RESERVED = 2,
100         ACPI_ADDRESS_RANGE_ACPI = 3,
101         ACPI_ADDRESS_RANGE_NVS  = 4,
102         ACPI_ADDRESS_RANGE_COUNT
103 };
104
105
106 /* Table Handlers */
107
108 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
109
110 typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
111                                       const unsigned long end);
112
113 #ifdef CONFIG_ACPI_INITRD_TABLE_OVERRIDE
114 void acpi_initrd_override(void *data, size_t size);
115 #else
116 static inline void acpi_initrd_override(void *data, size_t size)
117 {
118 }
119 #endif
120
121 #define BAD_MADT_ENTRY(entry, end) (                                        \
122                 (!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
123                 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
124
125 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
126 void __acpi_unmap_table(char *map, unsigned long size);
127 int early_acpi_boot_init(void);
128 int acpi_boot_init (void);
129 void acpi_boot_table_init (void);
130 int acpi_mps_check (void);
131 int acpi_numa_init (void);
132
133 int acpi_table_init (void);
134 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
135 int __init acpi_parse_entries(char *id, unsigned long table_size,
136                               acpi_tbl_entry_handler handler,
137                               struct acpi_table_header *table_header,
138                               int entry_id, unsigned int max_entries);
139 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
140                                     int entry_id,
141                                     acpi_tbl_entry_handler handler,
142                                     unsigned int max_entries);
143 int acpi_table_parse_madt(enum acpi_madt_type id,
144                           acpi_tbl_entry_handler handler,
145                           unsigned int max_entries);
146 int acpi_parse_mcfg (struct acpi_table_header *header);
147 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
148
149 /* the following four functions are architecture-dependent */
150 void acpi_numa_slit_init (struct acpi_table_slit *slit);
151 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
152 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
153 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
154 void acpi_numa_arch_fixup(void);
155
156 #ifndef PHYS_CPUID_INVALID
157 typedef u32 phys_cpuid_t;
158 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
159 #endif
160
161 #ifdef CONFIG_ACPI_HOTPLUG_CPU
162 /* Arch dependent functions for cpu hotplug support */
163 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, int *pcpu);
164 int acpi_unmap_cpu(int cpu);
165 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
166
167 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
168 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
169 #endif
170
171 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
172 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
173 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
174 void acpi_irq_stats_init(void);
175 extern u32 acpi_irq_handled;
176 extern u32 acpi_irq_not_handled;
177
178 extern int sbf_port;
179 extern unsigned long acpi_realmode_flags;
180
181 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
182 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
183 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
184
185 #ifdef CONFIG_X86_IO_APIC
186 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
187 #else
188 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
189 #endif
190 /*
191  * This function undoes the effect of one call to acpi_register_gsi().
192  * If this matches the last registration, any IRQ resources for gsi
193  * are freed.
194  */
195 void acpi_unregister_gsi (u32 gsi);
196
197 struct pci_dev;
198
199 int acpi_pci_irq_enable (struct pci_dev *dev);
200 void acpi_penalize_isa_irq(int irq, int active);
201
202 void acpi_pci_irq_disable (struct pci_dev *dev);
203
204 extern int ec_read(u8 addr, u8 *val);
205 extern int ec_write(u8 addr, u8 val);
206 extern int ec_transaction(u8 command,
207                           const u8 *wdata, unsigned wdata_len,
208                           u8 *rdata, unsigned rdata_len);
209 extern acpi_handle ec_get_handle(void);
210
211 extern bool acpi_is_pnp_device(struct acpi_device *);
212
213 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
214
215 typedef void (*wmi_notify_handler) (u32 value, void *context);
216
217 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
218                                         u32 method_id,
219                                         const struct acpi_buffer *in,
220                                         struct acpi_buffer *out);
221 extern acpi_status wmi_query_block(const char *guid, u8 instance,
222                                         struct acpi_buffer *out);
223 extern acpi_status wmi_set_block(const char *guid, u8 instance,
224                                         const struct acpi_buffer *in);
225 extern acpi_status wmi_install_notify_handler(const char *guid,
226                                         wmi_notify_handler handler, void *data);
227 extern acpi_status wmi_remove_notify_handler(const char *guid);
228 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
229 extern bool wmi_has_guid(const char *guid);
230
231 #endif  /* CONFIG_ACPI_WMI */
232
233 #define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
234 #define ACPI_VIDEO_DEVICE_POSTING                       0x0002
235 #define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
236 #define ACPI_VIDEO_BACKLIGHT                            0x0008
237 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
238 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
239 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
240 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
241 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
242 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
243 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
244 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
245
246 extern char acpi_video_backlight_string[];
247 extern long acpi_is_video_device(acpi_handle handle);
248
249 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
250
251 extern void acpi_video_dmi_promote_vendor(void);
252 extern int acpi_video_backlight_support(void);
253
254 #else
255
256 static inline void acpi_video_dmi_promote_vendor(void)
257 {
258 }
259
260 static inline int acpi_video_backlight_support(void)
261 {
262         return 0;
263 }
264
265 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
266
267 extern int acpi_blacklisted(void);
268 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
269 extern void acpi_osi_setup(char *str);
270 extern bool acpi_osi_is_win8(void);
271
272 #ifdef CONFIG_ACPI_NUMA
273 int acpi_get_node(acpi_handle handle);
274 #else
275 static inline int acpi_get_node(acpi_handle handle)
276 {
277         return 0;
278 }
279 #endif
280 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
281
282 extern int pnpacpi_disabled;
283
284 #define PXM_INVAL       (-1)
285
286 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
287 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
288 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
289                                      struct resource_win *win);
290 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
291                                          struct resource_win *win);
292 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
293 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
294                                  struct resource *res);
295
296 void acpi_dev_free_resource_list(struct list_head *list);
297 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
298                            int (*preproc)(struct acpi_resource *, void *),
299                            void *preproc_data);
300 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
301                                   unsigned long types);
302
303 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
304                                                    void *arg)
305 {
306         return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
307 }
308
309 int acpi_check_resource_conflict(const struct resource *res);
310
311 int acpi_check_region(resource_size_t start, resource_size_t n,
312                       const char *name);
313
314 int acpi_resources_are_enforced(void);
315
316 #ifdef CONFIG_HIBERNATION
317 void __init acpi_no_s4_hw_signature(void);
318 #endif
319
320 #ifdef CONFIG_PM_SLEEP
321 void __init acpi_old_suspend_ordering(void);
322 void __init acpi_nvs_nosave(void);
323 void __init acpi_nvs_nosave_s3(void);
324 #endif /* CONFIG_PM_SLEEP */
325
326 struct acpi_osc_context {
327         char *uuid_str;                 /* UUID string */
328         int rev;
329         struct acpi_buffer cap;         /* list of DWORD capabilities */
330         struct acpi_buffer ret;         /* free by caller if success */
331 };
332
333 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
334 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
335
336 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
337 #define OSC_QUERY_DWORD                         0       /* DWORD 1 */
338 #define OSC_SUPPORT_DWORD                       1       /* DWORD 2 */
339 #define OSC_CONTROL_DWORD                       2       /* DWORD 3 */
340
341 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
342 #define OSC_QUERY_ENABLE                        0x00000001  /* input */
343 #define OSC_REQUEST_ERROR                       0x00000002  /* return */
344 #define OSC_INVALID_UUID_ERROR                  0x00000004  /* return */
345 #define OSC_INVALID_REVISION_ERROR              0x00000008  /* return */
346 #define OSC_CAPABILITIES_MASK_ERROR             0x00000010  /* return */
347
348 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
349 #define OSC_SB_PAD_SUPPORT                      0x00000001
350 #define OSC_SB_PPC_OST_SUPPORT                  0x00000002
351 #define OSC_SB_PR3_SUPPORT                      0x00000004
352 #define OSC_SB_HOTPLUG_OST_SUPPORT              0x00000008
353 #define OSC_SB_APEI_SUPPORT                     0x00000010
354 #define OSC_SB_CPC_SUPPORT                      0x00000020
355
356 extern bool osc_sb_apei_support_acked;
357
358 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
359 #define OSC_PCI_EXT_CONFIG_SUPPORT              0x00000001
360 #define OSC_PCI_ASPM_SUPPORT                    0x00000002
361 #define OSC_PCI_CLOCK_PM_SUPPORT                0x00000004
362 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          0x00000008
363 #define OSC_PCI_MSI_SUPPORT                     0x00000010
364 #define OSC_PCI_SUPPORT_MASKS                   0x0000001f
365
366 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
367 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       0x00000001
368 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL          0x00000002
369 #define OSC_PCI_EXPRESS_PME_CONTROL             0x00000004
370 #define OSC_PCI_EXPRESS_AER_CONTROL             0x00000008
371 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL      0x00000010
372 #define OSC_PCI_CONTROL_MASKS                   0x0000001f
373
374 #define ACPI_GSB_ACCESS_ATTRIB_QUICK            0x00000002
375 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
376 #define ACPI_GSB_ACCESS_ATTRIB_BYTE             0x00000006
377 #define ACPI_GSB_ACCESS_ATTRIB_WORD             0x00000008
378 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK            0x0000000A
379 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE        0x0000000B
380 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL        0x0000000C
381 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL       0x0000000D
382 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES        0x0000000E
383 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS      0x0000000F
384
385 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
386                                              u32 *mask, u32 req);
387
388 /* Enable _OST when all relevant hotplug operations are enabled */
389 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
390         defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&          \
391         defined(CONFIG_ACPI_CONTAINER)
392 #define ACPI_HOTPLUG_OST
393 #endif
394
395 /* _OST Source Event Code (OSPM Action) */
396 #define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
397 #define ACPI_OST_EC_OSPM_EJECT                  0x103
398 #define ACPI_OST_EC_OSPM_INSERTION              0x200
399
400 /* _OST General Processing Status Code */
401 #define ACPI_OST_SC_SUCCESS                     0x0
402 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
403 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
404
405 /* _OST OS Shutdown Processing (0x100) Status Code */
406 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
407 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
408 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
409 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
410
411 /* _OST Ejection Request (0x3, 0x103) Status Code */
412 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
413 #define ACPI_OST_SC_DEVICE_IN_USE               0x81
414 #define ACPI_OST_SC_DEVICE_BUSY                 0x82
415 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
416 #define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
417
418 /* _OST Insertion Request (0x200) Status Code */
419 #define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
420 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
421 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
422
423 extern void acpi_early_init(void);
424
425 extern int acpi_nvs_register(__u64 start, __u64 size);
426
427 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
428                                     void *data);
429
430 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
431                                                const struct device *dev);
432
433 extern bool acpi_driver_match_device(struct device *dev,
434                                      const struct device_driver *drv);
435 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
436 int acpi_device_modalias(struct device *, char *, int);
437 void acpi_walk_dep_device_list(acpi_handle handle);
438
439 struct platform_device *acpi_create_platform_device(struct acpi_device *);
440 #define ACPI_PTR(_ptr)  (_ptr)
441
442 #else   /* !CONFIG_ACPI */
443
444 #define acpi_disabled 1
445
446 #define ACPI_COMPANION(dev)             (NULL)
447 #define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
448 #define ACPI_HANDLE(dev)                (NULL)
449
450 struct fwnode_handle;
451
452 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
453 {
454         return false;
455 }
456
457 static inline struct acpi_device *acpi_node(struct fwnode_handle *fwnode)
458 {
459         return NULL;
460 }
461
462 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
463 {
464         return NULL;
465 }
466
467 static inline bool has_acpi_companion(struct device *dev)
468 {
469         return false;
470 }
471
472 static inline const char *acpi_dev_name(struct acpi_device *adev)
473 {
474         return NULL;
475 }
476
477 static inline void acpi_early_init(void) { }
478
479 static inline int early_acpi_boot_init(void)
480 {
481         return 0;
482 }
483 static inline int acpi_boot_init(void)
484 {
485         return 0;
486 }
487
488 static inline void acpi_boot_table_init(void)
489 {
490         return;
491 }
492
493 static inline int acpi_mps_check(void)
494 {
495         return 0;
496 }
497
498 static inline int acpi_check_resource_conflict(struct resource *res)
499 {
500         return 0;
501 }
502
503 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
504                                     const char *name)
505 {
506         return 0;
507 }
508
509 struct acpi_table_header;
510 static inline int acpi_table_parse(char *id,
511                                 int (*handler)(struct acpi_table_header *))
512 {
513         return -ENODEV;
514 }
515
516 static inline int acpi_nvs_register(__u64 start, __u64 size)
517 {
518         return 0;
519 }
520
521 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
522                                            void *data)
523 {
524         return 0;
525 }
526
527 struct acpi_device_id;
528
529 static inline const struct acpi_device_id *acpi_match_device(
530         const struct acpi_device_id *ids, const struct device *dev)
531 {
532         return NULL;
533 }
534
535 static inline bool acpi_driver_match_device(struct device *dev,
536                                             const struct device_driver *drv)
537 {
538         return false;
539 }
540
541 static inline int acpi_device_uevent_modalias(struct device *dev,
542                                 struct kobj_uevent_env *env)
543 {
544         return -ENODEV;
545 }
546
547 static inline int acpi_device_modalias(struct device *dev,
548                                 char *buf, int size)
549 {
550         return -ENODEV;
551 }
552
553 #define ACPI_PTR(_ptr)  (NULL)
554
555 #endif  /* !CONFIG_ACPI */
556
557 #ifdef CONFIG_ACPI
558 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
559                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
560
561 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
562                                   u32 pm1a_control, u32 pm1b_control);
563
564 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
565                                         u32 val_a,  u32 val_b));
566
567 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
568                                            u32 val_a, u32 val_b);
569
570 #ifdef CONFIG_X86
571 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
572 #else
573 static inline void arch_reserve_mem_area(acpi_physical_address addr,
574                                           size_t size)
575 {
576 }
577 #endif /* CONFIG_X86 */
578 #else
579 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
580 #endif
581
582 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
583 int acpi_dev_runtime_suspend(struct device *dev);
584 int acpi_dev_runtime_resume(struct device *dev);
585 int acpi_subsys_runtime_suspend(struct device *dev);
586 int acpi_subsys_runtime_resume(struct device *dev);
587 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
588 int acpi_dev_pm_attach(struct device *dev, bool power_on);
589 #else
590 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
591 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
592 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
593 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
594 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
595 {
596         return NULL;
597 }
598 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
599 {
600         return -ENODEV;
601 }
602 #endif
603
604 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
605 int acpi_dev_suspend_late(struct device *dev);
606 int acpi_dev_resume_early(struct device *dev);
607 int acpi_subsys_prepare(struct device *dev);
608 void acpi_subsys_complete(struct device *dev);
609 int acpi_subsys_suspend_late(struct device *dev);
610 int acpi_subsys_resume_early(struct device *dev);
611 int acpi_subsys_suspend(struct device *dev);
612 int acpi_subsys_freeze(struct device *dev);
613 #else
614 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
615 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
616 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
617 static inline void acpi_subsys_complete(struct device *dev) {}
618 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
619 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
620 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
621 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
622 #endif
623
624 #ifdef CONFIG_ACPI
625 __printf(3, 4)
626 void acpi_handle_printk(const char *level, acpi_handle handle,
627                         const char *fmt, ...);
628 #else   /* !CONFIG_ACPI */
629 static inline __printf(3, 4) void
630 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
631 #endif  /* !CONFIG_ACPI */
632
633 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
634 __printf(3, 4)
635 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
636 #else
637 #define __acpi_handle_debug(descriptor, handle, fmt, ...)               \
638         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
639 #endif
640
641 /*
642  * acpi_handle_<level>: Print message with ACPI prefix and object path
643  *
644  * These interfaces acquire the global namespace mutex to obtain an object
645  * path.  In interrupt context, it shows the object path as <n/a>.
646  */
647 #define acpi_handle_emerg(handle, fmt, ...)                             \
648         acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
649 #define acpi_handle_alert(handle, fmt, ...)                             \
650         acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
651 #define acpi_handle_crit(handle, fmt, ...)                              \
652         acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
653 #define acpi_handle_err(handle, fmt, ...)                               \
654         acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
655 #define acpi_handle_warn(handle, fmt, ...)                              \
656         acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
657 #define acpi_handle_notice(handle, fmt, ...)                            \
658         acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
659 #define acpi_handle_info(handle, fmt, ...)                              \
660         acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
661
662 #if defined(DEBUG)
663 #define acpi_handle_debug(handle, fmt, ...)                             \
664         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
665 #else
666 #if defined(CONFIG_DYNAMIC_DEBUG)
667 #define acpi_handle_debug(handle, fmt, ...)                             \
668 do {                                                                    \
669         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
670         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT))          \
671                 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt),   \
672                                 ##__VA_ARGS__);                         \
673 } while (0)
674 #else
675 #define acpi_handle_debug(handle, fmt, ...)                             \
676 ({                                                                      \
677         if (0)                                                          \
678                 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
679         0;                                                              \
680 })
681 #endif
682 #endif
683
684 struct acpi_gpio_params {
685         unsigned int crs_entry_index;
686         unsigned int line_index;
687         bool active_low;
688 };
689
690 struct acpi_gpio_mapping {
691         const char *name;
692         const struct acpi_gpio_params *data;
693         unsigned int size;
694 };
695
696 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
697 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
698                               const struct acpi_gpio_mapping *gpios);
699
700 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
701 {
702         if (adev)
703                 adev->driver_gpios = NULL;
704 }
705 #else
706 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
707                               const struct acpi_gpio_mapping *gpios)
708 {
709         return -ENXIO;
710 }
711 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
712 #endif
713
714 /* Device properties */
715
716 #define MAX_ACPI_REFERENCE_ARGS 8
717 struct acpi_reference_args {
718         struct acpi_device *adev;
719         size_t nargs;
720         u64 args[MAX_ACPI_REFERENCE_ARGS];
721 };
722
723 #ifdef CONFIG_ACPI
724 int acpi_dev_get_property(struct acpi_device *adev, const char *name,
725                           acpi_object_type type, const union acpi_object **obj);
726 int acpi_dev_get_property_array(struct acpi_device *adev, const char *name,
727                                 acpi_object_type type,
728                                 const union acpi_object **obj);
729 int acpi_dev_get_property_reference(struct acpi_device *adev,
730                                     const char *name, size_t index,
731                                     struct acpi_reference_args *args);
732
733 int acpi_dev_prop_get(struct acpi_device *adev, const char *propname,
734                       void **valptr);
735 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
736                               enum dev_prop_type proptype, void *val);
737 int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
738                        enum dev_prop_type proptype, void *val, size_t nval);
739
740 struct acpi_device *acpi_get_next_child(struct device *dev,
741                                         struct acpi_device *child);
742 #else
743 static inline int acpi_dev_get_property(struct acpi_device *adev,
744                                         const char *name, acpi_object_type type,
745                                         const union acpi_object **obj)
746 {
747         return -ENXIO;
748 }
749 static inline int acpi_dev_get_property_array(struct acpi_device *adev,
750                                               const char *name,
751                                               acpi_object_type type,
752                                               const union acpi_object **obj)
753 {
754         return -ENXIO;
755 }
756 static inline int acpi_dev_get_property_reference(struct acpi_device *adev,
757                                 const char *name, const char *cells_name,
758                                 size_t index, struct acpi_reference_args *args)
759 {
760         return -ENXIO;
761 }
762
763 static inline int acpi_dev_prop_get(struct acpi_device *adev,
764                                     const char *propname,
765                                     void **valptr)
766 {
767         return -ENXIO;
768 }
769
770 static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
771                                             const char *propname,
772                                             enum dev_prop_type proptype,
773                                             void *val)
774 {
775         return -ENXIO;
776 }
777
778 static inline int acpi_dev_prop_read(struct acpi_device *adev,
779                                      const char *propname,
780                                      enum dev_prop_type proptype,
781                                      void *val, size_t nval)
782 {
783         return -ENXIO;
784 }
785
786 static inline struct acpi_device *acpi_get_next_child(struct device *dev,
787                                                       struct acpi_device *child)
788 {
789         return NULL;
790 }
791
792 #endif
793
794 #endif  /*_LINUX_ACPI_H*/