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 * $Revision: 82 $ 7 * 8 *****************************************************************************/ 9 10 /****************************************************************************** 11 * 12 * 1. Copyright Notice 13 * 14 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp. 15 * All rights reserved. 16 * 17 * 2. License 18 * 19 * 2.1. This is your license from Intel Corp. under its intellectual property 20 * rights. You may have additional license terms from the party that provided 21 * you this software, covering your right to use that party's intellectual 22 * property rights. 23 * 24 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 25 * copy of the source code appearing in this file ("Covered Code") an 26 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 27 * base code distributed originally by Intel ("Original Intel Code") to copy, 28 * make derivatives, distribute, use and display any portion of the Covered 29 * Code in any form, with the right to sublicense such rights; and 30 * 31 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 32 * license (with the right to sublicense), under only those claims of Intel 33 * patents that are infringed by the Original Intel Code, to make, use, sell, 34 * offer to sell, and import the Covered Code and derivative works thereof 35 * solely to the minimum extent necessary to exercise the above copyright 36 * license, and in no event shall the patent license extend to any additions 37 * to or modifications of the Original Intel Code. No other license or right 38 * is granted directly or by implication, estoppel or otherwise; 39 * 40 * The above copyright and patent license is granted only if the following 41 * conditions are met: 42 * 43 * 3. Conditions 44 * 45 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 46 * Redistribution of source code of any substantial portion of the Covered 47 * Code or modification with rights to further distribute source must include 48 * the above Copyright Notice, the above License, this list of Conditions, 49 * and the following Disclaimer and Export Compliance provision. In addition, 50 * Licensee must cause all Covered Code to which Licensee contributes to 51 * contain a file documenting the changes Licensee made to create that Covered 52 * Code and the date of any change. Licensee must include in that file the 53 * documentation of any changes made by any predecessor Licensee. Licensee 54 * must include a prominent statement that the modification is derived, 55 * directly or indirectly, from Original Intel Code. 56 * 57 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 58 * Redistribution of source code of any substantial portion of the Covered 59 * Code or modification without rights to further distribute source must 60 * include the following Disclaimer and Export Compliance provision in the 61 * documentation and/or other materials provided with distribution. In 62 * addition, Licensee may not authorize further sublicense of source of any 63 * portion of the Covered Code, and must include terms to the effect that the 64 * license from Licensee to its licensee is limited to the intellectual 65 * property embodied in the software Licensee provides to its licensee, and 66 * not to intellectual property embodied in modifications its licensee may 67 * make. 68 * 69 * 3.3. Redistribution of Executable. Redistribution in executable form of any 70 * substantial portion of the Covered Code or modification must reproduce the 71 * above Copyright Notice, and the following Disclaimer and Export Compliance 72 * provision in the documentation and/or other materials provided with the 73 * distribution. 74 * 75 * 3.4. Intel retains all right, title, and interest in and to the Original 76 * Intel Code. 77 * 78 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 79 * Intel shall be used in advertising or otherwise to promote the sale, use or 80 * other dealings in products derived from or relating to the Covered Code 81 * without prior written authorization from Intel. 82 * 83 * 4. Disclaimer and Export Compliance 84 * 85 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 86 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 87 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 88 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 89 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 90 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 91 * PARTICULAR PURPOSE. 92 * 93 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 94 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 95 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 96 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 97 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 98 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 99 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 100 * LIMITED REMEDY. 101 * 102 * 4.3. Licensee shall not export, either directly or indirectly, any of this 103 * software or system incorporating such software without first obtaining any 104 * required license or other approval from the U. S. Department of Commerce or 105 * any other agency or department of the United States Government. In the 106 * event Licensee exports any such software from the United States or 107 * re-exports any such software from a foreign destination, Licensee shall 108 * ensure that the distribution and export/re-export of the software is in 109 * compliance with all laws, regulations, orders, or other restrictions of the 110 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 111 * any of its subsidiaries will export/re-export any technical data, process, 112 * software, or service, directly or indirectly, to any country for which the 113 * United States government or any agency thereof requires an export license, 114 * other governmental approval, or letter of assurance, without first obtaining 115 * such license, approval or letter. 116 * 117 *****************************************************************************/ 118 119 #ifndef __AMLCODE_H__ 120 #define __AMLCODE_H__ 121 122 /* primary opcodes */ 123 124 #define AML_NULL_CHAR (UINT16) 0x00 125 126 #define AML_ZERO_OP (UINT16) 0x00 127 #define AML_ONE_OP (UINT16) 0x01 128 #define AML_UNASSIGNED (UINT16) 0x02 129 #define AML_ALIAS_OP (UINT16) 0x06 130 #define AML_NAME_OP (UINT16) 0x08 131 #define AML_BYTE_OP (UINT16) 0x0a 132 #define AML_WORD_OP (UINT16) 0x0b 133 #define AML_DWORD_OP (UINT16) 0x0c 134 #define AML_STRING_OP (UINT16) 0x0d 135 #define AML_QWORD_OP (UINT16) 0x0e /* ACPI 2.0 */ 136 #define AML_SCOPE_OP (UINT16) 0x10 137 #define AML_BUFFER_OP (UINT16) 0x11 138 #define AML_PACKAGE_OP (UINT16) 0x12 139 #define AML_VAR_PACKAGE_OP (UINT16) 0x13 /* ACPI 2.0 */ 140 #define AML_METHOD_OP (UINT16) 0x14 141 #define AML_DUAL_NAME_PREFIX (UINT16) 0x2e 142 #define AML_MULTI_NAME_PREFIX_OP (UINT16) 0x2f 143 #define AML_NAME_CHAR_SUBSEQ (UINT16) 0x30 144 #define AML_NAME_CHAR_FIRST (UINT16) 0x41 145 #define AML_EXTENDED_OP_PREFIX (UINT16) 0x5b 146 #define AML_ROOT_PREFIX (UINT16) 0x5c 147 #define AML_PARENT_PREFIX (UINT16) 0x5e 148 #define AML_LOCAL_OP (UINT16) 0x60 149 #define AML_LOCAL0 (UINT16) 0x60 150 #define AML_LOCAL1 (UINT16) 0x61 151 #define AML_LOCAL2 (UINT16) 0x62 152 #define AML_LOCAL3 (UINT16) 0x63 153 #define AML_LOCAL4 (UINT16) 0x64 154 #define AML_LOCAL5 (UINT16) 0x65 155 #define AML_LOCAL6 (UINT16) 0x66 156 #define AML_LOCAL7 (UINT16) 0x67 157 #define AML_ARG_OP (UINT16) 0x68 158 #define AML_ARG0 (UINT16) 0x68 159 #define AML_ARG1 (UINT16) 0x69 160 #define AML_ARG2 (UINT16) 0x6a 161 #define AML_ARG3 (UINT16) 0x6b 162 #define AML_ARG4 (UINT16) 0x6c 163 #define AML_ARG5 (UINT16) 0x6d 164 #define AML_ARG6 (UINT16) 0x6e 165 #define AML_STORE_OP (UINT16) 0x70 166 #define AML_REF_OF_OP (UINT16) 0x71 167 #define AML_ADD_OP (UINT16) 0x72 168 #define AML_CONCAT_OP (UINT16) 0x73 169 #define AML_SUBTRACT_OP (UINT16) 0x74 170 #define AML_INCREMENT_OP (UINT16) 0x75 171 #define AML_DECREMENT_OP (UINT16) 0x76 172 #define AML_MULTIPLY_OP (UINT16) 0x77 173 #define AML_DIVIDE_OP (UINT16) 0x78 174 #define AML_SHIFT_LEFT_OP (UINT16) 0x79 175 #define AML_SHIFT_RIGHT_OP (UINT16) 0x7a 176 #define AML_BIT_AND_OP (UINT16) 0x7b 177 #define AML_BIT_NAND_OP (UINT16) 0x7c 178 #define AML_BIT_OR_OP (UINT16) 0x7d 179 #define AML_BIT_NOR_OP (UINT16) 0x7e 180 #define AML_BIT_XOR_OP (UINT16) 0x7f 181 #define AML_BIT_NOT_OP (UINT16) 0x80 182 #define AML_FIND_SET_LEFT_BIT_OP (UINT16) 0x81 183 #define AML_FIND_SET_RIGHT_BIT_OP (UINT16) 0x82 184 #define AML_DEREF_OF_OP (UINT16) 0x83 185 #define AML_CONCAT_RES_OP (UINT16) 0x84 /* ACPI 2.0 */ 186 #define AML_MOD_OP (UINT16) 0x85 /* ACPI 2.0 */ 187 #define AML_NOTIFY_OP (UINT16) 0x86 188 #define AML_SIZE_OF_OP (UINT16) 0x87 189 #define AML_INDEX_OP (UINT16) 0x88 190 #define AML_MATCH_OP (UINT16) 0x89 191 #define AML_CREATE_DWORD_FIELD_OP (UINT16) 0x8a 192 #define AML_CREATE_WORD_FIELD_OP (UINT16) 0x8b 193 #define AML_CREATE_BYTE_FIELD_OP (UINT16) 0x8c 194 #define AML_CREATE_BIT_FIELD_OP (UINT16) 0x8d 195 #define AML_TYPE_OP (UINT16) 0x8e 196 #define AML_CREATE_QWORD_FIELD_OP (UINT16) 0x8f /* ACPI 2.0 */ 197 #define AML_LAND_OP (UINT16) 0x90 198 #define AML_LOR_OP (UINT16) 0x91 199 #define AML_LNOT_OP (UINT16) 0x92 200 #define AML_LEQUAL_OP (UINT16) 0x93 201 #define AML_LGREATER_OP (UINT16) 0x94 202 #define AML_LLESS_OP (UINT16) 0x95 203 #define AML_TO_BUFFER_OP (UINT16) 0x96 /* ACPI 2.0 */ 204 #define AML_TO_DECSTRING_OP (UINT16) 0x97 /* ACPI 2.0 */ 205 #define AML_TO_HEXSTRING_OP (UINT16) 0x98 /* ACPI 2.0 */ 206 #define AML_TO_INTEGER_OP (UINT16) 0x99 /* ACPI 2.0 */ 207 #define AML_TO_STRING_OP (UINT16) 0x9c /* ACPI 2.0 */ 208 #define AML_COPY_OP (UINT16) 0x9d /* ACPI 2.0 */ 209 #define AML_MID_OP (UINT16) 0x9e /* ACPI 2.0 */ 210 #define AML_CONTINUE_OP (UINT16) 0x9f /* ACPI 2.0 */ 211 #define AML_IF_OP (UINT16) 0xa0 212 #define AML_ELSE_OP (UINT16) 0xa1 213 #define AML_WHILE_OP (UINT16) 0xa2 214 #define AML_NOOP_OP (UINT16) 0xa3 215 #define AML_RETURN_OP (UINT16) 0xa4 216 #define AML_BREAK_OP (UINT16) 0xa5 217 #define AML_BREAK_POINT_OP (UINT16) 0xcc 218 #define AML_ONES_OP (UINT16) 0xff 219 220 /* prefixed opcodes */ 221 222 #define AML_EXTENDED_OPCODE (UINT16) 0x5b00 /* prefix for 2-byte opcodes */ 223 224 #define AML_MUTEX_OP (UINT16) 0x5b01 225 #define AML_EVENT_OP (UINT16) 0x5b02 226 #define AML_SHIFT_RIGHT_BIT_OP (UINT16) 0x5b10 227 #define AML_SHIFT_LEFT_BIT_OP (UINT16) 0x5b11 228 #define AML_COND_REF_OF_OP (UINT16) 0x5b12 229 #define AML_CREATE_FIELD_OP (UINT16) 0x5b13 230 #define AML_LOAD_TABLE_OP (UINT16) 0x5b1f /* ACPI 2.0 */ 231 #define AML_LOAD_OP (UINT16) 0x5b20 232 #define AML_STALL_OP (UINT16) 0x5b21 233 #define AML_SLEEP_OP (UINT16) 0x5b22 234 #define AML_ACQUIRE_OP (UINT16) 0x5b23 235 #define AML_SIGNAL_OP (UINT16) 0x5b24 236 #define AML_WAIT_OP (UINT16) 0x5b25 237 #define AML_RESET_OP (UINT16) 0x5b26 238 #define AML_RELEASE_OP (UINT16) 0x5b27 239 #define AML_FROM_BCD_OP (UINT16) 0x5b28 240 #define AML_TO_BCD_OP (UINT16) 0x5b29 241 #define AML_UNLOAD_OP (UINT16) 0x5b2a 242 #define AML_REVISION_OP (UINT16) 0x5b30 243 #define AML_DEBUG_OP (UINT16) 0x5b31 244 #define AML_FATAL_OP (UINT16) 0x5b32 245 #define AML_TIMER_OP (UINT16) 0x5b33 /* ACPI 3.0 */ 246 #define AML_REGION_OP (UINT16) 0x5b80 247 #define AML_FIELD_OP (UINT16) 0x5b81 248 #define AML_DEVICE_OP (UINT16) 0x5b82 249 #define AML_PROCESSOR_OP (UINT16) 0x5b83 250 #define AML_POWER_RES_OP (UINT16) 0x5b84 251 #define AML_THERMAL_ZONE_OP (UINT16) 0x5b85 252 #define AML_INDEX_FIELD_OP (UINT16) 0x5b86 253 #define AML_BANK_FIELD_OP (UINT16) 0x5b87 254 #define AML_DATA_REGION_OP (UINT16) 0x5b88 /* ACPI 2.0 */ 255 256 257 /* Bogus opcodes (they are actually two separate opcodes) */ 258 259 #define AML_LGREATEREQUAL_OP (UINT16) 0x9295 260 #define AML_LLESSEQUAL_OP (UINT16) 0x9294 261 #define AML_LNOTEQUAL_OP (UINT16) 0x9293 262 263 264 /* 265 * Internal opcodes 266 * Use only "Unknown" AML opcodes, don't attempt to use 267 * any valid ACPI ASCII values (A-Z, 0-9, '-') 268 */ 269 #define AML_INT_NAMEPATH_OP (UINT16) 0x002d 270 #define AML_INT_NAMEDFIELD_OP (UINT16) 0x0030 271 #define AML_INT_RESERVEDFIELD_OP (UINT16) 0x0031 272 #define AML_INT_ACCESSFIELD_OP (UINT16) 0x0032 273 #define AML_INT_BYTELIST_OP (UINT16) 0x0033 274 #define AML_INT_STATICSTRING_OP (UINT16) 0x0034 275 #define AML_INT_METHODCALL_OP (UINT16) 0x0035 276 #define AML_INT_RETURN_VALUE_OP (UINT16) 0x0036 277 #define AML_INT_EVAL_SUBTREE_OP (UINT16) 0x0037 278 279 280 #define ARG_NONE 0x0 281 282 /* 283 * Argument types for the AML Parser 284 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments. 285 * There can be up to 31 unique argument types 286 * Zero is reserved as end-of-list indicator 287 */ 288 #define ARGP_BYTEDATA 0x01 289 #define ARGP_BYTELIST 0x02 290 #define ARGP_CHARLIST 0x03 291 #define ARGP_DATAOBJ 0x04 292 #define ARGP_DATAOBJLIST 0x05 293 #define ARGP_DWORDDATA 0x06 294 #define ARGP_FIELDLIST 0x07 295 #define ARGP_NAME 0x08 296 #define ARGP_NAMESTRING 0x09 297 #define ARGP_OBJLIST 0x0A 298 #define ARGP_PKGLENGTH 0x0B 299 #define ARGP_SUPERNAME 0x0C 300 #define ARGP_TARGET 0x0D 301 #define ARGP_TERMARG 0x0E 302 #define ARGP_TERMLIST 0x0F 303 #define ARGP_WORDDATA 0x10 304 #define ARGP_QWORDDATA 0x11 305 #define ARGP_SIMPLENAME 0x12 306 307 /* 308 * Resolved argument types for the AML Interpreter 309 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments. 310 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator) 311 * 312 * Note1: These values are completely independent from the ACPI_TYPEs 313 * i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER 314 * 315 * Note2: If and when 5 bits becomes insufficient, it would probably be best 316 * to convert to a 6-byte array of argument types, allowing 8 bits per argument. 317 */ 318 319 /* Single, simple types */ 320 321 #define ARGI_ANYTYPE 0x01 /* Don't care */ 322 #define ARGI_PACKAGE 0x02 323 #define ARGI_EVENT 0x03 324 #define ARGI_MUTEX 0x04 325 #define ARGI_DDBHANDLE 0x05 326 327 /* Interchangeable types (via implicit conversion) */ 328 329 #define ARGI_INTEGER 0x06 330 #define ARGI_STRING 0x07 331 #define ARGI_BUFFER 0x08 332 #define ARGI_BUFFER_OR_STRING 0x09 /* Used by MID op only */ 333 #define ARGI_COMPUTEDATA 0x0A /* Buffer, String, or Integer */ 334 335 /* Reference objects */ 336 337 #define ARGI_INTEGER_REF 0x0B 338 #define ARGI_OBJECT_REF 0x0C 339 #define ARGI_DEVICE_REF 0x0D 340 #define ARGI_REFERENCE 0x0E 341 #define ARGI_TARGETREF 0x0F /* Target, subject to implicit conversion */ 342 #define ARGI_FIXED_TARGET 0x10 /* Target, no implicit conversion */ 343 #define ARGI_SIMPLE_TARGET 0x11 /* Name, Local, Arg -- no implicit conversion */ 344 345 /* Multiple/complex types */ 346 347 #define ARGI_DATAOBJECT 0x12 /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/ 348 #define ARGI_COMPLEXOBJ 0x13 /* Buffer, String, or package (Used by INDEX op only) */ 349 #define ARGI_REF_OR_STRING 0x14 /* Reference or String (Used by DEREFOF op only) */ 350 #define ARGI_REGION_OR_FIELD 0x15 /* Used by LOAD op only */ 351 #define ARGI_DATAREFOBJ 0x16 352 353 /* Note: types above can expand to 0x1F maximum */ 354 355 #define ARGI_INVALID_OPCODE 0xFFFFFFFF 356 357 358 /* 359 * hash offsets 360 */ 361 #define AML_EXTOP_HASH_OFFSET 22 362 #define AML_LNOT_HASH_OFFSET 19 363 364 365 /* 366 * opcode groups and types 367 */ 368 #define OPGRP_NAMED 0x01 369 #define OPGRP_FIELD 0x02 370 #define OPGRP_BYTELIST 0x04 371 372 373 /* 374 * Opcode information 375 */ 376 377 /* Opcode flags */ 378 379 #define AML_LOGICAL 0x0001 380 #define AML_LOGICAL_NUMERIC 0x0002 381 #define AML_MATH 0x0004 382 #define AML_CREATE 0x0008 383 #define AML_FIELD 0x0010 384 #define AML_DEFER 0x0020 385 #define AML_NAMED 0x0040 386 #define AML_NSNODE 0x0080 387 #define AML_NSOPCODE 0x0100 388 #define AML_NSOBJECT 0x0200 389 #define AML_HAS_RETVAL 0x0400 390 #define AML_HAS_TARGET 0x0800 391 #define AML_HAS_ARGS 0x1000 392 #define AML_CONSTANT 0x2000 393 #define AML_NO_OPERAND_RESOLVE 0x4000 394 395 /* Convenient flag groupings */ 396 397 #define AML_FLAGS_EXEC_0A_0T_1R AML_HAS_RETVAL 398 #define AML_FLAGS_EXEC_1A_0T_0R AML_HAS_ARGS /* Monadic1 */ 399 #define AML_FLAGS_EXEC_1A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Monadic2 */ 400 #define AML_FLAGS_EXEC_1A_1T_0R AML_HAS_ARGS | AML_HAS_TARGET 401 #define AML_FLAGS_EXEC_1A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */ 402 #define AML_FLAGS_EXEC_2A_0T_0R AML_HAS_ARGS /* Dyadic1 */ 403 #define AML_FLAGS_EXEC_2A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Dyadic2 */ 404 #define AML_FLAGS_EXEC_2A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R */ 405 #define AML_FLAGS_EXEC_2A_2T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL 406 #define AML_FLAGS_EXEC_3A_0T_0R AML_HAS_ARGS 407 #define AML_FLAGS_EXEC_3A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL 408 #define AML_FLAGS_EXEC_6A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL 409 410 411 /* 412 * The opcode Type is used in a dispatch table, do not change 413 * without updating the table. 414 */ 415 #define AML_TYPE_EXEC_0A_0T_1R 0x00 416 #define AML_TYPE_EXEC_1A_0T_0R 0x01 /* Monadic1 */ 417 #define AML_TYPE_EXEC_1A_0T_1R 0x02 /* Monadic2 */ 418 #define AML_TYPE_EXEC_1A_1T_0R 0x03 419 #define AML_TYPE_EXEC_1A_1T_1R 0x04 /* Monadic2R */ 420 #define AML_TYPE_EXEC_2A_0T_0R 0x05 /* Dyadic1 */ 421 #define AML_TYPE_EXEC_2A_0T_1R 0x06 /* Dyadic2 */ 422 #define AML_TYPE_EXEC_2A_1T_1R 0x07 /* Dyadic2R */ 423 #define AML_TYPE_EXEC_2A_2T_1R 0x08 424 #define AML_TYPE_EXEC_3A_0T_0R 0x09 425 #define AML_TYPE_EXEC_3A_1T_1R 0x0A 426 #define AML_TYPE_EXEC_6A_0T_1R 0x0B 427 /* End of types used in dispatch table */ 428 429 #define AML_TYPE_LITERAL 0x0B 430 #define AML_TYPE_CONSTANT 0x0C 431 #define AML_TYPE_METHOD_ARGUMENT 0x0D 432 #define AML_TYPE_LOCAL_VARIABLE 0x0E 433 #define AML_TYPE_DATA_TERM 0x0F 434 435 /* Generic for an op that returns a value */ 436 437 #define AML_TYPE_METHOD_CALL 0x10 438 439 /* Misc */ 440 441 #define AML_TYPE_CREATE_FIELD 0x11 442 #define AML_TYPE_CREATE_OBJECT 0x12 443 #define AML_TYPE_CONTROL 0x13 444 #define AML_TYPE_NAMED_NO_OBJ 0x14 445 #define AML_TYPE_NAMED_FIELD 0x15 446 #define AML_TYPE_NAMED_SIMPLE 0x16 447 #define AML_TYPE_NAMED_COMPLEX 0x17 448 #define AML_TYPE_RETURN 0x18 449 450 #define AML_TYPE_UNDEFINED 0x19 451 #define AML_TYPE_BOGUS 0x1A 452 453 /* AML Package Length encodings */ 454 455 #define ACPI_AML_PACKAGE_TYPE1 0x40 456 #define ACPI_AML_PACKAGE_TYPE2 0x4000 457 #define ACPI_AML_PACKAGE_TYPE3 0x400000 458 #define ACPI_AML_PACKAGE_TYPE4 0x40000000 459 460 /* 461 * Opcode classes 462 */ 463 #define AML_CLASS_EXECUTE 0x00 464 #define AML_CLASS_CREATE 0x01 465 #define AML_CLASS_ARGUMENT 0x02 466 #define AML_CLASS_NAMED_OBJECT 0x03 467 #define AML_CLASS_CONTROL 0x04 468 #define AML_CLASS_ASCII 0x05 469 #define AML_CLASS_PREFIX 0x06 470 #define AML_CLASS_INTERNAL 0x07 471 #define AML_CLASS_RETURN_VALUE 0x08 472 #define AML_CLASS_METHOD_CALL 0x09 473 #define AML_CLASS_UNKNOWN 0x0A 474 475 476 /* Predefined Operation Region SpaceIDs */ 477 478 typedef enum 479 { 480 REGION_MEMORY = 0, 481 REGION_IO, 482 REGION_PCI_CONFIG, 483 REGION_EC, 484 REGION_SMBUS, 485 REGION_CMOS, 486 REGION_PCI_BAR, 487 REGION_DATA_TABLE, /* Internal use only */ 488 REGION_FIXED_HW = 0x7F 489 490 } AML_REGION_TYPES; 491 492 493 /* Comparison operation codes for MatchOp operator */ 494 495 typedef enum 496 { 497 MATCH_MTR = 0, 498 MATCH_MEQ = 1, 499 MATCH_MLE = 2, 500 MATCH_MLT = 3, 501 MATCH_MGE = 4, 502 MATCH_MGT = 5 503 504 } AML_MATCH_OPERATOR; 505 506 #define MAX_MATCH_OPERATOR 5 507 508 509 /* 510 * FieldFlags 511 * 512 * This byte is extracted from the AML and includes three separate 513 * pieces of information about the field: 514 * 1) The field access type 515 * 2) The field update rule 516 * 3) The lock rule for the field 517 * 518 * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.) 519 * 04 : LockRule (1 == Lock) 520 * 05 - 06 : UpdateRule 521 */ 522 #define AML_FIELD_ACCESS_TYPE_MASK 0x0F 523 #define AML_FIELD_LOCK_RULE_MASK 0x10 524 #define AML_FIELD_UPDATE_RULE_MASK 0x60 525 526 527 /* 1) Field Access Types */ 528 529 typedef enum 530 { 531 AML_FIELD_ACCESS_ANY = 0x00, 532 AML_FIELD_ACCESS_BYTE = 0x01, 533 AML_FIELD_ACCESS_WORD = 0x02, 534 AML_FIELD_ACCESS_DWORD = 0x03, 535 AML_FIELD_ACCESS_QWORD = 0x04, /* ACPI 2.0 */ 536 AML_FIELD_ACCESS_BUFFER = 0x05 /* ACPI 2.0 */ 537 538 } AML_ACCESS_TYPE; 539 540 541 /* 2) Field Lock Rules */ 542 543 typedef enum 544 { 545 AML_FIELD_LOCK_NEVER = 0x00, 546 AML_FIELD_LOCK_ALWAYS = 0x10 547 548 } AML_LOCK_RULE; 549 550 551 /* 3) Field Update Rules */ 552 553 typedef enum 554 { 555 AML_FIELD_UPDATE_PRESERVE = 0x00, 556 AML_FIELD_UPDATE_WRITE_AS_ONES = 0x20, 557 AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40 558 559 } AML_UPDATE_RULE; 560 561 562 /* 563 * Field Access Attributes. 564 * This byte is extracted from the AML via the 565 * AccessAs keyword 566 */ 567 typedef enum 568 { 569 AML_FIELD_ATTRIB_SMB_QUICK = 0x02, 570 AML_FIELD_ATTRIB_SMB_SEND_RCV = 0x04, 571 AML_FIELD_ATTRIB_SMB_BYTE = 0x06, 572 AML_FIELD_ATTRIB_SMB_WORD = 0x08, 573 AML_FIELD_ATTRIB_SMB_BLOCK = 0x0A, 574 AML_FIELD_ATTRIB_SMB_WORD_CALL = 0x0C, 575 AML_FIELD_ATTRIB_SMB_BLOCK_CALL = 0x0D 576 577 } AML_ACCESS_ATTRIBUTE; 578 579 580 /* Bit fields in MethodFlags byte */ 581 582 #define AML_METHOD_ARG_COUNT 0x07 583 #define AML_METHOD_SERIALIZED 0x08 584 #define AML_METHOD_SYNCH_LEVEL 0xF0 585 586 /* METHOD_FLAGS_ARG_COUNT is not used internally, define additional flags */ 587 588 #define AML_METHOD_INTERNAL_ONLY 0x01 589 #define AML_METHOD_RESERVED1 0x02 590 #define AML_METHOD_RESERVED2 0x04 591 592 593 #endif /* __AMLCODE_H__ */ 594