xref: /freebsd-11.0-release/sys/contrib/dev/acpica/components/executer/exresnte.c

/******************************************************************************
 *
 * Module Name: amresnte - AML Interpreter object resolution
 *              $Revision: 24 $
 *
 *****************************************************************************/

/******************************************************************************
 *
 * 1. Copyright Notice
 *
 * Some or all of this work - Copyright (c) 1999, Intel Corp.  All rights
 * reserved.
 *
 * 2. License
 *
 * 2.1. This is your license from Intel Corp. under its intellectual property
 * rights.  You may have additional license terms from the party that provided
 * you this software, covering your right to use that party's intellectual
 * property rights.
 *
 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
 * copy of the source code appearing in this file ("Covered Code") an
 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
 * base code distributed originally by Intel ("Original Intel Code") to copy,
 * make derivatives, distribute, use and display any portion of the Covered
 * Code in any form, with the right to sublicense such rights; and
 *
 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
 * license (with the right to sublicense), under only those claims of Intel
 * patents that are infringed by the Original Intel Code, to make, use, sell,
 * offer to sell, and import the Covered Code and derivative works thereof
 * solely to the minimum extent necessary to exercise the above copyright
 * license, and in no event shall the patent license extend to any additions
 * to or modifications of the Original Intel Code.  No other license or right
 * is granted directly or by implication, estoppel or otherwise;
 *
 * The above copyright and patent license is granted only if the following
 * conditions are met:
 *
 * 3. Conditions
 *
 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification with rights to further distribute source must include
 * the above Copyright Notice, the above License, this list of Conditions,
 * and the following Disclaimer and Export Compliance provision.  In addition,
 * Licensee must cause all Covered Code to which Licensee contributes to
 * contain a file documenting the changes Licensee made to create that Covered
 * Code and the date of any change.  Licensee must include in that file the
 * documentation of any changes made by any predecessor Licensee.  Licensee
 * must include a prominent statement that the modification is derived,
 * directly or indirectly, from Original Intel Code.
 *
 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification without rights to further distribute source must
 * include the following Disclaimer and Export Compliance provision in the
 * documentation and/or other materials provided with distribution.  In
 * addition, Licensee may not authorize further sublicense of source of any
 * portion of the Covered Code, and must include terms to the effect that the
 * license from Licensee to its licensee is limited to the intellectual
 * property embodied in the software Licensee provides to its licensee, and
 * not to intellectual property embodied in modifications its licensee may
 * make.
 *
 * 3.3. Redistribution of Executable. Redistribution in executable form of any
 * substantial portion of the Covered Code or modification must reproduce the
 * above Copyright Notice, and the following Disclaimer and Export Compliance
 * provision in the documentation and/or other materials provided with the
 * distribution.
 *
 * 3.4. Intel retains all right, title, and interest in and to the Original
 * Intel Code.
 *
 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
 * Intel shall be used in advertising or otherwise to promote the sale, use or
 * other dealings in products derived from or relating to the Covered Code
 * without prior written authorization from Intel.
 *
 * 4. Disclaimer and Export Compliance
 *
 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
 * PARTICULAR PURPOSE.
 *
 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 * LIMITED REMEDY.
 *
 * 4.3. Licensee shall not export, either directly or indirectly, any of this
 * software or system incorporating such software without first obtaining any
 * required license or other approval from the U. S. Department of Commerce or
 * any other agency or department of the United States Government.  In the
 * event Licensee exports any such software from the United States or
 * re-exports any such software from a foreign destination, Licensee shall
 * ensure that the distribution and export/re-export of the software is in
 * compliance with all laws, regulations, orders, or other restrictions of the
 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 * any of its subsidiaries will export/re-export any technical data, process,
 * software, or service, directly or indirectly, to any country for which the
 * United States government or any agency thereof requires an export license,
 * other governmental approval, or letter of assurance, without first obtaining
 * such license, approval or letter.
 *
 *****************************************************************************/

