acpica/executer/exresnte.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: exresnte - AML Interpreter object resolution
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 "acinterp.h"
db2bae30SDana Myers#include "acnamesp.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_EXECUTER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("exresnte")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExResolveNodeToValue
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
db2bae30SDana Myers *                                a pointer to a NS node, and will receive a
db2bae30SDana Myers *                                pointer to the resolved object.
db2bae30SDana Myers *              WalkState       - Current state. Valid only if executing AML
db2bae30SDana Myers *                                code. NULL if simply resolving an object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Resolve a Namespace node to a valued object
db2bae30SDana Myers *
db2bae30SDana Myers * Note: for some of the data types, the pointer attached to the Node
db2bae30SDana Myers * can be either a pointer to an actual internal object or a pointer into the
db2bae30SDana Myers * AML stream itself. These types are currently:
db2bae30SDana Myers *
db2bae30SDana Myers *      ACPI_TYPE_INTEGER
db2bae30SDana Myers *      ACPI_TYPE_STRING
db2bae30SDana Myers *      ACPI_TYPE_BUFFER
db2bae30SDana Myers *      ACPI_TYPE_MUTEX
db2bae30SDana Myers *      ACPI_TYPE_PACKAGE
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExResolveNodeToValue (
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     **ObjectPtr,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *SourceDesc;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node;
db2bae30SDana Myers    ACPI_OBJECT_TYPE        EntryType;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExResolveNodeToValue);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * The stack pointer points to a ACPI_NAMESPACE_NODE (Node). Get the
db2bae30SDana Myers     * object that is attached to the Node.
db2bae30SDana Myers     */
db2bae30SDana Myers    Node = *ObjectPtr;
db2bae30SDana Myers    SourceDesc = AcpiNsGetAttachedObject (Node);
db2bae30SDana Myers    EntryType = AcpiNsGetType ((ACPI_HANDLE) Node);
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
db2bae30SDana Myers         Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
db2bae30SDana Myers
db2bae30SDana Myers    if ((EntryType == ACPI_TYPE_LOCAL_ALIAS) ||
db2bae30SDana Myers        (EntryType == ACPI_TYPE_LOCAL_METHOD_ALIAS))
db2bae30SDana Myers    {
db2bae30SDana Myers        /* There is always exactly one level of indirection */
db2bae30SDana Myers
db2bae30SDana Myers        Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
db2bae30SDana Myers        SourceDesc = AcpiNsGetAttachedObject (Node);
db2bae30SDana Myers        EntryType = AcpiNsGetType ((ACPI_HANDLE) Node);
db2bae30SDana Myers        *ObjectPtr = Node;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Several object types require no further processing:
*385cc6b4SJerry Jelinek     * 1) Device/Thermal objects don't have a "real" subobject, return Node
db2bae30SDana Myers     * 2) Method locals and arguments have a pseudo-Node
db2bae30SDana Myers     * 3) 10/2007: Added method type to assist with Package construction.
db2bae30SDana Myers     */
db2bae30SDana Myers    if ((EntryType == ACPI_TYPE_DEVICE)  ||
db2bae30SDana Myers        (EntryType == ACPI_TYPE_THERMAL) ||
db2bae30SDana Myers        (EntryType == ACPI_TYPE_METHOD)  ||
db2bae30SDana Myers        (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (!SourceDesc)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        ACPI_ERROR ((AE_INFO, "No object attached to node [%4.4s] %p",
*385cc6b4SJerry Jelinek            Node->Name.Ascii, Node));
*385cc6b4SJerry Jelinek        return_ACPI_STATUS (AE_AML_UNINITIALIZED_NODE);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Action is based on the type of the Node, which indicates the type
db2bae30SDana Myers     * of the attached object or pointer
db2bae30SDana Myers     */
db2bae30SDana Myers    switch (EntryType)
db2bae30SDana Myers    {
db2bae30SDana Myers    case ACPI_TYPE_PACKAGE:
db2bae30SDana Myers
aa2aa9a6SDana Myers        if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Object not a Package, type %s",
db2bae30SDana Myers                AcpiUtGetObjectTypeName (SourceDesc)));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiDsGetPackageArguments (SourceDesc);
db2bae30SDana Myers        if (ACPI_SUCCESS (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Return an additional reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers            ObjDesc = SourceDesc;
db2bae30SDana Myers            AcpiUtAddReference (ObjDesc);
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_BUFFER:
db2bae30SDana Myers
aa2aa9a6SDana Myers        if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Object not a Buffer, type %s",
db2bae30SDana Myers                AcpiUtGetObjectTypeName (SourceDesc)));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiDsGetBufferArguments (SourceDesc);
db2bae30SDana Myers        if (ACPI_SUCCESS (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Return an additional reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers            ObjDesc = SourceDesc;
db2bae30SDana Myers            AcpiUtAddReference (ObjDesc);
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_STRING:
db2bae30SDana Myers
aa2aa9a6SDana Myers        if (SourceDesc->Common.Type != ACPI_TYPE_STRING)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Object not a String, type %s",
db2bae30SDana Myers                AcpiUtGetObjectTypeName (SourceDesc)));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Return an additional reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers        ObjDesc = SourceDesc;
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_INTEGER:
db2bae30SDana Myers
aa2aa9a6SDana Myers        if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Object not a Integer, type %s",
db2bae30SDana Myers                AcpiUtGetObjectTypeName (SourceDesc)));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Return an additional reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers        ObjDesc = SourceDesc;
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_BUFFER_FIELD:
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_REGION_FIELD:
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_BANK_FIELD:
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_INDEX_FIELD:
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers            "FieldRead Node=%p SourceDesc=%p Type=%X\n",
db2bae30SDana Myers            Node, SourceDesc, EntryType));
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    /* For these objects, just return the object attached to the Node */
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_MUTEX:
db2bae30SDana Myers    case ACPI_TYPE_POWER:
db2bae30SDana Myers    case ACPI_TYPE_PROCESSOR:
db2bae30SDana Myers    case ACPI_TYPE_EVENT:
db2bae30SDana Myers    case ACPI_TYPE_REGION:
db2bae30SDana Myers
db2bae30SDana Myers        /* Return an additional reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers        ObjDesc = SourceDesc;
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    /* TYPE_ANY is untyped, and thus there is no object associated with it */
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_ANY:
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
db2bae30SDana Myers            "Untyped entry %p, no attached object!", Node));
db2bae30SDana Myers
db2bae30SDana Myers        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_REFERENCE:
db2bae30SDana Myers
db2bae30SDana Myers        switch (SourceDesc->Reference.Class)
db2bae30SDana Myers        {
db2bae30SDana Myers        case ACPI_REFCLASS_TABLE:   /* This is a DdbHandle */
db2bae30SDana Myers        case ACPI_REFCLASS_REFOF:
db2bae30SDana Myers        case ACPI_REFCLASS_INDEX:
db2bae30SDana Myers
db2bae30SDana Myers            /* Return an additional reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers            ObjDesc = SourceDesc;
db2bae30SDana Myers            AcpiUtAddReference (ObjDesc);
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        default:
*385cc6b4SJerry Jelinek
db2bae30SDana Myers            /* No named references are allowed here */
db2bae30SDana Myers
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Unsupported Reference type 0x%X",
db2bae30SDana Myers                SourceDesc->Reference.Class));
db2bae30SDana Myers
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
db2bae30SDana Myers
db2bae30SDana Myers        /* Default case is for unknown types */
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross            "Node %p - Unknown object type 0x%X",
db2bae30SDana Myers            Node, EntryType));
db2bae30SDana Myers
db2bae30SDana Myers        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers
db2bae30SDana Myers    } /* switch (EntryType) */
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Return the object descriptor */
db2bae30SDana Myers
db2bae30SDana Myers    *ObjectPtr = (void *) ObjDesc;
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}