xref: /onnv-gate/usr/src/uts/intel/io/acpica/dispatcher/dsmethod.c (revision 7851:e828bbb1689c)
1*7851SDana.Myers@Sun.COM /******************************************************************************
2*7851SDana.Myers@Sun.COM  *
3*7851SDana.Myers@Sun.COM  * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4*7851SDana.Myers@Sun.COM  *              $Revision: 1.140 $
5*7851SDana.Myers@Sun.COM  *
6*7851SDana.Myers@Sun.COM  *****************************************************************************/
7*7851SDana.Myers@Sun.COM 
8*7851SDana.Myers@Sun.COM /******************************************************************************
9*7851SDana.Myers@Sun.COM  *
10*7851SDana.Myers@Sun.COM  * 1. Copyright Notice
11*7851SDana.Myers@Sun.COM  *
12*7851SDana.Myers@Sun.COM  * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp.
13*7851SDana.Myers@Sun.COM  * All rights reserved.
14*7851SDana.Myers@Sun.COM  *
15*7851SDana.Myers@Sun.COM  * 2. License
16*7851SDana.Myers@Sun.COM  *
17*7851SDana.Myers@Sun.COM  * 2.1. This is your license from Intel Corp. under its intellectual property
18*7851SDana.Myers@Sun.COM  * rights.  You may have additional license terms from the party that provided
19*7851SDana.Myers@Sun.COM  * you this software, covering your right to use that party's intellectual
20*7851SDana.Myers@Sun.COM  * property rights.
21*7851SDana.Myers@Sun.COM  *
22*7851SDana.Myers@Sun.COM  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23*7851SDana.Myers@Sun.COM  * copy of the source code appearing in this file ("Covered Code") an
24*7851SDana.Myers@Sun.COM  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25*7851SDana.Myers@Sun.COM  * base code distributed originally by Intel ("Original Intel Code") to copy,
26*7851SDana.Myers@Sun.COM  * make derivatives, distribute, use and display any portion of the Covered
27*7851SDana.Myers@Sun.COM  * Code in any form, with the right to sublicense such rights; and
28*7851SDana.Myers@Sun.COM  *
29*7851SDana.Myers@Sun.COM  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30*7851SDana.Myers@Sun.COM  * license (with the right to sublicense), under only those claims of Intel
31*7851SDana.Myers@Sun.COM  * patents that are infringed by the Original Intel Code, to make, use, sell,
32*7851SDana.Myers@Sun.COM  * offer to sell, and import the Covered Code and derivative works thereof
33*7851SDana.Myers@Sun.COM  * solely to the minimum extent necessary to exercise the above copyright
34*7851SDana.Myers@Sun.COM  * license, and in no event shall the patent license extend to any additions
35*7851SDana.Myers@Sun.COM  * to or modifications of the Original Intel Code.  No other license or right
36*7851SDana.Myers@Sun.COM  * is granted directly or by implication, estoppel or otherwise;
37*7851SDana.Myers@Sun.COM  *
38*7851SDana.Myers@Sun.COM  * The above copyright and patent license is granted only if the following
39*7851SDana.Myers@Sun.COM  * conditions are met:
40*7851SDana.Myers@Sun.COM  *
41*7851SDana.Myers@Sun.COM  * 3. Conditions
42*7851SDana.Myers@Sun.COM  *
43*7851SDana.Myers@Sun.COM  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44*7851SDana.Myers@Sun.COM  * Redistribution of source code of any substantial portion of the Covered
45*7851SDana.Myers@Sun.COM  * Code or modification with rights to further distribute source must include
46*7851SDana.Myers@Sun.COM  * the above Copyright Notice, the above License, this list of Conditions,
47*7851SDana.Myers@Sun.COM  * and the following Disclaimer and Export Compliance provision.  In addition,
48*7851SDana.Myers@Sun.COM  * Licensee must cause all Covered Code to which Licensee contributes to
49*7851SDana.Myers@Sun.COM  * contain a file documenting the changes Licensee made to create that Covered
50*7851SDana.Myers@Sun.COM  * Code and the date of any change.  Licensee must include in that file the
51*7851SDana.Myers@Sun.COM  * documentation of any changes made by any predecessor Licensee.  Licensee
52*7851SDana.Myers@Sun.COM  * must include a prominent statement that the modification is derived,
53*7851SDana.Myers@Sun.COM  * directly or indirectly, from Original Intel Code.
54*7851SDana.Myers@Sun.COM  *
55*7851SDana.Myers@Sun.COM  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56*7851SDana.Myers@Sun.COM  * Redistribution of source code of any substantial portion of the Covered
57*7851SDana.Myers@Sun.COM  * Code or modification without rights to further distribute source must
58*7851SDana.Myers@Sun.COM  * include the following Disclaimer and Export Compliance provision in the
59*7851SDana.Myers@Sun.COM  * documentation and/or other materials provided with distribution.  In
60*7851SDana.Myers@Sun.COM  * addition, Licensee may not authorize further sublicense of source of any
61*7851SDana.Myers@Sun.COM  * portion of the Covered Code, and must include terms to the effect that the
62*7851SDana.Myers@Sun.COM  * license from Licensee to its licensee is limited to the intellectual
63*7851SDana.Myers@Sun.COM  * property embodied in the software Licensee provides to its licensee, and
64*7851SDana.Myers@Sun.COM  * not to intellectual property embodied in modifications its licensee may
65*7851SDana.Myers@Sun.COM  * make.
66*7851SDana.Myers@Sun.COM  *
67*7851SDana.Myers@Sun.COM  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68*7851SDana.Myers@Sun.COM  * substantial portion of the Covered Code or modification must reproduce the
69*7851SDana.Myers@Sun.COM  * above Copyright Notice, and the following Disclaimer and Export Compliance
70*7851SDana.Myers@Sun.COM  * provision in the documentation and/or other materials provided with the
71*7851SDana.Myers@Sun.COM  * distribution.
72*7851SDana.Myers@Sun.COM  *
73*7851SDana.Myers@Sun.COM  * 3.4. Intel retains all right, title, and interest in and to the Original
74*7851SDana.Myers@Sun.COM  * Intel Code.
75*7851SDana.Myers@Sun.COM  *
76*7851SDana.Myers@Sun.COM  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77*7851SDana.Myers@Sun.COM  * Intel shall be used in advertising or otherwise to promote the sale, use or
78*7851SDana.Myers@Sun.COM  * other dealings in products derived from or relating to the Covered Code
79*7851SDana.Myers@Sun.COM  * without prior written authorization from Intel.
80*7851SDana.Myers@Sun.COM  *
81*7851SDana.Myers@Sun.COM  * 4. Disclaimer and Export Compliance
82*7851SDana.Myers@Sun.COM  *
83*7851SDana.Myers@Sun.COM  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84*7851SDana.Myers@Sun.COM  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85*7851SDana.Myers@Sun.COM  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86*7851SDana.Myers@Sun.COM  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87*7851SDana.Myers@Sun.COM  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88*7851SDana.Myers@Sun.COM  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89*7851SDana.Myers@Sun.COM  * PARTICULAR PURPOSE.
90*7851SDana.Myers@Sun.COM  *
91*7851SDana.Myers@Sun.COM  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92*7851SDana.Myers@Sun.COM  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93*7851SDana.Myers@Sun.COM  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94*7851SDana.Myers@Sun.COM  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95*7851SDana.Myers@Sun.COM  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96*7851SDana.Myers@Sun.COM  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97*7851SDana.Myers@Sun.COM  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98*7851SDana.Myers@Sun.COM  * LIMITED REMEDY.
99*7851SDana.Myers@Sun.COM  *
100*7851SDana.Myers@Sun.COM  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101*7851SDana.Myers@Sun.COM  * software or system incorporating such software without first obtaining any
102*7851SDana.Myers@Sun.COM  * required license or other approval from the U. S. Department of Commerce or
103*7851SDana.Myers@Sun.COM  * any other agency or department of the United States Government.  In the
104*7851SDana.Myers@Sun.COM  * event Licensee exports any such software from the United States or
105*7851SDana.Myers@Sun.COM  * re-exports any such software from a foreign destination, Licensee shall
106*7851SDana.Myers@Sun.COM  * ensure that the distribution and export/re-export of the software is in
107*7851SDana.Myers@Sun.COM  * compliance with all laws, regulations, orders, or other restrictions of the
108*7851SDana.Myers@Sun.COM  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109*7851SDana.Myers@Sun.COM  * any of its subsidiaries will export/re-export any technical data, process,
110*7851SDana.Myers@Sun.COM  * software, or service, directly or indirectly, to any country for which the
111*7851SDana.Myers@Sun.COM  * United States government or any agency thereof requires an export license,
112*7851SDana.Myers@Sun.COM  * other governmental approval, or letter of assurance, without first obtaining
113*7851SDana.Myers@Sun.COM  * such license, approval or letter.
114*7851SDana.Myers@Sun.COM  *
115*7851SDana.Myers@Sun.COM  *****************************************************************************/
116*7851SDana.Myers@Sun.COM 
117*7851SDana.Myers@Sun.COM #define __DSMETHOD_C__
118*7851SDana.Myers@Sun.COM 
119*7851SDana.Myers@Sun.COM #include "acpi.h"
120*7851SDana.Myers@Sun.COM #include "amlcode.h"
121*7851SDana.Myers@Sun.COM #include "acdispat.h"
122*7851SDana.Myers@Sun.COM #include "acinterp.h"
123*7851SDana.Myers@Sun.COM #include "acnamesp.h"
124*7851SDana.Myers@Sun.COM #include "acdisasm.h"
125*7851SDana.Myers@Sun.COM 
126*7851SDana.Myers@Sun.COM 
127*7851SDana.Myers@Sun.COM #define _COMPONENT          ACPI_DISPATCHER
128*7851SDana.Myers@Sun.COM         ACPI_MODULE_NAME    ("dsmethod")
129*7851SDana.Myers@Sun.COM 
130*7851SDana.Myers@Sun.COM /* Local prototypes */
131*7851SDana.Myers@Sun.COM 
132*7851SDana.Myers@Sun.COM static ACPI_STATUS
133*7851SDana.Myers@Sun.COM AcpiDsCreateMethodMutex (
134*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *MethodDesc);
135*7851SDana.Myers@Sun.COM 
136*7851SDana.Myers@Sun.COM 
137*7851SDana.Myers@Sun.COM /*******************************************************************************
138*7851SDana.Myers@Sun.COM  *
139*7851SDana.Myers@Sun.COM  * FUNCTION:    AcpiDsMethodError
140*7851SDana.Myers@Sun.COM  *
141*7851SDana.Myers@Sun.COM  * PARAMETERS:  Status          - Execution status
142*7851SDana.Myers@Sun.COM  *              WalkState       - Current state
143*7851SDana.Myers@Sun.COM  *
144*7851SDana.Myers@Sun.COM  * RETURN:      Status
145*7851SDana.Myers@Sun.COM  *
146*7851SDana.Myers@Sun.COM  * DESCRIPTION: Called on method error. Invoke the global exception handler if
147*7851SDana.Myers@Sun.COM  *              present, dump the method data if the disassembler is configured
148*7851SDana.Myers@Sun.COM  *
149*7851SDana.Myers@Sun.COM  *              Note: Allows the exception handler to change the status code
150*7851SDana.Myers@Sun.COM  *
151*7851SDana.Myers@Sun.COM  ******************************************************************************/
152*7851SDana.Myers@Sun.COM 
153*7851SDana.Myers@Sun.COM ACPI_STATUS
154*7851SDana.Myers@Sun.COM AcpiDsMethodError (
155*7851SDana.Myers@Sun.COM     ACPI_STATUS             Status,
156*7851SDana.Myers@Sun.COM     ACPI_WALK_STATE         *WalkState)
157*7851SDana.Myers@Sun.COM {
158*7851SDana.Myers@Sun.COM     ACPI_FUNCTION_ENTRY ();
159*7851SDana.Myers@Sun.COM 
160*7851SDana.Myers@Sun.COM 
161*7851SDana.Myers@Sun.COM     /* Ignore AE_OK and control exception codes */
162*7851SDana.Myers@Sun.COM 
163*7851SDana.Myers@Sun.COM     if (ACPI_SUCCESS (Status) ||
164*7851SDana.Myers@Sun.COM         (Status & AE_CODE_CONTROL))
165*7851SDana.Myers@Sun.COM     {
166*7851SDana.Myers@Sun.COM         return (Status);
167*7851SDana.Myers@Sun.COM     }
168*7851SDana.Myers@Sun.COM 
169*7851SDana.Myers@Sun.COM     /* Invoke the global exception handler */
170*7851SDana.Myers@Sun.COM 
171*7851SDana.Myers@Sun.COM     if (AcpiGbl_ExceptionHandler)
172*7851SDana.Myers@Sun.COM     {
173*7851SDana.Myers@Sun.COM         /* Exit the interpreter, allow handler to execute methods */
174*7851SDana.Myers@Sun.COM 
175*7851SDana.Myers@Sun.COM         AcpiExExitInterpreter ();
176*7851SDana.Myers@Sun.COM 
177*7851SDana.Myers@Sun.COM         /*
178*7851SDana.Myers@Sun.COM          * Handler can map the exception code to anything it wants, including
179*7851SDana.Myers@Sun.COM          * AE_OK, in which case the executing method will not be aborted.
180*7851SDana.Myers@Sun.COM          */
181*7851SDana.Myers@Sun.COM         Status = AcpiGbl_ExceptionHandler (Status,
182*7851SDana.Myers@Sun.COM                     WalkState->MethodNode ?
183*7851SDana.Myers@Sun.COM                         WalkState->MethodNode->Name.Integer : 0,
184*7851SDana.Myers@Sun.COM                     WalkState->Opcode, WalkState->AmlOffset, NULL);
185*7851SDana.Myers@Sun.COM         AcpiExEnterInterpreter ();
186*7851SDana.Myers@Sun.COM     }
187*7851SDana.Myers@Sun.COM 
188*7851SDana.Myers@Sun.COM     AcpiDsClearImplicitReturn (WalkState);
189*7851SDana.Myers@Sun.COM 
190*7851SDana.Myers@Sun.COM #ifdef ACPI_DISASSEMBLER
191*7851SDana.Myers@Sun.COM     if (ACPI_FAILURE (Status))
192*7851SDana.Myers@Sun.COM     {
193*7851SDana.Myers@Sun.COM         /* Display method locals/args if disassembler is present */
194*7851SDana.Myers@Sun.COM 
195*7851SDana.Myers@Sun.COM         AcpiDmDumpMethodInfo (Status, WalkState, WalkState->Op);
196*7851SDana.Myers@Sun.COM     }
197*7851SDana.Myers@Sun.COM #endif
198*7851SDana.Myers@Sun.COM 
199*7851SDana.Myers@Sun.COM     return (Status);
200*7851SDana.Myers@Sun.COM }
201*7851SDana.Myers@Sun.COM 
202*7851SDana.Myers@Sun.COM 
203*7851SDana.Myers@Sun.COM /*******************************************************************************
204*7851SDana.Myers@Sun.COM  *
205*7851SDana.Myers@Sun.COM  * FUNCTION:    AcpiDsCreateMethodMutex
206*7851SDana.Myers@Sun.COM  *
207*7851SDana.Myers@Sun.COM  * PARAMETERS:  ObjDesc             - The method object
208*7851SDana.Myers@Sun.COM  *
209*7851SDana.Myers@Sun.COM  * RETURN:      Status
210*7851SDana.Myers@Sun.COM  *
211*7851SDana.Myers@Sun.COM  * DESCRIPTION: Create a mutex object for a serialized control method
212*7851SDana.Myers@Sun.COM  *
213*7851SDana.Myers@Sun.COM  ******************************************************************************/
214*7851SDana.Myers@Sun.COM 
215*7851SDana.Myers@Sun.COM static ACPI_STATUS
216*7851SDana.Myers@Sun.COM AcpiDsCreateMethodMutex (
217*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *MethodDesc)
218*7851SDana.Myers@Sun.COM {
219*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *MutexDesc;
220*7851SDana.Myers@Sun.COM     ACPI_STATUS             Status;
221*7851SDana.Myers@Sun.COM 
222*7851SDana.Myers@Sun.COM 
223*7851SDana.Myers@Sun.COM     ACPI_FUNCTION_TRACE (DsCreateMethodMutex);
224*7851SDana.Myers@Sun.COM 
225*7851SDana.Myers@Sun.COM 
226*7851SDana.Myers@Sun.COM     /* Create the new mutex object */
227*7851SDana.Myers@Sun.COM 
228*7851SDana.Myers@Sun.COM     MutexDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
229*7851SDana.Myers@Sun.COM     if (!MutexDesc)
230*7851SDana.Myers@Sun.COM     {
231*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (AE_NO_MEMORY);
232*7851SDana.Myers@Sun.COM     }
233*7851SDana.Myers@Sun.COM 
234*7851SDana.Myers@Sun.COM     /* Create the actual OS Mutex */
235*7851SDana.Myers@Sun.COM 
236*7851SDana.Myers@Sun.COM     Status = AcpiOsCreateMutex (&MutexDesc->Mutex.OsMutex);
237*7851SDana.Myers@Sun.COM     if (ACPI_FAILURE (Status))
238*7851SDana.Myers@Sun.COM     {
239*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (Status);
240*7851SDana.Myers@Sun.COM     }
241*7851SDana.Myers@Sun.COM 
242*7851SDana.Myers@Sun.COM     MutexDesc->Mutex.SyncLevel = MethodDesc->Method.SyncLevel;
243*7851SDana.Myers@Sun.COM     MethodDesc->Method.Mutex = MutexDesc;
244*7851SDana.Myers@Sun.COM     return_ACPI_STATUS (AE_OK);
245*7851SDana.Myers@Sun.COM }
246*7851SDana.Myers@Sun.COM 
247*7851SDana.Myers@Sun.COM 
248*7851SDana.Myers@Sun.COM /*******************************************************************************
249*7851SDana.Myers@Sun.COM  *
250*7851SDana.Myers@Sun.COM  * FUNCTION:    AcpiDsBeginMethodExecution
251*7851SDana.Myers@Sun.COM  *
252*7851SDana.Myers@Sun.COM  * PARAMETERS:  MethodNode          - Node of the method
253*7851SDana.Myers@Sun.COM  *              ObjDesc             - The method object
254*7851SDana.Myers@Sun.COM  *              WalkState           - current state, NULL if not yet executing
255*7851SDana.Myers@Sun.COM  *                                    a method.
256*7851SDana.Myers@Sun.COM  *
257*7851SDana.Myers@Sun.COM  * RETURN:      Status
258*7851SDana.Myers@Sun.COM  *
259*7851SDana.Myers@Sun.COM  * DESCRIPTION: Prepare a method for execution.  Parses the method if necessary,
260*7851SDana.Myers@Sun.COM  *              increments the thread count, and waits at the method semaphore
261*7851SDana.Myers@Sun.COM  *              for clearance to execute.
262*7851SDana.Myers@Sun.COM  *
263*7851SDana.Myers@Sun.COM  ******************************************************************************/
264*7851SDana.Myers@Sun.COM 
265*7851SDana.Myers@Sun.COM ACPI_STATUS
266*7851SDana.Myers@Sun.COM AcpiDsBeginMethodExecution (
267*7851SDana.Myers@Sun.COM     ACPI_NAMESPACE_NODE     *MethodNode,
268*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *ObjDesc,
269*7851SDana.Myers@Sun.COM     ACPI_WALK_STATE         *WalkState)
270*7851SDana.Myers@Sun.COM {
271*7851SDana.Myers@Sun.COM     ACPI_STATUS             Status = AE_OK;
272*7851SDana.Myers@Sun.COM 
273*7851SDana.Myers@Sun.COM 
274*7851SDana.Myers@Sun.COM     ACPI_FUNCTION_TRACE_PTR (DsBeginMethodExecution, MethodNode);
275*7851SDana.Myers@Sun.COM 
276*7851SDana.Myers@Sun.COM 
277*7851SDana.Myers@Sun.COM     if (!MethodNode)
278*7851SDana.Myers@Sun.COM     {
279*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (AE_NULL_ENTRY);
280*7851SDana.Myers@Sun.COM     }
281*7851SDana.Myers@Sun.COM 
282*7851SDana.Myers@Sun.COM     /* Prevent wraparound of thread count */
283*7851SDana.Myers@Sun.COM 
284*7851SDana.Myers@Sun.COM     if (ObjDesc->Method.ThreadCount == ACPI_UINT8_MAX)
285*7851SDana.Myers@Sun.COM     {
286*7851SDana.Myers@Sun.COM         ACPI_ERROR ((AE_INFO,
287*7851SDana.Myers@Sun.COM             "Method reached maximum reentrancy limit (255)"));
288*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
289*7851SDana.Myers@Sun.COM     }
290*7851SDana.Myers@Sun.COM 
291*7851SDana.Myers@Sun.COM     /*
292*7851SDana.Myers@Sun.COM      * If this method is serialized, we need to acquire the method mutex.
293*7851SDana.Myers@Sun.COM      */
294*7851SDana.Myers@Sun.COM     if (ObjDesc->Method.MethodFlags & AML_METHOD_SERIALIZED)
295*7851SDana.Myers@Sun.COM     {
296*7851SDana.Myers@Sun.COM         /*
297*7851SDana.Myers@Sun.COM          * Create a mutex for the method if it is defined to be Serialized
298*7851SDana.Myers@Sun.COM          * and a mutex has not already been created. We defer the mutex creation
299*7851SDana.Myers@Sun.COM          * until a method is actually executed, to minimize the object count
300*7851SDana.Myers@Sun.COM          */
301*7851SDana.Myers@Sun.COM         if (!ObjDesc->Method.Mutex)
302*7851SDana.Myers@Sun.COM         {
303*7851SDana.Myers@Sun.COM             Status = AcpiDsCreateMethodMutex (ObjDesc);
304*7851SDana.Myers@Sun.COM             if (ACPI_FAILURE (Status))
305*7851SDana.Myers@Sun.COM             {
306*7851SDana.Myers@Sun.COM                 return_ACPI_STATUS (Status);
307*7851SDana.Myers@Sun.COM             }
308*7851SDana.Myers@Sun.COM         }
309*7851SDana.Myers@Sun.COM 
310*7851SDana.Myers@Sun.COM         /*
311*7851SDana.Myers@Sun.COM          * The CurrentSyncLevel (per-thread) must be less than or equal to
312*7851SDana.Myers@Sun.COM          * the sync level of the method. This mechanism provides some
313*7851SDana.Myers@Sun.COM          * deadlock prevention
314*7851SDana.Myers@Sun.COM          *
315*7851SDana.Myers@Sun.COM          * Top-level method invocation has no walk state at this point
316*7851SDana.Myers@Sun.COM          */
317*7851SDana.Myers@Sun.COM         if (WalkState &&
318*7851SDana.Myers@Sun.COM             (WalkState->Thread->CurrentSyncLevel > ObjDesc->Method.Mutex->Mutex.SyncLevel))
319*7851SDana.Myers@Sun.COM         {
320*7851SDana.Myers@Sun.COM             ACPI_ERROR ((AE_INFO,
321*7851SDana.Myers@Sun.COM                 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%d)",
322*7851SDana.Myers@Sun.COM                 AcpiUtGetNodeName (MethodNode),
323*7851SDana.Myers@Sun.COM                 WalkState->Thread->CurrentSyncLevel));
324*7851SDana.Myers@Sun.COM 
325*7851SDana.Myers@Sun.COM             return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
326*7851SDana.Myers@Sun.COM         }
327*7851SDana.Myers@Sun.COM 
328*7851SDana.Myers@Sun.COM         /*
329*7851SDana.Myers@Sun.COM          * Obtain the method mutex if necessary. Do not acquire mutex for a
330*7851SDana.Myers@Sun.COM          * recursive call.
331*7851SDana.Myers@Sun.COM          */
332*7851SDana.Myers@Sun.COM         if (!WalkState ||
333*7851SDana.Myers@Sun.COM             !ObjDesc->Method.Mutex->Mutex.ThreadId ||
334*7851SDana.Myers@Sun.COM             (WalkState->Thread->ThreadId != ObjDesc->Method.Mutex->Mutex.ThreadId))
335*7851SDana.Myers@Sun.COM         {
336*7851SDana.Myers@Sun.COM             /*
337*7851SDana.Myers@Sun.COM              * Acquire the method mutex. This releases the interpreter if we
338*7851SDana.Myers@Sun.COM              * block (and reacquires it before it returns)
339*7851SDana.Myers@Sun.COM              */
340*7851SDana.Myers@Sun.COM             Status = AcpiExSystemWaitMutex (ObjDesc->Method.Mutex->Mutex.OsMutex,
341*7851SDana.Myers@Sun.COM                         ACPI_WAIT_FOREVER);
342*7851SDana.Myers@Sun.COM             if (ACPI_FAILURE (Status))
343*7851SDana.Myers@Sun.COM             {
344*7851SDana.Myers@Sun.COM                 return_ACPI_STATUS (Status);
345*7851SDana.Myers@Sun.COM             }
346*7851SDana.Myers@Sun.COM 
347*7851SDana.Myers@Sun.COM             /* Update the mutex and walk info and save the original SyncLevel */
348*7851SDana.Myers@Sun.COM 
349*7851SDana.Myers@Sun.COM             if (WalkState)
350*7851SDana.Myers@Sun.COM             {
351*7851SDana.Myers@Sun.COM                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
352*7851SDana.Myers@Sun.COM                     WalkState->Thread->CurrentSyncLevel;
353*7851SDana.Myers@Sun.COM 
354*7851SDana.Myers@Sun.COM                 ObjDesc->Method.Mutex->Mutex.ThreadId = WalkState->Thread->ThreadId;
355*7851SDana.Myers@Sun.COM                 WalkState->Thread->CurrentSyncLevel = ObjDesc->Method.SyncLevel;
356*7851SDana.Myers@Sun.COM             }
357*7851SDana.Myers@Sun.COM             else
358*7851SDana.Myers@Sun.COM             {
359*7851SDana.Myers@Sun.COM                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
360*7851SDana.Myers@Sun.COM                     ObjDesc->Method.Mutex->Mutex.SyncLevel;
361*7851SDana.Myers@Sun.COM             }
362*7851SDana.Myers@Sun.COM         }
363*7851SDana.Myers@Sun.COM 
364*7851SDana.Myers@Sun.COM         /* Always increase acquisition depth */
365*7851SDana.Myers@Sun.COM 
366*7851SDana.Myers@Sun.COM         ObjDesc->Method.Mutex->Mutex.AcquisitionDepth++;
367*7851SDana.Myers@Sun.COM     }
368*7851SDana.Myers@Sun.COM 
369*7851SDana.Myers@Sun.COM     /*
370*7851SDana.Myers@Sun.COM      * Allocate an Owner ID for this method, only if this is the first thread
371*7851SDana.Myers@Sun.COM      * to begin concurrent execution. We only need one OwnerId, even if the
372*7851SDana.Myers@Sun.COM      * method is invoked recursively.
373*7851SDana.Myers@Sun.COM      */
374*7851SDana.Myers@Sun.COM     if (!ObjDesc->Method.OwnerId)
375*7851SDana.Myers@Sun.COM     {
376*7851SDana.Myers@Sun.COM         Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId);
377*7851SDana.Myers@Sun.COM         if (ACPI_FAILURE (Status))
378*7851SDana.Myers@Sun.COM         {
379*7851SDana.Myers@Sun.COM             goto Cleanup;
380*7851SDana.Myers@Sun.COM         }
381*7851SDana.Myers@Sun.COM     }
382*7851SDana.Myers@Sun.COM 
383*7851SDana.Myers@Sun.COM     /*
384*7851SDana.Myers@Sun.COM      * Increment the method parse tree thread count since it has been
385*7851SDana.Myers@Sun.COM      * reentered one more time (even if it is the same thread)
386*7851SDana.Myers@Sun.COM      */
387*7851SDana.Myers@Sun.COM     ObjDesc->Method.ThreadCount++;
388*7851SDana.Myers@Sun.COM     AcpiMethodCount++;
389*7851SDana.Myers@Sun.COM     return_ACPI_STATUS (Status);
390*7851SDana.Myers@Sun.COM 
391*7851SDana.Myers@Sun.COM 
392*7851SDana.Myers@Sun.COM Cleanup:
393*7851SDana.Myers@Sun.COM     /* On error, must release the method mutex (if present) */
394*7851SDana.Myers@Sun.COM 
395*7851SDana.Myers@Sun.COM     if (ObjDesc->Method.Mutex)
396*7851SDana.Myers@Sun.COM     {
397*7851SDana.Myers@Sun.COM         AcpiOsReleaseMutex (ObjDesc->Method.Mutex->Mutex.OsMutex);
398*7851SDana.Myers@Sun.COM     }
399*7851SDana.Myers@Sun.COM     return_ACPI_STATUS (Status);
400*7851SDana.Myers@Sun.COM }
401*7851SDana.Myers@Sun.COM 
402*7851SDana.Myers@Sun.COM 
403*7851SDana.Myers@Sun.COM /*******************************************************************************
404*7851SDana.Myers@Sun.COM  *
405*7851SDana.Myers@Sun.COM  * FUNCTION:    AcpiDsCallControlMethod
406*7851SDana.Myers@Sun.COM  *
407*7851SDana.Myers@Sun.COM  * PARAMETERS:  Thread              - Info for this thread
408*7851SDana.Myers@Sun.COM  *              ThisWalkState       - Current walk state
409*7851SDana.Myers@Sun.COM  *              Op                  - Current Op to be walked
410*7851SDana.Myers@Sun.COM  *
411*7851SDana.Myers@Sun.COM  * RETURN:      Status
412*7851SDana.Myers@Sun.COM  *
413*7851SDana.Myers@Sun.COM  * DESCRIPTION: Transfer execution to a called control method
414*7851SDana.Myers@Sun.COM  *
415*7851SDana.Myers@Sun.COM  ******************************************************************************/
416*7851SDana.Myers@Sun.COM 
417*7851SDana.Myers@Sun.COM ACPI_STATUS
418*7851SDana.Myers@Sun.COM AcpiDsCallControlMethod (
419*7851SDana.Myers@Sun.COM     ACPI_THREAD_STATE       *Thread,
420*7851SDana.Myers@Sun.COM     ACPI_WALK_STATE         *ThisWalkState,
421*7851SDana.Myers@Sun.COM     ACPI_PARSE_OBJECT       *Op)
422*7851SDana.Myers@Sun.COM {
423*7851SDana.Myers@Sun.COM     ACPI_STATUS             Status;
424*7851SDana.Myers@Sun.COM     ACPI_NAMESPACE_NODE     *MethodNode;
425*7851SDana.Myers@Sun.COM     ACPI_WALK_STATE         *NextWalkState = NULL;
426*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *ObjDesc;
427*7851SDana.Myers@Sun.COM     ACPI_EVALUATE_INFO      *Info;
428*7851SDana.Myers@Sun.COM     UINT32                  i;
429*7851SDana.Myers@Sun.COM 
430*7851SDana.Myers@Sun.COM 
431*7851SDana.Myers@Sun.COM     ACPI_FUNCTION_TRACE_PTR (DsCallControlMethod, ThisWalkState);
432*7851SDana.Myers@Sun.COM 
433*7851SDana.Myers@Sun.COM     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Calling method %p, currentstate=%p\n",
434*7851SDana.Myers@Sun.COM         ThisWalkState->PrevOp, ThisWalkState));
435*7851SDana.Myers@Sun.COM 
436*7851SDana.Myers@Sun.COM     /*
437*7851SDana.Myers@Sun.COM      * Get the namespace entry for the control method we are about to call
438*7851SDana.Myers@Sun.COM      */
439*7851SDana.Myers@Sun.COM     MethodNode = ThisWalkState->MethodCallNode;
440*7851SDana.Myers@Sun.COM     if (!MethodNode)
441*7851SDana.Myers@Sun.COM     {
442*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (AE_NULL_ENTRY);
443*7851SDana.Myers@Sun.COM     }
444*7851SDana.Myers@Sun.COM 
445*7851SDana.Myers@Sun.COM     ObjDesc = AcpiNsGetAttachedObject (MethodNode);
446*7851SDana.Myers@Sun.COM     if (!ObjDesc)
447*7851SDana.Myers@Sun.COM     {
448*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (AE_NULL_OBJECT);
449*7851SDana.Myers@Sun.COM     }
450*7851SDana.Myers@Sun.COM 
451*7851SDana.Myers@Sun.COM     /* Init for new method, possibly wait on method mutex */
452*7851SDana.Myers@Sun.COM 
453*7851SDana.Myers@Sun.COM     Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
454*7851SDana.Myers@Sun.COM                 ThisWalkState);
455*7851SDana.Myers@Sun.COM     if (ACPI_FAILURE (Status))
456*7851SDana.Myers@Sun.COM     {
457*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (Status);
458*7851SDana.Myers@Sun.COM     }
459*7851SDana.Myers@Sun.COM 
460*7851SDana.Myers@Sun.COM     /* Begin method parse/execution. Create a new walk state */
461*7851SDana.Myers@Sun.COM 
462*7851SDana.Myers@Sun.COM     NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwnerId,
463*7851SDana.Myers@Sun.COM                         NULL, ObjDesc, Thread);
464*7851SDana.Myers@Sun.COM     if (!NextWalkState)
465*7851SDana.Myers@Sun.COM     {
466*7851SDana.Myers@Sun.COM         Status = AE_NO_MEMORY;
467*7851SDana.Myers@Sun.COM         goto Cleanup;
468*7851SDana.Myers@Sun.COM     }
469*7851SDana.Myers@Sun.COM 
470*7851SDana.Myers@Sun.COM     /*
471*7851SDana.Myers@Sun.COM      * The resolved arguments were put on the previous walk state's operand
472*7851SDana.Myers@Sun.COM      * stack. Operands on the previous walk state stack always
473*7851SDana.Myers@Sun.COM      * start at index 0. Also, null terminate the list of arguments
474*7851SDana.Myers@Sun.COM      */
475*7851SDana.Myers@Sun.COM     ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
476*7851SDana.Myers@Sun.COM 
477*7851SDana.Myers@Sun.COM     /*
478*7851SDana.Myers@Sun.COM      * Allocate and initialize the evaluation information block
479*7851SDana.Myers@Sun.COM      * TBD: this is somewhat inefficient, should change interface to
480*7851SDana.Myers@Sun.COM      * DsInitAmlWalk. For now, keeps this struct off the CPU stack
481*7851SDana.Myers@Sun.COM      */
482*7851SDana.Myers@Sun.COM     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
483*7851SDana.Myers@Sun.COM     if (!Info)
484*7851SDana.Myers@Sun.COM     {
485*7851SDana.Myers@Sun.COM         return_ACPI_STATUS (AE_NO_MEMORY);
486*7851SDana.Myers@Sun.COM     }
487*7851SDana.Myers@Sun.COM 
488*7851SDana.Myers@Sun.COM     Info->Parameters = &ThisWalkState->Operands[0];
489*7851SDana.Myers@Sun.COM 
490*7851SDana.Myers@Sun.COM     Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
491*7851SDana.Myers@Sun.COM                 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
492*7851SDana.Myers@Sun.COM                 Info, ACPI_IMODE_EXECUTE);
493*7851SDana.Myers@Sun.COM 
494*7851SDana.Myers@Sun.COM     ACPI_FREE (Info);
495*7851SDana.Myers@Sun.COM     if (ACPI_FAILURE (Status))
496*7851SDana.Myers@Sun.COM     {
497*7851SDana.Myers@Sun.COM         goto Cleanup;
498*7851SDana.Myers@Sun.COM     }
499*7851SDana.Myers@Sun.COM 
500*7851SDana.Myers@Sun.COM     /*
501*7851SDana.Myers@Sun.COM      * Delete the operands on the previous walkstate operand stack
502*7851SDana.Myers@Sun.COM      * (they were copied to new objects)
503*7851SDana.Myers@Sun.COM      */
504*7851SDana.Myers@Sun.COM     for (i = 0; i < ObjDesc->Method.ParamCount; i++)
505*7851SDana.Myers@Sun.COM     {
506*7851SDana.Myers@Sun.COM         AcpiUtRemoveReference (ThisWalkState->Operands [i]);
507*7851SDana.Myers@Sun.COM         ThisWalkState->Operands [i] = NULL;
508*7851SDana.Myers@Sun.COM     }
509*7851SDana.Myers@Sun.COM 
510*7851SDana.Myers@Sun.COM     /* Clear the operand stack */
511*7851SDana.Myers@Sun.COM 
512*7851SDana.Myers@Sun.COM     ThisWalkState->NumOperands = 0;
513*7851SDana.Myers@Sun.COM 
514*7851SDana.Myers@Sun.COM     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
515*7851SDana.Myers@Sun.COM         "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
516*7851SDana.Myers@Sun.COM         MethodNode->Name.Ascii, NextWalkState));
517*7851SDana.Myers@Sun.COM 
518*7851SDana.Myers@Sun.COM     /* Invoke an internal method if necessary */
519*7851SDana.Myers@Sun.COM 
520*7851SDana.Myers@Sun.COM     if (ObjDesc->Method.MethodFlags & AML_METHOD_INTERNAL_ONLY)
521*7851SDana.Myers@Sun.COM     {
522*7851SDana.Myers@Sun.COM         Status = ObjDesc->Method.Implementation (NextWalkState);
523*7851SDana.Myers@Sun.COM     }
524*7851SDana.Myers@Sun.COM 
525*7851SDana.Myers@Sun.COM     return_ACPI_STATUS (Status);
526*7851SDana.Myers@Sun.COM 
527*7851SDana.Myers@Sun.COM 
528*7851SDana.Myers@Sun.COM Cleanup:
529*7851SDana.Myers@Sun.COM 
530*7851SDana.Myers@Sun.COM     /* On error, we must terminate the method properly */
531*7851SDana.Myers@Sun.COM 
532*7851SDana.Myers@Sun.COM     AcpiDsTerminateControlMethod (ObjDesc, NextWalkState);
533*7851SDana.Myers@Sun.COM     if (NextWalkState)
534*7851SDana.Myers@Sun.COM     {
535*7851SDana.Myers@Sun.COM         AcpiDsDeleteWalkState (NextWalkState);
536*7851SDana.Myers@Sun.COM     }
537*7851SDana.Myers@Sun.COM 
538*7851SDana.Myers@Sun.COM     return_ACPI_STATUS (Status);
539*7851SDana.Myers@Sun.COM }
540*7851SDana.Myers@Sun.COM 
541*7851SDana.Myers@Sun.COM 
542*7851SDana.Myers@Sun.COM /*******************************************************************************
543*7851SDana.Myers@Sun.COM  *
544*7851SDana.Myers@Sun.COM  * FUNCTION:    AcpiDsRestartControlMethod
545*7851SDana.Myers@Sun.COM  *
546*7851SDana.Myers@Sun.COM  * PARAMETERS:  WalkState           - State for preempted method (caller)
547*7851SDana.Myers@Sun.COM  *              ReturnDesc          - Return value from the called method
548*7851SDana.Myers@Sun.COM  *
549*7851SDana.Myers@Sun.COM  * RETURN:      Status
550*7851SDana.Myers@Sun.COM  *
551*7851SDana.Myers@Sun.COM  * DESCRIPTION: Restart a method that was preempted by another (nested) method
552*7851SDana.Myers@Sun.COM  *              invocation.  Handle the return value (if any) from the callee.
553*7851SDana.Myers@Sun.COM  *
554*7851SDana.Myers@Sun.COM  ******************************************************************************/
555*7851SDana.Myers@Sun.COM 
556*7851SDana.Myers@Sun.COM ACPI_STATUS
557*7851SDana.Myers@Sun.COM AcpiDsRestartControlMethod (
558*7851SDana.Myers@Sun.COM     ACPI_WALK_STATE         *WalkState,
559*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *ReturnDesc)
560*7851SDana.Myers@Sun.COM {
561*7851SDana.Myers@Sun.COM     ACPI_STATUS             Status;
562*7851SDana.Myers@Sun.COM     int                     SameAsImplicitReturn;
563*7851SDana.Myers@Sun.COM 
564*7851SDana.Myers@Sun.COM 
565*7851SDana.Myers@Sun.COM     ACPI_FUNCTION_TRACE_PTR (DsRestartControlMethod, WalkState);
566*7851SDana.Myers@Sun.COM 
567*7851SDana.Myers@Sun.COM 
568*7851SDana.Myers@Sun.COM     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
569*7851SDana.Myers@Sun.COM         "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
570*7851SDana.Myers@Sun.COM         AcpiUtGetNodeName (WalkState->MethodNode),
571*7851SDana.Myers@Sun.COM         WalkState->MethodCallOp, ReturnDesc));
572*7851SDana.Myers@Sun.COM 
573*7851SDana.Myers@Sun.COM     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
574*7851SDana.Myers@Sun.COM         "    ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
575*7851SDana.Myers@Sun.COM         WalkState->ReturnUsed,
576*7851SDana.Myers@Sun.COM         WalkState->Results, WalkState));
577*7851SDana.Myers@Sun.COM 
578*7851SDana.Myers@Sun.COM     /* Did the called method return a value? */
579*7851SDana.Myers@Sun.COM 
580*7851SDana.Myers@Sun.COM     if (ReturnDesc)
581*7851SDana.Myers@Sun.COM     {
582*7851SDana.Myers@Sun.COM         /* Is the implicit return object the same as the return desc? */
583*7851SDana.Myers@Sun.COM 
584*7851SDana.Myers@Sun.COM         SameAsImplicitReturn = (WalkState->ImplicitReturnObj == ReturnDesc);
585*7851SDana.Myers@Sun.COM 
586*7851SDana.Myers@Sun.COM         /* Are we actually going to use the return value? */
587*7851SDana.Myers@Sun.COM 
588*7851SDana.Myers@Sun.COM         if (WalkState->ReturnUsed)
589*7851SDana.Myers@Sun.COM         {
590*7851SDana.Myers@Sun.COM             /* Save the return value from the previous method */
591*7851SDana.Myers@Sun.COM 
592*7851SDana.Myers@Sun.COM             Status = AcpiDsResultPush (ReturnDesc, WalkState);
593*7851SDana.Myers@Sun.COM             if (ACPI_FAILURE (Status))
594*7851SDana.Myers@Sun.COM             {
595*7851SDana.Myers@Sun.COM                 AcpiUtRemoveReference (ReturnDesc);
596*7851SDana.Myers@Sun.COM                 return_ACPI_STATUS (Status);
597*7851SDana.Myers@Sun.COM             }
598*7851SDana.Myers@Sun.COM 
599*7851SDana.Myers@Sun.COM             /*
600*7851SDana.Myers@Sun.COM              * Save as THIS method's return value in case it is returned
601*7851SDana.Myers@Sun.COM              * immediately to yet another method
602*7851SDana.Myers@Sun.COM              */
603*7851SDana.Myers@Sun.COM             WalkState->ReturnDesc = ReturnDesc;
604*7851SDana.Myers@Sun.COM         }
605*7851SDana.Myers@Sun.COM 
606*7851SDana.Myers@Sun.COM         /*
607*7851SDana.Myers@Sun.COM          * The following code is the optional support for the so-called
608*7851SDana.Myers@Sun.COM          * "implicit return". Some AML code assumes that the last value of the
609*7851SDana.Myers@Sun.COM          * method is "implicitly" returned to the caller, in the absence of an
610*7851SDana.Myers@Sun.COM          * explicit return value.
611*7851SDana.Myers@Sun.COM          *
612*7851SDana.Myers@Sun.COM          * Just save the last result of the method as the return value.
613*7851SDana.Myers@Sun.COM          *
614*7851SDana.Myers@Sun.COM          * NOTE: this is optional because the ASL language does not actually
615*7851SDana.Myers@Sun.COM          * support this behavior.
616*7851SDana.Myers@Sun.COM          */
617*7851SDana.Myers@Sun.COM         else if (!AcpiDsDoImplicitReturn (ReturnDesc, WalkState, FALSE) ||
618*7851SDana.Myers@Sun.COM                  SameAsImplicitReturn)
619*7851SDana.Myers@Sun.COM         {
620*7851SDana.Myers@Sun.COM             /*
621*7851SDana.Myers@Sun.COM              * Delete the return value if it will not be used by the
622*7851SDana.Myers@Sun.COM              * calling method or remove one reference if the explicit return
623*7851SDana.Myers@Sun.COM              * is the same as the implicit return value.
624*7851SDana.Myers@Sun.COM              */
625*7851SDana.Myers@Sun.COM             AcpiUtRemoveReference (ReturnDesc);
626*7851SDana.Myers@Sun.COM         }
627*7851SDana.Myers@Sun.COM     }
628*7851SDana.Myers@Sun.COM 
629*7851SDana.Myers@Sun.COM     return_ACPI_STATUS (AE_OK);
630*7851SDana.Myers@Sun.COM }
631*7851SDana.Myers@Sun.COM 
632*7851SDana.Myers@Sun.COM 
633*7851SDana.Myers@Sun.COM /*******************************************************************************
634*7851SDana.Myers@Sun.COM  *
635*7851SDana.Myers@Sun.COM  * FUNCTION:    AcpiDsTerminateControlMethod
636*7851SDana.Myers@Sun.COM  *
637*7851SDana.Myers@Sun.COM  * PARAMETERS:  MethodDesc          - Method object
638*7851SDana.Myers@Sun.COM  *              WalkState           - State associated with the method
639*7851SDana.Myers@Sun.COM  *
640*7851SDana.Myers@Sun.COM  * RETURN:      None
641*7851SDana.Myers@Sun.COM  *
642*7851SDana.Myers@Sun.COM  * DESCRIPTION: Terminate a control method.  Delete everything that the method
643*7851SDana.Myers@Sun.COM  *              created, delete all locals and arguments, and delete the parse
644*7851SDana.Myers@Sun.COM  *              tree if requested.
645*7851SDana.Myers@Sun.COM  *
646*7851SDana.Myers@Sun.COM  * MUTEX:       Interpreter is locked
647*7851SDana.Myers@Sun.COM  *
648*7851SDana.Myers@Sun.COM  ******************************************************************************/
649*7851SDana.Myers@Sun.COM 
650*7851SDana.Myers@Sun.COM void
651*7851SDana.Myers@Sun.COM AcpiDsTerminateControlMethod (
652*7851SDana.Myers@Sun.COM     ACPI_OPERAND_OBJECT     *MethodDesc,
653*7851SDana.Myers@Sun.COM     ACPI_WALK_STATE         *WalkState)
654*7851SDana.Myers@Sun.COM {
655*7851SDana.Myers@Sun.COM 
656*7851SDana.Myers@Sun.COM     ACPI_FUNCTION_TRACE_PTR (DsTerminateControlMethod, WalkState);
657*7851SDana.Myers@Sun.COM 
658*7851SDana.Myers@Sun.COM 
659*7851SDana.Myers@Sun.COM     /* MethodDesc is required, WalkState is optional */
660*7851SDana.Myers@Sun.COM 
661*7851SDana.Myers@Sun.COM     if (!MethodDesc)
662*7851SDana.Myers@Sun.COM     {
663*7851SDana.Myers@Sun.COM         return_VOID;
664*7851SDana.Myers@Sun.COM     }
665*7851SDana.Myers@Sun.COM 
666*7851SDana.Myers@Sun.COM     if (WalkState)
667*7851SDana.Myers@Sun.COM     {
668*7851SDana.Myers@Sun.COM         /* Delete all arguments and locals */
669*7851SDana.Myers@Sun.COM 
670*7851SDana.Myers@Sun.COM         AcpiDsMethodDataDeleteAll (WalkState);
671*7851SDana.Myers@Sun.COM 
672*7851SDana.Myers@Sun.COM         /*
673*7851SDana.Myers@Sun.COM          * If method is serialized, release the mutex and restore the
674*7851SDana.Myers@Sun.COM          * current sync level for this thread
675*7851SDana.Myers@Sun.COM          */
676*7851SDana.Myers@Sun.COM         if (MethodDesc->Method.Mutex)
677*7851SDana.Myers@Sun.COM         {
678*7851SDana.Myers@Sun.COM             /* Acquisition Depth handles recursive calls */
679*7851SDana.Myers@Sun.COM 
680*7851SDana.Myers@Sun.COM             MethodDesc->Method.Mutex->Mutex.AcquisitionDepth--;
681*7851SDana.Myers@Sun.COM             if (!MethodDesc->Method.Mutex->Mutex.AcquisitionDepth)
682*7851SDana.Myers@Sun.COM             {
683*7851SDana.Myers@Sun.COM                 WalkState->Thread->CurrentSyncLevel =
684*7851SDana.Myers@Sun.COM                     MethodDesc->Method.Mutex->Mutex.OriginalSyncLevel;
685*7851SDana.Myers@Sun.COM 
686*7851SDana.Myers@Sun.COM                 AcpiOsReleaseMutex (MethodDesc->Method.Mutex->Mutex.OsMutex);
687*7851SDana.Myers@Sun.COM                 MethodDesc->Method.Mutex->Mutex.ThreadId = 0;
688*7851SDana.Myers@Sun.COM             }
689*7851SDana.Myers@Sun.COM         }
690*7851SDana.Myers@Sun.COM 
691*7851SDana.Myers@Sun.COM         /*
692*7851SDana.Myers@Sun.COM          * Delete any namespace objects created anywhere within
693*7851SDana.Myers@Sun.COM          * the namespace by the execution of this method
694*7851SDana.Myers@Sun.COM          */
695*7851SDana.Myers@Sun.COM         AcpiNsDeleteNamespaceByOwner (MethodDesc->Method.OwnerId);
696*7851SDana.Myers@Sun.COM     }
697*7851SDana.Myers@Sun.COM 
698*7851SDana.Myers@Sun.COM     /* Decrement the thread count on the method */
699*7851SDana.Myers@Sun.COM 
700*7851SDana.Myers@Sun.COM     if (MethodDesc->Method.ThreadCount)
701*7851SDana.Myers@Sun.COM     {
702*7851SDana.Myers@Sun.COM         MethodDesc->Method.ThreadCount--;
703*7851SDana.Myers@Sun.COM     }
704*7851SDana.Myers@Sun.COM     else
705*7851SDana.Myers@Sun.COM     {
706*7851SDana.Myers@Sun.COM         ACPI_ERROR ((AE_INFO,
707*7851SDana.Myers@Sun.COM             "Invalid zero thread count in method"));
708*7851SDana.Myers@Sun.COM     }
709*7851SDana.Myers@Sun.COM 
710*7851SDana.Myers@Sun.COM     /* Are there any other threads currently executing this method? */
711*7851SDana.Myers@Sun.COM 
712*7851SDana.Myers@Sun.COM     if (MethodDesc->Method.ThreadCount)
713*7851SDana.Myers@Sun.COM     {
714*7851SDana.Myers@Sun.COM         /*
715*7851SDana.Myers@Sun.COM          * Additional threads. Do not release the OwnerId in this case,
716*7851SDana.Myers@Sun.COM          * we immediately reuse it for the next thread executing this method
717*7851SDana.Myers@Sun.COM          */
718*7851SDana.Myers@Sun.COM         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
719*7851SDana.Myers@Sun.COM             "*** Completed execution of one thread, %d threads remaining\n",
720*7851SDana.Myers@Sun.COM             MethodDesc->Method.ThreadCount));
721*7851SDana.Myers@Sun.COM     }
722*7851SDana.Myers@Sun.COM     else
723*7851SDana.Myers@Sun.COM     {
724*7851SDana.Myers@Sun.COM         /* This is the only executing thread for this method */
725*7851SDana.Myers@Sun.COM 
726*7851SDana.Myers@Sun.COM         /*
727*7851SDana.Myers@Sun.COM          * Support to dynamically change a method from NotSerialized to
728*7851SDana.Myers@Sun.COM          * Serialized if it appears that the method is incorrectly written and
729*7851SDana.Myers@Sun.COM          * does not support multiple thread execution. The best example of this
730*7851SDana.Myers@Sun.COM          * is if such a method creates namespace objects and blocks. A second
731*7851SDana.Myers@Sun.COM          * thread will fail with an AE_ALREADY_EXISTS exception
732*7851SDana.Myers@Sun.COM          *
733*7851SDana.Myers@Sun.COM          * This code is here because we must wait until the last thread exits
734*7851SDana.Myers@Sun.COM          * before creating the synchronization semaphore.
735*7851SDana.Myers@Sun.COM          */
736*7851SDana.Myers@Sun.COM         if ((MethodDesc->Method.MethodFlags & AML_METHOD_SERIALIZED) &&
737*7851SDana.Myers@Sun.COM             (!MethodDesc->Method.Mutex))
738*7851SDana.Myers@Sun.COM         {
739*7851SDana.Myers@Sun.COM             (void) AcpiDsCreateMethodMutex (MethodDesc);
740*7851SDana.Myers@Sun.COM         }
741*7851SDana.Myers@Sun.COM 
742*7851SDana.Myers@Sun.COM         /* No more threads, we can free the OwnerId */
743*7851SDana.Myers@Sun.COM 
744*7851SDana.Myers@Sun.COM         AcpiUtReleaseOwnerId (&MethodDesc->Method.OwnerId);
745*7851SDana.Myers@Sun.COM     }
746*7851SDana.Myers@Sun.COM 
747*7851SDana.Myers@Sun.COM     return_VOID;
748*7851SDana.Myers@Sun.COM }
749*7851SDana.Myers@Sun.COM 
750*7851SDana.Myers@Sun.COM 
751