utresrc.c File Reference

#include "acpi.h"
#include "accommon.h"
#include "acresrc.h"

Include dependency graph for utresrc.c:

Go to the source code of this file.

Macros
#define	_COMPONENT   ACPI_UTILITIES

Functions
ACPI_STATUS	AcpiUtWalkAmlResources (ACPI_WALK_STATE *WalkState, UINT8 *Aml, ACPI_SIZE AmlLength, ACPI_WALK_AML_CALLBACK UserFunction, void **Context)
ACPI_STATUS	AcpiUtValidateResource (ACPI_WALK_STATE *WalkState, void *Aml, UINT8 *ReturnIndex)
UINT8	AcpiUtGetResourceType (void *Aml)
UINT16	AcpiUtGetResourceLength (void *Aml)
UINT8	AcpiUtGetResourceHeaderLength (void *Aml)
UINT32	AcpiUtGetDescriptorLength (void *Aml)
ACPI_STATUS	AcpiUtGetResourceEndTag (ACPI_OPERAND_OBJECT *ObjDesc, UINT8 **EndTag)

Variables
const UINT8	AcpiGbl_ResourceAmlSizes []
const UINT8	AcpiGbl_ResourceAmlSerialBusSizes []
static const UINT8	AcpiGbl_ResourceTypes []

Macro Definition Documentation

_COMPONENT

#define _COMPONENT   ACPI_UTILITIES

Definition at line 49 of file utresrc.c.

Function Documentation

AcpiUtGetDescriptorLength()

UINT32 AcpiUtGetDescriptorLength

(

void *

Aml

)

Definition at line 606 of file utresrc.c.

{
    ACPI_FUNCTION_ENTRY ();
 
 
    /*
     * Get the Resource Length (does not include header length) and add
     * the header length (depends on if this is a small or large resource)
     */
    return (AcpiUtGetResourceLength (Aml) +
        AcpiUtGetResourceHeaderLength (Aml));
}

Referenced by AcpiRsConvertResourcesToAml(), AcpiRsGetListLength(), and AcpiUtWalkAmlResources().

AcpiUtGetResourceEndTag()

ACPI_STATUS AcpiUtGetResourceEndTag	(	ACPI_OPERAND_OBJECT *	ObjDesc,
		UINT8 **	EndTag
	)

Definition at line 636 of file utresrc.c.

{
    ACPI_STATUS             Status;
 
 
    ACPI_FUNCTION_TRACE (UtGetResourceEndTag);
 
 
    /* Allow a buffer length of zero */
 
    if (!ObjDesc->Buffer.Length)
    {
        *EndTag = ObjDesc->Buffer.Pointer;
        return_ACPI_STATUS (AE_OK);
    }
 
    /* Validate the template and get a pointer to the EndTag */
 
    Status = AcpiUtWalkAmlResources (NULL, ObjDesc->Buffer.Pointer,
        ObjDesc->Buffer.Length, NULL, (void **) EndTag);
 
    return_ACPI_STATUS (Status);
}

Referenced by AcpiExConcatTemplate().

AcpiUtGetResourceHeaderLength()

UINT8 AcpiUtGetResourceHeaderLength

(

void *

Aml

)

Definition at line 572 of file utresrc.c.

{
    ACPI_FUNCTION_ENTRY ();
 
 
    /* Examine the large/small bit in the resource header */
 
    if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
    {
        return (sizeof (AML_RESOURCE_LARGE_HEADER));
    }
    else
    {
        return (sizeof (AML_RESOURCE_SMALL_HEADER));
    }
}

Referenced by AcpiRsGetListLength(), AcpiRsSetResourceLength(), and AcpiUtGetDescriptorLength().

AcpiUtGetResourceLength()

UINT16 AcpiUtGetResourceLength

(

void *

Aml

)

Definition at line 527 of file utresrc.c.

{
    ACPI_RS_LENGTH          ResourceLength;
 
 
    ACPI_FUNCTION_ENTRY ();
 
 
    /*
     * Byte 0 contains the descriptor name (Resource Type)
     * Examine the large/small bit in the resource header
     */
    if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
    {
        /* Large Resource type -- bytes 1-2 contain the 16-bit length */
 
        ACPI_MOVE_16_TO_16 (&ResourceLength, ACPI_ADD_PTR (UINT8, Aml, 1));
 
    }
    else
    {
        /* Small Resource type -- bits 2:0 of byte 0 contain the length */
 
        ResourceLength = (UINT16) (ACPI_GET8 (Aml) &
            ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK);
    }
 
    return (ResourceLength);
}

Referenced by AcpiRsConvertAmlToResource(), AcpiRsGetListLength(), AcpiUtGetDescriptorLength(), and AcpiUtValidateResource().

AcpiUtGetResourceType()

UINT8 AcpiUtGetResourceType

(

void *

Aml

)

Definition at line 487 of file utresrc.c.

