Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / include / linux / acpi.h
blob968173ec2726d64367d18d88558975833366bc5b
1 /*
2 * acpi.h - ACPI Interface
4 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21 #ifndef _LINUX_ACPI_H
22 #define _LINUX_ACPI_H
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 #include <linux/uuid.h>
31 #ifndef _LINUX
32 #define _LINUX
33 #endif
34 #include <acpi/acpi.h>
36 #ifdef CONFIG_ACPI
38 #include <linux/list.h>
39 #include <linux/mod_devicetable.h>
40 #include <linux/dynamic_debug.h>
41 #include <linux/module.h>
42 #include <linux/mutex.h>
44 #include <acpi/acpi_bus.h>
45 #include <acpi/acpi_drivers.h>
46 #include <acpi/acpi_numa.h>
47 #include <acpi/acpi_io.h>
48 #include <asm/acpi.h>
50 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
52 return adev ? adev->handle : NULL;
55 #define ACPI_COMPANION(dev) to_acpi_device_node((dev)->fwnode)
56 #define ACPI_COMPANION_SET(dev, adev) set_primary_fwnode(dev, (adev) ? \
57 acpi_fwnode_handle(adev) : NULL)
58 #define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
59 #define ACPI_HANDLE_FWNODE(fwnode) \
60 acpi_device_handle(to_acpi_device_node(fwnode))
62 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
64 struct fwnode_handle *fwnode;
66 fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
67 if (!fwnode)
68 return NULL;
70 fwnode->ops = &acpi_static_fwnode_ops;
72 return fwnode;
75 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
77 if (WARN_ON(!is_acpi_static_node(fwnode)))
78 return;
80 kfree(fwnode);
83 /**
84 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
85 * the PCI-defined class-code information
87 * @_cls : the class, subclass, prog-if triple for this device
88 * @_msk : the class mask for this device
90 * This macro is used to create a struct acpi_device_id that matches a
91 * specific PCI class. The .id and .driver_data fields will be left
92 * initialized with the default value.
94 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
96 static inline bool has_acpi_companion(struct device *dev)
98 return is_acpi_device_node(dev->fwnode);
101 static inline void acpi_preset_companion(struct device *dev,
102 struct acpi_device *parent, u64 addr)
104 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
107 static inline const char *acpi_dev_name(struct acpi_device *adev)
109 return dev_name(&adev->dev);
112 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
114 enum acpi_irq_model_id {
115 ACPI_IRQ_MODEL_PIC = 0,
116 ACPI_IRQ_MODEL_IOAPIC,
117 ACPI_IRQ_MODEL_IOSAPIC,
118 ACPI_IRQ_MODEL_PLATFORM,
119 ACPI_IRQ_MODEL_GIC,
120 ACPI_IRQ_MODEL_COUNT
123 extern enum acpi_irq_model_id acpi_irq_model;
125 enum acpi_interrupt_id {
126 ACPI_INTERRUPT_PMI = 1,
127 ACPI_INTERRUPT_INIT,
128 ACPI_INTERRUPT_CPEI,
129 ACPI_INTERRUPT_COUNT
132 #define ACPI_SPACE_MEM 0
134 enum acpi_address_range_id {
135 ACPI_ADDRESS_RANGE_MEMORY = 1,
136 ACPI_ADDRESS_RANGE_RESERVED = 2,
137 ACPI_ADDRESS_RANGE_ACPI = 3,
138 ACPI_ADDRESS_RANGE_NVS = 4,
139 ACPI_ADDRESS_RANGE_COUNT
143 /* Table Handlers */
145 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
147 typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
148 const unsigned long end);
150 /* Debugger support */
152 struct acpi_debugger_ops {
153 int (*create_thread)(acpi_osd_exec_callback function, void *context);
154 ssize_t (*write_log)(const char *msg);
155 ssize_t (*read_cmd)(char *buffer, size_t length);
156 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
157 int (*notify_command_complete)(void);
160 struct acpi_debugger {
161 const struct acpi_debugger_ops *ops;
162 struct module *owner;
163 struct mutex lock;
166 #ifdef CONFIG_ACPI_DEBUGGER
167 int __init acpi_debugger_init(void);
168 int acpi_register_debugger(struct module *owner,
169 const struct acpi_debugger_ops *ops);
170 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
171 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
172 ssize_t acpi_debugger_write_log(const char *msg);
173 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
174 int acpi_debugger_wait_command_ready(void);
175 int acpi_debugger_notify_command_complete(void);
176 #else
177 static inline int acpi_debugger_init(void)
179 return -ENODEV;
182 static inline int acpi_register_debugger(struct module *owner,
183 const struct acpi_debugger_ops *ops)
185 return -ENODEV;
188 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
192 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
193 void *context)
195 return -ENODEV;
198 static inline int acpi_debugger_write_log(const char *msg)
200 return -ENODEV;
203 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
205 return -ENODEV;
208 static inline int acpi_debugger_wait_command_ready(void)
210 return -ENODEV;
213 static inline int acpi_debugger_notify_command_complete(void)
215 return -ENODEV;
217 #endif
219 #define BAD_MADT_ENTRY(entry, end) ( \
220 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
221 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
223 struct acpi_subtable_proc {
224 int id;
225 acpi_tbl_entry_handler handler;
226 int count;
229 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
230 void __acpi_unmap_table(void __iomem *map, unsigned long size);
231 int early_acpi_boot_init(void);
232 int acpi_boot_init (void);
233 void acpi_boot_table_init (void);
234 int acpi_mps_check (void);
235 int acpi_numa_init (void);
237 int acpi_table_init (void);
238 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
239 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
240 int entry_id,
241 acpi_tbl_entry_handler handler,
242 unsigned int max_entries);
243 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
244 struct acpi_subtable_proc *proc, int proc_num,
245 unsigned int max_entries);
246 int acpi_table_parse_madt(enum acpi_madt_type id,
247 acpi_tbl_entry_handler handler,
248 unsigned int max_entries);
249 int acpi_parse_mcfg (struct acpi_table_header *header);
250 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
252 /* the following numa functions are architecture-dependent */
253 void acpi_numa_slit_init (struct acpi_table_slit *slit);
255 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
256 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
257 #else
258 static inline void
259 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
260 #endif
262 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
264 #ifdef CONFIG_ARM64
265 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
266 #else
267 static inline void
268 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
269 #endif
271 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
273 #ifndef PHYS_CPUID_INVALID
274 typedef u32 phys_cpuid_t;
275 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
276 #endif
278 static inline bool invalid_logical_cpuid(u32 cpuid)
280 return (int)cpuid < 0;
283 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
285 return phys_id == PHYS_CPUID_INVALID;
288 /* Validate the processor object's proc_id */
289 bool acpi_duplicate_processor_id(int proc_id);
291 #ifdef CONFIG_ACPI_HOTPLUG_CPU
292 /* Arch dependent functions for cpu hotplug support */
293 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
294 int *pcpu);
295 int acpi_unmap_cpu(int cpu);
296 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
298 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
299 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
300 #endif
302 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
303 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
304 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
305 void acpi_irq_stats_init(void);
306 extern u32 acpi_irq_handled;
307 extern u32 acpi_irq_not_handled;
308 extern unsigned int acpi_sci_irq;
309 extern bool acpi_no_s5;
310 #define INVALID_ACPI_IRQ ((unsigned)-1)
311 static inline bool acpi_sci_irq_valid(void)
313 return acpi_sci_irq != INVALID_ACPI_IRQ;
316 extern int sbf_port;
317 extern unsigned long acpi_realmode_flags;
319 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
320 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
321 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
323 void acpi_set_irq_model(enum acpi_irq_model_id model,
324 struct fwnode_handle *fwnode);
326 #ifdef CONFIG_X86_IO_APIC
327 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
328 #else
329 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
330 #endif
332 * This function undoes the effect of one call to acpi_register_gsi().
333 * If this matches the last registration, any IRQ resources for gsi
334 * are freed.
336 void acpi_unregister_gsi (u32 gsi);
338 struct pci_dev;
340 int acpi_pci_irq_enable (struct pci_dev *dev);
341 void acpi_penalize_isa_irq(int irq, int active);
342 bool acpi_isa_irq_available(int irq);
343 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
344 void acpi_pci_irq_disable (struct pci_dev *dev);
346 extern int ec_read(u8 addr, u8 *val);
347 extern int ec_write(u8 addr, u8 val);
348 extern int ec_transaction(u8 command,
349 const u8 *wdata, unsigned wdata_len,
350 u8 *rdata, unsigned rdata_len);
351 extern acpi_handle ec_get_handle(void);
353 extern bool acpi_is_pnp_device(struct acpi_device *);
355 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
357 typedef void (*wmi_notify_handler) (u32 value, void *context);
359 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
360 u32 method_id,
361 const struct acpi_buffer *in,
362 struct acpi_buffer *out);
363 extern acpi_status wmi_query_block(const char *guid, u8 instance,
364 struct acpi_buffer *out);
365 extern acpi_status wmi_set_block(const char *guid, u8 instance,
366 const struct acpi_buffer *in);
367 extern acpi_status wmi_install_notify_handler(const char *guid,
368 wmi_notify_handler handler, void *data);
369 extern acpi_status wmi_remove_notify_handler(const char *guid);
370 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
371 extern bool wmi_has_guid(const char *guid);
373 #endif /* CONFIG_ACPI_WMI */
375 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
376 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
377 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
378 #define ACPI_VIDEO_BACKLIGHT 0x0008
379 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
380 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
381 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
382 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
383 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
384 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
385 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
386 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
388 extern char acpi_video_backlight_string[];
389 extern long acpi_is_video_device(acpi_handle handle);
390 extern int acpi_blacklisted(void);
391 extern void acpi_osi_setup(char *str);
392 extern bool acpi_osi_is_win8(void);
394 #ifdef CONFIG_ACPI_NUMA
395 int acpi_map_pxm_to_online_node(int pxm);
396 int acpi_get_node(acpi_handle handle);
397 #else
398 static inline int acpi_map_pxm_to_online_node(int pxm)
400 return 0;
402 static inline int acpi_get_node(acpi_handle handle)
404 return 0;
406 #endif
407 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
409 extern int pnpacpi_disabled;
411 #define PXM_INVAL (-1)
413 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
414 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
415 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
416 struct resource_win *win);
417 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
418 struct resource_win *win);
419 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
420 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
421 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
422 struct resource *res);
424 void acpi_dev_free_resource_list(struct list_head *list);
425 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
426 int (*preproc)(struct acpi_resource *, void *),
427 void *preproc_data);
428 int acpi_dev_get_dma_resources(struct acpi_device *adev,
429 struct list_head *list);
430 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
431 unsigned long types);
433 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
434 void *arg)
436 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
439 struct acpi_device *acpi_resource_consumer(struct resource *res);
441 int acpi_check_resource_conflict(const struct resource *res);
443 int acpi_check_region(resource_size_t start, resource_size_t n,
444 const char *name);
446 int acpi_resources_are_enforced(void);
448 #ifdef CONFIG_HIBERNATION
449 void __init acpi_no_s4_hw_signature(void);
450 #endif
452 #ifdef CONFIG_PM_SLEEP
453 void __init acpi_old_suspend_ordering(void);
454 void __init acpi_nvs_nosave(void);
455 void __init acpi_nvs_nosave_s3(void);
456 void __init acpi_sleep_no_blacklist(void);
457 #endif /* CONFIG_PM_SLEEP */
459 struct acpi_osc_context {
460 char *uuid_str; /* UUID string */
461 int rev;
462 struct acpi_buffer cap; /* list of DWORD capabilities */
463 struct acpi_buffer ret; /* free by caller if success */
466 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
468 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
469 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
470 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
471 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
473 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
474 #define OSC_QUERY_ENABLE 0x00000001 /* input */
475 #define OSC_REQUEST_ERROR 0x00000002 /* return */
476 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
477 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
478 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
480 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
481 #define OSC_SB_PAD_SUPPORT 0x00000001
482 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
483 #define OSC_SB_PR3_SUPPORT 0x00000004
484 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
485 #define OSC_SB_APEI_SUPPORT 0x00000010
486 #define OSC_SB_CPC_SUPPORT 0x00000020
487 #define OSC_SB_CPCV2_SUPPORT 0x00000040
488 #define OSC_SB_PCLPI_SUPPORT 0x00000080
489 #define OSC_SB_OSLPI_SUPPORT 0x00000100
490 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
492 extern bool osc_sb_apei_support_acked;
493 extern bool osc_pc_lpi_support_confirmed;
495 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
496 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
497 #define OSC_PCI_ASPM_SUPPORT 0x00000002
498 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
499 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
500 #define OSC_PCI_MSI_SUPPORT 0x00000010
501 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
503 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
504 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
505 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
506 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
507 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
508 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
509 #define OSC_PCI_CONTROL_MASKS 0x0000001f
511 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
512 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
513 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
514 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
515 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
516 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
517 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
518 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
519 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
520 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
522 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
523 u32 *mask, u32 req);
525 /* Enable _OST when all relevant hotplug operations are enabled */
526 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
527 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
528 defined(CONFIG_ACPI_CONTAINER)
529 #define ACPI_HOTPLUG_OST
530 #endif
532 /* _OST Source Event Code (OSPM Action) */
533 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
534 #define ACPI_OST_EC_OSPM_EJECT 0x103
535 #define ACPI_OST_EC_OSPM_INSERTION 0x200
537 /* _OST General Processing Status Code */
538 #define ACPI_OST_SC_SUCCESS 0x0
539 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
540 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
542 /* _OST OS Shutdown Processing (0x100) Status Code */
543 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
544 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
545 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
546 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
548 /* _OST Ejection Request (0x3, 0x103) Status Code */
549 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
550 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
551 #define ACPI_OST_SC_DEVICE_BUSY 0x82
552 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
553 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
555 /* _OST Insertion Request (0x200) Status Code */
556 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
557 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
558 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
560 enum acpi_predicate {
561 all_versions,
562 less_than_or_equal,
563 equal,
564 greater_than_or_equal,
567 /* Table must be terminted by a NULL entry */
568 struct acpi_platform_list {
569 char oem_id[ACPI_OEM_ID_SIZE+1];
570 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
571 u32 oem_revision;
572 char *table;
573 enum acpi_predicate pred;
574 char *reason;
575 u32 data;
577 int acpi_match_platform_list(const struct acpi_platform_list *plat);
579 extern void acpi_early_init(void);
580 extern void acpi_subsystem_init(void);
582 extern int acpi_nvs_register(__u64 start, __u64 size);
584 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
585 void *data);
587 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
588 const struct device *dev);
590 const void *acpi_device_get_match_data(const struct device *dev);
591 extern bool acpi_driver_match_device(struct device *dev,
592 const struct device_driver *drv);
593 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
594 int acpi_device_modalias(struct device *, char *, int);
595 void acpi_walk_dep_device_list(acpi_handle handle);
597 struct platform_device *acpi_create_platform_device(struct acpi_device *,
598 struct property_entry *);
599 #define ACPI_PTR(_ptr) (_ptr)
601 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
603 adev->flags.visited = true;
606 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
608 adev->flags.visited = false;
611 enum acpi_reconfig_event {
612 ACPI_RECONFIG_DEVICE_ADD = 0,
613 ACPI_RECONFIG_DEVICE_REMOVE,
616 int acpi_reconfig_notifier_register(struct notifier_block *nb);
617 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
619 #ifdef CONFIG_ACPI_GTDT
620 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
621 int acpi_gtdt_map_ppi(int type);
622 bool acpi_gtdt_c3stop(int type);
623 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
624 #endif
626 #else /* !CONFIG_ACPI */
628 #define acpi_disabled 1
630 #define ACPI_COMPANION(dev) (NULL)
631 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
632 #define ACPI_HANDLE(dev) (NULL)
633 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
634 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
636 struct fwnode_handle;
638 static inline bool acpi_dev_found(const char *hid)
640 return false;
643 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
645 return false;
648 static inline const char *
649 acpi_dev_get_first_match_name(const char *hid, const char *uid, s64 hrv)
651 return NULL;
654 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
656 return false;
659 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
661 return false;
664 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
666 return NULL;
669 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
671 return false;
674 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
676 return NULL;
679 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
680 const char *name)
682 return false;
685 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
687 return NULL;
690 static inline bool has_acpi_companion(struct device *dev)
692 return false;
695 static inline void acpi_preset_companion(struct device *dev,
696 struct acpi_device *parent, u64 addr)
700 static inline const char *acpi_dev_name(struct acpi_device *adev)
702 return NULL;
705 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
707 return NULL;
710 static inline void acpi_early_init(void) { }
711 static inline void acpi_subsystem_init(void) { }
713 static inline int early_acpi_boot_init(void)
715 return 0;
717 static inline int acpi_boot_init(void)
719 return 0;
722 static inline void acpi_boot_table_init(void)
724 return;
727 static inline int acpi_mps_check(void)
729 return 0;
732 static inline int acpi_check_resource_conflict(struct resource *res)
734 return 0;
737 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
738 const char *name)
740 return 0;
743 struct acpi_table_header;
744 static inline int acpi_table_parse(char *id,
745 int (*handler)(struct acpi_table_header *))
747 return -ENODEV;
750 static inline int acpi_nvs_register(__u64 start, __u64 size)
752 return 0;
755 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
756 void *data)
758 return 0;
761 struct acpi_device_id;
763 static inline const struct acpi_device_id *acpi_match_device(
764 const struct acpi_device_id *ids, const struct device *dev)
766 return NULL;
769 static inline const void *acpi_device_get_match_data(const struct device *dev)
771 return NULL;
774 static inline bool acpi_driver_match_device(struct device *dev,
775 const struct device_driver *drv)
777 return false;
780 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
781 const guid_t *guid,
782 int rev, int func,
783 union acpi_object *argv4)
785 return NULL;
788 static inline int acpi_device_uevent_modalias(struct device *dev,
789 struct kobj_uevent_env *env)
791 return -ENODEV;
794 static inline int acpi_device_modalias(struct device *dev,
795 char *buf, int size)
797 return -ENODEV;
800 static inline bool acpi_dma_supported(struct acpi_device *adev)
802 return false;
805 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
807 return DEV_DMA_NOT_SUPPORTED;
810 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
811 u64 *offset, u64 *size)
813 return -ENODEV;
816 static inline int acpi_dma_configure(struct device *dev,
817 enum dev_dma_attr attr)
819 return 0;
822 static inline void acpi_dma_deconfigure(struct device *dev) { }
824 #define ACPI_PTR(_ptr) (NULL)
826 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
830 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
834 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
836 return -EINVAL;
839 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
841 return -EINVAL;
844 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
846 return NULL;
849 #endif /* !CONFIG_ACPI */
851 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
852 int acpi_ioapic_add(acpi_handle root);
853 #else
854 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
855 #endif
857 #ifdef CONFIG_ACPI
858 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
859 u32 pm1a_ctrl, u32 pm1b_ctrl));
861 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
862 u32 pm1a_control, u32 pm1b_control);
864 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
865 u32 val_a, u32 val_b));
867 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
868 u32 val_a, u32 val_b);
870 #ifdef CONFIG_X86
871 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
872 #else
873 static inline void arch_reserve_mem_area(acpi_physical_address addr,
874 size_t size)
877 #endif /* CONFIG_X86 */
878 #else
879 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
880 #endif
882 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
883 int acpi_dev_suspend(struct device *dev, bool wakeup);
884 int acpi_dev_resume(struct device *dev);
885 int acpi_subsys_runtime_suspend(struct device *dev);
886 int acpi_subsys_runtime_resume(struct device *dev);
887 int acpi_dev_pm_attach(struct device *dev, bool power_on);
888 #else
889 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
890 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
891 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
892 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
893 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
895 return -ENODEV;
897 #endif
899 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
900 int acpi_dev_suspend_late(struct device *dev);
901 int acpi_subsys_prepare(struct device *dev);
902 void acpi_subsys_complete(struct device *dev);
903 int acpi_subsys_suspend_late(struct device *dev);
904 int acpi_subsys_suspend_noirq(struct device *dev);
905 int acpi_subsys_resume_noirq(struct device *dev);
906 int acpi_subsys_resume_early(struct device *dev);
907 int acpi_subsys_suspend(struct device *dev);
908 int acpi_subsys_freeze(struct device *dev);
909 int acpi_subsys_freeze_late(struct device *dev);
910 int acpi_subsys_freeze_noirq(struct device *dev);
911 int acpi_subsys_thaw_noirq(struct device *dev);
912 #else
913 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
914 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
915 static inline void acpi_subsys_complete(struct device *dev) {}
916 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
917 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
918 static inline int acpi_subsys_resume_noirq(struct device *dev) { return 0; }
919 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
920 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
921 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
922 static inline int acpi_subsys_freeze_late(struct device *dev) { return 0; }
923 static inline int acpi_subsys_freeze_noirq(struct device *dev) { return 0; }
924 static inline int acpi_subsys_thaw_noirq(struct device *dev) { return 0; }
925 #endif
927 #ifdef CONFIG_ACPI
928 __printf(3, 4)
929 void acpi_handle_printk(const char *level, acpi_handle handle,
930 const char *fmt, ...);
931 #else /* !CONFIG_ACPI */
932 static inline __printf(3, 4) void
933 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
934 #endif /* !CONFIG_ACPI */
936 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
937 __printf(3, 4)
938 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
939 #else
940 #define __acpi_handle_debug(descriptor, handle, fmt, ...) \
941 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
942 #endif
945 * acpi_handle_<level>: Print message with ACPI prefix and object path
947 * These interfaces acquire the global namespace mutex to obtain an object
948 * path. In interrupt context, it shows the object path as <n/a>.
950 #define acpi_handle_emerg(handle, fmt, ...) \
951 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
952 #define acpi_handle_alert(handle, fmt, ...) \
953 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
954 #define acpi_handle_crit(handle, fmt, ...) \
955 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
956 #define acpi_handle_err(handle, fmt, ...) \
957 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
958 #define acpi_handle_warn(handle, fmt, ...) \
959 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
960 #define acpi_handle_notice(handle, fmt, ...) \
961 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
962 #define acpi_handle_info(handle, fmt, ...) \
963 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
965 #if defined(DEBUG)
966 #define acpi_handle_debug(handle, fmt, ...) \
967 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
968 #else
969 #if defined(CONFIG_DYNAMIC_DEBUG)
970 #define acpi_handle_debug(handle, fmt, ...) \
971 do { \
972 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
973 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
974 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt), \
975 ##__VA_ARGS__); \
976 } while (0)
977 #else
978 #define acpi_handle_debug(handle, fmt, ...) \
979 ({ \
980 if (0) \
981 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
982 0; \
984 #endif
985 #endif
987 struct acpi_gpio_params {
988 unsigned int crs_entry_index;
989 unsigned int line_index;
990 bool active_low;
993 struct acpi_gpio_mapping {
994 const char *name;
995 const struct acpi_gpio_params *data;
996 unsigned int size;
998 /* Ignore IoRestriction field */
999 #define ACPI_GPIO_QUIRK_NO_IO_RESTRICTION BIT(0)
1001 unsigned int quirks;
1004 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1005 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1006 const struct acpi_gpio_mapping *gpios);
1008 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
1010 if (adev)
1011 adev->driver_gpios = NULL;
1014 int devm_acpi_dev_add_driver_gpios(struct device *dev,
1015 const struct acpi_gpio_mapping *gpios);
1016 void devm_acpi_dev_remove_driver_gpios(struct device *dev);
1018 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1019 struct acpi_resource_gpio **agpio);
1020 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
1021 #else
1022 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1023 const struct acpi_gpio_mapping *gpios)
1025 return -ENXIO;
1027 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
1029 static inline int devm_acpi_dev_add_driver_gpios(struct device *dev,
1030 const struct acpi_gpio_mapping *gpios)
1032 return -ENXIO;
1034 static inline void devm_acpi_dev_remove_driver_gpios(struct device *dev) {}
1036 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1037 struct acpi_resource_gpio **agpio)
1039 return false;
1041 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1043 return -ENXIO;
1045 #endif
1047 /* Device properties */
1049 #define MAX_ACPI_REFERENCE_ARGS 8
1050 struct acpi_reference_args {
1051 struct acpi_device *adev;
1052 size_t nargs;
1053 u64 args[MAX_ACPI_REFERENCE_ARGS];
1056 #ifdef CONFIG_ACPI
1057 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1058 acpi_object_type type, const union acpi_object **obj);
1059 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1060 const char *name, size_t index, size_t num_args,
1061 struct acpi_reference_args *args);
1063 static inline int acpi_node_get_property_reference(
1064 const struct fwnode_handle *fwnode,
1065 const char *name, size_t index,
1066 struct acpi_reference_args *args)
1068 return __acpi_node_get_property_reference(fwnode, name, index,
1069 MAX_ACPI_REFERENCE_ARGS, args);
1072 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1073 void **valptr);
1074 int acpi_dev_prop_read_single(struct acpi_device *adev,
1075 const char *propname, enum dev_prop_type proptype,
1076 void *val);
1077 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1078 const char *propname, enum dev_prop_type proptype,
1079 void *val, size_t nval);
1080 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
1081 enum dev_prop_type proptype, void *val, size_t nval);
1083 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1084 struct fwnode_handle *child);
1085 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
1087 struct fwnode_handle *
1088 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1089 struct fwnode_handle *prev);
1090 int acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1091 struct fwnode_handle **remote,
1092 struct fwnode_handle **port,
1093 struct fwnode_handle **endpoint);
1095 struct acpi_probe_entry;
1096 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1097 struct acpi_probe_entry *);
1099 #define ACPI_TABLE_ID_LEN 5
1102 * struct acpi_probe_entry - boot-time probing entry
1103 * @id: ACPI table name
1104 * @type: Optional subtable type to match
1105 * (if @id contains subtables)
1106 * @subtable_valid: Optional callback to check the validity of
1107 * the subtable
1108 * @probe_table: Callback to the driver being probed when table
1109 * match is successful
1110 * @probe_subtbl: Callback to the driver being probed when table and
1111 * subtable match (and optional callback is successful)
1112 * @driver_data: Sideband data provided back to the driver
1114 struct acpi_probe_entry {
1115 __u8 id[ACPI_TABLE_ID_LEN];
1116 __u8 type;
1117 acpi_probe_entry_validate_subtbl subtable_valid;
1118 union {
1119 acpi_tbl_table_handler probe_table;
1120 acpi_tbl_entry_handler probe_subtbl;
1122 kernel_ulong_t driver_data;
1125 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1126 static const struct acpi_probe_entry __acpi_probe_##name \
1127 __used __section(__##table##_acpi_probe_table) \
1128 = { \
1129 .id = table_id, \
1130 .type = subtable, \
1131 .subtable_valid = valid, \
1132 .probe_table = (acpi_tbl_table_handler)fn, \
1133 .driver_data = data, \
1136 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1137 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1139 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1141 #define acpi_probe_device_table(t) \
1142 ({ \
1143 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1144 ACPI_PROBE_TABLE_END(t); \
1145 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1146 (&ACPI_PROBE_TABLE_END(t) - \
1147 &ACPI_PROBE_TABLE(t))); \
1149 #else
1150 static inline int acpi_dev_get_property(struct acpi_device *adev,
1151 const char *name, acpi_object_type type,
1152 const union acpi_object **obj)
1154 return -ENXIO;
1157 static inline int
1158 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1159 const char *name, size_t index, size_t num_args,
1160 struct acpi_reference_args *args)
1162 return -ENXIO;
1165 static inline int
1166 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1167 const char *name, size_t index,
1168 struct acpi_reference_args *args)
1170 return -ENXIO;
1173 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1174 const char *propname,
1175 void **valptr)
1177 return -ENXIO;
1180 static inline int acpi_dev_prop_get(const struct acpi_device *adev,
1181 const char *propname,
1182 void **valptr)
1184 return -ENXIO;
1187 static inline int acpi_dev_prop_read_single(const struct acpi_device *adev,
1188 const char *propname,
1189 enum dev_prop_type proptype,
1190 void *val)
1192 return -ENXIO;
1195 static inline int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1196 const char *propname,
1197 enum dev_prop_type proptype,
1198 void *val, size_t nval)
1200 return -ENXIO;
1203 static inline int acpi_dev_prop_read(const struct acpi_device *adev,
1204 const char *propname,
1205 enum dev_prop_type proptype,
1206 void *val, size_t nval)
1208 return -ENXIO;
1211 static inline struct fwnode_handle *
1212 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1213 struct fwnode_handle *child)
1215 return NULL;
1218 static inline struct fwnode_handle *
1219 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1221 return NULL;
1224 static inline struct fwnode_handle *
1225 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1226 struct fwnode_handle *prev)
1228 return ERR_PTR(-ENXIO);
1231 static inline int
1232 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1233 struct fwnode_handle **remote,
1234 struct fwnode_handle **port,
1235 struct fwnode_handle **endpoint)
1237 return -ENXIO;
1240 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1241 static const void * __acpi_table_##name[] \
1242 __attribute__((unused)) \
1243 = { (void *) table_id, \
1244 (void *) subtable, \
1245 (void *) valid, \
1246 (void *) fn, \
1247 (void *) data }
1249 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1250 #endif
1252 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1253 void acpi_table_upgrade(void);
1254 #else
1255 static inline void acpi_table_upgrade(void) { }
1256 #endif
1258 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1259 extern bool acpi_has_watchdog(void);
1260 #else
1261 static inline bool acpi_has_watchdog(void) { return false; }
1262 #endif
1264 #ifdef CONFIG_ACPI_SPCR_TABLE
1265 extern bool qdf2400_e44_present;
1266 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1267 #else
1268 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1270 return 0;
1272 #endif
1274 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1275 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1276 #else
1277 static inline
1278 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1280 return -EINVAL;
1282 #endif
1284 #ifdef CONFIG_ACPI_LPIT
1285 int lpit_read_residency_count_address(u64 *address);
1286 #else
1287 static inline int lpit_read_residency_count_address(u64 *address)
1289 return -EINVAL;
1291 #endif
1293 #endif /*_LINUX_ACPI_H*/