1 /******************************************************************************
3 * Module Name: tbutils - ACPI 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("tbutils")
51 /* Local prototypes */
52 static acpi_physical_address
53 acpi_tb_get_root_table_entry(u8 *table_entry, u32 table_entry_size);
55 /*******************************************************************************
57 * FUNCTION: acpi_tb_check_xsdt
59 * PARAMETERS: address - Pointer to the XSDT
62 * AE_OK - XSDT is okay
63 * AE_NO_MEMORY - can't map XSDT
64 * AE_INVALID_TABLE_LENGTH - invalid table length
65 * AE_NULL_ENTRY - XSDT has NULL entry
67 * DESCRIPTION: validate XSDT
68 ******************************************************************************/
71 acpi_tb_check_xsdt(acpi_physical_address address)
73 struct acpi_table_header *table;
75 u64 xsdt_entry_address;
80 table = acpi_os_map_memory(address, sizeof(struct acpi_table_header));
84 length = table->length;
85 acpi_os_unmap_memory(table, sizeof(struct acpi_table_header));
86 if (length < sizeof(struct acpi_table_header))
87 return AE_INVALID_TABLE_LENGTH;
89 table = acpi_os_map_memory(address, length);
93 /* Calculate the number of tables described in XSDT */
95 (u32) ((table->length -
96 sizeof(struct acpi_table_header)) / sizeof(u64));
98 ACPI_CAST_PTR(u8, table) + sizeof(struct acpi_table_header);
99 for (i = 0; i < table_count; i++) {
100 ACPI_MOVE_64_TO_64(&xsdt_entry_address, table_entry);
101 if (!xsdt_entry_address) {
102 /* XSDT has NULL entry */
105 table_entry += sizeof(u64);
107 acpi_os_unmap_memory(table, length);
110 return AE_NULL_ENTRY;
115 #if (!ACPI_REDUCED_HARDWARE)
116 /*******************************************************************************
118 * FUNCTION: acpi_tb_initialize_facs
124 * DESCRIPTION: Create a permanent mapping for the FADT and save it in a global
125 * for accessing the Global Lock and Firmware Waking Vector
127 ******************************************************************************/
129 acpi_status acpi_tb_initialize_facs(void)
133 /* If Hardware Reduced flag is set, there is no FACS */
135 if (acpi_gbl_reduced_hardware) {
136 acpi_gbl_FACS = NULL;
140 status = acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS,
141 ACPI_CAST_INDIRECT_PTR(struct
146 #endif /* !ACPI_REDUCED_HARDWARE */
148 /*******************************************************************************
150 * FUNCTION: acpi_tb_tables_loaded
154 * RETURN: TRUE if required ACPI tables are loaded
156 * DESCRIPTION: Determine if the minimum required ACPI tables are present
159 ******************************************************************************/
161 u8 acpi_tb_tables_loaded(void)
164 if (acpi_gbl_root_table_list.current_table_count >= 3) {
171 /*******************************************************************************
173 * FUNCTION: acpi_tb_check_dsdt_header
179 * DESCRIPTION: Quick compare to check validity of the DSDT. This will detect
180 * if the DSDT has been replaced from outside the OS and/or if
181 * the DSDT header has been corrupted.
183 ******************************************************************************/
185 void acpi_tb_check_dsdt_header(void)
188 /* Compare original length and checksum to current values */
190 if (acpi_gbl_original_dsdt_header.length != acpi_gbl_DSDT->length ||
191 acpi_gbl_original_dsdt_header.checksum != acpi_gbl_DSDT->checksum) {
192 ACPI_BIOS_ERROR((AE_INFO,
193 "The DSDT has been corrupted or replaced - "
194 "old, new headers below"));
195 acpi_tb_print_table_header(0, &acpi_gbl_original_dsdt_header);
196 acpi_tb_print_table_header(0, acpi_gbl_DSDT);
199 "Please send DMI info to linux-acpi@vger.kernel.org\n"
200 "If system does not work as expected, please boot with acpi=copy_dsdt"));
202 /* Disable further error messages */
204 acpi_gbl_original_dsdt_header.length = acpi_gbl_DSDT->length;
205 acpi_gbl_original_dsdt_header.checksum =
206 acpi_gbl_DSDT->checksum;
210 /*******************************************************************************
212 * FUNCTION: acpi_tb_copy_dsdt
214 * PARAMETERS: table_desc - Installed table to copy
218 * DESCRIPTION: Implements a subsystem option to copy the DSDT to local memory.
219 * Some very bad BIOSs are known to either corrupt the DSDT or
220 * install a new, bad DSDT. This copy works around the problem.
222 ******************************************************************************/
224 struct acpi_table_header *acpi_tb_copy_dsdt(u32 table_index)
226 struct acpi_table_header *new_table;
227 struct acpi_table_desc *table_desc;
229 table_desc = &acpi_gbl_root_table_list.tables[table_index];
231 new_table = ACPI_ALLOCATE(table_desc->length);
233 ACPI_ERROR((AE_INFO, "Could not copy DSDT of length 0x%X",
234 table_desc->length));
238 ACPI_MEMCPY(new_table, table_desc->pointer, table_desc->length);
239 acpi_tb_delete_table(table_desc);
240 table_desc->pointer = new_table;
241 table_desc->flags = ACPI_TABLE_ORIGIN_ALLOCATED;
244 "Forced DSDT copy: length 0x%05X copied locally, original unmapped",
250 /*******************************************************************************
252 * FUNCTION: acpi_tb_install_table
254 * PARAMETERS: address - Physical address of DSDT or FACS
255 * signature - Table signature, NULL if no need to
257 * table_index - Index into root table array
261 * DESCRIPTION: Install an ACPI table into the global data structure. The
262 * table override mechanism is called to allow the host
263 * OS to replace any table before it is installed in the root
266 ******************************************************************************/
269 acpi_tb_install_table(acpi_physical_address address,
270 char *signature, u32 table_index)
272 struct acpi_table_header *table;
273 struct acpi_table_header *final_table;
274 struct acpi_table_desc *table_desc;
278 "Null physical address for ACPI table [%s]",
283 /* Map just the table header */
285 table = acpi_os_map_memory(address, sizeof(struct acpi_table_header));
288 "Could not map memory for table [%s] at %p",
289 signature, ACPI_CAST_PTR(void, address)));
293 /* If a particular signature is expected (DSDT/FACS), it must match */
295 if (signature && !ACPI_COMPARE_NAME(table->signature, signature)) {
296 ACPI_BIOS_ERROR((AE_INFO,
297 "Invalid signature 0x%X for ACPI table, expected [%s]",
298 *ACPI_CAST_PTR(u32, table->signature),
304 * Initialize the table entry. Set the pointer to NULL, since the
305 * table is not fully mapped at this time.
307 table_desc = &acpi_gbl_root_table_list.tables[table_index];
309 table_desc->address = address;
310 table_desc->pointer = NULL;
311 table_desc->length = table->length;
312 table_desc->flags = ACPI_TABLE_ORIGIN_MAPPED;
313 ACPI_MOVE_32_TO_32(table_desc->signature.ascii, table->signature);
316 * ACPI Table Override:
318 * Before we install the table, let the host OS override it with a new
319 * one if desired. Any table within the RSDT/XSDT can be replaced,
320 * including the DSDT which is pointed to by the FADT.
322 * NOTE: If the table is overridden, then final_table will contain a
323 * mapped pointer to the full new table. If the table is not overridden,
324 * or if there has been a physical override, then the table will be
325 * fully mapped later (in verify table). In any case, we must
326 * unmap the header that was mapped above.
328 final_table = acpi_tb_table_override(table, table_desc);
330 final_table = table; /* There was no override */
333 acpi_tb_print_table_header(table_desc->address, final_table);
335 /* Set the global integer width (based upon revision of the DSDT) */
337 if (table_index == ACPI_TABLE_INDEX_DSDT) {
338 acpi_ut_set_integer_width(final_table->revision);
342 * If we have a physical override during this early loading of the ACPI
343 * tables, unmap the table for now. It will be mapped again later when
344 * it is actually used. This supports very early loading of ACPI tables,
345 * before virtual memory is fully initialized and running within the
346 * host OS. Note: A logical override has the ACPI_TABLE_ORIGIN_OVERRIDE
347 * flag set and will not be deleted below.
349 if (final_table != table) {
350 acpi_tb_delete_table(table_desc);
355 /* Always unmap the table header that we mapped above */
357 acpi_os_unmap_memory(table, sizeof(struct acpi_table_header));
360 /*******************************************************************************
362 * FUNCTION: acpi_tb_get_root_table_entry
364 * PARAMETERS: table_entry - Pointer to the RSDT/XSDT table entry
365 * table_entry_size - sizeof 32 or 64 (RSDT or XSDT)
367 * RETURN: Physical address extracted from the root table
369 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on
370 * both 32-bit and 64-bit platforms
372 * NOTE: acpi_physical_address is 32-bit on 32-bit platforms, 64-bit on
375 ******************************************************************************/
377 static acpi_physical_address
378 acpi_tb_get_root_table_entry(u8 *table_entry, u32 table_entry_size)
383 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT):
384 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT
386 if (table_entry_size == sizeof(u32)) {
388 * 32-bit platform, RSDT: Return 32-bit table entry
389 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return
391 return ((acpi_physical_address)
392 (*ACPI_CAST_PTR(u32, table_entry)));
395 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return
396 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local,
399 ACPI_MOVE_64_TO_64(&address64, table_entry);
401 #if ACPI_MACHINE_WIDTH == 32
402 if (address64 > ACPI_UINT32_MAX) {
404 /* Will truncate 64-bit address to 32 bits, issue warning */
406 ACPI_BIOS_WARNING((AE_INFO,
407 "64-bit Physical Address in XSDT is too large (0x%8.8X%8.8X),"
409 ACPI_FORMAT_UINT64(address64)));
412 return ((acpi_physical_address) (address64));
416 /*******************************************************************************
418 * FUNCTION: acpi_tb_parse_root_table
420 * PARAMETERS: rsdp - Pointer to the RSDP
424 * DESCRIPTION: This function is called to parse the Root System Description
425 * Table (RSDT or XSDT)
427 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must
428 * be mapped and cannot be copied because it contains the actual
429 * memory location of the ACPI Global Lock.
431 ******************************************************************************/
434 acpi_tb_parse_root_table(acpi_physical_address rsdp_address)
436 struct acpi_table_rsdp *rsdp;
437 u32 table_entry_size;
440 struct acpi_table_header *table;
441 acpi_physical_address address;
442 acpi_physical_address uninitialized_var(rsdt_address);
447 ACPI_FUNCTION_TRACE(tb_parse_root_table);
450 * Map the entire RSDP and extract the address of the RSDT or XSDT
452 rsdp = acpi_os_map_memory(rsdp_address, sizeof(struct acpi_table_rsdp));
454 return_ACPI_STATUS(AE_NO_MEMORY);
457 acpi_tb_print_table_header(rsdp_address,
458 ACPI_CAST_PTR(struct acpi_table_header,
461 /* Differentiate between RSDT and XSDT root tables */
463 if (rsdp->revision > 1 && rsdp->xsdt_physical_address
464 && !acpi_rsdt_forced) {
466 * Root table is an XSDT (64-bit physical addresses). We must use the
467 * XSDT if the revision is > 1 and the XSDT pointer is present, as per
468 * the ACPI specification.
470 address = (acpi_physical_address) rsdp->xsdt_physical_address;
471 table_entry_size = sizeof(u64);
472 rsdt_address = (acpi_physical_address)
473 rsdp->rsdt_physical_address;
475 /* Root table is an RSDT (32-bit physical addresses) */
477 address = (acpi_physical_address) rsdp->rsdt_physical_address;
478 table_entry_size = sizeof(u32);
482 * It is not possible to map more than one entry in some environments,
483 * so unmap the RSDP here before mapping other tables
485 acpi_os_unmap_memory(rsdp, sizeof(struct acpi_table_rsdp));
487 if (table_entry_size == sizeof(u64)) {
488 if (acpi_tb_check_xsdt(address) == AE_NULL_ENTRY) {
489 /* XSDT has NULL entry, RSDT is used */
490 address = rsdt_address;
491 table_entry_size = sizeof(u32);
492 ACPI_WARNING((AE_INFO, "BIOS XSDT has NULL entry, "
496 /* Map the RSDT/XSDT table header to get the full table length */
498 table = acpi_os_map_memory(address, sizeof(struct acpi_table_header));
500 return_ACPI_STATUS(AE_NO_MEMORY);
503 acpi_tb_print_table_header(address, table);
505 /* Get the length of the full table, verify length and map entire table */
507 length = table->length;
508 acpi_os_unmap_memory(table, sizeof(struct acpi_table_header));
510 if (length < sizeof(struct acpi_table_header)) {
511 ACPI_BIOS_ERROR((AE_INFO,
512 "Invalid table length 0x%X in RSDT/XSDT",
514 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
517 table = acpi_os_map_memory(address, length);
519 return_ACPI_STATUS(AE_NO_MEMORY);
522 /* Validate the root table checksum */
524 status = acpi_tb_verify_checksum(table, length);
525 if (ACPI_FAILURE(status)) {
526 acpi_os_unmap_memory(table, length);
527 return_ACPI_STATUS(status);
530 /* Calculate the number of tables described in the root table */
532 table_count = (u32)((table->length - sizeof(struct acpi_table_header)) /
535 * First two entries in the table array are reserved for the DSDT
536 * and FACS, which are not actually present in the RSDT/XSDT - they
540 ACPI_CAST_PTR(u8, table) + sizeof(struct acpi_table_header);
541 acpi_gbl_root_table_list.current_table_count = 2;
544 * Initialize the root table array from the RSDT/XSDT
546 for (i = 0; i < table_count; i++) {
547 if (acpi_gbl_root_table_list.current_table_count >=
548 acpi_gbl_root_table_list.max_table_count) {
550 /* There is no more room in the root table array, attempt resize */
552 status = acpi_tb_resize_root_table_list();
553 if (ACPI_FAILURE(status)) {
554 ACPI_WARNING((AE_INFO,
555 "Truncating %u table entries!",
556 (unsigned) (table_count -
557 (acpi_gbl_root_table_list.
558 current_table_count -
564 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */
566 acpi_gbl_root_table_list.tables[acpi_gbl_root_table_list.
567 current_table_count].address =
568 acpi_tb_get_root_table_entry(table_entry, table_entry_size);
570 table_entry += table_entry_size;
571 acpi_gbl_root_table_list.current_table_count++;
575 * It is not possible to map more than one entry in some environments,
576 * so unmap the root table here before mapping other tables
578 acpi_os_unmap_memory(table, length);
581 * Complete the initialization of the root table array by examining
582 * the header of each table
584 for (i = 2; i < acpi_gbl_root_table_list.current_table_count; i++) {
585 acpi_tb_install_table(acpi_gbl_root_table_list.tables[i].
588 /* Special case for FADT - get the DSDT and FACS */
590 if (ACPI_COMPARE_NAME
591 (&acpi_gbl_root_table_list.tables[i].signature,
593 acpi_tb_parse_fadt(i);
597 return_ACPI_STATUS(AE_OK);