{
    ACPI_FUNCTION_ENTRY ();
 
 
    /*
     * Byte 0 contains the descriptor name (Resource Type)
     * Examine the large/small bit in the resource header
     */
    if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
    {
        /* Large Resource Type -- bits 6:0 contain the name */
 
        return (ACPI_GET8 (Aml));
    }
    else
    {
        /* Small Resource Type -- bits 6:3 contain the name */
 
        return ((UINT8) (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_SMALL_MASK));
    }
}

Referenced by AcpiRsConvertAmlToResources(), AcpiRsGetListLength(), and AcpiUtWalkAmlResources().

AcpiUtValidateResource()

ACPI_STATUS AcpiUtValidateResource	(	ACPI_WALK_STATE *	WalkState,
		void *	Aml,
		UINT8 *	ReturnIndex
	)

Definition at line 314 of file utresrc.c.

{
    AML_RESOURCE            *AmlResource;
    UINT8                   ResourceType;
    UINT8                   ResourceIndex;
    ACPI_RS_LENGTH          ResourceLength;
    ACPI_RS_LENGTH          MinimumResourceLength;
 
 
    ACPI_FUNCTION_ENTRY ();
 
 
    /*
     * 1) Validate the ResourceType field (Byte 0)
     */
    ResourceType = ACPI_GET8 (Aml);
 
    /*
     * Byte 0 contains the descriptor name (Resource Type)
     * Examine the large/small bit in the resource header
     */
    if (ResourceType & ACPI_RESOURCE_NAME_LARGE)
    {
        /* Verify the large resource type (name) against the max */
 
        if (ResourceType > ACPI_RESOURCE_NAME_LARGE_MAX)
        {
            goto InvalidResource;
        }
 
        /*
         * Large Resource Type -- bits 6:0 contain the name
         * Translate range 0x80-0x8B to index range 0x10-0x1B
         */
        ResourceIndex = (UINT8) (ResourceType - 0x70);
    }
    else
    {
        /*
         * Small Resource Type -- bits 6:3 contain the name
         * Shift range to index range 0x00-0x0F
         */
        ResourceIndex = (UINT8)
            ((ResourceType & ACPI_RESOURCE_NAME_SMALL_MASK) >> 3);
    }
 
    /*
     * Check validity of the resource type, via AcpiGbl_ResourceTypes.
     * Zero indicates an invalid resource.
     */
    if (!AcpiGbl_ResourceTypes[ResourceIndex])
    {
        goto InvalidResource;
    }
 
    /*
     * Validate the ResourceLength field. This ensures that the length
     * is at least reasonable, and guarantees that it is non-zero.
     */
    ResourceLength = AcpiUtGetResourceLength (Aml);
    MinimumResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex];
 
    /* Validate based upon the type of resource - fixed length or variable */
 
    switch (AcpiGbl_ResourceTypes[ResourceIndex])
    {
    case ACPI_FIXED_LENGTH:
 
        /* Fixed length resource, length must match exactly */
 
        if (ResourceLength != MinimumResourceLength)
        {
            goto BadResourceLength;
        }
        break;
 
    case ACPI_VARIABLE_LENGTH:
 
        /* Variable length resource, length must be at least the minimum */
 
        if (ResourceLength < MinimumResourceLength)
        {
            goto BadResourceLength;
        }
        break;
 
    case ACPI_SMALL_VARIABLE_LENGTH:
 
        /* Small variable length resource, length can be (Min) or (Min-1) */
 
        if ((ResourceLength > MinimumResourceLength) ||
            (ResourceLength < (MinimumResourceLength - 1)))
        {
            goto BadResourceLength;
        }
        break;
 
    default:
 
        /* Shouldn't happen (because of validation earlier), but be sure */
 
        goto InvalidResource;
    }
 
    AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml);
    if (ResourceType == ACPI_RESOURCE_NAME_SERIAL_BUS)
    {
        /* Validate the BusType field */
 
        if ((AmlResource->CommonSerialBus.Type == 0) ||
            (AmlResource->CommonSerialBus.Type > AML_RESOURCE_MAX_SERIALBUSTYPE))
        {
            if (WalkState)
            {
                ACPI_ERROR ((AE_INFO,
                    "Invalid/unsupported SerialBus resource descriptor: BusType 0x%2.2X",
                    AmlResource->CommonSerialBus.Type));
            }
            return (AE_AML_INVALID_RESOURCE_TYPE);
        }
    }
 
    /* Optionally return the resource table index */
 
    if (ReturnIndex)
    {
        *ReturnIndex = ResourceIndex;
    }
 
    return (AE_OK);
 
 
InvalidResource:
 
    if (WalkState)
    {
        ACPI_ERROR ((AE_INFO,
            "Invalid/unsupported resource descriptor: Type 0x%2.2X",
            ResourceType));
    }
    return (AE_AML_INVALID_RESOURCE_TYPE);
 
