1 /******************************************************************************
3 * Module Name: tbutils - 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("tbutils")
51 /* Local prototypes */
52 static void acpi_tb_fix_string(char *string
, acpi_size length
);
55 acpi_tb_cleanup_table_header(struct acpi_table_header
*out_header
,
56 struct acpi_table_header
*header
);
58 static acpi_physical_address
59 acpi_tb_get_root_table_entry(u8
*table_entry
, u32 table_entry_size
);
61 /*******************************************************************************
63 * FUNCTION: acpi_tb_check_xsdt
65 * PARAMETERS: address - Pointer to the XSDT
68 * AE_OK - XSDT is okay
69 * AE_NO_MEMORY - can't map XSDT
70 * AE_INVALID_TABLE_LENGTH - invalid table length
71 * AE_NULL_ENTRY - XSDT has NULL entry
73 * DESCRIPTION: validate XSDT
74 ******************************************************************************/
77 acpi_tb_check_xsdt(acpi_physical_address address
)
79 struct acpi_table_header
*table
;
81 u64 xsdt_entry_address
;
86 table
= acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
90 length
= table
->length
;
91 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
92 if (length
< sizeof(struct acpi_table_header
))
93 return AE_INVALID_TABLE_LENGTH
;
95 table
= acpi_os_map_memory(address
, length
);
99 /* Calculate the number of tables described in XSDT */
101 (u32
) ((table
->length
-
102 sizeof(struct acpi_table_header
)) / sizeof(u64
));
104 ACPI_CAST_PTR(u8
, table
) + sizeof(struct acpi_table_header
);
105 for (i
= 0; i
< table_count
; i
++) {
106 ACPI_MOVE_64_TO_64(&xsdt_entry_address
, table_entry
);
107 if (!xsdt_entry_address
) {
108 /* XSDT has NULL entry */
111 table_entry
+= sizeof(u64
);
113 acpi_os_unmap_memory(table
, length
);
116 return AE_NULL_ENTRY
;
121 /*******************************************************************************
123 * FUNCTION: acpi_tb_initialize_facs
129 * DESCRIPTION: Create a permanent mapping for the FADT and save it in a global
130 * for accessing the Global Lock and Firmware Waking Vector
132 ******************************************************************************/
134 acpi_status
acpi_tb_initialize_facs(void)
138 /* If Hardware Reduced flag is set, there is no FACS */
140 if (acpi_gbl_reduced_hardware
) {
141 acpi_gbl_FACS
= NULL
;
145 status
= acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
146 ACPI_CAST_INDIRECT_PTR(struct
152 /*******************************************************************************
154 * FUNCTION: acpi_tb_tables_loaded
158 * RETURN: TRUE if required ACPI tables are loaded
160 * DESCRIPTION: Determine if the minimum required ACPI tables are present
163 ******************************************************************************/
165 u8
acpi_tb_tables_loaded(void)
168 if (acpi_gbl_root_table_list
.current_table_count
>= 3) {
175 /*******************************************************************************
177 * FUNCTION: acpi_tb_fix_string
179 * PARAMETERS: String - String to be repaired
180 * Length - Maximum length
184 * DESCRIPTION: Replace every non-printable or non-ascii byte in the string
185 * with a question mark '?'.
187 ******************************************************************************/
189 static void acpi_tb_fix_string(char *string
, acpi_size length
)
192 while (length
&& *string
) {
193 if (!ACPI_IS_PRINT(*string
)) {
201 /*******************************************************************************
203 * FUNCTION: acpi_tb_cleanup_table_header
205 * PARAMETERS: out_header - Where the cleaned header is returned
206 * Header - Input ACPI table header
208 * RETURN: Returns the cleaned header in out_header
210 * DESCRIPTION: Copy the table header and ensure that all "string" fields in
211 * the header consist of printable characters.
213 ******************************************************************************/
216 acpi_tb_cleanup_table_header(struct acpi_table_header
*out_header
,
217 struct acpi_table_header
*header
)
220 ACPI_MEMCPY(out_header
, header
, sizeof(struct acpi_table_header
));
222 acpi_tb_fix_string(out_header
->signature
, ACPI_NAME_SIZE
);
223 acpi_tb_fix_string(out_header
->oem_id
, ACPI_OEM_ID_SIZE
);
224 acpi_tb_fix_string(out_header
->oem_table_id
, ACPI_OEM_TABLE_ID_SIZE
);
225 acpi_tb_fix_string(out_header
->asl_compiler_id
, ACPI_NAME_SIZE
);
228 /*******************************************************************************
230 * FUNCTION: acpi_tb_print_table_header
232 * PARAMETERS: Address - Table physical address
233 * Header - Table header
237 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
239 ******************************************************************************/
242 acpi_tb_print_table_header(acpi_physical_address address
,
243 struct acpi_table_header
*header
)
245 struct acpi_table_header local_header
;
248 * The reason that the Address is cast to a void pointer is so that we
249 * can use %p which will work properly on both 32-bit and 64-bit hosts.
251 if (ACPI_COMPARE_NAME(header
->signature
, ACPI_SIG_FACS
)) {
253 /* FACS only has signature and length fields */
255 ACPI_INFO((AE_INFO
, "%4.4s %p %05X",
256 header
->signature
, ACPI_CAST_PTR(void, address
),
258 } else if (ACPI_COMPARE_NAME(header
->signature
, ACPI_SIG_RSDP
)) {
260 /* RSDP has no common fields */
262 ACPI_MEMCPY(local_header
.oem_id
,
263 ACPI_CAST_PTR(struct acpi_table_rsdp
,
264 header
)->oem_id
, ACPI_OEM_ID_SIZE
);
265 acpi_tb_fix_string(local_header
.oem_id
, ACPI_OEM_ID_SIZE
);
267 ACPI_INFO((AE_INFO
, "RSDP %p %05X (v%.2d %6.6s)",
268 ACPI_CAST_PTR (void, address
),
269 (ACPI_CAST_PTR(struct acpi_table_rsdp
, header
)->
271 0) ? ACPI_CAST_PTR(struct acpi_table_rsdp
,
272 header
)->length
: 20,
273 ACPI_CAST_PTR(struct acpi_table_rsdp
,
275 local_header
.oem_id
));
277 /* Standard ACPI table with full common header */
279 acpi_tb_cleanup_table_header(&local_header
, header
);
282 "%4.4s %p %05X (v%.2d %6.6s %8.8s %08X %4.4s %08X)",
283 local_header
.signature
, ACPI_CAST_PTR(void, address
),
284 local_header
.length
, local_header
.revision
,
285 local_header
.oem_id
, local_header
.oem_table_id
,
286 local_header
.oem_revision
,
287 local_header
.asl_compiler_id
,
288 local_header
.asl_compiler_revision
));
293 /*******************************************************************************
295 * FUNCTION: acpi_tb_validate_checksum
297 * PARAMETERS: Table - ACPI table to verify
298 * Length - Length of entire table
302 * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
303 * exception on bad checksum.
305 ******************************************************************************/
307 acpi_status
acpi_tb_verify_checksum(struct acpi_table_header
*table
, u32 length
)
311 /* Compute the checksum on the table */
313 checksum
= acpi_tb_checksum(ACPI_CAST_PTR(u8
, table
), length
);
315 /* Checksum ok? (should be zero) */
318 ACPI_WARNING((AE_INFO
,
319 "Incorrect checksum in table [%4.4s] - 0x%2.2X, should be 0x%2.2X",
320 table
->signature
, table
->checksum
,
321 (u8
) (table
->checksum
- checksum
)));
323 #if (ACPI_CHECKSUM_ABORT)
325 return (AE_BAD_CHECKSUM
);
332 /*******************************************************************************
334 * FUNCTION: acpi_tb_checksum
336 * PARAMETERS: Buffer - Pointer to memory region to be checked
337 * Length - Length of this memory region
339 * RETURN: Checksum (u8)
341 * DESCRIPTION: Calculates circular checksum of memory region.
343 ******************************************************************************/
345 u8
acpi_tb_checksum(u8
*buffer
, u32 length
)
348 u8
*end
= buffer
+ length
;
350 while (buffer
< end
) {
351 sum
= (u8
) (sum
+ *(buffer
++));
357 /*******************************************************************************
359 * FUNCTION: acpi_tb_check_dsdt_header
365 * DESCRIPTION: Quick compare to check validity of the DSDT. This will detect
366 * if the DSDT has been replaced from outside the OS and/or if
367 * the DSDT header has been corrupted.
369 ******************************************************************************/
371 void acpi_tb_check_dsdt_header(void)
374 /* Compare original length and checksum to current values */
376 if (acpi_gbl_original_dsdt_header
.length
!= acpi_gbl_DSDT
->length
||
377 acpi_gbl_original_dsdt_header
.checksum
!= acpi_gbl_DSDT
->checksum
) {
379 "The DSDT has been corrupted or replaced - old, new headers below"));
380 acpi_tb_print_table_header(0, &acpi_gbl_original_dsdt_header
);
381 acpi_tb_print_table_header(0, acpi_gbl_DSDT
);
384 "Please send DMI info to linux-acpi@vger.kernel.org\n"
385 "If system does not work as expected, please boot with acpi=copy_dsdt"));
387 /* Disable further error messages */
389 acpi_gbl_original_dsdt_header
.length
= acpi_gbl_DSDT
->length
;
390 acpi_gbl_original_dsdt_header
.checksum
=
391 acpi_gbl_DSDT
->checksum
;
395 /*******************************************************************************
397 * FUNCTION: acpi_tb_copy_dsdt
399 * PARAMETERS: table_desc - Installed table to copy
403 * DESCRIPTION: Implements a subsystem option to copy the DSDT to local memory.
404 * Some very bad BIOSs are known to either corrupt the DSDT or
405 * install a new, bad DSDT. This copy works around the problem.
407 ******************************************************************************/
409 struct acpi_table_header
*acpi_tb_copy_dsdt(u32 table_index
)
411 struct acpi_table_header
*new_table
;
412 struct acpi_table_desc
*table_desc
;
414 table_desc
= &acpi_gbl_root_table_list
.tables
[table_index
];
416 new_table
= ACPI_ALLOCATE(table_desc
->length
);
418 ACPI_ERROR((AE_INFO
, "Could not copy DSDT of length 0x%X",
419 table_desc
->length
));
423 ACPI_MEMCPY(new_table
, table_desc
->pointer
, table_desc
->length
);
424 acpi_tb_delete_table(table_desc
);
425 table_desc
->pointer
= new_table
;
426 table_desc
->flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
429 "Forced DSDT copy: length 0x%05X copied locally, original unmapped",
435 /*******************************************************************************
437 * FUNCTION: acpi_tb_install_table
439 * PARAMETERS: Address - Physical address of DSDT or FACS
440 * Signature - Table signature, NULL if no need to
442 * table_index - Index into root table array
446 * DESCRIPTION: Install an ACPI table into the global data structure. The
447 * table override mechanism is implemented here to allow the host
448 * OS to replace any table before it is installed in the root
451 ******************************************************************************/
454 acpi_tb_install_table(acpi_physical_address address
,
455 char *signature
, u32 table_index
)
459 struct acpi_table_header
*table_to_install
;
460 struct acpi_table_header
*mapped_table
;
461 struct acpi_table_header
*override_table
= NULL
;
465 "Null physical address for ACPI table [%s]",
470 /* Map just the table header */
473 acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
478 /* If a particular signature is expected (DSDT/FACS), it must match */
480 if (signature
&& !ACPI_COMPARE_NAME(mapped_table
->signature
, signature
)) {
482 "Invalid signature 0x%X for ACPI table, expected [%s]",
483 *ACPI_CAST_PTR(u32
, mapped_table
->signature
),
489 * ACPI Table Override:
491 * Before we install the table, let the host OS override it with a new
492 * one if desired. Any table within the RSDT/XSDT can be replaced,
493 * including the DSDT which is pointed to by the FADT.
495 status
= acpi_os_table_override(mapped_table
, &override_table
);
496 if (ACPI_SUCCESS(status
) && override_table
) {
498 "%4.4s @ 0x%p Table override, replaced with:",
499 mapped_table
->signature
, ACPI_CAST_PTR(void,
502 acpi_gbl_root_table_list
.tables
[table_index
].pointer
=
504 address
= ACPI_PTR_TO_PHYSADDR(override_table
);
506 table_to_install
= override_table
;
507 flags
= ACPI_TABLE_ORIGIN_OVERRIDE
;
509 table_to_install
= mapped_table
;
510 flags
= ACPI_TABLE_ORIGIN_MAPPED
;
513 /* Initialize the table entry */
515 acpi_gbl_root_table_list
.tables
[table_index
].address
= address
;
516 acpi_gbl_root_table_list
.tables
[table_index
].length
=
517 table_to_install
->length
;
518 acpi_gbl_root_table_list
.tables
[table_index
].flags
= flags
;
521 (acpi_gbl_root_table_list
.tables
[table_index
].
522 signature
), table_to_install
->signature
);
524 acpi_tb_print_table_header(address
, table_to_install
);
526 if (table_index
== ACPI_TABLE_INDEX_DSDT
) {
528 /* Global integer width is based upon revision of the DSDT */
530 acpi_ut_set_integer_width(table_to_install
->revision
);
534 acpi_os_unmap_memory(mapped_table
, sizeof(struct acpi_table_header
));
537 /*******************************************************************************
539 * FUNCTION: acpi_tb_get_root_table_entry
541 * PARAMETERS: table_entry - Pointer to the RSDT/XSDT table entry
542 * table_entry_size - sizeof 32 or 64 (RSDT or XSDT)
544 * RETURN: Physical address extracted from the root table
546 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on
547 * both 32-bit and 64-bit platforms
549 * NOTE: acpi_physical_address is 32-bit on 32-bit platforms, 64-bit on
552 ******************************************************************************/
554 static acpi_physical_address
555 acpi_tb_get_root_table_entry(u8
*table_entry
, u32 table_entry_size
)
560 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT):
561 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT
563 if (table_entry_size
== sizeof(u32
)) {
565 * 32-bit platform, RSDT: Return 32-bit table entry
566 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return
568 return ((acpi_physical_address
)
569 (*ACPI_CAST_PTR(u32
, table_entry
)));
572 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return
573 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local,
576 ACPI_MOVE_64_TO_64(&address64
, table_entry
);
578 #if ACPI_MACHINE_WIDTH == 32
579 if (address64
> ACPI_UINT32_MAX
) {
581 /* Will truncate 64-bit address to 32 bits, issue warning */
583 ACPI_WARNING((AE_INFO
,
584 "64-bit Physical Address in XSDT is too large (0x%8.8X%8.8X),"
586 ACPI_FORMAT_UINT64(address64
)));
589 return ((acpi_physical_address
) (address64
));
593 /*******************************************************************************
595 * FUNCTION: acpi_tb_parse_root_table
597 * PARAMETERS: Rsdp - Pointer to the RSDP
601 * DESCRIPTION: This function is called to parse the Root System Description
602 * Table (RSDT or XSDT)
604 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must
605 * be mapped and cannot be copied because it contains the actual
606 * memory location of the ACPI Global Lock.
608 ******************************************************************************/
611 acpi_tb_parse_root_table(acpi_physical_address rsdp_address
)
613 struct acpi_table_rsdp
*rsdp
;
614 u32 table_entry_size
;
617 struct acpi_table_header
*table
;
618 acpi_physical_address address
;
619 acpi_physical_address
uninitialized_var(rsdt_address
);
624 ACPI_FUNCTION_TRACE(tb_parse_root_table
);
627 * Map the entire RSDP and extract the address of the RSDT or XSDT
629 rsdp
= acpi_os_map_memory(rsdp_address
, sizeof(struct acpi_table_rsdp
));
631 return_ACPI_STATUS(AE_NO_MEMORY
);
634 acpi_tb_print_table_header(rsdp_address
,
635 ACPI_CAST_PTR(struct acpi_table_header
,
638 /* Differentiate between RSDT and XSDT root tables */
640 if (rsdp
->revision
> 1 && rsdp
->xsdt_physical_address
641 && !acpi_rsdt_forced
) {
643 * Root table is an XSDT (64-bit physical addresses). We must use the
644 * XSDT if the revision is > 1 and the XSDT pointer is present, as per
645 * the ACPI specification.
647 address
= (acpi_physical_address
) rsdp
->xsdt_physical_address
;
648 table_entry_size
= sizeof(u64
);
649 rsdt_address
= (acpi_physical_address
)
650 rsdp
->rsdt_physical_address
;
652 /* Root table is an RSDT (32-bit physical addresses) */
654 address
= (acpi_physical_address
) rsdp
->rsdt_physical_address
;
655 table_entry_size
= sizeof(u32
);
659 * It is not possible to map more than one entry in some environments,
660 * so unmap the RSDP here before mapping other tables
662 acpi_os_unmap_memory(rsdp
, sizeof(struct acpi_table_rsdp
));
664 if (table_entry_size
== sizeof(u64
)) {
665 if (acpi_tb_check_xsdt(address
) == AE_NULL_ENTRY
) {
666 /* XSDT has NULL entry, RSDT is used */
667 address
= rsdt_address
;
668 table_entry_size
= sizeof(u32
);
669 ACPI_WARNING((AE_INFO
, "BIOS XSDT has NULL entry, "
673 /* Map the RSDT/XSDT table header to get the full table length */
675 table
= acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
677 return_ACPI_STATUS(AE_NO_MEMORY
);
680 acpi_tb_print_table_header(address
, table
);
682 /* Get the length of the full table, verify length and map entire table */
684 length
= table
->length
;
685 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
687 if (length
< sizeof(struct acpi_table_header
)) {
688 ACPI_ERROR((AE_INFO
, "Invalid length 0x%X in RSDT/XSDT",
690 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
693 table
= acpi_os_map_memory(address
, length
);
695 return_ACPI_STATUS(AE_NO_MEMORY
);
698 /* Validate the root table checksum */
700 status
= acpi_tb_verify_checksum(table
, length
);
701 if (ACPI_FAILURE(status
)) {
702 acpi_os_unmap_memory(table
, length
);
703 return_ACPI_STATUS(status
);
706 /* Calculate the number of tables described in the root table */
708 table_count
= (u32
)((table
->length
- sizeof(struct acpi_table_header
)) /
711 * First two entries in the table array are reserved for the DSDT
712 * and FACS, which are not actually present in the RSDT/XSDT - they
716 ACPI_CAST_PTR(u8
, table
) + sizeof(struct acpi_table_header
);
717 acpi_gbl_root_table_list
.current_table_count
= 2;
720 * Initialize the root table array from the RSDT/XSDT
722 for (i
= 0; i
< table_count
; i
++) {
723 if (acpi_gbl_root_table_list
.current_table_count
>=
724 acpi_gbl_root_table_list
.max_table_count
) {
726 /* There is no more room in the root table array, attempt resize */
728 status
= acpi_tb_resize_root_table_list();
729 if (ACPI_FAILURE(status
)) {
730 ACPI_WARNING((AE_INFO
,
731 "Truncating %u table entries!",
732 (unsigned) (table_count
-
733 (acpi_gbl_root_table_list
.
734 current_table_count
-
740 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */
742 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.
743 current_table_count
].address
=
744 acpi_tb_get_root_table_entry(table_entry
, table_entry_size
);
746 table_entry
+= table_entry_size
;
747 acpi_gbl_root_table_list
.current_table_count
++;
751 * It is not possible to map more than one entry in some environments,
752 * so unmap the root table here before mapping other tables
754 acpi_os_unmap_memory(table
, length
);
757 * Complete the initialization of the root table array by examining
758 * the header of each table
760 for (i
= 2; i
< acpi_gbl_root_table_list
.current_table_count
; i
++) {
761 acpi_tb_install_table(acpi_gbl_root_table_list
.tables
[i
].
764 /* Special case for FADT - get the DSDT and FACS */
766 if (ACPI_COMPARE_NAME
767 (&acpi_gbl_root_table_list
.tables
[i
].signature
,
769 acpi_tb_parse_fadt(i
);
773 return_ACPI_STATUS(AE_OK
);