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