453 lines · c
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */2/******************************************************************************3 *4 * Name: amlcode.h - Definitions for AML, as included in "definition blocks"5 * Declarations and definitions contained herein are derived6 * directly from the ACPI specification.7 *8 * Copyright (C) 2000 - 2023, Intel Corp.9 *10 *****************************************************************************/11 12#ifndef __AMLCODE_H__13#define __AMLCODE_H__14 15/* primary opcodes */16 17#define AML_ZERO_OP (u16) 0x0018#define AML_ONE_OP (u16) 0x0119#define AML_ALIAS_OP (u16) 0x0620#define AML_NAME_OP (u16) 0x0821#define AML_BYTE_OP (u16) 0x0a22#define AML_WORD_OP (u16) 0x0b23#define AML_DWORD_OP (u16) 0x0c24#define AML_STRING_OP (u16) 0x0d25#define AML_QWORD_OP (u16) 0x0e /* ACPI 2.0 */26#define AML_SCOPE_OP (u16) 0x1027#define AML_BUFFER_OP (u16) 0x1128#define AML_PACKAGE_OP (u16) 0x1229#define AML_VARIABLE_PACKAGE_OP (u16) 0x13 /* ACPI 2.0 */30#define AML_METHOD_OP (u16) 0x1431#define AML_EXTERNAL_OP (u16) 0x15 /* ACPI 6.0 */32#define AML_DUAL_NAME_PREFIX (u16) 0x2e33#define AML_MULTI_NAME_PREFIX (u16) 0x2f34#define AML_EXTENDED_PREFIX (u16) 0x5b35#define AML_ROOT_PREFIX (u16) 0x5c36#define AML_PARENT_PREFIX (u16) 0x5e37#define AML_FIRST_LOCAL_OP (u16) 0x60 /* Used for Local op # calculations */38#define AML_LOCAL0 (u16) 0x6039#define AML_LOCAL1 (u16) 0x6140#define AML_LOCAL2 (u16) 0x6241#define AML_LOCAL3 (u16) 0x6342#define AML_LOCAL4 (u16) 0x6443#define AML_LOCAL5 (u16) 0x6544#define AML_LOCAL6 (u16) 0x6645#define AML_LOCAL7 (u16) 0x6746#define AML_FIRST_ARG_OP (u16) 0x68 /* Used for Arg op # calculations */47#define AML_ARG0 (u16) 0x6848#define AML_ARG1 (u16) 0x6949#define AML_ARG2 (u16) 0x6a50#define AML_ARG3 (u16) 0x6b51#define AML_ARG4 (u16) 0x6c52#define AML_ARG5 (u16) 0x6d53#define AML_ARG6 (u16) 0x6e54#define AML_STORE_OP (u16) 0x7055#define AML_REF_OF_OP (u16) 0x7156#define AML_ADD_OP (u16) 0x7257#define AML_CONCATENATE_OP (u16) 0x7358#define AML_SUBTRACT_OP (u16) 0x7459#define AML_INCREMENT_OP (u16) 0x7560#define AML_DECREMENT_OP (u16) 0x7661#define AML_MULTIPLY_OP (u16) 0x7762#define AML_DIVIDE_OP (u16) 0x7863#define AML_SHIFT_LEFT_OP (u16) 0x7964#define AML_SHIFT_RIGHT_OP (u16) 0x7a65#define AML_BIT_AND_OP (u16) 0x7b66#define AML_BIT_NAND_OP (u16) 0x7c67#define AML_BIT_OR_OP (u16) 0x7d68#define AML_BIT_NOR_OP (u16) 0x7e69#define AML_BIT_XOR_OP (u16) 0x7f70#define AML_BIT_NOT_OP (u16) 0x8071#define AML_FIND_SET_LEFT_BIT_OP (u16) 0x8172#define AML_FIND_SET_RIGHT_BIT_OP (u16) 0x8273#define AML_DEREF_OF_OP (u16) 0x8374#define AML_CONCATENATE_TEMPLATE_OP (u16) 0x84 /* ACPI 2.0 */75#define AML_MOD_OP (u16) 0x85 /* ACPI 2.0 */76#define AML_NOTIFY_OP (u16) 0x8677#define AML_SIZE_OF_OP (u16) 0x8778#define AML_INDEX_OP (u16) 0x8879#define AML_MATCH_OP (u16) 0x8980#define AML_CREATE_DWORD_FIELD_OP (u16) 0x8a81#define AML_CREATE_WORD_FIELD_OP (u16) 0x8b82#define AML_CREATE_BYTE_FIELD_OP (u16) 0x8c83#define AML_CREATE_BIT_FIELD_OP (u16) 0x8d84#define AML_OBJECT_TYPE_OP (u16) 0x8e85#define AML_CREATE_QWORD_FIELD_OP (u16) 0x8f /* ACPI 2.0 */86#define AML_LOGICAL_AND_OP (u16) 0x9087#define AML_LOGICAL_OR_OP (u16) 0x9188#define AML_LOGICAL_NOT_OP (u16) 0x9289#define AML_LOGICAL_EQUAL_OP (u16) 0x9390#define AML_LOGICAL_GREATER_OP (u16) 0x9491#define AML_LOGICAL_LESS_OP (u16) 0x9592#define AML_TO_BUFFER_OP (u16) 0x96 /* ACPI 2.0 */93#define AML_TO_DECIMAL_STRING_OP (u16) 0x97 /* ACPI 2.0 */94#define AML_TO_HEX_STRING_OP (u16) 0x98 /* ACPI 2.0 */95#define AML_TO_INTEGER_OP (u16) 0x99 /* ACPI 2.0 */96#define AML_TO_STRING_OP (u16) 0x9c /* ACPI 2.0 */97#define AML_COPY_OBJECT_OP (u16) 0x9d /* ACPI 2.0 */98#define AML_MID_OP (u16) 0x9e /* ACPI 2.0 */99#define AML_CONTINUE_OP (u16) 0x9f /* ACPI 2.0 */100#define AML_IF_OP (u16) 0xa0101#define AML_ELSE_OP (u16) 0xa1102#define AML_WHILE_OP (u16) 0xa2103#define AML_NOOP_OP (u16) 0xa3104#define AML_RETURN_OP (u16) 0xa4105#define AML_BREAK_OP (u16) 0xa5106#define AML_COMMENT_OP (u16) 0xa9107#define AML_BREAKPOINT_OP (u16) 0xcc108#define AML_ONES_OP (u16) 0xff109 110/*111 * Combination opcodes (actually two one-byte opcodes)112 * Used by the disassembler and iASL compiler113 */114#define AML_LOGICAL_GREATER_EQUAL_OP (u16) 0x9295 /* LNot (LLess) */115#define AML_LOGICAL_LESS_EQUAL_OP (u16) 0x9294 /* LNot (LGreater) */116#define AML_LOGICAL_NOT_EQUAL_OP (u16) 0x9293 /* LNot (LEqual) */117 118/* Prefixed (2-byte) opcodes (with AML_EXTENDED_PREFIX) */119 120#define AML_EXTENDED_OPCODE (u16) 0x5b00 /* Prefix for 2-byte opcodes */121 122#define AML_MUTEX_OP (u16) 0x5b01123#define AML_EVENT_OP (u16) 0x5b02124#define AML_SHIFT_RIGHT_BIT_OP (u16) 0x5b10 /* Obsolete, not in ACPI spec */125#define AML_SHIFT_LEFT_BIT_OP (u16) 0x5b11 /* Obsolete, not in ACPI spec */126#define AML_CONDITIONAL_REF_OF_OP (u16) 0x5b12127#define AML_CREATE_FIELD_OP (u16) 0x5b13128#define AML_LOAD_TABLE_OP (u16) 0x5b1f /* ACPI 2.0 */129#define AML_LOAD_OP (u16) 0x5b20130#define AML_STALL_OP (u16) 0x5b21131#define AML_SLEEP_OP (u16) 0x5b22132#define AML_ACQUIRE_OP (u16) 0x5b23133#define AML_SIGNAL_OP (u16) 0x5b24134#define AML_WAIT_OP (u16) 0x5b25135#define AML_RESET_OP (u16) 0x5b26136#define AML_RELEASE_OP (u16) 0x5b27137#define AML_FROM_BCD_OP (u16) 0x5b28138#define AML_TO_BCD_OP (u16) 0x5b29139#define AML_UNLOAD_OP (u16) 0x5b2a140#define AML_REVISION_OP (u16) 0x5b30141#define AML_DEBUG_OP (u16) 0x5b31142#define AML_FATAL_OP (u16) 0x5b32143#define AML_TIMER_OP (u16) 0x5b33 /* ACPI 3.0 */144#define AML_REGION_OP (u16) 0x5b80145#define AML_FIELD_OP (u16) 0x5b81146#define AML_DEVICE_OP (u16) 0x5b82147#define AML_PROCESSOR_OP (u16) 0x5b83148#define AML_POWER_RESOURCE_OP (u16) 0x5b84149#define AML_THERMAL_ZONE_OP (u16) 0x5b85150#define AML_INDEX_FIELD_OP (u16) 0x5b86151#define AML_BANK_FIELD_OP (u16) 0x5b87152#define AML_DATA_REGION_OP (u16) 0x5b88 /* ACPI 2.0 */153 154/*155 * Opcodes for "Field" operators156 */157#define AML_FIELD_OFFSET_OP (u8) 0x00158#define AML_FIELD_ACCESS_OP (u8) 0x01159#define AML_FIELD_CONNECTION_OP (u8) 0x02 /* ACPI 5.0 */160#define AML_FIELD_EXT_ACCESS_OP (u8) 0x03 /* ACPI 5.0 */161 162/*163 * Internal opcodes164 * Use only "Unknown" AML opcodes, don't attempt to use165 * any valid ACPI ASCII values (A-Z, 0-9, '-')166 */167#define AML_INT_NAMEPATH_OP (u16) 0x002d168#define AML_INT_NAMEDFIELD_OP (u16) 0x0030169#define AML_INT_RESERVEDFIELD_OP (u16) 0x0031170#define AML_INT_ACCESSFIELD_OP (u16) 0x0032171#define AML_INT_BYTELIST_OP (u16) 0x0033172#define AML_INT_METHODCALL_OP (u16) 0x0035173#define AML_INT_RETURN_VALUE_OP (u16) 0x0036174#define AML_INT_EVAL_SUBTREE_OP (u16) 0x0037175#define AML_INT_CONNECTION_OP (u16) 0x0038176#define AML_INT_EXTACCESSFIELD_OP (u16) 0x0039177 178#define ARG_NONE 0x0179 180/*181 * Argument types for the AML Parser182 * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.183 * There can be up to 31 unique argument types184 * Zero is reserved as end-of-list indicator185 */186#define ARGP_BYTEDATA 0x01187#define ARGP_BYTELIST 0x02188#define ARGP_CHARLIST 0x03189#define ARGP_DATAOBJ 0x04190#define ARGP_DATAOBJLIST 0x05191#define ARGP_DWORDDATA 0x06192#define ARGP_FIELDLIST 0x07193#define ARGP_NAME 0x08194#define ARGP_NAMESTRING 0x09195#define ARGP_OBJLIST 0x0A196#define ARGP_PKGLENGTH 0x0B197#define ARGP_SUPERNAME 0x0C198#define ARGP_TARGET 0x0D199#define ARGP_TERMARG 0x0E200#define ARGP_TERMLIST 0x0F201#define ARGP_WORDDATA 0x10202#define ARGP_QWORDDATA 0x11203#define ARGP_SIMPLENAME 0x12 /* name_string | local_term | arg_term */204#define ARGP_NAME_OR_REF 0x13 /* For object_type only */205#define ARGP_MAX 0x13206#define ARGP_COMMENT 0x14207 208/*209 * Resolved argument types for the AML Interpreter210 * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.211 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)212 *213 * Note1: These values are completely independent from the ACPI_TYPEs214 * i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER215 *216 * Note2: If and when 5 bits becomes insufficient, it would probably be best217 * to convert to a 6-byte array of argument types, allowing 8 bits per argument.218 */219 220/* Single, simple types */221 222#define ARGI_ANYTYPE 0x01 /* Don't care */223#define ARGI_PACKAGE 0x02224#define ARGI_EVENT 0x03225#define ARGI_MUTEX 0x04226#define ARGI_DDBHANDLE 0x05227 228/* Interchangeable types (via implicit conversion) */229 230#define ARGI_INTEGER 0x06231#define ARGI_STRING 0x07232#define ARGI_BUFFER 0x08233#define ARGI_BUFFER_OR_STRING 0x09 /* Used by MID op only */234#define ARGI_COMPUTEDATA 0x0A /* Buffer, String, or Integer */235 236/* Reference objects */237 238#define ARGI_INTEGER_REF 0x0B239#define ARGI_OBJECT_REF 0x0C240#define ARGI_DEVICE_REF 0x0D241#define ARGI_REFERENCE 0x0E242#define ARGI_TARGETREF 0x0F /* Target, subject to implicit conversion */243#define ARGI_FIXED_TARGET 0x10 /* Target, no implicit conversion */244#define ARGI_SIMPLE_TARGET 0x11 /* Name, Local, Arg -- no implicit conversion */245#define ARGI_STORE_TARGET 0x12 /* Target for store is TARGETREF + package objects */246 247/* Multiple/complex types */248 249#define ARGI_DATAOBJECT 0x13 /* Buffer, String, package or reference to a node - Used only by size_of operator */250#define ARGI_COMPLEXOBJ 0x14 /* Buffer, String, or package (Used by INDEX op only) */251#define ARGI_REF_OR_STRING 0x15 /* Reference or String (Used by DEREFOF op only) */252#define ARGI_REGION_OR_BUFFER 0x16 /* Used by LOAD op only */253#define ARGI_DATAREFOBJ 0x17254 255/* Note: types above can expand to 0x1F maximum */256 257#define ARGI_INVALID_OPCODE 0xFFFFFFFF258 259/*260 * Some of the flags and types below are of the form:261 *262 * AML_FLAGS_EXEC_#A_#T,#R, or263 * AML_TYPE_EXEC_#A_#T,#R where:264 *265 * #A is the number of required arguments266 * #T is the number of target operands267 * #R indicates whether there is a return value268 *269 * These types are used for the top-level dispatch of the AML270 * opcode. They group similar operators that can share common271 * front-end code before dispatch to the final code that implements272 * the operator.273 */274 275/*276 * Opcode information flags277 */278#define AML_LOGICAL 0x0001279#define AML_LOGICAL_NUMERIC 0x0002280#define AML_MATH 0x0004281#define AML_CREATE 0x0008282#define AML_FIELD 0x0010283#define AML_DEFER 0x0020284#define AML_NAMED 0x0040285#define AML_NSNODE 0x0080286#define AML_NSOPCODE 0x0100287#define AML_NSOBJECT 0x0200288#define AML_HAS_RETVAL 0x0400289#define AML_HAS_TARGET 0x0800290#define AML_HAS_ARGS 0x1000291#define AML_CONSTANT 0x2000292#define AML_NO_OPERAND_RESOLVE 0x4000293 294/* Convenient flag groupings of the flags above */295 296#define AML_FLAGS_EXEC_0A_0T_1R AML_HAS_RETVAL297#define AML_FLAGS_EXEC_1A_0T_0R AML_HAS_ARGS /* Monadic1 */298#define AML_FLAGS_EXEC_1A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Monadic2 */299#define AML_FLAGS_EXEC_1A_1T_0R AML_HAS_ARGS | AML_HAS_TARGET300#define AML_FLAGS_EXEC_1A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* monadic2_r */301#define AML_FLAGS_EXEC_2A_0T_0R AML_HAS_ARGS /* Dyadic1 */302#define AML_FLAGS_EXEC_2A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Dyadic2 */303#define AML_FLAGS_EXEC_2A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* dyadic2_r */304#define AML_FLAGS_EXEC_2A_2T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL305#define AML_FLAGS_EXEC_3A_0T_0R AML_HAS_ARGS306#define AML_FLAGS_EXEC_3A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL307#define AML_FLAGS_EXEC_6A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL308 309/*310 * The opcode Type is used in a dispatch table, do not change311 * or add anything new without updating the table.312 */313#define AML_TYPE_EXEC_0A_0T_1R 0x00 /* 0 Args, 0 Target, 1 ret_val */314#define AML_TYPE_EXEC_1A_0T_0R 0x01 /* 1 Args, 0 Target, 0 ret_val */315#define AML_TYPE_EXEC_1A_0T_1R 0x02 /* 1 Args, 0 Target, 1 ret_val */316#define AML_TYPE_EXEC_1A_1T_0R 0x03 /* 1 Args, 1 Target, 0 ret_val */317#define AML_TYPE_EXEC_1A_1T_1R 0x04 /* 1 Args, 1 Target, 1 ret_val */318#define AML_TYPE_EXEC_2A_0T_0R 0x05 /* 2 Args, 0 Target, 0 ret_val */319#define AML_TYPE_EXEC_2A_0T_1R 0x06 /* 2 Args, 0 Target, 1 ret_val */320#define AML_TYPE_EXEC_2A_1T_1R 0x07 /* 2 Args, 1 Target, 1 ret_val */321#define AML_TYPE_EXEC_2A_2T_1R 0x08 /* 2 Args, 2 Target, 1 ret_val */322#define AML_TYPE_EXEC_3A_0T_0R 0x09 /* 3 Args, 0 Target, 0 ret_val */323#define AML_TYPE_EXEC_3A_1T_1R 0x0A /* 3 Args, 1 Target, 1 ret_val */324#define AML_TYPE_EXEC_6A_0T_1R 0x0B /* 6 Args, 0 Target, 1 ret_val */325/* End of types used in dispatch table */326 327#define AML_TYPE_LITERAL 0x0C328#define AML_TYPE_CONSTANT 0x0D329#define AML_TYPE_METHOD_ARGUMENT 0x0E330#define AML_TYPE_LOCAL_VARIABLE 0x0F331#define AML_TYPE_DATA_TERM 0x10332 333/* Generic for an op that returns a value */334 335#define AML_TYPE_METHOD_CALL 0x11336 337/* Miscellaneous types */338 339#define AML_TYPE_CREATE_FIELD 0x12340#define AML_TYPE_CREATE_OBJECT 0x13341#define AML_TYPE_CONTROL 0x14342#define AML_TYPE_NAMED_NO_OBJ 0x15343#define AML_TYPE_NAMED_FIELD 0x16344#define AML_TYPE_NAMED_SIMPLE 0x17345#define AML_TYPE_NAMED_COMPLEX 0x18346#define AML_TYPE_RETURN 0x19347#define AML_TYPE_UNDEFINED 0x1A348#define AML_TYPE_BOGUS 0x1B349 350/* AML Package Length encodings */351 352#define ACPI_AML_PACKAGE_TYPE1 0x40353#define ACPI_AML_PACKAGE_TYPE2 0x4000354#define ACPI_AML_PACKAGE_TYPE3 0x400000355#define ACPI_AML_PACKAGE_TYPE4 0x40000000356 357/*358 * Opcode classes359 */360#define AML_CLASS_EXECUTE 0x00361#define AML_CLASS_CREATE 0x01362#define AML_CLASS_ARGUMENT 0x02363#define AML_CLASS_NAMED_OBJECT 0x03364#define AML_CLASS_CONTROL 0x04365#define AML_CLASS_ASCII 0x05366#define AML_CLASS_PREFIX 0x06367#define AML_CLASS_INTERNAL 0x07368#define AML_CLASS_RETURN_VALUE 0x08369#define AML_CLASS_METHOD_CALL 0x09370#define AML_CLASS_UNKNOWN 0x0A371 372/* Comparison operation codes for match_op operator */373 374typedef enum {375 MATCH_MTR = 0,376 MATCH_MEQ = 1,377 MATCH_MLE = 2,378 MATCH_MLT = 3,379 MATCH_MGE = 4,380 MATCH_MGT = 5381} AML_MATCH_OPERATOR;382 383#define MAX_MATCH_OPERATOR 5384 385/*386 * field_flags387 *388 * This byte is extracted from the AML and includes three separate389 * pieces of information about the field:390 * 1) The field access type391 * 2) The field update rule392 * 3) The lock rule for the field393 *394 * Bits 00 - 03 : access_type (any_acc, byte_acc, etc.)395 * 04 : lock_rule (1 == Lock)396 * 05 - 06 : update_rule397 */398#define AML_FIELD_ACCESS_TYPE_MASK 0x0F399#define AML_FIELD_LOCK_RULE_MASK 0x10400#define AML_FIELD_UPDATE_RULE_MASK 0x60401 402/* 1) Field Access Types */403 404typedef enum {405 AML_FIELD_ACCESS_ANY = 0x00,406 AML_FIELD_ACCESS_BYTE = 0x01,407 AML_FIELD_ACCESS_WORD = 0x02,408 AML_FIELD_ACCESS_DWORD = 0x03,409 AML_FIELD_ACCESS_QWORD = 0x04, /* ACPI 2.0 */410 AML_FIELD_ACCESS_BUFFER = 0x05 /* ACPI 2.0 */411} AML_ACCESS_TYPE;412 413/* 2) Field Lock Rules */414 415typedef enum {416 AML_FIELD_LOCK_NEVER = 0x00,417 AML_FIELD_LOCK_ALWAYS = 0x10418} AML_LOCK_RULE;419 420/* 3) Field Update Rules */421 422typedef enum {423 AML_FIELD_UPDATE_PRESERVE = 0x00,424 AML_FIELD_UPDATE_WRITE_AS_ONES = 0x20,425 AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40426} AML_UPDATE_RULE;427 428/*429 * Field Access Attributes.430 * This byte is extracted from the AML via the431 * access_as keyword432 */433typedef enum {434 AML_FIELD_ATTRIB_QUICK = 0x02,435 AML_FIELD_ATTRIB_SEND_RECEIVE = 0x04,436 AML_FIELD_ATTRIB_BYTE = 0x06,437 AML_FIELD_ATTRIB_WORD = 0x08,438 AML_FIELD_ATTRIB_BLOCK = 0x0A,439 AML_FIELD_ATTRIB_BYTES = 0x0B,440 AML_FIELD_ATTRIB_PROCESS_CALL = 0x0C,441 AML_FIELD_ATTRIB_BLOCK_PROCESS_CALL = 0x0D,442 AML_FIELD_ATTRIB_RAW_BYTES = 0x0E,443 AML_FIELD_ATTRIB_RAW_PROCESS_BYTES = 0x0F444} AML_ACCESS_ATTRIBUTE;445 446/* Bit fields in the AML method_flags byte */447 448#define AML_METHOD_ARG_COUNT 0x07449#define AML_METHOD_SERIALIZED 0x08450#define AML_METHOD_SYNC_LEVEL 0xF0451 452#endif /* __AMLCODE_H__ */453