xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acdebug.h (revision 30082d0c)
1 /******************************************************************************
2  *
3  * Name: acdebug.h - ACPI/AML debugger
4  *       $Revision: 1.81 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 
123 typedef struct CommandInfo
124 {
125     char                    *Name;          /* Command Name */
126     UINT8                   MinArgs;        /* Minimum arguments required */
127 
128 } COMMAND_INFO;
129 
130 
131 typedef 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  */
150 ACPI_STATUS
151 AcpiDbInitialize (
152     void);
153 
154 void
155 AcpiDbTerminate (
156     void);
157 
158 ACPI_STATUS
159 AcpiDbSingleStep (
160     ACPI_WALK_STATE         *WalkState,
161     ACPI_PARSE_OBJECT       *Op,
162     UINT32                  OpType);
163 
164 
165 /*
166  * dbcmds - debug commands and output routines
167  */
168 ACPI_STATUS
169 AcpiDbDisassembleMethod (
170     char                    *Name);
171 
172 void
173 AcpiDbDisplayTableInfo (
174     char                    *TableArg);
175 
176 void
177 AcpiDbUnloadAcpiTable (
178     char                    *TableArg,
179     char                    *InstanceArg);
180 
181 void
182 AcpiDbSetMethodBreakpoint (
183     char                    *Location,
184     ACPI_WALK_STATE         *WalkState,
185     ACPI_PARSE_OBJECT       *Op);
186 
187 void
188 AcpiDbSetMethodCallBreakpoint (
189     ACPI_PARSE_OBJECT       *Op);
190 
191 void
192 AcpiDbGetBusInfo (
193     void);
194 
195 void
196 AcpiDbDisassembleAml (
197     char                    *Statements,
198     ACPI_PARSE_OBJECT       *Op);
199 
200 void
201 AcpiDbDumpNamespace (
202     char                    *StartArg,
203     char                    *DepthArg);
204 
205 void
206 AcpiDbDumpNamespaceByOwner (
207     char                    *OwnerArg,
208     char                    *DepthArg);
209 
210 void
211 AcpiDbSendNotify (
212     char                    *Name,
213     UINT32                  Value);
214 
215 void
216 AcpiDbSetMethodData (
217     char                    *TypeArg,
218     char                    *IndexArg,
219     char                    *ValueArg);
220 
221 ACPI_STATUS
222 AcpiDbDisplayObjects (
223     char                    *ObjTypeArg,
224     char                    *DisplayCountArg);
225 
226 ACPI_STATUS
227 AcpiDbFindNameInNamespace (
228     char                    *NameArg);
229 
230 void
231 AcpiDbSetScope (
232     char                    *Name);
233 
234 ACPI_STATUS
235 AcpiDbSleep (
236     char                    *ObjectArg);
237 
238 void
239 AcpiDbFindReferences (
240     char                    *ObjectArg);
241 
242 void
243 AcpiDbDisplayLocks (
244     void);
245 
246 void
247 AcpiDbDisplayResources (
248     char                    *ObjectArg);
249 
250 void
251 AcpiDbDisplayGpes (
252     void);
253 
254 void
255 AcpiDbCheckIntegrity (
256     void);
257 
258 void
259 AcpiDbGenerateGpe (
260     char                    *GpeArg,
261     char                    *BlockArg);
262 
263 
264 /*
265  * dbdisply - debug display commands
266  */
267 void
268 AcpiDbDisplayMethodInfo (
269     ACPI_PARSE_OBJECT       *Op);
270 
271 void
272 AcpiDbDecodeAndDisplayObject (
273     char                    *Target,
274     char                    *OutputType);
275 
276 void
277 AcpiDbDisplayResultObject (
278     ACPI_OPERAND_OBJECT     *ObjDesc,
279     ACPI_WALK_STATE         *WalkState);
280 
281 ACPI_STATUS
282 AcpiDbDisplayAllMethods (
283     char                    *DisplayCountArg);
284 
285 void
286 AcpiDbDisplayArguments (
287     void);
288 
289 void
290 AcpiDbDisplayLocals (
291     void);
292 
293 void
294 AcpiDbDisplayResults (
295     void);
296 
297 void
298 AcpiDbDisplayCallingTree (
299     void);
300 
301 void
302 AcpiDbDisplayObjectType (
303     char                    *ObjectArg);
304 
305 void
306 AcpiDbDisplayArgumentObject (
307     ACPI_OPERAND_OBJECT     *ObjDesc,
308     ACPI_WALK_STATE         *WalkState);
309 
310 
311 /*
312  * dbexec - debugger control method execution
313  */
314 void
315 AcpiDbExecute (
316     char                    *Name,
317     char                    **Args,
318     UINT32                  Flags);
319 
320 void
321 AcpiDbCreateExecutionThreads (
322     char                    *NumThreadsArg,
323     char                    *NumLoopsArg,
324     char                    *MethodNameArg);
325 
326 
327 /*
328  * dbfileio - Debugger file I/O commands
329  */
330 ACPI_OBJECT_TYPE
331 AcpiDbMatchArgument (
332     char                    *UserArgument,
333     ARGUMENT_INFO           *Arguments);
334 
335 void
336 AcpiDbCloseDebugFile (
337     void);
338 
339 void
340 AcpiDbOpenDebugFile (
341     char                    *Name);
342 
343 ACPI_STATUS
344 AcpiDbLoadAcpiTable (
345     char                    *Filename);
346 
347 ACPI_STATUS
348 AcpiDbGetTableFromFile (
349     char                    *Filename,
350     ACPI_TABLE_HEADER       **Table);
351 
352 ACPI_STATUS
353 AcpiDbReadTableFromFile (
354     char                    *Filename,
355     ACPI_TABLE_HEADER       **Table);
356 
357 
358 /*
359  * dbhistry - debugger HISTORY command
360  */
361 void
362 AcpiDbAddToHistory (
363     char                    *CommandLine);
364 
365 void
366 AcpiDbDisplayHistory (
367     void);
368 
369 char *
370 AcpiDbGetFromHistory (
371     char                    *CommandNumArg);
372 
373 
374 /*
375  * dbinput - user front-end to the AML debugger
376  */
377 ACPI_STATUS
378 AcpiDbCommandDispatch (
379     char                    *InputBuffer,
380     ACPI_WALK_STATE         *WalkState,
381     ACPI_PARSE_OBJECT       *Op);
382 
383 void ACPI_SYSTEM_XFACE
384 AcpiDbExecuteThread (
385     void                    *Context);
386 
387 ACPI_STATUS
388 AcpiDbUserCommands (
389     char                    Prompt,
390     ACPI_PARSE_OBJECT       *Op);
391 
392 
393 /*
394  * dbstats - Generation and display of ACPI table statistics
395  */
396 void
397 AcpiDbGenerateStatistics (
398     ACPI_PARSE_OBJECT       *Root,
399     BOOLEAN                 IsMethod);
400 
401 ACPI_STATUS
402 AcpiDbDisplayStatistics (
403     char                    *TypeArg);
404 
405 
406 /*
407  * dbutils - AML debugger utilities
408  */
409 void
410 AcpiDbSetOutputDestination (
411     UINT32                  Where);
412 
413 void
414 AcpiDbDumpExternalObject (
415     ACPI_OBJECT             *ObjDesc,
416     UINT32                  Level);
417 
418 void
419 AcpiDbPrepNamestring (
420     char                    *Name);
421 
422 ACPI_NAMESPACE_NODE *
423 AcpiDbLocalNsLookup (
424     char                    *Name);
425 
426 #endif  /* __ACDEBUG_H__ */
427