sys/external/intel-public/acpica/dist/include/acdebug.h

   1 /******************************************************************************
   2  *
   3  * Name: acdebug.h - ACPI/AML debugger
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2009, 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 #ifndef __ACDEBUG_H__
 117 #define __ACDEBUG_H__
 118
 119
 120 #define ACPI_DEBUG_BUFFER_SIZE  4196
 121
 122 typedef struct CommandInfo
 123 {
 124     const char              *Name;          /* Command Name */
 125     UINT8                   MinArgs;        /* Minimum arguments required */
 126
 127 } COMMAND_INFO;
 128
 129
 130 typedef struct ArgumentInfo
 131 {
 132     const char              *Name;          /* Argument Name */
 133
 134 } ARGUMENT_INFO;
 135
 136
 137 #define PARAM_LIST(pl)                  pl
 138 #define DBTEST_OUTPUT_LEVEL(lvl)        if (AcpiGbl_DbOpt_verbose)
 139 #define VERBOSE_PRINT(fp)               DBTEST_OUTPUT_LEVEL(lvl) {\
 140                                             AcpiOsPrintf PARAM_LIST(fp);}
 141
 142 #define EX_NO_SINGLE_STEP               1
 143 #define EX_SINGLE_STEP                  2
 144
 145
 146 /*
 147  * dbxface - external debugger interfaces
 148  */
 149 ACPI_STATUS
 150 AcpiDbInitialize (
 151     void);
 152
 153 void
 154 AcpiDbTerminate (
 155     void);
 156
 157 ACPI_STATUS
 158 AcpiDbSingleStep (
 159     ACPI_WALK_STATE         *WalkState,
 160     ACPI_PARSE_OBJECT       *Op,
 161     UINT32                  OpType);
 162
 163
 164 /*
 165  * dbcmds - debug commands and output routines
 166  */
 167 ACPI_STATUS
 168 AcpiDbDisassembleMethod (
 169     char                    *Name);
 170
 171 void
 172 AcpiDbDisplayTableInfo (
 173     char                    *TableArg);
 174
 175 void
 176 AcpiDbUnloadAcpiTable (
 177     char                    *TableArg,
 178     char                    *InstanceArg);
 179
 180 void
 181 AcpiDbSetMethodBreakpoint (
 182     char                    *Location,
 183     ACPI_WALK_STATE         *WalkState,
 184     ACPI_PARSE_OBJECT       *Op);
 185
 186 void
 187 AcpiDbSetMethodCallBreakpoint (
 188     ACPI_PARSE_OBJECT       *Op);
 189
 190 void
 191 AcpiDbGetBusInfo (
 192     void);
 193
 194 void
 195 AcpiDbDisassembleAml (
 196     char                    *Statements,
 197     ACPI_PARSE_OBJECT       *Op);
 198
 199 void
 200 AcpiDbDumpNamespace (
 201     char                    *StartArg,
 202     char                    *DepthArg);
 203
 204 void
 205 AcpiDbDumpNamespaceByOwner (
 206     char                    *OwnerArg,
 207     char                    *DepthArg);
 208
 209 void
 210 AcpiDbSendNotify (
 211     char                    *Name,
 212     UINT32                  Value);
 213
 214 void
 215 AcpiDbSetMethodData (
 216     char                    *TypeArg,
 217     char                    *IndexArg,
 218     char                    *ValueArg);
 219
 220 ACPI_STATUS
 221 AcpiDbDisplayObjects (
 222     char                    *ObjTypeArg,
 223     char                    *DisplayCountArg);
 224
 225 ACPI_STATUS
 226 AcpiDbFindNameInNamespace (
 227     char                    *NameArg);
 228
 229 void
 230 AcpiDbSetScope (
 231     char                    *Name);
 232
 233 ACPI_STATUS
 234 AcpiDbSleep (
 235     char                    *ObjectArg);
 236
 237 void
 238 AcpiDbFindReferences (
 239     char                    *ObjectArg);
 240
 241 void
 242 AcpiDbDisplayLocks (
 243     void);
 244
 245 void
 246 AcpiDbDisplayResources (
 247     char                    *ObjectArg);
 248
 249 void
 250 AcpiDbDisplayGpes (
 251     void);
 252
 253 void
 254 AcpiDbCheckIntegrity (
 255     void);
 256
 257 void
 258 AcpiDbGenerateGpe (
 259     char                    *GpeArg,
 260     char                    *BlockArg);
 261
 262 void
 263 AcpiDbCheckPredefinedNames (
 264     void);
 265
 266 void
 267 AcpiDbBatchExecute (
 268     void);
 269
 270 /*
 271  * dbdisply - debug display commands
 272  */
 273 void
 274 AcpiDbDisplayMethodInfo (
 275     ACPI_PARSE_OBJECT       *Op);
 276
 277 void
 278 AcpiDbDecodeAndDisplayObject (
 279     char                    *Target,
 280     char                    *OutputType);
 281
 282 void
 283 AcpiDbDisplayResultObject (
 284     ACPI_OPERAND_OBJECT     *ObjDesc,
 285     ACPI_WALK_STATE         *WalkState);
 286
 287 ACPI_STATUS
 288 AcpiDbDisplayAllMethods (
 289     char                    *DisplayCountArg);
 290
 291 void
 292 AcpiDbDisplayArguments (
 293     void);
 294
 295 void
 296 AcpiDbDisplayLocals (
 297     void);
 298
 299 void
 300 AcpiDbDisplayResults (
 301     void);
 302
 303 void
 304 AcpiDbDisplayCallingTree (
 305     void);
 306
 307 void
 308 AcpiDbDisplayObjectType (
 309     char                    *ObjectArg);
 310
 311 void
 312 AcpiDbDisplayArgumentObject (
 313     ACPI_OPERAND_OBJECT     *ObjDesc,
 314     ACPI_WALK_STATE         *WalkState);
 315
 316
 317 /*
 318  * dbexec - debugger control method execution
 319  */
 320 void
 321 AcpiDbExecute (
 322     char                    *Name,
 323     char                    **Args,
 324     UINT32                  Flags);
 325
 326 void
 327 AcpiDbCreateExecutionThreads (
 328     char                    *NumThreadsArg,
 329     char                    *NumLoopsArg,
 330     char                    *MethodNameArg);
 331
 332 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 333 UINT32
 334 AcpiDbGetCacheInfo (
 335     ACPI_MEMORY_LIST        *Cache);
 336 #endif
 337
 338
 339 /*
 340  * dbfileio - Debugger file I/O commands
 341  */
 342 ACPI_OBJECT_TYPE
 343 AcpiDbMatchArgument (
 344     char                    *UserArgument,
 345     ARGUMENT_INFO           *Arguments);
 346
 347 void
 348 AcpiDbCloseDebugFile (
 349     void);
 350
 351 void
 352 AcpiDbOpenDebugFile (
 353     char                    *Name);
 354
 355 ACPI_STATUS
 356 AcpiDbLoadAcpiTable (
 357     char                    *Filename);
 358
 359 ACPI_STATUS
 360 AcpiDbGetTableFromFile (
 361     char                    *Filename,
 362     ACPI_TABLE_HEADER       **Table);
 363
 364 ACPI_STATUS
 365 AcpiDbReadTableFromFile (
 366     char                    *Filename,
 367     ACPI_TABLE_HEADER       **Table);
 368
 369
 370 /*
 371  * dbhistry - debugger HISTORY command
 372  */
 373 void
 374 AcpiDbAddToHistory (
 375     char                    *CommandLine);
 376
 377 void
 378 AcpiDbDisplayHistory (
 379     void);
 380
 381 char *
 382 AcpiDbGetFromHistory (
 383     char                    *CommandNumArg);
 384
 385
 386 /*
 387  * dbinput - user front-end to the AML debugger
 388  */
 389 ACPI_STATUS
 390 AcpiDbCommandDispatch (
 391     char                    *InputBuffer,
 392     ACPI_WALK_STATE         *WalkState,
 393     ACPI_PARSE_OBJECT       *Op);
 394
 395 void ACPI_SYSTEM_XFACE
 396 AcpiDbExecuteThread (
 397     void                    *Context);
 398
 399 ACPI_STATUS
 400 AcpiDbUserCommands (
 401     char                    Prompt,
 402     ACPI_PARSE_OBJECT       *Op);
 403
 404
 405 /*
 406  * dbstats - Generation and display of ACPI table statistics
 407  */
 408 void
 409 AcpiDbGenerateStatistics (
 410     ACPI_PARSE_OBJECT       *Root,
 411     BOOLEAN                 IsMethod);
 412
 413 ACPI_STATUS
 414 AcpiDbDisplayStatistics (
 415     char                    *TypeArg);
 416
 417
 418 /*
 419  * dbutils - AML debugger utilities
 420  */
 421 void
 422 AcpiDbSetOutputDestination (
 423     UINT32                  Where);
 424
 425 void
 426 AcpiDbDumpExternalObject (
 427     ACPI_OBJECT             *ObjDesc,
 428     UINT32                  Level);
 429
 430 void
 431 AcpiDbPrepNamestring (
 432     char                    *Name);
 433
 434 ACPI_NAMESPACE_NODE *
 435 AcpiDbLocalNsLookup (
 436     char                    *Name);
 437
 438 void
 439 AcpiDbUInt32ToHexString (
 440     UINT32                  Value,
 441     char                    *Buffer);
 442
 443 #endif  /* __ACDEBUG_H__ */