amlcode.h revision 80062
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: 53 $ 7 * 8 *****************************************************************************/ 9 10/****************************************************************************** 11 * 12 * 1. Copyright Notice 13 * 14 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 123/* primary opcodes */ 124 125#define AML_NULL_CHAR (UINT16) 0x00 126 127#define AML_ZERO_OP (UINT16) 0x00 128#define AML_ONE_OP (UINT16) 0x01 129#define AML_UNASSIGNED (UINT16) 0x02 130#define AML_ALIAS_OP (UINT16) 0x06 131#define AML_NAME_OP (UINT16) 0x08 132#define AML_BYTE_OP (UINT16) 0x0a 133#define AML_WORD_OP (UINT16) 0x0b 134#define AML_DWORD_OP (UINT16) 0x0c 135#define AML_STRING_OP (UINT16) 0x0d 136#define AML_QWORD_OP (UINT16) 0x0e /* ACPI 2.0 */ 137#define AML_SCOPE_OP (UINT16) 0x10 138#define AML_BUFFER_OP (UINT16) 0x11 139#define AML_PACKAGE_OP (UINT16) 0x12 140#define AML_VAR_PACKAGE_OP (UINT16) 0x13 /* ACPI 2.0 */ 141#define AML_METHOD_OP (UINT16) 0x14 142#define AML_DUAL_NAME_PREFIX (UINT16) 0x2e 143#define AML_MULTI_NAME_PREFIX_OP (UINT16) 0x2f 144#define AML_NAME_CHAR_SUBSEQ (UINT16) 0x30 145#define AML_NAME_CHAR_FIRST (UINT16) 0x41 146#define AML_OP_PREFIX (UINT16) 0x5b 147#define AML_ROOT_PREFIX (UINT16) 0x5c 148#define AML_PARENT_PREFIX (UINT16) 0x5e 149#define AML_LOCAL_OP (UINT16) 0x60 150#define AML_LOCAL0 (UINT16) 0x60 151#define AML_LOCAL1 (UINT16) 0x61 152#define AML_LOCAL2 (UINT16) 0x62 153#define AML_LOCAL3 (UINT16) 0x63 154#define AML_LOCAL4 (UINT16) 0x64 155#define AML_LOCAL5 (UINT16) 0x65 156#define AML_LOCAL6 (UINT16) 0x66 157#define AML_LOCAL7 (UINT16) 0x67 158#define AML_ARG_OP (UINT16) 0x68 159#define AML_ARG0 (UINT16) 0x68 160#define AML_ARG1 (UINT16) 0x69 161#define AML_ARG2 (UINT16) 0x6a 162#define AML_ARG3 (UINT16) 0x6b 163#define AML_ARG4 (UINT16) 0x6c 164#define AML_ARG5 (UINT16) 0x6d 165#define AML_ARG6 (UINT16) 0x6e 166#define AML_STORE_OP (UINT16) 0x70 167#define AML_REF_OF_OP (UINT16) 0x71 168#define AML_ADD_OP (UINT16) 0x72 169#define AML_CONCAT_OP (UINT16) 0x73 170#define AML_SUBTRACT_OP (UINT16) 0x74 171#define AML_INCREMENT_OP (UINT16) 0x75 172#define AML_DECREMENT_OP (UINT16) 0x76 173#define AML_MULTIPLY_OP (UINT16) 0x77 174#define AML_DIVIDE_OP (UINT16) 0x78 175#define AML_SHIFT_LEFT_OP (UINT16) 0x79 176#define AML_SHIFT_RIGHT_OP (UINT16) 0x7a 177#define AML_BIT_AND_OP (UINT16) 0x7b 178#define AML_BIT_NAND_OP (UINT16) 0x7c 179#define AML_BIT_OR_OP (UINT16) 0x7d 180#define AML_BIT_NOR_OP (UINT16) 0x7e 181#define AML_BIT_XOR_OP (UINT16) 0x7f 182#define AML_BIT_NOT_OP (UINT16) 0x80 183#define AML_FIND_SET_LEFT_BIT_OP (UINT16) 0x81 184#define AML_FIND_SET_RIGHT_BIT_OP (UINT16) 0x82 185#define AML_DEREF_OF_OP (UINT16) 0x83 186#define AML_CONCAT_RES_OP (UINT16) 0x84 /* ACPI 2.0 */ 187#define AML_MOD_OP (UINT16) 0x85 /* ACPI 2.0 */ 188#define AML_NOTIFY_OP (UINT16) 0x86 189#define AML_SIZE_OF_OP (UINT16) 0x87 190#define AML_INDEX_OP (UINT16) 0x88 191#define AML_MATCH_OP (UINT16) 0x89 192#define AML_CREATE_DWORD_FIELD_OP (UINT16) 0x8a 193#define AML_CREATE_WORD_FIELD_OP (UINT16) 0x8b 194#define AML_CREATE_BYTE_FIELD_OP (UINT16) 0x8c 195#define AML_CREATE_BIT_FIELD_OP (UINT16) 0x8d 196#define AML_TYPE_OP (UINT16) 0x8e 197#define AML_CREATE_QWORD_FIELD_OP (UINT16) 0x8f /* ACPI 2.0 */ 198#define AML_LAND_OP (UINT16) 0x90 199#define AML_LOR_OP (UINT16) 0x91 200#define AML_LNOT_OP (UINT16) 0x92 201#define AML_LEQUAL_OP (UINT16) 0x93 202#define AML_LGREATER_OP (UINT16) 0x94 203#define AML_LLESS_OP (UINT16) 0x95 204#define AML_TO_BUFFER_OP (UINT16) 0x96 /* ACPI 2.0 */ 205#define AML_TO_DECSTRING_OP (UINT16) 0x97 /* ACPI 2.0 */ 206#define AML_TO_HEXSTRING_OP (UINT16) 0x98 /* ACPI 2.0 */ 207#define AML_TO_INTEGER_OP (UINT16) 0x99 /* ACPI 2.0 */ 208#define AML_TO_STRING_OP (UINT16) 0x9c /* ACPI 2.0 */ 209#define AML_COPY_OP (UINT16) 0x9d /* ACPI 2.0 */ 210#define AML_MID_OP (UINT16) 0x9e /* ACPI 2.0 */ 211#define AML_CONTINUE_OP (UINT16) 0x9f /* ACPI 2.0 */ 212#define AML_IF_OP (UINT16) 0xa0 213#define AML_ELSE_OP (UINT16) 0xa1 214#define AML_WHILE_OP (UINT16) 0xa2 215#define AML_NOOP_OP (UINT16) 0xa3 216#define AML_RETURN_OP (UINT16) 0xa4 217#define AML_BREAK_OP (UINT16) 0xa5 218#define AML_BREAK_POINT_OP (UINT16) 0xcc 219#define AML_ONES_OP (UINT16) 0xff 220 221/* prefixed opcodes */ 222 223#define AML_EXTOP (UINT16) 0x005b 224 225 226#define AML_MUTEX_OP (UINT16) 0x5b01 227#define AML_EVENT_OP (UINT16) 0x5b02 228#define AML_SHIFT_RIGHT_BIT_OP (UINT16) 0x5b10 229#define AML_SHIFT_LEFT_BIT_OP (UINT16) 0x5b11 230#define AML_COND_REF_OF_OP (UINT16) 0x5b12 231#define AML_CREATE_FIELD_OP (UINT16) 0x5b13 232#define AML_LOAD_TABLE_OP (UINT16) 0x5b1f /* ACPI 2.0 */ 233#define AML_LOAD_OP (UINT16) 0x5b20 234#define AML_STALL_OP (UINT16) 0x5b21 235#define AML_SLEEP_OP (UINT16) 0x5b22 236#define AML_ACQUIRE_OP (UINT16) 0x5b23 237#define AML_SIGNAL_OP (UINT16) 0x5b24 238#define AML_WAIT_OP (UINT16) 0x5b25 239#define AML_RESET_OP (UINT16) 0x5b26 240#define AML_RELEASE_OP (UINT16) 0x5b27 241#define AML_FROM_BCD_OP (UINT16) 0x5b28 242#define AML_TO_BCD_OP (UINT16) 0x5b29 243#define AML_UNLOAD_OP (UINT16) 0x5b2a 244#define AML_REVISION_OP (UINT16) 0x5b30 245#define AML_DEBUG_OP (UINT16) 0x5b31 246#define AML_FATAL_OP (UINT16) 0x5b32 247#define AML_REGION_OP (UINT16) 0x5b80 248#define AML_FIELD_OP (UINT16) 0x5b81 249#define AML_DEVICE_OP (UINT16) 0x5b82 250#define AML_PROCESSOR_OP (UINT16) 0x5b83 251#define AML_POWER_RES_OP (UINT16) 0x5b84 252#define AML_THERMAL_ZONE_OP (UINT16) 0x5b85 253#define AML_INDEX_FIELD_OP (UINT16) 0x5b86 254#define AML_BANK_FIELD_OP (UINT16) 0x5b87 255#define AML_DATA_REGION_OP (UINT16) 0x5b88 /* ACPI 2.0 */ 256 257 258/* Bogus opcodes (they are actually two separate opcodes) */ 259 260#define AML_LGREATEREQUAL_OP (UINT16) 0x9295 261#define AML_LLESSEQUAL_OP (UINT16) 0x9294 262#define AML_LNOTEQUAL_OP (UINT16) 0x9293 263 264 265/* 266 * Internal opcodes 267 * Use only "Unknown" AML opcodes, don't attempt to use 268 * any valid ACPI ASCII values (A-Z, 0-9, '-') 269 */ 270 271#define AML_INT_NAMEPATH_OP (UINT16) 0x002d 272#define AML_INT_NAMEDFIELD_OP (UINT16) 0x0030 273#define AML_INT_RESERVEDFIELD_OP (UINT16) 0x0031 274#define AML_INT_ACCESSFIELD_OP (UINT16) 0x0032 275#define AML_INT_BYTELIST_OP (UINT16) 0x0033 276#define AML_INT_STATICSTRING_OP (UINT16) 0x0034 277#define AML_INT_METHODCALL_OP (UINT16) 0x0035 278#define AML_INT_RETURN_VALUE_OP (UINT16) 0x0036 279 280 281#define ARG_NONE 0x0 282 283/* 284 * Argument types for the AML Parser 285 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments. 286 * There can be up to 31 unique argument types 287 */ 288 289#define ARGP_BYTEDATA 0x01 290#define ARGP_BYTELIST 0x02 291#define ARGP_CHARLIST 0x03 292#define ARGP_DATAOBJ 0x04 293#define ARGP_DATAOBJLIST 0x05 294#define ARGP_DWORDDATA 0x06 295#define ARGP_FIELDLIST 0x07 296#define ARGP_NAME 0x08 297#define ARGP_NAMESTRING 0x09 298#define ARGP_OBJLIST 0x0A 299#define ARGP_PKGLENGTH 0x0B 300#define ARGP_SUPERNAME 0x0C 301#define ARGP_TARGET 0x0D 302#define ARGP_TERMARG 0x0E 303#define ARGP_TERMLIST 0x0F 304#define ARGP_WORDDATA 0x10 305#define ARGP_QWORDDATA 0x11 306#define ARGP_SIMPLENAME 0x12 307 308/* 309 * Resolved argument types for the AML Interpreter 310 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments. 311 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator) 312 */ 313 314/* "Standard" ACPI types are 1-15 (0x0F) */ 315 316#define ARGI_INTEGER ACPI_TYPE_INTEGER /* 1 */ 317#define ARGI_STRING ACPI_TYPE_STRING /* 2 */ 318#define ARGI_BUFFER ACPI_TYPE_BUFFER /* 3 */ 319#define ARGI_PACKAGE ACPI_TYPE_PACKAGE /* 4 */ 320#define ARGI_EVENT ACPI_TYPE_EVENT 321#define ARGI_MUTEX ACPI_TYPE_MUTEX 322#define ARGI_REGION ACPI_TYPE_REGION 323#define ARGI_DDBHANDLE ACPI_TYPE_DDB_HANDLE 324 325/* Custom types are 0x10 through 0x1F */ 326 327#define ARGI_IF 0x10 328#define ARGI_ANYOBJECT 0x11 329#define ARGI_ANYTYPE 0x12 330#define ARGI_COMPUTEDATA 0x13 /* Buffer, String, or Integer */ 331#define ARGI_DATAOBJECT 0x14 /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/ 332#define ARGI_COMPLEXOBJ 0x15 /* Buffer, String, or package (Used by INDEX op only) */ 333#define ARGI_INTEGER_REF 0x16 334#define ARGI_OBJECT_REF 0x17 335#define ARGI_DEVICE_REF 0x18 336#define ARGI_REFERENCE 0x19 337#define ARGI_TARGETREF 0x1A /* Target, subject to implicit conversion */ 338#define ARGI_FIXED_TARGET 0x1B /* Target, no implicit conversion */ 339#define ARGI_SIMPLE_TARGET 0x1C /* Name, Local, Arg -- no implicit conversion */ 340#define ARGI_BUFFERSTRING 0x1D 341 342#define ARGI_INVALID_OPCODE 0xFFFFFFFF 343 344 345/* 346 * hash offsets 347 */ 348#define AML_EXTOP_HASH_OFFSET 22 349#define AML_LNOT_HASH_OFFSET 19 350 351 352/* 353 * opcode groups and types 354 */ 355 356#define OPGRP_NAMED 0x01 357#define OPGRP_FIELD 0x02 358#define OPGRP_BYTELIST 0x04 359 360#define OPTYPE_UNDEFINED 0 361 362 363#define OPTYPE_LITERAL 1 364#define OPTYPE_CONSTANT 2 365#define OPTYPE_METHOD_ARGUMENT 3 366#define OPTYPE_LOCAL_VARIABLE 4 367#define OPTYPE_DATA_TERM 5 368 369/* Type 1 opcodes */ 370 371#define OPTYPE_MONADIC1 6 372#define OPTYPE_DYADIC1 7 373 374/* Type 2 opcodes */ 375 376#define OPTYPE_MONADIC2 8 377#define OPTYPE_MONADIC2R 9 378#define OPTYPE_DYADIC2 10 379#define OPTYPE_DYADIC2R 11 380#define OPTYPE_DYADIC2S 12 381 382/* Multi-operand (>=3) opcodes */ 383 384#define OPTYPE_TRIADIC 13 385#define OPTYPE_QUADRADIC 14 386#define OPTYPE_HEXADIC 15 387 388/* Generic for an op that returns a value */ 389 390#define OPTYPE_METHOD_CALL 16 391 392/* Misc */ 393 394#define OPTYPE_CREATE_FIELD 17 395#define OPTYPE_CONTROL 18 396#define OPTYPE_RECONFIGURATION 19 397#define OPTYPE_NAMED_OBJECT 20 398#define OPTYPE_RETURN 21 399 400#define OPTYPE_BOGUS 22 401 402 403/* Predefined Operation Region SpaceIDs */ 404 405typedef enum 406{ 407 REGION_MEMORY = 0, 408 REGION_IO, 409 REGION_PCI_CONFIG, 410 REGION_EC, 411 REGION_SMBUS, 412 REGION_CMOS, 413 REGION_PCI_BAR, 414 REGION_FIXED_HW = 0x7F, 415 416} AML_REGION_TYPES; 417 418 419/* Comparison operation codes for MatchOp operator */ 420 421typedef enum 422{ 423 MATCH_MTR = 0, 424 MATCH_MEQ = 1, 425 MATCH_MLE = 2, 426 MATCH_MLT = 3, 427 MATCH_MGE = 4, 428 MATCH_MGT = 5 429 430} AML_MATCH_OPERATOR; 431 432#define MAX_MATCH_OPERATOR 5 433 434 435/* Field Access Types */ 436 437#define ACCESS_TYPE_MASK 0x0f 438#define ACCESS_TYPE_SHIFT 0 439 440typedef enum 441{ 442 ACCESS_ANY_ACC = 0, 443 ACCESS_BYTE_ACC = 1, 444 ACCESS_WORD_ACC = 2, 445 ACCESS_DWORD_ACC = 3, 446 ACCESS_QWORD_ACC = 4, /* ACPI 2.0 */ 447 ACCESS_BLOCK_ACC = 4, 448 ACCESS_SMBSEND_RECV_ACC = 5, 449 ACCESS_SMBQUICK_ACC = 6 450 451} AML_ACCESS_TYPE; 452 453 454/* Field Lock Rules */ 455 456#define LOCK_RULE_MASK 0x10 457#define LOCK_RULE_SHIFT 4 458 459typedef enum 460{ 461 GLOCK_NEVER_LOCK = 0, 462 GLOCK_ALWAYS_LOCK = 1 463 464} AML_LOCK_RULE; 465 466 467/* Field Update Rules */ 468 469#define UPDATE_RULE_MASK 0x060 470#define UPDATE_RULE_SHIFT 5 471 472typedef enum 473{ 474 UPDATE_PRESERVE = 0, 475 UPDATE_WRITE_AS_ONES = 1, 476 UPDATE_WRITE_AS_ZEROS = 2 477 478} AML_UPDATE_RULE; 479 480 481/* bit fields in MethodFlags byte */ 482 483#define METHOD_FLAGS_ARG_COUNT 0x07 484#define METHOD_FLAGS_SERIALIZED 0x08 485#define METHOD_FLAGS_SYNCH_LEVEL 0xF0 486 487 488/* Array sizes. Used for range checking also */ 489 490#define NUM_REGION_TYPES 7 491#define NUM_ACCESS_TYPES 7 492#define NUM_UPDATE_RULES 3 493#define NUM_MATCH_OPS 7 494#define NUM_OPCODES 256 495#define NUM_FIELD_NAMES 2 496 497 498#define USER_REGION_BEGIN 0x80 499 500/* 501 * AML tables 502 */ 503 504#ifdef DEFINE_AML_GLOBALS 505 506/* External declarations for the AML tables */ 507 508extern UINT8 AcpiGbl_Aml [NUM_OPCODES]; 509extern UINT16 AcpiGbl_Pfx [NUM_OPCODES]; 510 511 512#endif /* DEFINE_AML_GLOBALS */ 513 514#endif /* __AMLCODE_H__ */ 515