#define __AMRESNTE_C__

#include "acpi.h"
#include "amlcode.h"
#include "acparser.h"
#include "acdispat.h"
#include "acinterp.h"
#include "acnamesp.h"
#include "actables.h"
#include "acevents.h"


#define _COMPONENT          INTERPRETER
        MODULE_NAME         ("amresnte")


/*******************************************************************************
 *
 * FUNCTION:    AcpiAmlResolveNodeToValue
 *
 * PARAMETERS:  StackPtr        - Pointer to a location on a stack that contains
 *                                a pointer to an Node
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Resolve a ACPI_NAMESPACE_NODE (Node,
 *              A.K.A. a "direct name pointer")
 *
 * Note: for some of the data types, the pointer attached to the Node
 * can be either a pointer to an actual internal object or a pointer into the
 * AML stream itself.  These types are currently:
 *
 *      ACPI_TYPE_NUMBER
 *      ACPI_TYPE_STRING
 *      ACPI_TYPE_BUFFER
 *      ACPI_TYPE_MUTEX
 *      ACPI_TYPE_PACKAGE
 *
 ******************************************************************************/

ACPI_STATUS
AcpiAmlResolveNodeToValue (
    ACPI_NAMESPACE_NODE     **StackPtr,
    ACPI_WALK_STATE         *WalkState)

