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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #ifndef __ACDEBUG_H__ 153 #define __ACDEBUG_H__ 154 155 /* The debugger is used in conjunction with the disassembler most of time */ 156 157 #ifdef ACPI_DISASSEMBLER 158 #include "acdisasm.h" 159 #endif 160 161 162 #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */ 163 164 typedef struct acpi_db_command_info 165 { 166 const char *Name; /* Command Name */ 167 UINT8 MinArgs; /* Minimum arguments required */ 168 169 } ACPI_DB_COMMAND_INFO; 170 171 typedef struct acpi_db_command_help 172 { 173 UINT8 LineCount; /* Number of help lines */ 174 char *Invocation; /* Command Invocation */ 175 char *Description; /* Command Description */ 176 177 } ACPI_DB_COMMAND_HELP; 178 179 typedef struct acpi_db_argument_info 180 { 181 const char *Name; /* Argument Name */ 182 183 } ACPI_DB_ARGUMENT_INFO; 184 185 typedef struct acpi_db_execute_walk 186 { 187 UINT32 Count; 188 UINT32 MaxCount; 189 190 } ACPI_DB_EXECUTE_WALK; 191 192 193 #define PARAM_LIST(pl) pl 194 195 #define EX_NO_SINGLE_STEP 1 196 #define EX_SINGLE_STEP 2 197 198 199 /* 200 * dbxface - external debugger interfaces 201 */ 202 ACPI_DBR_DEPENDENT_RETURN_OK ( 203 ACPI_STATUS 204 AcpiDbSingleStep ( 205 ACPI_WALK_STATE *WalkState, 206 ACPI_PARSE_OBJECT *Op, 207 UINT32 OpType)) 208 209 ACPI_DBR_DEPENDENT_RETURN_VOID ( 210 void 211 AcpiDbSignalBreakPoint ( 212 ACPI_WALK_STATE *WalkState)) 213 214 215 /* 216 * dbcmds - debug commands and output routines 217 */ 218 ACPI_NAMESPACE_NODE * 219 AcpiDbConvertToNode ( 220 char *InString); 221 222 void 223 AcpiDbDisplayTableInfo ( 224 char *TableArg); 225 226 void 227 AcpiDbDisplayTemplate ( 228 char *BufferArg); 229 230 void 231 AcpiDbUnloadAcpiTable ( 232 char *Name); 233 234 void 235 AcpiDbSendNotify ( 236 char *Name, 237 UINT32 Value); 238 239 void 240 AcpiDbDisplayInterfaces ( 241 char *ActionArg, 242 char *InterfaceNameArg); 243 244 ACPI_STATUS 245 AcpiDbSleep ( 246 char *ObjectArg); 247 248 void 249 AcpiDbTrace ( 250 char *EnableArg, 251 char *MethodArg, 252 char *OnceArg); 253 254 void 255 AcpiDbDisplayLocks ( 256 void); 257 258 void 259 AcpiDbDisplayResources ( 260 char *ObjectArg); 261 262 ACPI_HW_DEPENDENT_RETURN_VOID ( 263 void 264 AcpiDbDisplayGpes ( 265 void)) 266 267 void 268 AcpiDbDisplayHandlers ( 269 void); 270 271 ACPI_HW_DEPENDENT_RETURN_VOID ( 272 void 273 AcpiDbGenerateGpe ( 274 char *GpeArg, 275 char *BlockArg)) 276 277 ACPI_HW_DEPENDENT_RETURN_VOID ( 278 void 279 AcpiDbGenerateSci ( 280 void)) 281 282 void 283 AcpiDbExecuteTest ( 284 char *TypeArg); 285 286 287 /* 288 * dbconvert - miscellaneous conversion routines 289 */ 290 ACPI_STATUS 291 AcpiDbHexCharToValue ( 292 int HexChar, 293 UINT8 *ReturnValue); 294 295 ACPI_STATUS 296 AcpiDbConvertToPackage ( 297 char *String, 298 ACPI_OBJECT *Object); 299 300 ACPI_STATUS 301 AcpiDbConvertToObject ( 302 ACPI_OBJECT_TYPE Type, 303 char *String, 304 ACPI_OBJECT *Object); 305 306 UINT8 * 307 AcpiDbEncodePldBuffer ( 308 ACPI_PLD_INFO *PldInfo); 309 310 void 311 AcpiDbDumpPldBuffer ( 312 ACPI_OBJECT *ObjDesc); 313 314 315 /* 316 * dbmethod - control method commands 317 */ 318 void 319 AcpiDbSetMethodBreakpoint ( 320 char *Location, 321 ACPI_WALK_STATE *WalkState, 322 ACPI_PARSE_OBJECT *Op); 323 324 void 325 AcpiDbSetMethodCallBreakpoint ( 326 ACPI_PARSE_OBJECT *Op); 327 328 void 329 AcpiDbSetMethodData ( 330 char *TypeArg, 331 char *IndexArg, 332 char *ValueArg); 333 334 ACPI_STATUS 335 AcpiDbDisassembleMethod ( 336 char *Name); 337 338 void 339 AcpiDbDisassembleAml ( 340 char *Statements, 341 ACPI_PARSE_OBJECT *Op); 342 343 void 344 AcpiDbEvaluatePredefinedNames ( 345 void); 346 347 348 /* 349 * dbnames - namespace commands 350 */ 351 void 352 AcpiDbSetScope ( 353 char *Name); 354 355 void 356 AcpiDbDumpNamespace ( 357 char *StartArg, 358 char *DepthArg); 359 360 void 361 AcpiDbDumpNamespacePaths ( 362 void); 363 364 void 365 AcpiDbDumpNamespaceByOwner ( 366 char *OwnerArg, 367 char *DepthArg); 368 369 ACPI_STATUS 370 AcpiDbFindNameInNamespace ( 371 char *NameArg); 372 373 void 374 AcpiDbCheckPredefinedNames ( 375 void); 376 377 ACPI_STATUS 378 AcpiDbDisplayObjects ( 379 char *ObjTypeArg, 380 char *DisplayCountArg); 381 382 void 383 AcpiDbCheckIntegrity ( 384 void); 385 386 void 387 AcpiDbFindReferences ( 388 char *ObjectArg); 389 390 void 391 AcpiDbGetBusInfo ( 392 void); 393 394 395 /* 396 * dbdisply - debug display commands 397 */ 398 void 399 AcpiDbDisplayMethodInfo ( 400 ACPI_PARSE_OBJECT *Op); 401 402 void 403 AcpiDbDecodeAndDisplayObject ( 404 char *Target, 405 char *OutputType); 406 407 ACPI_DBR_DEPENDENT_RETURN_VOID ( 408 void 409 AcpiDbDisplayResultObject ( 410 ACPI_OPERAND_OBJECT *ObjDesc, 411 ACPI_WALK_STATE *WalkState)) 412 413 ACPI_STATUS 414 AcpiDbDisplayAllMethods ( 415 char *DisplayCountArg); 416 417 void 418 AcpiDbDisplayArguments ( 419 void); 420 421 void 422 AcpiDbDisplayLocals ( 423 void); 424 425 void 426 AcpiDbDisplayResults ( 427 void); 428 429 void 430 AcpiDbDisplayCallingTree ( 431 void); 432 433 void 434 AcpiDbDisplayObjectType ( 435 char *ObjectArg); 436 437 ACPI_DBR_DEPENDENT_RETURN_VOID ( 438 void 439 AcpiDbDisplayArgumentObject ( 440 ACPI_OPERAND_OBJECT *ObjDesc, 441 ACPI_WALK_STATE *WalkState)) 442 443 444 /* 445 * dbexec - debugger control method execution 446 */ 447 void 448 AcpiDbExecute ( 449 char *Name, 450 char **Args, 451 ACPI_OBJECT_TYPE *Types, 452 UINT32 Flags); 453 454 void 455 AcpiDbCreateExecutionThread ( 456 char *MethodNameArg, 457 char **Arguments, 458 ACPI_OBJECT_TYPE *Types); 459 460 void 461 AcpiDbCreateExecutionThreads ( 462 char *NumThreadsArg, 463 char *NumLoopsArg, 464 char *MethodNameArg); 465 466 void 467 AcpiDbDeleteObjects ( 468 UINT32 Count, 469 ACPI_OBJECT *Objects); 470 471 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 472 UINT32 473 AcpiDbGetCacheInfo ( 474 ACPI_MEMORY_LIST *Cache); 475 #endif 476 477 478 /* 479 * dbfileio - Debugger file I/O commands 480 */ 481 ACPI_OBJECT_TYPE 482 AcpiDbMatchArgument ( 483 char *UserArgument, 484 ACPI_DB_ARGUMENT_INFO *Arguments); 485 486 void 487 AcpiDbCloseDebugFile ( 488 void); 489 490 void 491 AcpiDbOpenDebugFile ( 492 char *Name); 493 494 ACPI_STATUS 495 AcpiDbLoadAcpiTable ( 496 char *Filename); 497 498 ACPI_STATUS 499 AcpiDbLoadTables ( 500 ACPI_NEW_TABLE_DESC *ListHead); 501 502 503 /* 504 * dbhistry - debugger HISTORY command 505 */ 506 void 507 AcpiDbAddToHistory ( 508 char *CommandLine); 509 510 void 511 AcpiDbDisplayHistory ( 512 void); 513 514 char * 515 AcpiDbGetFromHistory ( 516 char *CommandNumArg); 517 518 char * 519 AcpiDbGetHistoryByIndex ( 520 UINT32 CommanddNum); 521 522 523 /* 524 * dbinput - user front-end to the AML debugger 525 */ 526 ACPI_STATUS 527 AcpiDbCommandDispatch ( 528 char *InputBuffer, 529 ACPI_WALK_STATE *WalkState, 530 ACPI_PARSE_OBJECT *Op); 531 532 void ACPI_SYSTEM_XFACE 533 AcpiDbExecuteThread ( 534 void *Context); 535 536 ACPI_STATUS 537 AcpiDbUserCommands ( 538 void); 539 540 char * 541 AcpiDbGetNextToken ( 542 char *String, 543 char **Next, 544 ACPI_OBJECT_TYPE *ReturnType); 545 546 547 /* 548 * dbobject 549 */ 550 void 551 AcpiDbDecodeInternalObject ( 552 ACPI_OPERAND_OBJECT *ObjDesc); 553 554 void 555 AcpiDbDisplayInternalObject ( 556 ACPI_OPERAND_OBJECT *ObjDesc, 557 ACPI_WALK_STATE *WalkState); 558 559 void 560 AcpiDbDecodeArguments ( 561 ACPI_WALK_STATE *WalkState); 562 563 void 564 AcpiDbDecodeLocals ( 565 ACPI_WALK_STATE *WalkState); 566 567 void 568 AcpiDbDumpMethodInfo ( 569 ACPI_STATUS Status, 570 ACPI_WALK_STATE *WalkState); 571 572 573 /* 574 * dbstats - Generation and display of ACPI table statistics 575 */ 576 void 577 AcpiDbGenerateStatistics ( 578 ACPI_PARSE_OBJECT *Root, 579 BOOLEAN IsMethod); 580 581 ACPI_STATUS 582 AcpiDbDisplayStatistics ( 583 char *TypeArg); 584 585 586 /* 587 * dbutils - AML debugger utilities 588 */ 589 void 590 AcpiDbSetOutputDestination ( 591 UINT32 Where); 592 593 void 594 AcpiDbDumpExternalObject ( 595 ACPI_OBJECT *ObjDesc, 596 UINT32 Level); 597 598 void 599 AcpiDbPrepNamestring ( 600 char *Name); 601 602 ACPI_NAMESPACE_NODE * 603 AcpiDbLocalNsLookup ( 604 char *Name); 605 606 void 607 AcpiDbUint32ToHexString ( 608 UINT32 Value, 609 char *Buffer); 610 611 #endif /* __ACDEBUG_H__ */ 612