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