tbfadt.c File Reference

#include "acpi.h"
#include "accommon.h"
#include "actables.h"

Include dependency graph for tbfadt.c:

Go to the source code of this file.

Classes
struct	acpi_fadt_info
struct	acpi_fadt_pm_info

Macros
#define	_COMPONENT   ACPI_TABLES
#define	ACPI_FADT_OPTIONAL   0
#define	ACPI_FADT_REQUIRED   1
#define	ACPI_FADT_SEPARATE_LENGTH   2
#define	ACPI_FADT_GPE_REGISTER   4
#define	ACPI_FADT_INFO_ENTRIES    (sizeof (FadtInfoTable) / sizeof (ACPI_FADT_INFO))
#define	ACPI_FADT_PM_INFO_ENTRIES    (sizeof (FadtPmInfoTable) / sizeof (ACPI_FADT_PM_INFO))

Typedefs
typedef struct acpi_fadt_info	ACPI_FADT_INFO
typedef struct acpi_fadt_pm_info	ACPI_FADT_PM_INFO

Functions
static void	AcpiTbInitGenericAddress (ACPI_GENERIC_ADDRESS *GenericAddress, UINT8 SpaceId, UINT8 ByteWidth, UINT64 Address, const char *RegisterName, UINT8 Flags)
static void	AcpiTbConvertFadt (void)
static void	AcpiTbSetupFadtRegisters (void)
static UINT64	AcpiTbSelectAddress (char *RegisterName, UINT32 Address32, UINT64 Address64)
void	AcpiTbParseFadt (void)
void	AcpiTbCreateLocalFadt (ACPI_TABLE_HEADER *Table, UINT32 Length)

Variables
static ACPI_FADT_INFO	FadtInfoTable []
static ACPI_FADT_PM_INFO	FadtPmInfoTable []

Macro Definition Documentation

_COMPONENT

#define _COMPONENT   ACPI_TABLES

Definition at line 48 of file tbfadt.c.

ACPI_FADT_GPE_REGISTER

#define ACPI_FADT_GPE_REGISTER   4

Definition at line 93 of file tbfadt.c.

ACPI_FADT_INFO_ENTRIES

#define ACPI_FADT_INFO_ENTRIES    (sizeof (FadtInfoTable) / sizeof (ACPI_FADT_INFO))

Definition at line 154 of file tbfadt.c.

ACPI_FADT_OPTIONAL

#define ACPI_FADT_OPTIONAL   0

Definition at line 90 of file tbfadt.c.

ACPI_FADT_PM_INFO_ENTRIES

#define ACPI_FADT_PM_INFO_ENTRIES    (sizeof (FadtPmInfoTable) / sizeof (ACPI_FADT_PM_INFO))

Definition at line 187 of file tbfadt.c.

ACPI_FADT_REQUIRED

#define ACPI_FADT_REQUIRED   1

Definition at line 91 of file tbfadt.c.

ACPI_FADT_SEPARATE_LENGTH

#define ACPI_FADT_SEPARATE_LENGTH   2

Definition at line 92 of file tbfadt.c.

Typedef Documentation

ACPI_FADT_INFO

typedef struct acpi_fadt_info ACPI_FADT_INFO

ACPI_FADT_PM_INFO

typedef struct acpi_fadt_pm_info ACPI_FADT_PM_INFO

Function Documentation

AcpiTbConvertFadt()

static void AcpiTbConvertFadt ( void  )

static

Definition at line 514 of file tbfadt.c.

