5da2d2e9d38e32a6b12a6f9b34d4cad81fb7be4c
[kvmfornfv.git] / kernel / 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 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
247
248 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
249 extern long acpi_is_video_device(acpi_handle handle);
250 extern void acpi_video_dmi_promote_vendor(void);
251 extern void acpi_video_dmi_demote_vendor(void);
252 extern int acpi_video_backlight_support(void);
253 extern int acpi_video_display_switch_support(void);
254
255 #else
256
257 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
258 {
259         return 0;
260 }
261
262 static inline long acpi_is_video_device(acpi_handle handle)
263 {
264         return 0;
265 }
266
267 static inline void acpi_video_dmi_promote_vendor(void)
268 {
269 }
270
271 static inline void acpi_video_dmi_demote_vendor(void)
272 {
273 }
274
275 static inline int acpi_video_backlight_support(void)
276 {
277         return 0;
278 }
279
280 static inline int acpi_video_display_switch_support(void)
281 {
282         return 0;
283 }
284
285 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
286
287 extern int acpi_blacklisted(void);
288 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
289 extern void acpi_osi_setup(char *str);
290
291 #ifdef CONFIG_ACPI_NUMA
292 int acpi_get_node(acpi_handle handle);
293 #else
294 static inline int acpi_get_node(acpi_handle handle)
295 {
296         return 0;
297 }
298 #endif
299 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
300
301 extern int pnpacpi_disabled;
302
303 #define PXM_INVAL       (-1)
304
305 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
306 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
307 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
308                                      struct resource_win *win);
309 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
310                                          struct resource_win *win);
311 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
312 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
313                                  struct resource *res);
314
315 void acpi_dev_free_resource_list(struct list_head *list);
316 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
317                            int (*preproc)(struct acpi_resource *, void *),
318                            void *preproc_data);
319 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
320                                   unsigned long types);
321
322 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
323                                                    void *arg)
324 {
325         return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
326 }
327
328 int acpi_check_resource_conflict(const struct resource *res);
329
330 int acpi_check_region(resource_size_t start, resource_size_t n,
331                       const char *name);
332
333 int acpi_resources_are_enforced(void);
334
335 int acpi_reserve_region(u64 start, unsigned int length, u8 space_id,
336                         unsigned long flags, char *desc);
337
338 #ifdef CONFIG_HIBERNATION
339 void __init acpi_no_s4_hw_signature(void);
340 #endif
341
342 #ifdef CONFIG_PM_SLEEP
343 void __init acpi_old_suspend_ordering(void);
344 void __init acpi_nvs_nosave(void);
345 void __init acpi_nvs_nosave_s3(void);
346 #endif /* CONFIG_PM_SLEEP */
347
348 struct acpi_osc_context {
349         char *uuid_str;                 /* UUID string */
350         int rev;
351         struct acpi_buffer cap;         /* list of DWORD capabilities */
352         struct acpi_buffer ret;         /* free by caller if success */
353 };
354
355 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
356 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
357
358 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
359 #define OSC_QUERY_DWORD                         0       /* DWORD 1 */
360 #define OSC_SUPPORT_DWORD                       1       /* DWORD 2 */
361 #define OSC_CONTROL_DWORD                       2       /* DWORD 3 */
362
363 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
364 #define OSC_QUERY_ENABLE                        0x00000001  /* input */
365 #define OSC_REQUEST_ERROR                       0x00000002  /* return */
366 #define OSC_INVALID_UUID_ERROR                  0x00000004  /* return */
367 #define OSC_INVALID_REVISION_ERROR              0x00000008  /* return */
368 #define OSC_CAPABILITIES_MASK_ERROR             0x00000010  /* return */
369
370 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
371 #define OSC_SB_PAD_SUPPORT                      0x00000001
372 #define OSC_SB_PPC_OST_SUPPORT                  0x00000002
373 #define OSC_SB_PR3_SUPPORT                      0x00000004
374 #define OSC_SB_HOTPLUG_OST_SUPPORT              0x00000008
375 #define OSC_SB_APEI_SUPPORT                     0x00000010
376 #define OSC_SB_CPC_SUPPORT                      0x00000020
377
378 extern bool osc_sb_apei_support_acked;
379
380 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
381 #define OSC_PCI_EXT_CONFIG_SUPPORT              0x00000001
382 #define OSC_PCI_ASPM_SUPPORT                    0x00000002
383 #define OSC_PCI_CLOCK_PM_SUPPORT                0x00000004
384 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          0x00000008
385 #define OSC_PCI_MSI_SUPPORT                     0x00000010
386 #define OSC_PCI_SUPPORT_MASKS                   0x0000001f
387
388 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
389 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       0x00000001
390 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL          0x00000002
391 #define OSC_PCI_EXPRESS_PME_CONTROL             0x00000004
392 #define OSC_PCI_EXPRESS_AER_CONTROL             0x00000008
393 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL      0x00000010
394 #define OSC_PCI_CONTROL_MASKS                   0x0000001f
395
396 #define ACPI_GSB_ACCESS_ATTRIB_QUICK            0x00000002
397 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
398 #define ACPI_GSB_ACCESS_ATTRIB_BYTE             0x00000006
399 #define ACPI_GSB_ACCESS_ATTRIB_WORD             0x00000008
400 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK            0x0000000A
401 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE        0x0000000B
402 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL        0x0000000C
403 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL       0x0000000D
404 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES        0x0000000E
405 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS      0x0000000F
406
407 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
408                                              u32 *mask, u32 req);
409
410 /* Enable _OST when all relevant hotplug operations are enabled */
411 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
412         defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&          \
413         defined(CONFIG_ACPI_CONTAINER)
414 #define ACPI_HOTPLUG_OST
415 #endif
416
417 /* _OST Source Event Code (OSPM Action) */
418 #define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
419 #define ACPI_OST_EC_OSPM_EJECT                  0x103
420 #define ACPI_OST_EC_OSPM_INSERTION              0x200
421
422 /* _OST General Processing Status Code */
423 #define ACPI_OST_SC_SUCCESS                     0x0
424 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
425 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
426
427 /* _OST OS Shutdown Processing (0x100) Status Code */
428 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
429 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
430 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
431 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
432
433 /* _OST Ejection Request (0x3, 0x103) Status Code */
434 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
435 #define ACPI_OST_SC_DEVICE_IN_USE               0x81
436 #define ACPI_OST_SC_DEVICE_BUSY                 0x82
437 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
438 #define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
439
440 /* _OST Insertion Request (0x200) Status Code */
441 #define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
442 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
443 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
444
445 extern void acpi_early_init(void);
446 extern void acpi_subsystem_init(void);
447
448 extern int acpi_nvs_register(__u64 start, __u64 size);
449
450 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
451                                     void *data);
452
453 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
454                                                const struct device *dev);
455
456 extern bool acpi_driver_match_device(struct device *dev,
457                                      const struct device_driver *drv);
458 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
459 int acpi_device_modalias(struct device *, char *, int);
460 void acpi_walk_dep_device_list(acpi_handle handle);
461
462 struct platform_device *acpi_create_platform_device(struct acpi_device *);
463 #define ACPI_PTR(_ptr)  (_ptr)
464
465 #else   /* !CONFIG_ACPI */
466
467 #define acpi_disabled 1
468
469 #define ACPI_COMPANION(dev)             (NULL)
470 #define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
471 #define ACPI_HANDLE(dev)                (NULL)
472
473 struct fwnode_handle;
474
475 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
476 {
477         return false;
478 }
479
480 static inline struct acpi_device *acpi_node(struct fwnode_handle *fwnode)
481 {
482         return NULL;
483 }
484
485 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
486 {
487         return NULL;
488 }
489
490 static inline bool has_acpi_companion(struct device *dev)
491 {
492         return false;
493 }
494
495 static inline const char *acpi_dev_name(struct acpi_device *adev)
496 {
497         return NULL;
498 }
499
500 static inline void acpi_early_init(void) { }
501 static inline void acpi_subsystem_init(void) { }
502
503 static inline int early_acpi_boot_init(void)
504 {
505         return 0;
506 }
507 static inline int acpi_boot_init(void)
508 {
509         return 0;
510 }
511
512 static inline void acpi_boot_table_init(void)
513 {
514         return;
515 }
516
517 static inline int acpi_mps_check(void)
518 {
519         return 0;
520 }
521
522 static inline int acpi_check_resource_conflict(struct resource *res)
523 {
524         return 0;
525 }
526
527 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
528                                     const char *name)
529 {
530         return 0;
531 }
532
533 static inline int acpi_reserve_region(u64 start, unsigned int length,
534                                       u8 space_id, unsigned long flags,
535                                       char *desc)
536 {
537         return -ENXIO;
538 }
539
540 struct acpi_table_header;
541 static inline int acpi_table_parse(char *id,
542                                 int (*handler)(struct acpi_table_header *))
543 {
544         return -ENODEV;
545 }
546
547 static inline int acpi_nvs_register(__u64 start, __u64 size)
548 {
549         return 0;
550 }
551
552 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
553                                            void *data)
554 {
555         return 0;
556 }
557
558 struct acpi_device_id;
559
560 static inline const struct acpi_device_id *acpi_match_device(
561         const struct acpi_device_id *ids, const struct device *dev)
562 {
563         return NULL;
564 }
565
566 static inline bool acpi_driver_match_device(struct device *dev,
567                                             const struct device_driver *drv)
568 {
569         return false;
570 }
571
572 static inline int acpi_device_uevent_modalias(struct device *dev,
573                                 struct kobj_uevent_env *env)
574 {
575         return -ENODEV;
576 }
577
578 static inline int acpi_device_modalias(struct device *dev,
579                                 char *buf, int size)
580 {
581         return -ENODEV;
582 }
583
584 #define ACPI_PTR(_ptr)  (NULL)
585
586 #endif  /* !CONFIG_ACPI */
587
588 #ifdef CONFIG_ACPI
589 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
590                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
591
592 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
593                                   u32 pm1a_control, u32 pm1b_control);
594
595 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
596                                         u32 val_a,  u32 val_b));
597
598 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
599                                            u32 val_a, u32 val_b);
600
601 #ifdef CONFIG_X86
602 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
603 #else
604 static inline void arch_reserve_mem_area(acpi_physical_address addr,
605                                           size_t size)
606 {
607 }
608 #endif /* CONFIG_X86 */
609 #else
610 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
611 #endif
612
613 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
614 int acpi_dev_runtime_suspend(struct device *dev);
615 int acpi_dev_runtime_resume(struct device *dev);
616 int acpi_subsys_runtime_suspend(struct device *dev);
617 int acpi_subsys_runtime_resume(struct device *dev);
618 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
619 int acpi_dev_pm_attach(struct device *dev, bool power_on);
620 #else
621 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
622 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
623 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
624 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
625 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
626 {
627         return NULL;
628 }
629 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
630 {
631         return -ENODEV;
632 }
633 #endif
634
635 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
636 int acpi_dev_suspend_late(struct device *dev);
637 int acpi_dev_resume_early(struct device *dev);
638 int acpi_subsys_prepare(struct device *dev);
639 void acpi_subsys_complete(struct device *dev);
640 int acpi_subsys_suspend_late(struct device *dev);
641 int acpi_subsys_resume_early(struct device *dev);
642 int acpi_subsys_suspend(struct device *dev);
643 int acpi_subsys_freeze(struct device *dev);
644 #else
645 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
646 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
647 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
648 static inline void acpi_subsys_complete(struct device *dev) {}
649 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
650 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
651 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
652 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
653 #endif
654
655 #ifdef CONFIG_ACPI
656 __printf(3, 4)
657 void acpi_handle_printk(const char *level, acpi_handle handle,
658                         const char *fmt, ...);
659 #else   /* !CONFIG_ACPI */
660 static inline __printf(3, 4) void
661 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
662 #endif  /* !CONFIG_ACPI */
663
664 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
665 __printf(3, 4)
666 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
667 #else
668 #define __acpi_handle_debug(descriptor, handle, fmt, ...)               \
669         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
670 #endif
671
672 /*
673  * acpi_handle_<level>: Print message with ACPI prefix and object path
674  *
675  * These interfaces acquire the global namespace mutex to obtain an object
676  * path.  In interrupt context, it shows the object path as <n/a>.
677  */
678 #define acpi_handle_emerg(handle, fmt, ...)                             \
679         acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
680 #define acpi_handle_alert(handle, fmt, ...)                             \
681         acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
682 #define acpi_handle_crit(handle, fmt, ...)                              \
683         acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
684 #define acpi_handle_err(handle, fmt, ...)                               \
685         acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
686 #define acpi_handle_warn(handle, fmt, ...)                              \
687         acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
688 #define acpi_handle_notice(handle, fmt, ...)                            \
689         acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
690 #define acpi_handle_info(handle, fmt, ...)                              \
691         acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
692
693 #if defined(DEBUG)
694 #define acpi_handle_debug(handle, fmt, ...)                             \
695         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
696 #else
697 #if defined(CONFIG_DYNAMIC_DEBUG)
698 #define acpi_handle_debug(handle, fmt, ...)                             \
699 do {                                                                    \
700         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
701         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT))          \
702                 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt),   \
703                                 ##__VA_ARGS__);                         \
704 } while (0)
705 #else
706 #define acpi_handle_debug(handle, fmt, ...)                             \
707 ({                                                                      \
708         if (0)                                                          \
709                 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
710         0;                                                              \
711 })
712 #endif
713 #endif
714
715 struct acpi_gpio_params {
716         unsigned int crs_entry_index;
717         unsigned int line_index;
718         bool active_low;
719 };
720
721 struct acpi_gpio_mapping {
722         const char *name;
723         const struct acpi_gpio_params *data;
724         unsigned int size;
725 };
726
727 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
728 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
729                               const struct acpi_gpio_mapping *gpios);
730
731 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
732 {
733         if (adev)
734                 adev->driver_gpios = NULL;
735 }
736 #else
737 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
738                               const struct acpi_gpio_mapping *gpios)
739 {
740         return -ENXIO;
741 }
742 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
743 #endif
744
745 /* Device properties */
746
747 #define MAX_ACPI_REFERENCE_ARGS 8
748 struct acpi_reference_args {
749         struct acpi_device *adev;
750         size_t nargs;
751         u64 args[MAX_ACPI_REFERENCE_ARGS];
752 };
753
754 #ifdef CONFIG_ACPI
755 int acpi_dev_get_property(struct acpi_device *adev, const char *name,
756                           acpi_object_type type, const union acpi_object **obj);
757 int acpi_dev_get_property_array(struct acpi_device *adev, const char *name,
758                                 acpi_object_type type,
759                                 const union acpi_object **obj);
760 int acpi_dev_get_property_reference(struct acpi_device *adev,
761                                     const char *name, size_t index,
762                                     struct acpi_reference_args *args);
763
764 int acpi_dev_prop_get(struct acpi_device *adev, const char *propname,
765                       void **valptr);
766 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
767                               enum dev_prop_type proptype, void *val);
768 int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
769                        enum dev_prop_type proptype, void *val, size_t nval);
770
771 struct acpi_device *acpi_get_next_child(struct device *dev,
772                                         struct acpi_device *child);
773 #else
774 static inline int acpi_dev_get_property(struct acpi_device *adev,
775                                         const char *name, acpi_object_type type,
776                                         const union acpi_object **obj)
777 {
778         return -ENXIO;
779 }
780 static inline int acpi_dev_get_property_array(struct acpi_device *adev,
781                                               const char *name,
782                                               acpi_object_type type,
783                                               const union acpi_object **obj)
784 {
785         return -ENXIO;
786 }
787 static inline int acpi_dev_get_property_reference(struct acpi_device *adev,
788                                 const char *name, const char *cells_name,
789                                 size_t index, struct acpi_reference_args *args)
790 {
791         return -ENXIO;
792 }
793
794 static inline int acpi_dev_prop_get(struct acpi_device *adev,
795                                     const char *propname,
796                                     void **valptr)
797 {
798         return -ENXIO;
799 }
800
801 static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
802                                             const char *propname,
803                                             enum dev_prop_type proptype,
804                                             void *val)
805 {
806         return -ENXIO;
807 }
808
809 static inline int acpi_dev_prop_read(struct acpi_device *adev,
810                                      const char *propname,
811                                      enum dev_prop_type proptype,
812                                      void *val, size_t nval)
813 {
814         return -ENXIO;
815 }
816
817 static inline struct acpi_device *acpi_get_next_child(struct device *dev,
818                                                       struct acpi_device *child)
819 {
820         return NULL;
821 }
822
823 #endif
824
825 #endif  /*_LINUX_ACPI_H*/