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