{
    const char              *Name;
    ACPI_GENERIC_ADDRESS    *Address64;
    UINT32                  Address32;
    UINT8                   Length;
    UINT8                   Flags;
    UINT32                  i;
 
 
    /*
     * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
     * should be zero are indeed zero. This will workaround BIOSs that
     * inadvertently place values in these fields.
     *
     * The ACPI 1.0 reserved fields that will be zeroed are the bytes located
     * at offset 45, 55, 95, and the word located at offset 109, 110.
     *
     * Note: The FADT revision value is unreliable. Only the length can be
     * trusted.
     */
    if (AcpiGbl_FADT.Header.Length <= ACPI_FADT_V2_SIZE)
    {
        AcpiGbl_FADT.PreferredProfile = 0;
        AcpiGbl_FADT.PstateControl = 0;
        AcpiGbl_FADT.CstControl = 0;
        AcpiGbl_FADT.BootFlags = 0;
    }
 
    /*
     * Now we can update the local FADT length to the length of the
     * current FADT version as defined by the ACPI specification.
     * Thus, we will have a common FADT internally.
     */
    AcpiGbl_FADT.Header.Length = sizeof (ACPI_TABLE_FADT);
 
    /*
     * Expand the 32-bit DSDT addresses to 64-bit as necessary.
     * Later ACPICA code will always use the X 64-bit field.
     */
    AcpiGbl_FADT.XDsdt = AcpiTbSelectAddress ("DSDT",
        AcpiGbl_FADT.Dsdt, AcpiGbl_FADT.XDsdt);
 
    /* If Hardware Reduced flag is set, we are all done */
 
    if (AcpiGbl_ReducedHardware)
    {
        return;
    }
 
    /* Examine all of the 64-bit extended address fields (X fields) */
 
    for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++)
    {
        /*
         * Get the 32-bit and 64-bit addresses, as well as the register
         * length and register name.
         */
        Address32 = *ACPI_ADD_PTR (UINT32,
            &AcpiGbl_FADT, FadtInfoTable[i].Address32);
 
        Address64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS,
            &AcpiGbl_FADT, FadtInfoTable[i].Address64);
 
        Length = *ACPI_ADD_PTR (UINT8,
            &AcpiGbl_FADT, FadtInfoTable[i].Length);
 
        Name = FadtInfoTable[i].Name;
        Flags = FadtInfoTable[i].Flags;
 
        /*
         * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
         * generic address structures as necessary. Later code will always use
         * the 64-bit address structures.
         *
         * November 2013:
         * Now always use the 64-bit address if it is valid (non-zero), in
         * accordance with the ACPI specification which states that a 64-bit
         * address supersedes the 32-bit version. This behavior can be
         * overridden by the AcpiGbl_Use32BitFadtAddresses flag.
         *
         * During 64-bit address construction and verification,
         * these cases are handled:
         *
         * Address32 zero, Address64 [don't care]   - Use Address64
         *
         * No override: if AcpiGbl_Use32BitFadtAddresses is FALSE, and:
         * Address32 non-zero, Address64 zero       - Copy/use Address32
         * Address32 non-zero == Address64 non-zero - Use Address64
         * Address32 non-zero != Address64 non-zero - Warning, use Address64
         *
         * Override: if AcpiGbl_Use32BitFadtAddresses is TRUE, and:
         * Address32 non-zero, Address64 zero       - Copy/use Address32
         * Address32 non-zero == Address64 non-zero - Copy/use Address32
         * Address32 non-zero != Address64 non-zero - Warning, copy/use Address32
         *
         * Note: SpaceId is always I/O for 32-bit legacy address fields
         */
        if (Address32)
        {
            if (Address64->Address)
            {
                if (Address64->Address != (UINT64) Address32)
                {
                    /* Address mismatch */
 
                    ACPI_BIOS_WARNING ((AE_INFO,
                        "32/64X address mismatch in FADT/%s: "
                        "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
                        Name, Address32,
                        ACPI_FORMAT_UINT64 (Address64->Address),
                        AcpiGbl_Use32BitFadtAddresses ? 32 : 64));
                }
 
                /*
                 * For each extended field, check for length mismatch
                 * between the legacy length field and the corresponding
                 * 64-bit X length field.
                 * Note: If the legacy length field is > 0xFF bits, ignore
                 * this check. (GPE registers can be larger than the
                 * 64-bit GAS structure can accommodate, 0xFF bits).
                 */
                if ((ACPI_MUL_8 (Length) <= ACPI_UINT8_MAX) &&
                    (Address64->BitWidth != ACPI_MUL_8 (Length)))
                {
                    ACPI_BIOS_WARNING ((AE_INFO,
                        "32/64X length mismatch in FADT/%s: %u/%u",
                        Name, ACPI_MUL_8 (Length), Address64->BitWidth));
                }
            }
 
            /*
             * Hardware register access code always uses the 64-bit fields.
             * So if the 64-bit field is zero or is to be overridden,
             * initialize it with the 32-bit fields.
             * Note that when the 32-bit address favor is specified, the
             * 64-bit fields are always re-initialized so that
             * AccessSize/BitWidth/BitOffset fields can be correctly
             * configured to the values to trigger a 32-bit compatible
             * access mode in the hardware register access code.
             */
            if (!Address64->Address || AcpiGbl_Use32BitFadtAddresses)
            {
                AcpiTbInitGenericAddress (Address64,
                    ACPI_ADR_SPACE_SYSTEM_IO, Length,
                    (UINT64) Address32, Name, Flags);
            }
        }
 
        if (FadtInfoTable[i].Flags & ACPI_FADT_REQUIRED)
        {
            /*
             * Field is required (PM1aEvent, PM1aControl).
             * Both the address and length must be non-zero.
             */
            if (!Address64->Address || !Length)
            {
                ACPI_BIOS_ERROR ((AE_INFO,
                    "Required FADT field %s has zero address and/or length: "
                    "0x%8.8X%8.8X/0x%X",
                    Name, ACPI_FORMAT_UINT64 (Address64->Address), Length));
            }
        }
        else if (FadtInfoTable[i].Flags & ACPI_FADT_SEPARATE_LENGTH)
        {
            /*
             * Field is optional (PM2Control, GPE0, GPE1) AND has its own
             * length field. If present, both the address and length must
             * be valid.
             */
            if ((Address64->Address && !Length) ||
                (!Address64->Address && Length))
            {
                ACPI_BIOS_WARNING ((AE_INFO,
                    "Optional FADT field %s has valid %s but zero %s: "
                    "0x%8.8X%8.8X/0x%X", Name,
                    (Length ? "Length" : "Address"),
                    (Length ? "Address": "Length"),
                    ACPI_FORMAT_UINT64 (Address64->Address), Length));
            }
        }
    }
}

