xref: /freebsd/sys/contrib/dev/acpica/components/debugger/dbxface.c (revision 722b16673c40aedf280895f2f2f676bb494518d7)
1 /*******************************************************************************
2  *
3  * Module Name: dbxface - AML Debugger external interfaces
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2023, 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 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acdebug.h>
156 #include <contrib/dev/acpica/include/acinterp.h>
157 #include <contrib/dev/acpica/include/acparser.h>
158 
159 
160 #define _COMPONENT          ACPI_CA_DEBUGGER
161         ACPI_MODULE_NAME    ("dbxface")
162 
163 
164 /* Local prototypes */
165 
166 static ACPI_STATUS
167 AcpiDbStartCommand (
168     ACPI_WALK_STATE         *WalkState,
169     ACPI_PARSE_OBJECT       *Op);
170 
171 #ifdef ACPI_OBSOLETE_FUNCTIONS
172 void
173 AcpiDbMethodEnd (
174     ACPI_WALK_STATE         *WalkState);
175 #endif
176 
177 #ifdef ACPI_DISASSEMBLER
178 static ACPI_PARSE_OBJECT *
179 AcpiDbGetDisplayOp (
180     ACPI_WALK_STATE         *WalkState,
181     ACPI_PARSE_OBJECT       *Op);
182 #endif
183 
184 /*******************************************************************************
185  *
186  * FUNCTION:    AcpiDbStartCommand
187  *
188  * PARAMETERS:  WalkState       - Current walk
189  *              Op              - Current executing Op, from AML interpreter
190  *
191  * RETURN:      Status
192  *
193  * DESCRIPTION: Enter debugger command loop
194  *
195  ******************************************************************************/
196 
197 static ACPI_STATUS
AcpiDbStartCommand(ACPI_WALK_STATE * WalkState,ACPI_PARSE_OBJECT * Op)198 AcpiDbStartCommand (
199     ACPI_WALK_STATE         *WalkState,
200     ACPI_PARSE_OBJECT       *Op)
201 {
202     ACPI_STATUS             Status;
203 
204 
205     /* TBD: [Investigate] are there namespace locking issues here? */
206 
207     /* AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); */
208 
209     /* Go into the command loop and await next user command */
210 
211 
212     AcpiGbl_MethodExecuting = TRUE;
213     Status = AE_CTRL_TRUE;
214 
215     while (Status == AE_CTRL_TRUE)
216     {
217         /* Notify the completion of the command */
218 
219         Status = AcpiOsNotifyCommandComplete ();
220         if (ACPI_FAILURE (Status))
221         {
222             goto ErrorExit;
223         }
224 
225         /* Wait the readiness of the command */
226 
227         Status = AcpiOsWaitCommandReady ();
228         if (ACPI_FAILURE (Status))
229         {
230             goto ErrorExit;
231         }
232 
233         Status = AcpiDbCommandDispatch (AcpiGbl_DbLineBuf, WalkState, Op);
234     }
235 
236     /* AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); */
237 
238 ErrorExit:
239     if (ACPI_FAILURE (Status) && Status != AE_CTRL_TERMINATE)
240     {
241         ACPI_EXCEPTION ((AE_INFO, Status,
242             "While parsing/handling command line"));
243     }
244     return (Status);
245 }
246 
247 
248 /*******************************************************************************
249  *
250  * FUNCTION:    AcpiDbSignalBreakPoint
251  *
252  * PARAMETERS:  WalkState       - Current walk
253  *
254  * RETURN:      Status
255  *
256  * DESCRIPTION: Called for AML_BREAKPOINT_OP
257  *
258  ******************************************************************************/
259 
260 void
AcpiDbSignalBreakPoint(ACPI_WALK_STATE * WalkState)261 AcpiDbSignalBreakPoint (
262     ACPI_WALK_STATE         *WalkState)
263 {
264 
265 #ifndef ACPI_APPLICATION
266     if (AcpiGbl_DbThreadId != AcpiOsGetThreadId ())
267     {
268         return;
269     }
270 #endif
271 
272     /*
273      * Set the single-step flag. This will cause the debugger (if present)
274      * to break to the console within the AML debugger at the start of the
275      * next AML instruction.
276      */
277     AcpiGbl_CmSingleStep = TRUE;
278     AcpiOsPrintf ("**break** Executed AML BreakPoint opcode\n");
279 }
280 
281 
282 #ifdef ACPI_DISASSEMBLER
283 /*******************************************************************************
284  *
285  * FUNCTION:    AcpiDbGetDisplayOp
286  *
287  * PARAMETERS:  WalkState       - Current walk
288  *              Op              - Current executing op (from aml interpreter)
289  *
290  * RETURN:      Opcode to display
291  *
292  * DESCRIPTION: Find the opcode to display during single stepping
293  *
294  ******************************************************************************/
295 
296 static ACPI_PARSE_OBJECT *
AcpiDbGetDisplayOp(ACPI_WALK_STATE * WalkState,ACPI_PARSE_OBJECT * Op)297 AcpiDbGetDisplayOp (
298     ACPI_WALK_STATE         *WalkState,
299     ACPI_PARSE_OBJECT       *Op)
300 {
301     ACPI_PARSE_OBJECT       *DisplayOp;
302     ACPI_PARSE_OBJECT       *ParentOp;
303 
304     DisplayOp = Op;
305     ParentOp = Op->Common.Parent;
306     if (ParentOp)
307     {
308         if ((WalkState->ControlState) &&
309             (WalkState->ControlState->Common.State ==
310                 ACPI_CONTROL_PREDICATE_EXECUTING))
311         {
312             /*
313              * We are executing the predicate of an IF or WHILE statement
314              * Search upwards for the containing IF or WHILE so that the
315              * entire predicate can be displayed.
316              */
317             while (ParentOp)
318             {
319                 if ((ParentOp->Common.AmlOpcode == AML_IF_OP) ||
320                     (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
321                 {
322                     DisplayOp = ParentOp;
323                     break;
324                 }
325                 ParentOp = ParentOp->Common.Parent;
326             }
327         }
328         else
329         {
330             while (ParentOp)
331             {
332                 if ((ParentOp->Common.AmlOpcode == AML_IF_OP)     ||
333                     (ParentOp->Common.AmlOpcode == AML_ELSE_OP)   ||
334                     (ParentOp->Common.AmlOpcode == AML_SCOPE_OP)  ||
335                     (ParentOp->Common.AmlOpcode == AML_METHOD_OP) ||
336                     (ParentOp->Common.AmlOpcode == AML_WHILE_OP))
337                 {
338                     break;
339                 }
340                 DisplayOp = ParentOp;
341                 ParentOp = ParentOp->Common.Parent;
342             }
343         }
344     }
345     return DisplayOp;
346 }
347 #endif
348 
349 
350 /*******************************************************************************
351  *
352  * FUNCTION:    AcpiDbSingleStep
353  *
354  * PARAMETERS:  WalkState       - Current walk
355  *              Op              - Current executing op (from aml interpreter)
356  *              OpcodeClass     - Class of the current AML Opcode
357  *
358  * RETURN:      Status
359  *
360  * DESCRIPTION: Called just before execution of an AML opcode.
361  *
362  ******************************************************************************/
363 
364 ACPI_STATUS
AcpiDbSingleStep(ACPI_WALK_STATE * WalkState,ACPI_PARSE_OBJECT * Op,UINT32 OpcodeClass)365 AcpiDbSingleStep (
366     ACPI_WALK_STATE         *WalkState,
367     ACPI_PARSE_OBJECT       *Op,
368     UINT32                  OpcodeClass)
369 {
370     ACPI_PARSE_OBJECT       *Next;
371     ACPI_STATUS             Status = AE_OK;
372     UINT32                  OriginalDebugLevel;
373     UINT32                  AmlOffset;
374 
375 
376     ACPI_FUNCTION_ENTRY ();
377 
378 
379 #ifndef ACPI_APPLICATION
380     if (AcpiGbl_DbThreadId != AcpiOsGetThreadId ())
381     {
382         return (AE_OK);
383     }
384 #endif
385 
386     /* Check the abort flag */
387 
388     if (AcpiGbl_AbortMethod)
389     {
390         AcpiGbl_AbortMethod = FALSE;
391         return (AE_ABORT_METHOD);
392     }
393 
394     AmlOffset = (UINT32) ACPI_PTR_DIFF (Op->Common.Aml,
395         WalkState->ParserState.AmlStart);
396 
397     /* Check for single-step breakpoint */
398 
399     if (WalkState->MethodBreakpoint &&
400        (WalkState->MethodBreakpoint <= AmlOffset))
401     {
402         /* Check if the breakpoint has been reached or passed */
403         /* Hit the breakpoint, resume single step, reset breakpoint */
404 
405         AcpiOsPrintf ("***Break*** at AML offset %X\n", AmlOffset);
406         AcpiGbl_CmSingleStep = TRUE;
407         AcpiGbl_StepToNextCall = FALSE;
408         WalkState->MethodBreakpoint = 0;
409     }
410 
411     /* Check for user breakpoint (Must be on exact Aml offset) */
412 
413     else if (WalkState->UserBreakpoint &&
414             (WalkState->UserBreakpoint == AmlOffset))
415     {
416         AcpiOsPrintf ("***UserBreakpoint*** at AML offset %X\n",
417             AmlOffset);
418         AcpiGbl_CmSingleStep = TRUE;
419         AcpiGbl_StepToNextCall = FALSE;
420         WalkState->MethodBreakpoint = 0;
421     }
422 
423     /*
424      * Check if this is an opcode that we are interested in --
425      * namely, opcodes that have arguments
426      */
427     if (Op->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP)
428     {
429         return (AE_OK);
430     }
431 
432     switch (OpcodeClass)
433     {
434     case AML_CLASS_UNKNOWN:
435     case AML_CLASS_ARGUMENT:    /* constants, literals, etc. do nothing */
436 
437         return (AE_OK);
438 
439     default:
440 
441         /* All other opcodes -- continue */
442         break;
443     }
444 
445     /*
446      * Under certain debug conditions, display this opcode and its operands
447      */
448     if ((AcpiGbl_DbOutputToFile)            ||
449         (AcpiGbl_CmSingleStep)              ||
450         (AcpiDbgLevel & ACPI_LV_PARSE))
451     {
452         if ((AcpiGbl_DbOutputToFile)        ||
453             (AcpiDbgLevel & ACPI_LV_PARSE))
454         {
455             AcpiOsPrintf ("\nAML Debug: Next AML Opcode to execute:\n");
456         }
457 
458         /*
459          * Display this op (and only this op - zero out the NEXT field
460          * temporarily, and disable parser trace output for the duration of
461          * the display because we don't want the extraneous debug output)
462          */
463         OriginalDebugLevel = AcpiDbgLevel;
464         AcpiDbgLevel &= ~(ACPI_LV_PARSE | ACPI_LV_FUNCTIONS);
465         Next = Op->Common.Next;
466         Op->Common.Next = NULL;
467 
468         /* Now we can disassemble and display it */
469 
470 #ifdef ACPI_DISASSEMBLER
471         AcpiDmDisassemble (WalkState, AcpiDbGetDisplayOp (WalkState, Op),
472             ACPI_UINT32_MAX);
473 #else
474         /*
475          * The AML Disassembler is not configured - at least we can
476          * display the opcode value and name
477          */
478         AcpiOsPrintf ("AML Opcode: %4.4X  %s\n", Op->Common.AmlOpcode,
479             AcpiPsGetOpcodeName (Op->Common.AmlOpcode));
480 #endif
481 
482         if ((Op->Common.AmlOpcode == AML_IF_OP) ||
483             (Op->Common.AmlOpcode == AML_WHILE_OP))
484         {
485             if (WalkState->ControlState->Common.Value)
486             {
487                 AcpiOsPrintf ("Predicate = [True], IF block was executed\n");
488             }
489             else
490             {
491                 AcpiOsPrintf ("Predicate = [False], Skipping IF block\n");
492             }
493         }
494         else if (Op->Common.AmlOpcode == AML_ELSE_OP)
495         {
496             AcpiOsPrintf ("Predicate = [False], ELSE block was executed\n");
497         }
498 
499         /* Restore everything */
500 
501         Op->Common.Next = Next;
502         AcpiOsPrintf ("\n");
503         if ((AcpiGbl_DbOutputToFile)        ||
504             (AcpiDbgLevel & ACPI_LV_PARSE))
505         {
506             AcpiOsPrintf ("\n");
507         }
508         AcpiDbgLevel = OriginalDebugLevel;
509     }
510 
511     /* If we are not single stepping, just continue executing the method */
512 
513     if (!AcpiGbl_CmSingleStep)
514     {
515         return (AE_OK);
516     }
517 
518     /*
519      * If we are executing a step-to-call command,
520      * Check if this is a method call.
521      */
522     if (AcpiGbl_StepToNextCall)
523     {
524         if (Op->Common.AmlOpcode != AML_INT_METHODCALL_OP)
525         {
526             /* Not a method call, just keep executing */
527 
528             return (AE_OK);
529         }
530 
531         /* Found a method call, stop executing */
532 
533         AcpiGbl_StepToNextCall = FALSE;
534     }
535 
536     /*
537      * If the next opcode is a method call, we will "step over" it
538      * by default.
539      */
540     if (Op->Common.AmlOpcode == AML_INT_METHODCALL_OP)
541     {
542         /* Force no more single stepping while executing called method */
543 
544         AcpiGbl_CmSingleStep = FALSE;
545 
546         /*
547          * Set the breakpoint on/before the call, it will stop execution
548          * as soon as we return
549          */
550         WalkState->MethodBreakpoint = 1;  /* Must be non-zero! */
551     }
552 
553 
554     AcpiExExitInterpreter ();
555     Status = AcpiDbStartCommand (WalkState, Op);
556     AcpiExEnterInterpreter ();
557 
558     /* User commands complete, continue execution of the interrupted method */
559 
560     return (Status);
561 }
562 
563 
564 /*******************************************************************************
565  *
566  * FUNCTION:    AcpiInitializeDebugger
567  *
568  * PARAMETERS:  None
569  *
570  * RETURN:      Status
571  *
572  * DESCRIPTION: Init and start debugger
573  *
574  ******************************************************************************/
575 
576 ACPI_STATUS
AcpiInitializeDebugger(void)577 AcpiInitializeDebugger (
578     void)
579 {
580     ACPI_STATUS             Status;
581 
582 
583     ACPI_FUNCTION_TRACE (AcpiInitializeDebugger);
584 
585 
586     /* Init globals */
587 
588     AcpiGbl_DbBuffer            = NULL;
589     AcpiGbl_DbFilename          = NULL;
590     AcpiGbl_DbOutputToFile      = FALSE;
591 
592     AcpiGbl_DbDebugLevel        = ACPI_LV_VERBOSITY2;
593     AcpiGbl_DbConsoleDebugLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES;
594     AcpiGbl_DbOutputFlags       = ACPI_DB_CONSOLE_OUTPUT;
595 
596     AcpiGbl_DbOpt_NoIniMethods  = FALSE;
597     AcpiGbl_DbOpt_NoRegionSupport = FALSE;
598 
599     AcpiGbl_DbBuffer = AcpiOsAllocate (ACPI_DEBUG_BUFFER_SIZE);
600     if (!AcpiGbl_DbBuffer)
601     {
602         return_ACPI_STATUS (AE_NO_MEMORY);
603     }
604     memset (AcpiGbl_DbBuffer, 0, ACPI_DEBUG_BUFFER_SIZE);
605 
606     /* Initial scope is the root */
607 
608     AcpiGbl_DbScopeBuf [0] = AML_ROOT_PREFIX;
609     AcpiGbl_DbScopeBuf [1] =  0;
610     AcpiGbl_DbScopeNode = AcpiGbl_RootNode;
611 
612     /* Initialize user commands loop */
613 
614     AcpiGbl_DbTerminateLoop = FALSE;
615 
616     /*
617      * If configured for multi-thread support, the debug executor runs in
618      * a separate thread so that the front end can be in another address
619      * space, environment, or even another machine.
620      */
621     if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
622     {
623         /* These were created with one unit, grab it */
624 
625         Status = AcpiOsInitializeDebugger ();
626         if (ACPI_FAILURE (Status))
627         {
628             AcpiOsPrintf ("Could not get debugger mutex\n");
629             return_ACPI_STATUS (Status);
630         }
631 
632         /* Create the debug execution thread to execute commands */
633 
634         AcpiGbl_DbThreadsTerminated = FALSE;
635         Status = AcpiOsExecute (OSL_DEBUGGER_MAIN_THREAD,
636             AcpiDbExecuteThread, NULL);
637         if (ACPI_FAILURE (Status))
638         {
639             ACPI_EXCEPTION ((AE_INFO, Status,
640                 "Could not start debugger thread"));
641             AcpiGbl_DbThreadsTerminated = TRUE;
642             return_ACPI_STATUS (Status);
643         }
644     }
645     else
646     {
647         AcpiGbl_DbThreadId = AcpiOsGetThreadId ();
648     }
649 
650     return_ACPI_STATUS (AE_OK);
651 }
652 
ACPI_EXPORT_SYMBOL(AcpiInitializeDebugger)653 ACPI_EXPORT_SYMBOL (AcpiInitializeDebugger)
654 
655 
656 /*******************************************************************************
657  *
658  * FUNCTION:    AcpiTerminateDebugger
659  *
660  * PARAMETERS:  None
661  *
662  * RETURN:      None
663  *
664  * DESCRIPTION: Stop debugger
665  *
666  ******************************************************************************/
667 
668 void
669 AcpiTerminateDebugger (
670     void)
671 {
672 
673     /* Terminate the AML Debugger */
674 
675     AcpiGbl_DbTerminateLoop = TRUE;
676 
677     if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
678     {
679         /* Wait the AML Debugger threads */
680 
681         while (!AcpiGbl_DbThreadsTerminated)
682         {
683             AcpiOsSleep (100);
684         }
685 
686         AcpiOsTerminateDebugger ();
687     }
688 
689     if (AcpiGbl_DbBuffer)
690     {
691         AcpiOsFree (AcpiGbl_DbBuffer);
692         AcpiGbl_DbBuffer = NULL;
693     }
694 
695     /* Ensure that debug output is now disabled */
696 
697     AcpiGbl_DbOutputFlags = ACPI_DB_DISABLE_OUTPUT;
698 }
699 
ACPI_EXPORT_SYMBOL(AcpiTerminateDebugger)700 ACPI_EXPORT_SYMBOL (AcpiTerminateDebugger)
701 
702 
703 /*******************************************************************************
704  *
705  * FUNCTION:    AcpiSetDebuggerThreadId
706  *
707  * PARAMETERS:  ThreadId        - Debugger thread ID
708  *
709  * RETURN:      None
710  *
711  * DESCRIPTION: Set debugger thread ID
712  *
713  ******************************************************************************/
714 
715 void
716 AcpiSetDebuggerThreadId (
717     ACPI_THREAD_ID          ThreadId)
718 {
719     AcpiGbl_DbThreadId = ThreadId;
720 }
721 
722 ACPI_EXPORT_SYMBOL (AcpiSetDebuggerThreadId)
723