1 /******************************************************************************
3 * Name: acdebug.h - ACPI/AML debugger
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
116 #ifndef __ACDEBUG_H__
117 #define __ACDEBUG_H__
120 #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
122 typedef struct CommandInfo
124 char *Name
; /* Command Name */
125 UINT8 MinArgs
; /* Minimum arguments required */
129 typedef struct ArgumentInfo
131 char *Name
; /* Argument Name */
135 typedef struct acpi_execute_walk
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);}
148 #define EX_NO_SINGLE_STEP 1
149 #define EX_SINGLE_STEP 2
153 * dbxface - external debugger interfaces
165 ACPI_WALK_STATE
*WalkState
,
166 ACPI_PARSE_OBJECT
*Op
,
171 * dbcmds - debug commands and output routines
173 ACPI_NAMESPACE_NODE
*
174 AcpiDbConvertToNode (
178 AcpiDbDisplayTableInfo (
182 AcpiDbUnloadAcpiTable (
192 AcpiDbDisplayInterfaces (
194 char *InterfaceNameArg
);
205 AcpiDbDisplayResources (
213 AcpiDbDisplayHandlers (
223 * dbmethod - control method commands
226 AcpiDbSetMethodBreakpoint (
228 ACPI_WALK_STATE
*WalkState
,
229 ACPI_PARSE_OBJECT
*Op
);
232 AcpiDbSetMethodCallBreakpoint (
233 ACPI_PARSE_OBJECT
*Op
);
236 AcpiDbSetMethodData (
242 AcpiDbDisassembleMethod (
246 AcpiDbDisassembleAml (
248 ACPI_PARSE_OBJECT
*Op
);
256 * dbnames - namespace commands
263 AcpiDbDumpNamespace (
268 AcpiDbDumpNamespaceByOwner (
273 AcpiDbFindNameInNamespace (
277 AcpiDbCheckPredefinedNames (
281 AcpiDbDisplayObjects (
283 char *DisplayCountArg
);
286 AcpiDbCheckIntegrity (
290 AcpiDbFindReferences (
299 * dbdisply - debug display commands
302 AcpiDbDisplayMethodInfo (
303 ACPI_PARSE_OBJECT
*Op
);
306 AcpiDbDecodeAndDisplayObject (
311 AcpiDbDisplayResultObject (
312 ACPI_OPERAND_OBJECT
*ObjDesc
,
313 ACPI_WALK_STATE
*WalkState
);
316 AcpiDbDisplayAllMethods (
317 char *DisplayCountArg
);
320 AcpiDbDisplayArguments (
324 AcpiDbDisplayLocals (
328 AcpiDbDisplayResults (
332 AcpiDbDisplayCallingTree (
336 AcpiDbDisplayObjectType (
340 AcpiDbDisplayArgumentObject (
341 ACPI_OPERAND_OBJECT
*ObjDesc
,
342 ACPI_WALK_STATE
*WalkState
);
346 * dbexec - debugger control method execution
352 ACPI_OBJECT_TYPE
*Types
,
356 AcpiDbCreateExecutionThreads (
359 char *MethodNameArg
);
361 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
364 ACPI_MEMORY_LIST
*Cache
);
369 * dbfileio - Debugger file I/O commands
372 AcpiDbMatchArgument (
374 ARGUMENT_INFO
*Arguments
);
377 AcpiDbCloseDebugFile (
381 AcpiDbOpenDebugFile (
385 AcpiDbLoadAcpiTable (
389 AcpiDbGetTableFromFile (
391 ACPI_TABLE_HEADER
**Table
);
394 AcpiDbReadTableFromFile (
396 ACPI_TABLE_HEADER
**Table
);
400 * dbhistry - debugger HISTORY command
407 AcpiDbDisplayHistory (
411 AcpiDbGetFromHistory (
412 char *CommandNumArg
);
416 * dbinput - user front-end to the AML debugger
419 AcpiDbCommandDispatch (
421 ACPI_WALK_STATE
*WalkState
,
422 ACPI_PARSE_OBJECT
*Op
);
424 void ACPI_SYSTEM_XFACE
425 AcpiDbExecuteThread (
431 ACPI_PARSE_OBJECT
*Op
);
437 ACPI_OBJECT_TYPE
*ReturnType
);
441 * dbstats - Generation and display of ACPI table statistics
444 AcpiDbGenerateStatistics (
445 ACPI_PARSE_OBJECT
*Root
,
449 AcpiDbDisplayStatistics (
454 * dbutils - AML debugger utilities
457 AcpiDbSetOutputDestination (
461 AcpiDbDumpExternalObject (
462 ACPI_OBJECT
*ObjDesc
,
466 AcpiDbPrepNamestring (
469 ACPI_NAMESPACE_NODE
*
470 AcpiDbLocalNsLookup (
474 AcpiDbUInt32ToHexString (
478 #endif /* __ACDEBUG_H__ */