Referenced by AcpiTbCreateLocalFadt().

AcpiTbCreateLocalFadt()

void AcpiTbCreateLocalFadt	(	ACPI_TABLE_HEADER *	Table,
		UINT32	Length
	)

Definition at line 423 of file tbfadt.c.

{
 
    /*
     * Check if the FADT is larger than the largest table that we expect
     * (typically the current ACPI specification version). If so, truncate
     * the table, and issue a warning.
     */
    if (Length > sizeof (ACPI_TABLE_FADT))
    {
        ACPI_BIOS_WARNING ((AE_INFO,
            "FADT (revision %u) is longer than %s length, "
            "truncating length %u to %u",
            Table->Revision, ACPI_FADT_CONFORMANCE, Length,
            (UINT32) sizeof (ACPI_TABLE_FADT)));
    }
 
    /* Clear the entire local FADT */
 
    memset (&AcpiGbl_FADT, 0, sizeof (ACPI_TABLE_FADT));
 
    /* Copy the original FADT, up to sizeof (ACPI_TABLE_FADT) */
 
    memcpy (&AcpiGbl_FADT, Table,
        ACPI_MIN (Length, sizeof (ACPI_TABLE_FADT)));
 
    /* Take a copy of the Hardware Reduced flag */
 
    AcpiGbl_ReducedHardware = FALSE;
    if (AcpiGbl_FADT.Flags & ACPI_FADT_HW_REDUCED)
    {
        AcpiGbl_ReducedHardware = TRUE;
    }
 
    /* Convert the local copy of the FADT to the common internal format */
 
    AcpiTbConvertFadt ();
 
    /* Initialize the global ACPI register structures */
 
    AcpiTbSetupFadtRegisters ();
}

Referenced by AcpiTbParseFadt().

AcpiTbInitGenericAddress()

static void AcpiTbInitGenericAddress ( ACPI_GENERIC_ADDRESS *  GenericAddress, UINT8  SpaceId, UINT8  ByteWidth, UINT64  Address, const char *  RegisterName, UINT8  Flags  )

static

Definition at line 210 of file tbfadt.c.

