1 /******************************************************************************
3 * Name: acdebug.h - ACPI/AML debugger
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #ifndef __ACDEBUG_H__
118 #define __ACDEBUG_H__
121 #define ACPI_DEBUG_BUFFER_SIZE 4196
123 typedef struct CommandInfo
125 char *Name; /* Command Name */
126 UINT8 MinArgs; /* Minimum arguments required */
131 typedef struct ArgumentInfo
133 char *Name; /* Argument Name */
138 #define PARAM_LIST(pl) pl
140 #define DBTEST_OUTPUT_LEVEL(lvl) if (AcpiGbl_DbOpt_verbose)
142 #define VERBOSE_PRINT(fp) DBTEST_OUTPUT_LEVEL(lvl) {\
143 AcpiOsPrintf PARAM_LIST(fp);}
145 #define EX_NO_SINGLE_STEP 1
146 #define EX_SINGLE_STEP 2
153 * dbxface - external debugger interfaces
166 ACPI_WALK_STATE *WalkState,
167 ACPI_PARSE_OBJECT *Op,
172 ACPI_WALK_STATE *WalkState,
173 ACPI_PARSE_OBJECT *Op);
177 ACPI_WALK_STATE *WalkState);
181 * dbcmds - debug commands and output routines
185 AcpiDbDisassembleMethod (
189 AcpiDbDisplayTableInfo (
193 AcpiDbUnloadAcpiTable (
198 AcpiDbSetMethodBreakpoint (
200 ACPI_WALK_STATE *WalkState,
201 ACPI_PARSE_OBJECT *Op);
204 AcpiDbSetMethodCallBreakpoint (
205 ACPI_PARSE_OBJECT *Op);
208 AcpiDbDisassembleAml (
210 ACPI_PARSE_OBJECT *Op);
213 AcpiDbDumpNamespace (
218 AcpiDbDumpNamespaceByOwner (
228 AcpiDbSetMethodData (
234 AcpiDbDisplayObjects (
236 char *DisplayCountArg);
239 AcpiDbFindNameInNamespace (
251 AcpiDbFindReferences (
255 AcpiDbDisplayLocks (void);
259 AcpiDbDisplayResources (
263 AcpiDbDisplayGpes (void);
266 AcpiDbCheckIntegrity (
270 AcpiDbIntegrityWalk (
271 ACPI_HANDLE ObjHandle,
277 AcpiDbWalkAndMatchName (
278 ACPI_HANDLE ObjHandle,
284 AcpiDbWalkForReferences (
285 ACPI_HANDLE ObjHandle,
291 AcpiDbWalkForSpecificObjects (
292 ACPI_HANDLE ObjHandle,
303 * dbdisply - debug display commands
307 AcpiDbDisplayMethodInfo (
308 ACPI_PARSE_OBJECT *Op);
311 AcpiDbDecodeAndDisplayObject (
316 AcpiDbDisplayResultObject (
317 ACPI_OPERAND_OBJECT *ObjDesc,
318 ACPI_WALK_STATE *WalkState);
321 AcpiDbDisplayAllMethods (
322 char *DisplayCountArg);
325 AcpiDbDisplayArguments (
329 AcpiDbDisplayLocals (
333 AcpiDbDisplayResults (
337 AcpiDbDisplayCallingTree (
341 AcpiDbDisplayObjectType (
345 AcpiDbDisplayArgumentObject (
346 ACPI_OPERAND_OBJECT *ObjDesc,
347 ACPI_WALK_STATE *WalkState);
350 AcpiDbDumpParserDescriptor (
351 ACPI_PARSE_OBJECT *Op);
359 * dbexec - debugger control method execution
369 AcpiDbCreateExecutionThreads (
372 char *MethodNameArg);
375 AcpiDbExecuteMethod (
376 ACPI_DB_METHOD_INFO *Info,
377 ACPI_BUFFER *ReturnObj);
381 ACPI_DB_METHOD_INFO *Info);
384 AcpiDbGetOutstandingAllocations (
387 void ACPI_SYSTEM_XFACE
392 AcpiDbExecutionWalk (
393 ACPI_HANDLE ObjHandle,
400 * dbfileio - Debugger file I/O commands
404 AcpiDbMatchArgument (
406 ARGUMENT_INFO *Arguments);
410 ACPI_TABLE_HEADER *TablePtr);
413 AcpiDbCloseDebugFile (
417 AcpiDbOpenDebugFile (
421 AcpiDbLoadAcpiTable (
425 AcpiDbGetTableFromFile (
427 ACPI_TABLE_HEADER **Table);
430 AcpiDbReadTableFromFile (
432 ACPI_TABLE_HEADER **Table);
435 * dbhistry - debugger HISTORY command
443 AcpiDbDisplayHistory (void);
446 AcpiDbGetFromHistory (
447 char *CommandNumArg);
451 * dbinput - user front-end to the AML debugger
455 AcpiDbCommandDispatch (
457 ACPI_WALK_STATE *WalkState,
458 ACPI_PARSE_OBJECT *Op);
460 void ACPI_SYSTEM_XFACE
461 AcpiDbExecuteThread (
467 ACPI_PARSE_OBJECT *Op);
492 * dbstats - Generation and display of ACPI table statistics
496 AcpiDbGenerateStatistics (
497 ACPI_PARSE_OBJECT *Root,
502 AcpiDbDisplayStatistics (
506 AcpiDbClassifyOneObject (
507 ACPI_HANDLE ObjHandle,
513 AcpiDbCountNamespaceObjects (
517 AcpiDbEnumerateObject (
518 ACPI_OPERAND_OBJECT *ObjDesc);
522 * dbutils - AML debugger utilities
526 AcpiDbSetOutputDestination (
535 ACPI_OBJECT *ObjDesc,
539 AcpiDbPrepNamestring (
544 AcpiDbSecondPassParse (
545 ACPI_PARSE_OBJECT *Root);
547 ACPI_NAMESPACE_NODE *
548 AcpiDbLocalNsLookup (
552 #endif /* __ACDEBUG_H__ */