exconvrt.c File Reference

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

Include dependency graph for exconvrt.c:

Go to the source code of this file.

Macros
#define	_COMPONENT   ACPI_EXECUTER

Functions
static UINT32	AcpiExConvertToAscii (UINT64 Integer, UINT16 Base, UINT8 *String, UINT8 MaxLength)
ACPI_STATUS	AcpiExConvertToInteger (ACPI_OPERAND_OBJECT *ObjDesc, ACPI_OPERAND_OBJECT **ResultDesc, UINT32 ImplicitConversion)
ACPI_STATUS	AcpiExConvertToBuffer (ACPI_OPERAND_OBJECT *ObjDesc, ACPI_OPERAND_OBJECT **ResultDesc)
ACPI_STATUS	AcpiExConvertToString (ACPI_OPERAND_OBJECT *ObjDesc, ACPI_OPERAND_OBJECT **ResultDesc, UINT32 Type)
ACPI_STATUS	AcpiExConvertToTargetType (ACPI_OBJECT_TYPE DestinationType, ACPI_OPERAND_OBJECT *SourceDesc, ACPI_OPERAND_OBJECT **ResultDesc, ACPI_WALK_STATE *WalkState)

Macro Definition Documentation

_COMPONENT

#define _COMPONENT   ACPI_EXECUTER

Definition at line 50 of file exconvrt.c.

Function Documentation

AcpiExConvertToAscii()

static UINT32 AcpiExConvertToAscii ( UINT64  Integer, UINT16  Base, UINT8 *  String, UINT8  MaxLength  )

static

Definition at line 315 of file exconvrt.c.

{
    UINT64                  Digit;
    UINT32                  i;
    UINT32                  j;
    UINT32                  k = 0;
    UINT32                  HexLength;
    UINT32                  DecimalLength;
    UINT32                  Remainder;
    BOOLEAN                 SupressZeros;
 
 
    ACPI_FUNCTION_ENTRY ();
 
 
    switch (Base)
    {
    case 10:
 
        /* Setup max length for the decimal number */
 
        switch (DataWidth)
        {
        case 1:
 
            DecimalLength = ACPI_MAX8_DECIMAL_DIGITS;
            break;
 
        case 4:
 
            DecimalLength = ACPI_MAX32_DECIMAL_DIGITS;
            break;
 
        case 8:
        default:
 
            DecimalLength = ACPI_MAX64_DECIMAL_DIGITS;
            break;
        }
 
        SupressZeros = TRUE;     /* No leading zeros */
        Remainder = 0;
 
        for (i = DecimalLength; i > 0; i--)
        {
            /* Divide by nth factor of 10 */
 
            Digit = Integer;
            for (j = 0; j < i; j++)
            {
                (void) AcpiUtShortDivide (Digit, 10, &Digit, &Remainder);
            }
 
            /* Handle leading zeros */
 
            if (Remainder != 0)
            {
                SupressZeros = FALSE;
            }
 
            if (!SupressZeros)
            {
                String[k] = (UINT8) (ACPI_ASCII_ZERO + Remainder);
                k++;
            }
        }
        break;
 
    case 16:
 
        /* HexLength: 2 ascii hex chars per data byte */
 
        HexLength = (DataWidth * 2);
        for (i = 0, j = (HexLength-1); i < HexLength; i++, j--)
        {
            /* Get one hex digit, most significant digits first */
 
            String[k] = (UINT8)
                AcpiUtHexToAsciiChar (Integer, ACPI_MUL_4 (j));
            k++;
        }
        break;
 
    default:
        return (0);
    }
 
    /*
     * Since leading zeros are suppressed, we must check for the case where
     * the integer equals 0
     *
     * Finally, null terminate the string and return the length
     */
    if (!k)
    {
        String [0] = ACPI_ASCII_ZERO;
        k = 1;
    }
 
    String [k] = 0;
    return ((UINT32) k);
}

Referenced by AcpiExConvertToString().

AcpiExConvertToBuffer()

