sys/contrib/dev/acpica/dbutils.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dbutils - AML debugger utilities
   4  *              $Revision: 1.83 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2007, 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/acnamesp.h>
 120 #include <contrib/dev/acpica/acdebug.h>
 121 #include <contrib/dev/acpica/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 ("[Object Reference] = %p", ObjDesc->Reference.Handle);
 252         AcpiDmDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
 253         break;
 254
 255
 256     case ACPI_TYPE_INTEGER:
 257
 258         AcpiOsPrintf ("[Integer] = %8.8X%8.8X\n",
 259                     ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
 260         break;
 261
 262
 263     case ACPI_TYPE_STRING:
 264
 265         AcpiOsPrintf ("[String] Length %.2X = ", ObjDesc->String.Length);
 266         for (i = 0; i < ObjDesc->String.Length; i++)
 267         {
 268             AcpiOsPrintf ("%c", ObjDesc->String.Pointer[i]);
 269         }
 270         AcpiOsPrintf ("\n");
 271         break;
 272
 273
 274     case ACPI_TYPE_BUFFER:
 275
 276         AcpiOsPrintf ("[Buffer] Length %.2X = ", ObjDesc->Buffer.Length);
 277         if (ObjDesc->Buffer.Length)
 278         {
 279             AcpiUtDumpBuffer (ACPI_CAST_PTR (UINT8, ObjDesc->Buffer.Pointer),
 280                     ObjDesc->Buffer.Length, DB_DWORD_DISPLAY, _COMPONENT);
 281         }
 282         else
 283         {
 284             AcpiOsPrintf ("\n");
 285         }
 286         break;
 287
 288
 289     case ACPI_TYPE_PACKAGE:
 290
 291         AcpiOsPrintf ("[Package] Contains %d Elements:\n",
 292                 ObjDesc->Package.Count);
 293
 294         for (i = 0; i < ObjDesc->Package.Count; i++)
 295         {
 296             AcpiDbDumpExternalObject (&ObjDesc->Package.Elements[i], Level+1);
 297         }
 298         break;
 299
 300
 301     case ACPI_TYPE_LOCAL_REFERENCE:
 302
 303         AcpiOsPrintf ("[Object Reference] = %p", ObjDesc->Reference.Handle);
 304         AcpiDmDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
 305         break;
 306
 307
 308     case ACPI_TYPE_PROCESSOR:
 309
 310         AcpiOsPrintf ("[Processor]\n");
 311         break;
 312
 313
 314     case ACPI_TYPE_POWER:
 315
 316         AcpiOsPrintf ("[Power Resource]\n");
 317         break;
 318
 319
 320     default:
 321
 322         AcpiOsPrintf ("[Unknown Type] %X\n", ObjDesc->Type);
 323         break;
 324     }
 325 }
 326
 327
 328 /*******************************************************************************
 329  *
 330  * FUNCTION:    AcpiDbPrepNamestring
 331  *
 332  * PARAMETERS:  Name            - String to prepare
 333  *
 334  * RETURN:      None
 335  *
 336  * DESCRIPTION: Translate all forward slashes and dots to backslashes.
 337  *
 338  ******************************************************************************/
 339
 340 void
 341 AcpiDbPrepNamestring (
 342     char                    *Name)
 343 {
 344
 345     if (!Name)
 346     {
 347         return;
 348     }
 349
 350     AcpiUtStrupr (Name);
 351
 352     /* Convert a leading forward slash to a backslash */
 353
 354     if (*Name == '/')
 355     {
 356         *Name = '\\';
 357     }
 358
 359     /* Ignore a leading backslash, this is the root prefix */
 360
 361     if (*Name == '\\')
 362     {
 363         Name++;
 364     }
 365
 366     /* Convert all slash path separators to dots */
 367
 368     while (*Name)
 369     {
 370         if ((*Name == '/') ||
 371             (*Name == '\\'))
 372         {
 373             *Name = '.';
 374         }
 375
 376         Name++;
 377     }
 378 }
 379
 380
 381 /*******************************************************************************
 382  *
 383  * FUNCTION:    AcpiDbLocalNsLookup
 384  *
 385  * PARAMETERS:  Name            - Name to lookup
 386  *
 387  * RETURN:      Pointer to a namespace node, null on failure
 388  *
 389  * DESCRIPTION: Lookup a name in the ACPI namespace
 390  *
 391  * Note: Currently begins search from the root.  Could be enhanced to use
 392  * the current prefix (scope) node as the search beginning point.
 393  *
 394  ******************************************************************************/
 395
 396 ACPI_NAMESPACE_NODE *
 397 AcpiDbLocalNsLookup (
 398     char                    *Name)
 399 {
 400     char                    *InternalPath;
 401     ACPI_STATUS             Status;
 402     ACPI_NAMESPACE_NODE     *Node = NULL;
 403
 404
 405     AcpiDbPrepNamestring (Name);
 406
 407     /* Build an internal namestring */
 408
 409     Status = AcpiNsInternalizeName (Name, &InternalPath);
 410     if (ACPI_FAILURE (Status))
 411     {
 412         AcpiOsPrintf ("Invalid namestring: %s\n", Name);
 413         return (NULL);
 414     }
 415
 416     /*
 417      * Lookup the name.
 418      * (Uses root node as the search starting point)
 419      */
 420     Status = AcpiNsLookup (NULL, InternalPath, ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
 421                     ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE, NULL, &Node);
 422     if (ACPI_FAILURE (Status))
 423     {
 424         AcpiOsPrintf ("Could not locate name: %s, %s\n",
 425                 Name, AcpiFormatException (Status));
 426     }
 427
 428     ACPI_FREE (InternalPath);
 429     return (Node);
 430 }
 431
 432
 433 /*******************************************************************************
 434  *
 435  * FUNCTION:    AcpiDbUInt32ToHexString
 436  *
 437  * PARAMETERS:  Value           - The value to be converted to string
 438  *              Buffer          - Buffer for result (not less than 11 bytes)
 439  *
 440  * RETURN:      None
 441  *
 442  * DESCRIPTION: Convert the unsigned 32-bit value to the hexadecimal image
 443  *
 444  * NOTE: It is the caller's responsibility to ensure that the length of buffer
 445  *       is sufficient.
 446  *
 447  ******************************************************************************/
 448
 449 void
 450 AcpiDbUInt32ToHexString (
 451     UINT32                  Value,
 452     char                    *Buffer)
 453 {
 454     UINT8                   i;
 455
 456
 457     if (Value == 0)
 458     {
 459         ACPI_STRCPY (Buffer, "0");
 460         return;
 461     }
 462
 463     ACPI_STRCPY (Buffer, "0x");
 464     Buffer[10] = '\0';
 465
 466     for (i = 9; i > 1; i--)
 467     {
 468         Buffer[i] = Converter [Value & 0x0F];
 469         Value = Value >> 4;
 470     }
 471 }
 472
 473
 474 #ifdef ACPI_OBSOLETE_FUNCTIONS
 475 /*******************************************************************************
 476  *
 477  * FUNCTION:    AcpiDbSecondPassParse
 478  *
 479  * PARAMETERS:  Root            - Root of the parse tree
 480  *
 481  * RETURN:      Status
 482  *
 483  * DESCRIPTION: Second pass parse of the ACPI tables.  We need to wait until
 484  *              second pass to parse the control methods
 485  *
 486  ******************************************************************************/
 487
 488 ACPI_STATUS
 489 AcpiDbSecondPassParse (
 490     ACPI_PARSE_OBJECT       *Root)
 491 {
 492     ACPI_PARSE_OBJECT       *Op = Root;
 493     ACPI_PARSE_OBJECT       *Method;
 494     ACPI_PARSE_OBJECT       *SearchOp;
 495     ACPI_PARSE_OBJECT       *StartOp;
 496     ACPI_STATUS             Status = AE_OK;
 497     UINT32                  BaseAmlOffset;
 498     ACPI_WALK_STATE         *WalkState;
 499
 500
 501     ACPI_FUNCTION_ENTRY ();
 502
 503
 504     AcpiOsPrintf ("Pass two parse ....\n");
 505
 506     while (Op)
 507     {
 508         if (Op->Common.AmlOpcode == AML_METHOD_OP)
 509         {
 510             Method = Op;
 511
 512             /* Create a new walk state for the parse */
 513
 514             WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
 515             if (!WalkState)
 516             {
 517                 return (AE_NO_MEMORY);
 518             }
 519
 520             /* Init the Walk State */
 521
 522             WalkState->ParserState.Aml          =
 523             WalkState->ParserState.AmlStart     = Method->Named.Data;
 524             WalkState->ParserState.AmlEnd       =
 525             WalkState->ParserState.PkgEnd       = Method->Named.Data +
 526                                                   Method->Named.Length;
 527             WalkState->ParserState.StartScope   = Op;
 528
 529             WalkState->DescendingCallback       = AcpiDsLoad1BeginOp;
 530             WalkState->AscendingCallback        = AcpiDsLoad1EndOp;
 531
 532             /* Perform the AML parse */
 533
 534             Status = AcpiPsParseAml (WalkState);
 535
 536             BaseAmlOffset = (Method->Common.Value.Arg)->Common.AmlOffset + 1;
 537             StartOp = (Method->Common.Value.Arg)->Common.Next;
 538             SearchOp = StartOp;
 539
 540             while (SearchOp)
 541             {
 542                 SearchOp->Common.AmlOffset += BaseAmlOffset;
 543                 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
 544             }
 545         }
 546
 547         if (Op->Common.AmlOpcode == AML_REGION_OP)
 548         {
 549             /* TBD: [Investigate] this isn't quite the right thing to do! */
 550             /*
 551              *
 552              * Method = (ACPI_DEFERRED_OP *) Op;
 553              * Status = AcpiPsParseAml (Op, Method->Body, Method->BodyLength);
 554              */
 555         }
 556
 557         if (ACPI_FAILURE (Status))
 558         {
 559             break;
 560         }
 561
 562         Op = AcpiPsGetDepthNext (Root, Op);
 563     }
 564
 565     return (Status);
 566 }
 567
 568
 569 /*******************************************************************************
 570  *
 571  * FUNCTION:    AcpiDbDumpBuffer
 572  *
 573  * PARAMETERS:  Address             - Pointer to the buffer
 574  *
 575  * RETURN:      None
 576  *
 577  * DESCRIPTION: Print a portion of a buffer
 578  *
 579  ******************************************************************************/
 580
 581 void
 582 AcpiDbDumpBuffer (
 583     UINT32                  Address)
 584 {
 585
 586     AcpiOsPrintf ("\nLocation %X:\n", Address);
 587
 588     AcpiDbgLevel |= ACPI_LV_TABLES;
 589     AcpiUtDumpBuffer (ACPI_TO_POINTER (Address), 64, DB_BYTE_DISPLAY,
 590             ACPI_UINT32_MAX);
 591 }
 592 #endif
 593
 594 #endif /* ACPI_DEBUGGER */
 595
 596