BadResourceLength:
 
    if (WalkState)
    {
        ACPI_ERROR ((AE_INFO,
            "Invalid resource descriptor length: Type "
            "0x%2.2X, Length 0x%4.4X, MinLength 0x%4.4X",
            ResourceType, ResourceLength, MinimumResourceLength));
    }
    return (AE_AML_BAD_RESOURCE_LENGTH);
}

Referenced by AcpiRsConvertResourcesToAml(), AcpiRsGetListLength(), and AcpiUtWalkAmlResources().

AcpiUtWalkAmlResources()

ACPI_STATUS AcpiUtWalkAmlResources	(	ACPI_WALK_STATE *	WalkState,
		UINT8 *	Aml,
		ACPI_SIZE	AmlLength,
		ACPI_WALK_AML_CALLBACK	UserFunction,
		void **	Context
	)

Definition at line 181 of file utresrc.c.

{
    ACPI_STATUS             Status;
    UINT8                   *EndAml;
    UINT8                   ResourceIndex;
    UINT32                  Length;
    UINT32                  Offset = 0;
    UINT8                   EndTag[2] = {0x79, 0x00};
 
 
    ACPI_FUNCTION_TRACE (UtWalkAmlResources);
 
 
    /* The absolute minimum resource template is one EndTag descriptor */
 
    if (AmlLength < sizeof (AML_RESOURCE_END_TAG))
    {
        return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
    }
 
    /* Point to the end of the resource template buffer */
 
    EndAml = Aml + AmlLength;
 
    /* Walk the byte list, abort on any invalid descriptor type or length */
 
    while (Aml < EndAml)
    {
        /* Validate the Resource Type and Resource Length */
 
        Status = AcpiUtValidateResource (WalkState, Aml, &ResourceIndex);
        if (ACPI_FAILURE (Status))
        {
            /*
             * Exit on failure. Cannot continue because the descriptor
             * length may be bogus also.
             */
            return_ACPI_STATUS (Status);
        }
 
        /* Get the length of this descriptor */
 
        Length = AcpiUtGetDescriptorLength (Aml);
 
        /* Invoke the user function */
 
        if (UserFunction)
        {
            Status = UserFunction (
                Aml, Length, Offset, ResourceIndex, Context);
            if (ACPI_FAILURE (Status))
            {
                return_ACPI_STATUS (Status);
            }
        }
 
        /* An EndTag descriptor terminates this resource template */
 
        if (AcpiUtGetResourceType (Aml) == ACPI_RESOURCE_NAME_END_TAG)
        {
            /*
             * There must be at least one more byte in the buffer for
             * the 2nd byte of the EndTag
             */
            if ((Aml + 1) >= EndAml)
            {
                return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
            }
 
            /*
             * Don't attempt to perform any validation on the 2nd byte.
             * Although all known ASL compilers insert a zero for the 2nd
             * byte, it can also be a checksum (as per the ACPI spec),
             * and this is occasionally seen in the field. July 2017.
             */
 
            /* Return the pointer to the EndTag if requested */
 
            if (!UserFunction)
            {
                *Context = Aml;
            }
 
            /* Normal exit */
 
            return_ACPI_STATUS (AE_OK);
        }
 
        Aml += Length;
        Offset += Length;
    }
 
    /* Did not find an EndTag descriptor */
 
    if (UserFunction)
    {
        /* Insert an EndTag anyway. AcpiRsGetListLength always leaves room */
 
        (void) AcpiUtValidateResource (WalkState, EndTag, &ResourceIndex);
        Status = UserFunction (EndTag, 2, Offset, ResourceIndex, Context);
        if (ACPI_FAILURE (Status))
        {
            return_ACPI_STATUS (Status);
        }
    }
 
    return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
}

Referenced by AcpiBufferToResource(), AcpiRsCreateResourceList(), and AcpiUtGetResourceEndTag().

Variable Documentation

AcpiGbl_ResourceAmlSerialBusSizes

const UINT8 AcpiGbl_ResourceAmlSerialBusSizes[]

Initial value:

=
{
    0,
    ACPI_AML_SIZE_LARGE (AML_RESOURCE_I2C_SERIALBUS),
    ACPI_AML_SIZE_LARGE (AML_RESOURCE_SPI_SERIALBUS),
    ACPI_AML_SIZE_LARGE (AML_RESOURCE_UART_SERIALBUS),
    ACPI_AML_SIZE_LARGE (AML_RESOURCE_CSI2_SERIALBUS),
}

Definition at line 101 of file utresrc.c.

Referenced by AcpiRsGetListLength().

AcpiGbl_ResourceAmlSizes

const UINT8 AcpiGbl_ResourceAmlSizes[]

Definition at line 57 of file utresrc.c.

Referenced by AcpiRsGetListLength(), and AcpiUtValidateResource().

AcpiGbl_ResourceTypes

const UINT8 AcpiGbl_ResourceTypes[]

static

Definition at line 117 of file utresrc.c.

Referenced by AcpiUtValidateResource().