ACPI_STATUS AcpiExConvertToBuffer	(	ACPI_OPERAND_OBJECT *	ObjDesc,
		ACPI_OPERAND_OBJECT **	ResultDesc
	)

Definition at line 224 of file exconvrt.c.

{
    ACPI_OPERAND_OBJECT     *ReturnDesc;
    UINT8                   *NewBuf;
 
 
    ACPI_FUNCTION_TRACE_PTR (ExConvertToBuffer, ObjDesc);
 
 
    switch (ObjDesc->Common.Type)
    {
    case ACPI_TYPE_BUFFER:
 
        /* No conversion necessary */
 
        *ResultDesc = ObjDesc;
        return_ACPI_STATUS (AE_OK);
 
 
    case ACPI_TYPE_INTEGER:
        /*
         * Create a new Buffer object.
         * Need enough space for one integer
         */
        ReturnDesc = AcpiUtCreateBufferObject (AcpiGbl_IntegerByteWidth);
        if (!ReturnDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }
 
        /* Copy the integer to the buffer, LSB first */
 
        NewBuf = ReturnDesc->Buffer.Pointer;
        memcpy (NewBuf, &ObjDesc->Integer.Value, AcpiGbl_IntegerByteWidth);
        break;
 
    case ACPI_TYPE_STRING:
        /*
         * Create a new Buffer object
         * Size will be the string length
         *
         * NOTE: Add one to the string length to include the null terminator.
         * The ACPI spec is unclear on this subject, but there is existing
         * ASL/AML code that depends on the null being transferred to the new
         * buffer.
         */
        ReturnDesc = AcpiUtCreateBufferObject ((ACPI_SIZE)
            ObjDesc->String.Length + 1);
        if (!ReturnDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }
 
        /* Copy the string to the buffer */
 
        NewBuf = ReturnDesc->Buffer.Pointer;
        strncpy ((char *) NewBuf, (char *) ObjDesc->String.Pointer,
            ObjDesc->String.Length);
        break;
 
    default:
 
        return_ACPI_STATUS (AE_TYPE);
    }
 
    /* Mark buffer initialized */
 
    ReturnDesc->Common.Flags |= AOPOBJ_DATA_VALID;
    *ResultDesc = ReturnDesc;
    return_ACPI_STATUS (AE_OK);
}

Referenced by AcpiExConvertToTargetType(), AcpiExDoConcatenate(), AcpiExDoLogicalOp(), AcpiExOpcode_1A_1T_1R(), AcpiExResolveOperands(), and AcpiNsConvertToBuffer().

AcpiExConvertToInteger()

ACPI_STATUS AcpiExConvertToInteger	(	ACPI_OPERAND_OBJECT *	ObjDesc,
		ACPI_OPERAND_OBJECT **	ResultDesc,
		UINT32	ImplicitConversion
	)

Definition at line 79 of file exconvrt.c.

