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 - 2023, 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 160 /******************************************************************************* 161 * 162 * FUNCTION: AcpiTbInstallTableWithOverride 163 * 164 * PARAMETERS: NewTableDesc - New table descriptor to install 165 * Override - Whether override should be performed 166 * TableIndex - Where the table index is returned 167 * 168 * RETURN: None 169 * 170 * DESCRIPTION: Install an ACPI table into the global data structure. The 171 * table override mechanism is called to allow the host 172 * OS to replace any table before it is installed in the root 173 * table array. 174 * 175 ******************************************************************************/ 176 177 void 178 AcpiTbInstallTableWithOverride ( 179 ACPI_TABLE_DESC *NewTableDesc, 180 BOOLEAN Override, 181 UINT32 *TableIndex) 182 { 183 UINT32 i; 184 ACPI_STATUS Status; 185 186 187 Status = AcpiTbGetNextTableDescriptor (&i, NULL); 188 if (ACPI_FAILURE (Status)) 189 { 190 return; 191 } 192 193 /* 194 * ACPI Table Override: 195 * 196 * Before we install the table, let the host OS override it with a new 197 * one if desired. Any table within the RSDT/XSDT can be replaced, 198 * including the DSDT which is pointed to by the FADT. 199 */ 200 if (Override) 201 { 202 AcpiTbOverrideTable (NewTableDesc); 203 } 204 205 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList.Tables[i], 206 NewTableDesc->Address, NewTableDesc->Flags, NewTableDesc->Pointer); 207 208 AcpiTbPrintTableHeader (NewTableDesc->Address, NewTableDesc->Pointer); 209 210 /* This synchronizes AcpiGbl_DsdtIndex */ 211 212 *TableIndex = i; 213 214 /* Set the global integer width (based upon revision of the DSDT) */ 215 216 if (i == AcpiGbl_DsdtIndex) 217 { 218 AcpiUtSetIntegerWidth (NewTableDesc->Pointer->Revision); 219 } 220 } 221 222 223 /******************************************************************************* 224 * 225 * FUNCTION: AcpiTbInstallStandardTable 226 * 227 * PARAMETERS: Address - Address of the table (might be a virtual 228 * address depending on the TableFlags) 229 * Flags - Flags for the table 230 * Table - Pointer to the table (required for virtual 231 * origins, optional for physical) 232 * Reload - Whether reload should be performed 233 * Override - Whether override should be performed 234 * TableIndex - Where the table index is returned 235 * 236 * RETURN: Status 237 * 238 * DESCRIPTION: This function is called to verify and install an ACPI table. 239 * When this function is called by "Load" or "LoadTable" opcodes, 240 * or by AcpiLoadTable() API, the "Reload" parameter is set. 241 * After successfully returning from this function, table is 242 * "INSTALLED" but not "VALIDATED". 243 * 244 ******************************************************************************/ 245 246 ACPI_STATUS 247 AcpiTbInstallStandardTable ( 248 ACPI_PHYSICAL_ADDRESS Address, 249 UINT8 Flags, 250 ACPI_TABLE_HEADER *Table, 251 BOOLEAN Reload, 252 BOOLEAN Override, 253 UINT32 *TableIndex) 254 { 255 UINT32 i; 256 ACPI_STATUS Status = AE_OK; 257 ACPI_TABLE_DESC NewTableDesc; 258 259 260 ACPI_FUNCTION_TRACE (TbInstallStandardTable); 261 262 263 /* Acquire a temporary table descriptor for validation */ 264 265 Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, Flags, Table); 266 if (ACPI_FAILURE (Status)) 267 { 268 ACPI_ERROR ((AE_INFO, 269 "Could not acquire table length at %8.8X%8.8X", 270 ACPI_FORMAT_UINT64 (Address))); 271 return_ACPI_STATUS (Status); 272 } 273 274 /* 275 * Optionally do not load any SSDTs from the RSDT/XSDT. This can 276 * be useful for debugging ACPI problems on some machines. 277 */ 278 if (!Reload && 279 AcpiGbl_DisableSsdtTableInstall && 280 ACPI_COMPARE_NAMESEG (&NewTableDesc.Signature, ACPI_SIG_SSDT)) 281 { 282 ACPI_INFO (( 283 "Ignoring installation of %4.4s at %8.8X%8.8X", 284 NewTableDesc.Signature.Ascii, ACPI_FORMAT_UINT64 (Address))); 285 goto ReleaseAndExit; 286 } 287 288 /* Acquire the table lock */ 289 290 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 291 292 /* Validate and verify a table before installation */ 293 294 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL, &i); 295 if (ACPI_FAILURE (Status)) 296 { 297 if (Status == AE_CTRL_TERMINATE) 298 { 299 /* 300 * Table was unloaded, allow it to be reloaded. 301 * As we are going to return AE_OK to the caller, we should 302 * take the responsibility of freeing the input descriptor. 303 * Refill the input descriptor to ensure 304 * AcpiTbInstallTableWithOverride() can be called again to 305 * indicate the re-installation. 306 */ 307 AcpiTbUninstallTable (&NewTableDesc); 308 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 309 *TableIndex = i; 310 return_ACPI_STATUS (AE_OK); 311 } 312 goto UnlockAndExit; 313 } 314 315 /* Add the table to the global root table list */ 316 317 AcpiTbInstallTableWithOverride (&NewTableDesc, Override, TableIndex); 318 319 /* Invoke table handler */ 320 321 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 322 AcpiTbNotifyTable (ACPI_TABLE_EVENT_INSTALL, NewTableDesc.Pointer); 323 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 324 325 UnlockAndExit: 326 327 /* Release the table lock */ 328 329 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 330 331 ReleaseAndExit: 332 333 /* Release the temporary table descriptor */ 334 335 AcpiTbReleaseTempTable (&NewTableDesc); 336 return_ACPI_STATUS (Status); 337 } 338 339 340 /******************************************************************************* 341 * 342 * FUNCTION: AcpiTbOverrideTable 343 * 344 * PARAMETERS: OldTableDesc - Validated table descriptor to be 345 * overridden 346 * 347 * RETURN: None 348 * 349 * DESCRIPTION: Attempt table override by calling the OSL override functions. 350 * Note: If the table is overridden, then the entire new table 351 * is acquired and returned by this function. 352 * Before/after invocation, the table descriptor is in a state 353 * that is "VALIDATED". 354 * 355 ******************************************************************************/ 356 357 void 358 AcpiTbOverrideTable ( 359 ACPI_TABLE_DESC *OldTableDesc) 360 { 361 ACPI_STATUS Status; 362 ACPI_TABLE_DESC NewTableDesc; 363 ACPI_TABLE_HEADER *Table; 364 ACPI_PHYSICAL_ADDRESS Address; 365 UINT32 Length; 366 ACPI_ERROR_ONLY (char *OverrideType); 367 368 369 /* (1) Attempt logical override (returns a logical address) */ 370 371 Status = AcpiOsTableOverride (OldTableDesc->Pointer, &Table); 372 if (ACPI_SUCCESS (Status) && Table) 373 { 374 AcpiTbAcquireTempTable (&NewTableDesc, ACPI_PTR_TO_PHYSADDR (Table), 375 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, Table); 376 ACPI_ERROR_ONLY (OverrideType = "Logical"); 377 goto FinishOverride; 378 } 379 380 /* (2) Attempt physical override (returns a physical address) */ 381 382 Status = AcpiOsPhysicalTableOverride (OldTableDesc->Pointer, 383 &Address, &Length); 384 if (ACPI_SUCCESS (Status) && Address && Length) 385 { 386 AcpiTbAcquireTempTable (&NewTableDesc, Address, 387 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL); 388 ACPI_ERROR_ONLY (OverrideType = "Physical"); 389 goto FinishOverride; 390 } 391 392 return; /* There was no override */ 393 394 395 FinishOverride: 396 397 /* 398 * Validate and verify a table before overriding, no nested table 399 * duplication check as it's too complicated and unnecessary. 400 */ 401 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL, NULL); 402 if (ACPI_FAILURE (Status)) 403 { 404 return; 405 } 406 407 ACPI_INFO (("%4.4s 0x%8.8X%8.8X" 408 " %s table override, new table: 0x%8.8X%8.8X", 409 OldTableDesc->Signature.Ascii, 410 ACPI_FORMAT_UINT64 (OldTableDesc->Address), 411 OverrideType, ACPI_FORMAT_UINT64 (NewTableDesc.Address))); 412 413 /* We can now uninstall the original table */ 414 415 AcpiTbUninstallTable (OldTableDesc); 416 417 /* 418 * Replace the original table descriptor and keep its state as 419 * "VALIDATED". 420 */ 421 AcpiTbInitTableDescriptor (OldTableDesc, NewTableDesc.Address, 422 NewTableDesc.Flags, NewTableDesc.Pointer); 423 AcpiTbValidateTempTable (OldTableDesc); 424 425 /* Release the temporary table descriptor */ 426 427 AcpiTbReleaseTempTable (&NewTableDesc); 428 } 429 430 431 /******************************************************************************* 432 * 433 * FUNCTION: AcpiTbUninstallTable 434 * 435 * PARAMETERS: TableDesc - Table descriptor 436 * 437 * RETURN: None 438 * 439 * DESCRIPTION: Delete one internal ACPI table 440 * 441 ******************************************************************************/ 442 443 void 444 AcpiTbUninstallTable ( 445 ACPI_TABLE_DESC *TableDesc) 446 { 447 448 ACPI_FUNCTION_TRACE (TbUninstallTable); 449 450 451 /* Table must be installed */ 452 453 if (!TableDesc->Address) 454 { 455 return_VOID; 456 } 457 458 AcpiTbInvalidateTable (TableDesc); 459 460 if ((TableDesc->Flags & ACPI_TABLE_ORIGIN_MASK) == 461 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL) 462 { 463 ACPI_FREE (TableDesc->Pointer); 464 TableDesc->Pointer = NULL; 465 } 466 467 TableDesc->Address = ACPI_PTR_TO_PHYSADDR (NULL); 468 return_VOID; 469 } 470