acpica/dispatcher/dsmthdat.c

db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: dsmthdat - control method arguments and local variables
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*385cc6b4SJerry 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 "acdispat.h"
db2bae30SDana Myers#include "acnamesp.h"
db2bae30SDana Myers#include "acinterp.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_DISPATCHER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("dsmthdat")
db2bae30SDana Myers
db2bae30SDana Myers/* Local prototypes */
db2bae30SDana Myers
db2bae30SDana Myersstatic void
db2bae30SDana MyersAcpiDsMethodDataDeleteValue (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState);
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiDsMethodDataSetValue (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *Object,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState);
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_OBSOLETE_FUNCTIONS
db2bae30SDana MyersACPI_OBJECT_TYPE
db2bae30SDana MyersAcpiDsMethodDataGetType (
db2bae30SDana Myers    UINT16                  Opcode,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState);
db2bae30SDana Myers#endif
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataInit
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current walk state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Initialize the data structures that hold the method's arguments
db2bae30SDana Myers *              and locals. The data struct is an array of namespace nodes for
db2bae30SDana Myers *              each - this allows RefOf and DeRefOf to work properly for these
db2bae30SDana Myers *              special data types.
db2bae30SDana Myers *
db2bae30SDana Myers * NOTES:       WalkState fields are initialized to zero by the
db2bae30SDana Myers *              ACPI_ALLOCATE_ZEROED().
db2bae30SDana Myers *
db2bae30SDana Myers *              A pseudo-Namespace Node is assigned to each argument and local
db2bae30SDana Myers *              so that RefOf() can return a pointer to the Node.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiDsMethodDataInit (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  i;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataInit);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Init the method arguments */
db2bae30SDana Myers
db2bae30SDana Myers    for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        ACPI_MOVE_32_TO_32 (&WalkState->Arguments[i].Name,
*385cc6b4SJerry Jelinek            NAMEOF_ARG_NTE);
*385cc6b4SJerry Jelinek
db2bae30SDana Myers        WalkState->Arguments[i].Name.Integer |= (i << 24);
db2bae30SDana Myers        WalkState->Arguments[i].DescriptorType = ACPI_DESC_TYPE_NAMED;
db2bae30SDana Myers        WalkState->Arguments[i].Type = ACPI_TYPE_ANY;
26f3cdf0SGordon Ross        WalkState->Arguments[i].Flags = ANOBJ_METHOD_ARG;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Init the method locals */
db2bae30SDana Myers
db2bae30SDana Myers    for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        ACPI_MOVE_32_TO_32 (&WalkState->LocalVariables[i].Name,
*385cc6b4SJerry Jelinek            NAMEOF_LOCAL_NTE);
db2bae30SDana Myers
db2bae30SDana Myers        WalkState->LocalVariables[i].Name.Integer |= (i << 24);
db2bae30SDana Myers        WalkState->LocalVariables[i].DescriptorType = ACPI_DESC_TYPE_NAMED;
db2bae30SDana Myers        WalkState->LocalVariables[i].Type = ACPI_TYPE_ANY;
26f3cdf0SGordon Ross        WalkState->LocalVariables[i].Flags = ANOBJ_METHOD_LOCAL;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataDeleteAll
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current walk state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Delete method locals and arguments. Arguments are only
db2bae30SDana Myers *              deleted if this method was called from another method.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiDsMethodDataDeleteAll (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  Index;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataDeleteAll);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Detach the locals */
db2bae30SDana Myers
db2bae30SDana Myers    for (Index = 0; Index < ACPI_METHOD_NUM_LOCALS; Index++)
db2bae30SDana Myers    {
db2bae30SDana Myers        if (WalkState->LocalVariables[Index].Object)
db2bae30SDana Myers        {
26f3cdf0SGordon Ross            ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Deleting Local%u=%p\n",
db2bae30SDana Myers                Index, WalkState->LocalVariables[Index].Object));
db2bae30SDana Myers
db2bae30SDana Myers            /* Detach object (if present) and remove a reference */
db2bae30SDana Myers
db2bae30SDana Myers            AcpiNsDetachObject (&WalkState->LocalVariables[Index]);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Detach the arguments */
db2bae30SDana Myers
db2bae30SDana Myers    for (Index = 0; Index < ACPI_METHOD_NUM_ARGS; Index++)
db2bae30SDana Myers    {
db2bae30SDana Myers        if (WalkState->Arguments[Index].Object)
db2bae30SDana Myers        {
26f3cdf0SGordon Ross            ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Deleting Arg%u=%p\n",
db2bae30SDana Myers                Index, WalkState->Arguments[Index].Object));
db2bae30SDana Myers
db2bae30SDana Myers            /* Detach object (if present) and remove a reference */
db2bae30SDana Myers
db2bae30SDana Myers            AcpiNsDetachObject (&WalkState->Arguments[Index]);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataInitArgs
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  *Params         - Pointer to a parameter list for the method
db2bae30SDana Myers *              MaxParamCount   - The arg count for this method
db2bae30SDana Myers *              WalkState       - Current walk state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
db2bae30SDana Myers *              of ACPI operand objects, either null terminated or whose length
db2bae30SDana Myers *              is defined by MaxParamCount.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsMethodDataInitArgs (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     **Params,
db2bae30SDana Myers    UINT32                  MaxParamCount,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    UINT32                  Index = 0;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (DsMethodDataInitArgs, Params);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!Params)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
*385cc6b4SJerry Jelinek            "No parameter list passed to method\n"));
db2bae30SDana Myers        return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Copy passed parameters into the new method stack frame */
db2bae30SDana Myers
db2bae30SDana Myers    while ((Index < ACPI_METHOD_NUM_ARGS) &&
db2bae30SDana Myers           (Index < MaxParamCount)        &&
db2bae30SDana Myers            Params[Index])
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * A valid parameter.
db2bae30SDana Myers         * Store the argument in the method/walk descriptor.
db2bae30SDana Myers         * Do not copy the arg in order to implement call by reference
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        Status = AcpiDsMethodDataSetValue (
*385cc6b4SJerry Jelinek            ACPI_REFCLASS_ARG, Index, Params[Index], WalkState);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Index++;
db2bae30SDana Myers    }
db2bae30SDana Myers
26f3cdf0SGordon Ross    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%u args passed to method\n", Index));
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataGetNode
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
db2bae30SDana Myers *                                    ACPI_REFCLASS_ARG
db2bae30SDana Myers *              Index               - Which Local or Arg whose type to get
db2bae30SDana Myers *              WalkState           - Current walk state object
db2bae30SDana Myers *              Node                - Where the node is returned.
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status and node
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get the Node associated with a local or arg.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsMethodDataGetNode (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState,
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     **Node)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataGetNode);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Method Locals and Arguments are supported
db2bae30SDana Myers     */
db2bae30SDana Myers    switch (Type)
db2bae30SDana Myers    {
db2bae30SDana Myers    case ACPI_REFCLASS_LOCAL:
db2bae30SDana Myers
db2bae30SDana Myers        if (Index > ACPI_METHOD_MAX_LOCAL)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Local index %u is invalid (max %u)",
db2bae30SDana Myers                Index, ACPI_METHOD_MAX_LOCAL));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_INVALID_INDEX);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Return a pointer to the pseudo-node */
db2bae30SDana Myers
db2bae30SDana Myers        *Node = &WalkState->LocalVariables[Index];
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_REFCLASS_ARG:
db2bae30SDana Myers
db2bae30SDana Myers        if (Index > ACPI_METHOD_MAX_ARG)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Arg index %u is invalid (max %u)",
db2bae30SDana Myers                Index, ACPI_METHOD_MAX_ARG));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_INVALID_INDEX);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Return a pointer to the pseudo-node */
db2bae30SDana Myers
db2bae30SDana Myers        *Node = &WalkState->Arguments[Index];
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
*385cc6b4SJerry Jelinek
26f3cdf0SGordon Ross        ACPI_ERROR ((AE_INFO, "Type %u is invalid", Type));
db2bae30SDana Myers        return_ACPI_STATUS (AE_TYPE);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataSetValue
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
db2bae30SDana Myers *                                    ACPI_REFCLASS_ARG
db2bae30SDana Myers *              Index               - Which Local or Arg to get
db2bae30SDana Myers *              Object              - Object to be inserted into the stack entry
db2bae30SDana Myers *              WalkState           - Current walk state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
db2bae30SDana Myers *              Note: There is no "implicit conversion" for locals.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiDsMethodDataSetValue (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *Object,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataSetValue);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
26f3cdf0SGordon Ross        "NewObj %p Type %2.2X, Refs=%u [%s]\n", Object,
db2bae30SDana Myers        Type, Object->Common.ReferenceCount,
db2bae30SDana Myers        AcpiUtGetTypeName (Object->Common.Type)));
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the namespace node for the arg/local */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiDsMethodDataGetNode (Type, Index, WalkState, &Node);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Increment ref count so object can't be deleted while installed.
db2bae30SDana Myers     * NOTE: We do not copy the object in order to preserve the call by
db2bae30SDana Myers     * reference semantics of ACPI Control Method invocation.
db2bae30SDana Myers     * (See ACPI Specification 2.0C)
db2bae30SDana Myers     */
db2bae30SDana Myers    AcpiUtAddReference (Object);
db2bae30SDana Myers
db2bae30SDana Myers    /* Install the object */
db2bae30SDana Myers
db2bae30SDana Myers    Node->Object = Object;
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataGetValue
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
db2bae30SDana Myers *                                    ACPI_REFCLASS_ARG
db2bae30SDana Myers *              Index               - Which localVar or argument to get
db2bae30SDana Myers *              WalkState           - Current walk state object
db2bae30SDana Myers *              DestDesc            - Where Arg or Local value is returned
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Retrieve value of selected Arg or Local for this method
db2bae30SDana Myers *              Used only in AcpiExResolveToValue().
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsMethodDataGetValue (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     **DestDesc)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *Object;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataGetValue);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Validate the object descriptor */
db2bae30SDana Myers
db2bae30SDana Myers    if (!DestDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "Null object descriptor pointer"));
db2bae30SDana Myers        return_ACPI_STATUS (AE_BAD_PARAMETER);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the namespace node for the arg/local */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiDsMethodDataGetNode (Type, Index, WalkState, &Node);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the object from the node */
db2bae30SDana Myers
db2bae30SDana Myers    Object = Node->Object;
db2bae30SDana Myers
db2bae30SDana Myers    /* Examine the returned object, it must be valid. */
db2bae30SDana Myers
db2bae30SDana Myers    if (!Object)
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Index points to uninitialized object.
db2bae30SDana Myers         * This means that either 1) The expected argument was
db2bae30SDana Myers         * not passed to the method, or 2) A local variable
db2bae30SDana Myers         * was referenced by the method (via the ASL)
db2bae30SDana Myers         * before it was initialized. Either case is an error.
db2bae30SDana Myers         */
db2bae30SDana Myers
db2bae30SDana Myers        /* If slack enabled, init the LocalX/ArgX to an Integer of value zero */
db2bae30SDana Myers
db2bae30SDana Myers        if (AcpiGbl_EnableInterpreterSlack)
db2bae30SDana Myers        {
57190917SDana Myers            Object = AcpiUtCreateIntegerObject ((UINT64) 0);
db2bae30SDana Myers            if (!Object)
db2bae30SDana Myers            {
db2bae30SDana Myers                return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            Node->Object = Object;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Otherwise, return the error */
db2bae30SDana Myers
db2bae30SDana Myers        else switch (Type)
db2bae30SDana Myers        {
db2bae30SDana Myers        case ACPI_REFCLASS_ARG:
db2bae30SDana Myers
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Uninitialized Arg[%u] at node %p",
db2bae30SDana Myers                Index, Node));
db2bae30SDana Myers
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_UNINITIALIZED_ARG);
db2bae30SDana Myers
db2bae30SDana Myers        case ACPI_REFCLASS_LOCAL:
57190917SDana Myers            /*
57190917SDana Myers             * No error message for this case, will be trapped again later to
57190917SDana Myers             * detect and ignore cases of Store(LocalX,LocalX)
57190917SDana Myers             */
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_UNINITIALIZED_LOCAL);
db2bae30SDana Myers
db2bae30SDana Myers        default:
db2bae30SDana Myers
26f3cdf0SGordon Ross            ACPI_ERROR ((AE_INFO, "Not a Arg/Local opcode: 0x%X", Type));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_INTERNAL);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * The Index points to an initialized and valid object.
db2bae30SDana Myers     * Return an additional reference to the object
db2bae30SDana Myers     */
db2bae30SDana Myers    *DestDesc = Object;
db2bae30SDana Myers    AcpiUtAddReference (Object);
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataDeleteValue
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
db2bae30SDana Myers *                                    ACPI_REFCLASS_ARG
db2bae30SDana Myers *              Index               - Which localVar or argument to delete
db2bae30SDana Myers *              WalkState           - Current walk state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
db2bae30SDana Myers *              a null into the stack slot after the object is deleted.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic void
db2bae30SDana MyersAcpiDsMethodDataDeleteValue (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *Object;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataDeleteValue);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the namespace node for the arg/local */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiDsMethodDataGetNode (Type, Index, WalkState, &Node);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_VOID;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the associated object */
db2bae30SDana Myers
db2bae30SDana Myers    Object = AcpiNsGetAttachedObject (Node);
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Undefine the Arg or Local by setting its descriptor
db2bae30SDana Myers     * pointer to NULL. Locals/Args can contain both
db2bae30SDana Myers     * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
db2bae30SDana Myers     */
db2bae30SDana Myers    Node->Object = NULL;
db2bae30SDana Myers
db2bae30SDana Myers    if ((Object) &&
db2bae30SDana Myers        (ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_OPERAND))
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * There is a valid object.
db2bae30SDana Myers         * Decrement the reference count by one to balance the
db2bae30SDana Myers         * increment when the object was stored.
db2bae30SDana Myers         */
db2bae30SDana Myers        AcpiUtRemoveReference (Object);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsStoreObjectToLocal
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
db2bae30SDana Myers *                                    ACPI_REFCLASS_ARG
db2bae30SDana Myers *              Index               - Which Local or Arg to set
db2bae30SDana Myers *              ObjDesc             - Value to be stored
db2bae30SDana Myers *              WalkState           - Current walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Store a value in an Arg or Local. The ObjDesc is installed
db2bae30SDana Myers *              as the new value for the Arg or Local and the reference count
db2bae30SDana Myers *              for ObjDesc is incremented.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsStoreObjectToLocal (
db2bae30SDana Myers    UINT8                   Type,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *CurrentObjDesc;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *NewObjDesc;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsStoreObjectToLocal);
26f3cdf0SGordon Ross    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Type=%2.2X Index=%u Obj=%p\n",
db2bae30SDana Myers        Type, Index, ObjDesc));
db2bae30SDana Myers
db2bae30SDana Myers    /* Parameter validation */
db2bae30SDana Myers
db2bae30SDana Myers    if (!ObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_BAD_PARAMETER);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the namespace node for the arg/local */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiDsMethodDataGetNode (Type, Index, WalkState, &Node);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    CurrentObjDesc = AcpiNsGetAttachedObject (Node);
db2bae30SDana Myers    if (CurrentObjDesc == ObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj=%p already installed!\n",
db2bae30SDana Myers            ObjDesc));
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * If the reference count on the object is more than one, we must
db2bae30SDana Myers     * take a copy of the object before we store. A reference count
db2bae30SDana Myers     * of exactly 1 means that the object was just created during the
db2bae30SDana Myers     * evaluation of an expression, and we can safely use it since it
db2bae30SDana Myers     * is not used anywhere else.
db2bae30SDana Myers     */
db2bae30SDana Myers    NewObjDesc = ObjDesc;
db2bae30SDana Myers    if (ObjDesc->Common.ReferenceCount > 1)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        Status = AcpiUtCopyIobjectToIobject (
*385cc6b4SJerry Jelinek            ObjDesc, &NewObjDesc, WalkState);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * If there is an object already in this slot, we either
db2bae30SDana Myers     * have to delete it, or if this is an argument and there
db2bae30SDana Myers     * is an object reference stored there, we have to do
db2bae30SDana Myers     * an indirect store!
db2bae30SDana Myers     */
db2bae30SDana Myers    if (CurrentObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Check for an indirect store if an argument
db2bae30SDana Myers         * contains an object reference (stored as an Node).
db2bae30SDana Myers         * We don't allow this automatic dereferencing for
db2bae30SDana Myers         * locals, since a store to a local should overwrite
db2bae30SDana Myers         * anything there, including an object reference.
db2bae30SDana Myers         *
db2bae30SDana Myers         * If both Arg0 and Local0 contain RefOf (Local4):
db2bae30SDana Myers         *
db2bae30SDana Myers         * Store (1, Arg0)             - Causes indirect store to local4
db2bae30SDana Myers         * Store (1, Local0)           - Stores 1 in local0, overwriting
db2bae30SDana Myers         *                                  the reference to local4
db2bae30SDana Myers         * Store (1, DeRefof (Local0)) - Causes indirect store to local4
db2bae30SDana Myers         *
db2bae30SDana Myers         * Weird, but true.
db2bae30SDana Myers         */
db2bae30SDana Myers        if (Type == ACPI_REFCLASS_ARG)
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * If we have a valid reference object that came from RefOf(),
db2bae30SDana Myers             * do the indirect store
db2bae30SDana Myers             */
*385cc6b4SJerry Jelinek            if ((ACPI_GET_DESCRIPTOR_TYPE (CurrentObjDesc) ==
*385cc6b4SJerry Jelinek                    ACPI_DESC_TYPE_OPERAND) &&
*385cc6b4SJerry Jelinek                (CurrentObjDesc->Common.Type ==
*385cc6b4SJerry Jelinek                    ACPI_TYPE_LOCAL_REFERENCE) &&
*385cc6b4SJerry Jelinek                (CurrentObjDesc->Reference.Class ==
*385cc6b4SJerry Jelinek                    ACPI_REFCLASS_REFOF))
db2bae30SDana Myers            {
db2bae30SDana Myers                ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers                    "Arg (%p) is an ObjRef(Node), storing in node %p\n",
db2bae30SDana Myers                    NewObjDesc, CurrentObjDesc));
db2bae30SDana Myers
db2bae30SDana Myers                /*
db2bae30SDana Myers                 * Store this object to the Node (perform the indirect store)
db2bae30SDana Myers                 * NOTE: No implicit conversion is performed, as per the ACPI
db2bae30SDana Myers                 * specification rules on storing to Locals/Args.
db2bae30SDana Myers                 */
db2bae30SDana Myers                Status = AcpiExStoreObjectToNode (NewObjDesc,
db2bae30SDana Myers                    CurrentObjDesc->Reference.Object, WalkState,
db2bae30SDana Myers                    ACPI_NO_IMPLICIT_CONVERSION);
db2bae30SDana Myers
db2bae30SDana Myers                /* Remove local reference if we copied the object above */
db2bae30SDana Myers
db2bae30SDana Myers                if (NewObjDesc != ObjDesc)
db2bae30SDana Myers                {
db2bae30SDana Myers                    AcpiUtRemoveReference (NewObjDesc);
db2bae30SDana Myers                }
*385cc6b4SJerry Jelinek
db2bae30SDana Myers                return_ACPI_STATUS (Status);
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Delete the existing object before storing the new one */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiDsMethodDataDeleteValue (Type, Index, WalkState);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Install the Obj descriptor (*NewObjDesc) into
db2bae30SDana Myers     * the descriptor for the Arg or Local.
db2bae30SDana Myers     * (increments the object reference count by one)
db2bae30SDana Myers     */
db2bae30SDana Myers    Status = AcpiDsMethodDataSetValue (Type, Index, NewObjDesc, WalkState);
db2bae30SDana Myers
db2bae30SDana Myers    /* Remove local reference if we copied the object above */
db2bae30SDana Myers
db2bae30SDana Myers    if (NewObjDesc != ObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiUtRemoveReference (NewObjDesc);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_OBSOLETE_FUNCTIONS
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsMethodDataGetType
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Opcode              - Either AML_LOCAL_OP or AML_ARG_OP
db2bae30SDana Myers *              Index               - Which Local or Arg whose type to get
db2bae30SDana Myers *              WalkState           - Current walk state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Data type of current value of the selected Arg or Local
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get the type of the object stored in the Local or Arg
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_OBJECT_TYPE
db2bae30SDana MyersAcpiDsMethodDataGetType (
db2bae30SDana Myers    UINT16                  Opcode,
db2bae30SDana Myers    UINT32                  Index,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *Object;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsMethodDataGetType);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the namespace node for the arg/local */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiDsMethodDataGetNode (Opcode, Index, WalkState, &Node);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_VALUE ((ACPI_TYPE_NOT_FOUND));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the object */
db2bae30SDana Myers
db2bae30SDana Myers    Object = AcpiNsGetAttachedObject (Node);
db2bae30SDana Myers    if (!Object)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Uninitialized local/arg, return TYPE_ANY */
db2bae30SDana Myers
db2bae30SDana Myers        return_VALUE (ACPI_TYPE_ANY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the object type */
db2bae30SDana Myers
aa2aa9a6SDana Myers    return_VALUE (Object->Type);
db2bae30SDana Myers}
db2bae30SDana Myers#endif