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