1 /******************************************************************************
3 * Module Name: tbutils - table utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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 status
= acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
139 ACPI_CAST_INDIRECT_PTR(struct
145 /*******************************************************************************
147 * FUNCTION: acpi_tb_tables_loaded
151 * RETURN: TRUE if required ACPI tables are loaded
153 * DESCRIPTION: Determine if the minimum required ACPI tables are present
156 ******************************************************************************/
158 u8
acpi_tb_tables_loaded(void)
161 if (acpi_gbl_root_table_list
.current_table_count
>= 3) {
168 /*******************************************************************************
170 * FUNCTION: acpi_tb_fix_string
172 * PARAMETERS: String - String to be repaired
173 * Length - Maximum length
177 * DESCRIPTION: Replace every non-printable or non-ascii byte in the string
178 * with a question mark '?'.
180 ******************************************************************************/
182 static void acpi_tb_fix_string(char *string
, acpi_size length
)
185 while (length
&& *string
) {
186 if (!ACPI_IS_PRINT(*string
)) {
194 /*******************************************************************************
196 * FUNCTION: acpi_tb_cleanup_table_header
198 * PARAMETERS: out_header - Where the cleaned header is returned
199 * Header - Input ACPI table header
201 * RETURN: Returns the cleaned header in out_header
203 * DESCRIPTION: Copy the table header and ensure that all "string" fields in
204 * the header consist of printable characters.
206 ******************************************************************************/
209 acpi_tb_cleanup_table_header(struct acpi_table_header
*out_header
,
210 struct acpi_table_header
*header
)
213 ACPI_MEMCPY(out_header
, header
, sizeof(struct acpi_table_header
));
215 acpi_tb_fix_string(out_header
->signature
, ACPI_NAME_SIZE
);
216 acpi_tb_fix_string(out_header
->oem_id
, ACPI_OEM_ID_SIZE
);
217 acpi_tb_fix_string(out_header
->oem_table_id
, ACPI_OEM_TABLE_ID_SIZE
);
218 acpi_tb_fix_string(out_header
->asl_compiler_id
, ACPI_NAME_SIZE
);
221 /*******************************************************************************
223 * FUNCTION: acpi_tb_print_table_header
225 * PARAMETERS: Address - Table physical address
226 * Header - Table header
230 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
232 ******************************************************************************/
235 acpi_tb_print_table_header(acpi_physical_address address
,
236 struct acpi_table_header
*header
)
238 struct acpi_table_header local_header
;
241 * The reason that the Address is cast to a void pointer is so that we
242 * can use %p which will work properly on both 32-bit and 64-bit hosts.
244 if (ACPI_COMPARE_NAME(header
->signature
, ACPI_SIG_FACS
)) {
246 /* FACS only has signature and length fields */
248 ACPI_INFO((AE_INFO
, "%4.4s %p %05X",
249 header
->signature
, ACPI_CAST_PTR(void, address
),
251 } else if (ACPI_COMPARE_NAME(header
->signature
, ACPI_SIG_RSDP
)) {
253 /* RSDP has no common fields */
255 ACPI_MEMCPY(local_header
.oem_id
,
256 ACPI_CAST_PTR(struct acpi_table_rsdp
,
257 header
)->oem_id
, ACPI_OEM_ID_SIZE
);
258 acpi_tb_fix_string(local_header
.oem_id
, ACPI_OEM_ID_SIZE
);
260 ACPI_INFO((AE_INFO
, "RSDP %p %05X (v%.2d %6.6s)",
261 ACPI_CAST_PTR (void, address
),
262 (ACPI_CAST_PTR(struct acpi_table_rsdp
, header
)->
264 0) ? ACPI_CAST_PTR(struct acpi_table_rsdp
,
265 header
)->length
: 20,
266 ACPI_CAST_PTR(struct acpi_table_rsdp
,
268 local_header
.oem_id
));
270 /* Standard ACPI table with full common header */
272 acpi_tb_cleanup_table_header(&local_header
, header
);
275 "%4.4s %p %05X (v%.2d %6.6s %8.8s %08X %4.4s %08X)",
276 local_header
.signature
, ACPI_CAST_PTR(void, address
),
277 local_header
.length
, local_header
.revision
,
278 local_header
.oem_id
, local_header
.oem_table_id
,
279 local_header
.oem_revision
,
280 local_header
.asl_compiler_id
,
281 local_header
.asl_compiler_revision
));
286 /*******************************************************************************
288 * FUNCTION: acpi_tb_validate_checksum
290 * PARAMETERS: Table - ACPI table to verify
291 * Length - Length of entire table
295 * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
296 * exception on bad checksum.
298 ******************************************************************************/
300 acpi_status
acpi_tb_verify_checksum(struct acpi_table_header
*table
, u32 length
)
304 /* Compute the checksum on the table */
306 checksum
= acpi_tb_checksum(ACPI_CAST_PTR(u8
, table
), length
);
308 /* Checksum ok? (should be zero) */
311 ACPI_WARNING((AE_INFO
,
312 "Incorrect checksum in table [%4.4s] - 0x%2.2X, should be 0x%2.2X",
313 table
->signature
, table
->checksum
,
314 (u8
) (table
->checksum
- checksum
)));
316 #if (ACPI_CHECKSUM_ABORT)
318 return (AE_BAD_CHECKSUM
);
325 /*******************************************************************************
327 * FUNCTION: acpi_tb_checksum
329 * PARAMETERS: Buffer - Pointer to memory region to be checked
330 * Length - Length of this memory region
332 * RETURN: Checksum (u8)
334 * DESCRIPTION: Calculates circular checksum of memory region.
336 ******************************************************************************/
338 u8
acpi_tb_checksum(u8
*buffer
, u32 length
)
341 u8
*end
= buffer
+ length
;
343 while (buffer
< end
) {
344 sum
= (u8
) (sum
+ *(buffer
++));
350 /*******************************************************************************
352 * FUNCTION: acpi_tb_check_dsdt_header
358 * DESCRIPTION: Quick compare to check validity of the DSDT. This will detect
359 * if the DSDT has been replaced from outside the OS and/or if
360 * the DSDT header has been corrupted.
362 ******************************************************************************/
364 void acpi_tb_check_dsdt_header(void)
367 /* Compare original length and checksum to current values */
369 if (acpi_gbl_original_dsdt_header
.length
!= acpi_gbl_DSDT
->length
||
370 acpi_gbl_original_dsdt_header
.checksum
!= acpi_gbl_DSDT
->checksum
) {
372 "The DSDT has been corrupted or replaced - old, new headers below"));
373 acpi_tb_print_table_header(0, &acpi_gbl_original_dsdt_header
);
374 acpi_tb_print_table_header(0, acpi_gbl_DSDT
);
377 "Please send DMI info to linux-acpi@vger.kernel.org\n"
378 "If system does not work as expected, please boot with acpi=copy_dsdt"));
380 /* Disable further error messages */
382 acpi_gbl_original_dsdt_header
.length
= acpi_gbl_DSDT
->length
;
383 acpi_gbl_original_dsdt_header
.checksum
=
384 acpi_gbl_DSDT
->checksum
;
388 /*******************************************************************************
390 * FUNCTION: acpi_tb_copy_dsdt
392 * PARAMETERS: table_desc - Installed table to copy
396 * DESCRIPTION: Implements a subsystem option to copy the DSDT to local memory.
397 * Some very bad BIOSs are known to either corrupt the DSDT or
398 * install a new, bad DSDT. This copy works around the problem.
400 ******************************************************************************/
402 struct acpi_table_header
*acpi_tb_copy_dsdt(u32 table_index
)
404 struct acpi_table_header
*new_table
;
405 struct acpi_table_desc
*table_desc
;
407 table_desc
= &acpi_gbl_root_table_list
.tables
[table_index
];
409 new_table
= ACPI_ALLOCATE(table_desc
->length
);
411 ACPI_ERROR((AE_INFO
, "Could not copy DSDT of length 0x%X",
412 table_desc
->length
));
416 ACPI_MEMCPY(new_table
, table_desc
->pointer
, table_desc
->length
);
417 acpi_tb_delete_table(table_desc
);
418 table_desc
->pointer
= new_table
;
419 table_desc
->flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
422 "Forced DSDT copy: length 0x%05X copied locally, original unmapped",
428 /*******************************************************************************
430 * FUNCTION: acpi_tb_install_table
432 * PARAMETERS: Address - Physical address of DSDT or FACS
433 * Signature - Table signature, NULL if no need to
435 * table_index - Index into root table array
439 * DESCRIPTION: Install an ACPI table into the global data structure. The
440 * table override mechanism is implemented here to allow the host
441 * OS to replace any table before it is installed in the root
444 ******************************************************************************/
447 acpi_tb_install_table(acpi_physical_address address
,
448 char *signature
, u32 table_index
)
452 struct acpi_table_header
*table_to_install
;
453 struct acpi_table_header
*mapped_table
;
454 struct acpi_table_header
*override_table
= NULL
;
458 "Null physical address for ACPI table [%s]",
463 /* Map just the table header */
466 acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
471 /* If a particular signature is expected (DSDT/FACS), it must match */
473 if (signature
&& !ACPI_COMPARE_NAME(mapped_table
->signature
, signature
)) {
475 "Invalid signature 0x%X for ACPI table, expected [%s]",
476 *ACPI_CAST_PTR(u32
, mapped_table
->signature
),
482 * ACPI Table Override:
484 * Before we install the table, let the host OS override it with a new
485 * one if desired. Any table within the RSDT/XSDT can be replaced,
486 * including the DSDT which is pointed to by the FADT.
488 status
= acpi_os_table_override(mapped_table
, &override_table
);
489 if (ACPI_SUCCESS(status
) && override_table
) {
491 "%4.4s @ 0x%p Table override, replaced with:",
492 mapped_table
->signature
, ACPI_CAST_PTR(void,
495 acpi_gbl_root_table_list
.tables
[table_index
].pointer
=
497 address
= ACPI_PTR_TO_PHYSADDR(override_table
);
499 table_to_install
= override_table
;
500 flags
= ACPI_TABLE_ORIGIN_OVERRIDE
;
502 table_to_install
= mapped_table
;
503 flags
= ACPI_TABLE_ORIGIN_MAPPED
;
506 /* Initialize the table entry */
508 acpi_gbl_root_table_list
.tables
[table_index
].address
= address
;
509 acpi_gbl_root_table_list
.tables
[table_index
].length
=
510 table_to_install
->length
;
511 acpi_gbl_root_table_list
.tables
[table_index
].flags
= flags
;
514 (acpi_gbl_root_table_list
.tables
[table_index
].
515 signature
), table_to_install
->signature
);
517 acpi_tb_print_table_header(address
, table_to_install
);
519 if (table_index
== ACPI_TABLE_INDEX_DSDT
) {
521 /* Global integer width is based upon revision of the DSDT */
523 acpi_ut_set_integer_width(table_to_install
->revision
);
527 acpi_os_unmap_memory(mapped_table
, sizeof(struct acpi_table_header
));
530 /*******************************************************************************
532 * FUNCTION: acpi_tb_get_root_table_entry
534 * PARAMETERS: table_entry - Pointer to the RSDT/XSDT table entry
535 * table_entry_size - sizeof 32 or 64 (RSDT or XSDT)
537 * RETURN: Physical address extracted from the root table
539 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on
540 * both 32-bit and 64-bit platforms
542 * NOTE: acpi_physical_address is 32-bit on 32-bit platforms, 64-bit on
545 ******************************************************************************/
547 static acpi_physical_address
548 acpi_tb_get_root_table_entry(u8
*table_entry
, u32 table_entry_size
)
553 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT):
554 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT
556 if (table_entry_size
== sizeof(u32
)) {
558 * 32-bit platform, RSDT: Return 32-bit table entry
559 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return
561 return ((acpi_physical_address
)
562 (*ACPI_CAST_PTR(u32
, table_entry
)));
565 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return
566 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local,
569 ACPI_MOVE_64_TO_64(&address64
, table_entry
);
571 #if ACPI_MACHINE_WIDTH == 32
572 if (address64
> ACPI_UINT32_MAX
) {
574 /* Will truncate 64-bit address to 32 bits, issue warning */
576 ACPI_WARNING((AE_INFO
,
577 "64-bit Physical Address in XSDT is too large (0x%8.8X%8.8X),"
579 ACPI_FORMAT_UINT64(address64
)));
582 return ((acpi_physical_address
) (address64
));
586 /*******************************************************************************
588 * FUNCTION: acpi_tb_parse_root_table
590 * PARAMETERS: Rsdp - Pointer to the RSDP
594 * DESCRIPTION: This function is called to parse the Root System Description
595 * Table (RSDT or XSDT)
597 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must
598 * be mapped and cannot be copied because it contains the actual
599 * memory location of the ACPI Global Lock.
601 ******************************************************************************/
604 acpi_tb_parse_root_table(acpi_physical_address rsdp_address
)
606 struct acpi_table_rsdp
*rsdp
;
607 u32 table_entry_size
;
610 struct acpi_table_header
*table
;
611 acpi_physical_address address
;
612 acpi_physical_address
uninitialized_var(rsdt_address
);
617 ACPI_FUNCTION_TRACE(tb_parse_root_table
);
620 * Map the entire RSDP and extract the address of the RSDT or XSDT
622 rsdp
= acpi_os_map_memory(rsdp_address
, sizeof(struct acpi_table_rsdp
));
624 return_ACPI_STATUS(AE_NO_MEMORY
);
627 acpi_tb_print_table_header(rsdp_address
,
628 ACPI_CAST_PTR(struct acpi_table_header
,
631 /* Differentiate between RSDT and XSDT root tables */
633 if (rsdp
->revision
> 1 && rsdp
->xsdt_physical_address
634 && !acpi_rsdt_forced
) {
636 * Root table is an XSDT (64-bit physical addresses). We must use the
637 * XSDT if the revision is > 1 and the XSDT pointer is present, as per
638 * the ACPI specification.
640 address
= (acpi_physical_address
) rsdp
->xsdt_physical_address
;
641 table_entry_size
= sizeof(u64
);
642 rsdt_address
= (acpi_physical_address
)
643 rsdp
->rsdt_physical_address
;
645 /* Root table is an RSDT (32-bit physical addresses) */
647 address
= (acpi_physical_address
) rsdp
->rsdt_physical_address
;
648 table_entry_size
= sizeof(u32
);
652 * It is not possible to map more than one entry in some environments,
653 * so unmap the RSDP here before mapping other tables
655 acpi_os_unmap_memory(rsdp
, sizeof(struct acpi_table_rsdp
));
657 if (table_entry_size
== sizeof(u64
)) {
658 if (acpi_tb_check_xsdt(address
) == AE_NULL_ENTRY
) {
659 /* XSDT has NULL entry, RSDT is used */
660 address
= rsdt_address
;
661 table_entry_size
= sizeof(u32
);
662 ACPI_WARNING((AE_INFO
, "BIOS XSDT has NULL entry, "
666 /* Map the RSDT/XSDT table header to get the full table length */
668 table
= acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
670 return_ACPI_STATUS(AE_NO_MEMORY
);
673 acpi_tb_print_table_header(address
, table
);
675 /* Get the length of the full table, verify length and map entire table */
677 length
= table
->length
;
678 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
680 if (length
< sizeof(struct acpi_table_header
)) {
681 ACPI_ERROR((AE_INFO
, "Invalid length 0x%X in RSDT/XSDT",
683 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
686 table
= acpi_os_map_memory(address
, length
);
688 return_ACPI_STATUS(AE_NO_MEMORY
);
691 /* Validate the root table checksum */
693 status
= acpi_tb_verify_checksum(table
, length
);
694 if (ACPI_FAILURE(status
)) {
695 acpi_os_unmap_memory(table
, length
);
696 return_ACPI_STATUS(status
);
699 /* Calculate the number of tables described in the root table */
701 table_count
= (u32
)((table
->length
- sizeof(struct acpi_table_header
)) /
704 * First two entries in the table array are reserved for the DSDT
705 * and FACS, which are not actually present in the RSDT/XSDT - they
709 ACPI_CAST_PTR(u8
, table
) + sizeof(struct acpi_table_header
);
710 acpi_gbl_root_table_list
.current_table_count
= 2;
713 * Initialize the root table array from the RSDT/XSDT
715 for (i
= 0; i
< table_count
; i
++) {
716 if (acpi_gbl_root_table_list
.current_table_count
>=
717 acpi_gbl_root_table_list
.max_table_count
) {
719 /* There is no more room in the root table array, attempt resize */
721 status
= acpi_tb_resize_root_table_list();
722 if (ACPI_FAILURE(status
)) {
723 ACPI_WARNING((AE_INFO
,
724 "Truncating %u table entries!",
725 (unsigned) (table_count
-
726 (acpi_gbl_root_table_list
.
727 current_table_count
-
733 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */
735 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.
736 current_table_count
].address
=
737 acpi_tb_get_root_table_entry(table_entry
, table_entry_size
);
739 table_entry
+= table_entry_size
;
740 acpi_gbl_root_table_list
.current_table_count
++;
744 * It is not possible to map more than one entry in some environments,
745 * so unmap the root table here before mapping other tables
747 acpi_os_unmap_memory(table
, length
);
750 * Complete the initialization of the root table array by examining
751 * the header of each table
753 for (i
= 2; i
< acpi_gbl_root_table_list
.current_table_count
; i
++) {
754 acpi_tb_install_table(acpi_gbl_root_table_list
.tables
[i
].
757 /* Special case for FADT - get the DSDT and FACS */
759 if (ACPI_COMPARE_NAME
760 (&acpi_gbl_root_table_list
.tables
[i
].signature
,
762 acpi_tb_parse_fadt(i
);
766 return_ACPI_STATUS(AE_OK
);