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_prepare (void);
226 void acpi_boot_table_init (void);
227 int acpi_mps_check (void);
228 int acpi_numa_init (void);
230 int acpi_locate_initial_tables (void);
231 void acpi_reserve_initial_tables (void);
232 void acpi_table_init_complete (void);
233 int acpi_table_init (void);
234 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
235 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
237 acpi_tbl_entry_handler handler,
238 unsigned int max_entries);
239 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
240 struct acpi_subtable_proc *proc, int proc_num,
241 unsigned int max_entries);
242 int acpi_table_parse_madt(enum acpi_madt_type id,
243 acpi_tbl_entry_handler handler,
244 unsigned int max_entries);
245 int acpi_parse_mcfg (struct acpi_table_header *header);
246 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
248 /* the following numa functions are architecture-dependent */
249 void acpi_numa_slit_init (struct acpi_table_slit *slit);
251 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
252 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
255 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
258 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
261 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
264 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
267 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
269 #ifndef PHYS_CPUID_INVALID
270 typedef u32 phys_cpuid_t;
271 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
274 static inline bool invalid_logical_cpuid(u32 cpuid)
276 return (int)cpuid < 0;
279 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
281 return phys_id == PHYS_CPUID_INVALID;
284 /* Validate the processor object's proc_id */
285 bool acpi_duplicate_processor_id(int proc_id);
287 #ifdef CONFIG_ACPI_HOTPLUG_CPU
288 /* Arch dependent functions for cpu hotplug support */
289 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
291 int acpi_unmap_cpu(int cpu);
292 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
294 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
295 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
298 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
299 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
300 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
301 void acpi_irq_stats_init(void);
302 extern u32 acpi_irq_handled;
303 extern u32 acpi_irq_not_handled;
304 extern unsigned int acpi_sci_irq;
305 extern bool acpi_no_s5;
306 #define INVALID_ACPI_IRQ ((unsigned)-1)
307 static inline bool acpi_sci_irq_valid(void)
309 return acpi_sci_irq != INVALID_ACPI_IRQ;
313 extern unsigned long acpi_realmode_flags;
315 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
316 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
317 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
319 void acpi_set_irq_model(enum acpi_irq_model_id model,
320 struct fwnode_handle *fwnode);
322 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
324 struct fwnode_handle *fwnode,
325 const struct irq_domain_ops *ops,
328 #ifdef CONFIG_X86_IO_APIC
329 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
331 static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
337 * This function undoes the effect of one call to acpi_register_gsi().
338 * If this matches the last registration, any IRQ resources for gsi
341 void acpi_unregister_gsi (u32 gsi);
345 int acpi_pci_irq_enable (struct pci_dev *dev);
346 void acpi_penalize_isa_irq(int irq, int active);
347 bool acpi_isa_irq_available(int irq);
349 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
351 static inline void acpi_penalize_sci_irq(int irq, int trigger,
356 void acpi_pci_irq_disable (struct pci_dev *dev);
358 extern int ec_read(u8 addr, u8 *val);
359 extern int ec_write(u8 addr, u8 val);
360 extern int ec_transaction(u8 command,
361 const u8 *wdata, unsigned wdata_len,
362 u8 *rdata, unsigned rdata_len);
363 extern acpi_handle ec_get_handle(void);
365 extern bool acpi_is_pnp_device(struct acpi_device *);
367 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
369 typedef void (*wmi_notify_handler) (u32 value, void *context);
371 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
373 const struct acpi_buffer *in,
374 struct acpi_buffer *out);
375 extern acpi_status wmi_query_block(const char *guid, u8 instance,
376 struct acpi_buffer *out);
377 extern acpi_status wmi_set_block(const char *guid, u8 instance,
378 const struct acpi_buffer *in);
379 extern acpi_status wmi_install_notify_handler(const char *guid,
380 wmi_notify_handler handler, void *data);
381 extern acpi_status wmi_remove_notify_handler(const char *guid);
382 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
383 extern bool wmi_has_guid(const char *guid);
384 extern char *wmi_get_acpi_device_uid(const char *guid);
386 #endif /* CONFIG_ACPI_WMI */
388 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
389 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
390 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
391 #define ACPI_VIDEO_BACKLIGHT 0x0008
392 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
393 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
394 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
395 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
396 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
397 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
398 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
399 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
401 extern char acpi_video_backlight_string[];
402 extern long acpi_is_video_device(acpi_handle handle);
403 extern int acpi_blacklisted(void);
404 extern void acpi_osi_setup(char *str);
405 extern bool acpi_osi_is_win8(void);
407 #ifdef CONFIG_ACPI_NUMA
408 int acpi_map_pxm_to_online_node(int pxm);
409 int acpi_map_pxm_to_node(int pxm);
410 int acpi_get_node(acpi_handle handle);
412 static inline int acpi_map_pxm_to_online_node(int pxm)
416 static inline int acpi_map_pxm_to_node(int pxm)
420 static inline int acpi_get_node(acpi_handle handle)
425 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
427 extern int pnpacpi_disabled;
429 #define PXM_INVAL (-1)
431 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
432 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
433 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
434 struct resource_win *win);
435 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
436 struct resource_win *win);
437 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
438 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
439 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
440 struct resource *res);
442 void acpi_dev_free_resource_list(struct list_head *list);
443 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
444 int (*preproc)(struct acpi_resource *, void *),
446 int acpi_dev_get_dma_resources(struct acpi_device *adev,
447 struct list_head *list);
448 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
449 unsigned long types);
451 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
454 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
457 struct acpi_device *acpi_resource_consumer(struct resource *res);
459 int acpi_check_resource_conflict(const struct resource *res);
461 int acpi_check_region(resource_size_t start, resource_size_t n,
464 acpi_status acpi_release_memory(acpi_handle handle, struct resource *res,
467 int acpi_resources_are_enforced(void);
469 #ifdef CONFIG_HIBERNATION
470 void __init acpi_no_s4_hw_signature(void);
473 #ifdef CONFIG_PM_SLEEP
474 void __init acpi_old_suspend_ordering(void);
475 void __init acpi_nvs_nosave(void);
476 void __init acpi_nvs_nosave_s3(void);
477 void __init acpi_sleep_no_blacklist(void);
478 #endif /* CONFIG_PM_SLEEP */
480 int acpi_register_wakeup_handler(
481 int wake_irq, bool (*wakeup)(void *context), void *context);
482 void acpi_unregister_wakeup_handler(
483 bool (*wakeup)(void *context), void *context);
485 struct acpi_osc_context {
486 char *uuid_str; /* UUID string */
488 struct acpi_buffer cap; /* list of DWORD capabilities */
489 struct acpi_buffer ret; /* free by caller if success */
492 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
494 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
495 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
496 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
497 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
499 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
500 #define OSC_QUERY_ENABLE 0x00000001 /* input */
501 #define OSC_REQUEST_ERROR 0x00000002 /* return */
502 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
503 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
504 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
506 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
507 #define OSC_SB_PAD_SUPPORT 0x00000001
508 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
509 #define OSC_SB_PR3_SUPPORT 0x00000004
510 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
511 #define OSC_SB_APEI_SUPPORT 0x00000010
512 #define OSC_SB_CPC_SUPPORT 0x00000020
513 #define OSC_SB_CPCV2_SUPPORT 0x00000040
514 #define OSC_SB_PCLPI_SUPPORT 0x00000080
515 #define OSC_SB_OSLPI_SUPPORT 0x00000100
516 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
518 extern bool osc_sb_apei_support_acked;
519 extern bool osc_pc_lpi_support_confirmed;
521 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
522 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
523 #define OSC_PCI_ASPM_SUPPORT 0x00000002
524 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
525 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
526 #define OSC_PCI_MSI_SUPPORT 0x00000010
527 #define OSC_PCI_HPX_TYPE_3_SUPPORT 0x00000100
528 #define OSC_PCI_SUPPORT_MASKS 0x0000011f
530 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
531 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
532 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
533 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
534 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
535 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
536 #define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
537 #define OSC_PCI_CONTROL_MASKS 0x0000003f
539 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
540 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
541 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
542 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
543 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
544 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
545 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
546 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
547 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
548 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
550 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
553 /* Enable _OST when all relevant hotplug operations are enabled */
554 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
555 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
556 defined(CONFIG_ACPI_CONTAINER)
557 #define ACPI_HOTPLUG_OST
560 /* _OST Source Event Code (OSPM Action) */
561 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
562 #define ACPI_OST_EC_OSPM_EJECT 0x103
563 #define ACPI_OST_EC_OSPM_INSERTION 0x200
565 /* _OST General Processing Status Code */
566 #define ACPI_OST_SC_SUCCESS 0x0
567 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
568 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
570 /* _OST OS Shutdown Processing (0x100) Status Code */
571 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
572 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
573 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
574 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
576 /* _OST Ejection Request (0x3, 0x103) Status Code */
577 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
578 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
579 #define ACPI_OST_SC_DEVICE_BUSY 0x82
580 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
581 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
583 /* _OST Insertion Request (0x200) Status Code */
584 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
585 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
586 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
588 enum acpi_predicate {
592 greater_than_or_equal,
595 /* Table must be terminted by a NULL entry */
596 struct acpi_platform_list {
597 char oem_id[ACPI_OEM_ID_SIZE+1];
598 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
601 enum acpi_predicate pred;
605 int acpi_match_platform_list(const struct acpi_platform_list *plat);
607 extern void acpi_early_init(void);
608 extern void acpi_subsystem_init(void);
609 extern void arch_post_acpi_subsys_init(void);
611 extern int acpi_nvs_register(__u64 start, __u64 size);
613 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
616 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
617 const struct device *dev);
619 const void *acpi_device_get_match_data(const struct device *dev);
620 extern bool acpi_driver_match_device(struct device *dev,
621 const struct device_driver *drv);
622 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
623 int acpi_device_modalias(struct device *, char *, int);
624 void acpi_walk_dep_device_list(acpi_handle handle);
626 struct platform_device *acpi_create_platform_device(struct acpi_device *,
627 struct property_entry *);
628 #define ACPI_PTR(_ptr) (_ptr)
630 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
632 adev->flags.visited = true;
635 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
637 adev->flags.visited = false;
640 enum acpi_reconfig_event {
641 ACPI_RECONFIG_DEVICE_ADD = 0,
642 ACPI_RECONFIG_DEVICE_REMOVE,
645 int acpi_reconfig_notifier_register(struct notifier_block *nb);
646 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
648 #ifdef CONFIG_ACPI_GTDT
649 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
650 int acpi_gtdt_map_ppi(int type);
651 bool acpi_gtdt_c3stop(int type);
652 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
655 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
656 static inline void acpi_arch_set_root_pointer(u64 addr)
661 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
662 static inline u64 acpi_arch_get_root_pointer(void)
668 #else /* !CONFIG_ACPI */
670 #define acpi_disabled 1
672 #define ACPI_COMPANION(dev) (NULL)
673 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
674 #define ACPI_HANDLE(dev) (NULL)
675 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
676 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
678 struct fwnode_handle;
680 static inline bool acpi_dev_found(const char *hid)
685 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
690 static inline struct acpi_device *
691 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
696 static inline void acpi_dev_put(struct acpi_device *adev) {}
698 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
703 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
708 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
713 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
718 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
723 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
729 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
734 static inline bool has_acpi_companion(struct device *dev)
739 static inline void acpi_preset_companion(struct device *dev,
740 struct acpi_device *parent, u64 addr)
744 static inline const char *acpi_dev_name(struct acpi_device *adev)
749 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
754 static inline void acpi_early_init(void) { }
755 static inline void acpi_subsystem_init(void) { }
757 static inline int early_acpi_boot_init(void)
761 static inline int acpi_boot_init(void)
766 static inline void acpi_boot_table_prepare(void)
770 static inline void acpi_boot_table_init(void)
774 static inline int acpi_mps_check(void)
779 static inline int acpi_check_resource_conflict(struct resource *res)
784 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
790 struct acpi_table_header;
791 static inline int acpi_table_parse(char *id,
792 int (*handler)(struct acpi_table_header *))
797 static inline int acpi_nvs_register(__u64 start, __u64 size)
802 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
808 struct acpi_device_id;
810 static inline const struct acpi_device_id *acpi_match_device(
811 const struct acpi_device_id *ids, const struct device *dev)
816 static inline const void *acpi_device_get_match_data(const struct device *dev)
821 static inline bool acpi_driver_match_device(struct device *dev,
822 const struct device_driver *drv)
827 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
830 union acpi_object *argv4)
835 static inline int acpi_device_uevent_modalias(struct device *dev,
836 struct kobj_uevent_env *env)
841 static inline int acpi_device_modalias(struct device *dev,
847 static inline struct platform_device *
848 acpi_create_platform_device(struct acpi_device *adev,
849 struct property_entry *properties)
854 static inline bool acpi_dma_supported(struct acpi_device *adev)
859 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
861 return DEV_DMA_NOT_SUPPORTED;
864 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
865 u64 *offset, u64 *size)
870 static inline int acpi_dma_configure(struct device *dev,
871 enum dev_dma_attr attr)
876 #define ACPI_PTR(_ptr) (NULL)
878 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
882 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
886 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
891 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
896 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
901 #endif /* !CONFIG_ACPI */
903 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
904 int acpi_ioapic_add(acpi_handle root);
906 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
910 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
911 u32 pm1a_ctrl, u32 pm1b_ctrl));
913 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
914 u32 pm1a_control, u32 pm1b_control);
916 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
917 u32 val_a, u32 val_b));
919 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
920 u32 val_a, u32 val_b);
923 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
925 static inline void arch_reserve_mem_area(acpi_physical_address addr,
929 #endif /* CONFIG_X86 */
931 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
934 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
935 int acpi_dev_suspend(struct device *dev, bool wakeup);
936 int acpi_dev_resume(struct device *dev);
937 int acpi_subsys_runtime_suspend(struct device *dev);
938 int acpi_subsys_runtime_resume(struct device *dev);
939 int acpi_dev_pm_attach(struct device *dev, bool power_on);
941 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
942 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
943 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
944 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
945 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
951 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
952 int acpi_subsys_prepare(struct device *dev);
953 void acpi_subsys_complete(struct device *dev);
954 int acpi_subsys_suspend_late(struct device *dev);
955 int acpi_subsys_suspend_noirq(struct device *dev);
956 int acpi_subsys_suspend(struct device *dev);
957 int acpi_subsys_freeze(struct device *dev);
958 int acpi_subsys_poweroff(struct device *dev);
959 void acpi_ec_mark_gpe_for_wake(void);
960 void acpi_ec_set_gpe_wake_mask(u8 action);
962 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
963 static inline void acpi_subsys_complete(struct device *dev) {}
964 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
965 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
966 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
967 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
968 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
969 static inline void acpi_ec_mark_gpe_for_wake(void) {}
970 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
975 void acpi_handle_printk(const char *level, acpi_handle handle,
976 const char *fmt, ...);
977 #else /* !CONFIG_ACPI */
978 static inline __printf(3, 4) void
979 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
980 #endif /* !CONFIG_ACPI */
982 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
984 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
988 * acpi_handle_<level>: Print message with ACPI prefix and object path
990 * These interfaces acquire the global namespace mutex to obtain an object
991 * path. In interrupt context, it shows the object path as <n/a>.
993 #define acpi_handle_emerg(handle, fmt, ...) \
994 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
995 #define acpi_handle_alert(handle, fmt, ...) \
996 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
997 #define acpi_handle_crit(handle, fmt, ...) \
998 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
999 #define acpi_handle_err(handle, fmt, ...) \
1000 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1001 #define acpi_handle_warn(handle, fmt, ...) \
1002 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1003 #define acpi_handle_notice(handle, fmt, ...) \
1004 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1005 #define acpi_handle_info(handle, fmt, ...) \
1006 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1009 #define acpi_handle_debug(handle, fmt, ...) \
1010 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1012 #if defined(CONFIG_DYNAMIC_DEBUG)
1013 #define acpi_handle_debug(handle, fmt, ...) \
1014 _dynamic_func_call(fmt, __acpi_handle_debug, \
1015 handle, pr_fmt(fmt), ##__VA_ARGS__)
1017 #define acpi_handle_debug(handle, fmt, ...) \
1020 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1026 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1027 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1028 struct acpi_resource_gpio **agpio);
1029 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
1031 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1032 struct acpi_resource_gpio **agpio)
1036 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1042 /* Device properties */
1045 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1046 acpi_object_type type, const union acpi_object **obj);
1047 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1048 const char *name, size_t index, size_t num_args,
1049 struct fwnode_reference_args *args);
1051 static inline int acpi_node_get_property_reference(
1052 const struct fwnode_handle *fwnode,
1053 const char *name, size_t index,
1054 struct fwnode_reference_args *args)
1056 return __acpi_node_get_property_reference(fwnode, name, index,
1057 NR_FWNODE_REFERENCE_ARGS, args);
1060 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1062 return !list_empty(&adev->data.properties);
1065 struct acpi_device_properties *
1066 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1067 const union acpi_object *properties);
1069 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1071 int acpi_dev_prop_read_single(struct acpi_device *adev,
1072 const char *propname, enum dev_prop_type proptype,
1074 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1075 const char *propname, enum dev_prop_type proptype,
1076 void *val, size_t nval);
1077 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
1078 enum dev_prop_type proptype, void *val, size_t nval);
1080 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1081 struct fwnode_handle *child);
1082 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
1084 struct acpi_probe_entry;
1085 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1086 struct acpi_probe_entry *);
1088 #define ACPI_TABLE_ID_LEN 5
1091 * struct acpi_probe_entry - boot-time probing entry
1092 * @id: ACPI table name
1093 * @type: Optional subtable type to match
1094 * (if @id contains subtables)
1095 * @subtable_valid: Optional callback to check the validity of
1097 * @probe_table: Callback to the driver being probed when table
1098 * match is successful
1099 * @probe_subtbl: Callback to the driver being probed when table and
1100 * subtable match (and optional callback is successful)
1101 * @driver_data: Sideband data provided back to the driver
1103 struct acpi_probe_entry {
1104 __u8 id[ACPI_TABLE_ID_LEN];
1106 acpi_probe_entry_validate_subtbl subtable_valid;
1108 acpi_tbl_table_handler probe_table;
1109 acpi_tbl_entry_handler probe_subtbl;
1111 kernel_ulong_t driver_data;
1114 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1115 static const struct acpi_probe_entry __acpi_probe_##name \
1116 __used __section(__##table##_acpi_probe_table) \
1120 .subtable_valid = valid, \
1121 .probe_table = (acpi_tbl_table_handler)fn, \
1122 .driver_data = data, \
1125 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1126 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1128 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1130 #define acpi_probe_device_table(t) \
1132 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1133 ACPI_PROBE_TABLE_END(t); \
1134 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1135 (&ACPI_PROBE_TABLE_END(t) - \
1136 &ACPI_PROBE_TABLE(t))); \
1139 static inline int acpi_dev_get_property(struct acpi_device *adev,
1140 const char *name, acpi_object_type type,
1141 const union acpi_object **obj)
1147 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1148 const char *name, size_t index, size_t num_args,
1149 struct fwnode_reference_args *args)
1155 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1156 const char *name, size_t index,
1157 struct fwnode_reference_args *args)
1162 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1163 const char *propname,
1169 static inline int acpi_dev_prop_get(const struct acpi_device *adev,
1170 const char *propname,
1176 static inline int acpi_dev_prop_read_single(const struct acpi_device *adev,
1177 const char *propname,
1178 enum dev_prop_type proptype,
1184 static inline int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1185 const char *propname,
1186 enum dev_prop_type proptype,
1187 void *val, size_t nval)
1192 static inline int acpi_dev_prop_read(const struct acpi_device *adev,
1193 const char *propname,
1194 enum dev_prop_type proptype,
1195 void *val, size_t nval)
1200 static inline struct fwnode_handle *
1201 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1202 struct fwnode_handle *child)
1207 static inline struct fwnode_handle *
1208 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1213 static inline struct fwnode_handle *
1214 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1215 struct fwnode_handle *prev)
1217 return ERR_PTR(-ENXIO);
1221 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1222 struct fwnode_handle **remote,
1223 struct fwnode_handle **port,
1224 struct fwnode_handle **endpoint)
1229 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1230 static const void * __acpi_table_##name[] \
1231 __attribute__((unused)) \
1232 = { (void *) table_id, \
1233 (void *) subtable, \
1238 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1241 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1242 void acpi_table_upgrade(void);
1244 static inline void acpi_table_upgrade(void) { }
1247 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1248 extern bool acpi_has_watchdog(void);
1250 static inline bool acpi_has_watchdog(void) { return false; }
1253 #ifdef CONFIG_ACPI_SPCR_TABLE
1254 extern bool qdf2400_e44_present;
1255 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1257 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1263 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1264 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1267 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1273 #ifdef CONFIG_ACPI_LPIT
1274 int lpit_read_residency_count_address(u64 *address);
1276 static inline int lpit_read_residency_count_address(u64 *address)
1282 #ifdef CONFIG_ACPI_PPTT
1283 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1284 int find_acpi_cpu_topology(unsigned int cpu, int level);
1285 int find_acpi_cpu_topology_package(unsigned int cpu);
1286 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1287 int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
1289 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1293 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1297 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1301 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1305 static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1312 extern int acpi_platform_notify(struct device *dev, enum kobject_action action);
1315 acpi_platform_notify(struct device *dev, enum kobject_action action)
1321 #endif /*_LINUX_ACPI_H*/