reactos/drivers/bus/acpi/acpica/parser/psxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psxface - Parser external interfaces
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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
  19  * property rights.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acparser.h"
 119 #include "acdispat.h"
 120 #include "acinterp.h"
 121 #include "actables.h"
 122 #include "acnamesp.h"
 123
 124
 125 #define _COMPONENT          ACPI_PARSER
 126         ACPI_MODULE_NAME    ("psxface")
 127
 128 /* Local Prototypes */
 129
 130 static void
 131 AcpiPsUpdateParameterList (
 132     ACPI_EVALUATE_INFO      *Info,
 133     UINT16                  Action);
 134
 135
 136 /*******************************************************************************
 137  *
 138  * FUNCTION:    AcpiDebugTrace
 139  *
 140  * PARAMETERS:  MethodName      - Valid ACPI name string
 141  *              DebugLevel      - Optional level mask. 0 to use default
 142  *              DebugLayer      - Optional layer mask. 0 to use default
 143  *              Flags           - bit 1: one shot(1) or persistent(0)
 144  *
 145  * RETURN:      Status
 146  *
 147  * DESCRIPTION: External interface to enable debug tracing during control
 148  *              method execution
 149  *
 150  ******************************************************************************/
 151
 152 ACPI_STATUS
 153 AcpiDebugTrace (
 154     const char              *Name,
 155     UINT32                  DebugLevel,
 156     UINT32                  DebugLayer,
 157     UINT32                  Flags)
 158 {
 159     ACPI_STATUS             Status;
 160
 161
 162     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 163     if (ACPI_FAILURE (Status))
 164     {
 165         return (Status);
 166     }
 167
 168     AcpiGbl_TraceMethodName = Name;
 169     AcpiGbl_TraceFlags = Flags;
 170     AcpiGbl_TraceDbgLevel = DebugLevel;
 171     AcpiGbl_TraceDbgLayer = DebugLayer;
 172     Status = AE_OK;
 173
 174     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 175     return (Status);
 176 }
 177
 178
 179 /*******************************************************************************
 180  *
 181  * FUNCTION:    AcpiPsExecuteMethod
 182  *
 183  * PARAMETERS:  Info            - Method info block, contains:
 184  *                  Node            - Method Node to execute
 185  *                  ObjDesc         - Method object
 186  *                  Parameters      - List of parameters to pass to the method,
 187  *                                    terminated by NULL. Params itself may be
 188  *                                    NULL if no parameters are being passed.
 189  *                  ReturnObject    - Where to put method's return value (if
 190  *                                    any). If NULL, no value is returned.
 191  *                  ParameterType   - Type of Parameter list
 192  *                  ReturnObject    - Where to put method's return value (if
 193  *                                    any). If NULL, no value is returned.
 194  *                  PassNumber      - Parse or execute pass
 195  *
 196  * RETURN:      Status
 197  *
 198  * DESCRIPTION: Execute a control method
 199  *
 200  ******************************************************************************/
 201
 202 ACPI_STATUS
 203 AcpiPsExecuteMethod (
 204     ACPI_EVALUATE_INFO      *Info)
 205 {
 206     ACPI_STATUS             Status;
 207     ACPI_PARSE_OBJECT       *Op;
 208     ACPI_WALK_STATE         *WalkState;
 209
 210
 211     ACPI_FUNCTION_TRACE (PsExecuteMethod);
 212
 213
 214     /* Quick validation of DSDT header */
 215
 216     AcpiTbCheckDsdtHeader ();
 217
 218     /* Validate the Info and method Node */
 219
 220     if (!Info || !Info->Node)
 221     {
 222         return_ACPI_STATUS (AE_NULL_ENTRY);
 223     }
 224
 225     /* Init for new method, wait on concurrency semaphore */
 226
 227     Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL);
 228     if (ACPI_FAILURE (Status))
 229     {
 230         return_ACPI_STATUS (Status);
 231     }
 232
 233     /*
 234      * The caller "owns" the parameters, so give each one an extra reference
 235      */
 236     AcpiPsUpdateParameterList (Info, REF_INCREMENT);
 237
 238     /*
 239      * Execute the method. Performs parse simultaneously
 240      */
 241     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 242         "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
 243         Info->Node->Name.Ascii, Info->Node, Info->ObjDesc));
 244
 245     /* Create and init a Root Node */
 246
 247     Op = AcpiPsCreateScopeOp (Info->ObjDesc->Method.AmlStart);
 248     if (!Op)
 249     {
 250         Status = AE_NO_MEMORY;
 251         goto Cleanup;
 252     }
 253
 254     /* Create and initialize a new walk state */
 255
 256     Info->PassNumber = ACPI_IMODE_EXECUTE;
 257     WalkState = AcpiDsCreateWalkState (
 258                     Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
 259     if (!WalkState)
 260     {
 261         Status = AE_NO_MEMORY;
 262         goto Cleanup;
 263     }
 264
 265     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
 266                 Info->ObjDesc->Method.AmlStart,
 267                 Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
 268     if (ACPI_FAILURE (Status))
 269     {
 270         AcpiDsDeleteWalkState (WalkState);
 271         goto Cleanup;
 272     }
 273
 274     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
 275     {
 276         WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
 277     }
 278
 279     /* Invoke an internal method if necessary */
 280
 281     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
 282     {
 283         Status = Info->ObjDesc->Method.Dispatch.Implementation (WalkState);
 284         Info->ReturnObject = WalkState->ReturnDesc;
 285
 286         /* Cleanup states */
 287
 288         AcpiDsScopeStackClear (WalkState);
 289         AcpiPsCleanupScope (&WalkState->ParserState);
 290         AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
 291         AcpiDsDeleteWalkState (WalkState);
 292         goto Cleanup;
 293     }
 294
 295     /*
 296      * Start method evaluation with an implicit return of zero.
 297      * This is done for Windows compatibility.
 298      */
 299     if (AcpiGbl_EnableInterpreterSlack)
 300     {
 301         WalkState->ImplicitReturnObj =
 302             AcpiUtCreateIntegerObject ((UINT64) 0);
 303         if (!WalkState->ImplicitReturnObj)
 304         {
 305             Status = AE_NO_MEMORY;
 306             AcpiDsDeleteWalkState (WalkState);
 307             goto Cleanup;
 308         }
 309     }
 310
 311     /* Parse the AML */
 312
 313     Status = AcpiPsParseAml (WalkState);
 314
 315     /* WalkState was deleted by ParseAml */
 316
 317 Cleanup:
 318     AcpiPsDeleteParseTree (Op);
 319
 320     /* Take away the extra reference that we gave the parameters above */
 321
 322     AcpiPsUpdateParameterList (Info, REF_DECREMENT);
 323
 324     /* Exit now if error above */
 325
 326     if (ACPI_FAILURE (Status))
 327     {
 328         return_ACPI_STATUS (Status);
 329     }
 330
 331     /*
 332      * If the method has returned an object, signal this to the caller with
 333      * a control exception code
 334      */
 335     if (Info->ReturnObject)
 336     {
 337         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
 338             Info->ReturnObject));
 339         ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
 340
 341         Status = AE_CTRL_RETURN_VALUE;
 342     }
 343
 344     return_ACPI_STATUS (Status);
 345 }
 346
 347
 348 /*******************************************************************************
 349  *
 350  * FUNCTION:    AcpiPsUpdateParameterList
 351  *
 352  * PARAMETERS:  Info            - See ACPI_EVALUATE_INFO
 353  *                                (Used: ParameterType and Parameters)
 354  *              Action          - Add or Remove reference
 355  *
 356  * RETURN:      Status
 357  *
 358  * DESCRIPTION: Update reference count on all method parameter objects
 359  *
 360  ******************************************************************************/
 361
 362 static void
 363 AcpiPsUpdateParameterList (
 364     ACPI_EVALUATE_INFO      *Info,
 365     UINT16                  Action)
 366 {
 367     UINT32                  i;
 368
 369
 370     if (Info->Parameters)
 371     {
 372         /* Update reference count for each parameter */
 373
 374         for (i = 0; Info->Parameters[i]; i++)
 375         {
 376             /* Ignore errors, just do them all */
 377
 378             (void) AcpiUtUpdateObjectReference (Info->Parameters[i], Action);
 379         }
 380     }
 381 }