{
    ACPI_OPERAND_OBJECT     *ReturnDesc;
    UINT8                   *Pointer;
    UINT64                  Result;
    UINT32                  i;
    UINT32                  Count;
 
 
    ACPI_FUNCTION_TRACE_PTR (ExConvertToInteger, ObjDesc);
 
 
    switch (ObjDesc->Common.Type)
    {
    case ACPI_TYPE_INTEGER:
 
        /* No conversion necessary */
 
        *ResultDesc = ObjDesc;
        return_ACPI_STATUS (AE_OK);
 
    case ACPI_TYPE_BUFFER:
    case ACPI_TYPE_STRING:
 
        /* Note: Takes advantage of common buffer/string fields */
 
        Pointer = ObjDesc->Buffer.Pointer;
        Count   = ObjDesc->Buffer.Length;
        break;
 
    default:
 
        return_ACPI_STATUS (AE_TYPE);
    }
 
    /*
     * Convert the buffer/string to an integer. Note that both buffers and
     * strings are treated as raw data - we don't convert ascii to hex for
     * strings.
     *
     * There are two terminating conditions for the loop:
     * 1) The size of an integer has been reached, or
     * 2) The end of the buffer or string has been reached
     */
    Result = 0;
 
    /* String conversion is different than Buffer conversion */
 
    switch (ObjDesc->Common.Type)
    {
    case ACPI_TYPE_STRING:
        /*
         * Convert string to an integer - for most cases, the string must be
         * hexadecimal as per the ACPI specification. The only exception (as
         * of ACPI 3.0) is that the ToInteger() operator allows both decimal
         * and hexadecimal strings (hex prefixed with "0x").
         *
         * Explicit conversion is used only by ToInteger.
         * All other string-to-integer conversions are implicit conversions.
         */
        if (ImplicitConversion)
        {
            Result = AcpiUtImplicitStrtoul64 (ACPI_CAST_PTR (char, Pointer));
        }
        else
        {
            Result = AcpiUtExplicitStrtoul64 (ACPI_CAST_PTR (char, Pointer));
        }
        break;
 
    case ACPI_TYPE_BUFFER:
 
        /* Check for zero-length buffer */
 
        if (!Count)
        {
            return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
        }
 
        /* Transfer no more than an integer's worth of data */
 
        if (Count > AcpiGbl_IntegerByteWidth)
        {
            Count = AcpiGbl_IntegerByteWidth;
        }
 
        /*
         * Convert buffer to an integer - we simply grab enough raw data
         * from the buffer to fill an integer
         */
        for (i = 0; i < Count; i++)
        {
            /*
             * Get next byte and shift it into the Result.
             * Little endian is used, meaning that the first byte of the buffer
             * is the LSB of the integer
             */
            Result |= (((UINT64) Pointer[i]) << (i * 8));
        }
        break;
 
    default:
 
        /* No other types can get here */
 
        break;
    }
 
    /* Create a new integer */
 
    ReturnDesc = AcpiUtCreateIntegerObject (Result);
    if (!ReturnDesc)
    {
        return_ACPI_STATUS (AE_NO_MEMORY);
    }
 
    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
        ACPI_FORMAT_UINT64 (Result)));
 
    /* Save the Result */
 
    (void) AcpiExTruncateFor32bitTable (ReturnDesc);
    *ResultDesc = ReturnDesc;
    return_ACPI_STATUS (AE_OK);
}

Referenced by AcpiDsGetPredicateValue(), AcpiExConvertToTargetType(), AcpiExDoConcatenate(), AcpiExDoLogicalOp(), AcpiExOpcode_1A_1T_1R(), and AcpiExResolveOperands().

AcpiExConvertToString()

ACPI_STATUS AcpiExConvertToString	(	ACPI_OPERAND_OBJECT *	ObjDesc,
		ACPI_OPERAND_OBJECT **	ResultDesc,
		UINT32	Type
	)

Definition at line 440 of file exconvrt.c.

