sys/contrib/dev/acpica-unix/compiler/dttemplate.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dttemplate - ACPI table template generation
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, 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 "aslcompiler.h"
 117 #include "acapps.h"
 118 #include "dtcompiler.h"
 119 #include "dttemplate.h" /* Contains the hex ACPI table templates */
 120
 121 #define _COMPONENT          DT_COMPILER
 122         ACPI_MODULE_NAME    ("dttemplate")
 123
 124
 125 /* Local prototypes */
 126
 127 static BOOLEAN
 128 AcpiUtIsSpecialTable (
 129     char                    *Signature);
 130
 131 static ACPI_STATUS
 132 DtCreateOneTemplate (
 133     char                    *Signature,
 134     ACPI_DMTABLE_DATA       *TableData);
 135
 136 static ACPI_STATUS
 137 DtCreateAllTemplates (
 138     void);
 139
 140
 141 /*******************************************************************************
 142  *
 143  * FUNCTION:    AcpiUtIsSpecialTable
 144  *
 145  * PARAMETERS:  Signature           - ACPI table signature
 146  *
 147  * RETURN:      TRUE if signature is a special ACPI table
 148  *
 149  * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
 150  *              table data structure (AcpiDmTableData).
 151  *
 152  ******************************************************************************/
 153
 154 static BOOLEAN
 155 AcpiUtIsSpecialTable (
 156     char                    *Signature)
 157 {
 158
 159     if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT) ||
 160         ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT) ||
 161         ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS) ||
 162         ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
 163     {
 164         return (TRUE);
 165     }
 166
 167     return (FALSE);
 168 }
 169
 170
 171 /*******************************************************************************
 172  *
 173  * FUNCTION:    DtCreateTemplates
 174  *
 175  * PARAMETERS:  Signature           - ACPI table signature
 176  *
 177  * RETURN:      Status
 178  *
 179  * DESCRIPTION: Create one or more template files.
 180  *
 181  ******************************************************************************/
 182
 183 ACPI_STATUS
 184 DtCreateTemplates (
 185     char                    *Signature)
 186 {
 187     ACPI_DMTABLE_DATA       *TableData;
 188     ACPI_STATUS             Status;
 189
 190
 191     AslInitializeGlobals ();
 192     AcpiUtStrupr (Signature);
 193
 194     /* Create all known templates if requested */
 195
 196     if (!ACPI_STRNCMP (Signature, "ALL", 3))
 197     {
 198         Status = DtCreateAllTemplates ();
 199         return (Status);
 200     }
 201
 202     /*
 203      * Validate signature and get the template data:
 204      *  1) Signature must be 4 characters
 205      *  2) Signature must be a recognized ACPI table
 206      *  3) There must be a template associated with the signature
 207      */
 208     if (strlen (Signature) != ACPI_NAME_SIZE)
 209     {
 210         fprintf (stderr, "%s, Invalid ACPI table signature\n", Signature);
 211         return (AE_ERROR);
 212     }
 213
 214     /*
 215      * Some slack for the two strange tables whose name is different than
 216      * their signatures: MADT->APIC and FADT->FACP.
 217      */
 218     if (!strcmp (Signature, "MADT"))
 219     {
 220         Signature = "APIC";
 221     }
 222     else if (!strcmp (Signature, "FADT"))
 223     {
 224         Signature = "FACP";
 225     }
 226
 227     TableData = AcpiDmGetTableData (Signature);
 228     if (TableData)
 229     {
 230         if (!TableData->Template)
 231         {
 232             fprintf (stderr, "%4.4s, No template available\n", Signature);
 233             return (AE_ERROR);
 234         }
 235     }
 236     else if (!AcpiUtIsSpecialTable (Signature))
 237     {
 238         fprintf (stderr,
 239             "%4.4s, Unrecognized ACPI table signature\n", Signature);
 240         return (AE_ERROR);
 241     }
 242
 243     Status = AdInitialize ();
 244     if (ACPI_FAILURE (Status))
 245     {
 246         return (Status);
 247     }
 248
 249     Status = DtCreateOneTemplate (Signature, TableData);
 250     return (Status);
 251 }
 252
 253
 254 /*******************************************************************************
 255  *
 256  * FUNCTION:    DtCreateAllTemplates
 257  *
 258  * PARAMETERS:  None
 259  *
 260  * RETURN:      Status
 261  *
 262  * DESCRIPTION: Create all currently defined template files
 263  *
 264  ******************************************************************************/
 265
 266 static ACPI_STATUS
 267 DtCreateAllTemplates (
 268     void)
 269 {
 270     ACPI_DMTABLE_DATA       *TableData;
 271     ACPI_STATUS             Status;
 272
 273
 274     Status = AdInitialize ();
 275     if (ACPI_FAILURE (Status))
 276     {
 277         return (Status);
 278     }
 279
 280     fprintf (stderr, "Creating all supported Template files\n");
 281
 282     /* Walk entire ACPI table data structure */
 283
 284     for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
 285     {
 286         /* If table has a template, create the template file */
 287
 288         if (TableData->Template)
 289         {
 290             Status = DtCreateOneTemplate (TableData->Signature,
 291                         TableData);
 292             if (ACPI_FAILURE (Status))
 293             {
 294                 return (Status);
 295             }
 296         }
 297     }
 298
 299     /*
 300      * Create the "special ACPI tables:
 301      * 1) DSDT/SSDT are AML tables, not data tables
 302      * 2) FACS and RSDP have non-standard headers
 303      */
 304     Status = DtCreateOneTemplate (ACPI_SIG_DSDT, NULL);
 305     if (ACPI_FAILURE (Status))
 306     {
 307         return (Status);
 308     }
 309
 310     Status = DtCreateOneTemplate (ACPI_SIG_SSDT, NULL);
 311     if (ACPI_FAILURE (Status))
 312     {
 313         return (Status);
 314     }
 315
 316     Status = DtCreateOneTemplate (ACPI_SIG_FACS, NULL);
 317     if (ACPI_FAILURE (Status))
 318     {
 319         return (Status);
 320     }
 321
 322     Status = DtCreateOneTemplate (ACPI_RSDP_NAME, NULL);
 323     if (ACPI_FAILURE (Status))
 324     {
 325         return (Status);
 326     }
 327
 328     return (AE_OK);
 329 }
 330
 331
 332 /*******************************************************************************
 333  *
 334  * FUNCTION:    DtCreateOneTemplate
 335  *
 336  * PARAMETERS:  Signature           - ACPI signature, NULL terminated.
 337  *              TableData           - Entry in ACPI table data structure.
 338  *                                    NULL if a special ACPI table.
 339  *
 340  * RETURN:      Status
 341  *
 342  * DESCRIPTION: Create one template source file for the requested ACPI table.
 343  *
 344  ******************************************************************************/
 345
 346 static ACPI_STATUS
 347 DtCreateOneTemplate (
 348     char                    *Signature,
 349     ACPI_DMTABLE_DATA       *TableData)
 350 {
 351     char                    *DisasmFilename;
 352     FILE                    *File;
 353     ACPI_STATUS             Status = AE_OK;
 354
 355
 356     /* New file will have a .asl suffix */
 357
 358     DisasmFilename = FlGenerateFilename (
 359         Signature, FILE_SUFFIX_ASL_CODE);
 360     if (!DisasmFilename)
 361     {
 362         fprintf (stderr, "Could not generate output filename\n");
 363         return (AE_ERROR);
 364     }
 365
 366     /* Probably should prompt to overwrite the file */
 367
 368     AcpiUtStrlwr (DisasmFilename);
 369     File = fopen (DisasmFilename, "w+");
 370     if (!File)
 371     {
 372         fprintf (stderr, "Could not open output file %s\n", DisasmFilename);
 373         return (AE_ERROR);
 374     }
 375
 376     /* Emit the common file header */
 377
 378     AcpiOsRedirectOutput (File);
 379
 380     AcpiOsPrintf ("/*\n");
 381     AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
 382
 383     AcpiOsPrintf (" * Template for [%4.4s] ACPI Table\n",
 384         Signature);
 385
 386     /* Dump the actual ACPI table */
 387
 388     if (TableData)
 389     {
 390         /* Normal case, tables that appear in AcpiDmTableData */
 391
 392         if (Gbl_VerboseTemplates)
 393         {
 394             AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
 395                 "  FieldName : HexFieldValue\n */\n\n");
 396         }
 397         else
 398         {
 399             AcpiOsPrintf (" * Format: [ByteLength]"
 400                 "  FieldName : HexFieldValue\n */\n\n");
 401         }
 402
 403         AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
 404             TableData->Template));
 405     }
 406     else
 407     {
 408         /* Special ACPI tables - DSDT, SSDT, FACS, RSDP */
 409
 410         AcpiOsPrintf (" */\n\n");
 411         if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))
 412         {
 413             fwrite (TemplateDsdt, sizeof (TemplateDsdt) -1, 1, File);
 414         }
 415         else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))
 416         {
 417             fwrite (TemplateSsdt, sizeof (TemplateSsdt) -1, 1, File);
 418         }
 419         else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
 420         {
 421             AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
 422                 TemplateFacs));
 423         }
 424         else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
 425         {
 426             AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
 427                 TemplateRsdp));
 428         }
 429         else
 430         {
 431             fprintf (stderr,
 432                 "%4.4s, Unrecognized ACPI table signature\n", Signature);
 433             return (AE_ERROR);
 434         }
 435     }
 436
 437     fprintf (stderr,
 438         "Created ACPI table template for [%4.4s], written to \"%s\"\n",
 439         Signature, DisasmFilename);
 440
 441     fclose (File);
 442     AcpiOsRedirectOutput (stdout);
 443     ACPI_FREE (DisasmFilename);
 444     return (Status);
 445 }