1 /******************************************************************************
3 * Module Name: dttemplate - ACPI table template generation
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/include/acapps.h>
154 #include <contrib/dev/acpica/compiler/dtcompiler.h>
155 #include <contrib/dev/acpica/compiler/dttemplate.h> /* Contains the hex ACPI table templates */
157 #define _COMPONENT DT_COMPILER
158 ACPI_MODULE_NAME ("dttemplate")
161 /* Local prototypes */
164 AcpiUtIsSpecialTable (
168 DtCreateOneTemplateFile (
173 DtCreateOneTemplate (
176 const ACPI_DMTABLE_DATA *TableData);
179 DtCreateAllTemplates (
183 DtEmitDefinitionBlock (
190 /*******************************************************************************
192 * FUNCTION: AcpiUtIsSpecialTable
194 * PARAMETERS: Signature - ACPI table signature
196 * RETURN: TRUE if signature is a special ACPI table
198 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
199 * table data structure (AcpiDmTableData).
201 ******************************************************************************/
204 AcpiUtIsSpecialTable (
208 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT) ||
209 ACPI_COMPARE_NAME (Signature, ACPI_SIG_OSDT) ||
210 ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT) ||
211 ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS) ||
212 ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
221 /*******************************************************************************
223 * FUNCTION: DtCreateTemplates
225 * PARAMETERS: argv - Standard command line arguments
229 * DESCRIPTION: Create one or more template files.
231 ******************************************************************************/
239 unsigned long TableCount;
240 ACPI_STATUS Status = AE_OK;
243 AslInitializeGlobals ();
245 Status = AdInitialize ();
246 if (ACPI_FAILURE (Status))
252 * Special cases for DSDT, ALL, and '*'
255 /* Default (no signature option) is DSDT */
257 if (AcpiGbl_Optind < 3)
259 Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, 0);
264 Signature = argv[AcpiGbl_Optind];
265 AcpiUtStrupr (Signature);
268 * Multiple SSDT support (-T <ssdt count>)
270 TableCount = strtoul (Signature, &End, 0);
271 if (Signature != End)
273 /* The count is used for table ID and method name - max is 254(+1) */
275 if (TableCount > 254)
277 fprintf (stderr, "%u SSDTs requested, maximum is 254\n",
278 (unsigned int) TableCount);
284 Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, TableCount);
288 if (!strcmp (Signature, "ALL"))
290 /* Create all available/known templates */
292 Status = DtCreateAllTemplates ();
297 * Normal case: Create template for each signature
299 while (argv[AcpiGbl_Optind])
301 Signature = argv[AcpiGbl_Optind];
302 AcpiUtStrupr (Signature);
304 Status = DtCreateOneTemplateFile (Signature, 0);
305 if (ACPI_FAILURE (Status))
315 /* Shutdown ACPICA subsystem */
317 (void) AcpiTerminate ();
323 /*******************************************************************************
325 * FUNCTION: DtCreateOneTemplateFile
327 * PARAMETERS: Signature - ACPI table signature
331 * DESCRIPTION: Create one template file of the requested signature.
333 ******************************************************************************/
336 DtCreateOneTemplateFile (
340 const ACPI_DMTABLE_DATA *TableData;
345 * Validate signature and get the template data:
346 * 1) Signature must be 4 characters
347 * 2) Signature must be a recognized ACPI table
348 * 3) There must be a template associated with the signature
350 if (strlen (Signature) != ACPI_NAME_SIZE)
353 "%s: Invalid ACPI table signature "
354 "(length must be 4 characters)\n", Signature);
359 * Some slack for the two strange tables whose name is different than
360 * their signatures: MADT->APIC and FADT->FACP.
362 if (!strcmp (Signature, "MADT"))
366 else if (!strcmp (Signature, "FADT"))
371 /* TableData will point to the template */
373 TableData = AcpiDmGetTableData (Signature);
376 if (!TableData->Template)
378 fprintf (stderr, "%4.4s: No template available\n", Signature);
382 else if (!AcpiUtIsSpecialTable (Signature))
385 "%4.4s: Unrecognized ACPI table signature\n", Signature);
389 Status = DtCreateOneTemplate (Signature, TableCount, TableData);
394 /*******************************************************************************
396 * FUNCTION: DtCreateAllTemplates
402 * DESCRIPTION: Create all currently defined template files
404 ******************************************************************************/
407 DtCreateAllTemplates (
410 const ACPI_DMTABLE_DATA *TableData;
414 fprintf (stderr, "Creating all supported Template files\n");
416 /* Walk entire ACPI table data structure */
418 for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
420 /* If table has a template, create the template file */
422 if (TableData->Template)
424 Status = DtCreateOneTemplate (TableData->Signature,
426 if (ACPI_FAILURE (Status))
434 * Create the special ACPI tables:
435 * 1) DSDT/SSDT are AML tables, not data tables
436 * 2) FACS and RSDP have non-standard headers
438 Status = DtCreateOneTemplate (ACPI_SIG_DSDT, 0, NULL);
439 if (ACPI_FAILURE (Status))
444 Status = DtCreateOneTemplate (ACPI_SIG_SSDT, 0, NULL);
445 if (ACPI_FAILURE (Status))
450 Status = DtCreateOneTemplate (ACPI_SIG_OSDT, 0, NULL);
451 if (ACPI_FAILURE (Status))
456 Status = DtCreateOneTemplate (ACPI_SIG_FACS, 0, NULL);
457 if (ACPI_FAILURE (Status))
462 Status = DtCreateOneTemplate (ACPI_RSDP_NAME, 0, NULL);
463 if (ACPI_FAILURE (Status))
472 /*******************************************************************************
474 * FUNCTION: DtCreateOneTemplate
476 * PARAMETERS: Signature - ACPI signature, NULL terminated.
477 * TableCount - Used for SSDTs in same file as DSDT
478 * TableData - Entry in ACPI table data structure.
479 * NULL if a special ACPI table.
483 * DESCRIPTION: Create one template source file for the requested ACPI table.
485 ******************************************************************************/
488 DtCreateOneTemplate (
491 const ACPI_DMTABLE_DATA *TableData)
493 char *DisasmFilename;
495 ACPI_STATUS Status = AE_OK;
500 /* New file will have a .asl suffix */
502 DisasmFilename = FlGenerateFilename (
503 Signature, FILE_SUFFIX_ASL_CODE);
506 fprintf (stderr, "Could not generate output filename\n");
510 AcpiUtStrlwr (DisasmFilename);
511 if (!UtQueryForOverwrite (DisasmFilename))
516 File = fopen (DisasmFilename, "w+");
519 fprintf (stderr, "Could not open output file %s\n",
524 /* Emit the common file header */
526 AcpiOsRedirectOutput (File);
528 AcpiOsPrintf ("/*\n");
529 AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
533 AcpiOsPrintf (" * Template for [%4.4s] ACPI Table",
538 AcpiOsPrintf (" * Template for [%4.4s] and %u [SSDT] ACPI Tables",
539 Signature, TableCount);
542 /* Dump the actual ACPI table */
546 /* Normal case, tables that appear in AcpiDmTableData */
548 AcpiOsPrintf (" (static data table)\n");
550 if (Gbl_VerboseTemplates)
552 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
553 " FieldName : HexFieldValue\n */\n\n");
557 AcpiOsPrintf (" * Format: [ByteLength]"
558 " FieldName : HexFieldValue\n */\n");
561 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
562 TableData->Template));
566 /* Special ACPI tables - DSDT, SSDT, OSDT, FACS, RSDP */
568 AcpiOsPrintf (" (AML byte code table)\n");
569 AcpiOsPrintf (" */\n");
571 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))
573 Actual = DtEmitDefinitionBlock (
574 File, DisasmFilename, ACPI_SIG_DSDT, 1);
581 /* Emit any requested SSDTs into the same file */
583 for (i = 1; i <= TableCount; i++)
585 Actual = DtEmitDefinitionBlock (
586 File, DisasmFilename, ACPI_SIG_SSDT, i + 1);
594 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))
596 Actual = DtEmitDefinitionBlock (
597 File, DisasmFilename, ACPI_SIG_SSDT, 1);
604 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_OSDT))
606 Actual = DtEmitDefinitionBlock (
607 File, DisasmFilename, ACPI_SIG_OSDT, 1);
614 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
616 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
619 else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
621 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
627 "%4.4s, Unrecognized ACPI table signature\n", Signature);
636 "Created ACPI table template for [%4.4s], "
637 "written to \"%s\"\n",
638 Signature, DisasmFilename);
643 "Created ACPI table templates for [%4.4s] "
644 "and %u [SSDT], written to \"%s\"\n",
645 Signature, TableCount, DisasmFilename);
650 AcpiOsRedirectOutput (stdout);
655 /*******************************************************************************
657 * FUNCTION: DtEmitDefinitionBlock
659 * PARAMETERS: File - An open file for the block
660 * Filename - Filename for same, for error msg(s)
661 * Signature - ACPI signature for the block
662 * Instance - Used for multiple SSDTs in the same file
664 * RETURN: Status from fprintf
666 * DESCRIPTION: Emit the raw ASL for a complete Definition Block (DSDT or SSDT)
668 * Note: The AMLFileName parameter for DefinitionBlock is left as a NULL
669 * string. This allows the compiler to create the output AML filename from
670 * the input filename.
672 ******************************************************************************/
675 DtEmitDefinitionBlock (
684 Status = fprintf (File,
685 "DefinitionBlock (\"\", \"%4.4s\", 2, \"Intel\", \"_%4.4s_%.2X\", 0x00000001)\n"
687 " Method (%2.2s%.2X)\n"
691 Signature, Signature, Instance, Signature, Instance);
696 "Could not write %4.4s to output file %s\n",
697 Signature, Filename);