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