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 static inline const char *acpi_dev_name(struct acpi_device
*adev
)
58 return dev_name(&adev
->dev
);
61 enum acpi_irq_model_id
{
62 ACPI_IRQ_MODEL_PIC
= 0,
63 ACPI_IRQ_MODEL_IOAPIC
,
64 ACPI_IRQ_MODEL_IOSAPIC
,
65 ACPI_IRQ_MODEL_PLATFORM
,
69 extern enum acpi_irq_model_id acpi_irq_model
;
71 enum acpi_interrupt_id
{
72 ACPI_INTERRUPT_PMI
= 1,
78 #define ACPI_SPACE_MEM 0
80 enum acpi_address_range_id
{
81 ACPI_ADDRESS_RANGE_MEMORY
= 1,
82 ACPI_ADDRESS_RANGE_RESERVED
= 2,
83 ACPI_ADDRESS_RANGE_ACPI
= 3,
84 ACPI_ADDRESS_RANGE_NVS
= 4,
85 ACPI_ADDRESS_RANGE_COUNT
91 typedef int (*acpi_tbl_table_handler
)(struct acpi_table_header
*table
);
93 typedef int (*acpi_tbl_entry_handler
)(struct acpi_subtable_header
*header
,
94 const unsigned long end
);
96 #ifdef CONFIG_ACPI_INITRD_TABLE_OVERRIDE
97 void acpi_initrd_override(void *data
, size_t size
);
99 static inline void acpi_initrd_override(void *data
, size_t size
)
104 char * __acpi_map_table (unsigned long phys_addr
, unsigned long size
);
105 void __acpi_unmap_table(char *map
, unsigned long size
);
106 int early_acpi_boot_init(void);
107 int acpi_boot_init (void);
108 void acpi_boot_table_init (void);
109 int acpi_mps_check (void);
110 int acpi_numa_init (void);
112 int acpi_table_init (void);
113 int acpi_table_parse(char *id
, acpi_tbl_table_handler handler
);
114 int __init
acpi_table_parse_entries(char *id
, unsigned long table_size
,
116 acpi_tbl_entry_handler handler
,
117 unsigned int max_entries
);
118 int acpi_table_parse_madt(enum acpi_madt_type id
,
119 acpi_tbl_entry_handler handler
,
120 unsigned int max_entries
);
121 int acpi_parse_mcfg (struct acpi_table_header
*header
);
122 void acpi_table_print_madt_entry (struct acpi_subtable_header
*madt
);
124 /* the following four functions are architecture-dependent */
125 void acpi_numa_slit_init (struct acpi_table_slit
*slit
);
126 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity
*pa
);
127 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity
*pa
);
128 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity
*ma
);
129 void acpi_numa_arch_fixup(void);
131 #ifdef CONFIG_ACPI_HOTPLUG_CPU
132 /* Arch dependent functions for cpu hotplug support */
133 int acpi_map_lsapic(acpi_handle handle
, int physid
, int *pcpu
);
134 int acpi_unmap_lsapic(int cpu
);
135 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
137 int acpi_register_ioapic(acpi_handle handle
, u64 phys_addr
, u32 gsi_base
);
138 int acpi_unregister_ioapic(acpi_handle handle
, u32 gsi_base
);
139 void acpi_irq_stats_init(void);
140 extern u32 acpi_irq_handled
;
141 extern u32 acpi_irq_not_handled
;
144 extern unsigned long acpi_realmode_flags
;
146 int acpi_register_gsi (struct device
*dev
, u32 gsi
, int triggering
, int polarity
);
147 int acpi_gsi_to_irq (u32 gsi
, unsigned int *irq
);
148 int acpi_isa_irq_to_gsi (unsigned isa_irq
, u32
*gsi
);
150 #ifdef CONFIG_X86_IO_APIC
151 extern int acpi_get_override_irq(u32 gsi
, int *trigger
, int *polarity
);
153 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
156 * This function undoes the effect of one call to acpi_register_gsi().
157 * If this matches the last registration, any IRQ resources for gsi
160 void acpi_unregister_gsi (u32 gsi
);
164 int acpi_pci_irq_enable (struct pci_dev
*dev
);
165 void acpi_penalize_isa_irq(int irq
, int active
);
167 void acpi_pci_irq_disable (struct pci_dev
*dev
);
169 extern int ec_read(u8 addr
, u8
*val
);
170 extern int ec_write(u8 addr
, u8 val
);
171 extern int ec_transaction(u8 command
,
172 const u8
*wdata
, unsigned wdata_len
,
173 u8
*rdata
, unsigned rdata_len
);
174 extern acpi_handle
ec_get_handle(void);
176 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
178 typedef void (*wmi_notify_handler
) (u32 value
, void *context
);
180 extern acpi_status
wmi_evaluate_method(const char *guid
, u8 instance
,
182 const struct acpi_buffer
*in
,
183 struct acpi_buffer
*out
);
184 extern acpi_status
wmi_query_block(const char *guid
, u8 instance
,
185 struct acpi_buffer
*out
);
186 extern acpi_status
wmi_set_block(const char *guid
, u8 instance
,
187 const struct acpi_buffer
*in
);
188 extern acpi_status
wmi_install_notify_handler(const char *guid
,
189 wmi_notify_handler handler
, void *data
);
190 extern acpi_status
wmi_remove_notify_handler(const char *guid
);
191 extern acpi_status
wmi_get_event_data(u32 event
, struct acpi_buffer
*out
);
192 extern bool wmi_has_guid(const char *guid
);
194 #endif /* CONFIG_ACPI_WMI */
196 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
197 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
198 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
199 #define ACPI_VIDEO_BACKLIGHT 0x0008
200 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
201 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
202 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
203 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
204 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
205 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
206 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
207 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
209 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
211 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle
);
212 extern long acpi_is_video_device(acpi_handle handle
);
213 extern void acpi_video_dmi_promote_vendor(void);
214 extern void acpi_video_dmi_demote_vendor(void);
215 extern int acpi_video_backlight_support(void);
216 extern int acpi_video_display_switch_support(void);
220 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle
)
225 static inline long acpi_is_video_device(acpi_handle handle
)
230 static inline void acpi_video_dmi_promote_vendor(void)
234 static inline void acpi_video_dmi_demote_vendor(void)
238 static inline int acpi_video_backlight_support(void)
243 static inline int acpi_video_display_switch_support(void)
248 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
250 extern int acpi_blacklisted(void);
251 extern void acpi_dmi_osi_linux(int enable
, const struct dmi_system_id
*d
);
252 extern void acpi_osi_setup(char *str
);
254 #ifdef CONFIG_ACPI_NUMA
255 int acpi_get_pxm(acpi_handle handle
);
256 int acpi_get_node(acpi_handle
*handle
);
258 static inline int acpi_get_pxm(acpi_handle handle
)
262 static inline int acpi_get_node(acpi_handle
*handle
)
267 extern int acpi_paddr_to_node(u64 start_addr
, u64 size
);
269 extern int pnpacpi_disabled
;
271 #define PXM_INVAL (-1)
273 bool acpi_dev_resource_memory(struct acpi_resource
*ares
, struct resource
*res
);
274 bool acpi_dev_resource_io(struct acpi_resource
*ares
, struct resource
*res
);
275 bool acpi_dev_resource_address_space(struct acpi_resource
*ares
,
276 struct resource
*res
);
277 bool acpi_dev_resource_ext_address_space(struct acpi_resource
*ares
,
278 struct resource
*res
);
279 unsigned long acpi_dev_irq_flags(u8 triggering
, u8 polarity
, u8 shareable
);
280 bool acpi_dev_resource_interrupt(struct acpi_resource
*ares
, int index
,
281 struct resource
*res
);
283 struct resource_list_entry
{
284 struct list_head node
;
288 void acpi_dev_free_resource_list(struct list_head
*list
);
289 int acpi_dev_get_resources(struct acpi_device
*adev
, struct list_head
*list
,
290 int (*preproc
)(struct acpi_resource
*, void *),
293 int acpi_check_resource_conflict(const struct resource
*res
);
295 int acpi_check_region(resource_size_t start
, resource_size_t n
,
298 int acpi_resources_are_enforced(void);
300 #ifdef CONFIG_HIBERNATION
301 void __init
acpi_no_s4_hw_signature(void);
304 #ifdef CONFIG_PM_SLEEP
305 void __init
acpi_old_suspend_ordering(void);
306 void __init
acpi_nvs_nosave(void);
307 void __init
acpi_nvs_nosave_s3(void);
308 #endif /* CONFIG_PM_SLEEP */
310 struct acpi_osc_context
{
311 char *uuid_str
; /* UUID string */
313 struct acpi_buffer cap
; /* list of DWORD capabilities */
314 struct acpi_buffer ret
; /* free by caller if success */
317 acpi_status
acpi_str_to_uuid(char *str
, u8
*uuid
);
318 acpi_status
acpi_run_osc(acpi_handle handle
, struct acpi_osc_context
*context
);
320 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
321 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
322 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
323 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
325 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
326 #define OSC_QUERY_ENABLE 0x00000001 /* input */
327 #define OSC_REQUEST_ERROR 0x00000002 /* return */
328 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
329 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
330 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
332 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
333 #define OSC_SB_PAD_SUPPORT 0x00000001
334 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
335 #define OSC_SB_PR3_SUPPORT 0x00000004
336 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
337 #define OSC_SB_APEI_SUPPORT 0x00000010
338 #define OSC_SB_CPC_SUPPORT 0x00000020
340 extern bool osc_sb_apei_support_acked
;
342 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
343 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
344 #define OSC_PCI_ASPM_SUPPORT 0x00000002
345 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
346 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
347 #define OSC_PCI_MSI_SUPPORT 0x00000010
348 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
350 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
351 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
352 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
353 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
354 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
355 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
356 #define OSC_PCI_CONTROL_MASKS 0x0000001f
358 extern acpi_status
acpi_pci_osc_control_set(acpi_handle handle
,
361 /* Enable _OST when all relevant hotplug operations are enabled */
362 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
363 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
364 defined(CONFIG_ACPI_CONTAINER)
365 #define ACPI_HOTPLUG_OST
368 /* _OST Source Event Code (OSPM Action) */
369 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
370 #define ACPI_OST_EC_OSPM_EJECT 0x103
371 #define ACPI_OST_EC_OSPM_INSERTION 0x200
373 /* _OST General Processing Status Code */
374 #define ACPI_OST_SC_SUCCESS 0x0
375 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
376 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
378 /* _OST OS Shutdown Processing (0x100) Status Code */
379 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
380 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
381 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
382 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
384 /* _OST Ejection Request (0x3, 0x103) Status Code */
385 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
386 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
387 #define ACPI_OST_SC_DEVICE_BUSY 0x82
388 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
389 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
391 /* _OST Insertion Request (0x200) Status Code */
392 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
393 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
394 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
396 extern void acpi_early_init(void);
398 extern int acpi_nvs_register(__u64 start
, __u64 size
);
400 extern int acpi_nvs_for_each_region(int (*func
)(__u64
, __u64
, void *),
403 const struct acpi_device_id
*acpi_match_device(const struct acpi_device_id
*ids
,
404 const struct device
*dev
);
406 static inline bool acpi_driver_match_device(struct device
*dev
,
407 const struct device_driver
*drv
)
409 return !!acpi_match_device(drv
->acpi_match_table
, dev
);
412 #define ACPI_PTR(_ptr) (_ptr)
414 #else /* !CONFIG_ACPI */
416 #define acpi_disabled 1
418 #define ACPI_COMPANION(dev) (NULL)
419 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
420 #define ACPI_HANDLE(dev) (NULL)
422 static inline const char *acpi_dev_name(struct acpi_device
*adev
)
427 static inline void acpi_early_init(void) { }
429 static inline int early_acpi_boot_init(void)
433 static inline int acpi_boot_init(void)
438 static inline void acpi_boot_table_init(void)
443 static inline int acpi_mps_check(void)
448 static inline int acpi_check_resource_conflict(struct resource
*res
)
453 static inline int acpi_check_region(resource_size_t start
, resource_size_t n
,
459 struct acpi_table_header
;
460 static inline int acpi_table_parse(char *id
,
461 int (*handler
)(struct acpi_table_header
*))
466 static inline int acpi_nvs_register(__u64 start
, __u64 size
)
471 static inline int acpi_nvs_for_each_region(int (*func
)(__u64
, __u64
, void *),
477 struct acpi_device_id
;
479 static inline const struct acpi_device_id
*acpi_match_device(
480 const struct acpi_device_id
*ids
, const struct device
*dev
)
485 static inline bool acpi_driver_match_device(struct device
*dev
,
486 const struct device_driver
*drv
)
491 #define ACPI_PTR(_ptr) (NULL)
493 #endif /* !CONFIG_ACPI */
496 void acpi_os_set_prepare_sleep(int (*func
)(u8 sleep_state
,
497 u32 pm1a_ctrl
, u32 pm1b_ctrl
));
499 acpi_status
acpi_os_prepare_sleep(u8 sleep_state
,
500 u32 pm1a_control
, u32 pm1b_control
);
502 void acpi_os_set_prepare_extended_sleep(int (*func
)(u8 sleep_state
,
503 u32 val_a
, u32 val_b
));
505 acpi_status
acpi_os_prepare_extended_sleep(u8 sleep_state
,
506 u32 val_a
, u32 val_b
);
509 void arch_reserve_mem_area(acpi_physical_address addr
, size_t size
);
511 static inline void arch_reserve_mem_area(acpi_physical_address addr
,
515 #endif /* CONFIG_X86 */
517 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
520 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_RUNTIME)
521 int acpi_dev_runtime_suspend(struct device
*dev
);
522 int acpi_dev_runtime_resume(struct device
*dev
);
523 int acpi_subsys_runtime_suspend(struct device
*dev
);
524 int acpi_subsys_runtime_resume(struct device
*dev
);
526 static inline int acpi_dev_runtime_suspend(struct device
*dev
) { return 0; }
527 static inline int acpi_dev_runtime_resume(struct device
*dev
) { return 0; }
528 static inline int acpi_subsys_runtime_suspend(struct device
*dev
) { return 0; }
529 static inline int acpi_subsys_runtime_resume(struct device
*dev
) { return 0; }
532 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
533 int acpi_dev_suspend_late(struct device
*dev
);
534 int acpi_dev_resume_early(struct device
*dev
);
535 int acpi_subsys_prepare(struct device
*dev
);
536 int acpi_subsys_suspend_late(struct device
*dev
);
537 int acpi_subsys_resume_early(struct device
*dev
);
539 static inline int acpi_dev_suspend_late(struct device
*dev
) { return 0; }
540 static inline int acpi_dev_resume_early(struct device
*dev
) { return 0; }
541 static inline int acpi_subsys_prepare(struct device
*dev
) { return 0; }
542 static inline int acpi_subsys_suspend_late(struct device
*dev
) { return 0; }
543 static inline int acpi_subsys_resume_early(struct device
*dev
) { return 0; }
546 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
547 struct acpi_device
*acpi_dev_pm_get_node(struct device
*dev
);
548 int acpi_dev_pm_attach(struct device
*dev
, bool power_on
);
549 void acpi_dev_pm_detach(struct device
*dev
, bool power_off
);
551 static inline struct acpi_device
*acpi_dev_pm_get_node(struct device
*dev
)
555 static inline int acpi_dev_pm_attach(struct device
*dev
, bool power_on
)
559 static inline void acpi_dev_pm_detach(struct device
*dev
, bool power_off
) {}
564 void acpi_handle_printk(const char *level
, acpi_handle handle
,
565 const char *fmt
, ...);
566 #else /* !CONFIG_ACPI */
567 static inline __printf(3, 4) void
568 acpi_handle_printk(const char *level
, void *handle
, const char *fmt
, ...) {}
569 #endif /* !CONFIG_ACPI */
572 * acpi_handle_<level>: Print message with ACPI prefix and object path
574 * These interfaces acquire the global namespace mutex to obtain an object
575 * path. In interrupt context, it shows the object path as <n/a>.
577 #define acpi_handle_emerg(handle, fmt, ...) \
578 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
579 #define acpi_handle_alert(handle, fmt, ...) \
580 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
581 #define acpi_handle_crit(handle, fmt, ...) \
582 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
583 #define acpi_handle_err(handle, fmt, ...) \
584 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
585 #define acpi_handle_warn(handle, fmt, ...) \
586 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
587 #define acpi_handle_notice(handle, fmt, ...) \
588 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
589 #define acpi_handle_info(handle, fmt, ...) \
590 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
592 /* REVISIT: Support CONFIG_DYNAMIC_DEBUG when necessary */
593 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
594 #define acpi_handle_debug(handle, fmt, ...) \
595 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
597 #define acpi_handle_debug(handle, fmt, ...) \
600 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
605 #endif /*_LINUX_ACPI_H*/