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_init(fwnode, &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;
135 struct acpi_prmt_module_header prmt;
138 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
140 typedef int (*acpi_tbl_entry_handler)(union acpi_subtable_headers *header,
141 const unsigned long end);
143 /* Debugger support */
145 struct acpi_debugger_ops {
146 int (*create_thread)(acpi_osd_exec_callback function, void *context);
147 ssize_t (*write_log)(const char *msg);
148 ssize_t (*read_cmd)(char *buffer, size_t length);
149 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
150 int (*notify_command_complete)(void);
153 struct acpi_debugger {
154 const struct acpi_debugger_ops *ops;
155 struct module *owner;
159 #ifdef CONFIG_ACPI_DEBUGGER
160 int __init acpi_debugger_init(void);
161 int acpi_register_debugger(struct module *owner,
162 const struct acpi_debugger_ops *ops);
163 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
164 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
165 ssize_t acpi_debugger_write_log(const char *msg);
166 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
167 int acpi_debugger_wait_command_ready(void);
168 int acpi_debugger_notify_command_complete(void);
170 static inline int acpi_debugger_init(void)
175 static inline int acpi_register_debugger(struct module *owner,
176 const struct acpi_debugger_ops *ops)
181 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
185 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
191 static inline int acpi_debugger_write_log(const char *msg)
196 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
201 static inline int acpi_debugger_wait_command_ready(void)
206 static inline int acpi_debugger_notify_command_complete(void)
212 #define BAD_MADT_ENTRY(entry, end) ( \
213 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
214 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
216 struct acpi_subtable_proc {
218 acpi_tbl_entry_handler handler;
222 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
223 void __acpi_unmap_table(void __iomem *map, unsigned long size);
224 int early_acpi_boot_init(void);
225 int acpi_boot_init (void);
226 void acpi_boot_table_prepare (void);
227 void acpi_boot_table_init (void);
228 int acpi_mps_check (void);
229 int acpi_numa_init (void);
231 int acpi_locate_initial_tables (void);
232 void acpi_reserve_initial_tables (void);
233 void acpi_table_init_complete (void);
234 int acpi_table_init (void);
235 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
236 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
238 acpi_tbl_entry_handler handler,
239 unsigned int max_entries);
240 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
241 struct acpi_subtable_proc *proc, int proc_num,
242 unsigned int max_entries);
243 int acpi_table_parse_madt(enum acpi_madt_type id,
244 acpi_tbl_entry_handler handler,
245 unsigned int max_entries);
246 int acpi_parse_mcfg (struct acpi_table_header *header);
247 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
249 /* the following numa functions are architecture-dependent */
250 void acpi_numa_slit_init (struct acpi_table_slit *slit);
252 #if defined(CONFIG_X86) || defined(CONFIG_IA64) || defined(CONFIG_LOONGARCH)
253 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
256 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
259 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
262 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
263 void acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size);
266 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
268 acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size) { }
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);
290 /* Processor _CTS control */
291 struct acpi_processor_power;
293 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
294 bool acpi_processor_claim_cst_control(void);
295 int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
296 struct acpi_processor_power *info);
298 static inline bool acpi_processor_claim_cst_control(void) { return false; }
299 static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
300 struct acpi_processor_power *info)
306 #ifdef CONFIG_ACPI_HOTPLUG_CPU
307 /* Arch dependent functions for cpu hotplug support */
308 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
310 int acpi_unmap_cpu(int cpu);
311 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
313 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
314 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
317 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
318 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
319 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
320 void acpi_irq_stats_init(void);
321 extern u32 acpi_irq_handled;
322 extern u32 acpi_irq_not_handled;
323 extern unsigned int acpi_sci_irq;
324 extern bool acpi_no_s5;
325 #define INVALID_ACPI_IRQ ((unsigned)-1)
326 static inline bool acpi_sci_irq_valid(void)
328 return acpi_sci_irq != INVALID_ACPI_IRQ;
332 extern unsigned long acpi_realmode_flags;
334 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
335 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
336 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
338 void acpi_set_irq_model(enum acpi_irq_model_id model,
339 struct fwnode_handle *fwnode);
341 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
343 struct fwnode_handle *fwnode,
344 const struct irq_domain_ops *ops,
347 #ifdef CONFIG_X86_IO_APIC
348 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
350 static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
356 * This function undoes the effect of one call to acpi_register_gsi().
357 * If this matches the last registration, any IRQ resources for gsi
360 void acpi_unregister_gsi (u32 gsi);
364 int acpi_pci_irq_enable (struct pci_dev *dev);
365 void acpi_penalize_isa_irq(int irq, int active);
366 bool acpi_isa_irq_available(int irq);
368 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
370 static inline void acpi_penalize_sci_irq(int irq, int trigger,
375 void acpi_pci_irq_disable (struct pci_dev *dev);
377 extern int ec_read(u8 addr, u8 *val);
378 extern int ec_write(u8 addr, u8 val);
379 extern int ec_transaction(u8 command,
380 const u8 *wdata, unsigned wdata_len,
381 u8 *rdata, unsigned rdata_len);
382 extern acpi_handle ec_get_handle(void);
384 extern bool acpi_is_pnp_device(struct acpi_device *);
386 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
388 typedef void (*wmi_notify_handler) (u32 value, void *context);
390 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
392 const struct acpi_buffer *in,
393 struct acpi_buffer *out);
394 extern acpi_status wmi_query_block(const char *guid, u8 instance,
395 struct acpi_buffer *out);
396 extern acpi_status wmi_set_block(const char *guid, u8 instance,
397 const struct acpi_buffer *in);
398 extern acpi_status wmi_install_notify_handler(const char *guid,
399 wmi_notify_handler handler, void *data);
400 extern acpi_status wmi_remove_notify_handler(const char *guid);
401 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
402 extern bool wmi_has_guid(const char *guid);
403 extern char *wmi_get_acpi_device_uid(const char *guid);
405 #endif /* CONFIG_ACPI_WMI */
407 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
408 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
409 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
410 #define ACPI_VIDEO_BACKLIGHT 0x0008
411 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
412 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
413 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
414 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
415 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
416 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
417 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
418 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
420 extern char acpi_video_backlight_string[];
421 extern long acpi_is_video_device(acpi_handle handle);
422 extern int acpi_blacklisted(void);
423 extern void acpi_osi_setup(char *str);
424 extern bool acpi_osi_is_win8(void);
426 #ifdef CONFIG_ACPI_NUMA
427 int acpi_map_pxm_to_node(int pxm);
428 int acpi_get_node(acpi_handle handle);
431 * pxm_to_online_node - Map proximity ID to online node
432 * @pxm: ACPI proximity ID
434 * This is similar to pxm_to_node(), but always returns an online
435 * node. When the mapped node from a given proximity ID is offline, it
436 * looks up the node distance table and returns the nearest online node.
438 * ACPI device drivers, which are called after the NUMA initialization has
439 * completed in the kernel, can call this interface to obtain their device
440 * NUMA topology from ACPI tables. Such drivers do not have to deal with
441 * offline nodes. A node may be offline when SRAT memory entry does not exist,
442 * or NUMA is disabled, ex. "numa=off" on x86.
444 static inline int pxm_to_online_node(int pxm)
446 int node = pxm_to_node(pxm);
448 return numa_map_to_online_node(node);
451 static inline int pxm_to_online_node(int pxm)
455 static inline int acpi_map_pxm_to_node(int pxm)
459 static inline int acpi_get_node(acpi_handle handle)
464 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
466 extern int pnpacpi_disabled;
468 #define PXM_INVAL (-1)
470 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
471 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
472 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
473 struct resource_win *win);
474 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
475 struct resource_win *win);
476 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
477 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
478 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
479 struct resource *res);
481 void acpi_dev_free_resource_list(struct list_head *list);
482 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
483 int (*preproc)(struct acpi_resource *, void *),
485 int acpi_dev_get_dma_resources(struct acpi_device *adev,
486 struct list_head *list);
487 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
488 unsigned long types);
490 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
493 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
496 struct acpi_device *acpi_resource_consumer(struct resource *res);
498 int acpi_check_resource_conflict(const struct resource *res);
500 int acpi_check_region(resource_size_t start, resource_size_t n,
503 acpi_status acpi_release_memory(acpi_handle handle, struct resource *res,
506 int acpi_resources_are_enforced(void);
508 #ifdef CONFIG_HIBERNATION
509 void __init acpi_no_s4_hw_signature(void);
512 #ifdef CONFIG_PM_SLEEP
513 void __init acpi_old_suspend_ordering(void);
514 void __init acpi_nvs_nosave(void);
515 void __init acpi_nvs_nosave_s3(void);
516 void __init acpi_sleep_no_blacklist(void);
517 #endif /* CONFIG_PM_SLEEP */
519 int acpi_register_wakeup_handler(
520 int wake_irq, bool (*wakeup)(void *context), void *context);
521 void acpi_unregister_wakeup_handler(
522 bool (*wakeup)(void *context), void *context);
524 struct acpi_osc_context {
525 char *uuid_str; /* UUID string */
527 struct acpi_buffer cap; /* list of DWORD capabilities */
528 struct acpi_buffer ret; /* free by caller if success */
531 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
533 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
534 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
535 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
536 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
538 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
539 #define OSC_QUERY_ENABLE 0x00000001 /* input */
540 #define OSC_REQUEST_ERROR 0x00000002 /* return */
541 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
542 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
543 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
545 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
546 #define OSC_SB_PAD_SUPPORT 0x00000001
547 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
548 #define OSC_SB_PR3_SUPPORT 0x00000004
549 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
550 #define OSC_SB_APEI_SUPPORT 0x00000010
551 #define OSC_SB_CPC_SUPPORT 0x00000020
552 #define OSC_SB_CPCV2_SUPPORT 0x00000040
553 #define OSC_SB_PCLPI_SUPPORT 0x00000080
554 #define OSC_SB_OSLPI_SUPPORT 0x00000100
555 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
556 #define OSC_SB_GENERIC_INITIATOR_SUPPORT 0x00002000
557 #define OSC_SB_NATIVE_USB4_SUPPORT 0x00040000
558 #define OSC_SB_PRM_SUPPORT 0x00200000
560 extern bool osc_sb_apei_support_acked;
561 extern bool osc_pc_lpi_support_confirmed;
562 extern bool osc_sb_native_usb4_support_confirmed;
564 /* USB4 Capabilities */
565 #define OSC_USB_USB3_TUNNELING 0x00000001
566 #define OSC_USB_DP_TUNNELING 0x00000002
567 #define OSC_USB_PCIE_TUNNELING 0x00000004
568 #define OSC_USB_XDOMAIN 0x00000008
570 extern u32 osc_sb_native_usb4_control;
572 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
573 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
574 #define OSC_PCI_ASPM_SUPPORT 0x00000002
575 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
576 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
577 #define OSC_PCI_MSI_SUPPORT 0x00000010
578 #define OSC_PCI_EDR_SUPPORT 0x00000080
579 #define OSC_PCI_HPX_TYPE_3_SUPPORT 0x00000100
581 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
582 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
583 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
584 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
585 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
586 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
587 #define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
588 #define OSC_PCI_EXPRESS_DPC_CONTROL 0x00000080
590 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
591 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
592 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
593 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
594 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
595 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
596 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
597 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
598 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
599 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
601 /* Enable _OST when all relevant hotplug operations are enabled */
602 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
603 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
604 defined(CONFIG_ACPI_CONTAINER)
605 #define ACPI_HOTPLUG_OST
608 /* _OST Source Event Code (OSPM Action) */
609 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
610 #define ACPI_OST_EC_OSPM_EJECT 0x103
611 #define ACPI_OST_EC_OSPM_INSERTION 0x200
613 /* _OST General Processing Status Code */
614 #define ACPI_OST_SC_SUCCESS 0x0
615 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
616 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
618 /* _OST OS Shutdown Processing (0x100) Status Code */
619 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
620 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
621 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
622 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
624 /* _OST Ejection Request (0x3, 0x103) Status Code */
625 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
626 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
627 #define ACPI_OST_SC_DEVICE_BUSY 0x82
628 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
629 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
631 /* _OST Insertion Request (0x200) Status Code */
632 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
633 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
634 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
636 enum acpi_predicate {
640 greater_than_or_equal,
643 /* Table must be terminted by a NULL entry */
644 struct acpi_platform_list {
645 char oem_id[ACPI_OEM_ID_SIZE+1];
646 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
649 enum acpi_predicate pred;
653 int acpi_match_platform_list(const struct acpi_platform_list *plat);
655 extern void acpi_early_init(void);
656 extern void acpi_subsystem_init(void);
657 extern void arch_post_acpi_subsys_init(void);
659 extern int acpi_nvs_register(__u64 start, __u64 size);
661 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
664 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
665 const struct device *dev);
667 const void *acpi_device_get_match_data(const struct device *dev);
668 extern bool acpi_driver_match_device(struct device *dev,
669 const struct device_driver *drv);
670 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
671 int acpi_device_modalias(struct device *, char *, int);
673 struct platform_device *acpi_create_platform_device(struct acpi_device *,
674 struct property_entry *);
675 #define ACPI_PTR(_ptr) (_ptr)
677 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
679 adev->flags.visited = true;
682 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
684 adev->flags.visited = false;
687 enum acpi_reconfig_event {
688 ACPI_RECONFIG_DEVICE_ADD = 0,
689 ACPI_RECONFIG_DEVICE_REMOVE,
692 int acpi_reconfig_notifier_register(struct notifier_block *nb);
693 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
695 #ifdef CONFIG_ACPI_GTDT
696 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
697 int acpi_gtdt_map_ppi(int type);
698 bool acpi_gtdt_c3stop(int type);
699 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
702 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
703 static inline void acpi_arch_set_root_pointer(u64 addr)
708 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
709 static inline u64 acpi_arch_get_root_pointer(void)
715 int acpi_get_local_address(acpi_handle handle, u32 *addr);
717 #else /* !CONFIG_ACPI */
719 #define acpi_disabled 1
721 #define ACPI_COMPANION(dev) (NULL)
722 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
723 #define ACPI_HANDLE(dev) (NULL)
724 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
725 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
727 #include <acpi/acpi_numa.h>
729 struct fwnode_handle;
731 static inline bool acpi_dev_found(const char *hid)
736 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
744 acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2)
749 static inline struct acpi_device *
750 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
755 static inline bool acpi_reduced_hardware(void)
760 static inline void acpi_dev_put(struct acpi_device *adev) {}
762 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
767 static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
772 static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
777 static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
782 static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
787 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
793 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
798 static inline bool has_acpi_companion(struct device *dev)
803 static inline void acpi_preset_companion(struct device *dev,
804 struct acpi_device *parent, u64 addr)
808 static inline const char *acpi_dev_name(struct acpi_device *adev)
813 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
818 static inline void acpi_early_init(void) { }
819 static inline void acpi_subsystem_init(void) { }
821 static inline int early_acpi_boot_init(void)
825 static inline int acpi_boot_init(void)
830 static inline void acpi_boot_table_prepare(void)
834 static inline void acpi_boot_table_init(void)
838 static inline int acpi_mps_check(void)
843 static inline int acpi_check_resource_conflict(struct resource *res)
848 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
854 struct acpi_table_header;
855 static inline int acpi_table_parse(char *id,
856 int (*handler)(struct acpi_table_header *))
861 static inline int acpi_nvs_register(__u64 start, __u64 size)
866 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
872 struct acpi_device_id;
874 static inline const struct acpi_device_id *acpi_match_device(
875 const struct acpi_device_id *ids, const struct device *dev)
880 static inline const void *acpi_device_get_match_data(const struct device *dev)
885 static inline bool acpi_driver_match_device(struct device *dev,
886 const struct device_driver *drv)
891 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
894 union acpi_object *argv4)
899 static inline int acpi_device_uevent_modalias(struct device *dev,
900 struct kobj_uevent_env *env)
905 static inline int acpi_device_modalias(struct device *dev,
911 static inline struct platform_device *
912 acpi_create_platform_device(struct acpi_device *adev,
913 struct property_entry *properties)
918 static inline bool acpi_dma_supported(const struct acpi_device *adev)
923 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
925 return DEV_DMA_NOT_SUPPORTED;
928 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
929 u64 *offset, u64 *size)
934 static inline int acpi_dma_configure(struct device *dev,
935 enum dev_dma_attr attr)
940 static inline int acpi_dma_configure_id(struct device *dev,
941 enum dev_dma_attr attr,
947 #define ACPI_PTR(_ptr) (NULL)
949 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
953 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
957 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
962 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
967 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
972 static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
977 #endif /* !CONFIG_ACPI */
979 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
980 int acpi_ioapic_add(acpi_handle root);
982 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
986 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
987 u32 pm1a_ctrl, u32 pm1b_ctrl));
989 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
990 u32 pm1a_control, u32 pm1b_control);
992 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
993 u32 val_a, u32 val_b));
995 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
996 u32 val_a, u32 val_b);
999 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1001 static inline void arch_reserve_mem_area(acpi_physical_address addr,
1005 #endif /* CONFIG_X86 */
1007 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1010 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1011 int acpi_dev_suspend(struct device *dev, bool wakeup);
1012 int acpi_dev_resume(struct device *dev);
1013 int acpi_subsys_runtime_suspend(struct device *dev);
1014 int acpi_subsys_runtime_resume(struct device *dev);
1015 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1016 bool acpi_storage_d3(struct device *dev);
1018 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1019 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1020 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1024 static inline bool acpi_storage_d3(struct device *dev)
1030 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1031 int acpi_subsys_prepare(struct device *dev);
1032 void acpi_subsys_complete(struct device *dev);
1033 int acpi_subsys_suspend_late(struct device *dev);
1034 int acpi_subsys_suspend_noirq(struct device *dev);
1035 int acpi_subsys_suspend(struct device *dev);
1036 int acpi_subsys_freeze(struct device *dev);
1037 int acpi_subsys_poweroff(struct device *dev);
1038 void acpi_ec_mark_gpe_for_wake(void);
1039 void acpi_ec_set_gpe_wake_mask(u8 action);
1041 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1042 static inline void acpi_subsys_complete(struct device *dev) {}
1043 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1044 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1045 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1046 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1047 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1048 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1049 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1054 void acpi_handle_printk(const char *level, acpi_handle handle,
1055 const char *fmt, ...);
1056 void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1057 acpi_status status);
1058 #else /* !CONFIG_ACPI */
1059 static inline __printf(3, 4) void
1060 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1061 static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1063 acpi_status status) {}
1064 #endif /* !CONFIG_ACPI */
1066 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1068 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1072 * acpi_handle_<level>: Print message with ACPI prefix and object path
1074 * These interfaces acquire the global namespace mutex to obtain an object
1075 * path. In interrupt context, it shows the object path as <n/a>.
1077 #define acpi_handle_emerg(handle, fmt, ...) \
1078 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1079 #define acpi_handle_alert(handle, fmt, ...) \
1080 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1081 #define acpi_handle_crit(handle, fmt, ...) \
1082 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1083 #define acpi_handle_err(handle, fmt, ...) \
1084 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1085 #define acpi_handle_warn(handle, fmt, ...) \
1086 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1087 #define acpi_handle_notice(handle, fmt, ...) \
1088 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1089 #define acpi_handle_info(handle, fmt, ...) \
1090 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1093 #define acpi_handle_debug(handle, fmt, ...) \
1094 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1096 #if defined(CONFIG_DYNAMIC_DEBUG)
1097 #define acpi_handle_debug(handle, fmt, ...) \
1098 _dynamic_func_call(fmt, __acpi_handle_debug, \
1099 handle, pr_fmt(fmt), ##__VA_ARGS__)
1101 #define acpi_handle_debug(handle, fmt, ...) \
1104 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1110 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1111 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1112 struct acpi_resource_gpio **agpio);
1113 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1114 struct acpi_resource_gpio **agpio);
1115 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index);
1117 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1118 struct acpi_resource_gpio **agpio)
1122 static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1123 struct acpi_resource_gpio **agpio)
1127 static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev,
1128 const char *name, int index)
1134 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1136 return acpi_dev_gpio_irq_get_by(adev, NULL, index);
1139 /* Device properties */
1142 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1143 acpi_object_type type, const union acpi_object **obj);
1144 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1145 const char *name, size_t index, size_t num_args,
1146 struct fwnode_reference_args *args);
1148 static inline int acpi_node_get_property_reference(
1149 const struct fwnode_handle *fwnode,
1150 const char *name, size_t index,
1151 struct fwnode_reference_args *args)
1153 return __acpi_node_get_property_reference(fwnode, name, index,
1154 NR_FWNODE_REFERENCE_ARGS, args);
1157 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1159 return !list_empty(&adev->data.properties);
1162 struct acpi_device_properties *
1163 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1164 const union acpi_object *properties);
1166 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1169 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1170 struct fwnode_handle *child);
1171 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
1173 struct acpi_probe_entry;
1174 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1175 struct acpi_probe_entry *);
1177 #define ACPI_TABLE_ID_LEN 5
1180 * struct acpi_probe_entry - boot-time probing entry
1181 * @id: ACPI table name
1182 * @type: Optional subtable type to match
1183 * (if @id contains subtables)
1184 * @subtable_valid: Optional callback to check the validity of
1186 * @probe_table: Callback to the driver being probed when table
1187 * match is successful
1188 * @probe_subtbl: Callback to the driver being probed when table and
1189 * subtable match (and optional callback is successful)
1190 * @driver_data: Sideband data provided back to the driver
1192 struct acpi_probe_entry {
1193 __u8 id[ACPI_TABLE_ID_LEN];
1195 acpi_probe_entry_validate_subtbl subtable_valid;
1197 acpi_tbl_table_handler probe_table;
1198 acpi_tbl_entry_handler probe_subtbl;
1200 kernel_ulong_t driver_data;
1203 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, \
1205 static const struct acpi_probe_entry __acpi_probe_##name \
1206 __used __section("__" #table "_acpi_probe_table") = { \
1209 .subtable_valid = valid, \
1210 .probe_table = fn, \
1211 .driver_data = data, \
1214 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id, \
1215 subtable, valid, data, fn) \
1216 static const struct acpi_probe_entry __acpi_probe_##name \
1217 __used __section("__" #table "_acpi_probe_table") = { \
1220 .subtable_valid = valid, \
1221 .probe_subtbl = fn, \
1222 .driver_data = data, \
1225 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1226 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1228 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1230 #define acpi_probe_device_table(t) \
1232 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1233 ACPI_PROBE_TABLE_END(t); \
1234 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1235 (&ACPI_PROBE_TABLE_END(t) - \
1236 &ACPI_PROBE_TABLE(t))); \
1239 static inline int acpi_dev_get_property(struct acpi_device *adev,
1240 const char *name, acpi_object_type type,
1241 const union acpi_object **obj)
1247 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1248 const char *name, size_t index, size_t num_args,
1249 struct fwnode_reference_args *args)
1255 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1256 const char *name, size_t index,
1257 struct fwnode_reference_args *args)
1262 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1263 const char *propname,
1269 static inline struct fwnode_handle *
1270 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1271 struct fwnode_handle *child)
1276 static inline struct fwnode_handle *
1277 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1282 static inline struct fwnode_handle *
1283 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1284 struct fwnode_handle *prev)
1286 return ERR_PTR(-ENXIO);
1290 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1291 struct fwnode_handle **remote,
1292 struct fwnode_handle **port,
1293 struct fwnode_handle **endpoint)
1298 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1299 static const void * __acpi_table_##name[] \
1300 __attribute__((unused)) \
1301 = { (void *) table_id, \
1302 (void *) subtable, \
1307 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1310 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1311 void acpi_table_upgrade(void);
1313 static inline void acpi_table_upgrade(void) { }
1316 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1317 extern bool acpi_has_watchdog(void);
1319 static inline bool acpi_has_watchdog(void) { return false; }
1322 #ifdef CONFIG_ACPI_SPCR_TABLE
1323 extern bool qdf2400_e44_present;
1324 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1326 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1332 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1333 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1336 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1342 #ifdef CONFIG_ACPI_LPIT
1343 int lpit_read_residency_count_address(u64 *address);
1345 static inline int lpit_read_residency_count_address(u64 *address)
1351 #ifdef CONFIG_ACPI_PPTT
1352 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1353 int find_acpi_cpu_topology(unsigned int cpu, int level);
1354 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1355 int find_acpi_cpu_topology_package(unsigned int cpu);
1356 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1357 int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
1359 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1363 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1367 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1371 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1375 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1379 static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1386 extern void acpi_device_notify(struct device *dev);
1387 extern void acpi_device_notify_remove(struct device *dev);
1389 static inline void acpi_device_notify(struct device *dev) { }
1390 static inline void acpi_device_notify_remove(struct device *dev) { }
1393 #endif /*_LINUX_ACPI_H*/