1 /****************************************************************************** 2 * 3 * Module Name: tbinstal - ACPI table installation and removal 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, 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 #include "acpi.h" 117 #include "accommon.h" 118 #include "actables.h" 119 120 #define _COMPONENT ACPI_TABLES 121 ACPI_MODULE_NAME ("tbinstal") 122 123 /* Local prototypes */ 124 125 static BOOLEAN 126 AcpiTbCompareTables ( 127 ACPI_TABLE_DESC *TableDesc, 128 UINT32 TableIndex); 129 130 131 /******************************************************************************* 132 * 133 * FUNCTION: AcpiTbCompareTables 134 * 135 * PARAMETERS: TableDesc - Table 1 descriptor to be compared 136 * TableIndex - Index of table 2 to be compared 137 * 138 * RETURN: TRUE if both tables are identical. 139 * 140 * DESCRIPTION: This function compares a table with another table that has 141 * already been installed in the root table list. 142 * 143 ******************************************************************************/ 144 145 static BOOLEAN 146 AcpiTbCompareTables ( 147 ACPI_TABLE_DESC *TableDesc, 148 UINT32 TableIndex) 149 { 150 ACPI_STATUS Status = AE_OK; 151 BOOLEAN IsIdentical; 152 ACPI_TABLE_HEADER *Table; 153 UINT32 TableLength; 154 UINT8 TableFlags; 155 156 157 Status = AcpiTbAcquireTable (&AcpiGbl_RootTableList.Tables[TableIndex], 158 &Table, &TableLength, &TableFlags); 159 if (ACPI_FAILURE (Status)) 160 { 161 return (FALSE); 162 } 163 164 /* 165 * Check for a table match on the entire table length, 166 * not just the header. 167 */ 168 IsIdentical = (BOOLEAN)((TableDesc->Length != TableLength || 169 memcmp (TableDesc->Pointer, Table, TableLength)) ? 170 FALSE : TRUE); 171 172 /* Release the acquired table */ 173 174 AcpiTbReleaseTable (Table, TableLength, TableFlags); 175 return (IsIdentical); 176 } 177 178 179 /******************************************************************************* 180 * 181 * FUNCTION: AcpiTbInstallTableWithOverride 182 * 183 * PARAMETERS: NewTableDesc - New table descriptor to install 184 * Override - Whether override should be performed 185 * TableIndex - Where the table index is returned 186 * 187 * RETURN: None 188 * 189 * DESCRIPTION: Install an ACPI table into the global data structure. The 190 * table override mechanism is called to allow the host 191 * OS to replace any table before it is installed in the root 192 * table array. 193 * 194 ******************************************************************************/ 195 196 void 197 AcpiTbInstallTableWithOverride ( 198 ACPI_TABLE_DESC *NewTableDesc, 199 BOOLEAN Override, 200 UINT32 *TableIndex) 201 { 202 UINT32 i; 203 ACPI_STATUS Status; 204 205 206 Status = AcpiTbGetNextTableDescriptor (&i, NULL); 207 if (ACPI_FAILURE (Status)) 208 { 209 return; 210 } 211 212 /* 213 * ACPI Table Override: 214 * 215 * Before we install the table, let the host OS override it with a new 216 * one if desired. Any table within the RSDT/XSDT can be replaced, 217 * including the DSDT which is pointed to by the FADT. 218 */ 219 if (Override) 220 { 221 AcpiTbOverrideTable (NewTableDesc); 222 } 223 224 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList.Tables[i], 225 NewTableDesc->Address, NewTableDesc->Flags, NewTableDesc->Pointer); 226 227 AcpiTbPrintTableHeader (NewTableDesc->Address, NewTableDesc->Pointer); 228 229 /* This synchronizes AcpiGbl_DsdtIndex */ 230 231 *TableIndex = i; 232 233 /* Set the global integer width (based upon revision of the DSDT) */ 234 235 if (i == AcpiGbl_DsdtIndex) 236 { 237 AcpiUtSetIntegerWidth (NewTableDesc->Pointer->Revision); 238 } 239 } 240 241 242 /******************************************************************************* 243 * 244 * FUNCTION: AcpiTbInstallFixedTable 245 * 246 * PARAMETERS: Address - Physical address of DSDT or FACS 247 * Signature - Table signature, NULL if no need to 248 * match 249 * TableIndex - Where the table index is returned 250 * 251 * RETURN: Status 252 * 253 * DESCRIPTION: Install a fixed ACPI table (DSDT/FACS) into the global data 254 * structure. 255 * 256 ******************************************************************************/ 257 258 ACPI_STATUS 259 AcpiTbInstallFixedTable ( 260 ACPI_PHYSICAL_ADDRESS Address, 261 char *Signature, 262 UINT32 *TableIndex) 263 { 264 ACPI_TABLE_DESC NewTableDesc; 265 ACPI_STATUS Status; 266 267 268 ACPI_FUNCTION_TRACE (TbInstallFixedTable); 269 270 271 if (!Address) 272 { 273 ACPI_ERROR ((AE_INFO, "Null physical address for ACPI table [%s]", 274 Signature)); 275 return (AE_NO_MEMORY); 276 } 277 278 /* Fill a table descriptor for validation */ 279 280 Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, 281 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL); 282 if (ACPI_FAILURE (Status)) 283 { 284 ACPI_ERROR ((AE_INFO, "Could not acquire table length at %8.8X%8.8X", 285 ACPI_FORMAT_UINT64 (Address))); 286 return_ACPI_STATUS (Status); 287 } 288 289 /* Validate and verify a table before installation */ 290 291 Status = AcpiTbVerifyTempTable (&NewTableDesc, Signature); 292 if (ACPI_FAILURE (Status)) 293 { 294 goto ReleaseAndExit; 295 } 296 297 /* Add the table to the global root table list */ 298 299 AcpiTbInstallTableWithOverride (&NewTableDesc, TRUE, TableIndex); 300 301 ReleaseAndExit: 302 303 /* Release the temporary table descriptor */ 304 305 AcpiTbReleaseTempTable (&NewTableDesc); 306 return_ACPI_STATUS (Status); 307 } 308 309 310 /******************************************************************************* 311 * 312 * FUNCTION: AcpiTbInstallStandardTable 313 * 314 * PARAMETERS: Address - Address of the table (might be a virtual 315 * address depending on the TableFlags) 316 * Flags - Flags for the table 317 * Reload - Whether reload should be performed 318 * Override - Whether override should be performed 319 * TableIndex - Where the table index is returned 320 * 321 * RETURN: Status 322 * 323 * DESCRIPTION: This function is called to install an ACPI table that is 324 * neither DSDT nor FACS (a "standard" table.) 325 * When this function is called by "Load" or "LoadTable" opcodes, 326 * or by AcpiLoadTable() API, the "Reload" parameter is set. 327 * After sucessfully returning from this function, table is 328 * "INSTALLED" but not "VALIDATED". 329 * 330 ******************************************************************************/ 331 332 ACPI_STATUS 333 AcpiTbInstallStandardTable ( 334 ACPI_PHYSICAL_ADDRESS Address, 335 UINT8 Flags, 336 BOOLEAN Reload, 337 BOOLEAN Override, 338 UINT32 *TableIndex) 339 { 340 UINT32 i; 341 ACPI_STATUS Status = AE_OK; 342 ACPI_TABLE_DESC NewTableDesc; 343 344 345 ACPI_FUNCTION_TRACE (TbInstallStandardTable); 346 347 348 /* Acquire a temporary table descriptor for validation */ 349 350 Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, Flags); 351 if (ACPI_FAILURE (Status)) 352 { 353 ACPI_ERROR ((AE_INFO, 354 "Could not acquire table length at %8.8X%8.8X", 355 ACPI_FORMAT_UINT64 (Address))); 356 return_ACPI_STATUS (Status); 357 } 358 359 /* 360 * Optionally do not load any SSDTs from the RSDT/XSDT. This can 361 * be useful for debugging ACPI problems on some machines. 362 */ 363 if (!Reload && 364 AcpiGbl_DisableSsdtTableInstall && 365 ACPI_COMPARE_NAME (&NewTableDesc.Signature, ACPI_SIG_SSDT)) 366 { 367 ACPI_INFO ((AE_INFO, 368 "Ignoring installation of %4.4s at %8.8X%8.8X", 369 NewTableDesc.Signature.Ascii, ACPI_FORMAT_UINT64 (Address))); 370 goto ReleaseAndExit; 371 } 372 373 /* Validate and verify a table before installation */ 374 375 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL); 376 if (ACPI_FAILURE (Status)) 377 { 378 goto ReleaseAndExit; 379 } 380 381 if (Reload) 382 { 383 /* 384 * Validate the incoming table signature. 385 * 386 * 1) Originally, we checked the table signature for "SSDT" or "PSDT". 387 * 2) We added support for OEMx tables, signature "OEM". 388 * 3) Valid tables were encountered with a null signature, so we just 389 * gave up on validating the signature, (05/2008). 390 * 4) We encountered non-AML tables such as the MADT, which caused 391 * interpreter errors and kernel faults. So now, we once again allow 392 * only "SSDT", "OEMx", and now, also a null signature. (05/2011). 393 */ 394 if ((NewTableDesc.Signature.Ascii[0] != 0x00) && 395 (!ACPI_COMPARE_NAME (&NewTableDesc.Signature, ACPI_SIG_SSDT)) && 396 (strncmp (NewTableDesc.Signature.Ascii, "OEM", 3))) 397 { 398 ACPI_BIOS_ERROR ((AE_INFO, 399 "Table has invalid signature [%4.4s] (0x%8.8X), " 400 "must be SSDT or OEMx", 401 AcpiUtValidAcpiName (NewTableDesc.Signature.Ascii) ? 402 NewTableDesc.Signature.Ascii : "????", 403 NewTableDesc.Signature.Integer)); 404 405 Status = AE_BAD_SIGNATURE; 406 goto ReleaseAndExit; 407 } 408 409 /* Check if table is already registered */ 410 411 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i) 412 { 413 /* 414 * Check for a table match on the entire table length, 415 * not just the header. 416 */ 417 if (!AcpiTbCompareTables (&NewTableDesc, i)) 418 { 419 continue; 420 } 421 422 /* 423 * Note: the current mechanism does not unregister a table if it is 424 * dynamically unloaded. The related namespace entries are deleted, 425 * but the table remains in the root table list. 426 * 427 * The assumption here is that the number of different tables that 428 * will be loaded is actually small, and there is minimal overhead 429 * in just keeping the table in case it is needed again. 430 * 431 * If this assumption changes in the future (perhaps on large 432 * machines with many table load/unload operations), tables will 433 * need to be unregistered when they are unloaded, and slots in the 434 * root table list should be reused when empty. 435 */ 436 if (AcpiGbl_RootTableList.Tables[i].Flags & 437 ACPI_TABLE_IS_LOADED) 438 { 439 /* Table is still loaded, this is an error */ 440 441 Status = AE_ALREADY_EXISTS; 442 goto ReleaseAndExit; 443 } 444 else 445 { 446 /* 447 * Table was unloaded, allow it to be reloaded. 448 * As we are going to return AE_OK to the caller, we should 449 * take the responsibility of freeing the input descriptor. 450 * Refill the input descriptor to ensure 451 * AcpiTbInstallTableWithOverride() can be called again to 452 * indicate the re-installation. 453 */ 454 AcpiTbUninstallTable (&NewTableDesc); 455 *TableIndex = i; 456 return_ACPI_STATUS (AE_OK); 457 } 458 } 459 } 460 461 /* Add the table to the global root table list */ 462 463 AcpiTbInstallTableWithOverride (&NewTableDesc, Override, TableIndex); 464 465 ReleaseAndExit: 466 467 /* Release the temporary table descriptor */ 468 469 AcpiTbReleaseTempTable (&NewTableDesc); 470 return_ACPI_STATUS (Status); 471 } 472 473 474 /******************************************************************************* 475 * 476 * FUNCTION: AcpiTbOverrideTable 477 * 478 * PARAMETERS: OldTableDesc - Validated table descriptor to be 479 * overridden 480 * 481 * RETURN: None 482 * 483 * DESCRIPTION: Attempt table override by calling the OSL override functions. 484 * Note: If the table is overridden, then the entire new table 485 * is acquired and returned by this function. 486 * Before/after invocation, the table descriptor is in a state 487 * that is "VALIDATED". 488 * 489 ******************************************************************************/ 490 491 void 492 AcpiTbOverrideTable ( 493 ACPI_TABLE_DESC *OldTableDesc) 494 { 495 ACPI_STATUS Status; 496 char *OverrideType; 497 ACPI_TABLE_DESC NewTableDesc; 498 ACPI_TABLE_HEADER *Table; 499 ACPI_PHYSICAL_ADDRESS Address; 500 UINT32 Length; 501 502 503 /* (1) Attempt logical override (returns a logical address) */ 504 505 Status = AcpiOsTableOverride (OldTableDesc->Pointer, &Table); 506 if (ACPI_SUCCESS (Status) && Table) 507 { 508 AcpiTbAcquireTempTable (&NewTableDesc, ACPI_PTR_TO_PHYSADDR (Table), 509 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL); 510 OverrideType = "Logical"; 511 goto FinishOverride; 512 } 513 514 /* (2) Attempt physical override (returns a physical address) */ 515 516 Status = AcpiOsPhysicalTableOverride (OldTableDesc->Pointer, 517 &Address, &Length); 518 if (ACPI_SUCCESS (Status) && Address && Length) 519 { 520 AcpiTbAcquireTempTable (&NewTableDesc, Address, 521 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL); 522 OverrideType = "Physical"; 523 goto FinishOverride; 524 } 525 526 return; /* There was no override */ 527 528 529 FinishOverride: 530 531 /* Validate and verify a table before overriding */ 532 533 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL); 534 if (ACPI_FAILURE (Status)) 535 { 536 return; 537 } 538 539 ACPI_INFO ((AE_INFO, "%4.4s 0x%8.8X%8.8X" 540 " %s table override, new table: 0x%8.8X%8.8X", 541 OldTableDesc->Signature.Ascii, 542 ACPI_FORMAT_UINT64 (OldTableDesc->Address), 543 OverrideType, ACPI_FORMAT_UINT64 (NewTableDesc.Address))); 544 545 /* We can now uninstall the original table */ 546 547 AcpiTbUninstallTable (OldTableDesc); 548 549 /* 550 * Replace the original table descriptor and keep its state as 551 * "VALIDATED". 552 */ 553 AcpiTbInitTableDescriptor (OldTableDesc, NewTableDesc.Address, 554 NewTableDesc.Flags, NewTableDesc.Pointer); 555 AcpiTbValidateTempTable (OldTableDesc); 556 557 /* Release the temporary table descriptor */ 558 559 AcpiTbReleaseTempTable (&NewTableDesc); 560 } 561 562 563 /******************************************************************************* 564 * 565 * FUNCTION: AcpiTbUninstallTable 566 * 567 * PARAMETERS: TableDesc - Table descriptor 568 * 569 * RETURN: None 570 * 571 * DESCRIPTION: Delete one internal ACPI table 572 * 573 ******************************************************************************/ 574 575 void 576 AcpiTbUninstallTable ( 577 ACPI_TABLE_DESC *TableDesc) 578 { 579 580 ACPI_FUNCTION_TRACE (TbUninstallTable); 581 582 583 /* Table must be installed */ 584 585 if (!TableDesc->Address) 586 { 587 return_VOID; 588 } 589 590 AcpiTbInvalidateTable (TableDesc); 591 592 if ((TableDesc->Flags & ACPI_TABLE_ORIGIN_MASK) == 593 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL) 594 { 595 ACPI_FREE (ACPI_PHYSADDR_TO_PTR (TableDesc->Address)); 596 } 597 598 TableDesc->Address = ACPI_PTR_TO_PHYSADDR (NULL); 599 return_VOID; 600 } 601