exfield.c File Reference

#include "acpi.h"
#include "accommon.h"
#include "acdispat.h"
#include "acinterp.h"
#include "amlcode.h"

Include dependency graph for exfield.c:

Go to the source code of this file.

Macros
#define	_COMPONENT   ACPI_EXECUTER
#define	ACPI_INVALID_PROTOCOL_ID   0x80
#define	ACPI_MAX_PROTOCOL_ID   0x0F
#define	PCC_MASTER_SUBSPACE   3
#define	GENERIC_SUBSPACE_COMMAND(a)   (4 == a || a == 5)
#define	MASTER_SUBSPACE_COMMAND(a)   (12 <= a && a <= 15)

Functions
ACPI_STATUS	AcpiExGetProtocolBufferLength (UINT32 ProtocolId, UINT32 *ReturnLength)
ACPI_STATUS	AcpiExReadDataFromField (ACPI_WALK_STATE *WalkState, ACPI_OPERAND_OBJECT *ObjDesc, ACPI_OPERAND_OBJECT **RetBufferDesc)
ACPI_STATUS	AcpiExWriteDataToField (ACPI_OPERAND_OBJECT *SourceDesc, ACPI_OPERAND_OBJECT *ObjDesc, ACPI_OPERAND_OBJECT **ResultDesc)

Variables
static const UINT8	AcpiProtocolLengths []

Macro Definition Documentation

_COMPONENT

#define _COMPONENT   ACPI_EXECUTER

Definition at line 51 of file exfield.c.

ACPI_INVALID_PROTOCOL_ID

#define ACPI_INVALID_PROTOCOL_ID   0x80

Definition at line 59 of file exfield.c.

ACPI_MAX_PROTOCOL_ID

#define ACPI_MAX_PROTOCOL_ID   0x0F

Definition at line 60 of file exfield.c.

GENERIC_SUBSPACE_COMMAND

#define GENERIC_SUBSPACE_COMMAND

(

a

)

(4 == a || a == 5)

Definition at line 90 of file exfield.c.

MASTER_SUBSPACE_COMMAND

#define MASTER_SUBSPACE_COMMAND

(

a

)

(12 <= a && a <= 15)

Definition at line 91 of file exfield.c.

PCC_MASTER_SUBSPACE

#define PCC_MASTER_SUBSPACE   3

Definition at line 82 of file exfield.c.

Function Documentation

AcpiExGetProtocolBufferLength()

ACPI_STATUS AcpiExGetProtocolBufferLength	(	UINT32	ProtocolId,
		UINT32 *	ReturnLength
	)

Definition at line 111 of file exfield.c.

{
 
    if ((ProtocolId > ACPI_MAX_PROTOCOL_ID) ||
        (AcpiProtocolLengths[ProtocolId] == ACPI_INVALID_PROTOCOL_ID))
    {
        ACPI_ERROR ((AE_INFO,
            "Invalid Field/AccessAs protocol ID: 0x%4.4X", ProtocolId));
 
        return (AE_AML_PROTOCOL);
    }
 
    *ReturnLength = AcpiProtocolLengths[ProtocolId];
    return (AE_OK);
}

Referenced by AcpiExReadSerialBus(), and AcpiExWriteSerialBus().

AcpiExReadDataFromField()

ACPI_STATUS AcpiExReadDataFromField	(	ACPI_WALK_STATE *	WalkState,
		ACPI_OPERAND_OBJECT *	ObjDesc,
		ACPI_OPERAND_OBJECT **	RetBufferDesc
	)

Definition at line 147 of file exfield.c.

