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