1 /******************************************************************************
3 * Module Name: tbutils - ACPI Table utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 #if (!ACPI_REDUCED_HARDWARE)
56 /*******************************************************************************
58 * FUNCTION: acpi_tb_initialize_facs
64 * DESCRIPTION: Create a permanent mapping for the FADT and save it in a global
65 * for accessing the Global Lock and Firmware Waking Vector
67 ******************************************************************************/
69 acpi_status
acpi_tb_initialize_facs(void)
71 struct acpi_table_facs
*facs
;
73 /* If Hardware Reduced flag is set, there is no FACS */
75 if (acpi_gbl_reduced_hardware
) {
78 } else if (acpi_gbl_FADT
.Xfacs
&&
80 || !acpi_gbl_use32_bit_facs_addresses
)) {
81 (void)acpi_get_table_by_index(acpi_gbl_xfacs_index
,
82 ACPI_CAST_INDIRECT_PTR(struct
86 } else if (acpi_gbl_FADT
.facs
) {
87 (void)acpi_get_table_by_index(acpi_gbl_facs_index
,
88 ACPI_CAST_INDIRECT_PTR(struct
94 /* If there is no FACS, just continue. There was already an error msg */
98 #endif /* !ACPI_REDUCED_HARDWARE */
100 /*******************************************************************************
102 * FUNCTION: acpi_tb_check_dsdt_header
108 * DESCRIPTION: Quick compare to check validity of the DSDT. This will detect
109 * if the DSDT has been replaced from outside the OS and/or if
110 * the DSDT header has been corrupted.
112 ******************************************************************************/
114 void acpi_tb_check_dsdt_header(void)
117 /* Compare original length and checksum to current values */
119 if (acpi_gbl_original_dsdt_header
.length
!= acpi_gbl_DSDT
->length
||
120 acpi_gbl_original_dsdt_header
.checksum
!= acpi_gbl_DSDT
->checksum
) {
121 ACPI_BIOS_ERROR((AE_INFO
,
122 "The DSDT has been corrupted or replaced - "
123 "old, new headers below"));
125 acpi_tb_print_table_header(0, &acpi_gbl_original_dsdt_header
);
126 acpi_tb_print_table_header(0, acpi_gbl_DSDT
);
129 "Please send DMI info to linux-acpi@vger.kernel.org\n"
130 "If system does not work as expected, please boot with acpi=copy_dsdt"));
132 /* Disable further error messages */
134 acpi_gbl_original_dsdt_header
.length
= acpi_gbl_DSDT
->length
;
135 acpi_gbl_original_dsdt_header
.checksum
=
136 acpi_gbl_DSDT
->checksum
;
140 /*******************************************************************************
142 * FUNCTION: acpi_tb_copy_dsdt
144 * PARAMETERS: table_desc - Installed table to copy
148 * DESCRIPTION: Implements a subsystem option to copy the DSDT to local memory.
149 * Some very bad BIOSs are known to either corrupt the DSDT or
150 * install a new, bad DSDT. This copy works around the problem.
152 ******************************************************************************/
154 struct acpi_table_header
*acpi_tb_copy_dsdt(u32 table_index
)
156 struct acpi_table_header
*new_table
;
157 struct acpi_table_desc
*table_desc
;
159 table_desc
= &acpi_gbl_root_table_list
.tables
[table_index
];
161 new_table
= ACPI_ALLOCATE(table_desc
->length
);
163 ACPI_ERROR((AE_INFO
, "Could not copy DSDT of length 0x%X",
164 table_desc
->length
));
168 memcpy(new_table
, table_desc
->pointer
, table_desc
->length
);
169 acpi_tb_uninstall_table(table_desc
);
171 acpi_tb_init_table_descriptor(&acpi_gbl_root_table_list
.
172 tables
[acpi_gbl_dsdt_index
],
173 ACPI_PTR_TO_PHYSADDR(new_table
),
174 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL
,
177 ACPI_INFO(("Forced DSDT copy: length 0x%05X copied locally, original unmapped", new_table
->length
));
182 /*******************************************************************************
184 * FUNCTION: acpi_tb_get_root_table_entry
186 * PARAMETERS: table_entry - Pointer to the RSDT/XSDT table entry
187 * table_entry_size - sizeof 32 or 64 (RSDT or XSDT)
189 * RETURN: Physical address extracted from the root table
191 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on
192 * both 32-bit and 64-bit platforms
194 * NOTE: acpi_physical_address is 32-bit on 32-bit platforms, 64-bit on
197 ******************************************************************************/
199 static acpi_physical_address
200 acpi_tb_get_root_table_entry(u8
*table_entry
, u32 table_entry_size
)
205 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT):
206 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT
208 if (table_entry_size
== ACPI_RSDT_ENTRY_SIZE
) {
210 * 32-bit platform, RSDT: Return 32-bit table entry
211 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return
213 return ((acpi_physical_address
)
214 (*ACPI_CAST_PTR(u32
, table_entry
)));
217 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return
218 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local,
221 ACPI_MOVE_64_TO_64(&address64
, table_entry
);
223 #if ACPI_MACHINE_WIDTH == 32
224 if (address64
> ACPI_UINT32_MAX
) {
226 /* Will truncate 64-bit address to 32 bits, issue warning */
228 ACPI_BIOS_WARNING((AE_INFO
,
229 "64-bit Physical Address in XSDT is too large (0x%8.8X%8.8X),"
231 ACPI_FORMAT_UINT64(address64
)));
234 return ((acpi_physical_address
)(address64
));
238 /*******************************************************************************
240 * FUNCTION: acpi_tb_parse_root_table
242 * PARAMETERS: rsdp - Pointer to the RSDP
246 * DESCRIPTION: This function is called to parse the Root System Description
247 * Table (RSDT or XSDT)
249 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must
250 * be mapped and cannot be copied because it contains the actual
251 * memory location of the ACPI Global Lock.
253 ******************************************************************************/
255 acpi_status __init
acpi_tb_parse_root_table(acpi_physical_address rsdp_address
)
257 struct acpi_table_rsdp
*rsdp
;
258 u32 table_entry_size
;
261 struct acpi_table_header
*table
;
262 acpi_physical_address address
;
268 ACPI_FUNCTION_TRACE(tb_parse_root_table
);
270 /* Map the entire RSDP and extract the address of the RSDT or XSDT */
272 rsdp
= acpi_os_map_memory(rsdp_address
, sizeof(struct acpi_table_rsdp
));
274 return_ACPI_STATUS(AE_NO_MEMORY
);
277 acpi_tb_print_table_header(rsdp_address
,
278 ACPI_CAST_PTR(struct acpi_table_header
,
281 /* Use XSDT if present and not overridden. Otherwise, use RSDT */
283 if ((rsdp
->revision
> 1) &&
284 rsdp
->xsdt_physical_address
&& !acpi_gbl_do_not_use_xsdt
) {
286 * RSDP contains an XSDT (64-bit physical addresses). We must use
287 * the XSDT if the revision is > 1 and the XSDT pointer is present,
288 * as per the ACPI specification.
290 address
= (acpi_physical_address
)rsdp
->xsdt_physical_address
;
291 table_entry_size
= ACPI_XSDT_ENTRY_SIZE
;
293 /* Root table is an RSDT (32-bit physical addresses) */
295 address
= (acpi_physical_address
)rsdp
->rsdt_physical_address
;
296 table_entry_size
= ACPI_RSDT_ENTRY_SIZE
;
300 * It is not possible to map more than one entry in some environments,
301 * so unmap the RSDP here before mapping other tables
303 acpi_os_unmap_memory(rsdp
, sizeof(struct acpi_table_rsdp
));
305 /* Map the RSDT/XSDT table header to get the full table length */
307 table
= acpi_os_map_memory(address
, sizeof(struct acpi_table_header
));
309 return_ACPI_STATUS(AE_NO_MEMORY
);
312 acpi_tb_print_table_header(address
, table
);
315 * Validate length of the table, and map entire table.
316 * Minimum length table must contain at least one entry.
318 length
= table
->length
;
319 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
321 if (length
< (sizeof(struct acpi_table_header
) + table_entry_size
)) {
322 ACPI_BIOS_ERROR((AE_INFO
,
323 "Invalid table length 0x%X in RSDT/XSDT",
325 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
328 table
= acpi_os_map_memory(address
, length
);
330 return_ACPI_STATUS(AE_NO_MEMORY
);
333 /* Validate the root table checksum */
335 status
= acpi_tb_verify_checksum(table
, length
);
336 if (ACPI_FAILURE(status
)) {
337 acpi_os_unmap_memory(table
, length
);
338 return_ACPI_STATUS(status
);
341 /* Get the number of entries and pointer to first entry */
343 table_count
= (u32
)((table
->length
- sizeof(struct acpi_table_header
)) /
345 table_entry
= ACPI_ADD_PTR(u8
, table
, sizeof(struct acpi_table_header
));
347 /* Initialize the root table array from the RSDT/XSDT */
349 for (i
= 0; i
< table_count
; i
++) {
351 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */
354 acpi_tb_get_root_table_entry(table_entry
, table_entry_size
);
356 /* Skip NULL entries in RSDT/XSDT */
362 status
= acpi_tb_install_standard_table(address
,
363 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
,
367 if (ACPI_SUCCESS(status
) &&
368 ACPI_COMPARE_NAME(&acpi_gbl_root_table_list
.
369 tables
[table_index
].signature
,
371 acpi_gbl_fadt_index
= table_index
;
372 acpi_tb_parse_fadt();
377 table_entry
+= table_entry_size
;
380 acpi_os_unmap_memory(table
, length
);
381 return_ACPI_STATUS(AE_OK
);