sys/contrib/dev/acpica/tbxface.c

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