xref: /freebsd/sys/contrib/dev/acpica/components/dispatcher/dsmethod.c (revision 313a0c13efa638cf248e35eed49f36ec0a1a7f26)
1a159c266SJung-uk Kim /******************************************************************************
2a159c266SJung-uk Kim  *
3a159c266SJung-uk Kim  * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4a159c266SJung-uk Kim  *
5a159c266SJung-uk Kim  *****************************************************************************/
6a159c266SJung-uk Kim 
7a159c266SJung-uk Kim /*
8*313a0c13SJung-uk Kim  * Copyright (C) 2000 - 2014, Intel Corp.
9a159c266SJung-uk Kim  * All rights reserved.
10a159c266SJung-uk Kim  *
11a159c266SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
12a159c266SJung-uk Kim  * modification, are permitted provided that the following conditions
13a159c266SJung-uk Kim  * are met:
14a159c266SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
15a159c266SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
16a159c266SJung-uk Kim  *    without modification.
17a159c266SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18a159c266SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
19a159c266SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
20a159c266SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
21a159c266SJung-uk Kim  *    binary redistribution.
22a159c266SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
23a159c266SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
24a159c266SJung-uk Kim  *    from this software without specific prior written permission.
25a159c266SJung-uk Kim  *
26a159c266SJung-uk Kim  * Alternatively, this software may be distributed under the terms of the
27a159c266SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
28a159c266SJung-uk Kim  * Software Foundation.
29a159c266SJung-uk Kim  *
30a159c266SJung-uk Kim  * NO WARRANTY
31a159c266SJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32a159c266SJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33a159c266SJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34a159c266SJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35a159c266SJung-uk Kim  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36a159c266SJung-uk Kim  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37a159c266SJung-uk Kim  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38a159c266SJung-uk Kim  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39a159c266SJung-uk Kim  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40a159c266SJung-uk Kim  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41a159c266SJung-uk Kim  * POSSIBILITY OF SUCH DAMAGES.
42a159c266SJung-uk Kim  */
43a159c266SJung-uk Kim 
44a159c266SJung-uk Kim #define __DSMETHOD_C__
45a159c266SJung-uk Kim 
46a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
47a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
48a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acdispat.h>
49a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acinterp.h>
50a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acnamesp.h>
51a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acdisasm.h>
52*313a0c13SJung-uk Kim #include <contrib/dev/acpica/include/acparser.h>
53*313a0c13SJung-uk Kim #include <contrib/dev/acpica/include/amlcode.h>
54a159c266SJung-uk Kim 
55a159c266SJung-uk Kim 
56a159c266SJung-uk Kim #define _COMPONENT          ACPI_DISPATCHER
57a159c266SJung-uk Kim         ACPI_MODULE_NAME    ("dsmethod")
58a159c266SJung-uk Kim 
59a159c266SJung-uk Kim /* Local prototypes */
60a159c266SJung-uk Kim 
61a159c266SJung-uk Kim static ACPI_STATUS
62*313a0c13SJung-uk Kim AcpiDsDetectNamedOpcodes (
63*313a0c13SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
64*313a0c13SJung-uk Kim     ACPI_PARSE_OBJECT       **OutOp);
65*313a0c13SJung-uk Kim 
66*313a0c13SJung-uk Kim static ACPI_STATUS
67a159c266SJung-uk Kim AcpiDsCreateMethodMutex (
68a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MethodDesc);
69a159c266SJung-uk Kim 
70a159c266SJung-uk Kim 
71a159c266SJung-uk Kim /*******************************************************************************
72a159c266SJung-uk Kim  *
73*313a0c13SJung-uk Kim  * FUNCTION:    AcpiDsAutoSerializeMethod
74*313a0c13SJung-uk Kim  *
75*313a0c13SJung-uk Kim  * PARAMETERS:  Node                        - Namespace Node of the method
76*313a0c13SJung-uk Kim  *              ObjDesc                     - Method object attached to node
77*313a0c13SJung-uk Kim  *
78*313a0c13SJung-uk Kim  * RETURN:      Status
79*313a0c13SJung-uk Kim  *
80*313a0c13SJung-uk Kim  * DESCRIPTION: Parse a control method AML to scan for control methods that
81*313a0c13SJung-uk Kim  *              need serialization due to the creation of named objects.
82*313a0c13SJung-uk Kim  *
83*313a0c13SJung-uk Kim  * NOTE: It is a bit of overkill to mark all such methods serialized, since
84*313a0c13SJung-uk Kim  * there is only a problem if the method actually blocks during execution.
85*313a0c13SJung-uk Kim  * A blocking operation is, for example, a Sleep() operation, or any access
86*313a0c13SJung-uk Kim  * to an operation region. However, it is probably not possible to easily
87*313a0c13SJung-uk Kim  * detect whether a method will block or not, so we simply mark all suspicious
88*313a0c13SJung-uk Kim  * methods as serialized.
89*313a0c13SJung-uk Kim  *
90*313a0c13SJung-uk Kim  * NOTE2: This code is essentially a generic routine for parsing a single
91*313a0c13SJung-uk Kim  * control method.
92*313a0c13SJung-uk Kim  *
93*313a0c13SJung-uk Kim  ******************************************************************************/
94*313a0c13SJung-uk Kim 
95*313a0c13SJung-uk Kim ACPI_STATUS
96*313a0c13SJung-uk Kim AcpiDsAutoSerializeMethod (
97*313a0c13SJung-uk Kim     ACPI_NAMESPACE_NODE     *Node,
98*313a0c13SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc)
99*313a0c13SJung-uk Kim {
100*313a0c13SJung-uk Kim     ACPI_STATUS             Status;
101*313a0c13SJung-uk Kim     ACPI_PARSE_OBJECT       *Op = NULL;
102*313a0c13SJung-uk Kim     ACPI_WALK_STATE         *WalkState;
103*313a0c13SJung-uk Kim 
104*313a0c13SJung-uk Kim 
105*313a0c13SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsAutoSerializeMethod, Node);
106*313a0c13SJung-uk Kim 
107*313a0c13SJung-uk Kim 
108*313a0c13SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
109*313a0c13SJung-uk Kim         "Method auto-serialization parse [%4.4s] %p\n",
110*313a0c13SJung-uk Kim         AcpiUtGetNodeName (Node), Node));
111*313a0c13SJung-uk Kim 
112*313a0c13SJung-uk Kim     /* Create/Init a root op for the method parse tree */
113*313a0c13SJung-uk Kim 
114*313a0c13SJung-uk Kim     Op = AcpiPsAllocOp (AML_METHOD_OP);
115*313a0c13SJung-uk Kim     if (!Op)
116*313a0c13SJung-uk Kim     {
117*313a0c13SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
118*313a0c13SJung-uk Kim     }
119*313a0c13SJung-uk Kim 
120*313a0c13SJung-uk Kim     AcpiPsSetName (Op, Node->Name.Integer);
121*313a0c13SJung-uk Kim     Op->Common.Node = Node;
122*313a0c13SJung-uk Kim 
123*313a0c13SJung-uk Kim     /* Create and initialize a new walk state */
124*313a0c13SJung-uk Kim 
125*313a0c13SJung-uk Kim     WalkState = AcpiDsCreateWalkState (Node->OwnerId, NULL, NULL, NULL);
126*313a0c13SJung-uk Kim     if (!WalkState)
127*313a0c13SJung-uk Kim     {
128*313a0c13SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
129*313a0c13SJung-uk Kim     }
130*313a0c13SJung-uk Kim 
131*313a0c13SJung-uk Kim     Status = AcpiDsInitAmlWalk (WalkState, Op, Node, ObjDesc->Method.AmlStart,
132*313a0c13SJung-uk Kim                 ObjDesc->Method.AmlLength, NULL, 0);
133*313a0c13SJung-uk Kim     if (ACPI_FAILURE (Status))
134*313a0c13SJung-uk Kim     {
135*313a0c13SJung-uk Kim         AcpiDsDeleteWalkState (WalkState);
136*313a0c13SJung-uk Kim         return_ACPI_STATUS (Status);
137*313a0c13SJung-uk Kim     }
138*313a0c13SJung-uk Kim 
139*313a0c13SJung-uk Kim     WalkState->DescendingCallback = AcpiDsDetectNamedOpcodes;
140*313a0c13SJung-uk Kim 
141*313a0c13SJung-uk Kim     /* Parse the method, scan for creation of named objects */
142*313a0c13SJung-uk Kim 
143*313a0c13SJung-uk Kim     Status = AcpiPsParseAml (WalkState);
144*313a0c13SJung-uk Kim     if (ACPI_FAILURE (Status))
145*313a0c13SJung-uk Kim     {
146*313a0c13SJung-uk Kim         return_ACPI_STATUS (Status);
147*313a0c13SJung-uk Kim     }
148*313a0c13SJung-uk Kim 
149*313a0c13SJung-uk Kim     AcpiPsDeleteParseTree (Op);
150*313a0c13SJung-uk Kim     return_ACPI_STATUS (Status);
151*313a0c13SJung-uk Kim }
152*313a0c13SJung-uk Kim 
153*313a0c13SJung-uk Kim 
154*313a0c13SJung-uk Kim /*******************************************************************************
155*313a0c13SJung-uk Kim  *
156*313a0c13SJung-uk Kim  * FUNCTION:    AcpiDsDetectNamedOpcodes
157*313a0c13SJung-uk Kim  *
158*313a0c13SJung-uk Kim  * PARAMETERS:  WalkState       - Current state of the parse tree walk
159*313a0c13SJung-uk Kim  *              OutOp           - Unused, required for parser interface
160*313a0c13SJung-uk Kim  *
161*313a0c13SJung-uk Kim  * RETURN:      Status
162*313a0c13SJung-uk Kim  *
163*313a0c13SJung-uk Kim  * DESCRIPTION: Descending callback used during the loading of ACPI tables.
164*313a0c13SJung-uk Kim  *              Currently used to detect methods that must be marked serialized
165*313a0c13SJung-uk Kim  *              in order to avoid problems with the creation of named objects.
166*313a0c13SJung-uk Kim  *
167*313a0c13SJung-uk Kim  ******************************************************************************/
168*313a0c13SJung-uk Kim 
169*313a0c13SJung-uk Kim static ACPI_STATUS
170*313a0c13SJung-uk Kim AcpiDsDetectNamedOpcodes (
171*313a0c13SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
172*313a0c13SJung-uk Kim     ACPI_PARSE_OBJECT       **OutOp)
173*313a0c13SJung-uk Kim {
174*313a0c13SJung-uk Kim 
175*313a0c13SJung-uk Kim     ACPI_FUNCTION_NAME (AcpiDsDetectNamedOpcodes);
176*313a0c13SJung-uk Kim 
177*313a0c13SJung-uk Kim 
178*313a0c13SJung-uk Kim     /* We are only interested in opcodes that create a new name */
179*313a0c13SJung-uk Kim 
180*313a0c13SJung-uk Kim     if (!(WalkState->OpInfo->Flags & (AML_NAMED | AML_CREATE | AML_FIELD)))
181*313a0c13SJung-uk Kim     {
182*313a0c13SJung-uk Kim         return (AE_OK);
183*313a0c13SJung-uk Kim     }
184*313a0c13SJung-uk Kim 
185*313a0c13SJung-uk Kim     /*
186*313a0c13SJung-uk Kim      * At this point, we know we have a Named object opcode.
187*313a0c13SJung-uk Kim      * Mark the method as serialized. Later code will create a mutex for
188*313a0c13SJung-uk Kim      * this method to enforce serialization.
189*313a0c13SJung-uk Kim      *
190*313a0c13SJung-uk Kim      * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
191*313a0c13SJung-uk Kim      * Sync Level mechanism for this method, even though it is now serialized.
192*313a0c13SJung-uk Kim      * Otherwise, there can be conflicts with existing ASL code that actually
193*313a0c13SJung-uk Kim      * uses sync levels.
194*313a0c13SJung-uk Kim      */
195*313a0c13SJung-uk Kim     WalkState->MethodDesc->Method.SyncLevel = 0;
196*313a0c13SJung-uk Kim     WalkState->MethodDesc->Method.InfoFlags |=
197*313a0c13SJung-uk Kim         (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
198*313a0c13SJung-uk Kim 
199*313a0c13SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
200*313a0c13SJung-uk Kim         "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
201*313a0c13SJung-uk Kim         WalkState->MethodNode->Name.Ascii, WalkState->MethodNode,
202*313a0c13SJung-uk Kim         WalkState->OpInfo->Name, WalkState->Opcode));
203*313a0c13SJung-uk Kim 
204*313a0c13SJung-uk Kim     /* Abort the parse, no need to examine this method any further */
205*313a0c13SJung-uk Kim 
206*313a0c13SJung-uk Kim     return (AE_CTRL_TERMINATE);
207*313a0c13SJung-uk Kim }
208*313a0c13SJung-uk Kim 
209*313a0c13SJung-uk Kim 
210*313a0c13SJung-uk Kim /*******************************************************************************
211*313a0c13SJung-uk Kim  *
212a159c266SJung-uk Kim  * FUNCTION:    AcpiDsMethodError
213a159c266SJung-uk Kim  *
214a159c266SJung-uk Kim  * PARAMETERS:  Status          - Execution status
215a159c266SJung-uk Kim  *              WalkState       - Current state
216a159c266SJung-uk Kim  *
217a159c266SJung-uk Kim  * RETURN:      Status
218a159c266SJung-uk Kim  *
219a159c266SJung-uk Kim  * DESCRIPTION: Called on method error. Invoke the global exception handler if
220a159c266SJung-uk Kim  *              present, dump the method data if the disassembler is configured
221a159c266SJung-uk Kim  *
222a159c266SJung-uk Kim  *              Note: Allows the exception handler to change the status code
223a159c266SJung-uk Kim  *
224a159c266SJung-uk Kim  ******************************************************************************/
225a159c266SJung-uk Kim 
226a159c266SJung-uk Kim ACPI_STATUS
227a159c266SJung-uk Kim AcpiDsMethodError (
228a159c266SJung-uk Kim     ACPI_STATUS             Status,
229a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
230a159c266SJung-uk Kim {
231a159c266SJung-uk Kim     ACPI_FUNCTION_ENTRY ();
232a159c266SJung-uk Kim 
233a159c266SJung-uk Kim 
234a159c266SJung-uk Kim     /* Ignore AE_OK and control exception codes */
235a159c266SJung-uk Kim 
236a159c266SJung-uk Kim     if (ACPI_SUCCESS (Status) ||
237a159c266SJung-uk Kim         (Status & AE_CODE_CONTROL))
238a159c266SJung-uk Kim     {
239a159c266SJung-uk Kim         return (Status);
240a159c266SJung-uk Kim     }
241a159c266SJung-uk Kim 
242a159c266SJung-uk Kim     /* Invoke the global exception handler */
243a159c266SJung-uk Kim 
244a159c266SJung-uk Kim     if (AcpiGbl_ExceptionHandler)
245a159c266SJung-uk Kim     {
246a159c266SJung-uk Kim         /* Exit the interpreter, allow handler to execute methods */
247a159c266SJung-uk Kim 
248a159c266SJung-uk Kim         AcpiExExitInterpreter ();
249a159c266SJung-uk Kim 
250a159c266SJung-uk Kim         /*
251a159c266SJung-uk Kim          * Handler can map the exception code to anything it wants, including
252a159c266SJung-uk Kim          * AE_OK, in which case the executing method will not be aborted.
253a159c266SJung-uk Kim          */
254a159c266SJung-uk Kim         Status = AcpiGbl_ExceptionHandler (Status,
255a159c266SJung-uk Kim                     WalkState->MethodNode ?
256a159c266SJung-uk Kim                         WalkState->MethodNode->Name.Integer : 0,
257a159c266SJung-uk Kim                     WalkState->Opcode, WalkState->AmlOffset, NULL);
258a159c266SJung-uk Kim         AcpiExEnterInterpreter ();
259a159c266SJung-uk Kim     }
260a159c266SJung-uk Kim 
261a159c266SJung-uk Kim     AcpiDsClearImplicitReturn (WalkState);
262a159c266SJung-uk Kim 
263a159c266SJung-uk Kim #ifdef ACPI_DISASSEMBLER
264a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
265a159c266SJung-uk Kim     {
266a159c266SJung-uk Kim         /* Display method locals/args if disassembler is present */
267a159c266SJung-uk Kim 
268a159c266SJung-uk Kim         AcpiDmDumpMethodInfo (Status, WalkState, WalkState->Op);
269a159c266SJung-uk Kim     }
270a159c266SJung-uk Kim #endif
271a159c266SJung-uk Kim 
272a159c266SJung-uk Kim     return (Status);
273a159c266SJung-uk Kim }
274a159c266SJung-uk Kim 
275a159c266SJung-uk Kim 
276a159c266SJung-uk Kim /*******************************************************************************
277a159c266SJung-uk Kim  *
278a159c266SJung-uk Kim  * FUNCTION:    AcpiDsCreateMethodMutex
279a159c266SJung-uk Kim  *
280a159c266SJung-uk Kim  * PARAMETERS:  ObjDesc             - The method object
281a159c266SJung-uk Kim  *
282a159c266SJung-uk Kim  * RETURN:      Status
283a159c266SJung-uk Kim  *
284a159c266SJung-uk Kim  * DESCRIPTION: Create a mutex object for a serialized control method
285a159c266SJung-uk Kim  *
286a159c266SJung-uk Kim  ******************************************************************************/
287a159c266SJung-uk Kim 
288a159c266SJung-uk Kim static ACPI_STATUS
289a159c266SJung-uk Kim AcpiDsCreateMethodMutex (
290a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MethodDesc)
291a159c266SJung-uk Kim {
292a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MutexDesc;
293a159c266SJung-uk Kim     ACPI_STATUS             Status;
294a159c266SJung-uk Kim 
295a159c266SJung-uk Kim 
296a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (DsCreateMethodMutex);
297a159c266SJung-uk Kim 
298a159c266SJung-uk Kim 
299a159c266SJung-uk Kim     /* Create the new mutex object */
300a159c266SJung-uk Kim 
301a159c266SJung-uk Kim     MutexDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
302a159c266SJung-uk Kim     if (!MutexDesc)
303a159c266SJung-uk Kim     {
304a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
305a159c266SJung-uk Kim     }
306a159c266SJung-uk Kim 
307a159c266SJung-uk Kim     /* Create the actual OS Mutex */
308a159c266SJung-uk Kim 
309a159c266SJung-uk Kim     Status = AcpiOsCreateMutex (&MutexDesc->Mutex.OsMutex);
310a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
311a159c266SJung-uk Kim     {
312efcc2a30SJung-uk Kim         AcpiUtDeleteObjectDesc (MutexDesc);
313a159c266SJung-uk Kim         return_ACPI_STATUS (Status);
314a159c266SJung-uk Kim     }
315a159c266SJung-uk Kim 
316a159c266SJung-uk Kim     MutexDesc->Mutex.SyncLevel = MethodDesc->Method.SyncLevel;
317a159c266SJung-uk Kim     MethodDesc->Method.Mutex = MutexDesc;
318a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
319a159c266SJung-uk Kim }
320a159c266SJung-uk Kim 
321a159c266SJung-uk Kim 
322a159c266SJung-uk Kim /*******************************************************************************
323a159c266SJung-uk Kim  *
324a159c266SJung-uk Kim  * FUNCTION:    AcpiDsBeginMethodExecution
325a159c266SJung-uk Kim  *
326a159c266SJung-uk Kim  * PARAMETERS:  MethodNode          - Node of the method
327a159c266SJung-uk Kim  *              ObjDesc             - The method object
328a159c266SJung-uk Kim  *              WalkState           - current state, NULL if not yet executing
329a159c266SJung-uk Kim  *                                    a method.
330a159c266SJung-uk Kim  *
331a159c266SJung-uk Kim  * RETURN:      Status
332a159c266SJung-uk Kim  *
333a159c266SJung-uk Kim  * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
334a159c266SJung-uk Kim  *              increments the thread count, and waits at the method semaphore
335a159c266SJung-uk Kim  *              for clearance to execute.
336a159c266SJung-uk Kim  *
337a159c266SJung-uk Kim  ******************************************************************************/
338a159c266SJung-uk Kim 
339a159c266SJung-uk Kim ACPI_STATUS
340a159c266SJung-uk Kim AcpiDsBeginMethodExecution (
341a159c266SJung-uk Kim     ACPI_NAMESPACE_NODE     *MethodNode,
342a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc,
343a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
344a159c266SJung-uk Kim {
345a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
346a159c266SJung-uk Kim 
347a159c266SJung-uk Kim 
348a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsBeginMethodExecution, MethodNode);
349a159c266SJung-uk Kim 
350a159c266SJung-uk Kim 
351a159c266SJung-uk Kim     if (!MethodNode)
352a159c266SJung-uk Kim     {
353a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NULL_ENTRY);
354a159c266SJung-uk Kim     }
355a159c266SJung-uk Kim 
356a159c266SJung-uk Kim     /* Prevent wraparound of thread count */
357a159c266SJung-uk Kim 
358a159c266SJung-uk Kim     if (ObjDesc->Method.ThreadCount == ACPI_UINT8_MAX)
359a159c266SJung-uk Kim     {
360a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
361a159c266SJung-uk Kim             "Method reached maximum reentrancy limit (255)"));
362a159c266SJung-uk Kim         return_ACPI_STATUS (AE_AML_METHOD_LIMIT);
363a159c266SJung-uk Kim     }
364a159c266SJung-uk Kim 
365a159c266SJung-uk Kim     /*
366a159c266SJung-uk Kim      * If this method is serialized, we need to acquire the method mutex.
367a159c266SJung-uk Kim      */
368a159c266SJung-uk Kim     if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
369a159c266SJung-uk Kim     {
370a159c266SJung-uk Kim         /*
371a159c266SJung-uk Kim          * Create a mutex for the method if it is defined to be Serialized
372a159c266SJung-uk Kim          * and a mutex has not already been created. We defer the mutex creation
373a159c266SJung-uk Kim          * until a method is actually executed, to minimize the object count
374a159c266SJung-uk Kim          */
375a159c266SJung-uk Kim         if (!ObjDesc->Method.Mutex)
376a159c266SJung-uk Kim         {
377a159c266SJung-uk Kim             Status = AcpiDsCreateMethodMutex (ObjDesc);
378a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
379a159c266SJung-uk Kim             {
380a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
381a159c266SJung-uk Kim             }
382a159c266SJung-uk Kim         }
383a159c266SJung-uk Kim 
384a159c266SJung-uk Kim         /*
385a159c266SJung-uk Kim          * The CurrentSyncLevel (per-thread) must be less than or equal to
386a159c266SJung-uk Kim          * the sync level of the method. This mechanism provides some
387*313a0c13SJung-uk Kim          * deadlock prevention.
388*313a0c13SJung-uk Kim          *
389*313a0c13SJung-uk Kim          * If the method was auto-serialized, we just ignore the sync level
390*313a0c13SJung-uk Kim          * mechanism, because auto-serialization of methods can interfere
391*313a0c13SJung-uk Kim          * with ASL code that actually uses sync levels.
392a159c266SJung-uk Kim          *
393a159c266SJung-uk Kim          * Top-level method invocation has no walk state at this point
394a159c266SJung-uk Kim          */
395a159c266SJung-uk Kim         if (WalkState &&
396*313a0c13SJung-uk Kim             (!(ObjDesc->Method.InfoFlags & ACPI_METHOD_IGNORE_SYNC_LEVEL)) &&
397a159c266SJung-uk Kim             (WalkState->Thread->CurrentSyncLevel > ObjDesc->Method.Mutex->Mutex.SyncLevel))
398a159c266SJung-uk Kim         {
399a159c266SJung-uk Kim             ACPI_ERROR ((AE_INFO,
400a159c266SJung-uk Kim                 "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
401a159c266SJung-uk Kim                 AcpiUtGetNodeName (MethodNode),
402a159c266SJung-uk Kim                 WalkState->Thread->CurrentSyncLevel));
403a159c266SJung-uk Kim 
404a159c266SJung-uk Kim             return_ACPI_STATUS (AE_AML_MUTEX_ORDER);
405a159c266SJung-uk Kim         }
406a159c266SJung-uk Kim 
407a159c266SJung-uk Kim         /*
408a159c266SJung-uk Kim          * Obtain the method mutex if necessary. Do not acquire mutex for a
409a159c266SJung-uk Kim          * recursive call.
410a159c266SJung-uk Kim          */
411a159c266SJung-uk Kim         if (!WalkState ||
412a159c266SJung-uk Kim             !ObjDesc->Method.Mutex->Mutex.ThreadId ||
413a159c266SJung-uk Kim             (WalkState->Thread->ThreadId != ObjDesc->Method.Mutex->Mutex.ThreadId))
414a159c266SJung-uk Kim         {
415a159c266SJung-uk Kim             /*
416a159c266SJung-uk Kim              * Acquire the method mutex. This releases the interpreter if we
417a159c266SJung-uk Kim              * block (and reacquires it before it returns)
418a159c266SJung-uk Kim              */
419a159c266SJung-uk Kim             Status = AcpiExSystemWaitMutex (ObjDesc->Method.Mutex->Mutex.OsMutex,
420a159c266SJung-uk Kim                         ACPI_WAIT_FOREVER);
421a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
422a159c266SJung-uk Kim             {
423a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
424a159c266SJung-uk Kim             }
425a159c266SJung-uk Kim 
426a159c266SJung-uk Kim             /* Update the mutex and walk info and save the original SyncLevel */
427a159c266SJung-uk Kim 
428a159c266SJung-uk Kim             if (WalkState)
429a159c266SJung-uk Kim             {
430a159c266SJung-uk Kim                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
431a159c266SJung-uk Kim                     WalkState->Thread->CurrentSyncLevel;
432a159c266SJung-uk Kim 
433a159c266SJung-uk Kim                 ObjDesc->Method.Mutex->Mutex.ThreadId = WalkState->Thread->ThreadId;
434a159c266SJung-uk Kim                 WalkState->Thread->CurrentSyncLevel = ObjDesc->Method.SyncLevel;
435a159c266SJung-uk Kim             }
436a159c266SJung-uk Kim             else
437a159c266SJung-uk Kim             {
438a159c266SJung-uk Kim                 ObjDesc->Method.Mutex->Mutex.OriginalSyncLevel =
439a159c266SJung-uk Kim                     ObjDesc->Method.Mutex->Mutex.SyncLevel;
440a159c266SJung-uk Kim             }
441a159c266SJung-uk Kim         }
442a159c266SJung-uk Kim 
443a159c266SJung-uk Kim         /* Always increase acquisition depth */
444a159c266SJung-uk Kim 
445a159c266SJung-uk Kim         ObjDesc->Method.Mutex->Mutex.AcquisitionDepth++;
446a159c266SJung-uk Kim     }
447a159c266SJung-uk Kim 
448a159c266SJung-uk Kim     /*
449a159c266SJung-uk Kim      * Allocate an Owner ID for this method, only if this is the first thread
450a159c266SJung-uk Kim      * to begin concurrent execution. We only need one OwnerId, even if the
451a159c266SJung-uk Kim      * method is invoked recursively.
452a159c266SJung-uk Kim      */
453a159c266SJung-uk Kim     if (!ObjDesc->Method.OwnerId)
454a159c266SJung-uk Kim     {
455a159c266SJung-uk Kim         Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId);
456a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
457a159c266SJung-uk Kim         {
458a159c266SJung-uk Kim             goto Cleanup;
459a159c266SJung-uk Kim         }
460a159c266SJung-uk Kim     }
461a159c266SJung-uk Kim 
462a159c266SJung-uk Kim     /*
463a159c266SJung-uk Kim      * Increment the method parse tree thread count since it has been
464a159c266SJung-uk Kim      * reentered one more time (even if it is the same thread)
465a159c266SJung-uk Kim      */
466a159c266SJung-uk Kim     ObjDesc->Method.ThreadCount++;
467a159c266SJung-uk Kim     AcpiMethodCount++;
468a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
469a159c266SJung-uk Kim 
470a159c266SJung-uk Kim 
471a159c266SJung-uk Kim Cleanup:
472a159c266SJung-uk Kim     /* On error, must release the method mutex (if present) */
473a159c266SJung-uk Kim 
474a159c266SJung-uk Kim     if (ObjDesc->Method.Mutex)
475a159c266SJung-uk Kim     {
476a159c266SJung-uk Kim         AcpiOsReleaseMutex (ObjDesc->Method.Mutex->Mutex.OsMutex);
477a159c266SJung-uk Kim     }
478a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
479a159c266SJung-uk Kim }
480a159c266SJung-uk Kim 
481a159c266SJung-uk Kim 
482a159c266SJung-uk Kim /*******************************************************************************
483a159c266SJung-uk Kim  *
484a159c266SJung-uk Kim  * FUNCTION:    AcpiDsCallControlMethod
485a159c266SJung-uk Kim  *
486a159c266SJung-uk Kim  * PARAMETERS:  Thread              - Info for this thread
487a159c266SJung-uk Kim  *              ThisWalkState       - Current walk state
488a159c266SJung-uk Kim  *              Op                  - Current Op to be walked
489a159c266SJung-uk Kim  *
490a159c266SJung-uk Kim  * RETURN:      Status
491a159c266SJung-uk Kim  *
492a159c266SJung-uk Kim  * DESCRIPTION: Transfer execution to a called control method
493a159c266SJung-uk Kim  *
494a159c266SJung-uk Kim  ******************************************************************************/
495a159c266SJung-uk Kim 
496a159c266SJung-uk Kim ACPI_STATUS
497a159c266SJung-uk Kim AcpiDsCallControlMethod (
498a159c266SJung-uk Kim     ACPI_THREAD_STATE       *Thread,
499a159c266SJung-uk Kim     ACPI_WALK_STATE         *ThisWalkState,
500a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op)
501a159c266SJung-uk Kim {
502a159c266SJung-uk Kim     ACPI_STATUS             Status;
503a159c266SJung-uk Kim     ACPI_NAMESPACE_NODE     *MethodNode;
504a159c266SJung-uk Kim     ACPI_WALK_STATE         *NextWalkState = NULL;
505a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc;
506a159c266SJung-uk Kim     ACPI_EVALUATE_INFO      *Info;
507a159c266SJung-uk Kim     UINT32                  i;
508a159c266SJung-uk Kim 
509a159c266SJung-uk Kim 
510a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsCallControlMethod, ThisWalkState);
511a159c266SJung-uk Kim 
512a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Calling method %p, currentstate=%p\n",
513a159c266SJung-uk Kim         ThisWalkState->PrevOp, ThisWalkState));
514a159c266SJung-uk Kim 
515a159c266SJung-uk Kim     /*
516a159c266SJung-uk Kim      * Get the namespace entry for the control method we are about to call
517a159c266SJung-uk Kim      */
518a159c266SJung-uk Kim     MethodNode = ThisWalkState->MethodCallNode;
519a159c266SJung-uk Kim     if (!MethodNode)
520a159c266SJung-uk Kim     {
521a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NULL_ENTRY);
522a159c266SJung-uk Kim     }
523a159c266SJung-uk Kim 
524a159c266SJung-uk Kim     ObjDesc = AcpiNsGetAttachedObject (MethodNode);
525a159c266SJung-uk Kim     if (!ObjDesc)
526a159c266SJung-uk Kim     {
527a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NULL_OBJECT);
528a159c266SJung-uk Kim     }
529a159c266SJung-uk Kim 
530a159c266SJung-uk Kim     /* Init for new method, possibly wait on method mutex */
531a159c266SJung-uk Kim 
532a159c266SJung-uk Kim     Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc,
533a159c266SJung-uk Kim                 ThisWalkState);
534a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
535a159c266SJung-uk Kim     {
536a159c266SJung-uk Kim         return_ACPI_STATUS (Status);
537a159c266SJung-uk Kim     }
538a159c266SJung-uk Kim 
539a159c266SJung-uk Kim     /* Begin method parse/execution. Create a new walk state */
540a159c266SJung-uk Kim 
541a159c266SJung-uk Kim     NextWalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwnerId,
542a159c266SJung-uk Kim                         NULL, ObjDesc, Thread);
543a159c266SJung-uk Kim     if (!NextWalkState)
544a159c266SJung-uk Kim     {
545a159c266SJung-uk Kim         Status = AE_NO_MEMORY;
546a159c266SJung-uk Kim         goto Cleanup;
547a159c266SJung-uk Kim     }
548a159c266SJung-uk Kim 
549a159c266SJung-uk Kim     /*
550a159c266SJung-uk Kim      * The resolved arguments were put on the previous walk state's operand
551a159c266SJung-uk Kim      * stack. Operands on the previous walk state stack always
552a159c266SJung-uk Kim      * start at index 0. Also, null terminate the list of arguments
553a159c266SJung-uk Kim      */
554a159c266SJung-uk Kim     ThisWalkState->Operands [ThisWalkState->NumOperands] = NULL;
555a159c266SJung-uk Kim 
556a159c266SJung-uk Kim     /*
557a159c266SJung-uk Kim      * Allocate and initialize the evaluation information block
558a159c266SJung-uk Kim      * TBD: this is somewhat inefficient, should change interface to
559a159c266SJung-uk Kim      * DsInitAmlWalk. For now, keeps this struct off the CPU stack
560a159c266SJung-uk Kim      */
561a159c266SJung-uk Kim     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
562a159c266SJung-uk Kim     if (!Info)
563a159c266SJung-uk Kim     {
564ed17e06eSJung-uk Kim         Status = AE_NO_MEMORY;
565ed17e06eSJung-uk Kim         goto Cleanup;
566a159c266SJung-uk Kim     }
567a159c266SJung-uk Kim 
568a159c266SJung-uk Kim     Info->Parameters = &ThisWalkState->Operands[0];
569a159c266SJung-uk Kim 
570a159c266SJung-uk Kim     Status = AcpiDsInitAmlWalk (NextWalkState, NULL, MethodNode,
571a159c266SJung-uk Kim                 ObjDesc->Method.AmlStart, ObjDesc->Method.AmlLength,
572a159c266SJung-uk Kim                 Info, ACPI_IMODE_EXECUTE);
573a159c266SJung-uk Kim 
574a159c266SJung-uk Kim     ACPI_FREE (Info);
575a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
576a159c266SJung-uk Kim     {
577a159c266SJung-uk Kim         goto Cleanup;
578a159c266SJung-uk Kim     }
579a159c266SJung-uk Kim 
580a159c266SJung-uk Kim     /*
581a159c266SJung-uk Kim      * Delete the operands on the previous walkstate operand stack
582a159c266SJung-uk Kim      * (they were copied to new objects)
583a159c266SJung-uk Kim      */
584a159c266SJung-uk Kim     for (i = 0; i < ObjDesc->Method.ParamCount; i++)
585a159c266SJung-uk Kim     {
586a159c266SJung-uk Kim         AcpiUtRemoveReference (ThisWalkState->Operands [i]);
587a159c266SJung-uk Kim         ThisWalkState->Operands [i] = NULL;
588a159c266SJung-uk Kim     }
589a159c266SJung-uk Kim 
590a159c266SJung-uk Kim     /* Clear the operand stack */
591a159c266SJung-uk Kim 
592a159c266SJung-uk Kim     ThisWalkState->NumOperands = 0;
593a159c266SJung-uk Kim 
594a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
595a159c266SJung-uk Kim         "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
596a159c266SJung-uk Kim         MethodNode->Name.Ascii, NextWalkState));
597a159c266SJung-uk Kim 
598a159c266SJung-uk Kim     /* Invoke an internal method if necessary */
599a159c266SJung-uk Kim 
600a159c266SJung-uk Kim     if (ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
601a159c266SJung-uk Kim     {
602a159c266SJung-uk Kim         Status = ObjDesc->Method.Dispatch.Implementation (NextWalkState);
603a159c266SJung-uk Kim         if (Status == AE_OK)
604a159c266SJung-uk Kim         {
605a159c266SJung-uk Kim             Status = AE_CTRL_TERMINATE;
606a159c266SJung-uk Kim         }
607a159c266SJung-uk Kim     }
608a159c266SJung-uk Kim 
609a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
610a159c266SJung-uk Kim 
611a159c266SJung-uk Kim 
612a159c266SJung-uk Kim Cleanup:
613a159c266SJung-uk Kim 
614a159c266SJung-uk Kim     /* On error, we must terminate the method properly */
615a159c266SJung-uk Kim 
616a159c266SJung-uk Kim     AcpiDsTerminateControlMethod (ObjDesc, NextWalkState);
617a159c266SJung-uk Kim     if (NextWalkState)
618a159c266SJung-uk Kim     {
619a159c266SJung-uk Kim         AcpiDsDeleteWalkState (NextWalkState);
620a159c266SJung-uk Kim     }
621a159c266SJung-uk Kim 
622a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
623a159c266SJung-uk Kim }
624a159c266SJung-uk Kim 
625a159c266SJung-uk Kim 
626a159c266SJung-uk Kim /*******************************************************************************
627a159c266SJung-uk Kim  *
628a159c266SJung-uk Kim  * FUNCTION:    AcpiDsRestartControlMethod
629a159c266SJung-uk Kim  *
630a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - State for preempted method (caller)
631a159c266SJung-uk Kim  *              ReturnDesc          - Return value from the called method
632a159c266SJung-uk Kim  *
633a159c266SJung-uk Kim  * RETURN:      Status
634a159c266SJung-uk Kim  *
635a159c266SJung-uk Kim  * DESCRIPTION: Restart a method that was preempted by another (nested) method
636a159c266SJung-uk Kim  *              invocation. Handle the return value (if any) from the callee.
637a159c266SJung-uk Kim  *
638a159c266SJung-uk Kim  ******************************************************************************/
639a159c266SJung-uk Kim 
640a159c266SJung-uk Kim ACPI_STATUS
641a159c266SJung-uk Kim AcpiDsRestartControlMethod (
642a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
643a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ReturnDesc)
644a159c266SJung-uk Kim {
645a159c266SJung-uk Kim     ACPI_STATUS             Status;
646a159c266SJung-uk Kim     int                     SameAsImplicitReturn;
647a159c266SJung-uk Kim 
648a159c266SJung-uk Kim 
649a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsRestartControlMethod, WalkState);
650a159c266SJung-uk Kim 
651a159c266SJung-uk Kim 
652a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
653a159c266SJung-uk Kim         "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
654a159c266SJung-uk Kim         AcpiUtGetNodeName (WalkState->MethodNode),
655a159c266SJung-uk Kim         WalkState->MethodCallOp, ReturnDesc));
656a159c266SJung-uk Kim 
657a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
658a159c266SJung-uk Kim         "    ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
659a159c266SJung-uk Kim         WalkState->ReturnUsed,
660a159c266SJung-uk Kim         WalkState->Results, WalkState));
661a159c266SJung-uk Kim 
662a159c266SJung-uk Kim     /* Did the called method return a value? */
663a159c266SJung-uk Kim 
664a159c266SJung-uk Kim     if (ReturnDesc)
665a159c266SJung-uk Kim     {
666a159c266SJung-uk Kim         /* Is the implicit return object the same as the return desc? */
667a159c266SJung-uk Kim 
668a159c266SJung-uk Kim         SameAsImplicitReturn = (WalkState->ImplicitReturnObj == ReturnDesc);
669a159c266SJung-uk Kim 
670a159c266SJung-uk Kim         /* Are we actually going to use the return value? */
671a159c266SJung-uk Kim 
672a159c266SJung-uk Kim         if (WalkState->ReturnUsed)
673a159c266SJung-uk Kim         {
674a159c266SJung-uk Kim             /* Save the return value from the previous method */
675a159c266SJung-uk Kim 
676a159c266SJung-uk Kim             Status = AcpiDsResultPush (ReturnDesc, WalkState);
677a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
678a159c266SJung-uk Kim             {
679a159c266SJung-uk Kim                 AcpiUtRemoveReference (ReturnDesc);
680a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
681a159c266SJung-uk Kim             }
682a159c266SJung-uk Kim 
683a159c266SJung-uk Kim             /*
684a159c266SJung-uk Kim              * Save as THIS method's return value in case it is returned
685a159c266SJung-uk Kim              * immediately to yet another method
686a159c266SJung-uk Kim              */
687a159c266SJung-uk Kim             WalkState->ReturnDesc = ReturnDesc;
688a159c266SJung-uk Kim         }
689a159c266SJung-uk Kim 
690a159c266SJung-uk Kim         /*
691a159c266SJung-uk Kim          * The following code is the optional support for the so-called
692a159c266SJung-uk Kim          * "implicit return". Some AML code assumes that the last value of the
693a159c266SJung-uk Kim          * method is "implicitly" returned to the caller, in the absence of an
694a159c266SJung-uk Kim          * explicit return value.
695a159c266SJung-uk Kim          *
696a159c266SJung-uk Kim          * Just save the last result of the method as the return value.
697a159c266SJung-uk Kim          *
698a159c266SJung-uk Kim          * NOTE: this is optional because the ASL language does not actually
699a159c266SJung-uk Kim          * support this behavior.
700a159c266SJung-uk Kim          */
701a159c266SJung-uk Kim         else if (!AcpiDsDoImplicitReturn (ReturnDesc, WalkState, FALSE) ||
702a159c266SJung-uk Kim                  SameAsImplicitReturn)
703a159c266SJung-uk Kim         {
704a159c266SJung-uk Kim             /*
705a159c266SJung-uk Kim              * Delete the return value if it will not be used by the
706a159c266SJung-uk Kim              * calling method or remove one reference if the explicit return
707a159c266SJung-uk Kim              * is the same as the implicit return value.
708a159c266SJung-uk Kim              */
709a159c266SJung-uk Kim             AcpiUtRemoveReference (ReturnDesc);
710a159c266SJung-uk Kim         }
711a159c266SJung-uk Kim     }
712a159c266SJung-uk Kim 
713a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
714a159c266SJung-uk Kim }
715a159c266SJung-uk Kim 
716a159c266SJung-uk Kim 
717a159c266SJung-uk Kim /*******************************************************************************
718a159c266SJung-uk Kim  *
719a159c266SJung-uk Kim  * FUNCTION:    AcpiDsTerminateControlMethod
720a159c266SJung-uk Kim  *
721a159c266SJung-uk Kim  * PARAMETERS:  MethodDesc          - Method object
722a159c266SJung-uk Kim  *              WalkState           - State associated with the method
723a159c266SJung-uk Kim  *
724a159c266SJung-uk Kim  * RETURN:      None
725a159c266SJung-uk Kim  *
726a159c266SJung-uk Kim  * DESCRIPTION: Terminate a control method. Delete everything that the method
727a159c266SJung-uk Kim  *              created, delete all locals and arguments, and delete the parse
728a159c266SJung-uk Kim  *              tree if requested.
729a159c266SJung-uk Kim  *
730a159c266SJung-uk Kim  * MUTEX:       Interpreter is locked
731a159c266SJung-uk Kim  *
732a159c266SJung-uk Kim  ******************************************************************************/
733a159c266SJung-uk Kim 
734a159c266SJung-uk Kim void
735a159c266SJung-uk Kim AcpiDsTerminateControlMethod (
736a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *MethodDesc,
737a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
738a159c266SJung-uk Kim {
739a159c266SJung-uk Kim 
740a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsTerminateControlMethod, WalkState);
741a159c266SJung-uk Kim 
742a159c266SJung-uk Kim 
743a159c266SJung-uk Kim     /* MethodDesc is required, WalkState is optional */
744a159c266SJung-uk Kim 
745a159c266SJung-uk Kim     if (!MethodDesc)
746a159c266SJung-uk Kim     {
747a159c266SJung-uk Kim         return_VOID;
748a159c266SJung-uk Kim     }
749a159c266SJung-uk Kim 
750a159c266SJung-uk Kim     if (WalkState)
751a159c266SJung-uk Kim     {
752a159c266SJung-uk Kim         /* Delete all arguments and locals */
753a159c266SJung-uk Kim 
754a159c266SJung-uk Kim         AcpiDsMethodDataDeleteAll (WalkState);
755a159c266SJung-uk Kim 
756a159c266SJung-uk Kim         /*
757a159c266SJung-uk Kim          * If method is serialized, release the mutex and restore the
758a159c266SJung-uk Kim          * current sync level for this thread
759a159c266SJung-uk Kim          */
760a159c266SJung-uk Kim         if (MethodDesc->Method.Mutex)
761a159c266SJung-uk Kim         {
762a159c266SJung-uk Kim             /* Acquisition Depth handles recursive calls */
763a159c266SJung-uk Kim 
764a159c266SJung-uk Kim             MethodDesc->Method.Mutex->Mutex.AcquisitionDepth--;
765a159c266SJung-uk Kim             if (!MethodDesc->Method.Mutex->Mutex.AcquisitionDepth)
766a159c266SJung-uk Kim             {
767a159c266SJung-uk Kim                 WalkState->Thread->CurrentSyncLevel =
768a159c266SJung-uk Kim                     MethodDesc->Method.Mutex->Mutex.OriginalSyncLevel;
769a159c266SJung-uk Kim 
770a159c266SJung-uk Kim                 AcpiOsReleaseMutex (MethodDesc->Method.Mutex->Mutex.OsMutex);
771a159c266SJung-uk Kim                 MethodDesc->Method.Mutex->Mutex.ThreadId = 0;
772a159c266SJung-uk Kim             }
773a159c266SJung-uk Kim         }
774a159c266SJung-uk Kim 
775a159c266SJung-uk Kim         /*
776a159c266SJung-uk Kim          * Delete any namespace objects created anywhere within the
777a159c266SJung-uk Kim          * namespace by the execution of this method. Unless:
778a159c266SJung-uk Kim          * 1) This method is a module-level executable code method, in which
779a159c266SJung-uk Kim          *    case we want make the objects permanent.
780a159c266SJung-uk Kim          * 2) There are other threads executing the method, in which case we
781a159c266SJung-uk Kim          *    will wait until the last thread has completed.
782a159c266SJung-uk Kim          */
783a159c266SJung-uk Kim         if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL) &&
784a159c266SJung-uk Kim              (MethodDesc->Method.ThreadCount == 1))
785a159c266SJung-uk Kim         {
786a159c266SJung-uk Kim             /* Delete any direct children of (created by) this method */
787a159c266SJung-uk Kim 
788a159c266SJung-uk Kim             AcpiNsDeleteNamespaceSubtree (WalkState->MethodNode);
789a159c266SJung-uk Kim 
790a159c266SJung-uk Kim             /*
791a159c266SJung-uk Kim              * Delete any objects that were created by this method
792a159c266SJung-uk Kim              * elsewhere in the namespace (if any were created).
793a159c266SJung-uk Kim              * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
794a159c266SJung-uk Kim              * deletion such that we don't have to perform an entire
795a159c266SJung-uk Kim              * namespace walk for every control method execution.
796a159c266SJung-uk Kim              */
797a159c266SJung-uk Kim             if (MethodDesc->Method.InfoFlags & ACPI_METHOD_MODIFIED_NAMESPACE)
798a159c266SJung-uk Kim             {
799a159c266SJung-uk Kim                 AcpiNsDeleteNamespaceByOwner (MethodDesc->Method.OwnerId);
800a159c266SJung-uk Kim                 MethodDesc->Method.InfoFlags &= ~ACPI_METHOD_MODIFIED_NAMESPACE;
801a159c266SJung-uk Kim             }
802a159c266SJung-uk Kim         }
803a159c266SJung-uk Kim     }
804a159c266SJung-uk Kim 
805a159c266SJung-uk Kim     /* Decrement the thread count on the method */
806a159c266SJung-uk Kim 
807a159c266SJung-uk Kim     if (MethodDesc->Method.ThreadCount)
808a159c266SJung-uk Kim     {
809a159c266SJung-uk Kim         MethodDesc->Method.ThreadCount--;
810a159c266SJung-uk Kim     }
811a159c266SJung-uk Kim     else
812a159c266SJung-uk Kim     {
813a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
814a159c266SJung-uk Kim             "Invalid zero thread count in method"));
815a159c266SJung-uk Kim     }
816a159c266SJung-uk Kim 
817a159c266SJung-uk Kim     /* Are there any other threads currently executing this method? */
818a159c266SJung-uk Kim 
819a159c266SJung-uk Kim     if (MethodDesc->Method.ThreadCount)
820a159c266SJung-uk Kim     {
821a159c266SJung-uk Kim         /*
822a159c266SJung-uk Kim          * Additional threads. Do not release the OwnerId in this case,
823a159c266SJung-uk Kim          * we immediately reuse it for the next thread executing this method
824a159c266SJung-uk Kim          */
825a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
826a159c266SJung-uk Kim             "*** Completed execution of one thread, %u threads remaining\n",
827a159c266SJung-uk Kim             MethodDesc->Method.ThreadCount));
828a159c266SJung-uk Kim     }
829a159c266SJung-uk Kim     else
830a159c266SJung-uk Kim     {
831a159c266SJung-uk Kim         /* This is the only executing thread for this method */
832a159c266SJung-uk Kim 
833a159c266SJung-uk Kim         /*
834a159c266SJung-uk Kim          * Support to dynamically change a method from NotSerialized to
835a159c266SJung-uk Kim          * Serialized if it appears that the method is incorrectly written and
836a159c266SJung-uk Kim          * does not support multiple thread execution. The best example of this
837a159c266SJung-uk Kim          * is if such a method creates namespace objects and blocks. A second
838a159c266SJung-uk Kim          * thread will fail with an AE_ALREADY_EXISTS exception.
839a159c266SJung-uk Kim          *
840a159c266SJung-uk Kim          * This code is here because we must wait until the last thread exits
841a159c266SJung-uk Kim          * before marking the method as serialized.
842a159c266SJung-uk Kim          */
843a159c266SJung-uk Kim         if (MethodDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED_PENDING)
844a159c266SJung-uk Kim         {
845a159c266SJung-uk Kim             if (WalkState)
846a159c266SJung-uk Kim             {
847a159c266SJung-uk Kim                 ACPI_INFO ((AE_INFO,
848a159c266SJung-uk Kim                     "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
849a159c266SJung-uk Kim                     WalkState->MethodNode->Name.Ascii));
850a159c266SJung-uk Kim             }
851a159c266SJung-uk Kim 
852a159c266SJung-uk Kim             /*
853a159c266SJung-uk Kim              * Method tried to create an object twice and was marked as
854a159c266SJung-uk Kim              * "pending serialized". The probable cause is that the method
855a159c266SJung-uk Kim              * cannot handle reentrancy.
856a159c266SJung-uk Kim              *
857a159c266SJung-uk Kim              * The method was created as NotSerialized, but it tried to create
858a159c266SJung-uk Kim              * a named object and then blocked, causing the second thread
859a159c266SJung-uk Kim              * entrance to begin and then fail. Workaround this problem by
860a159c266SJung-uk Kim              * marking the method permanently as Serialized when the last
861a159c266SJung-uk Kim              * thread exits here.
862a159c266SJung-uk Kim              */
863a159c266SJung-uk Kim             MethodDesc->Method.InfoFlags &= ~ACPI_METHOD_SERIALIZED_PENDING;
864*313a0c13SJung-uk Kim             MethodDesc->Method.InfoFlags |=
865*313a0c13SJung-uk Kim                 (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
866a159c266SJung-uk Kim             MethodDesc->Method.SyncLevel = 0;
867a159c266SJung-uk Kim         }
868a159c266SJung-uk Kim 
869a159c266SJung-uk Kim         /* No more threads, we can free the OwnerId */
870a159c266SJung-uk Kim 
871a159c266SJung-uk Kim         if (!(MethodDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL))
872a159c266SJung-uk Kim         {
873a159c266SJung-uk Kim             AcpiUtReleaseOwnerId (&MethodDesc->Method.OwnerId);
874a159c266SJung-uk Kim         }
875a159c266SJung-uk Kim     }
876a159c266SJung-uk Kim 
877a159c266SJung-uk Kim     return_VOID;
878a159c266SJung-uk Kim }
879