Home | History | Annotate | Line # | Download | only in include
amlcode.h revision 1.1.1.9
      1 /******************************************************************************
      2  *
      3  * Name: amlcode.h - Definitions for AML, as included in "definition blocks"
      4  *                   Declarations and definitions contained herein are derived
      5  *                   directly from the ACPI specification.
      6  *
      7  *****************************************************************************/
      8 
      9 /*
     10  * Copyright (C) 2000 - 2017, Intel Corp.
     11  * All rights reserved.
     12  *
     13  * Redistribution and use in source and binary forms, with or without
     14  * modification, are permitted provided that the following conditions
     15  * are met:
     16  * 1. Redistributions of source code must retain the above copyright
     17  *    notice, this list of conditions, and the following disclaimer,
     18  *    without modification.
     19  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     20  *    substantially similar to the "NO WARRANTY" disclaimer below
     21  *    ("Disclaimer") and any redistribution must be conditioned upon
     22  *    including a substantially similar Disclaimer requirement for further
     23  *    binary redistribution.
     24  * 3. Neither the names of the above-listed copyright holders nor the names
     25  *    of any contributors may be used to endorse or promote products derived
     26  *    from this software without specific prior written permission.
     27  *
     28  * Alternatively, this software may be distributed under the terms of the
     29  * GNU General Public License ("GPL") version 2 as published by the Free
     30  * Software Foundation.
     31  *
     32  * NO WARRANTY
     33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     34  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     35  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     36  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     37  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     38  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     39  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     40  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     41  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     42  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     43  * POSSIBILITY OF SUCH DAMAGES.
     44  */
     45 
     46 #ifndef __AMLCODE_H__
     47 #define __AMLCODE_H__
     48 
     49 /* primary opcodes */
     50 
     51 #define AML_ZERO_OP                 (UINT16) 0x00
     52 #define AML_ONE_OP                  (UINT16) 0x01
     53 #define AML_ALIAS_OP                (UINT16) 0x06
     54 #define AML_NAME_OP                 (UINT16) 0x08
     55 #define AML_BYTE_OP                 (UINT16) 0x0a
     56 #define AML_WORD_OP                 (UINT16) 0x0b
     57 #define AML_DWORD_OP                (UINT16) 0x0c
     58 #define AML_STRING_OP               (UINT16) 0x0d
     59 #define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
     60 #define AML_SCOPE_OP                (UINT16) 0x10
     61 #define AML_BUFFER_OP               (UINT16) 0x11
     62 #define AML_PACKAGE_OP              (UINT16) 0x12
     63 #define AML_VARIABLE_PACKAGE_OP     (UINT16) 0x13     /* ACPI 2.0 */
     64 #define AML_METHOD_OP               (UINT16) 0x14
     65 #define AML_EXTERNAL_OP             (UINT16) 0x15     /* ACPI 6.0 */
     66 #define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
     67 #define AML_MULTI_NAME_PREFIX       (UINT16) 0x2f
     68 #define AML_EXTENDED_PREFIX         (UINT16) 0x5b
     69 #define AML_ROOT_PREFIX             (UINT16) 0x5c
     70 #define AML_PARENT_PREFIX           (UINT16) 0x5e
     71 #define AML_FIRST_LOCAL_OP          (UINT16) 0x60     /* Used for Local op # calculations */
     72 #define AML_LOCAL0                  (UINT16) 0x60
     73 #define AML_LOCAL1                  (UINT16) 0x61
     74 #define AML_LOCAL2                  (UINT16) 0x62
     75 #define AML_LOCAL3                  (UINT16) 0x63
     76 #define AML_LOCAL4                  (UINT16) 0x64
     77 #define AML_LOCAL5                  (UINT16) 0x65
     78 #define AML_LOCAL6                  (UINT16) 0x66
     79 #define AML_LOCAL7                  (UINT16) 0x67
     80 #define AML_FIRST_ARG_OP            (UINT16) 0x68     /* Used for Arg op # calculations */
     81 #define AML_ARG0                    (UINT16) 0x68
     82 #define AML_ARG1                    (UINT16) 0x69
     83 #define AML_ARG2                    (UINT16) 0x6a
     84 #define AML_ARG3                    (UINT16) 0x6b
     85 #define AML_ARG4                    (UINT16) 0x6c
     86 #define AML_ARG5                    (UINT16) 0x6d
     87 #define AML_ARG6                    (UINT16) 0x6e
     88 #define AML_STORE_OP                (UINT16) 0x70
     89 #define AML_REF_OF_OP               (UINT16) 0x71
     90 #define AML_ADD_OP                  (UINT16) 0x72
     91 #define AML_CONCATENATE_OP          (UINT16) 0x73
     92 #define AML_SUBTRACT_OP             (UINT16) 0x74
     93 #define AML_INCREMENT_OP            (UINT16) 0x75
     94 #define AML_DECREMENT_OP            (UINT16) 0x76
     95 #define AML_MULTIPLY_OP             (UINT16) 0x77
     96 #define AML_DIVIDE_OP               (UINT16) 0x78
     97 #define AML_SHIFT_LEFT_OP           (UINT16) 0x79
     98 #define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
     99 #define AML_BIT_AND_OP              (UINT16) 0x7b
    100 #define AML_BIT_NAND_OP             (UINT16) 0x7c
    101 #define AML_BIT_OR_OP               (UINT16) 0x7d
    102 #define AML_BIT_NOR_OP              (UINT16) 0x7e
    103 #define AML_BIT_XOR_OP              (UINT16) 0x7f
    104 #define AML_BIT_NOT_OP              (UINT16) 0x80
    105 #define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
    106 #define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
    107 #define AML_DEREF_OF_OP             (UINT16) 0x83
    108 #define AML_CONCATENATE_TEMPLATE_OP (UINT16) 0x84     /* ACPI 2.0 */
    109 #define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
    110 #define AML_NOTIFY_OP               (UINT16) 0x86
    111 #define AML_SIZE_OF_OP              (UINT16) 0x87
    112 #define AML_INDEX_OP                (UINT16) 0x88
    113 #define AML_MATCH_OP                (UINT16) 0x89
    114 #define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
    115 #define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
    116 #define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
    117 #define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
    118 #define AML_OBJECT_TYPE_OP          (UINT16) 0x8e
    119 #define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
    120 #define AML_LOGICAL_AND_OP          (UINT16) 0x90
    121 #define AML_LOGICAL_OR_OP           (UINT16) 0x91
    122 #define AML_LOGICAL_NOT_OP          (UINT16) 0x92
    123 #define AML_LOGICAL_EQUAL_OP        (UINT16) 0x93
    124 #define AML_LOGICAL_GREATER_OP      (UINT16) 0x94
    125 #define AML_LOGICAL_LESS_OP         (UINT16) 0x95
    126 #define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
    127 #define AML_TO_DECIMAL_STRING_OP    (UINT16) 0x97     /* ACPI 2.0 */
    128 #define AML_TO_HEX_STRING_OP        (UINT16) 0x98     /* ACPI 2.0 */
    129 #define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
    130 #define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
    131 #define AML_COPY_OBJECT_OP          (UINT16) 0x9d     /* ACPI 2.0 */
    132 #define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
    133 #define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
    134 #define AML_IF_OP                   (UINT16) 0xa0
    135 #define AML_ELSE_OP                 (UINT16) 0xa1
    136 #define AML_WHILE_OP                (UINT16) 0xa2
    137 #define AML_NOOP_OP                 (UINT16) 0xa3
    138 #define AML_RETURN_OP               (UINT16) 0xa4
    139 #define AML_BREAK_OP                (UINT16) 0xa5
    140 #define AML_COMMENT_OP              (UINT16) 0xa9
    141 #define AML_BREAKPOINT_OP          (UINT16) 0xcc
    142 #define AML_ONES_OP                 (UINT16) 0xff
    143 
    144 
    145 /*
    146  * Combination opcodes (actually two one-byte opcodes)
    147  * Used by the disassembler and iASL compiler
    148  */
    149 #define AML_LOGICAL_GREATER_EQUAL_OP (UINT16) 0x9295    /* LNot (LLess) */
    150 #define AML_LOGICAL_LESS_EQUAL_OP    (UINT16) 0x9294    /* LNot (LGreater) */
    151 #define AML_LOGICAL_NOT_EQUAL_OP     (UINT16) 0x9293    /* LNot (LEqual) */
    152 
    153 
    154 /* Prefixed (2-byte) opcodes (with AML_EXTENDED_PREFIX) */
    155 
    156 #define AML_EXTENDED_OPCODE         (UINT16) 0x5b00     /* Prefix for 2-byte opcodes */
    157 
    158 #define AML_MUTEX_OP                (UINT16) 0x5b01
    159 #define AML_EVENT_OP                (UINT16) 0x5b02
    160 #define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10     /* Obsolete, not in ACPI spec */
    161 #define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11     /* Obsolete, not in ACPI spec */
    162 #define AML_CONDITIONAL_REF_OF_OP   (UINT16) 0x5b12
    163 #define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
    164 #define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
    165 #define AML_LOAD_OP                 (UINT16) 0x5b20
    166 #define AML_STALL_OP                (UINT16) 0x5b21
    167 #define AML_SLEEP_OP                (UINT16) 0x5b22
    168 #define AML_ACQUIRE_OP              (UINT16) 0x5b23
    169 #define AML_SIGNAL_OP               (UINT16) 0x5b24
    170 #define AML_WAIT_OP                 (UINT16) 0x5b25
    171 #define AML_RESET_OP                (UINT16) 0x5b26
    172 #define AML_RELEASE_OP              (UINT16) 0x5b27
    173 #define AML_FROM_BCD_OP             (UINT16) 0x5b28
    174 #define AML_TO_BCD_OP               (UINT16) 0x5b29
    175 #define AML_UNLOAD_OP               (UINT16) 0x5b2a
    176 #define AML_REVISION_OP             (UINT16) 0x5b30
    177 #define AML_DEBUG_OP                (UINT16) 0x5b31
    178 #define AML_FATAL_OP                (UINT16) 0x5b32
    179 #define AML_TIMER_OP                (UINT16) 0x5b33     /* ACPI 3.0 */
    180 #define AML_REGION_OP               (UINT16) 0x5b80
    181 #define AML_FIELD_OP                (UINT16) 0x5b81
    182 #define AML_DEVICE_OP               (UINT16) 0x5b82
    183 #define AML_PROCESSOR_OP            (UINT16) 0x5b83
    184 #define AML_POWER_RESOURCE_OP       (UINT16) 0x5b84
    185 #define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
    186 #define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
    187 #define AML_BANK_FIELD_OP           (UINT16) 0x5b87
    188 #define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
    189 
    190 
    191 /*
    192  * Opcodes for "Field" operators
    193  */
    194 #define AML_FIELD_OFFSET_OP         (UINT8) 0x00
    195 #define AML_FIELD_ACCESS_OP         (UINT8) 0x01
    196 #define AML_FIELD_CONNECTION_OP     (UINT8) 0x02        /* ACPI 5.0 */
    197 #define AML_FIELD_EXT_ACCESS_OP     (UINT8) 0x03        /* ACPI 5.0 */
    198 
    199 
    200 /*
    201  * Internal opcodes
    202  * Use only "Unknown" AML opcodes, don't attempt to use
    203  * any valid ACPI ASCII values (A-Z, 0-9, '-')
    204  */
    205 #define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
    206 #define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
    207 #define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
    208 #define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
    209 #define AML_INT_BYTELIST_OP         (UINT16) 0x0033
    210 #define AML_INT_METHODCALL_OP       (UINT16) 0x0035
    211 #define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
    212 #define AML_INT_EVAL_SUBTREE_OP     (UINT16) 0x0037
    213 #define AML_INT_CONNECTION_OP       (UINT16) 0x0038
    214 #define AML_INT_EXTACCESSFIELD_OP   (UINT16) 0x0039
    215 
    216 #define ARG_NONE                    0x0
    217 
    218 /*
    219  * Argument types for the AML Parser
    220  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
    221  * There can be up to 31 unique argument types
    222  * Zero is reserved as end-of-list indicator
    223  */
    224 #define ARGP_BYTEDATA               0x01
    225 #define ARGP_BYTELIST               0x02
    226 #define ARGP_CHARLIST               0x03
    227 #define ARGP_DATAOBJ                0x04
    228 #define ARGP_DATAOBJLIST            0x05
    229 #define ARGP_DWORDDATA              0x06
    230 #define ARGP_FIELDLIST              0x07
    231 #define ARGP_NAME                   0x08
    232 #define ARGP_NAMESTRING             0x09
    233 #define ARGP_OBJLIST                0x0A
    234 #define ARGP_PKGLENGTH              0x0B
    235 #define ARGP_SUPERNAME              0x0C
    236 #define ARGP_TARGET                 0x0D
    237 #define ARGP_TERMARG                0x0E
    238 #define ARGP_TERMLIST               0x0F
    239 #define ARGP_WORDDATA               0x10
    240 #define ARGP_QWORDDATA              0x11
    241 #define ARGP_SIMPLENAME             0x12 /* NameString | LocalTerm | ArgTerm */
    242 #define ARGP_NAME_OR_REF            0x13 /* For ObjectType only */
    243 #define ARGP_MAX                    0x13
    244 #define ARGP_COMMENT                0x14
    245 
    246 /*
    247  * Resolved argument types for the AML Interpreter
    248  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
    249  * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
    250  *
    251  * Note1: These values are completely independent from the ACPI_TYPEs
    252  *        i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
    253  *
    254  * Note2: If and when 5 bits becomes insufficient, it would probably be best
    255  * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
    256  */
    257 
    258 /* Single, simple types */
    259 
    260 #define ARGI_ANYTYPE                0x01    /* Don't care */
    261 #define ARGI_PACKAGE                0x02
    262 #define ARGI_EVENT                  0x03
    263 #define ARGI_MUTEX                  0x04
    264 #define ARGI_DDBHANDLE              0x05
    265 
    266 /* Interchangeable types (via implicit conversion) */
    267 
    268 #define ARGI_INTEGER                0x06
    269 #define ARGI_STRING                 0x07
    270 #define ARGI_BUFFER                 0x08
    271 #define ARGI_BUFFER_OR_STRING       0x09    /* Used by MID op only */
    272 #define ARGI_COMPUTEDATA            0x0A    /* Buffer, String, or Integer */
    273 
    274 /* Reference objects */
    275 
    276 #define ARGI_INTEGER_REF            0x0B
    277 #define ARGI_OBJECT_REF             0x0C
    278 #define ARGI_DEVICE_REF             0x0D
    279 #define ARGI_REFERENCE              0x0E
    280 #define ARGI_TARGETREF              0x0F    /* Target, subject to implicit conversion */
    281 #define ARGI_SIMPLE_TARGET          0x10    /* Name, Local, Arg -- no implicit conversion */
    282 #define ARGI_STORE_TARGET           0x11    /* Target for store is TARGETREF + package objects */
    283 /*
    284  * #define ARGI_FIXED_TARGET           0x10     Target, no implicit conversion
    285  *
    286  * Removed 10/2016. ARGI_FIXED_TARGET was used for these operators:
    287  *      FromBCD
    288  *      ToBCD
    289  *      ToDecimalString
    290  *      ToHexString
    291  *      ToInteger
    292  *      ToBuffer
    293  * The purpose of this type was to disable "implicit result conversion",
    294  * but this was incorrect per the ACPI spec and other ACPI implementations.
    295  * These operators now have the target operand defined as a normal
    296  * ARGI_TARGETREF.
    297  */
    298 
    299 
    300 /* Multiple/complex types */
    301 
    302 #define ARGI_DATAOBJECT             0x13    /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
    303 #define ARGI_COMPLEXOBJ             0x14    /* Buffer, String, or package (Used by INDEX op only) */
    304 #define ARGI_REF_OR_STRING          0x15    /* Reference or String (Used by DEREFOF op only) */
    305 #define ARGI_REGION_OR_BUFFER       0x16    /* Used by LOAD op only */
    306 #define ARGI_DATAREFOBJ             0x17
    307 
    308 /* Note: types above can expand to 0x1F maximum */
    309 
    310 #define ARGI_INVALID_OPCODE         0xFFFFFFFF
    311 
    312 
    313 /*
    314  * Some of the flags and types below are of the form:
    315  *
    316  * AML_FLAGS_EXEC_#A_#T,#R, or
    317  * AML_TYPE_EXEC_#A_#T,#R where:
    318  *
    319  *      #A is the number of required arguments
    320  *      #T is the number of target operands
    321  *      #R indicates whether there is a return value
    322  */
    323 
    324 /*
    325  * Opcode information flags
    326  */
    327 #define AML_LOGICAL                 0x0001
    328 #define AML_LOGICAL_NUMERIC         0x0002
    329 #define AML_MATH                    0x0004
    330 #define AML_CREATE                  0x0008
    331 #define AML_FIELD                   0x0010
    332 #define AML_DEFER                   0x0020
    333 #define AML_NAMED                   0x0040
    334 #define AML_NSNODE                  0x0080
    335 #define AML_NSOPCODE                0x0100
    336 #define AML_NSOBJECT                0x0200
    337 #define AML_HAS_RETVAL              0x0400
    338 #define AML_HAS_TARGET              0x0800
    339 #define AML_HAS_ARGS                0x1000
    340 #define AML_CONSTANT                0x2000
    341 #define AML_NO_OPERAND_RESOLVE      0x4000
    342 
    343 /* Convenient flag groupings of the flags above */
    344 
    345 #define AML_FLAGS_EXEC_0A_0T_1R                                     AML_HAS_RETVAL
    346 #define AML_FLAGS_EXEC_1A_0T_0R     AML_HAS_ARGS                                   /* Monadic1  */
    347 #define AML_FLAGS_EXEC_1A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Monadic2  */
    348 #define AML_FLAGS_EXEC_1A_1T_0R     AML_HAS_ARGS | AML_HAS_TARGET
    349 #define AML_FLAGS_EXEC_1A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */
    350 #define AML_FLAGS_EXEC_2A_0T_0R     AML_HAS_ARGS                                   /* Dyadic1   */
    351 #define AML_FLAGS_EXEC_2A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Dyadic2   */
    352 #define AML_FLAGS_EXEC_2A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R  */
    353 #define AML_FLAGS_EXEC_2A_2T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
    354 #define AML_FLAGS_EXEC_3A_0T_0R     AML_HAS_ARGS
    355 #define AML_FLAGS_EXEC_3A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
    356 #define AML_FLAGS_EXEC_6A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL
    357 
    358 
    359 /*
    360  * The opcode Type is used in a dispatch table, do not change
    361  * or add anything new without updating the table.
    362  */
    363 #define AML_TYPE_EXEC_0A_0T_1R      0x00
    364 #define AML_TYPE_EXEC_1A_0T_0R      0x01 /* Monadic1  */
    365 #define AML_TYPE_EXEC_1A_0T_1R      0x02 /* Monadic2  */
    366 #define AML_TYPE_EXEC_1A_1T_0R      0x03
    367 #define AML_TYPE_EXEC_1A_1T_1R      0x04 /* Monadic2R */
    368 #define AML_TYPE_EXEC_2A_0T_0R      0x05 /* Dyadic1   */
    369 #define AML_TYPE_EXEC_2A_0T_1R      0x06 /* Dyadic2   */
    370 #define AML_TYPE_EXEC_2A_1T_1R      0x07 /* Dyadic2R  */
    371 #define AML_TYPE_EXEC_2A_2T_1R      0x08
    372 #define AML_TYPE_EXEC_3A_0T_0R      0x09
    373 #define AML_TYPE_EXEC_3A_1T_1R      0x0A
    374 #define AML_TYPE_EXEC_6A_0T_1R      0x0B
    375 /* End of types used in dispatch table */
    376 
    377 #define AML_TYPE_LITERAL            0x0B
    378 #define AML_TYPE_CONSTANT           0x0C
    379 #define AML_TYPE_METHOD_ARGUMENT    0x0D
    380 #define AML_TYPE_LOCAL_VARIABLE     0x0E
    381 #define AML_TYPE_DATA_TERM          0x0F
    382 
    383 /* Generic for an op that returns a value */
    384 
    385 #define AML_TYPE_METHOD_CALL        0x10
    386 
    387 /* Miscellaneous types */
    388 
    389 #define AML_TYPE_CREATE_FIELD       0x11
    390 #define AML_TYPE_CREATE_OBJECT      0x12
    391 #define AML_TYPE_CONTROL            0x13
    392 #define AML_TYPE_NAMED_NO_OBJ       0x14
    393 #define AML_TYPE_NAMED_FIELD        0x15
    394 #define AML_TYPE_NAMED_SIMPLE       0x16
    395 #define AML_TYPE_NAMED_COMPLEX      0x17
    396 #define AML_TYPE_RETURN             0x18
    397 #define AML_TYPE_UNDEFINED          0x19
    398 #define AML_TYPE_BOGUS              0x1A
    399 
    400 /* AML Package Length encodings */
    401 
    402 #define ACPI_AML_PACKAGE_TYPE1      0x40
    403 #define ACPI_AML_PACKAGE_TYPE2      0x4000
    404 #define ACPI_AML_PACKAGE_TYPE3      0x400000
    405 #define ACPI_AML_PACKAGE_TYPE4      0x40000000
    406 
    407 /*
    408  * Opcode classes
    409  */
    410 #define AML_CLASS_EXECUTE           0x00
    411 #define AML_CLASS_CREATE            0x01
    412 #define AML_CLASS_ARGUMENT          0x02
    413 #define AML_CLASS_NAMED_OBJECT      0x03
    414 #define AML_CLASS_CONTROL           0x04
    415 #define AML_CLASS_ASCII             0x05
    416 #define AML_CLASS_PREFIX            0x06
    417 #define AML_CLASS_INTERNAL          0x07
    418 #define AML_CLASS_RETURN_VALUE      0x08
    419 #define AML_CLASS_METHOD_CALL       0x09
    420 #define AML_CLASS_UNKNOWN           0x0A
    421 
    422 
    423 /* Comparison operation codes for MatchOp operator */
    424 
    425 typedef enum
    426 {
    427     MATCH_MTR                       = 0,
    428     MATCH_MEQ                       = 1,
    429     MATCH_MLE                       = 2,
    430     MATCH_MLT                       = 3,
    431     MATCH_MGE                       = 4,
    432     MATCH_MGT                       = 5
    433 
    434 } AML_MATCH_OPERATOR;
    435 
    436 #define MAX_MATCH_OPERATOR          5
    437 
    438 
    439 /*
    440  * FieldFlags
    441  *
    442  * This byte is extracted from the AML and includes three separate
    443  * pieces of information about the field:
    444  * 1) The field access type
    445  * 2) The field update rule
    446  * 3) The lock rule for the field
    447  *
    448  * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
    449  *      04      : LockRule (1 == Lock)
    450  *      05 - 06 : UpdateRule
    451  */
    452 #define AML_FIELD_ACCESS_TYPE_MASK  0x0F
    453 #define AML_FIELD_LOCK_RULE_MASK    0x10
    454 #define AML_FIELD_UPDATE_RULE_MASK  0x60
    455 
    456 
    457 /* 1) Field Access Types */
    458 
    459 typedef enum
    460 {
    461     AML_FIELD_ACCESS_ANY            = 0x00,
    462     AML_FIELD_ACCESS_BYTE           = 0x01,
    463     AML_FIELD_ACCESS_WORD           = 0x02,
    464     AML_FIELD_ACCESS_DWORD          = 0x03,
    465     AML_FIELD_ACCESS_QWORD          = 0x04,    /* ACPI 2.0 */
    466     AML_FIELD_ACCESS_BUFFER         = 0x05     /* ACPI 2.0 */
    467 
    468 } AML_ACCESS_TYPE;
    469 
    470 
    471 /* 2) Field Lock Rules */
    472 
    473 typedef enum
    474 {
    475     AML_FIELD_LOCK_NEVER            = 0x00,
    476     AML_FIELD_LOCK_ALWAYS           = 0x10
    477 
    478 } AML_LOCK_RULE;
    479 
    480 
    481 /* 3) Field Update Rules */
    482 
    483 typedef enum
    484 {
    485     AML_FIELD_UPDATE_PRESERVE       = 0x00,
    486     AML_FIELD_UPDATE_WRITE_AS_ONES  = 0x20,
    487     AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
    488 
    489 } AML_UPDATE_RULE;
    490 
    491 
    492 /*
    493  * Field Access Attributes.
    494  * This byte is extracted from the AML via the
    495  * AccessAs keyword
    496  */
    497 typedef enum
    498 {
    499     AML_FIELD_ATTRIB_QUICK          = 0x02,
    500     AML_FIELD_ATTRIB_SEND_RCV       = 0x04,
    501     AML_FIELD_ATTRIB_BYTE           = 0x06,
    502     AML_FIELD_ATTRIB_WORD           = 0x08,
    503     AML_FIELD_ATTRIB_BLOCK          = 0x0A,
    504     AML_FIELD_ATTRIB_MULTIBYTE      = 0x0B,
    505     AML_FIELD_ATTRIB_WORD_CALL      = 0x0C,
    506     AML_FIELD_ATTRIB_BLOCK_CALL     = 0x0D,
    507     AML_FIELD_ATTRIB_RAW_BYTES      = 0x0E,
    508     AML_FIELD_ATTRIB_RAW_PROCESS    = 0x0F
    509 
    510 } AML_ACCESS_ATTRIBUTE;
    511 
    512 
    513 /* Bit fields in the AML MethodFlags byte */
    514 
    515 #define AML_METHOD_ARG_COUNT        0x07
    516 #define AML_METHOD_SERIALIZED       0x08
    517 #define AML_METHOD_SYNC_LEVEL       0xF0
    518 
    519 
    520 #endif /* __AMLCODE_H__ */
    521