sys/contrib/dev/acpica/dmopcode.c

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