sys/contrib/dev/acpica/tbgetall.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbgetall - Get all required ACPI tables
   4  *              $Revision: 5 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/tbgetall.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118 #define __TBGETALL_C__
 119
 120 #include "acpi.h"
 121 #include "actables.h"
 122
 123
 124 #define _COMPONENT          ACPI_TABLES
 125         ACPI_MODULE_NAME    ("tbgetall")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiTbGetPrimaryTable
 131  *
 132  * PARAMETERS:  Address             - Physical address of table to retrieve
 133  *              *TableInfo          - Where the table info is returned
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: Maps the physical address of table into a logical address
 138  *
 139  ******************************************************************************/
 140
 141 ACPI_STATUS
 142 AcpiTbGetPrimaryTable (
 143     ACPI_POINTER            *Address,
 144     ACPI_TABLE_DESC         *TableInfo)
 145 {
 146     ACPI_STATUS             Status;
 147     ACPI_TABLE_HEADER       Header;
 148
 149
 150     ACPI_FUNCTION_TRACE ("TbGetPrimaryTable");
 151
 152
 153     /* Ignore a NULL address in the RSDT */
 154
 155     if (!Address->Pointer.Value)
 156     {
 157         return_ACPI_STATUS (AE_OK);
 158     }
 159
 160     /*
 161      * Get the header in order to get signature and table size
 162      */
 163     Status = AcpiTbGetTableHeader (Address, &Header);
 164     if (ACPI_FAILURE (Status))
 165     {
 166         return_ACPI_STATUS (Status);
 167     }
 168
 169     /* Clear the TableInfo */
 170
 171     ACPI_MEMSET (TableInfo, 0, sizeof (ACPI_TABLE_DESC));
 172
 173     /*
 174      * Check the table signature and make sure it is recognized.
 175      * Also checks the header checksum
 176      */
 177     TableInfo->Pointer = &Header;
 178     Status = AcpiTbRecognizeTable (TableInfo, ACPI_TABLE_PRIMARY);
 179     if (ACPI_FAILURE (Status))
 180     {
 181         return_ACPI_STATUS (Status);
 182     }
 183
 184     /* Get the entire table */
 185
 186     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
 187     if (ACPI_FAILURE (Status))
 188     {
 189         return_ACPI_STATUS (Status);
 190     }
 191
 192     /* Install the table */
 193
 194     Status = AcpiTbInstallTable (TableInfo);
 195     return_ACPI_STATUS (Status);
 196 }
 197
 198
 199 /*******************************************************************************
 200  *
 201  * FUNCTION:    AcpiTbGetSecondaryTable
 202  *
 203  * PARAMETERS:  Address             - Physical address of table to retrieve
 204  *              *TableInfo          - Where the table info is returned
 205  *
 206  * RETURN:      Status
 207  *
 208  * DESCRIPTION: Maps the physical address of table into a logical address
 209  *
 210  ******************************************************************************/
 211
 212 ACPI_STATUS
 213 AcpiTbGetSecondaryTable (
 214     ACPI_POINTER            *Address,
 215     ACPI_STRING             Signature,
 216     ACPI_TABLE_DESC         *TableInfo)
 217 {
 218     ACPI_STATUS             Status;
 219     ACPI_TABLE_HEADER       Header;
 220
 221
 222     ACPI_FUNCTION_TRACE_STR ("TbGetSecondaryTable", Signature);
 223
 224
 225     /* Get the header in order to match the signature */
 226
 227     Status = AcpiTbGetTableHeader (Address, &Header);
 228     if (ACPI_FAILURE (Status))
 229     {
 230         return_ACPI_STATUS (Status);
 231     }
 232
 233     /* Signature must match request */
 234
 235     if (ACPI_STRNCMP (Header.Signature, Signature, ACPI_NAME_SIZE))
 236     {
 237         ACPI_REPORT_ERROR (("Incorrect table signature - wanted [%s] found [%4.4s]\n",
 238             Signature, Header.Signature));
 239         return_ACPI_STATUS (AE_BAD_SIGNATURE);
 240     }
 241
 242     /*
 243      * Check the table signature and make sure it is recognized.
 244      * Also checks the header checksum
 245      */
 246     TableInfo->Pointer = &Header;
 247     Status = AcpiTbRecognizeTable (TableInfo, ACPI_TABLE_SECONDARY);
 248     if (ACPI_FAILURE (Status))
 249     {
 250         return_ACPI_STATUS (Status);
 251     }
 252
 253     /* Get the entire table */
 254
 255     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
 256     if (ACPI_FAILURE (Status))
 257     {
 258         return_ACPI_STATUS (Status);
 259     }
 260
 261     /* Install the table */
 262
 263     Status = AcpiTbInstallTable (TableInfo);
 264     return_ACPI_STATUS (Status);
 265 }
 266
 267
 268 /*******************************************************************************
 269  *
 270  * FUNCTION:    AcpiTbGetRequiredTables
 271  *
 272  * PARAMETERS:  None
 273  *
 274  * RETURN:      Status
 275  *
 276  * DESCRIPTION: Load and validate tables other than the RSDT.  The RSDT must
 277  *              already be loaded and validated.
 278  *
 279  *              Get the minimum set of ACPI tables, namely:
 280  *
 281  *              1) FADT (via RSDT in loop below)
 282  *              2) FACS (via FADT)
 283  *              3) DSDT (via FADT)
 284  *
 285  ******************************************************************************/
 286
 287 ACPI_STATUS
 288 AcpiTbGetRequiredTables (
 289     void)
 290 {
 291     ACPI_STATUS             Status = AE_OK;
 292     UINT32                  i;
 293     ACPI_TABLE_DESC         TableInfo;
 294     ACPI_POINTER            Address;
 295
 296
 297     ACPI_FUNCTION_TRACE ("TbGetRequiredTables");
 298
 299     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "%d ACPI tables in RSDT\n",
 300         AcpiGbl_RsdtTableCount));
 301
 302
 303     Address.PointerType   = AcpiGbl_TableFlags | ACPI_LOGICAL_ADDRESSING;
 304
 305     /*
 306      * Loop through all table pointers found in RSDT.
 307      * This will NOT include the FACS and DSDT - we must get
 308      * them after the loop.
 309      *
 310      * The only tables we are interested in getting here is the FADT and
 311      * any SSDTs.
 312      */
 313     for (i = 0; i < AcpiGbl_RsdtTableCount; i++)
 314     {
 315         /* Get the table addresss from the common internal XSDT */
 316
 317         Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_XSDT->TableOffsetEntry[i]);
 318
 319         /*
 320          * Get the tables needed by this subsystem (FADT and any SSDTs).
 321          * NOTE: All other tables are completely ignored at this time.
 322          */
 323         Status = AcpiTbGetPrimaryTable (&Address, &TableInfo);
 324         if ((Status != AE_OK) && (Status != AE_TABLE_NOT_SUPPORTED))
 325         {
 326             ACPI_REPORT_WARNING (("%s, while getting table at %8.8X%8.8X\n",
 327                 AcpiFormatException (Status),
 328                 ACPI_HIDWORD (Address.Pointer.Value),
 329                 ACPI_LODWORD (Address.Pointer.Value)));
 330         }
 331     }
 332
 333     /* We must have a FADT to continue */
 334
 335     if (!AcpiGbl_FADT)
 336     {
 337         ACPI_REPORT_ERROR (("No FADT present in RSDT/XSDT\n"));
 338         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 339     }
 340
 341     /*
 342      * Convert the FADT to a common format.  This allows earlier revisions of the
 343      * table to coexist with newer versions, using common access code.
 344      */
 345     Status = AcpiTbConvertTableFadt ();
 346     if (ACPI_FAILURE (Status))
 347     {
 348         ACPI_REPORT_ERROR (("Could not convert FADT to internal common format\n"));
 349         return_ACPI_STATUS (Status);
 350     }
 351
 352     /*
 353      * Get the FACS (Pointed to by the FADT)
 354      */
 355     Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_FADT->XFirmwareCtrl);
 356
 357     Status = AcpiTbGetSecondaryTable (&Address, FACS_SIG, &TableInfo);
 358     if (ACPI_FAILURE (Status))
 359     {
 360         ACPI_REPORT_ERROR (("Could not get/install the FACS, %s\n",
 361             AcpiFormatException (Status)));
 362         return_ACPI_STATUS (Status);
 363     }
 364
 365     /*
 366      * Create the common FACS pointer table
 367      * (Contains pointers to the original table)
 368      */
 369     Status = AcpiTbBuildCommonFacs (&TableInfo);
 370     if (ACPI_FAILURE (Status))
 371     {
 372         return_ACPI_STATUS (Status);
 373     }
 374
 375     /*
 376      * Get/install the DSDT (Pointed to by the FADT)
 377      */
 378     Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_FADT->XDsdt);
 379
 380     Status = AcpiTbGetSecondaryTable (&Address, DSDT_SIG, &TableInfo);
 381     if (ACPI_FAILURE (Status))
 382     {
 383         ACPI_REPORT_ERROR (("Could not get/install the DSDT\n"));
 384         return_ACPI_STATUS (Status);
 385     }
 386
 387     /* Set Integer Width (32/64) based upon DSDT revision */
 388
 389     AcpiUtSetIntegerWidth (AcpiGbl_DSDT->Revision);
 390
 391     /* Dump the entire DSDT */
 392
 393     ACPI_DEBUG_PRINT ((ACPI_DB_TABLES,
 394         "Hex dump of entire DSDT, size %d (0x%X), Integer width = %d\n",
 395         AcpiGbl_DSDT->Length, AcpiGbl_DSDT->Length, AcpiGbl_IntegerBitWidth));
 396     ACPI_DUMP_BUFFER ((UINT8 *) AcpiGbl_DSDT, AcpiGbl_DSDT->Length);
 397
 398     /* Always delete the RSDP mapping, we are done with it */
 399
 400     AcpiTbDeleteAcpiTable (ACPI_TABLE_RSDP);
 401     return_ACPI_STATUS (Status);
 402 }
 403
 404