acpica/parser/psxface.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: psxface - Parser external interfaces
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*cb565728SJerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
db2bae30SDana Myers * All rights reserved.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
26f3cdf0SGordon Ross * are met:
26f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf0SGordon Ross *    notice, this list of conditions, and the following disclaimer,
26f3cdf0SGordon Ross *    without modification.
26f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf0SGordon Ross *    substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf0SGordon Ross *    ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf0SGordon Ross *    including a substantially similar Disclaimer requirement for further
26f3cdf0SGordon Ross *    binary redistribution.
26f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf0SGordon Ross *    of any contributors may be used to endorse or promote products derived
26f3cdf0SGordon Ross *    from this software without specific prior written permission.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf0SGordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf0SGordon Ross * Software Foundation.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * NO WARRANTY
26f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf0SGordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf0SGordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf0SGordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf0SGordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf0SGordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf0SGordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf0SGordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf0SGordon Ross * POSSIBILITY OF SUCH DAMAGES.
26f3cdf0SGordon Ross */
db2bae30SDana Myers
db2bae30SDana Myers#include "acpi.h"
aa2aa9a6SDana Myers#include "accommon.h"
db2bae30SDana Myers#include "acparser.h"
db2bae30SDana Myers#include "acdispat.h"
db2bae30SDana Myers#include "acinterp.h"
26f3cdf0SGordon Ross#include "actables.h"
*cb565728SJerry Jelinek#include "acnamesp.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_PARSER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("psxface")
db2bae30SDana Myers
db2bae30SDana Myers/* Local Prototypes */
db2bae30SDana Myers
db2bae30SDana Myersstatic void
db2bae30SDana MyersAcpiPsUpdateParameterList (
db2bae30SDana Myers    ACPI_EVALUATE_INFO      *Info,
db2bae30SDana Myers    UINT16                  Action);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDebugTrace
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  MethodName      - Valid ACPI name string
db2bae30SDana Myers *              DebugLevel      - Optional level mask. 0 to use default
db2bae30SDana Myers *              DebugLayer      - Optional layer mask. 0 to use default
db2bae30SDana Myers *              Flags           - bit 1: one shot(1) or persistent(0)
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: External interface to enable debug tracing during control
db2bae30SDana Myers *              method execution
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDebugTrace (
*cb565728SJerry Jelinek    const char              *Name,
db2bae30SDana Myers    UINT32                  DebugLevel,
db2bae30SDana Myers    UINT32                  DebugLayer,
db2bae30SDana Myers    UINT32                  Flags)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
*cb565728SJerry Jelinek    AcpiGbl_TraceMethodName = Name;
db2bae30SDana Myers    AcpiGbl_TraceFlags = Flags;
db2bae30SDana Myers    AcpiGbl_TraceDbgLevel = DebugLevel;
db2bae30SDana Myers    AcpiGbl_TraceDbgLayer = DebugLayer;
*cb565728SJerry Jelinek    Status = AE_OK;
db2bae30SDana Myers
db2bae30SDana Myers    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
*cb565728SJerry Jelinek    return (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsExecuteMethod
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Info            - Method info block, contains:
db2bae30SDana Myers *                  Node            - Method Node to execute
db2bae30SDana Myers *                  ObjDesc         - Method object
db2bae30SDana Myers *                  Parameters      - List of parameters to pass to the method,
db2bae30SDana Myers *                                    terminated by NULL. Params itself may be
db2bae30SDana Myers *                                    NULL if no parameters are being passed.
db2bae30SDana Myers *                  ReturnObject    - Where to put method's return value (if
db2bae30SDana Myers *                                    any). If NULL, no value is returned.
db2bae30SDana Myers *                  ParameterType   - Type of Parameter list
db2bae30SDana Myers *                  ReturnObject    - Where to put method's return value (if
db2bae30SDana Myers *                                    any). If NULL, no value is returned.
db2bae30SDana Myers *                  PassNumber      - Parse or execute pass
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Execute a control method
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiPsExecuteMethod (
db2bae30SDana Myers    ACPI_EVALUATE_INFO      *Info)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op;
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (PsExecuteMethod);
db2bae30SDana Myers
db2bae30SDana Myers
26f3cdf0SGordon Ross    /* Quick validation of DSDT header */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    AcpiTbCheckDsdtHeader ();
26f3cdf0SGordon Ross
db2bae30SDana Myers    /* Validate the Info and method Node */
db2bae30SDana Myers
*cb565728SJerry Jelinek    if (!Info || !Info->Node)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_NULL_ENTRY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Init for new method, wait on concurrency semaphore */
db2bae30SDana Myers
*cb565728SJerry Jelinek    Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * The caller "owns" the parameters, so give each one an extra reference
db2bae30SDana Myers     */
db2bae30SDana Myers    AcpiPsUpdateParameterList (Info, REF_INCREMENT);
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Execute the method. Performs parse simultaneously
db2bae30SDana Myers     */
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
db2bae30SDana Myers        "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
*cb565728SJerry Jelinek        Info->Node->Name.Ascii, Info->Node, Info->ObjDesc));
db2bae30SDana Myers
db2bae30SDana Myers    /* Create and init a Root Node */
db2bae30SDana Myers
*cb565728SJerry Jelinek    Op = AcpiPsCreateScopeOp (Info->ObjDesc->Method.AmlStart);
db2bae30SDana Myers    if (!Op)
db2bae30SDana Myers    {
db2bae30SDana Myers        Status = AE_NO_MEMORY;
db2bae30SDana Myers        goto Cleanup;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Create and initialize a new walk state */
db2bae30SDana Myers
db2bae30SDana Myers    Info->PassNumber = ACPI_IMODE_EXECUTE;
db2bae30SDana Myers    WalkState = AcpiDsCreateWalkState (
db2bae30SDana Myers        Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
db2bae30SDana Myers    if (!WalkState)
db2bae30SDana Myers    {
db2bae30SDana Myers        Status = AE_NO_MEMORY;
db2bae30SDana Myers        goto Cleanup;
db2bae30SDana Myers    }
db2bae30SDana Myers
*cb565728SJerry Jelinek    Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
db2bae30SDana Myers        Info->ObjDesc->Method.AmlStart,
db2bae30SDana Myers        Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiDsDeleteWalkState (WalkState);
db2bae30SDana Myers        goto Cleanup;
db2bae30SDana Myers    }
db2bae30SDana Myers
26f3cdf0SGordon Ross    if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
57190917SDana Myers    {
57190917SDana Myers        WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
57190917SDana Myers    }
57190917SDana Myers
aa2aa9a6SDana Myers    /* Invoke an internal method if necessary */
aa2aa9a6SDana Myers
26f3cdf0SGordon Ross    if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
aa2aa9a6SDana Myers    {
26f3cdf0SGordon Ross        Status = Info->ObjDesc->Method.Dispatch.Implementation (WalkState);
aa2aa9a6SDana Myers        Info->ReturnObject = WalkState->ReturnDesc;
aa2aa9a6SDana Myers
aa2aa9a6SDana Myers        /* Cleanup states */
aa2aa9a6SDana Myers
aa2aa9a6SDana Myers        AcpiDsScopeStackClear (WalkState);
aa2aa9a6SDana Myers        AcpiPsCleanupScope (&WalkState->ParserState);
aa2aa9a6SDana Myers        AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
aa2aa9a6SDana Myers        AcpiDsDeleteWalkState (WalkState);
aa2aa9a6SDana Myers        goto Cleanup;
aa2aa9a6SDana Myers    }
aa2aa9a6SDana Myers
aa2aa9a6SDana Myers    /*
*cb565728SJerry Jelinek     * Start method evaluation with an implicit return of zero.
*cb565728SJerry Jelinek     * This is done for Windows compatibility.
aa2aa9a6SDana Myers     */
aa2aa9a6SDana Myers    if (AcpiGbl_EnableInterpreterSlack)
aa2aa9a6SDana Myers    {
aa2aa9a6SDana Myers        WalkState->ImplicitReturnObj =
57190917SDana Myers            AcpiUtCreateIntegerObject ((UINT64) 0);
aa2aa9a6SDana Myers        if (!WalkState->ImplicitReturnObj)
aa2aa9a6SDana Myers        {
aa2aa9a6SDana Myers            Status = AE_NO_MEMORY;
aa2aa9a6SDana Myers            AcpiDsDeleteWalkState (WalkState);
aa2aa9a6SDana Myers            goto Cleanup;
aa2aa9a6SDana Myers        }
aa2aa9a6SDana Myers    }
aa2aa9a6SDana Myers
db2bae30SDana Myers    /* Parse the AML */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiPsParseAml (WalkState);
db2bae30SDana Myers
db2bae30SDana Myers    /* WalkState was deleted by ParseAml */
db2bae30SDana Myers
db2bae30SDana MyersCleanup:
db2bae30SDana Myers    AcpiPsDeleteParseTree (Op);
db2bae30SDana Myers
db2bae30SDana Myers    /* Take away the extra reference that we gave the parameters above */
db2bae30SDana Myers
db2bae30SDana Myers    AcpiPsUpdateParameterList (Info, REF_DECREMENT);
db2bae30SDana Myers
db2bae30SDana Myers    /* Exit now if error above */
db2bae30SDana Myers
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * If the method has returned an object, signal this to the caller with
db2bae30SDana Myers     * a control exception code
db2bae30SDana Myers     */
db2bae30SDana Myers    if (Info->ReturnObject)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
db2bae30SDana Myers            Info->ReturnObject));
db2bae30SDana Myers        ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
db2bae30SDana Myers
db2bae30SDana Myers        Status = AE_CTRL_RETURN_VALUE;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsUpdateParameterList
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Info            - See ACPI_EVALUATE_INFO
db2bae30SDana Myers *                                (Used: ParameterType and Parameters)
db2bae30SDana Myers *              Action          - Add or Remove reference
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Update reference count on all method parameter objects
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic void
db2bae30SDana MyersAcpiPsUpdateParameterList (
db2bae30SDana Myers    ACPI_EVALUATE_INFO      *Info,
db2bae30SDana Myers    UINT16                  Action)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  i;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (Info->Parameters)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Update reference count for each parameter */
db2bae30SDana Myers
db2bae30SDana Myers        for (i = 0; Info->Parameters[i]; i++)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Ignore errors, just do them all */
db2bae30SDana Myers
*cb565728SJerry Jelinek            (void) AcpiUtUpdateObjectReference (
*cb565728SJerry Jelinek                Info->Parameters[i], Action);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers}