acdebug.h revision 1.3.2.2 1 1.3.2.2 bouyer /******************************************************************************
2 1.3.2.2 bouyer *
3 1.3.2.2 bouyer * Name: acdebug.h - ACPI/AML debugger
4 1.3.2.2 bouyer *
5 1.3.2.2 bouyer *****************************************************************************/
6 1.3.2.2 bouyer
7 1.3.2.2 bouyer /*
8 1.3.2.2 bouyer * Copyright (C) 2000 - 2011, Intel Corp.
9 1.3.2.2 bouyer * All rights reserved.
10 1.3.2.2 bouyer *
11 1.3.2.2 bouyer * Redistribution and use in source and binary forms, with or without
12 1.3.2.2 bouyer * modification, are permitted provided that the following conditions
13 1.3.2.2 bouyer * are met:
14 1.3.2.2 bouyer * 1. Redistributions of source code must retain the above copyright
15 1.3.2.2 bouyer * notice, this list of conditions, and the following disclaimer,
16 1.3.2.2 bouyer * without modification.
17 1.3.2.2 bouyer * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.3.2.2 bouyer * substantially similar to the "NO WARRANTY" disclaimer below
19 1.3.2.2 bouyer * ("Disclaimer") and any redistribution must be conditioned upon
20 1.3.2.2 bouyer * including a substantially similar Disclaimer requirement for further
21 1.3.2.2 bouyer * binary redistribution.
22 1.3.2.2 bouyer * 3. Neither the names of the above-listed copyright holders nor the names
23 1.3.2.2 bouyer * of any contributors may be used to endorse or promote products derived
24 1.3.2.2 bouyer * from this software without specific prior written permission.
25 1.3.2.2 bouyer *
26 1.3.2.2 bouyer * Alternatively, this software may be distributed under the terms of the
27 1.3.2.2 bouyer * GNU General Public License ("GPL") version 2 as published by the Free
28 1.3.2.2 bouyer * Software Foundation.
29 1.3.2.2 bouyer *
30 1.3.2.2 bouyer * NO WARRANTY
31 1.3.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.3.2.2 bouyer * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.3.2.2 bouyer * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.3.2.2 bouyer * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.3.2.2 bouyer * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.3.2.2 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.3.2.2 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.3.2.2 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.3.2.2 bouyer * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.3.2.2 bouyer * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.3.2.2 bouyer * POSSIBILITY OF SUCH DAMAGES.
42 1.3.2.2 bouyer */
43 1.3.2.2 bouyer
44 1.3.2.2 bouyer #ifndef __ACDEBUG_H__
45 1.3.2.2 bouyer #define __ACDEBUG_H__
46 1.3.2.2 bouyer
47 1.3.2.2 bouyer
48 1.3.2.2 bouyer #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
49 1.3.2.2 bouyer
50 1.3.2.2 bouyer typedef struct CommandInfo
51 1.3.2.2 bouyer {
52 1.3.2.2 bouyer const char *Name; /* Command Name */
53 1.3.2.2 bouyer UINT8 MinArgs; /* Minimum arguments required */
54 1.3.2.2 bouyer
55 1.3.2.2 bouyer } COMMAND_INFO;
56 1.3.2.2 bouyer
57 1.3.2.2 bouyer typedef struct ArgumentInfo
58 1.3.2.2 bouyer {
59 1.3.2.2 bouyer const char *Name; /* Argument Name */
60 1.3.2.2 bouyer
61 1.3.2.2 bouyer } ARGUMENT_INFO;
62 1.3.2.2 bouyer
63 1.3.2.2 bouyer typedef struct acpi_execute_walk
64 1.3.2.2 bouyer {
65 1.3.2.2 bouyer UINT32 Count;
66 1.3.2.2 bouyer UINT32 MaxCount;
67 1.3.2.2 bouyer
68 1.3.2.2 bouyer } ACPI_EXECUTE_WALK;
69 1.3.2.2 bouyer
70 1.3.2.2 bouyer
71 1.3.2.2 bouyer #define PARAM_LIST(pl) pl
72 1.3.2.2 bouyer #define DBTEST_OUTPUT_LEVEL(lvl) if (AcpiGbl_DbOpt_verbose)
73 1.3.2.2 bouyer #define VERBOSE_PRINT(fp) DBTEST_OUTPUT_LEVEL(lvl) {\
74 1.3.2.2 bouyer AcpiOsPrintf PARAM_LIST(fp);}
75 1.3.2.2 bouyer
76 1.3.2.2 bouyer #define EX_NO_SINGLE_STEP 1
77 1.3.2.2 bouyer #define EX_SINGLE_STEP 2
78 1.3.2.2 bouyer
79 1.3.2.2 bouyer
80 1.3.2.2 bouyer /*
81 1.3.2.2 bouyer * dbxface - external debugger interfaces
82 1.3.2.2 bouyer */
83 1.3.2.2 bouyer ACPI_STATUS
84 1.3.2.2 bouyer AcpiDbInitialize (
85 1.3.2.2 bouyer void);
86 1.3.2.2 bouyer
87 1.3.2.2 bouyer void
88 1.3.2.2 bouyer AcpiDbTerminate (
89 1.3.2.2 bouyer void);
90 1.3.2.2 bouyer
91 1.3.2.2 bouyer ACPI_STATUS
92 1.3.2.2 bouyer AcpiDbSingleStep (
93 1.3.2.2 bouyer ACPI_WALK_STATE *WalkState,
94 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op,
95 1.3.2.2 bouyer UINT32 OpType);
96 1.3.2.2 bouyer
97 1.3.2.2 bouyer
98 1.3.2.2 bouyer /*
99 1.3.2.2 bouyer * dbcmds - debug commands and output routines
100 1.3.2.2 bouyer */
101 1.3.2.2 bouyer ACPI_NAMESPACE_NODE *
102 1.3.2.2 bouyer AcpiDbConvertToNode (
103 1.3.2.2 bouyer char *InString);
104 1.3.2.2 bouyer
105 1.3.2.2 bouyer void
106 1.3.2.2 bouyer AcpiDbDisplayTableInfo (
107 1.3.2.2 bouyer char *TableArg);
108 1.3.2.2 bouyer
109 1.3.2.2 bouyer void
110 1.3.2.2 bouyer AcpiDbUnloadAcpiTable (
111 1.3.2.2 bouyer char *TableArg,
112 1.3.2.2 bouyer char *InstanceArg);
113 1.3.2.2 bouyer
114 1.3.2.2 bouyer void
115 1.3.2.2 bouyer AcpiDbSendNotify (
116 1.3.2.2 bouyer char *Name,
117 1.3.2.2 bouyer UINT32 Value);
118 1.3.2.2 bouyer
119 1.3.2.2 bouyer void
120 1.3.2.2 bouyer AcpiDbDisplayInterfaces (
121 1.3.2.2 bouyer char *ActionArg,
122 1.3.2.2 bouyer char *InterfaceNameArg);
123 1.3.2.2 bouyer
124 1.3.2.2 bouyer ACPI_STATUS
125 1.3.2.2 bouyer AcpiDbSleep (
126 1.3.2.2 bouyer char *ObjectArg);
127 1.3.2.2 bouyer
128 1.3.2.2 bouyer void
129 1.3.2.2 bouyer AcpiDbDisplayLocks (
130 1.3.2.2 bouyer void);
131 1.3.2.2 bouyer
132 1.3.2.2 bouyer void
133 1.3.2.2 bouyer AcpiDbDisplayResources (
134 1.3.2.2 bouyer char *ObjectArg);
135 1.3.2.2 bouyer
136 1.3.2.2 bouyer void
137 1.3.2.2 bouyer AcpiDbDisplayGpes (
138 1.3.2.2 bouyer void);
139 1.3.2.2 bouyer
140 1.3.2.2 bouyer void
141 1.3.2.2 bouyer AcpiDbDisplayHandlers (
142 1.3.2.2 bouyer void);
143 1.3.2.2 bouyer
144 1.3.2.2 bouyer void
145 1.3.2.2 bouyer AcpiDbGenerateGpe (
146 1.3.2.2 bouyer char *GpeArg,
147 1.3.2.2 bouyer char *BlockArg);
148 1.3.2.2 bouyer
149 1.3.2.2 bouyer
150 1.3.2.2 bouyer /*
151 1.3.2.2 bouyer * dbmethod - control method commands
152 1.3.2.2 bouyer */
153 1.3.2.2 bouyer void
154 1.3.2.2 bouyer AcpiDbSetMethodBreakpoint (
155 1.3.2.2 bouyer char *Location,
156 1.3.2.2 bouyer ACPI_WALK_STATE *WalkState,
157 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op);
158 1.3.2.2 bouyer
159 1.3.2.2 bouyer void
160 1.3.2.2 bouyer AcpiDbSetMethodCallBreakpoint (
161 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op);
162 1.3.2.2 bouyer
163 1.3.2.2 bouyer void
164 1.3.2.2 bouyer AcpiDbSetMethodData (
165 1.3.2.2 bouyer char *TypeArg,
166 1.3.2.2 bouyer char *IndexArg,
167 1.3.2.2 bouyer char *ValueArg);
168 1.3.2.2 bouyer
169 1.3.2.2 bouyer ACPI_STATUS
170 1.3.2.2 bouyer AcpiDbDisassembleMethod (
171 1.3.2.2 bouyer char *Name);
172 1.3.2.2 bouyer
173 1.3.2.2 bouyer void
174 1.3.2.2 bouyer AcpiDbDisassembleAml (
175 1.3.2.2 bouyer char *Statements,
176 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op);
177 1.3.2.2 bouyer
178 1.3.2.2 bouyer void
179 1.3.2.2 bouyer AcpiDbBatchExecute (
180 1.3.2.2 bouyer char *CountArg);
181 1.3.2.2 bouyer
182 1.3.2.2 bouyer
183 1.3.2.2 bouyer /*
184 1.3.2.2 bouyer * dbnames - namespace commands
185 1.3.2.2 bouyer */
186 1.3.2.2 bouyer void
187 1.3.2.2 bouyer AcpiDbSetScope (
188 1.3.2.2 bouyer char *Name);
189 1.3.2.2 bouyer
190 1.3.2.2 bouyer void
191 1.3.2.2 bouyer AcpiDbDumpNamespace (
192 1.3.2.2 bouyer char *StartArg,
193 1.3.2.2 bouyer char *DepthArg);
194 1.3.2.2 bouyer
195 1.3.2.2 bouyer void
196 1.3.2.2 bouyer AcpiDbDumpNamespaceByOwner (
197 1.3.2.2 bouyer char *OwnerArg,
198 1.3.2.2 bouyer char *DepthArg);
199 1.3.2.2 bouyer
200 1.3.2.2 bouyer ACPI_STATUS
201 1.3.2.2 bouyer AcpiDbFindNameInNamespace (
202 1.3.2.2 bouyer char *NameArg);
203 1.3.2.2 bouyer
204 1.3.2.2 bouyer void
205 1.3.2.2 bouyer AcpiDbCheckPredefinedNames (
206 1.3.2.2 bouyer void);
207 1.3.2.2 bouyer
208 1.3.2.2 bouyer ACPI_STATUS
209 1.3.2.2 bouyer AcpiDbDisplayObjects (
210 1.3.2.2 bouyer char *ObjTypeArg,
211 1.3.2.2 bouyer char *DisplayCountArg);
212 1.3.2.2 bouyer
213 1.3.2.2 bouyer void
214 1.3.2.2 bouyer AcpiDbCheckIntegrity (
215 1.3.2.2 bouyer void);
216 1.3.2.2 bouyer
217 1.3.2.2 bouyer void
218 1.3.2.2 bouyer AcpiDbFindReferences (
219 1.3.2.2 bouyer char *ObjectArg);
220 1.3.2.2 bouyer
221 1.3.2.2 bouyer void
222 1.3.2.2 bouyer AcpiDbGetBusInfo (
223 1.3.2.2 bouyer void);
224 1.3.2.2 bouyer
225 1.3.2.2 bouyer
226 1.3.2.2 bouyer /*
227 1.3.2.2 bouyer * dbdisply - debug display commands
228 1.3.2.2 bouyer */
229 1.3.2.2 bouyer void
230 1.3.2.2 bouyer AcpiDbDisplayMethodInfo (
231 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op);
232 1.3.2.2 bouyer
233 1.3.2.2 bouyer void
234 1.3.2.2 bouyer AcpiDbDecodeAndDisplayObject (
235 1.3.2.2 bouyer char *Target,
236 1.3.2.2 bouyer char *OutputType);
237 1.3.2.2 bouyer
238 1.3.2.2 bouyer void
239 1.3.2.2 bouyer AcpiDbDisplayResultObject (
240 1.3.2.2 bouyer ACPI_OPERAND_OBJECT *ObjDesc,
241 1.3.2.2 bouyer ACPI_WALK_STATE *WalkState);
242 1.3.2.2 bouyer
243 1.3.2.2 bouyer ACPI_STATUS
244 1.3.2.2 bouyer AcpiDbDisplayAllMethods (
245 1.3.2.2 bouyer char *DisplayCountArg);
246 1.3.2.2 bouyer
247 1.3.2.2 bouyer void
248 1.3.2.2 bouyer AcpiDbDisplayArguments (
249 1.3.2.2 bouyer void);
250 1.3.2.2 bouyer
251 1.3.2.2 bouyer void
252 1.3.2.2 bouyer AcpiDbDisplayLocals (
253 1.3.2.2 bouyer void);
254 1.3.2.2 bouyer
255 1.3.2.2 bouyer void
256 1.3.2.2 bouyer AcpiDbDisplayResults (
257 1.3.2.2 bouyer void);
258 1.3.2.2 bouyer
259 1.3.2.2 bouyer void
260 1.3.2.2 bouyer AcpiDbDisplayCallingTree (
261 1.3.2.2 bouyer void);
262 1.3.2.2 bouyer
263 1.3.2.2 bouyer void
264 1.3.2.2 bouyer AcpiDbDisplayObjectType (
265 1.3.2.2 bouyer char *ObjectArg);
266 1.3.2.2 bouyer
267 1.3.2.2 bouyer void
268 1.3.2.2 bouyer AcpiDbDisplayArgumentObject (
269 1.3.2.2 bouyer ACPI_OPERAND_OBJECT *ObjDesc,
270 1.3.2.2 bouyer ACPI_WALK_STATE *WalkState);
271 1.3.2.2 bouyer
272 1.3.2.2 bouyer
273 1.3.2.2 bouyer /*
274 1.3.2.2 bouyer * dbexec - debugger control method execution
275 1.3.2.2 bouyer */
276 1.3.2.2 bouyer void
277 1.3.2.2 bouyer AcpiDbExecute (
278 1.3.2.2 bouyer char *Name,
279 1.3.2.2 bouyer char **Args,
280 1.3.2.2 bouyer UINT32 Flags);
281 1.3.2.2 bouyer
282 1.3.2.2 bouyer void
283 1.3.2.2 bouyer AcpiDbCreateExecutionThreads (
284 1.3.2.2 bouyer char *NumThreadsArg,
285 1.3.2.2 bouyer char *NumLoopsArg,
286 1.3.2.2 bouyer char *MethodNameArg);
287 1.3.2.2 bouyer
288 1.3.2.2 bouyer #ifdef ACPI_DBG_TRACK_ALLOCATIONS
289 1.3.2.2 bouyer UINT32
290 1.3.2.2 bouyer AcpiDbGetCacheInfo (
291 1.3.2.2 bouyer ACPI_MEMORY_LIST *Cache);
292 1.3.2.2 bouyer #endif
293 1.3.2.2 bouyer
294 1.3.2.2 bouyer
295 1.3.2.2 bouyer /*
296 1.3.2.2 bouyer * dbfileio - Debugger file I/O commands
297 1.3.2.2 bouyer */
298 1.3.2.2 bouyer ACPI_OBJECT_TYPE
299 1.3.2.2 bouyer AcpiDbMatchArgument (
300 1.3.2.2 bouyer char *UserArgument,
301 1.3.2.2 bouyer ARGUMENT_INFO *Arguments);
302 1.3.2.2 bouyer
303 1.3.2.2 bouyer void
304 1.3.2.2 bouyer AcpiDbCloseDebugFile (
305 1.3.2.2 bouyer void);
306 1.3.2.2 bouyer
307 1.3.2.2 bouyer void
308 1.3.2.2 bouyer AcpiDbOpenDebugFile (
309 1.3.2.2 bouyer char *Name);
310 1.3.2.2 bouyer
311 1.3.2.2 bouyer ACPI_STATUS
312 1.3.2.2 bouyer AcpiDbLoadAcpiTable (
313 1.3.2.2 bouyer char *Filename);
314 1.3.2.2 bouyer
315 1.3.2.2 bouyer ACPI_STATUS
316 1.3.2.2 bouyer AcpiDbGetTableFromFile (
317 1.3.2.2 bouyer char *Filename,
318 1.3.2.2 bouyer ACPI_TABLE_HEADER **Table);
319 1.3.2.2 bouyer
320 1.3.2.2 bouyer ACPI_STATUS
321 1.3.2.2 bouyer AcpiDbReadTableFromFile (
322 1.3.2.2 bouyer char *Filename,
323 1.3.2.2 bouyer ACPI_TABLE_HEADER **Table);
324 1.3.2.2 bouyer
325 1.3.2.2 bouyer
326 1.3.2.2 bouyer /*
327 1.3.2.2 bouyer * dbhistry - debugger HISTORY command
328 1.3.2.2 bouyer */
329 1.3.2.2 bouyer void
330 1.3.2.2 bouyer AcpiDbAddToHistory (
331 1.3.2.2 bouyer char *CommandLine);
332 1.3.2.2 bouyer
333 1.3.2.2 bouyer void
334 1.3.2.2 bouyer AcpiDbDisplayHistory (
335 1.3.2.2 bouyer void);
336 1.3.2.2 bouyer
337 1.3.2.2 bouyer char *
338 1.3.2.2 bouyer AcpiDbGetFromHistory (
339 1.3.2.2 bouyer char *CommandNumArg);
340 1.3.2.2 bouyer
341 1.3.2.2 bouyer
342 1.3.2.2 bouyer /*
343 1.3.2.2 bouyer * dbinput - user front-end to the AML debugger
344 1.3.2.2 bouyer */
345 1.3.2.2 bouyer ACPI_STATUS
346 1.3.2.2 bouyer AcpiDbCommandDispatch (
347 1.3.2.2 bouyer char *InputBuffer,
348 1.3.2.2 bouyer ACPI_WALK_STATE *WalkState,
349 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op);
350 1.3.2.2 bouyer
351 1.3.2.2 bouyer void ACPI_SYSTEM_XFACE
352 1.3.2.2 bouyer AcpiDbExecuteThread (
353 1.3.2.2 bouyer void *Context);
354 1.3.2.2 bouyer
355 1.3.2.2 bouyer ACPI_STATUS
356 1.3.2.2 bouyer AcpiDbUserCommands (
357 1.3.2.2 bouyer char Prompt,
358 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Op);
359 1.3.2.2 bouyer
360 1.3.2.2 bouyer
361 1.3.2.2 bouyer /*
362 1.3.2.2 bouyer * dbstats - Generation and display of ACPI table statistics
363 1.3.2.2 bouyer */
364 1.3.2.2 bouyer void
365 1.3.2.2 bouyer AcpiDbGenerateStatistics (
366 1.3.2.2 bouyer ACPI_PARSE_OBJECT *Root,
367 1.3.2.2 bouyer BOOLEAN IsMethod);
368 1.3.2.2 bouyer
369 1.3.2.2 bouyer ACPI_STATUS
370 1.3.2.2 bouyer AcpiDbDisplayStatistics (
371 1.3.2.2 bouyer char *TypeArg);
372 1.3.2.2 bouyer
373 1.3.2.2 bouyer
374 1.3.2.2 bouyer /*
375 1.3.2.2 bouyer * dbutils - AML debugger utilities
376 1.3.2.2 bouyer */
377 1.3.2.2 bouyer void
378 1.3.2.2 bouyer AcpiDbSetOutputDestination (
379 1.3.2.2 bouyer UINT32 Where);
380 1.3.2.2 bouyer
381 1.3.2.2 bouyer void
382 1.3.2.2 bouyer AcpiDbDumpExternalObject (
383 1.3.2.2 bouyer ACPI_OBJECT *ObjDesc,
384 1.3.2.2 bouyer UINT32 Level);
385 1.3.2.2 bouyer
386 1.3.2.2 bouyer void
387 1.3.2.2 bouyer AcpiDbPrepNamestring (
388 1.3.2.2 bouyer char *Name);
389 1.3.2.2 bouyer
390 1.3.2.2 bouyer ACPI_NAMESPACE_NODE *
391 1.3.2.2 bouyer AcpiDbLocalNsLookup (
392 1.3.2.2 bouyer char *Name);
393 1.3.2.2 bouyer
394 1.3.2.2 bouyer void
395 1.3.2.2 bouyer AcpiDbUInt32ToHexString (
396 1.3.2.2 bouyer UINT32 Value,
397 1.3.2.2 bouyer char *Buffer);
398 1.3.2.2 bouyer
399 1.3.2.2 bouyer #endif /* __ACDEBUG_H__ */
400