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
;
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
);
282 /* Processor _CTS control */
283 struct acpi_processor_power
;
285 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
286 bool acpi_processor_claim_cst_control(void);
287 int acpi_processor_evaluate_cst(acpi_handle handle
, u32 cpu
,
288 struct acpi_processor_power
*info
);
290 static inline bool acpi_processor_claim_cst_control(void) { return false; }
291 static inline int acpi_processor_evaluate_cst(acpi_handle handle
, u32 cpu
,
292 struct acpi_processor_power
*info
)
298 #ifdef CONFIG_ACPI_HOTPLUG_CPU
299 /* Arch dependent functions for cpu hotplug support */
300 int acpi_map_cpu(acpi_handle handle
, phys_cpuid_t physid
, u32 acpi_id
,
302 int acpi_unmap_cpu(int cpu
);
303 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
305 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
306 int acpi_get_ioapic_id(acpi_handle handle
, u32 gsi_base
, u64
*phys_addr
);
309 int acpi_register_ioapic(acpi_handle handle
, u64 phys_addr
, u32 gsi_base
);
310 int acpi_unregister_ioapic(acpi_handle handle
, u32 gsi_base
);
311 int acpi_ioapic_registered(acpi_handle handle
, u32 gsi_base
);
312 void acpi_irq_stats_init(void);
313 extern u32 acpi_irq_handled
;
314 extern u32 acpi_irq_not_handled
;
315 extern unsigned int acpi_sci_irq
;
316 extern bool acpi_no_s5
;
317 #define INVALID_ACPI_IRQ ((unsigned)-1)
318 static inline bool acpi_sci_irq_valid(void)
320 return acpi_sci_irq
!= INVALID_ACPI_IRQ
;
324 extern unsigned long acpi_realmode_flags
;
326 int acpi_register_gsi (struct device
*dev
, u32 gsi
, int triggering
, int polarity
);
327 int acpi_gsi_to_irq (u32 gsi
, unsigned int *irq
);
328 int acpi_isa_irq_to_gsi (unsigned isa_irq
, u32
*gsi
);
330 void acpi_set_irq_model(enum acpi_irq_model_id model
,
331 struct fwnode_handle
*fwnode
);
333 struct irq_domain
*acpi_irq_create_hierarchy(unsigned int flags
,
335 struct fwnode_handle
*fwnode
,
336 const struct irq_domain_ops
*ops
,
339 #ifdef CONFIG_X86_IO_APIC
340 extern int acpi_get_override_irq(u32 gsi
, int *trigger
, int *polarity
);
342 static inline int acpi_get_override_irq(u32 gsi
, int *trigger
, int *polarity
)
348 * This function undoes the effect of one call to acpi_register_gsi().
349 * If this matches the last registration, any IRQ resources for gsi
352 void acpi_unregister_gsi (u32 gsi
);
356 int acpi_pci_irq_enable (struct pci_dev
*dev
);
357 void acpi_penalize_isa_irq(int irq
, int active
);
358 bool acpi_isa_irq_available(int irq
);
360 void acpi_penalize_sci_irq(int irq
, int trigger
, int polarity
);
362 static inline void acpi_penalize_sci_irq(int irq
, int trigger
,
367 void acpi_pci_irq_disable (struct pci_dev
*dev
);
369 extern int ec_read(u8 addr
, u8
*val
);
370 extern int ec_write(u8 addr
, u8 val
);
371 extern int ec_transaction(u8 command
,
372 const u8
*wdata
, unsigned wdata_len
,
373 u8
*rdata
, unsigned rdata_len
);
374 extern acpi_handle
ec_get_handle(void);
376 extern bool acpi_is_pnp_device(struct acpi_device
*);
378 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
380 typedef void (*wmi_notify_handler
) (u32 value
, void *context
);
382 extern acpi_status
wmi_evaluate_method(const char *guid
, u8 instance
,
384 const struct acpi_buffer
*in
,
385 struct acpi_buffer
*out
);
386 extern acpi_status
wmi_query_block(const char *guid
, u8 instance
,
387 struct acpi_buffer
*out
);
388 extern acpi_status
wmi_set_block(const char *guid
, u8 instance
,
389 const struct acpi_buffer
*in
);
390 extern acpi_status
wmi_install_notify_handler(const char *guid
,
391 wmi_notify_handler handler
, void *data
);
392 extern acpi_status
wmi_remove_notify_handler(const char *guid
);
393 extern acpi_status
wmi_get_event_data(u32 event
, struct acpi_buffer
*out
);
394 extern bool wmi_has_guid(const char *guid
);
395 extern char *wmi_get_acpi_device_uid(const char *guid
);
397 #endif /* CONFIG_ACPI_WMI */
399 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
400 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
401 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
402 #define ACPI_VIDEO_BACKLIGHT 0x0008
403 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
404 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
405 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
406 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
407 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
408 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
409 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
410 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
412 extern char acpi_video_backlight_string
[];
413 extern long acpi_is_video_device(acpi_handle handle
);
414 extern int acpi_blacklisted(void);
415 extern void acpi_osi_setup(char *str
);
416 extern bool acpi_osi_is_win8(void);
418 #ifdef CONFIG_ACPI_NUMA
419 int acpi_map_pxm_to_node(int pxm
);
420 int acpi_get_node(acpi_handle handle
);
423 * pxm_to_online_node - Map proximity ID to online node
424 * @pxm: ACPI proximity ID
426 * This is similar to pxm_to_node(), but always returns an online
427 * node. When the mapped node from a given proximity ID is offline, it
428 * looks up the node distance table and returns the nearest online node.
430 * ACPI device drivers, which are called after the NUMA initialization has
431 * completed in the kernel, can call this interface to obtain their device
432 * NUMA topology from ACPI tables. Such drivers do not have to deal with
433 * offline nodes. A node may be offline when SRAT memory entry does not exist,
434 * or NUMA is disabled, ex. "numa=off" on x86.
436 static inline int pxm_to_online_node(int pxm
)
438 int node
= pxm_to_node(pxm
);
440 return numa_map_to_online_node(node
);
443 static inline int pxm_to_online_node(int pxm
)
447 static inline int acpi_map_pxm_to_node(int pxm
)
451 static inline int acpi_get_node(acpi_handle handle
)
456 extern int acpi_paddr_to_node(u64 start_addr
, u64 size
);
458 extern int pnpacpi_disabled
;
460 #define PXM_INVAL (-1)
462 bool acpi_dev_resource_memory(struct acpi_resource
*ares
, struct resource
*res
);
463 bool acpi_dev_resource_io(struct acpi_resource
*ares
, struct resource
*res
);
464 bool acpi_dev_resource_address_space(struct acpi_resource
*ares
,
465 struct resource_win
*win
);
466 bool acpi_dev_resource_ext_address_space(struct acpi_resource
*ares
,
467 struct resource_win
*win
);
468 unsigned long acpi_dev_irq_flags(u8 triggering
, u8 polarity
, u8 shareable
);
469 unsigned int acpi_dev_get_irq_type(int triggering
, int polarity
);
470 bool acpi_dev_resource_interrupt(struct acpi_resource
*ares
, int index
,
471 struct resource
*res
);
473 void acpi_dev_free_resource_list(struct list_head
*list
);
474 int acpi_dev_get_resources(struct acpi_device
*adev
, struct list_head
*list
,
475 int (*preproc
)(struct acpi_resource
*, void *),
477 int acpi_dev_get_dma_resources(struct acpi_device
*adev
,
478 struct list_head
*list
);
479 int acpi_dev_filter_resource_type(struct acpi_resource
*ares
,
480 unsigned long types
);
482 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource
*ares
,
485 return acpi_dev_filter_resource_type(ares
, (unsigned long)arg
);
488 struct acpi_device
*acpi_resource_consumer(struct resource
*res
);
490 int acpi_check_resource_conflict(const struct resource
*res
);
492 int acpi_check_region(resource_size_t start
, resource_size_t n
,
495 acpi_status
acpi_release_memory(acpi_handle handle
, struct resource
*res
,
498 int acpi_resources_are_enforced(void);
500 #ifdef CONFIG_HIBERNATION
501 void __init
acpi_no_s4_hw_signature(void);
504 #ifdef CONFIG_PM_SLEEP
505 void __init
acpi_old_suspend_ordering(void);
506 void __init
acpi_nvs_nosave(void);
507 void __init
acpi_nvs_nosave_s3(void);
508 void __init
acpi_sleep_no_blacklist(void);
509 #endif /* CONFIG_PM_SLEEP */
511 int acpi_register_wakeup_handler(
512 int wake_irq
, bool (*wakeup
)(void *context
), void *context
);
513 void acpi_unregister_wakeup_handler(
514 bool (*wakeup
)(void *context
), void *context
);
516 struct acpi_osc_context
{
517 char *uuid_str
; /* UUID string */
519 struct acpi_buffer cap
; /* list of DWORD capabilities */
520 struct acpi_buffer ret
; /* free by caller if success */
523 acpi_status
acpi_run_osc(acpi_handle handle
, struct acpi_osc_context
*context
);
525 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
526 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
527 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
528 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
530 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
531 #define OSC_QUERY_ENABLE 0x00000001 /* input */
532 #define OSC_REQUEST_ERROR 0x00000002 /* return */
533 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
534 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
535 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
537 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
538 #define OSC_SB_PAD_SUPPORT 0x00000001
539 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
540 #define OSC_SB_PR3_SUPPORT 0x00000004
541 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
542 #define OSC_SB_APEI_SUPPORT 0x00000010
543 #define OSC_SB_CPC_SUPPORT 0x00000020
544 #define OSC_SB_CPCV2_SUPPORT 0x00000040
545 #define OSC_SB_PCLPI_SUPPORT 0x00000080
546 #define OSC_SB_OSLPI_SUPPORT 0x00000100
547 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
548 #define OSC_SB_GENERIC_INITIATOR_SUPPORT 0x00002000
549 #define OSC_SB_NATIVE_USB4_SUPPORT 0x00040000
551 extern bool osc_sb_apei_support_acked
;
552 extern bool osc_pc_lpi_support_confirmed
;
553 extern bool osc_sb_native_usb4_support_confirmed
;
555 /* USB4 Capabilities */
556 #define OSC_USB_USB3_TUNNELING 0x00000001
557 #define OSC_USB_DP_TUNNELING 0x00000002
558 #define OSC_USB_PCIE_TUNNELING 0x00000004
559 #define OSC_USB_XDOMAIN 0x00000008
561 extern u32 osc_sb_native_usb4_control
;
563 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
564 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
565 #define OSC_PCI_ASPM_SUPPORT 0x00000002
566 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
567 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
568 #define OSC_PCI_MSI_SUPPORT 0x00000010
569 #define OSC_PCI_EDR_SUPPORT 0x00000080
570 #define OSC_PCI_HPX_TYPE_3_SUPPORT 0x00000100
571 #define OSC_PCI_SUPPORT_MASKS 0x0000019f
573 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
574 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
575 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
576 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
577 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
578 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
579 #define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
580 #define OSC_PCI_EXPRESS_DPC_CONTROL 0x00000080
581 #define OSC_PCI_CONTROL_MASKS 0x000000bf
583 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
584 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
585 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
586 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
587 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
588 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
589 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
590 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
591 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
592 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
594 extern acpi_status
acpi_pci_osc_control_set(acpi_handle handle
,
597 /* Enable _OST when all relevant hotplug operations are enabled */
598 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
599 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
600 defined(CONFIG_ACPI_CONTAINER)
601 #define ACPI_HOTPLUG_OST
604 /* _OST Source Event Code (OSPM Action) */
605 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
606 #define ACPI_OST_EC_OSPM_EJECT 0x103
607 #define ACPI_OST_EC_OSPM_INSERTION 0x200
609 /* _OST General Processing Status Code */
610 #define ACPI_OST_SC_SUCCESS 0x0
611 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
612 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
614 /* _OST OS Shutdown Processing (0x100) Status Code */
615 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
616 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
617 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
618 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
620 /* _OST Ejection Request (0x3, 0x103) Status Code */
621 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
622 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
623 #define ACPI_OST_SC_DEVICE_BUSY 0x82
624 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
625 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
627 /* _OST Insertion Request (0x200) Status Code */
628 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
629 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
630 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
632 enum acpi_predicate
{
636 greater_than_or_equal
,
639 /* Table must be terminted by a NULL entry */
640 struct acpi_platform_list
{
641 char oem_id
[ACPI_OEM_ID_SIZE
+1];
642 char oem_table_id
[ACPI_OEM_TABLE_ID_SIZE
+1];
645 enum acpi_predicate pred
;
649 int acpi_match_platform_list(const struct acpi_platform_list
*plat
);
651 extern void acpi_early_init(void);
652 extern void acpi_subsystem_init(void);
653 extern void arch_post_acpi_subsys_init(void);
655 extern int acpi_nvs_register(__u64 start
, __u64 size
);
657 extern int acpi_nvs_for_each_region(int (*func
)(__u64
, __u64
, void *),
660 const struct acpi_device_id
*acpi_match_device(const struct acpi_device_id
*ids
,
661 const struct device
*dev
);
663 const void *acpi_device_get_match_data(const struct device
*dev
);
664 extern bool acpi_driver_match_device(struct device
*dev
,
665 const struct device_driver
*drv
);
666 int acpi_device_uevent_modalias(struct device
*, struct kobj_uevent_env
*);
667 int acpi_device_modalias(struct device
*, char *, int);
668 void acpi_walk_dep_device_list(acpi_handle handle
);
670 struct platform_device
*acpi_create_platform_device(struct acpi_device
*,
671 struct property_entry
*);
672 #define ACPI_PTR(_ptr) (_ptr)
674 static inline void acpi_device_set_enumerated(struct acpi_device
*adev
)
676 adev
->flags
.visited
= true;
679 static inline void acpi_device_clear_enumerated(struct acpi_device
*adev
)
681 adev
->flags
.visited
= false;
684 enum acpi_reconfig_event
{
685 ACPI_RECONFIG_DEVICE_ADD
= 0,
686 ACPI_RECONFIG_DEVICE_REMOVE
,
689 int acpi_reconfig_notifier_register(struct notifier_block
*nb
);
690 int acpi_reconfig_notifier_unregister(struct notifier_block
*nb
);
692 #ifdef CONFIG_ACPI_GTDT
693 int acpi_gtdt_init(struct acpi_table_header
*table
, int *platform_timer_count
);
694 int acpi_gtdt_map_ppi(int type
);
695 bool acpi_gtdt_c3stop(int type
);
696 int acpi_arch_timer_mem_init(struct arch_timer_mem
*timer_mem
, int *timer_count
);
699 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
700 static inline void acpi_arch_set_root_pointer(u64 addr
)
705 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
706 static inline u64
acpi_arch_get_root_pointer(void)
712 #else /* !CONFIG_ACPI */
714 #define acpi_disabled 1
716 #define ACPI_COMPANION(dev) (NULL)
717 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
718 #define ACPI_HANDLE(dev) (NULL)
719 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
720 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
722 #include <acpi/acpi_numa.h>
724 struct fwnode_handle
;
726 static inline bool acpi_dev_found(const char *hid
)
731 static inline bool acpi_dev_present(const char *hid
, const char *uid
, s64 hrv
)
739 acpi_dev_hid_uid_match(struct acpi_device
*adev
, const char *hid2
, const char *uid2
)
744 static inline struct acpi_device
*
745 acpi_dev_get_first_match_dev(const char *hid
, const char *uid
, s64 hrv
)
750 static inline void acpi_dev_put(struct acpi_device
*adev
) {}
752 static inline bool is_acpi_node(struct fwnode_handle
*fwnode
)
757 static inline bool is_acpi_device_node(struct fwnode_handle
*fwnode
)
762 static inline struct acpi_device
*to_acpi_device_node(struct fwnode_handle
*fwnode
)
767 static inline bool is_acpi_data_node(struct fwnode_handle
*fwnode
)
772 static inline struct acpi_data_node
*to_acpi_data_node(struct fwnode_handle
*fwnode
)
777 static inline bool acpi_data_node_match(struct fwnode_handle
*fwnode
,
783 static inline struct fwnode_handle
*acpi_fwnode_handle(struct acpi_device
*adev
)
788 static inline bool has_acpi_companion(struct device
*dev
)
793 static inline void acpi_preset_companion(struct device
*dev
,
794 struct acpi_device
*parent
, u64 addr
)
798 static inline const char *acpi_dev_name(struct acpi_device
*adev
)
803 static inline struct device
*acpi_get_first_physical_node(struct acpi_device
*adev
)
808 static inline void acpi_early_init(void) { }
809 static inline void acpi_subsystem_init(void) { }
811 static inline int early_acpi_boot_init(void)
815 static inline int acpi_boot_init(void)
820 static inline void acpi_boot_table_init(void)
825 static inline int acpi_mps_check(void)
830 static inline int acpi_check_resource_conflict(struct resource
*res
)
835 static inline int acpi_check_region(resource_size_t start
, resource_size_t n
,
841 struct acpi_table_header
;
842 static inline int acpi_table_parse(char *id
,
843 int (*handler
)(struct acpi_table_header
*))
848 static inline int acpi_nvs_register(__u64 start
, __u64 size
)
853 static inline int acpi_nvs_for_each_region(int (*func
)(__u64
, __u64
, void *),
859 struct acpi_device_id
;
861 static inline const struct acpi_device_id
*acpi_match_device(
862 const struct acpi_device_id
*ids
, const struct device
*dev
)
867 static inline const void *acpi_device_get_match_data(const struct device
*dev
)
872 static inline bool acpi_driver_match_device(struct device
*dev
,
873 const struct device_driver
*drv
)
878 static inline union acpi_object
*acpi_evaluate_dsm(acpi_handle handle
,
881 union acpi_object
*argv4
)
886 static inline int acpi_device_uevent_modalias(struct device
*dev
,
887 struct kobj_uevent_env
*env
)
892 static inline int acpi_device_modalias(struct device
*dev
,
898 static inline struct platform_device
*
899 acpi_create_platform_device(struct acpi_device
*adev
,
900 struct property_entry
*properties
)
905 static inline bool acpi_dma_supported(struct acpi_device
*adev
)
910 static inline enum dev_dma_attr
acpi_get_dma_attr(struct acpi_device
*adev
)
912 return DEV_DMA_NOT_SUPPORTED
;
915 static inline int acpi_dma_get_range(struct device
*dev
, u64
*dma_addr
,
916 u64
*offset
, u64
*size
)
921 static inline int acpi_dma_configure(struct device
*dev
,
922 enum dev_dma_attr attr
)
927 static inline int acpi_dma_configure_id(struct device
*dev
,
928 enum dev_dma_attr attr
,
934 #define ACPI_PTR(_ptr) (NULL)
936 static inline void acpi_device_set_enumerated(struct acpi_device
*adev
)
940 static inline void acpi_device_clear_enumerated(struct acpi_device
*adev
)
944 static inline int acpi_reconfig_notifier_register(struct notifier_block
*nb
)
949 static inline int acpi_reconfig_notifier_unregister(struct notifier_block
*nb
)
954 static inline struct acpi_device
*acpi_resource_consumer(struct resource
*res
)
959 #endif /* !CONFIG_ACPI */
961 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
962 int acpi_ioapic_add(acpi_handle root
);
964 static inline int acpi_ioapic_add(acpi_handle root
) { return 0; }
968 void acpi_os_set_prepare_sleep(int (*func
)(u8 sleep_state
,
969 u32 pm1a_ctrl
, u32 pm1b_ctrl
));
971 acpi_status
acpi_os_prepare_sleep(u8 sleep_state
,
972 u32 pm1a_control
, u32 pm1b_control
);
974 void acpi_os_set_prepare_extended_sleep(int (*func
)(u8 sleep_state
,
975 u32 val_a
, u32 val_b
));
977 acpi_status
acpi_os_prepare_extended_sleep(u8 sleep_state
,
978 u32 val_a
, u32 val_b
);
981 void arch_reserve_mem_area(acpi_physical_address addr
, size_t size
);
983 static inline void arch_reserve_mem_area(acpi_physical_address addr
,
987 #endif /* CONFIG_X86 */
989 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
992 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
993 int acpi_dev_suspend(struct device
*dev
, bool wakeup
);
994 int acpi_dev_resume(struct device
*dev
);
995 int acpi_subsys_runtime_suspend(struct device
*dev
);
996 int acpi_subsys_runtime_resume(struct device
*dev
);
997 int acpi_dev_pm_attach(struct device
*dev
, bool power_on
);
999 static inline int acpi_subsys_runtime_suspend(struct device
*dev
) { return 0; }
1000 static inline int acpi_subsys_runtime_resume(struct device
*dev
) { return 0; }
1001 static inline int acpi_dev_pm_attach(struct device
*dev
, bool power_on
)
1007 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1008 int acpi_subsys_prepare(struct device
*dev
);
1009 void acpi_subsys_complete(struct device
*dev
);
1010 int acpi_subsys_suspend_late(struct device
*dev
);
1011 int acpi_subsys_suspend_noirq(struct device
*dev
);
1012 int acpi_subsys_suspend(struct device
*dev
);
1013 int acpi_subsys_freeze(struct device
*dev
);
1014 int acpi_subsys_poweroff(struct device
*dev
);
1015 void acpi_ec_mark_gpe_for_wake(void);
1016 void acpi_ec_set_gpe_wake_mask(u8 action
);
1018 static inline int acpi_subsys_prepare(struct device
*dev
) { return 0; }
1019 static inline void acpi_subsys_complete(struct device
*dev
) {}
1020 static inline int acpi_subsys_suspend_late(struct device
*dev
) { return 0; }
1021 static inline int acpi_subsys_suspend_noirq(struct device
*dev
) { return 0; }
1022 static inline int acpi_subsys_suspend(struct device
*dev
) { return 0; }
1023 static inline int acpi_subsys_freeze(struct device
*dev
) { return 0; }
1024 static inline int acpi_subsys_poweroff(struct device
*dev
) { return 0; }
1025 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1026 static inline void acpi_ec_set_gpe_wake_mask(u8 action
) {}
1031 void acpi_handle_printk(const char *level
, acpi_handle handle
,
1032 const char *fmt
, ...);
1033 #else /* !CONFIG_ACPI */
1034 static inline __printf(3, 4) void
1035 acpi_handle_printk(const char *level
, void *handle
, const char *fmt
, ...) {}
1036 #endif /* !CONFIG_ACPI */
1038 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1040 void __acpi_handle_debug(struct _ddebug
*descriptor
, acpi_handle handle
, const char *fmt
, ...);
1044 * acpi_handle_<level>: Print message with ACPI prefix and object path
1046 * These interfaces acquire the global namespace mutex to obtain an object
1047 * path. In interrupt context, it shows the object path as <n/a>.
1049 #define acpi_handle_emerg(handle, fmt, ...) \
1050 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1051 #define acpi_handle_alert(handle, fmt, ...) \
1052 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1053 #define acpi_handle_crit(handle, fmt, ...) \
1054 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1055 #define acpi_handle_err(handle, fmt, ...) \
1056 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1057 #define acpi_handle_warn(handle, fmt, ...) \
1058 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1059 #define acpi_handle_notice(handle, fmt, ...) \
1060 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1061 #define acpi_handle_info(handle, fmt, ...) \
1062 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1065 #define acpi_handle_debug(handle, fmt, ...) \
1066 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1068 #if defined(CONFIG_DYNAMIC_DEBUG)
1069 #define acpi_handle_debug(handle, fmt, ...) \
1070 _dynamic_func_call(fmt, __acpi_handle_debug, \
1071 handle, pr_fmt(fmt), ##__VA_ARGS__)
1073 #define acpi_handle_debug(handle, fmt, ...) \
1076 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1082 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1083 bool acpi_gpio_get_irq_resource(struct acpi_resource
*ares
,
1084 struct acpi_resource_gpio
**agpio
);
1085 int acpi_dev_gpio_irq_get(struct acpi_device
*adev
, int index
);
1087 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource
*ares
,
1088 struct acpi_resource_gpio
**agpio
)
1092 static inline int acpi_dev_gpio_irq_get(struct acpi_device
*adev
, int index
)
1098 /* Device properties */
1101 int acpi_dev_get_property(const struct acpi_device
*adev
, const char *name
,
1102 acpi_object_type type
, const union acpi_object
**obj
);
1103 int __acpi_node_get_property_reference(const struct fwnode_handle
*fwnode
,
1104 const char *name
, size_t index
, size_t num_args
,
1105 struct fwnode_reference_args
*args
);
1107 static inline int acpi_node_get_property_reference(
1108 const struct fwnode_handle
*fwnode
,
1109 const char *name
, size_t index
,
1110 struct fwnode_reference_args
*args
)
1112 return __acpi_node_get_property_reference(fwnode
, name
, index
,
1113 NR_FWNODE_REFERENCE_ARGS
, args
);
1116 static inline bool acpi_dev_has_props(const struct acpi_device
*adev
)
1118 return !list_empty(&adev
->data
.properties
);
1121 struct acpi_device_properties
*
1122 acpi_data_add_props(struct acpi_device_data
*data
, const guid_t
*guid
,
1123 const union acpi_object
*properties
);
1125 int acpi_node_prop_get(const struct fwnode_handle
*fwnode
, const char *propname
,
1127 int acpi_dev_prop_read_single(struct acpi_device
*adev
,
1128 const char *propname
, enum dev_prop_type proptype
,
1130 int acpi_node_prop_read(const struct fwnode_handle
*fwnode
,
1131 const char *propname
, enum dev_prop_type proptype
,
1132 void *val
, size_t nval
);
1133 int acpi_dev_prop_read(const struct acpi_device
*adev
, const char *propname
,
1134 enum dev_prop_type proptype
, void *val
, size_t nval
);
1136 struct fwnode_handle
*acpi_get_next_subnode(const struct fwnode_handle
*fwnode
,
1137 struct fwnode_handle
*child
);
1138 struct fwnode_handle
*acpi_node_get_parent(const struct fwnode_handle
*fwnode
);
1140 struct acpi_probe_entry
;
1141 typedef bool (*acpi_probe_entry_validate_subtbl
)(struct acpi_subtable_header
*,
1142 struct acpi_probe_entry
*);
1144 #define ACPI_TABLE_ID_LEN 5
1147 * struct acpi_probe_entry - boot-time probing entry
1148 * @id: ACPI table name
1149 * @type: Optional subtable type to match
1150 * (if @id contains subtables)
1151 * @subtable_valid: Optional callback to check the validity of
1153 * @probe_table: Callback to the driver being probed when table
1154 * match is successful
1155 * @probe_subtbl: Callback to the driver being probed when table and
1156 * subtable match (and optional callback is successful)
1157 * @driver_data: Sideband data provided back to the driver
1159 struct acpi_probe_entry
{
1160 __u8 id
[ACPI_TABLE_ID_LEN
];
1162 acpi_probe_entry_validate_subtbl subtable_valid
;
1164 acpi_tbl_table_handler probe_table
;
1165 acpi_tbl_entry_handler probe_subtbl
;
1167 kernel_ulong_t driver_data
;
1170 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, \
1172 static const struct acpi_probe_entry __acpi_probe_##name \
1173 __used __section("__" #table "_acpi_probe_table") = { \
1176 .subtable_valid = valid, \
1177 .probe_table = fn, \
1178 .driver_data = data, \
1181 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id, \
1182 subtable, valid, data, fn) \
1183 static const struct acpi_probe_entry __acpi_probe_##name \
1184 __used __section("__" #table "_acpi_probe_table") = { \
1187 .subtable_valid = valid, \
1188 .probe_subtbl = fn, \
1189 .driver_data = data, \
1192 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1193 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1195 int __acpi_probe_device_table(struct acpi_probe_entry
*start
, int nr
);
1197 #define acpi_probe_device_table(t) \
1199 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1200 ACPI_PROBE_TABLE_END(t); \
1201 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1202 (&ACPI_PROBE_TABLE_END(t) - \
1203 &ACPI_PROBE_TABLE(t))); \
1206 static inline int acpi_dev_get_property(struct acpi_device
*adev
,
1207 const char *name
, acpi_object_type type
,
1208 const union acpi_object
**obj
)
1214 __acpi_node_get_property_reference(const struct fwnode_handle
*fwnode
,
1215 const char *name
, size_t index
, size_t num_args
,
1216 struct fwnode_reference_args
*args
)
1222 acpi_node_get_property_reference(const struct fwnode_handle
*fwnode
,
1223 const char *name
, size_t index
,
1224 struct fwnode_reference_args
*args
)
1229 static inline int acpi_node_prop_get(const struct fwnode_handle
*fwnode
,
1230 const char *propname
,
1236 static inline int acpi_dev_prop_read_single(const struct acpi_device
*adev
,
1237 const char *propname
,
1238 enum dev_prop_type proptype
,
1244 static inline int acpi_node_prop_read(const struct fwnode_handle
*fwnode
,
1245 const char *propname
,
1246 enum dev_prop_type proptype
,
1247 void *val
, size_t nval
)
1252 static inline int acpi_dev_prop_read(const struct acpi_device
*adev
,
1253 const char *propname
,
1254 enum dev_prop_type proptype
,
1255 void *val
, size_t nval
)
1260 static inline struct fwnode_handle
*
1261 acpi_get_next_subnode(const struct fwnode_handle
*fwnode
,
1262 struct fwnode_handle
*child
)
1267 static inline struct fwnode_handle
*
1268 acpi_node_get_parent(const struct fwnode_handle
*fwnode
)
1273 static inline struct fwnode_handle
*
1274 acpi_graph_get_next_endpoint(const struct fwnode_handle
*fwnode
,
1275 struct fwnode_handle
*prev
)
1277 return ERR_PTR(-ENXIO
);
1281 acpi_graph_get_remote_endpoint(const struct fwnode_handle
*fwnode
,
1282 struct fwnode_handle
**remote
,
1283 struct fwnode_handle
**port
,
1284 struct fwnode_handle
**endpoint
)
1289 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1290 static const void * __acpi_table_##name[] \
1291 __attribute__((unused)) \
1292 = { (void *) table_id, \
1293 (void *) subtable, \
1298 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1301 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1302 void acpi_table_upgrade(void);
1304 static inline void acpi_table_upgrade(void) { }
1307 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1308 extern bool acpi_has_watchdog(void);
1310 static inline bool acpi_has_watchdog(void) { return false; }
1313 #ifdef CONFIG_ACPI_SPCR_TABLE
1314 extern bool qdf2400_e44_present
;
1315 int acpi_parse_spcr(bool enable_earlycon
, bool enable_console
);
1317 static inline int acpi_parse_spcr(bool enable_earlycon
, bool enable_console
)
1323 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1324 int acpi_irq_get(acpi_handle handle
, unsigned int index
, struct resource
*res
);
1327 int acpi_irq_get(acpi_handle handle
, unsigned int index
, struct resource
*res
)
1333 #ifdef CONFIG_ACPI_LPIT
1334 int lpit_read_residency_count_address(u64
*address
);
1336 static inline int lpit_read_residency_count_address(u64
*address
)
1342 #ifdef CONFIG_ACPI_PPTT
1343 int acpi_pptt_cpu_is_thread(unsigned int cpu
);
1344 int find_acpi_cpu_topology(unsigned int cpu
, int level
);
1345 int find_acpi_cpu_topology_package(unsigned int cpu
);
1346 int find_acpi_cpu_topology_hetero_id(unsigned int cpu
);
1347 int find_acpi_cpu_cache_topology(unsigned int cpu
, int level
);
1349 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu
)
1353 static inline int find_acpi_cpu_topology(unsigned int cpu
, int level
)
1357 static inline int find_acpi_cpu_topology_package(unsigned int cpu
)
1361 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu
)
1365 static inline int find_acpi_cpu_cache_topology(unsigned int cpu
, int level
)
1372 extern int acpi_platform_notify(struct device
*dev
, enum kobject_action action
);
1375 acpi_platform_notify(struct device
*dev
, enum kobject_action action
)
1381 #endif /*_LINUX_ACPI_H*/