]> git.karo-electronics.de Git - karo-tx-linux.git/blob - include/linux/acpi.h
Merge tag 'scsi-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/jejb/scsi
[karo-tx-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 #include <linux/module.h>
41 #include <linux/mutex.h>
42
43 #include <acpi/acpi_bus.h>
44 #include <acpi/acpi_drivers.h>
45 #include <acpi/acpi_numa.h>
46 #include <acpi/acpi_io.h>
47 #include <asm/acpi.h>
48
49 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
50 {
51         return adev ? adev->handle : NULL;
52 }
53
54 #define ACPI_COMPANION(dev)             to_acpi_device_node((dev)->fwnode)
55 #define ACPI_COMPANION_SET(dev, adev)   set_primary_fwnode(dev, (adev) ? \
56         acpi_fwnode_handle(adev) : NULL)
57 #define ACPI_HANDLE(dev)                acpi_device_handle(ACPI_COMPANION(dev))
58
59 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
60 {
61         struct fwnode_handle *fwnode;
62
63         fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
64         if (!fwnode)
65                 return NULL;
66
67         fwnode->type = FWNODE_ACPI_STATIC;
68
69         return fwnode;
70 }
71
72 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
73 {
74         if (WARN_ON(!fwnode || fwnode->type != FWNODE_ACPI_STATIC))
75                 return;
76
77         kfree(fwnode);
78 }
79
80 /**
81  * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
82  * the PCI-defined class-code information
83  *
84  * @_cls : the class, subclass, prog-if triple for this device
85  * @_msk : the class mask for this device
86  *
87  * This macro is used to create a struct acpi_device_id that matches a
88  * specific PCI class. The .id and .driver_data fields will be left
89  * initialized with the default value.
90  */
91 #define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (_cls), .cls_msk = (_msk),
92
93 static inline bool has_acpi_companion(struct device *dev)
94 {
95         return is_acpi_device_node(dev->fwnode);
96 }
97
98 static inline void acpi_preset_companion(struct device *dev,
99                                          struct acpi_device *parent, u64 addr)
100 {
101         ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
102 }
103
104 static inline const char *acpi_dev_name(struct acpi_device *adev)
105 {
106         return dev_name(&adev->dev);
107 }
108
109 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
110
111 enum acpi_irq_model_id {
112         ACPI_IRQ_MODEL_PIC = 0,
113         ACPI_IRQ_MODEL_IOAPIC,
114         ACPI_IRQ_MODEL_IOSAPIC,
115         ACPI_IRQ_MODEL_PLATFORM,
116         ACPI_IRQ_MODEL_GIC,
117         ACPI_IRQ_MODEL_COUNT
118 };
119
120 extern enum acpi_irq_model_id   acpi_irq_model;
121
122 enum acpi_interrupt_id {
123         ACPI_INTERRUPT_PMI      = 1,
124         ACPI_INTERRUPT_INIT,
125         ACPI_INTERRUPT_CPEI,
126         ACPI_INTERRUPT_COUNT
127 };
128
129 #define ACPI_SPACE_MEM          0
130
131 enum acpi_address_range_id {
132         ACPI_ADDRESS_RANGE_MEMORY = 1,
133         ACPI_ADDRESS_RANGE_RESERVED = 2,
134         ACPI_ADDRESS_RANGE_ACPI = 3,
135         ACPI_ADDRESS_RANGE_NVS  = 4,
136         ACPI_ADDRESS_RANGE_COUNT
137 };
138
139
140 /* Table Handlers */
141
142 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
143
144 typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
145                                       const unsigned long end);
146
147 /* Debugger support */
148
149 struct acpi_debugger_ops {
150         int (*create_thread)(acpi_osd_exec_callback function, void *context);
151         ssize_t (*write_log)(const char *msg);
152         ssize_t (*read_cmd)(char *buffer, size_t length);
153         int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
154         int (*notify_command_complete)(void);
155 };
156
157 struct acpi_debugger {
158         const struct acpi_debugger_ops *ops;
159         struct module *owner;
160         struct mutex lock;
161 };
162
163 #ifdef CONFIG_ACPI_DEBUGGER
164 int __init acpi_debugger_init(void);
165 int acpi_register_debugger(struct module *owner,
166                            const struct acpi_debugger_ops *ops);
167 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
168 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
169 ssize_t acpi_debugger_write_log(const char *msg);
170 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
171 int acpi_debugger_wait_command_ready(void);
172 int acpi_debugger_notify_command_complete(void);
173 #else
174 static inline int acpi_debugger_init(void)
175 {
176         return -ENODEV;
177 }
178
179 static inline int acpi_register_debugger(struct module *owner,
180                                          const struct acpi_debugger_ops *ops)
181 {
182         return -ENODEV;
183 }
184
185 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
186 {
187 }
188
189 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
190                                               void *context)
191 {
192         return -ENODEV;
193 }
194
195 static inline int acpi_debugger_write_log(const char *msg)
196 {
197         return -ENODEV;
198 }
199
200 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
201 {
202         return -ENODEV;
203 }
204
205 static inline int acpi_debugger_wait_command_ready(void)
206 {
207         return -ENODEV;
208 }
209
210 static inline int acpi_debugger_notify_command_complete(void)
211 {
212         return -ENODEV;
213 }
214 #endif
215
216 #define BAD_MADT_ENTRY(entry, end) (                                        \
217                 (!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
218                 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
219
220 struct acpi_subtable_proc {
221         int id;
222         acpi_tbl_entry_handler handler;
223         int count;
224 };
225
226 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
227 void __acpi_unmap_table(char *map, unsigned long size);
228 int early_acpi_boot_init(void);
229 int acpi_boot_init (void);
230 void acpi_boot_table_init (void);
231 int acpi_mps_check (void);
232 int acpi_numa_init (void);
233
234 int acpi_table_init (void);
235 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
236 int __init acpi_parse_entries(char *id, unsigned long table_size,
237                               acpi_tbl_entry_handler handler,
238                               struct acpi_table_header *table_header,
239                               int entry_id, unsigned int max_entries);
240 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
241                               int entry_id,
242                               acpi_tbl_entry_handler handler,
243                               unsigned int max_entries);
244 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
245                               struct acpi_subtable_proc *proc, int proc_num,
246                               unsigned int max_entries);
247 int acpi_table_parse_madt(enum acpi_madt_type id,
248                           acpi_tbl_entry_handler handler,
249                           unsigned int max_entries);
250 int acpi_parse_mcfg (struct acpi_table_header *header);
251 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
252
253 /* the following numa functions are architecture-dependent */
254 void acpi_numa_slit_init (struct acpi_table_slit *slit);
255
256 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
257 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
258 #else
259 static inline void
260 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
261 #endif
262
263 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
264
265 #ifdef CONFIG_ARM64
266 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
267 #else
268 static inline void
269 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
270 #endif
271
272 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
273
274 #ifndef PHYS_CPUID_INVALID
275 typedef u32 phys_cpuid_t;
276 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
277 #endif
278
279 static inline bool invalid_logical_cpuid(u32 cpuid)
280 {
281         return (int)cpuid < 0;
282 }
283
284 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
285 {
286         return phys_id == PHYS_CPUID_INVALID;
287 }
288
289 /* Validate the processor object's proc_id */
290 bool acpi_duplicate_processor_id(int proc_id);
291
292 #ifdef CONFIG_ACPI_HOTPLUG_CPU
293 /* Arch dependent functions for cpu hotplug support */
294 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
295                  int *pcpu);
296 int acpi_unmap_cpu(int cpu);
297 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
298
299 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
300 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
301 #endif
302
303 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
304 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
305 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
306 void acpi_irq_stats_init(void);
307 extern u32 acpi_irq_handled;
308 extern u32 acpi_irq_not_handled;
309 extern unsigned int acpi_sci_irq;
310 extern bool acpi_no_s5;
311 #define INVALID_ACPI_IRQ        ((unsigned)-1)
312 static inline bool acpi_sci_irq_valid(void)
313 {
314         return acpi_sci_irq != INVALID_ACPI_IRQ;
315 }
316
317 extern int sbf_port;
318 extern unsigned long acpi_realmode_flags;
319
320 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
321 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
322 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
323
324 void acpi_set_irq_model(enum acpi_irq_model_id model,
325                         struct fwnode_handle *fwnode);
326
327 #ifdef CONFIG_X86_IO_APIC
328 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
329 #else
330 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
331 #endif
332 /*
333  * This function undoes the effect of one call to acpi_register_gsi().
334  * If this matches the last registration, any IRQ resources for gsi
335  * are freed.
336  */
337 void acpi_unregister_gsi (u32 gsi);
338
339 struct pci_dev;
340
341 int acpi_pci_irq_enable (struct pci_dev *dev);
342 void acpi_penalize_isa_irq(int irq, int active);
343 bool acpi_isa_irq_available(int irq);
344 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
345 void acpi_pci_irq_disable (struct pci_dev *dev);
346
347 extern int ec_read(u8 addr, u8 *val);
348 extern int ec_write(u8 addr, u8 val);
349 extern int ec_transaction(u8 command,
350                           const u8 *wdata, unsigned wdata_len,
351                           u8 *rdata, unsigned rdata_len);
352 extern acpi_handle ec_get_handle(void);
353
354 extern bool acpi_is_pnp_device(struct acpi_device *);
355
356 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
357
358 typedef void (*wmi_notify_handler) (u32 value, void *context);
359
360 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
361                                         u32 method_id,
362                                         const struct acpi_buffer *in,
363                                         struct acpi_buffer *out);
364 extern acpi_status wmi_query_block(const char *guid, u8 instance,
365                                         struct acpi_buffer *out);
366 extern acpi_status wmi_set_block(const char *guid, u8 instance,
367                                         const struct acpi_buffer *in);
368 extern acpi_status wmi_install_notify_handler(const char *guid,
369                                         wmi_notify_handler handler, void *data);
370 extern acpi_status wmi_remove_notify_handler(const char *guid);
371 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
372 extern bool wmi_has_guid(const char *guid);
373
374 #endif  /* CONFIG_ACPI_WMI */
375
376 #define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
377 #define ACPI_VIDEO_DEVICE_POSTING                       0x0002
378 #define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
379 #define ACPI_VIDEO_BACKLIGHT                            0x0008
380 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
381 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
382 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
383 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
384 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
385 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
386 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
387 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
388
389 extern char acpi_video_backlight_string[];
390 extern long acpi_is_video_device(acpi_handle handle);
391 extern int acpi_blacklisted(void);
392 extern void acpi_osi_setup(char *str);
393 extern bool acpi_osi_is_win8(void);
394
395 #ifdef CONFIG_ACPI_NUMA
396 int acpi_map_pxm_to_online_node(int pxm);
397 int acpi_get_node(acpi_handle handle);
398 #else
399 static inline int acpi_map_pxm_to_online_node(int pxm)
400 {
401         return 0;
402 }
403 static inline int acpi_get_node(acpi_handle handle)
404 {
405         return 0;
406 }
407 #endif
408 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
409
410 extern int pnpacpi_disabled;
411
412 #define PXM_INVAL       (-1)
413
414 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
415 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
416 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
417                                      struct resource_win *win);
418 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
419                                          struct resource_win *win);
420 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
421 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
422 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
423                                  struct resource *res);
424
425 void acpi_dev_free_resource_list(struct list_head *list);
426 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
427                            int (*preproc)(struct acpi_resource *, void *),
428                            void *preproc_data);
429 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
430                                   unsigned long types);
431
432 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
433                                                    void *arg)
434 {
435         return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
436 }
437
438 struct acpi_device *acpi_resource_consumer(struct resource *res);
439
440 int acpi_check_resource_conflict(const struct resource *res);
441
442 int acpi_check_region(resource_size_t start, resource_size_t n,
443                       const char *name);
444
445 int acpi_resources_are_enforced(void);
446
447 #ifdef CONFIG_HIBERNATION
448 void __init acpi_no_s4_hw_signature(void);
449 #endif
450
451 #ifdef CONFIG_PM_SLEEP
452 void __init acpi_old_suspend_ordering(void);
453 void __init acpi_nvs_nosave(void);
454 void __init acpi_nvs_nosave_s3(void);
455 #endif /* CONFIG_PM_SLEEP */
456
457 struct acpi_osc_context {
458         char *uuid_str;                 /* UUID string */
459         int rev;
460         struct acpi_buffer cap;         /* list of DWORD capabilities */
461         struct acpi_buffer ret;         /* free by caller if success */
462 };
463
464 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
465 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
466
467 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
468 #define OSC_QUERY_DWORD                         0       /* DWORD 1 */
469 #define OSC_SUPPORT_DWORD                       1       /* DWORD 2 */
470 #define OSC_CONTROL_DWORD                       2       /* DWORD 3 */
471
472 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
473 #define OSC_QUERY_ENABLE                        0x00000001  /* input */
474 #define OSC_REQUEST_ERROR                       0x00000002  /* return */
475 #define OSC_INVALID_UUID_ERROR                  0x00000004  /* return */
476 #define OSC_INVALID_REVISION_ERROR              0x00000008  /* return */
477 #define OSC_CAPABILITIES_MASK_ERROR             0x00000010  /* return */
478
479 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
480 #define OSC_SB_PAD_SUPPORT                      0x00000001
481 #define OSC_SB_PPC_OST_SUPPORT                  0x00000002
482 #define OSC_SB_PR3_SUPPORT                      0x00000004
483 #define OSC_SB_HOTPLUG_OST_SUPPORT              0x00000008
484 #define OSC_SB_APEI_SUPPORT                     0x00000010
485 #define OSC_SB_CPC_SUPPORT                      0x00000020
486 #define OSC_SB_CPCV2_SUPPORT                    0x00000040
487 #define OSC_SB_PCLPI_SUPPORT                    0x00000080
488 #define OSC_SB_OSLPI_SUPPORT                    0x00000100
489 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT         0x00001000
490
491 extern bool osc_sb_apei_support_acked;
492 extern bool osc_pc_lpi_support_confirmed;
493
494 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
495 #define OSC_PCI_EXT_CONFIG_SUPPORT              0x00000001
496 #define OSC_PCI_ASPM_SUPPORT                    0x00000002
497 #define OSC_PCI_CLOCK_PM_SUPPORT                0x00000004
498 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          0x00000008
499 #define OSC_PCI_MSI_SUPPORT                     0x00000010
500 #define OSC_PCI_SUPPORT_MASKS                   0x0000001f
501
502 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
503 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       0x00000001
504 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL          0x00000002
505 #define OSC_PCI_EXPRESS_PME_CONTROL             0x00000004
506 #define OSC_PCI_EXPRESS_AER_CONTROL             0x00000008
507 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL      0x00000010
508 #define OSC_PCI_CONTROL_MASKS                   0x0000001f
509
510 #define ACPI_GSB_ACCESS_ATTRIB_QUICK            0x00000002
511 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
512 #define ACPI_GSB_ACCESS_ATTRIB_BYTE             0x00000006
513 #define ACPI_GSB_ACCESS_ATTRIB_WORD             0x00000008
514 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK            0x0000000A
515 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE        0x0000000B
516 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL        0x0000000C
517 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL       0x0000000D
518 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES        0x0000000E
519 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS      0x0000000F
520
521 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
522                                              u32 *mask, u32 req);
523
524 /* Enable _OST when all relevant hotplug operations are enabled */
525 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
526         defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&          \
527         defined(CONFIG_ACPI_CONTAINER)
528 #define ACPI_HOTPLUG_OST
529 #endif
530
531 /* _OST Source Event Code (OSPM Action) */
532 #define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
533 #define ACPI_OST_EC_OSPM_EJECT                  0x103
534 #define ACPI_OST_EC_OSPM_INSERTION              0x200
535
536 /* _OST General Processing Status Code */
537 #define ACPI_OST_SC_SUCCESS                     0x0
538 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
539 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
540
541 /* _OST OS Shutdown Processing (0x100) Status Code */
542 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
543 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
544 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
545 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
546
547 /* _OST Ejection Request (0x3, 0x103) Status Code */
548 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
549 #define ACPI_OST_SC_DEVICE_IN_USE               0x81
550 #define ACPI_OST_SC_DEVICE_BUSY                 0x82
551 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
552 #define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
553
554 /* _OST Insertion Request (0x200) Status Code */
555 #define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
556 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
557 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
558
559 extern void acpi_early_init(void);
560 extern void acpi_subsystem_init(void);
561
562 extern int acpi_nvs_register(__u64 start, __u64 size);
563
564 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
565                                     void *data);
566
567 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
568                                                const struct device *dev);
569
570 extern bool acpi_driver_match_device(struct device *dev,
571                                      const struct device_driver *drv);
572 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
573 int acpi_device_modalias(struct device *, char *, int);
574 void acpi_walk_dep_device_list(acpi_handle handle);
575
576 struct platform_device *acpi_create_platform_device(struct acpi_device *,
577                                                     struct property_entry *);
578 #define ACPI_PTR(_ptr)  (_ptr)
579
580 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
581 {
582         adev->flags.visited = true;
583 }
584
585 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
586 {
587         adev->flags.visited = false;
588 }
589
590 enum acpi_reconfig_event  {
591         ACPI_RECONFIG_DEVICE_ADD = 0,
592         ACPI_RECONFIG_DEVICE_REMOVE,
593 };
594
595 int acpi_reconfig_notifier_register(struct notifier_block *nb);
596 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
597
598 #else   /* !CONFIG_ACPI */
599
600 #define acpi_disabled 1
601
602 #define ACPI_COMPANION(dev)             (NULL)
603 #define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
604 #define ACPI_HANDLE(dev)                (NULL)
605 #define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (0), .cls_msk = (0),
606
607 struct fwnode_handle;
608
609 static inline bool acpi_dev_found(const char *hid)
610 {
611         return false;
612 }
613
614 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
615 {
616         return false;
617 }
618
619 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
620 {
621         return false;
622 }
623
624 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
625 {
626         return NULL;
627 }
628
629 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
630 {
631         return false;
632 }
633
634 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
635 {
636         return NULL;
637 }
638
639 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
640                                         const char *name)
641 {
642         return false;
643 }
644
645 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
646 {
647         return NULL;
648 }
649
650 static inline bool has_acpi_companion(struct device *dev)
651 {
652         return false;
653 }
654
655 static inline void acpi_preset_companion(struct device *dev,
656                                          struct acpi_device *parent, u64 addr)
657 {
658 }
659
660 static inline const char *acpi_dev_name(struct acpi_device *adev)
661 {
662         return NULL;
663 }
664
665 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
666 {
667         return NULL;
668 }
669
670 static inline void acpi_early_init(void) { }
671 static inline void acpi_subsystem_init(void) { }
672
673 static inline int early_acpi_boot_init(void)
674 {
675         return 0;
676 }
677 static inline int acpi_boot_init(void)
678 {
679         return 0;
680 }
681
682 static inline void acpi_boot_table_init(void)
683 {
684         return;
685 }
686
687 static inline int acpi_mps_check(void)
688 {
689         return 0;
690 }
691
692 static inline int acpi_check_resource_conflict(struct resource *res)
693 {
694         return 0;
695 }
696
697 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
698                                     const char *name)
699 {
700         return 0;
701 }
702
703 struct acpi_table_header;
704 static inline int acpi_table_parse(char *id,
705                                 int (*handler)(struct acpi_table_header *))
706 {
707         return -ENODEV;
708 }
709
710 static inline int acpi_nvs_register(__u64 start, __u64 size)
711 {
712         return 0;
713 }
714
715 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
716                                            void *data)
717 {
718         return 0;
719 }
720
721 struct acpi_device_id;
722
723 static inline const struct acpi_device_id *acpi_match_device(
724         const struct acpi_device_id *ids, const struct device *dev)
725 {
726         return NULL;
727 }
728
729 static inline bool acpi_driver_match_device(struct device *dev,
730                                             const struct device_driver *drv)
731 {
732         return false;
733 }
734
735 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
736                                                    const u8 *uuid,
737                                                    int rev, int func,
738                                                    union acpi_object *argv4)
739 {
740         return NULL;
741 }
742
743 static inline int acpi_device_uevent_modalias(struct device *dev,
744                                 struct kobj_uevent_env *env)
745 {
746         return -ENODEV;
747 }
748
749 static inline int acpi_device_modalias(struct device *dev,
750                                 char *buf, int size)
751 {
752         return -ENODEV;
753 }
754
755 static inline bool acpi_dma_supported(struct acpi_device *adev)
756 {
757         return false;
758 }
759
760 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
761 {
762         return DEV_DMA_NOT_SUPPORTED;
763 }
764
765 static inline void acpi_dma_configure(struct device *dev,
766                                       enum dev_dma_attr attr) { }
767
768 static inline void acpi_dma_deconfigure(struct device *dev) { }
769
770 #define ACPI_PTR(_ptr)  (NULL)
771
772 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
773 {
774 }
775
776 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
777 {
778 }
779
780 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
781 {
782         return -EINVAL;
783 }
784
785 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
786 {
787         return -EINVAL;
788 }
789
790 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
791 {
792         return NULL;
793 }
794
795 #endif  /* !CONFIG_ACPI */
796
797 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
798 int acpi_ioapic_add(acpi_handle root);
799 #else
800 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
801 #endif
802
803 #ifdef CONFIG_ACPI
804 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
805                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
806
807 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
808                                   u32 pm1a_control, u32 pm1b_control);
809
810 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
811                                         u32 val_a,  u32 val_b));
812
813 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
814                                            u32 val_a, u32 val_b);
815
816 #ifdef CONFIG_X86
817 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
818 #else
819 static inline void arch_reserve_mem_area(acpi_physical_address addr,
820                                           size_t size)
821 {
822 }
823 #endif /* CONFIG_X86 */
824 #else
825 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
826 #endif
827
828 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
829 int acpi_dev_runtime_suspend(struct device *dev);
830 int acpi_dev_runtime_resume(struct device *dev);
831 int acpi_subsys_runtime_suspend(struct device *dev);
832 int acpi_subsys_runtime_resume(struct device *dev);
833 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
834 int acpi_dev_pm_attach(struct device *dev, bool power_on);
835 #else
836 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
837 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
838 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
839 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
840 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
841 {
842         return NULL;
843 }
844 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
845 {
846         return -ENODEV;
847 }
848 #endif
849
850 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
851 int acpi_dev_suspend_late(struct device *dev);
852 int acpi_dev_resume_early(struct device *dev);
853 int acpi_subsys_prepare(struct device *dev);
854 void acpi_subsys_complete(struct device *dev);
855 int acpi_subsys_suspend_late(struct device *dev);
856 int acpi_subsys_resume_early(struct device *dev);
857 int acpi_subsys_suspend(struct device *dev);
858 int acpi_subsys_freeze(struct device *dev);
859 #else
860 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
861 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
862 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
863 static inline void acpi_subsys_complete(struct device *dev) {}
864 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
865 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
866 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
867 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
868 #endif
869
870 #ifdef CONFIG_ACPI
871 __printf(3, 4)
872 void acpi_handle_printk(const char *level, acpi_handle handle,
873                         const char *fmt, ...);
874 #else   /* !CONFIG_ACPI */
875 static inline __printf(3, 4) void
876 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
877 #endif  /* !CONFIG_ACPI */
878
879 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
880 __printf(3, 4)
881 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
882 #else
883 #define __acpi_handle_debug(descriptor, handle, fmt, ...)               \
884         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
885 #endif
886
887 /*
888  * acpi_handle_<level>: Print message with ACPI prefix and object path
889  *
890  * These interfaces acquire the global namespace mutex to obtain an object
891  * path.  In interrupt context, it shows the object path as <n/a>.
892  */
893 #define acpi_handle_emerg(handle, fmt, ...)                             \
894         acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
895 #define acpi_handle_alert(handle, fmt, ...)                             \
896         acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
897 #define acpi_handle_crit(handle, fmt, ...)                              \
898         acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
899 #define acpi_handle_err(handle, fmt, ...)                               \
900         acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
901 #define acpi_handle_warn(handle, fmt, ...)                              \
902         acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
903 #define acpi_handle_notice(handle, fmt, ...)                            \
904         acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
905 #define acpi_handle_info(handle, fmt, ...)                              \
906         acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
907
908 #if defined(DEBUG)
909 #define acpi_handle_debug(handle, fmt, ...)                             \
910         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
911 #else
912 #if defined(CONFIG_DYNAMIC_DEBUG)
913 #define acpi_handle_debug(handle, fmt, ...)                             \
914 do {                                                                    \
915         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
916         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT))          \
917                 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt),   \
918                                 ##__VA_ARGS__);                         \
919 } while (0)
920 #else
921 #define acpi_handle_debug(handle, fmt, ...)                             \
922 ({                                                                      \
923         if (0)                                                          \
924                 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
925         0;                                                              \
926 })
927 #endif
928 #endif
929
930 struct acpi_gpio_params {
931         unsigned int crs_entry_index;
932         unsigned int line_index;
933         bool active_low;
934 };
935
936 struct acpi_gpio_mapping {
937         const char *name;
938         const struct acpi_gpio_params *data;
939         unsigned int size;
940 };
941
942 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
943 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
944                               const struct acpi_gpio_mapping *gpios);
945
946 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
947 {
948         if (adev)
949                 adev->driver_gpios = NULL;
950 }
951
952 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
953 #else
954 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
955                               const struct acpi_gpio_mapping *gpios)
956 {
957         return -ENXIO;
958 }
959 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
960
961 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
962 {
963         return -ENXIO;
964 }
965 #endif
966
967 /* Device properties */
968
969 #define MAX_ACPI_REFERENCE_ARGS 8
970 struct acpi_reference_args {
971         struct acpi_device *adev;
972         size_t nargs;
973         u64 args[MAX_ACPI_REFERENCE_ARGS];
974 };
975
976 #ifdef CONFIG_ACPI
977 int acpi_dev_get_property(struct acpi_device *adev, const char *name,
978                           acpi_object_type type, const union acpi_object **obj);
979 int __acpi_node_get_property_reference(struct fwnode_handle *fwnode,
980                                 const char *name, size_t index, size_t num_args,
981                                 struct acpi_reference_args *args);
982
983 static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
984                                 const char *name, size_t index,
985                                 struct acpi_reference_args *args)
986 {
987         return __acpi_node_get_property_reference(fwnode, name, index,
988                 MAX_ACPI_REFERENCE_ARGS, args);
989 }
990
991 int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
992                        void **valptr);
993 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
994                               enum dev_prop_type proptype, void *val);
995 int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
996                         enum dev_prop_type proptype, void *val, size_t nval);
997 int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
998                        enum dev_prop_type proptype, void *val, size_t nval);
999
1000 struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
1001                                             struct fwnode_handle *subnode);
1002
1003 struct acpi_probe_entry;
1004 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1005                                                  struct acpi_probe_entry *);
1006
1007 #define ACPI_TABLE_ID_LEN       5
1008
1009 /**
1010  * struct acpi_probe_entry - boot-time probing entry
1011  * @id:                 ACPI table name
1012  * @type:               Optional subtable type to match
1013  *                      (if @id contains subtables)
1014  * @subtable_valid:     Optional callback to check the validity of
1015  *                      the subtable
1016  * @probe_table:        Callback to the driver being probed when table
1017  *                      match is successful
1018  * @probe_subtbl:       Callback to the driver being probed when table and
1019  *                      subtable match (and optional callback is successful)
1020  * @driver_data:        Sideband data provided back to the driver
1021  */
1022 struct acpi_probe_entry {
1023         __u8 id[ACPI_TABLE_ID_LEN];
1024         __u8 type;
1025         acpi_probe_entry_validate_subtbl subtable_valid;
1026         union {
1027                 acpi_tbl_table_handler probe_table;
1028                 acpi_tbl_entry_handler probe_subtbl;
1029         };
1030         kernel_ulong_t driver_data;
1031 };
1032
1033 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn)      \
1034         static const struct acpi_probe_entry __acpi_probe_##name        \
1035                 __used __section(__##table##_acpi_probe_table)          \
1036                  = {                                                    \
1037                         .id = table_id,                                 \
1038                         .type = subtable,                               \
1039                         .subtable_valid = valid,                        \
1040                         .probe_table = (acpi_tbl_table_handler)fn,      \
1041                         .driver_data = data,                            \
1042                    }
1043
1044 #define ACPI_PROBE_TABLE(name)          __##name##_acpi_probe_table
1045 #define ACPI_PROBE_TABLE_END(name)      __##name##_acpi_probe_table_end
1046
1047 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1048
1049 #define acpi_probe_device_table(t)                                      \
1050         ({                                                              \
1051                 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),     \
1052                                                ACPI_PROBE_TABLE_END(t); \
1053                 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t),         \
1054                                           (&ACPI_PROBE_TABLE_END(t) -   \
1055                                            &ACPI_PROBE_TABLE(t)));      \
1056         })
1057 #else
1058 static inline int acpi_dev_get_property(struct acpi_device *adev,
1059                                         const char *name, acpi_object_type type,
1060                                         const union acpi_object **obj)
1061 {
1062         return -ENXIO;
1063 }
1064
1065 static inline int
1066 __acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1067                                 const char *name, size_t index, size_t num_args,
1068                                 struct acpi_reference_args *args)
1069 {
1070         return -ENXIO;
1071 }
1072
1073 static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1074                                 const char *name, size_t index,
1075                                 struct acpi_reference_args *args)
1076 {
1077         return -ENXIO;
1078 }
1079
1080 static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
1081                                      const char *propname,
1082                                      void **valptr)
1083 {
1084         return -ENXIO;
1085 }
1086
1087 static inline int acpi_dev_prop_get(struct acpi_device *adev,
1088                                     const char *propname,
1089                                     void **valptr)
1090 {
1091         return -ENXIO;
1092 }
1093
1094 static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
1095                                             const char *propname,
1096                                             enum dev_prop_type proptype,
1097                                             void *val)
1098 {
1099         return -ENXIO;
1100 }
1101
1102 static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
1103                                       const char *propname,
1104                                       enum dev_prop_type proptype,
1105                                       void *val, size_t nval)
1106 {
1107         return -ENXIO;
1108 }
1109
1110 static inline int acpi_dev_prop_read(struct acpi_device *adev,
1111                                      const char *propname,
1112                                      enum dev_prop_type proptype,
1113                                      void *val, size_t nval)
1114 {
1115         return -ENXIO;
1116 }
1117
1118 static inline struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
1119                                                 struct fwnode_handle *subnode)
1120 {
1121         return NULL;
1122 }
1123
1124 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1125         static const void * __acpi_table_##name[]                       \
1126                 __attribute__((unused))                                 \
1127                  = { (void *) table_id,                                 \
1128                      (void *) subtable,                                 \
1129                      (void *) valid,                                    \
1130                      (void *) fn,                                       \
1131                      (void *) data }
1132
1133 #define acpi_probe_device_table(t)      ({ int __r = 0; __r;})
1134 #endif
1135
1136 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1137 void acpi_table_upgrade(void);
1138 #else
1139 static inline void acpi_table_upgrade(void) { }
1140 #endif
1141
1142 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1143 extern bool acpi_has_watchdog(void);
1144 #else
1145 static inline bool acpi_has_watchdog(void) { return false; }
1146 #endif
1147
1148 #ifdef CONFIG_ACPI_SPCR_TABLE
1149 int parse_spcr(bool earlycon);
1150 #else
1151 static inline int parse_spcr(bool earlycon) { return 0; }
1152 #endif
1153
1154 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1155 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1156 #else
1157 static inline
1158 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1159 {
1160         return -EINVAL;
1161 }
1162 #endif
1163
1164 #endif  /*_LINUX_ACPI_H*/