1 /******************************************************************************
3 * Module Name: tbutils - table utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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("tbutils")
50 /* Local prototypes */
51 static acpi_physical_address
52 acpi_tb_get_root_table_entry(u8 * table_entry,
53 acpi_native_uint table_entry_size);
55 /*******************************************************************************
57 * FUNCTION: acpi_tb_print_table_header
59 * PARAMETERS: Address - Table physical address
60 * Header - Table header
64 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
66 ******************************************************************************/
69 acpi_tb_print_table_header(acpi_physical_address address,
70 struct acpi_table_header *header)
73 if (ACPI_COMPARE_NAME(header->signature, ACPI_SIG_FACS)) {
75 /* FACS only has signature and length fields of common table header */
77 ACPI_INFO((AE_INFO, "%4.4s @ 0x%p/0x%04X",
78 header->signature, ACPI_CAST_PTR(void, address),
80 } else if (ACPI_COMPARE_NAME(header->signature, ACPI_SIG_RSDP)) {
82 /* RSDP has no common fields */
84 ACPI_INFO((AE_INFO, "RSDP @ 0x%p/0x%04X (v%3.3d %6.6s)",
85 ACPI_CAST_PTR(void, address),
86 (ACPI_CAST_PTR(struct acpi_table_rsdp, header)->
88 0) ? ACPI_CAST_PTR(struct acpi_table_rsdp,
90 ACPI_CAST_PTR(struct acpi_table_rsdp,
92 ACPI_CAST_PTR(struct acpi_table_rsdp,
95 /* Standard ACPI table with full common header */
98 "%4.4s @ 0x%p/0x%04X (v%3.3d %6.6s %8.8s 0x%08X %4.4s 0x%08X)",
99 header->signature, ACPI_CAST_PTR(void, address),
100 header->length, header->revision, header->oem_id,
101 header->oem_table_id, header->oem_revision,
102 header->asl_compiler_id,
103 header->asl_compiler_revision));
107 /*******************************************************************************
109 * FUNCTION: acpi_tb_validate_checksum
111 * PARAMETERS: Table - ACPI table to verify
112 * Length - Length of entire table
116 * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
117 * exception on bad checksum.
119 ******************************************************************************/
121 acpi_status acpi_tb_verify_checksum(struct acpi_table_header *table, u32 length)
125 /* Compute the checksum on the table */
127 checksum = acpi_tb_checksum(ACPI_CAST_PTR(u8, table), length);
129 /* Checksum ok? (should be zero) */
132 ACPI_WARNING((AE_INFO,
133 "Incorrect checksum in table [%4.4s] - %2.2X, should be %2.2X",
134 table->signature, table->checksum,
135 (u8) (table->checksum - checksum)));
137 #if (ACPI_CHECKSUM_ABORT)
139 return (AE_BAD_CHECKSUM);
146 /*******************************************************************************
148 * FUNCTION: acpi_tb_checksum
150 * PARAMETERS: Buffer - Pointer to memory region to be checked
151 * Length - Length of this memory region
153 * RETURN: Checksum (u8)
155 * DESCRIPTION: Calculates circular checksum of memory region.
157 ******************************************************************************/
159 u8 acpi_tb_checksum(u8 * buffer, acpi_native_uint length)
162 u8 *end = buffer + length;
164 while (buffer < end) {
165 sum = (u8) (sum + *(buffer++));
171 /*******************************************************************************
173 * FUNCTION: acpi_tb_install_table
175 * PARAMETERS: Address - Physical address of DSDT or FACS
177 * Signature - Table signature, NULL if no need to
179 * table_index - Index into root table array
183 * DESCRIPTION: Install an ACPI table into the global data structure.
185 ******************************************************************************/
188 acpi_tb_install_table(acpi_physical_address address,
189 u8 flags, char *signature, acpi_native_uint table_index)
191 struct acpi_table_header *table;
195 "Null physical address for ACPI table [%s]",
200 /* Map just the table header */
202 table = acpi_os_map_memory(address, sizeof(struct acpi_table_header));
207 /* If a particular signature is expected, signature must match */
209 if (signature && !ACPI_COMPARE_NAME(table->signature, signature)) {
211 "Invalid signature 0x%X for ACPI table [%s]",
212 *ACPI_CAST_PTR(u32, table->signature), signature));
216 /* Initialize the table entry */
218 acpi_gbl_root_table_list.tables[table_index].address = address;
219 acpi_gbl_root_table_list.tables[table_index].length = table->length;
220 acpi_gbl_root_table_list.tables[table_index].flags = flags;
223 (acpi_gbl_root_table_list.tables[table_index].
224 signature), table->signature);
226 acpi_tb_print_table_header(address, table);
228 if (table_index == ACPI_TABLE_INDEX_DSDT) {
230 /* Global integer width is based upon revision of the DSDT */
232 acpi_ut_set_integer_width(table->revision);
236 acpi_os_unmap_memory(table, sizeof(struct acpi_table_header));
239 /*******************************************************************************
241 * FUNCTION: acpi_tb_get_root_table_entry
243 * PARAMETERS: table_entry - Pointer to the RSDT/XSDT table entry
244 * table_entry_size - sizeof 32 or 64 (RSDT or XSDT)
246 * RETURN: Physical address extracted from the root table
248 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on
249 * both 32-bit and 64-bit platforms
251 * NOTE: acpi_physical_address is 32-bit on 32-bit platforms, 64-bit on
254 ******************************************************************************/
256 static acpi_physical_address
257 acpi_tb_get_root_table_entry(u8 * table_entry,
258 acpi_native_uint table_entry_size)
263 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT):
264 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT
266 if (table_entry_size == sizeof(u32)) {
268 * 32-bit platform, RSDT: Return 32-bit table entry
269 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return
271 return ((acpi_physical_address)
272 (*ACPI_CAST_PTR(u32, table_entry)));
275 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return
276 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local, return 64-bit
278 ACPI_MOVE_64_TO_64(&address64, table_entry);
280 #if ACPI_MACHINE_WIDTH == 32
281 if (address64 > ACPI_UINT32_MAX) {
283 /* Will truncate 64-bit address to 32 bits, issue warning */
285 ACPI_WARNING((AE_INFO,
286 "64-bit Physical Address in XSDT is too large (%8.8X%8.8X), truncating",
287 ACPI_FORMAT_UINT64(address64)));
290 return ((acpi_physical_address) (address64));
294 /*******************************************************************************
296 * FUNCTION: acpi_tb_parse_root_table
298 * PARAMETERS: Rsdp - Pointer to the RSDP
303 * DESCRIPTION: This function is called to parse the Root System Description
304 * Table (RSDT or XSDT)
306 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must
307 * be mapped and cannot be copied because it contains the actual
308 * memory location of the ACPI Global Lock.
310 ******************************************************************************/
313 acpi_tb_parse_root_table(acpi_physical_address rsdp_address, u8 flags)
315 struct acpi_table_rsdp *rsdp;
316 acpi_native_uint table_entry_size;
319 struct acpi_table_header *table;
320 acpi_physical_address address;
325 ACPI_FUNCTION_TRACE(tb_parse_root_table);
328 * Map the entire RSDP and extract the address of the RSDT or XSDT
330 rsdp = acpi_os_map_memory(rsdp_address, sizeof(struct acpi_table_rsdp));
332 return_ACPI_STATUS(AE_NO_MEMORY);
335 acpi_tb_print_table_header(rsdp_address,
336 ACPI_CAST_PTR(struct acpi_table_header,
339 /* Differentiate between RSDT and XSDT root tables */
341 if (rsdp->revision > 1 && rsdp->xsdt_physical_address) {
343 * Root table is an XSDT (64-bit physical addresses). We must use the
344 * XSDT if the revision is > 1 and the XSDT pointer is present, as per
345 * the ACPI specification.
347 address = (acpi_physical_address) rsdp->xsdt_physical_address;
348 table_entry_size = sizeof(u64);
350 /* Root table is an RSDT (32-bit physical addresses) */
352 address = (acpi_physical_address) rsdp->rsdt_physical_address;
353 table_entry_size = sizeof(u32);
357 * It is not possible to map more than one entry in some environments,
358 * so unmap the RSDP here before mapping other tables
360 acpi_os_unmap_memory(rsdp, sizeof(struct acpi_table_rsdp));
362 /* Map the RSDT/XSDT table header to get the full table length */
364 table = acpi_os_map_memory(address, sizeof(struct acpi_table_header));
366 return_ACPI_STATUS(AE_NO_MEMORY);
369 acpi_tb_print_table_header(address, table);
371 /* Get the length of the full table, verify length and map entire table */
373 length = table->length;
374 acpi_os_unmap_memory(table, sizeof(struct acpi_table_header));
376 if (length < sizeof(struct acpi_table_header)) {
377 ACPI_ERROR((AE_INFO, "Invalid length 0x%X in RSDT/XSDT",
379 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
382 table = acpi_os_map_memory(address, length);
384 return_ACPI_STATUS(AE_NO_MEMORY);
387 /* Validate the root table checksum */
389 status = acpi_tb_verify_checksum(table, length);
390 if (ACPI_FAILURE(status)) {
391 acpi_os_unmap_memory(table, length);
392 return_ACPI_STATUS(status);
395 /* Calculate the number of tables described in the root table */
398 (u32) ((table->length -
399 sizeof(struct acpi_table_header)) / table_entry_size);
402 * First two entries in the table array are reserved for the DSDT and FACS,
403 * which are not actually present in the RSDT/XSDT - they come from the FADT
406 ACPI_CAST_PTR(u8, table) + sizeof(struct acpi_table_header);
407 acpi_gbl_root_table_list.count = 2;
410 * Initialize the root table array from the RSDT/XSDT
412 for (i = 0; i < table_count; i++) {
413 if (acpi_gbl_root_table_list.count >=
414 acpi_gbl_root_table_list.size) {
416 /* There is no more room in the root table array, attempt resize */
418 status = acpi_tb_resize_root_table_list();
419 if (ACPI_FAILURE(status)) {
420 ACPI_WARNING((AE_INFO,
421 "Truncating %u table entries!",
423 (acpi_gbl_root_table_list.size -
424 acpi_gbl_root_table_list.
430 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */
432 acpi_gbl_root_table_list.tables[acpi_gbl_root_table_list.count].
434 acpi_tb_get_root_table_entry(table_entry, table_entry_size);
436 table_entry += table_entry_size;
437 acpi_gbl_root_table_list.count++;
441 * It is not possible to map more than one entry in some environments,
442 * so unmap the root table here before mapping other tables
444 acpi_os_unmap_memory(table, length);
447 * Complete the initialization of the root table array by examining
448 * the header of each table
450 for (i = 2; i < acpi_gbl_root_table_list.count; i++) {
451 acpi_tb_install_table(acpi_gbl_root_table_list.tables[i].
452 address, flags, NULL, i);
454 /* Special case for FADT - get the DSDT and FACS */
456 if (ACPI_COMPARE_NAME
457 (&acpi_gbl_root_table_list.tables[i].signature,
459 acpi_tb_parse_fadt(i, flags);
463 return_ACPI_STATUS(AE_OK);
466 /******************************************************************************
468 * FUNCTION: acpi_tb_map
470 * PARAMETERS: Address - Address to be mapped
471 * Length - Length to be mapped
472 * Flags - Logical or physical addressing mode
474 * RETURN: Pointer to mapped region
476 * DESCRIPTION: Maps memory according to flag
478 *****************************************************************************/
480 void *acpi_tb_map(acpi_physical_address address, u32 length, u32 flags)
483 if (flags == ACPI_TABLE_ORIGIN_MAPPED) {
484 return (acpi_os_map_memory(address, length));
486 return (ACPI_CAST_PTR(void, address));
490 /******************************************************************************
492 * FUNCTION: acpi_tb_unmap
494 * PARAMETERS: Pointer - To mapped region
495 * Length - Length to be unmapped
496 * Flags - Logical or physical addressing mode
500 * DESCRIPTION: Unmaps memory according to flag
502 *****************************************************************************/
504 void acpi_tb_unmap(void *pointer, u32 length, u32 flags)
507 if (flags == ACPI_TABLE_ORIGIN_MAPPED) {
508 acpi_os_unmap_memory(pointer, length);