1 /******************************************************************************
3 * Module Name: tbfadt - FADT table utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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
,
55 u8 byte_width
, u64 address
, char *register_name
);
57 static void acpi_tb_convert_fadt(void);
59 static void acpi_tb_setup_fadt_registers(void);
62 acpi_tb_select_address(char *register_name
, u32 address32
, u64 address64
);
64 /* Table for conversion of FADT to common internal format and FADT validation */
66 typedef struct acpi_fadt_info
{
76 #define ACPI_FADT_OPTIONAL 0
77 #define ACPI_FADT_REQUIRED 1
78 #define ACPI_FADT_SEPARATE_LENGTH 2
80 static struct acpi_fadt_info fadt_info_table
[] = {
82 ACPI_FADT_OFFSET(xpm1a_event_block
),
83 ACPI_FADT_OFFSET(pm1a_event_block
),
84 ACPI_FADT_OFFSET(pm1_event_length
),
85 ACPI_PM1_REGISTER_WIDTH
* 2, /* Enable + Status register */
89 ACPI_FADT_OFFSET(xpm1b_event_block
),
90 ACPI_FADT_OFFSET(pm1b_event_block
),
91 ACPI_FADT_OFFSET(pm1_event_length
),
92 ACPI_PM1_REGISTER_WIDTH
* 2, /* Enable + Status register */
96 ACPI_FADT_OFFSET(xpm1a_control_block
),
97 ACPI_FADT_OFFSET(pm1a_control_block
),
98 ACPI_FADT_OFFSET(pm1_control_length
),
99 ACPI_PM1_REGISTER_WIDTH
,
103 ACPI_FADT_OFFSET(xpm1b_control_block
),
104 ACPI_FADT_OFFSET(pm1b_control_block
),
105 ACPI_FADT_OFFSET(pm1_control_length
),
106 ACPI_PM1_REGISTER_WIDTH
,
110 ACPI_FADT_OFFSET(xpm2_control_block
),
111 ACPI_FADT_OFFSET(pm2_control_block
),
112 ACPI_FADT_OFFSET(pm2_control_length
),
113 ACPI_PM2_REGISTER_WIDTH
,
114 ACPI_FADT_SEPARATE_LENGTH
},
117 ACPI_FADT_OFFSET(xpm_timer_block
),
118 ACPI_FADT_OFFSET(pm_timer_block
),
119 ACPI_FADT_OFFSET(pm_timer_length
),
121 ACPI_FADT_SEPARATE_LENGTH
}, /* ACPI 5.0A: Timer is optional */
124 ACPI_FADT_OFFSET(xgpe0_block
),
125 ACPI_FADT_OFFSET(gpe0_block
),
126 ACPI_FADT_OFFSET(gpe0_block_length
),
128 ACPI_FADT_SEPARATE_LENGTH
},
131 ACPI_FADT_OFFSET(xgpe1_block
),
132 ACPI_FADT_OFFSET(gpe1_block
),
133 ACPI_FADT_OFFSET(gpe1_block_length
),
135 ACPI_FADT_SEPARATE_LENGTH
}
138 #define ACPI_FADT_INFO_ENTRIES \
139 (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
141 /* Table used to split Event Blocks into separate status/enable registers */
143 typedef struct acpi_fadt_pm_info
{
144 struct acpi_generic_address
*target
;
150 static struct acpi_fadt_pm_info fadt_pm_info_table
[] = {
151 {&acpi_gbl_xpm1a_status
,
152 ACPI_FADT_OFFSET(xpm1a_event_block
),
155 {&acpi_gbl_xpm1a_enable
,
156 ACPI_FADT_OFFSET(xpm1a_event_block
),
159 {&acpi_gbl_xpm1b_status
,
160 ACPI_FADT_OFFSET(xpm1b_event_block
),
163 {&acpi_gbl_xpm1b_enable
,
164 ACPI_FADT_OFFSET(xpm1b_event_block
),
168 #define ACPI_FADT_PM_INFO_ENTRIES \
169 (sizeof (fadt_pm_info_table) / sizeof (struct acpi_fadt_pm_info))
171 /*******************************************************************************
173 * FUNCTION: acpi_tb_init_generic_address
175 * PARAMETERS: generic_address - GAS struct to be initialized
176 * space_id - ACPI Space ID for this register
177 * byte_width - Width of this register
178 * address - Address of the register
179 * register_name - ASCII name of the ACPI register
183 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
184 * See the ACPI specification for a full description and
185 * definition of this structure.
187 ******************************************************************************/
190 acpi_tb_init_generic_address(struct acpi_generic_address
*generic_address
,
192 u8 byte_width
, u64 address
, char *register_name
)
196 /* Bit width field in the GAS is only one byte long, 255 max */
198 bit_width
= (u8
)(byte_width
* 8);
200 if (byte_width
> 31) { /* (31*8)=248 */
202 "%s - 32-bit FADT register is too long (%u bytes, %u bits) "
203 "to convert to GAS struct - 255 bits max, truncating",
204 register_name
, byte_width
, (byte_width
* 8)));
210 * The 64-bit Address field is non-aligned in the byte packed
213 ACPI_MOVE_64_TO_64(&generic_address
->address
, &address
);
215 /* All other fields are byte-wide */
217 generic_address
->space_id
= space_id
;
218 generic_address
->bit_width
= bit_width
;
219 generic_address
->bit_offset
= 0;
220 generic_address
->access_width
= 0; /* Access width ANY */
223 /*******************************************************************************
225 * FUNCTION: acpi_tb_select_address
227 * PARAMETERS: register_name - ASCII name of the ACPI register
228 * address32 - 32-bit address of the register
229 * address64 - 64-bit address of the register
231 * RETURN: The resolved 64-bit address
233 * DESCRIPTION: Select between 32-bit and 64-bit versions of addresses within
234 * the FADT. Used for the FACS and DSDT addresses.
238 * Check for FACS and DSDT address mismatches. An address mismatch between
239 * the 32-bit and 64-bit address fields (FIRMWARE_CTRL/X_FIRMWARE_CTRL and
240 * DSDT/X_DSDT) could be a corrupted address field or it might indicate
241 * the presence of two FACS or two DSDT tables.
244 * By default, as per the ACPICA specification, a valid 64-bit address is
245 * used regardless of the value of the 32-bit address. However, this
246 * behavior can be overridden via the acpi_gbl_use32_bit_fadt_addresses flag.
248 ******************************************************************************/
251 acpi_tb_select_address(char *register_name
, u32 address32
, u64 address64
)
256 /* 64-bit address is zero, use 32-bit address */
258 return ((u64
)address32
);
261 if (address32
&& (address64
!= (u64
)address32
)) {
263 /* Address mismatch between 32-bit and 64-bit versions */
265 ACPI_BIOS_WARNING((AE_INFO
,
266 "32/64X %s address mismatch in FADT: "
267 "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
268 register_name
, address32
,
269 ACPI_FORMAT_UINT64(address64
),
270 acpi_gbl_use32_bit_fadt_addresses
? 32 :
273 /* 32-bit address override */
275 if (acpi_gbl_use32_bit_fadt_addresses
) {
276 return ((u64
)address32
);
280 /* Default is to use the 64-bit address */
285 /*******************************************************************************
287 * FUNCTION: acpi_tb_parse_fadt
289 * PARAMETERS: table_index - Index for the FADT
293 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
294 * (FADT contains the addresses of the DSDT and FACS)
296 ******************************************************************************/
298 void acpi_tb_parse_fadt(u32 table_index
)
301 struct acpi_table_header
*table
;
304 * The FADT has multiple versions with different lengths,
305 * and it contains pointers to both the DSDT and FACS tables.
307 * Get a local copy of the FADT and convert it to a common format
308 * Map entire FADT, assumed to be smaller than one page.
310 length
= acpi_gbl_root_table_list
.tables
[table_index
].length
;
313 acpi_os_map_memory(acpi_gbl_root_table_list
.tables
[table_index
].
320 * Validate the FADT checksum before we copy the table. Ignore
321 * checksum error as we want to try to get the DSDT and FACS.
323 (void)acpi_tb_verify_checksum(table
, length
);
325 /* Create a local copy of the FADT in common ACPI 2.0+ format */
327 acpi_tb_create_local_fadt(table
, length
);
329 /* All done with the real FADT, unmap it */
331 acpi_os_unmap_memory(table
, length
);
333 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
335 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.Xdsdt
,
336 ACPI_SIG_DSDT
, ACPI_TABLE_INDEX_DSDT
);
338 /* If Hardware Reduced flag is set, there is no FACS */
340 if (!acpi_gbl_reduced_hardware
) {
341 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.
342 Xfacs
, ACPI_SIG_FACS
,
343 ACPI_TABLE_INDEX_FACS
);
347 /*******************************************************************************
349 * FUNCTION: acpi_tb_create_local_fadt
351 * PARAMETERS: table - Pointer to BIOS FADT
352 * length - Length of the table
356 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
357 * Performs validation on some important FADT fields.
359 * NOTE: We create a local copy of the FADT regardless of the version.
361 ******************************************************************************/
363 void acpi_tb_create_local_fadt(struct acpi_table_header
*table
, u32 length
)
366 * Check if the FADT is larger than the largest table that we expect
367 * (the ACPI 5.0 version). If so, truncate the table, and issue
370 if (length
> sizeof(struct acpi_table_fadt
)) {
371 ACPI_BIOS_WARNING((AE_INFO
,
372 "FADT (revision %u) is longer than ACPI 5.0 version, "
373 "truncating length %u to %u",
374 table
->revision
, length
,
375 (u32
)sizeof(struct acpi_table_fadt
)));
378 /* Clear the entire local FADT */
380 ACPI_MEMSET(&acpi_gbl_FADT
, 0, sizeof(struct acpi_table_fadt
));
382 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
384 ACPI_MEMCPY(&acpi_gbl_FADT
, table
,
385 ACPI_MIN(length
, sizeof(struct acpi_table_fadt
)));
387 /* Take a copy of the Hardware Reduced flag */
389 acpi_gbl_reduced_hardware
= FALSE
;
390 if (acpi_gbl_FADT
.flags
& ACPI_FADT_HW_REDUCED
) {
391 acpi_gbl_reduced_hardware
= TRUE
;
394 /* Convert the local copy of the FADT to the common internal format */
396 acpi_tb_convert_fadt();
398 /* Initialize the global ACPI register structures */
400 acpi_tb_setup_fadt_registers();
403 /*******************************************************************************
405 * FUNCTION: acpi_tb_convert_fadt
407 * PARAMETERS: none - acpi_gbl_FADT is used.
411 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
412 * Expand 32-bit addresses to 64-bit as necessary. Also validate
413 * important fields within the FADT.
415 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt), and must
416 * contain a copy of the actual BIOS-provided FADT.
418 * Notes on 64-bit register addresses:
420 * After this FADT conversion, later ACPICA code will only use the 64-bit "X"
421 * fields of the FADT for all ACPI register addresses.
423 * The 64-bit X fields are optional extensions to the original 32-bit FADT
424 * V1.0 fields. Even if they are present in the FADT, they are optional and
425 * are unused if the BIOS sets them to zero. Therefore, we must copy/expand
426 * 32-bit V1.0 fields to the 64-bit X fields if the the 64-bit X field is
429 * For ACPI 1.0 FADTs (that contain no 64-bit addresses), all 32-bit address
430 * fields are expanded to the corresponding 64-bit X fields in the internal
433 * For ACPI 2.0+ FADTs, all valid (non-zero) 32-bit address fields are expanded
434 * to the corresponding 64-bit X fields, if the 64-bit field is originally
435 * zero. Adhering to the ACPI specification, we completely ignore the 32-bit
436 * field if the 64-bit field is valid, regardless of whether the host OS is
439 * Possible additional checks:
440 * (acpi_gbl_FADT.pm1_event_length >= 4)
441 * (acpi_gbl_FADT.pm1_control_length >= 2)
442 * (acpi_gbl_FADT.pm_timer_length >= 4)
443 * Gpe block lengths must be multiple of 2
445 ******************************************************************************/
447 static void acpi_tb_convert_fadt(void)
450 struct acpi_generic_address
*address64
;
456 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
457 * should be zero are indeed zero. This will workaround BIOSs that
458 * inadvertently place values in these fields.
460 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located
461 * at offset 45, 55, 95, and the word located at offset 109, 110.
463 * Note: The FADT revision value is unreliable. Only the length can be
466 if (acpi_gbl_FADT
.header
.length
<= ACPI_FADT_V2_SIZE
) {
467 acpi_gbl_FADT
.preferred_profile
= 0;
468 acpi_gbl_FADT
.pstate_control
= 0;
469 acpi_gbl_FADT
.cst_control
= 0;
470 acpi_gbl_FADT
.boot_flags
= 0;
474 * Now we can update the local FADT length to the length of the
475 * current FADT version as defined by the ACPI specification.
476 * Thus, we will have a common FADT internally.
478 acpi_gbl_FADT
.header
.length
= sizeof(struct acpi_table_fadt
);
481 * Expand the 32-bit FACS and DSDT addresses to 64-bit as necessary.
482 * Later ACPICA code will always use the X 64-bit field.
484 acpi_gbl_FADT
.Xfacs
= acpi_tb_select_address("FACS",
486 acpi_gbl_FADT
.Xfacs
);
488 acpi_gbl_FADT
.Xdsdt
= acpi_tb_select_address("DSDT",
490 acpi_gbl_FADT
.Xdsdt
);
492 /* If Hardware Reduced flag is set, we are all done */
494 if (acpi_gbl_reduced_hardware
) {
498 /* Examine all of the 64-bit extended address fields (X fields) */
500 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
502 * Get the 32-bit and 64-bit addresses, as well as the register
503 * length and register name.
505 address32
= *ACPI_ADD_PTR(u32
,
507 fadt_info_table
[i
].address32
);
509 address64
= ACPI_ADD_PTR(struct acpi_generic_address
,
511 fadt_info_table
[i
].address64
);
513 length
= *ACPI_ADD_PTR(u8
,
515 fadt_info_table
[i
].length
);
517 name
= fadt_info_table
[i
].name
;
520 * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
521 * generic address structures as necessary. Later code will always use
522 * the 64-bit address structures.
525 * Now always use the 64-bit address if it is valid (non-zero), in
526 * accordance with the ACPI specification which states that a 64-bit
527 * address supersedes the 32-bit version. This behavior can be
528 * overridden by the acpi_gbl_use32_bit_fadt_addresses flag.
530 * During 64-bit address construction and verification,
531 * these cases are handled:
533 * Address32 zero, Address64 [don't care] - Use Address64
535 * Address32 non-zero, Address64 zero - Copy/use Address32
536 * Address32 non-zero == Address64 non-zero - Use Address64
537 * Address32 non-zero != Address64 non-zero - Warning, use Address64
539 * Override: if acpi_gbl_use32_bit_fadt_addresses is TRUE, and:
540 * Address32 non-zero != Address64 non-zero - Warning, copy/use Address32
542 * Note: space_id is always I/O for 32-bit legacy address fields
545 if (!address64
->address
) {
547 /* 64-bit address is zero, use 32-bit address */
549 acpi_tb_init_generic_address(address64
,
550 ACPI_ADR_SPACE_SYSTEM_IO
,
558 } else if (address64
->address
!= (u64
)address32
) {
560 /* Address mismatch */
562 ACPI_BIOS_WARNING((AE_INFO
,
563 "32/64X address mismatch in FADT/%s: "
564 "0x%8.8X/0x%8.8X%8.8X, using %u-bit address",
567 (address64
->address
),
568 acpi_gbl_use32_bit_fadt_addresses
571 if (acpi_gbl_use32_bit_fadt_addresses
) {
573 /* 32-bit address override */
575 acpi_tb_init_generic_address(address64
,
576 ACPI_ADR_SPACE_SYSTEM_IO
,
591 * For each extended field, check for length mismatch between the
592 * legacy length field and the corresponding 64-bit X length field.
593 * Note: If the legacy length field is > 0xFF bits, ignore this
594 * check. (GPE registers can be larger than the 64-bit GAS structure
595 * can accomodate, 0xFF bits).
597 if (address64
->address
&&
598 (ACPI_MUL_8(length
) <= ACPI_UINT8_MAX
) &&
599 (address64
->bit_width
!= ACPI_MUL_8(length
))) {
600 ACPI_BIOS_WARNING((AE_INFO
,
601 "32/64X length mismatch in FADT/%s: %u/%u",
602 name
, ACPI_MUL_8(length
),
603 address64
->bit_width
));
606 if (fadt_info_table
[i
].type
& ACPI_FADT_REQUIRED
) {
608 * Field is required (Pm1a_event, Pm1a_control).
609 * Both the address and length must be non-zero.
611 if (!address64
->address
|| !length
) {
612 ACPI_BIOS_ERROR((AE_INFO
,
613 "Required FADT field %s has zero address and/or length: "
616 ACPI_FORMAT_UINT64(address64
->
620 } else if (fadt_info_table
[i
].type
& ACPI_FADT_SEPARATE_LENGTH
) {
622 * Field is optional (Pm2_control, GPE0, GPE1) AND has its own
623 * length field. If present, both the address and length must
626 if ((address64
->address
&& !length
) ||
627 (!address64
->address
&& length
)) {
628 ACPI_BIOS_WARNING((AE_INFO
,
629 "Optional FADT field %s has zero address or length: "
633 (address64
->address
),
640 /*******************************************************************************
642 * FUNCTION: acpi_tb_setup_fadt_registers
644 * PARAMETERS: None, uses acpi_gbl_FADT.
648 * DESCRIPTION: Initialize global ACPI PM1 register definitions. Optionally,
649 * force FADT register definitions to their default lengths.
651 ******************************************************************************/
653 static void acpi_tb_setup_fadt_registers(void)
655 struct acpi_generic_address
*target64
;
656 struct acpi_generic_address
*source64
;
657 u8 pm1_register_byte_width
;
661 * Optionally check all register lengths against the default values and
662 * update them if they are incorrect.
664 if (acpi_gbl_use_default_register_widths
) {
665 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
667 ACPI_ADD_PTR(struct acpi_generic_address
,
669 fadt_info_table
[i
].address64
);
672 * If a valid register (Address != 0) and the (default_length > 0)
673 * (Not a GPE register), then check the width against the default.
675 if ((target64
->address
) &&
676 (fadt_info_table
[i
].default_length
> 0) &&
677 (fadt_info_table
[i
].default_length
!=
678 target64
->bit_width
)) {
679 ACPI_BIOS_WARNING((AE_INFO
,
680 "Invalid length for FADT/%s: %u, using default %u",
681 fadt_info_table
[i
].name
,
686 /* Incorrect size, set width to the default */
688 target64
->bit_width
=
689 fadt_info_table
[i
].default_length
;
695 * Get the length of the individual PM1 registers (enable and status).
696 * Each register is defined to be (event block length / 2). Extra divide
697 * by 8 converts bits to bytes.
699 pm1_register_byte_width
= (u8
)
700 ACPI_DIV_16(acpi_gbl_FADT
.xpm1a_event_block
.bit_width
);
703 * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
704 * registers. These addresses do not appear (directly) in the FADT, so it
705 * is useful to pre-calculate them from the PM1 Event Block definitions.
707 * The PM event blocks are split into two register blocks, first is the
708 * PM Status Register block, followed immediately by the PM Enable
709 * Register block. Each is of length (pm1_event_length/2)
711 * Note: The PM1A event block is required by the ACPI specification.
712 * However, the PM1B event block is optional and is rarely, if ever,
716 for (i
= 0; i
< ACPI_FADT_PM_INFO_ENTRIES
; i
++) {
718 ACPI_ADD_PTR(struct acpi_generic_address
, &acpi_gbl_FADT
,
719 fadt_pm_info_table
[i
].source
);
721 if (source64
->address
) {
722 acpi_tb_init_generic_address(fadt_pm_info_table
[i
].
723 target
, source64
->space_id
,
724 pm1_register_byte_width
,
726 (fadt_pm_info_table
[i
].
728 pm1_register_byte_width
),