{
    UINT8                   BitWidth;
 
 
    /*
     * Bit width field in the GAS is only one byte long, 255 max.
     * Check for BitWidth overflow in GAS.
     */
    BitWidth = (UINT8) (ByteWidth * 8);
    if (ByteWidth > 31)     /* (31*8)=248, (32*8)=256 */
    {
        /*
         * No error for GPE blocks, because we do not use the BitWidth
         * for GPEs, the legacy length (ByteWidth) is used instead to
         * allow for a large number of GPEs.
         */
        if (!(Flags & ACPI_FADT_GPE_REGISTER))
        {
            ACPI_ERROR ((AE_INFO,
                "%s - 32-bit FADT register is too long (%u bytes, %u bits) "
                "to convert to GAS struct - 255 bits max, truncating",
                RegisterName, ByteWidth, (ByteWidth * 8)));
        }
 
        BitWidth = 255;
    }
 
    /*
     * The 64-bit Address field is non-aligned in the byte packed
     * GAS struct.
     */
    ACPI_MOVE_64_TO_64 (&GenericAddress->Address, &Address);
 
    /* All other fields are byte-wide */
 
    GenericAddress->SpaceId = SpaceId;
    GenericAddress->BitWidth = BitWidth;
    GenericAddress->BitOffset = 0;
    GenericAddress->AccessWidth = 0; /* Access width ANY */
}

Referenced by AcpiTbConvertFadt(), and AcpiTbSetupFadtRegisters().

AcpiTbParseFadt()

void AcpiTbParseFadt

(

void

)

Definition at line 339 of file tbfadt.c.

