amlcode.h revision 67754
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: 40 $ 7 * 8 *****************************************************************************/ 9 10/****************************************************************************** 11 * 12 * 1. Copyright Notice 13 * 14 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 15 * 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_DWORD_FIELD_OP (UINT16) 0x8a 193#define AML_WORD_FIELD_OP (UINT16) 0x8b 194#define AML_BYTE_FIELD_OP (UINT16) 0x8c 195#define AML_BIT_FIELD_OP (UINT16) 0x8d 196#define AML_TYPE_OP (UINT16) 0x8e 197#define AML_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_BUFF_OP (UINT16) 0x96 /* ACPI 2.0 */ 205#define AML_DEC_STR_OP (UINT16) 0x97 /* ACPI 2.0 */ 206#define AML_HEX_STR_OP (UINT16) 0x98 /* ACPI 2.0 */ 207#define AML_INT_OP (UINT16) 0x99 /* 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_EXTOP (UINT16) 0x005b 223 224 225#define AML_MUTEX_OP (UINT16) 0x5b01 226#define AML_EVENT_OP (UINT16) 0x5b02 227#define AML_SHIFT_RIGHT_BIT_OP (UINT16) 0x5b10 228#define AML_SHIFT_LEFT_BIT_OP (UINT16) 0x5b11 229#define AML_COND_REF_OF_OP (UINT16) 0x5b12 230#define AML_CREATE_FIELD_OP (UINT16) 0x5b13 231#define AML_LOAD_TABLE_OP (UINT16) 0x5b1f /* ACPI 2.0 */ 232#define AML_LOAD_OP (UINT16) 0x5b20 233#define AML_STALL_OP (UINT16) 0x5b21 234#define AML_SLEEP_OP (UINT16) 0x5b22 235#define AML_ACQUIRE_OP (UINT16) 0x5b23 236#define AML_SIGNAL_OP (UINT16) 0x5b24 237#define AML_WAIT_OP (UINT16) 0x5b25 238#define AML_RESET_OP (UINT16) 0x5b26 239#define AML_RELEASE_OP (UINT16) 0x5b27 240#define AML_FROM_BCD_OP (UINT16) 0x5b28 241#define AML_TO_BCD_OP (UINT16) 0x5b29 242#define AML_UNLOAD_OP (UINT16) 0x5b2a 243#define AML_REVISION_OP (UINT16) 0x5b30 244#define AML_DEBUG_OP (UINT16) 0x5b31 245#define AML_FATAL_OP (UINT16) 0x5b32 246#define AML_REGION_OP (UINT16) 0x5b80 247#define AML_DEF_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 270#define AML_NAMEPATH_OP (UINT16) 0x002d 271#define AML_NAMEDFIELD_OP (UINT16) 0x0030 272#define AML_RESERVEDFIELD_OP (UINT16) 0x0031 273#define AML_ACCESSFIELD_OP (UINT16) 0x0032 274#define AML_BYTELIST_OP (UINT16) 0x0033 275#define AML_STATICSTRING_OP (UINT16) 0x0034 276#define AML_METHODCALL_OP (UINT16) 0x0035 277#define AML_RETURN_VALUE_OP (UINT16) 0x0036 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 */ 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 305/* 306 * Resolved argument types for the AML Interpreter 307 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments. 308 * There can be up to 31 unique argument types 309 */ 310 311#define ARGI_ANYTYPE 0x01 312#define ARGI_TARGETREF 0x02 313#define ARGI_REFERENCE 0x03 314#define ARGI_IF 0x04 315#define ARGI_NUMBER 0x05 316#define ARGI_STRING 0x06 317#define ARGI_BUFFER 0x07 318#define ARGI_PACKAGE 0x08 319#define ARGI_DATAOBJECT 0x09 /* Buffer, string, package or reference to a Node - Used only by SizeOf operator*/ 320#define ARGI_COMPLEXOBJ 0x0A /* Buffer or package */ 321#define ARGI_MUTEX 0x0B 322#define ARGI_EVENT 0x0C 323#define ARGI_REGION 0x0D 324#define ARGI_DDBHANDLE 0x0E 325 326#define ARGI_INVALID_OPCODE 0xFFFFFFFF 327 328 329/* 330 * hash offsets 331 */ 332#define AML_EXTOP_HASH_OFFSET 22 333#define AML_LNOT_HASH_OFFSET 19 334 335 336/* 337 * opcode groups and types 338 */ 339 340#define OPGRP_NAMED 0x01 341#define OPGRP_FIELD 0x02 342#define OPGRP_BYTELIST 0x04 343 344#define OPTYPE_UNDEFINED 0 345 346 347#define OPTYPE_LITERAL 1 348#define OPTYPE_CONSTANT 2 349#define OPTYPE_METHOD_ARGUMENT 3 350#define OPTYPE_LOCAL_VARIABLE 4 351#define OPTYPE_DATA_TERM 5 352 353/* Type 1 opcodes */ 354 355#define OPTYPE_MONADIC1 6 356#define OPTYPE_DYADIC1 7 357 358 359/* Type 2 opcodes */ 360 361#define OPTYPE_MONADIC2 8 362#define OPTYPE_MONADIC2R 9 363#define OPTYPE_DYADIC2 10 364#define OPTYPE_DYADIC2R 11 365#define OPTYPE_DYADIC2S 12 366#define OPTYPE_INDEX 13 367#define OPTYPE_MATCH 14 368 369/* Generic for an op that returns a value */ 370 371#define OPTYPE_METHOD_CALL 15 372 373 374/* Misc */ 375 376#define OPTYPE_CREATE_FIELD 16 377#define OPTYPE_FATAL 17 378#define OPTYPE_CONTROL 18 379#define OPTYPE_RECONFIGURATION 19 380#define OPTYPE_NAMED_OBJECT 20 381#define OPTYPE_RETURN 21 382 383#define OPTYPE_BOGUS 22 384 385 386/* Predefined Operation Region SpaceIDs */ 387 388typedef enum 389{ 390 REGION_MEMORY = 0, 391 REGION_IO, 392 REGION_PCI_CONFIG, 393 REGION_EC, 394 REGION_SMBUS, 395 REGION_CMOS, 396 REGION_PCI_BAR 397 398} AML_REGION_TYPES; 399 400 401/* Comparison operation codes for MatchOp operator */ 402 403typedef enum 404{ 405 MATCH_MTR = 0, 406 MATCH_MEQ = 1, 407 MATCH_MLE = 2, 408 MATCH_MLT = 3, 409 MATCH_MGE = 4, 410 MATCH_MGT = 5 411 412} AML_MATCH_OPERATOR; 413 414#define MAX_MATCH_OPERATOR 5 415 416 417/* Field Access Types */ 418 419#define ACCESS_TYPE_MASK 0x0f 420#define ACCESS_TYPE_SHIFT 0 421 422typedef enum 423{ 424 ACCESS_ANY_ACC = 0, 425 ACCESS_BYTE_ACC = 1, 426 ACCESS_WORD_ACC = 2, 427 ACCESS_DWORD_ACC = 3, 428 ACCESS_BLOCK_ACC = 4, 429 ACCESS_SMBSEND_RECV_ACC = 5, 430 ACCESS_SMBQUICK_ACC = 6 431 432} AML_ACCESS_TYPE; 433 434 435/* Field Lock Rules */ 436 437#define LOCK_RULE_MASK 0x10 438#define LOCK_RULE_SHIFT 4 439 440typedef enum 441{ 442 GLOCK_NEVER_LOCK = 0, 443 GLOCK_ALWAYS_LOCK = 1 444 445} AML_LOCK_RULE; 446 447 448/* Field Update Rules */ 449 450#define UPDATE_RULE_MASK 0x060 451#define UPDATE_RULE_SHIFT 5 452 453typedef enum 454{ 455 UPDATE_PRESERVE = 0, 456 UPDATE_WRITE_AS_ONES = 1, 457 UPDATE_WRITE_AS_ZEROS = 2 458 459} AML_UPDATE_RULE; 460 461 462/* bit fields in MethodFlags byte */ 463 464#define METHOD_FLAGS_ARG_COUNT 0x07 465#define METHOD_FLAGS_SERIALIZED 0x08 466 467 468/* Array sizes. Used for range checking also */ 469 470#define NUM_REGION_TYPES 5 471#define NUM_ACCESS_TYPES 7 472#define NUM_UPDATE_RULES 3 473#define NUM_MATCH_OPS 7 474#define NUM_OPCODES 256 475#define NUM_FIELD_NAMES 2 476 477/* External declarations of the AML tables */ 478 479extern UINT8 AcpiGbl_Aml [NUM_OPCODES]; 480extern UINT16 AcpiGbl_Pfx [NUM_OPCODES]; 481extern NATIVE_CHAR *AcpiGbl_RegionTypes [NUM_REGION_TYPES]; 482extern NATIVE_CHAR *AcpiGbl_MatchOps [NUM_MATCH_OPS]; 483extern NATIVE_CHAR *AcpiGbl_AccessTypes [NUM_ACCESS_TYPES]; 484extern NATIVE_CHAR *AcpiGbl_UpdateRules [NUM_UPDATE_RULES]; 485extern NATIVE_CHAR *AcpiGbl_FENames [NUM_FIELD_NAMES]; 486 487 488/* 489 * AML tables 490 */ 491 492#ifdef DEFINE_AML_GLOBALS 493 494/* Data used in keeping track of fields */ 495 496NATIVE_CHAR *AcpiGbl_FENames[NUM_FIELD_NAMES] = 497{ 498 "skip", 499 "?access?" 500}; /* FE = Field Element */ 501 502 503/* Region type decoding */ 504 505NATIVE_CHAR *AcpiGbl_RegionTypes[NUM_REGION_TYPES] = 506{ 507 "SystemMemory", 508 "SystemIO", 509 "PCIConfig", 510 "EmbeddedControl", 511 "SMBus" 512}; 513 514 515NATIVE_CHAR *AcpiGbl_MatchOps[NUM_MATCH_OPS] = 516{ 517 "Error", 518 "MTR", 519 "MEQ", 520 "MLE", 521 "MLT", 522 "MGE", 523 "MGT" 524}; 525 526 527/* Access type decoding */ 528 529NATIVE_CHAR *AcpiGbl_AccessTypes[NUM_ACCESS_TYPES] = 530{ 531 "AnyAcc", 532 "ByteAcc", 533 "WordAcc", 534 "DWordAcc", 535 "BlockAcc", 536 "SMBSendRecvAcc", 537 "SMBQuickAcc" 538}; 539 540 541/* Update rule decoding */ 542 543NATIVE_CHAR *AcpiGbl_UpdateRules[NUM_UPDATE_RULES] = 544{ 545 "Preserve", 546 "WriteAsOnes", 547 "WriteAsZeros" 548}; 549 550 551#endif /* DEFINE_AML_GLOBALS */ 552 553#endif /* __AMLCODE_H__ */ 554