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 - 2020, 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 <contrib/dev/acpica/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
165typedef 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
172typedef 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
180typedef struct acpi_db_argument_info
181{
182    const char              *Name;          /* Argument Name */
183
184} ACPI_DB_ARGUMENT_INFO;
185
186typedef 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 */
203ACPI_DBR_DEPENDENT_RETURN_OK (
204ACPI_STATUS
205AcpiDbSingleStep (
206    ACPI_WALK_STATE         *WalkState,
207    ACPI_PARSE_OBJECT       *Op,
208    UINT32                  OpType))
209
210ACPI_DBR_DEPENDENT_RETURN_VOID (
211void
212AcpiDbSignalBreakPoint (
213    ACPI_WALK_STATE         *WalkState))
214
215
216/*
217 * dbcmds - debug commands and output routines
218 */
219ACPI_NAMESPACE_NODE *
220AcpiDbConvertToNode (
221    char                    *InString);
222
223void
224AcpiDbDisplayTableInfo (
225    char                    *TableArg);
226
227void
228AcpiDbDisplayTemplate (
229    char                    *BufferArg);
230
231void
232AcpiDbUnloadAcpiTable (
233    char                    *Name);
234
235void
236AcpiDbSendNotify (
237    char                    *Name,
238    UINT32                  Value);
239
240void
241AcpiDbDisplayInterfaces (
242    char                    *ActionArg,
243    char                    *InterfaceNameArg);
244
245ACPI_STATUS
246AcpiDbSleep (
247    char                    *ObjectArg);
248
249void
250AcpiDbTrace (
251    char                    *EnableArg,
252    char                    *MethodArg,
253    char                    *OnceArg);
254
255void
256AcpiDbDisplayLocks (
257    void);
258
259void
260AcpiDbDisplayResources (
261    char                    *ObjectArg);
262
263ACPI_HW_DEPENDENT_RETURN_VOID (
264void
265AcpiDbDisplayGpes (
266    void))
267
268void
269AcpiDbDisplayHandlers (
270    void);
271
272ACPI_HW_DEPENDENT_RETURN_VOID (
273void
274AcpiDbGenerateGpe (
275    char                    *GpeArg,
276    char                    *BlockArg))
277
278ACPI_HW_DEPENDENT_RETURN_VOID (
279void
280AcpiDbGenerateSci (
281    void))
282
283void
284AcpiDbExecuteTest (
285    char                    *TypeArg);
286
287
288/*
289 * dbconvert - miscellaneous conversion routines
290 */
291ACPI_STATUS
292AcpiDbHexCharToValue (
293    int                     HexChar,
294    UINT8                   *ReturnValue);
295
296ACPI_STATUS
297AcpiDbConvertToPackage (
298    char                    *String,
299    ACPI_OBJECT             *Object);
300
301ACPI_STATUS
302AcpiDbConvertToObject (
303    ACPI_OBJECT_TYPE        Type,
304    char                    *String,
305    ACPI_OBJECT             *Object);
306
307UINT8 *
308AcpiDbEncodePldBuffer (
309    ACPI_PLD_INFO           *PldInfo);
310
311void
312AcpiDbDumpPldBuffer (
313    ACPI_OBJECT             *ObjDesc);
314
315
316/*
317 * dbmethod - control method commands
318 */
319void
320AcpiDbSetMethodBreakpoint (
321    char                    *Location,
322    ACPI_WALK_STATE         *WalkState,
323    ACPI_PARSE_OBJECT       *Op);
324
325void
326AcpiDbSetMethodCallBreakpoint (
327    ACPI_PARSE_OBJECT       *Op);
328
329void
330AcpiDbSetMethodData (
331    char                    *TypeArg,
332    char                    *IndexArg,
333    char                    *ValueArg);
334
335ACPI_STATUS
336AcpiDbDisassembleMethod (
337    char                    *Name);
338
339void
340AcpiDbDisassembleAml (
341    char                    *Statements,
342    ACPI_PARSE_OBJECT       *Op);
343
344void
345AcpiDbEvaluatePredefinedNames (
346    void);
347
348
349/*
350 * dbnames - namespace commands
351 */
352void
353AcpiDbSetScope (
354    char                    *Name);
355
356void
357AcpiDbDumpNamespace (
358    char                    *StartArg,
359    char                    *DepthArg);
360
361void
362AcpiDbDumpNamespacePaths (
363    void);
364
365void
366AcpiDbDumpNamespaceByOwner (
367    char                    *OwnerArg,
368    char                    *DepthArg);
369
370ACPI_STATUS
371AcpiDbFindNameInNamespace (
372    char                    *NameArg);
373
374void
375AcpiDbCheckPredefinedNames (
376    void);
377
378ACPI_STATUS
379AcpiDbDisplayObjects (
380    char                    *ObjTypeArg,
381    char                    *DisplayCountArg);
382
383void
384AcpiDbCheckIntegrity (
385    void);
386
387void
388AcpiDbFindReferences (
389    char                    *ObjectArg);
390
391void
392AcpiDbGetBusInfo (
393    void);
394
395ACPI_STATUS
396AcpiDbDisplayFields (
397    UINT32                  AddressSpaceId);
398
399
400/*
401 * dbdisply - debug display commands
402 */
403void
404AcpiDbDisplayMethodInfo (
405    ACPI_PARSE_OBJECT       *Op);
406
407void
408AcpiDbDecodeAndDisplayObject (
409    char                    *Target,
410    char                    *OutputType);
411
412ACPI_DBR_DEPENDENT_RETURN_VOID (
413void
414AcpiDbDisplayResultObject (
415    ACPI_OPERAND_OBJECT     *ObjDesc,
416    ACPI_WALK_STATE         *WalkState))
417
418ACPI_STATUS
419AcpiDbDisplayAllMethods (
420    char                    *DisplayCountArg);
421
422void
423AcpiDbDisplayArguments (
424    void);
425
426void
427AcpiDbDisplayLocals (
428    void);
429
430void
431AcpiDbDisplayResults (
432    void);
433
434void
435AcpiDbDisplayCallingTree (
436    void);
437
438void
439AcpiDbDisplayObjectType (
440    char                    *ObjectArg);
441
442ACPI_DBR_DEPENDENT_RETURN_VOID (
443void
444AcpiDbDisplayArgumentObject (
445    ACPI_OPERAND_OBJECT     *ObjDesc,
446    ACPI_WALK_STATE         *WalkState))
447
448
449/*
450 * dbexec - debugger control method execution
451 */
452void
453AcpiDbExecute (
454    char                    *Name,
455    char                    **Args,
456    ACPI_OBJECT_TYPE        *Types,
457    UINT32                  Flags);
458
459void
460AcpiDbCreateExecutionThread (
461    char                    *MethodNameArg,
462    char                    **Arguments,
463    ACPI_OBJECT_TYPE        *Types);
464
465void
466AcpiDbCreateExecutionThreads (
467    char                    *NumThreadsArg,
468    char                    *NumLoopsArg,
469    char                    *MethodNameArg);
470
471void
472AcpiDbDeleteObjects (
473    UINT32                  Count,
474    ACPI_OBJECT             *Objects);
475
476#ifdef ACPI_DBG_TRACK_ALLOCATIONS
477UINT32
478AcpiDbGetCacheInfo (
479    ACPI_MEMORY_LIST        *Cache);
480#endif
481
482
483/*
484 * dbfileio - Debugger file I/O commands
485 */
486ACPI_OBJECT_TYPE
487AcpiDbMatchArgument (
488    char                    *UserArgument,
489    ACPI_DB_ARGUMENT_INFO   *Arguments);
490
491void
492AcpiDbCloseDebugFile (
493    void);
494
495void
496AcpiDbOpenDebugFile (
497    char                    *Name);
498
499ACPI_STATUS
500AcpiDbLoadAcpiTable (
501    char                    *Filename);
502
503ACPI_STATUS
504AcpiDbLoadTables (
505    ACPI_NEW_TABLE_DESC     *ListHead);
506
507
508/*
509 * dbhistry - debugger HISTORY command
510 */
511void
512AcpiDbAddToHistory (
513    char                    *CommandLine);
514
515void
516AcpiDbDisplayHistory (
517    void);
518
519char *
520AcpiDbGetFromHistory (
521    char                    *CommandNumArg);
522
523char *
524AcpiDbGetHistoryByIndex (
525    UINT32                  CommanddNum);
526
527
528/*
529 * dbinput - user front-end to the AML debugger
530 */
531ACPI_STATUS
532AcpiDbCommandDispatch (
533    char                    *InputBuffer,
534    ACPI_WALK_STATE         *WalkState,
535    ACPI_PARSE_OBJECT       *Op);
536
537void ACPI_SYSTEM_XFACE
538AcpiDbExecuteThread (
539    void                    *Context);
540
541ACPI_STATUS
542AcpiDbUserCommands (
543    void);
544
545char *
546AcpiDbGetNextToken (
547    char                    *String,
548    char                    **Next,
549    ACPI_OBJECT_TYPE        *ReturnType);
550
551
552/*
553 * dbobject
554 */
555void
556AcpiDbDecodeInternalObject (
557    ACPI_OPERAND_OBJECT     *ObjDesc);
558
559void
560AcpiDbDisplayInternalObject (
561    ACPI_OPERAND_OBJECT     *ObjDesc,
562    ACPI_WALK_STATE         *WalkState);
563
564void
565AcpiDbDecodeArguments (
566    ACPI_WALK_STATE         *WalkState);
567
568void
569AcpiDbDecodeLocals (
570    ACPI_WALK_STATE         *WalkState);
571
572void
573AcpiDbDumpMethodInfo (
574    ACPI_STATUS             Status,
575    ACPI_WALK_STATE         *WalkState);
576
577
578/*
579 * dbstats - Generation and display of ACPI table statistics
580 */
581void
582AcpiDbGenerateStatistics (
583    ACPI_PARSE_OBJECT       *Root,
584    BOOLEAN                 IsMethod);
585
586ACPI_STATUS
587AcpiDbDisplayStatistics (
588    char                    *TypeArg);
589
590
591/*
592 * dbutils - AML debugger utilities
593 */
594void
595AcpiDbSetOutputDestination (
596    UINT32                  Where);
597
598void
599AcpiDbDumpExternalObject (
600    ACPI_OBJECT             *ObjDesc,
601    UINT32                  Level);
602
603void
604AcpiDbPrepNamestring (
605    char                    *Name);
606
607ACPI_NAMESPACE_NODE *
608AcpiDbLocalNsLookup (
609    char                    *Name);
610
611void
612AcpiDbUint32ToHexString (
613    UINT32                  Value,
614    char                    *Buffer);
615
616#endif  /* __ACDEBUG_H__ */
617