sys/contrib/dev/acpica/acdebug.h

   1 /******************************************************************************
   2  *
   3  * Name: acdebug.h - ACPI/AML debugger
   4  *       $Revision: 74 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2004, 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 #ifndef __ACDEBUG_H__
 118 #define __ACDEBUG_H__
 119
 120
 121 #define ACPI_DEBUG_BUFFER_SIZE  4196
 122
 123 typedef struct CommandInfo
 124 {
 125     char                    *Name;          /* Command Name */
 126     UINT8                   MinArgs;        /* Minimum arguments required */
 127
 128 } COMMAND_INFO;
 129
 130
 131 typedef struct ArgumentInfo
 132 {
 133     char                    *Name;          /* Argument Name */
 134
 135 } ARGUMENT_INFO;
 136
 137
 138 #define PARAM_LIST(pl)                  pl
 139
 140 #define DBTEST_OUTPUT_LEVEL(lvl)        if (AcpiGbl_DbOpt_verbose)
 141
 142 #define VERBOSE_PRINT(fp)               DBTEST_OUTPUT_LEVEL(lvl) {\
 143                                             AcpiOsPrintf PARAM_LIST(fp);}
 144
 145 #define EX_NO_SINGLE_STEP               1
 146 #define EX_SINGLE_STEP                  2
 147
 148
 149 /* Prototypes */
 150
 151
 152 /*
 153  * dbxface - external debugger interfaces
 154  */
 155
 156 ACPI_STATUS
 157 AcpiDbInitialize (
 158     void);
 159
 160 void
 161 AcpiDbTerminate (
 162     void);
 163
 164 ACPI_STATUS
 165 AcpiDbSingleStep (
 166     ACPI_WALK_STATE         *WalkState,
 167     ACPI_PARSE_OBJECT       *Op,
 168     UINT32                  OpType);
 169
 170 ACPI_STATUS
 171 AcpiDbStartCommand (
 172     ACPI_WALK_STATE         *WalkState,
 173     ACPI_PARSE_OBJECT       *Op);
 174
 175 void
 176 AcpiDbMethodEnd (
 177     ACPI_WALK_STATE         *WalkState);
 178
 179
 180 /*
 181  * dbcmds - debug commands and output routines
 182  */
 183
 184 void
 185 AcpiDbDisplayTableInfo (
 186     char                    *TableArg);
 187
 188 void
 189 AcpiDbUnloadAcpiTable (
 190     char                    *TableArg,
 191     char                    *InstanceArg);
 192
 193 void
 194 AcpiDbSetMethodBreakpoint (
 195     char                    *Location,
 196     ACPI_WALK_STATE         *WalkState,
 197     ACPI_PARSE_OBJECT       *Op);
 198
 199 void
 200 AcpiDbSetMethodCallBreakpoint (
 201     ACPI_PARSE_OBJECT       *Op);
 202
 203 void
 204 AcpiDbDisassembleAml (
 205     char                    *Statements,
 206     ACPI_PARSE_OBJECT       *Op);
 207
 208 void
 209 AcpiDbDumpNamespace (
 210     char                    *StartArg,
 211     char                    *DepthArg);
 212
 213 void
 214 AcpiDbDumpNamespaceByOwner (
 215     char                    *OwnerArg,
 216     char                    *DepthArg);
 217
 218 void
 219 AcpiDbSendNotify (
 220     char                    *Name,
 221     UINT32                  Value);
 222
 223 void
 224 AcpiDbSetMethodData (
 225     char                    *TypeArg,
 226     char                    *IndexArg,
 227     char                    *ValueArg);
 228
 229 ACPI_STATUS
 230 AcpiDbDisplayObjects (
 231     char                    *ObjTypeArg,
 232     char                    *DisplayCountArg);
 233
 234 ACPI_STATUS
 235 AcpiDbFindNameInNamespace (
 236     char                    *NameArg);
 237
 238 void
 239 AcpiDbSetScope (
 240     char                    *Name);
 241
 242 ACPI_STATUS
 243 AcpiDbSleep (
 244     char                    *ObjectArg);
 245
 246 void
 247 AcpiDbFindReferences (
 248     char                    *ObjectArg);
 249
 250 void
 251 AcpiDbDisplayLocks (void);
 252
 253
 254 void
 255 AcpiDbDisplayResources (
 256     char                    *ObjectArg);
 257
 258 void
 259 AcpiDbDisplayGpes (void);
 260
 261 void
 262 AcpiDbCheckIntegrity (
 263     void);
 264
 265 ACPI_STATUS
 266 AcpiDbIntegrityWalk (
 267     ACPI_HANDLE             ObjHandle,
 268     UINT32                  NestingLevel,
 269     void                    *Context,
 270     void                    **ReturnValue);
 271
 272 ACPI_STATUS
 273 AcpiDbWalkAndMatchName (
 274     ACPI_HANDLE             ObjHandle,
 275     UINT32                  NestingLevel,
 276     void                    *Context,
 277     void                    **ReturnValue);
 278
 279 ACPI_STATUS
 280 AcpiDbWalkForReferences (
 281     ACPI_HANDLE             ObjHandle,
 282     UINT32                  NestingLevel,
 283     void                    *Context,
 284     void                    **ReturnValue);
 285
 286 ACPI_STATUS
 287 AcpiDbWalkForSpecificObjects (
 288     ACPI_HANDLE             ObjHandle,
 289     UINT32                  NestingLevel,
 290     void                    *Context,
 291     void                    **ReturnValue);
 292
 293 void
 294 AcpiDbGenerateGpe (
 295     char                    *GpeArg,
 296     char                    *BlockArg);
 297
 298 /*
 299  * dbdisply - debug display commands
 300  */
 301
 302 void
 303 AcpiDbDisplayMethodInfo (
 304     ACPI_PARSE_OBJECT       *Op);
 305
 306 void
 307 AcpiDbDecodeAndDisplayObject (
 308     char                    *Target,
 309     char                    *OutputType);
 310
 311 void
 312 AcpiDbDisplayResultObject (
 313     ACPI_OPERAND_OBJECT     *ObjDesc,
 314     ACPI_WALK_STATE         *WalkState);
 315
 316 ACPI_STATUS
 317 AcpiDbDisplayAllMethods (
 318     char                    *DisplayCountArg);
 319
 320 void
 321 AcpiDbDisplayArguments (
 322     void);
 323
 324 void
 325 AcpiDbDisplayLocals (
 326     void);
 327
 328 void
 329 AcpiDbDisplayResults (
 330     void);
 331
 332 void
 333 AcpiDbDisplayCallingTree (
 334     void);
 335
 336 void
 337 AcpiDbDisplayObjectType (
 338     char                    *ObjectArg);
 339
 340 void
 341 AcpiDbDisplayArgumentObject (
 342     ACPI_OPERAND_OBJECT     *ObjDesc,
 343     ACPI_WALK_STATE         *WalkState);
 344
 345 void
 346 AcpiDbDumpParserDescriptor (
 347     ACPI_PARSE_OBJECT       *Op);
 348
 349 void *
 350 AcpiDbGetPointer (
 351     void                    *Target);
 352
 353
 354 /*
 355  * dbexec - debugger control method execution
 356  */
 357
 358 void
 359 AcpiDbExecute (
 360     char                    *Name,
 361     char                    **Args,
 362     UINT32                  Flags);
 363
 364 void
 365 AcpiDbCreateExecutionThreads (
 366     char                    *NumThreadsArg,
 367     char                    *NumLoopsArg,
 368     char                    *MethodNameArg);
 369
 370 ACPI_STATUS
 371 AcpiDbExecuteMethod (
 372     ACPI_DB_METHOD_INFO     *Info,
 373     ACPI_BUFFER             *ReturnObj);
 374
 375 void
 376 AcpiDbExecuteSetup (
 377     ACPI_DB_METHOD_INFO     *Info);
 378
 379 UINT32
 380 AcpiDbGetOutstandingAllocations (
 381     void);
 382
 383 void ACPI_SYSTEM_XFACE
 384 AcpiDbMethodThread (
 385     void                    *Context);
 386
 387 ACPI_STATUS
 388 AcpiDbExecutionWalk (
 389     ACPI_HANDLE             ObjHandle,
 390     UINT32                  NestingLevel,
 391     void                    *Context,
 392     void                    **ReturnValue);
 393
 394
 395 /*
 396  * dbfileio - Debugger file I/O commands
 397  */
 398
 399 ACPI_OBJECT_TYPE
 400 AcpiDbMatchArgument (
 401     char                    *UserArgument,
 402     ARGUMENT_INFO           *Arguments);
 403
 404 ACPI_STATUS
 405 AeLocalLoadTable (
 406     ACPI_TABLE_HEADER       *TablePtr);
 407
 408 void
 409 AcpiDbCloseDebugFile (
 410     void);
 411
 412 void
 413 AcpiDbOpenDebugFile (
 414     char                    *Name);
 415
 416 ACPI_STATUS
 417 AcpiDbLoadAcpiTable (
 418     char                    *Filename);
 419
 420 ACPI_STATUS
 421 AcpiDbGetTableFromFile (
 422     char                    *Filename,
 423     ACPI_TABLE_HEADER       **Table);
 424
 425 ACPI_STATUS
 426 AcpiDbReadTableFromFile (
 427     char                    *Filename,
 428     ACPI_TABLE_HEADER       **Table);
 429
 430 /*
 431  * dbhistry - debugger HISTORY command
 432  */
 433
 434 void
 435 AcpiDbAddToHistory (
 436     char                    *CommandLine);
 437
 438 void
 439 AcpiDbDisplayHistory (void);
 440
 441 char *
 442 AcpiDbGetFromHistory (
 443     char                    *CommandNumArg);
 444
 445
 446 /*
 447  * dbinput - user front-end to the AML debugger
 448  */
 449
 450 ACPI_STATUS
 451 AcpiDbCommandDispatch (
 452     char                    *InputBuffer,
 453     ACPI_WALK_STATE         *WalkState,
 454     ACPI_PARSE_OBJECT       *Op);
 455
 456 void ACPI_SYSTEM_XFACE
 457 AcpiDbExecuteThread (
 458     void                    *Context);
 459
 460 ACPI_STATUS
 461 AcpiDbUserCommands (
 462     char                    Prompt,
 463     ACPI_PARSE_OBJECT       *Op);
 464
 465 void
 466 AcpiDbDisplayHelp (
 467     char                    *HelpType);
 468
 469 char *
 470 AcpiDbGetNextToken (
 471     char                    *String,
 472     char                    **Next);
 473
 474 UINT32
 475 AcpiDbGetLine (
 476     char                    *InputBuffer);
 477
 478 UINT32
 479 AcpiDbMatchCommand (
 480     char                    *UserCommand);
 481
 482 void
 483 AcpiDbSingleThread (
 484     void);
 485
 486
 487 /*
 488  * dbstats - Generation and display of ACPI table statistics
 489  */
 490
 491 void
 492 AcpiDbGenerateStatistics (
 493     ACPI_PARSE_OBJECT       *Root,
 494     BOOLEAN                 IsMethod);
 495
 496
 497 ACPI_STATUS
 498 AcpiDbDisplayStatistics (
 499     char                    *TypeArg);
 500
 501 ACPI_STATUS
 502 AcpiDbClassifyOneObject (
 503     ACPI_HANDLE             ObjHandle,
 504     UINT32                  NestingLevel,
 505     void                    *Context,
 506     void                    **ReturnValue);
 507
 508 void
 509 AcpiDbCountNamespaceObjects (
 510     void);
 511
 512 void
 513 AcpiDbEnumerateObject (
 514     ACPI_OPERAND_OBJECT     *ObjDesc);
 515
 516
 517 /*
 518  * dbutils - AML debugger utilities
 519  */
 520
 521 void
 522 AcpiDbSetOutputDestination (
 523     UINT32                  Where);
 524
 525 void
 526 AcpiDbDumpBuffer (
 527     UINT32                  Address);
 528
 529 void
 530 AcpiDbDumpObject (
 531     ACPI_OBJECT             *ObjDesc,
 532     UINT32                  Level);
 533
 534 void
 535 AcpiDbPrepNamestring (
 536     char                    *Name);
 537
 538
 539 ACPI_STATUS
 540 AcpiDbSecondPassParse (
 541     ACPI_PARSE_OBJECT       *Root);
 542
 543 ACPI_NAMESPACE_NODE *
 544 AcpiDbLocalNsLookup (
 545     char                    *Name);
 546
 547
 548 #endif  /* __ACDEBUG_H__ */