projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 98f28081 PG |
1 | /** @file\r |
| 2 | AML grammar definitions.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved. <BR>\r | |
| 12e65fd2 | 5 | Copyright (c) 2019 - 2021, Arm Limited. All rights reserved.<BR>\r |
| 98f28081 PG |
6 | \r |
| 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
| 8 | **/\r | |
| 9 | \r | |
| 10 | #include <AmlEncoding/Aml.h>\r | |
| 11 | \r | |
| 12 | /** AML grammar encoding table.\r | |
| 13 | \r | |
| 14 | The ASL language is a description language, used to define abstract\r | |
| 15 | objects, like devices, thermal zones, etc. and their place in a hierarchical\r | |
| 16 | tree. The following table stores the AML grammar definition. It can be used\r | |
| 17 | to parse an AML bytestream. Each line corresponds to the definition of an\r | |
| 18 | opcode and what is expected to be found with this opcode.\r | |
| 19 | See table 20-440 in the ACPI 6.3 specification s20.3, and the AML\r | |
| 20 | grammar definitions in s20.2.\r | |
| 21 | \r | |
| 22 | - OpCode/SubOpCode:\r | |
| 23 | An OpCode/SubOpCode couple allows to identify an object type.\r | |
| 24 | The OpCode and SubOpCode are one byte each. The SubOpCode is\r | |
| 25 | used when the Opcode value is 0x5B (extended OpCode). Otherwise\r | |
| 26 | the SubOpcode is set to 0. If the SubOpCode is 0 in the table\r | |
| 27 | below, there is no SubOpCode in the AML bytestream, only the\r | |
| 28 | OpCode is used to identify the object.\r | |
| 29 | \r | |
| 30 | - Fixed arguments:\r | |
| 31 | The fixed arguments follow the OpCode and SubOpCode. Their number\r | |
| 32 | and type can be found in the table below. There can be at the most\r | |
| 33 | 6 fixed arguments for an object.\r | |
| 34 | Fixed arguments's type allow to know what is expected in the AML bytestream.\r | |
| 35 | Knowing the size of the incoming element, AML bytes can be packed and parsed\r | |
| 36 | accordingly. These types can be found in the same table 20-440 in the\r | |
| 37 | ACPI 6.3, s20.3 specification.\r | |
| 38 | E.g.: An AML object, a UINT8, a NULL terminated string, etc.\r | |
| 39 | \r | |
| 40 | -Attributes:\r | |
| 41 | The attribute field gives additional information on each object. This can\r | |
| 42 | be the presence of a variable list of arguments, the presence of a PkgLen,\r | |
| 43 | etc.\r | |
| 44 | \r | |
| 45 | In summary, an AML object is described as:\r | |
| 46 | OpCode [SubOpcode] [PkgLen] [FixedArgs] [VarArgs]\r | |
| 47 | \r | |
| 48 | OpCode {1 byte}\r | |
| 49 | [SubOpCode] {1 byte.\r | |
| 50 | Only relevant if the OpCode value is\r | |
| 51 | 0x5B (extended OpCode prefix).\r | |
| 52 | Otherwise 0. Most objects don't have one.}\r | |
| 53 | [PkgLen] {Size of the object.\r | |
| 54 | It has a special encoding, cf. ACPI 6.3\r | |
| 55 | specification, s20.2.4 "Package Length\r | |
| 56 | Encoding".\r | |
| 57 | Most objects don't have one.}\r | |
| 58 | [FixedArgs[0..X]] {Fixed list of arguments.\r | |
| 59 | (where X <= 5) Can be other objects or data (a byte,\r | |
| 60 | a string, etc.). They belong to the\r | |
| 61 | current AML object.\r | |
| 62 | The number of fixed arguments varies according\r | |
| 63 | to the object, but it is fixed for each kind of\r | |
| 64 | object.}\r | |
| 65 | [VarArgs] {Variable list of arguments.\r | |
| 66 | They also belong to the current object and can\r | |
| 67 | be objects or data.\r | |
| 68 | Most objects don't have one.}\r | |
| 69 | [ByteList] {This is a sub-type of a variable list of\r | |
| 70 | arguments. It can only be found in buffer\r | |
| 71 | objects.\r | |
| 72 | A ByteList is either a list of bytes or\r | |
| 73 | a list of resource data elements. Resource\r | |
| 74 | data elements have specific opcodes.}\r | |
| 75 | [FieldList] {This is a sub-type of a variable list of\r | |
| 76 | arguments. It can only be found in Fields,\r | |
| 77 | IndexFields and BankFields.\r | |
| 78 | A FieldList is made of FieldElements.\r | |
| 79 | FieldElements have specific opcodes.}\r | |
| 80 | */\r | |
| 81 | GLOBAL_REMOVE_IF_UNREFERENCED\r | |
| 82 | STATIC\r | |
| 83 | CONST\r | |
| 731c67e1 | 84 | AML_BYTE_ENCODING mAmlByteEncoding[] = {\r |
| 8670a4ce | 85 | // Comment Str OpCode SubOpCode MaxIndex NameIndex 0 1 2 3 4 5 Attribute\r |
| 731c67e1 MK |
86 | /* 0x00 */ { AML_OPCODE_DEF ("ZeroOp", AML_ZERO_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r |
| 87 | /* 0x01 */ { AML_OPCODE_DEF ("OneOp", AML_ONE_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 88 | /* 0x06 */ { AML_OPCODE_DEF ("AliasOp", AML_ALIAS_OP), 0, 2, 1, { EAmlName, EAmlName, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 89 | /* 0x08 */ { AML_OPCODE_DEF ("NameOp", AML_NAME_OP), 0, 2, 0, { EAmlName, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 90 | /* 0x0A */ { AML_OPCODE_DEF ("BytePrefix", AML_BYTE_PREFIX), 0, 1, 0, { EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 91 | /* 0x0B */ { AML_OPCODE_DEF ("WordPrefix", AML_WORD_PREFIX), 0, 1, 0, { EAmlUInt16, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 92 | /* 0x0C */ { AML_OPCODE_DEF ("DWordPrefix", AML_DWORD_PREFIX), 0, 1, 0, { EAmlUInt32, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 93 | /* 0x0D */ { AML_OPCODE_DEF ("StringPrefix", AML_STRING_PREFIX), 0, 1, 0, { EAmlString, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 94 | /* 0x0E */ { AML_OPCODE_DEF ("QWordPrefix", AML_QWORD_PREFIX), 0, 1, 0, { EAmlUInt64, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 95 | /* 0x10 */ { AML_OPCODE_DEF ("ScopeOp", AML_SCOPE_OP), 0, 1, 0, { EAmlName, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ | AML_IN_NAMESPACE },\r | |
| 96 | /* 0x11 */ { AML_OPCODE_DEF ("BufferOp", AML_BUFFER_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_BYTE_LIST },\r | |
| 97 | /* 0x12 */ { AML_OPCODE_DEF ("PackageOp", AML_PACKAGE_OP), 0, 1, 0, { EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ },\r | |
| 98 | /* 0x13 */ { AML_OPCODE_DEF ("VarPackageOp", AML_VAR_PACKAGE_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ },\r | |
| 99 | /* 0x14 */ { AML_OPCODE_DEF ("MethodOp", AML_METHOD_OP), 0, 2, 0, { EAmlName, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ | AML_IN_NAMESPACE },\r | |
| 100 | /* 0x15 */ { AML_OPCODE_DEF ("ExternalOp", AML_EXTERNAL_OP), 0, 3, 0, { EAmlName, EAmlUInt8, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 101 | /* 0x2E */ { AML_OPCODE_DEF ("DualNamePrefix", AML_DUAL_NAME_PREFIX), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 102 | /* 0x2F */ { AML_OPCODE_DEF ("MultiNamePrefix", AML_MULTI_NAME_PREFIX), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 103 | /* 0x41 */ { AML_OPCODE_DEF ("NameChar_A", 'A'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 104 | /* 0x42 */ { AML_OPCODE_DEF ("NameChar_B", 'B'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 105 | /* 0x43 */ { AML_OPCODE_DEF ("NameChar_C", 'C'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 106 | /* 0x44 */ { AML_OPCODE_DEF ("NameChar_D", 'D'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 107 | /* 0x45 */ { AML_OPCODE_DEF ("NameChar_E", 'E'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 108 | /* 0x46 */ { AML_OPCODE_DEF ("NameChar_F", 'F'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 109 | /* 0x47 */ { AML_OPCODE_DEF ("NameChar_G", 'G'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 110 | /* 0x48 */ { AML_OPCODE_DEF ("NameChar_H", 'H'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 111 | /* 0x49 */ { AML_OPCODE_DEF ("NameChar_I", 'I'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 112 | /* 0x4A */ { AML_OPCODE_DEF ("NameChar_J", 'J'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 113 | /* 0x4B */ { AML_OPCODE_DEF ("NameChar_K", 'K'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 114 | /* 0x4C */ { AML_OPCODE_DEF ("NameChar_L", 'L'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 115 | /* 0x4D */ { AML_OPCODE_DEF ("NameChar_M", 'M'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 116 | /* 0x4E */ { AML_OPCODE_DEF ("NameChar_N", 'N'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 117 | /* 0x4F */ { AML_OPCODE_DEF ("NameChar_O", 'O'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 118 | /* 0x50 */ { AML_OPCODE_DEF ("NameChar_P", 'P'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 119 | /* 0x51 */ { AML_OPCODE_DEF ("NameChar_Q", 'Q'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 120 | /* 0x52 */ { AML_OPCODE_DEF ("NameChar_R", 'R'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 121 | /* 0x53 */ { AML_OPCODE_DEF ("NameChar_S", 'S'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 122 | /* 0x54 */ { AML_OPCODE_DEF ("NameChar_T", 'T'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 123 | /* 0x55 */ { AML_OPCODE_DEF ("NameChar_U", 'U'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 124 | /* 0x56 */ { AML_OPCODE_DEF ("NameChar_V", 'V'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 125 | /* 0x57 */ { AML_OPCODE_DEF ("NameChar_W", 'W'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 126 | /* 0x58 */ { AML_OPCODE_DEF ("NameChar_X", 'X'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 127 | /* 0x59 */ { AML_OPCODE_DEF ("NameChar_Y", 'Y'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 128 | /* 0x5A */ { AML_OPCODE_DEF ("NameChar_Z", 'Z'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 129 | /* 0x5B 0x01 */ { AML_OPCODE_DEF ("MutexOp", AML_EXT_OP), AML_EXT_MUTEX_OP, 2, 0, { EAmlName, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 130 | /* 0x5B 0x02 */ { AML_OPCODE_DEF ("EventOp", AML_EXT_OP), AML_EXT_EVENT_OP, 1, 0, { EAmlName, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 131 | /* 0x5B 0x12 */ { AML_OPCODE_DEF ("CondRefOfOp", AML_EXT_OP), AML_EXT_COND_REF_OF_OP, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 132 | /* 0x5B 0x13 */ { AML_OPCODE_DEF ("CreateFieldOp", AML_EXT_OP), AML_EXT_CREATE_FIELD_OP, 4, 3, { EAmlObject, EAmlObject, EAmlObject, EAmlName, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 133 | /* 0x5B 0x1F */ { AML_OPCODE_DEF ("LoadTableOp", AML_EXT_OP), AML_EXT_LOAD_TABLE_OP, 6, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlObject, EAmlObject, EAmlObject }, 0 },\r | |
| 134 | /* 0x5B 0x20 */ { AML_OPCODE_DEF ("LoadOp", AML_EXT_OP), AML_EXT_LOAD_OP, 2, 0, { EAmlName, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 135 | /* 0x5B 0x21 */ { AML_OPCODE_DEF ("StallOp", AML_EXT_OP), AML_EXT_STALL_OP, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 136 | /* 0x5B 0x22 */ { AML_OPCODE_DEF ("SleepOp", AML_EXT_OP), AML_EXT_SLEEP_OP, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 137 | /* 0x5B 0x23 */ { AML_OPCODE_DEF ("AcquireOp", AML_EXT_OP), AML_EXT_ACQUIRE_OP, 2, 0, { EAmlObject, EAmlUInt16, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 138 | /* 0x5B 0x24 */ { AML_OPCODE_DEF ("SignalOp", AML_EXT_OP), AML_EXT_SIGNAL_OP, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 139 | /* 0x5B 0x25 */ { AML_OPCODE_DEF ("WaitOp", AML_EXT_OP), AML_EXT_WAIT_OP, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 140 | /* 0x5B 0x26 */ { AML_OPCODE_DEF ("ResetOp", AML_EXT_OP), AML_EXT_RESET_OP, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 141 | /* 0x5B 0x27 */ { AML_OPCODE_DEF ("ReleaseOp", AML_EXT_OP), AML_EXT_RELEASE_OP, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 142 | /* 0x5B 0x28 */ { AML_OPCODE_DEF ("FromBCDOp", AML_EXT_OP), AML_EXT_FROM_BCD_OP, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 143 | /* 0x5B 0x29 */ { AML_OPCODE_DEF ("ToBCDOp", AML_EXT_OP), AML_EXT_TO_BCD_OP, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 144 | /* 0x5B 0x2A */ { AML_OPCODE_DEF ("UnloadOp", AML_EXT_OP), AML_EXT_UNLOAD_OP, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 145 | /* 0x5B 0x30 */ { AML_OPCODE_DEF ("RevisionOp", AML_EXT_OP), AML_EXT_REVISION_OP, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 146 | /* 0x5B 0x31 */ { AML_OPCODE_DEF ("DebugOp", AML_EXT_OP), AML_EXT_DEBUG_OP, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 147 | /* 0x5B 0x32 */ { AML_OPCODE_DEF ("FatalOp", AML_EXT_OP), AML_EXT_FATAL_OP, 3, 0, { EAmlUInt8, EAmlUInt32, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 148 | /* 0x5B 0x33 */ { AML_OPCODE_DEF ("TimerOp", AML_EXT_OP), AML_EXT_TIMER_OP, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 149 | /* 0x5B 0x80 */ { AML_OPCODE_DEF ("OpRegionOp", AML_EXT_OP), AML_EXT_REGION_OP, 4, 0, { EAmlName, EAmlUInt8, EAmlObject, EAmlObject, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 150 | /* 0x5B 0x81 */ { AML_OPCODE_DEF ("FieldOp", AML_EXT_OP), AML_EXT_FIELD_OP, 2, 0, { EAmlName, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_FIELD_LIST },\r | |
| 151 | /* 0x5B 0x82 */ { AML_OPCODE_DEF ("DeviceOp", AML_EXT_OP), AML_EXT_DEVICE_OP, 1, 0, { EAmlName, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ | AML_IN_NAMESPACE },\r | |
| 152 | /* 0x5B 0x83 */ { AML_OPCODE_DEF ("ProcessorOp", AML_EXT_OP), AML_EXT_PROCESSOR_OP, 4, 0, { EAmlName, EAmlUInt8, EAmlUInt32, EAmlUInt8, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ | AML_IN_NAMESPACE },\r | |
| 153 | /* 0x5B 0x84 */ { AML_OPCODE_DEF ("PowerResOp", AML_EXT_OP), AML_EXT_POWER_RES_OP, 3, 0, { EAmlName, EAmlUInt8, EAmlUInt16, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ | AML_IN_NAMESPACE },\r | |
| 154 | /* 0x5B 0x85 */ { AML_OPCODE_DEF ("ThermalZoneOp", AML_EXT_OP), AML_EXT_THERMAL_ZONE_OP, 1, 0, { EAmlName, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ | AML_IN_NAMESPACE },\r | |
| 155 | /* 0x5B 0x86 */ { AML_OPCODE_DEF ("IndexFieldOp", AML_EXT_OP), AML_EXT_INDEX_FIELD_OP, 3, 0, { EAmlName, EAmlName, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_FIELD_LIST },\r | |
| 156 | /* 0x5B 0x87 */ { AML_OPCODE_DEF ("BankFieldOp", AML_EXT_OP), AML_EXT_BANK_FIELD_OP, 4, 0, { EAmlName, EAmlName, EAmlObject, EAmlUInt8, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_FIELD_LIST },\r | |
| 157 | /* 0x5B 0x88 */ { AML_OPCODE_DEF ("DataRegionOp", AML_EXT_OP), AML_EXT_DATA_REGION_OP, 4, 0, { EAmlName, EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 158 | /* 0x5C */ { AML_OPCODE_DEF ("RootChar", AML_ROOT_CHAR), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 159 | /* 0x5E */ { AML_OPCODE_DEF ("ParentPrefixChar", AML_PARENT_PREFIX_CHAR), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 160 | /* 0x5F */ { AML_OPCODE_DEF ("NameChar", '_'), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_NAME_CHAR },\r | |
| 161 | /* 0x60 */ { AML_OPCODE_DEF ("Local0Op", AML_LOCAL0), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 162 | /* 0x61 */ { AML_OPCODE_DEF ("Local1Op", AML_LOCAL1), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 163 | /* 0x62 */ { AML_OPCODE_DEF ("Local2Op", AML_LOCAL2), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 164 | /* 0x63 */ { AML_OPCODE_DEF ("Local3Op", AML_LOCAL3), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 165 | /* 0x64 */ { AML_OPCODE_DEF ("Local4Op", AML_LOCAL4), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 166 | /* 0x65 */ { AML_OPCODE_DEF ("Local5Op", AML_LOCAL5), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 167 | /* 0x66 */ { AML_OPCODE_DEF ("Local6Op", AML_LOCAL6), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 168 | /* 0x67 */ { AML_OPCODE_DEF ("Local7Op", AML_LOCAL7), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 169 | /* 0x68 */ { AML_OPCODE_DEF ("Arg0Op", AML_ARG0), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 170 | /* 0x69 */ { AML_OPCODE_DEF ("Arg1Op", AML_ARG1), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 171 | /* 0x6A */ { AML_OPCODE_DEF ("Arg2Op", AML_ARG2), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 172 | /* 0x6B */ { AML_OPCODE_DEF ("Arg3Op", AML_ARG3), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 173 | /* 0x6C */ { AML_OPCODE_DEF ("Arg4Op", AML_ARG4), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 174 | /* 0x6D */ { AML_OPCODE_DEF ("Arg5Op", AML_ARG5), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 175 | /* 0x6E */ { AML_OPCODE_DEF ("Arg6Op", AML_ARG6), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 176 | /* 0x70 */ { AML_OPCODE_DEF ("StoreOp", AML_STORE_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 177 | /* 0x71 */ { AML_OPCODE_DEF ("RefOfOp", AML_REF_OF_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 178 | /* 0x72 */ { AML_OPCODE_DEF ("AddOp", AML_ADD_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 179 | /* 0x73 */ { AML_OPCODE_DEF ("ConcatOp", AML_CONCAT_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 180 | /* 0x74 */ { AML_OPCODE_DEF ("SubtractOp", AML_SUBTRACT_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 181 | /* 0x75 */ { AML_OPCODE_DEF ("IncrementOp", AML_INCREMENT_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 182 | /* 0x76 */ { AML_OPCODE_DEF ("DecrementOp", AML_DECREMENT_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 183 | /* 0x77 */ { AML_OPCODE_DEF ("MultiplyOp", AML_MULTIPLY_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 184 | /* 0x78 */ { AML_OPCODE_DEF ("DivideOp", AML_DIVIDE_OP), 0, 4, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone }, 0 },\r | |
| 185 | /* 0x79 */ { AML_OPCODE_DEF ("ShiftLeftOp", AML_SHIFT_LEFT_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 186 | /* 0x7A */ { AML_OPCODE_DEF ("ShiftRightOp", AML_SHIFT_RIGHT_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 187 | /* 0x7B */ { AML_OPCODE_DEF ("AndOp", AML_AND_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 188 | /* 0x7C */ { AML_OPCODE_DEF ("NAndOp", AML_NAND_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 189 | /* 0x7D */ { AML_OPCODE_DEF ("OrOp", AML_OR_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 190 | /* 0x7E */ { AML_OPCODE_DEF ("NorOp", AML_NOR_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 191 | /* 0x7F */ { AML_OPCODE_DEF ("XOrOp", AML_XOR_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 192 | /* 0x80 */ { AML_OPCODE_DEF ("NotOp", AML_NOT_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 193 | /* 0x81 */ { AML_OPCODE_DEF ("FindSetLeftBitOp", AML_FIND_SET_LEFT_BIT_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 194 | /* 0x82 */ { AML_OPCODE_DEF ("FindSetRightBitOp", AML_FIND_SET_RIGHT_BIT_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 195 | /* 0x83 */ { AML_OPCODE_DEF ("DerefOfOp", AML_DEREF_OF_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 196 | /* 0x84 */ { AML_OPCODE_DEF ("ConcatResOp", AML_CONCAT_RES_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 197 | /* 0x85 */ { AML_OPCODE_DEF ("ModOp", AML_MOD_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 198 | /* 0x86 */ { AML_OPCODE_DEF ("NotifyOp", AML_NOTIFY_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 199 | /* 0x87 */ { AML_OPCODE_DEF ("SizeOfOp", AML_SIZE_OF_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 200 | /* 0x88 */ { AML_OPCODE_DEF ("IndexOp", AML_INDEX_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 201 | /* 0x89 */ { AML_OPCODE_DEF ("MatchOp", AML_MATCH_OP), 0, 6, 0, { EAmlObject, EAmlUInt8, EAmlObject, EAmlUInt8, EAmlObject, EAmlObject }, 0 },\r | |
| 202 | /* 0x8A */ { AML_OPCODE_DEF ("CreateDWordFieldOp", AML_CREATE_DWORD_FIELD_OP), 0, 3, 2, { EAmlObject, EAmlObject, EAmlName, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 203 | /* 0x8B */ { AML_OPCODE_DEF ("CreateWordFieldOp", AML_CREATE_WORD_FIELD_OP), 0, 3, 2, { EAmlObject, EAmlObject, EAmlName, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 204 | /* 0x8C */ { AML_OPCODE_DEF ("CreateByteFieldOp", AML_CREATE_BYTE_FIELD_OP), 0, 3, 2, { EAmlObject, EAmlObject, EAmlName, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 205 | /* 0x8D */ { AML_OPCODE_DEF ("CreateBitFieldOp", AML_CREATE_BIT_FIELD_OP), 0, 3, 2, { EAmlObject, EAmlObject, EAmlName, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 206 | /* 0x8E */ { AML_OPCODE_DEF ("ObjectTypeOp", AML_OBJECT_TYPE_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 207 | /* 0x8F */ { AML_OPCODE_DEF ("CreateQWordFieldOp", AML_CREATE_QWORD_FIELD_OP), 0, 3, 2, { EAmlObject, EAmlObject, EAmlName, EAmlNone, EAmlNone, EAmlNone }, AML_IN_NAMESPACE },\r | |
| 208 | /* 0x90 */ { AML_OPCODE_DEF ("LAndOp", AML_LAND_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 209 | /* 0x91 */ { AML_OPCODE_DEF ("LOrOp", AML_LOR_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 210 | /* 0x92 */ { AML_OPCODE_DEF ("LNotOp", AML_LNOT_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 211 | /* 0x93 */ { AML_OPCODE_DEF ("LEqualOp", AML_LEQUAL_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 212 | /* 0x94 */ { AML_OPCODE_DEF ("LGreaterOp", AML_LGREATER_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 213 | /* 0x95 */ { AML_OPCODE_DEF ("LLessOp", AML_LLESS_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 214 | /* 0x96 */ { AML_OPCODE_DEF ("ToBufferOp", AML_TO_BUFFER_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 215 | /* 0x97 */ { AML_OPCODE_DEF ("ToDecimalStringOp", AML_TO_DEC_STRING_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 216 | /* 0x98 */ { AML_OPCODE_DEF ("ToHexStringOp", AML_TO_HEX_STRING_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 217 | /* 0x99 */ { AML_OPCODE_DEF ("ToIntegerOp", AML_TO_INTEGER_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 218 | /* 0x9C */ { AML_OPCODE_DEF ("ToStringOp", AML_TO_STRING_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 219 | /* 0x9D */ { AML_OPCODE_DEF ("CopyObjectOp", AML_COPY_OBJECT_OP), 0, 2, 0, { EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 220 | /* 0x9E */ { AML_OPCODE_DEF ("MidOp", AML_MID_OP), 0, 3, 0, { EAmlObject, EAmlObject, EAmlObject, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 221 | /* 0x9F */ { AML_OPCODE_DEF ("ContinueOp", AML_CONTINUE_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 222 | /* 0xA0 */ { AML_OPCODE_DEF ("IfOp", AML_IF_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ },\r | |
| 223 | /* 0xA1 */ { AML_OPCODE_DEF ("ElseOp", AML_ELSE_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ },\r | |
| 224 | /* 0xA2 */ { AML_OPCODE_DEF ("WhileOp", AML_WHILE_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_HAS_PKG_LENGTH | AML_HAS_CHILD_OBJ },\r | |
| 225 | /* 0xA3 */ { AML_OPCODE_DEF ("NoopOp", AML_NOOP_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 226 | /* 0xA4 */ { AML_OPCODE_DEF ("ReturnOp", AML_RETURN_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 227 | /* 0xA5 */ { AML_OPCODE_DEF ("BreakOp", AML_BREAK_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 228 | /* 0xCC */ { AML_OPCODE_DEF ("BreakPointOp", AML_BREAK_POINT_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 229 | /* 0xD0 */ { AML_OPCODE_DEF ("MethodInvocOp", AML_METHOD_INVOC_OP), 0, 2, 0, { EAmlName, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_PSEUDO_OPCODE | AML_HAS_CHILD_OBJ },\r | |
| 230 | /* 0xFF */ { AML_OPCODE_DEF ("OnesOp", AML_ONES_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, 0 },\r | |
| 98f28081 PG |
231 | };\r |
| 232 | \r | |
| 233 | /** AML grammar encoding for field elements.\r | |
| 234 | \r | |
| 235 | Some AML objects are expecting a FieldList. They are referred in this library\r | |
| 236 | as field nodes. These objects have the following opcodes:\r | |
| 237 | - FieldOp;\r | |
| 238 | - IndexFieldOp;\r | |
| 239 | - BankFieldOp.\r | |
| 240 | In the AML grammar encoding table, they have the AML_HAS_FIELD_LIST\r | |
| 241 | attribute.\r | |
| 242 | \r | |
| 243 | A field list is made of field elements.\r | |
| 244 | According to the ACPI 6.3 specification, s20.2.5.2 "Named Objects Encoding",\r | |
| 245 | field elements can be:\r | |
| 246 | - NamedField := NameSeg PkgLength;\r | |
| 247 | - ReservedField := 0x00 PkgLength;\r | |
| 248 | - AccessField := 0x01 AccessType AccessAttrib;\r | |
| 249 | - ConnectField := <0x02 NameString> | <0x02 BufferData>;\r | |
| 250 | - ExtendedAccessField := 0x03 AccessType ExtendedAccessAttrib AccessLength.\r | |
| 251 | \r | |
| 252 | A small set of opcodes describes field elements. They are referred in this\r | |
| 253 | library as field opcodes.\r | |
| 254 | The NamedField field element doesn't have a field opcode. A pseudo\r | |
| 255 | OpCode/SubOpCode couple has been created for it.\r | |
| 256 | \r | |
| 257 | Field elements:\r | |
| 258 | - don't have a SubOpCode;\r | |
| 259 | - have at most 3 fixed arguments (6 for object opcodes,\r | |
| 260 | 8 for method invocations);\r | |
| 261 | - don't have variable list of arguments;\r | |
| 262 | - are not part of the AML namespace, except NamedField field elements.\r | |
| 263 | */\r | |
| 264 | GLOBAL_REMOVE_IF_UNREFERENCED\r | |
| 265 | STATIC\r | |
| 266 | CONST\r | |
| 731c67e1 | 267 | AML_BYTE_ENCODING mAmlFieldEncoding[] = {\r |
| 8670a4ce | 268 | // Comment Str OpCode SubOpCode MaxIndex NameIndex 0 1 2 3 4 5 Attribute\r |
| 731c67e1 MK |
269 | /* 0x00 */ { AML_OPCODE_DEF ("FieldReservedOp", AML_FIELD_RESERVED_OP), 0, 0, 0, { EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_FIELD_ELEMENT | AML_HAS_PKG_LENGTH },\r |
| 270 | /* 0x01 */ { AML_OPCODE_DEF ("FieldAccessOp", AML_FIELD_ACCESS_OP), 0, 2, 0, { EAmlUInt8, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_FIELD_ELEMENT },\r | |
| 271 | /* 0x02 */ { AML_OPCODE_DEF ("FieldConnectionOp", AML_FIELD_CONNECTION_OP), 0, 1, 0, { EAmlObject, EAmlNone, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_FIELD_ELEMENT },\r | |
| 272 | /* 0x03 */ { AML_OPCODE_DEF ("FieldExtAccessOp", AML_FIELD_EXT_ACCESS_OP), 0, 3, 0, { EAmlUInt8, EAmlUInt8, EAmlUInt8, EAmlNone, EAmlNone, EAmlNone }, AML_IS_FIELD_ELEMENT },\r | |
| 273 | /* 0x04 */ { AML_OPCODE_DEF ("FieldNamed", AML_FIELD_NAMED_OP), 0, 2, 0, { EAmlName, EAmlFieldPkgLen, EAmlNone, EAmlNone, EAmlNone, EAmlNone }, AML_IS_FIELD_ELEMENT | AML_IS_PSEUDO_OPCODE | AML_IN_NAMESPACE }\r | |
| 98f28081 PG |
274 | };\r |
| 275 | \r | |
| 276 | /** Get the AML_BYTE_ENCODING entry in the AML encoding table.\r | |
| 277 | \r | |
| 278 | Note: For Pseudo OpCodes this function returns NULL.\r | |
| 279 | \r | |
| 280 | @param [in] Buffer Pointer to an OpCode/SubOpCode couple.\r | |
| 281 | If *Buffer = 0x5b (extended OpCode),\r | |
| 282 | Buffer must be at least two bytes long.\r | |
| 283 | \r | |
| 284 | @return The corresponding AML_BYTE_ENCODING entry.\r | |
| 285 | NULL if not found.\r | |
| 286 | **/\r | |
| 287 | CONST\r | |
| 288 | AML_BYTE_ENCODING *\r | |
| 289 | EFIAPI\r | |
| 290 | AmlGetByteEncoding (\r | |
| 731c67e1 | 291 | IN CONST UINT8 *Buffer\r |
| 98f28081 PG |
292 | )\r |
| 293 | {\r | |
| 731c67e1 MK |
294 | UINT8 OpCode;\r |
| 295 | UINT8 SubOpCode;\r | |
| 296 | UINT32 Index;\r | |
| 98f28081 PG |
297 | \r |
| 298 | if (Buffer == NULL) {\r | |
| 299 | ASSERT (0);\r | |
| 300 | return NULL;\r | |
| 301 | }\r | |
| 302 | \r | |
| 303 | // Get OpCode and SubOpCode.\r | |
| 304 | OpCode = Buffer[0];\r | |
| 305 | if (OpCode == AML_EXT_OP) {\r | |
| 306 | SubOpCode = Buffer[1];\r | |
| 307 | } else {\r | |
| 308 | SubOpCode = 0;\r | |
| 309 | }\r | |
| 310 | \r | |
| 311 | // Search the table.\r | |
| 312 | for (Index = 0;\r | |
| 313 | Index < (sizeof (mAmlByteEncoding) / sizeof (mAmlByteEncoding[0]));\r | |
| 731c67e1 MK |
314 | Index++)\r |
| 315 | {\r | |
| 98f28081 | 316 | if ((mAmlByteEncoding[Index].OpCode == OpCode) &&\r |
| 731c67e1 MK |
317 | (mAmlByteEncoding[Index].SubOpCode == SubOpCode))\r |
| 318 | {\r | |
| 319 | if ((mAmlByteEncoding[Index].Attribute & AML_IS_PSEUDO_OPCODE) ==\r | |
| 320 | AML_IS_PSEUDO_OPCODE)\r | |
| 321 | {\r | |
| 98f28081 PG |
322 | // A pseudo OpCode cannot be parsed as it is internal to this library.\r |
| 323 | // The MethodInvocation encoding can be detected by NameSpace lookup.\r | |
| 324 | ASSERT (0);\r | |
| 325 | return NULL;\r | |
| 326 | }\r | |
| 731c67e1 | 327 | \r |
| 98f28081 PG |
328 | return &mAmlByteEncoding[Index];\r |
| 329 | }\r | |
| 330 | }\r | |
| 331 | \r | |
| 332 | return NULL;\r | |
| 333 | }\r | |
| 334 | \r | |
| 335 | /** Get the AML_BYTE_ENCODING entry in the AML encoding table\r | |
| 336 | by providing an OpCode/SubOpCode couple.\r | |
| 337 | \r | |
| 338 | @param [in] OpCode OpCode.\r | |
| 339 | @param [in] SubOpCode SubOpCode.\r | |
| 340 | \r | |
| 341 | @return The corresponding AML_BYTE_ENCODING entry.\r | |
| 342 | NULL if not found.\r | |
| 343 | **/\r | |
| 344 | CONST\r | |
| 345 | AML_BYTE_ENCODING *\r | |
| 346 | EFIAPI\r | |
| 347 | AmlGetByteEncodingByOpCode (\r | |
| 731c67e1 MK |
348 | IN UINT8 OpCode,\r |
| 349 | IN UINT8 SubOpCode\r | |
| 98f28081 PG |
350 | )\r |
| 351 | {\r | |
| 731c67e1 | 352 | UINT32 Index;\r |
| 98f28081 PG |
353 | \r |
| 354 | // Search the table.\r | |
| 355 | for (Index = 0;\r | |
| 356 | Index < (sizeof (mAmlByteEncoding) / sizeof (mAmlByteEncoding[0]));\r | |
| 731c67e1 MK |
357 | Index++)\r |
| 358 | {\r | |
| 98f28081 | 359 | if ((mAmlByteEncoding[Index].OpCode == OpCode) &&\r |
| 731c67e1 MK |
360 | (mAmlByteEncoding[Index].SubOpCode == SubOpCode))\r |
| 361 | {\r | |
| 98f28081 PG |
362 | return &mAmlByteEncoding[Index];\r |
| 363 | }\r | |
| 364 | }\r | |
| 731c67e1 | 365 | \r |
| 98f28081 PG |
366 | return NULL;\r |
| 367 | }\r | |
| 368 | \r | |
| 369 | /** Get the AML_BYTE_ENCODING entry in the field encoding table.\r | |
| 370 | \r | |
| 371 | Note: For Pseudo OpCodes this function returns NULL.\r | |
| 372 | \r | |
| 373 | @param [in] Buffer Pointer to a field OpCode.\r | |
| 374 | No SubOpCode is expected.\r | |
| 375 | \r | |
| 376 | @return The corresponding AML_BYTE_ENCODING entry\r | |
| 377 | in the field encoding table.\r | |
| 378 | NULL if not found.\r | |
| 379 | **/\r | |
| 380 | CONST\r | |
| 381 | AML_BYTE_ENCODING *\r | |
| 382 | EFIAPI\r | |
| 383 | AmlGetFieldEncoding (\r | |
| 731c67e1 | 384 | IN CONST UINT8 *Buffer\r |
| 98f28081 PG |
385 | )\r |
| 386 | {\r | |
| 731c67e1 MK |
387 | UINT8 OpCode;\r |
| 388 | UINT32 Index;\r | |
| 98f28081 PG |
389 | \r |
| 390 | if (Buffer == NULL) {\r | |
| 391 | ASSERT (0);\r | |
| 392 | return NULL;\r | |
| 393 | }\r | |
| 394 | \r | |
| 395 | // Get OpCode.\r | |
| 396 | OpCode = *Buffer;\r | |
| 397 | \r | |
| 398 | // Search in the table.\r | |
| 399 | for (Index = 0;\r | |
| 400 | Index < (sizeof (mAmlFieldEncoding) / sizeof (mAmlFieldEncoding[0]));\r | |
| 731c67e1 MK |
401 | Index++)\r |
| 402 | {\r | |
| 98f28081 PG |
403 | if (mAmlFieldEncoding[Index].OpCode == OpCode) {\r |
| 404 | if ((mAmlFieldEncoding[Index].Attribute & AML_IS_PSEUDO_OPCODE) ==\r | |
| 731c67e1 MK |
405 | AML_IS_PSEUDO_OPCODE)\r |
| 406 | {\r | |
| 98f28081 PG |
407 | // A pseudo OpCode cannot be parsed as it is internal to this library.\r |
| 408 | // The NamedField encoding can be detected because it begins with a\r | |
| 409 | // char.\r | |
| 410 | ASSERT (0);\r | |
| 411 | return NULL;\r | |
| 412 | }\r | |
| 731c67e1 | 413 | \r |
| 98f28081 PG |
414 | return &mAmlFieldEncoding[Index];\r |
| 415 | }\r | |
| 416 | }\r | |
| 417 | \r | |
| 418 | return NULL;\r | |
| 419 | }\r | |
| 420 | \r | |
| 421 | /** Get the AML_BYTE_ENCODING entry in the field encoding table\r | |
| 422 | by providing an OpCode/SubOpCode couple.\r | |
| 423 | \r | |
| 424 | @param [in] OpCode OpCode.\r | |
| 425 | @param [in] SubOpCode SubOpCode.\r | |
| 426 | \r | |
| 427 | @return The corresponding AML_BYTE_ENCODING entry\r | |
| 428 | in the field encoding table.\r | |
| 429 | NULL if not found.\r | |
| 430 | **/\r | |
| 431 | CONST\r | |
| 432 | AML_BYTE_ENCODING *\r | |
| 433 | EFIAPI\r | |
| 434 | AmlGetFieldEncodingByOpCode (\r | |
| 731c67e1 MK |
435 | IN UINT8 OpCode,\r |
| 436 | IN UINT8 SubOpCode\r | |
| 98f28081 PG |
437 | )\r |
| 438 | {\r | |
| 731c67e1 | 439 | UINT32 Index;\r |
| 98f28081 PG |
440 | \r |
| 441 | // Search the table.\r | |
| 442 | for (Index = 0;\r | |
| 443 | Index < (sizeof (mAmlFieldEncoding) / sizeof (mAmlFieldEncoding[0]));\r | |
| 731c67e1 MK |
444 | Index++)\r |
| 445 | {\r | |
| 98f28081 | 446 | if ((mAmlFieldEncoding[Index].OpCode == OpCode) &&\r |
| 731c67e1 MK |
447 | (mAmlFieldEncoding[Index].SubOpCode == SubOpCode))\r |
| 448 | {\r | |
| 98f28081 PG |
449 | return &mAmlFieldEncoding[Index];\r |
| 450 | }\r | |
| 451 | }\r | |
| 731c67e1 | 452 | \r |
| 98f28081 PG |
453 | return NULL;\r |
| 454 | }\r | |
| 455 | \r | |
| 456 | // Enable this function for debug.\r | |
| 457 | #if !defined (MDEPKG_NDEBUG)\r | |
| 731c67e1 | 458 | \r |
| 98f28081 PG |
459 | /** Look for an OpCode/SubOpCode couple in the AML grammar,\r |
| 460 | and return a corresponding string.\r | |
| 461 | \r | |
| 462 | @param [in] OpCode The OpCode.\r | |
| 463 | @param [in] SubOpCode The SubOpCode.\r | |
| 464 | \r | |
| 465 | @return A string describing the OpCode/SubOpCode couple.\r | |
| 466 | NULL if not found.\r | |
| 467 | **/\r | |
| 468 | CONST\r | |
| 469 | CHAR8 *\r | |
| 470 | AmlGetOpCodeStr (\r | |
| 731c67e1 MK |
471 | IN UINT8 OpCode,\r |
| 472 | IN UINT8 SubOpCode\r | |
| 98f28081 PG |
473 | )\r |
| 474 | {\r | |
| 475 | EAML_PARSE_INDEX Index;\r | |
| 476 | \r | |
| 477 | // Search the table.\r | |
| 478 | for (Index = 0;\r | |
| 479 | Index < (sizeof (mAmlByteEncoding) / sizeof (mAmlByteEncoding[0]));\r | |
| 731c67e1 MK |
480 | Index++)\r |
| 481 | {\r | |
| 98f28081 | 482 | if ((mAmlByteEncoding[Index].OpCode == OpCode) &&\r |
| 731c67e1 MK |
483 | (mAmlByteEncoding[Index].SubOpCode == SubOpCode))\r |
| 484 | {\r | |
| 98f28081 PG |
485 | return mAmlByteEncoding[Index].Str;\r |
| 486 | }\r | |
| 487 | }\r | |
| 488 | \r | |
| 489 | ASSERT (0);\r | |
| 490 | return NULL;\r | |
| 491 | }\r | |
| 492 | \r | |
| 493 | /** Look for an OpCode/SubOpCode couple in the AML field element grammar,\r | |
| 494 | and return a corresponding string.\r | |
| 495 | \r | |
| 496 | @param [in] OpCode The OpCode.\r | |
| 497 | @param [in] SubOpCode The SubOpCode. Must be zero.\r | |
| 498 | \r | |
| 499 | @return A string describing the OpCode/SubOpCode couple.\r | |
| 500 | NULL if not found.\r | |
| 501 | **/\r | |
| 502 | CONST\r | |
| 503 | CHAR8 *\r | |
| 504 | AmlGetFieldOpCodeStr (\r | |
| 731c67e1 MK |
505 | IN UINT8 OpCode,\r |
| 506 | IN UINT8 SubOpCode\r | |
| 98f28081 PG |
507 | )\r |
| 508 | {\r | |
| 509 | EAML_PARSE_INDEX Index;\r | |
| 510 | \r | |
| 511 | if (SubOpCode != 0) {\r | |
| 512 | ASSERT (0);\r | |
| 513 | return NULL;\r | |
| 514 | }\r | |
| 515 | \r | |
| 516 | // Search the table.\r | |
| 517 | for (Index = 0;\r | |
| 518 | Index < (sizeof (mAmlFieldEncoding) / sizeof (mAmlFieldEncoding[0]));\r | |
| 731c67e1 MK |
519 | Index++)\r |
| 520 | {\r | |
| 98f28081 PG |
521 | if ((mAmlFieldEncoding[Index].OpCode == OpCode)) {\r |
| 522 | return mAmlFieldEncoding[Index].Str;\r | |
| 523 | }\r | |
| 524 | }\r | |
| 525 | \r | |
| 526 | ASSERT (0);\r | |
| 527 | return NULL;\r | |
| 528 | }\r | |
| 731c67e1 | 529 | \r |
| 98f28081 PG |
530 | #endif // MDEPKG_NDEBUG\r |
| 531 | \r | |
| 532 | /** Check whether the OpCode/SubOpcode couple is a valid entry\r | |
| 533 | in the AML grammar encoding table.\r | |
| 534 | \r | |
| 535 | @param [in] OpCode OpCode to check.\r | |
| 536 | @param [in] SubOpCode SubOpCode to check.\r | |
| 537 | \r | |
| 538 | @retval TRUE The OpCode/SubOpCode couple is valid.\r | |
| 539 | @retval FALSE Otherwise.\r | |
| 540 | **/\r | |
| 541 | BOOLEAN\r | |
| 542 | EFIAPI\r | |
| 543 | AmlIsOpCodeValid (\r | |
| 731c67e1 MK |
544 | IN UINT8 OpCode,\r |
| 545 | IN UINT8 SubOpCode\r | |
| 98f28081 PG |
546 | )\r |
| 547 | {\r | |
| 548 | EAML_PARSE_INDEX Index;\r | |
| 549 | \r | |
| 550 | // Search the table.\r | |
| 551 | for (Index = 0;\r | |
| 552 | Index < (sizeof (mAmlByteEncoding) / sizeof (mAmlByteEncoding[0]));\r | |
| 731c67e1 MK |
553 | Index++)\r |
| 554 | {\r | |
| 98f28081 | 555 | if ((mAmlByteEncoding[Index].OpCode == OpCode) &&\r |
| 731c67e1 MK |
556 | (mAmlByteEncoding[Index].SubOpCode == SubOpCode))\r |
| 557 | {\r | |
| 98f28081 PG |
558 | return TRUE;\r |
| 559 | }\r | |
| 560 | }\r | |
| 731c67e1 | 561 | \r |
| 98f28081 PG |
562 | return FALSE;\r |
| 563 | }\r | |
| 564 | \r | |
| 565 | /** AML_PARSE_FORMAT to EAML_NODE_DATA_TYPE translation table.\r | |
| 566 | \r | |
| 567 | AML_PARSE_FORMAT describes an internal set of values identifying the types\r | |
| 568 | that can be found while parsing an AML bytestream.\r | |
| 569 | EAML_NODE_DATA_TYPE describes an external set of values allowing to identify\r | |
| 570 | what type of data can be found in data nodes.\r | |
| 571 | */\r | |
| 572 | GLOBAL_REMOVE_IF_UNREFERENCED\r | |
| 573 | STATIC\r | |
| 574 | CONST\r | |
| 731c67e1 | 575 | EAML_NODE_DATA_TYPE mAmlTypeToNodeDataType[] = {\r |
| 98f28081 PG |
576 | EAmlNodeDataTypeNone, // EAmlNone\r |
| 577 | EAmlNodeDataTypeUInt, // EAmlUInt8\r | |
| 578 | EAmlNodeDataTypeUInt, // EAmlUInt16\r | |
| 579 | EAmlNodeDataTypeUInt, // EAmlUInt32\r | |
| 580 | EAmlNodeDataTypeUInt, // EAmlUInt64\r | |
| 581 | EAmlNodeDataTypeReserved5, // EAmlObject\r | |
| 582 | EAmlNodeDataTypeNameString, // EAmlName\r | |
| 583 | EAmlNodeDataTypeString, // EAmlString\r | |
| 584 | EAmlNodeDataTypeFieldPkgLen // EAmlFieldPkgLen\r | |
| 585 | };\r | |
| 586 | \r | |
| 587 | /** Convert an AML_PARSE_FORMAT to its corresponding EAML_NODE_DATA_TYPE.\r | |
| 588 | \r | |
| 589 | @param [in] AmlType Input AML Type.\r | |
| 590 | \r | |
| 591 | @return The corresponding EAML_NODE_DATA_TYPE.\r | |
| 592 | EAmlNodeDataTypeNone if not found.\r | |
| 593 | **/\r | |
| 594 | EAML_NODE_DATA_TYPE\r | |
| 595 | EFIAPI\r | |
| 596 | AmlTypeToNodeDataType (\r | |
| 597 | IN AML_PARSE_FORMAT AmlType\r | |
| 598 | )\r | |
| 599 | {\r | |
| 600 | if (AmlType >=\r | |
| 731c67e1 MK |
601 | (sizeof (mAmlTypeToNodeDataType) / sizeof (mAmlTypeToNodeDataType[0])))\r |
| 602 | {\r | |
| 98f28081 PG |
603 | ASSERT (0);\r |
| 604 | return EAmlNodeDataTypeNone;\r | |
| 605 | }\r | |
| 606 | \r | |
| 607 | return mAmlTypeToNodeDataType[AmlType];\r | |
| 608 | }\r | |
| 609 | \r | |
| 610 | /** Get the package length from the buffer.\r | |
| 611 | \r | |
| 612 | @param [in] Buffer AML buffer.\r | |
| 613 | @param [out] PkgLength The interpreted PkgLen value.\r | |
| 614 | Length cannot exceed 2^28.\r | |
| 615 | \r | |
| 616 | @return The number of bytes to represent the package length.\r | |
| 617 | 0 if an issue occurred.\r | |
| 618 | **/\r | |
| 619 | UINT32\r | |
| 620 | EFIAPI\r | |
| 621 | AmlGetPkgLength (\r | |
| 731c67e1 MK |
622 | IN CONST UINT8 *Buffer,\r |
| 623 | OUT UINT32 *PkgLength\r | |
| 98f28081 PG |
624 | )\r |
| 625 | {\r | |
| 731c67e1 MK |
626 | UINT8 LeadByte;\r |
| 627 | UINT8 ByteCount;\r | |
| 628 | UINT32 RealLength;\r | |
| 629 | UINT32 Offset;\r | |
| 98f28081 PG |
630 | \r |
| 631 | if ((Buffer == NULL) ||\r | |
| 731c67e1 MK |
632 | (PkgLength == NULL))\r |
| 633 | {\r | |
| 98f28081 PG |
634 | ASSERT (0);\r |
| 635 | return 0;\r | |
| 636 | }\r | |
| 637 | \r | |
| 638 | /* From ACPI 6.3 specification, s20.2.4 "Package Length Encoding":\r | |
| 639 | \r | |
| 640 | PkgLength := PkgLeadByte |\r | |
| 641 | <PkgLeadByte ByteData> |\r | |
| 642 | <PkgLeadByte ByteData ByteData> |\r | |
| 643 | <PkgLeadByte ByteData ByteData ByteData>\r | |
| 644 | \r | |
| 645 | PkgLeadByte := <bit 7-6: ByteData count that follows (0-3)>\r | |
| 646 | <bit 5-4: Only used if PkgLength < 63>\r | |
| 647 | <bit 3-0: Least significant package length nibble>\r | |
| 648 | \r | |
| 649 | Note:\r | |
| 650 | The high 2 bits of the first byte reveal how many\r | |
| 651 | follow bytes are in the PkgLength. If the\r | |
| 652 | PkgLength has only one byte, bit 0 through 5 are\r | |
| 653 | used to encode the package length (in other\r | |
| 654 | words, values 0-63). If the package length value\r | |
| 655 | is more than 63, more than one byte must be\r | |
| 656 | used for the encoding in which case bit 4 and 5 of\r | |
| 657 | the PkgLeadByte are reserved and must be zero.\r | |
| 658 | If the multiple bytes encoding is used, bits 0-3 of\r | |
| 659 | the PkgLeadByte become the least significant 4\r | |
| 660 | bits of the resulting package length value. The next\r | |
| 661 | ByteData will become the next least\r | |
| 662 | significant 8 bits of the resulting value and so on,\r | |
| 663 | up to 3 ByteData bytes. Thus, the maximum\r | |
| 664 | package length is 2**28.\r | |
| 665 | */\r | |
| 666 | \r | |
| 731c67e1 MK |
667 | LeadByte = *Buffer;\r |
| 668 | ByteCount = (LeadByte >> 6) & 0x03U;\r | |
| 669 | Offset = ByteCount + 1U;\r | |
| 98f28081 PG |
670 | RealLength = 0;\r |
| 671 | \r | |
| 672 | // Switch on the number of bytes used to store the PkgLen.\r | |
| 673 | switch (ByteCount) {\r | |
| 674 | case 0:\r | |
| 675 | {\r | |
| 676 | RealLength = LeadByte;\r | |
| 677 | break;\r | |
| 678 | }\r | |
| 679 | case 1:\r | |
| 680 | {\r | |
| 681 | RealLength = *(Buffer + 1);\r | |
| 682 | RealLength = (RealLength << 4) | (LeadByte & 0xF);\r | |
| 683 | break;\r | |
| 684 | }\r | |
| 685 | case 2:\r | |
| 686 | {\r | |
| 731c67e1 | 687 | RealLength = *(Buffer + 1);\r |
| 98f28081 | 688 | RealLength |= ((UINT32)(*(Buffer + 2))) << 8;\r |
| 731c67e1 | 689 | RealLength = (RealLength << 4) | (LeadByte & 0xF);\r |
| 98f28081 PG |
690 | break;\r |
| 691 | }\r | |
| 692 | case 3:\r | |
| 693 | {\r | |
| 731c67e1 | 694 | RealLength = *(Buffer + 1);\r |
| 98f28081 PG |
695 | RealLength |= ((UINT32)(*(Buffer + 2))) << 8;\r |
| 696 | RealLength |= ((UINT32)(*(Buffer + 3))) << 16;\r | |
| 731c67e1 | 697 | RealLength = (RealLength << 4) | (LeadByte & 0xF);\r |
| 98f28081 PG |
698 | break;\r |
| 699 | }\r | |
| 700 | default:\r | |
| 701 | {\r | |
| 702 | ASSERT (0);\r | |
| 703 | Offset = 0;\r | |
| 704 | break;\r | |
| 705 | }\r | |
| 706 | } // switch\r | |
| 707 | \r | |
| 708 | *PkgLength = RealLength;\r | |
| 709 | \r | |
| 710 | return Offset;\r | |
| 711 | }\r | |
| 712 | \r | |
| 713 | /** Convert the Length to the AML PkgLen encoding,\r | |
| 714 | then and write it in the Buffer.\r | |
| 715 | \r | |
| 716 | @param [in] Length Length to convert.\r | |
| 717 | Length cannot exceed 2^28.\r | |
| 718 | @param [out] Buffer Write the result in this Buffer.\r | |
| 719 | \r | |
| 720 | @return The number of bytes used to write the Length.\r | |
| 721 | **/\r | |
| 722 | UINT8\r | |
| 723 | EFIAPI\r | |
| 724 | AmlSetPkgLength (\r | |
| 731c67e1 MK |
725 | IN UINT32 Length,\r |
| 726 | OUT UINT8 *Buffer\r | |
| 98f28081 PG |
727 | )\r |
| 728 | {\r | |
| 729 | UINT8 LeadByte;\r | |
| 730 | UINT8 Offset;\r | |
| 731 | UINT8 CurrentOffset;\r | |
| 732 | UINT8 CurrentShift;\r | |
| 733 | UINT32 ComputedLength;\r | |
| 734 | \r | |
| 735 | if (Buffer == NULL) {\r | |
| 736 | ASSERT (0);\r | |
| 737 | return 0;\r | |
| 738 | }\r | |
| 739 | \r | |
| 740 | LeadByte = 0;\r | |
| 731c67e1 | 741 | Offset = 0;\r |
| 98f28081 PG |
742 | \r |
| 743 | if ((Length < (1 << 6))) {\r | |
| 744 | // Length < 2^6, only need one byte to encode it.\r | |
| 745 | LeadByte = (UINT8)Length;\r | |
| 98f28081 PG |
746 | } else {\r |
| 747 | // Need more than one byte to encode it.\r | |
| 748 | // Test Length to find how many bytes are needed.\r | |
| 749 | \r | |
| 750 | if (Length >= (1 << 28)) {\r | |
| 751 | // Length >= 2^28, should not be possible.\r | |
| 752 | ASSERT (0);\r | |
| 753 | return 0;\r | |
| 98f28081 PG |
754 | } else if (Length >= (1 << 20)) {\r |
| 755 | // Length >= 2^20\r | |
| 756 | Offset = 3;\r | |
| 98f28081 PG |
757 | } else if (Length >= (1 << 12)) {\r |
| 758 | // Length >= 2^12\r | |
| 759 | Offset = 2;\r | |
| 98f28081 PG |
760 | } else if (Length >= (1 << 6)) {\r |
| 761 | // Length >= 2^6\r | |
| 762 | Offset = 1;\r | |
| 98f28081 PG |
763 | } else {\r |
| 764 | // Should not be possible.\r | |
| 765 | ASSERT (0);\r | |
| 766 | return 0;\r | |
| 767 | }\r | |
| 768 | \r | |
| 769 | // Set the LeadByte.\r | |
| 770 | LeadByte = (UINT8)(Offset << 6);\r | |
| 771 | LeadByte = (UINT8)(LeadByte | (Length & 0xF));\r | |
| 772 | }\r | |
| 773 | \r | |
| 774 | // Write to the Buffer.\r | |
| 731c67e1 | 775 | *Buffer = LeadByte;\r |
| 98f28081 PG |
776 | CurrentOffset = 1;\r |
| 777 | while (CurrentOffset < (Offset + 1)) {\r | |
| 731c67e1 MK |
778 | CurrentShift = (UINT8)((CurrentOffset - 1) * 8);\r |
| 779 | ComputedLength = Length & (UINT32)(0x00000FF0 << CurrentShift);\r | |
| 780 | ComputedLength = (ComputedLength) >> (4 + CurrentShift);\r | |
| 781 | LeadByte = (UINT8)(ComputedLength & 0xFF);\r | |
| 98f28081 PG |
782 | *(Buffer + CurrentOffset) = LeadByte;\r |
| 783 | CurrentOffset++;\r | |
| 784 | }\r | |
| 785 | \r | |
| 786 | return ++Offset;\r | |
| 787 | }\r | |
| 788 | \r | |
| 789 | /** Compute the number of bytes required to write a package length.\r | |
| 790 | \r | |
| 791 | @param [in] Length The length to convert in the AML package length\r | |
| 792 | encoding style.\r | |
| 793 | Length cannot exceed 2^28.\r | |
| 794 | \r | |
| 795 | @return The number of bytes required to write the Length.\r | |
| 796 | **/\r | |
| 797 | UINT8\r | |
| 798 | EFIAPI\r | |
| 799 | AmlComputePkgLengthWidth (\r | |
| 800 | IN UINT32 Length\r | |
| 801 | )\r | |
| 802 | {\r | |
| 803 | // Length >= 2^28, should not be possible.\r | |
| 804 | if (Length >= (1 << 28)) {\r | |
| 805 | ASSERT (0);\r | |
| 806 | return 0;\r | |
| 98f28081 PG |
807 | } else if (Length >= (1 << 20)) {\r |
| 808 | // Length >= 2^20\r | |
| 809 | return 4;\r | |
| 98f28081 PG |
810 | } else if (Length >= (1 << 12)) {\r |
| 811 | // Length >= 2^12\r | |
| 812 | return 3;\r | |
| 98f28081 PG |
813 | } else if (Length >= (1 << 6)) {\r |
| 814 | // Length >= 2^6\r | |
| 815 | return 2;\r | |
| 816 | }\r | |
| 817 | \r | |
| 818 | // Length < 2^6\r | |
| 819 | return 1;\r | |
| 820 | }\r | |
| 12e65fd2 PG |
821 | \r |
| 822 | /** Given a length, compute the value of a PkgLen.\r | |
| 823 | \r | |
| 824 | In AML, some object have a PkgLen, telling the size of the AML object.\r | |
| 825 | It can be encoded in 1 to 4 bytes. The bytes used to encode the PkgLen is\r | |
| 826 | itself counted in the PkgLen value.\r | |
| 827 | This means that if an AML object sees its size increment/decrement,\r | |
| 828 | the number of bytes used to encode the PkgLen value can itself\r | |
| 829 | increment/decrement.\r | |
| 830 | \r | |
| 831 | For instance, the AML encoding of a DeviceOp is:\r | |
| 832 | DefDevice := DeviceOp PkgLength NameString TermList\r | |
| 833 | If:\r | |
| 834 | - sizeof (NameString) = 4 (the name is "DEV0" for instance);\r | |
| 835 | - sizeof (TermList) = (2^6-6)\r | |
| 836 | then the PkgLen is encoded on 1 byte. Indeed, its value is:\r | |
| 837 | sizeof (PkgLen) + sizeof (NameString) + sizeof (TermList) =\r | |
| 838 | sizeof (PkgLen) + 4 + (2^6-6)\r | |
| 839 | So:\r | |
| 840 | PkgLen = sizeof (PkgLen) + (2^6-2)\r | |
| 841 | \r | |
| 842 | The input arguments Length and PkgLen represent, for the DefDevice:\r | |
| 843 | DefDevice := DeviceOp PkgLength NameString TermList\r | |
| 844 | |------Length-----|\r | |
| 845 | |--------*PgkLength---------|\r | |
| 846 | \r | |
| 847 | @param [in] Length The length to encode as a PkgLen.\r | |
| 848 | Length cannot exceed 2^28 - 4 (4 bytes for the\r | |
| 849 | PkgLen encoding).\r | |
| 850 | The size of the PkgLen encoding bytes should not be\r | |
| 851 | counted in this length value.\r | |
| 852 | @param [out] PkgLen If success, contains the value of the PkgLen,\r | |
| 853 | ready to encode in the PkgLen format.\r | |
| 854 | This value takes into account the size of PkgLen\r | |
| 855 | encoding.\r | |
| 856 | \r | |
| 857 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 858 | @retval EFI_INVALID_PARAMETER Invalid parameter.\r | |
| 859 | **/\r | |
| 860 | EFI_STATUS\r | |
| 861 | EFIAPI\r | |
| 862 | AmlComputePkgLength (\r | |
| 731c67e1 MK |
863 | IN UINT32 Length,\r |
| 864 | OUT UINT32 *PkgLen\r | |
| 12e65fd2 PG |
865 | )\r |
| 866 | {\r | |
| 867 | UINT32 PkgLenWidth;\r | |
| 868 | UINT32 ReComputedPkgLenWidth;\r | |
| 869 | \r | |
| 870 | if (PkgLen == NULL) {\r | |
| 871 | ASSERT (0);\r | |
| 872 | return EFI_INVALID_PARAMETER;\r | |
| 873 | }\r | |
| 874 | \r | |
| 875 | // Compute the PkgLenWidth.\r | |
| 876 | PkgLenWidth = AmlComputePkgLengthWidth (Length);\r | |
| 877 | if (PkgLenWidth == 0) {\r | |
| 878 | ASSERT (0);\r | |
| 879 | return EFI_INVALID_PARAMETER;\r | |
| 880 | }\r | |
| 881 | \r | |
| 882 | // Add it to the Length.\r | |
| 883 | Length += PkgLenWidth;\r | |
| 884 | \r | |
| 885 | // Check that adding the PkgLenWidth didn't trigger a domino effect,\r | |
| 886 | // increasing the encoding width of the PkgLen again.\r | |
| 887 | // The PkgLen is encoded in at most 4 bytes. It is possible to increase\r | |
| 888 | // the PkgLen width if its encoding is less than 3 bytes.\r | |
| 889 | ReComputedPkgLenWidth = AmlComputePkgLengthWidth (Length);\r | |
| 890 | if (ReComputedPkgLenWidth != PkgLenWidth) {\r | |
| 891 | if ((ReComputedPkgLenWidth != 0) &&\r | |
| 731c67e1 MK |
892 | (ReComputedPkgLenWidth < 4))\r |
| 893 | {\r | |
| 12e65fd2 PG |
894 | // No need to recompute the PkgLen since a new threshold cannot\r |
| 895 | // be reached by incrementing the value by one.\r | |
| 896 | Length += 1;\r | |
| 897 | } else {\r | |
| 898 | ASSERT (0);\r | |
| 899 | return EFI_INVALID_PARAMETER;\r | |
| 900 | }\r | |
| 901 | }\r | |
| 902 | \r | |
| 903 | *PkgLen = Length;\r | |
| 904 | \r | |
| 905 | return EFI_SUCCESS;\r | |
| 906 | }\r |