{
    ACPI_OPERAND_OBJECT     *ReturnDesc;
    UINT8                   *NewBuf;
    UINT32                  i;
    UINT32                  StringLength = 0;
    UINT16                  Base = 16;
    UINT8                   Separator = ',';
 
 
    ACPI_FUNCTION_TRACE_PTR (ExConvertToString, ObjDesc);
 
 
    switch (ObjDesc->Common.Type)
    {
    case ACPI_TYPE_STRING:
 
        /* No conversion necessary */
 
        *ResultDesc = ObjDesc;
        return_ACPI_STATUS (AE_OK);
 
    case ACPI_TYPE_INTEGER:
 
        switch (Type)
        {
        case ACPI_EXPLICIT_CONVERT_DECIMAL:
            /*
             * From ToDecimalString, integer source.
             *
             * Make room for the maximum decimal number size
             */
            StringLength = ACPI_MAX_DECIMAL_DIGITS;
            Base = 10;
            break;
 
        default:
 
            /* Two hex string characters for each integer byte */
 
            StringLength = ACPI_MUL_2 (AcpiGbl_IntegerByteWidth);
            break;
        }
 
        /*
         * Create a new String
         * Need enough space for one ASCII integer (plus null terminator)
         */
        ReturnDesc = AcpiUtCreateStringObject ((ACPI_SIZE) StringLength);
        if (!ReturnDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }
 
        NewBuf = ReturnDesc->Buffer.Pointer;
 
        /* Convert integer to string */
 
        StringLength = AcpiExConvertToAscii (
            ObjDesc->Integer.Value, Base, NewBuf, AcpiGbl_IntegerByteWidth);
 
        /* Null terminate at the correct place */
 
        ReturnDesc->String.Length = StringLength;
        NewBuf [StringLength] = 0;
        break;
 
    case ACPI_TYPE_BUFFER:
 
        /* Setup string length, base, and separator */
 
        switch (Type)
        {
        case ACPI_EXPLICIT_CONVERT_DECIMAL: /* Used by ToDecimalString */
            /*
             * Explicit conversion from the ToDecimalString ASL operator.
             *
             * From ACPI: "If the input is a buffer, it is converted to a
             * a string of decimal values separated by commas."
             */
            Base = 10;
 
            /*
             * Calculate the final string length. Individual string values
             * are variable length (include separator for each)
             */
            for (i = 0; i < ObjDesc->Buffer.Length; i++)
            {
                if (ObjDesc->Buffer.Pointer[i] >= 100)
                {
                    StringLength += 4;
                }
                else if (ObjDesc->Buffer.Pointer[i] >= 10)
                {
                    StringLength += 3;
                }
                else
                {
                    StringLength += 2;
                }
            }
            break;
 
        case ACPI_IMPLICIT_CONVERT_HEX:
            /*
             * Implicit buffer-to-string conversion
             *
             * From the ACPI spec:
             * "The entire contents of the buffer are converted to a string of
             * two-character hexadecimal numbers, each separated by a space."
             *
             * Each hex number is prefixed with 0x (11/2018)
             */
            Separator = ' ';
            StringLength = (ObjDesc->Buffer.Length * 5);
            break;
 
        case ACPI_EXPLICIT_CONVERT_HEX:
            /*
             * Explicit conversion from the ToHexString ASL operator.
             *
             * From ACPI: "If Data is a buffer, it is converted to a string of
             * hexadecimal values separated by commas."
             *
             * Each hex number is prefixed with 0x (11/2018)
             */
            Separator = ',';
            StringLength = (ObjDesc->Buffer.Length * 5);
            break;
 
        default:
            return_ACPI_STATUS (AE_BAD_PARAMETER);
        }
 
        /*
         * Create a new string object and string buffer
         * (-1 because of extra separator included in StringLength from above)
         * Allow creation of zero-length strings from zero-length buffers.
         */
        if (StringLength)
        {
            StringLength--;
        }
 
        ReturnDesc = AcpiUtCreateStringObject ((ACPI_SIZE) StringLength);
        if (!ReturnDesc)
        {
            return_ACPI_STATUS (AE_NO_MEMORY);
        }
 
        NewBuf = ReturnDesc->Buffer.Pointer;
 
        /*
         * Convert buffer bytes to hex or decimal values
         * (separated by commas or spaces)
         */
        for (i = 0; i < ObjDesc->Buffer.Length; i++)
        {
            if (Base == 16)
            {
                /* Emit 0x prefix for explicit/implicit hex conversion */
 
                *NewBuf++ = '0';
                *NewBuf++ = 'x';
            }
 
            NewBuf += AcpiExConvertToAscii (
                (UINT64) ObjDesc->Buffer.Pointer[i], Base, NewBuf, 1);
 
            /* Each digit is separated by either a comma or space */
 
            *NewBuf++ = Separator;
        }
 
        /*
         * Null terminate the string
         * (overwrites final comma/space from above)
         */
        if (ObjDesc->Buffer.Length)
        {
            NewBuf--;
        }
        *NewBuf = 0;
        break;
 
    default:
 
        return_ACPI_STATUS (AE_TYPE);
    }
 
    *ResultDesc = ReturnDesc;
    return_ACPI_STATUS (AE_OK);
}

