tbinstal.c revision 77424
1/****************************************************************************** 2 * 3 * Module Name: tbinstal - ACPI table installation and removal 4 * $Revision: 39 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 ACPI_TABLES 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 AcpiUtAcquireMutex (ACPI_MTX_TABLES); 168 169 /* Install the table into the global data structure */ 170 171 Status = AcpiTbInitTableDescriptor (TableInfo->Type, TableInfo); 172 173 DEBUG_PRINTP (ACPI_INFO, ("%s located at %p\n", 174 AcpiGbl_AcpiTableData[TableInfo->Type].Name, TableInfo->Pointer)); 175 176 AcpiUtReleaseMutex (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_PRINTP (ACPI_INFO, ("Found %4.4s\n", 245 AcpiGbl_AcpiTableData[i].Signature)); 246 break; 247 } 248 } 249 250 /* Return the table type and length via the info struct */ 251 252 TableInfo->Type = (UINT8) TableType; 253 TableInfo->Length = TableHeader->Length; 254 255 256 /* 257 * Validate checksum for _most_ tables, 258 * even the ones whose signature we don't recognize 259 */ 260 261 if (TableType != ACPI_TABLE_FACS) 262 { 263 /* But don't abort if the checksum is wrong */ 264 /* TBD: [Future] make this a configuration option? */ 265 266 AcpiTbVerifyTableChecksum (TableHeader); 267 } 268 269 /* 270 * An AE_SUPPORT means that the table was not recognized. 271 * We basically ignore this; just print a debug message 272 */ 273 274 if (Status == AE_SUPPORT) 275 { 276 DEBUG_PRINTP (ACPI_INFO, 277 ("Unsupported table %s (Type %X) was found and discarded\n", 278 AcpiGbl_AcpiTableData[TableType].Name, TableType)); 279 } 280 281 return_ACPI_STATUS (Status); 282} 283 284 285/******************************************************************************* 286 * 287 * FUNCTION: AcpiTbInitTableDescriptor 288 * 289 * PARAMETERS: TableType - The type of the table 290 * TableInfo - A table info struct 291 * 292 * RETURN: None. 293 * 294 * DESCRIPTION: Install a table into the global data structs. 295 * 296 ******************************************************************************/ 297 298ACPI_STATUS 299AcpiTbInitTableDescriptor ( 300 ACPI_TABLE_TYPE TableType, 301 ACPI_TABLE_DESC *TableInfo) 302{ 303 ACPI_TABLE_DESC *ListHead; 304 ACPI_TABLE_DESC *TableDesc; 305 306 307 FUNCTION_TRACE_U32 ("TbInitTableDescriptor", TableType); 308 309 /* 310 * Install the table into the global data structure 311 */ 312 313 ListHead = &AcpiGbl_AcpiTables[TableType]; 314 TableDesc = ListHead; 315 316 317 /* 318 * Two major types of tables: 1) Only one instance is allowed. This 319 * includes most ACPI tables such as the DSDT. 2) Multiple instances of 320 * the table are allowed. This includes SSDT and PSDTs. 321 */ 322 323 if (IS_SINGLE_TABLE (AcpiGbl_AcpiTableData[TableType].Flags)) 324 { 325 /* 326 * Only one table allowed, and a table has alread been installed 327 * at this location, so return an error. 328 */ 329 330 if (ListHead->Pointer) 331 { 332 return_ACPI_STATUS (AE_EXIST); 333 } 334 335 TableDesc->Count = 1; 336 } 337 338 339 else 340 { 341 /* 342 * Multiple tables allowed for this table type, we must link 343 * the new table in to the list of tables of this type. 344 */ 345 346 if (ListHead->Pointer) 347 { 348 TableDesc = AcpiUtCallocate (sizeof (ACPI_TABLE_DESC)); 349 if (!TableDesc) 350 { 351 return_ACPI_STATUS (AE_NO_MEMORY); 352 } 353 354 ListHead->Count++; 355 356 /* Update the original previous */ 357 358 ListHead->Prev->Next = TableDesc; 359 360 /* Update new entry */ 361 362 TableDesc->Prev = ListHead->Prev; 363 TableDesc->Next = ListHead; 364 365 /* Update list head */ 366 367 ListHead->Prev = TableDesc; 368 } 369 370 else 371 { 372 TableDesc->Count = 1; 373 } 374 } 375 376 377 /* Common initialization of the table descriptor */ 378 379 TableDesc->Pointer = TableInfo->Pointer; 380 TableDesc->BasePointer = TableInfo->BasePointer; 381 TableDesc->Length = TableInfo->Length; 382 TableDesc->Allocation = TableInfo->Allocation; 383 TableDesc->AmlPointer = (UINT8 *) (TableDesc->Pointer + 1), 384 TableDesc->AmlLength = (UINT32) (TableDesc->Length - 385 (UINT32) sizeof (ACPI_TABLE_HEADER)); 386 TableDesc->TableId = AcpiUtAllocateOwnerId (OWNER_TYPE_TABLE); 387 TableDesc->LoadedIntoNamespace = FALSE; 388 389 /* 390 * Set the appropriate global pointer (if there is one) to point to the 391 * newly installed table 392 */ 393 394 if (AcpiGbl_AcpiTableData[TableType].GlobalPtr) 395 { 396 *(AcpiGbl_AcpiTableData[TableType].GlobalPtr) = TableInfo->Pointer; 397 } 398 399 400 /* Return Data */ 401 402 TableInfo->TableId = TableDesc->TableId; 403 TableInfo->InstalledDesc = TableDesc; 404 405 return_ACPI_STATUS (AE_OK); 406} 407 408 409/******************************************************************************* 410 * 411 * FUNCTION: AcpiTbDeleteAcpiTables 412 * 413 * PARAMETERS: None. 414 * 415 * RETURN: None. 416 * 417 * DESCRIPTION: Delete all internal ACPI tables 418 * 419 ******************************************************************************/ 420 421void 422AcpiTbDeleteAcpiTables (void) 423{ 424 ACPI_TABLE_TYPE Type; 425 426 427 /* 428 * Free memory allocated for ACPI tables 429 * Memory can either be mapped or allocated 430 */ 431 432 for (Type = 0; Type < NUM_ACPI_TABLES; Type++) 433 { 434 AcpiTbDeleteAcpiTable (Type); 435 } 436 437} 438 439 440/******************************************************************************* 441 * 442 * FUNCTION: AcpiTbDeleteAcpiTable 443 * 444 * PARAMETERS: Type - The table type to be deleted 445 * 446 * RETURN: None. 447 * 448 * DESCRIPTION: Delete an internal ACPI table 449 * Locks the ACPI table mutex 450 * 451 ******************************************************************************/ 452 453void 454AcpiTbDeleteAcpiTable ( 455 ACPI_TABLE_TYPE Type) 456{ 457 FUNCTION_TRACE_U32 ("TbDeleteAcpiTable", Type); 458 459 460 if (Type > ACPI_TABLE_MAX) 461 { 462 return_VOID; 463 } 464 465 466 AcpiUtAcquireMutex (ACPI_MTX_TABLES); 467 468 /* Free the table */ 469 470 AcpiTbFreeAcpiTablesOfType (&AcpiGbl_AcpiTables[Type]); 471 472 473 /* Clear the appropriate "typed" global table pointer */ 474 475 switch (Type) 476 { 477 case ACPI_TABLE_RSDP: 478 AcpiGbl_RSDP = NULL; 479 break; 480 481 case ACPI_TABLE_DSDT: 482 AcpiGbl_DSDT = NULL; 483 break; 484 485 case ACPI_TABLE_FADT: 486 AcpiGbl_FADT = NULL; 487 break; 488 489 case ACPI_TABLE_FACS: 490 AcpiGbl_FACS = NULL; 491 break; 492 493 case ACPI_TABLE_XSDT: 494 AcpiGbl_XSDT = NULL; 495 break; 496 497 case ACPI_TABLE_SSDT: 498 case ACPI_TABLE_PSDT: 499 default: 500 break; 501 } 502 503 AcpiUtReleaseMutex (ACPI_MTX_TABLES); 504 505 return_VOID; 506} 507 508 509/******************************************************************************* 510 * 511 * FUNCTION: AcpiTbFreeAcpiTablesOfType 512 * 513 * PARAMETERS: TableInfo - A table info struct 514 * 515 * RETURN: None. 516 * 517 * DESCRIPTION: Free the memory associated with an internal ACPI table 518 * Table mutex should be locked. 519 * 520 ******************************************************************************/ 521 522void 523AcpiTbFreeAcpiTablesOfType ( 524 ACPI_TABLE_DESC *ListHead) 525{ 526 ACPI_TABLE_DESC *TableDesc; 527 UINT32 Count; 528 UINT32 i; 529 530 531 FUNCTION_TRACE_PTR ("TbFreeAcpiTablesOfType", ListHead); 532 533 534 /* Get the head of the list */ 535 536 TableDesc = ListHead; 537 Count = ListHead->Count; 538 539 /* 540 * Walk the entire list, deleting both the allocated tables 541 * and the table descriptors 542 */ 543 544 for (i = 0; i < Count; i++) 545 { 546 TableDesc = AcpiTbUninstallTable (TableDesc); 547 } 548 549 return_VOID; 550} 551 552 553/******************************************************************************* 554 * 555 * FUNCTION: AcpiTbDeleteSingleTable 556 * 557 * PARAMETERS: TableInfo - A table info struct 558 * 559 * RETURN: None. 560 * 561 * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where 562 * the table was allocated a buffer or was mapped. 563 * 564 ******************************************************************************/ 565 566void 567AcpiTbDeleteSingleTable ( 568 ACPI_TABLE_DESC *TableDesc) 569{ 570 571 if (!TableDesc) 572 { 573 return; 574 } 575 576 if (TableDesc->Pointer) 577 { 578 /* Valid table, determine type of memory allocation */ 579 580 switch (TableDesc->Allocation) 581 { 582 583 case ACPI_MEM_NOT_ALLOCATED: 584 break; 585 586 587 case ACPI_MEM_ALLOCATED: 588 589 AcpiUtFree (TableDesc->BasePointer); 590 break; 591 592 593 case ACPI_MEM_MAPPED: 594 595 AcpiOsUnmapMemory (TableDesc->BasePointer, TableDesc->Length); 596 break; 597 } 598 } 599} 600 601 602/******************************************************************************* 603 * 604 * FUNCTION: AcpiTbUninstallTable 605 * 606 * PARAMETERS: TableInfo - A table info struct 607 * 608 * RETURN: None. 609 * 610 * DESCRIPTION: Free the memory associated with an internal ACPI table that 611 * is either installed or has never been installed. 612 * Table mutex should be locked. 613 * 614 ******************************************************************************/ 615 616ACPI_TABLE_DESC * 617AcpiTbUninstallTable ( 618 ACPI_TABLE_DESC *TableDesc) 619{ 620 ACPI_TABLE_DESC *NextDesc; 621 622 623 FUNCTION_TRACE_PTR ("TbDeleteSingleTable", TableDesc); 624 625 626 if (!TableDesc) 627 { 628 return_PTR (NULL); 629 } 630 631 632 /* Unlink the descriptor */ 633 634 if (TableDesc->Prev) 635 { 636 TableDesc->Prev->Next = TableDesc->Next; 637 } 638 639 if (TableDesc->Next) 640 { 641 TableDesc->Next->Prev = TableDesc->Prev; 642 } 643 644 645 /* Free the memory allocated for the table itself */ 646 647 AcpiTbDeleteSingleTable (TableDesc); 648 649 650 /* Free the table descriptor (Don't delete the list head, tho) */ 651 652 if ((TableDesc->Prev) == (TableDesc->Next)) 653 { 654 655 NextDesc = NULL; 656 657 /* Clear the list head */ 658 659 TableDesc->Pointer = NULL; 660 TableDesc->Length = 0; 661 TableDesc->Count = 0; 662 663 } 664 665 else 666 { 667 /* Free the table descriptor */ 668 669 NextDesc = TableDesc->Next; 670 AcpiUtFree (TableDesc); 671 } 672 673 674 return_PTR (NextDesc); 675} 676 677 678