db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/******************************************************************************
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Module Name: tbfadt - FADT table utilities
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * All rights reserved.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * modification, are permitted provided that the following conditions
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * notice, this list of conditions, and the following disclaimer,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * without modification.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * including a substantially similar Disclaimer requirement for further
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * binary redistribution.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * of any contributors may be used to endorse or promote products derived
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * from this software without specific prior written permission.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Software Foundation.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * NO WARRANTY
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * POSSIBILITY OF SUCH DAMAGES.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/* Local prototypes */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/* Table for conversion of FADT to common internal format and FADT validation */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Pm1aEventBlock",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Pm1bEventBlock",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Pm1aControlBlock",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Pm1bControlBlock",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Pm2ControlBlock",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"PmTimerBlock",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_FADT_SEPARATE_LENGTH}, /* ACPI 5.0A: Timer is optional */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Gpe0Block",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_FADT_SEPARATE_LENGTH | ACPI_FADT_GPE_REGISTER},
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers {"Gpe1Block",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_FADT_SEPARATE_LENGTH | ACPI_FADT_GPE_REGISTER}
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers (sizeof (FadtInfoTable) / sizeof (ACPI_FADT_INFO))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/* Table used to split Event Blocks into separate status/enable registers */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers (sizeof (FadtPmInfoTable) / sizeof (ACPI_FADT_PM_INFO))
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/*******************************************************************************
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * FUNCTION: AcpiTbInitGenericAddress
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * PARAMETERS: GenericAddress - GAS struct to be initialized
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * SpaceId - ACPI Space ID for this register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * ByteWidth - Width of this register
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Address - Address of the register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RegisterName - ASCII name of the ACPI register
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * RETURN: None
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * DESCRIPTION: Initialize a Generic Address Structure (GAS)
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * See the ACPI specification for a full description and
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * definition of this structure.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Bit width field in the GAS is only one byte long, 255 max.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Check for BitWidth overflow in GAS.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (ByteWidth > 31) /* (31*8)=248, (32*8)=256 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * No error for GPE blocks, because we do not use the BitWidth
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * for GPEs, the legacy length (ByteWidth) is used instead to
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * allow for a large number of GPEs.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "%s - 32-bit FADT register is too long (%u bytes, %u bits) "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "to convert to GAS struct - 255 bits max, truncating",
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * The 64-bit Address field is non-aligned in the byte packed
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * GAS struct.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers ACPI_MOVE_64_TO_64 (&GenericAddress->Address, &Address);
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers /* All other fields are byte-wide */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers GenericAddress->AccessWidth = 0; /* Access width ANY */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiTbSelectAddress
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: RegisterName - ASCII name of the ACPI register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address32 - 32-bit address of the register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address64 - 64-bit address of the register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: The resolved 64-bit address
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Select between 32-bit and 64-bit versions of addresses within
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the FADT. Used for the FACS and DSDT addresses.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Check for FACS and DSDT address mismatches. An address mismatch between
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the 32-bit and 64-bit address fields (FIRMWARE_CTRL/X_FIRMWARE_CTRL and
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DSDT/X_DSDT) could be a corrupted address field or it might indicate
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the presence of two FACS or two DSDT tables.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * November 2013:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * By default, as per the ACPICA specification, a valid 64-bit address is
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * used regardless of the value of the 32-bit address. However, this
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * behavior can be overridden via the AcpiGbl_Use32BitFadtAddresses flag.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* 64-bit address is zero, use 32-bit address */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Address mismatch between 32-bit and 64-bit versions */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "32/64X %s address mismatch in FADT: "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek RegisterName, Address32, ACPI_FORMAT_UINT64 (Address64),
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* 32-bit address override */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Default is to use the 64-bit address */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/*******************************************************************************
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * FUNCTION: AcpiTbParseFadt
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: None
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * RETURN: None
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * (FADT contains the addresses of the DSDT and FACS)
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers ******************************************************************************/
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * The FADT has multiple versions with different lengths,
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * and it contains pointers to both the DSDT and FACS tables.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Get a local copy of the FADT and convert it to a common format
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Map entire FADT, assumed to be smaller than one page.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Length = AcpiGbl_RootTableList.Tables[AcpiGbl_FadtIndex].Length;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiGbl_RootTableList.Tables[AcpiGbl_FadtIndex].Address, Length);
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Validate the FADT checksum before we copy the table. Ignore
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * checksum error as we want to try to get the DSDT and FACS.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Create a local copy of the FADT in common ACPI 2.0+ format */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers /* All done with the real FADT, unmap it */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers /* Obtain the DSDT and FACS tables via their addresses within the FADT */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiTbInstallFixedTable ((ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.XDsdt,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* If Hardware Reduced flag is set, there is no FACS */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiTbInstallFixedTable ((ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.Facs,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiTbInstallFixedTable ((ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.XFacs,
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/*******************************************************************************
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * FUNCTION: AcpiTbCreateLocalFadt
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * PARAMETERS: Table - Pointer to BIOS FADT
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Length - Length of the table
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * RETURN: None
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Performs validation on some important FADT fields.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * NOTE: We create a local copy of the FADT regardless of the version.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers ******************************************************************************/
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Check if the FADT is larger than the largest table that we expect
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * (typically the current ACPI specification version). If so, truncate
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the table, and issue a warning.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "FADT (revision %u) is longer than %s length, "
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross "truncating length %u to %u",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Table->Revision, ACPI_FADT_CONFORMANCE, Length,
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers /* Clear the entire local FADT */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek memset (&AcpiGbl_FADT, 0, sizeof (ACPI_TABLE_FADT));
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers /* Copy the original FADT, up to sizeof (ACPI_TABLE_FADT) */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Take a copy of the Hardware Reduced flag */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (AcpiGbl_FADT.Flags & ACPI_FADT_HW_REDUCED)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Convert the local copy of the FADT to the common internal format */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Initialize the global ACPI register structures */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers/*******************************************************************************
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * FUNCTION: AcpiTbConvertFadt
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: None - AcpiGbl_FADT is used.
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * RETURN: None
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * DESCRIPTION: Converts all versions of the FADT to a common internal format.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Expand 32-bit addresses to 64-bit as necessary. Also validate
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * important fields within the FADT.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * NOTE: AcpiGbl_FADT must be of size (ACPI_TABLE_FADT), and must
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * contain a copy of the actual BIOS-provided FADT.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Notes on 64-bit register addresses:
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * After this FADT conversion, later ACPICA code will only use the 64-bit "X"
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * fields of the FADT for all ACPI register addresses.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * The 64-bit X fields are optional extensions to the original 32-bit FADT
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * V1.0 fields. Even if they are present in the FADT, they are optional and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * are unused if the BIOS sets them to zero. Therefore, we must copy/expand
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 32-bit V1.0 fields to the 64-bit X fields if the the 64-bit X field is
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * originally zero.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * For ACPI 1.0 FADTs (that contain no 64-bit addresses), all 32-bit address
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * fields are expanded to the corresponding 64-bit X fields in the internal
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * common FADT.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * For ACPI 2.0+ FADTs, all valid (non-zero) 32-bit address fields are expanded
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * to the corresponding 64-bit X fields, if the 64-bit field is originally
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * zero. Adhering to the ACPI specification, we completely ignore the 32-bit
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * field if the 64-bit field is valid, regardless of whether the host OS is
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 32-bit or 64-bit.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Possible additional checks:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * (AcpiGbl_FADT.Pm1EventLength >= 4)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * (AcpiGbl_FADT.Pm1ControlLength >= 2)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * (AcpiGbl_FADT.PmTimerLength >= 4)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Gpe block lengths must be multiple of 2
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers ******************************************************************************/
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * should be zero are indeed zero. This will workaround BIOSs that
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * inadvertently place values in these fields.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The ACPI 1.0 reserved fields that will be zeroed are the bytes located
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * at offset 45, 55, 95, and the word located at offset 109, 110.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Note: The FADT revision value is unreliable. Only the length can be
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross if (AcpiGbl_FADT.Header.Length <= ACPI_FADT_V2_SIZE)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Now we can update the local FADT length to the length of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * current FADT version as defined by the ACPI specification.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Thus, we will have a common FADT internally.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiGbl_FADT.Header.Length = sizeof (ACPI_TABLE_FADT);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Expand the 32-bit DSDT addresses to 64-bit as necessary.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Later ACPICA code will always use the X 64-bit field.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiGbl_FADT.XDsdt = AcpiTbSelectAddress ("DSDT",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* If Hardware Reduced flag is set, we are all done */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers /* Examine all of the 64-bit extended address fields (X fields) */
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Get the 32-bit and 64-bit addresses, as well as the register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * length and register name.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * generic address structures as necessary. Later code will always use
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the 64-bit address structures.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * November 2013:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Now always use the 64-bit address if it is valid (non-zero), in
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * accordance with the ACPI specification which states that a 64-bit
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * address supersedes the 32-bit version. This behavior can be
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * overridden by the AcpiGbl_Use32BitFadtAddresses flag.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * During 64-bit address construction and verification,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * these cases are handled:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address32 zero, Address64 [don't care] - Use Address64
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address32 non-zero, Address64 zero - Copy/use Address32
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address32 non-zero == Address64 non-zero - Use Address64
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address32 non-zero != Address64 non-zero - Warning, use Address64
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Override: if AcpiGbl_Use32BitFadtAddresses is TRUE, and:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Address32 non-zero != Address64 non-zero - Warning, copy/use Address32
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: SpaceId is always I/O for 32-bit legacy address fields
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* 64-bit address is zero, use 32-bit address */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek else if (Address64->Address != (UINT64) Address32)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Address mismatch */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "32/64X address mismatch in FADT/%s: "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* 32-bit address override */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * For each extended field, check for length mismatch between the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * legacy length field and the corresponding 64-bit X length field.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: If the legacy length field is > 0xFF bits, ignore this
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * check. (GPE registers can be larger than the 64-bit GAS structure
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * can accomodate, 0xFF bits).
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "32/64X length mismatch in FADT/%s: %u/%u",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Name, ACPI_MUL_8 (Length), Address64->BitWidth));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (FadtInfoTable[i].Flags & ACPI_FADT_REQUIRED)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Field is required (PM1aEvent, PM1aControl).
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Both the address and length must be non-zero.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Required FADT field %s has zero address and/or length: "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "0x%8.8X%8.8X/0x%X",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Name, ACPI_FORMAT_UINT64 (Address64->Address), Length));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek else if (FadtInfoTable[i].Flags & ACPI_FADT_SEPARATE_LENGTH)
db2bae3047e71d795bde12e3baa621f4b6cc8930Dana Myers * Field is optional (PM2Control, GPE0, GPE1) AND has its own
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * length field. If present, both the address and length must
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Optional FADT field %s has valid %s but zero %s: "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_FORMAT_UINT64 (Address64->Address), Length));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiTbSetupFadtRegisters
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: None, uses AcpiGbl_FADT.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: None
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Initialize global ACPI PM1 register definitions. Optionally,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * force FADT register definitions to their default lengths.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Optionally check all register lengths against the default values and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * update them if they are incorrect.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Target64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS, &AcpiGbl_FADT,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * If a valid register (Address != 0) and the (DefaultLength > 0)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * (Not a GPE register), then check the width against the default.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers (FadtInfoTable[i].DefaultLength != Target64->BitWidth))
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Invalid length for FADT/%s: %u, using default %u",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Incorrect size, set width to the default */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Target64->BitWidth = FadtInfoTable[i].DefaultLength;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Get the length of the individual PM1 registers (enable and status).
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Each register is defined to be (event block length / 2). Extra divide
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * by 8 converts bits to bytes.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_DIV_16 (AcpiGbl_FADT.XPm1aEventBlock.BitWidth);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * registers. These addresses do not appear (directly) in the FADT, so it
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * is useful to pre-calculate them from the PM1 Event Block definitions.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The PM event blocks are split into two register blocks, first is the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PM Status Register block, followed immediately by the PM Enable
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Register block. Each is of length (Pm1EventLength/2)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Note: The PM1A event block is required by the ACPI specification.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * However, the PM1B event block is optional and is rarely, if ever,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < ACPI_FADT_PM_INFO_ENTRIES; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Source64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS, &AcpiGbl_FADT,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers AcpiTbInitGenericAddress (FadtPmInfoTable[i].Target,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek (FadtPmInfoTable[i].RegisterNum * Pm1RegisterByteWidth),
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "PmRegisters", 0);