sys/contrib/dev/acpica-unix-20061109/disassembler/dmopcode.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmopcode - AML disassembler, specific AML opcodes
   4  *              $Revision: 1.99 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 #include "acpi.h"
 118 #include "acparser.h"
 119 #include "amlcode.h"
 120 #include "acdisasm.h"
 121
 122 #ifdef ACPI_DISASSEMBLER
 123
 124 #define _COMPONENT          ACPI_CA_DEBUGGER
 125         ACPI_MODULE_NAME    ("dmopcode")
 126
 127 /* Local prototypes */
 128
 129 static void
 130 AcpiDmMatchKeyword (
 131     ACPI_PARSE_OBJECT       *Op);
 132
 133
 134 /*******************************************************************************
 135  *
 136  * FUNCTION:    AcpiDmMethodFlags
 137  *
 138  * PARAMETERS:  Op              - Method Object to be examined
 139  *
 140  * RETURN:      None
 141  *
 142  * DESCRIPTION: Decode control method flags
 143  *
 144  ******************************************************************************/
 145
 146 void
 147 AcpiDmMethodFlags (
 148     ACPI_PARSE_OBJECT       *Op)
 149 {
 150     UINT32                  Flags;
 151     UINT32                  Args;
 152
 153
 154     /* The next Op contains the flags */
 155
 156     Op = AcpiPsGetDepthNext (NULL, Op);
 157     Flags = (UINT8) Op->Common.Value.Integer;
 158     Args = Flags & 0x07;
 159
 160     /* Mark the Op as completed */
 161
 162     Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
 163
 164     /* 1) Method argument count */
 165
 166     AcpiOsPrintf (", %d, ", Args);
 167
 168     /* 2) Serialize rule */
 169
 170     if (!(Flags & 0x08))
 171     {
 172         AcpiOsPrintf ("Not");
 173     }
 174
 175     AcpiOsPrintf ("Serialized");
 176
 177     /* 3) SyncLevel */
 178
 179     if (Flags & 0xF0)
 180     {
 181         AcpiOsPrintf (", %d", Flags >> 4);
 182     }
 183 }
 184
 185
 186 /*******************************************************************************
 187  *
 188  * FUNCTION:    AcpiDmFieldFlags
 189  *
 190  * PARAMETERS:  Op              - Field Object to be examined
 191  *
 192  * RETURN:      None
 193  *
 194  * DESCRIPTION: Decode Field definition flags
 195  *
 196  ******************************************************************************/
 197
 198 void
 199 AcpiDmFieldFlags (
 200     ACPI_PARSE_OBJECT       *Op)
 201 {
 202     UINT32                  Flags;
 203
 204
 205     /* The next peer Op (not child op) contains the flags */
 206
 207     Op = Op->Common.Next;
 208     Flags = (UINT8) Op->Common.Value.Integer;
 209
 210     /* Mark the Op as completed */
 211
 212     Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
 213
 214     AcpiOsPrintf ("%s, ", AcpiGbl_AccessTypes [Flags & 0x07]);
 215     AcpiOsPrintf ("%s, ", AcpiGbl_LockRule [(Flags & 0x10) >> 4]);
 216     AcpiOsPrintf ("%s)",  AcpiGbl_UpdateRules [(Flags & 0x60) >> 5]);
 217 }
 218
 219
 220 /*******************************************************************************
 221  *
 222  * FUNCTION:    AcpiDmAddressSpace
 223  *
 224  * PARAMETERS:  SpaceId         - ID to be translated
 225  *
 226  * RETURN:      None
 227  *
 228  * DESCRIPTION: Decode a SpaceId to an AddressSpaceKeyword
 229  *
 230  ******************************************************************************/
 231
 232 void
 233 AcpiDmAddressSpace (
 234     UINT8                   SpaceId)
 235 {
 236
 237     if (SpaceId >= ACPI_NUM_PREDEFINED_REGIONS)
 238     {
 239         if (SpaceId == 0x7F)
 240         {
 241             AcpiOsPrintf ("FFixedHW, ");
 242         }
 243         else
 244         {
 245             AcpiOsPrintf ("0x%.2X, ", SpaceId);
 246         }
 247     }
 248     else
 249     {
 250         AcpiOsPrintf ("%s, ", AcpiGbl_RegionTypes [SpaceId]);
 251     }
 252 }
 253
 254
 255 /*******************************************************************************
 256  *
 257  * FUNCTION:    AcpiDmRegionFlags
 258  *
 259  * PARAMETERS:  Op              - Object to be examined
 260  *
 261  * RETURN:      None
 262  *
 263  * DESCRIPTION: Decode OperationRegion flags
 264  *
 265  ******************************************************************************/
 266
 267 void
 268 AcpiDmRegionFlags (
 269     ACPI_PARSE_OBJECT       *Op)
 270 {
 271
 272
 273     /* The next Op contains the SpaceId */
 274
 275     Op = AcpiPsGetDepthNext (NULL, Op);
 276
 277     /* Mark the Op as completed */
 278
 279     Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
 280
 281     AcpiOsPrintf (", ");
 282     AcpiDmAddressSpace ((UINT8) Op->Common.Value.Integer);
 283 }
 284
 285
 286 /*******************************************************************************
 287  *
 288  * FUNCTION:    AcpiDmMatchOp
 289  *
 290  * PARAMETERS:  Op              - Match Object to be examined
 291  *
 292  * RETURN:      None
 293  *
 294  * DESCRIPTION: Decode Match opcode operands
 295  *
 296  ******************************************************************************/
 297
 298 void
 299 AcpiDmMatchOp (
 300     ACPI_PARSE_OBJECT       *Op)
 301 {
 302     ACPI_PARSE_OBJECT       *NextOp;
 303
 304
 305     NextOp = AcpiPsGetDepthNext (NULL, Op);
 306     NextOp = NextOp->Common.Next;
 307
 308     if (!NextOp)
 309     {
 310         /* Handle partial tree during single-step */
 311
 312         return;
 313     }
 314
 315     /* Mark the two nodes that contain the encoding for the match keywords */
 316
 317     NextOp->Common.DisasmOpcode = ACPI_DASM_MATCHOP;
 318
 319     NextOp = NextOp->Common.Next;
 320     NextOp = NextOp->Common.Next;
 321     NextOp->Common.DisasmOpcode = ACPI_DASM_MATCHOP;
 322 }
 323
 324
 325 /*******************************************************************************
 326  *
 327  * FUNCTION:    AcpiDmMatchKeyword
 328  *
 329  * PARAMETERS:  Op              - Match Object to be examined
 330  *
 331  * RETURN:      None
 332  *
 333  * DESCRIPTION: Decode Match opcode operands
 334  *
 335  ******************************************************************************/
 336
 337 static void
 338 AcpiDmMatchKeyword (
 339     ACPI_PARSE_OBJECT       *Op)
 340 {
 341
 342
 343     if (((UINT32) Op->Common.Value.Integer) > ACPI_MAX_MATCH_OPCODE)
 344     {
 345         AcpiOsPrintf ("/* Unknown Match Keyword encoding */");
 346     }
 347     else
 348     {
 349         AcpiOsPrintf ("%s", ACPI_CAST_PTR (char,
 350             AcpiGbl_MatchOps[(ACPI_SIZE) Op->Common.Value.Integer]));
 351     }
 352 }
 353
 354
 355 /*******************************************************************************
 356  *
 357  * FUNCTION:    AcpiDmDisassembleOneOp
 358  *
 359  * PARAMETERS:  WalkState           - Current walk info
 360  *              Info                - Parse tree walk info
 361  *              Op                  - Op that is to be printed
 362  *
 363  * RETURN:      None
 364  *
 365  * DESCRIPTION: Disassemble a single AML opcode
 366  *
 367  ******************************************************************************/
 368
 369 void
 370 AcpiDmDisassembleOneOp (
 371     ACPI_WALK_STATE         *WalkState,
 372     ACPI_OP_WALK_INFO       *Info,
 373     ACPI_PARSE_OBJECT       *Op)
 374 {
 375     const ACPI_OPCODE_INFO  *OpInfo = NULL;
 376     UINT32                  Offset;
 377     UINT32                  Length;
 378     ACPI_PARSE_OBJECT       *Child;
 379     ACPI_STATUS             Status;
 380
 381
 382     if (!Op)
 383     {
 384         AcpiOsPrintf ("<NULL OP PTR>");
 385         return;
 386     }
 387
 388     switch (Op->Common.DisasmOpcode)
 389     {
 390     case ACPI_DASM_MATCHOP:
 391
 392         AcpiDmMatchKeyword (Op);
 393         return;
 394
 395     case ACPI_DASM_LNOT_SUFFIX:
 396         switch (Op->Common.AmlOpcode)
 397         {
 398         case AML_LEQUAL_OP:
 399             AcpiOsPrintf ("LNotEqual");
 400             break;
 401
 402         case AML_LGREATER_OP:
 403             AcpiOsPrintf ("LLessEqual");
 404             break;
 405
 406         case AML_LLESS_OP:
 407             AcpiOsPrintf ("LGreaterEqual");
 408             break;
 409         }
 410         Op->Common.DisasmOpcode = 0;
 411         Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
 412         return;
 413
 414     default:
 415         break;
 416     }
 417
 418
 419     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
 420
 421     /* The op and arguments */
 422
 423     switch (Op->Common.AmlOpcode)
 424     {
 425     case AML_LNOT_OP:
 426
 427         Child = Op->Common.Value.Arg;
 428         if ((Child->Common.AmlOpcode == AML_LEQUAL_OP) ||
 429             (Child->Common.AmlOpcode == AML_LGREATER_OP) ||
 430             (Child->Common.AmlOpcode == AML_LLESS_OP))
 431         {
 432             Child->Common.DisasmOpcode = ACPI_DASM_LNOT_SUFFIX;
 433             Op->Common.DisasmOpcode = ACPI_DASM_LNOT_PREFIX;
 434         }
 435         else
 436         {
 437             AcpiOsPrintf ("%s", OpInfo->Name);
 438         }
 439         break;
 440
 441     case AML_BYTE_OP:
 442
 443         AcpiOsPrintf ("0x%2.2X", (UINT32) Op->Common.Value.Integer);
 444         break;
 445
 446
 447     case AML_WORD_OP:
 448
 449         if (Op->Common.DisasmOpcode == ACPI_DASM_EISAID)
 450         {
 451             AcpiDmEisaId ((UINT32) Op->Common.Value.Integer);
 452         }
 453         else
 454         {
 455             AcpiOsPrintf ("0x%4.4X", (UINT32) Op->Common.Value.Integer);
 456         }
 457         break;
 458
 459
 460     case AML_DWORD_OP:
 461
 462         if (Op->Common.DisasmOpcode == ACPI_DASM_EISAID)
 463         {
 464             AcpiDmEisaId ((UINT32) Op->Common.Value.Integer);
 465         }
 466         else
 467         {
 468             AcpiOsPrintf ("0x%8.8X", (UINT32) Op->Common.Value.Integer);
 469         }
 470         break;
 471
 472
 473     case AML_QWORD_OP:
 474
 475         AcpiOsPrintf ("0x%8.8X%8.8X", Op->Common.Value.Integer64.Hi,
 476                                       Op->Common.Value.Integer64.Lo);
 477         break;
 478
 479
 480     case AML_STRING_OP:
 481
 482         AcpiUtPrintString (Op->Common.Value.String, ACPI_UINT8_MAX);
 483         break;
 484
 485
 486     case AML_BUFFER_OP:
 487
 488         /*
 489          * Determine the type of buffer.  We can have one of the following:
 490          *
 491          * 1) ResourceTemplate containing Resource Descriptors.
 492          * 2) Unicode String buffer
 493          * 3) ASCII String buffer
 494          * 4) Raw data buffer (if none of the above)
 495          *
 496          * Since there are no special AML opcodes to differentiate these
 497          * types of buffers, we have to closely look at the data in the
 498          * buffer to determine the type.
 499          */
 500         Status = AcpiDmIsResourceTemplate (Op);
 501         if (ACPI_SUCCESS (Status))
 502         {
 503             Op->Common.DisasmOpcode = ACPI_DASM_RESOURCE;
 504             AcpiOsPrintf ("ResourceTemplate");
 505             break;
 506         }
 507         else if (Status == AE_AML_NO_RESOURCE_END_TAG)
 508         {
 509             AcpiOsPrintf ("/**** Is ResourceTemplate, but EndTag not at buffer end ****/ ");
 510         }
 511
 512         if (AcpiDmIsUnicodeBuffer (Op))
 513         {
 514             Op->Common.DisasmOpcode = ACPI_DASM_UNICODE;
 515             AcpiOsPrintf ("Unicode (");
 516         }
 517         else if (AcpiDmIsStringBuffer (Op))
 518         {
 519             Op->Common.DisasmOpcode = ACPI_DASM_STRING;
 520             AcpiOsPrintf ("Buffer");
 521         }
 522         else
 523         {
 524             Op->Common.DisasmOpcode = ACPI_DASM_BUFFER;
 525             AcpiOsPrintf ("Buffer");
 526         }
 527         break;
 528
 529
 530     case AML_INT_STATICSTRING_OP:
 531
 532         if (Op->Common.Value.String)
 533         {
 534             AcpiOsPrintf ("%s", Op->Common.Value.String);
 535         }
 536         else
 537         {
 538             AcpiOsPrintf ("\"<NULL STATIC STRING PTR>\"");
 539         }
 540         break;
 541
 542
 543     case AML_INT_NAMEPATH_OP:
 544
 545         AcpiDmNamestring (Op->Common.Value.Name);
 546         break;
 547
 548
 549     case AML_INT_NAMEDFIELD_OP:
 550
 551         Length = AcpiDmDumpName ((char *) &Op->Named.Name);
 552         AcpiOsPrintf (",%*.s  %d", (int) (5 - Length), " ",
 553             (UINT32) Op->Common.Value.Integer);
 554         AcpiDmCommaIfFieldMember (Op);
 555
 556         Info->BitOffset += (UINT32) Op->Common.Value.Integer;
 557         break;
 558
 559
 560     case AML_INT_RESERVEDFIELD_OP:
 561
 562         /* Offset() -- Must account for previous offsets */
 563
 564         Offset = (UINT32) Op->Common.Value.Integer;
 565         Info->BitOffset += Offset;
 566
 567         if (Info->BitOffset % 8 == 0)
 568         {
 569             AcpiOsPrintf ("        Offset (0x%.2X)", ACPI_DIV_8 (Info->BitOffset));
 570         }
 571         else
 572         {
 573             AcpiOsPrintf ("    ,   %d", Offset);
 574         }
 575
 576         AcpiDmCommaIfFieldMember (Op);
 577         break;
 578
 579
 580     case AML_INT_ACCESSFIELD_OP:
 581
 582         AcpiOsPrintf ("        AccessAs (%s, ",
 583             AcpiGbl_AccessTypes [(UINT32) (Op->Common.Value.Integer >> 8) & 0x7]);
 584
 585         AcpiDmDecodeAttribute ((UINT8) Op->Common.Value.Integer);
 586         AcpiOsPrintf (")");
 587         AcpiDmCommaIfFieldMember (Op);
 588         break;
 589
 590
 591     case AML_INT_BYTELIST_OP:
 592
 593         AcpiDmByteList (Info, Op);
 594         break;
 595
 596
 597     case AML_INT_METHODCALL_OP:
 598
 599         Op = AcpiPsGetDepthNext (NULL, Op);
 600         Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
 601
 602         AcpiDmNamestring (Op->Common.Value.Name);
 603         break;
 604
 605
 606     default:
 607
 608         /* Just get the opcode name and print it */
 609
 610         AcpiOsPrintf ("%s", OpInfo->Name);
 611
 612
 613 #ifdef ACPI_DEBUGGER
 614
 615         if ((Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP) &&
 616             (WalkState) &&
 617             (WalkState->Results) &&
 618             (WalkState->Results->Results.NumResults))
 619         {
 620             AcpiDmDecodeInternalObject (
 621                 WalkState->Results->Results.ObjDesc [
 622                     WalkState->Results->Results.NumResults-1]);
 623         }
 624 #endif
 625         break;
 626     }
 627 }
 628
 629 #endif  /* ACPI_DISASSEMBLER */