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 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28 #include <linux/errno.h>
29 #include <linux/ioport.h> /* for struct resource */
30 #include <linux/device.h>
38 #include <linux/list.h>
39 #include <linux/mod_devicetable.h>
41 #include <acpi/acpi.h>
42 #include <acpi/acpi_bus.h>
43 #include <acpi/acpi_drivers.h>
44 #include <acpi/acpi_numa.h>
47 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
49 return adev ? adev->handle : NULL;
52 #define ACPI_COMPANION(dev) ((dev)->acpi_node.companion)
53 #define ACPI_COMPANION_SET(dev, adev) ACPI_COMPANION(dev) = (adev)
54 #define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
56 enum acpi_irq_model_id {
57 ACPI_IRQ_MODEL_PIC = 0,
58 ACPI_IRQ_MODEL_IOAPIC,
59 ACPI_IRQ_MODEL_IOSAPIC,
60 ACPI_IRQ_MODEL_PLATFORM,
64 extern enum acpi_irq_model_id acpi_irq_model;
66 enum acpi_interrupt_id {
67 ACPI_INTERRUPT_PMI = 1,
73 #define ACPI_SPACE_MEM 0
75 enum acpi_address_range_id {
76 ACPI_ADDRESS_RANGE_MEMORY = 1,
77 ACPI_ADDRESS_RANGE_RESERVED = 2,
78 ACPI_ADDRESS_RANGE_ACPI = 3,
79 ACPI_ADDRESS_RANGE_NVS = 4,
80 ACPI_ADDRESS_RANGE_COUNT
86 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
88 typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
89 const unsigned long end);
91 #ifdef CONFIG_ACPI_INITRD_TABLE_OVERRIDE
92 void acpi_initrd_override(void *data, size_t size);
94 static inline void acpi_initrd_override(void *data, size_t size)
99 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
100 void __acpi_unmap_table(char *map, unsigned long size);
101 int early_acpi_boot_init(void);
102 int acpi_boot_init (void);
103 void acpi_boot_table_init (void);
104 int acpi_mps_check (void);
105 int acpi_numa_init (void);
107 int acpi_table_init (void);
108 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
109 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
111 acpi_tbl_entry_handler handler,
112 unsigned int max_entries);
113 int acpi_table_parse_madt(enum acpi_madt_type id,
114 acpi_tbl_entry_handler handler,
115 unsigned int max_entries);
116 int acpi_parse_mcfg (struct acpi_table_header *header);
117 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
119 /* the following four functions are architecture-dependent */
120 void acpi_numa_slit_init (struct acpi_table_slit *slit);
121 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
122 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
123 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
124 void acpi_numa_arch_fixup(void);
126 #ifdef CONFIG_ACPI_HOTPLUG_CPU
127 /* Arch dependent functions for cpu hotplug support */
128 int acpi_map_lsapic(acpi_handle handle, int physid, int *pcpu);
129 int acpi_unmap_lsapic(int cpu);
130 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
132 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
133 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
134 void acpi_irq_stats_init(void);
135 extern u32 acpi_irq_handled;
136 extern u32 acpi_irq_not_handled;
139 extern unsigned long acpi_realmode_flags;
141 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
142 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
143 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
145 #ifdef CONFIG_X86_IO_APIC
146 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
148 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
151 * This function undoes the effect of one call to acpi_register_gsi().
152 * If this matches the last registration, any IRQ resources for gsi
155 void acpi_unregister_gsi (u32 gsi);
159 int acpi_pci_irq_enable (struct pci_dev *dev);
160 void acpi_penalize_isa_irq(int irq, int active);
162 void acpi_pci_irq_disable (struct pci_dev *dev);
164 extern int ec_read(u8 addr, u8 *val);
165 extern int ec_write(u8 addr, u8 val);
166 extern int ec_transaction(u8 command,
167 const u8 *wdata, unsigned wdata_len,
168 u8 *rdata, unsigned rdata_len);
169 extern acpi_handle ec_get_handle(void);
171 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
173 typedef void (*wmi_notify_handler) (u32 value, void *context);
175 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
177 const struct acpi_buffer *in,
178 struct acpi_buffer *out);
179 extern acpi_status wmi_query_block(const char *guid, u8 instance,
180 struct acpi_buffer *out);
181 extern acpi_status wmi_set_block(const char *guid, u8 instance,
182 const struct acpi_buffer *in);
183 extern acpi_status wmi_install_notify_handler(const char *guid,
184 wmi_notify_handler handler, void *data);
185 extern acpi_status wmi_remove_notify_handler(const char *guid);
186 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
187 extern bool wmi_has_guid(const char *guid);
189 #endif /* CONFIG_ACPI_WMI */
191 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
192 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
193 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
194 #define ACPI_VIDEO_BACKLIGHT 0x0008
195 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
196 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
197 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
198 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
199 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
200 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
201 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
202 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
204 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
206 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
207 extern long acpi_is_video_device(acpi_handle handle);
208 extern void acpi_video_dmi_promote_vendor(void);
209 extern void acpi_video_dmi_demote_vendor(void);
210 extern int acpi_video_backlight_support(void);
211 extern int acpi_video_display_switch_support(void);
215 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
220 static inline long acpi_is_video_device(acpi_handle handle)
225 static inline void acpi_video_dmi_promote_vendor(void)
229 static inline void acpi_video_dmi_demote_vendor(void)
233 static inline int acpi_video_backlight_support(void)
238 static inline int acpi_video_display_switch_support(void)
243 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
245 extern int acpi_blacklisted(void);
246 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
247 extern void acpi_osi_setup(char *str);
249 #ifdef CONFIG_ACPI_NUMA
250 int acpi_get_pxm(acpi_handle handle);
251 int acpi_get_node(acpi_handle *handle);
253 static inline int acpi_get_pxm(acpi_handle handle)
257 static inline int acpi_get_node(acpi_handle *handle)
262 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
264 extern int pnpacpi_disabled;
266 #define PXM_INVAL (-1)
268 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
269 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
270 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
271 struct resource *res);
272 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
273 struct resource *res);
274 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
275 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
276 struct resource *res);
278 struct resource_list_entry {
279 struct list_head node;
283 void acpi_dev_free_resource_list(struct list_head *list);
284 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
285 int (*preproc)(struct acpi_resource *, void *),
288 int acpi_check_resource_conflict(const struct resource *res);
290 int acpi_check_region(resource_size_t start, resource_size_t n,
293 int acpi_resources_are_enforced(void);
295 #ifdef CONFIG_HIBERNATION
296 void __init acpi_no_s4_hw_signature(void);
299 #ifdef CONFIG_PM_SLEEP
300 void __init acpi_old_suspend_ordering(void);
301 void __init acpi_nvs_nosave(void);
302 void __init acpi_nvs_nosave_s3(void);
303 #endif /* CONFIG_PM_SLEEP */
305 struct acpi_osc_context {
306 char *uuid_str; /* UUID string */
308 struct acpi_buffer cap; /* list of DWORD capabilities */
309 struct acpi_buffer ret; /* free by caller if success */
312 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
313 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
315 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
316 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
317 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
318 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
320 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
321 #define OSC_QUERY_ENABLE 0x00000001 /* input */
322 #define OSC_REQUEST_ERROR 0x00000002 /* return */
323 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
324 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
325 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
327 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
328 #define OSC_SB_PAD_SUPPORT 0x00000001
329 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
330 #define OSC_SB_PR3_SUPPORT 0x00000004
331 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
332 #define OSC_SB_APEI_SUPPORT 0x00000010
333 #define OSC_SB_CPC_SUPPORT 0x00000020
335 extern bool osc_sb_apei_support_acked;
337 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
338 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
339 #define OSC_PCI_ASPM_SUPPORT 0x00000002
340 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
341 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
342 #define OSC_PCI_MSI_SUPPORT 0x00000010
343 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
345 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
346 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
347 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
348 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
349 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
350 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
351 #define OSC_PCI_CONTROL_MASKS 0x0000001f
353 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
356 /* Enable _OST when all relevant hotplug operations are enabled */
357 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
358 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
359 defined(CONFIG_ACPI_CONTAINER)
360 #define ACPI_HOTPLUG_OST
363 /* _OST Source Event Code (OSPM Action) */
364 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
365 #define ACPI_OST_EC_OSPM_EJECT 0x103
366 #define ACPI_OST_EC_OSPM_INSERTION 0x200
368 /* _OST General Processing Status Code */
369 #define ACPI_OST_SC_SUCCESS 0x0
370 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
371 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
373 /* _OST OS Shutdown Processing (0x100) Status Code */
374 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
375 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
376 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
377 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
379 /* _OST Ejection Request (0x3, 0x103) Status Code */
380 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
381 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
382 #define ACPI_OST_SC_DEVICE_BUSY 0x82
383 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
384 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
386 /* _OST Insertion Request (0x200) Status Code */
387 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
388 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
389 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
391 extern void acpi_early_init(void);
393 extern int acpi_nvs_register(__u64 start, __u64 size);
395 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
398 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
399 const struct device *dev);
401 static inline bool acpi_driver_match_device(struct device *dev,
402 const struct device_driver *drv)
404 return !!acpi_match_device(drv->acpi_match_table, dev);
407 #define ACPI_PTR(_ptr) (_ptr)
409 #else /* !CONFIG_ACPI */
411 #define acpi_disabled 1
413 #define ACPI_COMPANION(dev) (NULL)
414 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
415 #define ACPI_HANDLE(dev) (NULL)
417 static inline void acpi_early_init(void) { }
419 static inline int early_acpi_boot_init(void)
423 static inline int acpi_boot_init(void)
428 static inline void acpi_boot_table_init(void)
433 static inline int acpi_mps_check(void)
438 static inline int acpi_check_resource_conflict(struct resource *res)
443 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
449 struct acpi_table_header;
450 static inline int acpi_table_parse(char *id,
451 int (*handler)(struct acpi_table_header *))
456 static inline int acpi_nvs_register(__u64 start, __u64 size)
461 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
467 struct acpi_device_id;
469 static inline const struct acpi_device_id *acpi_match_device(
470 const struct acpi_device_id *ids, const struct device *dev)
475 static inline bool acpi_driver_match_device(struct device *dev,
476 const struct device_driver *drv)
481 #define ACPI_PTR(_ptr) (NULL)
483 #endif /* !CONFIG_ACPI */
485 #define DEVICE_ACPI_HANDLE(dev) ACPI_HANDLE(dev)
488 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
489 u32 pm1a_ctrl, u32 pm1b_ctrl));
491 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
492 u32 pm1a_control, u32 pm1b_control);
494 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
495 u32 val_a, u32 val_b));
497 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
498 u32 val_a, u32 val_b);
501 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
503 static inline void arch_reserve_mem_area(acpi_physical_address addr,
507 #endif /* CONFIG_X86 */
509 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
512 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_RUNTIME)
513 int acpi_dev_runtime_suspend(struct device *dev);
514 int acpi_dev_runtime_resume(struct device *dev);
515 int acpi_subsys_runtime_suspend(struct device *dev);
516 int acpi_subsys_runtime_resume(struct device *dev);
518 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
519 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
520 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
521 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
524 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
525 int acpi_dev_suspend_late(struct device *dev);
526 int acpi_dev_resume_early(struct device *dev);
527 int acpi_subsys_prepare(struct device *dev);
528 int acpi_subsys_suspend_late(struct device *dev);
529 int acpi_subsys_resume_early(struct device *dev);
531 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
532 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
533 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
534 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
535 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
538 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
539 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
540 int acpi_dev_pm_attach(struct device *dev, bool power_on);
541 void acpi_dev_pm_detach(struct device *dev, bool power_off);
543 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
547 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
551 static inline void acpi_dev_pm_detach(struct device *dev, bool power_off) {}
556 void acpi_handle_printk(const char *level, acpi_handle handle,
557 const char *fmt, ...);
558 #else /* !CONFIG_ACPI */
559 static inline __printf(3, 4) void
560 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
561 #endif /* !CONFIG_ACPI */
564 * acpi_handle_<level>: Print message with ACPI prefix and object path
566 * These interfaces acquire the global namespace mutex to obtain an object
567 * path. In interrupt context, it shows the object path as <n/a>.
569 #define acpi_handle_emerg(handle, fmt, ...) \
570 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
571 #define acpi_handle_alert(handle, fmt, ...) \
572 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
573 #define acpi_handle_crit(handle, fmt, ...) \
574 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
575 #define acpi_handle_err(handle, fmt, ...) \
576 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
577 #define acpi_handle_warn(handle, fmt, ...) \
578 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
579 #define acpi_handle_notice(handle, fmt, ...) \
580 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
581 #define acpi_handle_info(handle, fmt, ...) \
582 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
584 /* REVISIT: Support CONFIG_DYNAMIC_DEBUG when necessary */
585 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
586 #define acpi_handle_debug(handle, fmt, ...) \
587 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
589 #define acpi_handle_debug(handle, fmt, ...) \
592 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
597 #endif /*_LINUX_ACPI_H*/