1 /******************************************************************************
3 * Module Name: tbutils - 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>
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 /*******************************************************************************
117 * FUNCTION: acpi_tb_initialize_facs
123 * DESCRIPTION: Create a permanent mapping for the FADT and save it in a global
124 * for accessing the Global Lock and Firmware Waking Vector
126 ******************************************************************************/
128 acpi_status
acpi_tb_initialize_facs(void)
132 status
= acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
133 ACPI_CAST_INDIRECT_PTR(struct
139 /*******************************************************************************
141 * FUNCTION: acpi_tb_tables_loaded
145 * RETURN: TRUE if required ACPI tables are loaded
147 * DESCRIPTION: Determine if the minimum required ACPI tables are present
150 ******************************************************************************/
152 u8
acpi_tb_tables_loaded(void)
155 if (acpi_gbl_root_table_list
.count
>= 3) {
162 /*******************************************************************************
164 * FUNCTION: acpi_tb_print_table_header
166 * PARAMETERS: Address - Table physical address
167 * Header - Table header
171 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
173 ******************************************************************************/
176 acpi_tb_print_table_header(acpi_physical_address address
,
177 struct acpi_table_header
*header
)
180 if (ACPI_COMPARE_NAME(header
->signature
, ACPI_SIG_FACS
)) {
182 /* FACS only has signature and length fields of common table header */
184 ACPI_INFO((AE_INFO
, "%4.4s %08lX, %04X",
185 header
->signature
, (unsigned long)address
,
187 } else if (ACPI_COMPARE_NAME(header
->signature
, ACPI_SIG_RSDP
)) {
189 /* RSDP has no common fields */
191 ACPI_INFO((AE_INFO
, "RSDP %08lX, %04X (r%d %6.6s)",
192 (unsigned long)address
,
193 (ACPI_CAST_PTR(struct acpi_table_rsdp
, header
)->
195 0) ? ACPI_CAST_PTR(struct acpi_table_rsdp
,
196 header
)->length
: 20,
197 ACPI_CAST_PTR(struct acpi_table_rsdp
,
199 ACPI_CAST_PTR(struct acpi_table_rsdp
,
202 /* Standard ACPI table with full common header */
205 "%4.4s %08lX, %04X (r%d %6.6s %8.8s %8X %4.4s %8X)",
206 header
->signature
, (unsigned long)address
,
207 header
->length
, header
->revision
, header
->oem_id
,
208 header
->oem_table_id
, header
->oem_revision
,
209 header
->asl_compiler_id
,
210 header
->asl_compiler_revision
));
214 /*******************************************************************************
216 * FUNCTION: acpi_tb_validate_checksum
218 * PARAMETERS: Table - ACPI table to verify
219 * Length - Length of entire table
223 * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
224 * exception on bad checksum.
226 ******************************************************************************/
228 acpi_status
acpi_tb_verify_checksum(struct acpi_table_header
*table
, u32 length
)
232 /* Compute the checksum on the table */
234 checksum
= acpi_tb_checksum(ACPI_CAST_PTR(u8
, table
), length
);
236 /* Checksum ok? (should be zero) */
239 ACPI_WARNING((AE_INFO
,
240 "Incorrect checksum in table [%4.4s] - %2.2X, should be %2.2X",
241 table
->signature
, table
->checksum
,
242 (u8
) (table
->checksum
- checksum
)));
244 #if (ACPI_CHECKSUM_ABORT)
246 return (AE_BAD_CHECKSUM
);
253 /*******************************************************************************
255 * FUNCTION: acpi_tb_checksum
257 * PARAMETERS: Buffer - Pointer to memory region to be checked
258 * Length - Length of this memory region
260 * RETURN: Checksum (u8)
262 * DESCRIPTION: Calculates circular checksum of memory region.
264 ******************************************************************************/
266 u8
acpi_tb_checksum(u8
*buffer
, u32 length
)
269 u8
*end
= buffer
+ length
;
271 while (buffer
< end
) {
272 sum
= (u8
) (sum
+ *(buffer
++));
278 /*******************************************************************************
280 * FUNCTION: acpi_tb_install_table
282 * PARAMETERS: Address - Physical address of DSDT or FACS
284 * Signature - Table signature, NULL if no need to
286 * table_index - Index into root table array
290 * DESCRIPTION: Install an ACPI table into the global data structure.
292 ******************************************************************************/
295 acpi_tb_install_table(acpi_physical_address address
,
296 u8 flags
, char *signature
, u32 table_index
)
298 struct acpi_table_header
*table
;
302 "Null physical address for ACPI table [%s]",
307 /* Map just the table header */
309 table
= acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
314 /* If a particular signature is expected, signature must match */
316 if (signature
&& !ACPI_COMPARE_NAME(table
->signature
, signature
)) {
318 "Invalid signature 0x%X for ACPI table [%s]",
319 *ACPI_CAST_PTR(u32
, table
->signature
), signature
));
323 /* Initialize the table entry */
325 acpi_gbl_root_table_list
.tables
[table_index
].address
= address
;
326 acpi_gbl_root_table_list
.tables
[table_index
].length
= table
->length
;
327 acpi_gbl_root_table_list
.tables
[table_index
].flags
= flags
;
330 (acpi_gbl_root_table_list
.tables
[table_index
].
331 signature
), table
->signature
);
333 acpi_tb_print_table_header(address
, table
);
335 if (table_index
== ACPI_TABLE_INDEX_DSDT
) {
337 /* Global integer width is based upon revision of the DSDT */
339 acpi_ut_set_integer_width(table
->revision
);
343 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
346 /*******************************************************************************
348 * FUNCTION: acpi_tb_get_root_table_entry
350 * PARAMETERS: table_entry - Pointer to the RSDT/XSDT table entry
351 * table_entry_size - sizeof 32 or 64 (RSDT or XSDT)
353 * RETURN: Physical address extracted from the root table
355 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on
356 * both 32-bit and 64-bit platforms
358 * NOTE: acpi_physical_address is 32-bit on 32-bit platforms, 64-bit on
361 ******************************************************************************/
363 static acpi_physical_address
364 acpi_tb_get_root_table_entry(u8
*table_entry
, u32 table_entry_size
)
369 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT):
370 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT
372 if (table_entry_size
== sizeof(u32
)) {
374 * 32-bit platform, RSDT: Return 32-bit table entry
375 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return
377 return ((acpi_physical_address
)
378 (*ACPI_CAST_PTR(u32
, table_entry
)));
381 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return
382 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local, return 64-bit
384 ACPI_MOVE_64_TO_64(&address64
, table_entry
);
386 #if ACPI_MACHINE_WIDTH == 32
387 if (address64
> ACPI_UINT32_MAX
) {
389 /* Will truncate 64-bit address to 32 bits, issue warning */
391 ACPI_WARNING((AE_INFO
,
392 "64-bit Physical Address in XSDT is too large (%8.8X%8.8X), truncating",
393 ACPI_FORMAT_UINT64(address64
)));
396 return ((acpi_physical_address
) (address64
));
400 /*******************************************************************************
402 * FUNCTION: acpi_tb_parse_root_table
404 * PARAMETERS: Rsdp - Pointer to the RSDP
409 * DESCRIPTION: This function is called to parse the Root System Description
410 * Table (RSDT or XSDT)
412 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must
413 * be mapped and cannot be copied because it contains the actual
414 * memory location of the ACPI Global Lock.
416 ******************************************************************************/
419 acpi_tb_parse_root_table(acpi_physical_address rsdp_address
, u8 flags
)
421 struct acpi_table_rsdp
*rsdp
;
422 u32 table_entry_size
;
425 struct acpi_table_header
*table
;
426 acpi_physical_address address
;
427 acpi_physical_address
uninitialized_var(rsdt_address
);
432 ACPI_FUNCTION_TRACE(tb_parse_root_table
);
435 * Map the entire RSDP and extract the address of the RSDT or XSDT
437 rsdp
= acpi_os_map_memory(rsdp_address
, sizeof(struct acpi_table_rsdp
));
439 return_ACPI_STATUS(AE_NO_MEMORY
);
442 acpi_tb_print_table_header(rsdp_address
,
443 ACPI_CAST_PTR(struct acpi_table_header
,
446 /* Differentiate between RSDT and XSDT root tables */
448 if (rsdp
->revision
> 1 && rsdp
->xsdt_physical_address
) {
450 * Root table is an XSDT (64-bit physical addresses). We must use the
451 * XSDT if the revision is > 1 and the XSDT pointer is present, as per
452 * the ACPI specification.
454 address
= (acpi_physical_address
) rsdp
->xsdt_physical_address
;
455 table_entry_size
= sizeof(u64
);
456 rsdt_address
= (acpi_physical_address
)
457 rsdp
->rsdt_physical_address
;
459 /* Root table is an RSDT (32-bit physical addresses) */
461 address
= (acpi_physical_address
) rsdp
->rsdt_physical_address
;
462 table_entry_size
= sizeof(u32
);
466 * It is not possible to map more than one entry in some environments,
467 * so unmap the RSDP here before mapping other tables
469 acpi_os_unmap_memory(rsdp
, sizeof(struct acpi_table_rsdp
));
471 if (table_entry_size
== sizeof(u64
)) {
472 if (acpi_tb_check_xsdt(address
) == AE_NULL_ENTRY
) {
473 /* XSDT has NULL entry, RSDT is used */
474 address
= rsdt_address
;
475 table_entry_size
= sizeof(u32
);
476 ACPI_WARNING((AE_INFO
, "BIOS XSDT has NULL entry, "
480 /* Map the RSDT/XSDT table header to get the full table length */
482 table
= acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
484 return_ACPI_STATUS(AE_NO_MEMORY
);
487 acpi_tb_print_table_header(address
, table
);
489 /* Get the length of the full table, verify length and map entire table */
491 length
= table
->length
;
492 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
494 if (length
< sizeof(struct acpi_table_header
)) {
495 ACPI_ERROR((AE_INFO
, "Invalid length 0x%X in RSDT/XSDT",
497 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
500 table
= acpi_os_map_memory(address
, length
);
502 return_ACPI_STATUS(AE_NO_MEMORY
);
505 /* Validate the root table checksum */
507 status
= acpi_tb_verify_checksum(table
, length
);
508 if (ACPI_FAILURE(status
)) {
509 acpi_os_unmap_memory(table
, length
);
510 return_ACPI_STATUS(status
);
513 /* Calculate the number of tables described in the root table */
516 (u32
) ((table
->length
-
517 sizeof(struct acpi_table_header
)) / table_entry_size
);
520 * First two entries in the table array are reserved for the DSDT and FACS,
521 * which are not actually present in the RSDT/XSDT - they come from the FADT
524 ACPI_CAST_PTR(u8
, table
) + sizeof(struct acpi_table_header
);
525 acpi_gbl_root_table_list
.count
= 2;
528 * Initialize the root table array from the RSDT/XSDT
530 for (i
= 0; i
< table_count
; i
++) {
531 if (acpi_gbl_root_table_list
.count
>=
532 acpi_gbl_root_table_list
.size
) {
534 /* There is no more room in the root table array, attempt resize */
536 status
= acpi_tb_resize_root_table_list();
537 if (ACPI_FAILURE(status
)) {
538 ACPI_WARNING((AE_INFO
,
539 "Truncating %u table entries!",
541 (acpi_gbl_root_table_list
.size
-
542 acpi_gbl_root_table_list
.
548 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */
550 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.count
].
552 acpi_tb_get_root_table_entry(table_entry
, table_entry_size
);
554 table_entry
+= table_entry_size
;
555 acpi_gbl_root_table_list
.count
++;
559 * It is not possible to map more than one entry in some environments,
560 * so unmap the root table here before mapping other tables
562 acpi_os_unmap_memory(table
, length
);
565 * Complete the initialization of the root table array by examining
566 * the header of each table
568 for (i
= 2; i
< acpi_gbl_root_table_list
.count
; i
++) {
569 acpi_tb_install_table(acpi_gbl_root_table_list
.tables
[i
].
570 address
, flags
, NULL
, i
);
572 /* Special case for FADT - get the DSDT and FACS */
574 if (ACPI_COMPARE_NAME
575 (&acpi_gbl_root_table_list
.tables
[i
].signature
,
577 acpi_tb_parse_fadt(i
, flags
);
581 return_ACPI_STATUS(AE_OK
);