1 /******************************************************************************
3 * Name: acdebug.h - ACPI/AML debugger
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
48 #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
50 typedef struct acpi_db_command_info
52 char *Name; /* Command Name */
53 UINT8 MinArgs; /* Minimum arguments required */
55 } ACPI_DB_COMMAND_INFO;
57 typedef struct acpi_db_command_help
59 UINT8 LineCount; /* Number of help lines */
60 char *Invocation; /* Command Invocation */
61 char *Description; /* Command Description */
63 } ACPI_DB_COMMAND_HELP;
65 typedef struct acpi_db_argument_info
67 char *Name; /* Argument Name */
69 } ACPI_DB_ARGUMENT_INFO;
71 typedef struct acpi_db_execute_walk
76 } ACPI_DB_EXECUTE_WALK;
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);}
84 #define EX_NO_SINGLE_STEP 1
85 #define EX_SINGLE_STEP 2
89 * dbxface - external debugger interfaces
101 ACPI_WALK_STATE *WalkState,
102 ACPI_PARSE_OBJECT *Op,
107 * dbcmds - debug commands and output routines
109 ACPI_NAMESPACE_NODE *
110 AcpiDbConvertToNode (
114 AcpiDbDisplayTableInfo (
118 AcpiDbDisplayTemplate (
122 AcpiDbUnloadAcpiTable (
131 AcpiDbDisplayInterfaces (
133 char *InterfaceNameArg);
144 AcpiDbDisplayResources (
147 ACPI_HW_DEPENDENT_RETURN_VOID (
153 AcpiDbDisplayHandlers (
156 ACPI_HW_DEPENDENT_RETURN_VOID (
162 ACPI_HW_DEPENDENT_RETURN_VOID (
173 * dbconvert - miscellaneous conversion routines
176 AcpiDbHexCharToValue (
181 AcpiDbConvertToPackage (
183 ACPI_OBJECT *Object);
186 AcpiDbConvertToObject (
187 ACPI_OBJECT_TYPE Type,
189 ACPI_OBJECT *Object);
192 AcpiDbEncodePldBuffer (
193 ACPI_PLD_INFO *PldInfo);
196 AcpiDbDumpPldBuffer (
197 ACPI_OBJECT *ObjDesc);
201 * dbmethod - control method commands
204 AcpiDbSetMethodBreakpoint (
206 ACPI_WALK_STATE *WalkState,
207 ACPI_PARSE_OBJECT *Op);
210 AcpiDbSetMethodCallBreakpoint (
211 ACPI_PARSE_OBJECT *Op);
214 AcpiDbSetMethodData (
220 AcpiDbDisassembleMethod (
224 AcpiDbDisassembleAml (
226 ACPI_PARSE_OBJECT *Op);
234 * dbnames - namespace commands
241 AcpiDbDumpNamespace (
246 AcpiDbDumpNamespacePaths (
250 AcpiDbDumpNamespaceByOwner (
255 AcpiDbFindNameInNamespace (
259 AcpiDbCheckPredefinedNames (
263 AcpiDbDisplayObjects (
265 char *DisplayCountArg);
268 AcpiDbCheckIntegrity (
272 AcpiDbFindReferences (
281 * dbdisply - debug display commands
284 AcpiDbDisplayMethodInfo (
285 ACPI_PARSE_OBJECT *Op);
288 AcpiDbDecodeAndDisplayObject (
293 AcpiDbDisplayResultObject (
294 ACPI_OPERAND_OBJECT *ObjDesc,
295 ACPI_WALK_STATE *WalkState);
298 AcpiDbDisplayAllMethods (
299 char *DisplayCountArg);
302 AcpiDbDisplayArguments (
306 AcpiDbDisplayLocals (
310 AcpiDbDisplayResults (
314 AcpiDbDisplayCallingTree (
318 AcpiDbDisplayObjectType (
322 AcpiDbDisplayArgumentObject (
323 ACPI_OPERAND_OBJECT *ObjDesc,
324 ACPI_WALK_STATE *WalkState);
328 * dbexec - debugger control method execution
334 ACPI_OBJECT_TYPE *Types,
338 AcpiDbCreateExecutionThreads (
341 char *MethodNameArg);
344 AcpiDbDeleteObjects (
346 ACPI_OBJECT *Objects);
348 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
351 ACPI_MEMORY_LIST *Cache);
356 * dbfileio - Debugger file I/O commands
359 AcpiDbMatchArgument (
361 ACPI_DB_ARGUMENT_INFO *Arguments);
364 AcpiDbCloseDebugFile (
368 AcpiDbOpenDebugFile (
372 AcpiDbLoadAcpiTable (
376 AcpiDbGetTableFromFile (
378 ACPI_TABLE_HEADER **Table,
379 BOOLEAN MustBeAmlTable);
383 * dbhistry - debugger HISTORY command
390 AcpiDbDisplayHistory (
394 AcpiDbGetFromHistory (
395 char *CommandNumArg);
398 AcpiDbGetHistoryByIndex (
403 * dbinput - user front-end to the AML debugger
406 AcpiDbCommandDispatch (
408 ACPI_WALK_STATE *WalkState,
409 ACPI_PARSE_OBJECT *Op);
411 void ACPI_SYSTEM_XFACE
412 AcpiDbExecuteThread (
418 ACPI_PARSE_OBJECT *Op);
424 ACPI_OBJECT_TYPE *ReturnType);
428 * dbstats - Generation and display of ACPI table statistics
431 AcpiDbGenerateStatistics (
432 ACPI_PARSE_OBJECT *Root,
436 AcpiDbDisplayStatistics (
441 * dbutils - AML debugger utilities
444 AcpiDbSetOutputDestination (
448 AcpiDbDumpExternalObject (
449 ACPI_OBJECT *ObjDesc,
453 AcpiDbPrepNamestring (
456 ACPI_NAMESPACE_NODE *
457 AcpiDbLocalNsLookup (
461 AcpiDbUint32ToHexString (
465 #endif /* __ACDEBUG_H__ */