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