acdebug.h revision 71867 
1/******************************************************************************
2 *
3 * Name: acdebug.h - ACPI/AML debugger
4 *       $Revision: 39 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 DB_MAX_ARGS             8  /* Must be max method args + 1 */
122
123#define DB_COMMAND_PROMPT      '-'
124#define DB_EXECUTE_PROMPT      '%'
125
126
127extern int                      optind;
128extern NATIVE_CHAR              *optarg;
129extern UINT8                    *AmlPtr;
130extern UINT32                   AcpiAmlLength;
131
132extern BOOLEAN                  opt_tables;
133extern BOOLEAN                  opt_disasm;
134extern BOOLEAN                  opt_stats;
135extern BOOLEAN                  opt_parse_jit;
136extern BOOLEAN                  opt_verbose;
137
138
139extern NATIVE_CHAR              *Args[DB_MAX_ARGS];
140extern NATIVE_CHAR              LineBuf[80];
141extern NATIVE_CHAR              ScopeBuf[40];
142extern NATIVE_CHAR              DebugFilename[40];
143extern BOOLEAN                  OutputToFile;
144extern NATIVE_CHAR              *Buffer;
145extern NATIVE_CHAR              *Filename;
146extern NATIVE_CHAR              *INDENT_STRING;
147extern UINT8                    AcpiGbl_DbOutputFlags;
148extern UINT32                   AcpiGbl_DbDebugLevel;
149extern UINT32                   AcpiGbl_DbConsoleDebugLevel;
150
151extern UINT32                   NumNames;
152extern UINT32                   NumMethods;
153extern UINT32                   NumRegions;
154extern UINT32                   NumPackages;
155extern UINT32                   NumAliases;
156extern UINT32                   NumDevices;
157extern UINT32                   NumFieldDefs;
158extern UINT32                   NumThermalZones;
159extern UINT32                   NumNodes;
160extern UINT32                   NumGrammarElements;
161extern UINT32                   NumMethodElements ;
162extern UINT32                   NumMutexes;
163extern UINT32                   NumPowerResources;
164extern UINT32                   NumBankFields ;
165extern UINT32                   NumIndexFields;
166extern UINT32                   NumEvents;
167
168extern UINT32                   SizeOfParseTree;
169extern UINT32                   SizeOfMethodTrees;
170extern UINT32                   SizeOfNTEs;
171extern UINT32                   SizeOfAcpiObjects;
172
173
174#define BUFFER_SIZE             4196
175
176#define DB_REDIRECTABLE_OUTPUT  0x01
177#define DB_CONSOLE_OUTPUT       0x02
178#define DB_DUPLICATE_OUTPUT     0x03
179
180
181typedef struct CommandInfo
182{
183    NATIVE_CHAR             *Name;          /* Command Name */
184    UINT8                   MinArgs;        /* Minimum arguments required */
185
186} COMMAND_INFO;
187
188
189typedef struct ArgumentInfo
190{
191    NATIVE_CHAR             *Name;          /* Argument Name */
192
193} ARGUMENT_INFO;
194
195
196#define PARAM_LIST(pl)                  pl
197
198#define DBTEST_OUTPUT_LEVEL(lvl)        if (opt_verbose)
199
200#define VERBOSE_PRINT(fp)               DBTEST_OUTPUT_LEVEL(lvl) {\
201                                            AcpiOsPrintf PARAM_LIST(fp);}
202
203#define EX_NO_SINGLE_STEP       1
204#define EX_SINGLE_STEP          2
205
206
207/* Prototypes */
208
209
210/*
211 * dbapi - external debugger interfaces
212 */
213
214int
215AcpiDbInitialize (
216    void);
217
218ACPI_STATUS
219AcpiDbSingleStep (
220    ACPI_WALK_STATE         *WalkState,
221    ACPI_PARSE_OBJECT       *Op,
222    UINT8                   OpType);
223
224
225/*
226 * dbcmds - debug commands and output routines
227 */
228
229
230void
231AcpiDbDisplayTableInfo (
232    NATIVE_CHAR             *TableArg);
233
234void
235AcpiDbUnloadAcpiTable (
236    NATIVE_CHAR             *TableArg,
237    NATIVE_CHAR             *InstanceArg);
238
239void
240AcpiDbSetMethodBreakpoint (
241    NATIVE_CHAR             *Location,
242    ACPI_WALK_STATE         *WalkState,
243    ACPI_PARSE_OBJECT       *Op);
244
245void
246AcpiDbSetMethodCallBreakpoint (
247    ACPI_PARSE_OBJECT       *Op);
248
249void
250AcpiDbDisassembleAml (
251    NATIVE_CHAR             *Statements,
252    ACPI_PARSE_OBJECT       *Op);
253
254void
255AcpiDbDumpNamespace (
256    NATIVE_CHAR             *StartArg,
257    NATIVE_CHAR             *DepthArg);
258
259void
260AcpiDbDumpNamespaceByOwner (
261    NATIVE_CHAR             *OwnerArg,
262    NATIVE_CHAR             *DepthArg);
263
264void
265AcpiDbSendNotify (
266    NATIVE_CHAR             *Name,
267    UINT32                  Value);
268
269void
270AcpiDbSetMethodData (
271    NATIVE_CHAR             *TypeArg,
272    NATIVE_CHAR             *IndexArg,
273    NATIVE_CHAR             *ValueArg);
274
275ACPI_STATUS
276AcpiDbDisplayObjects (
277    NATIVE_CHAR             *ObjTypeArg,
278    NATIVE_CHAR             *DisplayCountArg);
279
280ACPI_STATUS
281AcpiDbFindNameInNamespace (
282    NATIVE_CHAR             *NameArg);
283
284void
285AcpiDbSetScope (
286    NATIVE_CHAR             *Name);
287
288void
289AcpiDbFindReferences (
290    NATIVE_CHAR             *ObjectArg);
291
292
293/*
294 * dbdisasm - AML disassembler
295 */
296
297void
298AcpiDbDisplayOp (
299    ACPI_WALK_STATE         *WalkState,
300    ACPI_PARSE_OBJECT       *Origin,
301    UINT32                  NumOpcodes);
302
303void
304AcpiDbDisplayNamestring (
305    NATIVE_CHAR             *Name);
306
307void
308AcpiDbDisplayPath (
309    ACPI_PARSE_OBJECT       *Op);
310
311void
312AcpiDbDisplayOpcode (
313    ACPI_WALK_STATE         *WalkState,
314    ACPI_PARSE_OBJECT       *Op);
315
316void
317AcpiDbDecodeInternalObject (
318    ACPI_OPERAND_OBJECT     *ObjDesc);
319
320
321/*
322 * dbdisply - debug display commands
323 */
324
325
326void
327AcpiDbDisplayMethodInfo (
328    ACPI_PARSE_OBJECT       *Op);
329
330void
331AcpiDbDecodeAndDisplayObject (
332    NATIVE_CHAR             *Target,
333    NATIVE_CHAR             *OutputType);
334
335void
336AcpiDbDisplayResultObject (
337    ACPI_OPERAND_OBJECT     *ObjDesc,
338    ACPI_WALK_STATE         *WalkState);
339
340ACPI_STATUS
341AcpiDbDisplayAllMethods (
342    NATIVE_CHAR             *DisplayCountArg);
343
344void
345AcpiDbDisplayInternalObject (
346    ACPI_OPERAND_OBJECT     *ObjDesc,
347    ACPI_WALK_STATE         *WalkState);
348
349void
350AcpiDbDisplayArguments (
351    void);
352
353void
354AcpiDbDisplayLocals (
355    void);
356
357void
358AcpiDbDisplayResults (
359    void);
360
361void
362AcpiDbDisplayCallingTree (
363    void);
364
365void
366AcpiDbDisplayArgumentObject (
367    ACPI_OPERAND_OBJECT     *ObjDesc,
368    ACPI_WALK_STATE         *WalkState);
369
370
371/*
372 * dbexec - debugger control method execution
373 */
374
375void
376AcpiDbExecute (
377    NATIVE_CHAR             *Name,
378    NATIVE_CHAR             **Args,
379    UINT32                  Flags);
380
381void
382AcpiDbCreateExecutionThreads (
383    NATIVE_CHAR             *NumThreadsArg,
384    NATIVE_CHAR             *NumLoopsArg,
385    NATIVE_CHAR             *MethodNameArg);
386
387
388/*
389 * dbfileio - Debugger file I/O commands
390 */
391
392OBJECT_TYPE_INTERNAL
393AcpiDbMatchArgument (
394    NATIVE_CHAR             *UserArgument,
395    ARGUMENT_INFO           *Arguments);
396
397
398void
399AcpiDbCloseDebugFile (
400    void);
401
402void
403AcpiDbOpenDebugFile (
404    NATIVE_CHAR             *Name);
405
406ACPI_STATUS
407AcpiDbLoadAcpiTable (
408    NATIVE_CHAR             *Filename);
409
410
411/*
412 * dbhistry - debugger HISTORY command
413 */
414
415void
416AcpiDbAddToHistory (
417    NATIVE_CHAR             *CommandLine);
418
419void
420AcpiDbDisplayHistory (void);
421
422NATIVE_CHAR *
423AcpiDbGetFromHistory (
424    NATIVE_CHAR             *CommandNumArg);
425
426
427/*
428 * dbinput - user front-end to the AML debugger
429 */
430
431ACPI_STATUS
432AcpiDbCommandDispatch (
433    NATIVE_CHAR             *InputBuffer,
434    ACPI_WALK_STATE         *WalkState,
435    ACPI_PARSE_OBJECT       *Op);
436
437void
438AcpiDbExecuteThread (
439    void                    *Context);
440
441ACPI_STATUS
442AcpiDbUserCommands (
443    NATIVE_CHAR             Prompt,
444    ACPI_PARSE_OBJECT       *Op);
445
446
447/*
448 * dbstats - Generation and display of ACPI table statistics
449 */
450
451void
452AcpiDbGenerateStatistics (
453    ACPI_PARSE_OBJECT       *Root,
454    BOOLEAN                 IsMethod);
455
456
457ACPI_STATUS
458AcpiDbDisplayStatistics (
459    NATIVE_CHAR             *TypeArg);
460
461
462/*
463 * dbutils - AML debugger utilities
464 */
465
466void
467AcpiDbSetOutputDestination (
468    UINT32                  Where);
469
470void
471AcpiDbDumpBuffer (
472    UINT32                  Address);
473
474void
475AcpiDbDumpObject (
476    ACPI_OBJECT             *ObjDesc,
477    UINT32                  Level);
478
479void
480AcpiDbPrepNamestring (
481    NATIVE_CHAR             *Name);
482
483
484ACPI_STATUS
485AcpiDbSecondPassParse (
486    ACPI_PARSE_OBJECT       *Root);
487
488ACPI_NAMESPACE_NODE *
489AcpiDbLocalNsLookup (
490    NATIVE_CHAR             *Name);
491
492
493#endif  /* __ACDEBUG_H__ */
494