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>
33 #include <acpi/acpi.h>
37 #include <linux/list.h>
38 #include <linux/mod_devicetable.h>
39 #include <linux/dynamic_debug.h>
40 #include <linux/module.h>
41 #include <linux/mutex.h>
42 #include <linux/uuid.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))
60 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
62 struct fwnode_handle *fwnode;
64 fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
68 fwnode->type = FWNODE_ACPI_STATIC;
73 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
75 if (WARN_ON(!fwnode || fwnode->type != FWNODE_ACPI_STATIC))
82 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
83 * the PCI-defined class-code information
85 * @_cls : the class, subclass, prog-if triple for this device
86 * @_msk : the class mask for this device
88 * This macro is used to create a struct acpi_device_id that matches a
89 * specific PCI class. The .id and .driver_data fields will be left
90 * initialized with the default value.
92 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
94 static inline bool has_acpi_companion(struct device *dev)
96 return is_acpi_device_node(dev->fwnode);
99 static inline void acpi_preset_companion(struct device *dev,
100 struct acpi_device *parent, u64 addr)
102 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
105 static inline const char *acpi_dev_name(struct acpi_device *adev)
107 return dev_name(&adev->dev);
110 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
112 enum acpi_irq_model_id {
113 ACPI_IRQ_MODEL_PIC = 0,
114 ACPI_IRQ_MODEL_IOAPIC,
115 ACPI_IRQ_MODEL_IOSAPIC,
116 ACPI_IRQ_MODEL_PLATFORM,
121 extern enum acpi_irq_model_id acpi_irq_model;
123 enum acpi_interrupt_id {
124 ACPI_INTERRUPT_PMI = 1,
130 #define ACPI_SPACE_MEM 0
132 enum acpi_address_range_id {
133 ACPI_ADDRESS_RANGE_MEMORY = 1,
134 ACPI_ADDRESS_RANGE_RESERVED = 2,
135 ACPI_ADDRESS_RANGE_ACPI = 3,
136 ACPI_ADDRESS_RANGE_NVS = 4,
137 ACPI_ADDRESS_RANGE_COUNT
143 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
145 typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
146 const unsigned long end);
148 /* Debugger support */
150 struct acpi_debugger_ops {
151 int (*create_thread)(acpi_osd_exec_callback function, void *context);
152 ssize_t (*write_log)(const char *msg);
153 ssize_t (*read_cmd)(char *buffer, size_t length);
154 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
155 int (*notify_command_complete)(void);
158 struct acpi_debugger {
159 const struct acpi_debugger_ops *ops;
160 struct module *owner;
164 #ifdef CONFIG_ACPI_DEBUGGER
165 int __init acpi_debugger_init(void);
166 int acpi_register_debugger(struct module *owner,
167 const struct acpi_debugger_ops *ops);
168 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
169 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
170 ssize_t acpi_debugger_write_log(const char *msg);
171 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
172 int acpi_debugger_wait_command_ready(void);
173 int acpi_debugger_notify_command_complete(void);
175 static inline int acpi_debugger_init(void)
180 static inline int acpi_register_debugger(struct module *owner,
181 const struct acpi_debugger_ops *ops)
186 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
190 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
196 static inline int acpi_debugger_write_log(const char *msg)
201 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
206 static inline int acpi_debugger_wait_command_ready(void)
211 static inline int acpi_debugger_notify_command_complete(void)
217 #define BAD_MADT_ENTRY(entry, end) ( \
218 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
219 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
221 struct acpi_subtable_proc {
223 acpi_tbl_entry_handler handler;
227 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
228 void __acpi_unmap_table(char *map, unsigned long size);
229 int early_acpi_boot_init(void);
230 int acpi_boot_init (void);
231 void acpi_boot_table_init (void);
232 int acpi_mps_check (void);
233 int acpi_numa_init (void);
235 int acpi_table_init (void);
236 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
237 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
239 acpi_tbl_entry_handler handler,
240 unsigned int max_entries);
241 int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
242 struct acpi_subtable_proc *proc, int proc_num,
243 unsigned int max_entries);
244 int acpi_table_parse_madt(enum acpi_madt_type id,
245 acpi_tbl_entry_handler handler,
246 unsigned int max_entries);
247 int acpi_parse_mcfg (struct acpi_table_header *header);
248 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
250 /* the following numa functions are architecture-dependent */
251 void acpi_numa_slit_init (struct acpi_table_slit *slit);
253 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
254 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
257 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
260 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
263 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
266 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
269 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
271 #ifndef PHYS_CPUID_INVALID
272 typedef u32 phys_cpuid_t;
273 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
276 static inline bool invalid_logical_cpuid(u32 cpuid)
278 return (int)cpuid < 0;
281 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
283 return phys_id == PHYS_CPUID_INVALID;
286 /* Validate the processor object's proc_id */
287 bool acpi_duplicate_processor_id(int proc_id);
289 #ifdef CONFIG_ACPI_HOTPLUG_CPU
290 /* Arch dependent functions for cpu hotplug support */
291 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
293 int acpi_unmap_cpu(int cpu);
294 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
296 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
297 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
300 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
301 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
302 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
303 void acpi_irq_stats_init(void);
304 extern u32 acpi_irq_handled;
305 extern u32 acpi_irq_not_handled;
306 extern unsigned int acpi_sci_irq;
307 extern bool acpi_no_s5;
308 #define INVALID_ACPI_IRQ ((unsigned)-1)
309 static inline bool acpi_sci_irq_valid(void)
311 return acpi_sci_irq != INVALID_ACPI_IRQ;
315 extern unsigned long acpi_realmode_flags;
317 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
318 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
319 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
321 void acpi_set_irq_model(enum acpi_irq_model_id model,
322 struct fwnode_handle *fwnode);
324 #ifdef CONFIG_X86_IO_APIC
325 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
327 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
330 * This function undoes the effect of one call to acpi_register_gsi().
331 * If this matches the last registration, any IRQ resources for gsi
334 void acpi_unregister_gsi (u32 gsi);
338 int acpi_pci_irq_enable (struct pci_dev *dev);
339 void acpi_penalize_isa_irq(int irq, int active);
340 bool acpi_isa_irq_available(int irq);
341 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
342 void acpi_pci_irq_disable (struct pci_dev *dev);
344 extern int ec_read(u8 addr, u8 *val);
345 extern int ec_write(u8 addr, u8 val);
346 extern int ec_transaction(u8 command,
347 const u8 *wdata, unsigned wdata_len,
348 u8 *rdata, unsigned rdata_len);
349 extern acpi_handle ec_get_handle(void);
351 extern bool acpi_is_pnp_device(struct acpi_device *);
353 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
355 typedef void (*wmi_notify_handler) (u32 value, void *context);
357 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
359 const struct acpi_buffer *in,
360 struct acpi_buffer *out);
361 extern acpi_status wmi_query_block(const char *guid, u8 instance,
362 struct acpi_buffer *out);
363 extern acpi_status wmi_set_block(const char *guid, u8 instance,
364 const struct acpi_buffer *in);
365 extern acpi_status wmi_install_notify_handler(const char *guid,
366 wmi_notify_handler handler, void *data);
367 extern acpi_status wmi_remove_notify_handler(const char *guid);
368 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
369 extern bool wmi_has_guid(const char *guid);
371 #endif /* CONFIG_ACPI_WMI */
373 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
374 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
375 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
376 #define ACPI_VIDEO_BACKLIGHT 0x0008
377 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
378 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
379 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
380 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
381 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
382 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
383 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
384 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
386 extern char acpi_video_backlight_string[];
387 extern long acpi_is_video_device(acpi_handle handle);
388 extern int acpi_blacklisted(void);
389 extern void acpi_osi_setup(char *str);
390 extern bool acpi_osi_is_win8(void);
392 #ifdef CONFIG_ACPI_NUMA
393 int acpi_map_pxm_to_online_node(int pxm);
394 int acpi_get_node(acpi_handle handle);
396 static inline int acpi_map_pxm_to_online_node(int pxm)
400 static inline int acpi_get_node(acpi_handle handle)
405 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
407 extern int pnpacpi_disabled;
409 #define PXM_INVAL (-1)
411 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
412 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
413 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
414 struct resource_win *win);
415 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
416 struct resource_win *win);
417 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
418 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
419 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
420 struct resource *res);
422 void acpi_dev_free_resource_list(struct list_head *list);
423 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
424 int (*preproc)(struct acpi_resource *, void *),
426 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
427 unsigned long types);
429 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
432 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
435 struct acpi_device *acpi_resource_consumer(struct resource *res);
437 int acpi_check_resource_conflict(const struct resource *res);
439 int acpi_check_region(resource_size_t start, resource_size_t n,
442 int acpi_resources_are_enforced(void);
444 #ifdef CONFIG_HIBERNATION
445 void __init acpi_no_s4_hw_signature(void);
448 #ifdef CONFIG_PM_SLEEP
449 void __init acpi_old_suspend_ordering(void);
450 void __init acpi_nvs_nosave(void);
451 void __init acpi_nvs_nosave_s3(void);
452 #endif /* CONFIG_PM_SLEEP */
454 struct acpi_osc_context {
455 char *uuid_str; /* UUID string */
457 struct acpi_buffer cap; /* list of DWORD capabilities */
458 struct acpi_buffer ret; /* free by caller if success */
461 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
462 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
464 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
465 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
466 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
467 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
469 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
470 #define OSC_QUERY_ENABLE 0x00000001 /* input */
471 #define OSC_REQUEST_ERROR 0x00000002 /* return */
472 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
473 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
474 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
476 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
477 #define OSC_SB_PAD_SUPPORT 0x00000001
478 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
479 #define OSC_SB_PR3_SUPPORT 0x00000004
480 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
481 #define OSC_SB_APEI_SUPPORT 0x00000010
482 #define OSC_SB_CPC_SUPPORT 0x00000020
483 #define OSC_SB_CPCV2_SUPPORT 0x00000040
484 #define OSC_SB_PCLPI_SUPPORT 0x00000080
485 #define OSC_SB_OSLPI_SUPPORT 0x00000100
486 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
488 extern bool osc_sb_apei_support_acked;
489 extern bool osc_pc_lpi_support_confirmed;
491 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
492 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
493 #define OSC_PCI_ASPM_SUPPORT 0x00000002
494 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
495 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
496 #define OSC_PCI_MSI_SUPPORT 0x00000010
497 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
499 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
500 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
501 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
502 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
503 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
504 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
505 #define OSC_PCI_CONTROL_MASKS 0x0000001f
507 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
508 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
509 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
510 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
511 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
512 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
513 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
514 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
515 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
516 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
518 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
521 /* Enable _OST when all relevant hotplug operations are enabled */
522 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
523 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
524 defined(CONFIG_ACPI_CONTAINER)
525 #define ACPI_HOTPLUG_OST
528 /* _OST Source Event Code (OSPM Action) */
529 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
530 #define ACPI_OST_EC_OSPM_EJECT 0x103
531 #define ACPI_OST_EC_OSPM_INSERTION 0x200
533 /* _OST General Processing Status Code */
534 #define ACPI_OST_SC_SUCCESS 0x0
535 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
536 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
538 /* _OST OS Shutdown Processing (0x100) Status Code */
539 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
540 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
541 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
542 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
544 /* _OST Ejection Request (0x3, 0x103) Status Code */
545 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
546 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
547 #define ACPI_OST_SC_DEVICE_BUSY 0x82
548 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
549 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
551 /* _OST Insertion Request (0x200) Status Code */
552 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
553 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
554 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
556 extern void acpi_early_init(void);
557 extern void acpi_subsystem_init(void);
559 extern int acpi_nvs_register(__u64 start, __u64 size);
561 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
564 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
565 const struct device *dev);
567 extern bool acpi_driver_match_device(struct device *dev,
568 const struct device_driver *drv);
569 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
570 int acpi_device_modalias(struct device *, char *, int);
571 void acpi_walk_dep_device_list(acpi_handle handle);
573 struct platform_device *acpi_create_platform_device(struct acpi_device *,
574 struct property_entry *);
575 #define ACPI_PTR(_ptr) (_ptr)
577 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
579 adev->flags.visited = true;
582 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
584 adev->flags.visited = false;
587 enum acpi_reconfig_event {
588 ACPI_RECONFIG_DEVICE_ADD = 0,
589 ACPI_RECONFIG_DEVICE_REMOVE,
592 int acpi_reconfig_notifier_register(struct notifier_block *nb);
593 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
595 #ifdef CONFIG_ACPI_GTDT
596 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
597 int acpi_gtdt_map_ppi(int type);
598 bool acpi_gtdt_c3stop(int type);
599 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
602 #else /* !CONFIG_ACPI */
604 #define acpi_disabled 1
606 #define ACPI_COMPANION(dev) (NULL)
607 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
608 #define ACPI_HANDLE(dev) (NULL)
609 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
611 struct fwnode_handle;
613 static inline bool acpi_dev_found(const char *hid)
618 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
623 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
628 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
633 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
638 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
643 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
648 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
654 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
659 static inline bool has_acpi_companion(struct device *dev)
664 static inline void acpi_preset_companion(struct device *dev,
665 struct acpi_device *parent, u64 addr)
669 static inline const char *acpi_dev_name(struct acpi_device *adev)
674 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
679 static inline void acpi_early_init(void) { }
680 static inline void acpi_subsystem_init(void) { }
682 static inline int early_acpi_boot_init(void)
686 static inline int acpi_boot_init(void)
691 static inline void acpi_boot_table_init(void)
696 static inline int acpi_mps_check(void)
701 static inline int acpi_check_resource_conflict(struct resource *res)
706 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
712 struct acpi_table_header;
713 static inline int acpi_table_parse(char *id,
714 int (*handler)(struct acpi_table_header *))
719 static inline int acpi_nvs_register(__u64 start, __u64 size)
724 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
730 struct acpi_device_id;
732 static inline const struct acpi_device_id *acpi_match_device(
733 const struct acpi_device_id *ids, const struct device *dev)
738 static inline bool acpi_driver_match_device(struct device *dev,
739 const struct device_driver *drv)
744 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
747 union acpi_object *argv4)
752 static inline int acpi_device_uevent_modalias(struct device *dev,
753 struct kobj_uevent_env *env)
758 static inline int acpi_device_modalias(struct device *dev,
764 static inline bool acpi_dma_supported(struct acpi_device *adev)
769 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
771 return DEV_DMA_NOT_SUPPORTED;
774 static inline int acpi_dma_configure(struct device *dev,
775 enum dev_dma_attr attr)
780 static inline void acpi_dma_deconfigure(struct device *dev) { }
782 #define ACPI_PTR(_ptr) (NULL)
784 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
788 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
792 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
797 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
802 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
807 #endif /* !CONFIG_ACPI */
809 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
810 int acpi_ioapic_add(acpi_handle root);
812 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
816 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
817 u32 pm1a_ctrl, u32 pm1b_ctrl));
819 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
820 u32 pm1a_control, u32 pm1b_control);
822 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
823 u32 val_a, u32 val_b));
825 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
826 u32 val_a, u32 val_b);
829 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
831 static inline void arch_reserve_mem_area(acpi_physical_address addr,
835 #endif /* CONFIG_X86 */
837 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
840 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
841 int acpi_dev_runtime_suspend(struct device *dev);
842 int acpi_dev_runtime_resume(struct device *dev);
843 int acpi_subsys_runtime_suspend(struct device *dev);
844 int acpi_subsys_runtime_resume(struct device *dev);
845 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
846 int acpi_dev_pm_attach(struct device *dev, bool power_on);
848 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
849 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
850 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
851 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
852 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
856 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
862 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
863 int acpi_dev_suspend_late(struct device *dev);
864 int acpi_dev_resume_early(struct device *dev);
865 int acpi_subsys_prepare(struct device *dev);
866 void acpi_subsys_complete(struct device *dev);
867 int acpi_subsys_suspend_late(struct device *dev);
868 int acpi_subsys_resume_early(struct device *dev);
869 int acpi_subsys_suspend(struct device *dev);
870 int acpi_subsys_freeze(struct device *dev);
872 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
873 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
874 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
875 static inline void acpi_subsys_complete(struct device *dev) {}
876 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
877 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
878 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
879 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
884 void acpi_handle_printk(const char *level, acpi_handle handle,
885 const char *fmt, ...);
886 #else /* !CONFIG_ACPI */
887 static inline __printf(3, 4) void
888 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
889 #endif /* !CONFIG_ACPI */
891 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
893 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
895 #define __acpi_handle_debug(descriptor, handle, fmt, ...) \
896 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
900 * acpi_handle_<level>: Print message with ACPI prefix and object path
902 * These interfaces acquire the global namespace mutex to obtain an object
903 * path. In interrupt context, it shows the object path as <n/a>.
905 #define acpi_handle_emerg(handle, fmt, ...) \
906 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
907 #define acpi_handle_alert(handle, fmt, ...) \
908 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
909 #define acpi_handle_crit(handle, fmt, ...) \
910 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
911 #define acpi_handle_err(handle, fmt, ...) \
912 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
913 #define acpi_handle_warn(handle, fmt, ...) \
914 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
915 #define acpi_handle_notice(handle, fmt, ...) \
916 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
917 #define acpi_handle_info(handle, fmt, ...) \
918 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
921 #define acpi_handle_debug(handle, fmt, ...) \
922 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
924 #if defined(CONFIG_DYNAMIC_DEBUG)
925 #define acpi_handle_debug(handle, fmt, ...) \
927 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
928 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
929 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt), \
933 #define acpi_handle_debug(handle, fmt, ...) \
936 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
942 struct acpi_gpio_params {
943 unsigned int crs_entry_index;
944 unsigned int line_index;
948 struct acpi_gpio_mapping {
950 const struct acpi_gpio_params *data;
954 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
955 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
956 const struct acpi_gpio_mapping *gpios);
958 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
961 adev->driver_gpios = NULL;
964 int devm_acpi_dev_add_driver_gpios(struct device *dev,
965 const struct acpi_gpio_mapping *gpios);
966 void devm_acpi_dev_remove_driver_gpios(struct device *dev);
968 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
970 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
971 const struct acpi_gpio_mapping *gpios)
975 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
977 static inline int devm_acpi_dev_add_driver_gpios(struct device *dev,
978 const struct acpi_gpio_mapping *gpios)
982 static inline void devm_acpi_dev_remove_driver_gpios(struct device *dev) {}
984 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
990 /* Device properties */
992 #define MAX_ACPI_REFERENCE_ARGS 8
993 struct acpi_reference_args {
994 struct acpi_device *adev;
996 u64 args[MAX_ACPI_REFERENCE_ARGS];
1000 int acpi_dev_get_property(struct acpi_device *adev, const char *name,
1001 acpi_object_type type, const union acpi_object **obj);
1002 int __acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1003 const char *name, size_t index, size_t num_args,
1004 struct acpi_reference_args *args);
1006 static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1007 const char *name, size_t index,
1008 struct acpi_reference_args *args)
1010 return __acpi_node_get_property_reference(fwnode, name, index,
1011 MAX_ACPI_REFERENCE_ARGS, args);
1014 int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
1016 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
1017 enum dev_prop_type proptype, void *val);
1018 int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
1019 enum dev_prop_type proptype, void *val, size_t nval);
1020 int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
1021 enum dev_prop_type proptype, void *val, size_t nval);
1023 struct fwnode_handle *acpi_get_next_subnode(struct fwnode_handle *fwnode,
1024 struct fwnode_handle *child);
1025 struct fwnode_handle *acpi_node_get_parent(struct fwnode_handle *fwnode);
1027 struct fwnode_handle *acpi_graph_get_next_endpoint(struct fwnode_handle *fwnode,
1028 struct fwnode_handle *prev);
1029 int acpi_graph_get_remote_endpoint(struct fwnode_handle *fwnode,
1030 struct fwnode_handle **remote,
1031 struct fwnode_handle **port,
1032 struct fwnode_handle **endpoint);
1034 struct acpi_probe_entry;
1035 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1036 struct acpi_probe_entry *);
1038 #define ACPI_TABLE_ID_LEN 5
1041 * struct acpi_probe_entry - boot-time probing entry
1042 * @id: ACPI table name
1043 * @type: Optional subtable type to match
1044 * (if @id contains subtables)
1045 * @subtable_valid: Optional callback to check the validity of
1047 * @probe_table: Callback to the driver being probed when table
1048 * match is successful
1049 * @probe_subtbl: Callback to the driver being probed when table and
1050 * subtable match (and optional callback is successful)
1051 * @driver_data: Sideband data provided back to the driver
1053 struct acpi_probe_entry {
1054 __u8 id[ACPI_TABLE_ID_LEN];
1056 acpi_probe_entry_validate_subtbl subtable_valid;
1058 acpi_tbl_table_handler probe_table;
1059 acpi_tbl_entry_handler probe_subtbl;
1061 kernel_ulong_t driver_data;
1064 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1065 static const struct acpi_probe_entry __acpi_probe_##name \
1066 __used __section(__##table##_acpi_probe_table) \
1070 .subtable_valid = valid, \
1071 .probe_table = (acpi_tbl_table_handler)fn, \
1072 .driver_data = data, \
1075 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1076 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1078 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1080 #define acpi_probe_device_table(t) \
1082 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1083 ACPI_PROBE_TABLE_END(t); \
1084 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1085 (&ACPI_PROBE_TABLE_END(t) - \
1086 &ACPI_PROBE_TABLE(t))); \
1089 static inline int acpi_dev_get_property(struct acpi_device *adev,
1090 const char *name, acpi_object_type type,
1091 const union acpi_object **obj)
1097 __acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1098 const char *name, size_t index, size_t num_args,
1099 struct acpi_reference_args *args)
1104 static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1105 const char *name, size_t index,
1106 struct acpi_reference_args *args)
1111 static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
1112 const char *propname,
1118 static inline int acpi_dev_prop_get(struct acpi_device *adev,
1119 const char *propname,
1125 static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
1126 const char *propname,
1127 enum dev_prop_type proptype,
1133 static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
1134 const char *propname,
1135 enum dev_prop_type proptype,
1136 void *val, size_t nval)
1141 static inline int acpi_dev_prop_read(struct acpi_device *adev,
1142 const char *propname,
1143 enum dev_prop_type proptype,
1144 void *val, size_t nval)
1149 static inline struct fwnode_handle *
1150 acpi_get_next_subnode(struct fwnode_handle *fwnode, struct fwnode_handle *child)
1155 static inline struct fwnode_handle *
1156 acpi_node_get_parent(struct fwnode_handle *fwnode)
1161 static inline struct fwnode_handle *
1162 acpi_graph_get_next_endpoint(struct fwnode_handle *fwnode,
1163 struct fwnode_handle *prev)
1165 return ERR_PTR(-ENXIO);
1169 acpi_graph_get_remote_endpoint(struct fwnode_handle *fwnode,
1170 struct fwnode_handle **remote,
1171 struct fwnode_handle **port,
1172 struct fwnode_handle **endpoint)
1177 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1178 static const void * __acpi_table_##name[] \
1179 __attribute__((unused)) \
1180 = { (void *) table_id, \
1181 (void *) subtable, \
1186 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1189 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1190 void acpi_table_upgrade(void);
1192 static inline void acpi_table_upgrade(void) { }
1195 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1196 extern bool acpi_has_watchdog(void);
1198 static inline bool acpi_has_watchdog(void) { return false; }
1201 #ifdef CONFIG_ACPI_SPCR_TABLE
1202 int parse_spcr(bool earlycon);
1204 static inline int parse_spcr(bool earlycon) { return 0; }
1207 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1208 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1211 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1217 #endif /*_LINUX_ACPI_H*/