sys/contrib/dev/acpica/include/acdebug.h

   1 /******************************************************************************
   2  *
   3  * Name: acdebug.h - ACPI/AML debugger
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2013, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #ifndef __ACDEBUG_H__
  45 #define __ACDEBUG_H__
  46
  47
  48 #define ACPI_DEBUG_BUFFER_SIZE  0x4000      /* 16K buffer for return objects */
  49
  50 typedef struct acpi_db_command_info
  51 {
  52     char                    *Name;          /* Command Name */
  53     UINT8                   MinArgs;        /* Minimum arguments required */
  54
  55 } ACPI_DB_COMMAND_INFO;
  56
  57 typedef struct acpi_db_command_help
  58 {
  59     UINT8                   LineCount;      /* Number of help lines */
  60     char                    *Invocation;    /* Command Invocation */
  61     char                    *Description;   /* Command Description */
  62
  63 } ACPI_DB_COMMAND_HELP;
  64
  65 typedef struct acpi_db_argument_info
  66 {
  67     char                    *Name;          /* Argument Name */
  68
  69 } ACPI_DB_ARGUMENT_INFO;
  70
  71 typedef struct acpi_db_execute_walk
  72 {
  73     UINT32                  Count;
  74     UINT32                  MaxCount;
  75
  76 } ACPI_DB_EXECUTE_WALK;
  77
  78
  79 #define PARAM_LIST(pl)                  pl
  80 #define DBTEST_OUTPUT_LEVEL(lvl)        if (AcpiGbl_DbOpt_verbose)
  81 #define VERBOSE_PRINT(fp)               DBTEST_OUTPUT_LEVEL(lvl) {\
  82                                             AcpiOsPrintf PARAM_LIST(fp);}
  83
  84 #define EX_NO_SINGLE_STEP               1
  85 #define EX_SINGLE_STEP                  2
  86
  87
  88 /*
  89  * dbxface - external debugger interfaces
  90  */
  91 ACPI_STATUS
  92 AcpiDbInitialize (
  93     void);
  94
  95 void
  96 AcpiDbTerminate (
  97     void);
  98
  99 ACPI_STATUS
 100 AcpiDbSingleStep (
 101     ACPI_WALK_STATE         *WalkState,
 102     ACPI_PARSE_OBJECT       *Op,
 103     UINT32                  OpType);
 104
 105
 106 /*
 107  * dbcmds - debug commands and output routines
 108  */
 109 ACPI_NAMESPACE_NODE *
 110 AcpiDbConvertToNode (
 111     char                    *InString);
 112
 113 void
 114 AcpiDbDisplayTableInfo (
 115     char                    *TableArg);
 116
 117 void
 118 AcpiDbDisplayTemplate (
 119     char                    *BufferArg);
 120
 121 void
 122 AcpiDbUnloadAcpiTable (
 123     char                    *Name);
 124
 125 void
 126 AcpiDbSendNotify (
 127     char                    *Name,
 128     UINT32                  Value);
 129
 130 void
 131 AcpiDbDisplayInterfaces (
 132     char                    *ActionArg,
 133     char                    *InterfaceNameArg);
 134
 135 ACPI_STATUS
 136 AcpiDbSleep (
 137     char                    *ObjectArg);
 138
 139 void
 140 AcpiDbDisplayLocks (
 141     void);
 142
 143 void
 144 AcpiDbDisplayResources (
 145     char                    *ObjectArg);
 146
 147 ACPI_HW_DEPENDENT_RETURN_VOID (
 148 void
 149 AcpiDbDisplayGpes (
 150     void))
 151
 152 void
 153 AcpiDbDisplayHandlers (
 154     void);
 155
 156 ACPI_HW_DEPENDENT_RETURN_VOID (
 157 void
 158 AcpiDbGenerateGpe (
 159     char                    *GpeArg,
 160     char                    *BlockArg))
 161
 162
 163 /*
 164  * dbconvert - miscellaneous conversion routines
 165  */
 166 ACPI_STATUS
 167 AcpiDbHexCharToValue (
 168     int                     HexChar,
 169     UINT8                   *ReturnValue);
 170
 171 ACPI_STATUS
 172 AcpiDbConvertToPackage (
 173     char                    *String,
 174     ACPI_OBJECT             *Object);
 175
 176 ACPI_STATUS
 177 AcpiDbConvertToObject (
 178     ACPI_OBJECT_TYPE        Type,
 179     char                    *String,
 180     ACPI_OBJECT             *Object);
 181
 182 UINT8 *
 183 AcpiDbEncodePldBuffer (
 184     ACPI_PLD_INFO           *PldInfo);
 185
 186 void
 187 AcpiDbDumpPldBuffer (
 188     ACPI_OBJECT             *ObjDesc);
 189
 190
 191 /*
 192  * dbmethod - control method commands
 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 AcpiDbSetMethodData (
 206     char                    *TypeArg,
 207     char                    *IndexArg,
 208     char                    *ValueArg);
 209
 210 ACPI_STATUS
 211 AcpiDbDisassembleMethod (
 212     char                    *Name);
 213
 214 void
 215 AcpiDbDisassembleAml (
 216     char                    *Statements,
 217     ACPI_PARSE_OBJECT       *Op);
 218
 219 void
 220 AcpiDbBatchExecute (
 221     char                    *CountArg);
 222
 223
 224 /*
 225  * dbnames - namespace commands
 226  */
 227 void
 228 AcpiDbSetScope (
 229     char                    *Name);
 230
 231 void
 232 AcpiDbDumpNamespace (
 233     char                    *StartArg,
 234     char                    *DepthArg);
 235
 236 void
 237 AcpiDbDumpNamespaceByOwner (
 238     char                    *OwnerArg,
 239     char                    *DepthArg);
 240
 241 ACPI_STATUS
 242 AcpiDbFindNameInNamespace (
 243     char                    *NameArg);
 244
 245 void
 246 AcpiDbCheckPredefinedNames (
 247     void);
 248
 249 ACPI_STATUS
 250 AcpiDbDisplayObjects (
 251     char                    *ObjTypeArg,
 252     char                    *DisplayCountArg);
 253
 254 void
 255 AcpiDbCheckIntegrity (
 256     void);
 257
 258 void
 259 AcpiDbFindReferences (
 260     char                    *ObjectArg);
 261
 262 void
 263 AcpiDbGetBusInfo (
 264     void);
 265
 266
 267 /*
 268  * dbdisply - debug display commands
 269  */
 270 void
 271 AcpiDbDisplayMethodInfo (
 272     ACPI_PARSE_OBJECT       *Op);
 273
 274 void
 275 AcpiDbDecodeAndDisplayObject (
 276     char                    *Target,
 277     char                    *OutputType);
 278
 279 void
 280 AcpiDbDisplayResultObject (
 281     ACPI_OPERAND_OBJECT     *ObjDesc,
 282     ACPI_WALK_STATE         *WalkState);
 283
 284 ACPI_STATUS
 285 AcpiDbDisplayAllMethods (
 286     char                    *DisplayCountArg);
 287
 288 void
 289 AcpiDbDisplayArguments (
 290     void);
 291
 292 void
 293 AcpiDbDisplayLocals (
 294     void);
 295
 296 void
 297 AcpiDbDisplayResults (
 298     void);
 299
 300 void
 301 AcpiDbDisplayCallingTree (
 302     void);
 303
 304 void
 305 AcpiDbDisplayObjectType (
 306     char                    *ObjectArg);
 307
 308 void
 309 AcpiDbDisplayArgumentObject (
 310     ACPI_OPERAND_OBJECT     *ObjDesc,
 311     ACPI_WALK_STATE         *WalkState);
 312
 313
 314 /*
 315  * dbexec - debugger control method execution
 316  */
 317 void
 318 AcpiDbExecute (
 319     char                    *Name,
 320     char                    **Args,
 321     ACPI_OBJECT_TYPE        *Types,
 322     UINT32                  Flags);
 323
 324 void
 325 AcpiDbCreateExecutionThreads (
 326     char                    *NumThreadsArg,
 327     char                    *NumLoopsArg,
 328     char                    *MethodNameArg);
 329
 330 void
 331 AcpiDbDeleteObjects (
 332     UINT32                  Count,
 333     ACPI_OBJECT             *Objects);
 334
 335 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 336 UINT32
 337 AcpiDbGetCacheInfo (
 338     ACPI_MEMORY_LIST        *Cache);
 339 #endif
 340
 341
 342 /*
 343  * dbfileio - Debugger file I/O commands
 344  */
 345 ACPI_OBJECT_TYPE
 346 AcpiDbMatchArgument (
 347     char                    *UserArgument,
 348     ACPI_DB_ARGUMENT_INFO   *Arguments);
 349
 350 void
 351 AcpiDbCloseDebugFile (
 352     void);
 353
 354 void
 355 AcpiDbOpenDebugFile (
 356     char                    *Name);
 357
 358 ACPI_STATUS
 359 AcpiDbLoadAcpiTable (
 360     char                    *Filename);
 361
 362 ACPI_STATUS
 363 AcpiDbGetTableFromFile (
 364     char                    *Filename,
 365     ACPI_TABLE_HEADER       **Table);
 366
 367 ACPI_STATUS
 368 AcpiDbReadTableFromFile (
 369     char                    *Filename,
 370     ACPI_TABLE_HEADER       **Table);
 371
 372
 373 /*
 374  * dbhistry - debugger HISTORY command
 375  */
 376 void
 377 AcpiDbAddToHistory (
 378     char                    *CommandLine);
 379
 380 void
 381 AcpiDbDisplayHistory (
 382     void);
 383
 384 char *
 385 AcpiDbGetFromHistory (
 386     char                    *CommandNumArg);
 387
 388
 389 /*
 390  * dbinput - user front-end to the AML debugger
 391  */
 392 ACPI_STATUS
 393 AcpiDbCommandDispatch (
 394     char                    *InputBuffer,
 395     ACPI_WALK_STATE         *WalkState,
 396     ACPI_PARSE_OBJECT       *Op);
 397
 398 void ACPI_SYSTEM_XFACE
 399 AcpiDbExecuteThread (
 400     void                    *Context);
 401
 402 ACPI_STATUS
 403 AcpiDbUserCommands (
 404     char                    Prompt,
 405     ACPI_PARSE_OBJECT       *Op);
 406
 407 char *
 408 AcpiDbGetNextToken (
 409     char                    *String,
 410     char                    **Next,
 411     ACPI_OBJECT_TYPE        *ReturnType);
 412
 413
 414 /*
 415  * dbstats - Generation and display of ACPI table statistics
 416  */
 417 void
 418 AcpiDbGenerateStatistics (
 419     ACPI_PARSE_OBJECT       *Root,
 420     BOOLEAN                 IsMethod);
 421
 422 ACPI_STATUS
 423 AcpiDbDisplayStatistics (
 424     char                    *TypeArg);
 425
 426
 427 /*
 428  * dbutils - AML debugger utilities
 429  */
 430 void
 431 AcpiDbSetOutputDestination (
 432     UINT32                  Where);
 433
 434 void
 435 AcpiDbDumpExternalObject (
 436     ACPI_OBJECT             *ObjDesc,
 437     UINT32                  Level);
 438
 439 void
 440 AcpiDbPrepNamestring (
 441     char                    *Name);
 442
 443 ACPI_NAMESPACE_NODE *
 444 AcpiDbLocalNsLookup (
 445     char                    *Name);
 446
 447 void
 448 AcpiDbUint32ToHexString (
 449     UINT32                  Value,
 450     char                    *Buffer);
 451
 452 #endif  /* __ACDEBUG_H__ */