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/actables.h>
47 #define _COMPONENT ACPI_TABLES
48 ACPI_MODULE_NAME("tbfadt")
50 /* Local prototypes */
52 acpi_tb_init_generic_address(struct acpi_generic_address
*generic_address
,
53 u8 byte_width
, u64 address
);
55 static void acpi_tb_convert_fadt(void);
57 static void acpi_tb_validate_fadt(void);
59 /* Table for conversion of FADT to common internal format and FADT validation */
61 typedef struct acpi_fadt_info
{
70 #define ACPI_FADT_REQUIRED 1
71 #define ACPI_FADT_SEPARATE_LENGTH 2
73 static struct acpi_fadt_info fadt_info_table
[] = {
74 {"Pm1aEventBlock", ACPI_FADT_OFFSET(xpm1a_event_block
),
75 ACPI_FADT_OFFSET(pm1a_event_block
),
76 ACPI_FADT_OFFSET(pm1_event_length
), ACPI_FADT_REQUIRED
},
78 {"Pm1bEventBlock", ACPI_FADT_OFFSET(xpm1b_event_block
),
79 ACPI_FADT_OFFSET(pm1b_event_block
),
80 ACPI_FADT_OFFSET(pm1_event_length
), 0},
82 {"Pm1aControlBlock", ACPI_FADT_OFFSET(xpm1a_control_block
),
83 ACPI_FADT_OFFSET(pm1a_control_block
),
84 ACPI_FADT_OFFSET(pm1_control_length
), ACPI_FADT_REQUIRED
},
86 {"Pm1bControlBlock", ACPI_FADT_OFFSET(xpm1b_control_block
),
87 ACPI_FADT_OFFSET(pm1b_control_block
),
88 ACPI_FADT_OFFSET(pm1_control_length
), 0},
90 {"Pm2ControlBlock", ACPI_FADT_OFFSET(xpm2_control_block
),
91 ACPI_FADT_OFFSET(pm2_control_block
),
92 ACPI_FADT_OFFSET(pm2_control_length
), ACPI_FADT_SEPARATE_LENGTH
},
94 {"PmTimerBlock", ACPI_FADT_OFFSET(xpm_timer_block
),
95 ACPI_FADT_OFFSET(pm_timer_block
),
96 ACPI_FADT_OFFSET(pm_timer_length
), ACPI_FADT_REQUIRED
},
98 {"Gpe0Block", ACPI_FADT_OFFSET(xgpe0_block
),
99 ACPI_FADT_OFFSET(gpe0_block
),
100 ACPI_FADT_OFFSET(gpe0_block_length
), ACPI_FADT_SEPARATE_LENGTH
},
102 {"Gpe1Block", ACPI_FADT_OFFSET(xgpe1_block
),
103 ACPI_FADT_OFFSET(gpe1_block
),
104 ACPI_FADT_OFFSET(gpe1_block_length
), ACPI_FADT_SEPARATE_LENGTH
}
107 #define ACPI_FADT_INFO_ENTRIES (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
109 /*******************************************************************************
111 * FUNCTION: acpi_tb_init_generic_address
113 * PARAMETERS: generic_address - GAS struct to be initialized
114 * byte_width - Width of this register
115 * Address - Address of the register
119 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
120 * See the ACPI specification for a full description and
121 * definition of this structure.
123 ******************************************************************************/
126 acpi_tb_init_generic_address(struct acpi_generic_address
*generic_address
,
127 u8 byte_width
, u64 address
)
131 * The 64-bit Address field is non-aligned in the byte packed
134 ACPI_MOVE_64_TO_64(&generic_address
->address
, &address
);
136 /* All other fields are byte-wide */
138 generic_address
->space_id
= ACPI_ADR_SPACE_SYSTEM_IO
;
139 generic_address
->bit_width
= byte_width
<< 3;
140 generic_address
->bit_offset
= 0;
141 generic_address
->access_width
= 0;
144 /*******************************************************************************
146 * FUNCTION: acpi_tb_parse_fadt
148 * PARAMETERS: table_index - Index for the FADT
153 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
154 * (FADT contains the addresses of the DSDT and FACS)
156 ******************************************************************************/
158 void acpi_tb_parse_fadt(u32 table_index
, u8 flags
)
161 struct acpi_table_header
*table
;
164 * The FADT has multiple versions with different lengths,
165 * and it contains pointers to both the DSDT and FACS tables.
167 * Get a local copy of the FADT and convert it to a common format
168 * Map entire FADT, assumed to be smaller than one page.
170 length
= acpi_gbl_root_table_list
.tables
[table_index
].length
;
173 acpi_os_map_memory(acpi_gbl_root_table_list
.tables
[table_index
].
180 * Validate the FADT checksum before we copy the table. Ignore
181 * checksum error as we want to try to get the DSDT and FACS.
183 (void)acpi_tb_verify_checksum(table
, length
);
185 /* Obtain a local copy of the FADT in common ACPI 2.0+ format */
187 acpi_tb_create_local_fadt(table
, length
);
189 /* All done with the real FADT, unmap it */
191 acpi_os_unmap_memory(table
, length
);
193 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
195 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.Xdsdt
,
196 flags
, ACPI_SIG_DSDT
, ACPI_TABLE_INDEX_DSDT
);
198 acpi_tb_install_table((acpi_physical_address
) acpi_gbl_FADT
.Xfacs
,
199 flags
, ACPI_SIG_FACS
, ACPI_TABLE_INDEX_FACS
);
202 /*******************************************************************************
204 * FUNCTION: acpi_tb_create_local_fadt
206 * PARAMETERS: Table - Pointer to BIOS FADT
207 * Length - Length of the table
211 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
212 * Performs validation on some important FADT fields.
214 * NOTE: We create a local copy of the FADT regardless of the version.
216 ******************************************************************************/
218 void acpi_tb_create_local_fadt(struct acpi_table_header
*table
, u32 length
)
222 * Check if the FADT is larger than the largest table that we expect
223 * (the ACPI 2.0/3.0 version). If so, truncate the table, and issue
226 if (length
> sizeof(struct acpi_table_fadt
)) {
227 ACPI_WARNING((AE_INFO
,
228 "FADT (revision %u) is longer than ACPI 2.0 version, truncating length 0x%X to 0x%zX",
229 table
->revision
, (unsigned)length
,
230 sizeof(struct acpi_table_fadt
)));
233 /* Clear the entire local FADT */
235 ACPI_MEMSET(&acpi_gbl_FADT
, 0, sizeof(struct acpi_table_fadt
));
237 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
239 ACPI_MEMCPY(&acpi_gbl_FADT
, table
,
240 ACPI_MIN(length
, sizeof(struct acpi_table_fadt
)));
243 * 1) Convert the local copy of the FADT to the common internal format
244 * 2) Validate some of the important values within the FADT
246 acpi_tb_convert_fadt();
247 acpi_tb_validate_fadt();
250 /*******************************************************************************
252 * FUNCTION: acpi_tb_convert_fadt
254 * PARAMETERS: None, uses acpi_gbl_FADT
258 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
259 * Expand all 32-bit addresses to 64-bit.
261 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt),
262 * and must contain a copy of the actual FADT.
264 * ACPICA will use the "X" fields of the FADT for all addresses.
266 * "X" fields are optional extensions to the original V1.0 fields. Even if
267 * they are present in the structure, they can be optionally not used by
268 * setting them to zero. Therefore, we must selectively expand V1.0 fields
269 * if the corresponding X field is zero.
271 * For ACPI 1.0 FADTs, all address fields are expanded to the corresponding
274 * For ACPI 2.0 FADTs, any "X" fields that are NULL are filled in by
275 * expanding the corresponding ACPI 1.0 field.
277 ******************************************************************************/
279 static void acpi_tb_convert_fadt(void)
281 u8 pm1_register_length
;
282 struct acpi_generic_address
*target
;
285 /* Update the local FADT table header length */
287 acpi_gbl_FADT
.header
.length
= sizeof(struct acpi_table_fadt
);
289 /* Expand the 32-bit FACS and DSDT addresses to 64-bit as necessary */
291 if (!acpi_gbl_FADT
.Xfacs
) {
292 acpi_gbl_FADT
.Xfacs
= (u64
) acpi_gbl_FADT
.facs
;
295 if (!acpi_gbl_FADT
.Xdsdt
) {
296 acpi_gbl_FADT
.Xdsdt
= (u64
) acpi_gbl_FADT
.dsdt
;
300 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
301 * should be zero are indeed zero. This will workaround BIOSs that
302 * inadvertently place values in these fields.
304 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located at
305 * offset 45, 55, 95, and the word located at offset 109, 110.
307 if (acpi_gbl_FADT
.header
.revision
< FADT2_REVISION_ID
) {
308 acpi_gbl_FADT
.preferred_profile
= 0;
309 acpi_gbl_FADT
.pstate_control
= 0;
310 acpi_gbl_FADT
.cst_control
= 0;
311 acpi_gbl_FADT
.boot_flags
= 0;
315 * Expand the ACPI 1.0 32-bit V1.0 addresses to the ACPI 2.0 64-bit "X"
316 * generic address structures as necessary.
318 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
320 ACPI_ADD_PTR(struct acpi_generic_address
, &acpi_gbl_FADT
,
321 fadt_info_table
[i
].target
);
323 /* Expand only if the X target is null */
325 if (!target
->address
) {
326 acpi_tb_init_generic_address(target
,
331 (u64
) * ACPI_ADD_PTR(u32
,
340 * Calculate separate GAS structs for the PM1 Enable registers.
341 * These addresses do not appear (directly) in the FADT, so it is
342 * useful to calculate them once, here.
344 * The PM event blocks are split into two register blocks, first is the
345 * PM Status Register block, followed immediately by the PM Enable
346 * Register block. Each is of length (xpm1x_event_block.bit_width/2).
348 * On various systems the v2 fields (and particularly the bit widths)
349 * cannot be relied upon, though. Hence resort to using the v1 length
350 * here (and warn about the inconsistency).
352 if (acpi_gbl_FADT
.xpm1a_event_block
.bit_width
353 != acpi_gbl_FADT
.pm1_event_length
* 8)
354 printk(KERN_WARNING
"FADT: "
355 "X_PM1a_EVT_BLK.bit_width (%u) does not match"
356 " PM1_EVT_LEN (%u)\n",
357 acpi_gbl_FADT
.xpm1a_event_block
.bit_width
,
358 acpi_gbl_FADT
.pm1_event_length
);
359 pm1_register_length
= (u8
) ACPI_DIV_2(acpi_gbl_FADT
.pm1_event_length
);
361 /* The PM1A register block is required */
363 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable
,
365 (acpi_gbl_FADT
.xpm1a_event_block
.address
+
366 pm1_register_length
));
367 /* Don't forget to copy space_id of the GAS */
368 acpi_gbl_xpm1a_enable
.space_id
=
369 acpi_gbl_FADT
.xpm1a_event_block
.space_id
;
371 /* The PM1B register block is optional, ignore if not present */
373 if (acpi_gbl_FADT
.xpm1b_event_block
.address
) {
374 if (acpi_gbl_FADT
.xpm1b_event_block
.bit_width
375 != acpi_gbl_FADT
.pm1_event_length
* 8)
376 printk(KERN_WARNING
"FADT: "
377 "X_PM1b_EVT_BLK.bit_width (%u) does not match"
378 " PM1_EVT_LEN (%u)\n",
379 acpi_gbl_FADT
.xpm1b_event_block
.bit_width
,
380 acpi_gbl_FADT
.pm1_event_length
);
381 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable
,
383 (acpi_gbl_FADT
.xpm1b_event_block
.
384 address
+ pm1_register_length
));
385 /* Don't forget to copy space_id of the GAS */
386 acpi_gbl_xpm1b_enable
.space_id
=
387 acpi_gbl_FADT
.xpm1b_event_block
.space_id
;
392 /******************************************************************************
394 * FUNCTION: acpi_tb_validate_fadt
396 * PARAMETERS: Table - Pointer to the FADT to be validated
400 * DESCRIPTION: Validate various important fields within the FADT. If a problem
401 * is found, issue a message, but no status is returned.
402 * Used by both the table manager and the disassembler.
404 * Possible additional checks:
405 * (acpi_gbl_FADT.pm1_event_length >= 4)
406 * (acpi_gbl_FADT.pm1_control_length >= 2)
407 * (acpi_gbl_FADT.pm_timer_length >= 4)
408 * Gpe block lengths must be multiple of 2
410 ******************************************************************************/
412 static void acpi_tb_validate_fadt(void)
415 struct acpi_generic_address
*address64
;
419 /* Examine all of the 64-bit extended address fields (X fields) */
421 for (i
= 0; i
< ACPI_FADT_INFO_ENTRIES
; i
++) {
423 /* Generate pointers to the 32-bit and 64-bit addresses and get the length */
426 ACPI_ADD_PTR(struct acpi_generic_address
, &acpi_gbl_FADT
,
427 fadt_info_table
[i
].target
);
429 ACPI_ADD_PTR(u32
, &acpi_gbl_FADT
,
430 fadt_info_table
[i
].source
);
432 *ACPI_ADD_PTR(u8
, &acpi_gbl_FADT
,
433 fadt_info_table
[i
].length
);
435 if (fadt_info_table
[i
].type
& ACPI_FADT_REQUIRED
) {
437 * Field is required (Pm1a_event, Pm1a_control, pm_timer).
438 * Both the address and length must be non-zero.
440 if (!address64
->address
|| !length
) {
442 "Required field \"%s\" has zero address and/or length: %8.8X%8.8X/%X",
443 fadt_info_table
[i
].name
,
444 ACPI_FORMAT_UINT64(address64
->
448 } else if (fadt_info_table
[i
].type
& ACPI_FADT_SEPARATE_LENGTH
) {
450 * Field is optional (PM2Control, GPE0, GPE1) AND has its own
451 * length field. If present, both the address and length must be valid.
453 if ((address64
->address
&& !length
)
454 || (!address64
->address
&& length
)) {
455 ACPI_WARNING((AE_INFO
,
456 "Optional field \"%s\" has zero address or length: %8.8X%8.8X/%X",
457 fadt_info_table
[i
].name
,
458 ACPI_FORMAT_UINT64(address64
->
464 /* If both 32- and 64-bit addresses are valid (non-zero), they must match */
466 if (address64
->address
&& *address32
&&
467 (address64
->address
!= (u64
) * address32
)) {
469 "32/64X address mismatch in \"%s\": [%8.8X] [%8.8X%8.8X], using 64X",
470 fadt_info_table
[i
].name
, *address32
,
471 ACPI_FORMAT_UINT64(address64
->address
)));