1 /*******************************************************************************
3 * Module Name: nseval - Object evaluation, includes control method execution
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
51 #define _COMPONENT ACPI_NAMESPACE
52 ACPI_MODULE_NAME ("nseval")
54 /* Local prototypes */
57 AcpiNsExecModuleCode (
58 ACPI_OPERAND_OBJECT *MethodObj,
59 ACPI_EVALUATE_INFO *Info);
62 /*******************************************************************************
64 * FUNCTION: AcpiNsEvaluate
66 * PARAMETERS: Info - Evaluation info block, contains:
67 * PrefixNode - Prefix or Method/Object Node to execute
68 * RelativePath - Name of method to execute, If NULL, the
69 * Node is the object to execute
70 * Parameters - List of parameters to pass to the method,
71 * terminated by NULL. Params itself may be
72 * NULL if no parameters are being passed.
73 * ReturnObject - Where to put method's return value (if
74 * any). If NULL, no value is returned.
75 * ParameterType - Type of Parameter list
76 * ReturnObject - Where to put method's return value (if
77 * any). If NULL, no value is returned.
78 * Flags - ACPI_IGNORE_RETURN_VALUE to delete return
82 * DESCRIPTION: Execute a control method or return the current value of an
83 * ACPI namespace object.
85 * MUTEX: Locks interpreter
87 ******************************************************************************/
91 ACPI_EVALUATE_INFO *Info)
96 ACPI_FUNCTION_TRACE (NsEvaluate);
101 return_ACPI_STATUS (AE_BAD_PARAMETER);
107 * Get the actual namespace node for the target object if we
108 * need to. Handles these cases:
110 * 1) Null node, valid pathname from root (absolute path)
111 * 2) Node and valid pathname (path relative to Node)
112 * 3) Node, Null pathname
114 Status = AcpiNsGetNode (Info->PrefixNode, Info->RelativePathname,
115 ACPI_NS_NO_UPSEARCH, &Info->Node);
116 if (ACPI_FAILURE (Status))
118 return_ACPI_STATUS (Status);
123 * For a method alias, we must grab the actual method node so that
124 * proper scoping context will be established before execution.
126 if (AcpiNsGetType (Info->Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS)
128 Info->Node = ACPI_CAST_PTR (
129 ACPI_NAMESPACE_NODE, Info->Node->Object);
132 /* Complete the info block initialization */
134 Info->ReturnObject = NULL;
135 Info->NodeFlags = Info->Node->Flags;
136 Info->ObjDesc = AcpiNsGetAttachedObject (Info->Node);
138 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%s [%p] Value %p\n",
139 Info->RelativePathname, Info->Node,
140 AcpiNsGetAttachedObject (Info->Node)));
142 /* Get info if we have a predefined name (_HID, etc.) */
144 Info->Predefined = AcpiUtMatchPredefinedMethod (Info->Node->Name.Ascii);
146 /* Get the full pathname to the object, for use in warning messages */
148 Info->FullPathname = AcpiNsGetExternalPathname (Info->Node);
149 if (!Info->FullPathname)
151 return_ACPI_STATUS (AE_NO_MEMORY);
154 /* Count the number of arguments being passed in */
156 Info->ParamCount = 0;
157 if (Info->Parameters)
159 while (Info->Parameters[Info->ParamCount])
164 /* Warn on impossible argument count */
166 if (Info->ParamCount > ACPI_METHOD_NUM_ARGS)
168 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS,
169 "Excess arguments (%u) - using only %u",
170 Info->ParamCount, ACPI_METHOD_NUM_ARGS));
172 Info->ParamCount = ACPI_METHOD_NUM_ARGS;
177 * For predefined names: Check that the declared argument count
178 * matches the ACPI spec -- otherwise this is a BIOS error.
180 AcpiNsCheckAcpiCompliance (Info->FullPathname, Info->Node,
184 * For all names: Check that the incoming argument count for
185 * this method/object matches the actual ASL/AML definition.
187 AcpiNsCheckArgumentCount (Info->FullPathname, Info->Node,
188 Info->ParamCount, Info->Predefined);
190 /* For predefined names: Typecheck all incoming arguments */
192 AcpiNsCheckArgumentTypes (Info);
195 * Three major evaluation cases:
197 * 1) Object types that cannot be evaluated by definition
198 * 2) The object is a control method -- execute it
199 * 3) The object is not a method -- just return it's current value
201 switch (AcpiNsGetType (Info->Node))
203 case ACPI_TYPE_DEVICE:
204 case ACPI_TYPE_EVENT:
205 case ACPI_TYPE_MUTEX:
206 case ACPI_TYPE_REGION:
207 case ACPI_TYPE_THERMAL:
208 case ACPI_TYPE_LOCAL_SCOPE:
210 * 1) Disallow evaluation of certain object types. For these,
211 * object evaluation is undefined and not supported.
213 ACPI_ERROR ((AE_INFO,
214 "%s: Evaluation of object type [%s] is not supported",
216 AcpiUtGetTypeName (Info->Node->Type)));
221 case ACPI_TYPE_METHOD:
223 * 2) Object is a control method - execute it
226 /* Verify that there is a method object associated with this node */
230 ACPI_ERROR ((AE_INFO, "%s: Method has no attached sub-object",
231 Info->FullPathname));
232 Status = AE_NULL_OBJECT;
236 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
237 "**** Execute method [%s] at AML address %p length %X\n",
239 Info->ObjDesc->Method.AmlStart + 1,
240 Info->ObjDesc->Method.AmlLength - 1));
243 * Any namespace deletion must acquire both the namespace and
244 * interpreter locks to ensure that no thread is using the portion of
245 * the namespace that is being deleted.
247 * Execute the method via the interpreter. The interpreter is locked
248 * here before calling into the AML parser
250 AcpiExEnterInterpreter ();
251 Status = AcpiPsExecuteMethod (Info);
252 AcpiExExitInterpreter ();
257 * 3) All other non-method objects -- get the current object value
261 * Some objects require additional resolution steps (e.g., the Node
262 * may be a field that must be read, etc.) -- we can't just grab
263 * the object out of the node.
265 * Use ResolveNodeToValue() to get the associated value.
267 * NOTE: we can get away with passing in NULL for a walk state because
268 * the Node is guaranteed to not be a reference to either a method
269 * local or a method argument (because this interface is never called
270 * from a running method.)
272 * Even though we do not directly invoke the interpreter for object
273 * resolution, we must lock it because we could access an OpRegion.
274 * The OpRegion access code assumes that the interpreter is locked.
276 AcpiExEnterInterpreter ();
278 /* TBD: ResolveNodeToValue has a strange interface, fix */
280 Info->ReturnObject = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Info->Node);
282 Status = AcpiExResolveNodeToValue (ACPI_CAST_INDIRECT_PTR (
283 ACPI_NAMESPACE_NODE, &Info->ReturnObject), NULL);
284 AcpiExExitInterpreter ();
286 if (ACPI_FAILURE (Status))
291 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Returned object %p [%s]\n",
293 AcpiUtGetObjectTypeName (Info->ReturnObject)));
295 Status = AE_CTRL_RETURN_VALUE; /* Always has a "return value" */
300 * For predefined names, check the return value against the ACPI
301 * specification. Some incorrect return value types are repaired.
303 (void) AcpiNsCheckReturnValue (Info->Node, Info, Info->ParamCount,
304 Status, &Info->ReturnObject);
306 /* Check if there is a return value that must be dealt with */
308 if (Status == AE_CTRL_RETURN_VALUE)
310 /* If caller does not want the return value, delete it */
312 if (Info->Flags & ACPI_IGNORE_RETURN_VALUE)
314 AcpiUtRemoveReference (Info->ReturnObject);
315 Info->ReturnObject = NULL;
318 /* Map AE_CTRL_RETURN_VALUE to AE_OK, we are done with it */
323 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
324 "*** Completed evaluation of object %s ***\n",
325 Info->RelativePathname));
329 * Namespace was unlocked by the handling AcpiNs* function, so we
330 * just free the pathname and return
332 ACPI_FREE (Info->FullPathname);
333 Info->FullPathname = NULL;
334 return_ACPI_STATUS (Status);
338 /*******************************************************************************
340 * FUNCTION: AcpiNsExecModuleCodeList
344 * RETURN: None. Exceptions during method execution are ignored, since
345 * we cannot abort a table load.
347 * DESCRIPTION: Execute all elements of the global module-level code list.
348 * Each element is executed as a single control method.
350 ******************************************************************************/
353 AcpiNsExecModuleCodeList (
356 ACPI_OPERAND_OBJECT *Prev;
357 ACPI_OPERAND_OBJECT *Next;
358 ACPI_EVALUATE_INFO *Info;
359 UINT32 MethodCount = 0;
362 ACPI_FUNCTION_TRACE (NsExecModuleCodeList);
365 /* Exit now if the list is empty */
367 Next = AcpiGbl_ModuleCodeList;
373 /* Allocate the evaluation information block */
375 Info = ACPI_ALLOCATE (sizeof (ACPI_EVALUATE_INFO));
381 /* Walk the list, executing each "method" */
386 Next = Next->Method.Mutex;
388 /* Clear the link field and execute the method */
390 Prev->Method.Mutex = NULL;
391 AcpiNsExecModuleCode (Prev, Info);
394 /* Delete the (temporary) method object */
396 AcpiUtRemoveReference (Prev);
400 "Executed %u blocks of module-level executable AML code",
404 AcpiGbl_ModuleCodeList = NULL;
409 /*******************************************************************************
411 * FUNCTION: AcpiNsExecModuleCode
413 * PARAMETERS: MethodObj - Object container for the module-level code
414 * Info - Info block for method evaluation
416 * RETURN: None. Exceptions during method execution are ignored, since
417 * we cannot abort a table load.
419 * DESCRIPTION: Execute a control method containing a block of module-level
420 * executable AML code. The control method is temporarily
421 * installed to the root node, then evaluated.
423 ******************************************************************************/
426 AcpiNsExecModuleCode (
427 ACPI_OPERAND_OBJECT *MethodObj,
428 ACPI_EVALUATE_INFO *Info)
430 ACPI_OPERAND_OBJECT *ParentObj;
431 ACPI_NAMESPACE_NODE *ParentNode;
432 ACPI_OBJECT_TYPE Type;
436 ACPI_FUNCTION_TRACE (NsExecModuleCode);
440 * Get the parent node. We cheat by using the NextObject field
441 * of the method object descriptor.
443 ParentNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE,
444 MethodObj->Method.NextObject);
445 Type = AcpiNsGetType (ParentNode);
448 * Get the region handler and save it in the method object. We may need
449 * this if an operation region declaration causes a _REG method to be run.
451 * We can't do this in AcpiPsLinkModuleCode because
452 * AcpiGbl_RootNode->Object is NULL at PASS1.
454 if ((Type == ACPI_TYPE_DEVICE) && ParentNode->Object)
456 MethodObj->Method.Dispatch.Handler =
457 ParentNode->Object->Device.Handler;
460 /* Must clear NextObject (AcpiNsAttachObject needs the field) */
462 MethodObj->Method.NextObject = NULL;
464 /* Initialize the evaluation information block */
466 ACPI_MEMSET (Info, 0, sizeof (ACPI_EVALUATE_INFO));
467 Info->PrefixNode = ParentNode;
470 * Get the currently attached parent object. Add a reference, because the
471 * ref count will be decreased when the method object is installed to
474 ParentObj = AcpiNsGetAttachedObject (ParentNode);
477 AcpiUtAddReference (ParentObj);
480 /* Install the method (module-level code) in the parent node */
482 Status = AcpiNsAttachObject (ParentNode, MethodObj,
484 if (ACPI_FAILURE (Status))
489 /* Execute the parent node as a control method */
491 Status = AcpiNsEvaluate (Info);
493 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Executed module-level code at %p\n",
494 MethodObj->Method.AmlStart));
496 /* Delete a possible implicit return value (in slack mode) */
498 if (Info->ReturnObject)
500 AcpiUtRemoveReference (Info->ReturnObject);
503 /* Detach the temporary method object */
505 AcpiNsDetachObject (ParentNode);
507 /* Restore the original parent object */
511 Status = AcpiNsAttachObject (ParentNode, ParentObj, Type);
515 ParentNode->Type = (UINT8) Type;
521 AcpiUtRemoveReference (ParentObj);