acdebug.h revision 193249 
1/******************************************************************************
2 *
3 * Name: acdebug.h - ACPI/AML debugger
4 *       $Revision: 1.84 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
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
20 * property rights.
21 *
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
28 *
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;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
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.
54 *
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
65 * make.
66 *
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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117#ifndef __ACDEBUG_H__
118#define __ACDEBUG_H__
119
120
121#define ACPI_DEBUG_BUFFER_SIZE  4196
122
123typedef struct CommandInfo
124{
125    char                    *Name;          /* Command Name */
126    UINT8                   MinArgs;        /* Minimum arguments required */
127
128} COMMAND_INFO;
129
130
131typedef struct ArgumentInfo
132{
133    char                    *Name;          /* Argument Name */
134
135} ARGUMENT_INFO;
136
137
138#define PARAM_LIST(pl)                  pl
139#define DBTEST_OUTPUT_LEVEL(lvl)        if (AcpiGbl_DbOpt_verbose)
140#define VERBOSE_PRINT(fp)               DBTEST_OUTPUT_LEVEL(lvl) {\
141                                            AcpiOsPrintf PARAM_LIST(fp);}
142
143#define EX_NO_SINGLE_STEP               1
144#define EX_SINGLE_STEP                  2
145
146
147/*
148 * dbxface - external debugger interfaces
149 */
150ACPI_STATUS
151AcpiDbInitialize (
152    void);
153
154void
155AcpiDbTerminate (
156    void);
157
158ACPI_STATUS
159AcpiDbSingleStep (
160    ACPI_WALK_STATE         *WalkState,
161    ACPI_PARSE_OBJECT       *Op,
162    UINT32                  OpType);
163
164
165/*
166 * dbcmds - debug commands and output routines
167 */
168ACPI_STATUS
169AcpiDbDisassembleMethod (
170    char                    *Name);
171
172void
173AcpiDbDisplayTableInfo (
174    char                    *TableArg);
175
176void
177AcpiDbUnloadAcpiTable (
178    char                    *TableArg,
179    char                    *InstanceArg);
180
181void
182AcpiDbSetMethodBreakpoint (
183    char                    *Location,
184    ACPI_WALK_STATE         *WalkState,
185    ACPI_PARSE_OBJECT       *Op);
186
187void
188AcpiDbSetMethodCallBreakpoint (
189    ACPI_PARSE_OBJECT       *Op);
190
191void
192AcpiDbGetBusInfo (
193    void);
194
195void
196AcpiDbDisassembleAml (
197    char                    *Statements,
198    ACPI_PARSE_OBJECT       *Op);
199
200void
201AcpiDbDumpNamespace (
202    char                    *StartArg,
203    char                    *DepthArg);
204
205void
206AcpiDbDumpNamespaceByOwner (
207    char                    *OwnerArg,
208    char                    *DepthArg);
209
210void
211AcpiDbSendNotify (
212    char                    *Name,
213    UINT32                  Value);
214
215void
216AcpiDbSetMethodData (
217    char                    *TypeArg,
218    char                    *IndexArg,
219    char                    *ValueArg);
220
221ACPI_STATUS
222AcpiDbDisplayObjects (
223    char                    *ObjTypeArg,
224    char                    *DisplayCountArg);
225
226ACPI_STATUS
227AcpiDbFindNameInNamespace (
228    char                    *NameArg);
229
230void
231AcpiDbSetScope (
232    char                    *Name);
233
234ACPI_STATUS
235AcpiDbSleep (
236    char                    *ObjectArg);
237
238void
239AcpiDbFindReferences (
240    char                    *ObjectArg);
241
242void
243AcpiDbDisplayLocks (
244    void);
245
246void
247AcpiDbDisplayResources (
248    char                    *ObjectArg);
249
250void
251AcpiDbDisplayGpes (
252    void);
253
254void
255AcpiDbCheckIntegrity (
256    void);
257
258void
259AcpiDbGenerateGpe (
260    char                    *GpeArg,
261    char                    *BlockArg);
262
263
264/*
265 * dbdisply - debug display commands
266 */
267void
268AcpiDbDisplayMethodInfo (
269    ACPI_PARSE_OBJECT       *Op);
270
271void
272AcpiDbDecodeAndDisplayObject (
273    char                    *Target,
274    char                    *OutputType);
275
276void
277AcpiDbDisplayResultObject (
278    ACPI_OPERAND_OBJECT     *ObjDesc,
279    ACPI_WALK_STATE         *WalkState);
280
281ACPI_STATUS
282AcpiDbDisplayAllMethods (
283    char                    *DisplayCountArg);
284
285void
286AcpiDbDisplayArguments (
287    void);
288
289void
290AcpiDbDisplayLocals (
291    void);
292
293void
294AcpiDbDisplayResults (
295    void);
296
297void
298AcpiDbDisplayCallingTree (
299    void);
300
301void
302AcpiDbDisplayObjectType (
303    char                    *ObjectArg);
304
305void
306AcpiDbDisplayArgumentObject (
307    ACPI_OPERAND_OBJECT     *ObjDesc,
308    ACPI_WALK_STATE         *WalkState);
309
310
311/*
312 * dbexec - debugger control method execution
313 */
314void
315AcpiDbExecute (
316    char                    *Name,
317    char                    **Args,
318    UINT32                  Flags);
319
320void
321AcpiDbCreateExecutionThreads (
322    char                    *NumThreadsArg,
323    char                    *NumLoopsArg,
324    char                    *MethodNameArg);
325
326#ifdef ACPI_DBG_TRACK_ALLOCATIONS
327UINT32
328AcpiDbGetCacheInfo (
329    ACPI_MEMORY_LIST        *Cache);
330#endif
331
332
333/*
334 * dbfileio - Debugger file I/O commands
335 */
336ACPI_OBJECT_TYPE
337AcpiDbMatchArgument (
338    char                    *UserArgument,
339    ARGUMENT_INFO           *Arguments);
340
341void
342AcpiDbCloseDebugFile (
343    void);
344
345void
346AcpiDbOpenDebugFile (
347    char                    *Name);
348
349ACPI_STATUS
350AcpiDbLoadAcpiTable (
351    char                    *Filename);
352
353ACPI_STATUS
354AcpiDbGetTableFromFile (
355    char                    *Filename,
356    ACPI_TABLE_HEADER       **Table);
357
358ACPI_STATUS
359AcpiDbReadTableFromFile (
360    char                    *Filename,
361    ACPI_TABLE_HEADER       **Table);
362
363
364/*
365 * dbhistry - debugger HISTORY command
366 */
367void
368AcpiDbAddToHistory (
369    char                    *CommandLine);
370
371void
372AcpiDbDisplayHistory (
373    void);
374
375char *
376AcpiDbGetFromHistory (
377    char                    *CommandNumArg);
378
379
380/*
381 * dbinput - user front-end to the AML debugger
382 */
383ACPI_STATUS
384AcpiDbCommandDispatch (
385    char                    *InputBuffer,
386    ACPI_WALK_STATE         *WalkState,
387    ACPI_PARSE_OBJECT       *Op);
388
389void ACPI_SYSTEM_XFACE
390AcpiDbExecuteThread (
391    void                    *Context);
392
393ACPI_STATUS
394AcpiDbUserCommands (
395    char                    Prompt,
396    ACPI_PARSE_OBJECT       *Op);
397
398
399/*
400 * dbstats - Generation and display of ACPI table statistics
401 */
402void
403AcpiDbGenerateStatistics (
404    ACPI_PARSE_OBJECT       *Root,
405    BOOLEAN                 IsMethod);
406
407ACPI_STATUS
408AcpiDbDisplayStatistics (
409    char                    *TypeArg);
410
411
412/*
413 * dbutils - AML debugger utilities
414 */
415void
416AcpiDbSetOutputDestination (
417    UINT32                  Where);
418
419void
420AcpiDbDumpExternalObject (
421    ACPI_OBJECT             *ObjDesc,
422    UINT32                  Level);
423
424void
425AcpiDbPrepNamestring (
426    char                    *Name);
427
428ACPI_NAMESPACE_NODE *
429AcpiDbLocalNsLookup (
430    char                    *Name);
431
432void
433AcpiDbUInt32ToHexString (
434    UINT32                  Value,
435    char                    *Buffer);
436
437#endif  /* __ACDEBUG_H__ */
438