{
    ACPI_STATUS             Status;
    ACPI_OPERAND_OBJECT     *BufferDesc;
    void                    *Buffer;
    UINT32                  BufferLength;
 
 
    ACPI_FUNCTION_TRACE_PTR (ExReadDataFromField, ObjDesc);
 
 
    /* Parameter validation */
 
    if (!ObjDesc)
    {
        return_ACPI_STATUS (AE_AML_NO_OPERAND);
    }
    if (!RetBufferDesc)
    {
        return_ACPI_STATUS (AE_BAD_PARAMETER);
    }
 
    if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
    {
        /*
         * If the BufferField arguments have not been previously evaluated,
         * evaluate them now and save the results.
         */
        if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
        {
            Status = AcpiDsGetBufferFieldArguments (ObjDesc);
            if (ACPI_FAILURE (Status))
            {
                return_ACPI_STATUS (Status);
            }
        }
    }
    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
        (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI  ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_PLATFORM_RT ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_FIXED_HARDWARE))
    {
        /* SMBus, GSBus, IPMI serial */
 
        Status = AcpiExReadSerialBus (ObjDesc, RetBufferDesc);
        return_ACPI_STATUS (Status);
    }
 
    /*
     * Allocate a buffer for the contents of the field.
     *
     * If the field is larger than the current integer width, create
     * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
     * the use of arithmetic operators on the returned value if the
     * field size is equal or smaller than an Integer.
     *
     * However, all buffer fields created by CreateField operator needs to
     * remain as a buffer to match other AML interpreter implementations.
     *
     * Note: Field.length is in bits.
     */
    BufferLength = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
        ObjDesc->Field.BitLength);
 
    if (BufferLength > AcpiGbl_IntegerByteWidth ||
        (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD &&
        ObjDesc->BufferField.IsCreateField))
    {
        /* Field is too large for an Integer, create a Buffer instead */
 
        BufferDesc = AcpiUtCreateBufferObject (BufferLength);
        if (!BufferDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }
        Buffer = BufferDesc->Buffer.Pointer;
    }
    else
    {
        /* Field will fit within an Integer (normal case) */
 
        BufferDesc = AcpiUtCreateIntegerObject ((UINT64) 0);
        if (!BufferDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }
 
        BufferLength = AcpiGbl_IntegerByteWidth;
        Buffer = &BufferDesc->Integer.Value;
    }
 
    if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
        (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO))
    {
        /* General Purpose I/O */
 
        Status = AcpiExReadGpio (ObjDesc, Buffer);
        goto Exit;
    }
    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
        (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_PLATFORM_COMM))
    {
        /*
         * Reading from a PCC field unit does not require the handler because
         * it only requires reading from the InternalPccBuffer.
         */
        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
            "PCC FieldRead bits %u\n", ObjDesc->Field.BitLength));
 
        memcpy (Buffer, ObjDesc->Field.RegionObj->Field.InternalPccBuffer +
        ObjDesc->Field.BaseByteOffset, (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
            ObjDesc->Field.BitLength));
 
        *RetBufferDesc = BufferDesc;
        return AE_OK;
    }
 
    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
        "FieldRead [TO]:   Obj %p, Type %X, Buf %p, ByteLen %X\n",
        ObjDesc, ObjDesc->Common.Type, Buffer, BufferLength));
    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
        "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
        ObjDesc->CommonField.BitLength,
        ObjDesc->CommonField.StartFieldBitOffset,
        ObjDesc->CommonField.BaseByteOffset));
 
    /* Lock entire transaction if requested */
 
    AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
 
    /* Read from the field */
 
    Status = AcpiExExtractFromField (ObjDesc, Buffer, BufferLength);
    AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
 
 
Exit:
    if (ACPI_FAILURE (Status))
    {
        AcpiUtRemoveReference (BufferDesc);
    }
    else
    {
        *RetBufferDesc = BufferDesc;
    }
 
    return_ACPI_STATUS (Status);
}

Referenced by AcpiExOpcode_1A_0T_1R(), AcpiExResolveNodeToValue(), and AcpiExResolveObjectToValue().

AcpiExWriteDataToField()

ACPI_STATUS AcpiExWriteDataToField	(	ACPI_OPERAND_OBJECT *	SourceDesc,
		ACPI_OPERAND_OBJECT *	ObjDesc,
		ACPI_OPERAND_OBJECT **	ResultDesc
	)

Definition at line 317 of file exfield.c.

