sys/contrib/dev/acpica/source/include/amlcode.h

   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 - 2014, 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 #pragma pack(push) /* Set default struct packing */
  50
  51
  52 /* primary opcodes */
  53
  54 #define AML_NULL_CHAR               (UINT16) 0x00
  55
  56 #define AML_ZERO_OP                 (UINT16) 0x00
  57 #define AML_ONE_OP                  (UINT16) 0x01
  58 #define AML_UNASSIGNED              (UINT16) 0x02
  59 #define AML_ALIAS_OP                (UINT16) 0x06
  60 #define AML_NAME_OP                 (UINT16) 0x08
  61 #define AML_BYTE_OP                 (UINT16) 0x0a
  62 #define AML_WORD_OP                 (UINT16) 0x0b
  63 #define AML_DWORD_OP                (UINT16) 0x0c
  64 #define AML_STRING_OP               (UINT16) 0x0d
  65 #define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
  66 #define AML_SCOPE_OP                (UINT16) 0x10
  67 #define AML_BUFFER_OP               (UINT16) 0x11
  68 #define AML_PACKAGE_OP              (UINT16) 0x12
  69 #define AML_VAR_PACKAGE_OP          (UINT16) 0x13     /* ACPI 2.0 */
  70 #define AML_METHOD_OP               (UINT16) 0x14
  71 #define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
  72 #define AML_MULTI_NAME_PREFIX_OP    (UINT16) 0x2f
  73 #define AML_NAME_CHAR_SUBSEQ        (UINT16) 0x30
  74 #define AML_NAME_CHAR_FIRST         (UINT16) 0x41
  75 #define AML_EXTENDED_OP_PREFIX      (UINT16) 0x5b
  76 #define AML_ROOT_PREFIX             (UINT16) 0x5c
  77 #define AML_PARENT_PREFIX           (UINT16) 0x5e
  78 #define AML_LOCAL_OP                (UINT16) 0x60
  79 #define AML_LOCAL0                  (UINT16) 0x60
  80 #define AML_LOCAL1                  (UINT16) 0x61
  81 #define AML_LOCAL2                  (UINT16) 0x62
  82 #define AML_LOCAL3                  (UINT16) 0x63
  83 #define AML_LOCAL4                  (UINT16) 0x64
  84 #define AML_LOCAL5                  (UINT16) 0x65
  85 #define AML_LOCAL6                  (UINT16) 0x66
  86 #define AML_LOCAL7                  (UINT16) 0x67
  87 #define AML_ARG_OP                  (UINT16) 0x68
  88 #define AML_ARG0                    (UINT16) 0x68
  89 #define AML_ARG1                    (UINT16) 0x69
  90 #define AML_ARG2                    (UINT16) 0x6a
  91 #define AML_ARG3                    (UINT16) 0x6b
  92 #define AML_ARG4                    (UINT16) 0x6c
  93 #define AML_ARG5                    (UINT16) 0x6d
  94 #define AML_ARG6                    (UINT16) 0x6e
  95 #define AML_STORE_OP                (UINT16) 0x70
  96 #define AML_REF_OF_OP               (UINT16) 0x71
  97 #define AML_ADD_OP                  (UINT16) 0x72
  98 #define AML_CONCAT_OP               (UINT16) 0x73
  99 #define AML_SUBTRACT_OP             (UINT16) 0x74
 100 #define AML_INCREMENT_OP            (UINT16) 0x75
 101 #define AML_DECREMENT_OP            (UINT16) 0x76
 102 #define AML_MULTIPLY_OP             (UINT16) 0x77
 103 #define AML_DIVIDE_OP               (UINT16) 0x78
 104 #define AML_SHIFT_LEFT_OP           (UINT16) 0x79
 105 #define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
 106 #define AML_BIT_AND_OP              (UINT16) 0x7b
 107 #define AML_BIT_NAND_OP             (UINT16) 0x7c
 108 #define AML_BIT_OR_OP               (UINT16) 0x7d
 109 #define AML_BIT_NOR_OP              (UINT16) 0x7e
 110 #define AML_BIT_XOR_OP              (UINT16) 0x7f
 111 #define AML_BIT_NOT_OP              (UINT16) 0x80
 112 #define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
 113 #define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
 114 #define AML_DEREF_OF_OP             (UINT16) 0x83
 115 #define AML_CONCAT_RES_OP           (UINT16) 0x84     /* ACPI 2.0 */
 116 #define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
 117 #define AML_NOTIFY_OP               (UINT16) 0x86
 118 #define AML_SIZE_OF_OP              (UINT16) 0x87
 119 #define AML_INDEX_OP                (UINT16) 0x88
 120 #define AML_MATCH_OP                (UINT16) 0x89
 121 #define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
 122 #define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
 123 #define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
 124 #define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
 125 #define AML_TYPE_OP                 (UINT16) 0x8e
 126 #define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
 127 #define AML_LAND_OP                 (UINT16) 0x90
 128 #define AML_LOR_OP                  (UINT16) 0x91
 129 #define AML_LNOT_OP                 (UINT16) 0x92
 130 #define AML_LEQUAL_OP               (UINT16) 0x93
 131 #define AML_LGREATER_OP             (UINT16) 0x94
 132 #define AML_LLESS_OP                (UINT16) 0x95
 133 #define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
 134 #define AML_TO_DECSTRING_OP         (UINT16) 0x97     /* ACPI 2.0 */
 135 #define AML_TO_HEXSTRING_OP         (UINT16) 0x98     /* ACPI 2.0 */
 136 #define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
 137 #define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
 138 #define AML_COPY_OP                 (UINT16) 0x9d     /* ACPI 2.0 */
 139 #define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
 140 #define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
 141 #define AML_IF_OP                   (UINT16) 0xa0
 142 #define AML_ELSE_OP                 (UINT16) 0xa1
 143 #define AML_WHILE_OP                (UINT16) 0xa2
 144 #define AML_NOOP_OP                 (UINT16) 0xa3
 145 #define AML_RETURN_OP               (UINT16) 0xa4
 146 #define AML_BREAK_OP                (UINT16) 0xa5
 147 #define AML_BREAK_POINT_OP          (UINT16) 0xcc
 148 #define AML_ONES_OP                 (UINT16) 0xff
 149
 150 /* prefixed opcodes */
 151
 152 #define AML_EXTENDED_OPCODE         (UINT16) 0x5b00     /* prefix for 2-byte opcodes */
 153
 154 #define AML_MUTEX_OP                (UINT16) 0x5b01
 155 #define AML_EVENT_OP                (UINT16) 0x5b02
 156 #define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10
 157 #define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11
 158 #define AML_COND_REF_OF_OP          (UINT16) 0x5b12
 159 #define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
 160 #define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
 161 #define AML_LOAD_OP                 (UINT16) 0x5b20
 162 #define AML_STALL_OP                (UINT16) 0x5b21
 163 #define AML_SLEEP_OP                (UINT16) 0x5b22
 164 #define AML_ACQUIRE_OP              (UINT16) 0x5b23
 165 #define AML_SIGNAL_OP               (UINT16) 0x5b24
 166 #define AML_WAIT_OP                 (UINT16) 0x5b25
 167 #define AML_RESET_OP                (UINT16) 0x5b26
 168 #define AML_RELEASE_OP              (UINT16) 0x5b27
 169 #define AML_FROM_BCD_OP             (UINT16) 0x5b28
 170 #define AML_TO_BCD_OP               (UINT16) 0x5b29
 171 #define AML_UNLOAD_OP               (UINT16) 0x5b2a
 172 #define AML_REVISION_OP             (UINT16) 0x5b30
 173 #define AML_DEBUG_OP                (UINT16) 0x5b31
 174 #define AML_FATAL_OP                (UINT16) 0x5b32
 175 #define AML_TIMER_OP                (UINT16) 0x5b33     /* ACPI 3.0 */
 176 #define AML_REGION_OP               (UINT16) 0x5b80
 177 #define AML_FIELD_OP                (UINT16) 0x5b81
 178 #define AML_DEVICE_OP               (UINT16) 0x5b82
 179 #define AML_PROCESSOR_OP            (UINT16) 0x5b83
 180 #define AML_POWER_RES_OP            (UINT16) 0x5b84
 181 #define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
 182 #define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
 183 #define AML_BANK_FIELD_OP           (UINT16) 0x5b87
 184 #define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
 185
 186
 187 /*
 188  * Combination opcodes (actually two one-byte opcodes)
 189  * Used by the disassembler and iASL compiler
 190  */
 191 #define AML_LGREATEREQUAL_OP        (UINT16) 0x9295
 192 #define AML_LLESSEQUAL_OP           (UINT16) 0x9294
 193 #define AML_LNOTEQUAL_OP            (UINT16) 0x9293
 194
 195
 196 /*
 197  * Opcodes for "Field" operators
 198  */
 199 #define AML_FIELD_OFFSET_OP         (UINT8) 0x00
 200 #define AML_FIELD_ACCESS_OP         (UINT8) 0x01
 201 #define AML_FIELD_CONNECTION_OP     (UINT8) 0x02        /* ACPI 5.0 */
 202 #define AML_FIELD_EXT_ACCESS_OP     (UINT8) 0x03        /* ACPI 5.0 */
 203
 204
 205 /*
 206  * Internal opcodes
 207  * Use only "Unknown" AML opcodes, don't attempt to use
 208  * any valid ACPI ASCII values (A-Z, 0-9, '-')
 209  */
 210 #define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
 211 #define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
 212 #define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
 213 #define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
 214 #define AML_INT_BYTELIST_OP         (UINT16) 0x0033
 215 #define AML_INT_STATICSTRING_OP     (UINT16) 0x0034
 216 #define AML_INT_METHODCALL_OP       (UINT16) 0x0035
 217 #define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
 218 #define AML_INT_EVAL_SUBTREE_OP     (UINT16) 0x0037
 219 #define AML_INT_CONNECTION_OP       (UINT16) 0x0038
 220 #define AML_INT_EXTACCESSFIELD_OP   (UINT16) 0x0039
 221
 222 #define ARG_NONE                    0x0
 223
 224 /*
 225  * Argument types for the AML Parser
 226  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
 227  * There can be up to 31 unique argument types
 228  * Zero is reserved as end-of-list indicator
 229  */
 230 #define ARGP_BYTEDATA               0x01
 231 #define ARGP_BYTELIST               0x02
 232 #define ARGP_CHARLIST               0x03
 233 #define ARGP_DATAOBJ                0x04
 234 #define ARGP_DATAOBJLIST            0x05
 235 #define ARGP_DWORDDATA              0x06
 236 #define ARGP_FIELDLIST              0x07
 237 #define ARGP_NAME                   0x08
 238 #define ARGP_NAMESTRING             0x09
 239 #define ARGP_OBJLIST                0x0A
 240 #define ARGP_PKGLENGTH              0x0B
 241 #define ARGP_SUPERNAME              0x0C
 242 #define ARGP_TARGET                 0x0D
 243 #define ARGP_TERMARG                0x0E
 244 #define ARGP_TERMLIST               0x0F
 245 #define ARGP_WORDDATA               0x10
 246 #define ARGP_QWORDDATA              0x11
 247 #define ARGP_SIMPLENAME             0x12
 248
 249 /*
 250  * Resolved argument types for the AML Interpreter
 251  * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
 252  * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
 253  *
 254  * Note1: These values are completely independent from the ACPI_TYPEs
 255  *        i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
 256  *
 257  * Note2: If and when 5 bits becomes insufficient, it would probably be best
 258  * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
 259  */
 260
 261 /* Single, simple types */
 262
 263 #define ARGI_ANYTYPE                0x01    /* Don't care */
 264 #define ARGI_PACKAGE                0x02
 265 #define ARGI_EVENT                  0x03
 266 #define ARGI_MUTEX                  0x04
 267 #define ARGI_DDBHANDLE              0x05
 268
 269 /* Interchangeable types (via implicit conversion) */
 270
 271 #define ARGI_INTEGER                0x06
 272 #define ARGI_STRING                 0x07
 273 #define ARGI_BUFFER                 0x08
 274 #define ARGI_BUFFER_OR_STRING       0x09    /* Used by MID op only */
 275 #define ARGI_COMPUTEDATA            0x0A    /* Buffer, String, or Integer */
 276
 277 /* Reference objects */
 278
 279 #define ARGI_INTEGER_REF            0x0B
 280 #define ARGI_OBJECT_REF             0x0C
 281 #define ARGI_DEVICE_REF             0x0D
 282 #define ARGI_REFERENCE              0x0E
 283 #define ARGI_TARGETREF              0x0F    /* Target, subject to implicit conversion */
 284 #define ARGI_FIXED_TARGET           0x10    /* Target, no implicit conversion */
 285 #define ARGI_SIMPLE_TARGET          0x11    /* Name, Local, Arg -- no implicit conversion */
 286
 287 /* Multiple/complex types */
 288
 289 #define ARGI_DATAOBJECT             0x12    /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
 290 #define ARGI_COMPLEXOBJ             0x13    /* Buffer, String, or package (Used by INDEX op only) */
 291 #define ARGI_REF_OR_STRING          0x14    /* Reference or String (Used by DEREFOF op only) */
 292 #define ARGI_REGION_OR_BUFFER       0x15    /* Used by LOAD op only */
 293 #define ARGI_DATAREFOBJ             0x16
 294
 295 /* Note: types above can expand to 0x1F maximum */
 296
 297 #define ARGI_INVALID_OPCODE         0xFFFFFFFF
 298
 299
 300 /*
 301  * hash offsets
 302  */
 303 #define AML_EXTOP_HASH_OFFSET       22
 304 #define AML_LNOT_HASH_OFFSET        19
 305
 306
 307 /*
 308  * opcode groups and types
 309  */
 310 #define OPGRP_NAMED                 0x01
 311 #define OPGRP_FIELD                 0x02
 312 #define OPGRP_BYTELIST              0x04
 313
 314
 315 /*
 316  * Opcode information
 317  */
 318
 319 /* Opcode flags */
 320
 321 #define AML_LOGICAL                 0x0001
 322 #define AML_LOGICAL_NUMERIC         0x0002
 323 #define AML_MATH                    0x0004
 324 #define AML_CREATE                  0x0008
 325 #define AML_FIELD                   0x0010
 326 #define AML_DEFER                   0x0020
 327 #define AML_NAMED                   0x0040
 328 #define AML_NSNODE                  0x0080
 329 #define AML_NSOPCODE                0x0100
 330 #define AML_NSOBJECT                0x0200
 331 #define AML_HAS_RETVAL              0x0400
 332 #define AML_HAS_TARGET              0x0800
 333 #define AML_HAS_ARGS                0x1000
 334 #define AML_CONSTANT                0x2000
 335 #define AML_NO_OPERAND_RESOLVE      0x4000
 336
 337 /* Convenient flag groupings */
 338
 339 #define AML_FLAGS_EXEC_0A_0T_1R                                     AML_HAS_RETVAL
 340 #define AML_FLAGS_EXEC_1A_0T_0R     AML_HAS_ARGS                                   /* Monadic1  */
 341 #define AML_FLAGS_EXEC_1A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Monadic2  */
 342 #define AML_FLAGS_EXEC_1A_1T_0R     AML_HAS_ARGS | AML_HAS_TARGET
 343 #define AML_FLAGS_EXEC_1A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */
 344 #define AML_FLAGS_EXEC_2A_0T_0R     AML_HAS_ARGS                                   /* Dyadic1   */
 345 #define AML_FLAGS_EXEC_2A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Dyadic2   */
 346 #define AML_FLAGS_EXEC_2A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R  */
 347 #define AML_FLAGS_EXEC_2A_2T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
 348 #define AML_FLAGS_EXEC_3A_0T_0R     AML_HAS_ARGS
 349 #define AML_FLAGS_EXEC_3A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
 350 #define AML_FLAGS_EXEC_6A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL
 351
 352
 353 /*
 354  * The opcode Type is used in a dispatch table, do not change
 355  * without updating the table.
 356  */
 357 #define AML_TYPE_EXEC_0A_0T_1R      0x00
 358 #define AML_TYPE_EXEC_1A_0T_0R      0x01 /* Monadic1  */
 359 #define AML_TYPE_EXEC_1A_0T_1R      0x02 /* Monadic2  */
 360 #define AML_TYPE_EXEC_1A_1T_0R      0x03
 361 #define AML_TYPE_EXEC_1A_1T_1R      0x04 /* Monadic2R */
 362 #define AML_TYPE_EXEC_2A_0T_0R      0x05 /* Dyadic1   */
 363 #define AML_TYPE_EXEC_2A_0T_1R      0x06 /* Dyadic2   */
 364 #define AML_TYPE_EXEC_2A_1T_1R      0x07 /* Dyadic2R  */
 365 #define AML_TYPE_EXEC_2A_2T_1R      0x08
 366 #define AML_TYPE_EXEC_3A_0T_0R      0x09
 367 #define AML_TYPE_EXEC_3A_1T_1R      0x0A
 368 #define AML_TYPE_EXEC_6A_0T_1R      0x0B
 369 /* End of types used in dispatch table */
 370
 371 #define AML_TYPE_LITERAL            0x0B
 372 #define AML_TYPE_CONSTANT           0x0C
 373 #define AML_TYPE_METHOD_ARGUMENT    0x0D
 374 #define AML_TYPE_LOCAL_VARIABLE     0x0E
 375 #define AML_TYPE_DATA_TERM          0x0F
 376
 377 /* Generic for an op that returns a value */
 378
 379 #define AML_TYPE_METHOD_CALL        0x10
 380
 381 /* Misc */
 382
 383 #define AML_TYPE_CREATE_FIELD       0x11
 384 #define AML_TYPE_CREATE_OBJECT      0x12
 385 #define AML_TYPE_CONTROL            0x13
 386 #define AML_TYPE_NAMED_NO_OBJ       0x14
 387 #define AML_TYPE_NAMED_FIELD        0x15
 388 #define AML_TYPE_NAMED_SIMPLE       0x16
 389 #define AML_TYPE_NAMED_COMPLEX      0x17
 390 #define AML_TYPE_RETURN             0x18
 391
 392 #define AML_TYPE_UNDEFINED          0x19
 393 #define AML_TYPE_BOGUS              0x1A
 394
 395 /* AML Package Length encodings */
 396
 397 #define ACPI_AML_PACKAGE_TYPE1      0x40
 398 #define ACPI_AML_PACKAGE_TYPE2      0x4000
 399 #define ACPI_AML_PACKAGE_TYPE3      0x400000
 400 #define ACPI_AML_PACKAGE_TYPE4      0x40000000
 401
 402 /*
 403  * Opcode classes
 404  */
 405 #define AML_CLASS_EXECUTE           0x00
 406 #define AML_CLASS_CREATE            0x01
 407 #define AML_CLASS_ARGUMENT          0x02
 408 #define AML_CLASS_NAMED_OBJECT      0x03
 409 #define AML_CLASS_CONTROL           0x04
 410 #define AML_CLASS_ASCII             0x05
 411 #define AML_CLASS_PREFIX            0x06
 412 #define AML_CLASS_INTERNAL          0x07
 413 #define AML_CLASS_RETURN_VALUE      0x08
 414 #define AML_CLASS_METHOD_CALL       0x09
 415 #define AML_CLASS_UNKNOWN           0x0A
 416
 417
 418 /* Comparison operation codes for MatchOp operator */
 419
 420 typedef enum
 421 {
 422     MATCH_MTR                       = 0,
 423     MATCH_MEQ                       = 1,
 424     MATCH_MLE                       = 2,
 425     MATCH_MLT                       = 3,
 426     MATCH_MGE                       = 4,
 427     MATCH_MGT                       = 5
 428
 429 } AML_MATCH_OPERATOR;
 430
 431 #define MAX_MATCH_OPERATOR          5
 432
 433
 434 /*
 435  * FieldFlags
 436  *
 437  * This byte is extracted from the AML and includes three separate
 438  * pieces of information about the field:
 439  * 1) The field access type
 440  * 2) The field update rule
 441  * 3) The lock rule for the field
 442  *
 443  * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
 444  *      04      : LockRule (1 == Lock)
 445  *      05 - 06 : UpdateRule
 446  */
 447 #define AML_FIELD_ACCESS_TYPE_MASK  0x0F
 448 #define AML_FIELD_LOCK_RULE_MASK    0x10
 449 #define AML_FIELD_UPDATE_RULE_MASK  0x60
 450
 451
 452 /* 1) Field Access Types */
 453
 454 typedef enum
 455 {
 456     AML_FIELD_ACCESS_ANY            = 0x00,
 457     AML_FIELD_ACCESS_BYTE           = 0x01,
 458     AML_FIELD_ACCESS_WORD           = 0x02,
 459     AML_FIELD_ACCESS_DWORD          = 0x03,
 460     AML_FIELD_ACCESS_QWORD          = 0x04,    /* ACPI 2.0 */
 461     AML_FIELD_ACCESS_BUFFER         = 0x05     /* ACPI 2.0 */
 462
 463 } AML_ACCESS_TYPE;
 464
 465
 466 /* 2) Field Lock Rules */
 467
 468 typedef enum
 469 {
 470     AML_FIELD_LOCK_NEVER            = 0x00,
 471     AML_FIELD_LOCK_ALWAYS           = 0x10
 472
 473 } AML_LOCK_RULE;
 474
 475
 476 /* 3) Field Update Rules */
 477
 478 typedef enum
 479 {
 480     AML_FIELD_UPDATE_PRESERVE       = 0x00,
 481     AML_FIELD_UPDATE_WRITE_AS_ONES  = 0x20,
 482     AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
 483
 484 } AML_UPDATE_RULE;
 485
 486
 487 /*
 488  * Field Access Attributes.
 489  * This byte is extracted from the AML via the
 490  * AccessAs keyword
 491  */
 492 typedef enum
 493 {
 494     AML_FIELD_ATTRIB_QUICK          = 0x02,
 495     AML_FIELD_ATTRIB_SEND_RCV       = 0x04,
 496     AML_FIELD_ATTRIB_BYTE           = 0x06,
 497     AML_FIELD_ATTRIB_WORD           = 0x08,
 498     AML_FIELD_ATTRIB_BLOCK          = 0x0A,
 499     AML_FIELD_ATTRIB_MULTIBYTE      = 0x0B,
 500     AML_FIELD_ATTRIB_WORD_CALL      = 0x0C,
 501     AML_FIELD_ATTRIB_BLOCK_CALL     = 0x0D,
 502     AML_FIELD_ATTRIB_RAW_BYTES      = 0x0E,
 503     AML_FIELD_ATTRIB_RAW_PROCESS    = 0x0F
 504
 505 } AML_ACCESS_ATTRIBUTE;
 506
 507
 508 /* Bit fields in the AML MethodFlags byte */
 509
 510 #define AML_METHOD_ARG_COUNT        0x07
 511 #define AML_METHOD_SERIALIZED       0x08
 512 #define AML_METHOD_SYNC_LEVEL       0xF0
 513
 514
 515 #pragma pack(pop) /* Restore original struct packing */
 516
 517 #endif /* __AMLCODE_H__ */