1 /******************************************************************************
3 * Module Name: tbfadt - FADT table utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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 */
52 static ACPI_INLINE
void
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_OPTIONAL 0
75 #define ACPI_FADT_REQUIRED 1
76 #define ACPI_FADT_SEPARATE_LENGTH 2
78 static struct acpi_fadt_info fadt_info_table
[] = {
80 ACPI_FADT_OFFSET(xpm1a_event_block
),
81 ACPI_FADT_OFFSET(pm1a_event_block
),
82 ACPI_FADT_OFFSET(pm1_event_length
),
83 ACPI_PM1_REGISTER_WIDTH
* 2, /* Enable + Status register */
87 ACPI_FADT_OFFSET(xpm1b_event_block
),
88 ACPI_FADT_OFFSET(pm1b_event_block
),
89 ACPI_FADT_OFFSET(pm1_event_length
),
90 ACPI_PM1_REGISTER_WIDTH
* 2, /* Enable + Status register */
94 ACPI_FADT_OFFSET(xpm1a_control_block
),
95 ACPI_FADT_OFFSET(pm1a_control_block
),
96 ACPI_FADT_OFFSET(pm1_control_length
),
97 ACPI_PM1_REGISTER_WIDTH
,
101 ACPI_FADT_OFFSET(xpm1b_control_block
),
102 ACPI_FADT_OFFSET(pm1b_control_block
),
103 ACPI_FADT_OFFSET(pm1_control_length
),
104 ACPI_PM1_REGISTER_WIDTH
,
108 ACPI_FADT_OFFSET(xpm2_control_block
),
109 ACPI_FADT_OFFSET(pm2_control_block
),
110 ACPI_FADT_OFFSET(pm2_control_length
),
111 ACPI_PM2_REGISTER_WIDTH
,
112 ACPI_FADT_SEPARATE_LENGTH
},
115 ACPI_FADT_OFFSET(xpm_timer_block
),
116 ACPI_FADT_OFFSET(pm_timer_block
),
117 ACPI_FADT_OFFSET(pm_timer_length
),
122 ACPI_FADT_OFFSET(xgpe0_block
),
123 ACPI_FADT_OFFSET(gpe0_block
),
124 ACPI_FADT_OFFSET(gpe0_block_length
),
126 ACPI_FADT_SEPARATE_LENGTH
},
129 ACPI_FADT_OFFSET(xgpe1_block
),
130 ACPI_FADT_OFFSET(gpe1_block
),
131 ACPI_FADT_OFFSET(gpe1_block_length
),
133 ACPI_FADT_SEPARATE_LENGTH
}
136 #define ACPI_FADT_INFO_ENTRIES \
137 (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
139 /* Table used to split Event Blocks into separate status/enable registers */
141 typedef struct acpi_fadt_pm_info
{
142 struct acpi_generic_address
*target
;
148 static struct acpi_fadt_pm_info fadt_pm_info_table
[] = {
149 {&acpi_gbl_xpm1a_status
,
150 ACPI_FADT_OFFSET(xpm1a_event_block
),
153 {&acpi_gbl_xpm1a_enable
,
154 ACPI_FADT_OFFSET(xpm1a_event_block
),
157 {&acpi_gbl_xpm1b_status
,
158 ACPI_FADT_OFFSET(xpm1b_event_block
),
161 {&acpi_gbl_xpm1b_enable
,
162 ACPI_FADT_OFFSET(xpm1b_event_block
),
166 #define ACPI_FADT_PM_INFO_ENTRIES \
167 (sizeof (fadt_pm_info_table) / sizeof (struct acpi_fadt_pm_info))
169 /*******************************************************************************
171 * FUNCTION: acpi_tb_init_generic_address
173 * PARAMETERS: generic_address - GAS struct to be initialized
174 * byte_width - Width of this register
175 * Address - Address of the register
179 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
180 * See the ACPI specification for a full description and
181 * definition of this structure.
183 ******************************************************************************/
185 static ACPI_INLINE
void
186 acpi_tb_init_generic_address(struct acpi_generic_address
*generic_address
,
187 u8 space_id
, u8 byte_width
, u64 address
)
191 * The 64-bit Address field is non-aligned in the byte packed
194 ACPI_MOVE_64_TO_64(&generic_address
->address
, &address
);
196 /* All other fields are byte-wide */
198 generic_address
->space_id
= space_id
;
199 generic_address
->bit_width
= (u8
)ACPI_MUL_8(byte_width
);
200 generic_address
->bit_offset
= 0;
201 generic_address
->access_width
= 0; /* Access width ANY */
204 /*******************************************************************************
206 * FUNCTION: acpi_tb_parse_fadt
208 * PARAMETERS: table_index - Index for the FADT
212 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
213 * (FADT contains the addresses of the DSDT and FACS)
215 ******************************************************************************/
217 void acpi_tb_parse_fadt(u32 table_index
)
220 struct acpi_table_header
*table
;
223 * The FADT has multiple versions with different lengths,
224 * and it contains pointers to both the DSDT and FACS tables.
226 * Get a local copy of the FADT and convert it to a common format
227 * Map entire FADT, assumed to be smaller than one page.
229 length
= acpi_gbl_root_table_list
.tables
[table_index
].length
;
232 acpi_os_map_memory(acpi_gbl_root_table_list
.tables
[table_index
].
239 * Validate the FADT checksum before we copy the table. Ignore
240 * checksum error as we want to try to get the DSDT and FACS.
242 (void)acpi_tb_verify_checksum(table
, length
);
244 /* Create a local copy of the FADT in common ACPI 2.0+ format */
246 acpi_tb_create_local_fadt(table
, length
);
248 /* All done with the real FADT, unmap it */
250 acpi_os_unmap_memory(table
, length
);
252 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
254 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.Xdsdt
,
255 ACPI_SIG_DSDT
, ACPI_TABLE_INDEX_DSDT
);
257 /* If Hardware Reduced flag is set, there is no FACS */
259 if (!acpi_gbl_reduced_hardware
) {
260 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.
261 Xfacs
, ACPI_SIG_FACS
,
262 ACPI_TABLE_INDEX_FACS
);
266 /*******************************************************************************
268 * FUNCTION: acpi_tb_create_local_fadt
270 * PARAMETERS: Table - Pointer to BIOS FADT
271 * Length - Length of the table
275 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
276 * Performs validation on some important FADT fields.
278 * NOTE: We create a local copy of the FADT regardless of the version.
280 ******************************************************************************/
282 void acpi_tb_create_local_fadt(struct acpi_table_header
*table
, u32 length
)
285 * Check if the FADT is larger than the largest table that we expect
286 * (the ACPI 5.0 version). If so, truncate the table, and issue
289 if (length
> sizeof(struct acpi_table_fadt
)) {
290 ACPI_WARNING((AE_INFO
,
291 "FADT (revision %u) is longer than ACPI 5.0 version, "
292 "truncating length %u to %u",
293 table
->revision
, length
,
294 (u32
)sizeof(struct acpi_table_fadt
)));
297 /* Clear the entire local FADT */
299 ACPI_MEMSET(&acpi_gbl_FADT
, 0, sizeof(struct acpi_table_fadt
));
301 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
303 ACPI_MEMCPY(&acpi_gbl_FADT
, table
,
304 ACPI_MIN(length
, sizeof(struct acpi_table_fadt
)));
306 /* Take a copy of the Hardware Reduced flag */
308 acpi_gbl_reduced_hardware
= FALSE
;
309 if (acpi_gbl_FADT
.flags
& ACPI_FADT_HW_REDUCED
) {
310 acpi_gbl_reduced_hardware
= TRUE
;
313 /* Convert the local copy of the FADT to the common internal format */
315 acpi_tb_convert_fadt();
317 /* Validate FADT values now, before we make any changes */
319 acpi_tb_validate_fadt();
321 /* Initialize the global ACPI register structures */
323 acpi_tb_setup_fadt_registers();
326 /*******************************************************************************
328 * FUNCTION: acpi_tb_convert_fadt
330 * PARAMETERS: None, uses acpi_gbl_FADT
334 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
335 * Expand 32-bit addresses to 64-bit as necessary.
337 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt),
338 * and must contain a copy of the actual FADT.
340 * Notes on 64-bit register addresses:
342 * After this FADT conversion, later ACPICA code will only use the 64-bit "X"
343 * fields of the FADT for all ACPI register addresses.
345 * The 64-bit "X" fields are optional extensions to the original 32-bit FADT
346 * V1.0 fields. Even if they are present in the FADT, they are optional and
347 * are unused if the BIOS sets them to zero. Therefore, we must copy/expand
348 * 32-bit V1.0 fields if the corresponding X field is zero.
350 * For ACPI 1.0 FADTs, all 32-bit address fields are expanded to the
351 * corresponding "X" fields in the internal FADT.
353 * For ACPI 2.0+ FADTs, all valid (non-zero) 32-bit address fields are expanded
354 * to the corresponding 64-bit X fields. For compatibility with other ACPI
355 * implementations, we ignore the 64-bit field if the 32-bit field is valid,
356 * regardless of whether the host OS is 32-bit or 64-bit.
358 ******************************************************************************/
360 static void acpi_tb_convert_fadt(void)
362 struct acpi_generic_address
*address64
;
367 * Expand the 32-bit FACS and DSDT addresses to 64-bit as necessary.
368 * Later code will always use the X 64-bit field. Also, check for an
369 * address mismatch between the 32-bit and 64-bit address fields
370 * (FIRMWARE_CTRL/X_FIRMWARE_CTRL, DSDT/X_DSDT) which would indicate
371 * the presence of two FACS or two DSDT tables.
373 if (!acpi_gbl_FADT
.Xfacs
) {
374 acpi_gbl_FADT
.Xfacs
= (u64
) acpi_gbl_FADT
.facs
;
375 } else if (acpi_gbl_FADT
.facs
&&
376 (acpi_gbl_FADT
.Xfacs
!= (u64
) acpi_gbl_FADT
.facs
)) {
377 ACPI_WARNING((AE_INFO
,
378 "32/64 FACS address mismatch in FADT - two FACS tables!"));
381 if (!acpi_gbl_FADT
.Xdsdt
) {
382 acpi_gbl_FADT
.Xdsdt
= (u64
) acpi_gbl_FADT
.dsdt
;
383 } else if (acpi_gbl_FADT
.dsdt
&&
384 (acpi_gbl_FADT
.Xdsdt
!= (u64
) acpi_gbl_FADT
.dsdt
)) {
385 ACPI_WARNING((AE_INFO
,
386 "32/64 DSDT address mismatch in FADT - two DSDT tables!"));
390 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
391 * should be zero are indeed zero. This will workaround BIOSs that
392 * inadvertently place values in these fields.
394 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located at
395 * offset 45, 55, 95, and the word located at offset 109, 110.
397 * Note: The FADT revision value is unreliable. Only the length can be
400 if (acpi_gbl_FADT
.header
.length
<= ACPI_FADT_V2_SIZE
) {
401 acpi_gbl_FADT
.preferred_profile
= 0;
402 acpi_gbl_FADT
.pstate_control
= 0;
403 acpi_gbl_FADT
.cst_control
= 0;
404 acpi_gbl_FADT
.boot_flags
= 0;
407 /* Update the local FADT table header length */
409 acpi_gbl_FADT
.header
.length
= sizeof(struct acpi_table_fadt
);
412 * Expand the ACPI 1.0 32-bit addresses to the ACPI 2.0 64-bit "X"
413 * generic address structures as necessary. Later code will always use
414 * the 64-bit address structures.
417 * We now always use the 32-bit address if it is valid (non-null). This
418 * is not in accordance with the ACPI specification which states that
419 * the 64-bit address supersedes the 32-bit version, but we do this for
420 * compatibility with other ACPI implementations. Most notably, in the
421 * case where both the 32 and 64 versions are non-null, we use the 32-bit
422 * version. This is the only address that is guaranteed to have been
423 * tested by the BIOS manufacturer.
425 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
426 address32
= *ACPI_ADD_PTR(u32
,
428 fadt_info_table
[i
].address32
);
430 address64
= ACPI_ADD_PTR(struct acpi_generic_address
,
432 fadt_info_table
[i
].address64
);
435 * If both 32- and 64-bit addresses are valid (non-zero),
438 if (address64
->address
&& address32
&&
439 (address64
->address
!= (u64
) address32
)) {
441 "32/64X address mismatch in %s: 0x%8.8X/0x%8.8X%8.8X, using 32",
442 fadt_info_table
[i
].name
, address32
,
443 ACPI_FORMAT_UINT64(address64
->address
)));
446 /* Always use 32-bit address if it is valid (non-null) */
450 * Copy the 32-bit address to the 64-bit GAS structure. The
451 * Space ID is always I/O for 32-bit legacy address fields
453 acpi_tb_init_generic_address(address64
,
454 ACPI_ADR_SPACE_SYSTEM_IO
,
464 /*******************************************************************************
466 * FUNCTION: acpi_tb_validate_fadt
468 * PARAMETERS: Table - Pointer to the FADT to be validated
472 * DESCRIPTION: Validate various important fields within the FADT. If a problem
473 * is found, issue a message, but no status is returned.
474 * Used by both the table manager and the disassembler.
476 * Possible additional checks:
477 * (acpi_gbl_FADT.pm1_event_length >= 4)
478 * (acpi_gbl_FADT.pm1_control_length >= 2)
479 * (acpi_gbl_FADT.pm_timer_length >= 4)
480 * Gpe block lengths must be multiple of 2
482 ******************************************************************************/
484 static void acpi_tb_validate_fadt(void)
487 struct acpi_generic_address
*address64
;
492 * Check for FACS and DSDT address mismatches. An address mismatch between
493 * the 32-bit and 64-bit address fields (FIRMWARE_CTRL/X_FIRMWARE_CTRL and
494 * DSDT/X_DSDT) would indicate the presence of two FACS or two DSDT tables.
496 if (acpi_gbl_FADT
.facs
&&
497 (acpi_gbl_FADT
.Xfacs
!= (u64
) acpi_gbl_FADT
.facs
)) {
498 ACPI_WARNING((AE_INFO
,
499 "32/64X FACS address mismatch in FADT - "
500 "0x%8.8X/0x%8.8X%8.8X, using 32",
502 ACPI_FORMAT_UINT64(acpi_gbl_FADT
.Xfacs
)));
504 acpi_gbl_FADT
.Xfacs
= (u64
) acpi_gbl_FADT
.facs
;
507 if (acpi_gbl_FADT
.dsdt
&&
508 (acpi_gbl_FADT
.Xdsdt
!= (u64
) acpi_gbl_FADT
.dsdt
)) {
509 ACPI_WARNING((AE_INFO
,
510 "32/64X DSDT address mismatch in FADT - "
511 "0x%8.8X/0x%8.8X%8.8X, using 32",
513 ACPI_FORMAT_UINT64(acpi_gbl_FADT
.Xdsdt
)));
515 acpi_gbl_FADT
.Xdsdt
= (u64
) acpi_gbl_FADT
.dsdt
;
518 /* If Hardware Reduced flag is set, we are all done */
520 if (acpi_gbl_reduced_hardware
) {
524 /* Examine all of the 64-bit extended address fields (X fields) */
526 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
528 * Generate pointer to the 64-bit address, get the register
529 * length (width) and the register name
531 address64
= ACPI_ADD_PTR(struct acpi_generic_address
,
533 fadt_info_table
[i
].address64
);
535 *ACPI_ADD_PTR(u8
, &acpi_gbl_FADT
,
536 fadt_info_table
[i
].length
);
537 name
= fadt_info_table
[i
].name
;
540 * For each extended field, check for length mismatch between the
541 * legacy length field and the corresponding 64-bit X length field.
543 if (address64
->address
&&
544 (address64
->bit_width
!= ACPI_MUL_8(length
))) {
545 ACPI_WARNING((AE_INFO
,
546 "32/64X length mismatch in %s: %u/%u",
547 name
, ACPI_MUL_8(length
),
548 address64
->bit_width
));
551 if (fadt_info_table
[i
].type
& ACPI_FADT_REQUIRED
) {
553 * Field is required (Pm1a_event, Pm1a_control, pm_timer).
554 * Both the address and length must be non-zero.
556 if (!address64
->address
|| !length
) {
558 "Required field %s has zero address and/or length:"
559 " 0x%8.8X%8.8X/0x%X",
561 ACPI_FORMAT_UINT64(address64
->
565 } else if (fadt_info_table
[i
].type
& ACPI_FADT_SEPARATE_LENGTH
) {
567 * Field is optional (PM2Control, GPE0, GPE1) AND has its own
568 * length field. If present, both the address and length must
571 if ((address64
->address
&& !length
) ||
572 (!address64
->address
&& length
)) {
573 ACPI_WARNING((AE_INFO
,
574 "Optional field %s has zero address or length: "
577 ACPI_FORMAT_UINT64(address64
->
585 /*******************************************************************************
587 * FUNCTION: acpi_tb_setup_fadt_registers
589 * PARAMETERS: None, uses acpi_gbl_FADT.
593 * DESCRIPTION: Initialize global ACPI PM1 register definitions. Optionally,
594 * force FADT register definitions to their default lengths.
596 ******************************************************************************/
598 static void acpi_tb_setup_fadt_registers(void)
600 struct acpi_generic_address
*target64
;
601 struct acpi_generic_address
*source64
;
602 u8 pm1_register_byte_width
;
606 * Optionally check all register lengths against the default values and
607 * update them if they are incorrect.
609 if (acpi_gbl_use_default_register_widths
) {
610 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
612 ACPI_ADD_PTR(struct acpi_generic_address
,
614 fadt_info_table
[i
].address64
);
617 * If a valid register (Address != 0) and the (default_length > 0)
618 * (Not a GPE register), then check the width against the default.
620 if ((target64
->address
) &&
621 (fadt_info_table
[i
].default_length
> 0) &&
622 (fadt_info_table
[i
].default_length
!=
623 target64
->bit_width
)) {
624 ACPI_WARNING((AE_INFO
,
625 "Invalid length for %s: %u, using default %u",
626 fadt_info_table
[i
].name
,
631 /* Incorrect size, set width to the default */
633 target64
->bit_width
=
634 fadt_info_table
[i
].default_length
;
640 * Get the length of the individual PM1 registers (enable and status).
641 * Each register is defined to be (event block length / 2). Extra divide
642 * by 8 converts bits to bytes.
644 pm1_register_byte_width
= (u8
)
645 ACPI_DIV_16(acpi_gbl_FADT
.xpm1a_event_block
.bit_width
);
648 * Calculate separate GAS structs for the PM1x (A/B) Status and Enable
649 * registers. These addresses do not appear (directly) in the FADT, so it
650 * is useful to pre-calculate them from the PM1 Event Block definitions.
652 * The PM event blocks are split into two register blocks, first is the
653 * PM Status Register block, followed immediately by the PM Enable
654 * Register block. Each is of length (pm1_event_length/2)
656 * Note: The PM1A event block is required by the ACPI specification.
657 * However, the PM1B event block is optional and is rarely, if ever,
661 for (i
= 0; i
< ACPI_FADT_PM_INFO_ENTRIES
; i
++) {
663 ACPI_ADD_PTR(struct acpi_generic_address
, &acpi_gbl_FADT
,
664 fadt_pm_info_table
[i
].source
);
666 if (source64
->address
) {
667 acpi_tb_init_generic_address(fadt_pm_info_table
[i
].
668 target
, source64
->space_id
,
669 pm1_register_byte_width
,
671 (fadt_pm_info_table
[i
].
673 pm1_register_byte_width
));