1 /****************************************************************************** 2 * 3 * Module Name: tbxface - Public interfaces to the ACPI subsystem 4 * ACPI table oriented interfaces 5 * $Revision: 1.79 $ 6 * 7 *****************************************************************************/ 8 9 /****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118 #define __TBXFACE_C__ 119 120 #include "acpi.h" 121 #include "acnamesp.h" 122 #include "actables.h" 123 124 125 #define _COMPONENT ACPI_TABLES 126 ACPI_MODULE_NAME ("tbxface") 127 128 129 /******************************************************************************* 130 * 131 * FUNCTION: AcpiLoadTables 132 * 133 * PARAMETERS: None 134 * 135 * RETURN: Status 136 * 137 * DESCRIPTION: This function is called to load the ACPI tables from the 138 * provided RSDT 139 * 140 ******************************************************************************/ 141 142 ACPI_STATUS 143 AcpiLoadTables ( 144 void) 145 { 146 ACPI_POINTER RsdpAddress; 147 ACPI_STATUS Status; 148 149 150 ACPI_FUNCTION_TRACE (AcpiLoadTables); 151 152 153 /* Get the RSDP */ 154 155 Status = AcpiOsGetRootPointer (ACPI_LOGICAL_ADDRESSING, 156 &RsdpAddress); 157 if (ACPI_FAILURE (Status)) 158 { 159 ACPI_EXCEPTION ((AE_INFO, Status, "Could not get the RSDP")); 160 goto ErrorExit; 161 } 162 163 /* Map and validate the RSDP */ 164 165 AcpiGbl_TableFlags = RsdpAddress.PointerType; 166 167 Status = AcpiTbVerifyRsdp (&RsdpAddress); 168 if (ACPI_FAILURE (Status)) 169 { 170 ACPI_EXCEPTION ((AE_INFO, Status, "During RSDP validation")); 171 goto ErrorExit; 172 } 173 174 /* Get the RSDT via the RSDP */ 175 176 Status = AcpiTbGetTableRsdt (); 177 if (ACPI_FAILURE (Status)) 178 { 179 ACPI_EXCEPTION ((AE_INFO, Status, "Could not load RSDT")); 180 goto ErrorExit; 181 } 182 183 /* Now get the tables needed by this subsystem (FADT, DSDT, etc.) */ 184 185 Status = AcpiTbGetRequiredTables (); 186 if (ACPI_FAILURE (Status)) 187 { 188 ACPI_EXCEPTION ((AE_INFO, Status, 189 "Could not get all required tables (DSDT/FADT/FACS)")); 190 goto ErrorExit; 191 } 192 193 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI Tables successfully acquired\n")); 194 195 /* Load the namespace from the tables */ 196 197 Status = AcpiNsLoadNamespace (); 198 if (ACPI_FAILURE (Status)) 199 { 200 ACPI_EXCEPTION ((AE_INFO, Status, "Could not load namespace")); 201 goto ErrorExit; 202 } 203 204 return_ACPI_STATUS (AE_OK); 205 206 207 ErrorExit: 208 ACPI_EXCEPTION ((AE_INFO, Status, "Could not load tables")); 209 return_ACPI_STATUS (Status); 210 } 211 212 ACPI_EXPORT_SYMBOL (AcpiLoadTables) 213 214 215 /******************************************************************************* 216 * 217 * FUNCTION: AcpiLoadTable 218 * 219 * PARAMETERS: TablePtr - pointer to a buffer containing the entire 220 * table to be loaded 221 * 222 * RETURN: Status 223 * 224 * DESCRIPTION: This function is called to load a table from the caller's 225 * buffer. The buffer must contain an entire ACPI Table including 226 * a valid header. The header fields will be verified, and if it 227 * is determined that the table is invalid, the call will fail. 228 * 229 ******************************************************************************/ 230 231 ACPI_STATUS 232 AcpiLoadTable ( 233 ACPI_TABLE_HEADER *TablePtr) 234 { 235 ACPI_STATUS Status; 236 ACPI_TABLE_DESC TableInfo; 237 ACPI_POINTER Address; 238 239 240 ACPI_FUNCTION_TRACE (AcpiLoadTable); 241 242 243 if (!TablePtr) 244 { 245 return_ACPI_STATUS (AE_BAD_PARAMETER); 246 } 247 248 /* Copy the table to a local buffer */ 249 250 Address.PointerType = ACPI_LOGICAL_POINTER | ACPI_LOGICAL_ADDRESSING; 251 Address.Pointer.Logical = TablePtr; 252 253 Status = AcpiTbGetTableBody (&Address, TablePtr, &TableInfo); 254 if (ACPI_FAILURE (Status)) 255 { 256 return_ACPI_STATUS (Status); 257 } 258 259 /* Check signature for a valid table type */ 260 261 Status = AcpiTbRecognizeTable (&TableInfo, ACPI_TABLE_ALL); 262 if (ACPI_FAILURE (Status)) 263 { 264 return_ACPI_STATUS (Status); 265 } 266 267 /* Install the new table into the local data structures */ 268 269 Status = AcpiTbInstallTable (&TableInfo); 270 if (ACPI_FAILURE (Status)) 271 { 272 if (Status == AE_ALREADY_EXISTS) 273 { 274 /* Table already exists, no error */ 275 276 Status = AE_OK; 277 } 278 279 /* Free table allocated by AcpiTbGetTableBody */ 280 281 AcpiTbDeleteSingleTable (&TableInfo); 282 return_ACPI_STATUS (Status); 283 } 284 285 /* Convert the table to common format if necessary */ 286 287 switch (TableInfo.Type) 288 { 289 case ACPI_TABLE_ID_FADT: 290 291 Status = AcpiTbConvertTableFadt (); 292 break; 293 294 case ACPI_TABLE_ID_FACS: 295 296 Status = AcpiTbBuildCommonFacs (&TableInfo); 297 break; 298 299 default: 300 /* Load table into namespace if it contains executable AML */ 301 302 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode); 303 break; 304 } 305 306 if (ACPI_FAILURE (Status)) 307 { 308 /* Uninstall table and free the buffer */ 309 310 (void) AcpiTbUninstallTable (TableInfo.InstalledDesc); 311 } 312 313 return_ACPI_STATUS (Status); 314 } 315 316 ACPI_EXPORT_SYMBOL (AcpiLoadTable) 317 318 319 /******************************************************************************* 320 * 321 * FUNCTION: AcpiUnloadTable 322 * 323 * PARAMETERS: TableType - Type of table to be unloaded 324 * 325 * RETURN: Status 326 * 327 * DESCRIPTION: This routine is used to force the unload of a table 328 * 329 ******************************************************************************/ 330 331 ACPI_STATUS 332 AcpiUnloadTable ( 333 ACPI_TABLE_TYPE TableType) 334 { 335 ACPI_TABLE_DESC *TableDesc; 336 337 338 ACPI_FUNCTION_TRACE (AcpiUnloadTable); 339 340 341 /* Parameter validation */ 342 343 if (TableType > ACPI_TABLE_ID_MAX) 344 { 345 return_ACPI_STATUS (AE_BAD_PARAMETER); 346 } 347 348 /* Find all tables of the requested type */ 349 350 TableDesc = AcpiGbl_TableLists[TableType].Next; 351 if (!TableDesc) 352 { 353 return_ACPI_STATUS (AE_NOT_EXIST); 354 } 355 356 while (TableDesc) 357 { 358 /* 359 * Delete all namespace objects owned by this table. Note that these 360 * objects can appear anywhere in the namespace by virtue of the AML 361 * "Scope" operator. Thus, we need to track ownership by an ID, not 362 * simply a position within the hierarchy 363 */ 364 AcpiNsDeleteNamespaceByOwner (TableDesc->OwnerId); 365 TableDesc = TableDesc->Next; 366 } 367 368 /* Delete (or unmap) all tables of this type */ 369 370 AcpiTbDeleteTablesByType (TableType); 371 return_ACPI_STATUS (AE_OK); 372 } 373 374 ACPI_EXPORT_SYMBOL (AcpiUnloadTable) 375 376 377 /******************************************************************************* 378 * 379 * FUNCTION: AcpiGetTableHeader 380 * 381 * PARAMETERS: TableType - one of the defined table types 382 * Instance - the non zero instance of the table, allows 383 * support for multiple tables of the same type 384 * see AcpiGbl_AcpiTableFlag 385 * OutTableHeader - pointer to the ACPI_TABLE_HEADER if successful 386 * 387 * DESCRIPTION: This function is called to get an ACPI table header. The caller 388 * supplies an pointer to a data area sufficient to contain an ACPI 389 * ACPI_TABLE_HEADER structure. 390 * 391 * The header contains a length field that can be used to determine 392 * the size of the buffer needed to contain the entire table. This 393 * function is not valid for the RSD PTR table since it does not 394 * have a standard header and is fixed length. 395 * 396 ******************************************************************************/ 397 398 ACPI_STATUS 399 AcpiGetTableHeader ( 400 ACPI_TABLE_TYPE TableType, 401 UINT32 Instance, 402 ACPI_TABLE_HEADER *OutTableHeader) 403 { 404 ACPI_TABLE_HEADER *TblPtr; 405 ACPI_STATUS Status; 406 407 408 ACPI_FUNCTION_TRACE (AcpiGetTableHeader); 409 410 411 if ((Instance == 0) || 412 (TableType == ACPI_TABLE_ID_RSDP) || 413 (!OutTableHeader)) 414 { 415 return_ACPI_STATUS (AE_BAD_PARAMETER); 416 } 417 418 /* Check the table type and instance */ 419 420 if ((TableType > ACPI_TABLE_ID_MAX) || 421 (ACPI_IS_SINGLE_TABLE (AcpiGbl_TableData[TableType].Flags) && 422 Instance > 1)) 423 { 424 return_ACPI_STATUS (AE_BAD_PARAMETER); 425 } 426 427 /* Get a pointer to the entire table */ 428 429 Status = AcpiTbGetTablePtr (TableType, Instance, &TblPtr); 430 if (ACPI_FAILURE (Status)) 431 { 432 return_ACPI_STATUS (Status); 433 } 434 435 /* The function will return a NULL pointer if the table is not loaded */ 436 437 if (TblPtr == NULL) 438 { 439 return_ACPI_STATUS (AE_NOT_EXIST); 440 } 441 442 /* Copy the header to the caller's buffer */ 443 444 ACPI_MEMCPY (ACPI_CAST_PTR (void, OutTableHeader), 445 ACPI_CAST_PTR (void, TblPtr), sizeof (ACPI_TABLE_HEADER)); 446 447 return_ACPI_STATUS (Status); 448 } 449 450 ACPI_EXPORT_SYMBOL (AcpiGetTableHeader) 451 452 453 /******************************************************************************* 454 * 455 * FUNCTION: AcpiGetTable 456 * 457 * PARAMETERS: TableType - one of the defined table types 458 * Instance - the non zero instance of the table, allows 459 * support for multiple tables of the same type 460 * see AcpiGbl_AcpiTableFlag 461 * RetBuffer - pointer to a structure containing a buffer to 462 * receive the table 463 * 464 * RETURN: Status 465 * 466 * DESCRIPTION: This function is called to get an ACPI table. The caller 467 * supplies an OutBuffer large enough to contain the entire ACPI 468 * table. The caller should call the AcpiGetTableHeader function 469 * first to determine the buffer size needed. Upon completion 470 * the OutBuffer->Length field will indicate the number of bytes 471 * copied into the OutBuffer->BufPtr buffer. This table will be 472 * a complete table including the header. 473 * 474 ******************************************************************************/ 475 476 ACPI_STATUS 477 AcpiGetTable ( 478 ACPI_TABLE_TYPE TableType, 479 UINT32 Instance, 480 ACPI_BUFFER *RetBuffer) 481 { 482 ACPI_TABLE_HEADER *TblPtr; 483 ACPI_STATUS Status; 484 ACPI_SIZE TableLength; 485 486 487 ACPI_FUNCTION_TRACE (AcpiGetTable); 488 489 490 /* Parameter validation */ 491 492 if (Instance == 0) 493 { 494 return_ACPI_STATUS (AE_BAD_PARAMETER); 495 } 496 497 Status = AcpiUtValidateBuffer (RetBuffer); 498 if (ACPI_FAILURE (Status)) 499 { 500 return_ACPI_STATUS (Status); 501 } 502 503 /* Check the table type and instance */ 504 505 if ((TableType > ACPI_TABLE_ID_MAX) || 506 (ACPI_IS_SINGLE_TABLE (AcpiGbl_TableData[TableType].Flags) && 507 Instance > 1)) 508 { 509 return_ACPI_STATUS (AE_BAD_PARAMETER); 510 } 511 512 /* Get a pointer to the entire table */ 513 514 Status = AcpiTbGetTablePtr (TableType, Instance, &TblPtr); 515 if (ACPI_FAILURE (Status)) 516 { 517 return_ACPI_STATUS (Status); 518 } 519 520 /* 521 * AcpiTbGetTablePtr will return a NULL pointer if the 522 * table is not loaded. 523 */ 524 if (TblPtr == NULL) 525 { 526 return_ACPI_STATUS (AE_NOT_EXIST); 527 } 528 529 /* Get the table length */ 530 531 if (TableType == ACPI_TABLE_ID_RSDP) 532 { 533 /* RSD PTR is the only "table" without a header */ 534 535 TableLength = sizeof (RSDP_DESCRIPTOR); 536 } 537 else 538 { 539 TableLength = (ACPI_SIZE) TblPtr->Length; 540 } 541 542 /* Validate/Allocate/Clear caller buffer */ 543 544 Status = AcpiUtInitializeBuffer (RetBuffer, TableLength); 545 if (ACPI_FAILURE (Status)) 546 { 547 return_ACPI_STATUS (Status); 548 } 549 550 /* Copy the table to the buffer */ 551 552 ACPI_MEMCPY (ACPI_CAST_PTR (void, RetBuffer->Pointer), 553 ACPI_CAST_PTR (void, TblPtr), TableLength); 554 555 return_ACPI_STATUS (AE_OK); 556 } 557 558 ACPI_EXPORT_SYMBOL (AcpiGetTable) 559 560 561