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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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>
34 #include <acpi/acpi.h>
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>
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);
70 fwnode->ops = &acpi_static_fwnode_ops;
75 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
77 if (WARN_ON(!is_acpi_static_node(fwnode)))
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, false));
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,
123 extern enum acpi_irq_model_id acpi_irq_model;
125 enum acpi_interrupt_id {
126 ACPI_INTERRUPT_PMI = 1,
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
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;
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);
177 static inline int acpi_debugger_init(void)
182 static inline int acpi_register_debugger(struct module *owner,
183 const struct acpi_debugger_ops *ops)
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,
198 static inline int acpi_debugger_write_log(const char *msg)
203 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
208 static inline int acpi_debugger_wait_command_ready(void)
213 static inline int acpi_debugger_notify_command_complete(void)
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 {
225 acpi_tbl_entry_handler handler;
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,
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);
259 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
262 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
265 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
268 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
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)
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,
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);
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;
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);
329 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
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
336 void acpi_unregister_gsi (u32 gsi);
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);
344 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
346 static inline void acpi_penalize_sci_irq(int irq, int trigger,
351 void acpi_pci_irq_disable (struct pci_dev *dev);
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);
360 extern bool acpi_is_pnp_device(struct acpi_device *);
362 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
364 typedef void (*wmi_notify_handler) (u32 value, void *context);
366 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
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);
380 #endif /* CONFIG_ACPI_WMI */
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
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);
401 #ifdef CONFIG_ACPI_NUMA
402 int acpi_map_pxm_to_online_node(int pxm);
403 int acpi_get_node(acpi_handle handle);
405 static inline int acpi_map_pxm_to_online_node(int pxm)
409 static inline int acpi_get_node(acpi_handle handle)
414 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
416 extern int pnpacpi_disabled;
418 #define PXM_INVAL (-1)
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);
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 *),
435 int acpi_dev_get_dma_resources(struct acpi_device *adev,
436 struct list_head *list);
437 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
438 unsigned long types);
440 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
443 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
446 struct acpi_device *acpi_resource_consumer(struct resource *res);
448 int acpi_check_resource_conflict(const struct resource *res);
450 int acpi_check_region(resource_size_t start, resource_size_t n,
453 acpi_status acpi_release_memory(acpi_handle handle, struct resource *res,
456 int acpi_resources_are_enforced(void);
458 #ifdef CONFIG_HIBERNATION
459 void __init acpi_no_s4_hw_signature(void);
462 #ifdef CONFIG_PM_SLEEP
463 void __init acpi_old_suspend_ordering(void);
464 void __init acpi_nvs_nosave(void);
465 void __init acpi_nvs_nosave_s3(void);
466 void __init acpi_sleep_no_blacklist(void);
467 #endif /* CONFIG_PM_SLEEP */
469 struct acpi_osc_context {
470 char *uuid_str; /* UUID string */
472 struct acpi_buffer cap; /* list of DWORD capabilities */
473 struct acpi_buffer ret; /* free by caller if success */
476 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
478 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
479 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
480 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
481 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
483 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
484 #define OSC_QUERY_ENABLE 0x00000001 /* input */
485 #define OSC_REQUEST_ERROR 0x00000002 /* return */
486 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
487 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
488 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
490 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
491 #define OSC_SB_PAD_SUPPORT 0x00000001
492 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
493 #define OSC_SB_PR3_SUPPORT 0x00000004
494 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
495 #define OSC_SB_APEI_SUPPORT 0x00000010
496 #define OSC_SB_CPC_SUPPORT 0x00000020
497 #define OSC_SB_CPCV2_SUPPORT 0x00000040
498 #define OSC_SB_PCLPI_SUPPORT 0x00000080
499 #define OSC_SB_OSLPI_SUPPORT 0x00000100
500 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
502 extern bool osc_sb_apei_support_acked;
503 extern bool osc_pc_lpi_support_confirmed;
505 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
506 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
507 #define OSC_PCI_ASPM_SUPPORT 0x00000002
508 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
509 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
510 #define OSC_PCI_MSI_SUPPORT 0x00000010
511 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
513 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
514 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
515 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
516 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
517 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
518 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
519 #define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
520 #define OSC_PCI_CONTROL_MASKS 0x0000003f
522 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
523 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
524 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
525 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
526 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
527 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
528 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
529 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
530 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
531 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
533 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
536 /* Enable _OST when all relevant hotplug operations are enabled */
537 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
538 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
539 defined(CONFIG_ACPI_CONTAINER)
540 #define ACPI_HOTPLUG_OST
543 /* _OST Source Event Code (OSPM Action) */
544 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
545 #define ACPI_OST_EC_OSPM_EJECT 0x103
546 #define ACPI_OST_EC_OSPM_INSERTION 0x200
548 /* _OST General Processing Status Code */
549 #define ACPI_OST_SC_SUCCESS 0x0
550 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
551 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
553 /* _OST OS Shutdown Processing (0x100) Status Code */
554 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
555 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
556 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
557 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
559 /* _OST Ejection Request (0x3, 0x103) Status Code */
560 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
561 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
562 #define ACPI_OST_SC_DEVICE_BUSY 0x82
563 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
564 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
566 /* _OST Insertion Request (0x200) Status Code */
567 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
568 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
569 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
571 enum acpi_predicate {
575 greater_than_or_equal,
578 /* Table must be terminted by a NULL entry */
579 struct acpi_platform_list {
580 char oem_id[ACPI_OEM_ID_SIZE+1];
581 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
584 enum acpi_predicate pred;
588 int acpi_match_platform_list(const struct acpi_platform_list *plat);
590 extern void acpi_early_init(void);
591 extern void acpi_subsystem_init(void);
592 extern void arch_post_acpi_subsys_init(void);
594 extern int acpi_nvs_register(__u64 start, __u64 size);
596 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
599 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
600 const struct device *dev);
602 const void *acpi_device_get_match_data(const struct device *dev);
603 extern bool acpi_driver_match_device(struct device *dev,
604 const struct device_driver *drv);
605 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
606 int acpi_device_modalias(struct device *, char *, int);
607 void acpi_walk_dep_device_list(acpi_handle handle);
609 struct platform_device *acpi_create_platform_device(struct acpi_device *,
610 struct property_entry *);
611 #define ACPI_PTR(_ptr) (_ptr)
613 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
615 adev->flags.visited = true;
618 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
620 adev->flags.visited = false;
623 enum acpi_reconfig_event {
624 ACPI_RECONFIG_DEVICE_ADD = 0,
625 ACPI_RECONFIG_DEVICE_REMOVE,
628 int acpi_reconfig_notifier_register(struct notifier_block *nb);
629 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
631 #ifdef CONFIG_ACPI_GTDT
632 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
633 int acpi_gtdt_map_ppi(int type);
634 bool acpi_gtdt_c3stop(int type);
635 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
638 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
639 static inline u64 acpi_arch_get_root_pointer(void)
645 #else /* !CONFIG_ACPI */
647 #define acpi_disabled 1
649 #define ACPI_COMPANION(dev) (NULL)
650 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
651 #define ACPI_HANDLE(dev) (NULL)
652 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
653 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
655 struct fwnode_handle;
657 static inline bool acpi_dev_found(const char *hid)
662 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
667 static inline const char *
668 acpi_dev_get_first_match_name(const char *hid, const char *uid, s64 hrv)
673 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
678 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
683 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
688 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
693 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
698 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
704 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
709 static inline bool has_acpi_companion(struct device *dev)
714 static inline void acpi_preset_companion(struct device *dev,
715 struct acpi_device *parent, u64 addr)
719 static inline const char *acpi_dev_name(struct acpi_device *adev)
724 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
729 static inline void acpi_early_init(void) { }
730 static inline void acpi_subsystem_init(void) { }
732 static inline int early_acpi_boot_init(void)
736 static inline int acpi_boot_init(void)
741 static inline void acpi_boot_table_init(void)
746 static inline int acpi_mps_check(void)
751 static inline int acpi_check_resource_conflict(struct resource *res)
756 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
762 struct acpi_table_header;
763 static inline int acpi_table_parse(char *id,
764 int (*handler)(struct acpi_table_header *))
769 static inline int acpi_nvs_register(__u64 start, __u64 size)
774 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
780 struct acpi_device_id;
782 static inline const struct acpi_device_id *acpi_match_device(
783 const struct acpi_device_id *ids, const struct device *dev)
788 static inline const void *acpi_device_get_match_data(const struct device *dev)
793 static inline bool acpi_driver_match_device(struct device *dev,
794 const struct device_driver *drv)
799 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
802 union acpi_object *argv4)
807 static inline int acpi_device_uevent_modalias(struct device *dev,
808 struct kobj_uevent_env *env)
813 static inline int acpi_device_modalias(struct device *dev,
819 static inline bool acpi_dma_supported(struct acpi_device *adev)
824 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
826 return DEV_DMA_NOT_SUPPORTED;
829 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
830 u64 *offset, u64 *size)
835 static inline int acpi_dma_configure(struct device *dev,
836 enum dev_dma_attr attr)
841 #define ACPI_PTR(_ptr) (NULL)
843 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
847 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
851 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
856 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
861 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
866 #endif /* !CONFIG_ACPI */
868 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
869 int acpi_ioapic_add(acpi_handle root);
871 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
875 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
876 u32 pm1a_ctrl, u32 pm1b_ctrl));
878 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
879 u32 pm1a_control, u32 pm1b_control);
881 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
882 u32 val_a, u32 val_b));
884 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
885 u32 val_a, u32 val_b);
888 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
890 static inline void arch_reserve_mem_area(acpi_physical_address addr,
894 #endif /* CONFIG_X86 */
896 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
899 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
900 int acpi_dev_suspend(struct device *dev, bool wakeup);
901 int acpi_dev_resume(struct device *dev);
902 int acpi_subsys_runtime_suspend(struct device *dev);
903 int acpi_subsys_runtime_resume(struct device *dev);
904 int acpi_dev_pm_attach(struct device *dev, bool power_on);
906 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
907 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
908 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
909 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
910 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
916 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
917 int acpi_dev_suspend_late(struct device *dev);
918 int acpi_subsys_prepare(struct device *dev);
919 void acpi_subsys_complete(struct device *dev);
920 int acpi_subsys_suspend_late(struct device *dev);
921 int acpi_subsys_suspend_noirq(struct device *dev);
922 int acpi_subsys_resume_noirq(struct device *dev);
923 int acpi_subsys_resume_early(struct device *dev);
924 int acpi_subsys_suspend(struct device *dev);
925 int acpi_subsys_freeze(struct device *dev);
926 int acpi_subsys_freeze_late(struct device *dev);
927 int acpi_subsys_freeze_noirq(struct device *dev);
928 int acpi_subsys_thaw_noirq(struct device *dev);
930 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
931 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
932 static inline void acpi_subsys_complete(struct device *dev) {}
933 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
934 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
935 static inline int acpi_subsys_resume_noirq(struct device *dev) { return 0; }
936 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
937 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
938 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
939 static inline int acpi_subsys_freeze_late(struct device *dev) { return 0; }
940 static inline int acpi_subsys_freeze_noirq(struct device *dev) { return 0; }
941 static inline int acpi_subsys_thaw_noirq(struct device *dev) { return 0; }
946 void acpi_handle_printk(const char *level, acpi_handle handle,
947 const char *fmt, ...);
948 #else /* !CONFIG_ACPI */
949 static inline __printf(3, 4) void
950 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
951 #endif /* !CONFIG_ACPI */
953 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
955 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
959 * acpi_handle_<level>: Print message with ACPI prefix and object path
961 * These interfaces acquire the global namespace mutex to obtain an object
962 * path. In interrupt context, it shows the object path as <n/a>.
964 #define acpi_handle_emerg(handle, fmt, ...) \
965 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
966 #define acpi_handle_alert(handle, fmt, ...) \
967 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
968 #define acpi_handle_crit(handle, fmt, ...) \
969 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
970 #define acpi_handle_err(handle, fmt, ...) \
971 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
972 #define acpi_handle_warn(handle, fmt, ...) \
973 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
974 #define acpi_handle_notice(handle, fmt, ...) \
975 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
976 #define acpi_handle_info(handle, fmt, ...) \
977 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
980 #define acpi_handle_debug(handle, fmt, ...) \
981 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
983 #if defined(CONFIG_DYNAMIC_DEBUG)
984 #define acpi_handle_debug(handle, fmt, ...) \
985 _dynamic_func_call(fmt, __acpi_handle_debug, \
986 handle, pr_fmt(fmt), ##__VA_ARGS__)
988 #define acpi_handle_debug(handle, fmt, ...) \
991 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
997 struct acpi_gpio_params {
998 unsigned int crs_entry_index;
999 unsigned int line_index;
1003 struct acpi_gpio_mapping {
1005 const struct acpi_gpio_params *data;
1008 /* Ignore IoRestriction field */
1009 #define ACPI_GPIO_QUIRK_NO_IO_RESTRICTION BIT(0)
1011 * When ACPI GPIO mapping table is in use the index parameter inside it
1012 * refers to the GPIO resource in _CRS method. That index has no
1013 * distinction of actual type of the resource. When consumer wants to
1014 * get GpioIo type explicitly, this quirk may be used.
1016 #define ACPI_GPIO_QUIRK_ONLY_GPIOIO BIT(1)
1018 unsigned int quirks;
1021 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1022 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1023 const struct acpi_gpio_mapping *gpios);
1025 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
1028 adev->driver_gpios = NULL;
1031 int devm_acpi_dev_add_driver_gpios(struct device *dev,
1032 const struct acpi_gpio_mapping *gpios);
1033 void devm_acpi_dev_remove_driver_gpios(struct device *dev);
1035 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1036 struct acpi_resource_gpio **agpio);
1037 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
1039 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1040 const struct acpi_gpio_mapping *gpios)
1044 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
1046 static inline int devm_acpi_dev_add_driver_gpios(struct device *dev,
1047 const struct acpi_gpio_mapping *gpios)
1051 static inline void devm_acpi_dev_remove_driver_gpios(struct device *dev) {}
1053 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1054 struct acpi_resource_gpio **agpio)
1058 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1064 /* Device properties */
1067 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1068 acpi_object_type type, const union acpi_object **obj);
1069 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1070 const char *name, size_t index, size_t num_args,
1071 struct fwnode_reference_args *args);
1073 static inline int acpi_node_get_property_reference(
1074 const struct fwnode_handle *fwnode,
1075 const char *name, size_t index,
1076 struct fwnode_reference_args *args)
1078 return __acpi_node_get_property_reference(fwnode, name, index,
1079 NR_FWNODE_REFERENCE_ARGS, args);
1082 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1084 return !list_empty(&adev->data.properties);
1087 struct acpi_device_properties *
1088 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1089 const union acpi_object *properties);
1091 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1093 int acpi_dev_prop_read_single(struct acpi_device *adev,
1094 const char *propname, enum dev_prop_type proptype,
1096 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1097 const char *propname, enum dev_prop_type proptype,
1098 void *val, size_t nval);
1099 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
1100 enum dev_prop_type proptype, void *val, size_t nval);
1102 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1103 struct fwnode_handle *child);
1104 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
1106 struct acpi_probe_entry;
1107 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1108 struct acpi_probe_entry *);
1110 #define ACPI_TABLE_ID_LEN 5
1113 * struct acpi_probe_entry - boot-time probing entry
1114 * @id: ACPI table name
1115 * @type: Optional subtable type to match
1116 * (if @id contains subtables)
1117 * @subtable_valid: Optional callback to check the validity of
1119 * @probe_table: Callback to the driver being probed when table
1120 * match is successful
1121 * @probe_subtbl: Callback to the driver being probed when table and
1122 * subtable match (and optional callback is successful)
1123 * @driver_data: Sideband data provided back to the driver
1125 struct acpi_probe_entry {
1126 __u8 id[ACPI_TABLE_ID_LEN];
1128 acpi_probe_entry_validate_subtbl subtable_valid;
1130 acpi_tbl_table_handler probe_table;
1131 acpi_tbl_entry_handler probe_subtbl;
1133 kernel_ulong_t driver_data;
1136 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1137 static const struct acpi_probe_entry __acpi_probe_##name \
1138 __used __section(__##table##_acpi_probe_table) \
1142 .subtable_valid = valid, \
1143 .probe_table = (acpi_tbl_table_handler)fn, \
1144 .driver_data = data, \
1147 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1148 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1150 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1152 #define acpi_probe_device_table(t) \
1154 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1155 ACPI_PROBE_TABLE_END(t); \
1156 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1157 (&ACPI_PROBE_TABLE_END(t) - \
1158 &ACPI_PROBE_TABLE(t))); \
1161 static inline int acpi_dev_get_property(struct acpi_device *adev,
1162 const char *name, acpi_object_type type,
1163 const union acpi_object **obj)
1169 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1170 const char *name, size_t index, size_t num_args,
1171 struct fwnode_reference_args *args)
1177 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1178 const char *name, size_t index,
1179 struct fwnode_reference_args *args)
1184 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1185 const char *propname,
1191 static inline int acpi_dev_prop_get(const struct acpi_device *adev,
1192 const char *propname,
1198 static inline int acpi_dev_prop_read_single(const struct acpi_device *adev,
1199 const char *propname,
1200 enum dev_prop_type proptype,
1206 static inline int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1207 const char *propname,
1208 enum dev_prop_type proptype,
1209 void *val, size_t nval)
1214 static inline int acpi_dev_prop_read(const struct acpi_device *adev,
1215 const char *propname,
1216 enum dev_prop_type proptype,
1217 void *val, size_t nval)
1222 static inline struct fwnode_handle *
1223 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1224 struct fwnode_handle *child)
1229 static inline struct fwnode_handle *
1230 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1235 static inline struct fwnode_handle *
1236 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1237 struct fwnode_handle *prev)
1239 return ERR_PTR(-ENXIO);
1243 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1244 struct fwnode_handle **remote,
1245 struct fwnode_handle **port,
1246 struct fwnode_handle **endpoint)
1251 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1252 static const void * __acpi_table_##name[] \
1253 __attribute__((unused)) \
1254 = { (void *) table_id, \
1255 (void *) subtable, \
1260 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1263 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1264 void acpi_table_upgrade(void);
1266 static inline void acpi_table_upgrade(void) { }
1269 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1270 extern bool acpi_has_watchdog(void);
1272 static inline bool acpi_has_watchdog(void) { return false; }
1275 #ifdef CONFIG_ACPI_SPCR_TABLE
1276 extern bool qdf2400_e44_present;
1277 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1279 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1285 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1286 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1289 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1295 #ifdef CONFIG_ACPI_LPIT
1296 int lpit_read_residency_count_address(u64 *address);
1298 static inline int lpit_read_residency_count_address(u64 *address)
1304 #ifdef CONFIG_ACPI_PPTT
1305 int find_acpi_cpu_topology(unsigned int cpu, int level);
1306 int find_acpi_cpu_topology_package(unsigned int cpu);
1307 int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
1309 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1313 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1317 static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1324 extern int acpi_platform_notify(struct device *dev, enum kobject_action action);
1327 acpi_platform_notify(struct device *dev, enum kobject_action action)
1333 #endif /*_LINUX_ACPI_H*/