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