// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 /****************************************************************************** * * Module Name: exutils - interpreter/scanner utilities * * Copyright (C) 2000 - 2023, Intel Corp. * *****************************************************************************/ /* * DEFINE_AML_GLOBALS is tested in amlcode.h * to determine whether certain global names should be "defined" or only * "declared" in the current compilation. This enhances maintainability * by enabling a single header file to embody all knowledge of the names * in question. * * Exactly one module of any executable should #define DEFINE_GLOBALS * before #including the header files which use this convention. The * names in question will be defined and initialized in that module, * and declared as extern in all other modules which #include those * header files. */ #define DEFINE_AML_GLOBALS #include <acpi/acpi.h> #include "accommon.h" #include "acinterp.h" #include "amlcode.h" #define _COMPONENT … ACPI_MODULE_NAME("exutils") /* Local prototypes */ static u32 acpi_ex_digits_needed(u64 value, u32 base); /******************************************************************************* * * FUNCTION: acpi_ex_enter_interpreter * * PARAMETERS: None * * RETURN: None * * DESCRIPTION: Enter the interpreter execution region. Failure to enter * the interpreter region is a fatal system error. Used in * conjunction with exit_interpreter. * ******************************************************************************/ void acpi_ex_enter_interpreter(void) { … } /******************************************************************************* * * FUNCTION: acpi_ex_exit_interpreter * * PARAMETERS: None * * RETURN: None * * DESCRIPTION: Exit the interpreter execution region. This is the top level * routine used to exit the interpreter when all processing has * been completed, or when the method blocks. * * Cases where the interpreter is unlocked internally: * 1) Method will be blocked on a Sleep() AML opcode * 2) Method will be blocked on an Acquire() AML opcode * 3) Method will be blocked on a Wait() AML opcode * 4) Method will be blocked to acquire the global lock * 5) Method will be blocked waiting to execute a serialized control * method that is currently executing * 6) About to invoke a user-installed opregion handler * ******************************************************************************/ void acpi_ex_exit_interpreter(void) { … } /******************************************************************************* * * FUNCTION: acpi_ex_truncate_for32bit_table * * PARAMETERS: obj_desc - Object to be truncated * * RETURN: TRUE if a truncation was performed, FALSE otherwise. * * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is * 32-bit, as determined by the revision of the DSDT. * ******************************************************************************/ u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc) { … } /******************************************************************************* * * FUNCTION: acpi_ex_acquire_global_lock * * PARAMETERS: field_flags - Flags with Lock rule: * always_lock or never_lock * * RETURN: None * * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field * flags specify that it is to be obtained before field access. * ******************************************************************************/ void acpi_ex_acquire_global_lock(u32 field_flags) { … } /******************************************************************************* * * FUNCTION: acpi_ex_release_global_lock * * PARAMETERS: field_flags - Flags with Lock rule: * always_lock or never_lock * * RETURN: None * * DESCRIPTION: Release the ACPI hardware Global Lock * ******************************************************************************/ void acpi_ex_release_global_lock(u32 field_flags) { … } /******************************************************************************* * * FUNCTION: acpi_ex_digits_needed * * PARAMETERS: value - Value to be represented * base - Base of representation * * RETURN: The number of digits. * * DESCRIPTION: Calculate the number of digits needed to represent the Value * in the given Base (Radix) * ******************************************************************************/ static u32 acpi_ex_digits_needed(u64 value, u32 base) { … } /******************************************************************************* * * FUNCTION: acpi_ex_eisa_id_to_string * * PARAMETERS: out_string - Where to put the converted string (8 bytes) * compressed_id - EISAID to be converted * * RETURN: None * * DESCRIPTION: Convert a numeric EISAID to string representation. Return * buffer must be large enough to hold the string. The string * returned is always exactly of length ACPI_EISAID_STRING_SIZE * (includes null terminator). The EISAID is always 32 bits. * ******************************************************************************/ void acpi_ex_eisa_id_to_string(char *out_string, u64 compressed_id) { … } /******************************************************************************* * * FUNCTION: acpi_ex_integer_to_string * * PARAMETERS: out_string - Where to put the converted string. At least * 21 bytes are needed to hold the largest * possible 64-bit integer. * value - Value to be converted * * RETURN: Converted string in out_string * * DESCRIPTION: Convert a 64-bit integer to decimal string representation. * Assumes string buffer is large enough to hold the string. The * largest string is (ACPI_MAX64_DECIMAL_DIGITS + 1). * ******************************************************************************/ void acpi_ex_integer_to_string(char *out_string, u64 value) { … } /******************************************************************************* * * FUNCTION: acpi_ex_pci_cls_to_string * * PARAMETERS: out_string - Where to put the converted string (7 bytes) * class_code - PCI class code to be converted (3 bytes) * * RETURN: Converted string in out_string * * DESCRIPTION: Convert 3-bytes PCI class code to string representation. * Return buffer must be large enough to hold the string. The * string returned is always exactly of length * ACPI_PCICLS_STRING_SIZE (includes null terminator). * ******************************************************************************/ void acpi_ex_pci_cls_to_string(char *out_string, u8 class_code[3]) { … } /******************************************************************************* * * FUNCTION: acpi_is_valid_space_id * * PARAMETERS: space_id - ID to be validated * * RETURN: TRUE if space_id is a valid/supported ID. * * DESCRIPTION: Validate an operation region space_ID. * ******************************************************************************/ u8 acpi_is_valid_space_id(u8 space_id) { … }