1 /****************************************************************************** 2 * 3 * Module Name: tbutils - ACPI Table utilities 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #define __TBUTILS_C__ 117 118 #include "acpi.h" 119 #include "accommon.h" 120 #include "actables.h" 121 122 #define _COMPONENT ACPI_TABLES 123 ACPI_MODULE_NAME ("tbutils") 124 125 126 /* Local prototypes */ 127 128 static ACPI_PHYSICAL_ADDRESS 129 AcpiTbGetRootTableEntry ( 130 UINT8 *TableEntry, 131 UINT32 TableEntrySize); 132 133 134 #if (!ACPI_REDUCED_HARDWARE) 135 /******************************************************************************* 136 * 137 * FUNCTION: AcpiTbInitializeFacs 138 * 139 * PARAMETERS: None 140 * 141 * RETURN: Status 142 * 143 * DESCRIPTION: Create a permanent mapping for the FADT and save it in a global 144 * for accessing the Global Lock and Firmware Waking Vector 145 * 146 ******************************************************************************/ 147 148 ACPI_STATUS 149 AcpiTbInitializeFacs ( 150 void) 151 { 152 ACPI_STATUS Status; 153 154 155 /* If Hardware Reduced flag is set, there is no FACS */ 156 157 if (AcpiGbl_ReducedHardware) 158 { 159 AcpiGbl_FACS = NULL; 160 return (AE_OK); 161 } 162 163 Status = AcpiGetTableByIndex (ACPI_TABLE_INDEX_FACS, 164 ACPI_CAST_INDIRECT_PTR (ACPI_TABLE_HEADER, &AcpiGbl_FACS)); 165 return (Status); 166 } 167 #endif /* !ACPI_REDUCED_HARDWARE */ 168 169 170 /******************************************************************************* 171 * 172 * FUNCTION: AcpiTbTablesLoaded 173 * 174 * PARAMETERS: None 175 * 176 * RETURN: TRUE if required ACPI tables are loaded 177 * 178 * DESCRIPTION: Determine if the minimum required ACPI tables are present 179 * (FADT, FACS, DSDT) 180 * 181 ******************************************************************************/ 182 183 BOOLEAN 184 AcpiTbTablesLoaded ( 185 void) 186 { 187 188 if (AcpiGbl_RootTableList.CurrentTableCount >= 3) 189 { 190 return (TRUE); 191 } 192 193 return (FALSE); 194 } 195 196 197 /******************************************************************************* 198 * 199 * FUNCTION: AcpiTbCheckDsdtHeader 200 * 201 * PARAMETERS: None 202 * 203 * RETURN: None 204 * 205 * DESCRIPTION: Quick compare to check validity of the DSDT. This will detect 206 * if the DSDT has been replaced from outside the OS and/or if 207 * the DSDT header has been corrupted. 208 * 209 ******************************************************************************/ 210 211 void 212 AcpiTbCheckDsdtHeader ( 213 void) 214 { 215 216 /* Compare original length and checksum to current values */ 217 218 if (AcpiGbl_OriginalDsdtHeader.Length != AcpiGbl_DSDT->Length || 219 AcpiGbl_OriginalDsdtHeader.Checksum != AcpiGbl_DSDT->Checksum) 220 { 221 ACPI_BIOS_ERROR ((AE_INFO, 222 "The DSDT has been corrupted or replaced - " 223 "old, new headers below")); 224 AcpiTbPrintTableHeader (0, &AcpiGbl_OriginalDsdtHeader); 225 AcpiTbPrintTableHeader (0, AcpiGbl_DSDT); 226 227 /* Disable further error messages */ 228 229 AcpiGbl_OriginalDsdtHeader.Length = AcpiGbl_DSDT->Length; 230 AcpiGbl_OriginalDsdtHeader.Checksum = AcpiGbl_DSDT->Checksum; 231 } 232 } 233 234 235 /******************************************************************************* 236 * 237 * FUNCTION: AcpiTbCopyDsdt 238 * 239 * PARAMETERS: TableDesc - Installed table to copy 240 * 241 * RETURN: None 242 * 243 * DESCRIPTION: Implements a subsystem option to copy the DSDT to local memory. 244 * Some very bad BIOSs are known to either corrupt the DSDT or 245 * install a new, bad DSDT. This copy works around the problem. 246 * 247 ******************************************************************************/ 248 249 ACPI_TABLE_HEADER * 250 AcpiTbCopyDsdt ( 251 UINT32 TableIndex) 252 { 253 ACPI_TABLE_HEADER *NewTable; 254 ACPI_TABLE_DESC *TableDesc; 255 256 257 TableDesc = &AcpiGbl_RootTableList.Tables[TableIndex]; 258 259 NewTable = ACPI_ALLOCATE (TableDesc->Length); 260 if (!NewTable) 261 { 262 ACPI_ERROR ((AE_INFO, "Could not copy DSDT of length 0x%X", 263 TableDesc->Length)); 264 return (NULL); 265 } 266 267 ACPI_MEMCPY (NewTable, TableDesc->Pointer, TableDesc->Length); 268 AcpiTbUninstallTable (TableDesc); 269 270 AcpiTbInitTableDescriptor ( 271 &AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT], 272 ACPI_PTR_TO_PHYSADDR (NewTable), ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL, 273 NewTable); 274 275 ACPI_INFO ((AE_INFO, 276 "Forced DSDT copy: length 0x%05X copied locally, original unmapped", 277 NewTable->Length)); 278 279 return (NewTable); 280 } 281 282 283 /******************************************************************************* 284 * 285 * FUNCTION: AcpiTbGetRootTableEntry 286 * 287 * PARAMETERS: TableEntry - Pointer to the RSDT/XSDT table entry 288 * TableEntrySize - sizeof 32 or 64 (RSDT or XSDT) 289 * 290 * RETURN: Physical address extracted from the root table 291 * 292 * DESCRIPTION: Get one root table entry. Handles 32-bit and 64-bit cases on 293 * both 32-bit and 64-bit platforms 294 * 295 * NOTE: ACPI_PHYSICAL_ADDRESS is 32-bit on 32-bit platforms, 64-bit on 296 * 64-bit platforms. 297 * 298 ******************************************************************************/ 299 300 static ACPI_PHYSICAL_ADDRESS 301 AcpiTbGetRootTableEntry ( 302 UINT8 *TableEntry, 303 UINT32 TableEntrySize) 304 { 305 UINT64 Address64; 306 307 308 /* 309 * Get the table physical address (32-bit for RSDT, 64-bit for XSDT): 310 * Note: Addresses are 32-bit aligned (not 64) in both RSDT and XSDT 311 */ 312 if (TableEntrySize == ACPI_RSDT_ENTRY_SIZE) 313 { 314 /* 315 * 32-bit platform, RSDT: Return 32-bit table entry 316 * 64-bit platform, RSDT: Expand 32-bit to 64-bit and return 317 */ 318 return ((ACPI_PHYSICAL_ADDRESS) (*ACPI_CAST_PTR (UINT32, TableEntry))); 319 } 320 else 321 { 322 /* 323 * 32-bit platform, XSDT: Truncate 64-bit to 32-bit and return 324 * 64-bit platform, XSDT: Move (unaligned) 64-bit to local, 325 * return 64-bit 326 */ 327 ACPI_MOVE_64_TO_64 (&Address64, TableEntry); 328 329 #if ACPI_MACHINE_WIDTH == 32 330 if (Address64 > ACPI_UINT32_MAX) 331 { 332 /* Will truncate 64-bit address to 32 bits, issue warning */ 333 334 ACPI_BIOS_WARNING ((AE_INFO, 335 "64-bit Physical Address in XSDT is too large (0x%8.8X%8.8X)," 336 " truncating", 337 ACPI_FORMAT_UINT64 (Address64))); 338 } 339 #endif 340 return ((ACPI_PHYSICAL_ADDRESS) (Address64)); 341 } 342 } 343 344 345 /******************************************************************************* 346 * 347 * FUNCTION: AcpiTbParseRootTable 348 * 349 * PARAMETERS: Rsdp - Pointer to the RSDP 350 * 351 * RETURN: Status 352 * 353 * DESCRIPTION: This function is called to parse the Root System Description 354 * Table (RSDT or XSDT) 355 * 356 * NOTE: Tables are mapped (not copied) for efficiency. The FACS must 357 * be mapped and cannot be copied because it contains the actual 358 * memory location of the ACPI Global Lock. 359 * 360 ******************************************************************************/ 361 362 ACPI_STATUS 363 AcpiTbParseRootTable ( 364 ACPI_PHYSICAL_ADDRESS RsdpAddress) 365 { 366 ACPI_TABLE_RSDP *Rsdp; 367 UINT32 TableEntrySize; 368 UINT32 i; 369 UINT32 TableCount; 370 ACPI_TABLE_HEADER *Table; 371 ACPI_PHYSICAL_ADDRESS Address; 372 UINT32 Length; 373 UINT8 *TableEntry; 374 ACPI_STATUS Status; 375 UINT32 TableIndex; 376 377 378 ACPI_FUNCTION_TRACE (TbParseRootTable); 379 380 381 /* Map the entire RSDP and extract the address of the RSDT or XSDT */ 382 383 Rsdp = AcpiOsMapMemory (RsdpAddress, sizeof (ACPI_TABLE_RSDP)); 384 if (!Rsdp) 385 { 386 return_ACPI_STATUS (AE_NO_MEMORY); 387 } 388 389 AcpiTbPrintTableHeader (RsdpAddress, 390 ACPI_CAST_PTR (ACPI_TABLE_HEADER, Rsdp)); 391 392 /* Use XSDT if present and not overridden. Otherwise, use RSDT */ 393 394 if ((Rsdp->Revision > 1) && 395 Rsdp->XsdtPhysicalAddress && 396 !AcpiGbl_DoNotUseXsdt) 397 { 398 /* 399 * RSDP contains an XSDT (64-bit physical addresses). We must use 400 * the XSDT if the revision is > 1 and the XSDT pointer is present, 401 * as per the ACPI specification. 402 */ 403 Address = (ACPI_PHYSICAL_ADDRESS) Rsdp->XsdtPhysicalAddress; 404 TableEntrySize = ACPI_XSDT_ENTRY_SIZE; 405 } 406 else 407 { 408 /* Root table is an RSDT (32-bit physical addresses) */ 409 410 Address = (ACPI_PHYSICAL_ADDRESS) Rsdp->RsdtPhysicalAddress; 411 TableEntrySize = ACPI_RSDT_ENTRY_SIZE; 412 } 413 414 /* 415 * It is not possible to map more than one entry in some environments, 416 * so unmap the RSDP here before mapping other tables 417 */ 418 AcpiOsUnmapMemory (Rsdp, sizeof (ACPI_TABLE_RSDP)); 419 420 /* Map the RSDT/XSDT table header to get the full table length */ 421 422 Table = AcpiOsMapMemory (Address, sizeof (ACPI_TABLE_HEADER)); 423 if (!Table) 424 { 425 return_ACPI_STATUS (AE_NO_MEMORY); 426 } 427 428 AcpiTbPrintTableHeader (Address, Table); 429 430 /* 431 * Validate length of the table, and map entire table. 432 * Minimum length table must contain at least one entry. 433 */ 434 Length = Table->Length; 435 AcpiOsUnmapMemory (Table, sizeof (ACPI_TABLE_HEADER)); 436 437 if (Length < (sizeof (ACPI_TABLE_HEADER) + TableEntrySize)) 438 { 439 ACPI_BIOS_ERROR ((AE_INFO, 440 "Invalid table length 0x%X in RSDT/XSDT", Length)); 441 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH); 442 } 443 444 Table = AcpiOsMapMemory (Address, Length); 445 if (!Table) 446 { 447 return_ACPI_STATUS (AE_NO_MEMORY); 448 } 449 450 /* Validate the root table checksum */ 451 452 Status = AcpiTbVerifyChecksum (Table, Length); 453 if (ACPI_FAILURE (Status)) 454 { 455 AcpiOsUnmapMemory (Table, Length); 456 return_ACPI_STATUS (Status); 457 } 458 459 /* Get the number of entries and pointer to first entry */ 460 461 TableCount = (UINT32) ((Table->Length - sizeof (ACPI_TABLE_HEADER)) / 462 TableEntrySize); 463 TableEntry = ACPI_ADD_PTR (UINT8, Table, sizeof (ACPI_TABLE_HEADER)); 464 465 /* 466 * First two entries in the table array are reserved for the DSDT 467 * and FACS, which are not actually present in the RSDT/XSDT - they 468 * come from the FADT 469 */ 470 AcpiGbl_RootTableList.CurrentTableCount = 2; 471 472 /* Initialize the root table array from the RSDT/XSDT */ 473 474 for (i = 0; i < TableCount; i++) 475 { 476 /* Get the table physical address (32-bit for RSDT, 64-bit for XSDT) */ 477 478 Address = AcpiTbGetRootTableEntry (TableEntry, TableEntrySize); 479 480 /* Skip NULL entries in RSDT/XSDT */ 481 482 if (!Address) 483 { 484 goto NextTable; 485 } 486 487 Status = AcpiTbInstallStandardTable (Address, 488 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, FALSE, TRUE, &TableIndex); 489 490 if (ACPI_SUCCESS (Status) && 491 ACPI_COMPARE_NAME (&AcpiGbl_RootTableList.Tables[TableIndex].Signature, 492 ACPI_SIG_FADT)) 493 { 494 AcpiTbParseFadt (TableIndex); 495 } 496 497 NextTable: 498 499 TableEntry += TableEntrySize; 500 } 501 502 AcpiOsUnmapMemory (Table, Length); 503 504 return_ACPI_STATUS (AE_OK); 505 } 506