xref: /titanic_52/usr/src/uts/intel/io/acpica/namespace/nseval.c (revision 1959748cbddf37d4734c107dadfa449e076045e3)
1 /*******************************************************************************
2  *
3  * Module Name: nseval - Object evaluation, includes control method execution
4  *              $Revision: 1.142 $
5  *
6  ******************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights.  You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code.  No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision.  In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change.  Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee.  Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution.  In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66 
67  *
68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
69  * substantial portion of the Covered Code or modification must reproduce the
70  * above Copyright Notice, and the following Disclaimer and Export Compliance
71  * provision in the documentation and/or other materials provided with the
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78  * Intel shall be used in advertising or otherwise to promote the sale, use or
79  * other dealings in products derived from or relating to the Covered Code
80  * without prior written authorization from Intel.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90  * PARTICULAR PURPOSE.
91  *
92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99  * LIMITED REMEDY.
100  *
101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
102  * software or system incorporating such software without first obtaining any
103  * required license or other approval from the U. S. Department of Commerce or
104  * any other agency or department of the United States Government.  In the
105  * event Licensee exports any such software from the United States or
106  * re-exports any such software from a foreign destination, Licensee shall
107  * ensure that the distribution and export/re-export of the software is in
108  * compliance with all laws, regulations, orders, or other restrictions of the
109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110  * any of its subsidiaries will export/re-export any technical data, process,
111  * software, or service, directly or indirectly, to any country for which the
112  * United States government or any agency thereof requires an export license,
113  * other governmental approval, or letter of assurance, without first obtaining
114  * such license, approval or letter.
115  *
116  *****************************************************************************/
117 
118 #define __NSEVAL_C__
119 
120 #include "acpi.h"
121 #include "acparser.h"
122 #include "acinterp.h"
123 #include "acnamesp.h"
124 
125 
126 #define _COMPONENT          ACPI_NAMESPACE
127         ACPI_MODULE_NAME    ("nseval")
128 
129 
130 /*******************************************************************************
131  *
132  * FUNCTION:    AcpiNsEvaluate
133  *
134  * PARAMETERS:  Info            - Evaluation info block, contains:
135  *                  PrefixNode      - Prefix or Method/Object Node to execute
136  *                  Pathname        - Name of method to execute, If NULL, the
137  *                                    Node is the object to execute
138  *                  Parameters      - List of parameters to pass to the method,
139  *                                    terminated by NULL. Params itself may be
140  *                                    NULL if no parameters are being passed.
141  *                  ReturnObject    - Where to put method's return value (if
142  *                                    any). If NULL, no value is returned.
143  *                  ParameterType   - Type of Parameter list
144  *                  ReturnObject    - Where to put method's return value (if
145  *                                    any). If NULL, no value is returned.
146  *                  Flags           - ACPI_IGNORE_RETURN_VALUE to delete return
147  *
148  * RETURN:      Status
149  *
150  * DESCRIPTION: Execute a control method or return the current value of an
151  *              ACPI namespace object.
152  *
153  * MUTEX:       Locks interpreter
154  *
155  ******************************************************************************/
156 
157 ACPI_STATUS
158 AcpiNsEvaluate (
159     ACPI_EVALUATE_INFO      *Info)
160 {
161     ACPI_STATUS             Status;
162 
163 
164     ACPI_FUNCTION_TRACE (NsEvaluate);
165 
166 
167     if (!Info)
168     {
169         return_ACPI_STATUS (AE_BAD_PARAMETER);
170     }
171 
172     /* Initialize the return value to an invalid object */
173 
174     Info->ReturnObject = NULL;
175 
176     /*
177      * Get the actual namespace node for the target object. Handles these cases:
178      *
179      * 1) Null node, Pathname (absolute path)
180      * 2) Node, Pathname (path relative to Node)
181      * 3) Node, Null Pathname
182      */
183     Status = AcpiNsGetNode (Info->PrefixNode, Info->Pathname,
184                 ACPI_NS_NO_UPSEARCH, &Info->ResolvedNode);
185     if (ACPI_FAILURE (Status))
186     {
187         return_ACPI_STATUS (Status);
188     }
189 
190     /*
191      * For a method alias, we must grab the actual method node so that proper
192      * scoping context will be established before execution.
193      */
194     if (AcpiNsGetType (Info->ResolvedNode) == ACPI_TYPE_LOCAL_METHOD_ALIAS)
195     {
196         Info->ResolvedNode =
197             ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Info->ResolvedNode->Object);
198     }
199 
200     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%s [%p] Value %p\n", Info->Pathname,
201         Info->ResolvedNode, AcpiNsGetAttachedObject (Info->ResolvedNode)));
202 
203     /*
204      * Two major cases here:
205      *
206      * 1) The object is a control method -- execute it
207      * 2) The object is not a method -- just return it's current value
208      */
209     if (AcpiNsGetType (Info->ResolvedNode) == ACPI_TYPE_METHOD)
210     {
211         /*
212          * 1) Object is a control method - execute it
213          */
214 
215         /* Verify that there is a method object associated with this node */
216 
217         Info->ObjDesc = AcpiNsGetAttachedObject (Info->ResolvedNode);
218         if (!Info->ObjDesc)
219         {
220             ACPI_ERROR ((AE_INFO, "Control method has no attached sub-object"));
221             return_ACPI_STATUS (AE_NULL_OBJECT);
222         }
223 
224         ACPI_DUMP_PATHNAME (Info->ResolvedNode, "Execute Method:",
225             ACPI_LV_INFO, _COMPONENT);
226 
227         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
228             "Method at AML address %p Length %X\n",
229             Info->ObjDesc->Method.AmlStart + 1,
230             Info->ObjDesc->Method.AmlLength - 1));
231 
232         /*
233          * Any namespace deletion must acquire both the namespace and
234          * interpreter locks to ensure that no thread is using the portion of
235          * the namespace that is being deleted.
236          *
237          * Execute the method via the interpreter. The interpreter is locked
238          * here before calling into the AML parser
239          */
240         Status = AcpiExEnterInterpreter ();
241         if (ACPI_FAILURE (Status))
242         {
243             return_ACPI_STATUS (Status);
244         }
245 
246         Status = AcpiPsExecuteMethod (Info);
247         AcpiExExitInterpreter ();
248     }
249     else
250     {
251         /*
252          * 2) Object is not a method, return its current value
253          */
254 
255         /*
256          * Objects require additional resolution steps (e.g., the Node may be
257          * a field that must be read, etc.) -- we can't just grab the object
258          * out of the node.
259          *
260          * Use ResolveNodeToValue() to get the associated value.
261          *
262          * NOTE: we can get away with passing in NULL for a walk state because
263          * ResolvedNode is guaranteed to not be a reference to either a method
264          * local or a method argument (because this interface is never called
265          * from a running method.)
266          *
267          * Even though we do not directly invoke the interpreter for object
268          * resolution, we must lock it because we could access an opregion.
269          * The opregion access code assumes that the interpreter is locked.
270          */
271         Status = AcpiExEnterInterpreter ();
272         if (ACPI_FAILURE (Status))
273         {
274             return_ACPI_STATUS (Status);
275         }
276 
277         /* Function has a strange interface */
278 
279         Status = AcpiExResolveNodeToValue (&Info->ResolvedNode, NULL);
280         AcpiExExitInterpreter ();
281 
282         /*
283          * If AcpiExResolveNodeToValue() succeeded, the return value was placed
284          * in ResolvedNode.
285          */
286         if (ACPI_SUCCESS (Status))
287         {
288             Status = AE_CTRL_RETURN_VALUE;
289             Info->ReturnObject =
290                 ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Info->ResolvedNode);
291 
292             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Returning object %p [%s]\n",
293                 Info->ReturnObject,
294                 AcpiUtGetObjectTypeName (Info->ReturnObject)));
295         }
296     }
297 
298     /*
299      * Check if there is a return value that must be dealt with
300      */
301     if (Status == AE_CTRL_RETURN_VALUE)
302     {
303         /* If caller does not want the return value, delete it */
304 
305         if (Info->Flags & ACPI_IGNORE_RETURN_VALUE)
306         {
307             AcpiUtRemoveReference (Info->ReturnObject);
308             Info->ReturnObject = NULL;
309         }
310 
311         /* Map AE_CTRL_RETURN_VALUE to AE_OK, we are done with it */
312 
313         Status = AE_OK;
314     }
315 
316     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
317         "*** Completed evaluation of object %s ***\n", Info->Pathname));
318 
319     /*
320      * Namespace was unlocked by the handling AcpiNs* function, so we
321      * just return
322      */
323     return_ACPI_STATUS (Status);
324 }
325 
326