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 enum acpi_irq_model_id
{
48 ACPI_IRQ_MODEL_PIC
= 0,
49 ACPI_IRQ_MODEL_IOAPIC
,
50 ACPI_IRQ_MODEL_IOSAPIC
,
51 ACPI_IRQ_MODEL_PLATFORM
,
55 extern enum acpi_irq_model_id acpi_irq_model
;
57 enum acpi_interrupt_id
{
58 ACPI_INTERRUPT_PMI
= 1,
64 #define ACPI_SPACE_MEM 0
66 enum acpi_address_range_id
{
67 ACPI_ADDRESS_RANGE_MEMORY
= 1,
68 ACPI_ADDRESS_RANGE_RESERVED
= 2,
69 ACPI_ADDRESS_RANGE_ACPI
= 3,
70 ACPI_ADDRESS_RANGE_NVS
= 4,
71 ACPI_ADDRESS_RANGE_COUNT
77 typedef int (*acpi_tbl_table_handler
)(struct acpi_table_header
*table
);
79 typedef int (*acpi_tbl_entry_handler
)(struct acpi_subtable_header
*header
,
80 const unsigned long end
);
82 #ifdef CONFIG_ACPI_INITRD_TABLE_OVERRIDE
83 void acpi_initrd_override(void *data
, size_t size
);
85 static inline void acpi_initrd_override(void *data
, size_t size
)
90 char * __acpi_map_table (unsigned long phys_addr
, unsigned long size
);
91 void __acpi_unmap_table(char *map
, unsigned long size
);
92 int early_acpi_boot_init(void);
93 int acpi_boot_init (void);
94 void acpi_boot_table_init (void);
95 int acpi_mps_check (void);
96 int acpi_numa_init (void);
98 int acpi_table_init (void);
99 int acpi_table_parse(char *id
, acpi_tbl_table_handler handler
);
100 int __init
acpi_table_parse_entries(char *id
, unsigned long table_size
,
102 acpi_tbl_entry_handler handler
,
103 unsigned int max_entries
);
104 int acpi_table_parse_madt(enum acpi_madt_type id
,
105 acpi_tbl_entry_handler handler
,
106 unsigned int max_entries
);
107 int acpi_parse_mcfg (struct acpi_table_header
*header
);
108 void acpi_table_print_madt_entry (struct acpi_subtable_header
*madt
);
110 /* the following four functions are architecture-dependent */
111 void acpi_numa_slit_init (struct acpi_table_slit
*slit
);
112 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity
*pa
);
113 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity
*pa
);
114 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity
*ma
);
115 void acpi_numa_arch_fixup(void);
117 #ifdef CONFIG_ACPI_HOTPLUG_CPU
118 /* Arch dependent functions for cpu hotplug support */
119 int acpi_map_lsapic(acpi_handle handle
, int *pcpu
);
120 int acpi_unmap_lsapic(int cpu
);
121 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
123 int acpi_register_ioapic(acpi_handle handle
, u64 phys_addr
, u32 gsi_base
);
124 int acpi_unregister_ioapic(acpi_handle handle
, u32 gsi_base
);
125 void acpi_irq_stats_init(void);
126 extern u32 acpi_irq_handled
;
127 extern u32 acpi_irq_not_handled
;
130 extern unsigned long acpi_realmode_flags
;
132 int acpi_register_gsi (struct device
*dev
, u32 gsi
, int triggering
, int polarity
);
133 int acpi_gsi_to_irq (u32 gsi
, unsigned int *irq
);
134 int acpi_isa_irq_to_gsi (unsigned isa_irq
, u32
*gsi
);
136 #ifdef CONFIG_X86_IO_APIC
137 extern int acpi_get_override_irq(u32 gsi
, int *trigger
, int *polarity
);
139 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
142 * This function undoes the effect of one call to acpi_register_gsi().
143 * If this matches the last registration, any IRQ resources for gsi
146 void acpi_unregister_gsi (u32 gsi
);
150 int acpi_pci_irq_enable (struct pci_dev
*dev
);
151 void acpi_penalize_isa_irq(int irq
, int active
);
153 void acpi_pci_irq_disable (struct pci_dev
*dev
);
155 extern int ec_read(u8 addr
, u8
*val
);
156 extern int ec_write(u8 addr
, u8 val
);
157 extern int ec_transaction(u8 command
,
158 const u8
*wdata
, unsigned wdata_len
,
159 u8
*rdata
, unsigned rdata_len
);
160 extern acpi_handle
ec_get_handle(void);
162 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
164 typedef void (*wmi_notify_handler
) (u32 value
, void *context
);
166 extern acpi_status
wmi_evaluate_method(const char *guid
, u8 instance
,
168 const struct acpi_buffer
*in
,
169 struct acpi_buffer
*out
);
170 extern acpi_status
wmi_query_block(const char *guid
, u8 instance
,
171 struct acpi_buffer
*out
);
172 extern acpi_status
wmi_set_block(const char *guid
, u8 instance
,
173 const struct acpi_buffer
*in
);
174 extern acpi_status
wmi_install_notify_handler(const char *guid
,
175 wmi_notify_handler handler
, void *data
);
176 extern acpi_status
wmi_remove_notify_handler(const char *guid
);
177 extern acpi_status
wmi_get_event_data(u32 event
, struct acpi_buffer
*out
);
178 extern bool wmi_has_guid(const char *guid
);
180 #endif /* CONFIG_ACPI_WMI */
182 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
183 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
184 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
185 #define ACPI_VIDEO_BACKLIGHT 0x0008
186 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
187 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
188 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
189 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
190 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
191 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
192 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
193 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
195 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
197 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle
);
198 extern long acpi_is_video_device(acpi_handle handle
);
199 extern void acpi_video_dmi_promote_vendor(void);
200 extern void acpi_video_dmi_demote_vendor(void);
201 extern int acpi_video_backlight_support(void);
202 extern int acpi_video_display_switch_support(void);
206 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle
)
211 static inline long acpi_is_video_device(acpi_handle handle
)
216 static inline void acpi_video_dmi_promote_vendor(void)
220 static inline void acpi_video_dmi_demote_vendor(void)
224 static inline int acpi_video_backlight_support(void)
229 static inline int acpi_video_display_switch_support(void)
234 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
236 extern int acpi_blacklisted(void);
237 extern void acpi_dmi_osi_linux(int enable
, const struct dmi_system_id
*d
);
238 extern void acpi_osi_setup(char *str
);
240 #ifdef CONFIG_ACPI_NUMA
241 int acpi_get_pxm(acpi_handle handle
);
242 int acpi_get_node(acpi_handle
*handle
);
244 static inline int acpi_get_pxm(acpi_handle handle
)
248 static inline int acpi_get_node(acpi_handle
*handle
)
253 extern int acpi_paddr_to_node(u64 start_addr
, u64 size
);
255 extern int pnpacpi_disabled
;
257 #define PXM_INVAL (-1)
259 bool acpi_dev_resource_memory(struct acpi_resource
*ares
, struct resource
*res
);
260 bool acpi_dev_resource_io(struct acpi_resource
*ares
, struct resource
*res
);
261 bool acpi_dev_resource_address_space(struct acpi_resource
*ares
,
262 struct resource
*res
);
263 bool acpi_dev_resource_ext_address_space(struct acpi_resource
*ares
,
264 struct resource
*res
);
265 unsigned long acpi_dev_irq_flags(u8 triggering
, u8 polarity
, u8 shareable
);
266 bool acpi_dev_resource_interrupt(struct acpi_resource
*ares
, int index
,
267 struct resource
*res
);
269 struct resource_list_entry
{
270 struct list_head node
;
274 void acpi_dev_free_resource_list(struct list_head
*list
);
275 int acpi_dev_get_resources(struct acpi_device
*adev
, struct list_head
*list
,
276 int (*preproc
)(struct acpi_resource
*, void *),
279 int acpi_check_resource_conflict(const struct resource
*res
);
281 int acpi_check_region(resource_size_t start
, resource_size_t n
,
284 int acpi_resources_are_enforced(void);
286 #ifdef CONFIG_HIBERNATION
287 void __init
acpi_no_s4_hw_signature(void);
290 #ifdef CONFIG_PM_SLEEP
291 void __init
acpi_old_suspend_ordering(void);
292 void __init
acpi_nvs_nosave(void);
293 void __init
acpi_nvs_nosave_s3(void);
294 #endif /* CONFIG_PM_SLEEP */
296 struct acpi_osc_context
{
297 char *uuid_str
; /* uuid string */
299 struct acpi_buffer cap
; /* arg2/arg3 */
300 struct acpi_buffer ret
; /* free by caller if success */
303 #define OSC_QUERY_TYPE 0
304 #define OSC_SUPPORT_TYPE 1
305 #define OSC_CONTROL_TYPE 2
307 /* _OSC DW0 Definition */
308 #define OSC_QUERY_ENABLE 1
309 #define OSC_REQUEST_ERROR 2
310 #define OSC_INVALID_UUID_ERROR 4
311 #define OSC_INVALID_REVISION_ERROR 8
312 #define OSC_CAPABILITIES_MASK_ERROR 16
314 acpi_status
acpi_run_osc(acpi_handle handle
, struct acpi_osc_context
*context
);
316 /* platform-wide _OSC bits */
317 #define OSC_SB_PAD_SUPPORT 1
318 #define OSC_SB_PPC_OST_SUPPORT 2
319 #define OSC_SB_PR3_SUPPORT 4
320 #define OSC_SB_HOTPLUG_OST_SUPPORT 8
321 #define OSC_SB_APEI_SUPPORT 16
323 extern bool osc_sb_apei_support_acked
;
325 /* PCI defined _OSC bits */
326 /* _OSC DW1 Definition (OS Support Fields) */
327 #define OSC_EXT_PCI_CONFIG_SUPPORT 1
328 #define OSC_ACTIVE_STATE_PWR_SUPPORT 2
329 #define OSC_CLOCK_PWR_CAPABILITY_SUPPORT 4
330 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 8
331 #define OSC_MSI_SUPPORT 16
332 #define OSC_PCI_SUPPORT_MASKS 0x1f
334 /* _OSC DW1 Definition (OS Control Fields) */
335 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 1
336 #define OSC_SHPC_NATIVE_HP_CONTROL 2
337 #define OSC_PCI_EXPRESS_PME_CONTROL 4
338 #define OSC_PCI_EXPRESS_AER_CONTROL 8
339 #define OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL 16
341 #define OSC_PCI_CONTROL_MASKS (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL | \
342 OSC_SHPC_NATIVE_HP_CONTROL | \
343 OSC_PCI_EXPRESS_PME_CONTROL | \
344 OSC_PCI_EXPRESS_AER_CONTROL | \
345 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL)
347 #define OSC_PCI_NATIVE_HOTPLUG (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL | \
348 OSC_SHPC_NATIVE_HP_CONTROL)
350 extern acpi_status
acpi_pci_osc_control_set(acpi_handle handle
,
353 /* Enable _OST when all relevant hotplug operations are enabled */
354 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
355 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
356 defined(CONFIG_ACPI_CONTAINER)
357 #define ACPI_HOTPLUG_OST
360 /* _OST Source Event Code (OSPM Action) */
361 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
362 #define ACPI_OST_EC_OSPM_EJECT 0x103
363 #define ACPI_OST_EC_OSPM_INSERTION 0x200
365 /* _OST General Processing Status Code */
366 #define ACPI_OST_SC_SUCCESS 0x0
367 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
368 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
370 /* _OST OS Shutdown Processing (0x100) Status Code */
371 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
372 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
373 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
374 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
376 /* _OST Ejection Request (0x3, 0x103) Status Code */
377 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
378 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
379 #define ACPI_OST_SC_DEVICE_BUSY 0x82
380 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
381 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
383 /* _OST Insertion Request (0x200) Status Code */
384 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
385 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
386 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
388 extern void acpi_early_init(void);
390 extern int acpi_nvs_register(__u64 start
, __u64 size
);
392 extern int acpi_nvs_for_each_region(int (*func
)(__u64
, __u64
, void *),
395 const struct acpi_device_id
*acpi_match_device(const struct acpi_device_id
*ids
,
396 const struct device
*dev
);
398 static inline bool acpi_driver_match_device(struct device
*dev
,
399 const struct device_driver
*drv
)
401 return !!acpi_match_device(drv
->acpi_match_table
, dev
);
404 #define ACPI_PTR(_ptr) (_ptr)
406 #else /* !CONFIG_ACPI */
408 #define acpi_disabled 1
410 static inline void acpi_early_init(void) { }
412 static inline int early_acpi_boot_init(void)
416 static inline int acpi_boot_init(void)
421 static inline void acpi_boot_table_init(void)
426 static inline int acpi_mps_check(void)
431 static inline int acpi_check_resource_conflict(struct resource
*res
)
436 static inline int acpi_check_region(resource_size_t start
, resource_size_t n
,
442 struct acpi_table_header
;
443 static inline int acpi_table_parse(char *id
,
444 int (*handler
)(struct acpi_table_header
*))
449 static inline int acpi_nvs_register(__u64 start
, __u64 size
)
454 static inline int acpi_nvs_for_each_region(int (*func
)(__u64
, __u64
, void *),
460 struct acpi_device_id
;
462 static inline const struct acpi_device_id
*acpi_match_device(
463 const struct acpi_device_id
*ids
, const struct device
*dev
)
468 static inline bool acpi_driver_match_device(struct device
*dev
,
469 const struct device_driver
*drv
)
474 #define ACPI_PTR(_ptr) (NULL)
476 #endif /* !CONFIG_ACPI */
479 void acpi_os_set_prepare_sleep(int (*func
)(u8 sleep_state
,
480 u32 pm1a_ctrl
, u32 pm1b_ctrl
));
482 acpi_status
acpi_os_prepare_sleep(u8 sleep_state
,
483 u32 pm1a_control
, u32 pm1b_control
);
485 void arch_reserve_mem_area(acpi_physical_address addr
, size_t size
);
487 static inline void arch_reserve_mem_area(acpi_physical_address addr
,
491 #endif /* CONFIG_X86 */
493 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
496 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_RUNTIME)
497 int acpi_dev_runtime_suspend(struct device
*dev
);
498 int acpi_dev_runtime_resume(struct device
*dev
);
499 int acpi_subsys_runtime_suspend(struct device
*dev
);
500 int acpi_subsys_runtime_resume(struct device
*dev
);
502 static inline int acpi_dev_runtime_suspend(struct device
*dev
) { return 0; }
503 static inline int acpi_dev_runtime_resume(struct device
*dev
) { return 0; }
504 static inline int acpi_subsys_runtime_suspend(struct device
*dev
) { return 0; }
505 static inline int acpi_subsys_runtime_resume(struct device
*dev
) { return 0; }
508 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
509 int acpi_dev_suspend_late(struct device
*dev
);
510 int acpi_dev_resume_early(struct device
*dev
);
511 int acpi_subsys_prepare(struct device
*dev
);
512 int acpi_subsys_suspend_late(struct device
*dev
);
513 int acpi_subsys_resume_early(struct device
*dev
);
515 static inline int acpi_dev_suspend_late(struct device
*dev
) { return 0; }
516 static inline int acpi_dev_resume_early(struct device
*dev
) { return 0; }
517 static inline int acpi_subsys_prepare(struct device
*dev
) { return 0; }
518 static inline int acpi_subsys_suspend_late(struct device
*dev
) { return 0; }
519 static inline int acpi_subsys_resume_early(struct device
*dev
) { return 0; }
522 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
523 struct acpi_device
*acpi_dev_pm_get_node(struct device
*dev
);
524 int acpi_dev_pm_attach(struct device
*dev
, bool power_on
);
525 void acpi_dev_pm_detach(struct device
*dev
, bool power_off
);
527 static inline struct acpi_device
*acpi_dev_pm_get_node(struct device
*dev
)
531 static inline int acpi_dev_pm_attach(struct device
*dev
, bool power_on
)
535 static inline void acpi_dev_pm_detach(struct device
*dev
, bool power_off
) {}
540 void acpi_handle_printk(const char *level
, acpi_handle handle
,
541 const char *fmt
, ...);
542 #else /* !CONFIG_ACPI */
543 static inline __printf(3, 4) void
544 acpi_handle_printk(const char *level
, void *handle
, const char *fmt
, ...) {}
545 #endif /* !CONFIG_ACPI */
548 * acpi_handle_<level>: Print message with ACPI prefix and object path
550 * These interfaces acquire the global namespace mutex to obtain an object
551 * path. In interrupt context, it shows the object path as <n/a>.
553 #define acpi_handle_emerg(handle, fmt, ...) \
554 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
555 #define acpi_handle_alert(handle, fmt, ...) \
556 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
557 #define acpi_handle_crit(handle, fmt, ...) \
558 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
559 #define acpi_handle_err(handle, fmt, ...) \
560 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
561 #define acpi_handle_warn(handle, fmt, ...) \
562 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
563 #define acpi_handle_notice(handle, fmt, ...) \
564 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
565 #define acpi_handle_info(handle, fmt, ...) \
566 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
568 /* REVISIT: Support CONFIG_DYNAMIC_DEBUG when necessary */
569 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
570 #define acpi_handle_debug(handle, fmt, ...) \
571 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
573 #define acpi_handle_debug(handle, fmt, ...) \
576 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
581 #endif /*_LINUX_ACPI_H*/