/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ /****************************************************************************** * * Name: amlcode.h - Definitions for AML, as included in "definition blocks" * Declarations and definitions contained herein are derived * directly from the ACPI specification. * * Copyright (C) 2000 - 2023, Intel Corp. * *****************************************************************************/ #ifndef __AMLCODE_H__ #define __AMLCODE_H__ /* primary opcodes */ #define AML_ZERO_OP … #define AML_ONE_OP … #define AML_ALIAS_OP … #define AML_NAME_OP … #define AML_BYTE_OP … #define AML_WORD_OP … #define AML_DWORD_OP … #define AML_STRING_OP … #define AML_QWORD_OP … #define AML_SCOPE_OP … #define AML_BUFFER_OP … #define AML_PACKAGE_OP … #define AML_VARIABLE_PACKAGE_OP … #define AML_METHOD_OP … #define AML_EXTERNAL_OP … #define AML_DUAL_NAME_PREFIX … #define AML_MULTI_NAME_PREFIX … #define AML_EXTENDED_PREFIX … #define AML_ROOT_PREFIX … #define AML_PARENT_PREFIX … #define AML_FIRST_LOCAL_OP … #define AML_LOCAL0 … #define AML_LOCAL1 … #define AML_LOCAL2 … #define AML_LOCAL3 … #define AML_LOCAL4 … #define AML_LOCAL5 … #define AML_LOCAL6 … #define AML_LOCAL7 … #define AML_FIRST_ARG_OP … #define AML_ARG0 … #define AML_ARG1 … #define AML_ARG2 … #define AML_ARG3 … #define AML_ARG4 … #define AML_ARG5 … #define AML_ARG6 … #define AML_STORE_OP … #define AML_REF_OF_OP … #define AML_ADD_OP … #define AML_CONCATENATE_OP … #define AML_SUBTRACT_OP … #define AML_INCREMENT_OP … #define AML_DECREMENT_OP … #define AML_MULTIPLY_OP … #define AML_DIVIDE_OP … #define AML_SHIFT_LEFT_OP … #define AML_SHIFT_RIGHT_OP … #define AML_BIT_AND_OP … #define AML_BIT_NAND_OP … #define AML_BIT_OR_OP … #define AML_BIT_NOR_OP … #define AML_BIT_XOR_OP … #define AML_BIT_NOT_OP … #define AML_FIND_SET_LEFT_BIT_OP … #define AML_FIND_SET_RIGHT_BIT_OP … #define AML_DEREF_OF_OP … #define AML_CONCATENATE_TEMPLATE_OP … #define AML_MOD_OP … #define AML_NOTIFY_OP … #define AML_SIZE_OF_OP … #define AML_INDEX_OP … #define AML_MATCH_OP … #define AML_CREATE_DWORD_FIELD_OP … #define AML_CREATE_WORD_FIELD_OP … #define AML_CREATE_BYTE_FIELD_OP … #define AML_CREATE_BIT_FIELD_OP … #define AML_OBJECT_TYPE_OP … #define AML_CREATE_QWORD_FIELD_OP … #define AML_LOGICAL_AND_OP … #define AML_LOGICAL_OR_OP … #define AML_LOGICAL_NOT_OP … #define AML_LOGICAL_EQUAL_OP … #define AML_LOGICAL_GREATER_OP … #define AML_LOGICAL_LESS_OP … #define AML_TO_BUFFER_OP … #define AML_TO_DECIMAL_STRING_OP … #define AML_TO_HEX_STRING_OP … #define AML_TO_INTEGER_OP … #define AML_TO_STRING_OP … #define AML_COPY_OBJECT_OP … #define AML_MID_OP … #define AML_CONTINUE_OP … #define AML_IF_OP … #define AML_ELSE_OP … #define AML_WHILE_OP … #define AML_NOOP_OP … #define AML_RETURN_OP … #define AML_BREAK_OP … #define AML_COMMENT_OP … #define AML_BREAKPOINT_OP … #define AML_ONES_OP … /* * Combination opcodes (actually two one-byte opcodes) * Used by the disassembler and iASL compiler */ #define AML_LOGICAL_GREATER_EQUAL_OP … #define AML_LOGICAL_LESS_EQUAL_OP … #define AML_LOGICAL_NOT_EQUAL_OP … /* Prefixed (2-byte) opcodes (with AML_EXTENDED_PREFIX) */ #define AML_EXTENDED_OPCODE … #define AML_MUTEX_OP … #define AML_EVENT_OP … #define AML_SHIFT_RIGHT_BIT_OP … #define AML_SHIFT_LEFT_BIT_OP … #define AML_CONDITIONAL_REF_OF_OP … #define AML_CREATE_FIELD_OP … #define AML_LOAD_TABLE_OP … #define AML_LOAD_OP … #define AML_STALL_OP … #define AML_SLEEP_OP … #define AML_ACQUIRE_OP … #define AML_SIGNAL_OP … #define AML_WAIT_OP … #define AML_RESET_OP … #define AML_RELEASE_OP … #define AML_FROM_BCD_OP … #define AML_TO_BCD_OP … #define AML_UNLOAD_OP … #define AML_REVISION_OP … #define AML_DEBUG_OP … #define AML_FATAL_OP … #define AML_TIMER_OP … #define AML_REGION_OP … #define AML_FIELD_OP … #define AML_DEVICE_OP … #define AML_PROCESSOR_OP … #define AML_POWER_RESOURCE_OP … #define AML_THERMAL_ZONE_OP … #define AML_INDEX_FIELD_OP … #define AML_BANK_FIELD_OP … #define AML_DATA_REGION_OP … /* * Opcodes for "Field" operators */ #define AML_FIELD_OFFSET_OP … #define AML_FIELD_ACCESS_OP … #define AML_FIELD_CONNECTION_OP … #define AML_FIELD_EXT_ACCESS_OP … /* * Internal opcodes * Use only "Unknown" AML opcodes, don't attempt to use * any valid ACPI ASCII values (A-Z, 0-9, '-') */ #define AML_INT_NAMEPATH_OP … #define AML_INT_NAMEDFIELD_OP … #define AML_INT_RESERVEDFIELD_OP … #define AML_INT_ACCESSFIELD_OP … #define AML_INT_BYTELIST_OP … #define AML_INT_METHODCALL_OP … #define AML_INT_RETURN_VALUE_OP … #define AML_INT_EVAL_SUBTREE_OP … #define AML_INT_CONNECTION_OP … #define AML_INT_EXTACCESSFIELD_OP … #define ARG_NONE … /* * Argument types for the AML Parser * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments. * There can be up to 31 unique argument types * Zero is reserved as end-of-list indicator */ #define ARGP_BYTEDATA … #define ARGP_BYTELIST … #define ARGP_CHARLIST … #define ARGP_DATAOBJ … #define ARGP_DATAOBJLIST … #define ARGP_DWORDDATA … #define ARGP_FIELDLIST … #define ARGP_NAME … #define ARGP_NAMESTRING … #define ARGP_OBJLIST … #define ARGP_PKGLENGTH … #define ARGP_SUPERNAME … #define ARGP_TARGET … #define ARGP_TERMARG … #define ARGP_TERMLIST … #define ARGP_WORDDATA … #define ARGP_QWORDDATA … #define ARGP_SIMPLENAME … #define ARGP_NAME_OR_REF … #define ARGP_MAX … #define ARGP_COMMENT … /* * Resolved argument types for the AML Interpreter * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments. * There can be up to 31 unique argument types (0 is end-of-arg-list indicator) * * Note1: These values are completely independent from the ACPI_TYPEs * i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER * * Note2: If and when 5 bits becomes insufficient, it would probably be best * to convert to a 6-byte array of argument types, allowing 8 bits per argument. */ /* Single, simple types */ #define ARGI_ANYTYPE … #define ARGI_PACKAGE … #define ARGI_EVENT … #define ARGI_MUTEX … #define ARGI_DDBHANDLE … /* Interchangeable types (via implicit conversion) */ #define ARGI_INTEGER … #define ARGI_STRING … #define ARGI_BUFFER … #define ARGI_BUFFER_OR_STRING … #define ARGI_COMPUTEDATA … /* Reference objects */ #define ARGI_INTEGER_REF … #define ARGI_OBJECT_REF … #define ARGI_DEVICE_REF … #define ARGI_REFERENCE … #define ARGI_TARGETREF … #define ARGI_FIXED_TARGET … #define ARGI_SIMPLE_TARGET … #define ARGI_STORE_TARGET … /* Multiple/complex types */ #define ARGI_DATAOBJECT … #define ARGI_COMPLEXOBJ … #define ARGI_REF_OR_STRING … #define ARGI_REGION_OR_BUFFER … #define ARGI_DATAREFOBJ … /* Note: types above can expand to 0x1F maximum */ #define ARGI_INVALID_OPCODE … /* * Some of the flags and types below are of the form: * * AML_FLAGS_EXEC_#A_#T,#R, or * AML_TYPE_EXEC_#A_#T,#R where: * * #A is the number of required arguments * #T is the number of target operands * #R indicates whether there is a return value * * These types are used for the top-level dispatch of the AML * opcode. They group similar operators that can share common * front-end code before dispatch to the final code that implements * the operator. */ /* * Opcode information flags */ #define AML_LOGICAL … #define AML_LOGICAL_NUMERIC … #define AML_MATH … #define AML_CREATE … #define AML_FIELD … #define AML_DEFER … #define AML_NAMED … #define AML_NSNODE … #define AML_NSOPCODE … #define AML_NSOBJECT … #define AML_HAS_RETVAL … #define AML_HAS_TARGET … #define AML_HAS_ARGS … #define AML_CONSTANT … #define AML_NO_OPERAND_RESOLVE … /* Convenient flag groupings of the flags above */ #define AML_FLAGS_EXEC_0A_0T_1R … #define AML_FLAGS_EXEC_1A_0T_0R … #define AML_FLAGS_EXEC_1A_0T_1R … #define AML_FLAGS_EXEC_1A_1T_0R … #define AML_FLAGS_EXEC_1A_1T_1R … #define AML_FLAGS_EXEC_2A_0T_0R … #define AML_FLAGS_EXEC_2A_0T_1R … #define AML_FLAGS_EXEC_2A_1T_1R … #define AML_FLAGS_EXEC_2A_2T_1R … #define AML_FLAGS_EXEC_3A_0T_0R … #define AML_FLAGS_EXEC_3A_1T_1R … #define AML_FLAGS_EXEC_6A_0T_1R … /* * The opcode Type is used in a dispatch table, do not change * or add anything new without updating the table. */ #define AML_TYPE_EXEC_0A_0T_1R … #define AML_TYPE_EXEC_1A_0T_0R … #define AML_TYPE_EXEC_1A_0T_1R … #define AML_TYPE_EXEC_1A_1T_0R … #define AML_TYPE_EXEC_1A_1T_1R … #define AML_TYPE_EXEC_2A_0T_0R … #define AML_TYPE_EXEC_2A_0T_1R … #define AML_TYPE_EXEC_2A_1T_1R … #define AML_TYPE_EXEC_2A_2T_1R … #define AML_TYPE_EXEC_3A_0T_0R … #define AML_TYPE_EXEC_3A_1T_1R … #define AML_TYPE_EXEC_6A_0T_1R … /* End of types used in dispatch table */ #define AML_TYPE_LITERAL … #define AML_TYPE_CONSTANT … #define AML_TYPE_METHOD_ARGUMENT … #define AML_TYPE_LOCAL_VARIABLE … #define AML_TYPE_DATA_TERM … /* Generic for an op that returns a value */ #define AML_TYPE_METHOD_CALL … /* Miscellaneous types */ #define AML_TYPE_CREATE_FIELD … #define AML_TYPE_CREATE_OBJECT … #define AML_TYPE_CONTROL … #define AML_TYPE_NAMED_NO_OBJ … #define AML_TYPE_NAMED_FIELD … #define AML_TYPE_NAMED_SIMPLE … #define AML_TYPE_NAMED_COMPLEX … #define AML_TYPE_RETURN … #define AML_TYPE_UNDEFINED … #define AML_TYPE_BOGUS … /* AML Package Length encodings */ #define ACPI_AML_PACKAGE_TYPE1 … #define ACPI_AML_PACKAGE_TYPE2 … #define ACPI_AML_PACKAGE_TYPE3 … #define ACPI_AML_PACKAGE_TYPE4 … /* * Opcode classes */ #define AML_CLASS_EXECUTE … #define AML_CLASS_CREATE … #define AML_CLASS_ARGUMENT … #define AML_CLASS_NAMED_OBJECT … #define AML_CLASS_CONTROL … #define AML_CLASS_ASCII … #define AML_CLASS_PREFIX … #define AML_CLASS_INTERNAL … #define AML_CLASS_RETURN_VALUE … #define AML_CLASS_METHOD_CALL … #define AML_CLASS_UNKNOWN … /* Comparison operation codes for match_op operator */ AML_MATCH_OPERATOR; #define MAX_MATCH_OPERATOR … /* * field_flags * * This byte is extracted from the AML and includes three separate * pieces of information about the field: * 1) The field access type * 2) The field update rule * 3) The lock rule for the field * * Bits 00 - 03 : access_type (any_acc, byte_acc, etc.) * 04 : lock_rule (1 == Lock) * 05 - 06 : update_rule */ #define AML_FIELD_ACCESS_TYPE_MASK … #define AML_FIELD_LOCK_RULE_MASK … #define AML_FIELD_UPDATE_RULE_MASK … /* 1) Field Access Types */ AML_ACCESS_TYPE; /* 2) Field Lock Rules */ AML_LOCK_RULE; /* 3) Field Update Rules */ AML_UPDATE_RULE; /* * Field Access Attributes. * This byte is extracted from the AML via the * access_as keyword */ AML_ACCESS_ATTRIBUTE; /* Bit fields in the AML method_flags byte */ #define AML_METHOD_ARG_COUNT … #define AML_METHOD_SERIALIZED … #define AML_METHOD_SYNC_LEVEL … #endif /* __AMLCODE_H__ */
Codebase Browser
linux