1 /******************************************************************************
3 * Module Name: dttemplate - ACPI table template generation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/compiler/aslcompiler.h>
45 #include <contrib/dev/acpica/include/acapps.h>
46 #include <contrib/dev/acpica/compiler/dtcompiler.h>
47 #include <contrib/dev/acpica/compiler/dttemplate.h> /* Contains the hex ACPI table templates */
49 #define _COMPONENT DT_COMPILER
50 ACPI_MODULE_NAME ("dttemplate")
53 /* Local prototypes */
56 AcpiUtIsSpecialTable (
62 ACPI_DMTABLE_DATA *TableData);
65 DtCreateAllTemplates (
69 /*******************************************************************************
71 * FUNCTION: AcpiUtIsSpecialTable
73 * PARAMETERS: Signature - ACPI table signature
75 * RETURN: TRUE if signature is a special ACPI table
77 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
78 * table data structure (AcpiDmTableData).
80 ******************************************************************************/
83 AcpiUtIsSpecialTable (
87 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT) ||
88 ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT) ||
89 ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS) ||
90 ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
99 /*******************************************************************************
101 * FUNCTION: DtCreateTemplates
103 * PARAMETERS: Signature - ACPI table signature
107 * DESCRIPTION: Create one or more template files.
109 ******************************************************************************/
115 ACPI_DMTABLE_DATA *TableData;
119 AslInitializeGlobals ();
120 AcpiUtStrupr (Signature);
122 /* Create all known templates if requested */
124 if (!ACPI_STRNCMP (Signature, "ALL", 3) ||
125 !ACPI_STRCMP (Signature, "*"))
127 Status = DtCreateAllTemplates ();
132 * Validate signature and get the template data:
133 * 1) Signature must be 4 characters
134 * 2) Signature must be a recognized ACPI table
135 * 3) There must be a template associated with the signature
137 if (strlen (Signature) != ACPI_NAME_SIZE)
139 fprintf (stderr, "%s, Invalid ACPI table signature\n", Signature);
144 * Some slack for the two strange tables whose name is different than
145 * their signatures: MADT->APIC and FADT->FACP.
147 if (!strcmp (Signature, "MADT"))
151 else if (!strcmp (Signature, "FADT"))
156 TableData = AcpiDmGetTableData (Signature);
159 if (!TableData->Template)
161 fprintf (stderr, "%4.4s, No template available\n", Signature);
165 else if (!AcpiUtIsSpecialTable (Signature))
168 "%4.4s, Unrecognized ACPI table signature\n", Signature);
172 Status = AdInitialize ();
173 if (ACPI_FAILURE (Status))
178 Status = DtCreateOneTemplate (Signature, TableData);
183 /*******************************************************************************
185 * FUNCTION: DtCreateAllTemplates
191 * DESCRIPTION: Create all currently defined template files
193 ******************************************************************************/
196 DtCreateAllTemplates (
199 ACPI_DMTABLE_DATA *TableData;
203 Status = AdInitialize ();
204 if (ACPI_FAILURE (Status))
209 fprintf (stderr, "Creating all supported Template files\n");
211 /* Walk entire ACPI table data structure */
213 for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
215 /* If table has a template, create the template file */
217 if (TableData->Template)
219 Status = DtCreateOneTemplate (TableData->Signature,
221 if (ACPI_FAILURE (Status))
229 * Create the "special ACPI tables:
230 * 1) DSDT/SSDT are AML tables, not data tables
231 * 2) FACS and RSDP have non-standard headers
233 Status = DtCreateOneTemplate (ACPI_SIG_DSDT, NULL);
234 if (ACPI_FAILURE (Status))
239 Status = DtCreateOneTemplate (ACPI_SIG_SSDT, NULL);
240 if (ACPI_FAILURE (Status))
245 Status = DtCreateOneTemplate (ACPI_SIG_FACS, NULL);
246 if (ACPI_FAILURE (Status))
251 Status = DtCreateOneTemplate (ACPI_RSDP_NAME, NULL);
252 if (ACPI_FAILURE (Status))
261 /*******************************************************************************
263 * FUNCTION: DtCreateOneTemplate
265 * PARAMETERS: Signature - ACPI signature, NULL terminated.
266 * TableData - Entry in ACPI table data structure.
267 * NULL if a special ACPI table.
271 * DESCRIPTION: Create one template source file for the requested ACPI table.
273 ******************************************************************************/
276 DtCreateOneTemplate (
278 ACPI_DMTABLE_DATA *TableData)
280 char *DisasmFilename;
282 ACPI_STATUS Status = AE_OK;
285 /* New file will have a .asl suffix */
287 DisasmFilename = FlGenerateFilename (
288 Signature, FILE_SUFFIX_ASL_CODE);
291 fprintf (stderr, "Could not generate output filename\n");
295 /* Probably should prompt to overwrite the file */
297 AcpiUtStrlwr (DisasmFilename);
298 File = fopen (DisasmFilename, "w+");
301 fprintf (stderr, "Could not open output file %s\n", DisasmFilename);
305 /* Emit the common file header */
307 AcpiOsRedirectOutput (File);
309 AcpiOsPrintf ("/*\n");
310 AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
312 AcpiOsPrintf (" * Template for [%4.4s] ACPI Table\n",
315 /* Dump the actual ACPI table */
319 /* Normal case, tables that appear in AcpiDmTableData */
321 if (Gbl_VerboseTemplates)
323 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
324 " FieldName : HexFieldValue\n */\n\n");
328 AcpiOsPrintf (" * Format: [ByteLength]"
329 " FieldName : HexFieldValue\n */\n\n");
332 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
333 TableData->Template));
337 /* Special ACPI tables - DSDT, SSDT, FACS, RSDP */
339 AcpiOsPrintf (" */\n\n");
340 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))
342 fwrite (TemplateDsdt, sizeof (TemplateDsdt) -1, 1, File);
344 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))
346 fwrite (TemplateSsdt, sizeof (TemplateSsdt) -1, 1, File);
348 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
350 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
353 else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
355 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
361 "%4.4s, Unrecognized ACPI table signature\n", Signature);
367 "Created ACPI table template for [%4.4s], written to \"%s\"\n",
368 Signature, DisasmFilename);
371 AcpiOsRedirectOutput (stdout);
372 ACPI_FREE (DisasmFilename);