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

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmnames - AML disassembler, names, namestrings, pathnames
   4  *              $Revision: 1.16 $
   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
 118 #include "acpi.h"
 119 #include "acparser.h"
 120 #include "amlcode.h"
 121 #include "acnamesp.h"
 122 #include "acdisasm.h"
 123
 124
 125 #ifdef ACPI_DISASSEMBLER
 126
 127 #define _COMPONENT          ACPI_CA_DEBUGGER
 128         ACPI_MODULE_NAME    ("dmnames")
 129
 130 /* Local prototypes */
 131
 132 #ifdef ACPI_OBSOLETE_FUNCTIONS
 133 void
 134 AcpiDmDisplayPath (
 135     ACPI_PARSE_OBJECT       *Op);
 136 #endif
 137
 138
 139 /*******************************************************************************
 140  *
 141  * FUNCTION:    AcpiDmDumpName
 142  *
 143  * PARAMETERS:  Name            - 4 character ACPI name
 144  *
 145  * RETURN:      Final length of name
 146  *
 147  * DESCRIPTION: Dump an ACPI name, minus any trailing underscores.
 148  *
 149  ******************************************************************************/
 150
 151 UINT32
 152 AcpiDmDumpName (
 153     char                    *Name)
 154 {
 155     UINT32                  i;
 156     UINT32                  Length;
 157     char                    NewName[4];
 158
 159
 160     /* Ensure that the name is printable, even if we have to fix it */
 161
 162     *(UINT32 *) NewName = AcpiUtRepairName (Name);
 163
 164     /* Remove all trailing underscores from the name */
 165
 166     Length = ACPI_NAME_SIZE;
 167     for (i = (ACPI_NAME_SIZE - 1); i != 0; i--)
 168     {
 169         if (NewName[i] == '_')
 170         {
 171             Length--;
 172         }
 173         else
 174         {
 175             break;
 176         }
 177     }
 178
 179     /* Dump the name, up to the start of the trailing underscores */
 180
 181     for (i = 0; i < Length; i++)
 182     {
 183         AcpiOsPrintf ("%c", NewName[i]);
 184     }
 185
 186     return (Length);
 187 }
 188
 189
 190 /*******************************************************************************
 191  *
 192  * FUNCTION:    AcpiPsDisplayObjectPathname
 193  *
 194  * PARAMETERS:  WalkState       - Current walk state
 195  *              Op              - Object whose pathname is to be obtained
 196  *
 197  * RETURN:      Status
 198  *
 199  * DESCRIPTION: Diplay the pathname associated with a named object.  Two
 200  *              versions. One searches the parse tree (for parser-only
 201  *              applications suchas AcpiDump), and the other searches the
 202  *              ACPI namespace (the parse tree is probably deleted)
 203  *
 204  ******************************************************************************/
 205
 206 ACPI_STATUS
 207 AcpiPsDisplayObjectPathname (
 208     ACPI_WALK_STATE         *WalkState,
 209     ACPI_PARSE_OBJECT       *Op)
 210 {
 211     ACPI_STATUS             Status;
 212     ACPI_NAMESPACE_NODE     *Node;
 213     ACPI_BUFFER             Buffer;
 214     UINT32                  DebugLevel;
 215
 216
 217     /* Save current debug level so we don't get extraneous debug output */
 218
 219     DebugLevel = AcpiDbgLevel;
 220     AcpiDbgLevel = 0;
 221
 222     /* Just get the Node out of the Op object */
 223
 224     Node = Op->Common.Node;
 225     if (!Node)
 226     {
 227         /* Node not defined in this scope, look it up */
 228
 229         Status = AcpiNsLookup (WalkState->ScopeInfo, Op->Common.Value.String,
 230                     ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
 231                     WalkState, &(Node));
 232
 233         if (ACPI_FAILURE (Status))
 234         {
 235             /*
 236              * We can't get the pathname since the object
 237              * is not in the namespace.  This can happen during single
 238              * stepping where a dynamic named object is *about* to be created.
 239              */
 240             AcpiOsPrintf ("  [Path not found]");
 241             goto Exit;
 242         }
 243
 244         /* Save it for next time. */
 245
 246         Op->Common.Node = Node;
 247     }
 248
 249     /* Convert NamedDesc/handle to a full pathname */
 250
 251     Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
 252     Status = AcpiNsHandleToPathname (Node, &Buffer);
 253     if (ACPI_FAILURE (Status))
 254     {
 255         AcpiOsPrintf ("****Could not get pathname****)");
 256         goto Exit;
 257     }
 258
 259     AcpiOsPrintf ("  (Path %s)", (char *) Buffer.Pointer);
 260     ACPI_FREE (Buffer.Pointer);
 261
 262
 263 Exit:
 264     /* Restore the debug level */
 265
 266     AcpiDbgLevel = DebugLevel;
 267     return (Status);
 268 }
 269
 270
 271 /*******************************************************************************
 272  *
 273  * FUNCTION:    AcpiDmNamestring
 274  *
 275  * PARAMETERS:  Name                - ACPI Name string to store
 276  *
 277  * RETURN:      None
 278  *
 279  * DESCRIPTION: Decode and dump an ACPI namestring. Handles prefix characters
 280  *
 281  ******************************************************************************/
 282
 283 void
 284 AcpiDmNamestring (
 285     char                    *Name)
 286 {
 287     UINT32                  SegCount;
 288
 289
 290     if (!Name)
 291     {
 292         return;
 293     }
 294
 295     /* Handle all Scope Prefix operators */
 296
 297     while (AcpiPsIsPrefixChar (ACPI_GET8 (Name)))
 298     {
 299         /* Append prefix character */
 300
 301         AcpiOsPrintf ("%1c", ACPI_GET8 (Name));
 302         Name++;
 303     }
 304
 305     switch (ACPI_GET8 (Name))
 306     {
 307     case 0:
 308         SegCount = 0;
 309         break;
 310
 311     case AML_DUAL_NAME_PREFIX:
 312         SegCount = 2;
 313         Name++;
 314         break;
 315
 316     case AML_MULTI_NAME_PREFIX_OP:
 317         SegCount = (UINT32) ACPI_GET8 (Name + 1);
 318         Name += 2;
 319         break;
 320
 321     default:
 322         SegCount = 1;
 323         break;
 324     }
 325
 326     while (SegCount)
 327     {
 328         /* Append Name segment */
 329
 330         AcpiDmDumpName ((char *) Name);
 331
 332         SegCount--;
 333         if (SegCount)
 334         {
 335             /* Not last name, append dot separator */
 336
 337             AcpiOsPrintf (".");
 338         }
 339         Name += ACPI_NAME_SIZE;
 340     }
 341 }
 342
 343
 344 #ifdef ACPI_OBSOLETE_FUNCTIONS
 345 /*******************************************************************************
 346  *
 347  * FUNCTION:    AcpiDmDisplayPath
 348  *
 349  * PARAMETERS:  Op                  - Named Op whose path is to be constructed
 350  *
 351  * RETURN:      None
 352  *
 353  * DESCRIPTION: Walk backwards from current scope and display the name
 354  *              of each previous level of scope up to the root scope
 355  *              (like "pwd" does with file systems)
 356  *
 357  ******************************************************************************/
 358
 359 void
 360 AcpiDmDisplayPath (
 361     ACPI_PARSE_OBJECT       *Op)
 362 {
 363     ACPI_PARSE_OBJECT       *Prev;
 364     ACPI_PARSE_OBJECT       *Search;
 365     UINT32                  Name;
 366     BOOLEAN                 DoDot = FALSE;
 367     ACPI_PARSE_OBJECT       *NamePath;
 368     const ACPI_OPCODE_INFO  *OpInfo;
 369
 370
 371     /* We are only interested in named objects */
 372
 373     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
 374     if (!(OpInfo->Flags & AML_NSNODE))
 375     {
 376         return;
 377     }
 378
 379     if (OpInfo->Flags & AML_CREATE)
 380     {
 381         /* Field creation - check for a fully qualified namepath */
 382
 383         if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
 384         {
 385             NamePath = AcpiPsGetArg (Op, 3);
 386         }
 387         else
 388         {
 389             NamePath = AcpiPsGetArg (Op, 2);
 390         }
 391
 392         if ((NamePath) &&
 393             (NamePath->Common.Value.String) &&
 394             (NamePath->Common.Value.String[0] == '\\'))
 395         {
 396             AcpiDmNamestring (NamePath->Common.Value.String);
 397             return;
 398         }
 399     }
 400
 401     Prev = NULL;            /* Start with Root Node */
 402
 403     while (Prev != Op)
 404     {
 405         /* Search upwards in the tree to find scope with "prev" as its parent */
 406
 407         Search = Op;
 408         for (; ;)
 409         {
 410             if (Search->Common.Parent == Prev)
 411             {
 412                 break;
 413             }
 414
 415             /* Go up one level */
 416
 417             Search = Search->Common.Parent;
 418         }
 419
 420         if (Prev)
 421         {
 422             OpInfo = AcpiPsGetOpcodeInfo (Search->Common.AmlOpcode);
 423             if (!(OpInfo->Flags & AML_FIELD))
 424             {
 425                 /* Below root scope, append scope name */
 426
 427                 if (DoDot)
 428                 {
 429                     /* Append dot */
 430
 431                     AcpiOsPrintf (".");
 432                 }
 433
 434                 if (OpInfo->Flags & AML_CREATE)
 435                 {
 436                     if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
 437                     {
 438                         NamePath = AcpiPsGetArg (Op, 3);
 439                     }
 440                     else
 441                     {
 442                         NamePath = AcpiPsGetArg (Op, 2);
 443                     }
 444
 445                     if ((NamePath) &&
 446                         (NamePath->Common.Value.String))
 447                     {
 448                         AcpiDmDumpName (NamePath->Common.Value.String);
 449                     }
 450                 }
 451                 else
 452                 {
 453                     Name = AcpiPsGetName (Search);
 454                     AcpiDmDumpName ((char *) &Name);
 455                 }
 456
 457                 DoDot = TRUE;
 458             }
 459         }
 460         Prev = Search;
 461     }
 462 }
 463
 464
 465 /*******************************************************************************
 466  *
 467  * FUNCTION:    AcpiDmValidateName
 468  *
 469  * PARAMETERS:  Name            - 4 character ACPI name
 470  *
 471  * RETURN:      None
 472  *
 473  * DESCRIPTION: Lookup the name
 474  *
 475  ******************************************************************************/
 476
 477 void
 478 AcpiDmValidateName (
 479     char                    *Name,
 480     ACPI_PARSE_OBJECT       *Op)
 481 {
 482
 483     if ((!Name) ||
 484         (!Op->Common.Parent))
 485     {
 486         return;
 487     }
 488
 489     if (!Op->Common.Node)
 490     {
 491         AcpiOsPrintf (
 492             " /**** Name not found or not accessible from this scope ****/ ");
 493     }
 494
 495     ACPI_PARSE_OBJECT       *TargetOp;
 496
 497
 498     if ((!Name) ||
 499         (!Op->Common.Parent))
 500     {
 501         return;
 502     }
 503
 504     TargetOp = AcpiPsFind (Op, Name, 0, 0);
 505     if (!TargetOp)
 506     {
 507         /*
 508          * Didn't find the name in the parse tree.  This may be
 509          * a problem, or it may simply be one of the predefined names
 510          * (such as _OS_).  Rather than worry about looking up all
 511          * the predefined names, just display the name as given
 512          */
 513         AcpiOsPrintf (
 514             " /**** Name not found or not accessible from this scope ****/ ");
 515     }
 516 }
 517 #endif
 518
 519 #endif
 520
 521