1 /****************************************************************************** 2 * 3 * Module Name: tbxfload - Table load/unload external interfaces 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 #define EXPORT_ACPI_INTERFACES 153 154 #include <contrib/dev/acpica/include/acpi.h> 155 #include <contrib/dev/acpica/include/accommon.h> 156 #include <contrib/dev/acpica/include/acnamesp.h> 157 #include <contrib/dev/acpica/include/actables.h> 158 #include <contrib/dev/acpica/include/acevents.h> 159 160 #define _COMPONENT ACPI_TABLES 161 ACPI_MODULE_NAME ("tbxfload") 162 163 164 /******************************************************************************* 165 * 166 * FUNCTION: AcpiLoadTables 167 * 168 * PARAMETERS: None 169 * 170 * RETURN: Status 171 * 172 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT 173 * 174 ******************************************************************************/ 175 176 ACPI_STATUS ACPI_INIT_FUNCTION 177 AcpiLoadTables ( 178 void) 179 { 180 ACPI_STATUS Status; 181 182 183 ACPI_FUNCTION_TRACE (AcpiLoadTables); 184 185 186 /* 187 * Install the default operation region handlers. These are the 188 * handlers that are defined by the ACPI specification to be 189 * "always accessible" -- namely, SystemMemory, SystemIO, and 190 * PCI_Config. This also means that no _REG methods need to be 191 * run for these address spaces. We need to have these handlers 192 * installed before any AML code can be executed, especially any 193 * module-level code (11/2015). 194 * Note that we allow OSPMs to install their own region handlers 195 * between AcpiInitializeSubsystem() and AcpiLoadTables() to use 196 * their customized default region handlers. 197 */ 198 Status = AcpiEvInstallRegionHandlers (); 199 if (ACPI_FAILURE (Status)) 200 { 201 ACPI_EXCEPTION ((AE_INFO, Status, "During Region initialization")); 202 return_ACPI_STATUS (Status); 203 } 204 205 /* Load the namespace from the tables */ 206 207 Status = AcpiTbLoadNamespace (); 208 209 /* Don't let single failures abort the load */ 210 211 if (Status == AE_CTRL_TERMINATE) 212 { 213 Status = AE_OK; 214 } 215 216 if (ACPI_FAILURE (Status)) 217 { 218 ACPI_EXCEPTION ((AE_INFO, Status, 219 "While loading namespace from ACPI tables")); 220 } 221 222 if (AcpiGbl_ParseTableAsTermList || !AcpiGbl_GroupModuleLevelCode) 223 { 224 /* 225 * Initialize the objects that remain uninitialized. This 226 * runs the executable AML that may be part of the 227 * declaration of these objects: 228 * OperationRegions, BufferFields, Buffers, and Packages. 229 */ 230 Status = AcpiNsInitializeObjects (); 231 if (ACPI_FAILURE (Status)) 232 { 233 return_ACPI_STATUS (Status); 234 } 235 } 236 237 AcpiGbl_NamespaceInitialized = TRUE; 238 return_ACPI_STATUS (Status); 239 } 240 241 ACPI_EXPORT_SYMBOL_INIT (AcpiLoadTables) 242 243 244 /******************************************************************************* 245 * 246 * FUNCTION: AcpiTbLoadNamespace 247 * 248 * PARAMETERS: None 249 * 250 * RETURN: Status 251 * 252 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in 253 * the RSDT/XSDT. 254 * 255 ******************************************************************************/ 256 257 ACPI_STATUS 258 AcpiTbLoadNamespace ( 259 void) 260 { 261 ACPI_STATUS Status; 262 UINT32 i; 263 ACPI_TABLE_HEADER *NewDsdt; 264 ACPI_TABLE_DESC *Table; 265 UINT32 TablesLoaded = 0; 266 UINT32 TablesFailed = 0; 267 268 269 ACPI_FUNCTION_TRACE (TbLoadNamespace); 270 271 272 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 273 274 /* 275 * Load the namespace. The DSDT is required, but any SSDT and 276 * PSDT tables are optional. Verify the DSDT. 277 */ 278 Table = &AcpiGbl_RootTableList.Tables[AcpiGbl_DsdtIndex]; 279 280 if (!AcpiGbl_RootTableList.CurrentTableCount || 281 !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_DSDT) || 282 ACPI_FAILURE (AcpiTbValidateTable (Table))) 283 { 284 Status = AE_NO_ACPI_TABLES; 285 goto UnlockAndExit; 286 } 287 288 /* 289 * Save the DSDT pointer for simple access. This is the mapped memory 290 * address. We must take care here because the address of the .Tables 291 * array can change dynamically as tables are loaded at run-time. Note: 292 * .Pointer field is not validated until after call to AcpiTbValidateTable. 293 */ 294 AcpiGbl_DSDT = Table->Pointer; 295 296 /* 297 * Optionally copy the entire DSDT to local memory (instead of simply 298 * mapping it.) There are some BIOSs that corrupt or replace the original 299 * DSDT, creating the need for this option. Default is FALSE, do not copy 300 * the DSDT. 301 */ 302 if (AcpiGbl_CopyDsdtLocally) 303 { 304 NewDsdt = AcpiTbCopyDsdt (AcpiGbl_DsdtIndex); 305 if (NewDsdt) 306 { 307 AcpiGbl_DSDT = NewDsdt; 308 } 309 } 310 311 /* 312 * Save the original DSDT header for detection of table corruption 313 * and/or replacement of the DSDT from outside the OS. 314 */ 315 memcpy (&AcpiGbl_OriginalDsdtHeader, AcpiGbl_DSDT, 316 sizeof (ACPI_TABLE_HEADER)); 317 318 /* Load and parse tables */ 319 320 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 321 Status = AcpiNsLoadTable (AcpiGbl_DsdtIndex, AcpiGbl_RootNode); 322 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 323 if (ACPI_FAILURE (Status)) 324 { 325 ACPI_EXCEPTION ((AE_INFO, Status, "[DSDT] table load failed")); 326 TablesFailed++; 327 } 328 else 329 { 330 TablesLoaded++; 331 } 332 333 /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */ 334 335 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i) 336 { 337 Table = &AcpiGbl_RootTableList.Tables[i]; 338 339 if (!Table->Address || 340 (!ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_SSDT) && 341 !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_PSDT) && 342 !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_OSDT)) || 343 ACPI_FAILURE (AcpiTbValidateTable (Table))) 344 { 345 continue; 346 } 347 348 /* Ignore errors while loading tables, get as many as possible */ 349 350 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 351 Status = AcpiNsLoadTable (i, AcpiGbl_RootNode); 352 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 353 if (ACPI_FAILURE (Status)) 354 { 355 ACPI_EXCEPTION ((AE_INFO, Status, "(%4.4s:%8.8s) while loading table", 356 Table->Signature.Ascii, Table->Pointer->OemTableId)); 357 358 TablesFailed++; 359 360 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, 361 "Table [%4.4s:%8.8s] (id FF) - Table namespace load failed\n\n", 362 Table->Signature.Ascii, Table->Pointer->OemTableId)); 363 } 364 else 365 { 366 TablesLoaded++; 367 } 368 } 369 370 if (!TablesFailed) 371 { 372 ACPI_INFO (( 373 "%u ACPI AML tables successfully acquired and loaded", 374 TablesLoaded)); 375 } 376 else 377 { 378 ACPI_ERROR ((AE_INFO, 379 "%u table load failures, %u successful", 380 TablesFailed, TablesLoaded)); 381 382 /* Indicate at least one failure */ 383 384 Status = AE_CTRL_TERMINATE; 385 } 386 387 #ifdef ACPI_APPLICATION 388 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "\n")); 389 #endif 390 391 392 UnlockAndExit: 393 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 394 return_ACPI_STATUS (Status); 395 } 396 397 398 /******************************************************************************* 399 * 400 * FUNCTION: AcpiInstallTable 401 * 402 * PARAMETERS: Address - Address of the ACPI table to be installed. 403 * Physical - Whether the address is a physical table 404 * address or not 405 * 406 * RETURN: Status 407 * 408 * DESCRIPTION: Dynamically install an ACPI table. 409 * Note: This function should only be invoked after 410 * AcpiInitializeTables() and before AcpiLoadTables(). 411 * 412 ******************************************************************************/ 413 414 ACPI_STATUS ACPI_INIT_FUNCTION 415 AcpiInstallTable ( 416 ACPI_PHYSICAL_ADDRESS Address, 417 BOOLEAN Physical) 418 { 419 ACPI_STATUS Status; 420 UINT8 Flags; 421 UINT32 TableIndex; 422 423 424 ACPI_FUNCTION_TRACE (AcpiInstallTable); 425 426 427 if (Physical) 428 { 429 Flags = ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL; 430 } 431 else 432 { 433 Flags = ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL; 434 } 435 436 Status = AcpiTbInstallStandardTable (Address, Flags, 437 FALSE, FALSE, &TableIndex); 438 439 return_ACPI_STATUS (Status); 440 } 441 442 ACPI_EXPORT_SYMBOL_INIT (AcpiInstallTable) 443 444 445 /******************************************************************************* 446 * 447 * FUNCTION: AcpiLoadTable 448 * 449 * PARAMETERS: Table - Pointer to a buffer containing the ACPI 450 * table to be loaded. 451 * 452 * RETURN: Status 453 * 454 * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must 455 * be a valid ACPI table with a valid ACPI table header. 456 * Note1: Mainly intended to support hotplug addition of SSDTs. 457 * Note2: Does not copy the incoming table. User is responsible 458 * to ensure that the table is not deleted or unmapped. 459 * 460 ******************************************************************************/ 461 462 ACPI_STATUS 463 AcpiLoadTable ( 464 ACPI_TABLE_HEADER *Table) 465 { 466 ACPI_STATUS Status; 467 UINT32 TableIndex; 468 469 470 ACPI_FUNCTION_TRACE (AcpiLoadTable); 471 472 473 /* Parameter validation */ 474 475 if (!Table) 476 { 477 return_ACPI_STATUS (AE_BAD_PARAMETER); 478 } 479 480 /* Install the table and load it into the namespace */ 481 482 ACPI_INFO (("Host-directed Dynamic ACPI Table Load:")); 483 Status = AcpiTbInstallAndLoadTable (ACPI_PTR_TO_PHYSADDR (Table), 484 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, FALSE, &TableIndex); 485 return_ACPI_STATUS (Status); 486 } 487 488 ACPI_EXPORT_SYMBOL (AcpiLoadTable) 489 490 491 /******************************************************************************* 492 * 493 * FUNCTION: AcpiUnloadParentTable 494 * 495 * PARAMETERS: Object - Handle to any namespace object owned by 496 * the table to be unloaded 497 * 498 * RETURN: Status 499 * 500 * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads 501 * the table and deletes all namespace objects associated with 502 * that table. Unloading of the DSDT is not allowed. 503 * Note: Mainly intended to support hotplug removal of SSDTs. 504 * 505 ******************************************************************************/ 506 507 ACPI_STATUS 508 AcpiUnloadParentTable ( 509 ACPI_HANDLE Object) 510 { 511 ACPI_NAMESPACE_NODE *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Object); 512 ACPI_STATUS Status = AE_NOT_EXIST; 513 ACPI_OWNER_ID OwnerId; 514 UINT32 i; 515 516 517 ACPI_FUNCTION_TRACE (AcpiUnloadParentTable); 518 519 520 /* Parameter validation */ 521 522 if (!Object) 523 { 524 return_ACPI_STATUS (AE_BAD_PARAMETER); 525 } 526 527 /* 528 * The node OwnerId is currently the same as the parent table ID. 529 * However, this could change in the future. 530 */ 531 OwnerId = Node->OwnerId; 532 if (!OwnerId) 533 { 534 /* OwnerId==0 means DSDT is the owner. DSDT cannot be unloaded */ 535 536 return_ACPI_STATUS (AE_TYPE); 537 } 538 539 /* Must acquire the table lock during this operation */ 540 541 Status = AcpiUtAcquireMutex (ACPI_MTX_TABLES); 542 if (ACPI_FAILURE (Status)) 543 { 544 return_ACPI_STATUS (Status); 545 } 546 547 /* Find the table in the global table list */ 548 549 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++) 550 { 551 if (OwnerId != AcpiGbl_RootTableList.Tables[i].OwnerId) 552 { 553 continue; 554 } 555 556 /* 557 * Allow unload of SSDT and OEMx tables only. Do not allow unload 558 * of the DSDT. No other types of tables should get here, since 559 * only these types can contain AML and thus are the only types 560 * that can create namespace objects. 561 */ 562 if (ACPI_COMPARE_NAME ( 563 AcpiGbl_RootTableList.Tables[i].Signature.Ascii, 564 ACPI_SIG_DSDT)) 565 { 566 Status = AE_TYPE; 567 break; 568 } 569 570 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 571 Status = AcpiTbUnloadTable (i); 572 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 573 break; 574 } 575 576 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 577 return_ACPI_STATUS (Status); 578 } 579 580 ACPI_EXPORT_SYMBOL (AcpiUnloadParentTable) 581