sys/contrib/dev/acpica-unix-20031203/interpreter/parser/psxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psxface - Parser external interfaces
   4  *              $Revision: 69 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 "acnamesp.h"
 124
 125
 126 #define _COMPONENT          ACPI_PARSER
 127         ACPI_MODULE_NAME    ("psxface")
 128
 129
 130 /*******************************************************************************
 131  *
 132  * FUNCTION:    AcpiPsxExecute
 133  *
 134  * PARAMETERS:  MethodNode          - A method object containing both the AML
 135  *                                    address and length.
 136  *              **Params            - List of parameters to pass to method,
 137  *                                    terminated by NULL. Params itself may be
 138  *                                    NULL if no parameters are being passed.
 139  *              **ReturnObjDesc     - Return object from execution of the
 140  *                                    method.
 141  *
 142  * RETURN:      Status
 143  *
 144  * DESCRIPTION: Execute a control method
 145  *
 146  ******************************************************************************/
 147
 148 ACPI_STATUS
 149 AcpiPsxExecute (
 150     ACPI_NAMESPACE_NODE     *MethodNode,
 151     ACPI_OPERAND_OBJECT     **Params,
 152     ACPI_OPERAND_OBJECT     **ReturnObjDesc)
 153 {
 154     ACPI_STATUS             Status;
 155     ACPI_OPERAND_OBJECT     *ObjDesc;
 156     UINT32                  i;
 157     ACPI_PARSE_OBJECT       *Op;
 158     ACPI_WALK_STATE         *WalkState;
 159
 160
 161     ACPI_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         for (i = 0; Params[i]; i++)
 192         {
 193             AcpiUtAddReference (Params[i]);
 194         }
 195     }
 196
 197     /*
 198      * 1) Perform the first pass parse of the method to enter any
 199      * named objects that it creates into the namespace
 200      */
 201     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 202         "**** Begin Method Parse **** Entry=%p obj=%p\n",
 203         MethodNode, ObjDesc));
 204
 205     /* Create and init a Root Node */
 206
 207     Op = AcpiPsCreateScopeOp ();
 208     if (!Op)
 209     {
 210         Status = AE_NO_MEMORY;
 211         goto Cleanup1;
 212     }
 213
 214     /*
 215      * Get a new OwnerId for objects created by this method.  Namespace
 216      * objects (such as Operation Regions) can be created during the
 217      * first pass parse.
 218      */
 219     ObjDesc->Method.OwningId = AcpiUtAllocateOwnerId (ACPI_OWNER_TYPE_METHOD);
 220
 221     /* Create and initialize a new walk state */
 222
 223     WalkState = AcpiDsCreateWalkState (ObjDesc->Method.OwningId,
 224                                     NULL, NULL, NULL);
 225     if (!WalkState)
 226     {
 227         Status = AE_NO_MEMORY;
 228         goto Cleanup2;
 229     }
 230
 231     Status = AcpiDsInitAmlWalk (WalkState, Op, MethodNode, ObjDesc->Method.AmlStart,
 232                     ObjDesc->Method.AmlLength, NULL, NULL, 1);
 233     if (ACPI_FAILURE (Status))
 234     {
 235         goto Cleanup3;
 236     }
 237
 238     /* Parse the AML */
 239
 240     Status = AcpiPsParseAml (WalkState);
 241     AcpiPsDeleteParseTree (Op);
 242     if (ACPI_FAILURE (Status))
 243     {
 244         goto Cleanup1; /* Walk state is already deleted */
 245
 246     }
 247
 248     /*
 249      * 2) Execute the method.  Performs second pass parse simultaneously
 250      */
 251     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 252         "**** Begin Method Execution **** Entry=%p obj=%p\n",
 253         MethodNode, ObjDesc));
 254
 255     /* Create and init a Root Node */
 256
 257     Op = AcpiPsCreateScopeOp ();
 258     if (!Op)
 259     {
 260         Status = AE_NO_MEMORY;
 261         goto Cleanup1;
 262     }
 263
 264     /* Init new op with the method name and pointer back to the NS node */
 265
 266     AcpiPsSetName (Op, MethodNode->Name.Integer);
 267     Op->Common.Node = MethodNode;
 268
 269     /* Create and initialize a new walk state */
 270
 271     WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
 272     if (!WalkState)
 273     {
 274         Status = AE_NO_MEMORY;
 275         goto Cleanup2;
 276     }
 277
 278     Status = AcpiDsInitAmlWalk (WalkState, Op, MethodNode, ObjDesc->Method.AmlStart,
 279                     ObjDesc->Method.AmlLength, Params, ReturnObjDesc, 3);
 280     if (ACPI_FAILURE (Status))
 281     {
 282         goto Cleanup3;
 283     }
 284
 285     /*
 286      * The walk of the parse tree is where we actually execute the method
 287      */
 288     Status = AcpiPsParseAml (WalkState);
 289     goto Cleanup2; /* Walk state already deleted */
 290
 291
 292
 293 Cleanup3:
 294     AcpiDsDeleteWalkState (WalkState);
 295
 296 Cleanup2:
 297     AcpiPsDeleteParseTree (Op);
 298
 299 Cleanup1:
 300     if (Params)
 301     {
 302         /* Take away the extra reference that we gave the parameters above */
 303
 304         for (i = 0; Params[i]; i++)
 305         {
 306             /* Ignore errors, just do them all */
 307
 308             (void) AcpiUtUpdateObjectReference (Params[i], REF_DECREMENT);
 309         }
 310     }
 311
 312     if (ACPI_FAILURE (Status))
 313     {
 314         return_ACPI_STATUS (Status);
 315     }
 316
 317     /*
 318      * If the method has returned an object, signal this to the caller with
 319      * a control exception code
 320      */
 321     if (*ReturnObjDesc)
 322     {
 323         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
 324             *ReturnObjDesc));
 325         ACPI_DUMP_STACK_ENTRY (*ReturnObjDesc);
 326
 327         Status = AE_CTRL_RETURN_VALUE;
 328     }
 329
 330     return_ACPI_STATUS (Status);
 331 }
 332
 333