sys/contrib/dev/acpica-unix-20031203/include/acdebug.h

   1 /******************************************************************************
   2  *
   3  * Name: acdebug.h - ACPI/AML debugger
   4  *       $Revision: 72 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 void
 243 AcpiDbFindReferences (
 244     char                    *ObjectArg);
 245
 246 void
 247 AcpiDbDisplayLocks (void);
 248
 249
 250 void
 251 AcpiDbDisplayResources (
 252     char                    *ObjectArg);
 253
 254 void
 255 AcpiDbDisplayGpes (void);
 256
 257 void
 258 AcpiDbCheckIntegrity (
 259     void);
 260
 261 ACPI_STATUS
 262 AcpiDbIntegrityWalk (
 263     ACPI_HANDLE             ObjHandle,
 264     UINT32                  NestingLevel,
 265     void                    *Context,
 266     void                    **ReturnValue);
 267
 268 ACPI_STATUS
 269 AcpiDbWalkAndMatchName (
 270     ACPI_HANDLE             ObjHandle,
 271     UINT32                  NestingLevel,
 272     void                    *Context,
 273     void                    **ReturnValue);
 274
 275 ACPI_STATUS
 276 AcpiDbWalkForReferences (
 277     ACPI_HANDLE             ObjHandle,
 278     UINT32                  NestingLevel,
 279     void                    *Context,
 280     void                    **ReturnValue);
 281
 282 ACPI_STATUS
 283 AcpiDbWalkForSpecificObjects (
 284     ACPI_HANDLE             ObjHandle,
 285     UINT32                  NestingLevel,
 286     void                    *Context,
 287     void                    **ReturnValue);
 288
 289 void
 290 AcpiDbGenerateGpe (
 291     char                    *GpeArg,
 292     char                    *BlockArg);
 293
 294 /*
 295  * dbdisply - debug display commands
 296  */
 297
 298 void
 299 AcpiDbDisplayMethodInfo (
 300     ACPI_PARSE_OBJECT       *Op);
 301
 302 void
 303 AcpiDbDecodeAndDisplayObject (
 304     char                    *Target,
 305     char                    *OutputType);
 306
 307 void
 308 AcpiDbDisplayResultObject (
 309     ACPI_OPERAND_OBJECT     *ObjDesc,
 310     ACPI_WALK_STATE         *WalkState);
 311
 312 ACPI_STATUS
 313 AcpiDbDisplayAllMethods (
 314     char                    *DisplayCountArg);
 315
 316 void
 317 AcpiDbDisplayArguments (
 318     void);
 319
 320 void
 321 AcpiDbDisplayLocals (
 322     void);
 323
 324 void
 325 AcpiDbDisplayResults (
 326     void);
 327
 328 void
 329 AcpiDbDisplayCallingTree (
 330     void);
 331
 332 void
 333 AcpiDbDisplayObjectType (
 334     char                    *ObjectArg);
 335
 336 void
 337 AcpiDbDisplayArgumentObject (
 338     ACPI_OPERAND_OBJECT     *ObjDesc,
 339     ACPI_WALK_STATE         *WalkState);
 340
 341 void
 342 AcpiDbDumpParserDescriptor (
 343     ACPI_PARSE_OBJECT       *Op);
 344
 345 void *
 346 AcpiDbGetPointer (
 347     void                    *Target);
 348
 349
 350 /*
 351  * dbexec - debugger control method execution
 352  */
 353
 354 void
 355 AcpiDbExecute (
 356     char                    *Name,
 357     char                    **Args,
 358     UINT32                  Flags);
 359
 360 void
 361 AcpiDbCreateExecutionThreads (
 362     char                    *NumThreadsArg,
 363     char                    *NumLoopsArg,
 364     char                    *MethodNameArg);
 365
 366 ACPI_STATUS
 367 AcpiDbExecuteMethod (
 368     ACPI_DB_METHOD_INFO     *Info,
 369     ACPI_BUFFER             *ReturnObj);
 370
 371 void
 372 AcpiDbExecuteSetup (
 373     ACPI_DB_METHOD_INFO     *Info);
 374
 375 UINT32
 376 AcpiDbGetOutstandingAllocations (
 377     void);
 378
 379 void ACPI_SYSTEM_XFACE
 380 AcpiDbMethodThread (
 381     void                    *Context);
 382
 383 ACPI_STATUS
 384 AcpiDbExecutionWalk (
 385     ACPI_HANDLE             ObjHandle,
 386     UINT32                  NestingLevel,
 387     void                    *Context,
 388     void                    **ReturnValue);
 389
 390
 391 /*
 392  * dbfileio - Debugger file I/O commands
 393  */
 394
 395 ACPI_OBJECT_TYPE
 396 AcpiDbMatchArgument (
 397     char                    *UserArgument,
 398     ARGUMENT_INFO           *Arguments);
 399
 400 ACPI_STATUS
 401 AeLocalLoadTable (
 402     ACPI_TABLE_HEADER       *TablePtr);
 403
 404 void
 405 AcpiDbCloseDebugFile (
 406     void);
 407
 408 void
 409 AcpiDbOpenDebugFile (
 410     char                    *Name);
 411
 412 ACPI_STATUS
 413 AcpiDbLoadAcpiTable (
 414     char                    *Filename);
 415
 416 ACPI_STATUS
 417 AcpiDbGetTableFromFile (
 418     char                    *Filename,
 419     ACPI_TABLE_HEADER       **Table);
 420
 421 ACPI_STATUS
 422 AcpiDbReadTableFromFile (
 423     char                    *Filename,
 424     ACPI_TABLE_HEADER       **Table);
 425
 426 /*
 427  * dbhistry - debugger HISTORY command
 428  */
 429
 430 void
 431 AcpiDbAddToHistory (
 432     char                    *CommandLine);
 433
 434 void
 435 AcpiDbDisplayHistory (void);
 436
 437 char *
 438 AcpiDbGetFromHistory (
 439     char                    *CommandNumArg);
 440
 441
 442 /*
 443  * dbinput - user front-end to the AML debugger
 444  */
 445
 446 ACPI_STATUS
 447 AcpiDbCommandDispatch (
 448     char                    *InputBuffer,
 449     ACPI_WALK_STATE         *WalkState,
 450     ACPI_PARSE_OBJECT       *Op);
 451
 452 void ACPI_SYSTEM_XFACE
 453 AcpiDbExecuteThread (
 454     void                    *Context);
 455
 456 ACPI_STATUS
 457 AcpiDbUserCommands (
 458     char                    Prompt,
 459     ACPI_PARSE_OBJECT       *Op);
 460
 461 void
 462 AcpiDbDisplayHelp (
 463     char                    *HelpType);
 464
 465 char *
 466 AcpiDbGetNextToken (
 467     char                    *String,
 468     char                    **Next);
 469
 470 UINT32
 471 AcpiDbGetLine (
 472     char                    *InputBuffer);
 473
 474 UINT32
 475 AcpiDbMatchCommand (
 476     char                    *UserCommand);
 477
 478 void
 479 AcpiDbSingleThread (
 480     void);
 481
 482
 483 /*
 484  * dbstats - Generation and display of ACPI table statistics
 485  */
 486
 487 void
 488 AcpiDbGenerateStatistics (
 489     ACPI_PARSE_OBJECT       *Root,
 490     BOOLEAN                 IsMethod);
 491
 492
 493 ACPI_STATUS
 494 AcpiDbDisplayStatistics (
 495     char                    *TypeArg);
 496
 497 ACPI_STATUS
 498 AcpiDbClassifyOneObject (
 499     ACPI_HANDLE             ObjHandle,
 500     UINT32                  NestingLevel,
 501     void                    *Context,
 502     void                    **ReturnValue);
 503
 504 void
 505 AcpiDbCountNamespaceObjects (
 506     void);
 507
 508 void
 509 AcpiDbEnumerateObject (
 510     ACPI_OPERAND_OBJECT     *ObjDesc);
 511
 512
 513 /*
 514  * dbutils - AML debugger utilities
 515  */
 516
 517 void
 518 AcpiDbSetOutputDestination (
 519     UINT32                  Where);
 520
 521 void
 522 AcpiDbDumpBuffer (
 523     UINT32                  Address);
 524
 525 void
 526 AcpiDbDumpObject (
 527     ACPI_OBJECT             *ObjDesc,
 528     UINT32                  Level);
 529
 530 void
 531 AcpiDbPrepNamestring (
 532     char                    *Name);
 533
 534
 535 ACPI_STATUS
 536 AcpiDbSecondPassParse (
 537     ACPI_PARSE_OBJECT       *Root);
 538
 539 ACPI_NAMESPACE_NODE *
 540 AcpiDbLocalNsLookup (
 541     char                    *Name);
 542
 543
 544 #endif  /* __ACDEBUG_H__ */