acpica/executer/exoparg3.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: exoparg3 - AML execution - opcodes with 3 arguments
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 "acinterp.h"
db2bae30SDana Myers#include "acparser.h"
db2bae30SDana Myers#include "amlcode.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_EXECUTER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("exoparg3")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*!
db2bae30SDana Myers * Naming convention for AML interpreter execution routines.
db2bae30SDana Myers *
db2bae30SDana Myers * The routines that begin execution of AML opcodes are named with a common
db2bae30SDana Myers * convention based upon the number of arguments, the number of target operands,
db2bae30SDana Myers * and whether or not a value is returned:
db2bae30SDana Myers *
db2bae30SDana Myers *      AcpiExOpcode_xA_yT_zR
db2bae30SDana Myers *
db2bae30SDana Myers * Where:
db2bae30SDana Myers *
db2bae30SDana Myers * xA - ARGUMENTS:    The number of arguments (input operands) that are
db2bae30SDana Myers *                    required for this opcode type (1 through 6 args).
db2bae30SDana Myers * yT - TARGETS:      The number of targets (output operands) that are required
db2bae30SDana Myers *                    for this opcode type (0, 1, or 2 targets).
db2bae30SDana Myers * zR - RETURN VALUE: Indicates whether this opcode type returns a value
db2bae30SDana Myers *                    as the function return (0 or 1).
db2bae30SDana Myers *
db2bae30SDana Myers * The AcpiExOpcode* functions are called via the Dispatcher component with
db2bae30SDana Myers * fully resolved operands.
db2bae30SDana Myers!*/
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExOpcode_3A_0T_0R
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Execute Triadic operator (3 operands)
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExOpcode_3A_0T_0R (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
db2bae30SDana Myers    ACPI_SIGNAL_FATAL_INFO  *Fatal;
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_0T_0R,
db2bae30SDana Myers        AcpiPsGetOpcodeName (WalkState->Opcode));
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    switch (WalkState->Opcode)
db2bae30SDana Myers    {
db2bae30SDana Myers    case AML_FATAL_OP:          /* Fatal (FatalType  FatalCode  FatalArg) */
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
*385cc6b4SJerry Jelinek            "FatalOp: Type %X Code %X Arg %X "
*385cc6b4SJerry Jelinek            "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n",
db2bae30SDana Myers            (UINT32) Operand[0]->Integer.Value,
db2bae30SDana Myers            (UINT32) Operand[1]->Integer.Value,
db2bae30SDana Myers            (UINT32) Operand[2]->Integer.Value));
db2bae30SDana Myers
db2bae30SDana Myers        Fatal = ACPI_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO));
db2bae30SDana Myers        if (Fatal)
db2bae30SDana Myers        {
db2bae30SDana Myers            Fatal->Type = (UINT32) Operand[0]->Integer.Value;
db2bae30SDana Myers            Fatal->Code = (UINT32) Operand[1]->Integer.Value;
db2bae30SDana Myers            Fatal->Argument = (UINT32) Operand[2]->Integer.Value;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Always signal the OS! */
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal);
db2bae30SDana Myers
db2bae30SDana Myers        /* Might return while OS is shutting down, just continue */
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_FREE (Fatal);
*385cc6b4SJerry Jelinek        goto Cleanup;
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    case AML_EXTERNAL_OP:
*385cc6b4SJerry Jelinek        /*
*385cc6b4SJerry Jelinek         * If the interpreter sees this opcode, just ignore it. The External
*385cc6b4SJerry Jelinek         * op is intended for use by disassemblers in order to properly
*385cc6b4SJerry Jelinek         * disassemble control method invocations. The opcode or group of
*385cc6b4SJerry Jelinek         * opcodes should be surrounded by an "if (0)" clause to ensure that
*385cc6b4SJerry Jelinek         * AML interpreters never see the opcode. Thus, something is
*385cc6b4SJerry Jelinek         * wrong if an external opcode ever gets here.
*385cc6b4SJerry Jelinek         */
*385cc6b4SJerry Jelinek        ACPI_ERROR ((AE_INFO, "Executed External Op"));
*385cc6b4SJerry Jelinek        Status = AE_OK;
*385cc6b4SJerry Jelinek        goto Cleanup;
db2bae30SDana Myers
db2bae30SDana Myers    default:
db2bae30SDana Myers
26f3cdf0SGordon Ross        ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
db2bae30SDana Myers            WalkState->Opcode));
*385cc6b4SJerry Jelinek
db2bae30SDana Myers        Status = AE_AML_BAD_OPCODE;
db2bae30SDana Myers        goto Cleanup;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana MyersCleanup:
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExOpcode_3A_1T_1R
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Execute Triadic operator (3 operands)
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExOpcode_3A_1T_1R (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
db2bae30SDana Myers    char                    *Buffer = NULL;
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
26f3cdf0SGordon Ross    UINT64                  Index;
db2bae30SDana Myers    ACPI_SIZE               Length;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R,
db2bae30SDana Myers        AcpiPsGetOpcodeName (WalkState->Opcode));
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    switch (WalkState->Opcode)
db2bae30SDana Myers    {
db2bae30SDana Myers    case AML_MID_OP:    /* Mid (Source[0], Index[1], Length[2], Result[3]) */
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Create the return object. The Source operand is guaranteed to be
db2bae30SDana Myers         * either a String or a Buffer, so just use its type.
db2bae30SDana Myers         */
db2bae30SDana Myers        ReturnDesc = AcpiUtCreateInternalObject (
aa2aa9a6SDana Myers            (Operand[0])->Common.Type);
db2bae30SDana Myers        if (!ReturnDesc)
db2bae30SDana Myers        {
db2bae30SDana Myers            Status = AE_NO_MEMORY;
db2bae30SDana Myers            goto Cleanup;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Get the Integer values from the objects */
db2bae30SDana Myers
db2bae30SDana Myers        Index = Operand[1]->Integer.Value;
db2bae30SDana Myers        Length = (ACPI_SIZE) Operand[2]->Integer.Value;
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * If the index is beyond the length of the String/Buffer, or if the
db2bae30SDana Myers         * requested length is zero, return a zero-length String/Buffer
db2bae30SDana Myers         */
db2bae30SDana Myers        if (Index >= Operand[0]->String.Length)
db2bae30SDana Myers        {
db2bae30SDana Myers            Length = 0;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Truncate request if larger than the actual String/Buffer */
db2bae30SDana Myers
db2bae30SDana Myers        else if ((Index + Length) > Operand[0]->String.Length)
db2bae30SDana Myers        {
*385cc6b4SJerry Jelinek            Length =
*385cc6b4SJerry Jelinek                (ACPI_SIZE) Operand[0]->String.Length - (ACPI_SIZE) Index;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Strings always have a sub-pointer, not so for buffers */
db2bae30SDana Myers
aa2aa9a6SDana Myers        switch ((Operand[0])->Common.Type)
db2bae30SDana Myers        {
db2bae30SDana Myers        case ACPI_TYPE_STRING:
db2bae30SDana Myers
db2bae30SDana Myers            /* Always allocate a new buffer for the String */
db2bae30SDana Myers
db2bae30SDana Myers            Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1);
db2bae30SDana Myers            if (!Buffer)
db2bae30SDana Myers            {
db2bae30SDana Myers                Status = AE_NO_MEMORY;
db2bae30SDana Myers                goto Cleanup;
db2bae30SDana Myers            }
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        case ACPI_TYPE_BUFFER:
db2bae30SDana Myers
db2bae30SDana Myers            /* If the requested length is zero, don't allocate a buffer */
db2bae30SDana Myers
db2bae30SDana Myers            if (Length > 0)
db2bae30SDana Myers            {
db2bae30SDana Myers                /* Allocate a new buffer for the Buffer */
db2bae30SDana Myers
db2bae30SDana Myers                Buffer = ACPI_ALLOCATE_ZEROED (Length);
db2bae30SDana Myers                if (!Buffer)
db2bae30SDana Myers                {
db2bae30SDana Myers                    Status = AE_NO_MEMORY;
db2bae30SDana Myers                    goto Cleanup;
db2bae30SDana Myers                }
db2bae30SDana Myers            }
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        default:                        /* Should not happen */
db2bae30SDana Myers
db2bae30SDana Myers            Status = AE_AML_OPERAND_TYPE;
db2bae30SDana Myers            goto Cleanup;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (Buffer)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* We have a buffer, copy the portion requested */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek            memcpy (Buffer,
*385cc6b4SJerry Jelinek                Operand[0]->String.Pointer + Index, Length);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Set the length of the new String/Buffer */
db2bae30SDana Myers
db2bae30SDana Myers        ReturnDesc->String.Pointer = Buffer;
db2bae30SDana Myers        ReturnDesc->String.Length = (UINT32) Length;
db2bae30SDana Myers
db2bae30SDana Myers        /* Mark buffer initialized */
db2bae30SDana Myers
db2bae30SDana Myers        ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
db2bae30SDana Myers
26f3cdf0SGordon Ross        ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
db2bae30SDana Myers            WalkState->Opcode));
*385cc6b4SJerry Jelinek
db2bae30SDana Myers        Status = AE_AML_BAD_OPCODE;
db2bae30SDana Myers        goto Cleanup;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Store the result in the target */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiExStore (ReturnDesc, Operand[3], WalkState);
db2bae30SDana Myers
db2bae30SDana MyersCleanup:
db2bae30SDana Myers
db2bae30SDana Myers    /* Delete return object on error */
db2bae30SDana Myers
db2bae30SDana Myers    if (ACPI_FAILURE (Status) || WalkState->ResultObj)
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiUtRemoveReference (ReturnDesc);
db2bae30SDana Myers        WalkState->ResultObj = NULL;
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        /* Set the return object and exit */
*385cc6b4SJerry Jelinek
db2bae30SDana Myers        WalkState->ResultObj = ReturnDesc;
db2bae30SDana Myers    }
*385cc6b4SJerry Jelinek
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}