sys/contrib/dev/acpica/source/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 - 2019, 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  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include "acpinames.h"
 153
 154 #define _COMPONENT          ACPI_TOOLS
 155         ACPI_MODULE_NAME    ("antables")
 156
 157 /* Local prototypes */
 158
 159 static void
 160 AnInitializeTableHeader (
 161     ACPI_TABLE_HEADER       *Header,
 162     char                    *Signature,
 163     UINT32                  Length);
 164
 165
 166 /* Non-AML tables that are constructed locally and installed */
 167
 168 static ACPI_TABLE_RSDP          LocalRSDP;
 169 static ACPI_TABLE_FACS          LocalFACS;
 170
 171 /*
 172  * We need a local FADT so that the hardware subcomponent will function,
 173  * even though the underlying OSD HW access functions don't do anything.
 174  */
 175 static ACPI_TABLE_FADT          LocalFADT;
 176
 177 /*
 178  * Use XSDT so that both 32- and 64-bit versions of this utility will
 179  * function automatically.
 180  */
 181 static ACPI_TABLE_XSDT          *LocalXSDT;
 182
 183 #define BASE_XSDT_TABLES        1
 184 #define BASE_XSDT_SIZE          (sizeof (ACPI_TABLE_XSDT) + \
 185                                     ((BASE_XSDT_TABLES -1) * sizeof (UINT64)))
 186
 187
 188 /******************************************************************************
 189  *
 190  * FUNCTION:    AnInitializeTableHeader
 191  *
 192  * PARAMETERS:  Header          - A valid standard ACPI table header
 193  *              Signature       - Signature to insert
 194  *              Length          - Length of the table
 195  *
 196  * RETURN:      None. Header is modified.
 197  *
 198  * DESCRIPTION: Initialize the table header for a local ACPI table.
 199  *
 200  *****************************************************************************/
 201
 202 static void
 203 AnInitializeTableHeader (
 204     ACPI_TABLE_HEADER       *Header,
 205     char                    *Signature,
 206     UINT32                  Length)
 207 {
 208
 209     ACPI_MOVE_NAME (Header->Signature, Signature);
 210     Header->Length = Length;
 211
 212     Header->OemRevision = 0x1001;
 213     memcpy (Header->OemId, "Intel ", ACPI_OEM_ID_SIZE);
 214     memcpy (Header->OemTableId, "AcpiExec", ACPI_OEM_TABLE_ID_SIZE);
 215     ACPI_MOVE_NAME (Header->AslCompilerId, "INTL");
 216     Header->AslCompilerRevision = ACPI_CA_VERSION;
 217
 218     /* Set the checksum, must set to zero first */
 219
 220     Header->Checksum = 0;
 221     Header->Checksum = (UINT8) -AcpiTbChecksum (
 222         (void *) Header, Header->Length);
 223 }
 224
 225
 226 /******************************************************************************
 227  *
 228  * FUNCTION:    AnBuildLocalTables
 229  *
 230  * PARAMETERS:  TableCount      - Number of tables on the command line
 231  *              TableList       - List of actual tables from files
 232  *
 233  * RETURN:      Status
 234  *
 235  * DESCRIPTION: Build a complete ACPI table chain, with a local RSDP, XSDT,
 236  *              FADT, FACS, and the input DSDT/SSDT.
 237  *
 238  *****************************************************************************/
 239
 240 ACPI_STATUS
 241 AnBuildLocalTables (
 242     ACPI_NEW_TABLE_DESC     *TableList)
 243 {
 244     UINT32                  TableCount = 0;
 245     ACPI_PHYSICAL_ADDRESS   DsdtAddress = 0;
 246     UINT32                  XsdtSize;
 247     ACPI_NEW_TABLE_DESC     *NextTable;
 248     UINT32                  NextIndex;
 249     ACPI_TABLE_FADT         *ExternalFadt = NULL;
 250
 251
 252     /*
 253      * Update the table count. For the DSDT, it is not put into the XSDT.
 254      * For the FADT, this table is already accounted for since we usually
 255      * install a local FADT.
 256      */
 257     NextTable = TableList;
 258     while (NextTable)
 259     {
 260         if (!ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT) &&
 261             !ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT))
 262         {
 263             TableCount++;
 264         }
 265
 266         NextTable = NextTable->Next;
 267     }
 268
 269     XsdtSize = BASE_XSDT_SIZE + (TableCount * sizeof (UINT64));
 270
 271     /* Build an XSDT */
 272
 273     LocalXSDT = AcpiOsAllocate (XsdtSize);
 274     if (!LocalXSDT)
 275     {
 276         return (AE_NO_MEMORY);
 277     }
 278
 279     memset (LocalXSDT, 0, XsdtSize);
 280     LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (&LocalFADT);
 281
 282     /*
 283      * Install the user tables. The DSDT must be installed in the FADT.
 284      * All other tables are installed directly into the XSDT.
 285      *
 286      * Note: The tables are loaded in reverse order from the incoming
 287      * input, which makes it match the command line order.
 288      */
 289     NextIndex = BASE_XSDT_TABLES;
 290     NextTable = TableList;
 291     while (NextTable)
 292     {
 293         /*
 294          * Incoming DSDT or FADT are special cases. All other tables are
 295          * just immediately installed into the XSDT.
 296          */
 297         if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT))
 298         {
 299             if (DsdtAddress)
 300             {
 301                 printf ("Already found a DSDT, only one allowed\n");
 302                 return (AE_ALREADY_EXISTS);
 303             }
 304
 305             /* The incoming user table is a DSDT */
 306
 307             DsdtAddress = ACPI_PTR_TO_PHYSADDR (NextTable->Table);
 308         }
 309         else if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT))
 310         {
 311             ExternalFadt =
 312                 ACPI_CAST_PTR (ACPI_TABLE_FADT, NextTable->Table);
 313             LocalXSDT->TableOffsetEntry[0] =
 314                 ACPI_PTR_TO_PHYSADDR (NextTable->Table);
 315         }
 316         else
 317         {
 318             /* Install the table in the XSDT */
 319
 320             LocalXSDT->TableOffsetEntry[TableCount - NextIndex + 1] =
 321                 ACPI_PTR_TO_PHYSADDR (NextTable->Table);
 322             NextIndex++;
 323         }
 324
 325         NextTable = NextTable->Next;
 326     }
 327
 328     /* Build an RSDP. Contains a valid XSDT only, no RSDT */
 329
 330     memset (&LocalRSDP, 0, sizeof (ACPI_TABLE_RSDP));
 331     ACPI_MAKE_RSDP_SIG (LocalRSDP.Signature);
 332     memcpy (LocalRSDP.OemId, "Intel", 6);
 333
 334     LocalRSDP.Revision = 2;
 335     LocalRSDP.XsdtPhysicalAddress = ACPI_PTR_TO_PHYSADDR (LocalXSDT);
 336     LocalRSDP.Length = sizeof (ACPI_TABLE_XSDT);
 337
 338     /* Set checksums for both XSDT and RSDP */
 339
 340     AnInitializeTableHeader ((void *) LocalXSDT, ACPI_SIG_XSDT, XsdtSize);
 341
 342     LocalRSDP.Checksum = 0;
 343     LocalRSDP.Checksum = (UINT8) -AcpiTbChecksum (
 344         (void *) &LocalRSDP, ACPI_RSDP_CHECKSUM_LENGTH);
 345
 346     if (!DsdtAddress)
 347     {
 348         return (AE_SUPPORT);
 349     }
 350
 351     /*
 352      * Build an FADT. There are two options for the FADT:
 353      * 1) Incoming external FADT specified on the command line
 354      * 2) A fully featured local FADT
 355      */
 356     memset (&LocalFADT, 0, sizeof (ACPI_TABLE_FADT));
 357
 358     if (ExternalFadt)
 359     {
 360         /*
 361          * Use the external FADT, but we must update the DSDT/FACS
 362          * addresses as well as the checksum
 363          */
 364         ExternalFadt->Dsdt = (UINT32) DsdtAddress;
 365         ExternalFadt->Facs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
 366
 367         /*
 368          * If there room in the FADT for the XDsdt and XFacs 64-bit
 369          * pointers, use them.
 370          */
 371         if (ExternalFadt->Header.Length > ACPI_PTR_DIFF (
 372             &ExternalFadt->XDsdt, ExternalFadt))
 373         {
 374             ExternalFadt->Dsdt = 0;
 375             ExternalFadt->Facs = 0;
 376             ExternalFadt->XDsdt = DsdtAddress;
 377             ExternalFadt->XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
 378         }
 379
 380         /* Complete the external FADT with the checksum */
 381
 382         ExternalFadt->Header.Checksum = 0;
 383         ExternalFadt->Header.Checksum = (UINT8) -AcpiTbChecksum (
 384             (void *) ExternalFadt, ExternalFadt->Header.Length);
 385     }
 386     else
 387     {
 388         /*
 389          * Build a local FADT so we can test the hardware/event init
 390          */
 391         LocalFADT.Header.Revision = 5;
 392
 393         /* Setup FADT header and DSDT/FACS addresses */
 394
 395         LocalFADT.Dsdt = 0;
 396         LocalFADT.Facs = 0;
 397
 398         LocalFADT.XDsdt = DsdtAddress;
 399         LocalFADT.XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
 400
 401         /* Miscellaneous FADT fields */
 402
 403         LocalFADT.Gpe0BlockLength = 16;
 404         LocalFADT.Gpe0Block = 0x00001234;
 405
 406         LocalFADT.Gpe1BlockLength = 6;
 407         LocalFADT.Gpe1Block = 0x00005678;
 408         LocalFADT.Gpe1Base = 96;
 409
 410         LocalFADT.Pm1EventLength = 4;
 411         LocalFADT.Pm1aEventBlock = 0x00001aaa;
 412         LocalFADT.Pm1bEventBlock = 0x00001bbb;
 413
 414         LocalFADT.Pm1ControlLength = 2;
 415         LocalFADT.Pm1aControlBlock = 0xB0;
 416
 417         LocalFADT.PmTimerLength = 4;
 418         LocalFADT.PmTimerBlock = 0xA0;
 419
 420         LocalFADT.Pm2ControlBlock = 0xC0;
 421         LocalFADT.Pm2ControlLength = 1;
 422
 423         /* Setup one example X-64 field */
 424
 425         LocalFADT.XPm1bEventBlock.SpaceId = ACPI_ADR_SPACE_SYSTEM_IO;
 426         LocalFADT.XPm1bEventBlock.Address = LocalFADT.Pm1bEventBlock;
 427         LocalFADT.XPm1bEventBlock.BitWidth = (UINT8)
 428             ACPI_MUL_8 (LocalFADT.Pm1EventLength);
 429     }
 430
 431     AnInitializeTableHeader ((void *) &LocalFADT,
 432         ACPI_SIG_FADT, sizeof (ACPI_TABLE_FADT));
 433
 434     /* Build a FACS */
 435
 436     memset (&LocalFACS, 0, sizeof (ACPI_TABLE_FACS));
 437     ACPI_MOVE_NAME (LocalFACS.Signature, ACPI_SIG_FACS);
 438
 439     LocalFACS.Length = sizeof (ACPI_TABLE_FACS);
 440     LocalFACS.GlobalLock = 0x11AA0011;
 441     return (AE_OK);
 442 }
 443
 444
 445 /******************************************************************************
 446  *
 447  * FUNCTION:    AcpiOsGetRootPointer
 448  *
 449  * PARAMETERS:  None
 450  *
 451  * RETURN:      Address of the RSDP
 452  *
 453  * DESCRIPTION: Return a local RSDP, used to dynamically load tables via the
 454  *              standard ACPI mechanism.
 455  *
 456  *****************************************************************************/
 457
 458 ACPI_PHYSICAL_ADDRESS
 459 AcpiOsGetRootPointer (
 460     void)
 461 {
 462
 463     return (ACPI_PTR_TO_PHYSADDR (&LocalRSDP));
 464 }