sys/contrib/dev/acpica/dmnames.c

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