xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/dispatcher/dsmethod.c (revision 37fedaf8494b34aad811abcc49e79aa32943f880)
1 /******************************************************************************
2  *
3  * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2013, 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 #define __DSMETHOD_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acdispat.h"
121 #include "acinterp.h"
122 #include "acnamesp.h"
123 #include "acdisasm.h"
124 
125 
126 #define _COMPONENT          ACPI_DISPATCHER
127         ACPI_MODULE_NAME    ("dsmethod")
128 
129 /* Local prototypes */
130 
131 static ACPI_STATUS
132 AcpiDsCreateMethodMutex (
133     ACPI_OPERAND_OBJECT     *MethodDesc);
134 
135 
136 /*******************************************************************************
137  *
138  * FUNCTION:    AcpiDsMethodError
139  *
140  * PARAMETERS:  Status          - Execution status
141  *              WalkState       - Current state
142  *
143  * RETURN:      Status
144  *
145  * DESCRIPTION: Called on method error. Invoke the global exception handler if
146  *              present, dump the method data if the disassembler is configured
147  *
148  *              Note: Allows the exception handler to change the status code
149  *
150  ******************************************************************************/
151 
152 ACPI_STATUS
153 AcpiDsMethodError (
154     ACPI_STATUS             Status,
155     ACPI_WALK_STATE         *WalkState)
156 {
157     ACPI_FUNCTION_ENTRY ();
158 
159 
160     /* Ignore AE_OK and control exception codes */
161 
162     if (ACPI_SUCCESS (Status) ||
163         (Status & AE_CODE_CONTROL))
164     {
165         return (Status);
166     }
167 
168     /* Invoke the global exception handler */
169 
170     if (AcpiGbl_ExceptionHandler)
171     {
172         /* Exit the interpreter, allow handler to execute methods */
173 
174         AcpiExExitInterpreter ();
175 
176         /*
177          * Handler can map the exception code to anything it wants, including
178          * AE_OK, in which case the executing method will not be aborted.
179          */
180         Status = AcpiGbl_ExceptionHandler (Status,
181                     WalkState->MethodNode ?
182                         WalkState->MethodNode->Name.Integer : 0,
183                     WalkState->Opcode, WalkState->AmlOffset, NULL);
184         AcpiExEnterInterpreter ();
185     }
186 
187     AcpiDsClearImplicitReturn (WalkState);
188 
189 #ifdef ACPI_DISASSEMBLER
190     if (ACPI_FAILURE (Status))
191     {
192         /* Display method locals/args if disassembler is present */
193 
194         AcpiDmDumpMethodInfo (Status, WalkState, WalkState->Op);
195     }
196 #endif
197 
198     return (Status);
199 }
200 
201 
202 /*******************************************************************************
203  *
204  * FUNCTION:    AcpiDsCreateMethodMutex
205  *
206  * PARAMETERS:  ObjDesc             - The method object
207  *
208  * RETURN:      Status
209  *
210  * DESCRIPTION: Create a mutex object for a serialized control method
211  *
212  ******************************************************************************/
213 
214 static ACPI_STATUS
215 AcpiDsCreateMethodMutex (
216     ACPI_OPERAND_OBJECT     *MethodDesc)
217 {
218     ACPI_OPERAND_OBJECT     *MutexDesc;
219     ACPI_STATUS             Status;
220 
221 
222     ACPI_FUNCTION_TRACE (DsCreateMethodMutex);
223 
224 
225     /* Create the new mutex object */
226 
227     MutexDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
228     if (!MutexDesc)
229     {
230         return_ACPI_STATUS (AE_NO_MEMORY);
231     }
232 
233     /* Create the actual OS Mutex */
234 
235     Status = AcpiOsCreateMutex (&MutexDesc->Mutex.OsMutex);
236     if (ACPI_FAILURE (Status))
237     {
238         AcpiUtDeleteObjectDesc (MutexDesc);
239         return_ACPI_STATUS (Status);
240     }
241 
242     MutexDesc->Mutex.SyncLevel = MethodDesc->Method.SyncLevel;
243     MethodDesc->Method.Mutex = MutexDesc;
244     return_ACPI_STATUS (AE_OK);
245 }
246 
247 
248 /*******************************************************************************
249  *
250  * FUNCTION:    AcpiDsBeginMethodExecution
251  *
252  * PARAMETERS:  MethodNode          - Node of the method
253  *              ObjDesc             - The method object
254  *              WalkState           - current state, NULL if not yet executing
255  *                                    a method.
256  *
257  * RETURN:      Status
258  *
259  * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
260  *              increments the thread count, and waits at the method semaphore
261  *              for clearance to execute.
262  *
263  ******************************************************************************/
264 
265 ACPI_STATUS
266 AcpiDsBeginMethodExecution (
267     ACPI_NAMESPACE_NODE     *MethodNode,
268     ACPI_OPERAND_OBJECT     *ObjDesc,
269     ACPI_WALK_STATE         *WalkState)
270 {
271     ACPI_STATUS             Status = AE_OK;
272 
273 
274     ACPI_FUNCTION_TRACE_PTR (DsBeginMethodExecution, MethodNode);
275 
276 
277     if (!MethodNode)
278     {
279         return_ACPI_STATUS (AE_NULL_ENTRY);
280     }
281 
282     /* Prevent wraparound of thread count */
283 
284     if (ObjDesc->Method.ThreadCount == ACPI_UINT8_MAX)
285     {
286         ACPI_ERROR ((AE_INFO,
287             "Method reached maximum reentrancy limit (255)"));
288         return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
289     }
290 
291     /*
292      * If this method is serialized, we need to acquire the method mutex.
293      */
294     if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
295     {
296         /*
297          * Create a mutex for the method if it is defined to be Serialized
298          * and a mutex has not already been created. We defer the mutex creation
299          * until a method is actually executed, to minimize the object count
300          */
301         if (!ObjDesc->Method.Mutex)
302         {
303             Status = AcpiDsCreateMethodMutex (ObjDesc);
304             if (ACPI_FAILURE (Status))
305             {
306                 return_ACPI_STATUS (Status);
307             }
308         }
309 
310         /*
311          * The CurrentSyncLevel (per-thread) must be less than or equal to
312          * the sync level of the method. This mechanism provides some
313          * deadlock prevention
314          *
315          * Top-level method invocation has no walk state at this point
316          */
317         if (WalkState &&
318             (WalkState->Thread->CurrentSyncLevel > ObjDesc->Method.Mutex->Mutex.SyncLevel))
319         {
320             ACPI_ERROR ((AE_INFO,
321                 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
322                 AcpiUtGetNodeName (MethodNode),
323                 WalkState->Thread->CurrentSyncLevel));
324 
325             return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
326         }
327 
328         /*
329          * Obtain the method mutex if necessary. Do not acquire mutex for a
330          * recursive call.
331          */
332         if (!WalkState ||
333             !ObjDesc->Method.Mutex->Mutex.ThreadId ||
334             (WalkState->Thread->ThreadId != ObjDesc->Method.Mutex->Mutex.ThreadId))
335         {
336             /*
337              * Acquire the method mutex. This releases the interpreter if we
338              * block (and reacquires it before it returns)
339              */
340             Status = AcpiExSystemWaitMutex (ObjDesc->Method.Mutex->Mutex.OsMutex,
341                         ACPI_WAIT_FOREVER);
342             if (ACPI_FAILURE (Status))
343             {
344                 return_ACPI_STATUS (Status);
345             }
346 
347             /* Update the mutex and walk info and save the original SyncLevel */
348 
349             if (WalkState)
350             {
351                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
352                     WalkState->Thread->CurrentSyncLevel;
353 
354                 ObjDesc->Method.Mutex->Mutex.ThreadId = WalkState->Thread->ThreadId;
355                 WalkState->Thread->CurrentSyncLevel = ObjDesc->Method.SyncLevel;
356             }
357             else
358             {
359                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
360                     ObjDesc->Method.Mutex->Mutex.SyncLevel;
361             }
362         }
363 
364         /* Always increase acquisition depth */
365 
366         ObjDesc->Method.Mutex->Mutex.AcquisitionDepth++;
367     }
368 
369     /*
370      * Allocate an Owner ID for this method, only if this is the first thread
371      * to begin concurrent execution. We only need one OwnerId, even if the
372      * method is invoked recursively.
373      */
374     if (!ObjDesc->Method.OwnerId)
375     {
376         Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId);
377         if (ACPI_FAILURE (Status))
378         {
379             goto Cleanup;
380         }
381     }
382 
383     /*
384      * Increment the method parse tree thread count since it has been
385      * reentered one more time (even if it is the same thread)
386      */
387     ObjDesc->Method.ThreadCount++;
388     AcpiMethodCount++;
389     return_ACPI_STATUS (Status);
390 
391 
392 Cleanup:
393     /* On error, must release the method mutex (if present) */
394 
395     if (ObjDesc->Method.Mutex)
396     {
397         AcpiOsReleaseMutex (ObjDesc->Method.Mutex->Mutex.OsMutex);
398     }
399     return_ACPI_STATUS (Status);
400 }
401 
402 
403 /*******************************************************************************
404  *
405  * FUNCTION:    AcpiDsCallControlMethod
406  *
407  * PARAMETERS:  Thread              - Info for this thread
408  *              ThisWalkState       - Current walk state
409  *              Op                  - Current Op to be walked
410  *
411  * RETURN:      Status
412  *
413  * DESCRIPTION: Transfer execution to a called control method
414  *
415  ******************************************************************************/
416 
417 ACPI_STATUS
418 AcpiDsCallControlMethod (
419     ACPI_THREAD_STATE       *Thread,
420     ACPI_WALK_STATE         *ThisWalkState,
421     ACPI_PARSE_OBJECT       *Op)
422 {
423     ACPI_STATUS             Status;
424     ACPI_NAMESPACE_NODE     *MethodNode;
425     ACPI_WALK_STATE         *NextWalkState = NULL;
426     ACPI_OPERAND_OBJECT     *ObjDesc;
427     ACPI_EVALUATE_INFO      *Info;
428     UINT32                  i;
429 
430 
431     ACPI_FUNCTION_TRACE_PTR (DsCallControlMethod, ThisWalkState);
432 
433     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Calling method %p, currentstate=%p\n",
434         ThisWalkState->PrevOp, ThisWalkState));
435 
436     /*
437      * Get the namespace entry for the control method we are about to call
438      */
439     MethodNode = ThisWalkState->MethodCallNode;
440     if (!MethodNode)
441     {
442         return_ACPI_STATUS (AE_NULL_ENTRY);
443     }
444 
445     ObjDesc = AcpiNsGetAttachedObject (MethodNode);
446     if (!ObjDesc)
447     {
448         return_ACPI_STATUS (AE_NULL_OBJECT);
449     }
450 
451     /* Init for new method, possibly wait on method mutex */
452 
453     Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
454                 ThisWalkState);
455     if (ACPI_FAILURE (Status))
456     {
457         return_ACPI_STATUS (Status);
458     }
459 
460     /* Begin method parse/execution. Create a new walk state */
461 
462     NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwnerId,
463                         NULL, ObjDesc, Thread);
464     if (!NextWalkState)
465     {
466         Status = AE_NO_MEMORY;
467         goto Cleanup;
468     }
469 
470     /*
471      * The resolved arguments were put on the previous walk state's operand
472      * stack. Operands on the previous walk state stack always
473      * start at index 0. Also, null terminate the list of arguments
474      */
475     ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
476 
477     /*
478      * Allocate and initialize the evaluation information block
479      * TBD: this is somewhat inefficient, should change interface to
480      * DsInitAmlWalk. For now, keeps this struct off the CPU stack
481      */
482     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
483     if (!Info)
484     {
485         Status = AE_NO_MEMORY;
486         goto Cleanup;
487     }
488 
489     Info->Parameters = &ThisWalkState->Operands[0];
490 
491     Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
492                 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
493                 Info, ACPI_IMODE_EXECUTE);
494 
495     ACPI_FREE (Info);
496     if (ACPI_FAILURE (Status))
497     {
498         goto Cleanup;
499     }
500 
501     /*
502      * Delete the operands on the previous walkstate operand stack
503      * (they were copied to new objects)
504      */
505     for (i = 0; i < ObjDesc->Method.ParamCount; i++)
506     {
507         AcpiUtRemoveReference (ThisWalkState->Operands [i]);
508         ThisWalkState->Operands [i] = NULL;
509     }
510 
511     /* Clear the operand stack */
512 
513     ThisWalkState->NumOperands = 0;
514 
515     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
516         "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
517         MethodNode->Name.Ascii, NextWalkState));
518 
519     /* Invoke an internal method if necessary */
520 
521     if (ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
522     {
523         Status = ObjDesc->Method.Dispatch.Implementation (NextWalkState);
524         if (Status == AE_OK)
525         {
526             Status = AE_CTRL_TERMINATE;
527         }
528     }
529 
530     return_ACPI_STATUS (Status);
531 
532 
533 Cleanup:
534 
535     /* On error, we must terminate the method properly */
536 
537     AcpiDsTerminateControlMethod (ObjDesc, NextWalkState);
538     if (NextWalkState)
539     {
540         AcpiDsDeleteWalkState (NextWalkState);
541     }
542 
543     return_ACPI_STATUS (Status);
544 }
545 
546 
547 /*******************************************************************************
548  *
549  * FUNCTION:    AcpiDsRestartControlMethod
550  *
551  * PARAMETERS:  WalkState           - State for preempted method (caller)
552  *              ReturnDesc          - Return value from the called method
553  *
554  * RETURN:      Status
555  *
556  * DESCRIPTION: Restart a method that was preempted by another (nested) method
557  *              invocation. Handle the return value (if any) from the callee.
558  *
559  ******************************************************************************/
560 
561 ACPI_STATUS
562 AcpiDsRestartControlMethod (
563     ACPI_WALK_STATE         *WalkState,
564     ACPI_OPERAND_OBJECT     *ReturnDesc)
565 {
566     ACPI_STATUS             Status;
567     int                     SameAsImplicitReturn;
568 
569 
570     ACPI_FUNCTION_TRACE_PTR (DsRestartControlMethod, WalkState);
571 
572 
573     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
574         "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
575         AcpiUtGetNodeName (WalkState->MethodNode),
576         WalkState->MethodCallOp, ReturnDesc));
577 
578     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
579         "    ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
580         WalkState->ReturnUsed,
581         WalkState->Results, WalkState));
582 
583     /* Did the called method return a value? */
584 
585     if (ReturnDesc)
586     {
587         /* Is the implicit return object the same as the return desc? */
588 
589         SameAsImplicitReturn = (WalkState->ImplicitReturnObj == ReturnDesc);
590 
591         /* Are we actually going to use the return value? */
592 
593         if (WalkState->ReturnUsed)
594         {
595             /* Save the return value from the previous method */
596 
597             Status = AcpiDsResultPush (ReturnDesc, WalkState);
598             if (ACPI_FAILURE (Status))
599             {
600                 AcpiUtRemoveReference (ReturnDesc);
601                 return_ACPI_STATUS (Status);
602             }
603 
604             /*
605              * Save as THIS method's return value in case it is returned
606              * immediately to yet another method
607              */
608             WalkState->ReturnDesc = ReturnDesc;
609         }
610 
611         /*
612          * The following code is the optional support for the so-called
613          * "implicit return". Some AML code assumes that the last value of the
614          * method is "implicitly" returned to the caller, in the absence of an
615          * explicit return value.
616          *
617          * Just save the last result of the method as the return value.
618          *
619          * NOTE: this is optional because the ASL language does not actually
620          * support this behavior.
621          */
622         else if (!AcpiDsDoImplicitReturn (ReturnDesc, WalkState, FALSE) ||
623                  SameAsImplicitReturn)
624         {
625             /*
626              * Delete the return value if it will not be used by the
627              * calling method or remove one reference if the explicit return
628              * is the same as the implicit return value.
629              */
630             AcpiUtRemoveReference (ReturnDesc);
631         }
632     }
633 
634     return_ACPI_STATUS (AE_OK);
635 }
636 
637 
638 /*******************************************************************************
639  *
640  * FUNCTION:    AcpiDsTerminateControlMethod
641  *
642  * PARAMETERS:  MethodDesc          - Method object
643  *              WalkState           - State associated with the method
644  *
645  * RETURN:      None
646  *
647  * DESCRIPTION: Terminate a control method. Delete everything that the method
648  *              created, delete all locals and arguments, and delete the parse
649  *              tree if requested.
650  *
651  * MUTEX:       Interpreter is locked
652  *
653  ******************************************************************************/
654 
655 void
656 AcpiDsTerminateControlMethod (
657     ACPI_OPERAND_OBJECT     *MethodDesc,
658     ACPI_WALK_STATE         *WalkState)
659 {
660 
661     ACPI_FUNCTION_TRACE_PTR (DsTerminateControlMethod, WalkState);
662 
663 
664     /* MethodDesc is required, WalkState is optional */
665 
666     if (!MethodDesc)
667     {
668         return_VOID;
669     }
670 
671     if (WalkState)
672     {
673         /* Delete all arguments and locals */
674 
675         AcpiDsMethodDataDeleteAll (WalkState);
676 
677         /*
678          * If method is serialized, release the mutex and restore the
679          * current sync level for this thread
680          */
681         if (MethodDesc->Method.Mutex)
682         {
683             /* Acquisition Depth handles recursive calls */
684 
685             MethodDesc->Method.Mutex->Mutex.AcquisitionDepth--;
686             if (!MethodDesc->Method.Mutex->Mutex.AcquisitionDepth)
687             {
688                 WalkState->Thread->CurrentSyncLevel =
689                     MethodDesc->Method.Mutex->Mutex.OriginalSyncLevel;
690 
691                 AcpiOsReleaseMutex (MethodDesc->Method.Mutex->Mutex.OsMutex);
692                 MethodDesc->Method.Mutex->Mutex.ThreadId = 0;
693             }
694         }
695 
696         /*
697          * Delete any namespace objects created anywhere within the
698          * namespace by the execution of this method. Unless:
699          * 1) This method is a module-level executable code method, in which
700          *    case we want make the objects permanent.
701          * 2) There are other threads executing the method, in which case we
702          *    will wait until the last thread has completed.
703          */
704         if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL) &&
705              (MethodDesc->Method.ThreadCount == 1))
706         {
707             /* Delete any direct children of (created by) this method */
708 
709             AcpiNsDeleteNamespaceSubtree (WalkState->MethodNode);
710 
711             /*
712              * Delete any objects that were created by this method
713              * elsewhere in the namespace (if any were created).
714              * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
715              * deletion such that we don't have to perform an entire
716              * namespace walk for every control method execution.
717              */
718             if (MethodDesc->Method.InfoFlags & ACPI_METHOD_MODIFIED_NAMESPACE)
719             {
720                 AcpiNsDeleteNamespaceByOwner (MethodDesc->Method.OwnerId);
721                 MethodDesc->Method.InfoFlags &= ~ACPI_METHOD_MODIFIED_NAMESPACE;
722             }
723         }
724     }
725 
726     /* Decrement the thread count on the method */
727 
728     if (MethodDesc->Method.ThreadCount)
729     {
730         MethodDesc->Method.ThreadCount--;
731     }
732     else
733     {
734         ACPI_ERROR ((AE_INFO,
735             "Invalid zero thread count in method"));
736     }
737 
738     /* Are there any other threads currently executing this method? */
739 
740     if (MethodDesc->Method.ThreadCount)
741     {
742         /*
743          * Additional threads. Do not release the OwnerId in this case,
744          * we immediately reuse it for the next thread executing this method
745          */
746         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
747             "*** Completed execution of one thread, %u threads remaining\n",
748             MethodDesc->Method.ThreadCount));
749     }
750     else
751     {
752         /* This is the only executing thread for this method */
753 
754         /*
755          * Support to dynamically change a method from NotSerialized to
756          * Serialized if it appears that the method is incorrectly written and
757          * does not support multiple thread execution. The best example of this
758          * is if such a method creates namespace objects and blocks. A second
759          * thread will fail with an AE_ALREADY_EXISTS exception.
760          *
761          * This code is here because we must wait until the last thread exits
762          * before marking the method as serialized.
763          */
764         if (MethodDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED_PENDING)
765         {
766             if (WalkState)
767             {
768                 ACPI_INFO ((AE_INFO,
769                     "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
770                     WalkState->MethodNode->Name.Ascii));
771             }
772 
773             /*
774              * Method tried to create an object twice and was marked as
775              * "pending serialized". The probable cause is that the method
776              * cannot handle reentrancy.
777              *
778              * The method was created as NotSerialized, but it tried to create
779              * a named object and then blocked, causing the second thread
780              * entrance to begin and then fail. Workaround this problem by
781              * marking the method permanently as Serialized when the last
782              * thread exits here.
783              */
784             MethodDesc->Method.InfoFlags &= ~ACPI_METHOD_SERIALIZED_PENDING;
785             MethodDesc->Method.InfoFlags |= ACPI_METHOD_SERIALIZED;
786             MethodDesc->Method.SyncLevel = 0;
787         }
788 
789         /* No more threads, we can free the OwnerId */
790 
791         if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL))
792         {
793             AcpiUtReleaseOwnerId (&MethodDesc->Method.OwnerId);
794         }
795     }
796 
797     return_VOID;
798 }
799