tbinstal.c revision 70243
1/****************************************************************************** 2 * 3 * Module Name: tbinstal - ACPI table installation and removal 4 * $Revision: 35 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118#define __TBINSTAL_C__ 119 120#include "acpi.h" 121#include "achware.h" 122#include "actables.h" 123 124 125#define _COMPONENT TABLE_MANAGER 126 MODULE_NAME ("tbinstal") 127 128 129/******************************************************************************* 130 * 131 * FUNCTION: AcpiTbInstallTable 132 * 133 * PARAMETERS: TablePtr - Input buffer pointer, optional 134 * TableInfo - Return value from AcpiTbGetTable 135 * 136 * RETURN: Status 137 * 138 * DESCRIPTION: Load and validate all tables other than the RSDT. The RSDT must 139 * already be loaded and validated. 140 * Install the table into the global data structs. 141 * 142 ******************************************************************************/ 143 144ACPI_STATUS 145AcpiTbInstallTable ( 146 ACPI_TABLE_HEADER *TablePtr, 147 ACPI_TABLE_DESC *TableInfo) 148{ 149 ACPI_STATUS Status; 150 151 FUNCTION_TRACE ("TbInstallTable"); 152 153 154 /* 155 * Check the table signature and make sure it is recognized 156 * Also checks the header checksum 157 */ 158 159 Status = AcpiTbRecognizeTable (TablePtr, TableInfo); 160 if (ACPI_FAILURE (Status)) 161 { 162 return_ACPI_STATUS (Status); 163 } 164 165 /* Lock tables while installing */ 166 167 AcpiCmAcquireMutex (ACPI_MTX_TABLES); 168 169 /* Install the table into the global data structure */ 170 171 Status = AcpiTbInitTableDescriptor (TableInfo->Type, TableInfo); 172 173 DEBUG_PRINT (ACPI_INFO, ("%s located at %p\n", 174 AcpiGbl_AcpiTableData[TableInfo->Type].Name, TableInfo->Pointer)); 175 176 AcpiCmReleaseMutex (ACPI_MTX_TABLES); 177 return_ACPI_STATUS (Status); 178} 179 180 181/******************************************************************************* 182 * 183 * FUNCTION: AcpiTbRecognizeTable 184 * 185 * PARAMETERS: TablePtr - Input buffer pointer, optional 186 * TableInfo - Return value from AcpiTbGetTable 187 * 188 * RETURN: Status 189 * 190 * DESCRIPTION: Check a table signature for a match against known table types 191 * 192 * NOTE: All table pointers are validated as follows: 193 * 1) Table pointer must point to valid physical memory 194 * 2) Signature must be 4 ASCII chars, even if we don't recognize the 195 * name 196 * 3) Table must be readable for length specified in the header 197 * 4) Table checksum must be valid (with the exception of the FACS 198 * which has no checksum for some odd reason) 199 * 200 ******************************************************************************/ 201 202ACPI_STATUS 203AcpiTbRecognizeTable ( 204 ACPI_TABLE_HEADER *TablePtr, 205 ACPI_TABLE_DESC *TableInfo) 206{ 207 ACPI_TABLE_HEADER *TableHeader; 208 ACPI_STATUS Status; 209 ACPI_TABLE_TYPE TableType = 0; 210 UINT32 i; 211 212 213 FUNCTION_TRACE ("TbRecognizeTable"); 214 215 216 /* Ensure that we have a valid table pointer */ 217 218 TableHeader = (ACPI_TABLE_HEADER *) TableInfo->Pointer; 219 if (!TableHeader) 220 { 221 return_ACPI_STATUS (AE_BAD_PARAMETER); 222 } 223 224 /* 225 * Search for a signature match among the known table types 226 * Start at index one -> Skip the RSDP 227 */ 228 229 Status = AE_SUPPORT; 230 for (i = 1; i < NUM_ACPI_TABLES; i++) 231 { 232 if (!STRNCMP (TableHeader->Signature, 233 AcpiGbl_AcpiTableData[i].Signature, 234 AcpiGbl_AcpiTableData[i].SigLength)) 235 { 236 /* 237 * Found a signature match, get the pertinent info from the 238 * TableData structure 239 */ 240 241 TableType = i; 242 Status = AcpiGbl_AcpiTableData[i].Status; 243 244 DEBUG_PRINT (ACPI_INFO, 245 ("TbRecognizeTable: Found %4.4s\n", 246 AcpiGbl_AcpiTableData[i].Signature)); 247 break; 248 } 249 } 250 251 /* Return the table type and length via the info struct */ 252 253 TableInfo->Type = (UINT8) TableType; 254 TableInfo->Length = TableHeader->Length; 255 256 257 /* 258 * Validate checksum for _most_ tables, 259 * even the ones whose signature we don't recognize 260 */ 261 262 if (TableType != ACPI_TABLE_FACS) 263 { 264 /* But don't abort if the checksum is wrong */ 265 /* TBD: [Future] make this a configuration option? */ 266 267 AcpiTbVerifyTableChecksum (TableHeader); 268 } 269 270 /* 271 * An AE_SUPPORT means that the table was not recognized. 272 * We basically ignore this; just print a debug message 273 */ 274 275 if (Status == AE_SUPPORT) 276 { 277 DEBUG_PRINT (ACPI_INFO, 278 ("Unsupported table %s (Type %X) was found and discarded\n", 279 AcpiGbl_AcpiTableData[TableType].Name, TableType)); 280 } 281 282 return_ACPI_STATUS (Status); 283} 284 285 286/******************************************************************************* 287 * 288 * FUNCTION: AcpiTbInitTableDescriptor 289 * 290 * PARAMETERS: TableType - The type of the table 291 * TableInfo - A table info struct 292 * 293 * RETURN: None. 294 * 295 * DESCRIPTION: Install a table into the global data structs. 296 * 297 ******************************************************************************/ 298 299ACPI_STATUS 300AcpiTbInitTableDescriptor ( 301 ACPI_TABLE_TYPE TableType, 302 ACPI_TABLE_DESC *TableInfo) 303{ 304 ACPI_TABLE_DESC *ListHead; 305 ACPI_TABLE_DESC *TableDesc; 306 307 308 FUNCTION_TRACE_U32 ("TbInitTableDescriptor", TableType); 309 310 /* 311 * Install the table into the global data structure 312 */ 313 314 ListHead = &AcpiGbl_AcpiTables[TableType]; 315 TableDesc = ListHead; 316 317 318 /* 319 * Two major types of tables: 1) Only one instance is allowed. This 320 * includes most ACPI tables such as the DSDT. 2) Multiple instances of 321 * the table are allowed. This includes SSDT and PSDTs. 322 */ 323 324 if (IS_SINGLE_TABLE (AcpiGbl_AcpiTableData[TableType].Flags)) 325 { 326 /* 327 * Only one table allowed, and a table has alread been installed 328 * at this location, so return an error. 329 */ 330 331 if (ListHead->Pointer) 332 { 333 return_ACPI_STATUS (AE_EXIST); 334 } 335 336 TableDesc->Count = 1; 337 } 338 339 340 else 341 { 342 /* 343 * Multiple tables allowed for this table type, we must link 344 * the new table in to the list of tables of this type. 345 */ 346 347 if (ListHead->Pointer) 348 { 349 TableDesc = AcpiCmCallocate (sizeof (ACPI_TABLE_DESC)); 350 if (!TableDesc) 351 { 352 return_ACPI_STATUS (AE_NO_MEMORY); 353 } 354 355 ListHead->Count++; 356 357 /* Update the original previous */ 358 359 ListHead->Prev->Next = TableDesc; 360 361 /* Update new entry */ 362 363 TableDesc->Prev = ListHead->Prev; 364 TableDesc->Next = ListHead; 365 366 /* Update list head */ 367 368 ListHead->Prev = TableDesc; 369 } 370 371 else 372 { 373 TableDesc->Count = 1; 374 } 375 } 376 377 378 /* Common initialization of the table descriptor */ 379 380 TableDesc->Pointer = TableInfo->Pointer; 381 TableDesc->BasePointer = TableInfo->BasePointer; 382 TableDesc->Length = TableInfo->Length; 383 TableDesc->Allocation = TableInfo->Allocation; 384 TableDesc->AmlPointer = (UINT8 *) (TableDesc->Pointer + 1), 385 TableDesc->AmlLength = (UINT32) (TableDesc->Length - 386 (UINT32) sizeof (ACPI_TABLE_HEADER)); 387 TableDesc->TableId = AcpiCmAllocateOwnerId (OWNER_TYPE_TABLE); 388 TableDesc->LoadedIntoNamespace = FALSE; 389 390 /* 391 * Set the appropriate global pointer (if there is one) to point to the 392 * newly installed table 393 */ 394 395 if (AcpiGbl_AcpiTableData[TableType].GlobalPtr) 396 { 397 *(AcpiGbl_AcpiTableData[TableType].GlobalPtr) = TableInfo->Pointer; 398 } 399 400 401 /* Return Data */ 402 403 TableInfo->TableId = TableDesc->TableId; 404 TableInfo->InstalledDesc = TableDesc; 405 406 return_ACPI_STATUS (AE_OK); 407} 408 409 410/******************************************************************************* 411 * 412 * FUNCTION: AcpiTbDeleteAcpiTables 413 * 414 * PARAMETERS: None. 415 * 416 * RETURN: None. 417 * 418 * DESCRIPTION: Delete all internal ACPI tables 419 * 420 ******************************************************************************/ 421 422void 423AcpiTbDeleteAcpiTables (void) 424{ 425 ACPI_TABLE_TYPE Type; 426 427 428 /* 429 * Free memory allocated for ACPI tables 430 * Memory can either be mapped or allocated 431 */ 432 433 for (Type = 0; Type < NUM_ACPI_TABLES; Type++) 434 { 435 AcpiTbDeleteAcpiTable (Type); 436 } 437 438} 439 440 441/******************************************************************************* 442 * 443 * FUNCTION: AcpiTbDeleteAcpiTable 444 * 445 * PARAMETERS: Type - The table type to be deleted 446 * 447 * RETURN: None. 448 * 449 * DESCRIPTION: Delete an internal ACPI table 450 * Locks the ACPI table mutex 451 * 452 ******************************************************************************/ 453 454void 455AcpiTbDeleteAcpiTable ( 456 ACPI_TABLE_TYPE Type) 457{ 458 FUNCTION_TRACE_U32 ("TbDeleteAcpiTable", Type); 459 460 461 if (Type > ACPI_TABLE_MAX) 462 { 463 return_VOID; 464 } 465 466 467 AcpiCmAcquireMutex (ACPI_MTX_TABLES); 468 469 /* Free the table */ 470 471 AcpiTbFreeAcpiTablesOfType (&AcpiGbl_AcpiTables[Type]); 472 473 474 /* Clear the appropriate "typed" global table pointer */ 475 476 switch (Type) 477 { 478 case ACPI_TABLE_RSDP: 479 AcpiGbl_RSDP = NULL; 480 break; 481 482 case ACPI_TABLE_DSDT: 483 AcpiGbl_DSDT = NULL; 484 break; 485 486 case ACPI_TABLE_FADT: 487 AcpiGbl_FADT = NULL; 488 break; 489 490 case ACPI_TABLE_FACS: 491 AcpiGbl_FACS = NULL; 492 break; 493 494 case ACPI_TABLE_XSDT: 495 AcpiGbl_XSDT = NULL; 496 break; 497 498 case ACPI_TABLE_SSDT: 499 case ACPI_TABLE_PSDT: 500 default: 501 break; 502 } 503 504 AcpiCmReleaseMutex (ACPI_MTX_TABLES); 505 506 return_VOID; 507} 508 509 510/******************************************************************************* 511 * 512 * FUNCTION: AcpiTbFreeAcpiTablesOfType 513 * 514 * PARAMETERS: TableInfo - A table info struct 515 * 516 * RETURN: None. 517 * 518 * DESCRIPTION: Free the memory associated with an internal ACPI table 519 * Table mutex should be locked. 520 * 521 ******************************************************************************/ 522 523void 524AcpiTbFreeAcpiTablesOfType ( 525 ACPI_TABLE_DESC *ListHead) 526{ 527 ACPI_TABLE_DESC *TableDesc; 528 UINT32 Count; 529 UINT32 i; 530 531 532 FUNCTION_TRACE_PTR ("TbFreeAcpiTablesOfType", ListHead); 533 534 535 /* Get the head of the list */ 536 537 TableDesc = ListHead; 538 Count = ListHead->Count; 539 540 /* 541 * Walk the entire list, deleting both the allocated tables 542 * and the table descriptors 543 */ 544 545 for (i = 0; i < Count; i++) 546 { 547 TableDesc = AcpiTbUninstallTable (TableDesc); 548 } 549 550 return_VOID; 551} 552 553 554/******************************************************************************* 555 * 556 * FUNCTION: AcpiTbDeleteSingleTable 557 * 558 * PARAMETERS: TableInfo - A table info struct 559 * 560 * RETURN: None. 561 * 562 * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where 563 * the table was allocated a buffer or was mapped. 564 * 565 ******************************************************************************/ 566 567void 568AcpiTbDeleteSingleTable ( 569 ACPI_TABLE_DESC *TableDesc) 570{ 571 572 if (!TableDesc) 573 { 574 return; 575 } 576 577 if (TableDesc->Pointer) 578 { 579 /* Valid table, determine type of memory allocation */ 580 581 switch (TableDesc->Allocation) 582 { 583 584 case ACPI_MEM_NOT_ALLOCATED: 585 break; 586 587 588 case ACPI_MEM_ALLOCATED: 589 590 AcpiCmFree (TableDesc->BasePointer); 591 break; 592 593 594 case ACPI_MEM_MAPPED: 595 596 AcpiOsUnmapMemory (TableDesc->BasePointer, TableDesc->Length); 597 break; 598 } 599 } 600} 601 602 603/******************************************************************************* 604 * 605 * FUNCTION: AcpiTbUninstallTable 606 * 607 * PARAMETERS: TableInfo - A table info struct 608 * 609 * RETURN: None. 610 * 611 * DESCRIPTION: Free the memory associated with an internal ACPI table that 612 * is either installed or has never been installed. 613 * Table mutex should be locked. 614 * 615 ******************************************************************************/ 616 617ACPI_TABLE_DESC * 618AcpiTbUninstallTable ( 619 ACPI_TABLE_DESC *TableDesc) 620{ 621 ACPI_TABLE_DESC *NextDesc; 622 623 624 FUNCTION_TRACE_PTR ("TbDeleteSingleTable", TableDesc); 625 626 627 if (!TableDesc) 628 { 629 return_PTR (NULL); 630 } 631 632 633 /* Unlink the descriptor */ 634 635 if (TableDesc->Prev) 636 { 637 TableDesc->Prev->Next = TableDesc->Next; 638 } 639 640 if (TableDesc->Next) 641 { 642 TableDesc->Next->Prev = TableDesc->Prev; 643 } 644 645 646 /* Free the memory allocated for the table itself */ 647 648 AcpiTbDeleteSingleTable (TableDesc); 649 650 651 /* Free the table descriptor (Don't delete the list head, tho) */ 652 653 if ((TableDesc->Prev) == (TableDesc->Next)) 654 { 655 656 NextDesc = NULL; 657 658 /* Clear the list head */ 659 660 TableDesc->Pointer = NULL; 661 TableDesc->Length = 0; 662 TableDesc->Count = 0; 663 664 } 665 666 else 667 { 668 /* Free the table descriptor */ 669 670 NextDesc = TableDesc->Next; 671 AcpiCmFree (TableDesc); 672 } 673 674 675 return_PTR (NextDesc); 676} 677 678 679