psxface.c revision 77424 
1/******************************************************************************
2 *
3 * Module Name: psxface - Parser external interfaces
4 *              $Revision: 44 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 * 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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117#define __PSXFACE_C__
118
119#include "acpi.h"
120#include "acparser.h"
121#include "acdispat.h"
122#include "acinterp.h"
123#include "amlcode.h"
124#include "acnamesp.h"
125
126
127#define _COMPONENT          ACPI_PARSER
128        MODULE_NAME         ("psxface")
129
130
131/*****************************************************************************
132 *
133 * FUNCTION:    AcpiPsxExecute
134 *
135 * PARAMETERS:  MethodNode          - A method object containing both the AML
136 *                                    address and length.
137 *              **Params            - List of parameters to pass to method,
138 *                                    terminated by NULL. Params itself may be
139 *                                    NULL if no parameters are being passed.
140 *              **ReturnObjDesc     - Return object from execution of the
141 *                                    method.
142 *
143 * RETURN:      Status
144 *
145 * DESCRIPTION: Execute a control method
146 *
147 ****************************************************************************/
148
149ACPI_STATUS
150AcpiPsxExecute (
151    ACPI_NAMESPACE_NODE     *MethodNode,
152    ACPI_OPERAND_OBJECT     **Params,
153    ACPI_OPERAND_OBJECT     **ReturnObjDesc)
154{
155    ACPI_STATUS             Status;
156    ACPI_OPERAND_OBJECT     *ObjDesc;
157    UINT32                  i;
158    ACPI_PARSE_OBJECT       *Op;
159
160
161    FUNCTION_TRACE ("PsxExecute");
162
163
164    /* Validate the Node and get the attached object */
165
166    if (!MethodNode)
167    {
168        return_ACPI_STATUS (AE_NULL_ENTRY);
169    }
170
171    ObjDesc = AcpiNsGetAttachedObject (MethodNode);
172    if (!ObjDesc)
173    {
174        return_ACPI_STATUS (AE_NULL_OBJECT);
175    }
176
177    /* Init for new method, wait on concurrency semaphore */
178
179    Status = AcpiDsBeginMethodExecution (MethodNode, ObjDesc, NULL);
180    if (ACPI_FAILURE (Status))
181    {
182        return_ACPI_STATUS (Status);
183    }
184
185    if (Params)
186    {
187        /*
188         * The caller "owns" the parameters, so give each one an extra
189         * reference
190         */
191
192        for (i = 0; Params[i]; i++)
193        {
194            AcpiUtAddReference (Params[i]);
195        }
196    }
197
198    /*
199     * Perform the first pass parse of the method to enter any
200     * named objects that it creates into the namespace
201     */
202
203    DEBUG_PRINTP (ACPI_INFO,
204        ("**** Begin Method Execution **** Entry=%p obj=%p\n",
205        MethodNode, ObjDesc));
206
207    /* Create and init a Root Node */
208
209    Op = AcpiPsAllocOp (AML_SCOPE_OP);
210    if (!Op)
211    {
212        return_ACPI_STATUS (AE_NO_MEMORY);
213    }
214
215    Status = AcpiPsParseAml (Op, ObjDesc->Method.Pcode,
216                                ObjDesc->Method.PcodeLength,
217                                ACPI_PARSE_LOAD_PASS1 | ACPI_PARSE_DELETE_TREE,
218                                MethodNode, Params, ReturnObjDesc,
219                                AcpiDsLoad1BeginOp, AcpiDsLoad1EndOp);
220    AcpiPsDeleteParseTree (Op);
221
222    /* Create and init a Root Node */
223
224    Op = AcpiPsAllocOp (AML_SCOPE_OP);
225    if (!Op)
226    {
227        return_ACPI_STATUS (AE_NO_MEMORY);
228    }
229
230
231    /* Init new op with the method name and pointer back to the NS node */
232
233    AcpiPsSetName (Op, MethodNode->Name);
234    Op->Node = MethodNode;
235
236    /*
237     * The walk of the parse tree is where we actually execute the method
238     */
239    Status = AcpiPsParseAml (Op, ObjDesc->Method.Pcode,
240                                ObjDesc->Method.PcodeLength,
241                                ACPI_PARSE_EXECUTE | ACPI_PARSE_DELETE_TREE,
242                                MethodNode, Params, ReturnObjDesc,
243                                AcpiDsExecBeginOp, AcpiDsExecEndOp);
244    AcpiPsDeleteParseTree (Op);
245
246    if (Params)
247    {
248        /* Take away the extra reference that we gave the parameters above */
249
250        for (i = 0; Params[i]; i++)
251        {
252            AcpiUtUpdateObjectReference (Params[i], REF_DECREMENT);
253        }
254    }
255
256
257    /*
258     * Normal exit is with Status == AE_RETURN_VALUE when a ReturnOp has been
259     * executed, or with Status == AE_PENDING at end of AML block (end of
260     * Method code)
261     */
262
263    if (*ReturnObjDesc)
264    {
265        DEBUG_PRINTP (ACPI_INFO, ("Method returned ObjDesc=%X\n",
266            *ReturnObjDesc));
267        DUMP_STACK_ENTRY (*ReturnObjDesc);
268
269        Status = AE_CTRL_RETURN_VALUE;
270    }
271
272
273    return_ACPI_STATUS (Status);
274}
275
276
277