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

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmutils - AML disassembler utilities
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116
 117 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "amlcode.h"
 120 #include "acdisasm.h"
 121
 122 #ifdef ACPI_ASL_COMPILER
 123 #include <acnamesp.h>
 124 #endif
 125
 126 #ifdef ACPI_DISASSEMBLER
 127
 128 #define _COMPONENT          ACPI_CA_DEBUGGER
 129         ACPI_MODULE_NAME    ("dmutils")
 130
 131
 132 /* Data used in keeping track of fields */
 133 #if 0
 134 const char                      *AcpiGbl_FENames[] =
 135 {
 136     "skip",
 137     "?access?"
 138 };              /* FE = Field Element */
 139 #endif
 140
 141 /* Operators for Match() */
 142
 143 const char                      *AcpiGbl_MatchOps[] =
 144 {
 145     "MTR",
 146     "MEQ",
 147     "MLE",
 148     "MLT",
 149     "MGE",
 150     "MGT"
 151 };
 152
 153 /* Access type decoding */
 154
 155 const char                      *AcpiGbl_AccessTypes[] =
 156 {
 157     "AnyAcc",
 158     "ByteAcc",
 159     "WordAcc",
 160     "DWordAcc",
 161     "QWordAcc",
 162     "BufferAcc",
 163     "InvalidAccType",
 164     "InvalidAccType"
 165 };
 166
 167 /* Lock rule decoding */
 168
 169 const char                      *AcpiGbl_LockRule[] =
 170 {
 171     "NoLock",
 172     "Lock"
 173 };
 174
 175 /* Update rule decoding */
 176
 177 const char                      *AcpiGbl_UpdateRules[] =
 178 {
 179     "Preserve",
 180     "WriteAsOnes",
 181     "WriteAsZeros",
 182     "InvalidUpdateRule"
 183 };
 184
 185 /* Strings used to decode resource descriptors */
 186
 187 const char                      *AcpiGbl_WordDecode[] =
 188 {
 189     "Memory",
 190     "IO",
 191     "BusNumber",
 192     "UnknownResourceType"
 193 };
 194
 195 const char                      *AcpiGbl_IrqDecode[] =
 196 {
 197     "IRQNoFlags",
 198     "IRQ"
 199 };
 200
 201
 202 /*******************************************************************************
 203  *
 204  * FUNCTION:    AcpiDmDecodeAttribute
 205  *
 206  * PARAMETERS:  Attribute       - Attribute field of AccessAs keyword
 207  *
 208  * RETURN:      None
 209  *
 210  * DESCRIPTION: Decode the AccessAs attribute byte.  (Mostly SMBus stuff)
 211  *
 212  ******************************************************************************/
 213
 214 void
 215 AcpiDmDecodeAttribute (
 216     UINT8                   Attribute)
 217 {
 218
 219     switch (Attribute)
 220     {
 221     case AML_FIELD_ATTRIB_SMB_QUICK:
 222
 223         AcpiOsPrintf ("SMBQuick");
 224         break;
 225
 226     case AML_FIELD_ATTRIB_SMB_SEND_RCV:
 227
 228         AcpiOsPrintf ("SMBSendReceive");
 229         break;
 230
 231     case AML_FIELD_ATTRIB_SMB_BYTE:
 232
 233         AcpiOsPrintf ("SMBByte");
 234         break;
 235
 236     case AML_FIELD_ATTRIB_SMB_WORD:
 237
 238         AcpiOsPrintf ("SMBWord");
 239         break;
 240
 241     case AML_FIELD_ATTRIB_SMB_WORD_CALL:
 242
 243         AcpiOsPrintf ("SMBProcessCall");
 244         break;
 245
 246     case AML_FIELD_ATTRIB_SMB_BLOCK:
 247
 248         AcpiOsPrintf ("SMBBlock");
 249         break;
 250
 251     case AML_FIELD_ATTRIB_SMB_BLOCK_CALL:
 252
 253         AcpiOsPrintf ("SMBBlockProcessCall");
 254         break;
 255
 256     default:
 257
 258         AcpiOsPrintf ("0x%.2X", Attribute);
 259         break;
 260     }
 261 }
 262
 263
 264 /*******************************************************************************
 265  *
 266  * FUNCTION:    AcpiDmIndent
 267  *
 268  * PARAMETERS:  Level               - Current source code indentation level
 269  *
 270  * RETURN:      None
 271  *
 272  * DESCRIPTION: Indent 4 spaces per indentation level.
 273  *
 274  ******************************************************************************/
 275
 276 void
 277 AcpiDmIndent (
 278     UINT32                  Level)
 279 {
 280
 281     if (!Level)
 282     {
 283         return;
 284     }
 285
 286     AcpiOsPrintf ("%*.s", ACPI_MUL_4 (Level), " ");
 287 }
 288
 289
 290 /*******************************************************************************
 291  *
 292  * FUNCTION:    AcpiDmCommaIfListMember
 293  *
 294  * PARAMETERS:  Op              - Current operator/operand
 295  *
 296  * RETURN:      TRUE if a comma was inserted
 297  *
 298  * DESCRIPTION: Insert a comma if this Op is a member of an argument list.
 299  *
 300  ******************************************************************************/
 301
 302 BOOLEAN
 303 AcpiDmCommaIfListMember (
 304     ACPI_PARSE_OBJECT       *Op)
 305 {
 306
 307     if (!Op->Common.Next)
 308     {
 309         return FALSE;
 310     }
 311
 312     if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST)
 313     {
 314         /* Check for a NULL target operand */
 315
 316         if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
 317             (!Op->Common.Next->Common.Value.String))
 318         {
 319             /*
 320              * To handle the Divide() case where there are two optional
 321              * targets, look ahead one more op.  If null, this null target
 322              * is the one and only target -- no comma needed.  Otherwise,
 323              * we need a comma to prepare for the next target.
 324              */
 325             if (!Op->Common.Next->Common.Next)
 326             {
 327                 return FALSE;
 328             }
 329         }
 330
 331         if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
 332             (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)))
 333         {
 334             return FALSE;
 335         }
 336
 337         AcpiOsPrintf (", ");
 338         return (TRUE);
 339     }
 340
 341     else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
 342              (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
 343     {
 344         AcpiOsPrintf (", ");
 345         return (TRUE);
 346     }
 347
 348     return (FALSE);
 349 }
 350
 351
 352 /*******************************************************************************
 353  *
 354  * FUNCTION:    AcpiDmCommaIfFieldMember
 355  *
 356  * PARAMETERS:  Op              - Current operator/operand
 357  *
 358  * RETURN:      None
 359  *
 360  * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list.
 361  *
 362  ******************************************************************************/
 363
 364 void
 365 AcpiDmCommaIfFieldMember (
 366     ACPI_PARSE_OBJECT       *Op)
 367 {
 368
 369     if (Op->Common.Next)
 370     {
 371         AcpiOsPrintf (", ");
 372     }
 373 }
 374
 375 #endif