acdisasm.h revision 193251
1/****************************************************************************** 2 * 3 * Name: acdisasm.h - AML disassembler 4 * $Revision: 1.39 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#ifndef __ACDISASM_H__ 118#define __ACDISASM_H__ 119 120#include "amlresrc.h" 121 122 123#define BLOCK_NONE 0 124#define BLOCK_PAREN 1 125#define BLOCK_BRACE 2 126#define BLOCK_COMMA_LIST 4 127#define ACPI_DEFAULT_RESNAME *(UINT32 *) "__RD" 128 129typedef struct acpi_external_list 130{ 131 char *Path; 132 char *InternalPath; 133 struct acpi_external_list *Next; 134 UINT32 Value; 135 UINT16 Length; 136 UINT8 Type; 137 138} ACPI_EXTERNAL_LIST; 139 140extern ACPI_EXTERNAL_LIST *AcpiGbl_ExternalList; 141 142typedef const struct acpi_dmtable_info 143{ 144 UINT8 Opcode; 145 UINT8 Offset; 146 char *Name; 147 148} ACPI_DMTABLE_INFO; 149 150/* 151 * Values for Opcode above. 152 * Note: 0-7 must not change, used as a flag shift value 153 */ 154#define ACPI_DMT_FLAG0 0 155#define ACPI_DMT_FLAG1 1 156#define ACPI_DMT_FLAG2 2 157#define ACPI_DMT_FLAG3 3 158#define ACPI_DMT_FLAG4 4 159#define ACPI_DMT_FLAG5 5 160#define ACPI_DMT_FLAG6 6 161#define ACPI_DMT_FLAG7 7 162#define ACPI_DMT_FLAGS0 8 163#define ACPI_DMT_FLAGS2 9 164#define ACPI_DMT_UINT8 10 165#define ACPI_DMT_UINT16 11 166#define ACPI_DMT_UINT24 12 167#define ACPI_DMT_UINT32 13 168#define ACPI_DMT_UINT56 14 169#define ACPI_DMT_UINT64 15 170#define ACPI_DMT_STRING 16 171#define ACPI_DMT_NAME4 17 172#define ACPI_DMT_NAME6 18 173#define ACPI_DMT_NAME8 19 174#define ACPI_DMT_CHKSUM 20 175#define ACPI_DMT_SPACEID 21 176#define ACPI_DMT_GAS 22 177#define ACPI_DMT_DMAR 23 178#define ACPI_DMT_MADT 24 179#define ACPI_DMT_SRAT 25 180#define ACPI_DMT_EXIT 26 181#define ACPI_DMT_SIG 27 182 183typedef 184void (*ACPI_TABLE_HANDLER) ( 185 ACPI_TABLE_HEADER *Table); 186 187typedef struct acpi_dmtable_data 188{ 189 char *Signature; 190 ACPI_DMTABLE_INFO *TableInfo; 191 ACPI_TABLE_HANDLER TableHandler; 192 char *Name; 193 194} ACPI_DMTABLE_DATA; 195 196 197typedef struct acpi_op_walk_info 198{ 199 UINT32 Level; 200 UINT32 LastLevel; 201 UINT32 Count; 202 UINT32 BitOffset; 203 UINT32 Flags; 204 ACPI_WALK_STATE *WalkState; 205 206} ACPI_OP_WALK_INFO; 207 208typedef 209ACPI_STATUS (*ASL_WALK_CALLBACK) ( 210 ACPI_PARSE_OBJECT *Op, 211 UINT32 Level, 212 void *Context); 213 214typedef struct acpi_resource_tag 215{ 216 UINT32 BitIndex; 217 char *Tag; 218 219} ACPI_RESOURCE_TAG; 220 221/* Strings used for decoding flags to ASL keywords */ 222 223extern const char *AcpiGbl_WordDecode[]; 224extern const char *AcpiGbl_IrqDecode[]; 225extern const char *AcpiGbl_LockRule[]; 226extern const char *AcpiGbl_AccessTypes[]; 227extern const char *AcpiGbl_UpdateRules[]; 228extern const char *AcpiGbl_MatchOps[]; 229 230extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf0[]; 231extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1[]; 232extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf1a[]; 233extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2[]; 234extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf2a[]; 235extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf3[]; 236extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsf4[]; 237extern ACPI_DMTABLE_INFO AcpiDmTableInfoAsfHdr[]; 238extern ACPI_DMTABLE_INFO AcpiDmTableInfoBoot[]; 239extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep[]; 240extern ACPI_DMTABLE_INFO AcpiDmTableInfoCpep0[]; 241extern ACPI_DMTABLE_INFO AcpiDmTableInfoDbgp[]; 242extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar[]; 243extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarHdr[]; 244extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmarScope[]; 245extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar0[]; 246extern ACPI_DMTABLE_INFO AcpiDmTableInfoDmar1[]; 247extern ACPI_DMTABLE_INFO AcpiDmTableInfoEcdt[]; 248extern ACPI_DMTABLE_INFO AcpiDmTableInfoFacs[]; 249extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt1[]; 250extern ACPI_DMTABLE_INFO AcpiDmTableInfoFadt2[]; 251extern ACPI_DMTABLE_INFO AcpiDmTableInfoGas[]; 252extern ACPI_DMTABLE_INFO AcpiDmTableInfoHeader[]; 253extern ACPI_DMTABLE_INFO AcpiDmTableInfoHpet[]; 254extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt[]; 255extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt0[]; 256extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt1[]; 257extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt2[]; 258extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt3[]; 259extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt4[]; 260extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt5[]; 261extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt6[]; 262extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt7[]; 263extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadt8[]; 264extern ACPI_DMTABLE_INFO AcpiDmTableInfoMadtHdr[]; 265extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg[]; 266extern ACPI_DMTABLE_INFO AcpiDmTableInfoMcfg0[]; 267extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp1[]; 268extern ACPI_DMTABLE_INFO AcpiDmTableInfoRsdp2[]; 269extern ACPI_DMTABLE_INFO AcpiDmTableInfoSbst[]; 270extern ACPI_DMTABLE_INFO AcpiDmTableInfoSlit[]; 271extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpcr[]; 272extern ACPI_DMTABLE_INFO AcpiDmTableInfoSpmi[]; 273extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat[]; 274extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat0[]; 275extern ACPI_DMTABLE_INFO AcpiDmTableInfoSrat1[]; 276extern ACPI_DMTABLE_INFO AcpiDmTableInfoTcpa[]; 277extern ACPI_DMTABLE_INFO AcpiDmTableInfoWdrt[]; 278 279 280/* 281 * dmtable 282 */ 283void 284AcpiDmDumpDataTable ( 285 ACPI_TABLE_HEADER *Table); 286 287void 288AcpiDmDumpTable ( 289 UINT32 TableLength, 290 UINT32 TableOffset, 291 void *Table, 292 UINT32 SubTableLength, 293 ACPI_DMTABLE_INFO *Info); 294 295void 296AcpiDmLineHeader ( 297 UINT32 Offset, 298 UINT32 ByteLength, 299 char *Name); 300 301void 302AcpiDmLineHeader2 ( 303 UINT32 Offset, 304 UINT32 ByteLength, 305 char *Name, 306 UINT32 Value); 307 308 309/* 310 * dmtbdump 311 */ 312void 313AcpiDmDumpAsf ( 314 ACPI_TABLE_HEADER *Table); 315 316void 317AcpiDmDumpCpep ( 318 ACPI_TABLE_HEADER *Table); 319 320void 321AcpiDmDumpDmar ( 322 ACPI_TABLE_HEADER *Table); 323 324void 325AcpiDmDumpFadt ( 326 ACPI_TABLE_HEADER *Table); 327 328void 329AcpiDmDumpSrat ( 330 ACPI_TABLE_HEADER *Table); 331 332void 333AcpiDmDumpMcfg ( 334 ACPI_TABLE_HEADER *Table); 335 336void 337AcpiDmDumpMadt ( 338 ACPI_TABLE_HEADER *Table); 339 340UINT32 341AcpiDmDumpRsdp ( 342 ACPI_TABLE_HEADER *Table); 343 344void 345AcpiDmDumpRsdt ( 346 ACPI_TABLE_HEADER *Table); 347 348void 349AcpiDmDumpSlit ( 350 ACPI_TABLE_HEADER *Table); 351 352void 353AcpiDmDumpXsdt ( 354 ACPI_TABLE_HEADER *Table); 355 356 357/* 358 * dmwalk 359 */ 360void 361AcpiDmDisassemble ( 362 ACPI_WALK_STATE *WalkState, 363 ACPI_PARSE_OBJECT *Origin, 364 UINT32 NumOpcodes); 365 366void 367AcpiDmWalkParseTree ( 368 ACPI_PARSE_OBJECT *Op, 369 ASL_WALK_CALLBACK DescendingCallback, 370 ASL_WALK_CALLBACK AscendingCallback, 371 void *Context); 372 373 374/* 375 * dmopcode 376 */ 377void 378AcpiDmDisassembleOneOp ( 379 ACPI_WALK_STATE *WalkState, 380 ACPI_OP_WALK_INFO *Info, 381 ACPI_PARSE_OBJECT *Op); 382 383void 384AcpiDmDecodeInternalObject ( 385 ACPI_OPERAND_OBJECT *ObjDesc); 386 387UINT32 388AcpiDmListType ( 389 ACPI_PARSE_OBJECT *Op); 390 391void 392AcpiDmMethodFlags ( 393 ACPI_PARSE_OBJECT *Op); 394 395void 396AcpiDmFieldFlags ( 397 ACPI_PARSE_OBJECT *Op); 398 399void 400AcpiDmAddressSpace ( 401 UINT8 SpaceId); 402 403void 404AcpiDmRegionFlags ( 405 ACPI_PARSE_OBJECT *Op); 406 407void 408AcpiDmMatchOp ( 409 ACPI_PARSE_OBJECT *Op); 410 411BOOLEAN 412AcpiDmCommaIfListMember ( 413 ACPI_PARSE_OBJECT *Op); 414 415void 416AcpiDmCommaIfFieldMember ( 417 ACPI_PARSE_OBJECT *Op); 418 419 420/* 421 * dmnames 422 */ 423UINT32 424AcpiDmDumpName ( 425 char *Name); 426 427ACPI_STATUS 428AcpiPsDisplayObjectPathname ( 429 ACPI_WALK_STATE *WalkState, 430 ACPI_PARSE_OBJECT *Op); 431 432void 433AcpiDmNamestring ( 434 char *Name); 435 436 437/* 438 * dmobject 439 */ 440void 441AcpiDmDisplayInternalObject ( 442 ACPI_OPERAND_OBJECT *ObjDesc, 443 ACPI_WALK_STATE *WalkState); 444 445void 446AcpiDmDisplayArguments ( 447 ACPI_WALK_STATE *WalkState); 448 449void 450AcpiDmDisplayLocals ( 451 ACPI_WALK_STATE *WalkState); 452 453void 454AcpiDmDumpMethodInfo ( 455 ACPI_STATUS Status, 456 ACPI_WALK_STATE *WalkState, 457 ACPI_PARSE_OBJECT *Op); 458 459 460/* 461 * dmbuffer 462 */ 463void 464AcpiDmDisasmByteList ( 465 UINT32 Level, 466 UINT8 *ByteData, 467 UINT32 ByteCount); 468 469void 470AcpiDmByteList ( 471 ACPI_OP_WALK_INFO *Info, 472 ACPI_PARSE_OBJECT *Op); 473 474void 475AcpiDmIsEisaId ( 476 ACPI_PARSE_OBJECT *Op); 477 478void 479AcpiDmEisaId ( 480 UINT32 EncodedId); 481 482BOOLEAN 483AcpiDmIsUnicodeBuffer ( 484 ACPI_PARSE_OBJECT *Op); 485 486BOOLEAN 487AcpiDmIsStringBuffer ( 488 ACPI_PARSE_OBJECT *Op); 489 490 491/* 492 * dmresrc 493 */ 494void 495AcpiDmDumpInteger8 ( 496 UINT8 Value, 497 char *Name); 498 499void 500AcpiDmDumpInteger16 ( 501 UINT16 Value, 502 char *Name); 503 504void 505AcpiDmDumpInteger32 ( 506 UINT32 Value, 507 char *Name); 508 509void 510AcpiDmDumpInteger64 ( 511 UINT64 Value, 512 char *Name); 513 514void 515AcpiDmResourceTemplate ( 516 ACPI_OP_WALK_INFO *Info, 517 ACPI_PARSE_OBJECT *Op, 518 UINT8 *ByteData, 519 UINT32 ByteCount); 520 521ACPI_STATUS 522AcpiDmIsResourceTemplate ( 523 ACPI_PARSE_OBJECT *Op); 524 525void 526AcpiDmIndent ( 527 UINT32 Level); 528 529void 530AcpiDmBitList ( 531 UINT16 Mask); 532 533void 534AcpiDmDecodeAttribute ( 535 UINT8 Attribute); 536 537void 538AcpiDmDescriptorName ( 539 void); 540 541 542/* 543 * dmresrcl 544 */ 545void 546AcpiDmWordDescriptor ( 547 AML_RESOURCE *Resource, 548 UINT32 Length, 549 UINT32 Level); 550 551void 552AcpiDmDwordDescriptor ( 553 AML_RESOURCE *Resource, 554 UINT32 Length, 555 UINT32 Level); 556 557void 558AcpiDmExtendedDescriptor ( 559 AML_RESOURCE *Resource, 560 UINT32 Length, 561 UINT32 Level); 562 563void 564AcpiDmQwordDescriptor ( 565 AML_RESOURCE *Resource, 566 UINT32 Length, 567 UINT32 Level); 568 569void 570AcpiDmMemory24Descriptor ( 571 AML_RESOURCE *Resource, 572 UINT32 Length, 573 UINT32 Level); 574 575void 576AcpiDmMemory32Descriptor ( 577 AML_RESOURCE *Resource, 578 UINT32 Length, 579 UINT32 Level); 580 581void 582AcpiDmFixedMemory32Descriptor ( 583 AML_RESOURCE *Resource, 584 UINT32 Length, 585 UINT32 Level); 586 587void 588AcpiDmGenericRegisterDescriptor ( 589 AML_RESOURCE *Resource, 590 UINT32 Length, 591 UINT32 Level); 592 593void 594AcpiDmInterruptDescriptor ( 595 AML_RESOURCE *Resource, 596 UINT32 Length, 597 UINT32 Level); 598 599void 600AcpiDmVendorLargeDescriptor ( 601 AML_RESOURCE *Resource, 602 UINT32 Length, 603 UINT32 Level); 604 605void 606AcpiDmVendorCommon ( 607 char *Name, 608 UINT8 *ByteData, 609 UINT32 Length, 610 UINT32 Level); 611 612 613/* 614 * dmresrcs 615 */ 616void 617AcpiDmIrqDescriptor ( 618 AML_RESOURCE *Resource, 619 UINT32 Length, 620 UINT32 Level); 621 622void 623AcpiDmDmaDescriptor ( 624 AML_RESOURCE *Resource, 625 UINT32 Length, 626 UINT32 Level); 627 628void 629AcpiDmIoDescriptor ( 630 AML_RESOURCE *Resource, 631 UINT32 Length, 632 UINT32 Level); 633 634void 635AcpiDmFixedIoDescriptor ( 636 AML_RESOURCE *Resource, 637 UINT32 Length, 638 UINT32 Level); 639 640void 641AcpiDmStartDependentDescriptor ( 642 AML_RESOURCE *Resource, 643 UINT32 Length, 644 UINT32 Level); 645 646void 647AcpiDmEndDependentDescriptor ( 648 AML_RESOURCE *Resource, 649 UINT32 Length, 650 UINT32 Level); 651 652void 653AcpiDmVendorSmallDescriptor ( 654 AML_RESOURCE *Resource, 655 UINT32 Length, 656 UINT32 Level); 657 658 659/* 660 * dmutils 661 */ 662void 663AcpiDmAddToExternalList ( 664 char *Path, 665 UINT8 Type, 666 UINT32 Value); 667 668/* 669 * dmrestag 670 */ 671void 672AcpiDmFindResources ( 673 ACPI_PARSE_OBJECT *Root); 674 675void 676AcpiDmCheckResourceReference ( 677 ACPI_PARSE_OBJECT *Op, 678 ACPI_WALK_STATE *WalkState); 679 680#endif /* __ACDISASM_H__ */ 681