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

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