1 /*******************************************************************************
3 * Module Name: nseval - Object evaluation, includes control method execution
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************
117 * Alternatively, you may choose to be licensed under the terms of the
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
123 * 1. Redistributions of source code must retain the above copyright
124 * notice, this list of conditions, and the following disclaimer,
125 * without modification.
126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127 * substantially similar to the "NO WARRANTY" disclaimer below
128 * ("Disclaimer") and any redistribution must be conditioned upon
129 * including a substantially similar Disclaimer requirement for further
130 * binary redistribution.
131 * 3. Neither the names of the above-listed copyright holders nor the names
132 * of any contributors may be used to endorse or promote products derived
133 * from this software without specific prior written permission.
135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
147 * Alternatively, you may choose to be licensed under the terms of the
148 * GNU General Public License ("GPL") version 2 as published by the Free
149 * Software Foundation.
151 *****************************************************************************/
154 #include "accommon.h"
155 #include "acparser.h"
156 #include "acinterp.h"
157 #include "acnamesp.h"
160 #define _COMPONENT ACPI_NAMESPACE
161 ACPI_MODULE_NAME ("nseval")
163 /* Local prototypes */
166 AcpiNsExecModuleCode (
167 ACPI_OPERAND_OBJECT *MethodObj,
168 ACPI_EVALUATE_INFO *Info);
171 /*******************************************************************************
173 * FUNCTION: AcpiNsEvaluate
175 * PARAMETERS: Info - Evaluation info block, contains these fields
177 * PrefixNode - Prefix or Method/Object Node to execute
178 * RelativePath - Name of method to execute, If NULL, the
179 * Node is the object to execute
180 * Parameters - List of parameters to pass to the method,
181 * terminated by NULL. Params itself may be
182 * NULL if no parameters are being passed.
183 * ParameterType - Type of Parameter list
184 * ReturnObject - Where to put method's return value (if
185 * any). If NULL, no value is returned.
186 * Flags - ACPI_IGNORE_RETURN_VALUE to delete return
190 * DESCRIPTION: Execute a control method or return the current value of an
191 * ACPI namespace object.
193 * MUTEX: Locks interpreter
195 ******************************************************************************/
199 ACPI_EVALUATE_INFO *Info)
204 ACPI_FUNCTION_TRACE (NsEvaluate);
209 return_ACPI_STATUS (AE_BAD_PARAMETER);
215 * Get the actual namespace node for the target object if we
216 * need to. Handles these cases:
218 * 1) Null node, valid pathname from root (absolute path)
219 * 2) Node and valid pathname (path relative to Node)
220 * 3) Node, Null pathname
222 Status = AcpiNsGetNode (Info->PrefixNode, Info->RelativePathname,
223 ACPI_NS_NO_UPSEARCH, &Info->Node);
224 if (ACPI_FAILURE (Status))
226 return_ACPI_STATUS (Status);
231 * For a method alias, we must grab the actual method node so that
232 * proper scoping context will be established before execution.
234 if (AcpiNsGetType (Info->Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS)
236 Info->Node = ACPI_CAST_PTR (
237 ACPI_NAMESPACE_NODE, Info->Node->Object);
240 /* Complete the info block initialization */
242 Info->ReturnObject = NULL;
243 Info->NodeFlags = Info->Node->Flags;
244 Info->ObjDesc = AcpiNsGetAttachedObject (Info->Node);
246 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%s [%p] Value %p\n",
247 Info->RelativePathname, Info->Node,
248 AcpiNsGetAttachedObject (Info->Node)));
250 /* Get info if we have a predefined name (_HID, etc.) */
252 Info->Predefined = AcpiUtMatchPredefinedMethod (Info->Node->Name.Ascii);
254 /* Get the full pathname to the object, for use in warning messages */
256 Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE);
257 if (!Info->FullPathname)
259 return_ACPI_STATUS (AE_NO_MEMORY);
262 /* Count the number of arguments being passed in */
264 Info->ParamCount = 0;
265 if (Info->Parameters)
267 while (Info->Parameters[Info->ParamCount])
272 /* Warn on impossible argument count */
274 if (Info->ParamCount > ACPI_METHOD_NUM_ARGS)
276 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS,
277 "Excess arguments (%u) - using only %u",
278 Info->ParamCount, ACPI_METHOD_NUM_ARGS));
280 Info->ParamCount = ACPI_METHOD_NUM_ARGS;
285 * For predefined names: Check that the declared argument count
286 * matches the ACPI spec -- otherwise this is a BIOS error.
288 AcpiNsCheckAcpiCompliance (Info->FullPathname, Info->Node,
292 * For all names: Check that the incoming argument count for
293 * this method/object matches the actual ASL/AML definition.
295 AcpiNsCheckArgumentCount (Info->FullPathname, Info->Node,
296 Info->ParamCount, Info->Predefined);
298 /* For predefined names: Typecheck all incoming arguments */
300 AcpiNsCheckArgumentTypes (Info);
303 * Three major evaluation cases:
305 * 1) Object types that cannot be evaluated by definition
306 * 2) The object is a control method -- execute it
307 * 3) The object is not a method -- just return it's current value
309 switch (AcpiNsGetType (Info->Node))
311 case ACPI_TYPE_DEVICE:
312 case ACPI_TYPE_EVENT:
313 case ACPI_TYPE_MUTEX:
314 case ACPI_TYPE_REGION:
315 case ACPI_TYPE_THERMAL:
316 case ACPI_TYPE_LOCAL_SCOPE:
318 * 1) Disallow evaluation of certain object types. For these,
319 * object evaluation is undefined and not supported.
321 ACPI_ERROR ((AE_INFO,
322 "%s: Evaluation of object type [%s] is not supported",
324 AcpiUtGetTypeName (Info->Node->Type)));
329 case ACPI_TYPE_METHOD:
331 * 2) Object is a control method - execute it
334 /* Verify that there is a method object associated with this node */
338 ACPI_ERROR ((AE_INFO, "%s: Method has no attached sub-object",
339 Info->FullPathname));
340 Status = AE_NULL_OBJECT;
344 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
345 "**** Execute method [%s] at AML address %p length %X\n",
347 Info->ObjDesc->Method.AmlStart + 1,
348 Info->ObjDesc->Method.AmlLength - 1));
351 * Any namespace deletion must acquire both the namespace and
352 * interpreter locks to ensure that no thread is using the portion of
353 * the namespace that is being deleted.
355 * Execute the method via the interpreter. The interpreter is locked
356 * here before calling into the AML parser
358 AcpiExEnterInterpreter ();
359 Status = AcpiPsExecuteMethod (Info);
360 AcpiExExitInterpreter ();
365 * 3) All other non-method objects -- get the current object value
369 * Some objects require additional resolution steps (e.g., the Node
370 * may be a field that must be read, etc.) -- we can't just grab
371 * the object out of the node.
373 * Use ResolveNodeToValue() to get the associated value.
375 * NOTE: we can get away with passing in NULL for a walk state because
376 * the Node is guaranteed to not be a reference to either a method
377 * local or a method argument (because this interface is never called
378 * from a running method.)
380 * Even though we do not directly invoke the interpreter for object
381 * resolution, we must lock it because we could access an OpRegion.
382 * The OpRegion access code assumes that the interpreter is locked.
384 AcpiExEnterInterpreter ();
386 /* TBD: ResolveNodeToValue has a strange interface, fix */
388 Info->ReturnObject = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Info->Node);
390 Status = AcpiExResolveNodeToValue (ACPI_CAST_INDIRECT_PTR (
391 ACPI_NAMESPACE_NODE, &Info->ReturnObject), NULL);
392 AcpiExExitInterpreter ();
394 if (ACPI_FAILURE (Status))
396 Info->ReturnObject = NULL;
400 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Returned object %p [%s]\n",
402 AcpiUtGetObjectTypeName (Info->ReturnObject)));
404 Status = AE_CTRL_RETURN_VALUE; /* Always has a "return value" */
409 * For predefined names, check the return value against the ACPI
410 * specification. Some incorrect return value types are repaired.
412 (void) AcpiNsCheckReturnValue (Info->Node, Info, Info->ParamCount,
413 Status, &Info->ReturnObject);
415 /* Check if there is a return value that must be dealt with */
417 if (Status == AE_CTRL_RETURN_VALUE)
419 /* If caller does not want the return value, delete it */
421 if (Info->Flags & ACPI_IGNORE_RETURN_VALUE)
423 AcpiUtRemoveReference (Info->ReturnObject);
424 Info->ReturnObject = NULL;
427 /* Map AE_CTRL_RETURN_VALUE to AE_OK, we are done with it */
432 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
433 "*** Completed evaluation of object %s ***\n",
434 Info->RelativePathname));
438 * Namespace was unlocked by the handling AcpiNs* function, so we
439 * just free the pathname and return
441 ACPI_FREE (Info->FullPathname);
442 Info->FullPathname = NULL;
443 return_ACPI_STATUS (Status);
447 /*******************************************************************************
449 * FUNCTION: AcpiNsExecModuleCodeList
453 * RETURN: None. Exceptions during method execution are ignored, since
454 * we cannot abort a table load.
456 * DESCRIPTION: Execute all elements of the global module-level code list.
457 * Each element is executed as a single control method.
459 ******************************************************************************/
462 AcpiNsExecModuleCodeList (
465 ACPI_OPERAND_OBJECT *Prev;
466 ACPI_OPERAND_OBJECT *Next;
467 ACPI_EVALUATE_INFO *Info;
468 UINT32 MethodCount = 0;
471 ACPI_FUNCTION_TRACE (NsExecModuleCodeList);
474 /* Exit now if the list is empty */
476 Next = AcpiGbl_ModuleCodeList;
482 /* Allocate the evaluation information block */
484 Info = ACPI_ALLOCATE (sizeof (ACPI_EVALUATE_INFO));
490 /* Walk the list, executing each "method" */
495 Next = Next->Method.Mutex;
497 /* Clear the link field and execute the method */
499 Prev->Method.Mutex = NULL;
500 AcpiNsExecModuleCode (Prev, Info);
503 /* Delete the (temporary) method object */
505 AcpiUtRemoveReference (Prev);
509 "Executed %u blocks of module-level executable AML code",
513 AcpiGbl_ModuleCodeList = NULL;
518 /*******************************************************************************
520 * FUNCTION: AcpiNsExecModuleCode
522 * PARAMETERS: MethodObj - Object container for the module-level code
523 * Info - Info block for method evaluation
525 * RETURN: None. Exceptions during method execution are ignored, since
526 * we cannot abort a table load.
528 * DESCRIPTION: Execute a control method containing a block of module-level
529 * executable AML code. The control method is temporarily
530 * installed to the root node, then evaluated.
532 ******************************************************************************/
535 AcpiNsExecModuleCode (
536 ACPI_OPERAND_OBJECT *MethodObj,
537 ACPI_EVALUATE_INFO *Info)
539 ACPI_OPERAND_OBJECT *ParentObj;
540 ACPI_NAMESPACE_NODE *ParentNode;
541 ACPI_OBJECT_TYPE Type;
545 ACPI_FUNCTION_TRACE (NsExecModuleCode);
549 * Get the parent node. We cheat by using the NextObject field
550 * of the method object descriptor.
552 ParentNode = ACPI_CAST_PTR (
553 ACPI_NAMESPACE_NODE, MethodObj->Method.NextObject);
554 Type = AcpiNsGetType (ParentNode);
557 * Get the region handler and save it in the method object. We may need
558 * this if an operation region declaration causes a _REG method to be run.
560 * We can't do this in AcpiPsLinkModuleCode because
561 * AcpiGbl_RootNode->Object is NULL at PASS1.
563 if ((Type == ACPI_TYPE_DEVICE) && ParentNode->Object)
565 MethodObj->Method.Dispatch.Handler =
566 ParentNode->Object->Device.Handler;
569 /* Must clear NextObject (AcpiNsAttachObject needs the field) */
571 MethodObj->Method.NextObject = NULL;
573 /* Initialize the evaluation information block */
575 memset (Info, 0, sizeof (ACPI_EVALUATE_INFO));
576 Info->PrefixNode = ParentNode;
579 * Get the currently attached parent object. Add a reference,
580 * because the ref count will be decreased when the method object
581 * is installed to the parent node.
583 ParentObj = AcpiNsGetAttachedObject (ParentNode);
586 AcpiUtAddReference (ParentObj);
589 /* Install the method (module-level code) in the parent node */
591 Status = AcpiNsAttachObject (ParentNode, MethodObj, ACPI_TYPE_METHOD);
592 if (ACPI_FAILURE (Status))
597 /* Execute the parent node as a control method */
599 Status = AcpiNsEvaluate (Info);
601 ACPI_DEBUG_PRINT ((ACPI_DB_INIT_NAMES,
602 "Executed module-level code at %p\n",
603 MethodObj->Method.AmlStart));
605 /* Delete a possible implicit return value (in slack mode) */
607 if (Info->ReturnObject)
609 AcpiUtRemoveReference (Info->ReturnObject);
612 /* Detach the temporary method object */
614 AcpiNsDetachObject (ParentNode);
616 /* Restore the original parent object */
620 Status = AcpiNsAttachObject (ParentNode, ParentObj, Type);
624 ParentNode->Type = (UINT8) Type;
630 AcpiUtRemoveReference (ParentObj);