sys/contrib/dev/acpica/source/components/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 - 2019, 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  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include "acpi.h"
 153 #include "accommon.h"
 154 #include "acparser.h"
 155 #include "acdispat.h"
 156 #include "acinterp.h"
 157 #include "actables.h"
 158 #include "acnamesp.h"
 159
 160
 161 #define _COMPONENT          ACPI_PARSER
 162         ACPI_MODULE_NAME    ("psxface")
 163
 164 /* Local Prototypes */
 165
 166 static void
 167 AcpiPsUpdateParameterList (
 168     ACPI_EVALUATE_INFO      *Info,
 169     UINT16                  Action);
 170
 171
 172 /*******************************************************************************
 173  *
 174  * FUNCTION:    AcpiDebugTrace
 175  *
 176  * PARAMETERS:  MethodName      - Valid ACPI name string
 177  *              DebugLevel      - Optional level mask. 0 to use default
 178  *              DebugLayer      - Optional layer mask. 0 to use default
 179  *              Flags           - bit 1: one shot(1) or persistent(0)
 180  *
 181  * RETURN:      Status
 182  *
 183  * DESCRIPTION: External interface to enable debug tracing during control
 184  *              method execution
 185  *
 186  ******************************************************************************/
 187
 188 ACPI_STATUS
 189 AcpiDebugTrace (
 190     const char              *Name,
 191     UINT32                  DebugLevel,
 192     UINT32                  DebugLayer,
 193     UINT32                  Flags)
 194 {
 195     ACPI_STATUS             Status;
 196
 197
 198     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 199     if (ACPI_FAILURE (Status))
 200     {
 201         return (Status);
 202     }
 203
 204     AcpiGbl_TraceMethodName = Name;
 205     AcpiGbl_TraceFlags = Flags;
 206     AcpiGbl_TraceDbgLevel = DebugLevel;
 207     AcpiGbl_TraceDbgLayer = DebugLayer;
 208     Status = AE_OK;
 209
 210     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 211     return (Status);
 212 }
 213
 214
 215 /*******************************************************************************
 216  *
 217  * FUNCTION:    AcpiPsExecuteMethod
 218  *
 219  * PARAMETERS:  Info            - Method info block, contains:
 220  *                  Node            - Method Node to execute
 221  *                  ObjDesc         - Method object
 222  *                  Parameters      - List of parameters to pass to the method,
 223  *                                    terminated by NULL. Params itself may be
 224  *                                    NULL if no parameters are being passed.
 225  *                  ReturnObject    - Where to put method's return value (if
 226  *                                    any). If NULL, no value is returned.
 227  *                  ParameterType   - Type of Parameter list
 228  *                  ReturnObject    - Where to put method's return value (if
 229  *                                    any). If NULL, no value is returned.
 230  *                  PassNumber      - Parse or execute pass
 231  *
 232  * RETURN:      Status
 233  *
 234  * DESCRIPTION: Execute a control method
 235  *
 236  ******************************************************************************/
 237
 238 ACPI_STATUS
 239 AcpiPsExecuteMethod (
 240     ACPI_EVALUATE_INFO      *Info)
 241 {
 242     ACPI_STATUS             Status;
 243     ACPI_PARSE_OBJECT       *Op;
 244     ACPI_WALK_STATE         *WalkState;
 245
 246
 247     ACPI_FUNCTION_TRACE (PsExecuteMethod);
 248
 249
 250     /* Quick validation of DSDT header */
 251
 252     AcpiTbCheckDsdtHeader ();
 253
 254     /* Validate the Info and method Node */
 255
 256     if (!Info || !Info->Node)
 257     {
 258         return_ACPI_STATUS (AE_NULL_ENTRY);
 259     }
 260
 261     /* Init for new method, wait on concurrency semaphore */
 262
 263     Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL);
 264     if (ACPI_FAILURE (Status))
 265     {
 266         return_ACPI_STATUS (Status);
 267     }
 268
 269     /*
 270      * The caller "owns" the parameters, so give each one an extra reference
 271      */
 272     AcpiPsUpdateParameterList (Info, REF_INCREMENT);
 273
 274     /*
 275      * Execute the method. Performs parse simultaneously
 276      */
 277     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
 278         "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
 279         Info->Node->Name.Ascii, Info->Node, Info->ObjDesc));
 280
 281     /* Create and init a Root Node */
 282
 283     Op = AcpiPsCreateScopeOp (Info->ObjDesc->Method.AmlStart);
 284     if (!Op)
 285     {
 286         Status = AE_NO_MEMORY;
 287         goto Cleanup;
 288     }
 289
 290     /* Create and initialize a new walk state */
 291
 292     Info->PassNumber = ACPI_IMODE_EXECUTE;
 293     WalkState = AcpiDsCreateWalkState (
 294         Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
 295     if (!WalkState)
 296     {
 297         Status = AE_NO_MEMORY;
 298         goto Cleanup;
 299     }
 300
 301     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
 302         Info->ObjDesc->Method.AmlStart,
 303         Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
 304     if (ACPI_FAILURE (Status))
 305     {
 306         AcpiDsDeleteWalkState (WalkState);
 307         goto Cleanup;
 308     }
 309
 310     WalkState->MethodPathname = Info->FullPathname;
 311     WalkState->MethodIsNested = FALSE;
 312
 313     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
 314     {
 315         WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
 316     }
 317
 318     /* Invoke an internal method if necessary */
 319
 320     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
 321     {
 322         Status = Info->ObjDesc->Method.Dispatch.Implementation (WalkState);
 323         Info->ReturnObject = WalkState->ReturnDesc;
 324
 325         /* Cleanup states */
 326
 327         AcpiDsScopeStackClear (WalkState);
 328         AcpiPsCleanupScope (&WalkState->ParserState);
 329         AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
 330         AcpiDsDeleteWalkState (WalkState);
 331         goto Cleanup;
 332     }
 333
 334     /*
 335      * Start method evaluation with an implicit return of zero.
 336      * This is done for Windows compatibility.
 337      */
 338     if (AcpiGbl_EnableInterpreterSlack)
 339     {
 340         WalkState->ImplicitReturnObj =
 341             AcpiUtCreateIntegerObject ((UINT64) 0);
 342         if (!WalkState->ImplicitReturnObj)
 343         {
 344             Status = AE_NO_MEMORY;
 345             AcpiDsDeleteWalkState (WalkState);
 346             goto Cleanup;
 347         }
 348     }
 349
 350     /* Parse the AML */
 351
 352     Status = AcpiPsParseAml (WalkState);
 353
 354     /* WalkState was deleted by ParseAml */
 355
 356 Cleanup:
 357     AcpiPsDeleteParseTree (Op);
 358
 359     /* Take away the extra reference that we gave the parameters above */
 360
 361     AcpiPsUpdateParameterList (Info, REF_DECREMENT);
 362
 363     /* Exit now if error above */
 364
 365     if (ACPI_FAILURE (Status))
 366     {
 367         return_ACPI_STATUS (Status);
 368     }
 369
 370     /*
 371      * If the method has returned an object, signal this to the caller with
 372      * a control exception code
 373      */
 374     if (Info->ReturnObject)
 375     {
 376         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
 377             Info->ReturnObject));
 378         ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
 379
 380         Status = AE_CTRL_RETURN_VALUE;
 381     }
 382
 383     return_ACPI_STATUS (Status);
 384 }
 385
 386
 387 /*******************************************************************************
 388  *
 389  * FUNCTION:    AcpiPsExecuteTable
 390  *
 391  * PARAMETERS:  Info            - Method info block, contains:
 392  *              Node            - Node to where the is entered into the
 393  *                                namespace
 394  *              ObjDesc         - Pseudo method object describing the AML
 395  *                                code of the entire table
 396  *              PassNumber      - Parse or execute pass
 397  *
 398  * RETURN:      Status
 399  *
 400  * DESCRIPTION: Execute a table
 401  *
 402  ******************************************************************************/
 403
 404 ACPI_STATUS
 405 AcpiPsExecuteTable (
 406     ACPI_EVALUATE_INFO      *Info)
 407 {
 408     ACPI_STATUS             Status;
 409     ACPI_PARSE_OBJECT       *Op = NULL;
 410     ACPI_WALK_STATE         *WalkState = NULL;
 411
 412
 413     ACPI_FUNCTION_TRACE (PsExecuteTable);
 414
 415
 416     /* Create and init a Root Node */
 417
 418     Op = AcpiPsCreateScopeOp (Info->ObjDesc->Method.AmlStart);
 419     if (!Op)
 420     {
 421         Status = AE_NO_MEMORY;
 422         goto Cleanup;
 423     }
 424
 425     /* Create and initialize a new walk state */
 426
 427     WalkState = AcpiDsCreateWalkState (
 428         Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
 429     if (!WalkState)
 430     {
 431         Status = AE_NO_MEMORY;
 432         goto Cleanup;
 433     }
 434
 435     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
 436         Info->ObjDesc->Method.AmlStart,
 437         Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
 438     if (ACPI_FAILURE (Status))
 439     {
 440         goto Cleanup;
 441     }
 442
 443     WalkState->MethodPathname = Info->FullPathname;
 444     WalkState->MethodIsNested = FALSE;
 445
 446     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
 447     {
 448         WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
 449     }
 450
 451     /* Info->Node is the default location to load the table  */
 452
 453     if (Info->Node && Info->Node != AcpiGbl_RootNode)
 454     {
 455         Status = AcpiDsScopeStackPush (
 456             Info->Node, ACPI_TYPE_METHOD, WalkState);
 457         if (ACPI_FAILURE (Status))
 458         {
 459             goto Cleanup;
 460         }
 461     }
 462
 463     /*
 464      * Parse the AML, WalkState will be deleted by ParseAml
 465      */
 466     AcpiExEnterInterpreter ();
 467     Status = AcpiPsParseAml (WalkState);
 468     AcpiExExitInterpreter ();
 469     WalkState = NULL;
 470
 471 Cleanup:
 472     if (WalkState)
 473     {
 474         AcpiDsDeleteWalkState (WalkState);
 475     }
 476     if (Op)
 477     {
 478         AcpiPsDeleteParseTree (Op);
 479     }
 480     return_ACPI_STATUS (Status);
 481 }
 482
 483
 484 /*******************************************************************************
 485  *
 486  * FUNCTION:    AcpiPsUpdateParameterList
 487  *
 488  * PARAMETERS:  Info            - See ACPI_EVALUATE_INFO
 489  *                                (Used: ParameterType and Parameters)
 490  *              Action          - Add or Remove reference
 491  *
 492  * RETURN:      Status
 493  *
 494  * DESCRIPTION: Update reference count on all method parameter objects
 495  *
 496  ******************************************************************************/
 497
 498 static void
 499 AcpiPsUpdateParameterList (
 500     ACPI_EVALUATE_INFO      *Info,
 501     UINT16                  Action)
 502 {
 503     UINT32                  i;
 504
 505
 506     if (Info->Parameters)
 507     {
 508         /* Update reference count for each parameter */
 509
 510         for (i = 0; Info->Parameters[i]; i++)
 511         {
 512             /* Ignore errors, just do them all */
 513
 514             (void) AcpiUtUpdateObjectReference (
 515                 Info->Parameters[i], Action);
 516         }
 517     }
 518 }