sys/contrib/dev/acpica/acdebug.h

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