sys/contrib/dev/acpica/tbrsdt.c

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