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