Referenced by AcpiExConvertToTargetType(), AcpiExDoConcatenate(), AcpiExDoLogicalOp(), AcpiExOpcode_1A_1T_1R(), AcpiExResolveOperands(), and AcpiNsConvertToString().

AcpiExConvertToTargetType()

ACPI_STATUS AcpiExConvertToTargetType	(	ACPI_OBJECT_TYPE	DestinationType,
		ACPI_OPERAND_OBJECT *	SourceDesc,
		ACPI_OPERAND_OBJECT **	ResultDesc,
		ACPI_WALK_STATE *	WalkState
	)

Definition at line 654 of file exconvrt.c.

{
    ACPI_STATUS             Status = AE_OK;
 
 
    ACPI_FUNCTION_TRACE (ExConvertToTargetType);
 
 
    /* Default behavior */
 
    *ResultDesc = SourceDesc;
 
    /*
     * If required by the target,
     * perform implicit conversion on the source before we store it.
     */
    switch (GET_CURRENT_ARG_TYPE (WalkState->OpInfo->RuntimeArgs))
    {
    case ARGI_SIMPLE_TARGET:
    case ARGI_FIXED_TARGET:
    case ARGI_INTEGER_REF:      /* Handles Increment, Decrement cases */
 
        switch (DestinationType)
        {
        case ACPI_TYPE_LOCAL_REGION_FIELD:
            /*
             * Named field can always handle conversions
             */
            break;
 
        default:
 
            /* No conversion allowed for these types */
 
            if (DestinationType != SourceDesc->Common.Type)
            {
                ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
                    "Explicit operator, will store (%s) over existing type (%s)\n",
                    AcpiUtGetObjectTypeName (SourceDesc),
                    AcpiUtGetTypeName (DestinationType)));
                Status = AE_TYPE;
            }
        }
        break;
 
    case ARGI_TARGETREF:
    case ARGI_STORE_TARGET:
 
        switch (DestinationType)
        {
        case ACPI_TYPE_INTEGER:
        case ACPI_TYPE_BUFFER_FIELD:
        case ACPI_TYPE_LOCAL_BANK_FIELD:
        case ACPI_TYPE_LOCAL_INDEX_FIELD:
            /*
             * These types require an Integer operand. We can convert
             * a Buffer or a String to an Integer if necessary.
             */
            Status = AcpiExConvertToInteger (SourceDesc, ResultDesc,
                ACPI_IMPLICIT_CONVERSION);
            break;
 
        case ACPI_TYPE_STRING:
            /*
             * The operand must be a String. We can convert an
             * Integer or Buffer if necessary
             */
            Status = AcpiExConvertToString (SourceDesc, ResultDesc,
                ACPI_IMPLICIT_CONVERT_HEX);
            break;
 
        case ACPI_TYPE_BUFFER:
            /*
             * The operand must be a Buffer. We can convert an
             * Integer or String if necessary
             */
            Status = AcpiExConvertToBuffer (SourceDesc, ResultDesc);
            break;
 
        default:
 
            ACPI_ERROR ((AE_INFO,
                "Bad destination type during conversion: 0x%X",
                DestinationType));
            Status = AE_AML_INTERNAL;
            break;
        }
        break;
 
    case ARGI_REFERENCE:
        /*
         * CreateXxxxField cases - we are storing the field object into the name
         */
        break;
 
    default:
 
        ACPI_ERROR ((AE_INFO,
            "Unknown Target type ID 0x%X AmlOpcode 0x%X DestType %s",
            GET_CURRENT_ARG_TYPE (WalkState->OpInfo->RuntimeArgs),
            WalkState->Opcode, AcpiUtGetTypeName (DestinationType)));
        Status = AE_AML_INTERNAL;
    }
 
    /*
     * Source-to-Target conversion semantics:
     *
     * If conversion to the target type cannot be performed, then simply
     * overwrite the target with the new object and type.
     */
    if (Status == AE_TYPE)
    {
        Status = AE_OK;
    }
 
    return_ACPI_STATUS (Status);
}

Referenced by AcpiExStoreObjectToObject().