sys/contrib/dev/acpica/tbgetall.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbgetall - Get all required ACPI tables
   4  *              $Revision: 1.13 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #define __TBGETALL_C__
 118
 119 #include <contrib/dev/acpica/acpi.h>
 120 #include <contrib/dev/acpica/actables.h>
 121
 122
 123 #define _COMPONENT          ACPI_TABLES
 124         ACPI_MODULE_NAME    ("tbgetall")
 125
 126 /* Local prototypes */
 127
 128 static ACPI_STATUS
 129 AcpiTbGetPrimaryTable (
 130     ACPI_POINTER            *Address,
 131     ACPI_TABLE_DESC         *TableInfo);
 132
 133 static ACPI_STATUS
 134 AcpiTbGetSecondaryTable (
 135     ACPI_POINTER            *Address,
 136     ACPI_STRING             Signature,
 137     ACPI_TABLE_DESC         *TableInfo);
 138
 139
 140 /*******************************************************************************
 141  *
 142  * FUNCTION:    AcpiTbGetPrimaryTable
 143  *
 144  * PARAMETERS:  Address             - Physical address of table to retrieve
 145  *              *TableInfo          - Where the table info is returned
 146  *
 147  * RETURN:      Status
 148  *
 149  * DESCRIPTION: Maps the physical address of table into a logical address
 150  *
 151  ******************************************************************************/
 152
 153 static ACPI_STATUS
 154 AcpiTbGetPrimaryTable (
 155     ACPI_POINTER            *Address,
 156     ACPI_TABLE_DESC         *TableInfo)
 157 {
 158     ACPI_STATUS             Status;
 159     ACPI_TABLE_HEADER       Header;
 160
 161
 162     ACPI_FUNCTION_TRACE ("TbGetPrimaryTable");
 163
 164
 165     /* Ignore a NULL address in the RSDT */
 166
 167     if (!Address->Pointer.Value)
 168     {
 169         return_ACPI_STATUS (AE_OK);
 170     }
 171
 172     /* Get the header in order to get signature and table size */
 173
 174     Status = AcpiTbGetTableHeader (Address, &Header);
 175     if (ACPI_FAILURE (Status))
 176     {
 177         return_ACPI_STATUS (Status);
 178     }
 179
 180     /* Clear the TableInfo */
 181
 182     ACPI_MEMSET (TableInfo, 0, sizeof (ACPI_TABLE_DESC));
 183
 184     /*
 185      * Check the table signature and make sure it is recognized.
 186      * Also checks the header checksum
 187      */
 188     TableInfo->Pointer = &Header;
 189     Status = AcpiTbRecognizeTable (TableInfo, ACPI_TABLE_PRIMARY);
 190     if (ACPI_FAILURE (Status))
 191     {
 192         return_ACPI_STATUS (Status);
 193     }
 194
 195     /* Get the entire table */
 196
 197     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
 198     if (ACPI_FAILURE (Status))
 199     {
 200         return_ACPI_STATUS (Status);
 201     }
 202
 203     /* Install the table */
 204
 205     Status = AcpiTbInstallTable (TableInfo);
 206     return_ACPI_STATUS (Status);
 207 }
 208
 209
 210 /*******************************************************************************
 211  *
 212  * FUNCTION:    AcpiTbGetSecondaryTable
 213  *
 214  * PARAMETERS:  Address             - Physical address of table to retrieve
 215  *              *TableInfo          - Where the table info is returned
 216  *
 217  * RETURN:      Status
 218  *
 219  * DESCRIPTION: Maps the physical address of table into a logical address
 220  *
 221  ******************************************************************************/
 222
 223 static ACPI_STATUS
 224 AcpiTbGetSecondaryTable (
 225     ACPI_POINTER            *Address,
 226     ACPI_STRING             Signature,
 227     ACPI_TABLE_DESC         *TableInfo)
 228 {
 229     ACPI_STATUS             Status;
 230     ACPI_TABLE_HEADER       Header;
 231
 232
 233     ACPI_FUNCTION_TRACE_STR ("TbGetSecondaryTable", Signature);
 234
 235
 236     /* Get the header in order to match the signature */
 237
 238     Status = AcpiTbGetTableHeader (Address, &Header);
 239     if (ACPI_FAILURE (Status))
 240     {
 241         return_ACPI_STATUS (Status);
 242     }
 243
 244     /* Signature must match request */
 245
 246     if (ACPI_STRNCMP (Header.Signature, Signature, ACPI_NAME_SIZE))
 247     {
 248         ACPI_REPORT_ERROR ((
 249             "Incorrect table signature - wanted [%s] found [%4.4s]\n",
 250             Signature, Header.Signature));
 251         return_ACPI_STATUS (AE_BAD_SIGNATURE);
 252     }
 253
 254     /*
 255      * Check the table signature and make sure it is recognized.
 256      * Also checks the header checksum
 257      */
 258     TableInfo->Pointer = &Header;
 259     Status = AcpiTbRecognizeTable (TableInfo, ACPI_TABLE_SECONDARY);
 260     if (ACPI_FAILURE (Status))
 261     {
 262         return_ACPI_STATUS (Status);
 263     }
 264
 265     /* Get the entire table */
 266
 267     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
 268     if (ACPI_FAILURE (Status))
 269     {
 270         return_ACPI_STATUS (Status);
 271     }
 272
 273     /* Install the table */
 274
 275     Status = AcpiTbInstallTable (TableInfo);
 276     return_ACPI_STATUS (Status);
 277 }
 278
 279
 280 /*******************************************************************************
 281  *
 282  * FUNCTION:    AcpiTbGetRequiredTables
 283  *
 284  * PARAMETERS:  None
 285  *
 286  * RETURN:      Status
 287  *
 288  * DESCRIPTION: Load and validate tables other than the RSDT.  The RSDT must
 289  *              already be loaded and validated.
 290  *
 291  *              Get the minimum set of ACPI tables, namely:
 292  *
 293  *              1) FADT (via RSDT in loop below)
 294  *              2) FACS (via FADT)
 295  *              3) DSDT (via FADT)
 296  *
 297  ******************************************************************************/
 298
 299 ACPI_STATUS
 300 AcpiTbGetRequiredTables (
 301     void)
 302 {
 303     ACPI_STATUS             Status = AE_OK;
 304     UINT32                  i;
 305     ACPI_TABLE_DESC         TableInfo;
 306     ACPI_POINTER            Address;
 307
 308
 309     ACPI_FUNCTION_TRACE ("TbGetRequiredTables");
 310
 311     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "%d ACPI tables in RSDT\n",
 312         AcpiGbl_RsdtTableCount));
 313
 314
 315     Address.PointerType   = AcpiGbl_TableFlags | ACPI_LOGICAL_ADDRESSING;
 316
 317     /*
 318      * Loop through all table pointers found in RSDT.
 319      * This will NOT include the FACS and DSDT - we must get
 320      * them after the loop.
 321      *
 322      * The only tables we are interested in getting here is the FADT and
 323      * any SSDTs.
 324      */
 325     for (i = 0; i < AcpiGbl_RsdtTableCount; i++)
 326     {
 327         /* Get the table address from the common internal XSDT */
 328
 329         Address.Pointer.Value = ACPI_GET_ADDRESS (
 330                                     AcpiGbl_XSDT->TableOffsetEntry[i]);
 331
 332         /*
 333          * Get the tables needed by this subsystem (FADT and any SSDTs).
 334          * NOTE: All other tables are completely ignored at this time.
 335          */
 336         Status = AcpiTbGetPrimaryTable (&Address, &TableInfo);
 337         if ((Status != AE_OK) && (Status != AE_TABLE_NOT_SUPPORTED))
 338         {
 339             ACPI_REPORT_WARNING (("%s, while getting table at %8.8X%8.8X\n",
 340                 AcpiFormatException (Status),
 341                 ACPI_FORMAT_UINT64 (Address.Pointer.Value)));
 342         }
 343     }
 344
 345     /* We must have a FADT to continue */
 346
 347     if (!AcpiGbl_FADT)
 348     {
 349         ACPI_REPORT_ERROR (("No FADT present in RSDT/XSDT\n"));
 350         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 351     }
 352
 353     /*
 354      * Convert the FADT to a common format.  This allows earlier revisions of
 355      * the table to coexist with newer versions, using common access code.
 356      */
 357     Status = AcpiTbConvertTableFadt ();
 358     if (ACPI_FAILURE (Status))
 359     {
 360         ACPI_REPORT_ERROR ((
 361             "Could not convert FADT to internal common format\n"));
 362         return_ACPI_STATUS (Status);
 363     }
 364
 365     /* Get the FACS (Pointed to by the FADT) */
 366
 367     Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_FADT->XFirmwareCtrl);
 368
 369     Status = AcpiTbGetSecondaryTable (&Address, FACS_SIG, &TableInfo);
 370     if (ACPI_FAILURE (Status))
 371     {
 372         ACPI_REPORT_ERROR (("Could not get/install the FACS, %s\n",
 373             AcpiFormatException (Status)));
 374         return_ACPI_STATUS (Status);
 375     }
 376
 377     /*
 378      * Create the common FACS pointer table
 379      * (Contains pointers to the original table)
 380      */
 381     Status = AcpiTbBuildCommonFacs (&TableInfo);
 382     if (ACPI_FAILURE (Status))
 383     {
 384         return_ACPI_STATUS (Status);
 385     }
 386
 387     /* Get/install the DSDT (Pointed to by the FADT) */
 388
 389     Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_FADT->XDsdt);
 390
 391     Status = AcpiTbGetSecondaryTable (&Address, DSDT_SIG, &TableInfo);
 392     if (ACPI_FAILURE (Status))
 393     {
 394         ACPI_REPORT_ERROR (("Could not get/install the DSDT\n"));
 395         return_ACPI_STATUS (Status);
 396     }
 397
 398     /* Set Integer Width (32/64) based upon DSDT revision */
 399
 400     AcpiUtSetIntegerWidth (AcpiGbl_DSDT->Revision);
 401
 402     /* Dump the entire DSDT */
 403
 404     ACPI_DEBUG_PRINT ((ACPI_DB_TABLES,
 405         "Hex dump of entire DSDT, size %d (0x%X), Integer width = %d\n",
 406         AcpiGbl_DSDT->Length, AcpiGbl_DSDT->Length, AcpiGbl_IntegerBitWidth));
 407     ACPI_DUMP_BUFFER ((UINT8 *) AcpiGbl_DSDT, AcpiGbl_DSDT->Length);
 408
 409     /* Always delete the RSDP mapping, we are done with it */
 410
 411     AcpiTbDeleteTablesByType (ACPI_TABLE_RSDP);
 412     return_ACPI_STATUS (Status);
 413 }
 414
 415