2 * acpi.h - ACPI Interface
4 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 #include <linux/errno.h>
25 #include <linux/ioport.h> /* for struct resource */
26 #include <linux/resource_ext.h>
27 #include <linux/device.h>
28 #include <linux/property.h>
29 #include <linux/uuid.h>
34 #include <acpi/acpi.h>
38 #include <linux/list.h>
39 #include <linux/mod_devicetable.h>
40 #include <linux/dynamic_debug.h>
41 #include <linux/module.h>
42 #include <linux/mutex.h>
44 #include <acpi/acpi_bus.h>
45 #include <acpi/acpi_drivers.h>
46 #include <acpi/acpi_numa.h>
47 #include <acpi/acpi_io.h>
50 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
52 return adev ? adev->handle : NULL;
55 #define ACPI_COMPANION(dev) to_acpi_device_node((dev)->fwnode)
56 #define ACPI_COMPANION_SET(dev, adev) set_primary_fwnode(dev, (adev) ? \
57 acpi_fwnode_handle(adev) : NULL)
58 #define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
59 #define ACPI_HANDLE_FWNODE(fwnode) \
60 acpi_device_handle(to_acpi_device_node(fwnode))
62 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
64 struct fwnode_handle *fwnode;
66 fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
70 fwnode->ops = &acpi_static_fwnode_ops;
75 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
77 if (WARN_ON(!is_acpi_static_node(fwnode)))
84 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
85 * the PCI-defined class-code information
87 * @_cls : the class, subclass, prog-if triple for this device
88 * @_msk : the class mask for this device
90 * This macro is used to create a struct acpi_device_id that matches a
91 * specific PCI class. The .id and .driver_data fields will be left
92 * initialized with the default value.
94 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
96 static inline bool has_acpi_companion(struct device *dev)
98 return is_acpi_device_node(dev->fwnode);
101 static inline void acpi_preset_companion(struct device *dev,
102 struct acpi_device *parent, u64 addr)
104 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
107 static inline const char *acpi_dev_name(struct acpi_device *adev)
109 return dev_name(&adev->dev);
112 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
114 enum acpi_irq_model_id {
115 ACPI_IRQ_MODEL_PIC = 0,
116 ACPI_IRQ_MODEL_IOAPIC,
117 ACPI_IRQ_MODEL_IOSAPIC,
118 ACPI_IRQ_MODEL_PLATFORM,
123 extern enum acpi_irq_model_id acpi_irq_model;
125 enum acpi_interrupt_id {
126 ACPI_INTERRUPT_PMI = 1,
132 #define ACPI_SPACE_MEM 0
134 enum acpi_address_range_id {
135 ACPI_ADDRESS_RANGE_MEMORY = 1,
136 ACPI_ADDRESS_RANGE_RESERVED = 2,
137 ACPI_ADDRESS_RANGE_ACPI = 3,
138 ACPI_ADDRESS_RANGE_NVS = 4,
139 ACPI_ADDRESS_RANGE_COUNT
144 union acpi_subtable_headers {
145 struct acpi_subtable_header common;
146 struct acpi_hmat_structure hmat;
149 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
151 typedef int (*acpi_tbl_entry_handler)(union acpi_subtable_headers *header,
152 const unsigned long end);
154 /* Debugger support */
156 struct acpi_debugger_ops {
157 int (*create_thread)(acpi_osd_exec_callback function, void *context);
158 ssize_t (*write_log)(const char *msg);
159 ssize_t (*read_cmd)(char *buffer, size_t length);
160 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
161 int (*notify_command_complete)(void);
164 struct acpi_debugger {
165 const struct acpi_debugger_ops *ops;
166 struct module *owner;
170 #ifdef CONFIG_ACPI_DEBUGGER
171 int __init acpi_debugger_init(void);
172 int acpi_register_debugger(struct module *owner,
173 const struct acpi_debugger_ops *ops);
174 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
175 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
176 ssize_t acpi_debugger_write_log(const char *msg);
177 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
178 int acpi_debugger_wait_command_ready(void);
179 int acpi_debugger_notify_command_complete(void);
181 static inline int acpi_debugger_init(void)
186 static inline int acpi_register_debugger(struct module *owner,
187 const struct acpi_debugger_ops *ops)
192 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
196 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
202 static inline int acpi_debugger_write_log(const char *msg)
207 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
212 static inline int acpi_debugger_wait_command_ready(void)
217 static inline int acpi_debugger_notify_command_complete(void)
223 #define BAD_MADT_ENTRY(entry, end) ( \
224 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
225 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
227 struct acpi_subtable_proc {
229 acpi_tbl_entry_handler handler;
233 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
234 void __acpi_unmap_table(void __iomem *map, unsigned long size);
235 int early_acpi_boot_init(void);
236 int acpi_boot_init (void);
237 void acpi_boot_table_init (void);
238 int acpi_mps_check (void);
239 int acpi_numa_init (void);
241 int acpi_table_init (void);
242 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
243 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
245 acpi_tbl_entry_handler handler,
246 unsigned int max_entries);
247 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
248 struct acpi_subtable_proc *proc, int proc_num,
249 unsigned int max_entries);
250 int acpi_table_parse_madt(enum acpi_madt_type id,
251 acpi_tbl_entry_handler handler,
252 unsigned int max_entries);
253 int acpi_parse_mcfg (struct acpi_table_header *header);
254 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
256 /* the following numa functions are architecture-dependent */
257 void acpi_numa_slit_init (struct acpi_table_slit *slit);
259 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
260 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
263 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
266 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
269 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
272 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
275 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
277 #ifndef PHYS_CPUID_INVALID
278 typedef u32 phys_cpuid_t;
279 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
282 static inline bool invalid_logical_cpuid(u32 cpuid)
284 return (int)cpuid < 0;
287 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
289 return phys_id == PHYS_CPUID_INVALID;
292 /* Validate the processor object's proc_id */
293 bool acpi_duplicate_processor_id(int proc_id);
295 #ifdef CONFIG_ACPI_HOTPLUG_CPU
296 /* Arch dependent functions for cpu hotplug support */
297 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
299 int acpi_unmap_cpu(int cpu);
300 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
302 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
303 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
306 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
307 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
308 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
309 void acpi_irq_stats_init(void);
310 extern u32 acpi_irq_handled;
311 extern u32 acpi_irq_not_handled;
312 extern unsigned int acpi_sci_irq;
313 extern bool acpi_no_s5;
314 #define INVALID_ACPI_IRQ ((unsigned)-1)
315 static inline bool acpi_sci_irq_valid(void)
317 return acpi_sci_irq != INVALID_ACPI_IRQ;
321 extern unsigned long acpi_realmode_flags;
323 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
324 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
325 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
327 void acpi_set_irq_model(enum acpi_irq_model_id model,
328 struct fwnode_handle *fwnode);
330 #ifdef CONFIG_X86_IO_APIC
331 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
333 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
336 * This function undoes the effect of one call to acpi_register_gsi().
337 * If this matches the last registration, any IRQ resources for gsi
340 void acpi_unregister_gsi (u32 gsi);
344 int acpi_pci_irq_enable (struct pci_dev *dev);
345 void acpi_penalize_isa_irq(int irq, int active);
346 bool acpi_isa_irq_available(int irq);
348 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
350 static inline void acpi_penalize_sci_irq(int irq, int trigger,
355 void acpi_pci_irq_disable (struct pci_dev *dev);
357 extern int ec_read(u8 addr, u8 *val);
358 extern int ec_write(u8 addr, u8 val);
359 extern int ec_transaction(u8 command,
360 const u8 *wdata, unsigned wdata_len,
361 u8 *rdata, unsigned rdata_len);
362 extern acpi_handle ec_get_handle(void);
364 extern bool acpi_is_pnp_device(struct acpi_device *);
366 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
368 typedef void (*wmi_notify_handler) (u32 value, void *context);
370 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
372 const struct acpi_buffer *in,
373 struct acpi_buffer *out);
374 extern acpi_status wmi_query_block(const char *guid, u8 instance,
375 struct acpi_buffer *out);
376 extern acpi_status wmi_set_block(const char *guid, u8 instance,
377 const struct acpi_buffer *in);
378 extern acpi_status wmi_install_notify_handler(const char *guid,
379 wmi_notify_handler handler, void *data);
380 extern acpi_status wmi_remove_notify_handler(const char *guid);
381 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
382 extern bool wmi_has_guid(const char *guid);
383 extern char *wmi_get_acpi_device_uid(const char *guid);
385 #endif /* CONFIG_ACPI_WMI */
387 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
388 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
389 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
390 #define ACPI_VIDEO_BACKLIGHT 0x0008
391 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
392 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
393 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
394 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
395 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
396 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
397 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
398 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
400 extern char acpi_video_backlight_string[];
401 extern long acpi_is_video_device(acpi_handle handle);
402 extern int acpi_blacklisted(void);
403 extern void acpi_osi_setup(char *str);
404 extern bool acpi_osi_is_win8(void);
406 #ifdef CONFIG_ACPI_NUMA
407 int acpi_map_pxm_to_online_node(int pxm);
408 int acpi_map_pxm_to_node(int pxm);
409 int acpi_get_node(acpi_handle handle);
411 static inline int acpi_map_pxm_to_online_node(int pxm)
415 static inline int acpi_map_pxm_to_node(int pxm)
419 static inline int acpi_get_node(acpi_handle handle)
424 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
426 extern int pnpacpi_disabled;
428 #define PXM_INVAL (-1)
430 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
431 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
432 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
433 struct resource_win *win);
434 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
435 struct resource_win *win);
436 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
437 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
438 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
439 struct resource *res);
441 void acpi_dev_free_resource_list(struct list_head *list);
442 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
443 int (*preproc)(struct acpi_resource *, void *),
445 int acpi_dev_get_dma_resources(struct acpi_device *adev,
446 struct list_head *list);
447 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
448 unsigned long types);
450 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
453 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
456 struct acpi_device *acpi_resource_consumer(struct resource *res);
458 int acpi_check_resource_conflict(const struct resource *res);
460 int acpi_check_region(resource_size_t start, resource_size_t n,
463 acpi_status acpi_release_memory(acpi_handle handle, struct resource *res,
466 int acpi_resources_are_enforced(void);
468 #ifdef CONFIG_HIBERNATION
469 void __init acpi_no_s4_hw_signature(void);
472 #ifdef CONFIG_PM_SLEEP
473 void __init acpi_old_suspend_ordering(void);
474 void __init acpi_nvs_nosave(void);
475 void __init acpi_nvs_nosave_s3(void);
476 void __init acpi_sleep_no_blacklist(void);
477 #endif /* CONFIG_PM_SLEEP */
479 struct acpi_osc_context {
480 char *uuid_str; /* UUID string */
482 struct acpi_buffer cap; /* list of DWORD capabilities */
483 struct acpi_buffer ret; /* free by caller if success */
486 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
488 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
489 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
490 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
491 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
493 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
494 #define OSC_QUERY_ENABLE 0x00000001 /* input */
495 #define OSC_REQUEST_ERROR 0x00000002 /* return */
496 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
497 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
498 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
500 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
501 #define OSC_SB_PAD_SUPPORT 0x00000001
502 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
503 #define OSC_SB_PR3_SUPPORT 0x00000004
504 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
505 #define OSC_SB_APEI_SUPPORT 0x00000010
506 #define OSC_SB_CPC_SUPPORT 0x00000020
507 #define OSC_SB_CPCV2_SUPPORT 0x00000040
508 #define OSC_SB_PCLPI_SUPPORT 0x00000080
509 #define OSC_SB_OSLPI_SUPPORT 0x00000100
510 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
512 extern bool osc_sb_apei_support_acked;
513 extern bool osc_pc_lpi_support_confirmed;
515 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
516 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
517 #define OSC_PCI_ASPM_SUPPORT 0x00000002
518 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
519 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
520 #define OSC_PCI_MSI_SUPPORT 0x00000010
521 #define OSC_PCI_HPX_TYPE_3_SUPPORT 0x00000100
522 #define OSC_PCI_SUPPORT_MASKS 0x0000011f
524 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
525 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
526 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
527 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
528 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
529 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
530 #define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
531 #define OSC_PCI_CONTROL_MASKS 0x0000003f
533 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
534 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
535 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
536 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
537 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
538 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
539 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
540 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
541 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
542 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
544 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
547 /* Enable _OST when all relevant hotplug operations are enabled */
548 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
549 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
550 defined(CONFIG_ACPI_CONTAINER)
551 #define ACPI_HOTPLUG_OST
554 /* _OST Source Event Code (OSPM Action) */
555 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
556 #define ACPI_OST_EC_OSPM_EJECT 0x103
557 #define ACPI_OST_EC_OSPM_INSERTION 0x200
559 /* _OST General Processing Status Code */
560 #define ACPI_OST_SC_SUCCESS 0x0
561 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
562 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
564 /* _OST OS Shutdown Processing (0x100) Status Code */
565 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
566 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
567 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
568 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
570 /* _OST Ejection Request (0x3, 0x103) Status Code */
571 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
572 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
573 #define ACPI_OST_SC_DEVICE_BUSY 0x82
574 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
575 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
577 /* _OST Insertion Request (0x200) Status Code */
578 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
579 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
580 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
582 enum acpi_predicate {
586 greater_than_or_equal,
589 /* Table must be terminted by a NULL entry */
590 struct acpi_platform_list {
591 char oem_id[ACPI_OEM_ID_SIZE+1];
592 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
595 enum acpi_predicate pred;
599 int acpi_match_platform_list(const struct acpi_platform_list *plat);
601 extern void acpi_early_init(void);
602 extern void acpi_subsystem_init(void);
603 extern void arch_post_acpi_subsys_init(void);
605 extern int acpi_nvs_register(__u64 start, __u64 size);
607 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
610 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
611 const struct device *dev);
613 const void *acpi_device_get_match_data(const struct device *dev);
614 extern bool acpi_driver_match_device(struct device *dev,
615 const struct device_driver *drv);
616 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
617 int acpi_device_modalias(struct device *, char *, int);
618 void acpi_walk_dep_device_list(acpi_handle handle);
620 struct platform_device *acpi_create_platform_device(struct acpi_device *,
621 struct property_entry *);
622 #define ACPI_PTR(_ptr) (_ptr)
624 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
626 adev->flags.visited = true;
629 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
631 adev->flags.visited = false;
634 enum acpi_reconfig_event {
635 ACPI_RECONFIG_DEVICE_ADD = 0,
636 ACPI_RECONFIG_DEVICE_REMOVE,
639 int acpi_reconfig_notifier_register(struct notifier_block *nb);
640 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
642 #ifdef CONFIG_ACPI_GTDT
643 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
644 int acpi_gtdt_map_ppi(int type);
645 bool acpi_gtdt_c3stop(int type);
646 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
649 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
650 static inline u64 acpi_arch_get_root_pointer(void)
656 #else /* !CONFIG_ACPI */
658 #define acpi_disabled 1
660 #define ACPI_COMPANION(dev) (NULL)
661 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
662 #define ACPI_HANDLE(dev) (NULL)
663 #define ACPI_HANDLE_FWNODE(fwnode) (NULL)
664 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
666 struct fwnode_handle;
668 static inline bool acpi_dev_found(const char *hid)
673 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
678 static inline struct acpi_device *
679 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
684 static inline void acpi_dev_put(struct acpi_device *adev) {}
686 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
691 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
696 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
701 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
706 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
711 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
717 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
722 static inline bool has_acpi_companion(struct device *dev)
727 static inline void acpi_preset_companion(struct device *dev,
728 struct acpi_device *parent, u64 addr)
732 static inline const char *acpi_dev_name(struct acpi_device *adev)
737 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
742 static inline void acpi_early_init(void) { }
743 static inline void acpi_subsystem_init(void) { }
745 static inline int early_acpi_boot_init(void)
749 static inline int acpi_boot_init(void)
754 static inline void acpi_boot_table_init(void)
759 static inline int acpi_mps_check(void)
764 static inline int acpi_check_resource_conflict(struct resource *res)
769 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
775 struct acpi_table_header;
776 static inline int acpi_table_parse(char *id,
777 int (*handler)(struct acpi_table_header *))
782 static inline int acpi_nvs_register(__u64 start, __u64 size)
787 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
793 struct acpi_device_id;
795 static inline const struct acpi_device_id *acpi_match_device(
796 const struct acpi_device_id *ids, const struct device *dev)
801 static inline const void *acpi_device_get_match_data(const struct device *dev)
806 static inline bool acpi_driver_match_device(struct device *dev,
807 const struct device_driver *drv)
812 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
815 union acpi_object *argv4)
820 static inline int acpi_device_uevent_modalias(struct device *dev,
821 struct kobj_uevent_env *env)
826 static inline int acpi_device_modalias(struct device *dev,
832 static inline bool acpi_dma_supported(struct acpi_device *adev)
837 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
839 return DEV_DMA_NOT_SUPPORTED;
842 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
843 u64 *offset, u64 *size)
848 static inline int acpi_dma_configure(struct device *dev,
849 enum dev_dma_attr attr)
854 #define ACPI_PTR(_ptr) (NULL)
856 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
860 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
864 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
869 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
874 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
879 #endif /* !CONFIG_ACPI */
881 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
882 int acpi_ioapic_add(acpi_handle root);
884 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
888 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
889 u32 pm1a_ctrl, u32 pm1b_ctrl));
891 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
892 u32 pm1a_control, u32 pm1b_control);
894 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
895 u32 val_a, u32 val_b));
897 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
898 u32 val_a, u32 val_b);
901 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
903 static inline void arch_reserve_mem_area(acpi_physical_address addr,
907 #endif /* CONFIG_X86 */
909 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
912 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
913 int acpi_dev_suspend(struct device *dev, bool wakeup);
914 int acpi_dev_resume(struct device *dev);
915 int acpi_subsys_runtime_suspend(struct device *dev);
916 int acpi_subsys_runtime_resume(struct device *dev);
917 int acpi_dev_pm_attach(struct device *dev, bool power_on);
919 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
920 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
921 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
922 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
923 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
929 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
930 int acpi_dev_suspend_late(struct device *dev);
931 int acpi_subsys_prepare(struct device *dev);
932 void acpi_subsys_complete(struct device *dev);
933 int acpi_subsys_suspend_late(struct device *dev);
934 int acpi_subsys_suspend_noirq(struct device *dev);
935 int acpi_subsys_resume_noirq(struct device *dev);
936 int acpi_subsys_resume_early(struct device *dev);
937 int acpi_subsys_suspend(struct device *dev);
938 int acpi_subsys_freeze(struct device *dev);
939 int acpi_subsys_freeze_late(struct device *dev);
940 int acpi_subsys_freeze_noirq(struct device *dev);
941 int acpi_subsys_thaw_noirq(struct device *dev);
943 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
944 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
945 static inline void acpi_subsys_complete(struct device *dev) {}
946 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
947 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
948 static inline int acpi_subsys_resume_noirq(struct device *dev) { return 0; }
949 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
950 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
951 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
952 static inline int acpi_subsys_freeze_late(struct device *dev) { return 0; }
953 static inline int acpi_subsys_freeze_noirq(struct device *dev) { return 0; }
954 static inline int acpi_subsys_thaw_noirq(struct device *dev) { return 0; }
959 void acpi_handle_printk(const char *level, acpi_handle handle,
960 const char *fmt, ...);
961 #else /* !CONFIG_ACPI */
962 static inline __printf(3, 4) void
963 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
964 #endif /* !CONFIG_ACPI */
966 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
968 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
972 * acpi_handle_<level>: Print message with ACPI prefix and object path
974 * These interfaces acquire the global namespace mutex to obtain an object
975 * path. In interrupt context, it shows the object path as <n/a>.
977 #define acpi_handle_emerg(handle, fmt, ...) \
978 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
979 #define acpi_handle_alert(handle, fmt, ...) \
980 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
981 #define acpi_handle_crit(handle, fmt, ...) \
982 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
983 #define acpi_handle_err(handle, fmt, ...) \
984 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
985 #define acpi_handle_warn(handle, fmt, ...) \
986 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
987 #define acpi_handle_notice(handle, fmt, ...) \
988 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
989 #define acpi_handle_info(handle, fmt, ...) \
990 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
993 #define acpi_handle_debug(handle, fmt, ...) \
994 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
996 #if defined(CONFIG_DYNAMIC_DEBUG)
997 #define acpi_handle_debug(handle, fmt, ...) \
998 _dynamic_func_call(fmt, __acpi_handle_debug, \
999 handle, pr_fmt(fmt), ##__VA_ARGS__)
1001 #define acpi_handle_debug(handle, fmt, ...) \
1004 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1010 struct acpi_gpio_params {
1011 unsigned int crs_entry_index;
1012 unsigned int line_index;
1016 struct acpi_gpio_mapping {
1018 const struct acpi_gpio_params *data;
1021 /* Ignore IoRestriction field */
1022 #define ACPI_GPIO_QUIRK_NO_IO_RESTRICTION BIT(0)
1024 * When ACPI GPIO mapping table is in use the index parameter inside it
1025 * refers to the GPIO resource in _CRS method. That index has no
1026 * distinction of actual type of the resource. When consumer wants to
1027 * get GpioIo type explicitly, this quirk may be used.
1029 #define ACPI_GPIO_QUIRK_ONLY_GPIOIO BIT(1)
1031 unsigned int quirks;
1034 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1035 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1036 const struct acpi_gpio_mapping *gpios);
1038 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
1041 adev->driver_gpios = NULL;
1044 int devm_acpi_dev_add_driver_gpios(struct device *dev,
1045 const struct acpi_gpio_mapping *gpios);
1046 void devm_acpi_dev_remove_driver_gpios(struct device *dev);
1048 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1049 struct acpi_resource_gpio **agpio);
1050 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
1052 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
1053 const struct acpi_gpio_mapping *gpios)
1057 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
1059 static inline int devm_acpi_dev_add_driver_gpios(struct device *dev,
1060 const struct acpi_gpio_mapping *gpios)
1064 static inline void devm_acpi_dev_remove_driver_gpios(struct device *dev) {}
1066 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1067 struct acpi_resource_gpio **agpio)
1071 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1077 /* Device properties */
1080 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1081 acpi_object_type type, const union acpi_object **obj);
1082 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1083 const char *name, size_t index, size_t num_args,
1084 struct fwnode_reference_args *args);
1086 static inline int acpi_node_get_property_reference(
1087 const struct fwnode_handle *fwnode,
1088 const char *name, size_t index,
1089 struct fwnode_reference_args *args)
1091 return __acpi_node_get_property_reference(fwnode, name, index,
1092 NR_FWNODE_REFERENCE_ARGS, args);
1095 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1097 return !list_empty(&adev->data.properties);
1100 struct acpi_device_properties *
1101 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1102 const union acpi_object *properties);
1104 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1106 int acpi_dev_prop_read_single(struct acpi_device *adev,
1107 const char *propname, enum dev_prop_type proptype,
1109 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1110 const char *propname, enum dev_prop_type proptype,
1111 void *val, size_t nval);
1112 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
1113 enum dev_prop_type proptype, void *val, size_t nval);
1115 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1116 struct fwnode_handle *child);
1117 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
1119 struct acpi_probe_entry;
1120 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1121 struct acpi_probe_entry *);
1123 #define ACPI_TABLE_ID_LEN 5
1126 * struct acpi_probe_entry - boot-time probing entry
1127 * @id: ACPI table name
1128 * @type: Optional subtable type to match
1129 * (if @id contains subtables)
1130 * @subtable_valid: Optional callback to check the validity of
1132 * @probe_table: Callback to the driver being probed when table
1133 * match is successful
1134 * @probe_subtbl: Callback to the driver being probed when table and
1135 * subtable match (and optional callback is successful)
1136 * @driver_data: Sideband data provided back to the driver
1138 struct acpi_probe_entry {
1139 __u8 id[ACPI_TABLE_ID_LEN];
1141 acpi_probe_entry_validate_subtbl subtable_valid;
1143 acpi_tbl_table_handler probe_table;
1144 acpi_tbl_entry_handler probe_subtbl;
1146 kernel_ulong_t driver_data;
1149 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1150 static const struct acpi_probe_entry __acpi_probe_##name \
1151 __used __section(__##table##_acpi_probe_table) \
1155 .subtable_valid = valid, \
1156 .probe_table = (acpi_tbl_table_handler)fn, \
1157 .driver_data = data, \
1160 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1161 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1163 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1165 #define acpi_probe_device_table(t) \
1167 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1168 ACPI_PROBE_TABLE_END(t); \
1169 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1170 (&ACPI_PROBE_TABLE_END(t) - \
1171 &ACPI_PROBE_TABLE(t))); \
1174 static inline int acpi_dev_get_property(struct acpi_device *adev,
1175 const char *name, acpi_object_type type,
1176 const union acpi_object **obj)
1182 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1183 const char *name, size_t index, size_t num_args,
1184 struct fwnode_reference_args *args)
1190 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1191 const char *name, size_t index,
1192 struct fwnode_reference_args *args)
1197 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1198 const char *propname,
1204 static inline int acpi_dev_prop_get(const struct acpi_device *adev,
1205 const char *propname,
1211 static inline int acpi_dev_prop_read_single(const struct acpi_device *adev,
1212 const char *propname,
1213 enum dev_prop_type proptype,
1219 static inline int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1220 const char *propname,
1221 enum dev_prop_type proptype,
1222 void *val, size_t nval)
1227 static inline int acpi_dev_prop_read(const struct acpi_device *adev,
1228 const char *propname,
1229 enum dev_prop_type proptype,
1230 void *val, size_t nval)
1235 static inline struct fwnode_handle *
1236 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1237 struct fwnode_handle *child)
1242 static inline struct fwnode_handle *
1243 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1248 static inline struct fwnode_handle *
1249 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1250 struct fwnode_handle *prev)
1252 return ERR_PTR(-ENXIO);
1256 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1257 struct fwnode_handle **remote,
1258 struct fwnode_handle **port,
1259 struct fwnode_handle **endpoint)
1264 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1265 static const void * __acpi_table_##name[] \
1266 __attribute__((unused)) \
1267 = { (void *) table_id, \
1268 (void *) subtable, \
1273 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1276 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1277 void acpi_table_upgrade(void);
1279 static inline void acpi_table_upgrade(void) { }
1282 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1283 extern bool acpi_has_watchdog(void);
1285 static inline bool acpi_has_watchdog(void) { return false; }
1288 #ifdef CONFIG_ACPI_SPCR_TABLE
1289 extern bool qdf2400_e44_present;
1290 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1292 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1298 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1299 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1302 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1308 #ifdef CONFIG_ACPI_LPIT
1309 int lpit_read_residency_count_address(u64 *address);
1311 static inline int lpit_read_residency_count_address(u64 *address)
1317 #ifdef CONFIG_ACPI_PPTT
1318 int find_acpi_cpu_topology(unsigned int cpu, int level);
1319 int find_acpi_cpu_topology_package(unsigned int cpu);
1320 int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
1322 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1326 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1330 static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1337 extern int acpi_platform_notify(struct device *dev, enum kobject_action action);
1340 acpi_platform_notify(struct device *dev, enum kobject_action action)
1346 #endif /*_LINUX_ACPI_H*/