10d02842fSSascha Wildner /******************************************************************************
20d02842fSSascha Wildner *
30d02842fSSascha Wildner * Module Name: tbfadt - FADT table utilities
40d02842fSSascha Wildner *
50d02842fSSascha Wildner *****************************************************************************/
60d02842fSSascha Wildner
7b4315fc7SSascha Wildner /******************************************************************************
8b4315fc7SSascha Wildner *
9b4315fc7SSascha Wildner * 1. Copyright Notice
10b4315fc7SSascha Wildner *
11383048acSSascha Wildner * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
120d02842fSSascha Wildner * All rights reserved.
130d02842fSSascha Wildner *
14b4315fc7SSascha Wildner * 2. License
15b4315fc7SSascha Wildner *
16b4315fc7SSascha Wildner * 2.1. This is your license from Intel Corp. under its intellectual property
17b4315fc7SSascha Wildner * rights. You may have additional license terms from the party that provided
18b4315fc7SSascha Wildner * you this software, covering your right to use that party's intellectual
19b4315fc7SSascha Wildner * property rights.
20b4315fc7SSascha Wildner *
21b4315fc7SSascha Wildner * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22b4315fc7SSascha Wildner * copy of the source code appearing in this file ("Covered Code") an
23b4315fc7SSascha Wildner * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24b4315fc7SSascha Wildner * base code distributed originally by Intel ("Original Intel Code") to copy,
25b4315fc7SSascha Wildner * make derivatives, distribute, use and display any portion of the Covered
26b4315fc7SSascha Wildner * Code in any form, with the right to sublicense such rights; and
27b4315fc7SSascha Wildner *
28b4315fc7SSascha Wildner * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29b4315fc7SSascha Wildner * license (with the right to sublicense), under only those claims of Intel
30b4315fc7SSascha Wildner * patents that are infringed by the Original Intel Code, to make, use, sell,
31b4315fc7SSascha Wildner * offer to sell, and import the Covered Code and derivative works thereof
32b4315fc7SSascha Wildner * solely to the minimum extent necessary to exercise the above copyright
33b4315fc7SSascha Wildner * license, and in no event shall the patent license extend to any additions
34b4315fc7SSascha Wildner * to or modifications of the Original Intel Code. No other license or right
35b4315fc7SSascha Wildner * is granted directly or by implication, estoppel or otherwise;
36b4315fc7SSascha Wildner *
37b4315fc7SSascha Wildner * The above copyright and patent license is granted only if the following
38b4315fc7SSascha Wildner * conditions are met:
39b4315fc7SSascha Wildner *
40b4315fc7SSascha Wildner * 3. Conditions
41b4315fc7SSascha Wildner *
42b4315fc7SSascha Wildner * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
44b4315fc7SSascha Wildner * Code or modification with rights to further distribute source must include
45b4315fc7SSascha Wildner * the above Copyright Notice, the above License, this list of Conditions,
46b4315fc7SSascha Wildner * and the following Disclaimer and Export Compliance provision. In addition,
47b4315fc7SSascha Wildner * Licensee must cause all Covered Code to which Licensee contributes to
48b4315fc7SSascha Wildner * contain a file documenting the changes Licensee made to create that Covered
49b4315fc7SSascha Wildner * Code and the date of any change. Licensee must include in that file the
50b4315fc7SSascha Wildner * documentation of any changes made by any predecessor Licensee. Licensee
51b4315fc7SSascha Wildner * must include a prominent statement that the modification is derived,
52b4315fc7SSascha Wildner * directly or indirectly, from Original Intel Code.
53b4315fc7SSascha Wildner *
54b4315fc7SSascha Wildner * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
56b4315fc7SSascha Wildner * Code or modification without rights to further distribute source must
57b4315fc7SSascha Wildner * include the following Disclaimer and Export Compliance provision in the
58b4315fc7SSascha Wildner * documentation and/or other materials provided with distribution. In
59b4315fc7SSascha Wildner * addition, Licensee may not authorize further sublicense of source of any
60b4315fc7SSascha Wildner * portion of the Covered Code, and must include terms to the effect that the
61b4315fc7SSascha Wildner * license from Licensee to its licensee is limited to the intellectual
62b4315fc7SSascha Wildner * property embodied in the software Licensee provides to its licensee, and
63b4315fc7SSascha Wildner * not to intellectual property embodied in modifications its licensee may
64b4315fc7SSascha Wildner * make.
65b4315fc7SSascha Wildner *
66b4315fc7SSascha Wildner * 3.3. Redistribution of Executable. Redistribution in executable form of any
67b4315fc7SSascha Wildner * substantial portion of the Covered Code or modification must reproduce the
68b4315fc7SSascha Wildner * above Copyright Notice, and the following Disclaimer and Export Compliance
69b4315fc7SSascha Wildner * provision in the documentation and/or other materials provided with the
70b4315fc7SSascha Wildner * distribution.
71b4315fc7SSascha Wildner *
72b4315fc7SSascha Wildner * 3.4. Intel retains all right, title, and interest in and to the Original
73b4315fc7SSascha Wildner * Intel Code.
74b4315fc7SSascha Wildner *
75b4315fc7SSascha Wildner * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76b4315fc7SSascha Wildner * Intel shall be used in advertising or otherwise to promote the sale, use or
77b4315fc7SSascha Wildner * other dealings in products derived from or relating to the Covered Code
78b4315fc7SSascha Wildner * without prior written authorization from Intel.
79b4315fc7SSascha Wildner *
80b4315fc7SSascha Wildner * 4. Disclaimer and Export Compliance
81b4315fc7SSascha Wildner *
82b4315fc7SSascha Wildner * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83b4315fc7SSascha Wildner * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84b4315fc7SSascha Wildner * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85b4315fc7SSascha Wildner * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86b4315fc7SSascha Wildner * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87b4315fc7SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88b4315fc7SSascha Wildner * PARTICULAR PURPOSE.
89b4315fc7SSascha Wildner *
90b4315fc7SSascha Wildner * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91b4315fc7SSascha Wildner * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92b4315fc7SSascha Wildner * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93b4315fc7SSascha Wildner * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94b4315fc7SSascha Wildner * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95b4315fc7SSascha Wildner * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96b4315fc7SSascha Wildner * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97b4315fc7SSascha Wildner * LIMITED REMEDY.
98b4315fc7SSascha Wildner *
99b4315fc7SSascha Wildner * 4.3. Licensee shall not export, either directly or indirectly, any of this
100b4315fc7SSascha Wildner * software or system incorporating such software without first obtaining any
101b4315fc7SSascha Wildner * required license or other approval from the U. S. Department of Commerce or
102b4315fc7SSascha Wildner * any other agency or department of the United States Government. In the
103b4315fc7SSascha Wildner * event Licensee exports any such software from the United States or
104b4315fc7SSascha Wildner * re-exports any such software from a foreign destination, Licensee shall
105b4315fc7SSascha Wildner * ensure that the distribution and export/re-export of the software is in
106b4315fc7SSascha Wildner * compliance with all laws, regulations, orders, or other restrictions of the
107b4315fc7SSascha Wildner * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108b4315fc7SSascha Wildner * any of its subsidiaries will export/re-export any technical data, process,
109b4315fc7SSascha Wildner * software, or service, directly or indirectly, to any country for which the
110b4315fc7SSascha Wildner * United States government or any agency thereof requires an export license,
111b4315fc7SSascha Wildner * other governmental approval, or letter of assurance, without first obtaining
112b4315fc7SSascha Wildner * such license, approval or letter.
113b4315fc7SSascha Wildner *
114b4315fc7SSascha Wildner *****************************************************************************
115b4315fc7SSascha Wildner *
116b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
117b4315fc7SSascha Wildner * following license:
118b4315fc7SSascha Wildner *
1190d02842fSSascha Wildner * Redistribution and use in source and binary forms, with or without
1200d02842fSSascha Wildner * modification, are permitted provided that the following conditions
1210d02842fSSascha Wildner * are met:
1220d02842fSSascha Wildner * 1. Redistributions of source code must retain the above copyright
1230d02842fSSascha Wildner * notice, this list of conditions, and the following disclaimer,
1240d02842fSSascha Wildner * without modification.
1250d02842fSSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1260d02842fSSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below
1270d02842fSSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon
1280d02842fSSascha Wildner * including a substantially similar Disclaimer requirement for further
1290d02842fSSascha Wildner * binary redistribution.
1300d02842fSSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names
1310d02842fSSascha Wildner * of any contributors may be used to endorse or promote products derived
1320d02842fSSascha Wildner * from this software without specific prior written permission.
1330d02842fSSascha Wildner *
134b4315fc7SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135b4315fc7SSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136b4315fc7SSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137b4315fc7SSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138b4315fc7SSascha Wildner * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139b4315fc7SSascha Wildner * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140b4315fc7SSascha Wildner * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141b4315fc7SSascha Wildner * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142b4315fc7SSascha Wildner * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143b4315fc7SSascha Wildner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144b4315fc7SSascha Wildner * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145b4315fc7SSascha Wildner *
146b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
1470d02842fSSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free
1480d02842fSSascha Wildner * Software Foundation.
1490d02842fSSascha Wildner *
150b4315fc7SSascha Wildner *****************************************************************************/
1510d02842fSSascha Wildner
1520d02842fSSascha Wildner #include "acpi.h"
1530d02842fSSascha Wildner #include "accommon.h"
1540d02842fSSascha Wildner #include "actables.h"
1550d02842fSSascha Wildner
1560d02842fSSascha Wildner #define _COMPONENT ACPI_TABLES
1570d02842fSSascha Wildner ACPI_MODULE_NAME ("tbfadt")
1580d02842fSSascha Wildner
1590d02842fSSascha Wildner /* Local prototypes */
1600d02842fSSascha Wildner
1610d02842fSSascha Wildner static void
1620d02842fSSascha Wildner AcpiTbInitGenericAddress (
1630d02842fSSascha Wildner ACPI_GENERIC_ADDRESS *GenericAddress,
1640d02842fSSascha Wildner UINT8 SpaceId,
1650d02842fSSascha Wildner UINT8 ByteWidth,
1660d02842fSSascha Wildner UINT64 Address,
1672ffe9f16SSascha Wildner const char *RegisterName,
1689e1c0880SSascha Wildner UINT8 Flags);
1690d02842fSSascha Wildner
1700d02842fSSascha Wildner static void
1710d02842fSSascha Wildner AcpiTbConvertFadt (
1720d02842fSSascha Wildner void);
1730d02842fSSascha Wildner
1740d02842fSSascha Wildner static void
1750d02842fSSascha Wildner AcpiTbSetupFadtRegisters (
1760d02842fSSascha Wildner void);
1770d02842fSSascha Wildner
1780d02842fSSascha Wildner static UINT64
1790d02842fSSascha Wildner AcpiTbSelectAddress (
1800d02842fSSascha Wildner char *RegisterName,
1810d02842fSSascha Wildner UINT32 Address32,
1820d02842fSSascha Wildner UINT64 Address64);
1830d02842fSSascha Wildner
1840d02842fSSascha Wildner
1850d02842fSSascha Wildner /* Table for conversion of FADT to common internal format and FADT validation */
1860d02842fSSascha Wildner
1870d02842fSSascha Wildner typedef struct acpi_fadt_info
1880d02842fSSascha Wildner {
1892ffe9f16SSascha Wildner const char *Name;
1900d02842fSSascha Wildner UINT16 Address64;
1910d02842fSSascha Wildner UINT16 Address32;
1920d02842fSSascha Wildner UINT16 Length;
1930d02842fSSascha Wildner UINT8 DefaultLength;
1949e1c0880SSascha Wildner UINT8 Flags;
1950d02842fSSascha Wildner
1960d02842fSSascha Wildner } ACPI_FADT_INFO;
1970d02842fSSascha Wildner
1980d02842fSSascha Wildner #define ACPI_FADT_OPTIONAL 0
1990d02842fSSascha Wildner #define ACPI_FADT_REQUIRED 1
2000d02842fSSascha Wildner #define ACPI_FADT_SEPARATE_LENGTH 2
2019e1c0880SSascha Wildner #define ACPI_FADT_GPE_REGISTER 4
2020d02842fSSascha Wildner
2030d02842fSSascha Wildner static ACPI_FADT_INFO FadtInfoTable[] =
2040d02842fSSascha Wildner {
2050d02842fSSascha Wildner {"Pm1aEventBlock",
2060d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1aEventBlock),
2070d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1aEventBlock),
2080d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1EventLength),
2090d02842fSSascha Wildner ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
2100d02842fSSascha Wildner ACPI_FADT_REQUIRED},
2110d02842fSSascha Wildner
2120d02842fSSascha Wildner {"Pm1bEventBlock",
2130d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1bEventBlock),
2140d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1bEventBlock),
2150d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1EventLength),
2160d02842fSSascha Wildner ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
2170d02842fSSascha Wildner ACPI_FADT_OPTIONAL},
2180d02842fSSascha Wildner
2190d02842fSSascha Wildner {"Pm1aControlBlock",
2200d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1aControlBlock),
2210d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1aControlBlock),
2220d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1ControlLength),
2230d02842fSSascha Wildner ACPI_PM1_REGISTER_WIDTH,
2240d02842fSSascha Wildner ACPI_FADT_REQUIRED},
2250d02842fSSascha Wildner
2260d02842fSSascha Wildner {"Pm1bControlBlock",
2270d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1bControlBlock),
2280d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1bControlBlock),
2290d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm1ControlLength),
2300d02842fSSascha Wildner ACPI_PM1_REGISTER_WIDTH,
2310d02842fSSascha Wildner ACPI_FADT_OPTIONAL},
2320d02842fSSascha Wildner
2330d02842fSSascha Wildner {"Pm2ControlBlock",
2340d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm2ControlBlock),
2350d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm2ControlBlock),
2360d02842fSSascha Wildner ACPI_FADT_OFFSET (Pm2ControlLength),
2370d02842fSSascha Wildner ACPI_PM2_REGISTER_WIDTH,
2380d02842fSSascha Wildner ACPI_FADT_SEPARATE_LENGTH},
2390d02842fSSascha Wildner
2400d02842fSSascha Wildner {"PmTimerBlock",
2410d02842fSSascha Wildner ACPI_FADT_OFFSET (XPmTimerBlock),
2420d02842fSSascha Wildner ACPI_FADT_OFFSET (PmTimerBlock),
2430d02842fSSascha Wildner ACPI_FADT_OFFSET (PmTimerLength),
2440d02842fSSascha Wildner ACPI_PM_TIMER_WIDTH,
2450d02842fSSascha Wildner ACPI_FADT_SEPARATE_LENGTH}, /* ACPI 5.0A: Timer is optional */
2460d02842fSSascha Wildner
2470d02842fSSascha Wildner {"Gpe0Block",
2480d02842fSSascha Wildner ACPI_FADT_OFFSET (XGpe0Block),
2490d02842fSSascha Wildner ACPI_FADT_OFFSET (Gpe0Block),
2500d02842fSSascha Wildner ACPI_FADT_OFFSET (Gpe0BlockLength),
2510d02842fSSascha Wildner 0,
2529e1c0880SSascha Wildner ACPI_FADT_SEPARATE_LENGTH | ACPI_FADT_GPE_REGISTER},
2530d02842fSSascha Wildner
2540d02842fSSascha Wildner {"Gpe1Block",
2550d02842fSSascha Wildner ACPI_FADT_OFFSET (XGpe1Block),
2560d02842fSSascha Wildner ACPI_FADT_OFFSET (Gpe1Block),
2570d02842fSSascha Wildner ACPI_FADT_OFFSET (Gpe1BlockLength),
2580d02842fSSascha Wildner 0,
2599e1c0880SSascha Wildner ACPI_FADT_SEPARATE_LENGTH | ACPI_FADT_GPE_REGISTER}
2600d02842fSSascha Wildner };
2610d02842fSSascha Wildner
2620d02842fSSascha Wildner #define ACPI_FADT_INFO_ENTRIES \
2630d02842fSSascha Wildner (sizeof (FadtInfoTable) / sizeof (ACPI_FADT_INFO))
2640d02842fSSascha Wildner
2650d02842fSSascha Wildner
2660d02842fSSascha Wildner /* Table used to split Event Blocks into separate status/enable registers */
2670d02842fSSascha Wildner
2680d02842fSSascha Wildner typedef struct acpi_fadt_pm_info
2690d02842fSSascha Wildner {
2700d02842fSSascha Wildner ACPI_GENERIC_ADDRESS *Target;
2710d02842fSSascha Wildner UINT16 Source;
2720d02842fSSascha Wildner UINT8 RegisterNum;
2730d02842fSSascha Wildner
2740d02842fSSascha Wildner } ACPI_FADT_PM_INFO;
2750d02842fSSascha Wildner
2760d02842fSSascha Wildner static ACPI_FADT_PM_INFO FadtPmInfoTable[] =
2770d02842fSSascha Wildner {
2780d02842fSSascha Wildner {&AcpiGbl_XPm1aStatus,
2790d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1aEventBlock),
2800d02842fSSascha Wildner 0},
2810d02842fSSascha Wildner
2820d02842fSSascha Wildner {&AcpiGbl_XPm1aEnable,
2830d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1aEventBlock),
2840d02842fSSascha Wildner 1},
2850d02842fSSascha Wildner
2860d02842fSSascha Wildner {&AcpiGbl_XPm1bStatus,
2870d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1bEventBlock),
2880d02842fSSascha Wildner 0},
2890d02842fSSascha Wildner
2900d02842fSSascha Wildner {&AcpiGbl_XPm1bEnable,
2910d02842fSSascha Wildner ACPI_FADT_OFFSET (XPm1bEventBlock),
2920d02842fSSascha Wildner 1}
2930d02842fSSascha Wildner };
2940d02842fSSascha Wildner
2950d02842fSSascha Wildner #define ACPI_FADT_PM_INFO_ENTRIES \
2960d02842fSSascha Wildner (sizeof (FadtPmInfoTable) / sizeof (ACPI_FADT_PM_INFO))
2970d02842fSSascha Wildner
2980d02842fSSascha Wildner
2990d02842fSSascha Wildner /*******************************************************************************
3000d02842fSSascha Wildner *
3010d02842fSSascha Wildner * FUNCTION: AcpiTbInitGenericAddress
3020d02842fSSascha Wildner *
3030d02842fSSascha Wildner * PARAMETERS: GenericAddress - GAS struct to be initialized
3040d02842fSSascha Wildner * SpaceId - ACPI Space ID for this register
3050d02842fSSascha Wildner * ByteWidth - Width of this register
3060d02842fSSascha Wildner * Address - Address of the register
3070d02842fSSascha Wildner * RegisterName - ASCII name of the ACPI register
3080d02842fSSascha Wildner *
3090d02842fSSascha Wildner * RETURN: None
3100d02842fSSascha Wildner *
3110d02842fSSascha Wildner * DESCRIPTION: Initialize a Generic Address Structure (GAS)
3120d02842fSSascha Wildner * See the ACPI specification for a full description and
3130d02842fSSascha Wildner * definition of this structure.
3140d02842fSSascha Wildner *
3150d02842fSSascha Wildner ******************************************************************************/
3160d02842fSSascha Wildner
3170d02842fSSascha Wildner static void
AcpiTbInitGenericAddress(ACPI_GENERIC_ADDRESS * GenericAddress,UINT8 SpaceId,UINT8 ByteWidth,UINT64 Address,const char * RegisterName,UINT8 Flags)3180d02842fSSascha Wildner AcpiTbInitGenericAddress (
3190d02842fSSascha Wildner ACPI_GENERIC_ADDRESS *GenericAddress,
3200d02842fSSascha Wildner UINT8 SpaceId,
3210d02842fSSascha Wildner UINT8 ByteWidth,
3220d02842fSSascha Wildner UINT64 Address,
3232ffe9f16SSascha Wildner const char *RegisterName,
3249e1c0880SSascha Wildner UINT8 Flags)
3250d02842fSSascha Wildner {
3260d02842fSSascha Wildner UINT8 BitWidth;
3270d02842fSSascha Wildner
3280d02842fSSascha Wildner
3299e1c0880SSascha Wildner /*
3309e1c0880SSascha Wildner * Bit width field in the GAS is only one byte long, 255 max.
3319e1c0880SSascha Wildner * Check for BitWidth overflow in GAS.
3329e1c0880SSascha Wildner */
3330d02842fSSascha Wildner BitWidth = (UINT8) (ByteWidth * 8);
3349e1c0880SSascha Wildner if (ByteWidth > 31) /* (31*8)=248, (32*8)=256 */
3359e1c0880SSascha Wildner {
3369e1c0880SSascha Wildner /*
3379e1c0880SSascha Wildner * No error for GPE blocks, because we do not use the BitWidth
3389e1c0880SSascha Wildner * for GPEs, the legacy length (ByteWidth) is used instead to
3399e1c0880SSascha Wildner * allow for a large number of GPEs.
3409e1c0880SSascha Wildner */
3419e1c0880SSascha Wildner if (!(Flags & ACPI_FADT_GPE_REGISTER))
3420d02842fSSascha Wildner {
3430d02842fSSascha Wildner ACPI_ERROR ((AE_INFO,
3440d02842fSSascha Wildner "%s - 32-bit FADT register is too long (%u bytes, %u bits) "
3450d02842fSSascha Wildner "to convert to GAS struct - 255 bits max, truncating",
3460d02842fSSascha Wildner RegisterName, ByteWidth, (ByteWidth * 8)));
3479e1c0880SSascha Wildner }
3480d02842fSSascha Wildner
3490d02842fSSascha Wildner BitWidth = 255;
3500d02842fSSascha Wildner }
3510d02842fSSascha Wildner
3520d02842fSSascha Wildner /*
3530d02842fSSascha Wildner * The 64-bit Address field is non-aligned in the byte packed
3540d02842fSSascha Wildner * GAS struct.
3550d02842fSSascha Wildner */
3560d02842fSSascha Wildner ACPI_MOVE_64_TO_64 (&GenericAddress->Address, &Address);
3570d02842fSSascha Wildner
3580d02842fSSascha Wildner /* All other fields are byte-wide */
3590d02842fSSascha Wildner
3600d02842fSSascha Wildner GenericAddress->SpaceId = SpaceId;
3610d02842fSSascha Wildner GenericAddress->BitWidth = BitWidth;
3620d02842fSSascha Wildner GenericAddress->BitOffset = 0;
3630d02842fSSascha Wildner GenericAddress->AccessWidth = 0; /* Access width ANY */
3640d02842fSSascha Wildner }
3650d02842fSSascha Wildner
3660d02842fSSascha Wildner
3670d02842fSSascha Wildner /*******************************************************************************
3680d02842fSSascha Wildner *
3690d02842fSSascha Wildner * FUNCTION: AcpiTbSelectAddress
3700d02842fSSascha Wildner *
3710d02842fSSascha Wildner * PARAMETERS: RegisterName - ASCII name of the ACPI register
3720d02842fSSascha Wildner * Address32 - 32-bit address of the register
3730d02842fSSascha Wildner * Address64 - 64-bit address of the register
3740d02842fSSascha Wildner *
3750d02842fSSascha Wildner * RETURN: The resolved 64-bit address
3760d02842fSSascha Wildner *
3770d02842fSSascha Wildner * DESCRIPTION: Select between 32-bit and 64-bit versions of addresses within
3780d02842fSSascha Wildner * the FADT. Used for the FACS and DSDT addresses.
3790d02842fSSascha Wildner *
3800d02842fSSascha Wildner * NOTES:
3810d02842fSSascha Wildner *
3820d02842fSSascha Wildner * Check for FACS and DSDT address mismatches. An address mismatch between
3830d02842fSSascha Wildner * the 32-bit and 64-bit address fields (FIRMWARE_CTRL/X_FIRMWARE_CTRL and
3840d02842fSSascha Wildner * DSDT/X_DSDT) could be a corrupted address field or it might indicate
3850d02842fSSascha Wildner * the presence of two FACS or two DSDT tables.
3860d02842fSSascha Wildner *
3870d02842fSSascha Wildner * November 2013:
3880d02842fSSascha Wildner * By default, as per the ACPICA specification, a valid 64-bit address is
3890d02842fSSascha Wildner * used regardless of the value of the 32-bit address. However, this
3900d02842fSSascha Wildner * behavior can be overridden via the AcpiGbl_Use32BitFadtAddresses flag.
3910d02842fSSascha Wildner *
3920d02842fSSascha Wildner ******************************************************************************/
3930d02842fSSascha Wildner
3940d02842fSSascha Wildner static UINT64
AcpiTbSelectAddress(char * RegisterName,UINT32 Address32,UINT64 Address64)3950d02842fSSascha Wildner AcpiTbSelectAddress (
3960d02842fSSascha Wildner char *RegisterName,
3970d02842fSSascha Wildner UINT32 Address32,
3980d02842fSSascha Wildner UINT64 Address64)
3990d02842fSSascha Wildner {
4000d02842fSSascha Wildner
4010d02842fSSascha Wildner if (!Address64)
4020d02842fSSascha Wildner {
4030d02842fSSascha Wildner /* 64-bit address is zero, use 32-bit address */
4040d02842fSSascha Wildner
4050d02842fSSascha Wildner return ((UINT64) Address32);
4060d02842fSSascha Wildner }
4070d02842fSSascha Wildner
4080d02842fSSascha Wildner if (Address32 &&
4090d02842fSSascha Wildner (Address64 != (UINT64) Address32))
4100d02842fSSascha Wildner {
4110d02842fSSascha Wildner /* Address mismatch between 32-bit and 64-bit versions */
4120d02842fSSascha Wildner
4130d02842fSSascha Wildner ACPI_BIOS_WARNING ((AE_INFO,
4140d02842fSSascha Wildner "32/64X %s address mismatch in FADT: "
4150d02842fSSascha Wildner "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
4160d02842fSSascha Wildner RegisterName, Address32, ACPI_FORMAT_UINT64 (Address64),
4170d02842fSSascha Wildner AcpiGbl_Use32BitFadtAddresses ? 32 : 64));
4180d02842fSSascha Wildner
4190d02842fSSascha Wildner /* 32-bit address override */
4200d02842fSSascha Wildner
4210d02842fSSascha Wildner if (AcpiGbl_Use32BitFadtAddresses)
4220d02842fSSascha Wildner {
4230d02842fSSascha Wildner return ((UINT64) Address32);
4240d02842fSSascha Wildner }
4250d02842fSSascha Wildner }
4260d02842fSSascha Wildner
4270d02842fSSascha Wildner /* Default is to use the 64-bit address */
4280d02842fSSascha Wildner
4290d02842fSSascha Wildner return (Address64);
4300d02842fSSascha Wildner }
4310d02842fSSascha Wildner
4320d02842fSSascha Wildner
4330d02842fSSascha Wildner /*******************************************************************************
4340d02842fSSascha Wildner *
4350d02842fSSascha Wildner * FUNCTION: AcpiTbParseFadt
4360d02842fSSascha Wildner *
437820c5b08SSascha Wildner * PARAMETERS: None
4380d02842fSSascha Wildner *
4390d02842fSSascha Wildner * RETURN: None
4400d02842fSSascha Wildner *
4410d02842fSSascha Wildner * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
4420d02842fSSascha Wildner * (FADT contains the addresses of the DSDT and FACS)
4430d02842fSSascha Wildner *
4440d02842fSSascha Wildner ******************************************************************************/
4450d02842fSSascha Wildner
4460d02842fSSascha Wildner void
AcpiTbParseFadt(void)4470d02842fSSascha Wildner AcpiTbParseFadt (
448820c5b08SSascha Wildner void)
4490d02842fSSascha Wildner {
4500d02842fSSascha Wildner UINT32 Length;
4510d02842fSSascha Wildner ACPI_TABLE_HEADER *Table;
452a96e04f2SSascha Wildner ACPI_TABLE_DESC *FadtDesc;
453a96e04f2SSascha Wildner ACPI_STATUS Status;
4540d02842fSSascha Wildner
4550d02842fSSascha Wildner
4560d02842fSSascha Wildner /*
4570d02842fSSascha Wildner * The FADT has multiple versions with different lengths,
4580d02842fSSascha Wildner * and it contains pointers to both the DSDT and FACS tables.
4590d02842fSSascha Wildner *
4600d02842fSSascha Wildner * Get a local copy of the FADT and convert it to a common format
4610d02842fSSascha Wildner * Map entire FADT, assumed to be smaller than one page.
4620d02842fSSascha Wildner */
463a96e04f2SSascha Wildner FadtDesc = &AcpiGbl_RootTableList.Tables[AcpiGbl_FadtIndex];
464a96e04f2SSascha Wildner Status = AcpiTbGetTable (FadtDesc, &Table);
465a96e04f2SSascha Wildner if (ACPI_FAILURE (Status))
4660d02842fSSascha Wildner {
4670d02842fSSascha Wildner return;
4680d02842fSSascha Wildner }
469a96e04f2SSascha Wildner Length = FadtDesc->Length;
4700d02842fSSascha Wildner
4710d02842fSSascha Wildner /*
4720d02842fSSascha Wildner * Validate the FADT checksum before we copy the table. Ignore
4730d02842fSSascha Wildner * checksum error as we want to try to get the DSDT and FACS.
4740d02842fSSascha Wildner */
4750d02842fSSascha Wildner (void) AcpiTbVerifyChecksum (Table, Length);
4760d02842fSSascha Wildner
4770d02842fSSascha Wildner /* Create a local copy of the FADT in common ACPI 2.0+ format */
4780d02842fSSascha Wildner
4790d02842fSSascha Wildner AcpiTbCreateLocalFadt (Table, Length);
4800d02842fSSascha Wildner
4810d02842fSSascha Wildner /* All done with the real FADT, unmap it */
4820d02842fSSascha Wildner
483a96e04f2SSascha Wildner AcpiTbPutTable (FadtDesc);
4840d02842fSSascha Wildner
4850d02842fSSascha Wildner /* Obtain the DSDT and FACS tables via their addresses within the FADT */
4860d02842fSSascha Wildner
487e5e174adSSascha Wildner AcpiTbInstallStandardTable (
488e5e174adSSascha Wildner (ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.XDsdt,
489*aab122a6SSascha Wildner ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL, FALSE, TRUE,
490e5e174adSSascha Wildner &AcpiGbl_DsdtIndex);
4910d02842fSSascha Wildner
4920d02842fSSascha Wildner /* If Hardware Reduced flag is set, there is no FACS */
4930d02842fSSascha Wildner
4940d02842fSSascha Wildner if (!AcpiGbl_ReducedHardware)
4950d02842fSSascha Wildner {
49625ca8c79SSascha Wildner if (AcpiGbl_FADT.Facs)
49725ca8c79SSascha Wildner {
498e5e174adSSascha Wildner AcpiTbInstallStandardTable (
499e5e174adSSascha Wildner (ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.Facs,
500*aab122a6SSascha Wildner ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL, FALSE, TRUE,
501e5e174adSSascha Wildner &AcpiGbl_FacsIndex);
5020d02842fSSascha Wildner }
50325ca8c79SSascha Wildner if (AcpiGbl_FADT.XFacs)
50425ca8c79SSascha Wildner {
505e5e174adSSascha Wildner AcpiTbInstallStandardTable (
506e5e174adSSascha Wildner (ACPI_PHYSICAL_ADDRESS) AcpiGbl_FADT.XFacs,
507*aab122a6SSascha Wildner ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL, FALSE, TRUE,
508e5e174adSSascha Wildner &AcpiGbl_XFacsIndex);
50925ca8c79SSascha Wildner }
51025ca8c79SSascha Wildner }
5110d02842fSSascha Wildner }
5120d02842fSSascha Wildner
5130d02842fSSascha Wildner
5140d02842fSSascha Wildner /*******************************************************************************
5150d02842fSSascha Wildner *
5160d02842fSSascha Wildner * FUNCTION: AcpiTbCreateLocalFadt
5170d02842fSSascha Wildner *
5180d02842fSSascha Wildner * PARAMETERS: Table - Pointer to BIOS FADT
5190d02842fSSascha Wildner * Length - Length of the table
5200d02842fSSascha Wildner *
5210d02842fSSascha Wildner * RETURN: None
5220d02842fSSascha Wildner *
5230d02842fSSascha Wildner * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
5240d02842fSSascha Wildner * Performs validation on some important FADT fields.
5250d02842fSSascha Wildner *
5260d02842fSSascha Wildner * NOTE: We create a local copy of the FADT regardless of the version.
5270d02842fSSascha Wildner *
5280d02842fSSascha Wildner ******************************************************************************/
5290d02842fSSascha Wildner
5300d02842fSSascha Wildner void
AcpiTbCreateLocalFadt(ACPI_TABLE_HEADER * Table,UINT32 Length)5310d02842fSSascha Wildner AcpiTbCreateLocalFadt (
5320d02842fSSascha Wildner ACPI_TABLE_HEADER *Table,
5330d02842fSSascha Wildner UINT32 Length)
5340d02842fSSascha Wildner {
5350d02842fSSascha Wildner
5360d02842fSSascha Wildner /*
5370d02842fSSascha Wildner * Check if the FADT is larger than the largest table that we expect
5382ffe9f16SSascha Wildner * (typically the current ACPI specification version). If so, truncate
5392ffe9f16SSascha Wildner * the table, and issue a warning.
5400d02842fSSascha Wildner */
5410d02842fSSascha Wildner if (Length > sizeof (ACPI_TABLE_FADT))
5420d02842fSSascha Wildner {
5430d02842fSSascha Wildner ACPI_BIOS_WARNING ((AE_INFO,
5442ffe9f16SSascha Wildner "FADT (revision %u) is longer than %s length, "
5450d02842fSSascha Wildner "truncating length %u to %u",
5462ffe9f16SSascha Wildner Table->Revision, ACPI_FADT_CONFORMANCE, Length,
5472ffe9f16SSascha Wildner (UINT32) sizeof (ACPI_TABLE_FADT)));
5480d02842fSSascha Wildner }
5490d02842fSSascha Wildner
5500d02842fSSascha Wildner /* Clear the entire local FADT */
5510d02842fSSascha Wildner
55225ca8c79SSascha Wildner memset (&AcpiGbl_FADT, 0, sizeof (ACPI_TABLE_FADT));
5530d02842fSSascha Wildner
5540d02842fSSascha Wildner /* Copy the original FADT, up to sizeof (ACPI_TABLE_FADT) */
5550d02842fSSascha Wildner
55625ca8c79SSascha Wildner memcpy (&AcpiGbl_FADT, Table,
5570d02842fSSascha Wildner ACPI_MIN (Length, sizeof (ACPI_TABLE_FADT)));
5580d02842fSSascha Wildner
5590d02842fSSascha Wildner /* Take a copy of the Hardware Reduced flag */
5600d02842fSSascha Wildner
5610d02842fSSascha Wildner AcpiGbl_ReducedHardware = FALSE;
5620d02842fSSascha Wildner if (AcpiGbl_FADT.Flags & ACPI_FADT_HW_REDUCED)
5630d02842fSSascha Wildner {
5640d02842fSSascha Wildner AcpiGbl_ReducedHardware = TRUE;
5650d02842fSSascha Wildner }
5660d02842fSSascha Wildner
5670d02842fSSascha Wildner /* Convert the local copy of the FADT to the common internal format */
5680d02842fSSascha Wildner
5690d02842fSSascha Wildner AcpiTbConvertFadt ();
5700d02842fSSascha Wildner
5710d02842fSSascha Wildner /* Initialize the global ACPI register structures */
5720d02842fSSascha Wildner
5730d02842fSSascha Wildner AcpiTbSetupFadtRegisters ();
5740d02842fSSascha Wildner }
5750d02842fSSascha Wildner
5760d02842fSSascha Wildner
5770d02842fSSascha Wildner /*******************************************************************************
5780d02842fSSascha Wildner *
5790d02842fSSascha Wildner * FUNCTION: AcpiTbConvertFadt
5800d02842fSSascha Wildner *
5810d02842fSSascha Wildner * PARAMETERS: None - AcpiGbl_FADT is used.
5820d02842fSSascha Wildner *
5830d02842fSSascha Wildner * RETURN: None
5840d02842fSSascha Wildner *
5850d02842fSSascha Wildner * DESCRIPTION: Converts all versions of the FADT to a common internal format.
5860d02842fSSascha Wildner * Expand 32-bit addresses to 64-bit as necessary. Also validate
5870d02842fSSascha Wildner * important fields within the FADT.
5880d02842fSSascha Wildner *
5890d02842fSSascha Wildner * NOTE: AcpiGbl_FADT must be of size (ACPI_TABLE_FADT), and must
5900d02842fSSascha Wildner * contain a copy of the actual BIOS-provided FADT.
5910d02842fSSascha Wildner *
5920d02842fSSascha Wildner * Notes on 64-bit register addresses:
5930d02842fSSascha Wildner *
5940d02842fSSascha Wildner * After this FADT conversion, later ACPICA code will only use the 64-bit "X"
5950d02842fSSascha Wildner * fields of the FADT for all ACPI register addresses.
5960d02842fSSascha Wildner *
5970d02842fSSascha Wildner * The 64-bit X fields are optional extensions to the original 32-bit FADT
5980d02842fSSascha Wildner * V1.0 fields. Even if they are present in the FADT, they are optional and
5990d02842fSSascha Wildner * are unused if the BIOS sets them to zero. Therefore, we must copy/expand
6001093ca81SSascha Wildner * 32-bit V1.0 fields to the 64-bit X fields if the 64-bit X field is originally
6011093ca81SSascha Wildner * zero.
6020d02842fSSascha Wildner *
6030d02842fSSascha Wildner * For ACPI 1.0 FADTs (that contain no 64-bit addresses), all 32-bit address
6040d02842fSSascha Wildner * fields are expanded to the corresponding 64-bit X fields in the internal
6050d02842fSSascha Wildner * common FADT.
6060d02842fSSascha Wildner *
6070d02842fSSascha Wildner * For ACPI 2.0+ FADTs, all valid (non-zero) 32-bit address fields are expanded
6080d02842fSSascha Wildner * to the corresponding 64-bit X fields, if the 64-bit field is originally
6090d02842fSSascha Wildner * zero. Adhering to the ACPI specification, we completely ignore the 32-bit
6100d02842fSSascha Wildner * field if the 64-bit field is valid, regardless of whether the host OS is
6110d02842fSSascha Wildner * 32-bit or 64-bit.
6120d02842fSSascha Wildner *
6130d02842fSSascha Wildner * Possible additional checks:
6140d02842fSSascha Wildner * (AcpiGbl_FADT.Pm1EventLength >= 4)
6150d02842fSSascha Wildner * (AcpiGbl_FADT.Pm1ControlLength >= 2)
6160d02842fSSascha Wildner * (AcpiGbl_FADT.PmTimerLength >= 4)
6170d02842fSSascha Wildner * Gpe block lengths must be multiple of 2
6180d02842fSSascha Wildner *
6190d02842fSSascha Wildner ******************************************************************************/
6200d02842fSSascha Wildner
6210d02842fSSascha Wildner static void
AcpiTbConvertFadt(void)6220d02842fSSascha Wildner AcpiTbConvertFadt (
6230d02842fSSascha Wildner void)
6240d02842fSSascha Wildner {
6252ffe9f16SSascha Wildner const char *Name;
6260d02842fSSascha Wildner ACPI_GENERIC_ADDRESS *Address64;
6270d02842fSSascha Wildner UINT32 Address32;
6280d02842fSSascha Wildner UINT8 Length;
6299e1c0880SSascha Wildner UINT8 Flags;
6300d02842fSSascha Wildner UINT32 i;
6310d02842fSSascha Wildner
6320d02842fSSascha Wildner
6330d02842fSSascha Wildner /*
634a96e04f2SSascha Wildner * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
6350d02842fSSascha Wildner * should be zero are indeed zero. This will workaround BIOSs that
6360d02842fSSascha Wildner * inadvertently place values in these fields.
6370d02842fSSascha Wildner *
6380d02842fSSascha Wildner * The ACPI 1.0 reserved fields that will be zeroed are the bytes located
6390d02842fSSascha Wildner * at offset 45, 55, 95, and the word located at offset 109, 110.
6400d02842fSSascha Wildner *
641a96e04f2SSascha Wildner * Note: The FADT revision value is unreliable. Only the length can be
642a96e04f2SSascha Wildner * trusted.
6430d02842fSSascha Wildner */
644a96e04f2SSascha Wildner if (AcpiGbl_FADT.Header.Length <= ACPI_FADT_V2_SIZE)
6450d02842fSSascha Wildner {
6460d02842fSSascha Wildner AcpiGbl_FADT.PreferredProfile = 0;
6470d02842fSSascha Wildner AcpiGbl_FADT.PstateControl = 0;
6480d02842fSSascha Wildner AcpiGbl_FADT.CstControl = 0;
6490d02842fSSascha Wildner AcpiGbl_FADT.BootFlags = 0;
6500d02842fSSascha Wildner }
6510d02842fSSascha Wildner
6520d02842fSSascha Wildner /*
6530d02842fSSascha Wildner * Now we can update the local FADT length to the length of the
6540d02842fSSascha Wildner * current FADT version as defined by the ACPI specification.
6550d02842fSSascha Wildner * Thus, we will have a common FADT internally.
6560d02842fSSascha Wildner */
6570d02842fSSascha Wildner AcpiGbl_FADT.Header.Length = sizeof (ACPI_TABLE_FADT);
6580d02842fSSascha Wildner
6590d02842fSSascha Wildner /*
66025ca8c79SSascha Wildner * Expand the 32-bit DSDT addresses to 64-bit as necessary.
6610d02842fSSascha Wildner * Later ACPICA code will always use the X 64-bit field.
6620d02842fSSascha Wildner */
6630d02842fSSascha Wildner AcpiGbl_FADT.XDsdt = AcpiTbSelectAddress ("DSDT",
6640d02842fSSascha Wildner AcpiGbl_FADT.Dsdt, AcpiGbl_FADT.XDsdt);
6650d02842fSSascha Wildner
6660d02842fSSascha Wildner /* If Hardware Reduced flag is set, we are all done */
6670d02842fSSascha Wildner
6680d02842fSSascha Wildner if (AcpiGbl_ReducedHardware)
6690d02842fSSascha Wildner {
6700d02842fSSascha Wildner return;
6710d02842fSSascha Wildner }
6720d02842fSSascha Wildner
6730d02842fSSascha Wildner /* Examine all of the 64-bit extended address fields (X fields) */
6740d02842fSSascha Wildner
6750d02842fSSascha Wildner for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++)
6760d02842fSSascha Wildner {
6770d02842fSSascha Wildner /*
6780d02842fSSascha Wildner * Get the 32-bit and 64-bit addresses, as well as the register
6790d02842fSSascha Wildner * length and register name.
6800d02842fSSascha Wildner */
6810d02842fSSascha Wildner Address32 = *ACPI_ADD_PTR (UINT32,
6820d02842fSSascha Wildner &AcpiGbl_FADT, FadtInfoTable[i].Address32);
6830d02842fSSascha Wildner
6840d02842fSSascha Wildner Address64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS,
6850d02842fSSascha Wildner &AcpiGbl_FADT, FadtInfoTable[i].Address64);
6860d02842fSSascha Wildner
6870d02842fSSascha Wildner Length = *ACPI_ADD_PTR (UINT8,
6880d02842fSSascha Wildner &AcpiGbl_FADT, FadtInfoTable[i].Length);
6890d02842fSSascha Wildner
6900d02842fSSascha Wildner Name = FadtInfoTable[i].Name;
6919e1c0880SSascha Wildner Flags = FadtInfoTable[i].Flags;
6920d02842fSSascha Wildner
6930d02842fSSascha Wildner /*
6940d02842fSSascha Wildner * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
6950d02842fSSascha Wildner * generic address structures as necessary. Later code will always use
6960d02842fSSascha Wildner * the 64-bit address structures.
6970d02842fSSascha Wildner *
6980d02842fSSascha Wildner * November 2013:
6990d02842fSSascha Wildner * Now always use the 64-bit address if it is valid (non-zero), in
7000d02842fSSascha Wildner * accordance with the ACPI specification which states that a 64-bit
7010d02842fSSascha Wildner * address supersedes the 32-bit version. This behavior can be
7020d02842fSSascha Wildner * overridden by the AcpiGbl_Use32BitFadtAddresses flag.
7030d02842fSSascha Wildner *
7040d02842fSSascha Wildner * During 64-bit address construction and verification,
7050d02842fSSascha Wildner * these cases are handled:
7060d02842fSSascha Wildner *
7070d02842fSSascha Wildner * Address32 zero, Address64 [don't care] - Use Address64
7080d02842fSSascha Wildner *
709e5e174adSSascha Wildner * No override: if AcpiGbl_Use32BitFadtAddresses is FALSE, and:
7100d02842fSSascha Wildner * Address32 non-zero, Address64 zero - Copy/use Address32
7110d02842fSSascha Wildner * Address32 non-zero == Address64 non-zero - Use Address64
7120d02842fSSascha Wildner * Address32 non-zero != Address64 non-zero - Warning, use Address64
7130d02842fSSascha Wildner *
7140d02842fSSascha Wildner * Override: if AcpiGbl_Use32BitFadtAddresses is TRUE, and:
715e5e174adSSascha Wildner * Address32 non-zero, Address64 zero - Copy/use Address32
716e5e174adSSascha Wildner * Address32 non-zero == Address64 non-zero - Copy/use Address32
7170d02842fSSascha Wildner * Address32 non-zero != Address64 non-zero - Warning, copy/use Address32
7180d02842fSSascha Wildner *
7190d02842fSSascha Wildner * Note: SpaceId is always I/O for 32-bit legacy address fields
7200d02842fSSascha Wildner */
7210d02842fSSascha Wildner if (Address32)
7220d02842fSSascha Wildner {
723e5e174adSSascha Wildner if (Address64->Address)
7240d02842fSSascha Wildner {
725e5e174adSSascha Wildner if (Address64->Address != (UINT64) Address32)
7260d02842fSSascha Wildner {
7270d02842fSSascha Wildner /* Address mismatch */
7280d02842fSSascha Wildner
7290d02842fSSascha Wildner ACPI_BIOS_WARNING ((AE_INFO,
7300d02842fSSascha Wildner "32/64X address mismatch in FADT/%s: "
7310d02842fSSascha Wildner "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
7320d02842fSSascha Wildner Name, Address32,
7330d02842fSSascha Wildner ACPI_FORMAT_UINT64 (Address64->Address),
7340d02842fSSascha Wildner AcpiGbl_Use32BitFadtAddresses ? 32 : 64));
7350d02842fSSascha Wildner }
7360d02842fSSascha Wildner
7370d02842fSSascha Wildner /*
738e5e174adSSascha Wildner * For each extended field, check for length mismatch
739e5e174adSSascha Wildner * between the legacy length field and the corresponding
740e5e174adSSascha Wildner * 64-bit X length field.
741e5e174adSSascha Wildner * Note: If the legacy length field is > 0xFF bits, ignore
742e5e174adSSascha Wildner * this check. (GPE registers can be larger than the
74300ffa116SSascha Wildner * 64-bit GAS structure can accommodate, 0xFF bits).
7440d02842fSSascha Wildner */
745e5e174adSSascha Wildner if ((ACPI_MUL_8 (Length) <= ACPI_UINT8_MAX) &&
7460d02842fSSascha Wildner (Address64->BitWidth != ACPI_MUL_8 (Length)))
7470d02842fSSascha Wildner {
7480d02842fSSascha Wildner ACPI_BIOS_WARNING ((AE_INFO,
7490d02842fSSascha Wildner "32/64X length mismatch in FADT/%s: %u/%u",
7500d02842fSSascha Wildner Name, ACPI_MUL_8 (Length), Address64->BitWidth));
7510d02842fSSascha Wildner }
752e5e174adSSascha Wildner }
753e5e174adSSascha Wildner
754e5e174adSSascha Wildner /*
755e5e174adSSascha Wildner * Hardware register access code always uses the 64-bit fields.
756e5e174adSSascha Wildner * So if the 64-bit field is zero or is to be overridden,
757e5e174adSSascha Wildner * initialize it with the 32-bit fields.
758e5e174adSSascha Wildner * Note that when the 32-bit address favor is specified, the
759e5e174adSSascha Wildner * 64-bit fields are always re-initialized so that
760e5e174adSSascha Wildner * AccessSize/BitWidth/BitOffset fields can be correctly
761e5e174adSSascha Wildner * configured to the values to trigger a 32-bit compatible
762e5e174adSSascha Wildner * access mode in the hardware register access code.
763e5e174adSSascha Wildner */
764e5e174adSSascha Wildner if (!Address64->Address || AcpiGbl_Use32BitFadtAddresses)
765e5e174adSSascha Wildner {
766e5e174adSSascha Wildner AcpiTbInitGenericAddress (Address64,
767e5e174adSSascha Wildner ACPI_ADR_SPACE_SYSTEM_IO, Length,
768e5e174adSSascha Wildner (UINT64) Address32, Name, Flags);
769e5e174adSSascha Wildner }
770e5e174adSSascha Wildner }
7710d02842fSSascha Wildner
7729e1c0880SSascha Wildner if (FadtInfoTable[i].Flags & ACPI_FADT_REQUIRED)
7730d02842fSSascha Wildner {
7740d02842fSSascha Wildner /*
7750d02842fSSascha Wildner * Field is required (PM1aEvent, PM1aControl).
7760d02842fSSascha Wildner * Both the address and length must be non-zero.
7770d02842fSSascha Wildner */
7780d02842fSSascha Wildner if (!Address64->Address || !Length)
7790d02842fSSascha Wildner {
7800d02842fSSascha Wildner ACPI_BIOS_ERROR ((AE_INFO,
7810d02842fSSascha Wildner "Required FADT field %s has zero address and/or length: "
7820d02842fSSascha Wildner "0x%8.8X%8.8X/0x%X",
7830d02842fSSascha Wildner Name, ACPI_FORMAT_UINT64 (Address64->Address), Length));
7840d02842fSSascha Wildner }
7850d02842fSSascha Wildner }
7869e1c0880SSascha Wildner else if (FadtInfoTable[i].Flags & ACPI_FADT_SEPARATE_LENGTH)
7870d02842fSSascha Wildner {
7880d02842fSSascha Wildner /*
7890d02842fSSascha Wildner * Field is optional (PM2Control, GPE0, GPE1) AND has its own
7900d02842fSSascha Wildner * length field. If present, both the address and length must
7910d02842fSSascha Wildner * be valid.
7920d02842fSSascha Wildner */
7930d02842fSSascha Wildner if ((Address64->Address && !Length) ||
7940d02842fSSascha Wildner (!Address64->Address && Length))
7950d02842fSSascha Wildner {
7960d02842fSSascha Wildner ACPI_BIOS_WARNING ((AE_INFO,
7972ffe9f16SSascha Wildner "Optional FADT field %s has valid %s but zero %s: "
7982ffe9f16SSascha Wildner "0x%8.8X%8.8X/0x%X", Name,
7992ffe9f16SSascha Wildner (Length ? "Length" : "Address"),
8002ffe9f16SSascha Wildner (Length ? "Address": "Length"),
8012ffe9f16SSascha Wildner ACPI_FORMAT_UINT64 (Address64->Address), Length));
8020d02842fSSascha Wildner }
8030d02842fSSascha Wildner }
8040d02842fSSascha Wildner }
8050d02842fSSascha Wildner }
8060d02842fSSascha Wildner
8070d02842fSSascha Wildner
8080d02842fSSascha Wildner /*******************************************************************************
8090d02842fSSascha Wildner *
8100d02842fSSascha Wildner * FUNCTION: AcpiTbSetupFadtRegisters
8110d02842fSSascha Wildner *
8120d02842fSSascha Wildner * PARAMETERS: None, uses AcpiGbl_FADT.
8130d02842fSSascha Wildner *
8140d02842fSSascha Wildner * RETURN: None
8150d02842fSSascha Wildner *
8160d02842fSSascha Wildner * DESCRIPTION: Initialize global ACPI PM1 register definitions. Optionally,
8170d02842fSSascha Wildner * force FADT register definitions to their default lengths.
8180d02842fSSascha Wildner *
8190d02842fSSascha Wildner ******************************************************************************/
8200d02842fSSascha Wildner
8210d02842fSSascha Wildner static void
AcpiTbSetupFadtRegisters(void)8220d02842fSSascha Wildner AcpiTbSetupFadtRegisters (
8230d02842fSSascha Wildner void)
8240d02842fSSascha Wildner {
8250d02842fSSascha Wildner ACPI_GENERIC_ADDRESS *Target64;
8260d02842fSSascha Wildner ACPI_GENERIC_ADDRESS *Source64;
8270d02842fSSascha Wildner UINT8 Pm1RegisterByteWidth;
8280d02842fSSascha Wildner UINT32 i;
8290d02842fSSascha Wildner
8300d02842fSSascha Wildner
8310d02842fSSascha Wildner /*
8320d02842fSSascha Wildner * Optionally check all register lengths against the default values and
8330d02842fSSascha Wildner * update them if they are incorrect.
8340d02842fSSascha Wildner */
8350d02842fSSascha Wildner if (AcpiGbl_UseDefaultRegisterWidths)
8360d02842fSSascha Wildner {
8370d02842fSSascha Wildner for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++)
8380d02842fSSascha Wildner {
8390d02842fSSascha Wildner Target64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS, &AcpiGbl_FADT,
8400d02842fSSascha Wildner FadtInfoTable[i].Address64);
8410d02842fSSascha Wildner
8420d02842fSSascha Wildner /*
8430d02842fSSascha Wildner * If a valid register (Address != 0) and the (DefaultLength > 0)
8440d02842fSSascha Wildner * (Not a GPE register), then check the width against the default.
8450d02842fSSascha Wildner */
8460d02842fSSascha Wildner if ((Target64->Address) &&
8470d02842fSSascha Wildner (FadtInfoTable[i].DefaultLength > 0) &&
8480d02842fSSascha Wildner (FadtInfoTable[i].DefaultLength != Target64->BitWidth))
8490d02842fSSascha Wildner {
8500d02842fSSascha Wildner ACPI_BIOS_WARNING ((AE_INFO,
8510d02842fSSascha Wildner "Invalid length for FADT/%s: %u, using default %u",
8520d02842fSSascha Wildner FadtInfoTable[i].Name, Target64->BitWidth,
8530d02842fSSascha Wildner FadtInfoTable[i].DefaultLength));
8540d02842fSSascha Wildner
8550d02842fSSascha Wildner /* Incorrect size, set width to the default */
8560d02842fSSascha Wildner
8570d02842fSSascha Wildner Target64->BitWidth = FadtInfoTable[i].DefaultLength;
8580d02842fSSascha Wildner }
8590d02842fSSascha Wildner }
8600d02842fSSascha Wildner }
8610d02842fSSascha Wildner
8620d02842fSSascha Wildner /*
8630d02842fSSascha Wildner * Get the length of the individual PM1 registers (enable and status).
8640d02842fSSascha Wildner * Each register is defined to be (event block length / 2). Extra divide
8650d02842fSSascha Wildner * by 8 converts bits to bytes.
8660d02842fSSascha Wildner */
8670d02842fSSascha Wildner Pm1RegisterByteWidth = (UINT8)
8680d02842fSSascha Wildner ACPI_DIV_16 (AcpiGbl_FADT.XPm1aEventBlock.BitWidth);
8690d02842fSSascha Wildner
8700d02842fSSascha Wildner /*
8710d02842fSSascha Wildner * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
8720d02842fSSascha Wildner * registers. These addresses do not appear (directly) in the FADT, so it
8730d02842fSSascha Wildner * is useful to pre-calculate them from the PM1 Event Block definitions.
8740d02842fSSascha Wildner *
8750d02842fSSascha Wildner * The PM event blocks are split into two register blocks, first is the
8760d02842fSSascha Wildner * PM Status Register block, followed immediately by the PM Enable
8770d02842fSSascha Wildner * Register block. Each is of length (Pm1EventLength/2)
8780d02842fSSascha Wildner *
8790d02842fSSascha Wildner * Note: The PM1A event block is required by the ACPI specification.
8800d02842fSSascha Wildner * However, the PM1B event block is optional and is rarely, if ever,
8810d02842fSSascha Wildner * used.
8820d02842fSSascha Wildner */
8830d02842fSSascha Wildner
8840d02842fSSascha Wildner for (i = 0; i < ACPI_FADT_PM_INFO_ENTRIES; i++)
8850d02842fSSascha Wildner {
8860d02842fSSascha Wildner Source64 = ACPI_ADD_PTR (ACPI_GENERIC_ADDRESS, &AcpiGbl_FADT,
8870d02842fSSascha Wildner FadtPmInfoTable[i].Source);
8880d02842fSSascha Wildner
8890d02842fSSascha Wildner if (Source64->Address)
8900d02842fSSascha Wildner {
8910d02842fSSascha Wildner AcpiTbInitGenericAddress (FadtPmInfoTable[i].Target,
8920d02842fSSascha Wildner Source64->SpaceId, Pm1RegisterByteWidth,
8930d02842fSSascha Wildner Source64->Address +
8940d02842fSSascha Wildner (FadtPmInfoTable[i].RegisterNum * Pm1RegisterByteWidth),
8959e1c0880SSascha Wildner "PmRegisters", 0);
8960d02842fSSascha Wildner }
8970d02842fSSascha Wildner }
8980d02842fSSascha Wildner }
899