sys/contrib/dev/acpica-unix-20040527/disassembler/dmutils.c

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