1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * acpi.h - ACPI Interface
5 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
11 #include <linux/errno.h>
12 #include <linux/ioport.h> /* for struct resource */
13 #include <linux/irqdomain.h>
14 #include <linux/resource_ext.h>
15 #include <linux/device.h>
16 #include <linux/property.h>
17 #include <linux/uuid.h>
22 #include <acpi/acpi.h>
26 #include <linux/list.h>
27 #include <linux/mod_devicetable.h>
28 #include <linux/dynamic_debug.h>
29 #include <linux/module.h>
30 #include <linux/mutex.h>
32 #include <acpi/acpi_bus.h>
33 #include <acpi/acpi_drivers.h>
34 #include <acpi/acpi_numa.h>
35 #include <acpi/acpi_io.h>
38 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
40 return adev ? adev->handle : NULL;
43 #define ACPI_COMPANION(dev) to_acpi_device_node((dev)->fwnode)
44 #define ACPI_COMPANION_SET(dev, adev) set_primary_fwnode(dev, (adev) ? \
45 acpi_fwnode_handle(adev) : NULL)
46 #define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
47 #define ACPI_HANDLE_FWNODE(fwnode) \
48 acpi_device_handle(to_acpi_device_node(fwnode))
50 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
52 struct fwnode_handle *fwnode;
54 fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
58 fwnode->ops = &acpi_static_fwnode_ops;
63 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
65 if (WARN_ON(!is_acpi_static_node(fwnode)))
72 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
73 * the PCI-defined class-code information
75 * @_cls : the class, subclass, prog-if triple for this device
76 * @_msk : the class mask for this device
78 * This macro is used to create a struct acpi_device_id that matches a
79 * specific PCI class. The .id and .driver_data fields will be left
80 * initialized with the default value.
82 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
84 static inline bool has_acpi_companion(struct device *dev)
86 return is_acpi_device_node(dev->fwnode);
89 static inline void acpi_preset_companion(struct device *dev,
90 struct acpi_device *parent, u64 addr)
92 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
95 static inline const char *acpi_dev_name(struct acpi_device *adev)
97 return dev_name(&adev->dev);
100 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
102 enum acpi_irq_model_id {
103 ACPI_IRQ_MODEL_PIC = 0,
104 ACPI_IRQ_MODEL_IOAPIC,
105 ACPI_IRQ_MODEL_IOSAPIC,
106 ACPI_IRQ_MODEL_PLATFORM,
111 extern enum acpi_irq_model_id acpi_irq_model;
113 enum acpi_interrupt_id {
114 ACPI_INTERRUPT_PMI = 1,
120 #define ACPI_SPACE_MEM 0
122 enum acpi_address_range_id {
123 ACPI_ADDRESS_RANGE_MEMORY = 1,
124 ACPI_ADDRESS_RANGE_RESERVED = 2,
125 ACPI_ADDRESS_RANGE_ACPI = 3,
126 ACPI_ADDRESS_RANGE_NVS = 4,
127 ACPI_ADDRESS_RANGE_COUNT
132 union acpi_subtable_headers {
133 struct acpi_subtable_header common;
134 struct acpi_hmat_structure hmat;
137 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
139 typedef int (*acpi_tbl_entry_handler)(union acpi_subtable_headers *header,
140 const unsigned long end);
142 /* Debugger support */
144 struct acpi_debugger_ops {
145 int (*create_thread)(acpi_osd_exec_callback function, void *context);
146 ssize_t (*write_log)(const char *msg);
147 ssize_t (*read_cmd)(char *buffer, size_t length);
148 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
149 int (*notify_command_complete)(void);
152 struct acpi_debugger {
153 const struct acpi_debugger_ops *ops;
154 struct module *owner;
158 #ifdef CONFIG_ACPI_DEBUGGER
159 int __init acpi_debugger_init(void);
160 int acpi_register_debugger(struct module *owner,
161 const struct acpi_debugger_ops *ops);
162 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
163 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
164 ssize_t acpi_debugger_write_log(const char *msg);
165 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
166 int acpi_debugger_wait_command_ready(void);
167 int acpi_debugger_notify_command_complete(void);
169 static inline int acpi_debugger_init(void)
174 static inline int acpi_register_debugger(struct module *owner,
175 const struct acpi_debugger_ops *ops)
180 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
184 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
190 static inline int acpi_debugger_write_log(const char *msg)
195 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
200 static inline int acpi_debugger_wait_command_ready(void)
205 static inline int acpi_debugger_notify_command_complete(void)
211 #define BAD_MADT_ENTRY(entry, end) ( \
212 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
213 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
215 struct acpi_subtable_proc {
217 acpi_tbl_entry_handler handler;
221 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
222 void __acpi_unmap_table(void __iomem *map, unsigned long size);
223 int early_acpi_boot_init(void);
224 int acpi_boot_init (void);
225 void acpi_boot_table_init (void);
226 int acpi_mps_check (void);
227 int acpi_numa_init (void);
229 int acpi_table_init (void);
230 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
231 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
233 acpi_tbl_entry_handler handler,
234 unsigned int max_entries);
235 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
236 struct acpi_subtable_proc *proc, int proc_num,
237 unsigned int max_entries);
238 int acpi_table_parse_madt(enum acpi_madt_type id,
239 acpi_tbl_entry_handler handler,
240 unsigned int max_entries);
241 int acpi_parse_mcfg (struct acpi_table_header *header);
242 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
244 /* the following numa functions are architecture-dependent */
245 void acpi_numa_slit_init (struct acpi_table_slit *slit);
247 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
248 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
251 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
254 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
257 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
260 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
263 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
265 #ifndef PHYS_CPUID_INVALID
266 typedef u32 phys_cpuid_t;
267 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
270 static inline bool invalid_logical_cpuid(u32 cpuid)
272 return (int)cpuid < 0;
275 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
277 return phys_id == PHYS_CPUID_INVALID;
280 /* Validate the processor object's proc_id */
281 bool acpi_duplicate_processor_id(int proc_id);
283 #ifdef CONFIG_ACPI_HOTPLUG_CPU
284 /* Arch dependent functions for cpu hotplug support */
285 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
287 int acpi_unmap_cpu(int cpu);
288 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
290 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
291 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
294 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
295 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
296 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
297 void acpi_irq_stats_init(void);
298 extern u32 acpi_irq_handled;
299 extern u32 acpi_irq_not_handled;
300 extern unsigned int acpi_sci_irq;
301 extern bool acpi_no_s5;
302 #define INVALID_ACPI_IRQ ((unsigned)-1)
303 static inline bool acpi_sci_irq_valid(void)
305 return acpi_sci_irq != INVALID_ACPI_IRQ;
309 extern unsigned long acpi_realmode_flags;
311 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
312 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
313 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
315 void acpi_set_irq_model(enum acpi_irq_model_id model,
316 struct fwnode_handle *fwnode);
318 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
320 struct fwnode_handle *fwnode,
321 const struct irq_domain_ops *ops,
324 #ifdef CONFIG_X86_IO_APIC
325 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
327 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
330 * This function undoes the effect of one call to acpi_register_gsi().
331 * If this matches the last registration, any IRQ resources for gsi
334 void acpi_unregister_gsi (u32 gsi);
338 int acpi_pci_irq_enable (struct pci_dev *dev);
339 void acpi_penalize_isa_irq(int irq, int active);
340 bool acpi_isa_irq_available(int irq);
342 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
344 static inline void acpi_penalize_sci_irq(int irq, int trigger,
349 void acpi_pci_irq_disable (struct pci_dev *dev);
351 extern int ec_read(u8 addr, u8 *val);
352 extern int ec_write(u8 addr, u8 val);
353 extern int ec_transaction(u8 command,
354 const u8 *wdata, unsigned wdata_len,
355 u8 *rdata, unsigned rdata_len);
356 extern acpi_handle ec_get_handle(void);
358 extern bool acpi_is_pnp_device(struct acpi_device *);
360 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
362 typedef void (*wmi_notify_handler) (u32 value, void *context);
364 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
366 const struct acpi_buffer *in,
367 struct acpi_buffer *out);
368 extern acpi_status wmi_query_block(const char *guid, u8 instance,
369 struct acpi_buffer *out);
370 extern acpi_status wmi_set_block(const char *guid, u8 instance,
371 const struct acpi_buffer *in);
372 extern acpi_status wmi_install_notify_handler(const char *guid,
373 wmi_notify_handler handler, void *data);
374 extern acpi_status wmi_remove_notify_handler(const char *guid);
375 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
376 extern bool wmi_has_guid(const char *guid);
378 #endif /* CONFIG_ACPI_WMI */
380 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
381 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
382 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
383 #define ACPI_VIDEO_BACKLIGHT 0x0008
384 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
385 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
386 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
387 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
388 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
389 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
390 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
391 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
393 extern char acpi_video_backlight_string[];
394 extern long acpi_is_video_device(acpi_handle handle);
395 extern int acpi_blacklisted(void);
396 extern void acpi_osi_setup(char *str);
397 extern bool acpi_osi_is_win8(void);
399 #ifdef CONFIG_ACPI_NUMA
400 int acpi_map_pxm_to_online_node(int pxm);
401 int acpi_map_pxm_to_node(int pxm);
402 int acpi_get_node(acpi_handle handle);
404 static inline int acpi_map_pxm_to_online_node(int pxm)
408 static inline int acpi_map_pxm_to_node(int pxm)
412 static inline int acpi_get_node(acpi_handle handle)
417 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
419 extern int pnpacpi_disabled;
421 #define PXM_INVAL (-1)
423 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
424 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
425 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
426 struct resource_win *win);
427 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
428 struct resource_win *win);
429 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
430 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
431 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
432 struct resource *res);
434 void acpi_dev_free_resource_list(struct list_head *list);
435 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
436 int (*preproc)(struct acpi_resource *, void *),
438 int acpi_dev_get_dma_resources(struct acpi_device *adev,
439 struct list_head *list);
440 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
441 unsigned long types);
443 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
446 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
449 struct acpi_device *acpi_resource_consumer(struct resource *res);
451 int acpi_check_resource_conflict(const struct resource *res);
453 int acpi_check_region(resource_size_t start, resource_size_t n,
456 acpi_status acpi_release_memory(acpi_handle handle, struct resource *res,
459 int acpi_resources_are_enforced(void);
461 #ifdef CONFIG_HIBERNATION
462 void __init acpi_no_s4_hw_signature(void);
465 #ifdef CONFIG_PM_SLEEP
466 void __init acpi_old_suspend_ordering(void);
467 void __init acpi_nvs_nosave(void);
468 void __init acpi_nvs_nosave_s3(void);
469 void __init acpi_sleep_no_blacklist(void);
470 #endif /* CONFIG_PM_SLEEP */
472 struct acpi_osc_context {
473 char *uuid_str; /* UUID string */
475 struct acpi_buffer cap; /* list of DWORD capabilities */
476 struct acpi_buffer ret; /* free by caller if success */
479 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
481 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
482 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
483 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
484 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
486 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
487 #define OSC_QUERY_ENABLE 0x00000001 /* input */
488 #define OSC_REQUEST_ERROR 0x00000002 /* return */
489 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
490 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
491 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
493 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
494 #define OSC_SB_PAD_SUPPORT 0x00000001
495 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
496 #define OSC_SB_PR3_SUPPORT 0x00000004
497 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
498 #define OSC_SB_APEI_SUPPORT 0x00000010
499 #define OSC_SB_CPC_SUPPORT 0x00000020
500 #define OSC_SB_CPCV2_SUPPORT 0x00000040
501 #define OSC_SB_PCLPI_SUPPORT 0x00000080
502 #define OSC_SB_OSLPI_SUPPORT 0x00000100
503 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
505 extern bool osc_sb_apei_support_acked;
506 extern bool osc_pc_lpi_support_confirmed;
508 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
509 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
510 #define OSC_PCI_ASPM_SUPPORT 0x00000002
511 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
512 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
513 #define OSC_PCI_MSI_SUPPORT 0x00000010
514 #define OSC_PCI_HPX_TYPE_3_SUPPORT 0x00000100
515 #define OSC_PCI_SUPPORT_MASKS 0x0000011f
517 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
518 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
519 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
520 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
521 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
522 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
523 #define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
524 #define OSC_PCI_CONTROL_MASKS 0x0000003f
526 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
527 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
528 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
529 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
530 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
531 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
532 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
533 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
534 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
535 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
537 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
540 /* Enable _OST when all relevant hotplug operations are enabled */
541 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
542 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
543 defined(CONFIG_ACPI_CONTAINER)
544 #define ACPI_HOTPLUG_OST
547 /* _OST Source Event Code (OSPM Action) */
548 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
549 #define ACPI_OST_EC_OSPM_EJECT 0x103
550 #define ACPI_OST_EC_OSPM_INSERTION 0x200
552 /* _OST General Processing Status Code */
553 #define ACPI_OST_SC_SUCCESS 0x0
554 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
555 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
557 /* _OST OS Shutdown Processing (0x100) Status Code */
558 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
559 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
560 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
561 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
563 /* _OST Ejection Request (0x3, 0x103) Status Code */
564 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
565 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
566 #define ACPI_OST_SC_DEVICE_BUSY 0x82
567 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
568 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
570 /* _OST Insertion Request (0x200) Status Code */
571 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
572 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
573 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
575 enum acpi_predicate {
579 greater_than_or_equal,
582 /* Table must be terminted by a NULL entry */
583 struct acpi_platform_list {
584 char oem_id[ACPI_OEM_ID_SIZE+1];
585 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
588 enum acpi_predicate pred;
592 int acpi_match_platform_list(const struct acpi_platform_list *plat);
594 extern void acpi_early_init(void);
595 extern void acpi_subsystem_init(void);
596 extern void arch_post_acpi_subsys_init(void);
598 extern int acpi_nvs_register(__u64 start, __u64 size);
600 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
603 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
604 const struct device *dev);
606 const void *acpi_device_get_match_data(const struct device *dev);
607 extern bool acpi_driver_match_device(struct device *dev,
608 const struct device_driver *drv);
609 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
610 int acpi_device_modalias(struct device *, char *, int);
611 void acpi_walk_dep_device_list(acpi_handle handle);
613 struct platform_device *acpi_create_platform_device(struct acpi_device *,
614 struct property_entry *);
615 #define ACPI_PTR(_ptr) (_ptr)
617 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
619 adev->flags.visited = true;
622 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
624 adev->flags.visited = false;
627 enum acpi_reconfig_event {
628 ACPI_RECONFIG_DEVICE_ADD = 0,
629 ACPI_RECONFIG_DEVICE_REMOVE,
632 int acpi_reconfig_notifier_register(struct notifier_block *nb);
633 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
635 #ifdef CONFIG_ACPI_GTDT
636 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
637 int acpi_gtdt_map_ppi(int type);
638 bool acpi_gtdt_c3stop(int type);
639 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
642 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
643 static inline u64 acpi_arch_get_root_pointer(void)
649 #else /* !CONFIG_ACPI */
651 #define acpi_disabled 1
653 #define ACPI_COMPANION(dev) (NULL)
654 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
655 #define ACPI_HANDLE(dev) (NULL)
656 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
657 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
659 struct fwnode_handle;
661 static inline bool acpi_dev_found(const char *hid)
666 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
671 static inline struct acpi_device *
672 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
677 static inline void acpi_dev_put(struct acpi_device *adev) {}
679 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
684 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
689 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
694 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
699 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
704 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
710 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
715 static inline bool has_acpi_companion(struct device *dev)
720 static inline void acpi_preset_companion(struct device *dev,
721 struct acpi_device *parent, u64 addr)
725 static inline const char *acpi_dev_name(struct acpi_device *adev)
730 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
735 static inline void acpi_early_init(void) { }
736 static inline void acpi_subsystem_init(void) { }
738 static inline int early_acpi_boot_init(void)
742 static inline int acpi_boot_init(void)
747 static inline void acpi_boot_table_init(void)
752 static inline int acpi_mps_check(void)
757 static inline int acpi_check_resource_conflict(struct resource *res)
762 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
768 struct acpi_table_header;
769 static inline int acpi_table_parse(char *id,
770 int (*handler)(struct acpi_table_header *))
775 static inline int acpi_nvs_register(__u64 start, __u64 size)
780 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
786 struct acpi_device_id;
788 static inline const struct acpi_device_id *acpi_match_device(
789 const struct acpi_device_id *ids, const struct device *dev)
794 static inline const void *acpi_device_get_match_data(const struct device *dev)
799 static inline bool acpi_driver_match_device(struct device *dev,
800 const struct device_driver *drv)
805 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
808 union acpi_object *argv4)
813 static inline int acpi_device_uevent_modalias(struct device *dev,
814 struct kobj_uevent_env *env)
819 static inline int acpi_device_modalias(struct device *dev,
825 static inline bool acpi_dma_supported(struct acpi_device *adev)
830 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
832 return DEV_DMA_NOT_SUPPORTED;
835 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
836 u64 *offset, u64 *size)
841 static inline int acpi_dma_configure(struct device *dev,
842 enum dev_dma_attr attr)
847 #define ACPI_PTR(_ptr) (NULL)
849 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
853 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
857 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
862 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
867 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
872 #endif /* !CONFIG_ACPI */
874 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
875 int acpi_ioapic_add(acpi_handle root);
877 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
881 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
882 u32 pm1a_ctrl, u32 pm1b_ctrl));
884 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
885 u32 pm1a_control, u32 pm1b_control);
887 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
888 u32 val_a, u32 val_b));
890 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
891 u32 val_a, u32 val_b);
894 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
896 static inline void arch_reserve_mem_area(acpi_physical_address addr,
900 #endif /* CONFIG_X86 */
902 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
905 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
906 int acpi_dev_suspend(struct device *dev, bool wakeup);
907 int acpi_dev_resume(struct device *dev);
908 int acpi_subsys_runtime_suspend(struct device *dev);
909 int acpi_subsys_runtime_resume(struct device *dev);
910 int acpi_dev_pm_attach(struct device *dev, bool power_on);
912 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
913 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
914 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
915 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
916 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
922 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
923 int acpi_subsys_prepare(struct device *dev);
924 void acpi_subsys_complete(struct device *dev);
925 int acpi_subsys_suspend_late(struct device *dev);
926 int acpi_subsys_suspend_noirq(struct device *dev);
927 int acpi_subsys_suspend(struct device *dev);
928 int acpi_subsys_freeze(struct device *dev);
929 int acpi_subsys_poweroff(struct device *dev);
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_suspend(struct device *dev) { return 0; }
936 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
937 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
942 void acpi_handle_printk(const char *level, acpi_handle handle,
943 const char *fmt, ...);
944 #else /* !CONFIG_ACPI */
945 static inline __printf(3, 4) void
946 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
947 #endif /* !CONFIG_ACPI */
949 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
951 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
955 * acpi_handle_<level>: Print message with ACPI prefix and object path
957 * These interfaces acquire the global namespace mutex to obtain an object
958 * path. In interrupt context, it shows the object path as <n/a>.
960 #define acpi_handle_emerg(handle, fmt, ...) \
961 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
962 #define acpi_handle_alert(handle, fmt, ...) \
963 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
964 #define acpi_handle_crit(handle, fmt, ...) \
965 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
966 #define acpi_handle_err(handle, fmt, ...) \
967 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
968 #define acpi_handle_warn(handle, fmt, ...) \
969 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
970 #define acpi_handle_notice(handle, fmt, ...) \
971 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
972 #define acpi_handle_info(handle, fmt, ...) \
973 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
976 #define acpi_handle_debug(handle, fmt, ...) \
977 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
979 #if defined(CONFIG_DYNAMIC_DEBUG)
980 #define acpi_handle_debug(handle, fmt, ...) \
981 _dynamic_func_call(fmt, __acpi_handle_debug, \
982 handle, pr_fmt(fmt), ##__VA_ARGS__)
984 #define acpi_handle_debug(handle, fmt, ...) \
987 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
993 struct acpi_gpio_params {
994 unsigned int crs_entry_index;
995 unsigned int line_index;
999 struct acpi_gpio_mapping {
1001 const struct acpi_gpio_params *data;
1004 /* Ignore IoRestriction field */
1005 #define ACPI_GPIO_QUIRK_NO_IO_RESTRICTION BIT(0)
1007 * When ACPI GPIO mapping table is in use the index parameter inside it
1008 * refers to the GPIO resource in _CRS method. That index has no
1009 * distinction of actual type of the resource. When consumer wants to
1010 * get GpioIo type explicitly, this quirk may be used.
1012 #define ACPI_GPIO_QUIRK_ONLY_GPIOIO BIT(1)
1014 unsigned int quirks;
1017 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1018 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1019 const struct acpi_gpio_mapping *gpios);
1021 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
1024 adev->driver_gpios = NULL;
1027 int devm_acpi_dev_add_driver_gpios(struct device *dev,
1028 const struct acpi_gpio_mapping *gpios);
1029 void devm_acpi_dev_remove_driver_gpios(struct device *dev);
1031 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1032 struct acpi_resource_gpio **agpio);
1033 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
1035 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1036 const struct acpi_gpio_mapping *gpios)
1040 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
1042 static inline int devm_acpi_dev_add_driver_gpios(struct device *dev,
1043 const struct acpi_gpio_mapping *gpios)
1047 static inline void devm_acpi_dev_remove_driver_gpios(struct device *dev) {}
1049 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1050 struct acpi_resource_gpio **agpio)
1054 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1060 /* Device properties */
1063 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1064 acpi_object_type type, const union acpi_object **obj);
1065 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1066 const char *name, size_t index, size_t num_args,
1067 struct fwnode_reference_args *args);
1069 static inline int acpi_node_get_property_reference(
1070 const struct fwnode_handle *fwnode,
1071 const char *name, size_t index,
1072 struct fwnode_reference_args *args)
1074 return __acpi_node_get_property_reference(fwnode, name, index,
1075 NR_FWNODE_REFERENCE_ARGS, args);
1078 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1080 return !list_empty(&adev->data.properties);
1083 struct acpi_device_properties *
1084 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1085 const union acpi_object *properties);
1087 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1089 int acpi_dev_prop_read_single(struct acpi_device *adev,
1090 const char *propname, enum dev_prop_type proptype,
1092 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1093 const char *propname, enum dev_prop_type proptype,
1094 void *val, size_t nval);
1095 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
1096 enum dev_prop_type proptype, void *val, size_t nval);
1098 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1099 struct fwnode_handle *child);
1100 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
1102 struct acpi_probe_entry;
1103 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1104 struct acpi_probe_entry *);
1106 #define ACPI_TABLE_ID_LEN 5
1109 * struct acpi_probe_entry - boot-time probing entry
1110 * @id: ACPI table name
1111 * @type: Optional subtable type to match
1112 * (if @id contains subtables)
1113 * @subtable_valid: Optional callback to check the validity of
1115 * @probe_table: Callback to the driver being probed when table
1116 * match is successful
1117 * @probe_subtbl: Callback to the driver being probed when table and
1118 * subtable match (and optional callback is successful)
1119 * @driver_data: Sideband data provided back to the driver
1121 struct acpi_probe_entry {
1122 __u8 id[ACPI_TABLE_ID_LEN];
1124 acpi_probe_entry_validate_subtbl subtable_valid;
1126 acpi_tbl_table_handler probe_table;
1127 acpi_tbl_entry_handler probe_subtbl;
1129 kernel_ulong_t driver_data;
1132 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1133 static const struct acpi_probe_entry __acpi_probe_##name \
1134 __used __section(__##table##_acpi_probe_table) \
1138 .subtable_valid = valid, \
1139 .probe_table = (acpi_tbl_table_handler)fn, \
1140 .driver_data = data, \
1143 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1144 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1146 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1148 #define acpi_probe_device_table(t) \
1150 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1151 ACPI_PROBE_TABLE_END(t); \
1152 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1153 (&ACPI_PROBE_TABLE_END(t) - \
1154 &ACPI_PROBE_TABLE(t))); \
1157 static inline int acpi_dev_get_property(struct acpi_device *adev,
1158 const char *name, acpi_object_type type,
1159 const union acpi_object **obj)
1165 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1166 const char *name, size_t index, size_t num_args,
1167 struct fwnode_reference_args *args)
1173 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1174 const char *name, size_t index,
1175 struct fwnode_reference_args *args)
1180 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1181 const char *propname,
1187 static inline int acpi_dev_prop_get(const struct acpi_device *adev,
1188 const char *propname,
1194 static inline int acpi_dev_prop_read_single(const struct acpi_device *adev,
1195 const char *propname,
1196 enum dev_prop_type proptype,
1202 static inline int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1203 const char *propname,
1204 enum dev_prop_type proptype,
1205 void *val, size_t nval)
1210 static inline int acpi_dev_prop_read(const struct acpi_device *adev,
1211 const char *propname,
1212 enum dev_prop_type proptype,
1213 void *val, size_t nval)
1218 static inline struct fwnode_handle *
1219 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1220 struct fwnode_handle *child)
1225 static inline struct fwnode_handle *
1226 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1231 static inline struct fwnode_handle *
1232 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1233 struct fwnode_handle *prev)
1235 return ERR_PTR(-ENXIO);
1239 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1240 struct fwnode_handle **remote,
1241 struct fwnode_handle **port,
1242 struct fwnode_handle **endpoint)
1247 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1248 static const void * __acpi_table_##name[] \
1249 __attribute__((unused)) \
1250 = { (void *) table_id, \
1251 (void *) subtable, \
1256 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1259 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1260 void acpi_table_upgrade(void);
1262 static inline void acpi_table_upgrade(void) { }
1265 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1266 extern bool acpi_has_watchdog(void);
1268 static inline bool acpi_has_watchdog(void) { return false; }
1271 #ifdef CONFIG_ACPI_SPCR_TABLE
1272 extern bool qdf2400_e44_present;
1273 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1275 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1281 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1282 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1285 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1291 #ifdef CONFIG_ACPI_LPIT
1292 int lpit_read_residency_count_address(u64 *address);
1294 static inline int lpit_read_residency_count_address(u64 *address)
1300 #ifdef CONFIG_ACPI_PPTT
1301 int find_acpi_cpu_topology(unsigned int cpu, int level);
1302 int find_acpi_cpu_topology_package(unsigned int cpu);
1303 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1304 int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
1306 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1310 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1314 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1318 static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1325 extern int acpi_platform_notify(struct device *dev, enum kobject_action action);
1328 acpi_platform_notify(struct device *dev, enum kobject_action action)
1334 #endif /*_LINUX_ACPI_H*/