drivers/acpi/tools/acpinames/antables.c

   1 /******************************************************************************
   2  *
   3  * Module Name: antables - ACPI table setup/install for AcpiNames utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpinames.h"
 117
 118 #define _COMPONENT          ACPI_TOOLS
 119         ACPI_MODULE_NAME    ("antables")
 120
 121 /* Local prototypes */
 122
 123 /* Non-AML tables that are constructed locally and installed */
 124
 125 static ACPI_TABLE_RSDP          LocalRSDP;
 126 static ACPI_TABLE_FACS          LocalFACS;
 127
 128 /*
 129  * We need a local FADT so that the hardware subcomponent will function,
 130  * even though the underlying OSD HW access functions don't do anything.
 131  */
 132 static ACPI_TABLE_FADT          LocalFADT;
 133
 134 /*
 135  * Use XSDT so that both 32- and 64-bit versions of this utility will
 136  * function automatically.
 137  */
 138 static ACPI_TABLE_XSDT          *LocalXSDT;
 139
 140 #define BASE_XSDT_TABLES        1
 141 #define BASE_XSDT_SIZE          (sizeof (ACPI_TABLE_XSDT) + \
 142                                     ((BASE_XSDT_TABLES -1) * sizeof (UINT64)))
 143
 144 ACPI_TABLE_DESC                 Tables[ACPI_MAX_INIT_TABLES];
 145
 146
 147 /******************************************************************************
 148  *
 149  * FUNCTION:    AeBuildLocalTables
 150  *
 151  * PARAMETERS:  TableCount      - Number of tables on the command line
 152  *              TableList       - List of actual tables from files
 153  *
 154  * RETURN:      Status
 155  *
 156  * DESCRIPTION: Build a complete ACPI table chain, with a local RSDP, XSDT,
 157  *              FADT, FACS, and the input DSDT/SSDT.
 158  *
 159  *****************************************************************************/
 160
 161 ACPI_STATUS
 162 AeBuildLocalTables (
 163     UINT32                  TableCount,
 164     AE_TABLE_DESC           *TableList)
 165 {
 166     ACPI_PHYSICAL_ADDRESS   DsdtAddress = 0;
 167     UINT32                  XsdtSize;
 168     AE_TABLE_DESC           *NextTable;
 169     UINT32                  NextIndex;
 170     ACPI_TABLE_FADT         *ExternalFadt = NULL;
 171
 172
 173     /*
 174      * Update the table count. For DSDT, it is not put into the XSDT. For
 175      * FADT, this is already accounted for since we usually install a
 176      * local FADT.
 177      */
 178     NextTable = TableList;
 179     while (NextTable)
 180     {
 181         if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT) ||
 182             ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT))
 183         {
 184             TableCount--;
 185         }
 186         NextTable = NextTable->Next;
 187     }
 188
 189     XsdtSize = BASE_XSDT_SIZE + (TableCount * sizeof (UINT64));
 190
 191     /* Build an XSDT */
 192
 193     LocalXSDT = AcpiOsAllocate (XsdtSize);
 194     if (!LocalXSDT)
 195     {
 196         return (AE_NO_MEMORY);
 197     }
 198
 199     ACPI_MEMSET (LocalXSDT, 0, XsdtSize);
 200     ACPI_MOVE_NAME (LocalXSDT->Header.Signature, ACPI_SIG_XSDT);
 201     LocalXSDT->Header.Length = XsdtSize;
 202     LocalXSDT->Header.Revision = 1;
 203
 204     LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (&LocalFADT);
 205
 206     /*
 207      * Install the user tables. The DSDT must be installed in the FADT.
 208      * All other tables are installed directly into the XSDT.
 209      */
 210     NextIndex = BASE_XSDT_TABLES;
 211     NextTable = TableList;
 212     while (NextTable)
 213     {
 214         /*
 215          * Incoming DSDT or FADT are special cases. All other tables are
 216          * just immediately installed into the XSDT.
 217          */
 218         if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT))
 219         {
 220             if (DsdtAddress)
 221             {
 222                 printf ("Already found a DSDT, only one allowed\n");
 223                 return (AE_ALREADY_EXISTS);
 224             }
 225
 226             /* The incoming user table is a DSDT */
 227
 228             DsdtAddress = ACPI_PTR_TO_PHYSADDR (NextTable->Table);
 229         }
 230         else if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT))
 231         {
 232             ExternalFadt = ACPI_CAST_PTR (ACPI_TABLE_FADT, NextTable->Table);
 233             LocalXSDT->TableOffsetEntry[2] = ACPI_PTR_TO_PHYSADDR (NextTable->Table);
 234         }
 235         else
 236         {
 237             /* Install the table in the XSDT */
 238
 239             LocalXSDT->TableOffsetEntry[NextIndex] = ACPI_PTR_TO_PHYSADDR (NextTable->Table);
 240             NextIndex++;
 241         }
 242
 243         NextTable = NextTable->Next;
 244     }
 245
 246     /* Build an RSDP */
 247
 248     ACPI_MEMSET (&LocalRSDP, 0, sizeof (ACPI_TABLE_RSDP));
 249     ACPI_MAKE_RSDP_SIG (LocalRSDP.Signature);
 250     ACPI_MEMCPY (LocalRSDP.OemId, "I_TEST", 6);
 251     LocalRSDP.Revision = 2;
 252     LocalRSDP.XsdtPhysicalAddress = ACPI_PTR_TO_PHYSADDR (LocalXSDT);
 253     LocalRSDP.Length = sizeof (ACPI_TABLE_XSDT);
 254
 255     /* Set checksums for both XSDT and RSDP */
 256
 257     LocalXSDT->Header.Checksum = (UINT8) -AcpiTbChecksum (
 258         (void *) LocalXSDT, LocalXSDT->Header.Length);
 259     LocalRSDP.Checksum = (UINT8) -AcpiTbChecksum (
 260         (void *) &LocalRSDP, ACPI_RSDP_CHECKSUM_LENGTH);
 261
 262     if (!DsdtAddress)
 263     {
 264         return (AE_SUPPORT);
 265     }
 266
 267     if (ExternalFadt)
 268     {
 269         /*
 270          * Use the external FADT, but we must update the DSDT/FACS addresses
 271          * as well as the checksum
 272          */
 273         ExternalFadt->Dsdt = (UINT32) DsdtAddress;
 274         ExternalFadt->Facs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
 275
 276         if (ExternalFadt->Header.Length > ACPI_PTR_DIFF (&ExternalFadt->XDsdt, ExternalFadt))
 277         {
 278             ExternalFadt->XDsdt = DsdtAddress;
 279             ExternalFadt->XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
 280         }
 281         /* Complete the FADT with the checksum */
 282
 283         ExternalFadt->Header.Checksum = 0;
 284         ExternalFadt->Header.Checksum = (UINT8) -AcpiTbChecksum (
 285             (void *) ExternalFadt, ExternalFadt->Header.Length);
 286     }
 287     else
 288     {
 289         /*
 290          * Build a local FADT so we can test the hardware/event init
 291          */
 292         ACPI_MEMSET (&LocalFADT, 0, sizeof (ACPI_TABLE_FADT));
 293         ACPI_MOVE_NAME (LocalFADT.Header.Signature, ACPI_SIG_FADT);
 294
 295         /* Setup FADT header and DSDT/FACS addresses */
 296
 297         LocalFADT.Dsdt = 0;
 298         LocalFADT.Facs = 0;
 299
 300         LocalFADT.XDsdt = DsdtAddress;
 301         LocalFADT.XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
 302
 303         LocalFADT.Header.Revision = 3;
 304         LocalFADT.Header.Length = sizeof (ACPI_TABLE_FADT);
 305
 306         /* Miscellaneous FADT fields */
 307
 308         LocalFADT.Gpe0BlockLength = 16;
 309         LocalFADT.Gpe0Block = 0x00001234;
 310
 311         LocalFADT.Gpe1BlockLength = 6;
 312         LocalFADT.Gpe1Block = 0x00005678;
 313         LocalFADT.Gpe1Base = 96;
 314
 315         LocalFADT.Pm1EventLength = 4;
 316         LocalFADT.Pm1aEventBlock = 0x00001aaa;
 317         LocalFADT.Pm1bEventBlock = 0x00001bbb;
 318
 319         LocalFADT.Pm1ControlLength = 2;
 320         LocalFADT.Pm1aControlBlock = 0xB0;
 321
 322         LocalFADT.PmTimerLength = 4;
 323         LocalFADT.PmTimerBlock = 0xA0;
 324
 325         LocalFADT.Pm2ControlBlock = 0xC0;
 326         LocalFADT.Pm2ControlLength = 1;
 327
 328         /* Setup one example X-64 field */
 329
 330         LocalFADT.XPm1bEventBlock.SpaceId = ACPI_ADR_SPACE_SYSTEM_IO;
 331         LocalFADT.XPm1bEventBlock.Address = LocalFADT.Pm1bEventBlock;
 332         LocalFADT.XPm1bEventBlock.BitWidth = (UINT8) ACPI_MUL_8 (LocalFADT.Pm1EventLength);
 333
 334         /* Complete the FADT with the checksum */
 335
 336         LocalFADT.Header.Checksum = 0;
 337         LocalFADT.Header.Checksum = (UINT8) -AcpiTbChecksum (
 338             (void *) &LocalFADT, LocalFADT.Header.Length);
 339     }
 340
 341     /* Build a FACS */
 342
 343     ACPI_MEMSET (&LocalFACS, 0, sizeof (ACPI_TABLE_FACS));
 344     ACPI_MOVE_NAME (LocalFACS.Signature, ACPI_SIG_FACS);
 345
 346     LocalFACS.Length = sizeof (ACPI_TABLE_FACS);
 347     LocalFACS.GlobalLock = 0x11AA0011;
 348
 349     return (AE_OK);
 350 }
 351
 352
 353 /******************************************************************************
 354  *
 355  * FUNCTION:    AcpiOsGetRootPointer
 356  *
 357  * PARAMETERS:  None
 358  *
 359  * RETURN:      Address of the RSDP
 360  *
 361  * DESCRIPTION: Return a local RSDP, used to dynamically load tables via the
 362  *              standard ACPI mechanism.
 363  *
 364  *****************************************************************************/
 365
 366 ACPI_PHYSICAL_ADDRESS
 367 AcpiOsGetRootPointer (
 368     void)
 369 {
 370
 371     return (ACPI_PTR_TO_PHYSADDR (&LocalRSDP));
 372 }