1 /******************************************************************************
3 * Module Name: tbfadt - FADT table utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_TABLES
49 ACPI_MODULE_NAME("tbfadt")
51 /* Local prototypes */
53 acpi_tb_init_generic_address(struct acpi_generic_address *generic_address,
54 u8 space_id, u8 byte_width, u64 address);
56 static void acpi_tb_convert_fadt(void);
58 static void acpi_tb_validate_fadt(void);
60 static void acpi_tb_setup_fadt_registers(void);
62 /* Table for conversion of FADT to common internal format and FADT validation */
64 typedef struct acpi_fadt_info {
74 #define ACPI_FADT_REQUIRED 1
75 #define ACPI_FADT_SEPARATE_LENGTH 2
77 static struct acpi_fadt_info fadt_info_table[] = {
79 ACPI_FADT_OFFSET(xpm1a_event_block),
80 ACPI_FADT_OFFSET(pm1a_event_block),
81 ACPI_FADT_OFFSET(pm1_event_length),
82 ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
86 ACPI_FADT_OFFSET(xpm1b_event_block),
87 ACPI_FADT_OFFSET(pm1b_event_block),
88 ACPI_FADT_OFFSET(pm1_event_length),
89 ACPI_PM1_REGISTER_WIDTH * 2, /* Enable + Status register */
93 ACPI_FADT_OFFSET(xpm1a_control_block),
94 ACPI_FADT_OFFSET(pm1a_control_block),
95 ACPI_FADT_OFFSET(pm1_control_length),
96 ACPI_PM1_REGISTER_WIDTH,
100 ACPI_FADT_OFFSET(xpm1b_control_block),
101 ACPI_FADT_OFFSET(pm1b_control_block),
102 ACPI_FADT_OFFSET(pm1_control_length),
103 ACPI_PM1_REGISTER_WIDTH,
107 ACPI_FADT_OFFSET(xpm2_control_block),
108 ACPI_FADT_OFFSET(pm2_control_block),
109 ACPI_FADT_OFFSET(pm2_control_length),
110 ACPI_PM2_REGISTER_WIDTH,
111 ACPI_FADT_SEPARATE_LENGTH},
114 ACPI_FADT_OFFSET(xpm_timer_block),
115 ACPI_FADT_OFFSET(pm_timer_block),
116 ACPI_FADT_OFFSET(pm_timer_length),
121 ACPI_FADT_OFFSET(xgpe0_block),
122 ACPI_FADT_OFFSET(gpe0_block),
123 ACPI_FADT_OFFSET(gpe0_block_length),
125 ACPI_FADT_SEPARATE_LENGTH},
128 ACPI_FADT_OFFSET(xgpe1_block),
129 ACPI_FADT_OFFSET(gpe1_block),
130 ACPI_FADT_OFFSET(gpe1_block_length),
132 ACPI_FADT_SEPARATE_LENGTH}
135 #define ACPI_FADT_INFO_ENTRIES \
136 (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
138 /* Table used to split Event Blocks into separate status/enable registers */
140 typedef struct acpi_fadt_pm_info {
141 struct acpi_generic_address *target;
147 static struct acpi_fadt_pm_info fadt_pm_info_table[] = {
148 {&acpi_gbl_xpm1a_status,
149 ACPI_FADT_OFFSET(xpm1a_event_block),
152 {&acpi_gbl_xpm1a_enable,
153 ACPI_FADT_OFFSET(xpm1a_event_block),
156 {&acpi_gbl_xpm1b_status,
157 ACPI_FADT_OFFSET(xpm1b_event_block),
160 {&acpi_gbl_xpm1b_enable,
161 ACPI_FADT_OFFSET(xpm1b_event_block),
165 #define ACPI_FADT_PM_INFO_ENTRIES \
166 (sizeof (fadt_pm_info_table) / sizeof (struct acpi_fadt_pm_info))
168 /*******************************************************************************
170 * FUNCTION: acpi_tb_init_generic_address
172 * PARAMETERS: generic_address - GAS struct to be initialized
173 * byte_width - Width of this register
174 * Address - Address of the register
178 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
179 * See the ACPI specification for a full description and
180 * definition of this structure.
182 ******************************************************************************/
185 acpi_tb_init_generic_address(struct acpi_generic_address *generic_address,
186 u8 space_id, u8 byte_width, u64 address)
190 * The 64-bit Address field is non-aligned in the byte packed
193 ACPI_MOVE_64_TO_64(&generic_address->address, &address);
195 /* All other fields are byte-wide */
197 generic_address->space_id = space_id;
198 generic_address->bit_width = (u8)ACPI_MUL_8(byte_width);
199 generic_address->bit_offset = 0;
200 generic_address->access_width = 0; /* Access width ANY */
203 /*******************************************************************************
205 * FUNCTION: acpi_tb_parse_fadt
207 * PARAMETERS: table_index - Index for the FADT
211 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
212 * (FADT contains the addresses of the DSDT and FACS)
214 ******************************************************************************/
216 void acpi_tb_parse_fadt(u32 table_index)
219 struct acpi_table_header *table;
222 * The FADT has multiple versions with different lengths,
223 * and it contains pointers to both the DSDT and FACS tables.
225 * Get a local copy of the FADT and convert it to a common format
226 * Map entire FADT, assumed to be smaller than one page.
228 length = acpi_gbl_root_table_list.tables[table_index].length;
231 acpi_os_map_memory(acpi_gbl_root_table_list.tables[table_index].
238 * Validate the FADT checksum before we copy the table. Ignore
239 * checksum error as we want to try to get the DSDT and FACS.
241 (void)acpi_tb_verify_checksum(table, length);
243 /* Create a local copy of the FADT in common ACPI 2.0+ format */
245 acpi_tb_create_local_fadt(table, length);
247 /* All done with the real FADT, unmap it */
249 acpi_os_unmap_memory(table, length);
251 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
253 acpi_tb_install_table((acpi_physical_address) acpi_gbl_FADT.Xdsdt,
254 ACPI_SIG_DSDT, ACPI_TABLE_INDEX_DSDT);
256 acpi_tb_install_table((acpi_physical_address) acpi_gbl_FADT.Xfacs,
257 ACPI_SIG_FACS, ACPI_TABLE_INDEX_FACS);
260 /*******************************************************************************
262 * FUNCTION: acpi_tb_create_local_fadt
264 * PARAMETERS: Table - Pointer to BIOS FADT
265 * Length - Length of the table
269 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
270 * Performs validation on some important FADT fields.
272 * NOTE: We create a local copy of the FADT regardless of the version.
274 ******************************************************************************/
276 void acpi_tb_create_local_fadt(struct acpi_table_header *table, u32 length)
280 * Check if the FADT is larger than the largest table that we expect
281 * (the ACPI 2.0/3.0 version). If so, truncate the table, and issue
284 if (length > sizeof(struct acpi_table_fadt)) {
285 ACPI_WARNING((AE_INFO,
286 "FADT (revision %u) is longer than ACPI 2.0 version, "
287 "truncating length 0x%X to 0x%zX",
288 table->revision, (unsigned)length,
289 sizeof(struct acpi_table_fadt)));
292 /* Clear the entire local FADT */
294 ACPI_MEMSET(&acpi_gbl_FADT, 0, sizeof(struct acpi_table_fadt));
296 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
298 ACPI_MEMCPY(&acpi_gbl_FADT, table,
299 ACPI_MIN(length, sizeof(struct acpi_table_fadt)));
301 /* Convert the local copy of the FADT to the common internal format */
303 acpi_tb_convert_fadt();
305 /* Validate FADT values now, before we make any changes */
307 acpi_tb_validate_fadt();
309 /* Initialize the global ACPI register structures */
311 acpi_tb_setup_fadt_registers();
314 /*******************************************************************************
316 * FUNCTION: acpi_tb_convert_fadt
318 * PARAMETERS: None, uses acpi_gbl_FADT
322 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
323 * Expand all 32-bit addresses to 64-bit.
325 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt),
326 * and must contain a copy of the actual FADT.
328 * ACPICA will use the "X" fields of the FADT for all addresses.
330 * "X" fields are optional extensions to the original V1.0 fields. Even if
331 * they are present in the structure, they can be optionally not used by
332 * setting them to zero. Therefore, we must selectively expand V1.0 fields
333 * if the corresponding X field is zero.
335 * For ACPI 1.0 FADTs, all address fields are expanded to the corresponding
338 * For ACPI 2.0 FADTs, any "X" fields that are NULL are filled in by
339 * expanding the corresponding ACPI 1.0 field.
341 ******************************************************************************/
343 static void acpi_tb_convert_fadt(void)
345 struct acpi_generic_address *target64;
348 /* Update the local FADT table header length */
350 acpi_gbl_FADT.header.length = sizeof(struct acpi_table_fadt);
353 * Expand the 32-bit FACS and DSDT addresses to 64-bit as necessary.
354 * Later code will always use the X 64-bit field. Also, check for an
355 * address mismatch between the 32-bit and 64-bit address fields
356 * (FIRMWARE_CTRL/X_FIRMWARE_CTRL, DSDT/X_DSDT) which would indicate
357 * the presence of two FACS or two DSDT tables.
359 if (!acpi_gbl_FADT.Xfacs) {
360 acpi_gbl_FADT.Xfacs = (u64) acpi_gbl_FADT.facs;
361 } else if (acpi_gbl_FADT.facs &&
362 (acpi_gbl_FADT.Xfacs != (u64) acpi_gbl_FADT.facs)) {
363 ACPI_WARNING((AE_INFO,
364 "32/64 FACS address mismatch in FADT - two FACS tables!"));
367 if (!acpi_gbl_FADT.Xdsdt) {
368 acpi_gbl_FADT.Xdsdt = (u64) acpi_gbl_FADT.dsdt;
369 } else if (acpi_gbl_FADT.dsdt &&
370 (acpi_gbl_FADT.Xdsdt != (u64) acpi_gbl_FADT.dsdt)) {
371 ACPI_WARNING((AE_INFO,
372 "32/64 DSDT address mismatch in FADT - two DSDT tables!"));
376 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
377 * should be zero are indeed zero. This will workaround BIOSs that
378 * inadvertently place values in these fields.
380 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located at
381 * offset 45, 55, 95, and the word located at offset 109, 110.
383 if (acpi_gbl_FADT.header.revision < FADT2_REVISION_ID) {
384 acpi_gbl_FADT.preferred_profile = 0;
385 acpi_gbl_FADT.pstate_control = 0;
386 acpi_gbl_FADT.cst_control = 0;
387 acpi_gbl_FADT.boot_flags = 0;
391 * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
392 * generic address structures as necessary. Later code will always use
393 * the 64-bit address structures.
395 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
397 ACPI_ADD_PTR(struct acpi_generic_address, &acpi_gbl_FADT,
398 fadt_info_table[i].address64);
400 /* Expand only if the 64-bit X target is null */
402 if (!target64->address) {
404 /* The space_id is always I/O for the 32-bit legacy address fields */
406 acpi_tb_init_generic_address(target64,
407 ACPI_ADR_SPACE_SYSTEM_IO,
412 (u64) * ACPI_ADD_PTR(u32,
421 /*******************************************************************************
423 * FUNCTION: acpi_tb_validate_fadt
425 * PARAMETERS: Table - Pointer to the FADT to be validated
429 * DESCRIPTION: Validate various important fields within the FADT. If a problem
430 * is found, issue a message, but no status is returned.
431 * Used by both the table manager and the disassembler.
433 * Possible additional checks:
434 * (acpi_gbl_FADT.pm1_event_length >= 4)
435 * (acpi_gbl_FADT.pm1_control_length >= 2)
436 * (acpi_gbl_FADT.pm_timer_length >= 4)
437 * Gpe block lengths must be multiple of 2
439 ******************************************************************************/
441 static void acpi_tb_validate_fadt(void)
445 struct acpi_generic_address *address64;
450 * Check for FACS and DSDT address mismatches. An address mismatch between
451 * the 32-bit and 64-bit address fields (FIRMWARE_CTRL/X_FIRMWARE_CTRL and
452 * DSDT/X_DSDT) would indicate the presence of two FACS or two DSDT tables.
454 if (acpi_gbl_FADT.facs &&
455 (acpi_gbl_FADT.Xfacs != (u64) acpi_gbl_FADT.facs)) {
456 ACPI_WARNING((AE_INFO,
457 "32/64X FACS address mismatch in FADT - "
458 "two FACS tables! %8.8X/%8.8X%8.8X",
460 ACPI_FORMAT_UINT64(acpi_gbl_FADT.Xfacs)));
463 if (acpi_gbl_FADT.dsdt &&
464 (acpi_gbl_FADT.Xdsdt != (u64) acpi_gbl_FADT.dsdt)) {
465 ACPI_WARNING((AE_INFO,
466 "32/64X DSDT address mismatch in FADT - "
467 "two DSDT tables! %8.8X/%8.8X%8.8X",
469 ACPI_FORMAT_UINT64(acpi_gbl_FADT.Xdsdt)));
472 /* Examine all of the 64-bit extended address fields (X fields) */
474 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
476 * Generate pointers to the 32-bit and 64-bit addresses, get the
477 * register length (width), and the register name
479 address64 = ACPI_ADD_PTR(struct acpi_generic_address,
481 fadt_info_table[i].address64);
483 ACPI_ADD_PTR(u32, &acpi_gbl_FADT,
484 fadt_info_table[i].address32);
486 *ACPI_ADD_PTR(u8, &acpi_gbl_FADT,
487 fadt_info_table[i].length);
488 name = fadt_info_table[i].name;
491 * For each extended field, check for length mismatch between the
492 * legacy length field and the corresponding 64-bit X length field.
494 if (address64 && (address64->bit_width != ACPI_MUL_8(length))) {
495 ACPI_WARNING((AE_INFO,
496 "32/64X length mismatch in %s: %d/%d",
497 name, ACPI_MUL_8(length),
498 address64->bit_width));
501 if (fadt_info_table[i].type & ACPI_FADT_REQUIRED) {
503 * Field is required (Pm1a_event, Pm1a_control, pm_timer).
504 * Both the address and length must be non-zero.
506 if (!address64->address || !length) {
508 "Required field %s has zero address and/or length:"
511 ACPI_FORMAT_UINT64(address64->
515 } else if (fadt_info_table[i].type & ACPI_FADT_SEPARATE_LENGTH) {
517 * Field is optional (PM2Control, GPE0, GPE1) AND has its own
518 * length field. If present, both the address and length must
521 if ((address64->address && !length) ||
522 (!address64->address && length)) {
523 ACPI_WARNING((AE_INFO,
524 "Optional field %s has zero address or length: "
527 ACPI_FORMAT_UINT64(address64->
534 * If both 32- and 64-bit addresses are valid (non-zero),
537 if (address64->address && *address32 &&
538 (address64->address != (u64) * address32)) {
540 "32/64X address mismatch in %s: %8.8X/%8.8X%8.8X, using 64X",
542 ACPI_FORMAT_UINT64(address64->address)));
547 /*******************************************************************************
549 * FUNCTION: acpi_tb_setup_fadt_registers
551 * PARAMETERS: None, uses acpi_gbl_FADT.
555 * DESCRIPTION: Initialize global ACPI PM1 register definitions. Optionally,
556 * force FADT register definitions to their default lengths.
558 ******************************************************************************/
560 static void acpi_tb_setup_fadt_registers(void)
562 struct acpi_generic_address *target64;
563 struct acpi_generic_address *source64;
564 u8 pm1_register_byte_width;
568 * Optionally check all register lengths against the default values and
569 * update them if they are incorrect.
571 if (acpi_gbl_use_default_register_widths) {
572 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
574 ACPI_ADD_PTR(struct acpi_generic_address,
576 fadt_info_table[i].address64);
579 * If a valid register (Address != 0) and the (default_length > 0)
580 * (Not a GPE register), then check the width against the default.
582 if ((target64->address) &&
583 (fadt_info_table[i].default_length > 0) &&
584 (fadt_info_table[i].default_length !=
585 target64->bit_width)) {
586 ACPI_WARNING((AE_INFO,
587 "Invalid length for %s: %d, using default %d",
588 fadt_info_table[i].name,
593 /* Incorrect size, set width to the default */
595 target64->bit_width =
596 fadt_info_table[i].default_length;
602 * Get the length of the individual PM1 registers (enable and status).
603 * Each register is defined to be (event block length / 2). Extra divide
604 * by 8 converts bits to bytes.
606 pm1_register_byte_width = (u8)
607 ACPI_DIV_16(acpi_gbl_FADT.xpm1a_event_block.bit_width);
610 * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
611 * registers. These addresses do not appear (directly) in the FADT, so it
612 * is useful to pre-calculate them from the PM1 Event Block definitions.
614 * The PM event blocks are split into two register blocks, first is the
615 * PM Status Register block, followed immediately by the PM Enable
616 * Register block. Each is of length (pm1_event_length/2)
618 * Note: The PM1A event block is required by the ACPI specification.
619 * However, the PM1B event block is optional and is rarely, if ever,
623 for (i = 0; i < ACPI_FADT_PM_INFO_ENTRIES; i++) {
625 ACPI_ADD_PTR(struct acpi_generic_address, &acpi_gbl_FADT,
626 fadt_pm_info_table[i].source);
628 if (source64->address) {
629 acpi_tb_init_generic_address(fadt_pm_info_table[i].
630 target, source64->space_id,
631 pm1_register_byte_width,
633 (fadt_pm_info_table[i].
635 pm1_register_byte_width));