acpica/executer/exfldio.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: exfldio - Aml Field I/O
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*de5d74c2SJerry 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 "acevents.h"
db2bae30SDana Myers#include "acdispat.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_EXECUTER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("exfldio")
db2bae30SDana Myers
db2bae30SDana Myers/* Local prototypes */
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiExFieldDatumIo (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT32                  FieldDatumByteOffset,
26f3cdf0SGordon Ross    UINT64                  *Value,
db2bae30SDana Myers    UINT32                  ReadWrite);
db2bae30SDana Myers
db2bae30SDana Myersstatic BOOLEAN
db2bae30SDana MyersAcpiExRegisterOverflow (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
26f3cdf0SGordon Ross    UINT64                  Value);
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiExSetupRegion (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT32                  FieldDatumByteOffset);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSetupRegion
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc                 - Field to be read or written
db2bae30SDana Myers *              FieldDatumByteOffset    - Byte offset of this datum within the
db2bae30SDana Myers *                                        parent field
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Common processing for AcpiExExtractFromField and
db2bae30SDana Myers *              AcpiExInsertIntoField. Initialize the Region if necessary and
db2bae30SDana Myers *              validate the request.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiExSetupRegion (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT32                  FieldDatumByteOffset)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *RgnDesc;
*de5d74c2SJerry Jelinek    UINT8                   SpaceId;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_U32 (ExSetupRegion, FieldDatumByteOffset);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    RgnDesc = ObjDesc->CommonField.RegionObj;
db2bae30SDana Myers
db2bae30SDana Myers    /* We must have a valid region */
db2bae30SDana Myers
aa2aa9a6SDana Myers    if (RgnDesc->Common.Type != ACPI_TYPE_REGION)
db2bae30SDana Myers    {
26f3cdf0SGordon Ross        ACPI_ERROR ((AE_INFO, "Needed Region, found type 0x%X (%s)",
aa2aa9a6SDana Myers            RgnDesc->Common.Type,
db2bae30SDana Myers            AcpiUtGetObjectTypeName (RgnDesc)));
db2bae30SDana Myers
db2bae30SDana Myers        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
db2bae30SDana Myers    }
db2bae30SDana Myers
*de5d74c2SJerry Jelinek    SpaceId = RgnDesc->Region.SpaceId;
*de5d74c2SJerry Jelinek
*de5d74c2SJerry Jelinek    /* Validate the Space ID */
*de5d74c2SJerry Jelinek
*de5d74c2SJerry Jelinek    if (!AcpiIsValidSpaceId (SpaceId))
*de5d74c2SJerry Jelinek    {
*de5d74c2SJerry Jelinek        ACPI_ERROR ((AE_INFO,
*de5d74c2SJerry Jelinek            "Invalid/unknown Address Space ID: 0x%2.2X", SpaceId));
*de5d74c2SJerry Jelinek        return_ACPI_STATUS (AE_AML_INVALID_SPACE_ID);
*de5d74c2SJerry Jelinek    }
*de5d74c2SJerry Jelinek
db2bae30SDana Myers    /*
db2bae30SDana Myers     * If the Region Address and Length have not been previously evaluated,
db2bae30SDana Myers     * evaluate them now and save the results.
db2bae30SDana Myers     */
db2bae30SDana Myers    if (!(RgnDesc->Common.Flags & AOPOBJ_DATA_VALID))
db2bae30SDana Myers    {
db2bae30SDana Myers        Status = AcpiDsGetRegionArguments (RgnDesc);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
*de5d74c2SJerry Jelinek     * Exit now for SMBus, GSBus or IPMI address space, it has a non-linear
26f3cdf0SGordon Ross     * address space and the request cannot be directly validated
db2bae30SDana Myers     */
*de5d74c2SJerry Jelinek    if (SpaceId == ACPI_ADR_SPACE_SMBUS ||
*de5d74c2SJerry Jelinek        SpaceId == ACPI_ADR_SPACE_GSBUS ||
*de5d74c2SJerry Jelinek        SpaceId == ACPI_ADR_SPACE_IPMI)
db2bae30SDana Myers    {
57190917SDana Myers        /* SMBus or IPMI has a non-linear address space */
db2bae30SDana Myers
db2bae30SDana Myers        return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_UNDER_DEVELOPMENT
db2bae30SDana Myers    /*
db2bae30SDana Myers     * If the Field access is AnyAcc, we can now compute the optimal
db2bae30SDana Myers     * access (because we know know the length of the parent region)
db2bae30SDana Myers     */
db2bae30SDana Myers    if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
db2bae30SDana Myers    {
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers#endif
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Validate the request. The entire request from the byte offset for a
db2bae30SDana Myers     * length of one field datum (access width) must fit within the region.
db2bae30SDana Myers     * (Region length is specified in bytes)
db2bae30SDana Myers     */
db2bae30SDana Myers    if (RgnDesc->Region.Length <
26f3cdf0SGordon Ross        (ObjDesc->CommonField.BaseByteOffset + FieldDatumByteOffset +
db2bae30SDana Myers        ObjDesc->CommonField.AccessByteWidth))
db2bae30SDana Myers    {
db2bae30SDana Myers        if (AcpiGbl_EnableInterpreterSlack)
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * Slack mode only:  We will go ahead and allow access to this
db2bae30SDana Myers             * field if it is within the region length rounded up to the next
db2bae30SDana Myers             * access width boundary. ACPI_SIZE cast for 64-bit compile.
db2bae30SDana Myers             */
db2bae30SDana Myers            if (ACPI_ROUND_UP (RgnDesc->Region.Length,
db2bae30SDana Myers                    ObjDesc->CommonField.AccessByteWidth) >=
db2bae30SDana Myers                ((ACPI_SIZE) ObjDesc->CommonField.BaseByteOffset +
db2bae30SDana Myers                    ObjDesc->CommonField.AccessByteWidth +
db2bae30SDana Myers                    FieldDatumByteOffset))
db2bae30SDana Myers            {
db2bae30SDana Myers                return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (RgnDesc->Region.Length < ObjDesc->CommonField.AccessByteWidth)
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * This is the case where the AccessType (AccWord, etc.) is wider
db2bae30SDana Myers             * than the region itself. For example, a region of length one
db2bae30SDana Myers             * byte, and a field with Dword access specified.
db2bae30SDana Myers             */
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
*de5d74c2SJerry Jelinek                "Field [%4.4s] access width (%u bytes) "
*de5d74c2SJerry Jelinek                "too large for region [%4.4s] (length %u)",
db2bae30SDana Myers                AcpiUtGetNodeName (ObjDesc->CommonField.Node),
db2bae30SDana Myers                ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers                AcpiUtGetNodeName (RgnDesc->Region.Node),
db2bae30SDana Myers                RgnDesc->Region.Length));
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Offset rounded up to next multiple of field width
db2bae30SDana Myers         * exceeds region length, indicate an error
db2bae30SDana Myers         */
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
*de5d74c2SJerry Jelinek            "Field [%4.4s] Base+Offset+Width %u+%u+%u "
*de5d74c2SJerry Jelinek            "is beyond end of region [%4.4s] (length %u)",
db2bae30SDana Myers            AcpiUtGetNodeName (ObjDesc->CommonField.Node),
db2bae30SDana Myers            ObjDesc->CommonField.BaseByteOffset,
db2bae30SDana Myers            FieldDatumByteOffset, ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers            AcpiUtGetNodeName (RgnDesc->Region.Node),
db2bae30SDana Myers            RgnDesc->Region.Length));
db2bae30SDana Myers
db2bae30SDana Myers        return_ACPI_STATUS (AE_AML_REGION_LIMIT);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExAccessRegion
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc                 - Field to be read
db2bae30SDana Myers *              FieldDatumByteOffset    - Byte offset of this datum within the
db2bae30SDana Myers *                                        parent field
db2bae30SDana Myers *              Value                   - Where to store value (must at least
26f3cdf0SGordon Ross *                                        64 bits)
db2bae30SDana Myers *              Function                - Read or Write flag plus other region-
db2bae30SDana Myers *                                        dependent flags
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Read or Write a single field datum to an Operation Region.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExAccessRegion (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT32                  FieldDatumByteOffset,
26f3cdf0SGordon Ross    UINT64                  *Value,
db2bae30SDana Myers    UINT32                  Function)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *RgnDesc;
aa2aa9a6SDana Myers    UINT32                  RegionOffset;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExAccessRegion);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Ensure that the region operands are fully evaluated and verify
db2bae30SDana Myers     * the validity of the request
db2bae30SDana Myers     */
db2bae30SDana Myers    Status = AcpiExSetupRegion (ObjDesc, FieldDatumByteOffset);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * The physical address of this field datum is:
db2bae30SDana Myers     *
db2bae30SDana Myers     * 1) The base of the region, plus
db2bae30SDana Myers     * 2) The base offset of the field, plus
db2bae30SDana Myers     * 3) The current offset into the field
db2bae30SDana Myers     */
db2bae30SDana Myers    RgnDesc = ObjDesc->CommonField.RegionObj;
aa2aa9a6SDana Myers    RegionOffset =
db2bae30SDana Myers        ObjDesc->CommonField.BaseByteOffset +
db2bae30SDana Myers        FieldDatumByteOffset;
db2bae30SDana Myers
db2bae30SDana Myers    if ((Function & ACPI_IO_MASK) == ACPI_READ)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "[READ]"));
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "[WRITE]"));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT_RAW ((ACPI_DB_BFIELD,
*de5d74c2SJerry Jelinek        " Region [%s:%X], Width %X, ByteBase %X, Offset %X at %8.8X%8.8X\n",
db2bae30SDana Myers        AcpiUtGetRegionName (RgnDesc->Region.SpaceId),
db2bae30SDana Myers        RgnDesc->Region.SpaceId,
db2bae30SDana Myers        ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers        ObjDesc->CommonField.BaseByteOffset,
db2bae30SDana Myers        FieldDatumByteOffset,
*de5d74c2SJerry Jelinek        ACPI_FORMAT_UINT64 (RgnDesc->Region.Address + RegionOffset)));
db2bae30SDana Myers
db2bae30SDana Myers    /* Invoke the appropriate AddressSpace/OpRegion handler */
db2bae30SDana Myers
*de5d74c2SJerry Jelinek    Status = AcpiEvAddressSpaceDispatch (RgnDesc, ObjDesc,
*de5d74c2SJerry Jelinek        Function, RegionOffset,
db2bae30SDana Myers        ACPI_MUL_8 (ObjDesc->CommonField.AccessByteWidth), Value);
db2bae30SDana Myers
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        if (Status == AE_NOT_IMPLEMENTED)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Region %s (ID=%u) not implemented",
db2bae30SDana Myers                AcpiUtGetRegionName (RgnDesc->Region.SpaceId),
db2bae30SDana Myers                RgnDesc->Region.SpaceId));
db2bae30SDana Myers        }
db2bae30SDana Myers        else if (Status == AE_NOT_EXIST)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Region %s (ID=%u) has no handler",
db2bae30SDana Myers                AcpiUtGetRegionName (RgnDesc->Region.SpaceId),
db2bae30SDana Myers                RgnDesc->Region.SpaceId));
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExRegisterOverflow
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc                 - Register(Field) to be written
db2bae30SDana Myers *              Value                   - Value to be stored
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      TRUE if value overflows the field, FALSE otherwise
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Check if a value is out of range of the field being written.
db2bae30SDana Myers *              Used to check if the values written to Index and Bank registers
db2bae30SDana Myers *              are out of range. Normally, the value is simply truncated
db2bae30SDana Myers *              to fit the field, but this case is most likely a serious
db2bae30SDana Myers *              coding error in the ASL.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic BOOLEAN
db2bae30SDana MyersAcpiExRegisterOverflow (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
26f3cdf0SGordon Ross    UINT64                  Value)
db2bae30SDana Myers{
db2bae30SDana Myers
db2bae30SDana Myers    if (ObjDesc->CommonField.BitLength >= ACPI_INTEGER_BIT_SIZE)
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * The field is large enough to hold the maximum integer, so we can
db2bae30SDana Myers         * never overflow it.
db2bae30SDana Myers         */
db2bae30SDana Myers        return (FALSE);
db2bae30SDana Myers    }
db2bae30SDana Myers
26f3cdf0SGordon Ross    if (Value >= ((UINT64) 1 << ObjDesc->CommonField.BitLength))
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * The Value is larger than the maximum value that can fit into
db2bae30SDana Myers         * the register.
db2bae30SDana Myers         */
*de5d74c2SJerry Jelinek        ACPI_ERROR ((AE_INFO,
*de5d74c2SJerry Jelinek            "Index value 0x%8.8X%8.8X overflows field width 0x%X",
*de5d74c2SJerry Jelinek            ACPI_FORMAT_UINT64 (Value),
*de5d74c2SJerry Jelinek            ObjDesc->CommonField.BitLength));
*de5d74c2SJerry Jelinek
db2bae30SDana Myers        return (TRUE);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* The Value will fit into the field with no truncation */
db2bae30SDana Myers
db2bae30SDana Myers    return (FALSE);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExFieldDatumIo
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc                 - Field to be read
db2bae30SDana Myers *              FieldDatumByteOffset    - Byte offset of this datum within the
db2bae30SDana Myers *                                        parent field
db2bae30SDana Myers *              Value                   - Where to store value (must be 64 bits)
db2bae30SDana Myers *              ReadWrite               - Read or Write flag
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Read or Write a single datum of a field. The FieldType is
db2bae30SDana Myers *              demultiplexed here to handle the different types of fields
db2bae30SDana Myers *              (BufferField, RegionField, IndexField, BankField)
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiExFieldDatumIo (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    UINT32                  FieldDatumByteOffset,
26f3cdf0SGordon Ross    UINT64                  *Value,
db2bae30SDana Myers    UINT32                  ReadWrite)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
26f3cdf0SGordon Ross    UINT64                  LocalValue;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_U32 (ExFieldDatumIo, FieldDatumByteOffset);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (ReadWrite == ACPI_READ)
db2bae30SDana Myers    {
db2bae30SDana Myers        if (!Value)
db2bae30SDana Myers        {
db2bae30SDana Myers            LocalValue = 0;
db2bae30SDana Myers
db2bae30SDana Myers            /* To support reads without saving return value */
db2bae30SDana Myers            Value = &LocalValue;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Clear the entire return buffer first, [Very Important!] */
db2bae30SDana Myers
db2bae30SDana Myers        *Value = 0;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * The four types of fields are:
db2bae30SDana Myers     *
db2bae30SDana Myers     * BufferField - Read/write from/to a Buffer
db2bae30SDana Myers     * RegionField - Read/write from/to a Operation Region.
db2bae30SDana Myers     * BankField   - Write to a Bank Register, then read/write from/to an
db2bae30SDana Myers     *               OperationRegion
db2bae30SDana Myers     * IndexField  - Write to an Index Register, then read/write from/to a
db2bae30SDana Myers     *               Data Register
db2bae30SDana Myers     */
aa2aa9a6SDana Myers    switch (ObjDesc->Common.Type)
db2bae30SDana Myers    {
db2bae30SDana Myers    case ACPI_TYPE_BUFFER_FIELD:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * If the BufferField arguments have not been previously evaluated,
db2bae30SDana Myers         * evaluate them now and save the results.
db2bae30SDana Myers         */
db2bae30SDana Myers        if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
db2bae30SDana Myers        {
db2bae30SDana Myers            Status = AcpiDsGetBufferFieldArguments (ObjDesc);
db2bae30SDana Myers            if (ACPI_FAILURE (Status))
db2bae30SDana Myers            {
db2bae30SDana Myers                return_ACPI_STATUS (Status);
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (ReadWrite == ACPI_READ)
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * Copy the data from the source buffer.
db2bae30SDana Myers             * Length is the field width in bytes.
db2bae30SDana Myers             */
*de5d74c2SJerry Jelinek            memcpy (Value,
db2bae30SDana Myers                (ObjDesc->BufferField.BufferObj)->Buffer.Pointer +
db2bae30SDana Myers                    ObjDesc->BufferField.BaseByteOffset +
db2bae30SDana Myers                    FieldDatumByteOffset,
db2bae30SDana Myers                ObjDesc->CommonField.AccessByteWidth);
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * Copy the data to the target buffer.
db2bae30SDana Myers             * Length is the field width in bytes.
db2bae30SDana Myers             */
*de5d74c2SJerry Jelinek            memcpy ((ObjDesc->BufferField.BufferObj)->Buffer.Pointer +
db2bae30SDana Myers                ObjDesc->BufferField.BaseByteOffset +
db2bae30SDana Myers                FieldDatumByteOffset,
db2bae30SDana Myers                Value, ObjDesc->CommonField.AccessByteWidth);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Status = AE_OK;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_BANK_FIELD:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Ensure that the BankValue is not beyond the capacity of
db2bae30SDana Myers         * the register
db2bae30SDana Myers         */
db2bae30SDana Myers        if (AcpiExRegisterOverflow (ObjDesc->BankField.BankObj,
26f3cdf0SGordon Ross                (UINT64) ObjDesc->BankField.Value))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_REGISTER_LIMIT);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * For BankFields, we must write the BankValue to the BankRegister
db2bae30SDana Myers         * (itself a RegionField) before we can access the data.
db2bae30SDana Myers         */
db2bae30SDana Myers        Status = AcpiExInsertIntoField (ObjDesc->BankField.BankObj,
db2bae30SDana Myers                    &ObjDesc->BankField.Value,
db2bae30SDana Myers                    sizeof (ObjDesc->BankField.Value));
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Now that the Bank has been selected, fall through to the
db2bae30SDana Myers         * RegionField case and write the datum to the Operation Region
db2bae30SDana Myers         */
db2bae30SDana Myers
db2bae30SDana Myers        /*lint -fallthrough */
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_REGION_FIELD:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * For simple RegionFields, we just directly access the owning
db2bae30SDana Myers         * Operation Region.
db2bae30SDana Myers         */
*de5d74c2SJerry Jelinek        Status = AcpiExAccessRegion (
*de5d74c2SJerry Jelinek            ObjDesc, FieldDatumByteOffset, Value, ReadWrite);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case ACPI_TYPE_LOCAL_INDEX_FIELD:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Ensure that the IndexValue is not beyond the capacity of
db2bae30SDana Myers         * the register
db2bae30SDana Myers         */
db2bae30SDana Myers        if (AcpiExRegisterOverflow (ObjDesc->IndexField.IndexObj,
26f3cdf0SGordon Ross                (UINT64) ObjDesc->IndexField.Value))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_REGISTER_LIMIT);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Write the index value to the IndexRegister (itself a RegionField) */
db2bae30SDana Myers
db2bae30SDana Myers        FieldDatumByteOffset += ObjDesc->IndexField.Value;
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
db2bae30SDana Myers            "Write to Index Register: Value %8.8X\n",
db2bae30SDana Myers            FieldDatumByteOffset));
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiExInsertIntoField (ObjDesc->IndexField.IndexObj,
*de5d74c2SJerry Jelinek            &FieldDatumByteOffset, sizeof (FieldDatumByteOffset));
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (ReadWrite == ACPI_READ)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Read the datum from the DataRegister */
db2bae30SDana Myers
aa2aa9a6SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
aa2aa9a6SDana Myers                "Read from Data Register\n"));
aa2aa9a6SDana Myers
*de5d74c2SJerry Jelinek            Status = AcpiExExtractFromField (
*de5d74c2SJerry Jelinek                ObjDesc->IndexField.DataObj, Value, sizeof (UINT64));
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Write the datum to the DataRegister */
db2bae30SDana Myers
aa2aa9a6SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
aa2aa9a6SDana Myers                "Write to Data Register: Value %8.8X%8.8X\n",
aa2aa9a6SDana Myers                ACPI_FORMAT_UINT64 (*Value)));
aa2aa9a6SDana Myers
*de5d74c2SJerry Jelinek            Status = AcpiExInsertIntoField (
*de5d74c2SJerry Jelinek                ObjDesc->IndexField.DataObj, Value, sizeof (UINT64));
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
db2bae30SDana Myers
26f3cdf0SGordon Ross        ACPI_ERROR ((AE_INFO, "Wrong object type in field I/O %u",
aa2aa9a6SDana Myers            ObjDesc->Common.Type));
db2bae30SDana Myers        Status = AE_AML_INTERNAL;
db2bae30SDana Myers        break;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (ACPI_SUCCESS (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        if (ReadWrite == ACPI_READ)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross                "Value Read %8.8X%8.8X, Width %u\n",
db2bae30SDana Myers                ACPI_FORMAT_UINT64 (*Value),
db2bae30SDana Myers                ObjDesc->CommonField.AccessByteWidth));
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
26f3cdf0SGordon Ross                "Value Written %8.8X%8.8X, Width %u\n",
db2bae30SDana Myers                ACPI_FORMAT_UINT64 (*Value),
db2bae30SDana Myers                ObjDesc->CommonField.AccessByteWidth));
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExWriteWithUpdateRule
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc                 - Field to be written
db2bae30SDana Myers *              Mask                    - bitmask within field datum
db2bae30SDana Myers *              FieldValue              - Value to write
db2bae30SDana Myers *              FieldDatumByteOffset    - Offset of datum within field
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Apply the field update rule to a field write
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExWriteWithUpdateRule (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
26f3cdf0SGordon Ross    UINT64                  Mask,
26f3cdf0SGordon Ross    UINT64                  FieldValue,
db2bae30SDana Myers    UINT32                  FieldDatumByteOffset)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
26f3cdf0SGordon Ross    UINT64                  MergedValue;
26f3cdf0SGordon Ross    UINT64                  CurrentValue;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_U32 (ExWriteWithUpdateRule, Mask);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Start with the new bits  */
db2bae30SDana Myers
db2bae30SDana Myers    MergedValue = FieldValue;
db2bae30SDana Myers
db2bae30SDana Myers    /* If the mask is all ones, we don't need to worry about the update rule */
db2bae30SDana Myers
26f3cdf0SGordon Ross    if (Mask != ACPI_UINT64_MAX)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Decode the update rule */
db2bae30SDana Myers
db2bae30SDana Myers        switch (ObjDesc->CommonField.FieldFlags & AML_FIELD_UPDATE_RULE_MASK)
db2bae30SDana Myers        {
db2bae30SDana Myers        case AML_FIELD_UPDATE_PRESERVE:
db2bae30SDana Myers            /*
db2bae30SDana Myers             * Check if update rule needs to be applied (not if mask is all
db2bae30SDana Myers             * ones)  The left shift drops the bits we want to ignore.
db2bae30SDana Myers             */
db2bae30SDana Myers            if ((~Mask << (ACPI_MUL_8 (sizeof (Mask)) -
db2bae30SDana Myers                   ACPI_MUL_8 (ObjDesc->CommonField.AccessByteWidth))) != 0)
db2bae30SDana Myers            {
db2bae30SDana Myers                /*
db2bae30SDana Myers                 * Read the current contents of the byte/word/dword containing
db2bae30SDana Myers                 * the field, and merge with the new field value.
db2bae30SDana Myers                 */
*de5d74c2SJerry Jelinek                Status = AcpiExFieldDatumIo (
*de5d74c2SJerry Jelinek                    ObjDesc, FieldDatumByteOffset, &CurrentValue, ACPI_READ);
db2bae30SDana Myers                if (ACPI_FAILURE (Status))
db2bae30SDana Myers                {
db2bae30SDana Myers                    return_ACPI_STATUS (Status);
db2bae30SDana Myers                }
db2bae30SDana Myers
db2bae30SDana Myers                MergedValue |= (CurrentValue & ~Mask);
db2bae30SDana Myers            }
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        case AML_FIELD_UPDATE_WRITE_AS_ONES:
db2bae30SDana Myers
db2bae30SDana Myers            /* Set positions outside the field to all ones */
db2bae30SDana Myers
db2bae30SDana Myers            MergedValue |= ~Mask;
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        case AML_FIELD_UPDATE_WRITE_AS_ZEROS:
db2bae30SDana Myers
db2bae30SDana Myers            /* Set positions outside the field to all zeros */
db2bae30SDana Myers
db2bae30SDana Myers            MergedValue &= Mask;
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        default:
db2bae30SDana Myers
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Unknown UpdateRule value: 0x%X",
*de5d74c2SJerry Jelinek                (ObjDesc->CommonField.FieldFlags &
*de5d74c2SJerry Jelinek                    AML_FIELD_UPDATE_RULE_MASK)));
db2bae30SDana Myers            return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
*de5d74c2SJerry Jelinek        "Mask %8.8X%8.8X, DatumOffset %X, Width %X, "
*de5d74c2SJerry Jelinek        "Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n",
db2bae30SDana Myers        ACPI_FORMAT_UINT64 (Mask),
db2bae30SDana Myers        FieldDatumByteOffset,
db2bae30SDana Myers        ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers        ACPI_FORMAT_UINT64 (FieldValue),
db2bae30SDana Myers        ACPI_FORMAT_UINT64 (MergedValue)));
db2bae30SDana Myers
db2bae30SDana Myers    /* Write the merged value */
db2bae30SDana Myers
*de5d74c2SJerry Jelinek    Status = AcpiExFieldDatumIo (
*de5d74c2SJerry Jelinek        ObjDesc, FieldDatumByteOffset, &MergedValue, ACPI_WRITE);
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExExtractFromField
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc             - Field to be read
db2bae30SDana Myers *              Buffer              - Where to store the field data
db2bae30SDana Myers *              BufferLength        - Length of Buffer
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Retrieve the current value of the given field
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExExtractFromField (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    void                    *Buffer,
db2bae30SDana Myers    UINT32                  BufferLength)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
26f3cdf0SGordon Ross    UINT64                  RawDatum;
26f3cdf0SGordon Ross    UINT64                  MergedDatum;
db2bae30SDana Myers    UINT32                  FieldOffset = 0;
db2bae30SDana Myers    UINT32                  BufferOffset = 0;
db2bae30SDana Myers    UINT32                  BufferTailBits;
db2bae30SDana Myers    UINT32                  DatumCount;
db2bae30SDana Myers    UINT32                  FieldDatumCount;
26f3cdf0SGordon Ross    UINT32                  AccessBitWidth;
db2bae30SDana Myers    UINT32                  i;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExExtractFromField);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Validate target buffer and clear it */
db2bae30SDana Myers
db2bae30SDana Myers    if (BufferLength <
db2bae30SDana Myers        ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->CommonField.BitLength))
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross            "Field size %u (bits) is too large for buffer (%u)",
db2bae30SDana Myers            ObjDesc->CommonField.BitLength, BufferLength));
db2bae30SDana Myers
db2bae30SDana Myers        return_ACPI_STATUS (AE_BUFFER_OVERFLOW);
db2bae30SDana Myers    }
26f3cdf0SGordon Ross
*de5d74c2SJerry Jelinek    memset (Buffer, 0, BufferLength);
26f3cdf0SGordon Ross    AccessBitWidth = ACPI_MUL_8 (ObjDesc->CommonField.AccessByteWidth);
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    /* Handle the simple case here */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    if ((ObjDesc->CommonField.StartFieldBitOffset == 0) &&
26f3cdf0SGordon Ross        (ObjDesc->CommonField.BitLength == AccessBitWidth))
26f3cdf0SGordon Ross    {
*de5d74c2SJerry Jelinek        if (BufferLength >= sizeof (UINT64))
*de5d74c2SJerry Jelinek        {
26f3cdf0SGordon Ross            Status = AcpiExFieldDatumIo (ObjDesc, 0, Buffer, ACPI_READ);
*de5d74c2SJerry Jelinek        }
*de5d74c2SJerry Jelinek        else
*de5d74c2SJerry Jelinek        {
*de5d74c2SJerry Jelinek            /* Use RawDatum (UINT64) to handle buffers < 64 bits */
*de5d74c2SJerry Jelinek
*de5d74c2SJerry Jelinek            Status = AcpiExFieldDatumIo (ObjDesc, 0, &RawDatum, ACPI_READ);
*de5d74c2SJerry Jelinek            memcpy (Buffer, &RawDatum, BufferLength);
*de5d74c2SJerry Jelinek        }
*de5d74c2SJerry Jelinek
26f3cdf0SGordon Ross        return_ACPI_STATUS (Status);
26f3cdf0SGordon Ross    }
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross/* TBD: Move to common setup code */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    /* Field algorithm is limited to sizeof(UINT64), truncate if needed */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    if (ObjDesc->CommonField.AccessByteWidth > sizeof (UINT64))
26f3cdf0SGordon Ross    {
26f3cdf0SGordon Ross        ObjDesc->CommonField.AccessByteWidth = sizeof (UINT64);
26f3cdf0SGordon Ross        AccessBitWidth = sizeof (UINT64) * 8;
26f3cdf0SGordon Ross    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Compute the number of datums (access width data items) */
db2bae30SDana Myers
db2bae30SDana Myers    DatumCount = ACPI_ROUND_UP_TO (
26f3cdf0SGordon Ross        ObjDesc->CommonField.BitLength, AccessBitWidth);
26f3cdf0SGordon Ross
db2bae30SDana Myers    FieldDatumCount = ACPI_ROUND_UP_TO (
db2bae30SDana Myers        ObjDesc->CommonField.BitLength +
26f3cdf0SGordon Ross        ObjDesc->CommonField.StartFieldBitOffset, AccessBitWidth);
db2bae30SDana Myers
db2bae30SDana Myers    /* Priming read from the field */
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiExFieldDatumIo (ObjDesc, FieldOffset, &RawDatum, ACPI_READ);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers    MergedDatum = RawDatum >> ObjDesc->CommonField.StartFieldBitOffset;
db2bae30SDana Myers
db2bae30SDana Myers    /* Read the rest of the field */
db2bae30SDana Myers
db2bae30SDana Myers    for (i = 1; i < FieldDatumCount; i++)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Get next input datum from the field */
db2bae30SDana Myers
db2bae30SDana Myers        FieldOffset += ObjDesc->CommonField.AccessByteWidth;
*de5d74c2SJerry Jelinek        Status = AcpiExFieldDatumIo (
*de5d74c2SJerry Jelinek            ObjDesc, FieldOffset, &RawDatum, ACPI_READ);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Merge with previous datum if necessary.
db2bae30SDana Myers         *
db2bae30SDana Myers         * Note: Before the shift, check if the shift value will be larger than
db2bae30SDana Myers         * the integer size. If so, there is no need to perform the operation.
db2bae30SDana Myers         * This avoids the differences in behavior between different compilers
db2bae30SDana Myers         * concerning shift values larger than the target data width.
db2bae30SDana Myers         */
26f3cdf0SGordon Ross        if (AccessBitWidth - ObjDesc->CommonField.StartFieldBitOffset <
26f3cdf0SGordon Ross            ACPI_INTEGER_BIT_SIZE)
db2bae30SDana Myers        {
db2bae30SDana Myers            MergedDatum |= RawDatum <<
26f3cdf0SGordon Ross                (AccessBitWidth - ObjDesc->CommonField.StartFieldBitOffset);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (i == DatumCount)
db2bae30SDana Myers        {
db2bae30SDana Myers            break;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Write merged datum to target buffer */
db2bae30SDana Myers
*de5d74c2SJerry Jelinek        memcpy (((char *) Buffer) + BufferOffset, &MergedDatum,
db2bae30SDana Myers            ACPI_MIN(ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers                BufferLength - BufferOffset));
db2bae30SDana Myers
db2bae30SDana Myers        BufferOffset += ObjDesc->CommonField.AccessByteWidth;
db2bae30SDana Myers        MergedDatum = RawDatum >> ObjDesc->CommonField.StartFieldBitOffset;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Mask off any extra bits in the last datum */
db2bae30SDana Myers
26f3cdf0SGordon Ross    BufferTailBits = ObjDesc->CommonField.BitLength % AccessBitWidth;
db2bae30SDana Myers    if (BufferTailBits)
db2bae30SDana Myers    {
db2bae30SDana Myers        MergedDatum &= ACPI_MASK_BITS_ABOVE (BufferTailBits);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Write the last datum to the buffer */
db2bae30SDana Myers
*de5d74c2SJerry Jelinek    memcpy (((char *) Buffer) + BufferOffset, &MergedDatum,
db2bae30SDana Myers        ACPI_MIN(ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers            BufferLength - BufferOffset));
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExInsertIntoField
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc             - Field to be written
db2bae30SDana Myers *              Buffer              - Data to be written
db2bae30SDana Myers *              BufferLength        - Length of Buffer
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Store the Buffer contents into the given field
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExInsertIntoField (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc,
db2bae30SDana Myers    void                    *Buffer,
db2bae30SDana Myers    UINT32                  BufferLength)
db2bae30SDana Myers{
26f3cdf0SGordon Ross    void                    *NewBuffer;
db2bae30SDana Myers    ACPI_STATUS             Status;
26f3cdf0SGordon Ross    UINT64                  Mask;
26f3cdf0SGordon Ross    UINT64                  WidthMask;
26f3cdf0SGordon Ross    UINT64                  MergedDatum;
26f3cdf0SGordon Ross    UINT64                  RawDatum = 0;
db2bae30SDana Myers    UINT32                  FieldOffset = 0;
db2bae30SDana Myers    UINT32                  BufferOffset = 0;
db2bae30SDana Myers    UINT32                  BufferTailBits;
db2bae30SDana Myers    UINT32                  DatumCount;
db2bae30SDana Myers    UINT32                  FieldDatumCount;
26f3cdf0SGordon Ross    UINT32                  AccessBitWidth;
db2bae30SDana Myers    UINT32                  RequiredLength;
26f3cdf0SGordon Ross    UINT32                  i;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExInsertIntoField);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Validate input buffer */
db2bae30SDana Myers
db2bae30SDana Myers    NewBuffer = NULL;
db2bae30SDana Myers    RequiredLength = ACPI_ROUND_BITS_UP_TO_BYTES (
db2bae30SDana Myers        ObjDesc->CommonField.BitLength);
*de5d74c2SJerry Jelinek
db2bae30SDana Myers    /*
db2bae30SDana Myers     * We must have a buffer that is at least as long as the field
db2bae30SDana Myers     * we are writing to. This is because individual fields are
db2bae30SDana Myers     * indivisible and partial writes are not supported -- as per
db2bae30SDana Myers     * the ACPI specification.
db2bae30SDana Myers     */
db2bae30SDana Myers    if (BufferLength < RequiredLength)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* We need to create a new buffer */
db2bae30SDana Myers
db2bae30SDana Myers        NewBuffer = ACPI_ALLOCATE_ZEROED (RequiredLength);
db2bae30SDana Myers        if (!NewBuffer)
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Copy the original data to the new buffer, starting
db2bae30SDana Myers         * at Byte zero. All unused (upper) bytes of the
db2bae30SDana Myers         * buffer will be 0.
db2bae30SDana Myers         */
*de5d74c2SJerry Jelinek        memcpy ((char *) NewBuffer, (char *) Buffer, BufferLength);
db2bae30SDana Myers        Buffer = NewBuffer;
db2bae30SDana Myers        BufferLength = RequiredLength;
db2bae30SDana Myers    }
db2bae30SDana Myers
26f3cdf0SGordon Ross/* TBD: Move to common setup code */
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    /* Algo is limited to sizeof(UINT64), so cut the AccessByteWidth */
26f3cdf0SGordon Ross    if (ObjDesc->CommonField.AccessByteWidth > sizeof (UINT64))
26f3cdf0SGordon Ross    {
26f3cdf0SGordon Ross        ObjDesc->CommonField.AccessByteWidth = sizeof (UINT64);
26f3cdf0SGordon Ross    }
26f3cdf0SGordon Ross
26f3cdf0SGordon Ross    AccessBitWidth = ACPI_MUL_8 (ObjDesc->CommonField.AccessByteWidth);
26f3cdf0SGordon Ross
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Create the bitmasks used for bit insertion.
db2bae30SDana Myers     * Note: This if/else is used to bypass compiler differences with the
db2bae30SDana Myers     * shift operator
db2bae30SDana Myers     */
26f3cdf0SGordon Ross    if (AccessBitWidth == ACPI_INTEGER_BIT_SIZE)
db2bae30SDana Myers    {
26f3cdf0SGordon Ross        WidthMask = ACPI_UINT64_MAX;
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
26f3cdf0SGordon Ross        WidthMask = ACPI_MASK_BITS_ABOVE (AccessBitWidth);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    Mask = WidthMask &
db2bae30SDana Myers        ACPI_MASK_BITS_BELOW (ObjDesc->CommonField.StartFieldBitOffset);
db2bae30SDana Myers
db2bae30SDana Myers    /* Compute the number of datums (access width data items) */
db2bae30SDana Myers
db2bae30SDana Myers    DatumCount = ACPI_ROUND_UP_TO (ObjDesc->CommonField.BitLength,
26f3cdf0SGordon Ross        AccessBitWidth);
db2bae30SDana Myers
db2bae30SDana Myers    FieldDatumCount = ACPI_ROUND_UP_TO (ObjDesc->CommonField.BitLength +
db2bae30SDana Myers        ObjDesc->CommonField.StartFieldBitOffset,
26f3cdf0SGordon Ross        AccessBitWidth);
db2bae30SDana Myers
db2bae30SDana Myers    /* Get initial Datum from the input buffer */
db2bae30SDana Myers
*de5d74c2SJerry Jelinek    memcpy (&RawDatum, Buffer,
db2bae30SDana Myers        ACPI_MIN(ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers            BufferLength - BufferOffset));
db2bae30SDana Myers
db2bae30SDana Myers    MergedDatum = RawDatum << ObjDesc->CommonField.StartFieldBitOffset;
db2bae30SDana Myers
db2bae30SDana Myers    /* Write the entire field */
db2bae30SDana Myers
db2bae30SDana Myers    for (i = 1; i < FieldDatumCount; i++)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Write merged datum to the target field */
db2bae30SDana Myers
db2bae30SDana Myers        MergedDatum &= Mask;
*de5d74c2SJerry Jelinek        Status = AcpiExWriteWithUpdateRule (
*de5d74c2SJerry Jelinek            ObjDesc, Mask, MergedDatum, FieldOffset);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            goto Exit;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        FieldOffset += ObjDesc->CommonField.AccessByteWidth;
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Start new output datum by merging with previous input datum
db2bae30SDana Myers         * if necessary.
db2bae30SDana Myers         *
db2bae30SDana Myers         * Note: Before the shift, check if the shift value will be larger than
db2bae30SDana Myers         * the integer size. If so, there is no need to perform the operation.
db2bae30SDana Myers         * This avoids the differences in behavior between different compilers
db2bae30SDana Myers         * concerning shift values larger than the target data width.
db2bae30SDana Myers         */
26f3cdf0SGordon Ross        if ((AccessBitWidth - ObjDesc->CommonField.StartFieldBitOffset) <
26f3cdf0SGordon Ross            ACPI_INTEGER_BIT_SIZE)
db2bae30SDana Myers        {
db2bae30SDana Myers            MergedDatum = RawDatum >>
26f3cdf0SGordon Ross                (AccessBitWidth - ObjDesc->CommonField.StartFieldBitOffset);
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            MergedDatum = 0;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Mask = WidthMask;
db2bae30SDana Myers
db2bae30SDana Myers        if (i == DatumCount)
db2bae30SDana Myers        {
db2bae30SDana Myers            break;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Get the next input datum from the buffer */
db2bae30SDana Myers
db2bae30SDana Myers        BufferOffset += ObjDesc->CommonField.AccessByteWidth;
*de5d74c2SJerry Jelinek        memcpy (&RawDatum, ((char *) Buffer) + BufferOffset,
db2bae30SDana Myers            ACPI_MIN(ObjDesc->CommonField.AccessByteWidth,
db2bae30SDana Myers                 BufferLength - BufferOffset));
26f3cdf0SGordon Ross
db2bae30SDana Myers        MergedDatum |= RawDatum << ObjDesc->CommonField.StartFieldBitOffset;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Mask off any extra bits in the last datum */
db2bae30SDana Myers
db2bae30SDana Myers    BufferTailBits = (ObjDesc->CommonField.BitLength +
26f3cdf0SGordon Ross        ObjDesc->CommonField.StartFieldBitOffset) % AccessBitWidth;
db2bae30SDana Myers    if (BufferTailBits)
db2bae30SDana Myers    {
db2bae30SDana Myers        Mask &= ACPI_MASK_BITS_ABOVE (BufferTailBits);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Write the last datum to the field */
db2bae30SDana Myers
db2bae30SDana Myers    MergedDatum &= Mask;
*de5d74c2SJerry Jelinek    Status = AcpiExWriteWithUpdateRule (
*de5d74c2SJerry Jelinek        ObjDesc, Mask, MergedDatum, FieldOffset);
db2bae30SDana Myers
db2bae30SDana MyersExit:
db2bae30SDana Myers    /* Free temporary buffer if we used one */
db2bae30SDana Myers
db2bae30SDana Myers    if (NewBuffer)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_FREE (NewBuffer);
db2bae30SDana Myers    }
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}