{
    UINT32                  Length;
    ACPI_TABLE_HEADER       *Table;
    ACPI_TABLE_DESC         *FadtDesc;
    ACPI_STATUS             Status;
 
 
    /*
     * The FADT has multiple versions with different lengths,
     * and it contains pointers to both the DSDT and FACS tables.
     *
     * Get a local copy of the FADT and convert it to a common format
     * Map entire FADT, assumed to be smaller than one page.
     */
    FadtDesc = &AcpiGbl_RootTableList.Tables[AcpiGbl_FadtIndex];
    Status = AcpiTbGetTable (FadtDesc, &Table);
    if (ACPI_FAILURE (Status))
    {
        return;
    }
    Length = FadtDesc->Length;
 
    /*
     * Validate the FADT checksum before we copy the table. Ignore
     * checksum error as we want to try to get the DSDT and FACS.
     */
    (void) AcpiUtVerifyChecksum (Table, Length);
 
    /* Create a local copy of the FADT in common ACPI 2.0+ format */
 
    AcpiTbCreateLocalFadt (Table, Length);
 
    /* All done with the real FADT, unmap it */
 
    AcpiTbPutTable (FadtDesc);
 
    /* Obtain the DSDT and FACS tables via their addresses within the FADT */
 
    AcpiTbInstallStandardTable (
        (ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.XDsdt,
        ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL, FALSE, TRUE,
        &AcpiGbl_DsdtIndex);
 
    /* If Hardware Reduced flag is set, there is no FACS */
 
    if (!AcpiGbl_ReducedHardware)
    {
        if (AcpiGbl_FADT.Facs)
        {
            AcpiTbInstallStandardTable (
                (ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.Facs,
                ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL, FALSE, TRUE,
                &AcpiGbl_FacsIndex);
        }
        if (AcpiGbl_FADT.XFacs)
        {
            AcpiTbInstallStandardTable (
                (ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.XFacs,
                ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL, FALSE, TRUE,
                &AcpiGbl_XFacsIndex);
        }
    }
}

Referenced by AcpiTbParseRootTable().

AcpiTbSelectAddress()

static UINT64 AcpiTbSelectAddress ( char *  RegisterName, UINT32  Address32, UINT64  Address64  )

static

Definition at line 287 of file tbfadt.c.

{
 
    if (!Address64)
    {
        /* 64-bit address is zero, use 32-bit address */
 
        return ((UINT64) Address32);
    }
 
    if (Address32 &&
       (Address64 != (UINT64) Address32))
    {
        /* Address mismatch between 32-bit and 64-bit versions */
 
        ACPI_BIOS_WARNING ((AE_INFO,
            "32/64X %s address mismatch in FADT: "
            "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
            RegisterName, Address32, ACPI_FORMAT_UINT64 (Address64),
            AcpiGbl_Use32BitFadtAddresses ? 32 : 64));
 
        /* 32-bit address override */
 
        if (AcpiGbl_Use32BitFadtAddresses)
        {
            return ((UINT64) Address32);
        }
    }
 
    /* Default is to use the 64-bit address */
 
    return (Address64);
}

Referenced by AcpiTbConvertFadt().

AcpiTbSetupFadtRegisters()

static void AcpiTbSetupFadtRegisters ( void  )

static

Definition at line 714 of file tbfadt.c.

{
    ACPI_GENERIC_ADDRESS    *Target64;
    ACPI_GENERIC_ADDRESS    *Source64;
    UINT8                   Pm1RegisterByteWidth;
    UINT32                  i;
 
 
    /*
     * Optionally check all register lengths against the default values and
     * update them if they are incorrect.
     */
    if (AcpiGbl_UseDefaultRegisterWidths)
    {
        for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++)
        {
            Target64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS, &AcpiGbl_FADT,
                FadtInfoTable[i].Address64);
 
            /*
             * If a valid register (Address != 0) and the (DefaultLength > 0)
             * (Not a GPE register), then check the width against the default.
             */
            if ((Target64->Address) &&
                (FadtInfoTable[i].DefaultLength > 0) &&
                (FadtInfoTable[i].DefaultLength != Target64->BitWidth))
            {
                ACPI_BIOS_WARNING ((AE_INFO,
                    "Invalid length for FADT/%s: %u, using default %u",
                    FadtInfoTable[i].Name, Target64->BitWidth,
                    FadtInfoTable[i].DefaultLength));
 
                /* Incorrect size, set width to the default */
 
                Target64->BitWidth = FadtInfoTable[i].DefaultLength;
            }
        }
    }
 
    /*
     * Get the length of the individual PM1 registers (enable and status).
     * Each register is defined to be (event block length / 2). Extra divide
     * by 8 converts bits to bytes.
     */
    Pm1RegisterByteWidth = (UINT8)
        ACPI_DIV_16 (AcpiGbl_FADT.XPm1aEventBlock.BitWidth);
 
    /*
     * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
     * registers. These addresses do not appear (directly) in the FADT, so it
     * is useful to pre-calculate them from the PM1 Event Block definitions.
     *
     * The PM event blocks are split into two register blocks, first is the
     * PM Status Register block, followed immediately by the PM Enable
     * Register block. Each is of length (Pm1EventLength/2)
     *
     * Note: The PM1A event block is required by the ACPI specification.
     * However, the PM1B event block is optional and is rarely, if ever,
     * used.
     */
 
    for (i = 0; i < ACPI_FADT_PM_INFO_ENTRIES; i++)
    {
        Source64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS, &AcpiGbl_FADT,
            FadtPmInfoTable[i].Source);
 
        if (Source64->Address)
        {
            AcpiTbInitGenericAddress (FadtPmInfoTable[i].Target,
                Source64->SpaceId, Pm1RegisterByteWidth,
                Source64->Address +
                    (FadtPmInfoTable[i].RegisterNum * Pm1RegisterByteWidth),
                "PmRegisters", 0);
        }
    }
}

Referenced by AcpiTbCreateLocalFadt().

Variable Documentation

FadtInfoTable

ACPI_FADT_INFO FadtInfoTable[]

static

Definition at line 95 of file tbfadt.c.

Referenced by AcpiTbConvertFadt(), and AcpiTbSetupFadtRegisters().

FadtPmInfoTable

ACPI_FADT_PM_INFO FadtPmInfoTable[]

static

Initial value:

=
{
    {&AcpiGbl_XPm1aStatus,
        ACPI_FADT_OFFSET (XPm1aEventBlock),
        0},
 
    {&AcpiGbl_XPm1aEnable,
        ACPI_FADT_OFFSET (XPm1aEventBlock),
        1},
 
    {&AcpiGbl_XPm1bStatus,
        ACPI_FADT_OFFSET (XPm1bEventBlock),
        0},
 
    {&AcpiGbl_XPm1bEnable,
        ACPI_FADT_OFFSET (XPm1bEventBlock),
        1}
}

Definition at line 168 of file tbfadt.c.

Referenced by AcpiTbSetupFadtRegisters().