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>
45 #include <acpi/accommon.h>
46 #include <acpi/actables.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 byte_width
, u64 address
);
56 static void acpi_tb_convert_fadt(void);
58 static void acpi_tb_validate_fadt(void);
60 /* Table for conversion of FADT to common internal format and FADT validation */
62 typedef struct acpi_fadt_info
{
71 #define ACPI_FADT_REQUIRED 1
72 #define ACPI_FADT_SEPARATE_LENGTH 2
74 static struct acpi_fadt_info fadt_info_table
[] = {
75 {"Pm1aEventBlock", ACPI_FADT_OFFSET(xpm1a_event_block
),
76 ACPI_FADT_OFFSET(pm1a_event_block
),
77 ACPI_FADT_OFFSET(pm1_event_length
), ACPI_FADT_REQUIRED
},
79 {"Pm1bEventBlock", ACPI_FADT_OFFSET(xpm1b_event_block
),
80 ACPI_FADT_OFFSET(pm1b_event_block
),
81 ACPI_FADT_OFFSET(pm1_event_length
), 0},
83 {"Pm1aControlBlock", ACPI_FADT_OFFSET(xpm1a_control_block
),
84 ACPI_FADT_OFFSET(pm1a_control_block
),
85 ACPI_FADT_OFFSET(pm1_control_length
), ACPI_FADT_REQUIRED
},
87 {"Pm1bControlBlock", ACPI_FADT_OFFSET(xpm1b_control_block
),
88 ACPI_FADT_OFFSET(pm1b_control_block
),
89 ACPI_FADT_OFFSET(pm1_control_length
), 0},
91 {"Pm2ControlBlock", ACPI_FADT_OFFSET(xpm2_control_block
),
92 ACPI_FADT_OFFSET(pm2_control_block
),
93 ACPI_FADT_OFFSET(pm2_control_length
), ACPI_FADT_SEPARATE_LENGTH
},
95 {"PmTimerBlock", ACPI_FADT_OFFSET(xpm_timer_block
),
96 ACPI_FADT_OFFSET(pm_timer_block
),
97 ACPI_FADT_OFFSET(pm_timer_length
), ACPI_FADT_REQUIRED
},
99 {"Gpe0Block", ACPI_FADT_OFFSET(xgpe0_block
),
100 ACPI_FADT_OFFSET(gpe0_block
),
101 ACPI_FADT_OFFSET(gpe0_block_length
), ACPI_FADT_SEPARATE_LENGTH
},
103 {"Gpe1Block", ACPI_FADT_OFFSET(xgpe1_block
),
104 ACPI_FADT_OFFSET(gpe1_block
),
105 ACPI_FADT_OFFSET(gpe1_block_length
), ACPI_FADT_SEPARATE_LENGTH
}
108 #define ACPI_FADT_INFO_ENTRIES (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
110 /*******************************************************************************
112 * FUNCTION: acpi_tb_init_generic_address
114 * PARAMETERS: generic_address - GAS struct to be initialized
115 * byte_width - Width of this register
116 * Address - Address of the register
120 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
121 * See the ACPI specification for a full description and
122 * definition of this structure.
124 ******************************************************************************/
127 acpi_tb_init_generic_address(struct acpi_generic_address
*generic_address
,
128 u8 byte_width
, u64 address
)
132 * The 64-bit Address field is non-aligned in the byte packed
135 ACPI_MOVE_64_TO_64(&generic_address
->address
, &address
);
137 /* All other fields are byte-wide */
139 generic_address
->space_id
= ACPI_ADR_SPACE_SYSTEM_IO
;
140 generic_address
->bit_width
= byte_width
<< 3;
141 generic_address
->bit_offset
= 0;
142 generic_address
->access_width
= 0;
145 /*******************************************************************************
147 * FUNCTION: acpi_tb_parse_fadt
149 * PARAMETERS: table_index - Index for the FADT
154 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
155 * (FADT contains the addresses of the DSDT and FACS)
157 ******************************************************************************/
159 void acpi_tb_parse_fadt(u32 table_index
, u8 flags
)
162 struct acpi_table_header
*table
;
165 * The FADT has multiple versions with different lengths,
166 * and it contains pointers to both the DSDT and FACS tables.
168 * Get a local copy of the FADT and convert it to a common format
169 * Map entire FADT, assumed to be smaller than one page.
171 length
= acpi_gbl_root_table_list
.tables
[table_index
].length
;
174 acpi_os_map_memory(acpi_gbl_root_table_list
.tables
[table_index
].
181 * Validate the FADT checksum before we copy the table. Ignore
182 * checksum error as we want to try to get the DSDT and FACS.
184 (void)acpi_tb_verify_checksum(table
, length
);
186 /* Obtain a local copy of the FADT in common ACPI 2.0+ format */
188 acpi_tb_create_local_fadt(table
, length
);
190 /* All done with the real FADT, unmap it */
192 acpi_os_unmap_memory(table
, length
);
194 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
196 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.Xdsdt
,
197 flags
, ACPI_SIG_DSDT
, ACPI_TABLE_INDEX_DSDT
);
199 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.Xfacs
,
200 flags
, ACPI_SIG_FACS
, ACPI_TABLE_INDEX_FACS
);
203 /*******************************************************************************
205 * FUNCTION: acpi_tb_create_local_fadt
207 * PARAMETERS: Table - Pointer to BIOS FADT
208 * Length - Length of the table
212 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
213 * Performs validation on some important FADT fields.
215 * NOTE: We create a local copy of the FADT regardless of the version.
217 ******************************************************************************/
219 void acpi_tb_create_local_fadt(struct acpi_table_header
*table
, u32 length
)
223 * Check if the FADT is larger than the largest table that we expect
224 * (the ACPI 2.0/3.0 version). If so, truncate the table, and issue
227 if (length
> sizeof(struct acpi_table_fadt
)) {
228 ACPI_WARNING((AE_INFO
,
229 "FADT (revision %u) is longer than ACPI 2.0 version, truncating length 0x%X to 0x%zX",
230 table
->revision
, (unsigned)length
,
231 sizeof(struct acpi_table_fadt
)));
234 /* Clear the entire local FADT */
236 ACPI_MEMSET(&acpi_gbl_FADT
, 0, sizeof(struct acpi_table_fadt
));
238 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
240 ACPI_MEMCPY(&acpi_gbl_FADT
, table
,
241 ACPI_MIN(length
, sizeof(struct acpi_table_fadt
)));
244 * 1) Convert the local copy of the FADT to the common internal format
245 * 2) Validate some of the important values within the FADT
247 acpi_tb_convert_fadt();
248 acpi_tb_validate_fadt();
251 /*******************************************************************************
253 * FUNCTION: acpi_tb_convert_fadt
255 * PARAMETERS: None, uses acpi_gbl_FADT
259 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
260 * Expand all 32-bit addresses to 64-bit.
262 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt),
263 * and must contain a copy of the actual FADT.
265 * ACPICA will use the "X" fields of the FADT for all addresses.
267 * "X" fields are optional extensions to the original V1.0 fields. Even if
268 * they are present in the structure, they can be optionally not used by
269 * setting them to zero. Therefore, we must selectively expand V1.0 fields
270 * if the corresponding X field is zero.
272 * For ACPI 1.0 FADTs, all address fields are expanded to the corresponding
275 * For ACPI 2.0 FADTs, any "X" fields that are NULL are filled in by
276 * expanding the corresponding ACPI 1.0 field.
278 ******************************************************************************/
280 static void acpi_tb_convert_fadt(void)
282 u8 pm1_register_length
;
283 struct acpi_generic_address
*target
;
286 /* Update the local FADT table header length */
288 acpi_gbl_FADT
.header
.length
= sizeof(struct acpi_table_fadt
);
291 * Expand the 32-bit FACS and DSDT addresses to 64-bit as necessary.
292 * Later code will always use the X 64-bit field. Also, check for an
293 * address mismatch between the 32-bit and 64-bit address fields
294 * (FIRMWARE_CTRL/X_FIRMWARE_CTRL, DSDT/X_DSDT) which would indicate
295 * the presence of two FACS or two DSDT tables.
297 if (!acpi_gbl_FADT
.Xfacs
) {
298 acpi_gbl_FADT
.Xfacs
= (u64
) acpi_gbl_FADT
.facs
;
299 } else if (acpi_gbl_FADT
.facs
&&
300 (acpi_gbl_FADT
.Xfacs
!= (u64
) acpi_gbl_FADT
.facs
)) {
301 ACPI_WARNING((AE_INFO
,
302 "32/64 FACS address mismatch in FADT - two FACS tables!"));
305 if (!acpi_gbl_FADT
.Xdsdt
) {
306 acpi_gbl_FADT
.Xdsdt
= (u64
) acpi_gbl_FADT
.dsdt
;
307 } else if (acpi_gbl_FADT
.dsdt
&&
308 (acpi_gbl_FADT
.Xdsdt
!= (u64
) acpi_gbl_FADT
.dsdt
)) {
309 ACPI_WARNING((AE_INFO
,
310 "32/64 DSDT address mismatch in FADT - two DSDT tables!"));
314 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
315 * should be zero are indeed zero. This will workaround BIOSs that
316 * inadvertently place values in these fields.
318 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located at
319 * offset 45, 55, 95, and the word located at offset 109, 110.
321 if (acpi_gbl_FADT
.header
.revision
< FADT2_REVISION_ID
) {
322 acpi_gbl_FADT
.preferred_profile
= 0;
323 acpi_gbl_FADT
.pstate_control
= 0;
324 acpi_gbl_FADT
.cst_control
= 0;
325 acpi_gbl_FADT
.boot_flags
= 0;
329 * Expand the ACPI 1.0 32-bit V1.0 addresses to the ACPI 2.0 64-bit "X"
330 * generic address structures as necessary.
332 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
334 ACPI_ADD_PTR(struct acpi_generic_address
, &acpi_gbl_FADT
,
335 fadt_info_table
[i
].target
);
337 /* Expand only if the X target is null */
339 if (!target
->address
) {
340 acpi_tb_init_generic_address(target
,
345 (u64
) * ACPI_ADD_PTR(u32
,
354 * Calculate separate GAS structs for the PM1 Enable registers.
355 * These addresses do not appear (directly) in the FADT, so it is
356 * useful to calculate them once, here.
358 * The PM event blocks are split into two register blocks, first is the
359 * PM Status Register block, followed immediately by the PM Enable
360 * Register block. Each is of length (xpm1x_event_block.bit_width/2).
362 * On various systems the v2 fields (and particularly the bit widths)
363 * cannot be relied upon, though. Hence resort to using the v1 length
364 * here (and warn about the inconsistency).
366 if (acpi_gbl_FADT
.xpm1a_event_block
.bit_width
367 != acpi_gbl_FADT
.pm1_event_length
* 8)
368 printk(KERN_WARNING
"FADT: "
369 "X_PM1a_EVT_BLK.bit_width (%u) does not match"
370 " PM1_EVT_LEN (%u)\n",
371 acpi_gbl_FADT
.xpm1a_event_block
.bit_width
,
372 acpi_gbl_FADT
.pm1_event_length
);
373 pm1_register_length
= (u8
) ACPI_DIV_2(acpi_gbl_FADT
.pm1_event_length
);
375 /* The PM1A register block is required */
377 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable
,
379 (acpi_gbl_FADT
.xpm1a_event_block
.address
+
380 pm1_register_length
));
381 /* Don't forget to copy space_id of the GAS */
382 acpi_gbl_xpm1a_enable
.space_id
=
383 acpi_gbl_FADT
.xpm1a_event_block
.space_id
;
385 /* The PM1B register block is optional, ignore if not present */
387 if (acpi_gbl_FADT
.xpm1b_event_block
.address
) {
388 if (acpi_gbl_FADT
.xpm1b_event_block
.bit_width
389 != acpi_gbl_FADT
.pm1_event_length
* 8)
390 printk(KERN_WARNING
"FADT: "
391 "X_PM1b_EVT_BLK.bit_width (%u) does not match"
392 " PM1_EVT_LEN (%u)\n",
393 acpi_gbl_FADT
.xpm1b_event_block
.bit_width
,
394 acpi_gbl_FADT
.pm1_event_length
);
395 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable
,
397 (acpi_gbl_FADT
.xpm1b_event_block
.
398 address
+ pm1_register_length
));
399 /* Don't forget to copy space_id of the GAS */
400 acpi_gbl_xpm1b_enable
.space_id
=
401 acpi_gbl_FADT
.xpm1b_event_block
.space_id
;
406 /******************************************************************************
408 * FUNCTION: acpi_tb_validate_fadt
410 * PARAMETERS: Table - Pointer to the FADT to be validated
414 * DESCRIPTION: Validate various important fields within the FADT. If a problem
415 * is found, issue a message, but no status is returned.
416 * Used by both the table manager and the disassembler.
418 * Possible additional checks:
419 * (acpi_gbl_FADT.pm1_event_length >= 4)
420 * (acpi_gbl_FADT.pm1_control_length >= 2)
421 * (acpi_gbl_FADT.pm_timer_length >= 4)
422 * Gpe block lengths must be multiple of 2
424 ******************************************************************************/
426 static void acpi_tb_validate_fadt(void)
429 struct acpi_generic_address
*address64
;
433 /* Examine all of the 64-bit extended address fields (X fields) */
435 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
437 /* Generate pointers to the 32-bit and 64-bit addresses and get the length */
440 ACPI_ADD_PTR(struct acpi_generic_address
, &acpi_gbl_FADT
,
441 fadt_info_table
[i
].target
);
443 ACPI_ADD_PTR(u32
, &acpi_gbl_FADT
,
444 fadt_info_table
[i
].source
);
446 *ACPI_ADD_PTR(u8
, &acpi_gbl_FADT
,
447 fadt_info_table
[i
].length
);
449 if (fadt_info_table
[i
].type
& ACPI_FADT_REQUIRED
) {
451 * Field is required (Pm1a_event, Pm1a_control, pm_timer).
452 * Both the address and length must be non-zero.
454 if (!address64
->address
|| !length
) {
456 "Required field \"%s\" has zero address and/or length: %8.8X%8.8X/%X",
457 fadt_info_table
[i
].name
,
458 ACPI_FORMAT_UINT64(address64
->
462 } else if (fadt_info_table
[i
].type
& ACPI_FADT_SEPARATE_LENGTH
) {
464 * Field is optional (PM2Control, GPE0, GPE1) AND has its own
465 * length field. If present, both the address and length must be valid.
467 if ((address64
->address
&& !length
)
468 || (!address64
->address
&& length
)) {
469 ACPI_WARNING((AE_INFO
,
470 "Optional field \"%s\" has zero address or length: %8.8X%8.8X/%X",
471 fadt_info_table
[i
].name
,
472 ACPI_FORMAT_UINT64(address64
->
478 /* If both 32- and 64-bit addresses are valid (non-zero), they must match */
480 if (address64
->address
&& *address32
&&
481 (address64
->address
!= (u64
) * address32
)) {
483 "32/64X address mismatch in \"%s\": [%8.8X] [%8.8X%8.8X], using 64X",
484 fadt_info_table
[i
].name
, *address32
,
485 ACPI_FORMAT_UINT64(address64
->address
)));