10d02842fSSascha Wildner /******************************************************************************
20d02842fSSascha Wildner *
30d02842fSSascha Wildner * Module Name: dttemplate - ACPI table template generation
40d02842fSSascha Wildner *
50d02842fSSascha Wildner *****************************************************************************/
60d02842fSSascha Wildner
7b4315fc7SSascha Wildner /******************************************************************************
8b4315fc7SSascha Wildner *
9b4315fc7SSascha Wildner * 1. Copyright Notice
10b4315fc7SSascha Wildner *
11*383048acSSascha Wildner * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
120d02842fSSascha Wildner * All rights reserved.
130d02842fSSascha Wildner *
14b4315fc7SSascha Wildner * 2. License
15b4315fc7SSascha Wildner *
16b4315fc7SSascha Wildner * 2.1. This is your license from Intel Corp. under its intellectual property
17b4315fc7SSascha Wildner * rights. You may have additional license terms from the party that provided
18b4315fc7SSascha Wildner * you this software, covering your right to use that party's intellectual
19b4315fc7SSascha Wildner * property rights.
20b4315fc7SSascha Wildner *
21b4315fc7SSascha Wildner * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22b4315fc7SSascha Wildner * copy of the source code appearing in this file ("Covered Code") an
23b4315fc7SSascha Wildner * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24b4315fc7SSascha Wildner * base code distributed originally by Intel ("Original Intel Code") to copy,
25b4315fc7SSascha Wildner * make derivatives, distribute, use and display any portion of the Covered
26b4315fc7SSascha Wildner * Code in any form, with the right to sublicense such rights; and
27b4315fc7SSascha Wildner *
28b4315fc7SSascha Wildner * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29b4315fc7SSascha Wildner * license (with the right to sublicense), under only those claims of Intel
30b4315fc7SSascha Wildner * patents that are infringed by the Original Intel Code, to make, use, sell,
31b4315fc7SSascha Wildner * offer to sell, and import the Covered Code and derivative works thereof
32b4315fc7SSascha Wildner * solely to the minimum extent necessary to exercise the above copyright
33b4315fc7SSascha Wildner * license, and in no event shall the patent license extend to any additions
34b4315fc7SSascha Wildner * to or modifications of the Original Intel Code. No other license or right
35b4315fc7SSascha Wildner * is granted directly or by implication, estoppel or otherwise;
36b4315fc7SSascha Wildner *
37b4315fc7SSascha Wildner * The above copyright and patent license is granted only if the following
38b4315fc7SSascha Wildner * conditions are met:
39b4315fc7SSascha Wildner *
40b4315fc7SSascha Wildner * 3. Conditions
41b4315fc7SSascha Wildner *
42b4315fc7SSascha Wildner * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
44b4315fc7SSascha Wildner * Code or modification with rights to further distribute source must include
45b4315fc7SSascha Wildner * the above Copyright Notice, the above License, this list of Conditions,
46b4315fc7SSascha Wildner * and the following Disclaimer and Export Compliance provision. In addition,
47b4315fc7SSascha Wildner * Licensee must cause all Covered Code to which Licensee contributes to
48b4315fc7SSascha Wildner * contain a file documenting the changes Licensee made to create that Covered
49b4315fc7SSascha Wildner * Code and the date of any change. Licensee must include in that file the
50b4315fc7SSascha Wildner * documentation of any changes made by any predecessor Licensee. Licensee
51b4315fc7SSascha Wildner * must include a prominent statement that the modification is derived,
52b4315fc7SSascha Wildner * directly or indirectly, from Original Intel Code.
53b4315fc7SSascha Wildner *
54b4315fc7SSascha Wildner * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
56b4315fc7SSascha Wildner * Code or modification without rights to further distribute source must
57b4315fc7SSascha Wildner * include the following Disclaimer and Export Compliance provision in the
58b4315fc7SSascha Wildner * documentation and/or other materials provided with distribution. In
59b4315fc7SSascha Wildner * addition, Licensee may not authorize further sublicense of source of any
60b4315fc7SSascha Wildner * portion of the Covered Code, and must include terms to the effect that the
61b4315fc7SSascha Wildner * license from Licensee to its licensee is limited to the intellectual
62b4315fc7SSascha Wildner * property embodied in the software Licensee provides to its licensee, and
63b4315fc7SSascha Wildner * not to intellectual property embodied in modifications its licensee may
64b4315fc7SSascha Wildner * make.
65b4315fc7SSascha Wildner *
66b4315fc7SSascha Wildner * 3.3. Redistribution of Executable. Redistribution in executable form of any
67b4315fc7SSascha Wildner * substantial portion of the Covered Code or modification must reproduce the
68b4315fc7SSascha Wildner * above Copyright Notice, and the following Disclaimer and Export Compliance
69b4315fc7SSascha Wildner * provision in the documentation and/or other materials provided with the
70b4315fc7SSascha Wildner * distribution.
71b4315fc7SSascha Wildner *
72b4315fc7SSascha Wildner * 3.4. Intel retains all right, title, and interest in and to the Original
73b4315fc7SSascha Wildner * Intel Code.
74b4315fc7SSascha Wildner *
75b4315fc7SSascha Wildner * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76b4315fc7SSascha Wildner * Intel shall be used in advertising or otherwise to promote the sale, use or
77b4315fc7SSascha Wildner * other dealings in products derived from or relating to the Covered Code
78b4315fc7SSascha Wildner * without prior written authorization from Intel.
79b4315fc7SSascha Wildner *
80b4315fc7SSascha Wildner * 4. Disclaimer and Export Compliance
81b4315fc7SSascha Wildner *
82b4315fc7SSascha Wildner * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83b4315fc7SSascha Wildner * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84b4315fc7SSascha Wildner * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85b4315fc7SSascha Wildner * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86b4315fc7SSascha Wildner * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87b4315fc7SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88b4315fc7SSascha Wildner * PARTICULAR PURPOSE.
89b4315fc7SSascha Wildner *
90b4315fc7SSascha Wildner * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91b4315fc7SSascha Wildner * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92b4315fc7SSascha Wildner * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93b4315fc7SSascha Wildner * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94b4315fc7SSascha Wildner * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95b4315fc7SSascha Wildner * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96b4315fc7SSascha Wildner * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97b4315fc7SSascha Wildner * LIMITED REMEDY.
98b4315fc7SSascha Wildner *
99b4315fc7SSascha Wildner * 4.3. Licensee shall not export, either directly or indirectly, any of this
100b4315fc7SSascha Wildner * software or system incorporating such software without first obtaining any
101b4315fc7SSascha Wildner * required license or other approval from the U. S. Department of Commerce or
102b4315fc7SSascha Wildner * any other agency or department of the United States Government. In the
103b4315fc7SSascha Wildner * event Licensee exports any such software from the United States or
104b4315fc7SSascha Wildner * re-exports any such software from a foreign destination, Licensee shall
105b4315fc7SSascha Wildner * ensure that the distribution and export/re-export of the software is in
106b4315fc7SSascha Wildner * compliance with all laws, regulations, orders, or other restrictions of the
107b4315fc7SSascha Wildner * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108b4315fc7SSascha Wildner * any of its subsidiaries will export/re-export any technical data, process,
109b4315fc7SSascha Wildner * software, or service, directly or indirectly, to any country for which the
110b4315fc7SSascha Wildner * United States government or any agency thereof requires an export license,
111b4315fc7SSascha Wildner * other governmental approval, or letter of assurance, without first obtaining
112b4315fc7SSascha Wildner * such license, approval or letter.
113b4315fc7SSascha Wildner *
114b4315fc7SSascha Wildner *****************************************************************************
115b4315fc7SSascha Wildner *
116b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
117b4315fc7SSascha Wildner * following license:
118b4315fc7SSascha Wildner *
1190d02842fSSascha Wildner * Redistribution and use in source and binary forms, with or without
1200d02842fSSascha Wildner * modification, are permitted provided that the following conditions
1210d02842fSSascha Wildner * are met:
1220d02842fSSascha Wildner * 1. Redistributions of source code must retain the above copyright
1230d02842fSSascha Wildner * notice, this list of conditions, and the following disclaimer,
1240d02842fSSascha Wildner * without modification.
1250d02842fSSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1260d02842fSSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below
1270d02842fSSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon
1280d02842fSSascha Wildner * including a substantially similar Disclaimer requirement for further
1290d02842fSSascha Wildner * binary redistribution.
1300d02842fSSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names
1310d02842fSSascha Wildner * of any contributors may be used to endorse or promote products derived
1320d02842fSSascha Wildner * from this software without specific prior written permission.
1330d02842fSSascha Wildner *
134b4315fc7SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135b4315fc7SSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136b4315fc7SSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137b4315fc7SSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138b4315fc7SSascha Wildner * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139b4315fc7SSascha Wildner * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140b4315fc7SSascha Wildner * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141b4315fc7SSascha Wildner * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142b4315fc7SSascha Wildner * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143b4315fc7SSascha Wildner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144b4315fc7SSascha Wildner * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145b4315fc7SSascha Wildner *
146b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
1470d02842fSSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free
1480d02842fSSascha Wildner * Software Foundation.
1490d02842fSSascha Wildner *
150b4315fc7SSascha Wildner *****************************************************************************/
1510d02842fSSascha Wildner
1520d02842fSSascha Wildner #include "aslcompiler.h"
1530d02842fSSascha Wildner #include "acapps.h"
1540d02842fSSascha Wildner #include "dttemplate.h" /* Contains the hex ACPI table templates */
1550d02842fSSascha Wildner
1560d02842fSSascha Wildner #define _COMPONENT DT_COMPILER
1570d02842fSSascha Wildner ACPI_MODULE_NAME ("dttemplate")
1580d02842fSSascha Wildner
1590d02842fSSascha Wildner
1600d02842fSSascha Wildner /* Local prototypes */
1610d02842fSSascha Wildner
1620d02842fSSascha Wildner static BOOLEAN
1630d02842fSSascha Wildner AcpiUtIsSpecialTable (
1640d02842fSSascha Wildner char *Signature);
1650d02842fSSascha Wildner
1660d02842fSSascha Wildner static ACPI_STATUS
167f5f76cf2SSascha Wildner DtCreateOneTemplateFile (
168f5f76cf2SSascha Wildner char *Signature,
169f5f76cf2SSascha Wildner UINT32 TableCount);
170f5f76cf2SSascha Wildner
171f5f76cf2SSascha Wildner static ACPI_STATUS
1720d02842fSSascha Wildner DtCreateOneTemplate (
1730d02842fSSascha Wildner char *Signature,
174f5f76cf2SSascha Wildner UINT32 TableCount,
175896f2e3aSSascha Wildner const ACPI_DMTABLE_DATA *TableData);
1760d02842fSSascha Wildner
1770d02842fSSascha Wildner static ACPI_STATUS
1780d02842fSSascha Wildner DtCreateAllTemplates (
1790d02842fSSascha Wildner void);
1800d02842fSSascha Wildner
181f5f76cf2SSascha Wildner static int
182f5f76cf2SSascha Wildner DtEmitDefinitionBlock (
183f5f76cf2SSascha Wildner FILE *File,
184f5f76cf2SSascha Wildner char *Filename,
185f5f76cf2SSascha Wildner char *Signature,
186f5f76cf2SSascha Wildner UINT32 Instance);
187f5f76cf2SSascha Wildner
1880d02842fSSascha Wildner
1890d02842fSSascha Wildner /*******************************************************************************
1900d02842fSSascha Wildner *
1910d02842fSSascha Wildner * FUNCTION: AcpiUtIsSpecialTable
1920d02842fSSascha Wildner *
1930d02842fSSascha Wildner * PARAMETERS: Signature - ACPI table signature
1940d02842fSSascha Wildner *
1950d02842fSSascha Wildner * RETURN: TRUE if signature is a special ACPI table
1960d02842fSSascha Wildner *
1970d02842fSSascha Wildner * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
1980d02842fSSascha Wildner * table data structure (AcpiDmTableData).
1990d02842fSSascha Wildner *
2000d02842fSSascha Wildner ******************************************************************************/
2010d02842fSSascha Wildner
2020d02842fSSascha Wildner static BOOLEAN
AcpiUtIsSpecialTable(char * Signature)2030d02842fSSascha Wildner AcpiUtIsSpecialTable (
2040d02842fSSascha Wildner char *Signature)
2050d02842fSSascha Wildner {
2060d02842fSSascha Wildner
207c1776041SSascha Wildner if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_DSDT) ||
208c1776041SSascha Wildner ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_OSDT) ||
209c1776041SSascha Wildner ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT) ||
210c1776041SSascha Wildner ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_FACS) ||
211c1776041SSascha Wildner ACPI_COMPARE_NAMESEG (Signature, ACPI_RSDP_NAME))
2120d02842fSSascha Wildner {
2130d02842fSSascha Wildner return (TRUE);
2140d02842fSSascha Wildner }
2150d02842fSSascha Wildner
2160d02842fSSascha Wildner return (FALSE);
2170d02842fSSascha Wildner }
2180d02842fSSascha Wildner
2190d02842fSSascha Wildner
2200d02842fSSascha Wildner /*******************************************************************************
2210d02842fSSascha Wildner *
2220d02842fSSascha Wildner * FUNCTION: DtCreateTemplates
2230d02842fSSascha Wildner *
224f5f76cf2SSascha Wildner * PARAMETERS: argv - Standard command line arguments
2250d02842fSSascha Wildner *
2260d02842fSSascha Wildner * RETURN: Status
2270d02842fSSascha Wildner *
2280d02842fSSascha Wildner * DESCRIPTION: Create one or more template files.
2290d02842fSSascha Wildner *
2300d02842fSSascha Wildner ******************************************************************************/
2310d02842fSSascha Wildner
2320d02842fSSascha Wildner ACPI_STATUS
DtCreateTemplates(char ** argv)2330d02842fSSascha Wildner DtCreateTemplates (
234f5f76cf2SSascha Wildner char **argv)
23527624239SSascha Wildner {
236f5f76cf2SSascha Wildner char *Signature;
237f5f76cf2SSascha Wildner char *End;
238f5f76cf2SSascha Wildner unsigned long TableCount;
239f5f76cf2SSascha Wildner ACPI_STATUS Status = AE_OK;
24027624239SSascha Wildner
24127624239SSascha Wildner
24212673cf1SSascha Wildner AslInitializeGlobals ();
24312673cf1SSascha Wildner
244f5f76cf2SSascha Wildner Status = AdInitialize ();
245f5f76cf2SSascha Wildner if (ACPI_FAILURE (Status))
24612673cf1SSascha Wildner {
247f5f76cf2SSascha Wildner return (Status);
24812673cf1SSascha Wildner }
24912673cf1SSascha Wildner
250f5f76cf2SSascha Wildner /*
251f5f76cf2SSascha Wildner * Special cases for DSDT, ALL, and '*'
252f5f76cf2SSascha Wildner */
253f5f76cf2SSascha Wildner
254f5f76cf2SSascha Wildner /* Default (no signature option) is DSDT */
255f5f76cf2SSascha Wildner
256f5f76cf2SSascha Wildner if (AcpiGbl_Optind < 3)
257f5f76cf2SSascha Wildner {
25808343eafSSascha Wildner fprintf (stderr, "Creating default template: [DSDT]\n");
259f5f76cf2SSascha Wildner Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, 0);
260f5f76cf2SSascha Wildner goto Exit;
261f5f76cf2SSascha Wildner }
262f5f76cf2SSascha Wildner
263f5f76cf2SSascha Wildner AcpiGbl_Optind--;
264f5f76cf2SSascha Wildner Signature = argv[AcpiGbl_Optind];
26512673cf1SSascha Wildner AcpiUtStrupr (Signature);
266f5f76cf2SSascha Wildner
267f5f76cf2SSascha Wildner /*
268f5f76cf2SSascha Wildner * Multiple SSDT support (-T <ssdt count>)
269f5f76cf2SSascha Wildner */
270f5f76cf2SSascha Wildner TableCount = strtoul (Signature, &End, 0);
271f5f76cf2SSascha Wildner if (Signature != End)
272f5f76cf2SSascha Wildner {
273f5f76cf2SSascha Wildner /* The count is used for table ID and method name - max is 254(+1) */
274f5f76cf2SSascha Wildner
275f5f76cf2SSascha Wildner if (TableCount > 254)
276f5f76cf2SSascha Wildner {
277f5f76cf2SSascha Wildner fprintf (stderr, "%u SSDTs requested, maximum is 254\n",
278f5f76cf2SSascha Wildner (unsigned int) TableCount);
279f5f76cf2SSascha Wildner
280f5f76cf2SSascha Wildner Status = AE_LIMIT;
281f5f76cf2SSascha Wildner goto Exit;
282f5f76cf2SSascha Wildner }
283f5f76cf2SSascha Wildner
284f5f76cf2SSascha Wildner Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, TableCount);
285f5f76cf2SSascha Wildner goto Exit;
286f5f76cf2SSascha Wildner }
287f5f76cf2SSascha Wildner
288f5f76cf2SSascha Wildner if (!strcmp (Signature, "ALL"))
28912673cf1SSascha Wildner {
29012673cf1SSascha Wildner /* Create all available/known templates */
29112673cf1SSascha Wildner
29212673cf1SSascha Wildner Status = DtCreateAllTemplates ();
293f5f76cf2SSascha Wildner goto Exit;
294f5f76cf2SSascha Wildner }
295f5f76cf2SSascha Wildner
296f5f76cf2SSascha Wildner /*
297f5f76cf2SSascha Wildner * Normal case: Create template for each signature
298f5f76cf2SSascha Wildner */
299f5f76cf2SSascha Wildner while (argv[AcpiGbl_Optind])
300f5f76cf2SSascha Wildner {
301f5f76cf2SSascha Wildner Signature = argv[AcpiGbl_Optind];
302f5f76cf2SSascha Wildner AcpiUtStrupr (Signature);
303f5f76cf2SSascha Wildner
304f5f76cf2SSascha Wildner Status = DtCreateOneTemplateFile (Signature, 0);
305f5f76cf2SSascha Wildner if (ACPI_FAILURE (Status))
306f5f76cf2SSascha Wildner {
307f5f76cf2SSascha Wildner goto Exit;
308f5f76cf2SSascha Wildner }
309f5f76cf2SSascha Wildner
310f5f76cf2SSascha Wildner AcpiGbl_Optind++;
311f5f76cf2SSascha Wildner }
312f5f76cf2SSascha Wildner
313f5f76cf2SSascha Wildner
314f5f76cf2SSascha Wildner Exit:
315f5f76cf2SSascha Wildner /* Shutdown ACPICA subsystem */
316f5f76cf2SSascha Wildner
317f5f76cf2SSascha Wildner (void) AcpiTerminate ();
3187bcb6cafSSascha Wildner UtDeleteLocalCaches ();
31912673cf1SSascha Wildner return (Status);
32012673cf1SSascha Wildner }
32112673cf1SSascha Wildner
322f5f76cf2SSascha Wildner
323f5f76cf2SSascha Wildner /*******************************************************************************
324f5f76cf2SSascha Wildner *
325f5f76cf2SSascha Wildner * FUNCTION: DtCreateOneTemplateFile
326f5f76cf2SSascha Wildner *
327f5f76cf2SSascha Wildner * PARAMETERS: Signature - ACPI table signature
328f5f76cf2SSascha Wildner *
329f5f76cf2SSascha Wildner * RETURN: Status
330f5f76cf2SSascha Wildner *
331f5f76cf2SSascha Wildner * DESCRIPTION: Create one template file of the requested signature.
332f5f76cf2SSascha Wildner *
333f5f76cf2SSascha Wildner ******************************************************************************/
334f5f76cf2SSascha Wildner
335f5f76cf2SSascha Wildner static ACPI_STATUS
DtCreateOneTemplateFile(char * Signature,UINT32 TableCount)336f5f76cf2SSascha Wildner DtCreateOneTemplateFile (
337f5f76cf2SSascha Wildner char *Signature,
338f5f76cf2SSascha Wildner UINT32 TableCount)
339f5f76cf2SSascha Wildner {
340f5f76cf2SSascha Wildner const ACPI_DMTABLE_DATA *TableData;
341f5f76cf2SSascha Wildner ACPI_STATUS Status;
342f5f76cf2SSascha Wildner
343f5f76cf2SSascha Wildner
3440d02842fSSascha Wildner /*
3450d02842fSSascha Wildner * Validate signature and get the template data:
3460d02842fSSascha Wildner * 1) Signature must be 4 characters
3470d02842fSSascha Wildner * 2) Signature must be a recognized ACPI table
3480d02842fSSascha Wildner * 3) There must be a template associated with the signature
3490d02842fSSascha Wildner */
350c1776041SSascha Wildner if (strlen (Signature) != ACPI_NAMESEG_SIZE)
3510d02842fSSascha Wildner {
3520d02842fSSascha Wildner fprintf (stderr,
353f5f76cf2SSascha Wildner "%s: Invalid ACPI table signature "
354f5f76cf2SSascha Wildner "(length must be 4 characters)\n", Signature);
3550d02842fSSascha Wildner return (AE_ERROR);
3560d02842fSSascha Wildner }
3570d02842fSSascha Wildner
3580d02842fSSascha Wildner /*
3590d02842fSSascha Wildner * Some slack for the two strange tables whose name is different than
3600d02842fSSascha Wildner * their signatures: MADT->APIC and FADT->FACP.
3610d02842fSSascha Wildner */
3620d02842fSSascha Wildner if (!strcmp (Signature, "MADT"))
3630d02842fSSascha Wildner {
3640d02842fSSascha Wildner Signature = "APIC";
3650d02842fSSascha Wildner }
3660d02842fSSascha Wildner else if (!strcmp (Signature, "FADT"))
3670d02842fSSascha Wildner {
3680d02842fSSascha Wildner Signature = "FACP";
3690d02842fSSascha Wildner }
3700d02842fSSascha Wildner
371f5f76cf2SSascha Wildner /* TableData will point to the template */
372f5f76cf2SSascha Wildner
3730d02842fSSascha Wildner TableData = AcpiDmGetTableData (Signature);
3740d02842fSSascha Wildner if (TableData)
3750d02842fSSascha Wildner {
3760d02842fSSascha Wildner if (!TableData->Template)
3770d02842fSSascha Wildner {
3780d02842fSSascha Wildner fprintf (stderr, "%4.4s: No template available\n", Signature);
3790d02842fSSascha Wildner return (AE_ERROR);
3800d02842fSSascha Wildner }
3810d02842fSSascha Wildner }
3820d02842fSSascha Wildner else if (!AcpiUtIsSpecialTable (Signature))
3830d02842fSSascha Wildner {
3840d02842fSSascha Wildner fprintf (stderr,
3850d02842fSSascha Wildner "%4.4s: Unrecognized ACPI table signature\n", Signature);
3860d02842fSSascha Wildner return (AE_ERROR);
3870d02842fSSascha Wildner }
3880d02842fSSascha Wildner
389f5f76cf2SSascha Wildner Status = DtCreateOneTemplate (Signature, TableCount, TableData);
3900d02842fSSascha Wildner return (Status);
3910d02842fSSascha Wildner }
3920d02842fSSascha Wildner
3930d02842fSSascha Wildner
3940d02842fSSascha Wildner /*******************************************************************************
3950d02842fSSascha Wildner *
3960d02842fSSascha Wildner * FUNCTION: DtCreateAllTemplates
3970d02842fSSascha Wildner *
3980d02842fSSascha Wildner * PARAMETERS: None
3990d02842fSSascha Wildner *
4000d02842fSSascha Wildner * RETURN: Status
4010d02842fSSascha Wildner *
4020d02842fSSascha Wildner * DESCRIPTION: Create all currently defined template files
4030d02842fSSascha Wildner *
4040d02842fSSascha Wildner ******************************************************************************/
4050d02842fSSascha Wildner
4060d02842fSSascha Wildner static ACPI_STATUS
DtCreateAllTemplates(void)4070d02842fSSascha Wildner DtCreateAllTemplates (
4080d02842fSSascha Wildner void)
4090d02842fSSascha Wildner {
410896f2e3aSSascha Wildner const ACPI_DMTABLE_DATA *TableData;
4110d02842fSSascha Wildner ACPI_STATUS Status;
4120d02842fSSascha Wildner
4130d02842fSSascha Wildner
4140d02842fSSascha Wildner fprintf (stderr, "Creating all supported Template files\n");
4150d02842fSSascha Wildner
4160d02842fSSascha Wildner /* Walk entire ACPI table data structure */
4170d02842fSSascha Wildner
4180d02842fSSascha Wildner for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
4190d02842fSSascha Wildner {
4200d02842fSSascha Wildner /* If table has a template, create the template file */
4210d02842fSSascha Wildner
4220d02842fSSascha Wildner if (TableData->Template)
4230d02842fSSascha Wildner {
4240d02842fSSascha Wildner Status = DtCreateOneTemplate (TableData->Signature,
425f5f76cf2SSascha Wildner 0, TableData);
4260d02842fSSascha Wildner if (ACPI_FAILURE (Status))
4270d02842fSSascha Wildner {
4280d02842fSSascha Wildner return (Status);
4290d02842fSSascha Wildner }
4300d02842fSSascha Wildner }
4310d02842fSSascha Wildner }
4320d02842fSSascha Wildner
4330d02842fSSascha Wildner /*
4340d02842fSSascha Wildner * Create the special ACPI tables:
4350d02842fSSascha Wildner * 1) DSDT/SSDT are AML tables, not data tables
4360d02842fSSascha Wildner * 2) FACS and RSDP have non-standard headers
4370d02842fSSascha Wildner */
438f5f76cf2SSascha Wildner Status = DtCreateOneTemplate (ACPI_SIG_DSDT, 0, NULL);
4390d02842fSSascha Wildner if (ACPI_FAILURE (Status))
4400d02842fSSascha Wildner {
4410d02842fSSascha Wildner return (Status);
4420d02842fSSascha Wildner }
4430d02842fSSascha Wildner
444f5f76cf2SSascha Wildner Status = DtCreateOneTemplate (ACPI_SIG_SSDT, 0, NULL);
4450d02842fSSascha Wildner if (ACPI_FAILURE (Status))
4460d02842fSSascha Wildner {
4470d02842fSSascha Wildner return (Status);
4480d02842fSSascha Wildner }
4490d02842fSSascha Wildner
450f5f76cf2SSascha Wildner Status = DtCreateOneTemplate (ACPI_SIG_OSDT, 0, NULL);
4510d02842fSSascha Wildner if (ACPI_FAILURE (Status))
4520d02842fSSascha Wildner {
4530d02842fSSascha Wildner return (Status);
4540d02842fSSascha Wildner }
4550d02842fSSascha Wildner
456f5f76cf2SSascha Wildner Status = DtCreateOneTemplate (ACPI_SIG_FACS, 0, NULL);
457f5f76cf2SSascha Wildner if (ACPI_FAILURE (Status))
458f5f76cf2SSascha Wildner {
459f5f76cf2SSascha Wildner return (Status);
460f5f76cf2SSascha Wildner }
461f5f76cf2SSascha Wildner
462f5f76cf2SSascha Wildner Status = DtCreateOneTemplate (ACPI_RSDP_NAME, 0, NULL);
4630d02842fSSascha Wildner if (ACPI_FAILURE (Status))
4640d02842fSSascha Wildner {
4650d02842fSSascha Wildner return (Status);
4660d02842fSSascha Wildner }
4670d02842fSSascha Wildner
4680d02842fSSascha Wildner return (AE_OK);
4690d02842fSSascha Wildner }
4700d02842fSSascha Wildner
4710d02842fSSascha Wildner
4720d02842fSSascha Wildner /*******************************************************************************
4730d02842fSSascha Wildner *
4740d02842fSSascha Wildner * FUNCTION: DtCreateOneTemplate
4750d02842fSSascha Wildner *
4760d02842fSSascha Wildner * PARAMETERS: Signature - ACPI signature, NULL terminated.
477f5f76cf2SSascha Wildner * TableCount - Used for SSDTs in same file as DSDT
4780d02842fSSascha Wildner * TableData - Entry in ACPI table data structure.
4790d02842fSSascha Wildner * NULL if a special ACPI table.
4800d02842fSSascha Wildner *
4810d02842fSSascha Wildner * RETURN: Status
4820d02842fSSascha Wildner *
4830d02842fSSascha Wildner * DESCRIPTION: Create one template source file for the requested ACPI table.
4840d02842fSSascha Wildner *
4850d02842fSSascha Wildner ******************************************************************************/
4860d02842fSSascha Wildner
4870d02842fSSascha Wildner static ACPI_STATUS
DtCreateOneTemplate(char * Signature,UINT32 TableCount,const ACPI_DMTABLE_DATA * TableData)4880d02842fSSascha Wildner DtCreateOneTemplate (
4890d02842fSSascha Wildner char *Signature,
490f5f76cf2SSascha Wildner UINT32 TableCount,
491896f2e3aSSascha Wildner const ACPI_DMTABLE_DATA *TableData)
4920d02842fSSascha Wildner {
4930d02842fSSascha Wildner char *DisasmFilename;
4940d02842fSSascha Wildner FILE *File;
4950d02842fSSascha Wildner ACPI_STATUS Status = AE_OK;
496f5f76cf2SSascha Wildner int Actual;
497f5f76cf2SSascha Wildner UINT32 i;
4980d02842fSSascha Wildner
4990d02842fSSascha Wildner
5000d02842fSSascha Wildner /* New file will have a .asl suffix */
5010d02842fSSascha Wildner
5020d02842fSSascha Wildner DisasmFilename = FlGenerateFilename (
5030d02842fSSascha Wildner Signature, FILE_SUFFIX_ASL_CODE);
5040d02842fSSascha Wildner if (!DisasmFilename)
5050d02842fSSascha Wildner {
5060d02842fSSascha Wildner fprintf (stderr, "Could not generate output filename\n");
5070d02842fSSascha Wildner return (AE_ERROR);
5080d02842fSSascha Wildner }
5090d02842fSSascha Wildner
51012673cf1SSascha Wildner AcpiUtStrlwr (DisasmFilename);
511f5f76cf2SSascha Wildner if (!UtQueryForOverwrite (DisasmFilename))
512f5f76cf2SSascha Wildner {
513e5412f1eSSascha Wildner return (AE_OK);
514f5f76cf2SSascha Wildner }
515f5f76cf2SSascha Wildner
5160d02842fSSascha Wildner File = fopen (DisasmFilename, "w+");
5170d02842fSSascha Wildner if (!File)
5180d02842fSSascha Wildner {
519f5f76cf2SSascha Wildner fprintf (stderr, "Could not open output file %s\n",
520f5f76cf2SSascha Wildner DisasmFilename);
5210d02842fSSascha Wildner return (AE_ERROR);
5220d02842fSSascha Wildner }
5230d02842fSSascha Wildner
5240d02842fSSascha Wildner /* Emit the common file header */
5250d02842fSSascha Wildner
5260d02842fSSascha Wildner AcpiOsRedirectOutput (File);
5270d02842fSSascha Wildner
5280d02842fSSascha Wildner AcpiOsPrintf ("/*\n");
5290d02842fSSascha Wildner AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
5300d02842fSSascha Wildner
531f5f76cf2SSascha Wildner if (TableCount == 0)
532f5f76cf2SSascha Wildner {
53325ca8c79SSascha Wildner AcpiOsPrintf (" * Template for [%4.4s] ACPI Table",
5340d02842fSSascha Wildner Signature);
535f5f76cf2SSascha Wildner }
536f5f76cf2SSascha Wildner else
537f5f76cf2SSascha Wildner {
538f5f76cf2SSascha Wildner AcpiOsPrintf (" * Template for [%4.4s] and %u [SSDT] ACPI Tables",
539f5f76cf2SSascha Wildner Signature, TableCount);
540f5f76cf2SSascha Wildner }
5410d02842fSSascha Wildner
5420d02842fSSascha Wildner /* Dump the actual ACPI table */
5430d02842fSSascha Wildner
5440d02842fSSascha Wildner if (TableData)
5450d02842fSSascha Wildner {
5460d02842fSSascha Wildner /* Normal case, tables that appear in AcpiDmTableData */
5470d02842fSSascha Wildner
54825ca8c79SSascha Wildner AcpiOsPrintf (" (static data table)\n");
54925ca8c79SSascha Wildner
550806343b9SSascha Wildner if (AslGbl_VerboseTemplates)
5510d02842fSSascha Wildner {
5520d02842fSSascha Wildner AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
5530d02842fSSascha Wildner " FieldName : HexFieldValue\n */\n\n");
5540d02842fSSascha Wildner }
5550d02842fSSascha Wildner else
5560d02842fSSascha Wildner {
5570d02842fSSascha Wildner AcpiOsPrintf (" * Format: [ByteLength]"
55825ca8c79SSascha Wildner " FieldName : HexFieldValue\n */\n");
5590d02842fSSascha Wildner }
5600d02842fSSascha Wildner
5610d02842fSSascha Wildner AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
5620d02842fSSascha Wildner TableData->Template));
5630d02842fSSascha Wildner }
5640d02842fSSascha Wildner else
5650d02842fSSascha Wildner {
566f5f76cf2SSascha Wildner /* Special ACPI tables - DSDT, SSDT, OSDT, FACS, RSDP */
5670d02842fSSascha Wildner
56825ca8c79SSascha Wildner AcpiOsPrintf (" (AML byte code table)\n");
56912673cf1SSascha Wildner AcpiOsPrintf (" */\n");
570f5f76cf2SSascha Wildner
571c1776041SSascha Wildner if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_DSDT))
5720d02842fSSascha Wildner {
573f5f76cf2SSascha Wildner Actual = DtEmitDefinitionBlock (
574f5f76cf2SSascha Wildner File, DisasmFilename, ACPI_SIG_DSDT, 1);
575f5f76cf2SSascha Wildner if (Actual < 0)
5760d02842fSSascha Wildner {
577f5f76cf2SSascha Wildner Status = AE_ERROR;
578f5f76cf2SSascha Wildner goto Cleanup;
579f5f76cf2SSascha Wildner }
580f5f76cf2SSascha Wildner
581f5f76cf2SSascha Wildner /* Emit any requested SSDTs into the same file */
582f5f76cf2SSascha Wildner
583f5f76cf2SSascha Wildner for (i = 1; i <= TableCount; i++)
584f5f76cf2SSascha Wildner {
585f5f76cf2SSascha Wildner Actual = DtEmitDefinitionBlock (
586f5f76cf2SSascha Wildner File, DisasmFilename, ACPI_SIG_SSDT, i + 1);
587f5f76cf2SSascha Wildner if (Actual < 0)
588f5f76cf2SSascha Wildner {
58927624239SSascha Wildner Status = AE_ERROR;
59027624239SSascha Wildner goto Cleanup;
59127624239SSascha Wildner }
59227624239SSascha Wildner }
593f5f76cf2SSascha Wildner }
594c1776041SSascha Wildner else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT))
5950d02842fSSascha Wildner {
596f5f76cf2SSascha Wildner Actual = DtEmitDefinitionBlock (
597f5f76cf2SSascha Wildner File, DisasmFilename, ACPI_SIG_SSDT, 1);
598f5f76cf2SSascha Wildner if (Actual < 0)
5990d02842fSSascha Wildner {
6000d02842fSSascha Wildner Status = AE_ERROR;
6010d02842fSSascha Wildner goto Cleanup;
6020d02842fSSascha Wildner }
6030d02842fSSascha Wildner }
604c1776041SSascha Wildner else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_OSDT))
60525ca8c79SSascha Wildner {
606f5f76cf2SSascha Wildner Actual = DtEmitDefinitionBlock (
607f5f76cf2SSascha Wildner File, DisasmFilename, ACPI_SIG_OSDT, 1);
608f5f76cf2SSascha Wildner if (Actual < 0)
60925ca8c79SSascha Wildner {
61025ca8c79SSascha Wildner Status = AE_ERROR;
61125ca8c79SSascha Wildner goto Cleanup;
61225ca8c79SSascha Wildner }
61325ca8c79SSascha Wildner }
614c1776041SSascha Wildner else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_FACS))
6150d02842fSSascha Wildner {
6160d02842fSSascha Wildner AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
6170d02842fSSascha Wildner TemplateFacs));
6180d02842fSSascha Wildner }
619c1776041SSascha Wildner else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_RSDP_NAME))
6200d02842fSSascha Wildner {
6210d02842fSSascha Wildner AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
6220d02842fSSascha Wildner TemplateRsdp));
6230d02842fSSascha Wildner }
6240d02842fSSascha Wildner else
6250d02842fSSascha Wildner {
6260d02842fSSascha Wildner fprintf (stderr,
6270d02842fSSascha Wildner "%4.4s, Unrecognized ACPI table signature\n", Signature);
6280d02842fSSascha Wildner Status = AE_ERROR;
6290d02842fSSascha Wildner goto Cleanup;
6300d02842fSSascha Wildner }
6310d02842fSSascha Wildner }
6320d02842fSSascha Wildner
633f5f76cf2SSascha Wildner if (TableCount == 0)
634f5f76cf2SSascha Wildner {
6350d02842fSSascha Wildner fprintf (stderr,
636f5f76cf2SSascha Wildner "Created ACPI table template for [%4.4s], "
637f5f76cf2SSascha Wildner "written to \"%s\"\n",
6380d02842fSSascha Wildner Signature, DisasmFilename);
639f5f76cf2SSascha Wildner }
640f5f76cf2SSascha Wildner else
641f5f76cf2SSascha Wildner {
642f5f76cf2SSascha Wildner fprintf (stderr,
643f5f76cf2SSascha Wildner "Created ACPI table templates for [%4.4s] "
64408343eafSSascha Wildner "and %u [SSDT] in same file, written to \"%s\"\n",
645f5f76cf2SSascha Wildner Signature, TableCount, DisasmFilename);
646f5f76cf2SSascha Wildner }
6470d02842fSSascha Wildner
6480d02842fSSascha Wildner Cleanup:
6490d02842fSSascha Wildner fclose (File);
6500d02842fSSascha Wildner AcpiOsRedirectOutput (stdout);
6510d02842fSSascha Wildner return (Status);
6520d02842fSSascha Wildner }
653f5f76cf2SSascha Wildner
654f5f76cf2SSascha Wildner
655f5f76cf2SSascha Wildner /*******************************************************************************
656f5f76cf2SSascha Wildner *
657f5f76cf2SSascha Wildner * FUNCTION: DtEmitDefinitionBlock
658f5f76cf2SSascha Wildner *
659f5f76cf2SSascha Wildner * PARAMETERS: File - An open file for the block
660f5f76cf2SSascha Wildner * Filename - Filename for same, for error msg(s)
661f5f76cf2SSascha Wildner * Signature - ACPI signature for the block
662f5f76cf2SSascha Wildner * Instance - Used for multiple SSDTs in the same file
663f5f76cf2SSascha Wildner *
664f5f76cf2SSascha Wildner * RETURN: Status from fprintf
665f5f76cf2SSascha Wildner *
666f5f76cf2SSascha Wildner * DESCRIPTION: Emit the raw ASL for a complete Definition Block (DSDT or SSDT)
667f5f76cf2SSascha Wildner *
668f5f76cf2SSascha Wildner * Note: The AMLFileName parameter for DefinitionBlock is left as a NULL
669f5f76cf2SSascha Wildner * string. This allows the compiler to create the output AML filename from
670f5f76cf2SSascha Wildner * the input filename.
671f5f76cf2SSascha Wildner *
672f5f76cf2SSascha Wildner ******************************************************************************/
673f5f76cf2SSascha Wildner
674f5f76cf2SSascha Wildner static int
DtEmitDefinitionBlock(FILE * File,char * Filename,char * Signature,UINT32 Instance)675f5f76cf2SSascha Wildner DtEmitDefinitionBlock (
676f5f76cf2SSascha Wildner FILE *File,
677f5f76cf2SSascha Wildner char *Filename,
678f5f76cf2SSascha Wildner char *Signature,
679f5f76cf2SSascha Wildner UINT32 Instance)
680f5f76cf2SSascha Wildner {
681f5f76cf2SSascha Wildner int Status;
682f5f76cf2SSascha Wildner
683f5f76cf2SSascha Wildner
684f5f76cf2SSascha Wildner Status = fprintf (File,
685f5f76cf2SSascha Wildner "DefinitionBlock (\"\", \"%4.4s\", 2, \"Intel\", \"_%4.4s_%.2X\", 0x00000001)\n"
686f5f76cf2SSascha Wildner "{\n"
687f5f76cf2SSascha Wildner " Method (%2.2s%.2X)\n"
688f5f76cf2SSascha Wildner " {\n"
689f5f76cf2SSascha Wildner " }\n"
690f5f76cf2SSascha Wildner "}\n\n",
691f5f76cf2SSascha Wildner Signature, Signature, Instance, Signature, Instance);
692f5f76cf2SSascha Wildner
693f5f76cf2SSascha Wildner if (Status < 0)
694f5f76cf2SSascha Wildner {
695f5f76cf2SSascha Wildner fprintf (stderr,
696f5f76cf2SSascha Wildner "Could not write %4.4s to output file %s\n",
697f5f76cf2SSascha Wildner Signature, Filename);
698f5f76cf2SSascha Wildner }
699f5f76cf2SSascha Wildner
700f5f76cf2SSascha Wildner return (Status);
701f5f76cf2SSascha Wildner }
702