sys/contrib/dev/acpica/dmutils.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmutils - AML disassembler utilities
   4  *              $Revision: 1.19 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, 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
 118 #include <contrib/dev/acpica/acpi.h>
 119 #include <contrib/dev/acpica/amlcode.h>
 120 #include <contrib/dev/acpica/acdisasm.h>
 121
 122 #ifdef ACPI_ASL_COMPILER
 123 #include <contrib/dev/acpica/acnamesp.h>
 124 #endif
 125
 126 #ifdef ACPI_DISASSEMBLER
 127
 128 #define _COMPONENT          ACPI_CA_DEBUGGER
 129         ACPI_MODULE_NAME    ("dmutils")
 130
 131
 132 ACPI_EXTERNAL_LIST              *AcpiGbl_ExternalList = NULL;
 133
 134
 135 /* Data used in keeping track of fields */
 136 #if 0
 137 const char                      *AcpiGbl_FENames[ACPI_NUM_FIELD_NAMES] =
 138 {
 139     "skip",
 140     "?access?"
 141 };              /* FE = Field Element */
 142 #endif
 143
 144
 145 const char                      *AcpiGbl_MatchOps[ACPI_NUM_MATCH_OPS] =
 146 {
 147     "MTR",
 148     "MEQ",
 149     "MLE",
 150     "MLT",
 151     "MGE",
 152     "MGT"
 153 };
 154
 155
 156 /* Access type decoding */
 157
 158 const char                      *AcpiGbl_AccessTypes[ACPI_NUM_ACCESS_TYPES] =
 159 {
 160     "AnyAcc",
 161     "ByteAcc",
 162     "WordAcc",
 163     "DWordAcc",
 164     "QWordAcc",
 165     "BufferAcc",
 166 };
 167
 168
 169 /* Lock rule decoding */
 170
 171 const char                      *AcpiGbl_LockRule[ACPI_NUM_LOCK_RULES] =
 172 {
 173     "NoLock",
 174     "Lock"
 175 };
 176
 177 /* Update rule decoding */
 178
 179 const char                      *AcpiGbl_UpdateRules[ACPI_NUM_UPDATE_RULES] =
 180 {
 181     "Preserve",
 182     "WriteAsOnes",
 183     "WriteAsZeros"
 184 };
 185
 186 /*
 187  * Strings used to decode resource descriptors
 188  */
 189 const char                      *AcpiGbl_IoDecode[2] =
 190 {
 191     "Decode10",
 192     "Decode16"
 193 };
 194
 195 const char                      *AcpiGbl_WordDecode[4] =
 196 {
 197     "Memory",
 198     "IO",
 199     "BusNumber",
 200     "Unknown-resource-type"
 201 };
 202
 203 const char                      *AcpiGbl_ConsumeDecode[2] =
 204 {
 205     "ResourceProducer",
 206     "ResourceConsumer"
 207 };
 208
 209 const char                      *AcpiGbl_MinDecode[2] =
 210 {
 211     "MinNotFixed",
 212     "MinFixed"
 213 };
 214
 215 const char                      *AcpiGbl_MaxDecode[2] =
 216 {
 217     "MaxNotFixed",
 218     "MaxFixed"
 219 };
 220
 221 const char                      *AcpiGbl_DECDecode[2] =
 222 {
 223     "PosDecode",
 224     "SubDecode"
 225 };
 226
 227 const char                      *AcpiGbl_IrqDecode[2] =
 228 {
 229     "IRQNoFlags",
 230     "IRQ"
 231 };
 232
 233 const char                      *AcpiGbl_HEDecode[2] =
 234 {
 235     "Level",
 236     "Edge"
 237 };
 238
 239 const char                      *AcpiGbl_LLDecode[2] =
 240 {
 241     "ActiveHigh",
 242     "ActiveLow"
 243 };
 244
 245 const char                      *AcpiGbl_SHRDecode[2] =
 246 {
 247     "Exclusive",
 248     "Shared"
 249 };
 250
 251 const char                      *AcpiGbl_TYPDecode[4] =
 252 {
 253     "Compatibility",
 254     "TypeA",
 255     "TypeB",
 256     "TypeF"
 257 };
 258
 259 const char                      *AcpiGbl_BMDecode[2] =
 260 {
 261     "NotBusMaster",
 262     "BusMaster"
 263 };
 264
 265 const char                      *AcpiGbl_SIZDecode[4] =
 266 {
 267     "Transfer8",
 268     "Transfer8_16",
 269     "Transfer16",
 270     "InvalidSize"
 271 };
 272
 273 /* Type Specific Flags */
 274
 275 const char                      *AcpiGbl_TTPDecode[2] =
 276 {
 277     "TypeStatic",
 278     "TypeTranslation"
 279 };
 280
 281 const char                      *AcpiGbl_MTPDecode[4] =
 282 {
 283     "AddressRangeMemory",
 284     "AddressRangeReserved",
 285     "AddressRangeACPI",
 286     "AddressRangeNVS"
 287 };
 288
 289 const char                      *AcpiGbl_MEMDecode[4] =
 290 {
 291     "NonCacheable",
 292     "Cacheable",
 293     "WriteCombining",
 294     "Prefetchable"
 295 };
 296
 297 const char                      *AcpiGbl_RWDecode[2] =
 298 {
 299     "ReadOnly",
 300     "ReadWrite"
 301 };
 302
 303 const char                      *AcpiGbl_TRSDecode[2] =
 304 {
 305     "DenseTranslation",
 306     "SparseTranslation"
 307 };
 308
 309 const char                      *AcpiGbl_RNGDecode[4] =
 310 {
 311     "InvalidRanges",
 312     "NonISAOnlyRanges",
 313     "ISAOnlyRanges",
 314     "EntireRange"
 315 };
 316
 317 const char                      *AcpiGbl_ConfigDecode[4] =
 318 {
 319     "0 - Good Configuration",
 320     "1 - Acceptable Configuration",
 321     "2 - Suboptimal Configuration",
 322     "3 - ***Invalid Configuration***",
 323 };
 324
 325
 326 #ifdef ACPI_ASL_COMPILER
 327 /*******************************************************************************
 328  *
 329  * FUNCTION:    AcpiDmAddToExternalList
 330  *
 331  * PARAMETERS:  Path            - Internal (AML) path to the object
 332  *
 333  * RETURN:      None
 334  *
 335  * DESCRIPTION: Insert a new path into the list of Externals which will in
 336  *              turn be emitted as an External() declaration in the disassembled
 337  *              output.
 338  *
 339  ******************************************************************************/
 340
 341 void
 342 AcpiDmAddToExternalList (
 343     char                    *Path)
 344 {
 345     char                    *ExternalPath;
 346     ACPI_EXTERNAL_LIST      *NewExternal;
 347     ACPI_STATUS             Status;
 348
 349
 350     if (!Path)
 351     {
 352         return;
 353     }
 354
 355     /* Externalize the ACPI path */
 356
 357     Status = AcpiNsExternalizeName (ACPI_UINT32_MAX, Path,
 358                     NULL, &ExternalPath);
 359     if (ACPI_SUCCESS (Status))
 360     {
 361         /* Allocate and init a new External() descriptor */
 362
 363         NewExternal = ACPI_MEM_CALLOCATE (sizeof (ACPI_EXTERNAL_LIST));
 364         NewExternal->Path = ExternalPath;
 365
 366         /* Link the new descriptor into the global list */
 367
 368         if (AcpiGbl_ExternalList)
 369         {
 370             NewExternal->Next = AcpiGbl_ExternalList;
 371         }
 372         AcpiGbl_ExternalList = NewExternal;
 373     }
 374 }
 375 #endif
 376
 377 /*******************************************************************************
 378  *
 379  * FUNCTION:    AcpiDmDecodeAttribute
 380  *
 381  * PARAMETERS:  Attribute       - Attribute field of AccessAs keyword
 382  *
 383  * RETURN:      None
 384  *
 385  * DESCRIPTION: Decode the AccessAs attribute byte.  (Mostly SMBus stuff)
 386  *
 387  ******************************************************************************/
 388
 389 void
 390 AcpiDmDecodeAttribute (
 391     UINT8                   Attribute)
 392 {
 393
 394     switch (Attribute)
 395     {
 396     case AML_FIELD_ATTRIB_SMB_QUICK:
 397
 398         AcpiOsPrintf ("SMBQuick");
 399         break;
 400
 401     case AML_FIELD_ATTRIB_SMB_SEND_RCV:
 402
 403         AcpiOsPrintf ("SMBSendReceive");
 404         break;
 405
 406     case AML_FIELD_ATTRIB_SMB_BYTE:
 407
 408         AcpiOsPrintf ("SMBByte");
 409         break;
 410
 411     case AML_FIELD_ATTRIB_SMB_WORD:
 412
 413         AcpiOsPrintf ("SMBWord");
 414         break;
 415
 416     case AML_FIELD_ATTRIB_SMB_WORD_CALL:
 417
 418         AcpiOsPrintf ("SMBProcessCall");
 419         break;
 420
 421     case AML_FIELD_ATTRIB_SMB_BLOCK:
 422
 423         AcpiOsPrintf ("SMBBlock");
 424         break;
 425
 426     case AML_FIELD_ATTRIB_SMB_BLOCK_CALL:
 427
 428         AcpiOsPrintf ("SMBBlockProcessCall");
 429         break;
 430
 431     default:
 432
 433         AcpiOsPrintf ("0x%.2X", Attribute);
 434         break;
 435     }
 436 }
 437
 438
 439 /*******************************************************************************
 440  *
 441  * FUNCTION:    AcpiDmIndent
 442  *
 443  * PARAMETERS:  Level               - Current source code indentation level
 444  *
 445  * RETURN:      None
 446  *
 447  * DESCRIPTION: Indent 4 spaces per indentation level.
 448  *
 449  ******************************************************************************/
 450
 451 void
 452 AcpiDmIndent (
 453     UINT32                  Level)
 454 {
 455
 456     if (!Level)
 457     {
 458         return;
 459     }
 460
 461     AcpiOsPrintf ("%*.s", ACPI_MUL_4 (Level), " ");
 462 }
 463
 464
 465 /*******************************************************************************
 466  *
 467  * FUNCTION:    AcpiDmCommaIfListMember
 468  *
 469  * PARAMETERS:  Op              - Current operator/operand
 470  *
 471  * RETURN:      TRUE if a comma was inserted
 472  *
 473  * DESCRIPTION: Insert a comma if this Op is a member of an argument list.
 474  *
 475  ******************************************************************************/
 476
 477 BOOLEAN
 478 AcpiDmCommaIfListMember (
 479     ACPI_PARSE_OBJECT       *Op)
 480 {
 481
 482     if (!Op->Common.Next)
 483     {
 484         return FALSE;
 485     }
 486
 487     if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST)
 488     {
 489         /* Check for a NULL target operand */
 490
 491         if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
 492             (!Op->Common.Next->Common.Value.String))
 493         {
 494             /*
 495              * To handle the Divide() case where there are two optional
 496              * targets, look ahead one more op.  If null, this null target
 497              * is the one and only target -- no comma needed.  Otherwise,
 498              * we need a comma to prepare for the next target.
 499              */
 500             if (!Op->Common.Next->Common.Next)
 501             {
 502                 return FALSE;
 503             }
 504         }
 505
 506         if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
 507             (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)))
 508         {
 509             return FALSE;
 510         }
 511
 512         AcpiOsPrintf (", ");
 513         return (TRUE);
 514     }
 515
 516     else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
 517              (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
 518     {
 519         AcpiOsPrintf (", ");
 520         return (TRUE);
 521     }
 522
 523     return (FALSE);
 524 }
 525
 526
 527 /*******************************************************************************
 528  *
 529  * FUNCTION:    AcpiDmCommaIfFieldMember
 530  *
 531  * PARAMETERS:  Op              - Current operator/operand
 532  *
 533  * RETURN:      None
 534  *
 535  * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list.
 536  *
 537  ******************************************************************************/
 538
 539 void
 540 AcpiDmCommaIfFieldMember (
 541     ACPI_PARSE_OBJECT       *Op)
 542 {
 543
 544     if (Op->Common.Next)
 545     {
 546         AcpiOsPrintf (", ");
 547     }
 548 }
 549
 550 #endif