exfldio.c revision 186507a7cf6e4b4155e9ef89631777a96633ac0e
/******************************************************************************
*
* Module Name: exfldio - Aml Field I/O
* $Revision: 1.116 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
* All rights reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************/
#define __EXFLDIO_C__
#include "acpi.h"
#include "acinterp.h"
#include "amlcode.h"
#include "acevents.h"
#include "acdispat.h"
#define _COMPONENT ACPI_EXECUTER
ACPI_MODULE_NAME ("exfldio")
/* Local prototypes */
static ACPI_STATUS
static BOOLEAN
static ACPI_STATUS
/*******************************************************************************
*
* FUNCTION: AcpiExSetupRegion
*
* PARAMETERS: ObjDesc - Field to be read or written
* FieldDatumByteOffset - Byte offset of this datum within the
* parent field
*
* RETURN: Status
*
* DESCRIPTION: Common processing for AcpiExExtractFromField and
* AcpiExInsertIntoField. Initialize the Region if necessary and
* validate the request.
*
******************************************************************************/
static ACPI_STATUS
{
/* We must have a valid region */
{
}
/*
* If the Region Address and Length have not been previously evaluated,
* evaluate them now and save the results.
*/
{
if (ACPI_FAILURE (Status))
{
}
}
{
/* SMBus has a non-linear address space */
}
#ifdef ACPI_UNDER_DEVELOPMENT
/*
* If the Field access is AnyAcc, we can now compute the optimal
* access (because we know know the length of the parent region)
*/
{
if (ACPI_FAILURE (Status))
{
}
}
#endif
/*
* Validate the request. The entire request from the byte offset for a
* length of one field datum (access width) must fit within the region.
* (Region length is specified in bytes)
*/
{
{
/*
* Slack mode only: We will go ahead and allow access to this
* field if it is within the region length rounded up to the next
* access width boundary.
*/
{
}
}
{
/*
* This is the case where the AccessType (AccWord, etc.) is wider
* than the region itself. For example, a region of length one
* byte, and a field with Dword access specified.
*/
"Field [%4.4s] access width (%d bytes) too large for region [%4.4s] (length %X)\n",
}
/*
* Offset rounded up to next multiple of field width
* exceeds region length, indicate an error
*/
"Field [%4.4s] Base+Offset+Width %X+%X+%X is beyond end of region [%4.4s] (length %X)\n",
}
}
/*******************************************************************************
*
* FUNCTION: AcpiExAccessRegion
*
* PARAMETERS: ObjDesc - Field to be read
* FieldDatumByteOffset - Byte offset of this datum within the
* parent field
* Value - Where to store value (must at least
* the size of ACPI_INTEGER)
* Function - Read or Write flag plus other region-
* dependent flags
*
* RETURN: Status
*
* DESCRIPTION: Read or Write a single field datum to an Operation Region.
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("ExAccessRegion");
/*
* Ensure that the region operands are fully evaluated and verify
* the validity of the request
*/
if (ACPI_FAILURE (Status))
{
}
/*
* The physical address of this field datum is:
*
* 1) The base of the region, plus
* 2) The base offset of the field, plus
* 3) The current offset into the field
*/
{
}
else
{
}
" Region [%s:%X], Width %X, ByteBase %X, Offset %X at %8.8X%8.8X\n",
/* Invoke the appropriate AddressSpace/OpRegion handler */
if (ACPI_FAILURE (Status))
{
if (Status == AE_NOT_IMPLEMENTED)
{
"Region %s(%X) not implemented\n",
}
else if (Status == AE_NOT_EXIST)
{
"Region %s(%X) has no handler\n",
}
}
}
/*******************************************************************************
*
* FUNCTION: AcpiExRegisterOverflow
*
* PARAMETERS: ObjDesc - Register(Field) to be written
* Value - Value to be stored
*
* RETURN: TRUE if value overflows the field, FALSE otherwise
*
* DESCRIPTION: Check if a value is out of range of the field being written.
* Used to check if the values written to Index and Bank registers
* are out of range. Normally, the value is simply truncated
* to fit the field, but this case is most likely a serious
* coding error in the ASL.
*
******************************************************************************/
static BOOLEAN
{
{
/*
* The field is large enough to hold the maximum integer, so we can
* never overflow it.
*/
return (FALSE);
}
{
/*
* The Value is larger than the maximum value that can fit into
* the register.
*/
return (TRUE);
}
/* The Value will fit into the field with no truncation */
return (FALSE);
}
/*******************************************************************************
*
* FUNCTION: AcpiExFieldDatumIo
*
* PARAMETERS: ObjDesc - Field to be read
* FieldDatumByteOffset - Byte offset of this datum within the
* parent field
* Value - Where to store value (must be 64 bits)
* ReadWrite - Read or Write flag
*
* RETURN: Status
*
* DESCRIPTION: Read or Write a single datum of a field. The FieldType is
* demultiplexed here to handle the different types of fields
* (BufferField, RegionField, IndexField, BankField)
*
******************************************************************************/
static ACPI_STATUS
{
{
if (!Value)
{
LocalValue = 0;
/* To support reads without saving return value */
Value = &LocalValue;
}
/* Clear the entire return buffer first, [Very Important!] */
*Value = 0;
}
/*
* The four types of fields are:
*
* OperationRegion
* Data Register
*/
switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
{
case ACPI_TYPE_BUFFER_FIELD:
/*
* If the BufferField arguments have not been previously evaluated,
* evaluate them now and save the results.
*/
{
if (ACPI_FAILURE (Status))
{
}
}
{
/*
* Copy the data from the source buffer.
* Length is the field width in bytes.
*/
}
else
{
/*
* Copy the data to the target buffer.
* Length is the field width in bytes.
*/
}
break;
/*
* Ensure that the BankValue is not beyond the capacity of
* the register
*/
{
}
/*
* For BankFields, we must write the BankValue to the BankRegister
* (itself a RegionField) before we can access the data.
*/
if (ACPI_FAILURE (Status))
{
}
/*
* Now that the Bank has been selected, fall through to the
* RegionField case and write the datum to the Operation Region
*/
/*lint -fallthrough */
/*
* For simple RegionFields, we just directly access the owning
* Operation Region.
*/
break;
/*
* Ensure that the IndexValue is not beyond the capacity of
* the register
*/
{
}
/* Write the index value to the IndexRegister (itself a RegionField) */
"Write to Index Register: Value %8.8X\n",
sizeof (FieldDatumByteOffset));
if (ACPI_FAILURE (Status))
{
}
"I/O to Data Register: ValuePtr %p\n",
Value));
{
/* Read the datum from the DataRegister */
Value, sizeof (ACPI_INTEGER));
}
else
{
/* Write the datum to the DataRegister */
Value, sizeof (ACPI_INTEGER));
}
break;
default:
ACPI_REPORT_ERROR (("Wrong object type in field I/O %X\n",
break;
}
if (ACPI_SUCCESS (Status))
{
{
"Value Read %8.8X%8.8X, Width %d\n",
}
else
{
"Value Written %8.8X%8.8X, Width %d\n",
}
}
}
/*******************************************************************************
*
* FUNCTION: AcpiExWriteWithUpdateRule
*
* PARAMETERS: ObjDesc - Field to be written
* Mask - bitmask within field datum
* FieldValue - Value to write
* FieldDatumByteOffset - Offset of datum within field
*
* RETURN: Status
*
* DESCRIPTION: Apply the field update rule to a field write
*
******************************************************************************/
{
/* Start with the new bits */
/* If the mask is all ones, we don't need to worry about the update rule */
if (Mask != ACPI_INTEGER_MAX)
{
/* Decode the update rule */
{
/*
* Check if update rule needs to be applied (not if mask is all
* ones) The left shift drops the bits we want to ignore.
*/
{
/*
* the field, and merge with the new field value.
*/
if (ACPI_FAILURE (Status))
{
}
}
break;
/* Set positions outside the field to all ones */
MergedValue |= ~Mask;
break;
/* Set positions outside the field to all zeros */
MergedValue &= Mask;
break;
default:
"WriteWithUpdateRule: Unknown UpdateRule setting: %X\n",
}
}
"Mask %8.8X%8.8X, DatumOffset %X, Width %X, Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n",
/* Write the merged value */
}
/*******************************************************************************
*
* FUNCTION: AcpiExExtractFromField
*
* PARAMETERS: ObjDesc - Field to be read
* Buffer - Where to store the field data
* BufferLength - Length of Buffer
*
* RETURN: Status
*
* DESCRIPTION: Retrieve the current value of the given field
*
******************************************************************************/
void *Buffer,
{
UINT32 FieldOffset = 0;
UINT32 BufferOffset = 0;
UINT32 i;
ACPI_FUNCTION_TRACE ("ExExtractFromField");
/* Validate target buffer and clear it */
{
"Field size %X (bits) is too large for buffer (%X)\n",
}
/* Compute the number of datums (access width data items) */
/* Priming read from the field */
if (ACPI_FAILURE (Status))
{
}
/* Read the rest of the field */
for (i = 1; i < FieldDatumCount; i++)
{
/* Get next input datum from the field */
if (ACPI_FAILURE (Status))
{
}
/* Merge with previous datum if necessary */
MergedDatum |= RawDatum <<
if (i == DatumCount)
{
break;
}
/* Write merged datum to target buffer */
BufferLength - BufferOffset));
}
/* Mask off any extra bits in the last datum */
if (BufferTailBits)
{
}
/* Write the last datum to the buffer */
BufferLength - BufferOffset));
}
/*******************************************************************************
*
* FUNCTION: AcpiExInsertIntoField
*
* PARAMETERS: ObjDesc - Field to be written
* Buffer - Data to be written
* BufferLength - Length of Buffer
*
* RETURN: Status
*
* DESCRIPTION: Store the Buffer contents into the given field
*
******************************************************************************/
void *Buffer,
{
ACPI_INTEGER RawDatum = 0;
UINT32 FieldOffset = 0;
UINT32 BufferOffset = 0;
UINT32 i;
ACPI_FUNCTION_TRACE ("ExInsertIntoField");
/* Validate input buffer */
{
"Field size %X (bits) is too large for buffer (%X)\n",
}
/* Compute the number of datums (access width data items) */
/* Get initial Datum from the input buffer */
BufferLength - BufferOffset));
/* Write the entire field */
for (i = 1; i < FieldDatumCount; i++)
{
/* Write merged datum to the target field */
MergedDatum &= Mask;
if (ACPI_FAILURE (Status))
{
}
/* Start new output datum by merging with previous input datum */
MergedDatum = RawDatum >>
if (i == DatumCount)
{
break;
}
/* Get the next input datum from the buffer */
BufferLength - BufferOffset));
}
/* Mask off any extra bits in the last datum */
if (BufferTailBits)
{
}
/* Write the last datum to the field */
MergedDatum &= Mask;
}