sys/contrib/dev/acpica/tbrsdt.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbrsdt - ACPI RSDT table utilities
   4  *              $Revision: 1.20 $
   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 __TBRSDT_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    ("tbrsdt")
 125
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiTbVerifyRsdp
 130  *
 131  * PARAMETERS:  Address         - RSDP (Pointer to RSDT)
 132  *
 133  * RETURN:      Status
 134  *
 135  * DESCRIPTION: Load and validate the RSDP (ptr) and RSDT (table)
 136  *
 137  ******************************************************************************/
 138
 139 ACPI_STATUS
 140 AcpiTbVerifyRsdp (
 141     ACPI_POINTER            *Address)
 142 {
 143     ACPI_TABLE_DESC         TableInfo;
 144     ACPI_STATUS             Status;
 145     RSDP_DESCRIPTOR         *Rsdp;
 146
 147
 148     ACPI_FUNCTION_TRACE ("TbVerifyRsdp");
 149
 150
 151     switch (Address->PointerType)
 152     {
 153     case ACPI_LOGICAL_POINTER:
 154
 155         Rsdp = Address->Pointer.Logical;
 156         break;
 157
 158     case ACPI_PHYSICAL_POINTER:
 159         /*
 160          * Obtain access to the RSDP structure
 161          */
 162         Status = AcpiOsMapMemory (Address->Pointer.Physical,
 163                     sizeof (RSDP_DESCRIPTOR),
 164                                     (void *) &Rsdp);
 165         if (ACPI_FAILURE (Status))
 166         {
 167             return_ACPI_STATUS (Status);
 168         }
 169         break;
 170
 171     default:
 172         return_ACPI_STATUS (AE_BAD_PARAMETER);
 173     }
 174
 175     /* Verify RSDP signature and checksum */
 176
 177     Status = AcpiTbValidateRsdp (Rsdp);
 178     if (ACPI_FAILURE (Status))
 179     {
 180         goto Cleanup;
 181     }
 182
 183     /* The RSDP supplied is OK */
 184
 185     TableInfo.Pointer      = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Rsdp);
 186     TableInfo.Length       = sizeof (RSDP_DESCRIPTOR);
 187     TableInfo.Allocation   = ACPI_MEM_MAPPED;
 188
 189     /* Save the table pointers and allocation info */
 190
 191     Status = AcpiTbInitTableDescriptor (ACPI_TABLE_RSDP, &TableInfo);
 192     if (ACPI_FAILURE (Status))
 193     {
 194         goto Cleanup;
 195     }
 196
 197     /* Save the RSDP in a global for easy access */
 198
 199     AcpiGbl_RSDP = ACPI_CAST_PTR (RSDP_DESCRIPTOR, TableInfo.Pointer);
 200     return_ACPI_STATUS (Status);
 201
 202
 203     /* Error exit */
 204 Cleanup:
 205
 206     if (AcpiGbl_TableFlags & ACPI_PHYSICAL_POINTER)
 207     {
 208         AcpiOsUnmapMemory (Rsdp, sizeof (RSDP_DESCRIPTOR));
 209     }
 210     return_ACPI_STATUS (Status);
 211 }
 212
 213
 214 /*******************************************************************************
 215  *
 216  * FUNCTION:    AcpiTbGetRsdtAddress
 217  *
 218  * PARAMETERS:  OutAddress          - Where the address is returned
 219  *
 220  * RETURN:      None, Address
 221  *
 222  * DESCRIPTION: Extract the address of either the RSDT or XSDT, depending on the
 223  *              version of the RSDP and whether the XSDT pointer is valid
 224  *
 225  ******************************************************************************/
 226
 227 void
 228 AcpiTbGetRsdtAddress (
 229     ACPI_POINTER            *OutAddress)
 230 {
 231
 232     ACPI_FUNCTION_ENTRY ();
 233
 234
 235     OutAddress->PointerType = AcpiGbl_TableFlags | ACPI_LOGICAL_ADDRESSING;
 236
 237     /* Use XSDT if it is present */
 238
 239     if ((AcpiGbl_RSDP->Revision >= 2) &&
 240         ACPI_GET_ADDRESS (AcpiGbl_RSDP->XsdtPhysicalAddress))
 241     {
 242         OutAddress->Pointer.Value =
 243             ACPI_GET_ADDRESS (AcpiGbl_RSDP->XsdtPhysicalAddress);
 244         AcpiGbl_RootTableType = ACPI_TABLE_TYPE_XSDT;
 245     }
 246     else
 247     {
 248         /* No XSDT, use the RSDT */
 249
 250         OutAddress->Pointer.Value = AcpiGbl_RSDP->RsdtPhysicalAddress;
 251         AcpiGbl_RootTableType = ACPI_TABLE_TYPE_RSDT;
 252     }
 253 }
 254
 255
 256 /*******************************************************************************
 257  *
 258  * FUNCTION:    AcpiTbValidateRsdt
 259  *
 260  * PARAMETERS:  TablePtr        - Addressable pointer to the RSDT.
 261  *
 262  * RETURN:      Status
 263  *
 264  * DESCRIPTION: Validate signature for the RSDT or XSDT
 265  *
 266  ******************************************************************************/
 267
 268 ACPI_STATUS
 269 AcpiTbValidateRsdt (
 270     ACPI_TABLE_HEADER       *TablePtr)
 271 {
 272     int                     NoMatch;
 273
 274
 275     ACPI_FUNCTION_NAME ("TbValidateRsdt");
 276
 277
 278     /*
 279      * Search for appropriate signature, RSDT or XSDT
 280      */
 281     if (AcpiGbl_RootTableType == ACPI_TABLE_TYPE_RSDT)
 282     {
 283         NoMatch = ACPI_STRNCMP ((char *) TablePtr, RSDT_SIG,
 284                         sizeof (RSDT_SIG) -1);
 285     }
 286     else
 287     {
 288         NoMatch = ACPI_STRNCMP ((char *) TablePtr, XSDT_SIG,
 289                         sizeof (XSDT_SIG) -1);
 290     }
 291
 292     if (NoMatch)
 293     {
 294         /* Invalid RSDT or XSDT signature */
 295
 296         ACPI_REPORT_ERROR ((
 297             "Invalid signature where RSDP indicates RSDT/XSDT should be located\n"));
 298
 299         ACPI_DUMP_BUFFER (AcpiGbl_RSDP, 20);
 300
 301         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ERROR,
 302             "RSDT/XSDT signature at %X (%p) is invalid\n",
 303             AcpiGbl_RSDP->RsdtPhysicalAddress,
 304             (void *) (ACPI_NATIVE_UINT) AcpiGbl_RSDP->RsdtPhysicalAddress));
 305
 306         if (AcpiGbl_RootTableType == ACPI_TABLE_TYPE_RSDT)
 307         {
 308             ACPI_REPORT_ERROR (("Looking for RSDT\n"))
 309         }
 310         else
 311         {
 312             ACPI_REPORT_ERROR (("Looking for XSDT\n"))
 313         }
 314
 315         ACPI_DUMP_BUFFER ((char *) TablePtr, 48);
 316
 317         return (AE_BAD_SIGNATURE);
 318     }
 319
 320     return (AE_OK);
 321 }
 322
 323
 324 /*******************************************************************************
 325  *
 326  * FUNCTION:    AcpiTbGetTableRsdt
 327  *
 328  * PARAMETERS:  None
 329  *
 330  * RETURN:      Status
 331  *
 332  * DESCRIPTION: Load and validate the RSDP (ptr) and RSDT (table)
 333  *
 334  ******************************************************************************/
 335
 336 ACPI_STATUS
 337 AcpiTbGetTableRsdt (
 338     void)
 339 {
 340     ACPI_TABLE_DESC         TableInfo;
 341     ACPI_STATUS             Status;
 342     ACPI_POINTER            Address;
 343
 344
 345     ACPI_FUNCTION_TRACE ("TbGetTableRsdt");
 346
 347
 348     /* Get the RSDT/XSDT via the RSDP */
 349
 350     AcpiTbGetRsdtAddress (&Address);
 351
 352     TableInfo.Type = ACPI_TABLE_XSDT;
 353     Status = AcpiTbGetTable (&Address, &TableInfo);
 354     if (ACPI_FAILURE (Status))
 355     {
 356         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not get the RSDT/XSDT, %s\n",
 357             AcpiFormatException (Status)));
 358
 359         return_ACPI_STATUS (Status);
 360     }
 361
 362     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 363         "RSDP located at %p, points to RSDT physical=%8.8X%8.8X\n",
 364         AcpiGbl_RSDP,
 365         ACPI_FORMAT_UINT64 (Address.Pointer.Value)));
 366
 367     /* Check the RSDT or XSDT signature */
 368
 369     Status = AcpiTbValidateRsdt (TableInfo.Pointer);
 370     if (ACPI_FAILURE (Status))
 371     {
 372         return_ACPI_STATUS (Status);
 373     }
 374
 375     /* Get the number of tables defined in the RSDT or XSDT */
 376
 377     AcpiGbl_RsdtTableCount = AcpiTbGetTableCount (AcpiGbl_RSDP,
 378                                 TableInfo.Pointer);
 379
 380     /* Convert and/or copy to an XSDT structure */
 381
 382     Status = AcpiTbConvertToXsdt (&TableInfo);
 383     if (ACPI_FAILURE (Status))
 384     {
 385         return_ACPI_STATUS (Status);
 386     }
 387
 388     /* Save the table pointers and allocation info */
 389
 390     Status = AcpiTbInitTableDescriptor (ACPI_TABLE_XSDT, &TableInfo);
 391     if (ACPI_FAILURE (Status))
 392     {
 393         return_ACPI_STATUS (Status);
 394     }
 395
 396     AcpiGbl_XSDT = ACPI_CAST_PTR (XSDT_DESCRIPTOR, TableInfo.Pointer);
 397
 398     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "XSDT located at %p\n", AcpiGbl_XSDT));
 399     return_ACPI_STATUS (Status);
 400 }
 401
 402