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
 123
 124 #define _COMPONENT          ACPI_PARSER
 125         ACPI_MODULE_NAME    ("psxface")
 126
 127 /* Local Prototypes */
 128
 129 static void
 130 AcpiPsStartTrace (
 131     ACPI_EVALUATE_INFO      *Info);
 132
 133 static void
 134 AcpiPsStopTrace (
 135     ACPI_EVALUATE_INFO      *Info);
 136
 137 static void
 138 AcpiPsUpdateParameterList (
 139     ACPI_EVALUATE_INFO      *Info,
 140     UINT16                  Action);
 141
 142
 143 /*******************************************************************************
 144  *
 145  * FUNCTION:    AcpiDebugTrace
 146  *
 147  * PARAMETERS:  MethodName      - Valid ACPI name string
 148  *              DebugLevel      - Optional level mask. 0 to use default
 149  *              DebugLayer      - Optional layer mask. 0 to use default
 150  *              Flags           - bit 1: one shot(1) or persistent(0)
 151  *
 152  * RETURN:      Status
 153  *
 154  * DESCRIPTION: External interface to enable debug tracing during control
 155  *              method execution
 156  *
 157  ******************************************************************************/
 158
 159 ACPI_STATUS
 160 AcpiDebugTrace (
 161     char                    *Name,
 162     UINT32                  DebugLevel,
 163     UINT32                  DebugLayer,
 164     UINT32                  Flags)
 165 {
 166     ACPI_STATUS             Status;
 167
 168
 169     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 170     if (ACPI_FAILURE (Status))
 171     {
 172         return (Status);
 173     }
 174
 175     /* TBDs: Validate name, allow full path or just nameseg */
 176
 177     AcpiGbl_TraceMethodName = *ACPI_CAST_PTR (UINT32, Name);
 178     AcpiGbl_TraceFlags = Flags;
 179
 180     if (DebugLevel)
 181     {
 182         AcpiGbl_TraceDbgLevel = DebugLevel;
 183     }
 184     if (DebugLayer)
 185     {
 186         AcpiGbl_TraceDbgLayer = DebugLayer;
 187     }
 188
 189     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 190     return (AE_OK);
 191 }
 192
 193
 194 /*******************************************************************************
 195  *
 196  * FUNCTION:    AcpiPsStartTrace
 197  *
 198  * PARAMETERS:  Info        - Method info struct
 199  *
 200  * RETURN:      None
 201  *
 202  * DESCRIPTION: Start control method execution trace
 203  *
 204  ******************************************************************************/
 205
 206 static void
 207 AcpiPsStartTrace (
 208     ACPI_EVALUATE_INFO      *Info)
 209 {
 210     ACPI_STATUS             Status;
 211
 212
 213     ACPI_FUNCTION_ENTRY ();
 214
 215
 216     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 217     if (ACPI_FAILURE (Status))
 218     {
 219         return;
 220     }
 221
 222     if ((!AcpiGbl_TraceMethodName) ||
 223         (AcpiGbl_TraceMethodName != Info->Node->Name.Integer))
 224     {
 225         goto Exit;
 226     }
 227
 228     AcpiGbl_OriginalDbgLevel = AcpiDbgLevel;
 229     AcpiGbl_OriginalDbgLayer = AcpiDbgLayer;
 230
 231     AcpiDbgLevel = 0x00FFFFFF;
 232     AcpiDbgLayer = ACPI_UINT32_MAX;
 233
 234     if (AcpiGbl_TraceDbgLevel)
 235     {
 236         AcpiDbgLevel = AcpiGbl_TraceDbgLevel;
 237     }
 238     if (AcpiGbl_TraceDbgLayer)
 239     {
 240         AcpiDbgLayer = AcpiGbl_TraceDbgLayer;
 241     }
 242
 243
 244 Exit:
 245     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 246 }
 247
 248
 249 /*******************************************************************************
 250  *
 251  * FUNCTION:    AcpiPsStopTrace
 252  *
 253  * PARAMETERS:  Info        - Method info struct
 254  *
 255  * RETURN:      None
 256  *
 257  * DESCRIPTION: Stop control method execution trace
 258  *
 259  ******************************************************************************/
 260
 261 static void
 262 AcpiPsStopTrace (
 263     ACPI_EVALUATE_INFO      *Info)
 264 {
 265     ACPI_STATUS             Status;
 266
 267
 268     ACPI_FUNCTION_ENTRY ();
 269
 270
 271     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 272     if (ACPI_FAILURE (Status))
 273     {
 274         return;
 275     }
 276
 277     if ((!AcpiGbl_TraceMethodName) ||
 278         (AcpiGbl_TraceMethodName != Info->Node->Name.Integer))
 279     {
 280         goto Exit;
 281     }
 282
 283     /* Disable further tracing if type is one-shot */
 284
 285     if (AcpiGbl_TraceFlags & 1)
 286     {
 287         AcpiGbl_TraceMethodName = 0;
 288         AcpiGbl_TraceDbgLevel = 0;
 289         AcpiGbl_TraceDbgLayer = 0;
 290     }
 291
 292     AcpiDbgLevel = AcpiGbl_OriginalDbgLevel;
 293     AcpiDbgLayer = AcpiGbl_OriginalDbgLayer;
 294
 295 Exit:
 296     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 297 }
 298
 299
 300 /*******************************************************************************
 301  *
 302  * FUNCTION:    AcpiPsExecuteMethod
 303  *
 304  * PARAMETERS:  Info            - Method info block, contains:
 305  *                  Node            - Method Node to execute
 306  *                  ObjDesc         - Method object
 307  *                  Parameters      - List of parameters to pass to the method,
 308  *                                    terminated by NULL. Params itself may be
 309  *                                    NULL if no parameters are being passed.
 310  *                  ReturnObject    - Where to put method's return value (if
 311  *                                    any). If NULL, no value is returned.
 312  *                  ParameterType   - Type of Parameter list
 313  *                  ReturnObject    - Where to put method's return value (if
 314  *                                    any). If NULL, no value is returned.
 315  *                  PassNumber      - Parse or execute pass
 316  *
 317  * RETURN:      Status
 318  *
 319  * DESCRIPTION: Execute a control method
 320  *
 321  ******************************************************************************/
 322
 323 ACPI_STATUS
 324 AcpiPsExecuteMethod (
 325     ACPI_EVALUATE_INFO      *Info)
 326 {
 327     ACPI_STATUS             Status;
 328     ACPI_PARSE_OBJECT       *Op;
 329     ACPI_WALK_STATE         *WalkState;
 330
 331
 332     ACPI_FUNCTION_TRACE (PsExecuteMethod);
 333
 334
 335     /* Quick validation of DSDT header */
 336
 337     AcpiTbCheckDsdtHeader ();
 338
 339     /* Validate the Info and method Node */
 340
 341     if (!Info || !Info->Node)
 342     {
 343         return_ACPI_STATUS (AE_NULL_ENTRY);
 344     }
 345
 346     /* Init for new method, wait on concurrency semaphore */
 347
 348     Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL);
 349     if (ACPI_FAILURE (Status))
 350     {
 351         return_ACPI_STATUS (Status);
 352     }
 353
 354     /*
 355      * The caller "owns" the parameters, so give each one an extra reference
 356      */
 357     AcpiPsUpdateParameterList (Info, REF_INCREMENT);
 358
 359     /* Begin tracing if requested */
 360
 361     AcpiPsStartTrace (Info);
 362
 363     /*
 364      * Execute the method. Performs parse simultaneously
 365      */
 366     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 367         "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
 368         Info->Node->Name.Ascii, Info->Node, Info->ObjDesc));
 369
 370     /* Create and init a Root Node */
 371
 372     Op = AcpiPsCreateScopeOp ();
 373     if (!Op)
 374     {
 375         Status = AE_NO_MEMORY;
 376         goto Cleanup;
 377     }
 378
 379     /* Create and initialize a new walk state */
 380
 381     Info->PassNumber = ACPI_IMODE_EXECUTE;
 382     WalkState = AcpiDsCreateWalkState (
 383                     Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
 384     if (!WalkState)
 385     {
 386         Status = AE_NO_MEMORY;
 387         goto Cleanup;
 388     }
 389
 390     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
 391                 Info->ObjDesc->Method.AmlStart,
 392                 Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
 393     if (ACPI_FAILURE (Status))
 394     {
 395         AcpiDsDeleteWalkState (WalkState);
 396         goto Cleanup;
 397     }
 398
 399     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
 400     {
 401         WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
 402     }
 403
 404     /* Invoke an internal method if necessary */
 405
 406     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
 407     {
 408         Status = Info->ObjDesc->Method.Dispatch.Implementation (WalkState);
 409         Info->ReturnObject = WalkState->ReturnDesc;
 410
 411         /* Cleanup states */
 412
 413         AcpiDsScopeStackClear (WalkState);
 414         AcpiPsCleanupScope (&WalkState->ParserState);
 415         AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
 416         AcpiDsDeleteWalkState (WalkState);
 417         goto Cleanup;
 418     }
 419
 420     /*
 421      * Start method evaluation with an implicit return of zero.
 422      * This is done for Windows compatibility.
 423      */
 424     if (AcpiGbl_EnableInterpreterSlack)
 425     {
 426         WalkState->ImplicitReturnObj =
 427             AcpiUtCreateIntegerObject ((UINT64) 0);
 428         if (!WalkState->ImplicitReturnObj)
 429         {
 430             Status = AE_NO_MEMORY;
 431             AcpiDsDeleteWalkState (WalkState);
 432             goto Cleanup;
 433         }
 434     }
 435
 436     /* Parse the AML */
 437
 438     Status = AcpiPsParseAml (WalkState);
 439
 440     /* WalkState was deleted by ParseAml */
 441
 442 Cleanup:
 443     AcpiPsDeleteParseTree (Op);
 444
 445     /* End optional tracing */
 446
 447     AcpiPsStopTrace (Info);
 448
 449     /* Take away the extra reference that we gave the parameters above */
 450
 451     AcpiPsUpdateParameterList (Info, REF_DECREMENT);
 452
 453     /* Exit now if error above */
 454
 455     if (ACPI_FAILURE (Status))
 456     {
 457         return_ACPI_STATUS (Status);
 458     }
 459
 460     /*
 461      * If the method has returned an object, signal this to the caller with
 462      * a control exception code
 463      */
 464     if (Info->ReturnObject)
 465     {
 466         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
 467             Info->ReturnObject));
 468         ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
 469
 470         Status = AE_CTRL_RETURN_VALUE;
 471     }
 472
 473     return_ACPI_STATUS (Status);
 474 }
 475
 476
 477 /*******************************************************************************
 478  *
 479  * FUNCTION:    AcpiPsUpdateParameterList
 480  *
 481  * PARAMETERS:  Info            - See ACPI_EVALUATE_INFO
 482  *                                (Used: ParameterType and Parameters)
 483  *              Action          - Add or Remove reference
 484  *
 485  * RETURN:      Status
 486  *
 487  * DESCRIPTION: Update reference count on all method parameter objects
 488  *
 489  ******************************************************************************/
 490
 491 static void
 492 AcpiPsUpdateParameterList (
 493     ACPI_EVALUATE_INFO      *Info,
 494     UINT16                  Action)
 495 {
 496     UINT32                  i;
 497
 498
 499     if (Info->Parameters)
 500     {
 501         /* Update reference count for each parameter */
 502
 503         for (i = 0; Info->Parameters[i]; i++)
 504         {
 505             /* Ignore errors, just do them all */
 506
 507             (void) AcpiUtUpdateObjectReference (Info->Parameters[i], Action);
 508         }
 509     }
 510 }