1 /******************************************************************************
3 * Module Name: dttemplate - ACPI table template generation
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, 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 #include <contrib/dev/acpica/compiler/aslcompiler.h>
117 #include <contrib/dev/acpica/include/acapps.h>
118 #include <contrib/dev/acpica/compiler/dtcompiler.h>
119 #include <contrib/dev/acpica/compiler/dttemplate.h> /* Contains the hex ACPI table templates */
121 #define _COMPONENT DT_COMPILER
122 ACPI_MODULE_NAME ("dttemplate")
125 /* Local prototypes */
128 AcpiUtIsSpecialTable (
132 DtCreateOneTemplate (
134 ACPI_DMTABLE_DATA *TableData);
137 DtCreateAllTemplates (
141 /*******************************************************************************
143 * FUNCTION: AcpiUtIsSpecialTable
145 * PARAMETERS: Signature - ACPI table signature
147 * RETURN: TRUE if signature is a special ACPI table
149 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
150 * table data structure (AcpiDmTableData).
152 ******************************************************************************/
155 AcpiUtIsSpecialTable (
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))
171 /*******************************************************************************
173 * FUNCTION: DtCreateTemplates
175 * PARAMETERS: Signature - ACPI table signature
179 * DESCRIPTION: Create one or more template files.
181 ******************************************************************************/
187 ACPI_DMTABLE_DATA *TableData;
191 AslInitializeGlobals ();
192 AcpiUtStrupr (Signature);
194 /* Create all known templates if requested */
196 if (!ACPI_STRNCMP (Signature, "ALL", 3))
198 Status = DtCreateAllTemplates ();
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
208 if (strlen (Signature) != ACPI_NAME_SIZE)
210 fprintf (stderr, "%s, Invalid ACPI table signature\n", Signature);
215 * Some slack for the two strange tables whose name is different than
216 * their signatures: MADT->APIC and FADT->FACP.
218 if (!strcmp (Signature, "MADT"))
222 else if (!strcmp (Signature, "FADT"))
227 TableData = AcpiDmGetTableData (Signature);
230 if (!TableData->Template)
232 fprintf (stderr, "%4.4s, No template available\n", Signature);
236 else if (!AcpiUtIsSpecialTable (Signature))
239 "%4.4s, Unrecognized ACPI table signature\n", Signature);
243 Status = AdInitialize ();
244 if (ACPI_FAILURE (Status))
249 Status = DtCreateOneTemplate (Signature, TableData);
254 /*******************************************************************************
256 * FUNCTION: DtCreateAllTemplates
262 * DESCRIPTION: Create all currently defined template files
264 ******************************************************************************/
267 DtCreateAllTemplates (
270 ACPI_DMTABLE_DATA *TableData;
274 Status = AdInitialize ();
275 if (ACPI_FAILURE (Status))
280 fprintf (stderr, "Creating all supported Template files\n");
282 /* Walk entire ACPI table data structure */
284 for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
286 /* If table has a template, create the template file */
288 if (TableData->Template)
290 Status = DtCreateOneTemplate (TableData->Signature,
292 if (ACPI_FAILURE (Status))
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
304 Status = DtCreateOneTemplate (ACPI_SIG_DSDT, NULL);
305 if (ACPI_FAILURE (Status))
310 Status = DtCreateOneTemplate (ACPI_SIG_SSDT, NULL);
311 if (ACPI_FAILURE (Status))
316 Status = DtCreateOneTemplate (ACPI_SIG_FACS, NULL);
317 if (ACPI_FAILURE (Status))
322 Status = DtCreateOneTemplate (ACPI_RSDP_NAME, NULL);
323 if (ACPI_FAILURE (Status))
332 /*******************************************************************************
334 * FUNCTION: DtCreateOneTemplate
336 * PARAMETERS: Signature - ACPI signature, NULL terminated.
337 * TableData - Entry in ACPI table data structure.
338 * NULL if a special ACPI table.
342 * DESCRIPTION: Create one template source file for the requested ACPI table.
344 ******************************************************************************/
347 DtCreateOneTemplate (
349 ACPI_DMTABLE_DATA *TableData)
351 char *DisasmFilename;
353 ACPI_STATUS Status = AE_OK;
356 /* New file will have a .asl suffix */
358 DisasmFilename = FlGenerateFilename (
359 Signature, FILE_SUFFIX_ASL_CODE);
362 fprintf (stderr, "Could not generate output filename\n");
366 /* Probably should prompt to overwrite the file */
368 AcpiUtStrlwr (DisasmFilename);
369 File = fopen (DisasmFilename, "w+");
372 fprintf (stderr, "Could not open output file %s\n", DisasmFilename);
376 /* Emit the common file header */
378 AcpiOsRedirectOutput (File);
380 AcpiOsPrintf ("/*\n");
381 AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
383 AcpiOsPrintf (" * Template for [%4.4s] ACPI Table\n",
386 /* Dump the actual ACPI table */
390 /* Normal case, tables that appear in AcpiDmTableData */
392 if (Gbl_VerboseTemplates)
394 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
395 " FieldName : HexFieldValue\n */\n\n");
399 AcpiOsPrintf (" * Format: [ByteLength]"
400 " FieldName : HexFieldValue\n */\n\n");
403 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
404 TableData->Template));
408 /* Special ACPI tables - DSDT, SSDT, FACS, RSDP */
410 AcpiOsPrintf (" */\n\n");
411 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))
413 fwrite (TemplateDsdt, sizeof (TemplateDsdt) -1, 1, File);
415 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))
417 fwrite (TemplateSsdt, sizeof (TemplateSsdt) -1, 1, File);
419 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
421 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
424 else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
426 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
432 "%4.4s, Unrecognized ACPI table signature\n", Signature);
438 "Created ACPI table template for [%4.4s], written to \"%s\"\n",
439 Signature, DisasmFilename);
442 AcpiOsRedirectOutput (stdout);
443 ACPI_FREE (DisasmFilename);