acpica/executer/exprep.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
*cb565728SJerry Jelinek * Module Name: exprep - ACPI AML field prep utilities
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*cb565728SJerry 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 "amlcode.h"
db2bae30SDana Myers#include "acnamesp.h"
*cb565728SJerry Jelinek#include "acdispat.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_EXECUTER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("exprep")
db2bae30SDana Myers
db2bae30SDana Myers/* Local prototypes */
db2bae30SDana Myers
db2bae30SDana Myersstatic UINT32
db2bae30SDana MyersAcpiExDecodeFieldAccess (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT8                   FieldFlags,
db2bae30SDana Myers    UINT32                  *ReturnByteAlignment);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_UNDER_DEVELOPMENT
db2bae30SDana Myers
db2bae30SDana Myersstatic UINT32
db2bae30SDana MyersAcpiExGenerateAccess (
db2bae30SDana Myers    UINT32                  FieldBitOffset,
db2bae30SDana Myers    UINT32                  FieldBitLength,
db2bae30SDana Myers    UINT32                  RegionLength);
db2bae30SDana Myers
*cb565728SJerry Jelinek
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExGenerateAccess
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  FieldBitOffset      - Start of field within parent region/buffer
db2bae30SDana Myers *              FieldBitLength      - Length of field in bits
db2bae30SDana Myers *              RegionLength        - Length of parent in bytes
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Field granularity (8, 16, 32 or 64) and
db2bae30SDana Myers *              ByteAlignment (1, 2, 3, or 4)
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Generate an optimal access width for fields defined with the
db2bae30SDana Myers *              AnyAcc keyword.
db2bae30SDana Myers *
db2bae30SDana Myers * NOTE: Need to have the RegionLength in order to check for boundary
db2bae30SDana Myers *       conditions (end-of-region). However, the RegionLength is a deferred
db2bae30SDana Myers *       operation. Therefore, to complete this implementation, the generation
db2bae30SDana Myers *       of this access width must be deferred until the region length has
db2bae30SDana Myers *       been evaluated.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic UINT32
db2bae30SDana MyersAcpiExGenerateAccess (
db2bae30SDana Myers    UINT32                  FieldBitOffset,
db2bae30SDana Myers    UINT32                  FieldBitLength,
db2bae30SDana Myers    UINT32                  RegionLength)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  FieldByteLength;
db2bae30SDana Myers    UINT32                  FieldByteOffset;
db2bae30SDana Myers    UINT32                  FieldByteEndOffset;
db2bae30SDana Myers    UINT32                  AccessByteWidth;
db2bae30SDana Myers    UINT32                  FieldStartOffset;
db2bae30SDana Myers    UINT32                  FieldEndOffset;
db2bae30SDana Myers    UINT32                  MinimumAccessWidth = 0xFFFFFFFF;
db2bae30SDana Myers    UINT32                  MinimumAccesses = 0xFFFFFFFF;
db2bae30SDana Myers    UINT32                  Accesses;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExGenerateAccess);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Round Field start offset and length to "minimal" byte boundaries */
db2bae30SDana Myers
*cb565728SJerry Jelinek    FieldByteOffset = ACPI_DIV_8 (
*cb565728SJerry Jelinek        ACPI_ROUND_DOWN (FieldBitOffset, 8));
*cb565728SJerry Jelinek
*cb565728SJerry Jelinek    FieldByteEndOffset = ACPI_DIV_8 (
*cb565728SJerry Jelinek        ACPI_ROUND_UP (FieldBitLength + FieldBitOffset, 8));
*cb565728SJerry Jelinek
db2bae30SDana Myers    FieldByteLength = FieldByteEndOffset - FieldByteOffset;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross        "Bit length %u, Bit offset %u\n",
db2bae30SDana Myers        FieldBitLength, FieldBitOffset));
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross        "Byte Length %u, Byte Offset %u, End Offset %u\n",
db2bae30SDana Myers        FieldByteLength, FieldByteOffset, FieldByteEndOffset));
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Iterative search for the maximum access width that is both aligned
db2bae30SDana Myers     * and does not go beyond the end of the region
db2bae30SDana Myers     *
db2bae30SDana Myers     * Start at ByteAcc and work upwards to QwordAcc max. (1,2,4,8 bytes)
db2bae30SDana Myers     */
db2bae30SDana Myers    for (AccessByteWidth = 1; AccessByteWidth <= 8; AccessByteWidth <<= 1)
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * 1) Round end offset up to next access boundary and make sure that
db2bae30SDana Myers         *    this does not go beyond the end of the parent region.
db2bae30SDana Myers         * 2) When the Access width is greater than the FieldByteLength, we
db2bae30SDana Myers         *    are done. (This does not optimize for the perfectly aligned
db2bae30SDana Myers         *    case yet).
db2bae30SDana Myers         */
*cb565728SJerry Jelinek        if (ACPI_ROUND_UP (FieldByteEndOffset, AccessByteWidth) <=
*cb565728SJerry Jelinek            RegionLength)
db2bae30SDana Myers        {
db2bae30SDana Myers            FieldStartOffset =
db2bae30SDana Myers                ACPI_ROUND_DOWN (FieldByteOffset, AccessByteWidth) /
db2bae30SDana Myers                AccessByteWidth;
db2bae30SDana Myers
db2bae30SDana Myers            FieldEndOffset =
db2bae30SDana Myers                ACPI_ROUND_UP ((FieldByteLength + FieldByteOffset),
db2bae30SDana Myers                    AccessByteWidth) / AccessByteWidth;
db2bae30SDana Myers
db2bae30SDana Myers            Accesses = FieldEndOffset - FieldStartOffset;
db2bae30SDana Myers
db2bae30SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross                "AccessWidth %u end is within region\n", AccessByteWidth));
db2bae30SDana Myers
db2bae30SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross                "Field Start %u, Field End %u -- requires %u accesses\n",
db2bae30SDana Myers                FieldStartOffset, FieldEndOffset, Accesses));
db2bae30SDana Myers
db2bae30SDana Myers            /* Single access is optimal */
db2bae30SDana Myers
db2bae30SDana Myers            if (Accesses <= 1)
db2bae30SDana Myers            {
db2bae30SDana Myers                ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
*cb565728SJerry Jelinek                    "Entire field can be accessed "
*cb565728SJerry Jelinek                    "with one operation of size %u\n",
db2bae30SDana Myers                    AccessByteWidth));
db2bae30SDana Myers                return_VALUE (AccessByteWidth);
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            /*
db2bae30SDana Myers             * Fits in the region, but requires more than one read/write.
db2bae30SDana Myers             * try the next wider access on next iteration
db2bae30SDana Myers             */
db2bae30SDana Myers            if (Accesses < MinimumAccesses)
db2bae30SDana Myers            {
db2bae30SDana Myers                MinimumAccesses = Accesses;
db2bae30SDana Myers                MinimumAccessWidth = AccessByteWidth;
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
*cb565728SJerry Jelinek                "AccessWidth %u end is NOT within region\n",
*cb565728SJerry Jelinek                AccessByteWidth));
db2bae30SDana Myers            if (AccessByteWidth == 1)
db2bae30SDana Myers            {
db2bae30SDana Myers                ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
db2bae30SDana Myers                    "Field goes beyond end-of-region!\n"));
db2bae30SDana Myers
db2bae30SDana Myers                /* Field does not fit in the region at all */
db2bae30SDana Myers
db2bae30SDana Myers                return_VALUE (0);
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            /*
db2bae30SDana Myers             * This width goes beyond the end-of-region, back off to
db2bae30SDana Myers             * previous access
db2bae30SDana Myers             */
db2bae30SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross                "Backing off to previous optimal access width of %u\n",
db2bae30SDana Myers                MinimumAccessWidth));
db2bae30SDana Myers            return_VALUE (MinimumAccessWidth);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Could not read/write field with one operation,
db2bae30SDana Myers     * just use max access width
db2bae30SDana Myers     */
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
db2bae30SDana Myers        "Cannot access field in one operation, using width 8\n"));
*cb565728SJerry Jelinek
db2bae30SDana Myers    return_VALUE (8);
db2bae30SDana Myers}
db2bae30SDana Myers#endif /* ACPI_UNDER_DEVELOPMENT */
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExDecodeFieldAccess
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc             - Field object
db2bae30SDana Myers *              FieldFlags          - Encoded fieldflags (contains access bits)
db2bae30SDana Myers *              ReturnByteAlignment - Where the byte alignment is returned
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Field granularity (8, 16, 32 or 64) and
db2bae30SDana Myers *              ByteAlignment (1, 2, 3, or 4)
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Decode the AccessType bits of a field definition.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic UINT32
db2bae30SDana MyersAcpiExDecodeFieldAccess (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT8                   FieldFlags,
db2bae30SDana Myers    UINT32                  *ReturnByteAlignment)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  Access;
db2bae30SDana Myers    UINT32                  ByteAlignment;
db2bae30SDana Myers    UINT32                  BitLength;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExDecodeFieldAccess);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Access = (FieldFlags & AML_FIELD_ACCESS_TYPE_MASK);
db2bae30SDana Myers
db2bae30SDana Myers    switch (Access)
db2bae30SDana Myers    {
db2bae30SDana Myers    case AML_FIELD_ACCESS_ANY:
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_UNDER_DEVELOPMENT
db2bae30SDana Myers        ByteAlignment =
db2bae30SDana Myers            AcpiExGenerateAccess (ObjDesc->CommonField.StartFieldBitOffset,
db2bae30SDana Myers                ObjDesc->CommonField.BitLength,
db2bae30SDana Myers                0xFFFFFFFF /* Temp until we pass RegionLength as parameter */);
db2bae30SDana Myers        BitLength = ByteAlignment * 8;
db2bae30SDana Myers#endif
db2bae30SDana Myers
db2bae30SDana Myers        ByteAlignment = 1;
db2bae30SDana Myers        BitLength = 8;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_FIELD_ACCESS_BYTE:
db2bae30SDana Myers    case AML_FIELD_ACCESS_BUFFER:   /* ACPI 2.0 (SMBus Buffer) */
*cb565728SJerry Jelinek
db2bae30SDana Myers        ByteAlignment = 1;
db2bae30SDana Myers        BitLength     = 8;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_FIELD_ACCESS_WORD:
*cb565728SJerry Jelinek
db2bae30SDana Myers        ByteAlignment = 2;
db2bae30SDana Myers        BitLength     = 16;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_FIELD_ACCESS_DWORD:
*cb565728SJerry Jelinek
db2bae30SDana Myers        ByteAlignment = 4;
db2bae30SDana Myers        BitLength     = 32;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_FIELD_ACCESS_QWORD:    /* ACPI 2.0 */
*cb565728SJerry Jelinek
db2bae30SDana Myers        ByteAlignment = 8;
db2bae30SDana Myers        BitLength     = 64;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
*cb565728SJerry Jelinek
db2bae30SDana Myers        /* Invalid field access type */
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross            "Unknown field access type 0x%X",
db2bae30SDana Myers            Access));
*cb565728SJerry Jelinek
db2bae30SDana Myers        return_UINT32 (0);
db2bae30SDana Myers    }
db2bae30SDana Myers
aa2aa9a6SDana Myers    if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * BufferField access can be on any byte boundary, so the
db2bae30SDana Myers         * ByteAlignment is always 1 byte -- regardless of any ByteAlignment
db2bae30SDana Myers         * implied by the field access type.
db2bae30SDana Myers         */
db2bae30SDana Myers        ByteAlignment = 1;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    *ReturnByteAlignment = ByteAlignment;
db2bae30SDana Myers    return_UINT32 (BitLength);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExPrepCommonFieldObject
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc             - The field object
db2bae30SDana Myers *              FieldFlags          - Access, LockRule, and UpdateRule.
db2bae30SDana Myers *                                    The format of a FieldFlag is described
db2bae30SDana Myers *                                    in the ACPI specification
db2bae30SDana Myers *              FieldAttribute      - Special attributes (not used)
db2bae30SDana Myers *              FieldBitPosition    - Field start position
db2bae30SDana Myers *              FieldBitLength      - Field length in number of bits
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Initialize the areas of the field object that are common
db2bae30SDana Myers *              to the various types of fields. Note: This is very "sensitive"
db2bae30SDana Myers *              code because we are solving the general case for field
db2bae30SDana Myers *              alignment.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExPrepCommonFieldObject (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT8                   FieldFlags,
db2bae30SDana Myers    UINT8                   FieldAttribute,
db2bae30SDana Myers    UINT32                  FieldBitPosition,
db2bae30SDana Myers    UINT32                  FieldBitLength)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  AccessBitWidth;
db2bae30SDana Myers    UINT32                  ByteAlignment;
db2bae30SDana Myers    UINT32                  NearestByteAddress;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExPrepCommonFieldObject);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Note: the structure being initialized is the
db2bae30SDana Myers     * ACPI_COMMON_FIELD_INFO;  No structure fields outside of the common
db2bae30SDana Myers     * area are initialized by this procedure.
db2bae30SDana Myers     */
db2bae30SDana Myers    ObjDesc->CommonField.FieldFlags = FieldFlags;
db2bae30SDana Myers    ObjDesc->CommonField.Attribute  = FieldAttribute;
db2bae30SDana Myers    ObjDesc->CommonField.BitLength  = FieldBitLength;
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Decode the access type so we can compute offsets. The access type gives
db2bae30SDana Myers     * two pieces of information - the width of each field access and the
db2bae30SDana Myers     * necessary ByteAlignment (address granularity) of the access.
db2bae30SDana Myers     *
db2bae30SDana Myers     * For AnyAcc, the AccessBitWidth is the largest width that is both
db2bae30SDana Myers     * necessary and possible in an attempt to access the whole field in one
db2bae30SDana Myers     * I/O operation. However, for AnyAcc, the ByteAlignment is always one
db2bae30SDana Myers     * byte.
db2bae30SDana Myers     *
db2bae30SDana Myers     * For all Buffer Fields, the ByteAlignment is always one byte.
db2bae30SDana Myers     *
db2bae30SDana Myers     * For all other access types (Byte, Word, Dword, Qword), the Bitwidth is
db2bae30SDana Myers     * the same (equivalent) as the ByteAlignment.
db2bae30SDana Myers     */
*cb565728SJerry Jelinek    AccessBitWidth = AcpiExDecodeFieldAccess (
*cb565728SJerry Jelinek        ObjDesc, FieldFlags, &ByteAlignment);
db2bae30SDana Myers    if (!AccessBitWidth)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
db2bae30SDana Myers    }
db2bae30SDana Myers
26f3cdf0SGordon Ross    /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */
db2bae30SDana Myers
db2bae30SDana Myers    ObjDesc->CommonField.AccessByteWidth = (UINT8)
26f3cdf0SGordon Ross        ACPI_DIV_8 (AccessBitWidth);
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * BaseByteOffset is the address of the start of the field within the
db2bae30SDana Myers     * region. It is the byte address of the first *datum* (field-width data
db2bae30SDana Myers     * unit) of the field. (i.e., the first datum that contains at least the
db2bae30SDana Myers     * first *bit* of the field.)
db2bae30SDana Myers     *
db2bae30SDana Myers     * Note: ByteAlignment is always either equal to the AccessBitWidth or 8
db2bae30SDana Myers     * (Byte access), and it defines the addressing granularity of the parent
db2bae30SDana Myers     * region or buffer.
db2bae30SDana Myers     */
db2bae30SDana Myers    NearestByteAddress =
db2bae30SDana Myers        ACPI_ROUND_BITS_DOWN_TO_BYTES (FieldBitPosition);
db2bae30SDana Myers    ObjDesc->CommonField.BaseByteOffset = (UINT32)
db2bae30SDana Myers        ACPI_ROUND_DOWN (NearestByteAddress, ByteAlignment);
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * StartFieldBitOffset is the offset of the first bit of the field within
db2bae30SDana Myers     * a field datum.
db2bae30SDana Myers     */
db2bae30SDana Myers    ObjDesc->CommonField.StartFieldBitOffset = (UINT8)
db2bae30SDana Myers        (FieldBitPosition - ACPI_MUL_8 (ObjDesc->CommonField.BaseByteOffset));
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExPrepFieldValue
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Info    - Contains all field creation info
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
*cb565728SJerry Jelinek * DESCRIPTION: Construct an object of type ACPI_OPERAND_OBJECT with a
*cb565728SJerry Jelinek *              subtype of DefField and connect it to the parent Node.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExPrepFieldValue (
db2bae30SDana Myers    ACPI_CREATE_FIELD_INFO  *Info)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *SecondDesc = NULL;
db2bae30SDana Myers    ACPI_STATUS             Status;
26f3cdf0SGordon Ross    UINT32                  AccessByteWidth;
26f3cdf0SGordon Ross    UINT32                  Type;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExPrepFieldValue);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Parameter validation */
db2bae30SDana Myers
db2bae30SDana Myers    if (Info->FieldType != ACPI_TYPE_LOCAL_INDEX_FIELD)
db2bae30SDana Myers    {
db2bae30SDana Myers        if (!Info->RegionNode)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Null RegionNode"));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_NO_OPERAND);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Type = AcpiNsGetType (Info->RegionNode);
db2bae30SDana Myers        if (Type != ACPI_TYPE_REGION)
db2bae30SDana Myers        {
26f3cdf0SGordon Ross            ACPI_ERROR ((AE_INFO, "Needed Region, found type 0x%X (%s)",
db2bae30SDana Myers                Type, AcpiUtGetTypeName (Type)));
db2bae30SDana Myers
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Allocate a new field object */
db2bae30SDana Myers
db2bae30SDana Myers    ObjDesc = AcpiUtCreateInternalObject (Info->FieldType);
db2bae30SDana Myers    if (!ObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Initialize areas of the object that are common to all fields */
db2bae30SDana Myers
db2bae30SDana Myers    ObjDesc->CommonField.Node = Info->FieldNode;
26f3cdf0SGordon Ross    Status = AcpiExPrepCommonFieldObject (ObjDesc,
26f3cdf0SGordon Ross        Info->FieldFlags, Info->Attribute,
26f3cdf0SGordon Ross        Info->FieldBitPosition, Info->FieldBitLength);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiUtDeleteObjectDesc (ObjDesc);
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Initialize areas of the object that are specific to the field type */
db2bae30SDana Myers
db2bae30SDana Myers    switch (Info->FieldType)
db2bae30SDana Myers    {
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_REGION_FIELD:
db2bae30SDana Myers
db2bae30SDana Myers        ObjDesc->Field.RegionObj = AcpiNsGetAttachedObject (Info->RegionNode);
db2bae30SDana Myers
*cb565728SJerry Jelinek        /* Fields specific to GenericSerialBus fields */
*cb565728SJerry Jelinek
*cb565728SJerry Jelinek        ObjDesc->Field.AccessLength = Info->AccessLength;
*cb565728SJerry Jelinek
*cb565728SJerry Jelinek        if (Info->ConnectionNode)
*cb565728SJerry Jelinek        {
*cb565728SJerry Jelinek            SecondDesc = Info->ConnectionNode->Object;
*cb565728SJerry Jelinek            if (!(SecondDesc->Common.Flags & AOPOBJ_DATA_VALID))
*cb565728SJerry Jelinek            {
*cb565728SJerry Jelinek                Status = AcpiDsGetBufferArguments (SecondDesc);
*cb565728SJerry Jelinek                if (ACPI_FAILURE (Status))
*cb565728SJerry Jelinek                {
*cb565728SJerry Jelinek                    AcpiUtDeleteObjectDesc (ObjDesc);
*cb565728SJerry Jelinek                    return_ACPI_STATUS (Status);
*cb565728SJerry Jelinek                }
*cb565728SJerry Jelinek            }
*cb565728SJerry Jelinek
*cb565728SJerry Jelinek            ObjDesc->Field.ResourceBuffer =
*cb565728SJerry Jelinek                SecondDesc->Buffer.Pointer;
*cb565728SJerry Jelinek            ObjDesc->Field.ResourceLength =
*cb565728SJerry Jelinek                (UINT16) SecondDesc->Buffer.Length;
*cb565728SJerry Jelinek        }
*cb565728SJerry Jelinek        else if (Info->ResourceBuffer)
*cb565728SJerry Jelinek        {
*cb565728SJerry Jelinek            ObjDesc->Field.ResourceBuffer = Info->ResourceBuffer;
*cb565728SJerry Jelinek            ObjDesc->Field.ResourceLength = Info->ResourceLength;
*cb565728SJerry Jelinek        }
*cb565728SJerry Jelinek
*cb565728SJerry Jelinek        ObjDesc->Field.PinNumberIndex = Info->PinNumberIndex;
*cb565728SJerry Jelinek
26f3cdf0SGordon Ross        /* Allow full data read from EC address space */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross        if ((ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_EC) &&
26f3cdf0SGordon Ross            (ObjDesc->CommonField.BitLength > 8))
26f3cdf0SGordon Ross        {
26f3cdf0SGordon Ross            AccessByteWidth = ACPI_ROUND_BITS_UP_TO_BYTES (
26f3cdf0SGordon Ross                ObjDesc->CommonField.BitLength);
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross            /* Maximum byte width supported is 255 */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross            if (AccessByteWidth < 256)
26f3cdf0SGordon Ross            {
*cb565728SJerry Jelinek                ObjDesc->CommonField.AccessByteWidth =
*cb565728SJerry Jelinek                    (UINT8) AccessByteWidth;
26f3cdf0SGordon Ross            }
26f3cdf0SGordon Ross        }
26f3cdf0SGordon Ross
db2bae30SDana Myers        /* An additional reference for the container */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc->Field.RegionObj);
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
db2bae30SDana Myers            "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n",
*cb565728SJerry Jelinek            ObjDesc->Field.StartFieldBitOffset,
*cb565728SJerry Jelinek            ObjDesc->Field.BaseByteOffset,
*cb565728SJerry Jelinek            ObjDesc->Field.AccessByteWidth,
*cb565728SJerry Jelinek            ObjDesc->Field.RegionObj));
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_BANK_FIELD:
db2bae30SDana Myers
db2bae30SDana Myers        ObjDesc->BankField.Value = Info->BankValue;
26f3cdf0SGordon Ross        ObjDesc->BankField.RegionObj =
26f3cdf0SGordon Ross            AcpiNsGetAttachedObject (Info->RegionNode);
26f3cdf0SGordon Ross        ObjDesc->BankField.BankObj =
26f3cdf0SGordon Ross            AcpiNsGetAttachedObject (Info->RegisterNode);
db2bae30SDana Myers
db2bae30SDana Myers        /* An additional reference for the attached objects */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc->BankField.RegionObj);
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc->BankField.BankObj);
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
db2bae30SDana Myers            "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n",
db2bae30SDana Myers            ObjDesc->BankField.StartFieldBitOffset,
db2bae30SDana Myers            ObjDesc->BankField.BaseByteOffset,
db2bae30SDana Myers            ObjDesc->Field.AccessByteWidth,
db2bae30SDana Myers            ObjDesc->BankField.RegionObj,
db2bae30SDana Myers            ObjDesc->BankField.BankObj));
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Remember location in AML stream of the field unit
db2bae30SDana Myers         * opcode and operands -- since the BankValue
db2bae30SDana Myers         * operands must be evaluated.
db2bae30SDana Myers         */
db2bae30SDana Myers        SecondDesc = ObjDesc->Common.NextObject;
26f3cdf0SGordon Ross        SecondDesc->Extra.AmlStart = ACPI_CAST_PTR (ACPI_PARSE_OBJECT,
26f3cdf0SGordon Ross            Info->DataRegisterNode)->Named.Data;
26f3cdf0SGordon Ross        SecondDesc->Extra.AmlLength = ACPI_CAST_PTR (ACPI_PARSE_OBJECT,
26f3cdf0SGordon Ross            Info->DataRegisterNode)->Named.Length;
db2bae30SDana Myers
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_INDEX_FIELD:
db2bae30SDana Myers
db2bae30SDana Myers        /* Get the Index and Data registers */
db2bae30SDana Myers
26f3cdf0SGordon Ross        ObjDesc->IndexField.IndexObj =
26f3cdf0SGordon Ross            AcpiNsGetAttachedObject (Info->RegisterNode);
26f3cdf0SGordon Ross        ObjDesc->IndexField.DataObj =
26f3cdf0SGordon Ross            AcpiNsGetAttachedObject (Info->DataRegisterNode);
db2bae30SDana Myers
db2bae30SDana Myers        if (!ObjDesc->IndexField.DataObj || !ObjDesc->IndexField.IndexObj)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Null Index Object during field prep"));
db2bae30SDana Myers            AcpiUtDeleteObjectDesc (ObjDesc);
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_INTERNAL);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* An additional reference for the attached objects */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc->IndexField.DataObj);
db2bae30SDana Myers        AcpiUtAddReference (ObjDesc->IndexField.IndexObj);
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * April 2006: Changed to match MS behavior
db2bae30SDana Myers         *
db2bae30SDana Myers         * The value written to the Index register is the byte offset of the
db2bae30SDana Myers         * target field in units of the granularity of the IndexField
db2bae30SDana Myers         *
db2bae30SDana Myers         * Previously, the value was calculated as an index in terms of the
db2bae30SDana Myers         * width of the Data register, as below:
db2bae30SDana Myers         *
db2bae30SDana Myers         *      ObjDesc->IndexField.Value = (UINT32)
db2bae30SDana Myers         *          (Info->FieldBitPosition / ACPI_MUL_8 (
db2bae30SDana Myers         *              ObjDesc->Field.AccessByteWidth));
db2bae30SDana Myers         *
db2bae30SDana Myers         * February 2006: Tried value as a byte offset:
db2bae30SDana Myers         *      ObjDesc->IndexField.Value = (UINT32)
db2bae30SDana Myers         *          ACPI_DIV_8 (Info->FieldBitPosition);
db2bae30SDana Myers         */
db2bae30SDana Myers        ObjDesc->IndexField.Value = (UINT32) ACPI_ROUND_DOWN (
db2bae30SDana Myers            ACPI_DIV_8 (Info->FieldBitPosition),
db2bae30SDana Myers            ObjDesc->IndexField.AccessByteWidth);
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
*cb565728SJerry Jelinek            "IndexField: BitOff %X, Off %X, Value %X, "
*cb565728SJerry Jelinek            "Gran %X, Index %p, Data %p\n",
db2bae30SDana Myers            ObjDesc->IndexField.StartFieldBitOffset,
db2bae30SDana Myers            ObjDesc->IndexField.BaseByteOffset,
db2bae30SDana Myers            ObjDesc->IndexField.Value,
db2bae30SDana Myers            ObjDesc->Field.AccessByteWidth,
db2bae30SDana Myers            ObjDesc->IndexField.IndexObj,
db2bae30SDana Myers            ObjDesc->IndexField.DataObj));
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
*cb565728SJerry Jelinek
db2bae30SDana Myers        /* No other types should get here */
*cb565728SJerry Jelinek
db2bae30SDana Myers        break;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Store the constructed descriptor (ObjDesc) into the parent Node,
db2bae30SDana Myers     * preserving the current type of that NamedObj.
db2bae30SDana Myers     */
*cb565728SJerry Jelinek    Status = AcpiNsAttachObject (
*cb565728SJerry Jelinek        Info->FieldNode, ObjDesc, AcpiNsGetType (Info->FieldNode));
db2bae30SDana Myers
*cb565728SJerry Jelinek    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
*cb565728SJerry Jelinek        "Set NamedObj %p [%4.4s], ObjDesc %p\n",
db2bae30SDana Myers        Info->FieldNode, AcpiUtGetNodeName (Info->FieldNode), ObjDesc));
db2bae30SDana Myers
db2bae30SDana Myers    /* Remove local reference to the object */
db2bae30SDana Myers
db2bae30SDana Myers    AcpiUtRemoveReference (ObjDesc);
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}