tbxface.c revision 99146
1/****************************************************************************** 2 * 3 * Module Name: tbxface - Public interfaces to the ACPI subsystem 4 * ACPI table oriented interfaces 5 * $Revision: 52 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, 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 "acinterp.h" 123#include "actables.h" 124 125 126#define _COMPONENT ACPI_TABLES 127 ACPI_MODULE_NAME ("tbxface") 128 129 130/******************************************************************************* 131 * 132 * FUNCTION: AcpiLoadTables 133 * 134 * PARAMETERS: None 135 * 136 * RETURN: Status 137 * 138 * DESCRIPTION: This function is called to load the ACPI tables from the 139 * provided RSDT 140 * 141 ******************************************************************************/ 142 143ACPI_STATUS 144AcpiLoadTables (void) 145{ 146 ACPI_POINTER RsdpAddress; 147 ACPI_STATUS Status; 148 UINT32 NumberOfTables = 0; 149 150 151 ACPI_FUNCTION_TRACE ("AcpiLoadTables"); 152 153 154 /* Get the RSDP */ 155 156 Status = AcpiOsGetRootPointer (ACPI_LOGICAL_ADDRESSING, 157 &RsdpAddress); 158 if (ACPI_FAILURE (Status)) 159 { 160 ACPI_REPORT_ERROR (("AcpiLoadTables: Could not get RSDP, %s\n", 161 AcpiFormatException (Status))); 162 goto ErrorExit; 163 } 164 165 /* Map and validate the RSDP */ 166 167 AcpiGbl_TableFlags = RsdpAddress.PointerType; 168 169 Status = AcpiTbVerifyRsdp (&RsdpAddress); 170 if (ACPI_FAILURE (Status)) 171 { 172 ACPI_REPORT_ERROR (("AcpiLoadTables: RSDP Failed validation: %s\n", 173 AcpiFormatException (Status))); 174 goto ErrorExit; 175 } 176 177 /* Get the RSDT via the RSDP */ 178 179 Status = AcpiTbGetTableRsdt (&NumberOfTables); 180 if (ACPI_FAILURE (Status)) 181 { 182 ACPI_REPORT_ERROR (("AcpiLoadTables: Could not load RSDT: %s\n", 183 AcpiFormatException (Status))); 184 goto ErrorExit; 185 } 186 187 /* Now get the rest of the tables */ 188 189 Status = AcpiTbGetAllTables (NumberOfTables, NULL); 190 if (ACPI_FAILURE (Status)) 191 { 192 ACPI_REPORT_ERROR (("AcpiLoadTables: Error getting required tables (DSDT/FADT/FACS): %s\n", 193 AcpiFormatException (Status))); 194 goto ErrorExit; 195 } 196 197 ACPI_DEBUG_PRINT ((ACPI_DB_OK, "ACPI Tables successfully loaded\n")); 198 199 200 /* Load the namespace from the tables */ 201 202 Status = AcpiNsLoadNamespace (); 203 if (ACPI_FAILURE (Status)) 204 { 205 ACPI_REPORT_ERROR (("AcpiLoadTables: Could not load namespace: %s\n", 206 AcpiFormatException (Status))); 207 goto ErrorExit; 208 } 209 210 return_ACPI_STATUS (AE_OK); 211 212 213ErrorExit: 214 ACPI_REPORT_ERROR (("AcpiLoadTables: Could not load tables: %s\n", 215 AcpiFormatException (Status))); 216 217 return_ACPI_STATUS (Status); 218} 219 220 221/******************************************************************************* 222 * 223 * FUNCTION: AcpiLoadTable 224 * 225 * PARAMETERS: TablePtr - pointer to a buffer containing the entire 226 * table to be loaded 227 * 228 * RETURN: Status 229 * 230 * DESCRIPTION: This function is called to load a table from the caller's 231 * buffer. The buffer must contain an entire ACPI Table including 232 * a valid header. The header fields will be verified, and if it 233 * is determined that the table is invalid, the call will fail. 234 * 235 ******************************************************************************/ 236 237ACPI_STATUS 238AcpiLoadTable ( 239 ACPI_TABLE_HEADER *TablePtr) 240{ 241 ACPI_STATUS Status; 242 ACPI_TABLE_DESC TableInfo; 243 ACPI_POINTER Address; 244 245 246 ACPI_FUNCTION_TRACE ("AcpiLoadTable"); 247 248 249 if (!TablePtr) 250 { 251 return_ACPI_STATUS (AE_BAD_PARAMETER); 252 } 253 254 /* Copy the table to a local buffer */ 255 256 Address.PointerType = ACPI_LOGICAL_POINTER; 257 Address.Pointer.Logical = TablePtr; 258 259 Status = AcpiTbGetTable (&Address, &TableInfo); 260 if (ACPI_FAILURE (Status)) 261 { 262 return_ACPI_STATUS (Status); 263 } 264 265 /* Install the new table into the local data structures */ 266 267 Status = AcpiTbInstallTable (NULL, &TableInfo); 268 if (ACPI_FAILURE (Status)) 269 { 270 /* Free table allocated by AcpiTbGetTable */ 271 272 AcpiTbDeleteSingleTable (&TableInfo); 273 return_ACPI_STATUS (Status); 274 } 275 276 /* Convert the table to common format if necessary */ 277 278 switch (TableInfo.Type) 279 { 280 case ACPI_TABLE_FADT: 281 282 Status = AcpiTbConvertTableFadt (); 283 break; 284 285 case ACPI_TABLE_FACS: 286 287 Status = AcpiTbBuildCommonFacs (&TableInfo); 288 break; 289 290 default: 291 /* Load table into namespace if it contains executable AML */ 292 293 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode); 294 break; 295 } 296 297 if (ACPI_FAILURE (Status)) 298 { 299 /* Uninstall table and free the buffer */ 300 301 AcpiTbUninstallTable (TableInfo.InstalledDesc); 302 } 303 304 return_ACPI_STATUS (Status); 305} 306 307 308/******************************************************************************* 309 * 310 * FUNCTION: AcpiUnloadTable 311 * 312 * PARAMETERS: TableType - Type of table to be unloaded 313 * 314 * RETURN: Status 315 * 316 * DESCRIPTION: This routine is used to force the unload of a table 317 * 318 ******************************************************************************/ 319 320ACPI_STATUS 321AcpiUnloadTable ( 322 ACPI_TABLE_TYPE TableType) 323{ 324 ACPI_TABLE_DESC *ListHead; 325 326 327 ACPI_FUNCTION_TRACE ("AcpiUnloadTable"); 328 329 330 /* Parameter validation */ 331 332 if (TableType > ACPI_TABLE_MAX) 333 { 334 return_ACPI_STATUS (AE_BAD_PARAMETER); 335 } 336 337 338 /* Find all tables of the requested type */ 339 340 ListHead = &AcpiGbl_AcpiTables[TableType]; 341 do 342 { 343 /* 344 * Delete all namespace entries owned by this table. Note that these 345 * entries can appear anywhere in the namespace by virtue of the AML 346 * "Scope" operator. Thus, we need to track ownership by an ID, not 347 * simply a position within the hierarchy 348 */ 349 AcpiNsDeleteNamespaceByOwner (ListHead->TableId); 350 351 /* Delete (or unmap) the actual table */ 352 353 AcpiTbDeleteAcpiTable (TableType); 354 355 } while (ListHead != &AcpiGbl_AcpiTables[TableType]); 356 357 return_ACPI_STATUS (AE_OK); 358} 359 360 361/******************************************************************************* 362 * 363 * FUNCTION: AcpiGetTableHeader 364 * 365 * PARAMETERS: TableType - one of the defined table types 366 * Instance - the non zero instance of the table, allows 367 * support for multiple tables of the same type 368 * see AcpiGbl_AcpiTableFlag 369 * OutTableHeader - pointer to the ACPI_TABLE_HEADER if successful 370 * 371 * DESCRIPTION: This function is called to get an ACPI table header. The caller 372 * supplies an pointer to a data area sufficient to contain an ACPI 373 * ACPI_TABLE_HEADER structure. 374 * 375 * The header contains a length field that can be used to determine 376 * the size of the buffer needed to contain the entire table. This 377 * function is not valid for the RSD PTR table since it does not 378 * have a standard header and is fixed length. 379 * 380 ******************************************************************************/ 381 382ACPI_STATUS 383AcpiGetTableHeader ( 384 ACPI_TABLE_TYPE TableType, 385 UINT32 Instance, 386 ACPI_TABLE_HEADER *OutTableHeader) 387{ 388 ACPI_TABLE_HEADER *TblPtr; 389 ACPI_STATUS Status; 390 391 392 ACPI_FUNCTION_TRACE ("AcpiGetTableHeader"); 393 394 395 if ((Instance == 0) || 396 (TableType == ACPI_TABLE_RSDP) || 397 (!OutTableHeader)) 398 { 399 return_ACPI_STATUS (AE_BAD_PARAMETER); 400 } 401 402 /* Check the table type and instance */ 403 404 if ((TableType > ACPI_TABLE_MAX) || 405 (ACPI_IS_SINGLE_TABLE (AcpiGbl_AcpiTableData[TableType].Flags) && 406 Instance > 1)) 407 { 408 return_ACPI_STATUS (AE_BAD_PARAMETER); 409 } 410 411 412 /* Get a pointer to the entire table */ 413 414 Status = AcpiTbGetTablePtr (TableType, Instance, &TblPtr); 415 if (ACPI_FAILURE (Status)) 416 { 417 return_ACPI_STATUS (Status); 418 } 419 420 /* 421 * The function will return a NULL pointer if the table is not loaded 422 */ 423 if (TblPtr == NULL) 424 { 425 return_ACPI_STATUS (AE_NOT_EXIST); 426 } 427 428 /* 429 * Copy the header to the caller's buffer 430 */ 431 ACPI_MEMCPY ((void *) OutTableHeader, (void *) TblPtr, 432 sizeof (ACPI_TABLE_HEADER)); 433 434 return_ACPI_STATUS (Status); 435} 436 437 438/******************************************************************************* 439 * 440 * FUNCTION: AcpiGetTable 441 * 442 * PARAMETERS: TableType - one of the defined table types 443 * Instance - the non zero instance of the table, allows 444 * support for multiple tables of the same type 445 * see AcpiGbl_AcpiTableFlag 446 * RetBuffer - pointer to a structure containing a buffer to 447 * receive the table 448 * 449 * RETURN: Status 450 * 451 * DESCRIPTION: This function is called to get an ACPI table. The caller 452 * supplies an OutBuffer large enough to contain the entire ACPI 453 * table. The caller should call the AcpiGetTableHeader function 454 * first to determine the buffer size needed. Upon completion 455 * the OutBuffer->Length field will indicate the number of bytes 456 * copied into the OutBuffer->BufPtr buffer. This table will be 457 * a complete table including the header. 458 * 459 ******************************************************************************/ 460 461ACPI_STATUS 462AcpiGetTable ( 463 ACPI_TABLE_TYPE TableType, 464 UINT32 Instance, 465 ACPI_BUFFER *RetBuffer) 466{ 467 ACPI_TABLE_HEADER *TblPtr; 468 ACPI_STATUS Status; 469 UINT32 TableLength; 470 471 472 ACPI_FUNCTION_TRACE ("AcpiGetTable"); 473 474 475 /* Parameter validation */ 476 477 if (Instance == 0) 478 { 479 return_ACPI_STATUS (AE_BAD_PARAMETER); 480 } 481 482 Status = AcpiUtValidateBuffer (RetBuffer); 483 if (ACPI_FAILURE (Status)) 484 { 485 return_ACPI_STATUS (Status); 486 } 487 488 /* Check the table type and instance */ 489 490 if ((TableType > ACPI_TABLE_MAX) || 491 (ACPI_IS_SINGLE_TABLE (AcpiGbl_AcpiTableData[TableType].Flags) && 492 Instance > 1)) 493 { 494 return_ACPI_STATUS (AE_BAD_PARAMETER); 495 } 496 497 498 /* Get a pointer to the entire table */ 499 500 Status = AcpiTbGetTablePtr (TableType, Instance, &TblPtr); 501 if (ACPI_FAILURE (Status)) 502 { 503 return_ACPI_STATUS (Status); 504 } 505 506 /* 507 * AcpiTbGetTablePtr will return a NULL pointer if the 508 * table is not loaded. 509 */ 510 if (TblPtr == NULL) 511 { 512 return_ACPI_STATUS (AE_NOT_EXIST); 513 } 514 515 /* Get the table length */ 516 517 if (TableType == ACPI_TABLE_RSDP) 518 { 519 /* 520 * RSD PTR is the only "table" without a header 521 */ 522 TableLength = sizeof (RSDP_DESCRIPTOR); 523 } 524 else 525 { 526 TableLength = TblPtr->Length; 527 } 528 529 /* Validate/Allocate/Clear caller buffer */ 530 531 Status = AcpiUtInitializeBuffer (RetBuffer, TableLength); 532 if (ACPI_FAILURE (Status)) 533 { 534 return_ACPI_STATUS (Status); 535 } 536 537 /* Copy the table to the buffer */ 538 539 ACPI_MEMCPY ((void *) RetBuffer->Pointer, (void *) TblPtr, TableLength); 540 return_ACPI_STATUS (AE_OK); 541} 542 543 544