{
    ACPI_STATUS             Status = AE_OK;
    ACPI_OPERAND_OBJECT     *ValDesc = NULL;
    ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
    ACPI_NAMESPACE_NODE     *Node;
    UINT8                   *AmlPointer = NULL;
    OBJECT_TYPE_INTERNAL    EntryType;
    BOOLEAN                 Locked;
    BOOLEAN                 AttachedAmlPointer = FALSE;
    UINT8                   AmlOpcode = 0;
    ACPI_INTEGER            TempVal;
    OBJECT_TYPE_INTERNAL    ObjectType;


    FUNCTION_TRACE ("AmlResolveEntryToValue");

    Node = *StackPtr;


    /*
     * The stack pointer is a "Direct name ptr", and points to a
     * a ACPI_NAMESPACE_NODE (Node).  Get the pointer that is attached to
     * the Node.
     */

    ValDesc     = AcpiNsGetAttachedObject ((ACPI_HANDLE) Node);
    EntryType   = AcpiNsGetType ((ACPI_HANDLE) Node);

    DEBUG_PRINT (TRACE_EXEC,
        ("AmlResolveEntryToValue: Entry=%p ValDesc=%p Type=%X\n",
         Node, ValDesc, EntryType));

    /*
     * The ValDesc attached to the Node can be either:
     * 1) An internal ACPI object
     * 2) A pointer into the AML stream (into one of the ACPI system tables)
     */

    if (AcpiTbSystemTablePointer (ValDesc))
    {
        AttachedAmlPointer = TRUE;
        AmlOpcode = *((UINT8 *) ValDesc);
        AmlPointer = ((UINT8 *) ValDesc) + 1;

        DEBUG_PRINT (TRACE_EXEC,
            ("AmlResolveEntryToValue: Unparsed AML: %p Len=%X\n",
            AmlOpcode, AmlPointer));
    }


    /*
     * Several EntryTypes do not require further processing, so
     *  we will return immediately
     */
    /* Devices rarely have an attached object, return the Node
     *  and Method locals and arguments have a pseudo-Node
     */
    if (EntryType == ACPI_TYPE_DEVICE ||
        EntryType == INTERNAL_TYPE_METHOD_ARGUMENT ||
        EntryType == INTERNAL_TYPE_METHOD_LOCAL_VAR)
    {
        return_ACPI_STATUS (AE_OK);
    }

    if (!ValDesc)
    {
        DEBUG_PRINT (ACPI_ERROR,
            ("AmlResolveEntryToValue: No object attached to node %p\n",
            Node));
        return_ACPI_STATUS (AE_AML_NO_OPERAND);
    }

    /*
     * Action is based on the type of the Node, which indicates the type
     * of the attached object or pointer
     */
    switch (EntryType)
    {

    case ACPI_TYPE_PACKAGE:

        if (AttachedAmlPointer)
        {
            /*
             * This means that the package initialization is not parsed
             * -- should not happen
             */
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveEntryToValue: Unparsed Packages not supported!\n"));
            return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
        }

        /* ValDesc is an internal object in all cases by the time we get here */

        if (ACPI_TYPE_PACKAGE != ValDesc->Common.Type)
        {
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveEntryToValue: Object not a package, type %X\n",
                ValDesc->Common.Type));
            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }

        /* Return an additional reference to the object */

        ObjDesc = ValDesc;
        AcpiCmAddReference (ObjDesc);
        break;


    case ACPI_TYPE_BUFFER:

        if (AttachedAmlPointer)
        {
            /*
             * This means that the buffer initialization is not parsed
             * -- should not happen
             */
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveEntryToValue: Unparsed Buffers not supported!\n"));
            return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
        }

        /* ValDesc is an internal object in all cases by the time we get here */

        if (ACPI_TYPE_BUFFER != ValDesc->Common.Type)
        {
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveEntryToValue: Object not a buffer, type %X\n",
                ValDesc->Common.Type));
            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }

        /* Return an additional reference to the object */

        ObjDesc = ValDesc;
        AcpiCmAddReference (ObjDesc);
        break;


    case ACPI_TYPE_STRING:

        if (AttachedAmlPointer)
        {
            /* Allocate a new string object */

            ObjDesc = AcpiCmCreateInternalObject (ACPI_TYPE_STRING);
            if (!ObjDesc)
            {
                return_ACPI_STATUS (AE_NO_MEMORY);
            }

            /* Init the internal object */

            ObjDesc->String.Pointer = (NATIVE_CHAR *) AmlPointer;
            ObjDesc->String.Length = STRLEN (ObjDesc->String.Pointer);
        }

        else
        {
            if (ACPI_TYPE_STRING != ValDesc->Common.Type)
            {
                DEBUG_PRINT (ACPI_ERROR,
                    ("AmlResolveEntryToValue: Object not a string, type %X\n",
                    ValDesc->Common.Type));
                return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
            }

            /* Return an additional reference to the object */

            ObjDesc = ValDesc;
            AcpiCmAddReference (ObjDesc);
        }

        break;


    case ACPI_TYPE_NUMBER:

        DEBUG_PRINT (TRACE_EXEC, ("AmlResolveEntryToValue: case Number \n"));

        /*
         * The Node has an attached internal object, make sure that it's a
         * number
         */

        if (ACPI_TYPE_NUMBER != ValDesc->Common.Type)
        {
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveToValue: Object not a Number, type %X\n",
                ValDesc->Common.Type));
            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }

        /* Return an additional reference to the object */

        ObjDesc = ValDesc;
        AcpiCmAddReference (ObjDesc);
        break;


    case INTERNAL_TYPE_DEF_FIELD:

        /*
         * TBD: [Investigate] Is this the correct solution?
         *
         * This section was extended to convert to generic buffer if
         *  the return length is greater than 32 bits, but still allows
         *  for returning a type Number for smaller values because the
         *  caller can then apply arithmetic operators on those fields.
         *
         * XXX - Implementation limitation: Fields are implemented as type
         * XXX - Number, but they really are supposed to be type Buffer.
         * XXX - The two are interchangeable only for lengths <= 32 bits.
         */
        if(ValDesc->Field.Length > 32)
        {
            ObjectType = ACPI_TYPE_BUFFER;
        }
        else
        {
            ObjectType = ACPI_TYPE_NUMBER;
        }

        /*
         * Create the destination buffer object and the buffer space.
         */
        ObjDesc = AcpiCmCreateInternalObject (ObjectType);
        if (!ObjDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }

        /*
         * Fill in the object specific details
         */
        if (ACPI_TYPE_BUFFER == ObjectType)
        {
            ObjDesc->Buffer.Pointer = AcpiCmCallocate (ValDesc->Field.Length);
            if (!ObjDesc->Buffer.Pointer)
            {
                AcpiCmRemoveReference(ObjDesc);
                return_ACPI_STATUS (AE_NO_MEMORY);
            }

            ObjDesc->Buffer.Length = ValDesc->Field.Length;

            Status = AcpiAmlAccessNamedField (ACPI_READ, (ACPI_HANDLE) Node,
                            ObjDesc->Buffer.Pointer, ObjDesc->Buffer.Length);

            if (ACPI_FAILURE (Status))
            {
                return_ACPI_STATUS (Status);
            }
        }
        else
        {
            Status = AcpiAmlAccessNamedField (ACPI_READ, (ACPI_HANDLE) Node,
                            &TempVal, sizeof (TempVal));

            if (ACPI_FAILURE (Status))
            {
                return_ACPI_STATUS (Status);
            }

            ObjDesc->Number.Value = TempVal;
        }


        DEBUG_PRINT (TRACE_EXEC,
            ("AmlResolveEntryToValue: DefField Entry=%p ValDesc=%p Type=%X\n",
            Node, ValDesc, EntryType));
        break;


    case INTERNAL_TYPE_BANK_FIELD:

        if (AttachedAmlPointer)
        {
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveEntryToValue: BankField cannot be an Aml ptr\n"));
            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }

        if (INTERNAL_TYPE_BANK_FIELD != ValDesc->Common.Type)
        {
            DEBUG_PRINT (ACPI_ERROR, (
                "AmlResolveToValue: Object not a BankField, type %X\n",
                ValDesc->Common.Type));

            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }


        /* Get the global lock if needed */

        ObjDesc = (ACPI_OPERAND_OBJECT  *) *StackPtr;
        Locked = AcpiAmlAcquireGlobalLock (ObjDesc->FieldUnit.LockRule);

        /* Set Index value to select proper Data register */
        /* perform the update */

        Status = AcpiAmlAccessNamedField (ACPI_WRITE,
                    ValDesc->BankField.BankSelect, &ValDesc->BankField.Value,
                    sizeof (ValDesc->BankField.Value));

        AcpiAmlReleaseGlobalLock (Locked);


        if (ACPI_FAILURE (Status))
        {
            return_ACPI_STATUS (Status);
        }

        /* Read Data value */

        Status = AcpiAmlAccessNamedField (ACPI_READ,
                    (ACPI_HANDLE) ValDesc->BankField.Container,
                    &TempVal, sizeof (TempVal));
        if (ACPI_FAILURE (Status))
        {
            return_ACPI_STATUS (Status);
        }

        /* Create an object for the result */

        ObjDesc = AcpiCmCreateInternalObject (ACPI_TYPE_NUMBER);
        if (!ObjDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }

        ObjDesc->Number.Value = TempVal;
        break;


    case INTERNAL_TYPE_INDEX_FIELD:

        if (AttachedAmlPointer)
        {
            DEBUG_PRINT (ACPI_ERROR, ("AmlResolveEntryToValue: Internal - IndexField cannot be an Aml ptr\n"));
            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }

        if (INTERNAL_TYPE_INDEX_FIELD != ValDesc->Common.Type)
        {
            DEBUG_PRINT (ACPI_ERROR, (
                "AmlResolveToValue: Object not an IndexField, type %X\n",
                ValDesc->Common.Type));

            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }


        /* Set Index value to select proper Data register */
        /* Get the global lock if needed */

        ObjDesc = (ACPI_OPERAND_OBJECT  *) *StackPtr;
        Locked = AcpiAmlAcquireGlobalLock (ObjDesc->FieldUnit.LockRule);

        /* Perform the update */

        Status = AcpiAmlAccessNamedField (ACPI_WRITE,
                        ValDesc->IndexField.Index, &ValDesc->IndexField.Value,
                        sizeof (ValDesc->IndexField.Value));

        AcpiAmlReleaseGlobalLock (Locked);

        if (ACPI_FAILURE (Status))
        {
            return_ACPI_STATUS (Status);
        }

        /* Read Data value */

        Status = AcpiAmlAccessNamedField (ACPI_READ, ValDesc->IndexField.Data,
                        &TempVal, sizeof (TempVal));
        if (ACPI_FAILURE (Status))
        {
            return_ACPI_STATUS (Status);
        }

        /* Create an object for the result */

        ObjDesc = AcpiCmCreateInternalObject (ACPI_TYPE_NUMBER);
        if (!ObjDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }

        ObjDesc->Number.Value = TempVal;
        break;


    case ACPI_TYPE_FIELD_UNIT:

        if (AttachedAmlPointer)
        {
            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveEntryToValue: FieldUnit cannot be an Aml ptr\n"));
            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
        }

        if (ValDesc->Common.Type != (UINT8) EntryType)
        {
            DEBUG_PRINT (ACPI_ERROR, (
                "AmlResolveToValue: Object type %X not same as EntryType %X\n",
                ValDesc->Common.Type, EntryType));

            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
            break;
        }

        /* Create object for result */

        ObjDesc = AcpiCmCreateInternalObject (ACPI_TYPE_ANY);
        if (!ObjDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }

        Status = AcpiAmlGetFieldUnitValue (ValDesc, ObjDesc);
        if (ACPI_FAILURE (Status))
        {
            AcpiCmRemoveReference (ObjDesc);
            return_ACPI_STATUS (Status);
        }

        break;


    /*
     * For these objects, just return the object attached to the Node
     */

    case ACPI_TYPE_MUTEX:
    case ACPI_TYPE_METHOD:
    case ACPI_TYPE_POWER:
    case ACPI_TYPE_PROCESSOR:
    case ACPI_TYPE_THERMAL:
    case ACPI_TYPE_EVENT:
    case ACPI_TYPE_REGION:


        /* Return an additional reference to the object */

        ObjDesc = ValDesc;
        AcpiCmAddReference (ObjDesc);
        break;


    /* TYPE_Any is untyped, and thus there is no object associated with it */

    case ACPI_TYPE_ANY:

        DEBUG_PRINT (ACPI_ERROR,
            ("AmlResolveEntryToValue: Untyped entry %p, no attached object!\n",
            Node));

        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
        break;


    /*
     * The only named references allowed are named constants
     *
     * e.g.     Name (\OSFL, Ones)
     */
    case INTERNAL_TYPE_REFERENCE:

        switch (ValDesc->Reference.OpCode)
        {

        case AML_ZERO_OP:

            TempVal = 0;
            break;


        case AML_ONE_OP:

            TempVal = 1;
            break;


        case AML_ONES_OP:

            TempVal = ACPI_INTEGER_MAX;
            break;


        default:

            DEBUG_PRINT (ACPI_ERROR,
                ("AmlResolveToValue/Number: Unsupported reference opcode %X\n",
                ValDesc->Reference.OpCode));

            return_ACPI_STATUS (AE_AML_BAD_OPCODE);
        }

        /* Create object for result */

        ObjDesc = AcpiCmCreateInternalObject (ACPI_TYPE_NUMBER);
        if (!ObjDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }

        ObjDesc->Number.Value = TempVal;

        /* Truncate value if we are executing from a 32-bit ACPI table */

        AcpiAmlTruncateFor32bitTable (ObjDesc, WalkState);
        break;


    /* Default case is for unknown types */

    default:

        DEBUG_PRINT (ACPI_ERROR,
            ("AmlResolveEntryToValue: Node %p - Unknown object type %X\n",
            Node, EntryType));

        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);

    } /* switch (EntryType) */


    /* Put the object descriptor on the stack */

    *StackPtr = (void *) ObjDesc;

    return_ACPI_STATUS (Status);
}