exprep.c revision 7b1019a6d29ccb7999dc76cba3dde1c627e8e609
/******************************************************************************
*
* Module Name: exprep - ACPI AML field prep utilities
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2016, Intel Corp.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* substantially similar to the "NO WARRANTY" disclaimer below
* ("Disclaimer") and any redistribution must be conditioned upon
* including a substantially similar Disclaimer requirement for further
* binary redistribution.
* 3. Neither the names of the above-listed copyright holders nor the names
* of any contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* Alternatively, this software may be distributed under the terms of the
* GNU General Public License ("GPL") version 2 as published by the Free
* Software Foundation.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*/
#include "acpi.h"
#include "accommon.h"
#include "acinterp.h"
#include "amlcode.h"
#include "acnamesp.h"
#include "acdispat.h"
#define _COMPONENT ACPI_EXECUTER
ACPI_MODULE_NAME ("exprep")
/* Local prototypes */
static UINT32
#ifdef ACPI_UNDER_DEVELOPMENT
static UINT32
/*******************************************************************************
*
* FUNCTION: AcpiExGenerateAccess
*
* FieldBitLength - Length of field in bits
* RegionLength - Length of parent in bytes
*
* RETURN: Field granularity (8, 16, 32 or 64) and
* ByteAlignment (1, 2, 3, or 4)
*
* DESCRIPTION: Generate an optimal access width for fields defined with the
* AnyAcc keyword.
*
* NOTE: Need to have the RegionLength in order to check for boundary
* conditions (end-of-region). However, the RegionLength is a deferred
* operation. Therefore, to complete this implementation, the generation
* of this access width must be deferred until the region length has
* been evaluated.
*
******************************************************************************/
static UINT32
{
/* Round Field start offset and length to "minimal" byte boundaries */
"Bit length %u, Bit offset %u\n",
"Byte Length %u, Byte Offset %u, End Offset %u\n",
/*
* Iterative search for the maximum access width that is both aligned
* and does not go beyond the end of the region
*
* Start at ByteAcc and work upwards to QwordAcc max. (1,2,4,8 bytes)
*/
{
/*
* 1) Round end offset up to next access boundary and make sure that
* this does not go beyond the end of the parent region.
* 2) When the Access width is greater than the FieldByteLength, we
* are done. (This does not optimize for the perfectly aligned
* case yet).
*/
{
"AccessWidth %u end is within region\n", AccessByteWidth));
"Field Start %u, Field End %u -- requires %u accesses\n",
/* Single access is optimal */
if (Accesses <= 1)
{
"Entire field can be accessed "
"with one operation of size %u\n",
}
/*
* try the next wider access on next iteration
*/
if (Accesses < MinimumAccesses)
{
}
}
else
{
"AccessWidth %u end is NOT within region\n",
if (AccessByteWidth == 1)
{
"Field goes beyond end-of-region!\n"));
/* Field does not fit in the region at all */
return_VALUE (0);
}
/*
* This width goes beyond the end-of-region, back off to
* previous access
*/
"Backing off to previous optimal access width of %u\n",
}
}
/*
* just use max access width
*/
"Cannot access field in one operation, using width 8\n"));
return_VALUE (8);
}
#endif /* ACPI_UNDER_DEVELOPMENT */
/*******************************************************************************
*
* FUNCTION: AcpiExDecodeFieldAccess
*
* PARAMETERS: ObjDesc - Field object
* FieldFlags - Encoded fieldflags (contains access bits)
* ReturnByteAlignment - Where the byte alignment is returned
*
* RETURN: Field granularity (8, 16, 32 or 64) and
* ByteAlignment (1, 2, 3, or 4)
*
* DESCRIPTION: Decode the AccessType bits of a field definition.
*
******************************************************************************/
static UINT32
{
switch (Access)
{
case AML_FIELD_ACCESS_ANY:
#ifdef ACPI_UNDER_DEVELOPMENT
0xFFFFFFFF /* Temp until we pass RegionLength as parameter */);
#endif
ByteAlignment = 1;
BitLength = 8;
break;
case AML_FIELD_ACCESS_BYTE:
case AML_FIELD_ACCESS_BUFFER: /* ACPI 2.0 (SMBus Buffer) */
ByteAlignment = 1;
BitLength = 8;
break;
case AML_FIELD_ACCESS_WORD:
ByteAlignment = 2;
BitLength = 16;
break;
case AML_FIELD_ACCESS_DWORD:
ByteAlignment = 4;
BitLength = 32;
break;
case AML_FIELD_ACCESS_QWORD: /* ACPI 2.0 */
ByteAlignment = 8;
BitLength = 64;
break;
default:
/* Invalid field access type */
"Unknown field access type 0x%X",
Access));
return_UINT32 (0);
}
{
/*
* BufferField access can be on any byte boundary, so the
* ByteAlignment is always 1 byte -- regardless of any ByteAlignment
* implied by the field access type.
*/
ByteAlignment = 1;
}
}
/*******************************************************************************
*
* FUNCTION: AcpiExPrepCommonFieldObject
*
* PARAMETERS: ObjDesc - The field object
* FieldFlags - Access, LockRule, and UpdateRule.
* The format of a FieldFlag is described
* in the ACPI specification
* FieldAttribute - Special attributes (not used)
* FieldBitPosition - Field start position
* FieldBitLength - Field length in number of bits
*
* RETURN: Status
*
* DESCRIPTION: Initialize the areas of the field object that are common
* to the various types of fields. Note: This is very "sensitive"
* code because we are solving the general case for field
* alignment.
*
******************************************************************************/
{
/*
* Note: the structure being initialized is the
* ACPI_COMMON_FIELD_INFO; No structure fields outside of the common
* area are initialized by this procedure.
*/
/*
* Decode the access type so we can compute offsets. The access type gives
* two pieces of information - the width of each field access and the
* necessary ByteAlignment (address granularity) of the access.
*
* For AnyAcc, the AccessBitWidth is the largest width that is both
* necessary and possible in an attempt to access the whole field in one
* I/O operation. However, for AnyAcc, the ByteAlignment is always one
* byte.
*
* For all Buffer Fields, the ByteAlignment is always one byte.
*
* For all other access types (Byte, Word, Dword, Qword), the Bitwidth is
* the same (equivalent) as the ByteAlignment.
*/
if (!AccessBitWidth)
{
}
/* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */
/*
* BaseByteOffset is the address of the start of the field within the
* region. It is the byte address of the first *datum* (field-width data
* unit) of the field. (i.e., the first datum that contains at least the
* first *bit* of the field.)
*
* Note: ByteAlignment is always either equal to the AccessBitWidth or 8
* (Byte access), and it defines the addressing granularity of the parent
* region or buffer.
*/
/*
* StartFieldBitOffset is the offset of the first bit of the field within
* a field datum.
*/
}
/*******************************************************************************
*
* FUNCTION: AcpiExPrepFieldValue
*
* PARAMETERS: Info - Contains all field creation info
*
* RETURN: Status
*
* DESCRIPTION: Construct an object of type ACPI_OPERAND_OBJECT with a
* subtype of DefField and connect it to the parent Node.
*
******************************************************************************/
{
/* Parameter validation */
{
if (!Info->RegionNode)
{
}
if (Type != ACPI_TYPE_REGION)
{
}
}
/* Allocate a new field object */
if (!ObjDesc)
{
}
/* Initialize areas of the object that are common to all fields */
if (ACPI_FAILURE (Status))
{
}
/* Initialize areas of the object that are specific to the field type */
{
/* Fields specific to GenericSerialBus fields */
if (Info->ConnectionNode)
{
{
if (ACPI_FAILURE (Status))
{
}
}
}
else if (Info->ResourceBuffer)
{
}
/* Allow full data read from EC address space */
{
/* Maximum byte width supported is 255 */
if (AccessByteWidth < 256)
{
}
}
/* An additional reference for the container */
"RegionField: BitOff %X, Off %X, Gran %X, Region %p\n",
break;
/* An additional reference for the attached objects */
"Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n",
/*
* Remember location in AML stream of the field unit
* opcode and operands -- since the BankValue
* operands must be evaluated.
*/
break;
/* Get the Index and Data registers */
{
}
/* An additional reference for the attached objects */
/*
* April 2006: Changed to match MS behavior
*
* The value written to the Index register is the byte offset of the
* target field in units of the granularity of the IndexField
*
* Previously, the value was calculated as an index in terms of the
* width of the Data register, as below:
*
* ObjDesc->IndexField.Value = (UINT32)
* (Info->FieldBitPosition / ACPI_MUL_8 (
* ObjDesc->Field.AccessByteWidth));
*
* February 2006: Tried value as a byte offset:
* ObjDesc->IndexField.Value = (UINT32)
* ACPI_DIV_8 (Info->FieldBitPosition);
*/
"IndexField: BitOff %X, Off %X, Value %X, "
"Gran %X, Index %p, Data %p\n",
break;
default:
/* No other types should get here */
break;
}
/*
* Store the constructed descriptor (ObjDesc) into the parent Node,
* preserving the current type of that NamedObj.
*/
"Set NamedObj %p [%4.4s], ObjDesc %p\n",
/* Remove local reference to the object */
}