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 - 2019, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ACDEBUG_H__
153 #define __ACDEBUG_H__
154 
155 /* The debugger is used in conjunction with the disassembler most of time */
156 
157 #ifdef ACPI_DISASSEMBLER
158 #include "acdisasm.h"
159 #endif
160 
161 
162 #define ACPI_DEBUG_BUFFER_SIZE      0x4000      /* 16K buffer for return objects */
163 #define ACPI_DEBUG_LENGTH_FORMAT    " (%.4X bits, %.3X bytes)"
164 
165 typedef struct acpi_db_command_info
166 {
167     const char              *Name;          /* Command Name */
168     UINT8                   MinArgs;        /* Minimum arguments required */
169 
170 } ACPI_DB_COMMAND_INFO;
171 
172 typedef struct acpi_db_command_help
173 {
174     UINT8                   LineCount;      /* Number of help lines */
175     char                    *Invocation;    /* Command Invocation */
176     char                    *Description;   /* Command Description */
177 
178 } ACPI_DB_COMMAND_HELP;
179 
180 typedef struct acpi_db_argument_info
181 {
182     const char              *Name;          /* Argument Name */
183 
184 } ACPI_DB_ARGUMENT_INFO;
185 
186 typedef struct acpi_db_execute_walk
187 {
188     UINT32                  Count;
189     UINT32                  MaxCount;
190 
191 } ACPI_DB_EXECUTE_WALK;
192 
193 
194 #define PARAM_LIST(pl)                  pl
195 
196 #define EX_NO_SINGLE_STEP               1
197 #define EX_SINGLE_STEP                  2
198 
199 
200 /*
201  * dbxface - external debugger interfaces
202  */
203 ACPI_DBR_DEPENDENT_RETURN_OK (
204 ACPI_STATUS
205 AcpiDbSingleStep (
206     ACPI_WALK_STATE         *WalkState,
207     ACPI_PARSE_OBJECT       *Op,
208     UINT32                  OpType))
209 
210 ACPI_DBR_DEPENDENT_RETURN_VOID (
211 void
212 AcpiDbSignalBreakPoint (
213     ACPI_WALK_STATE         *WalkState))
214 
215 
216 /*
217  * dbcmds - debug commands and output routines
218  */
219 ACPI_NAMESPACE_NODE *
220 AcpiDbConvertToNode (
221     char                    *InString);
222 
223 void
224 AcpiDbDisplayTableInfo (
225     char                    *TableArg);
226 
227 void
228 AcpiDbDisplayTemplate (
229     char                    *BufferArg);
230 
231 void
232 AcpiDbUnloadAcpiTable (
233     char                    *Name);
234 
235 void
236 AcpiDbSendNotify (
237     char                    *Name,
238     UINT32                  Value);
239 
240 void
241 AcpiDbDisplayInterfaces (
242     char                    *ActionArg,
243     char                    *InterfaceNameArg);
244 
245 ACPI_STATUS
246 AcpiDbSleep (
247     char                    *ObjectArg);
248 
249 void
250 AcpiDbTrace (
251     char                    *EnableArg,
252     char                    *MethodArg,
253     char                    *OnceArg);
254 
255 void
256 AcpiDbDisplayLocks (
257     void);
258 
259 void
260 AcpiDbDisplayResources (
261     char                    *ObjectArg);
262 
263 ACPI_HW_DEPENDENT_RETURN_VOID (
264 void
265 AcpiDbDisplayGpes (
266     void))
267 
268 void
269 AcpiDbDisplayHandlers (
270     void);
271 
272 ACPI_HW_DEPENDENT_RETURN_VOID (
273 void
274 AcpiDbGenerateGpe (
275     char                    *GpeArg,
276     char                    *BlockArg))
277 
278 ACPI_HW_DEPENDENT_RETURN_VOID (
279 void
280 AcpiDbGenerateSci (
281     void))
282 
283 void
284 AcpiDbExecuteTest (
285     char                    *TypeArg);
286 
287 
288 /*
289  * dbconvert - miscellaneous conversion routines
290  */
291 ACPI_STATUS
292 AcpiDbHexCharToValue (
293     int                     HexChar,
294     UINT8                   *ReturnValue);
295 
296 ACPI_STATUS
297 AcpiDbConvertToPackage (
298     char                    *String,
299     ACPI_OBJECT             *Object);
300 
301 ACPI_STATUS
302 AcpiDbConvertToObject (
303     ACPI_OBJECT_TYPE        Type,
304     char                    *String,
305     ACPI_OBJECT             *Object);
306 
307 UINT8 *
308 AcpiDbEncodePldBuffer (
309     ACPI_PLD_INFO           *PldInfo);
310 
311 void
312 AcpiDbDumpPldBuffer (
313     ACPI_OBJECT             *ObjDesc);
314 
315 
316 /*
317  * dbmethod - control method commands
318  */
319 void
320 AcpiDbSetMethodBreakpoint (
321     char                    *Location,
322     ACPI_WALK_STATE         *WalkState,
323     ACPI_PARSE_OBJECT       *Op);
324 
325 void
326 AcpiDbSetMethodCallBreakpoint (
327     ACPI_PARSE_OBJECT       *Op);
328 
329 void
330 AcpiDbSetMethodData (
331     char                    *TypeArg,
332     char                    *IndexArg,
333     char                    *ValueArg);
334 
335 ACPI_STATUS
336 AcpiDbDisassembleMethod (
337     char                    *Name);
338 
339 void
340 AcpiDbDisassembleAml (
341     char                    *Statements,
342     ACPI_PARSE_OBJECT       *Op);
343 
344 void
345 AcpiDbEvaluatePredefinedNames (
346     void);
347 
348 
349 /*
350  * dbnames - namespace commands
351  */
352 void
353 AcpiDbSetScope (
354     char                    *Name);
355 
356 void
357 AcpiDbDumpNamespace (
358     char                    *StartArg,
359     char                    *DepthArg);
360 
361 void
362 AcpiDbDumpNamespacePaths (
363     void);
364 
365 void
366 AcpiDbDumpNamespaceByOwner (
367     char                    *OwnerArg,
368     char                    *DepthArg);
369 
370 ACPI_STATUS
371 AcpiDbFindNameInNamespace (
372     char                    *NameArg);
373 
374 void
375 AcpiDbCheckPredefinedNames (
376     void);
377 
378 ACPI_STATUS
379 AcpiDbDisplayObjects (
380     char                    *ObjTypeArg,
381     char                    *DisplayCountArg);
382 
383 void
384 AcpiDbCheckIntegrity (
385     void);
386 
387 void
388 AcpiDbFindReferences (
389     char                    *ObjectArg);
390 
391 void
392 AcpiDbGetBusInfo (
393     void);
394 
395 
396 /*
397  * dbdisply - debug display commands
398  */
399 void
400 AcpiDbDisplayMethodInfo (
401     ACPI_PARSE_OBJECT       *Op);
402 
403 void
404 AcpiDbDecodeAndDisplayObject (
405     char                    *Target,
406     char                    *OutputType);
407 
408 ACPI_DBR_DEPENDENT_RETURN_VOID (
409 void
410 AcpiDbDisplayResultObject (
411     ACPI_OPERAND_OBJECT     *ObjDesc,
412     ACPI_WALK_STATE         *WalkState))
413 
414 ACPI_STATUS
415 AcpiDbDisplayAllMethods (
416     char                    *DisplayCountArg);
417 
418 void
419 AcpiDbDisplayArguments (
420     void);
421 
422 void
423 AcpiDbDisplayLocals (
424     void);
425 
426 void
427 AcpiDbDisplayResults (
428     void);
429 
430 void
431 AcpiDbDisplayCallingTree (
432     void);
433 
434 void
435 AcpiDbDisplayObjectType (
436     char                    *ObjectArg);
437 
438 ACPI_DBR_DEPENDENT_RETURN_VOID (
439 void
440 AcpiDbDisplayArgumentObject (
441     ACPI_OPERAND_OBJECT     *ObjDesc,
442     ACPI_WALK_STATE         *WalkState))
443 
444 
445 /*
446  * dbexec - debugger control method execution
447  */
448 void
449 AcpiDbExecute (
450     char                    *Name,
451     char                    **Args,
452     ACPI_OBJECT_TYPE        *Types,
453     UINT32                  Flags);
454 
455 void
456 AcpiDbCreateExecutionThread (
457     char                    *MethodNameArg,
458     char                    **Arguments,
459     ACPI_OBJECT_TYPE        *Types);
460 
461 void
462 AcpiDbCreateExecutionThreads (
463     char                    *NumThreadsArg,
464     char                    *NumLoopsArg,
465     char                    *MethodNameArg);
466 
467 void
468 AcpiDbDeleteObjects (
469     UINT32                  Count,
470     ACPI_OBJECT             *Objects);
471 
472 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
473 UINT32
474 AcpiDbGetCacheInfo (
475     ACPI_MEMORY_LIST        *Cache);
476 #endif
477 
478 
479 /*
480  * dbfileio - Debugger file I/O commands
481  */
482 ACPI_OBJECT_TYPE
483 AcpiDbMatchArgument (
484     char                    *UserArgument,
485     ACPI_DB_ARGUMENT_INFO   *Arguments);
486 
487 void
488 AcpiDbCloseDebugFile (
489     void);
490 
491 void
492 AcpiDbOpenDebugFile (
493     char                    *Name);
494 
495 ACPI_STATUS
496 AcpiDbLoadAcpiTable (
497     char                    *Filename);
498 
499 ACPI_STATUS
500 AcpiDbLoadTables (
501     ACPI_NEW_TABLE_DESC     *ListHead);
502 
503 
504 /*
505  * dbhistry - debugger HISTORY command
506  */
507 void
508 AcpiDbAddToHistory (
509     char                    *CommandLine);
510 
511 void
512 AcpiDbDisplayHistory (
513     void);
514 
515 char *
516 AcpiDbGetFromHistory (
517     char                    *CommandNumArg);
518 
519 char *
520 AcpiDbGetHistoryByIndex (
521     UINT32                  CommanddNum);
522 
523 
524 /*
525  * dbinput - user front-end to the AML debugger
526  */
527 ACPI_STATUS
528 AcpiDbCommandDispatch (
529     char                    *InputBuffer,
530     ACPI_WALK_STATE         *WalkState,
531     ACPI_PARSE_OBJECT       *Op);
532 
533 void ACPI_SYSTEM_XFACE
534 AcpiDbExecuteThread (
535     void                    *Context);
536 
537 ACPI_STATUS
538 AcpiDbUserCommands (
539     void);
540 
541 char *
542 AcpiDbGetNextToken (
543     char                    *String,
544     char                    **Next,
545     ACPI_OBJECT_TYPE        *ReturnType);
546 
547 
548 /*
549  * dbobject
550  */
551 void
552 AcpiDbDecodeInternalObject (
553     ACPI_OPERAND_OBJECT     *ObjDesc);
554 
555 void
556 AcpiDbDisplayInternalObject (
557     ACPI_OPERAND_OBJECT     *ObjDesc,
558     ACPI_WALK_STATE         *WalkState);
559 
560 void
561 AcpiDbDecodeArguments (
562     ACPI_WALK_STATE         *WalkState);
563 
564 void
565 AcpiDbDecodeLocals (
566     ACPI_WALK_STATE         *WalkState);
567 
568 void
569 AcpiDbDumpMethodInfo (
570     ACPI_STATUS             Status,
571     ACPI_WALK_STATE         *WalkState);
572 
573 
574 /*
575  * dbstats - Generation and display of ACPI table statistics
576  */
577 void
578 AcpiDbGenerateStatistics (
579     ACPI_PARSE_OBJECT       *Root,
580     BOOLEAN                 IsMethod);
581 
582 ACPI_STATUS
583 AcpiDbDisplayStatistics (
584     char                    *TypeArg);
585 
586 
587 /*
588  * dbutils - AML debugger utilities
589  */
590 void
591 AcpiDbSetOutputDestination (
592     UINT32                  Where);
593 
594 void
595 AcpiDbDumpExternalObject (
596     ACPI_OBJECT             *ObjDesc,
597     UINT32                  Level);
598 
599 void
600 AcpiDbPrepNamestring (
601     char                    *Name);
602 
603 ACPI_NAMESPACE_NODE *
604 AcpiDbLocalNsLookup (
605     char                    *Name);
606 
607 void
608 AcpiDbUint32ToHexString (
609     UINT32                  Value,
610     char                    *Buffer);
611 
612 #endif  /* __ACDEBUG_H__ */
613