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>
45 #include <acpi/acpi_io.h>
48 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
50 return adev ? adev->handle : NULL;
53 #define ACPI_COMPANION(dev) ((dev)->acpi_node.companion)
54 #define ACPI_COMPANION_SET(dev, adev) ACPI_COMPANION(dev) = (adev)
55 #define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
57 static inline void acpi_preset_companion(struct device *dev,
58 struct acpi_device *parent, u64 addr)
60 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
63 static inline const char *acpi_dev_name(struct acpi_device *adev)
65 return dev_name(&adev->dev);
68 enum acpi_irq_model_id {
69 ACPI_IRQ_MODEL_PIC = 0,
70 ACPI_IRQ_MODEL_IOAPIC,
71 ACPI_IRQ_MODEL_IOSAPIC,
72 ACPI_IRQ_MODEL_PLATFORM,
76 extern enum acpi_irq_model_id acpi_irq_model;
78 enum acpi_interrupt_id {
79 ACPI_INTERRUPT_PMI = 1,
85 #define ACPI_SPACE_MEM 0
87 enum acpi_address_range_id {
88 ACPI_ADDRESS_RANGE_MEMORY = 1,
89 ACPI_ADDRESS_RANGE_RESERVED = 2,
90 ACPI_ADDRESS_RANGE_ACPI = 3,
91 ACPI_ADDRESS_RANGE_NVS = 4,
92 ACPI_ADDRESS_RANGE_COUNT
98 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
100 typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
101 const unsigned long end);
103 #ifdef CONFIG_ACPI_INITRD_TABLE_OVERRIDE
104 void acpi_initrd_override(void *data, size_t size);
106 static inline void acpi_initrd_override(void *data, size_t size)
111 #define BAD_MADT_ENTRY(entry, end) ( \
112 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
113 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
115 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
116 void __acpi_unmap_table(char *map, unsigned long size);
117 int early_acpi_boot_init(void);
118 int acpi_boot_init (void);
119 void acpi_boot_table_init (void);
120 int acpi_mps_check (void);
121 int acpi_numa_init (void);
123 int acpi_table_init (void);
124 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
125 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
127 acpi_tbl_entry_handler handler,
128 unsigned int max_entries);
129 int acpi_table_parse_madt(enum acpi_madt_type id,
130 acpi_tbl_entry_handler handler,
131 unsigned int max_entries);
132 int acpi_parse_mcfg (struct acpi_table_header *header);
133 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
135 /* the following four functions are architecture-dependent */
136 void acpi_numa_slit_init (struct acpi_table_slit *slit);
137 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
138 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
139 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
140 void acpi_numa_arch_fixup(void);
142 #ifdef CONFIG_ACPI_HOTPLUG_CPU
143 /* Arch dependent functions for cpu hotplug support */
144 int acpi_map_lsapic(acpi_handle handle, int physid, int *pcpu);
145 int acpi_unmap_lsapic(int cpu);
146 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
148 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
149 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
150 void acpi_irq_stats_init(void);
151 extern u32 acpi_irq_handled;
152 extern u32 acpi_irq_not_handled;
155 extern unsigned long acpi_realmode_flags;
157 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
158 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
159 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
161 #ifdef CONFIG_X86_IO_APIC
162 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
164 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
167 * This function undoes the effect of one call to acpi_register_gsi().
168 * If this matches the last registration, any IRQ resources for gsi
171 void acpi_unregister_gsi (u32 gsi);
175 int acpi_pci_irq_enable (struct pci_dev *dev);
176 void acpi_penalize_isa_irq(int irq, int active);
178 void acpi_pci_irq_disable (struct pci_dev *dev);
180 extern int ec_read(u8 addr, u8 *val);
181 extern int ec_write(u8 addr, u8 val);
182 extern int ec_transaction(u8 command,
183 const u8 *wdata, unsigned wdata_len,
184 u8 *rdata, unsigned rdata_len);
185 extern acpi_handle ec_get_handle(void);
187 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
189 typedef void (*wmi_notify_handler) (u32 value, void *context);
191 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
193 const struct acpi_buffer *in,
194 struct acpi_buffer *out);
195 extern acpi_status wmi_query_block(const char *guid, u8 instance,
196 struct acpi_buffer *out);
197 extern acpi_status wmi_set_block(const char *guid, u8 instance,
198 const struct acpi_buffer *in);
199 extern acpi_status wmi_install_notify_handler(const char *guid,
200 wmi_notify_handler handler, void *data);
201 extern acpi_status wmi_remove_notify_handler(const char *guid);
202 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
203 extern bool wmi_has_guid(const char *guid);
205 #endif /* CONFIG_ACPI_WMI */
207 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
208 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
209 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
210 #define ACPI_VIDEO_BACKLIGHT 0x0008
211 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
212 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
213 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
214 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
215 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
216 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
217 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
218 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
220 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
222 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
223 extern long acpi_is_video_device(acpi_handle handle);
224 extern void acpi_video_dmi_promote_vendor(void);
225 extern void acpi_video_dmi_demote_vendor(void);
226 extern int acpi_video_backlight_support(void);
227 extern int acpi_video_display_switch_support(void);
231 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
236 static inline long acpi_is_video_device(acpi_handle handle)
241 static inline void acpi_video_dmi_promote_vendor(void)
245 static inline void acpi_video_dmi_demote_vendor(void)
249 static inline int acpi_video_backlight_support(void)
254 static inline int acpi_video_display_switch_support(void)
259 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
261 extern int acpi_blacklisted(void);
262 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
263 extern void acpi_osi_setup(char *str);
265 #ifdef CONFIG_ACPI_NUMA
266 int acpi_get_pxm(acpi_handle handle);
267 int acpi_get_node(acpi_handle *handle);
269 static inline int acpi_get_pxm(acpi_handle handle)
273 static inline int acpi_get_node(acpi_handle *handle)
278 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
280 extern int pnpacpi_disabled;
282 #define PXM_INVAL (-1)
284 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
285 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
286 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
287 struct resource *res);
288 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
289 struct resource *res);
290 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
291 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
292 struct resource *res);
294 struct resource_list_entry {
295 struct list_head node;
299 void acpi_dev_free_resource_list(struct list_head *list);
300 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
301 int (*preproc)(struct acpi_resource *, void *),
304 int acpi_check_resource_conflict(const struct resource *res);
306 int acpi_check_region(resource_size_t start, resource_size_t n,
309 int acpi_resources_are_enforced(void);
311 #ifdef CONFIG_HIBERNATION
312 void __init acpi_no_s4_hw_signature(void);
315 #ifdef CONFIG_PM_SLEEP
316 void __init acpi_old_suspend_ordering(void);
317 void __init acpi_nvs_nosave(void);
318 void __init acpi_nvs_nosave_s3(void);
319 #endif /* CONFIG_PM_SLEEP */
321 struct acpi_osc_context {
322 char *uuid_str; /* UUID string */
324 struct acpi_buffer cap; /* list of DWORD capabilities */
325 struct acpi_buffer ret; /* free by caller if success */
328 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
329 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
331 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
332 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
333 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
334 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
336 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
337 #define OSC_QUERY_ENABLE 0x00000001 /* input */
338 #define OSC_REQUEST_ERROR 0x00000002 /* return */
339 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
340 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
341 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
343 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
344 #define OSC_SB_PAD_SUPPORT 0x00000001
345 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
346 #define OSC_SB_PR3_SUPPORT 0x00000004
347 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
348 #define OSC_SB_APEI_SUPPORT 0x00000010
349 #define OSC_SB_CPC_SUPPORT 0x00000020
351 extern bool osc_sb_apei_support_acked;
353 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
354 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
355 #define OSC_PCI_ASPM_SUPPORT 0x00000002
356 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
357 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
358 #define OSC_PCI_MSI_SUPPORT 0x00000010
359 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
361 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
362 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
363 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
364 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
365 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
366 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
367 #define OSC_PCI_CONTROL_MASKS 0x0000001f
369 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
372 /* Enable _OST when all relevant hotplug operations are enabled */
373 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
374 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
375 defined(CONFIG_ACPI_CONTAINER)
376 #define ACPI_HOTPLUG_OST
379 /* _OST Source Event Code (OSPM Action) */
380 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
381 #define ACPI_OST_EC_OSPM_EJECT 0x103
382 #define ACPI_OST_EC_OSPM_INSERTION 0x200
384 /* _OST General Processing Status Code */
385 #define ACPI_OST_SC_SUCCESS 0x0
386 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
387 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
389 /* _OST OS Shutdown Processing (0x100) Status Code */
390 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
391 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
392 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
393 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
395 /* _OST Ejection Request (0x3, 0x103) Status Code */
396 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
397 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
398 #define ACPI_OST_SC_DEVICE_BUSY 0x82
399 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
400 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
402 /* _OST Insertion Request (0x200) Status Code */
403 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
404 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
405 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
407 extern void acpi_early_init(void);
409 extern int acpi_nvs_register(__u64 start, __u64 size);
411 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
414 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
415 const struct device *dev);
417 static inline bool acpi_driver_match_device(struct device *dev,
418 const struct device_driver *drv)
420 return !!acpi_match_device(drv->acpi_match_table, dev);
423 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
424 int acpi_device_modalias(struct device *, char *, int);
426 #define ACPI_PTR(_ptr) (_ptr)
428 #else /* !CONFIG_ACPI */
430 #define acpi_disabled 1
432 #define ACPI_COMPANION(dev) (NULL)
433 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
434 #define ACPI_HANDLE(dev) (NULL)
436 static inline const char *acpi_dev_name(struct acpi_device *adev)
441 static inline void acpi_early_init(void) { }
443 static inline int early_acpi_boot_init(void)
447 static inline int acpi_boot_init(void)
452 static inline void acpi_boot_table_init(void)
457 static inline int acpi_mps_check(void)
462 static inline int acpi_check_resource_conflict(struct resource *res)
467 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
473 struct acpi_table_header;
474 static inline int acpi_table_parse(char *id,
475 int (*handler)(struct acpi_table_header *))
480 static inline int acpi_nvs_register(__u64 start, __u64 size)
485 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
491 struct acpi_device_id;
493 static inline const struct acpi_device_id *acpi_match_device(
494 const struct acpi_device_id *ids, const struct device *dev)
499 static inline bool acpi_driver_match_device(struct device *dev,
500 const struct device_driver *drv)
505 static inline int acpi_device_uevent_modalias(struct device *dev,
506 struct kobj_uevent_env *env)
511 static inline int acpi_device_modalias(struct device *dev,
517 #define ACPI_PTR(_ptr) (NULL)
519 #endif /* !CONFIG_ACPI */
522 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
523 u32 pm1a_ctrl, u32 pm1b_ctrl));
525 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
526 u32 pm1a_control, u32 pm1b_control);
528 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
529 u32 val_a, u32 val_b));
531 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
532 u32 val_a, u32 val_b);
535 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
537 static inline void arch_reserve_mem_area(acpi_physical_address addr,
541 #endif /* CONFIG_X86 */
543 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
546 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_RUNTIME)
547 int acpi_dev_runtime_suspend(struct device *dev);
548 int acpi_dev_runtime_resume(struct device *dev);
549 int acpi_subsys_runtime_suspend(struct device *dev);
550 int acpi_subsys_runtime_resume(struct device *dev);
552 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
553 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
554 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
555 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
558 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
559 int acpi_dev_suspend_late(struct device *dev);
560 int acpi_dev_resume_early(struct device *dev);
561 int acpi_subsys_prepare(struct device *dev);
562 int acpi_subsys_suspend_late(struct device *dev);
563 int acpi_subsys_resume_early(struct device *dev);
565 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
566 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
567 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
568 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
569 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
572 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
573 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
574 int acpi_dev_pm_attach(struct device *dev, bool power_on);
575 void acpi_dev_pm_detach(struct device *dev, bool power_off);
577 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
581 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
585 static inline void acpi_dev_pm_detach(struct device *dev, bool power_off) {}
590 void acpi_handle_printk(const char *level, acpi_handle handle,
591 const char *fmt, ...);
592 #else /* !CONFIG_ACPI */
593 static inline __printf(3, 4) void
594 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
595 #endif /* !CONFIG_ACPI */
598 * acpi_handle_<level>: Print message with ACPI prefix and object path
600 * These interfaces acquire the global namespace mutex to obtain an object
601 * path. In interrupt context, it shows the object path as <n/a>.
603 #define acpi_handle_emerg(handle, fmt, ...) \
604 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
605 #define acpi_handle_alert(handle, fmt, ...) \
606 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
607 #define acpi_handle_crit(handle, fmt, ...) \
608 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
609 #define acpi_handle_err(handle, fmt, ...) \
610 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
611 #define acpi_handle_warn(handle, fmt, ...) \
612 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
613 #define acpi_handle_notice(handle, fmt, ...) \
614 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
615 #define acpi_handle_info(handle, fmt, ...) \
616 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
618 /* REVISIT: Support CONFIG_DYNAMIC_DEBUG when necessary */
619 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
620 #define acpi_handle_debug(handle, fmt, ...) \
621 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
623 #define acpi_handle_debug(handle, fmt, ...) \
626 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
631 #endif /*_LINUX_ACPI_H*/