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 - 2014, 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 0x4000 /* 16K buffer for return objects */ 121 122 typedef struct acpi_db_command_info 123 { 124 char *Name; /* Command Name */ 125 UINT8 MinArgs; /* Minimum arguments required */ 126 127 } ACPI_DB_COMMAND_INFO; 128 129 typedef struct acpi_db_command_help 130 { 131 UINT8 LineCount; /* Number of help lines */ 132 char *Invocation; /* Command Invocation */ 133 char *Description; /* Command Description */ 134 135 } ACPI_DB_COMMAND_HELP; 136 137 typedef struct acpi_db_argument_info 138 { 139 char *Name; /* Argument Name */ 140 141 } ACPI_DB_ARGUMENT_INFO; 142 143 typedef struct acpi_db_execute_walk 144 { 145 UINT32 Count; 146 UINT32 MaxCount; 147 148 } ACPI_DB_EXECUTE_WALK; 149 150 151 #define PARAM_LIST(pl) pl 152 #define DBTEST_OUTPUT_LEVEL(lvl) if (AcpiGbl_DbOpt_verbose) 153 #define VERBOSE_PRINT(fp) DBTEST_OUTPUT_LEVEL(lvl) {\ 154 AcpiOsPrintf PARAM_LIST(fp);} 155 156 #define EX_NO_SINGLE_STEP 1 157 #define EX_SINGLE_STEP 2 158 159 160 /* 161 * dbxface - external debugger interfaces 162 */ 163 ACPI_STATUS 164 AcpiDbInitialize ( 165 void); 166 167 void 168 AcpiDbTerminate ( 169 void); 170 171 ACPI_STATUS 172 AcpiDbSingleStep ( 173 ACPI_WALK_STATE *WalkState, 174 ACPI_PARSE_OBJECT *Op, 175 UINT32 OpType); 176 177 178 /* 179 * dbcmds - debug commands and output routines 180 */ 181 ACPI_NAMESPACE_NODE * 182 AcpiDbConvertToNode ( 183 char *InString); 184 185 void 186 AcpiDbDisplayTableInfo ( 187 char *TableArg); 188 189 void 190 AcpiDbDisplayTemplate ( 191 char *BufferArg); 192 193 void 194 AcpiDbUnloadAcpiTable ( 195 char *Name); 196 197 void 198 AcpiDbSendNotify ( 199 char *Name, 200 UINT32 Value); 201 202 void 203 AcpiDbDisplayInterfaces ( 204 char *ActionArg, 205 char *InterfaceNameArg); 206 207 ACPI_STATUS 208 AcpiDbSleep ( 209 char *ObjectArg); 210 211 void 212 AcpiDbDisplayLocks ( 213 void); 214 215 void 216 AcpiDbDisplayResources ( 217 char *ObjectArg); 218 219 ACPI_HW_DEPENDENT_RETURN_VOID ( 220 void 221 AcpiDbDisplayGpes ( 222 void)) 223 224 void 225 AcpiDbDisplayHandlers ( 226 void); 227 228 ACPI_HW_DEPENDENT_RETURN_VOID ( 229 void 230 AcpiDbGenerateGpe ( 231 char *GpeArg, 232 char *BlockArg)) 233 234 ACPI_HW_DEPENDENT_RETURN_VOID ( 235 void 236 AcpiDbGenerateSci ( 237 void)) 238 239 void 240 AcpiDbExecuteTest ( 241 char *TypeArg); 242 243 244 /* 245 * dbconvert - miscellaneous conversion routines 246 */ 247 ACPI_STATUS 248 AcpiDbHexCharToValue ( 249 int HexChar, 250 UINT8 *ReturnValue); 251 252 ACPI_STATUS 253 AcpiDbConvertToPackage ( 254 char *String, 255 ACPI_OBJECT *Object); 256 257 ACPI_STATUS 258 AcpiDbConvertToObject ( 259 ACPI_OBJECT_TYPE Type, 260 char *String, 261 ACPI_OBJECT *Object); 262 263 UINT8 * 264 AcpiDbEncodePldBuffer ( 265 ACPI_PLD_INFO *PldInfo); 266 267 void 268 AcpiDbDumpPldBuffer ( 269 ACPI_OBJECT *ObjDesc); 270 271 272 /* 273 * dbmethod - control method commands 274 */ 275 void 276 AcpiDbSetMethodBreakpoint ( 277 char *Location, 278 ACPI_WALK_STATE *WalkState, 279 ACPI_PARSE_OBJECT *Op); 280 281 void 282 AcpiDbSetMethodCallBreakpoint ( 283 ACPI_PARSE_OBJECT *Op); 284 285 void 286 AcpiDbSetMethodData ( 287 char *TypeArg, 288 char *IndexArg, 289 char *ValueArg); 290 291 ACPI_STATUS 292 AcpiDbDisassembleMethod ( 293 char *Name); 294 295 void 296 AcpiDbDisassembleAml ( 297 char *Statements, 298 ACPI_PARSE_OBJECT *Op); 299 300 void 301 AcpiDbBatchExecute ( 302 char *CountArg); 303 304 305 /* 306 * dbnames - namespace commands 307 */ 308 void 309 AcpiDbSetScope ( 310 char *Name); 311 312 void 313 AcpiDbDumpNamespace ( 314 char *StartArg, 315 char *DepthArg); 316 317 void 318 AcpiDbDumpNamespacePaths ( 319 void); 320 321 void 322 AcpiDbDumpNamespaceByOwner ( 323 char *OwnerArg, 324 char *DepthArg); 325 326 ACPI_STATUS 327 AcpiDbFindNameInNamespace ( 328 char *NameArg); 329 330 void 331 AcpiDbCheckPredefinedNames ( 332 void); 333 334 ACPI_STATUS 335 AcpiDbDisplayObjects ( 336 char *ObjTypeArg, 337 char *DisplayCountArg); 338 339 void 340 AcpiDbCheckIntegrity ( 341 void); 342 343 void 344 AcpiDbFindReferences ( 345 char *ObjectArg); 346 347 void 348 AcpiDbGetBusInfo ( 349 void); 350 351 352 /* 353 * dbdisply - debug display commands 354 */ 355 void 356 AcpiDbDisplayMethodInfo ( 357 ACPI_PARSE_OBJECT *Op); 358 359 void 360 AcpiDbDecodeAndDisplayObject ( 361 char *Target, 362 char *OutputType); 363 364 void 365 AcpiDbDisplayResultObject ( 366 ACPI_OPERAND_OBJECT *ObjDesc, 367 ACPI_WALK_STATE *WalkState); 368 369 ACPI_STATUS 370 AcpiDbDisplayAllMethods ( 371 char *DisplayCountArg); 372 373 void 374 AcpiDbDisplayArguments ( 375 void); 376 377 void 378 AcpiDbDisplayLocals ( 379 void); 380 381 void 382 AcpiDbDisplayResults ( 383 void); 384 385 void 386 AcpiDbDisplayCallingTree ( 387 void); 388 389 void 390 AcpiDbDisplayObjectType ( 391 char *ObjectArg); 392 393 void 394 AcpiDbDisplayArgumentObject ( 395 ACPI_OPERAND_OBJECT *ObjDesc, 396 ACPI_WALK_STATE *WalkState); 397 398 399 /* 400 * dbexec - debugger control method execution 401 */ 402 void 403 AcpiDbExecute ( 404 char *Name, 405 char **Args, 406 ACPI_OBJECT_TYPE *Types, 407 UINT32 Flags); 408 409 void 410 AcpiDbCreateExecutionThreads ( 411 char *NumThreadsArg, 412 char *NumLoopsArg, 413 char *MethodNameArg); 414 415 void 416 AcpiDbDeleteObjects ( 417 UINT32 Count, 418 ACPI_OBJECT *Objects); 419 420 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 421 UINT32 422 AcpiDbGetCacheInfo ( 423 ACPI_MEMORY_LIST *Cache); 424 #endif 425 426 427 /* 428 * dbfileio - Debugger file I/O commands 429 */ 430 ACPI_OBJECT_TYPE 431 AcpiDbMatchArgument ( 432 char *UserArgument, 433 ACPI_DB_ARGUMENT_INFO *Arguments); 434 435 void 436 AcpiDbCloseDebugFile ( 437 void); 438 439 void 440 AcpiDbOpenDebugFile ( 441 char *Name); 442 443 ACPI_STATUS 444 AcpiDbLoadAcpiTable ( 445 char *Filename); 446 447 ACPI_STATUS 448 AcpiDbGetTableFromFile ( 449 char *Filename, 450 ACPI_TABLE_HEADER **Table); 451 452 453 /* 454 * dbhistry - debugger HISTORY command 455 */ 456 void 457 AcpiDbAddToHistory ( 458 char *CommandLine); 459 460 void 461 AcpiDbDisplayHistory ( 462 void); 463 464 char * 465 AcpiDbGetFromHistory ( 466 char *CommandNumArg); 467 468 char * 469 AcpiDbGetHistoryByIndex ( 470 UINT32 CommanddNum); 471 472 473 /* 474 * dbinput - user front-end to the AML debugger 475 */ 476 ACPI_STATUS 477 AcpiDbCommandDispatch ( 478 char *InputBuffer, 479 ACPI_WALK_STATE *WalkState, 480 ACPI_PARSE_OBJECT *Op); 481 482 void ACPI_SYSTEM_XFACE 483 AcpiDbExecuteThread ( 484 void *Context); 485 486 ACPI_STATUS 487 AcpiDbUserCommands ( 488 char Prompt, 489 ACPI_PARSE_OBJECT *Op); 490 491 char * 492 AcpiDbGetNextToken ( 493 char *String, 494 char **Next, 495 ACPI_OBJECT_TYPE *ReturnType); 496 497 498 /* 499 * dbstats - Generation and display of ACPI table statistics 500 */ 501 void 502 AcpiDbGenerateStatistics ( 503 ACPI_PARSE_OBJECT *Root, 504 BOOLEAN IsMethod); 505 506 ACPI_STATUS 507 AcpiDbDisplayStatistics ( 508 char *TypeArg); 509 510 511 /* 512 * dbutils - AML debugger utilities 513 */ 514 void 515 AcpiDbSetOutputDestination ( 516 UINT32 Where); 517 518 void 519 AcpiDbDumpExternalObject ( 520 ACPI_OBJECT *ObjDesc, 521 UINT32 Level); 522 523 void 524 AcpiDbPrepNamestring ( 525 char *Name); 526 527 ACPI_NAMESPACE_NODE * 528 AcpiDbLocalNsLookup ( 529 char *Name); 530 531 void 532 AcpiDbUint32ToHexString ( 533 UINT32 Value, 534 char *Buffer); 535 536 #endif /* __ACDEBUG_H__ */ 537