{
    ACPI_STATUS             Status;
    UINT32                  BufferLength;
    UINT32                  DataLength;
    void                    *Buffer;
 
 
    ACPI_FUNCTION_TRACE_PTR (ExWriteDataToField, ObjDesc);
 
 
    /* Parameter validation */
 
    if (!SourceDesc || !ObjDesc)
    {
        return_ACPI_STATUS (AE_AML_NO_OPERAND);
    }
 
    if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
    {
        /*
         * If the BufferField arguments have not been previously evaluated,
         * evaluate them now and save the results.
         */
        if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
        {
            Status = AcpiDsGetBufferFieldArguments (ObjDesc);
            if (ACPI_FAILURE (Status))
            {
                return_ACPI_STATUS (Status);
            }
        }
    }
    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
        (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO))
    {
        /* General Purpose I/O */
 
        Status = AcpiExWriteGpio (SourceDesc, ObjDesc, ResultDesc);
        return_ACPI_STATUS (Status);
    }
    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
        (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI  ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_PLATFORM_RT ||
         ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_FIXED_HARDWARE))
    {
        /* SMBus, GSBus, IPMI serial */
 
        Status = AcpiExWriteSerialBus (SourceDesc, ObjDesc, ResultDesc);
        return_ACPI_STATUS (Status);
    }
    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
             (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_PLATFORM_COMM))
    {
        /*
         * According to the spec a write to the COMD field will invoke the
         * region handler. Otherwise, write to the PccInternal buffer. This
         * implementation will use the offsets specified rather than the name
         * of the field. This is considered safer because some firmware tools
         * are known to obfiscate named objects.
         */
        DataLength = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
            ObjDesc->Field.BitLength);
        memcpy (ObjDesc->Field.RegionObj->Field.InternalPccBuffer +
            ObjDesc->Field.BaseByteOffset,
            SourceDesc->Buffer.Pointer, DataLength);
 
        if (MASTER_SUBSPACE_COMMAND (ObjDesc->Field.BaseByteOffset))
        {
            /* Perform the write */
 
            ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
                "PCC COMD field has been written. Invoking PCC handler now.\n"));
 
            Status = AcpiExAccessRegion (
                ObjDesc, 0, (UINT64 *) ObjDesc->Field.RegionObj->Field.InternalPccBuffer,
                ACPI_WRITE);
            return_ACPI_STATUS (Status);
        }
        return (AE_OK);
    }
 
 
    /* Get a pointer to the data to be written */
 
    switch (SourceDesc->Common.Type)
    {
    case ACPI_TYPE_INTEGER:
 
        Buffer = &SourceDesc->Integer.Value;
        BufferLength = sizeof (SourceDesc->Integer.Value);
        break;
 
    case ACPI_TYPE_BUFFER:
 
        Buffer = SourceDesc->Buffer.Pointer;
        BufferLength = SourceDesc->Buffer.Length;
        break;
 
    case ACPI_TYPE_STRING:
 
        Buffer = SourceDesc->String.Pointer;
        BufferLength = SourceDesc->String.Length;
        break;
 
    default:
        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
    }
 
    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
        "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
        SourceDesc, AcpiUtGetTypeName (SourceDesc->Common.Type),
        SourceDesc->Common.Type, Buffer, BufferLength));
 
    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
        "FieldWrite [TO]:   Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
        ObjDesc, AcpiUtGetTypeName (ObjDesc->Common.Type),
        ObjDesc->Common.Type,
        ObjDesc->CommonField.BitLength,
        ObjDesc->CommonField.StartFieldBitOffset,
        ObjDesc->CommonField.BaseByteOffset));
 
    /* Lock entire transaction if requested */
 
    AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
 
    /* Write to the field */
 
    Status = AcpiExInsertIntoField (ObjDesc, Buffer, BufferLength);
    AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
    return_ACPI_STATUS (Status);
}

Referenced by AcpiDsExecEndOp(), AcpiDsGetFieldNames(), and AcpiExStoreObjectToNode().

Variable Documentation

AcpiProtocolLengths

const UINT8 AcpiProtocolLengths[]

static

Initial value:

=
{
    ACPI_INVALID_PROTOCOL_ID,   
    ACPI_INVALID_PROTOCOL_ID,   
    0x00,                       
    ACPI_INVALID_PROTOCOL_ID,   
    0x01,                       
    ACPI_INVALID_PROTOCOL_ID,   
    0x01,                       
    ACPI_INVALID_PROTOCOL_ID,   
    0x02,                       
    ACPI_INVALID_PROTOCOL_ID,   
    0xFF,                       
    0xFF,                       
    0x02,                       
    0xFF,                       
    0xFF,                       
    0xFF                        
}

Definition at line 62 of file exfield.c.

Referenced by AcpiExGetProtocolBufferLength().