1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
47 /* Current ACPICA subsystem version in YYYYMMDD format */
49 #define ACPI_CA_VERSION 0x20130517
51 #include <acpi/acconfig.h>
52 #include <acpi/actypes.h>
53 #include <acpi/actbl.h>
54 #include <acpi/acbuffer.h>
56 extern u8 acpi_gbl_permanent_mmap;
59 * Globals that are publically available
61 extern u32 acpi_current_gpe_count;
62 extern struct acpi_table_fadt acpi_gbl_FADT;
63 extern u8 acpi_gbl_system_awake_and_running;
64 extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */
65 extern u8 acpi_gbl_osi_data;
67 /* Runtime configuration of debug print levels */
69 extern u32 acpi_dbg_level;
70 extern u32 acpi_dbg_layer;
72 /* ACPICA runtime options */
74 extern u8 acpi_gbl_enable_interpreter_slack;
75 extern u8 acpi_gbl_all_methods_serialized;
76 extern u8 acpi_gbl_create_osi_method;
77 extern u8 acpi_gbl_use_default_register_widths;
78 extern acpi_name acpi_gbl_trace_method_name;
79 extern u32 acpi_gbl_trace_flags;
80 extern bool acpi_gbl_enable_aml_debug_object;
81 extern u8 acpi_gbl_copy_dsdt_locally;
82 extern u8 acpi_gbl_truncate_io_addresses;
83 extern u8 acpi_gbl_disable_auto_repair;
84 extern u8 acpi_gbl_disable_ssdt_table_load;
87 * Hardware-reduced prototypes. All interfaces that use these macros will
88 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
91 #if (!ACPI_REDUCED_HARDWARE)
92 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
95 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
98 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
102 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
103 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
105 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
106 static ACPI_INLINE prototype {return(AE_OK);}
108 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
109 static ACPI_INLINE prototype {}
111 #endif /* !ACPI_REDUCED_HARDWARE */
113 extern u32 acpi_rsdt_forced;
118 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
119 u32 initial_table_count, u8 allow_resize);
121 acpi_status __init acpi_initialize_subsystem(void);
123 acpi_status acpi_enable_subsystem(u32 flags);
125 acpi_status acpi_initialize_objects(u32 flags);
127 acpi_status acpi_terminate(void);
130 * Miscellaneous global interfaces
132 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
134 #ifdef ACPI_FUTURE_USAGE
135 acpi_status acpi_subsystem_status(void);
138 #ifdef ACPI_FUTURE_USAGE
139 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
142 const char *acpi_format_exception(acpi_status exception);
144 acpi_status acpi_purge_cached_objects(void);
146 acpi_status acpi_install_interface(acpi_string interface_name);
148 acpi_status acpi_remove_interface(acpi_string interface_name);
151 acpi_check_address_range(acpi_adr_space_type space_id,
152 acpi_physical_address address,
153 acpi_size length, u8 warn);
156 acpi_decode_pld_buffer(u8 *in_buffer,
157 acpi_size length, struct acpi_pld_info **return_buffer);
160 * ACPI Memory management
162 void *acpi_allocate(u32 size);
164 void *acpi_callocate(u32 size);
166 void acpi_free(void *address);
169 * ACPI table load/unload interfaces
171 acpi_status acpi_load_table(struct acpi_table_header *table);
173 acpi_status acpi_unload_parent_table(acpi_handle object);
175 acpi_status acpi_load_tables(void);
178 * ACPI table manipulation interfaces
180 acpi_status acpi_reallocate_root_table(void);
182 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
184 acpi_status acpi_unload_table_id(acpi_owner_id id);
187 acpi_get_table_header(acpi_string signature,
188 u32 instance, struct acpi_table_header *out_table_header);
191 acpi_get_table_with_size(acpi_string signature,
192 u32 instance, struct acpi_table_header **out_table,
193 acpi_size *tbl_size);
195 acpi_get_table(acpi_string signature,
196 u32 instance, struct acpi_table_header **out_table);
199 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
202 acpi_install_table_handler(acpi_table_handler handler, void *context);
204 acpi_status acpi_remove_table_handler(acpi_table_handler handler);
207 * Namespace and name interfaces
210 acpi_walk_namespace(acpi_object_type type,
211 acpi_handle start_object,
213 acpi_walk_callback pre_order_visit,
214 acpi_walk_callback post_order_visit,
215 void *context, void **return_value);
218 acpi_get_devices(const char *HID,
219 acpi_walk_callback user_function,
220 void *context, void **return_value);
223 acpi_get_name(acpi_handle object,
224 u32 name_type, struct acpi_buffer *ret_path_ptr);
227 acpi_get_handle(acpi_handle parent,
228 acpi_string pathname, acpi_handle * ret_handle);
231 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
233 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
236 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
239 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
242 * Object manipulation and enumeration
245 acpi_evaluate_object(acpi_handle object,
246 acpi_string pathname,
247 struct acpi_object_list *parameter_objects,
248 struct acpi_buffer *return_object_buffer);
251 acpi_evaluate_object_typed(acpi_handle object,
252 acpi_string pathname,
253 struct acpi_object_list *external_params,
254 struct acpi_buffer *return_buffer,
255 acpi_object_type return_type);
258 acpi_get_object_info(acpi_handle object,
259 struct acpi_device_info **return_buffer);
261 acpi_status acpi_install_method(u8 *buffer);
264 acpi_get_next_object(acpi_object_type type,
266 acpi_handle child, acpi_handle * out_handle);
268 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
270 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
272 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
278 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
280 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
281 acpi_install_global_event_handler
282 (acpi_gbl_event_handler handler, void *context))
284 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
285 acpi_install_fixed_event_handler(u32
291 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
292 acpi_remove_fixed_event_handler(u32 acpi_event,
295 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
296 acpi_install_gpe_handler(acpi_handle
303 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
304 acpi_remove_gpe_handler(acpi_handle gpe_device,
308 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
309 acpi_notify_handler handler,
313 acpi_remove_notify_handler(acpi_handle device,
314 u32 handler_type, acpi_notify_handler handler);
317 acpi_install_address_space_handler(acpi_handle device,
318 acpi_adr_space_type space_id,
319 acpi_adr_space_handler handler,
320 acpi_adr_space_setup setup, void *context);
323 acpi_remove_address_space_handler(acpi_handle device,
324 acpi_adr_space_type space_id,
325 acpi_adr_space_handler handler);
327 #ifdef ACPI_FUTURE_USAGE
328 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
331 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
334 * Global Lock interfaces
336 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
337 acpi_acquire_global_lock(u16 timeout,
339 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
340 acpi_release_global_lock(u32 handle))
343 * Interfaces to AML mutex objects
346 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
348 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
351 * Fixed Event interfaces
353 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
354 acpi_enable_event(u32 event, u32 flags))
356 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
357 acpi_disable_event(u32 event, u32 flags))
359 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
361 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
362 acpi_get_event_status(u32 event,
366 * General Purpose Event (GPE) Interfaces
368 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
371 acpi_enable_gpe(acpi_handle gpe_device,
374 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
375 acpi_disable_gpe(acpi_handle gpe_device,
378 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
379 acpi_clear_gpe(acpi_handle gpe_device,
382 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
383 acpi_set_gpe(acpi_handle gpe_device,
384 u32 gpe_number, u8 action))
386 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
387 acpi_finish_gpe(acpi_handle gpe_device,
390 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
391 acpi_setup_gpe_for_wake(acpi_handle
393 acpi_handle gpe_device,
395 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
396 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
399 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
400 acpi_get_gpe_status(acpi_handle gpe_device,
405 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
407 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
409 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
410 acpi_get_gpe_device(u32 gpe_index,
411 acpi_handle * gpe_device))
413 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
414 acpi_install_gpe_block(acpi_handle gpe_device,
419 u32 interrupt_number))
420 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
421 acpi_remove_gpe_block(acpi_handle gpe_device))
424 * Resource interfaces
427 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
431 acpi_get_vendor_resource(acpi_handle device,
433 struct acpi_vendor_uuid *uuid,
434 struct acpi_buffer *ret_buffer);
437 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
439 #ifdef ACPI_FUTURE_USAGE
441 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
445 acpi_get_event_resources(acpi_handle device_handle,
446 struct acpi_buffer *ret_buffer);
449 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
450 acpi_walk_resource_callback user_function,
454 acpi_walk_resources(acpi_handle device,
456 acpi_walk_resource_callback user_function, void *context);
459 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
462 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
465 acpi_resource_to_address64(struct acpi_resource *resource,
466 struct acpi_resource_address64 *out);
469 acpi_buffer_to_resource(u8 *aml_buffer,
470 u16 aml_buffer_length,
471 struct acpi_resource **resource_ptr);
474 * Hardware (ACPI device) interfaces
476 acpi_status acpi_reset(void);
478 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
480 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
482 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
483 acpi_read_bit_register(u32 register_id,
486 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
487 acpi_write_bit_register(u32 register_id,
491 * Sleep/Wake interfaces
494 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
496 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
498 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
500 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
502 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
504 acpi_status acpi_leave_sleep_state(u8 sleep_state);
506 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
507 acpi_set_firmware_waking_vector(u32
510 #if ACPI_MACHINE_WIDTH == 64
511 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
512 acpi_set_firmware_waking_vector64(u64
516 * ACPI Timer interfaces
518 #ifdef ACPI_FUTURE_USAGE
519 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
520 acpi_get_timer_resolution(u32 *resolution))
522 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
524 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
525 acpi_get_timer_duration(u32 start_ticks,
528 #endif /* ACPI_FUTURE_USAGE */
531 * Error/Warning output
533 void ACPI_INTERNAL_VAR_XFACE
534 acpi_error(const char *module_name,
535 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
537 void ACPI_INTERNAL_VAR_XFACE
538 acpi_exception(const char *module_name,
540 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
542 void ACPI_INTERNAL_VAR_XFACE
543 acpi_warning(const char *module_name,
544 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
546 void ACPI_INTERNAL_VAR_XFACE
547 acpi_info(const char *module_name,
548 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
550 void ACPI_INTERNAL_VAR_XFACE
551 acpi_bios_error(const char *module_name,
552 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
554 void ACPI_INTERNAL_VAR_XFACE
555 acpi_bios_warning(const char *module_name,
556 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
561 #ifdef ACPI_DEBUG_OUTPUT
563 void ACPI_INTERNAL_VAR_XFACE
564 acpi_debug_print(u32 requested_debug_level,
566 const char *function_name,
567 const char *module_name,
568 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
570 void ACPI_INTERNAL_VAR_XFACE
571 acpi_debug_print_raw(u32 requested_debug_level,
573 const char *function_name,
574 const char *module_name,
576 const char *format, ...) ACPI_PRINTF_LIKE(6);
579 #endif /* __ACXFACE_H__ */