sys/contrib/dev/acpica/debugger/dbutils.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dbutils - AML debugger utilities
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2010, 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 <contrib/dev/acpica/include/acpi.h>
 118 #include <contrib/dev/acpica/include/accommon.h>
 119 #include <contrib/dev/acpica/include/acnamesp.h>
 120 #include <contrib/dev/acpica/include/acdebug.h>
 121 #include <contrib/dev/acpica/include/acdisasm.h>
 122
 123
 124 #ifdef ACPI_DEBUGGER
 125
 126 #define _COMPONENT          ACPI_CA_DEBUGGER
 127         ACPI_MODULE_NAME    ("dbutils")
 128
 129 /* Local prototypes */
 130
 131 #ifdef ACPI_OBSOLETE_FUNCTIONS
 132 ACPI_STATUS
 133 AcpiDbSecondPassParse (
 134     ACPI_PARSE_OBJECT       *Root);
 135
 136 void
 137 AcpiDbDumpBuffer (
 138     UINT32                  Address);
 139 #endif
 140
 141 static char                 *Converter = "0123456789ABCDEF";
 142
 143
 144 /*******************************************************************************
 145  *
 146  * FUNCTION:    AcpiDbMatchArgument
 147  *
 148  * PARAMETERS:  UserArgument            - User command line
 149  *              Arguments               - Array of commands to match against
 150  *
 151  * RETURN:      Index into command array or ACPI_TYPE_NOT_FOUND if not found
 152  *
 153  * DESCRIPTION: Search command array for a command match
 154  *
 155  ******************************************************************************/
 156
 157 ACPI_OBJECT_TYPE
 158 AcpiDbMatchArgument (
 159     char                    *UserArgument,
 160     ARGUMENT_INFO           *Arguments)
 161 {
 162     UINT32                  i;
 163
 164
 165     if (!UserArgument || UserArgument[0] == 0)
 166     {
 167         return (ACPI_TYPE_NOT_FOUND);
 168     }
 169
 170     for (i = 0; Arguments[i].Name; i++)
 171     {
 172         if (ACPI_STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name)
 173         {
 174             return (i);
 175         }
 176     }
 177
 178     /* Argument not recognized */
 179
 180     return (ACPI_TYPE_NOT_FOUND);
 181 }
 182
 183
 184 /*******************************************************************************
 185  *
 186  * FUNCTION:    AcpiDbSetOutputDestination
 187  *
 188  * PARAMETERS:  OutputFlags         - Current flags word
 189  *
 190  * RETURN:      None
 191  *
 192  * DESCRIPTION: Set the current destination for debugger output.  Also sets
 193  *              the debug output level accordingly.
 194  *
 195  ******************************************************************************/
 196
 197 void
 198 AcpiDbSetOutputDestination (
 199     UINT32                  OutputFlags)
 200 {
 201
 202     AcpiGbl_DbOutputFlags = (UINT8) OutputFlags;
 203
 204     if ((OutputFlags & ACPI_DB_REDIRECTABLE_OUTPUT) && AcpiGbl_DbOutputToFile)
 205     {
 206         AcpiDbgLevel = AcpiGbl_DbDebugLevel;
 207     }
 208     else
 209     {
 210         AcpiDbgLevel = AcpiGbl_DbConsoleDebugLevel;
 211     }
 212 }
 213
 214
 215 /*******************************************************************************
 216  *
 217  * FUNCTION:    AcpiDbDumpExternalObject
 218  *
 219  * PARAMETERS:  ObjDesc         - External ACPI object to dump
 220  *              Level           - Nesting level.
 221  *
 222  * RETURN:      None
 223  *
 224  * DESCRIPTION: Dump the contents of an ACPI external object
 225  *
 226  ******************************************************************************/
 227
 228 void
 229 AcpiDbDumpExternalObject (
 230     ACPI_OBJECT             *ObjDesc,
 231     UINT32                  Level)
 232 {
 233     UINT32                  i;
 234
 235
 236     if (!ObjDesc)
 237     {
 238         AcpiOsPrintf ("[Null Object]\n");
 239         return;
 240     }
 241
 242     for (i = 0; i < Level; i++)
 243     {
 244         AcpiOsPrintf ("  ");
 245     }
 246
 247     switch (ObjDesc->Type)
 248     {
 249     case ACPI_TYPE_ANY:
 250
 251         AcpiOsPrintf ("[Null Object] (Type=0)\n");
 252         break;
 253
 254
 255     case ACPI_TYPE_INTEGER:
 256
 257         AcpiOsPrintf ("[Integer] = %8.8X%8.8X\n",
 258                     ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
 259         break;
 260
 261
 262     case ACPI_TYPE_STRING:
 263
 264         AcpiOsPrintf ("[String] Length %.2X = ", ObjDesc->String.Length);
 265         for (i = 0; i < ObjDesc->String.Length; i++)
 266         {
 267             AcpiOsPrintf ("%c", ObjDesc->String.Pointer[i]);
 268         }
 269         AcpiOsPrintf ("\n");
 270         break;
 271
 272
 273     case ACPI_TYPE_BUFFER:
 274
 275         AcpiOsPrintf ("[Buffer] Length %.2X = ", ObjDesc->Buffer.Length);
 276         if (ObjDesc->Buffer.Length)
 277         {
 278             if (ObjDesc->Buffer.Length > 16)
 279             {
 280                 AcpiOsPrintf ("\n");
 281             }
 282             AcpiUtDumpBuffer (ACPI_CAST_PTR (UINT8, ObjDesc->Buffer.Pointer),
 283                     ObjDesc->Buffer.Length, DB_DWORD_DISPLAY, _COMPONENT);
 284         }
 285         else
 286         {
 287             AcpiOsPrintf ("\n");
 288         }
 289         break;
 290
 291
 292     case ACPI_TYPE_PACKAGE:
 293
 294         AcpiOsPrintf ("[Package] Contains %d Elements:\n",
 295                 ObjDesc->Package.Count);
 296
 297         for (i = 0; i < ObjDesc->Package.Count; i++)
 298         {
 299             AcpiDbDumpExternalObject (&ObjDesc->Package.Elements[i], Level+1);
 300         }
 301         break;
 302
 303
 304     case ACPI_TYPE_LOCAL_REFERENCE:
 305
 306         AcpiOsPrintf ("[Object Reference] = ");
 307         AcpiDmDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
 308         break;
 309
 310
 311     case ACPI_TYPE_PROCESSOR:
 312
 313         AcpiOsPrintf ("[Processor]\n");
 314         break;
 315
 316
 317     case ACPI_TYPE_POWER:
 318
 319         AcpiOsPrintf ("[Power Resource]\n");
 320         break;
 321
 322
 323     default:
 324
 325         AcpiOsPrintf ("[Unknown Type] %X\n", ObjDesc->Type);
 326         break;
 327     }
 328 }
 329
 330
 331 /*******************************************************************************
 332  *
 333  * FUNCTION:    AcpiDbPrepNamestring
 334  *
 335  * PARAMETERS:  Name            - String to prepare
 336  *
 337  * RETURN:      None
 338  *
 339  * DESCRIPTION: Translate all forward slashes and dots to backslashes.
 340  *
 341  ******************************************************************************/
 342
 343 void
 344 AcpiDbPrepNamestring (
 345     char                    *Name)
 346 {
 347
 348     if (!Name)
 349     {
 350         return;
 351     }
 352
 353     AcpiUtStrupr (Name);
 354
 355     /* Convert a leading forward slash to a backslash */
 356
 357     if (*Name == '/')
 358     {
 359         *Name = '\\';
 360     }
 361
 362     /* Ignore a leading backslash, this is the root prefix */
 363
 364     if (*Name == '\\')
 365     {
 366         Name++;
 367     }
 368
 369     /* Convert all slash path separators to dots */
 370
 371     while (*Name)
 372     {
 373         if ((*Name == '/') ||
 374             (*Name == '\\'))
 375         {
 376             *Name = '.';
 377         }
 378
 379         Name++;
 380     }
 381 }
 382
 383
 384 /*******************************************************************************
 385  *
 386  * FUNCTION:    AcpiDbLocalNsLookup
 387  *
 388  * PARAMETERS:  Name            - Name to lookup
 389  *
 390  * RETURN:      Pointer to a namespace node, null on failure
 391  *
 392  * DESCRIPTION: Lookup a name in the ACPI namespace
 393  *
 394  * Note: Currently begins search from the root.  Could be enhanced to use
 395  * the current prefix (scope) node as the search beginning point.
 396  *
 397  ******************************************************************************/
 398
 399 ACPI_NAMESPACE_NODE *
 400 AcpiDbLocalNsLookup (
 401     char                    *Name)
 402 {
 403     char                    *InternalPath;
 404     ACPI_STATUS             Status;
 405     ACPI_NAMESPACE_NODE     *Node = NULL;
 406
 407
 408     AcpiDbPrepNamestring (Name);
 409
 410     /* Build an internal namestring */
 411
 412     Status = AcpiNsInternalizeName (Name, &InternalPath);
 413     if (ACPI_FAILURE (Status))
 414     {
 415         AcpiOsPrintf ("Invalid namestring: %s\n", Name);
 416         return (NULL);
 417     }
 418
 419     /*
 420      * Lookup the name.
 421      * (Uses root node as the search starting point)
 422      */
 423     Status = AcpiNsLookup (NULL, InternalPath, ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
 424                     ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE, NULL, &Node);
 425     if (ACPI_FAILURE (Status))
 426     {
 427         AcpiOsPrintf ("Could not locate name: %s, %s\n",
 428                 Name, AcpiFormatException (Status));
 429     }
 430
 431     ACPI_FREE (InternalPath);
 432     return (Node);
 433 }
 434
 435
 436 /*******************************************************************************
 437  *
 438  * FUNCTION:    AcpiDbUInt32ToHexString
 439  *
 440  * PARAMETERS:  Value           - The value to be converted to string
 441  *              Buffer          - Buffer for result (not less than 11 bytes)
 442  *
 443  * RETURN:      None
 444  *
 445  * DESCRIPTION: Convert the unsigned 32-bit value to the hexadecimal image
 446  *
 447  * NOTE: It is the caller's responsibility to ensure that the length of buffer
 448  *       is sufficient.
 449  *
 450  ******************************************************************************/
 451
 452 void
 453 AcpiDbUInt32ToHexString (
 454     UINT32                  Value,
 455     char                    *Buffer)
 456 {
 457     UINT8                   i;
 458
 459
 460     if (Value == 0)
 461     {
 462         ACPI_STRCPY (Buffer, "0");
 463         return;
 464     }
 465
 466     ACPI_STRCPY (Buffer, "0x");
 467     Buffer[10] = '\0';
 468
 469     for (i = 9; i > 1; i--)
 470     {
 471         Buffer[i] = Converter [Value & 0x0F];
 472         Value = Value >> 4;
 473     }
 474 }
 475
 476
 477 #ifdef ACPI_OBSOLETE_FUNCTIONS
 478 /*******************************************************************************
 479  *
 480  * FUNCTION:    AcpiDbSecondPassParse
 481  *
 482  * PARAMETERS:  Root            - Root of the parse tree
 483  *
 484  * RETURN:      Status
 485  *
 486  * DESCRIPTION: Second pass parse of the ACPI tables.  We need to wait until
 487  *              second pass to parse the control methods
 488  *
 489  ******************************************************************************/
 490
 491 ACPI_STATUS
 492 AcpiDbSecondPassParse (
 493     ACPI_PARSE_OBJECT       *Root)
 494 {
 495     ACPI_PARSE_OBJECT       *Op = Root;
 496     ACPI_PARSE_OBJECT       *Method;
 497     ACPI_PARSE_OBJECT       *SearchOp;
 498     ACPI_PARSE_OBJECT       *StartOp;
 499     ACPI_STATUS             Status = AE_OK;
 500     UINT32                  BaseAmlOffset;
 501     ACPI_WALK_STATE         *WalkState;
 502
 503
 504     ACPI_FUNCTION_ENTRY ();
 505
 506
 507     AcpiOsPrintf ("Pass two parse ....\n");
 508
 509     while (Op)
 510     {
 511         if (Op->Common.AmlOpcode == AML_METHOD_OP)
 512         {
 513             Method = Op;
 514
 515             /* Create a new walk state for the parse */
 516
 517             WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
 518             if (!WalkState)
 519             {
 520                 return (AE_NO_MEMORY);
 521             }
 522
 523             /* Init the Walk State */
 524
 525             WalkState->ParserState.Aml          =
 526             WalkState->ParserState.AmlStart     = Method->Named.Data;
 527             WalkState->ParserState.AmlEnd       =
 528             WalkState->ParserState.PkgEnd       = Method->Named.Data +
 529                                                   Method->Named.Length;
 530             WalkState->ParserState.StartScope   = Op;
 531
 532             WalkState->DescendingCallback       = AcpiDsLoad1BeginOp;
 533             WalkState->AscendingCallback        = AcpiDsLoad1EndOp;
 534
 535             /* Perform the AML parse */
 536
 537             Status = AcpiPsParseAml (WalkState);
 538
 539             BaseAmlOffset = (Method->Common.Value.Arg)->Common.AmlOffset + 1;
 540             StartOp = (Method->Common.Value.Arg)->Common.Next;
 541             SearchOp = StartOp;
 542
 543             while (SearchOp)
 544             {
 545                 SearchOp->Common.AmlOffset += BaseAmlOffset;
 546                 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
 547             }
 548         }
 549
 550         if (Op->Common.AmlOpcode == AML_REGION_OP)
 551         {
 552             /* TBD: [Investigate] this isn't quite the right thing to do! */
 553             /*
 554              *
 555              * Method = (ACPI_DEFERRED_OP *) Op;
 556              * Status = AcpiPsParseAml (Op, Method->Body, Method->BodyLength);
 557              */
 558         }
 559
 560         if (ACPI_FAILURE (Status))
 561         {
 562             break;
 563         }
 564
 565         Op = AcpiPsGetDepthNext (Root, Op);
 566     }
 567
 568     return (Status);
 569 }
 570
 571
 572 /*******************************************************************************
 573  *
 574  * FUNCTION:    AcpiDbDumpBuffer
 575  *
 576  * PARAMETERS:  Address             - Pointer to the buffer
 577  *
 578  * RETURN:      None
 579  *
 580  * DESCRIPTION: Print a portion of a buffer
 581  *
 582  ******************************************************************************/
 583
 584 void
 585 AcpiDbDumpBuffer (
 586     UINT32                  Address)
 587 {
 588
 589     AcpiOsPrintf ("\nLocation %X:\n", Address);
 590
 591     AcpiDbgLevel |= ACPI_LV_TABLES;
 592     AcpiUtDumpBuffer (ACPI_TO_POINTER (Address), 64, DB_BYTE_DISPLAY,
 593             ACPI_UINT32_MAX);
 594 }
 595 #endif
 596
 597 #endif /* ACPI_DEBUGGER */
 598
 599