1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 * Copyright (C) 2000 - 2023, Intel Corp.
8 *****************************************************************************/
13 /* Current ACPICA subsystem version in YYYYMMDD format */
15 #define ACPI_CA_VERSION 0x20240827
17 #include <acpi/acconfig.h>
18 #include <acpi/actypes.h>
19 #include <acpi/actbl.h>
20 #include <acpi/acbuffer.h>
22 /*****************************************************************************
24 * Macros used for ACPICA globals and configuration
26 ****************************************************************************/
29 * Ensure that global variables are defined and initialized only once.
31 * The use of these macros allows for a single list of globals (here)
32 * in order to simplify maintenance of the code.
34 #ifdef DEFINE_ACPI_GLOBALS
35 #define ACPI_GLOBAL(type,name) \
39 #define ACPI_INIT_GLOBAL(type,name,value) \
44 #define ACPI_GLOBAL(type,name) \
48 #ifndef ACPI_INIT_GLOBAL
49 #define ACPI_INIT_GLOBAL(type,name,value) \
55 * These macros configure the various ACPICA interfaces. They are
56 * useful for generating stub inline functions for features that are
57 * configured out of the current kernel or ACPICA application.
59 #ifndef ACPI_EXTERNAL_RETURN_STATUS
60 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
64 #ifndef ACPI_EXTERNAL_RETURN_OK
65 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
69 #ifndef ACPI_EXTERNAL_RETURN_VOID
70 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
74 #ifndef ACPI_EXTERNAL_RETURN_UINT32
75 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
79 #ifndef ACPI_EXTERNAL_RETURN_PTR
80 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
84 /*****************************************************************************
86 * Public globals and runtime configuration options
88 ****************************************************************************/
91 * Enable "slack mode" of the AML interpreter? Default is FALSE, and the
92 * interpreter strictly follows the ACPI specification. Setting to TRUE
93 * allows the interpreter to ignore certain errors and/or bad AML constructs.
95 * Currently, these features are enabled by this flag:
97 * 1) Allow "implicit return" of last value in a control method
98 * 2) Allow access beyond the end of an operation region
99 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
100 * 4) Allow ANY object type to be a source operand for the Store() operator
101 * 5) Allow unresolved references (invalid target name) in package objects
102 * 6) Enable warning messages for behavior that is not ACPI spec compliant
104 ACPI_INIT_GLOBAL(u8
, acpi_gbl_enable_interpreter_slack
, FALSE
);
107 * Automatically serialize all methods that create named objects? Default
108 * is TRUE, meaning that all non_serialized methods are scanned once at
109 * table load time to determine those that create named objects. Methods
110 * that create named objects are marked Serialized in order to prevent
111 * possible run-time problems if they are entered by more than one thread.
113 ACPI_INIT_GLOBAL(u8
, acpi_gbl_auto_serialize_methods
, TRUE
);
116 * Create the predefined _OSI method in the namespace? Default is TRUE
117 * because ACPICA is fully compatible with other ACPI implementations.
118 * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
120 ACPI_INIT_GLOBAL(u8
, acpi_gbl_create_osi_method
, TRUE
);
123 * Optionally use default values for the ACPI register widths. Set this to
124 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
126 ACPI_INIT_GLOBAL(u8
, acpi_gbl_use_default_register_widths
, TRUE
);
129 * Whether or not to validate (map) an entire table to verify
130 * checksum/duplication in early stage before install. Set this to TRUE to
131 * allow early table validation before install it to the table manager.
132 * Note that enabling this option causes errors to happen in some OSPMs
133 * during early initialization stages. Default behavior is to allow such
136 ACPI_INIT_GLOBAL(u8
, acpi_gbl_enable_table_validation
, TRUE
);
139 * Optionally enable output from the AML Debug Object.
141 ACPI_INIT_GLOBAL(u8
, acpi_gbl_enable_aml_debug_object
, FALSE
);
144 * Optionally copy the entire DSDT to local memory (instead of simply
145 * mapping it.) There are some BIOSs that corrupt or replace the original
146 * DSDT, creating the need for this option. Default is FALSE, do not copy
149 ACPI_INIT_GLOBAL(u8
, acpi_gbl_copy_dsdt_locally
, FALSE
);
152 * Optionally ignore an XSDT if present and use the RSDT instead.
153 * Although the ACPI specification requires that an XSDT be used instead
154 * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
155 * some machines. Default behavior is to use the XSDT if present.
157 ACPI_INIT_GLOBAL(u8
, acpi_gbl_do_not_use_xsdt
, FALSE
);
160 * Optionally use 32-bit FADT addresses if and when there is a conflict
161 * (address mismatch) between the 32-bit and 64-bit versions of the
162 * address. Although ACPICA adheres to the ACPI specification which
163 * requires the use of the corresponding 64-bit address if it is non-zero,
164 * some machines have been found to have a corrupted non-zero 64-bit
165 * address. Default is FALSE, do not favor the 32-bit addresses.
167 ACPI_INIT_GLOBAL(u8
, acpi_gbl_use32_bit_fadt_addresses
, FALSE
);
170 * Optionally use 32-bit FACS table addresses.
171 * It is reported that some platforms fail to resume from system suspending
172 * if 64-bit FACS table address is selected:
173 * https://bugzilla.kernel.org/show_bug.cgi?id=74021
174 * Default is TRUE, favor the 32-bit addresses.
176 ACPI_INIT_GLOBAL(u8
, acpi_gbl_use32_bit_facs_addresses
, TRUE
);
179 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
180 * with other ACPI implementations. NOTE: During ACPICA initialization,
181 * this value is set to TRUE if any Windows OSI strings have been
182 * requested by the BIOS.
184 ACPI_INIT_GLOBAL(u8
, acpi_gbl_truncate_io_addresses
, FALSE
);
187 * Disable runtime checking and repair of values returned by control methods.
188 * Use only if the repair is causing a problem on a particular machine.
190 ACPI_INIT_GLOBAL(u8
, acpi_gbl_disable_auto_repair
, FALSE
);
193 * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
194 * This can be useful for debugging ACPI problems on some machines.
196 ACPI_INIT_GLOBAL(u8
, acpi_gbl_disable_ssdt_table_install
, FALSE
);
199 * Optionally enable runtime namespace override.
201 ACPI_INIT_GLOBAL(u8
, acpi_gbl_runtime_namespace_override
, TRUE
);
204 * We keep track of the latest version of Windows that has been requested by
205 * the BIOS. ACPI 5.0.
207 ACPI_INIT_GLOBAL(u8
, acpi_gbl_osi_data
, 0);
210 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
211 * that the ACPI hardware is no longer required. A flag in the FADT indicates
212 * a reduced HW machine, and that flag is duplicated here for convenience.
214 ACPI_INIT_GLOBAL(u8
, acpi_gbl_reduced_hardware
, FALSE
);
217 * Maximum timeout for While() loop iterations before forced method abort.
218 * This mechanism is intended to prevent infinite loops during interpreter
219 * execution within a host kernel.
221 ACPI_INIT_GLOBAL(u32
, acpi_gbl_max_loop_iterations
, ACPI_MAX_LOOP_TIMEOUT
);
224 * Optionally ignore AE_NOT_FOUND errors from named reference package elements
225 * during DSDT/SSDT table loading. This reduces error "noise" in platforms
226 * whose firmware is carrying around a bunch of unused package objects that
227 * refer to non-existent named objects. However, If the AML actually tries to
228 * use such a package, the unresolved element(s) will be replaced with NULL
231 ACPI_INIT_GLOBAL(u8
, acpi_gbl_ignore_package_resolution_errors
, FALSE
);
234 * This mechanism is used to trace a specified AML method. The method is
235 * traced each time it is executed.
237 ACPI_INIT_GLOBAL(u32
, acpi_gbl_trace_flags
, 0);
238 ACPI_INIT_GLOBAL(const char *, acpi_gbl_trace_method_name
, NULL
);
239 ACPI_INIT_GLOBAL(u32
, acpi_gbl_trace_dbg_level
, ACPI_TRACE_LEVEL_DEFAULT
);
240 ACPI_INIT_GLOBAL(u32
, acpi_gbl_trace_dbg_layer
, ACPI_TRACE_LAYER_DEFAULT
);
243 * Runtime configuration of debug output control masks. We want the debug
244 * switches statically initialized so they are already set when the debugger
247 ACPI_INIT_GLOBAL(u32
, acpi_dbg_level
, ACPI_DEBUG_DEFAULT
);
248 ACPI_INIT_GLOBAL(u32
, acpi_dbg_layer
, 0);
250 /* Optionally enable timer output with Debug Object output */
252 ACPI_INIT_GLOBAL(u8
, acpi_gbl_display_debug_timer
, FALSE
);
255 * Debugger command handshake globals. Host OSes need to access these
256 * variables to implement their own command handshake mechanism.
259 ACPI_INIT_GLOBAL(u8
, acpi_gbl_method_executing
, FALSE
);
260 ACPI_GLOBAL(char, acpi_gbl_db_line_buf
[ACPI_DB_LINE_BUFFER_SIZE
]);
264 * Other miscellaneous globals
266 ACPI_GLOBAL(struct acpi_table_fadt
, acpi_gbl_FADT
);
267 ACPI_GLOBAL(u32
, acpi_current_gpe_count
);
268 ACPI_GLOBAL(u8
, acpi_gbl_system_awake_and_running
);
270 /*****************************************************************************
272 * ACPICA public interface configuration.
274 * Interfaces that are configured out of the ACPICA build are replaced
275 * by inlined stubs by default.
277 ****************************************************************************/
280 * Hardware-reduced prototypes (default: Not hardware reduced).
282 * All ACPICA hardware-related interfaces that use these macros will be
283 * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
286 * Note: This static build option for reduced hardware is intended to
287 * reduce ACPICA code size if desired or necessary. However, even if this
288 * option is not specified, the runtime behavior of ACPICA is dependent
289 * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
290 * the flag will enable similar behavior -- ACPICA will not attempt
291 * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
293 #if (!ACPI_REDUCED_HARDWARE)
294 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
295 ACPI_EXTERNAL_RETURN_STATUS(prototype)
297 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
298 ACPI_EXTERNAL_RETURN_OK(prototype)
300 #define ACPI_HW_DEPENDENT_RETURN_UINT32(prototype) \
301 ACPI_EXTERNAL_RETURN_UINT32(prototype)
303 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
304 ACPI_EXTERNAL_RETURN_VOID(prototype)
307 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
308 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
310 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
311 static ACPI_INLINE prototype {return(AE_OK);}
313 #define ACPI_HW_DEPENDENT_RETURN_UINT32(prototype) \
314 static ACPI_INLINE prototype {return(0);}
316 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
317 static ACPI_INLINE prototype {return;}
319 #endif /* !ACPI_REDUCED_HARDWARE */
322 * Error message prototypes (default: error messages enabled).
324 * All interfaces related to error and warning messages
325 * will be configured out of the ACPICA build if the
326 * ACPI_NO_ERROR_MESSAGE flag is defined.
328 #ifndef ACPI_NO_ERROR_MESSAGES
329 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
333 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
334 static ACPI_INLINE prototype {return;}
336 #endif /* ACPI_NO_ERROR_MESSAGES */
339 * Debugging output prototypes (default: no debug output).
341 * All interfaces related to debug output messages
342 * will be configured out of the ACPICA build unless the
343 * ACPI_DEBUG_OUTPUT flag is defined.
345 #ifdef ACPI_DEBUG_OUTPUT
346 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
350 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
351 static ACPI_INLINE prototype {return;}
353 #endif /* ACPI_DEBUG_OUTPUT */
356 * Application prototypes
358 * All interfaces used by application will be configured
359 * out of the ACPICA build unless the ACPI_APPLICATION
362 #ifdef ACPI_APPLICATION
363 #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
367 #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
368 static ACPI_INLINE prototype {return;}
370 #endif /* ACPI_APPLICATION */
373 * Debugger prototypes
375 * All interfaces used by debugger will be configured
376 * out of the ACPICA build unless the ACPI_DEBUGGER
380 #define ACPI_DBR_DEPENDENT_RETURN_OK(prototype) \
381 ACPI_EXTERNAL_RETURN_OK(prototype)
383 #define ACPI_DBR_DEPENDENT_RETURN_VOID(prototype) \
384 ACPI_EXTERNAL_RETURN_VOID(prototype)
387 #define ACPI_DBR_DEPENDENT_RETURN_OK(prototype) \
388 static ACPI_INLINE prototype {return(AE_OK);}
390 #define ACPI_DBR_DEPENDENT_RETURN_VOID(prototype) \
391 static ACPI_INLINE prototype {return;}
393 #endif /* ACPI_DEBUGGER */
395 /*****************************************************************************
397 * ACPICA public interface prototypes
399 ****************************************************************************/
404 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
405 acpi_initialize_tables(struct acpi_table_desc
407 u32 initial_table_count
,
409 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
410 acpi_initialize_subsystem(void))
411 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
412 acpi_enable_subsystem(u32 flags
))
413 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
414 acpi_initialize_objects(u32 flags
))
415 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
416 acpi_terminate(void))
419 * Miscellaneous global interfaces
421 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enable(void))
422 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_disable(void))
423 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_subsystem_status(void))
425 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
426 acpi_get_system_info(struct acpi_buffer
428 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
429 acpi_get_statistics(struct acpi_statistics
*stats
))
430 ACPI_EXTERNAL_RETURN_PTR(const char
431 *acpi_format_exception(acpi_status exception
))
432 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_purge_cached_objects(void))
434 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
435 acpi_install_interface(acpi_string interface_name
))
437 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
438 acpi_remove_interface(acpi_string interface_name
))
439 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_update_interfaces(u8 action
))
441 ACPI_EXTERNAL_RETURN_UINT32(u32
442 acpi_check_address_range(acpi_adr_space_type
444 acpi_physical_address
445 address
, acpi_size length
,
447 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
448 acpi_decode_pld_buffer(u8
*in_buffer
,
454 * ACPI table load/unload interfaces
456 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
457 acpi_install_table(struct acpi_table_header
*table
))
459 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
460 acpi_install_physical_table(acpi_physical_address
462 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
463 acpi_load_table(struct acpi_table_header
*table
,
466 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
467 acpi_unload_table(u32 table_index
))
469 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
470 acpi_unload_parent_table(acpi_handle object
))
472 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
473 acpi_load_tables(void))
476 * ACPI table manipulation interfaces
478 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
479 acpi_reallocate_root_table(void))
481 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
482 acpi_find_root_pointer(acpi_physical_address
484 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
485 acpi_get_table_header(acpi_string signature
,
487 struct acpi_table_header
489 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
490 acpi_get_table(acpi_string signature
, u32 instance
,
491 struct acpi_table_header
493 ACPI_EXTERNAL_RETURN_VOID(void acpi_put_table(struct acpi_table_header
*table
))
495 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
496 acpi_get_table_by_index(u32 table_index
,
497 struct acpi_table_header
499 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
500 acpi_install_table_handler(acpi_table_handler
501 handler
, void *context
))
502 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
503 acpi_remove_table_handler(acpi_table_handler
507 * Namespace and name interfaces
509 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
510 acpi_walk_namespace(acpi_object_type type
,
511 acpi_handle start_object
,
518 void **return_value
))
519 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
520 acpi_get_devices(const char *HID
,
521 acpi_walk_callback user_function
,
523 void **return_value
))
524 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
525 acpi_get_name(acpi_handle object
, u32 name_type
,
526 struct acpi_buffer
*ret_path_ptr
))
527 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
528 acpi_get_handle(acpi_handle parent
,
529 const char *pathname
,
530 acpi_handle
*ret_handle
))
531 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
532 acpi_attach_data(acpi_handle object
,
533 acpi_object_handler handler
,
535 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
536 acpi_detach_data(acpi_handle object
,
537 acpi_object_handler handler
))
538 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
539 acpi_get_data(acpi_handle object
,
540 acpi_object_handler handler
,
542 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
543 acpi_debug_trace(const char *name
, u32 debug_level
,
544 u32 debug_layer
, u32 flags
))
547 * Object manipulation and enumeration
549 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
550 acpi_evaluate_object(acpi_handle object
,
551 acpi_string pathname
,
552 struct acpi_object_list
555 *return_object_buffer
))
556 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
557 acpi_evaluate_object_typed(acpi_handle object
,
558 acpi_string pathname
,
559 struct acpi_object_list
565 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
566 acpi_get_object_info(acpi_handle object
,
567 struct acpi_device_info
569 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_install_method(u8
*buffer
))
571 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
572 acpi_get_next_object(acpi_object_type type
,
575 acpi_handle
*out_handle
))
577 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
578 acpi_get_type(acpi_handle object
,
579 acpi_object_type
*out_type
))
581 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
582 acpi_get_parent(acpi_handle object
,
583 acpi_handle
*out_handle
))
588 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
589 acpi_install_initialization_handler
590 (acpi_init_handler handler
, u32 function
))
591 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
592 acpi_install_sci_handler(acpi_sci_handler
595 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
596 acpi_remove_sci_handler(acpi_sci_handler
598 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
599 acpi_install_global_event_handler
600 (acpi_gbl_event_handler handler
,
602 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
603 acpi_install_fixed_event_handler(u32
609 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
610 acpi_remove_fixed_event_handler(u32 acpi_event
,
613 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
614 acpi_install_gpe_handler(acpi_handle
621 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
622 acpi_install_gpe_raw_handler(acpi_handle
629 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
630 acpi_remove_gpe_handler(acpi_handle gpe_device
,
634 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
635 acpi_install_notify_handler(acpi_handle device
,
640 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
641 acpi_remove_notify_handler(acpi_handle device
,
645 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
646 acpi_install_address_space_handler(acpi_handle
650 acpi_adr_space_handler
655 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
656 acpi_install_address_space_handler_no_reg
657 (acpi_handle device
, acpi_adr_space_type space_id
,
658 acpi_adr_space_handler handler
,
659 acpi_adr_space_setup setup
,
661 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
662 acpi_execute_reg_methods(acpi_handle device
,
666 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
667 acpi_remove_address_space_handler(acpi_handle
671 acpi_adr_space_handler
673 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
674 acpi_install_exception_handler
675 (acpi_exception_handler handler
))
676 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
677 acpi_install_interface_handler
678 (acpi_interface_handler handler
))
681 * Global Lock interfaces
683 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
684 acpi_acquire_global_lock(u16 timeout
,
687 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
688 acpi_release_global_lock(u32 handle
))
691 * Interfaces to AML mutex objects
693 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
694 acpi_acquire_mutex(acpi_handle handle
,
695 acpi_string pathname
,
698 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
699 acpi_release_mutex(acpi_handle handle
,
700 acpi_string pathname
))
703 * Fixed Event interfaces
705 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
706 acpi_enable_event(u32 event
, u32 flags
))
708 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
709 acpi_disable_event(u32 event
, u32 flags
))
710 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_clear_event(u32 event
))
712 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
713 acpi_get_event_status(u32 event
,
718 * General Purpose Event (GPE) Interfaces
720 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_update_all_gpes(void))
722 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
723 acpi_enable_gpe(acpi_handle gpe_device
,
726 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
727 acpi_disable_gpe(acpi_handle gpe_device
,
730 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
731 acpi_clear_gpe(acpi_handle gpe_device
,
734 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
735 acpi_set_gpe(acpi_handle gpe_device
,
736 u32 gpe_number
, u8 action
))
738 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
739 acpi_finish_gpe(acpi_handle gpe_device
,
742 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
743 acpi_mask_gpe(acpi_handle gpe_device
,
744 u32 gpe_number
, u8 is_masked
))
746 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
747 acpi_mark_gpe_for_wake(acpi_handle gpe_device
,
750 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
751 acpi_setup_gpe_for_wake(acpi_handle
753 acpi_handle gpe_device
,
755 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
756 acpi_set_gpe_wake_mask(acpi_handle gpe_device
,
759 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
760 acpi_get_gpe_status(acpi_handle gpe_device
,
764 ACPI_HW_DEPENDENT_RETURN_UINT32(u32
acpi_dispatch_gpe(acpi_handle gpe_device
, u32 gpe_number
))
765 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_hw_disable_all_gpes(void))
766 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_disable_all_gpes(void))
767 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enable_all_runtime_gpes(void))
768 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enable_all_wakeup_gpes(void))
769 ACPI_HW_DEPENDENT_RETURN_UINT32(u32
acpi_any_gpe_status_set(u32 gpe_skip_number
))
770 ACPI_HW_DEPENDENT_RETURN_UINT32(u32
acpi_any_fixed_event_status_set(void))
772 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
773 acpi_get_gpe_device(u32 gpe_index
,
774 acpi_handle
*gpe_device
))
776 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
777 acpi_install_gpe_block(acpi_handle gpe_device
,
782 u32 interrupt_number
))
783 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
784 acpi_remove_gpe_block(acpi_handle gpe_device
))
787 * Resource interfaces
790 acpi_status (*acpi_walk_resource_callback
) (struct acpi_resource
* resource
,
793 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
794 acpi_get_vendor_resource(acpi_handle device
,
796 struct acpi_vendor_uuid
800 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
801 acpi_get_current_resources(acpi_handle device
,
804 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
805 acpi_get_possible_resources(acpi_handle device
,
808 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
809 acpi_get_event_resources(acpi_handle device_handle
,
812 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
813 acpi_walk_resource_buffer(struct acpi_buffer
815 acpi_walk_resource_callback
818 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
819 acpi_walk_resources(acpi_handle device
, char *name
,
820 acpi_walk_resource_callback
821 user_function
, void *context
))
822 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
823 acpi_set_current_resources(acpi_handle device
,
826 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
827 acpi_get_irq_routing_table(acpi_handle device
,
830 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
831 acpi_resource_to_address64(struct acpi_resource
834 acpi_resource_address64
836 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
837 acpi_buffer_to_resource(u8
*aml_buffer
,
838 u16 aml_buffer_length
,
843 * Hardware (ACPI device) interfaces
845 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_reset(void))
847 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
848 acpi_read(u64
*value
,
849 struct acpi_generic_address
*reg
))
851 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
852 acpi_write(u64 value
,
853 struct acpi_generic_address
*reg
))
855 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
856 acpi_read_bit_register(u32 register_id
,
859 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
860 acpi_write_bit_register(u32 register_id
,
864 * Sleep/Wake interfaces
866 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
867 acpi_get_sleep_type_data(u8 sleep_state
,
871 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
872 acpi_enter_sleep_state_prep(u8 sleep_state
))
873 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_enter_sleep_state(u8 sleep_state
))
875 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enter_sleep_state_s4bios(void))
877 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
878 acpi_leave_sleep_state_prep(u8 sleep_state
))
879 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
acpi_leave_sleep_state(u8 sleep_state
))
881 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
882 acpi_set_firmware_waking_vector
883 (acpi_physical_address physical_address
,
884 acpi_physical_address physical_address64
))
886 * ACPI Timer interfaces
888 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
889 acpi_get_timer_resolution(u32
*resolution
))
890 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_get_timer(u32
*ticks
))
892 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
893 acpi_get_timer_duration(u32 start_ticks
,
898 * Error/Warning output
900 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
901 void ACPI_INTERNAL_VAR_XFACE
902 acpi_error(const char *module_name
,
904 const char *format
, ...))
905 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
906 void ACPI_INTERNAL_VAR_XFACE
907 acpi_exception(const char *module_name
,
910 const char *format
, ...))
911 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
912 void ACPI_INTERNAL_VAR_XFACE
913 acpi_warning(const char *module_name
,
915 const char *format
, ...))
916 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(1)
917 void ACPI_INTERNAL_VAR_XFACE
918 acpi_info(const char *format
, ...))
919 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
920 void ACPI_INTERNAL_VAR_XFACE
921 acpi_bios_error(const char *module_name
,
923 const char *format
, ...))
924 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
925 void ACPI_INTERNAL_VAR_XFACE
926 acpi_bios_exception(const char *module_name
,
929 const char *format
, ...))
930 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
931 void ACPI_INTERNAL_VAR_XFACE
932 acpi_bios_warning(const char *module_name
,
934 const char *format
, ...))
939 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
940 void ACPI_INTERNAL_VAR_XFACE
941 acpi_debug_print(u32 requested_debug_level
,
943 const char *function_name
,
944 const char *module_name
,
946 const char *format
, ...))
947 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
948 void ACPI_INTERNAL_VAR_XFACE
949 acpi_debug_print_raw(u32 requested_debug_level
,
951 const char *function_name
,
952 const char *module_name
,
954 const char *format
, ...))
956 ACPI_DBG_DEPENDENT_RETURN_VOID(void
957 acpi_trace_point(acpi_trace_event_type type
,
959 u8
*aml
, char *pathname
))
961 acpi_status
acpi_initialize_debugger(void);
963 void acpi_terminate_debugger(void);
968 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
969 acpi_get_data_full(acpi_handle object
,
970 acpi_object_handler handler
,
972 void (*callback
)(void *)))
974 void acpi_set_debugger_thread_id(acpi_thread_id thread_id
);
976 #endif /* __ACXFACE_H__ */