blob: a6454f4a6fb343b52cada9dc5394094768c6ea14 [file] [log] [blame]
Bob Moore95befdb2007-02-02 19:48:20 +03001/******************************************************************************
2 *
3 * Module Name: tbfadt - FADT table utilities
4 *
5 *****************************************************************************/
6
7/*
David E. Box82a80942015-02-05 15:20:45 +08008 * Copyright (C) 2000 - 2015, Intel Corp.
Bob Moore95befdb2007-02-02 19:48:20 +03009 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
46#include "actables.h"
Bob Moore95befdb2007-02-02 19:48:20 +030047
48#define _COMPONENT ACPI_TABLES
49ACPI_MODULE_NAME("tbfadt")
50
51/* Local prototypes */
Bob Moore66be71f2012-05-22 16:35:00 +080052static void
Bob Mooreea5d8eb2007-02-02 19:48:20 +030053acpi_tb_init_generic_address(struct acpi_generic_address *generic_address,
Bob Moore66be71f2012-05-22 16:35:00 +080054 u8 space_id,
Bob Moore21126b22014-04-30 10:06:09 +080055 u8 byte_width,
56 u64 address, char *register_name, u8 flags);
Bob Moore95befdb2007-02-02 19:48:20 +030057
Bob Moore71392842007-02-02 19:48:20 +030058static void acpi_tb_convert_fadt(void);
59
Bob Moore531c6332009-02-18 14:06:12 +080060static void acpi_tb_setup_fadt_registers(void);
61
Bob Moore0249ed22014-01-08 13:43:46 +080062static u64
63acpi_tb_select_address(char *register_name, u32 address32, u64 address64);
64
Bob Mooreea5d8eb2007-02-02 19:48:20 +030065/* Table for conversion of FADT to common internal format and FADT validation */
Bob Moore95befdb2007-02-02 19:48:20 +030066
Bob Mooreea5d8eb2007-02-02 19:48:20 +030067typedef struct acpi_fadt_info {
68 char *name;
Bob Mooreecafe6f2012-01-12 11:09:58 +080069 u16 address64;
70 u16 address32;
71 u16 length;
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +080072 u8 default_length;
Bob Moore21126b22014-04-30 10:06:09 +080073 u8 flags;
Bob Moore95befdb2007-02-02 19:48:20 +030074
Bob Mooreea5d8eb2007-02-02 19:48:20 +030075} acpi_fadt_info;
Bob Moore95befdb2007-02-02 19:48:20 +030076
Bob Mooreecafe6f2012-01-12 11:09:58 +080077#define ACPI_FADT_OPTIONAL 0
Bob Mooreea5d8eb2007-02-02 19:48:20 +030078#define ACPI_FADT_REQUIRED 1
79#define ACPI_FADT_SEPARATE_LENGTH 2
Bob Moore21126b22014-04-30 10:06:09 +080080#define ACPI_FADT_GPE_REGISTER 4
Bob Mooreea5d8eb2007-02-02 19:48:20 +030081
82static struct acpi_fadt_info fadt_info_table[] = {
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +080083 {"Pm1aEventBlock",
84 ACPI_FADT_OFFSET(xpm1a_event_block),
Bob Moore95befdb2007-02-02 19:48:20 +030085 ACPI_FADT_OFFSET(pm1a_event_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +080086 ACPI_FADT_OFFSET(pm1_event_length),
87 ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
88 ACPI_FADT_REQUIRED},
Bob Mooreea5d8eb2007-02-02 19:48:20 +030089
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +080090 {"Pm1bEventBlock",
91 ACPI_FADT_OFFSET(xpm1b_event_block),
Bob Moore95befdb2007-02-02 19:48:20 +030092 ACPI_FADT_OFFSET(pm1b_event_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +080093 ACPI_FADT_OFFSET(pm1_event_length),
94 ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
Bob Mooreecafe6f2012-01-12 11:09:58 +080095 ACPI_FADT_OPTIONAL},
Bob Mooreea5d8eb2007-02-02 19:48:20 +030096
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +080097 {"Pm1aControlBlock",
98 ACPI_FADT_OFFSET(xpm1a_control_block),
Bob Moore95befdb2007-02-02 19:48:20 +030099 ACPI_FADT_OFFSET(pm1a_control_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800100 ACPI_FADT_OFFSET(pm1_control_length),
101 ACPI_PM1_REGISTER_WIDTH,
102 ACPI_FADT_REQUIRED},
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300103
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800104 {"Pm1bControlBlock",
105 ACPI_FADT_OFFSET(xpm1b_control_block),
Bob Moore95befdb2007-02-02 19:48:20 +0300106 ACPI_FADT_OFFSET(pm1b_control_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800107 ACPI_FADT_OFFSET(pm1_control_length),
108 ACPI_PM1_REGISTER_WIDTH,
Bob Mooreecafe6f2012-01-12 11:09:58 +0800109 ACPI_FADT_OPTIONAL},
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300110
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800111 {"Pm2ControlBlock",
112 ACPI_FADT_OFFSET(xpm2_control_block),
Bob Moore95befdb2007-02-02 19:48:20 +0300113 ACPI_FADT_OFFSET(pm2_control_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800114 ACPI_FADT_OFFSET(pm2_control_length),
115 ACPI_PM2_REGISTER_WIDTH,
116 ACPI_FADT_SEPARATE_LENGTH},
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300117
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800118 {"PmTimerBlock",
119 ACPI_FADT_OFFSET(xpm_timer_block),
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300120 ACPI_FADT_OFFSET(pm_timer_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800121 ACPI_FADT_OFFSET(pm_timer_length),
122 ACPI_PM_TIMER_WIDTH,
Bob Moore1d82980c92013-08-08 15:29:51 +0800123 ACPI_FADT_SEPARATE_LENGTH}, /* ACPI 5.0A: Timer is optional */
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300124
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800125 {"Gpe0Block",
126 ACPI_FADT_OFFSET(xgpe0_block),
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300127 ACPI_FADT_OFFSET(gpe0_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800128 ACPI_FADT_OFFSET(gpe0_block_length),
129 0,
Bob Moore21126b22014-04-30 10:06:09 +0800130 ACPI_FADT_SEPARATE_LENGTH | ACPI_FADT_GPE_REGISTER},
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300131
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800132 {"Gpe1Block",
133 ACPI_FADT_OFFSET(xgpe1_block),
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300134 ACPI_FADT_OFFSET(gpe1_block),
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800135 ACPI_FADT_OFFSET(gpe1_block_length),
136 0,
Bob Moore21126b22014-04-30 10:06:09 +0800137 ACPI_FADT_SEPARATE_LENGTH | ACPI_FADT_GPE_REGISTER}
Bob Moore95befdb2007-02-02 19:48:20 +0300138};
139
Bob Mooreec41f192009-02-18 15:03:30 +0800140#define ACPI_FADT_INFO_ENTRIES \
141 (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
Bob Moore95befdb2007-02-02 19:48:20 +0300142
Bob Moore531c6332009-02-18 14:06:12 +0800143/* Table used to split Event Blocks into separate status/enable registers */
144
145typedef struct acpi_fadt_pm_info {
146 struct acpi_generic_address *target;
Bob Mooreecafe6f2012-01-12 11:09:58 +0800147 u16 source;
Bob Moore531c6332009-02-18 14:06:12 +0800148 u8 register_num;
149
150} acpi_fadt_pm_info;
151
152static struct acpi_fadt_pm_info fadt_pm_info_table[] = {
153 {&acpi_gbl_xpm1a_status,
154 ACPI_FADT_OFFSET(xpm1a_event_block),
155 0},
156
157 {&acpi_gbl_xpm1a_enable,
158 ACPI_FADT_OFFSET(xpm1a_event_block),
159 1},
160
161 {&acpi_gbl_xpm1b_status,
162 ACPI_FADT_OFFSET(xpm1b_event_block),
163 0},
164
165 {&acpi_gbl_xpm1b_enable,
166 ACPI_FADT_OFFSET(xpm1b_event_block),
167 1}
168};
169
Bob Mooreec41f192009-02-18 15:03:30 +0800170#define ACPI_FADT_PM_INFO_ENTRIES \
171 (sizeof (fadt_pm_info_table) / sizeof (struct acpi_fadt_pm_info))
Bob Moore531c6332009-02-18 14:06:12 +0800172
Bob Moore95befdb2007-02-02 19:48:20 +0300173/*******************************************************************************
174 *
175 * FUNCTION: acpi_tb_init_generic_address
176 *
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300177 * PARAMETERS: generic_address - GAS struct to be initialized
Lv Zheng75c80442012-12-19 05:36:49 +0000178 * space_id - ACPI Space ID for this register
Jan Beulichfcea94b2008-09-19 15:50:32 -0700179 * byte_width - Width of this register
Bob Mooreba494be2012-07-12 09:40:10 +0800180 * address - Address of the register
Bob Moore0249ed22014-01-08 13:43:46 +0800181 * register_name - ASCII name of the ACPI register
Bob Moore95befdb2007-02-02 19:48:20 +0300182 *
183 * RETURN: None
184 *
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300185 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
186 * See the ACPI specification for a full description and
187 * definition of this structure.
Bob Moore95befdb2007-02-02 19:48:20 +0300188 *
189 ******************************************************************************/
190
Bob Moore66be71f2012-05-22 16:35:00 +0800191static void
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300192acpi_tb_init_generic_address(struct acpi_generic_address *generic_address,
Bob Moore66be71f2012-05-22 16:35:00 +0800193 u8 space_id,
Bob Moore21126b22014-04-30 10:06:09 +0800194 u8 byte_width,
195 u64 address, char *register_name, u8 flags)
Bob Moore95befdb2007-02-02 19:48:20 +0300196{
Bob Moore66be71f2012-05-22 16:35:00 +0800197 u8 bit_width;
198
Bob Moore21126b22014-04-30 10:06:09 +0800199 /*
200 * Bit width field in the GAS is only one byte long, 255 max.
201 * Check for bit_width overflow in GAS.
202 */
Bob Moore66be71f2012-05-22 16:35:00 +0800203 bit_width = (u8)(byte_width * 8);
Bob Moore21126b22014-04-30 10:06:09 +0800204 if (byte_width > 31) { /* (31*8)=248, (32*8)=256 */
205 /*
206 * No error for GPE blocks, because we do not use the bit_width
207 * for GPEs, the legacy length (byte_width) is used instead to
208 * allow for a large number of GPEs.
209 */
210 if (!(flags & ACPI_FADT_GPE_REGISTER)) {
211 ACPI_ERROR((AE_INFO,
212 "%s - 32-bit FADT register is too long (%u bytes, %u bits) "
213 "to convert to GAS struct - 255 bits max, truncating",
214 register_name, byte_width,
215 (byte_width * 8)));
216 }
Bob Moore66be71f2012-05-22 16:35:00 +0800217
218 bit_width = 255;
219 }
Bob Moore95befdb2007-02-02 19:48:20 +0300220
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300221 /*
222 * The 64-bit Address field is non-aligned in the byte packed
223 * GAS struct.
224 */
225 ACPI_MOVE_64_TO_64(&generic_address->address, &address);
226
227 /* All other fields are byte-wide */
228
Bob Moore06f55412008-12-31 03:06:06 +0800229 generic_address->space_id = space_id;
Bob Moore66be71f2012-05-22 16:35:00 +0800230 generic_address->bit_width = bit_width;
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300231 generic_address->bit_offset = 0;
Bob Moore06f55412008-12-31 03:06:06 +0800232 generic_address->access_width = 0; /* Access width ANY */
Bob Moore95befdb2007-02-02 19:48:20 +0300233}
234
235/*******************************************************************************
236 *
Bob Moore0249ed22014-01-08 13:43:46 +0800237 * FUNCTION: acpi_tb_select_address
238 *
239 * PARAMETERS: register_name - ASCII name of the ACPI register
240 * address32 - 32-bit address of the register
241 * address64 - 64-bit address of the register
242 *
243 * RETURN: The resolved 64-bit address
244 *
245 * DESCRIPTION: Select between 32-bit and 64-bit versions of addresses within
246 * the FADT. Used for the FACS and DSDT addresses.
247 *
248 * NOTES:
249 *
250 * Check for FACS and DSDT address mismatches. An address mismatch between
251 * the 32-bit and 64-bit address fields (FIRMWARE_CTRL/X_FIRMWARE_CTRL and
252 * DSDT/X_DSDT) could be a corrupted address field or it might indicate
253 * the presence of two FACS or two DSDT tables.
254 *
255 * November 2013:
256 * By default, as per the ACPICA specification, a valid 64-bit address is
257 * used regardless of the value of the 32-bit address. However, this
258 * behavior can be overridden via the acpi_gbl_use32_bit_fadt_addresses flag.
259 *
260 ******************************************************************************/
261
262static u64
263acpi_tb_select_address(char *register_name, u32 address32, u64 address64)
264{
265
266 if (!address64) {
267
268 /* 64-bit address is zero, use 32-bit address */
269
270 return ((u64)address32);
271 }
272
273 if (address32 && (address64 != (u64)address32)) {
274
275 /* Address mismatch between 32-bit and 64-bit versions */
276
277 ACPI_BIOS_WARNING((AE_INFO,
278 "32/64X %s address mismatch in FADT: "
279 "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
280 register_name, address32,
281 ACPI_FORMAT_UINT64(address64),
282 acpi_gbl_use32_bit_fadt_addresses ? 32 :
283 64));
284
285 /* 32-bit address override */
286
287 if (acpi_gbl_use32_bit_fadt_addresses) {
288 return ((u64)address32);
289 }
290 }
291
292 /* Default is to use the 64-bit address */
293
294 return (address64);
295}
296
297/*******************************************************************************
298 *
Bob Moore95befdb2007-02-02 19:48:20 +0300299 * FUNCTION: acpi_tb_parse_fadt
300 *
Lv Zheng62fcce92015-10-14 13:53:57 +0800301 * PARAMETERS: None
Bob Moore95befdb2007-02-02 19:48:20 +0300302 *
303 * RETURN: None
304 *
305 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
306 * (FADT contains the addresses of the DSDT and FACS)
307 *
308 ******************************************************************************/
309
Lv Zheng62fcce92015-10-14 13:53:57 +0800310void acpi_tb_parse_fadt(void)
Bob Moore95befdb2007-02-02 19:48:20 +0300311{
312 u32 length;
313 struct acpi_table_header *table;
314
315 /*
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300316 * The FADT has multiple versions with different lengths,
317 * and it contains pointers to both the DSDT and FACS tables.
Bob Moore95befdb2007-02-02 19:48:20 +0300318 *
319 * Get a local copy of the FADT and convert it to a common format
320 * Map entire FADT, assumed to be smaller than one page.
321 */
Lv Zheng62fcce92015-10-14 13:53:57 +0800322 length = acpi_gbl_root_table_list.tables[acpi_gbl_fadt_index].length;
Bob Moore95befdb2007-02-02 19:48:20 +0300323
324 table =
Lv Zheng62fcce92015-10-14 13:53:57 +0800325 acpi_os_map_memory(acpi_gbl_root_table_list.
326 tables[acpi_gbl_fadt_index].address, length);
Bob Moore95befdb2007-02-02 19:48:20 +0300327 if (!table) {
328 return;
329 }
330
331 /*
332 * Validate the FADT checksum before we copy the table. Ignore
333 * checksum error as we want to try to get the DSDT and FACS.
334 */
335 (void)acpi_tb_verify_checksum(table, length);
336
Bob Moore531c6332009-02-18 14:06:12 +0800337 /* Create a local copy of the FADT in common ACPI 2.0+ format */
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300338
Bob Moore71392842007-02-02 19:48:20 +0300339 acpi_tb_create_local_fadt(table, length);
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300340
341 /* All done with the real FADT, unmap it */
342
Bob Moore95befdb2007-02-02 19:48:20 +0300343 acpi_os_unmap_memory(table, length);
344
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300345 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
Bob Moore95befdb2007-02-02 19:48:20 +0300346
Lv Zheng86dfc6f32014-04-04 12:38:57 +0800347 acpi_tb_install_fixed_table((acpi_physical_address) acpi_gbl_FADT.Xdsdt,
Lv Zheng8ec3f452015-08-25 10:29:01 +0800348 ACPI_SIG_DSDT, &acpi_gbl_dsdt_index);
Bob Moore95befdb2007-02-02 19:48:20 +0300349
Bob Moore22e5b402011-11-16 10:57:28 +0800350 /* If Hardware Reduced flag is set, there is no FACS */
351
352 if (!acpi_gbl_reduced_hardware) {
Lv Zhengc04e1fb2015-07-01 14:43:11 +0800353 if (acpi_gbl_FADT.facs) {
354 acpi_tb_install_fixed_table((acpi_physical_address)
355 acpi_gbl_FADT.facs,
356 ACPI_SIG_FACS,
Lv Zheng8ec3f452015-08-25 10:29:01 +0800357 &acpi_gbl_facs_index);
Lv Zhengc04e1fb2015-07-01 14:43:11 +0800358 }
359 if (acpi_gbl_FADT.Xfacs) {
360 acpi_tb_install_fixed_table((acpi_physical_address)
361 acpi_gbl_FADT.Xfacs,
362 ACPI_SIG_FACS,
Lv Zheng8ec3f452015-08-25 10:29:01 +0800363 &acpi_gbl_xfacs_index);
Lv Zhengc04e1fb2015-07-01 14:43:11 +0800364 }
Bob Moore22e5b402011-11-16 10:57:28 +0800365 }
Bob Moore95befdb2007-02-02 19:48:20 +0300366}
367
368/*******************************************************************************
369 *
Bob Moore71392842007-02-02 19:48:20 +0300370 * FUNCTION: acpi_tb_create_local_fadt
371 *
Bob Mooreba494be2012-07-12 09:40:10 +0800372 * PARAMETERS: table - Pointer to BIOS FADT
373 * length - Length of the table
Bob Moore71392842007-02-02 19:48:20 +0300374 *
375 * RETURN: None
376 *
377 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
378 * Performs validation on some important FADT fields.
379 *
Bob Moore55f8f3c2007-05-02 15:51:37 -0400380 * NOTE: We create a local copy of the FADT regardless of the version.
381 *
Bob Moore71392842007-02-02 19:48:20 +0300382 ******************************************************************************/
383
384void acpi_tb_create_local_fadt(struct acpi_table_header *table, u32 length)
385{
Bob Moore71392842007-02-02 19:48:20 +0300386 /*
Bob Moore55f8f3c2007-05-02 15:51:37 -0400387 * Check if the FADT is larger than the largest table that we expect
Bob Moore2355e102011-11-16 10:42:09 +0800388 * (the ACPI 5.0 version). If so, truncate the table, and issue
Bob Moore55f8f3c2007-05-02 15:51:37 -0400389 * a warning.
Bob Moore71392842007-02-02 19:48:20 +0300390 */
391 if (length > sizeof(struct acpi_table_fadt)) {
Bob Moore3b3ea772012-07-16 09:39:54 +0800392 ACPI_BIOS_WARNING((AE_INFO,
393 "FADT (revision %u) is longer than ACPI 5.0 version, "
394 "truncating length %u to %u",
395 table->revision, length,
396 (u32)sizeof(struct acpi_table_fadt)));
Bob Moore71392842007-02-02 19:48:20 +0300397 }
398
Bob Moore55f8f3c2007-05-02 15:51:37 -0400399 /* Clear the entire local FADT */
Bob Moore71392842007-02-02 19:48:20 +0300400
Bob Moore4fa46162015-07-01 14:45:11 +0800401 memset(&acpi_gbl_FADT, 0, sizeof(struct acpi_table_fadt));
Bob Moore71392842007-02-02 19:48:20 +0300402
Bob Moore55f8f3c2007-05-02 15:51:37 -0400403 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
404
Bob Moore4fa46162015-07-01 14:45:11 +0800405 memcpy(&acpi_gbl_FADT, table,
406 ACPI_MIN(length, sizeof(struct acpi_table_fadt)));
Bob Moore71392842007-02-02 19:48:20 +0300407
Bob Moore22e5b402011-11-16 10:57:28 +0800408 /* Take a copy of the Hardware Reduced flag */
409
410 acpi_gbl_reduced_hardware = FALSE;
411 if (acpi_gbl_FADT.flags & ACPI_FADT_HW_REDUCED) {
412 acpi_gbl_reduced_hardware = TRUE;
413 }
414
Bob Moore531c6332009-02-18 14:06:12 +0800415 /* Convert the local copy of the FADT to the common internal format */
416
Bob Moore71392842007-02-02 19:48:20 +0300417 acpi_tb_convert_fadt();
Bob Moore531c6332009-02-18 14:06:12 +0800418
Bob Moore531c6332009-02-18 14:06:12 +0800419 /* Initialize the global ACPI register structures */
420
421 acpi_tb_setup_fadt_registers();
Bob Moore71392842007-02-02 19:48:20 +0300422}
423
424/*******************************************************************************
425 *
Bob Moore95befdb2007-02-02 19:48:20 +0300426 * FUNCTION: acpi_tb_convert_fadt
427 *
Bob Moore0249ed22014-01-08 13:43:46 +0800428 * PARAMETERS: none - acpi_gbl_FADT is used.
Bob Moore95befdb2007-02-02 19:48:20 +0300429 *
430 * RETURN: None
431 *
432 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
Bob Moore0249ed22014-01-08 13:43:46 +0800433 * Expand 32-bit addresses to 64-bit as necessary. Also validate
434 * important fields within the FADT.
Bob Moore95befdb2007-02-02 19:48:20 +0300435 *
Bob Moore0249ed22014-01-08 13:43:46 +0800436 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt), and must
437 * contain a copy of the actual BIOS-provided FADT.
Bob Moore95befdb2007-02-02 19:48:20 +0300438 *
Bob Moore31fbc072009-03-19 10:12:13 +0800439 * Notes on 64-bit register addresses:
Bob Moore95befdb2007-02-02 19:48:20 +0300440 *
Bob Moore31fbc072009-03-19 10:12:13 +0800441 * After this FADT conversion, later ACPICA code will only use the 64-bit "X"
442 * fields of the FADT for all ACPI register addresses.
Bob Moore95befdb2007-02-02 19:48:20 +0300443 *
Bob Moore0249ed22014-01-08 13:43:46 +0800444 * The 64-bit X fields are optional extensions to the original 32-bit FADT
Bob Moore31fbc072009-03-19 10:12:13 +0800445 * V1.0 fields. Even if they are present in the FADT, they are optional and
446 * are unused if the BIOS sets them to zero. Therefore, we must copy/expand
Bob Moore0249ed22014-01-08 13:43:46 +0800447 * 32-bit V1.0 fields to the 64-bit X fields if the the 64-bit X field is
448 * originally zero.
Bob Moore95befdb2007-02-02 19:48:20 +0300449 *
Bob Moore0249ed22014-01-08 13:43:46 +0800450 * For ACPI 1.0 FADTs (that contain no 64-bit addresses), all 32-bit address
451 * fields are expanded to the corresponding 64-bit X fields in the internal
452 * common FADT.
Bob Moore31fbc072009-03-19 10:12:13 +0800453 *
454 * For ACPI 2.0+ FADTs, all valid (non-zero) 32-bit address fields are expanded
Bob Moore0249ed22014-01-08 13:43:46 +0800455 * to the corresponding 64-bit X fields, if the 64-bit field is originally
456 * zero. Adhering to the ACPI specification, we completely ignore the 32-bit
457 * field if the 64-bit field is valid, regardless of whether the host OS is
458 * 32-bit or 64-bit.
459 *
460 * Possible additional checks:
461 * (acpi_gbl_FADT.pm1_event_length >= 4)
462 * (acpi_gbl_FADT.pm1_control_length >= 2)
463 * (acpi_gbl_FADT.pm_timer_length >= 4)
464 * Gpe block lengths must be multiple of 2
Bob Moore95befdb2007-02-02 19:48:20 +0300465 *
466 ******************************************************************************/
467
Bob Moore71392842007-02-02 19:48:20 +0300468static void acpi_tb_convert_fadt(void)
Bob Moore95befdb2007-02-02 19:48:20 +0300469{
Bob Moore0249ed22014-01-08 13:43:46 +0800470 char *name;
Bob Moore31fbc072009-03-19 10:12:13 +0800471 struct acpi_generic_address *address64;
472 u32 address32;
Bob Moore0249ed22014-01-08 13:43:46 +0800473 u8 length;
Bob Moore21126b22014-04-30 10:06:09 +0800474 u8 flags;
Bob Moore67a119f2008-06-10 13:42:13 +0800475 u32 i;
Bob Moore95befdb2007-02-02 19:48:20 +0300476
Bob Moorec87609f2008-11-12 15:23:20 +0800477 /*
Bob Moore55f8f3c2007-05-02 15:51:37 -0400478 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
479 * should be zero are indeed zero. This will workaround BIOSs that
480 * inadvertently place values in these fields.
481 *
Lv Zheng75c80442012-12-19 05:36:49 +0000482 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located
483 * at offset 45, 55, 95, and the word located at offset 109, 110.
Bob Moore64b3db22011-02-14 15:50:42 +0800484 *
485 * Note: The FADT revision value is unreliable. Only the length can be
486 * trusted.
Bob Moore55f8f3c2007-05-02 15:51:37 -0400487 */
Bob Moore64b3db22011-02-14 15:50:42 +0800488 if (acpi_gbl_FADT.header.length <= ACPI_FADT_V2_SIZE) {
Bob Moore55f8f3c2007-05-02 15:51:37 -0400489 acpi_gbl_FADT.preferred_profile = 0;
490 acpi_gbl_FADT.pstate_control = 0;
491 acpi_gbl_FADT.cst_control = 0;
492 acpi_gbl_FADT.boot_flags = 0;
493 }
494
Bob Moore0249ed22014-01-08 13:43:46 +0800495 /*
496 * Now we can update the local FADT length to the length of the
497 * current FADT version as defined by the ACPI specification.
498 * Thus, we will have a common FADT internally.
499 */
Julian Anastasov3e80acd2012-02-23 22:40:43 +0200500 acpi_gbl_FADT.header.length = sizeof(struct acpi_table_fadt);
501
Bob Moore55f8f3c2007-05-02 15:51:37 -0400502 /*
Lv Zhengc04e1fb2015-07-01 14:43:11 +0800503 * Expand the 32-bit DSDT addresses to 64-bit as necessary.
Bob Moore0249ed22014-01-08 13:43:46 +0800504 * Later ACPICA code will always use the X 64-bit field.
Bob Moore95befdb2007-02-02 19:48:20 +0300505 */
Bob Moore0249ed22014-01-08 13:43:46 +0800506 acpi_gbl_FADT.Xdsdt = acpi_tb_select_address("DSDT",
507 acpi_gbl_FADT.dsdt,
508 acpi_gbl_FADT.Xdsdt);
Bob Moore06f55412008-12-31 03:06:06 +0800509
Bob Moore22e5b402011-11-16 10:57:28 +0800510 /* If Hardware Reduced flag is set, we are all done */
511
512 if (acpi_gbl_reduced_hardware) {
513 return;
514 }
515
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300516 /* Examine all of the 64-bit extended address fields (X fields) */
Bob Moore95befdb2007-02-02 19:48:20 +0300517
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300518 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
Bob Moore06f55412008-12-31 03:06:06 +0800519 /*
Bob Moore0249ed22014-01-08 13:43:46 +0800520 * Get the 32-bit and 64-bit addresses, as well as the register
521 * length and register name.
Bob Moore06f55412008-12-31 03:06:06 +0800522 */
Bob Moore0249ed22014-01-08 13:43:46 +0800523 address32 = *ACPI_ADD_PTR(u32,
524 &acpi_gbl_FADT,
525 fadt_info_table[i].address32);
526
Bob Moore06f55412008-12-31 03:06:06 +0800527 address64 = ACPI_ADD_PTR(struct acpi_generic_address,
528 &acpi_gbl_FADT,
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800529 fadt_info_table[i].address64);
Bob Moore0249ed22014-01-08 13:43:46 +0800530
531 length = *ACPI_ADD_PTR(u8,
532 &acpi_gbl_FADT,
533 fadt_info_table[i].length);
534
Bob Moore06f55412008-12-31 03:06:06 +0800535 name = fadt_info_table[i].name;
Bob Moore21126b22014-04-30 10:06:09 +0800536 flags = fadt_info_table[i].flags;
Bob Moore06f55412008-12-31 03:06:06 +0800537
538 /*
Bob Moore0249ed22014-01-08 13:43:46 +0800539 * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
540 * generic address structures as necessary. Later code will always use
541 * the 64-bit address structures.
542 *
543 * November 2013:
544 * Now always use the 64-bit address if it is valid (non-zero), in
545 * accordance with the ACPI specification which states that a 64-bit
546 * address supersedes the 32-bit version. This behavior can be
547 * overridden by the acpi_gbl_use32_bit_fadt_addresses flag.
548 *
549 * During 64-bit address construction and verification,
550 * these cases are handled:
551 *
552 * Address32 zero, Address64 [don't care] - Use Address64
553 *
554 * Address32 non-zero, Address64 zero - Copy/use Address32
555 * Address32 non-zero == Address64 non-zero - Use Address64
556 * Address32 non-zero != Address64 non-zero - Warning, use Address64
557 *
558 * Override: if acpi_gbl_use32_bit_fadt_addresses is TRUE, and:
559 * Address32 non-zero != Address64 non-zero - Warning, copy/use Address32
560 *
561 * Note: space_id is always I/O for 32-bit legacy address fields
562 */
563 if (address32) {
564 if (!address64->address) {
565
566 /* 64-bit address is zero, use 32-bit address */
567
568 acpi_tb_init_generic_address(address64,
569 ACPI_ADR_SPACE_SYSTEM_IO,
570 *ACPI_ADD_PTR(u8,
571 &acpi_gbl_FADT,
572 fadt_info_table
573 [i].
574 length),
575 (u64)address32,
Bob Moore21126b22014-04-30 10:06:09 +0800576 name, flags);
Bob Moore0249ed22014-01-08 13:43:46 +0800577 } else if (address64->address != (u64)address32) {
578
579 /* Address mismatch */
580
581 ACPI_BIOS_WARNING((AE_INFO,
582 "32/64X address mismatch in FADT/%s: "
583 "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
584 name, address32,
585 ACPI_FORMAT_UINT64
586 (address64->address),
587 acpi_gbl_use32_bit_fadt_addresses
588 ? 32 : 64));
589
590 if (acpi_gbl_use32_bit_fadt_addresses) {
591
592 /* 32-bit address override */
593
594 acpi_tb_init_generic_address(address64,
595 ACPI_ADR_SPACE_SYSTEM_IO,
596 *ACPI_ADD_PTR
597 (u8,
598 &acpi_gbl_FADT,
599 fadt_info_table
600 [i].
601 length),
602 (u64)
603 address32,
Bob Moore21126b22014-04-30 10:06:09 +0800604 name,
605 flags);
Bob Moore0249ed22014-01-08 13:43:46 +0800606 }
607 }
608 }
609
610 /*
Bob Moore06f55412008-12-31 03:06:06 +0800611 * For each extended field, check for length mismatch between the
robert.moore@intel.com4b67a0e2008-12-31 13:07:26 +0800612 * legacy length field and the corresponding 64-bit X length field.
Linn Crosetto6d1490e2013-04-12 00:25:17 +0000613 * Note: If the legacy length field is > 0xFF bits, ignore this
614 * check. (GPE registers can be larger than the 64-bit GAS structure
615 * can accomodate, 0xFF bits).
Bob Moore06f55412008-12-31 03:06:06 +0800616 */
Bob Mooreaab61b62009-03-06 10:09:00 +0800617 if (address64->address &&
Linn Crosetto6d1490e2013-04-12 00:25:17 +0000618 (ACPI_MUL_8(length) <= ACPI_UINT8_MAX) &&
Bob Mooreaab61b62009-03-06 10:09:00 +0800619 (address64->bit_width != ACPI_MUL_8(length))) {
Bob Moore3b3ea772012-07-16 09:39:54 +0800620 ACPI_BIOS_WARNING((AE_INFO,
621 "32/64X length mismatch in FADT/%s: %u/%u",
622 name, ACPI_MUL_8(length),
623 address64->bit_width));
Bob Moore06f55412008-12-31 03:06:06 +0800624 }
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300625
Bob Moore21126b22014-04-30 10:06:09 +0800626 if (fadt_info_table[i].flags & ACPI_FADT_REQUIRED) {
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300627 /*
Bob Moore1d82980c92013-08-08 15:29:51 +0800628 * Field is required (Pm1a_event, Pm1a_control).
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300629 * Both the address and length must be non-zero.
630 */
631 if (!address64->address || !length) {
Bob Moore3b3ea772012-07-16 09:39:54 +0800632 ACPI_BIOS_ERROR((AE_INFO,
633 "Required FADT field %s has zero address and/or length: "
634 "0x%8.8X%8.8X/0x%X",
635 name,
636 ACPI_FORMAT_UINT64(address64->
637 address),
638 length));
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300639 }
Bob Moore21126b22014-04-30 10:06:09 +0800640 } else if (fadt_info_table[i].flags & ACPI_FADT_SEPARATE_LENGTH) {
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300641 /*
Bob Mooreba494be2012-07-12 09:40:10 +0800642 * Field is optional (Pm2_control, GPE0, GPE1) AND has its own
Bob Mooreec41f192009-02-18 15:03:30 +0800643 * length field. If present, both the address and length must
644 * be valid.
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300645 */
Bob Mooreec41f192009-02-18 15:03:30 +0800646 if ((address64->address && !length) ||
647 (!address64->address && length)) {
Bob Moore3b3ea772012-07-16 09:39:54 +0800648 ACPI_BIOS_WARNING((AE_INFO,
649 "Optional FADT field %s has zero address or length: "
650 "0x%8.8X%8.8X/0x%X",
651 name,
652 ACPI_FORMAT_UINT64
653 (address64->address),
654 length));
Bob Mooreea5d8eb2007-02-02 19:48:20 +0300655 }
656 }
Bob Moore95befdb2007-02-02 19:48:20 +0300657 }
Bob Moore95befdb2007-02-02 19:48:20 +0300658}
Bob Moore531c6332009-02-18 14:06:12 +0800659
Bob Mooreec41f192009-02-18 15:03:30 +0800660/*******************************************************************************
Bob Moore531c6332009-02-18 14:06:12 +0800661 *
662 * FUNCTION: acpi_tb_setup_fadt_registers
663 *
664 * PARAMETERS: None, uses acpi_gbl_FADT.
665 *
666 * RETURN: None
667 *
668 * DESCRIPTION: Initialize global ACPI PM1 register definitions. Optionally,
669 * force FADT register definitions to their default lengths.
670 *
671 ******************************************************************************/
672
673static void acpi_tb_setup_fadt_registers(void)
674{
675 struct acpi_generic_address *target64;
676 struct acpi_generic_address *source64;
677 u8 pm1_register_byte_width;
678 u32 i;
679
680 /*
681 * Optionally check all register lengths against the default values and
682 * update them if they are incorrect.
683 */
684 if (acpi_gbl_use_default_register_widths) {
685 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
686 target64 =
687 ACPI_ADD_PTR(struct acpi_generic_address,
688 &acpi_gbl_FADT,
689 fadt_info_table[i].address64);
690
691 /*
692 * If a valid register (Address != 0) and the (default_length > 0)
693 * (Not a GPE register), then check the width against the default.
694 */
695 if ((target64->address) &&
696 (fadt_info_table[i].default_length > 0) &&
697 (fadt_info_table[i].default_length !=
698 target64->bit_width)) {
Bob Moore3b3ea772012-07-16 09:39:54 +0800699 ACPI_BIOS_WARNING((AE_INFO,
700 "Invalid length for FADT/%s: %u, using default %u",
701 fadt_info_table[i].name,
702 target64->bit_width,
703 fadt_info_table[i].
704 default_length));
Bob Moore531c6332009-02-18 14:06:12 +0800705
706 /* Incorrect size, set width to the default */
707
708 target64->bit_width =
709 fadt_info_table[i].default_length;
710 }
711 }
712 }
713
714 /*
715 * Get the length of the individual PM1 registers (enable and status).
716 * Each register is defined to be (event block length / 2). Extra divide
717 * by 8 converts bits to bytes.
718 */
Bob Mooreec41f192009-02-18 15:03:30 +0800719 pm1_register_byte_width = (u8)
720 ACPI_DIV_16(acpi_gbl_FADT.xpm1a_event_block.bit_width);
Bob Moore531c6332009-02-18 14:06:12 +0800721
722 /*
723 * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
724 * registers. These addresses do not appear (directly) in the FADT, so it
725 * is useful to pre-calculate them from the PM1 Event Block definitions.
726 *
727 * The PM event blocks are split into two register blocks, first is the
728 * PM Status Register block, followed immediately by the PM Enable
729 * Register block. Each is of length (pm1_event_length/2)
730 *
731 * Note: The PM1A event block is required by the ACPI specification.
732 * However, the PM1B event block is optional and is rarely, if ever,
733 * used.
734 */
735
736 for (i = 0; i < ACPI_FADT_PM_INFO_ENTRIES; i++) {
737 source64 =
738 ACPI_ADD_PTR(struct acpi_generic_address, &acpi_gbl_FADT,
739 fadt_pm_info_table[i].source);
740
Lin Ming5e053e72009-03-04 14:31:25 +0800741 if (source64->address) {
742 acpi_tb_init_generic_address(fadt_pm_info_table[i].
743 target, source64->space_id,
744 pm1_register_byte_width,
745 source64->address +
746 (fadt_pm_info_table[i].
747 register_num *
Bob Moore66be71f2012-05-22 16:35:00 +0800748 pm1_register_byte_width),
Bob Moore21126b22014-04-30 10:06:09 +0800749 "PmRegisters", 0);
Lin Ming5e053e72009-03-04 14:31:25 +0800750 }
Bob Moore531c6332009-02-18 14:06:12 +0800751 }
752}