acpica/executer/exoparg6.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: exoparg6 - AML execution - opcodes with 6 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    ("exoparg6")
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/* Local prototypes */
db2bae30SDana Myers
db2bae30SDana Myersstatic BOOLEAN
db2bae30SDana MyersAcpiExDoMatch (
db2bae30SDana Myers    UINT32                  MatchOp,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *PackageObj,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *MatchObj);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExDoMatch
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  MatchOp         - The AML match operand
db2bae30SDana Myers *              PackageObj      - Object from the target package
db2bae30SDana Myers *              MatchObj        - Object to be matched
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      TRUE if the match is successful, FALSE otherwise
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Implements the low-level match for the ASL Match operator.
db2bae30SDana Myers *              Package elements will be implicitly converted to the type of
db2bae30SDana Myers *              the match object (Integer/Buffer/String).
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic BOOLEAN
db2bae30SDana MyersAcpiExDoMatch (
db2bae30SDana Myers    UINT32                  MatchOp,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *PackageObj,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *MatchObj)
db2bae30SDana Myers{
db2bae30SDana Myers    BOOLEAN                 LogicalResult = TRUE;
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Note: Since the PackageObj/MatchObj ordering is opposite to that of
db2bae30SDana Myers     * the standard logical operators, we have to reverse them when we call
db2bae30SDana Myers     * DoLogicalOp in order to make the implicit conversion rules work
db2bae30SDana Myers     * correctly. However, this means we have to flip the entire equation
db2bae30SDana Myers     * also. A bit ugly perhaps, but overall, better than fussing the
db2bae30SDana Myers     * parameters around at runtime, over and over again.
db2bae30SDana Myers     *
db2bae30SDana Myers     * Below, P[i] refers to the package element, M refers to the Match object.
db2bae30SDana Myers     */
db2bae30SDana Myers    switch (MatchOp)
db2bae30SDana Myers    {
db2bae30SDana Myers    case MATCH_MTR:
db2bae30SDana Myers
db2bae30SDana Myers        /* Always true */
db2bae30SDana Myers
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case MATCH_MEQ:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * True if equal: (P[i] == M)
db2bae30SDana Myers         * Change to:     (M == P[i])
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        Status = AcpiExDoLogicalOp (
*385cc6b4SJerry Jelinek            AML_LEQUAL_OP, MatchObj, PackageObj, &LogicalResult);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return (FALSE);
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case MATCH_MLE:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * True if less than or equal: (P[i] <= M) (P[i] NotGreater than M)
db2bae30SDana Myers         * Change to:                  (M >= P[i]) (M NotLess than P[i])
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        Status = AcpiExDoLogicalOp (
*385cc6b4SJerry Jelinek            AML_LLESS_OP, MatchObj, PackageObj, &LogicalResult);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return (FALSE);
db2bae30SDana Myers        }
db2bae30SDana Myers        LogicalResult = (BOOLEAN) !LogicalResult;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case MATCH_MLT:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * True if less than: (P[i] < M)
db2bae30SDana Myers         * Change to:         (M > P[i])
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        Status = AcpiExDoLogicalOp (
*385cc6b4SJerry Jelinek            AML_LGREATER_OP, MatchObj, PackageObj, &LogicalResult);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return (FALSE);
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case MATCH_MGE:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * True if greater than or equal: (P[i] >= M) (P[i] NotLess than M)
db2bae30SDana Myers         * Change to:                     (M <= P[i]) (M NotGreater than P[i])
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        Status = AcpiExDoLogicalOp (
*385cc6b4SJerry Jelinek            AML_LGREATER_OP, MatchObj, PackageObj, &LogicalResult);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return (FALSE);
db2bae30SDana Myers        }
db2bae30SDana Myers        LogicalResult = (BOOLEAN)!LogicalResult;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case MATCH_MGT:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * True if greater than: (P[i] > M)
db2bae30SDana Myers         * Change to:            (M < P[i])
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        Status = AcpiExDoLogicalOp (
*385cc6b4SJerry Jelinek            AML_LLESS_OP, MatchObj, PackageObj, &LogicalResult);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return (FALSE);
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
db2bae30SDana Myers
db2bae30SDana Myers        /* Undefined */
db2bae30SDana Myers
db2bae30SDana Myers        return (FALSE);
db2bae30SDana Myers    }
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    return (LogicalResult);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExOpcode_6A_0T_1R
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExOpcode_6A_0T_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    ACPI_STATUS             Status = AE_OK;
26f3cdf0SGordon Ross    UINT64                  Index;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ThisElement;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_STR (ExOpcode_6A_0T_1R,
db2bae30SDana Myers        AcpiPsGetOpcodeName (WalkState->Opcode));
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    switch (WalkState->Opcode)
db2bae30SDana Myers    {
db2bae30SDana Myers    case AML_MATCH_OP:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Match (SearchPkg[0], MatchOp1[1], MatchObj1[2],
db2bae30SDana Myers         *                      MatchOp2[3], MatchObj2[4], StartIndex[5])
db2bae30SDana Myers         */
db2bae30SDana Myers
db2bae30SDana Myers        /* Validate both Match Term Operators (MTR, MEQ, etc.) */
db2bae30SDana Myers
db2bae30SDana Myers        if ((Operand[1]->Integer.Value > MAX_MATCH_OPERATOR) ||
db2bae30SDana Myers            (Operand[3]->Integer.Value > MAX_MATCH_OPERATOR))
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Match operator out of range"));
db2bae30SDana Myers            Status = AE_AML_OPERAND_VALUE;
db2bae30SDana Myers            goto Cleanup;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Get the package StartIndex, validate against the package length */
db2bae30SDana Myers
db2bae30SDana Myers        Index = Operand[5]->Integer.Value;
db2bae30SDana Myers        if (Index >= Operand[0]->Package.Count)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Index (0x%8.8X%8.8X) beyond package end (0x%X)",
db2bae30SDana Myers                ACPI_FORMAT_UINT64 (Index), Operand[0]->Package.Count));
db2bae30SDana Myers            Status = AE_AML_PACKAGE_LIMIT;
db2bae30SDana Myers            goto Cleanup;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Create an integer for the return value */
26f3cdf0SGordon Ross        /* Default return value is ACPI_UINT64_MAX if no match found */
db2bae30SDana Myers
26f3cdf0SGordon Ross        ReturnDesc = AcpiUtCreateIntegerObject (ACPI_UINT64_MAX);
db2bae30SDana Myers        if (!ReturnDesc)
db2bae30SDana Myers        {
db2bae30SDana Myers            Status = AE_NO_MEMORY;
db2bae30SDana Myers            goto Cleanup;
db2bae30SDana Myers
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Examine each element until a match is found. Both match conditions
db2bae30SDana Myers         * must be satisfied for a match to occur. Within the loop,
db2bae30SDana Myers         * "continue" signifies that the current element does not match
db2bae30SDana Myers         * and the next should be examined.
db2bae30SDana Myers         *
db2bae30SDana Myers         * Upon finding a match, the loop will terminate via "break" at
db2bae30SDana Myers         * the bottom. If it terminates "normally", MatchValue will be
26f3cdf0SGordon Ross         * ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
db2bae30SDana Myers         * match was found.
db2bae30SDana Myers         */
db2bae30SDana Myers        for ( ; Index < Operand[0]->Package.Count; Index++)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Get the current package element */
db2bae30SDana Myers
db2bae30SDana Myers            ThisElement = Operand[0]->Package.Elements[Index];
db2bae30SDana Myers
db2bae30SDana Myers            /* Treat any uninitialized (NULL) elements as non-matching */
db2bae30SDana Myers
db2bae30SDana Myers            if (!ThisElement)
db2bae30SDana Myers            {
db2bae30SDana Myers                continue;
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            /*
db2bae30SDana Myers             * Both match conditions must be satisfied. Execution of a continue
db2bae30SDana Myers             * (proceed to next iteration of enclosing for loop) signifies a
db2bae30SDana Myers             * non-match.
db2bae30SDana Myers             */
db2bae30SDana Myers            if (!AcpiExDoMatch ((UINT32) Operand[1]->Integer.Value,
db2bae30SDana Myers                    ThisElement, Operand[2]))
db2bae30SDana Myers            {
db2bae30SDana Myers                continue;
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            if (!AcpiExDoMatch ((UINT32) Operand[3]->Integer.Value,
db2bae30SDana Myers                    ThisElement, Operand[4]))
db2bae30SDana Myers            {
db2bae30SDana Myers                continue;
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            /* Match found: Index is the return value */
db2bae30SDana Myers
db2bae30SDana Myers            ReturnDesc->Integer.Value = Index;
db2bae30SDana Myers            break;
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_LOAD_TABLE_OP:
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiExLoadTableOp (WalkState, &ReturnDesc);
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
db2bae30SDana MyersCleanup:
db2bae30SDana Myers
db2bae30SDana Myers    /* Delete return object on error */
db2bae30SDana Myers
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiUtRemoveReference (ReturnDesc);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Save return object on success */
db2bae30SDana Myers
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        WalkState->ResultObj = ReturnDesc;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}