xref: /illumos-gate/usr/src/cmd/acpi/iasl/dttemplate.c (revision 35786f68)
1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts  *
3bc36eafdSMike Gerdts  * Module Name: dttemplate - ACPI table template generation
4bc36eafdSMike Gerdts  *
5bc36eafdSMike Gerdts  *****************************************************************************/
6bc36eafdSMike Gerdts 
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi  *
9*35786f68SRobert Mustacchi  * 1. Copyright Notice
10*35786f68SRobert Mustacchi  *
11*35786f68SRobert Mustacchi  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts  * All rights reserved.
13bc36eafdSMike Gerdts  *
14*35786f68SRobert Mustacchi  * 2. License
15*35786f68SRobert Mustacchi  *
16*35786f68SRobert Mustacchi  * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi  * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi  * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi  * property rights.
20*35786f68SRobert Mustacchi  *
21*35786f68SRobert Mustacchi  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi  * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi  * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi  * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi  *
28*35786f68SRobert Mustacchi  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi  * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi  * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi  * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi  * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi  * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi  * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi  *
37*35786f68SRobert Mustacchi  * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi  * conditions are met:
39*35786f68SRobert Mustacchi  *
40*35786f68SRobert Mustacchi  * 3. Conditions
41*35786f68SRobert Mustacchi  *
42*35786f68SRobert Mustacchi  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi  * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi  * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi  * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi  * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi  * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi  * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi  * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi  * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi  * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi  *
54*35786f68SRobert Mustacchi  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi  * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi  * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi  * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi  * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi  * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi  * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi  * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi  * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi  * make.
65*35786f68SRobert Mustacchi  *
66*35786f68SRobert Mustacchi  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi  * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi  * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi  * distribution.
71*35786f68SRobert Mustacchi  *
72*35786f68SRobert Mustacchi  * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi  * Intel Code.
74*35786f68SRobert Mustacchi  *
75*35786f68SRobert Mustacchi  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi  * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi  * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi  *
80*35786f68SRobert Mustacchi  * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi  *
82*35786f68SRobert Mustacchi  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi  * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi  *
90*35786f68SRobert Mustacchi  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi  * LIMITED REMEDY.
98*35786f68SRobert Mustacchi  *
99*35786f68SRobert Mustacchi  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi  * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi  * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi  * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi  * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi  * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi  * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi  * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi  * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi  * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi  * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi  * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi  * such license, approval or letter.
113*35786f68SRobert Mustacchi  *
114*35786f68SRobert Mustacchi  *****************************************************************************
115*35786f68SRobert Mustacchi  *
116*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi  * following license:
118*35786f68SRobert Mustacchi  *
119bc36eafdSMike Gerdts  * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts  * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts  * are met:
122bc36eafdSMike Gerdts  * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts  *    notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts  *    without modification.
125bc36eafdSMike Gerdts  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts  *    substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts  *    ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts  *    including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts  *    binary redistribution.
130bc36eafdSMike Gerdts  * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts  *    of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts  *    from this software without specific prior written permission.
133bc36eafdSMike Gerdts  *
134bc36eafdSMike Gerdts  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135bc36eafdSMike Gerdts  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137bc36eafdSMike Gerdts  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi  *
146*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi  * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi  * Software Foundation.
149*35786f68SRobert Mustacchi  *
150*35786f68SRobert Mustacchi  *****************************************************************************/
151bc36eafdSMike Gerdts 
152bc36eafdSMike Gerdts #include "aslcompiler.h"
153bc36eafdSMike Gerdts #include "acapps.h"
154bc36eafdSMike Gerdts #include "dttemplate.h" /* Contains the hex ACPI table templates */
155bc36eafdSMike Gerdts 
156bc36eafdSMike Gerdts #define _COMPONENT          DT_COMPILER
157bc36eafdSMike Gerdts         ACPI_MODULE_NAME    ("dttemplate")
158bc36eafdSMike Gerdts 
159bc36eafdSMike Gerdts 
160bc36eafdSMike Gerdts /* Local prototypes */
161bc36eafdSMike Gerdts 
162bc36eafdSMike Gerdts static BOOLEAN
163bc36eafdSMike Gerdts AcpiUtIsSpecialTable (
164bc36eafdSMike Gerdts     char                    *Signature);
165bc36eafdSMike Gerdts 
166bc36eafdSMike Gerdts static ACPI_STATUS
167bc36eafdSMike Gerdts DtCreateOneTemplateFile (
168bc36eafdSMike Gerdts     char                    *Signature,
169bc36eafdSMike Gerdts     UINT32                  TableCount);
170bc36eafdSMike Gerdts 
171bc36eafdSMike Gerdts static ACPI_STATUS
172bc36eafdSMike Gerdts DtCreateOneTemplate (
173bc36eafdSMike Gerdts     char                    *Signature,
174bc36eafdSMike Gerdts     UINT32                  TableCount,
175bc36eafdSMike Gerdts     const ACPI_DMTABLE_DATA *TableData);
176bc36eafdSMike Gerdts 
177bc36eafdSMike Gerdts static ACPI_STATUS
178bc36eafdSMike Gerdts DtCreateAllTemplates (
179bc36eafdSMike Gerdts     void);
180bc36eafdSMike Gerdts 
181bc36eafdSMike Gerdts static int
182bc36eafdSMike Gerdts DtEmitDefinitionBlock (
183bc36eafdSMike Gerdts     FILE                    *File,
184bc36eafdSMike Gerdts     char                    *Filename,
185bc36eafdSMike Gerdts     char                    *Signature,
186bc36eafdSMike Gerdts     UINT32                  Instance);
187bc36eafdSMike Gerdts 
188bc36eafdSMike Gerdts 
189bc36eafdSMike Gerdts /*******************************************************************************
190bc36eafdSMike Gerdts  *
191bc36eafdSMike Gerdts  * FUNCTION:    AcpiUtIsSpecialTable
192bc36eafdSMike Gerdts  *
193bc36eafdSMike Gerdts  * PARAMETERS:  Signature           - ACPI table signature
194bc36eafdSMike Gerdts  *
195bc36eafdSMike Gerdts  * RETURN:      TRUE if signature is a special ACPI table
196bc36eafdSMike Gerdts  *
197bc36eafdSMike Gerdts  * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
198bc36eafdSMike Gerdts  *              table data structure (AcpiDmTableData).
199bc36eafdSMike Gerdts  *
200bc36eafdSMike Gerdts  ******************************************************************************/
201bc36eafdSMike Gerdts 
202bc36eafdSMike Gerdts static BOOLEAN
AcpiUtIsSpecialTable(char * Signature)203bc36eafdSMike Gerdts AcpiUtIsSpecialTable (
204bc36eafdSMike Gerdts     char                    *Signature)
205bc36eafdSMike Gerdts {
206bc36eafdSMike Gerdts 
207bc36eafdSMike Gerdts     if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT) ||
208bc36eafdSMike Gerdts         ACPI_COMPARE_NAME (Signature, ACPI_SIG_OSDT) ||
209bc36eafdSMike Gerdts         ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT) ||
210bc36eafdSMike Gerdts         ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS) ||
211bc36eafdSMike Gerdts         ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
212bc36eafdSMike Gerdts     {
213bc36eafdSMike Gerdts         return (TRUE);
214bc36eafdSMike Gerdts     }
215bc36eafdSMike Gerdts 
216bc36eafdSMike Gerdts     return (FALSE);
217bc36eafdSMike Gerdts }
218bc36eafdSMike Gerdts 
219bc36eafdSMike Gerdts 
220bc36eafdSMike Gerdts /*******************************************************************************
221bc36eafdSMike Gerdts  *
222bc36eafdSMike Gerdts  * FUNCTION:    DtCreateTemplates
223bc36eafdSMike Gerdts  *
224bc36eafdSMike Gerdts  * PARAMETERS:  argv                - Standard command line arguments
225bc36eafdSMike Gerdts  *
226bc36eafdSMike Gerdts  * RETURN:      Status
227bc36eafdSMike Gerdts  *
228bc36eafdSMike Gerdts  * DESCRIPTION: Create one or more template files.
229bc36eafdSMike Gerdts  *
230bc36eafdSMike Gerdts  ******************************************************************************/
231bc36eafdSMike Gerdts 
232bc36eafdSMike Gerdts ACPI_STATUS
DtCreateTemplates(char ** argv)233bc36eafdSMike Gerdts DtCreateTemplates (
234bc36eafdSMike Gerdts     char                    **argv)
235bc36eafdSMike Gerdts {
236bc36eafdSMike Gerdts     char                    *Signature;
237bc36eafdSMike Gerdts     char                    *End;
238bc36eafdSMike Gerdts     unsigned long           TableCount;
239bc36eafdSMike Gerdts     ACPI_STATUS             Status = AE_OK;
240bc36eafdSMike Gerdts 
241bc36eafdSMike Gerdts 
242bc36eafdSMike Gerdts     AslInitializeGlobals ();
243bc36eafdSMike Gerdts 
244bc36eafdSMike Gerdts     Status = AdInitialize ();
245bc36eafdSMike Gerdts     if (ACPI_FAILURE (Status))
246bc36eafdSMike Gerdts     {
247bc36eafdSMike Gerdts         return (Status);
248bc36eafdSMike Gerdts     }
249bc36eafdSMike Gerdts 
250bc36eafdSMike Gerdts     /*
251bc36eafdSMike Gerdts      * Special cases for DSDT, ALL, and '*'
252bc36eafdSMike Gerdts      */
253bc36eafdSMike Gerdts 
254bc36eafdSMike Gerdts     /* Default (no signature option) is DSDT */
255bc36eafdSMike Gerdts 
256bc36eafdSMike Gerdts     if (AcpiGbl_Optind < 3)
257bc36eafdSMike Gerdts     {
258bc36eafdSMike Gerdts         Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, 0);
259bc36eafdSMike Gerdts         goto Exit;
260bc36eafdSMike Gerdts     }
261bc36eafdSMike Gerdts 
262bc36eafdSMike Gerdts     AcpiGbl_Optind--;
263bc36eafdSMike Gerdts     Signature = argv[AcpiGbl_Optind];
264bc36eafdSMike Gerdts     AcpiUtStrupr (Signature);
265bc36eafdSMike Gerdts 
266bc36eafdSMike Gerdts     /*
267bc36eafdSMike Gerdts      * Multiple SSDT support (-T <ssdt count>)
268bc36eafdSMike Gerdts      */
269bc36eafdSMike Gerdts     TableCount = strtoul (Signature, &End, 0);
270bc36eafdSMike Gerdts     if (Signature != End)
271bc36eafdSMike Gerdts     {
272bc36eafdSMike Gerdts         /* The count is used for table ID and method name - max is 254(+1) */
273bc36eafdSMike Gerdts 
274bc36eafdSMike Gerdts         if (TableCount > 254)
275bc36eafdSMike Gerdts         {
276bc36eafdSMike Gerdts             fprintf (stderr, "%u SSDTs requested, maximum is 254\n",
277bc36eafdSMike Gerdts                 (unsigned int) TableCount);
278bc36eafdSMike Gerdts 
279bc36eafdSMike Gerdts             Status = AE_LIMIT;
280bc36eafdSMike Gerdts             goto Exit;
281bc36eafdSMike Gerdts         }
282bc36eafdSMike Gerdts 
283bc36eafdSMike Gerdts         Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, TableCount);
284bc36eafdSMike Gerdts         goto Exit;
285bc36eafdSMike Gerdts     }
286bc36eafdSMike Gerdts 
287bc36eafdSMike Gerdts     if (!strcmp (Signature, "ALL"))
288bc36eafdSMike Gerdts     {
289bc36eafdSMike Gerdts         /* Create all available/known templates */
290bc36eafdSMike Gerdts 
291bc36eafdSMike Gerdts         Status = DtCreateAllTemplates ();
292bc36eafdSMike Gerdts         goto Exit;
293bc36eafdSMike Gerdts     }
294bc36eafdSMike Gerdts 
295bc36eafdSMike Gerdts     /*
296bc36eafdSMike Gerdts      * Normal case: Create template for each signature
297bc36eafdSMike Gerdts      */
298bc36eafdSMike Gerdts     while (argv[AcpiGbl_Optind])
299bc36eafdSMike Gerdts     {
300bc36eafdSMike Gerdts         Signature = argv[AcpiGbl_Optind];
301bc36eafdSMike Gerdts         AcpiUtStrupr (Signature);
302bc36eafdSMike Gerdts 
303bc36eafdSMike Gerdts         Status = DtCreateOneTemplateFile (Signature, 0);
304bc36eafdSMike Gerdts         if (ACPI_FAILURE (Status))
305bc36eafdSMike Gerdts         {
306bc36eafdSMike Gerdts             goto Exit;
307bc36eafdSMike Gerdts         }
308bc36eafdSMike Gerdts 
309bc36eafdSMike Gerdts         AcpiGbl_Optind++;
310bc36eafdSMike Gerdts     }
311bc36eafdSMike Gerdts 
312bc36eafdSMike Gerdts 
313bc36eafdSMike Gerdts Exit:
314bc36eafdSMike Gerdts     /* Shutdown ACPICA subsystem */
315bc36eafdSMike Gerdts 
316bc36eafdSMike Gerdts     (void) AcpiTerminate ();
317*35786f68SRobert Mustacchi     UtDeleteLocalCaches ();
318bc36eafdSMike Gerdts     return (Status);
319bc36eafdSMike Gerdts }
320bc36eafdSMike Gerdts 
321bc36eafdSMike Gerdts 
322bc36eafdSMike Gerdts /*******************************************************************************
323bc36eafdSMike Gerdts  *
324bc36eafdSMike Gerdts  * FUNCTION:    DtCreateOneTemplateFile
325bc36eafdSMike Gerdts  *
326bc36eafdSMike Gerdts  * PARAMETERS:  Signature           - ACPI table signature
327bc36eafdSMike Gerdts  *
328bc36eafdSMike Gerdts  * RETURN:      Status
329bc36eafdSMike Gerdts  *
330bc36eafdSMike Gerdts  * DESCRIPTION: Create one template file of the requested signature.
331bc36eafdSMike Gerdts  *
332bc36eafdSMike Gerdts  ******************************************************************************/
333bc36eafdSMike Gerdts 
334bc36eafdSMike Gerdts static ACPI_STATUS
DtCreateOneTemplateFile(char * Signature,UINT32 TableCount)335bc36eafdSMike Gerdts DtCreateOneTemplateFile (
336bc36eafdSMike Gerdts     char                    *Signature,
337bc36eafdSMike Gerdts     UINT32                  TableCount)
338bc36eafdSMike Gerdts {
339bc36eafdSMike Gerdts     const ACPI_DMTABLE_DATA *TableData;
340bc36eafdSMike Gerdts     ACPI_STATUS             Status;
341bc36eafdSMike Gerdts 
342bc36eafdSMike Gerdts 
343bc36eafdSMike Gerdts     /*
344bc36eafdSMike Gerdts      * Validate signature and get the template data:
345bc36eafdSMike Gerdts      *  1) Signature must be 4 characters
346bc36eafdSMike Gerdts      *  2) Signature must be a recognized ACPI table
347bc36eafdSMike Gerdts      *  3) There must be a template associated with the signature
348bc36eafdSMike Gerdts      */
349bc36eafdSMike Gerdts     if (strlen (Signature) != ACPI_NAME_SIZE)
350bc36eafdSMike Gerdts     {
351bc36eafdSMike Gerdts         fprintf (stderr,
352bc36eafdSMike Gerdts             "%s: Invalid ACPI table signature "
353bc36eafdSMike Gerdts             "(length must be 4 characters)\n", Signature);
354bc36eafdSMike Gerdts         return (AE_ERROR);
355bc36eafdSMike Gerdts     }
356bc36eafdSMike Gerdts 
357bc36eafdSMike Gerdts     /*
358bc36eafdSMike Gerdts      * Some slack for the two strange tables whose name is different than
359bc36eafdSMike Gerdts      * their signatures: MADT->APIC and FADT->FACP.
360bc36eafdSMike Gerdts      */
361bc36eafdSMike Gerdts     if (!strcmp (Signature, "MADT"))
362bc36eafdSMike Gerdts     {
363bc36eafdSMike Gerdts         Signature = "APIC";
364bc36eafdSMike Gerdts     }
365bc36eafdSMike Gerdts     else if (!strcmp (Signature, "FADT"))
366bc36eafdSMike Gerdts     {
367bc36eafdSMike Gerdts         Signature = "FACP";
368bc36eafdSMike Gerdts     }
369bc36eafdSMike Gerdts 
370bc36eafdSMike Gerdts     /* TableData will point to the template */
371bc36eafdSMike Gerdts 
372bc36eafdSMike Gerdts     TableData = AcpiDmGetTableData (Signature);
373bc36eafdSMike Gerdts     if (TableData)
374bc36eafdSMike Gerdts     {
375bc36eafdSMike Gerdts         if (!TableData->Template)
376bc36eafdSMike Gerdts         {
377bc36eafdSMike Gerdts             fprintf (stderr, "%4.4s: No template available\n", Signature);
378bc36eafdSMike Gerdts             return (AE_ERROR);
379bc36eafdSMike Gerdts         }
380bc36eafdSMike Gerdts     }
381bc36eafdSMike Gerdts     else if (!AcpiUtIsSpecialTable (Signature))
382bc36eafdSMike Gerdts     {
383bc36eafdSMike Gerdts         fprintf (stderr,
384bc36eafdSMike Gerdts             "%4.4s: Unrecognized ACPI table signature\n", Signature);
385bc36eafdSMike Gerdts         return (AE_ERROR);
386bc36eafdSMike Gerdts     }
387bc36eafdSMike Gerdts 
388bc36eafdSMike Gerdts     Status = DtCreateOneTemplate (Signature, TableCount, TableData);
389bc36eafdSMike Gerdts     return (Status);
390bc36eafdSMike Gerdts }
391bc36eafdSMike Gerdts 
392bc36eafdSMike Gerdts 
393bc36eafdSMike Gerdts /*******************************************************************************
394bc36eafdSMike Gerdts  *
395bc36eafdSMike Gerdts  * FUNCTION:    DtCreateAllTemplates
396bc36eafdSMike Gerdts  *
397bc36eafdSMike Gerdts  * PARAMETERS:  None
398bc36eafdSMike Gerdts  *
399bc36eafdSMike Gerdts  * RETURN:      Status
400bc36eafdSMike Gerdts  *
401bc36eafdSMike Gerdts  * DESCRIPTION: Create all currently defined template files
402bc36eafdSMike Gerdts  *
403bc36eafdSMike Gerdts  ******************************************************************************/
404bc36eafdSMike Gerdts 
405bc36eafdSMike Gerdts static ACPI_STATUS
DtCreateAllTemplates(void)406bc36eafdSMike Gerdts DtCreateAllTemplates (
407bc36eafdSMike Gerdts     void)
408bc36eafdSMike Gerdts {
409bc36eafdSMike Gerdts     const ACPI_DMTABLE_DATA *TableData;
410bc36eafdSMike Gerdts     ACPI_STATUS             Status;
411bc36eafdSMike Gerdts 
412bc36eafdSMike Gerdts 
413bc36eafdSMike Gerdts     fprintf (stderr, "Creating all supported Template files\n");
414bc36eafdSMike Gerdts 
415bc36eafdSMike Gerdts     /* Walk entire ACPI table data structure */
416bc36eafdSMike Gerdts 
417bc36eafdSMike Gerdts     for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
418bc36eafdSMike Gerdts     {
419bc36eafdSMike Gerdts         /* If table has a template, create the template file */
420bc36eafdSMike Gerdts 
421bc36eafdSMike Gerdts         if (TableData->Template)
422bc36eafdSMike Gerdts         {
423bc36eafdSMike Gerdts             Status = DtCreateOneTemplate (TableData->Signature,
424bc36eafdSMike Gerdts                 0, TableData);
425bc36eafdSMike Gerdts             if (ACPI_FAILURE (Status))
426bc36eafdSMike Gerdts             {
427bc36eafdSMike Gerdts                 return (Status);
428bc36eafdSMike Gerdts             }
429bc36eafdSMike Gerdts         }
430bc36eafdSMike Gerdts     }
431bc36eafdSMike Gerdts 
432bc36eafdSMike Gerdts     /*
433bc36eafdSMike Gerdts      * Create the special ACPI tables:
434bc36eafdSMike Gerdts      * 1) DSDT/SSDT are AML tables, not data tables
435bc36eafdSMike Gerdts      * 2) FACS and RSDP have non-standard headers
436bc36eafdSMike Gerdts      */
437bc36eafdSMike Gerdts     Status = DtCreateOneTemplate (ACPI_SIG_DSDT, 0, NULL);
438bc36eafdSMike Gerdts     if (ACPI_FAILURE (Status))
439bc36eafdSMike Gerdts     {
440bc36eafdSMike Gerdts         return (Status);
441bc36eafdSMike Gerdts     }
442bc36eafdSMike Gerdts 
443bc36eafdSMike Gerdts     Status = DtCreateOneTemplate (ACPI_SIG_SSDT, 0, NULL);
444bc36eafdSMike Gerdts     if (ACPI_FAILURE (Status))
445bc36eafdSMike Gerdts     {
446bc36eafdSMike Gerdts         return (Status);
447bc36eafdSMike Gerdts     }
448bc36eafdSMike Gerdts 
449bc36eafdSMike Gerdts     Status = DtCreateOneTemplate (ACPI_SIG_OSDT, 0, NULL);
450bc36eafdSMike Gerdts     if (ACPI_FAILURE (Status))
451bc36eafdSMike Gerdts     {
452bc36eafdSMike Gerdts         return (Status);
453bc36eafdSMike Gerdts     }
454bc36eafdSMike Gerdts 
455bc36eafdSMike Gerdts     Status = DtCreateOneTemplate (ACPI_SIG_FACS, 0, NULL);
456bc36eafdSMike Gerdts     if (ACPI_FAILURE (Status))
457bc36eafdSMike Gerdts     {
458bc36eafdSMike Gerdts         return (Status);
459bc36eafdSMike Gerdts     }
460bc36eafdSMike Gerdts 
461bc36eafdSMike Gerdts     Status = DtCreateOneTemplate (ACPI_RSDP_NAME, 0, NULL);
462bc36eafdSMike Gerdts     if (ACPI_FAILURE (Status))
463bc36eafdSMike Gerdts     {
464bc36eafdSMike Gerdts         return (Status);
465bc36eafdSMike Gerdts     }
466bc36eafdSMike Gerdts 
467bc36eafdSMike Gerdts     return (AE_OK);
468bc36eafdSMike Gerdts }
469bc36eafdSMike Gerdts 
470bc36eafdSMike Gerdts 
471bc36eafdSMike Gerdts /*******************************************************************************
472bc36eafdSMike Gerdts  *
473bc36eafdSMike Gerdts  * FUNCTION:    DtCreateOneTemplate
474bc36eafdSMike Gerdts  *
475bc36eafdSMike Gerdts  * PARAMETERS:  Signature           - ACPI signature, NULL terminated.
476bc36eafdSMike Gerdts  *              TableCount          - Used for SSDTs in same file as DSDT
477bc36eafdSMike Gerdts  *              TableData           - Entry in ACPI table data structure.
478bc36eafdSMike Gerdts  *                                    NULL if a special ACPI table.
479bc36eafdSMike Gerdts  *
480bc36eafdSMike Gerdts  * RETURN:      Status
481bc36eafdSMike Gerdts  *
482bc36eafdSMike Gerdts  * DESCRIPTION: Create one template source file for the requested ACPI table.
483bc36eafdSMike Gerdts  *
484bc36eafdSMike Gerdts  ******************************************************************************/
485bc36eafdSMike Gerdts 
486bc36eafdSMike Gerdts static ACPI_STATUS
DtCreateOneTemplate(char * Signature,UINT32 TableCount,const ACPI_DMTABLE_DATA * TableData)487bc36eafdSMike Gerdts DtCreateOneTemplate (
488bc36eafdSMike Gerdts     char                    *Signature,
489bc36eafdSMike Gerdts     UINT32                  TableCount,
490bc36eafdSMike Gerdts     const ACPI_DMTABLE_DATA  *TableData)
491bc36eafdSMike Gerdts {
492bc36eafdSMike Gerdts     char                    *DisasmFilename;
493bc36eafdSMike Gerdts     FILE                    *File;
494bc36eafdSMike Gerdts     ACPI_STATUS             Status = AE_OK;
495bc36eafdSMike Gerdts     int                     Actual;
496bc36eafdSMike Gerdts     UINT32                  i;
497bc36eafdSMike Gerdts 
498bc36eafdSMike Gerdts 
499bc36eafdSMike Gerdts     /* New file will have a .asl suffix */
500bc36eafdSMike Gerdts 
501bc36eafdSMike Gerdts     DisasmFilename = FlGenerateFilename (
502bc36eafdSMike Gerdts         Signature, FILE_SUFFIX_ASL_CODE);
503bc36eafdSMike Gerdts     if (!DisasmFilename)
504bc36eafdSMike Gerdts     {
505bc36eafdSMike Gerdts         fprintf (stderr, "Could not generate output filename\n");
506bc36eafdSMike Gerdts         return (AE_ERROR);
507bc36eafdSMike Gerdts     }
508bc36eafdSMike Gerdts 
509bc36eafdSMike Gerdts     AcpiUtStrlwr (DisasmFilename);
510bc36eafdSMike Gerdts     if (!UtQueryForOverwrite (DisasmFilename))
511bc36eafdSMike Gerdts     {
512bc36eafdSMike Gerdts         return (AE_ERROR);
513bc36eafdSMike Gerdts     }
514bc36eafdSMike Gerdts 
515bc36eafdSMike Gerdts     File = fopen (DisasmFilename, "w+");
516bc36eafdSMike Gerdts     if (!File)
517bc36eafdSMike Gerdts     {
518bc36eafdSMike Gerdts         fprintf (stderr, "Could not open output file %s\n",
519bc36eafdSMike Gerdts             DisasmFilename);
520bc36eafdSMike Gerdts         return (AE_ERROR);
521bc36eafdSMike Gerdts     }
522bc36eafdSMike Gerdts 
523bc36eafdSMike Gerdts     /* Emit the common file header */
524bc36eafdSMike Gerdts 
525bc36eafdSMike Gerdts     AcpiOsRedirectOutput (File);
526bc36eafdSMike Gerdts 
527bc36eafdSMike Gerdts     AcpiOsPrintf ("/*\n");
528bc36eafdSMike Gerdts     AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
529bc36eafdSMike Gerdts 
530bc36eafdSMike Gerdts     if (TableCount == 0)
531bc36eafdSMike Gerdts     {
532bc36eafdSMike Gerdts         AcpiOsPrintf (" * Template for [%4.4s] ACPI Table",
533bc36eafdSMike Gerdts             Signature);
534bc36eafdSMike Gerdts     }
535bc36eafdSMike Gerdts     else
536bc36eafdSMike Gerdts     {
537bc36eafdSMike Gerdts         AcpiOsPrintf (" * Template for [%4.4s] and %u [SSDT] ACPI Tables",
538bc36eafdSMike Gerdts             Signature, TableCount);
539bc36eafdSMike Gerdts     }
540bc36eafdSMike Gerdts 
541bc36eafdSMike Gerdts     /* Dump the actual ACPI table */
542bc36eafdSMike Gerdts 
543bc36eafdSMike Gerdts     if (TableData)
544bc36eafdSMike Gerdts     {
545bc36eafdSMike Gerdts         /* Normal case, tables that appear in AcpiDmTableData */
546bc36eafdSMike Gerdts 
547bc36eafdSMike Gerdts         AcpiOsPrintf (" (static data table)\n");
548bc36eafdSMike Gerdts 
549bc36eafdSMike Gerdts         if (Gbl_VerboseTemplates)
550bc36eafdSMike Gerdts         {
551bc36eafdSMike Gerdts             AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
552bc36eafdSMike Gerdts                 "  FieldName : HexFieldValue\n */\n\n");
553bc36eafdSMike Gerdts         }
554bc36eafdSMike Gerdts         else
555bc36eafdSMike Gerdts         {
556bc36eafdSMike Gerdts             AcpiOsPrintf (" * Format: [ByteLength]"
557bc36eafdSMike Gerdts                 "  FieldName : HexFieldValue\n */\n");
558bc36eafdSMike Gerdts         }
559bc36eafdSMike Gerdts 
560bc36eafdSMike Gerdts         AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
561bc36eafdSMike Gerdts             TableData->Template));
562bc36eafdSMike Gerdts     }
563bc36eafdSMike Gerdts     else
564bc36eafdSMike Gerdts     {
565bc36eafdSMike Gerdts         /* Special ACPI tables - DSDT, SSDT, OSDT, FACS, RSDP */
566bc36eafdSMike Gerdts 
567bc36eafdSMike Gerdts         AcpiOsPrintf (" (AML byte code table)\n");
568bc36eafdSMike Gerdts         AcpiOsPrintf (" */\n");
569bc36eafdSMike Gerdts 
570bc36eafdSMike Gerdts         if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))
571bc36eafdSMike Gerdts         {
572bc36eafdSMike Gerdts             Actual = DtEmitDefinitionBlock (
573bc36eafdSMike Gerdts                 File, DisasmFilename, ACPI_SIG_DSDT, 1);
574bc36eafdSMike Gerdts             if (Actual < 0)
575bc36eafdSMike Gerdts             {
576bc36eafdSMike Gerdts                 Status = AE_ERROR;
577bc36eafdSMike Gerdts                 goto Cleanup;
578bc36eafdSMike Gerdts             }
579bc36eafdSMike Gerdts 
580bc36eafdSMike Gerdts             /* Emit any requested SSDTs into the same file */
581bc36eafdSMike Gerdts 
582bc36eafdSMike Gerdts             for (i = 1; i <= TableCount; i++)
583bc36eafdSMike Gerdts             {
584bc36eafdSMike Gerdts                 Actual = DtEmitDefinitionBlock (
585bc36eafdSMike Gerdts                     File, DisasmFilename, ACPI_SIG_SSDT, i + 1);
586bc36eafdSMike Gerdts                 if (Actual < 0)
587bc36eafdSMike Gerdts                 {
588bc36eafdSMike Gerdts                     Status = AE_ERROR;
589bc36eafdSMike Gerdts                     goto Cleanup;
590bc36eafdSMike Gerdts                 }
591bc36eafdSMike Gerdts             }
592bc36eafdSMike Gerdts         }
593bc36eafdSMike Gerdts         else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))
594bc36eafdSMike Gerdts         {
595bc36eafdSMike Gerdts             Actual = DtEmitDefinitionBlock (
596bc36eafdSMike Gerdts                 File, DisasmFilename, ACPI_SIG_SSDT, 1);
597bc36eafdSMike Gerdts             if (Actual < 0)
598bc36eafdSMike Gerdts             {
599bc36eafdSMike Gerdts                 Status = AE_ERROR;
600bc36eafdSMike Gerdts                 goto Cleanup;
601bc36eafdSMike Gerdts             }
602bc36eafdSMike Gerdts         }
603bc36eafdSMike Gerdts         else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_OSDT))
604bc36eafdSMike Gerdts         {
605bc36eafdSMike Gerdts             Actual = DtEmitDefinitionBlock (
606bc36eafdSMike Gerdts                 File, DisasmFilename, ACPI_SIG_OSDT, 1);
607bc36eafdSMike Gerdts             if (Actual < 0)
608bc36eafdSMike Gerdts             {
609bc36eafdSMike Gerdts                 Status = AE_ERROR;
610bc36eafdSMike Gerdts                 goto Cleanup;
611bc36eafdSMike Gerdts             }
612bc36eafdSMike Gerdts         }
613bc36eafdSMike Gerdts         else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
614bc36eafdSMike Gerdts         {
615bc36eafdSMike Gerdts             AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
616bc36eafdSMike Gerdts                 TemplateFacs));
617bc36eafdSMike Gerdts         }
618bc36eafdSMike Gerdts         else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
619bc36eafdSMike Gerdts         {
620bc36eafdSMike Gerdts             AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
621bc36eafdSMike Gerdts                 TemplateRsdp));
622bc36eafdSMike Gerdts         }
623bc36eafdSMike Gerdts         else
624bc36eafdSMike Gerdts         {
625bc36eafdSMike Gerdts             fprintf (stderr,
626bc36eafdSMike Gerdts                 "%4.4s, Unrecognized ACPI table signature\n", Signature);
627bc36eafdSMike Gerdts             Status = AE_ERROR;
628bc36eafdSMike Gerdts             goto Cleanup;
629bc36eafdSMike Gerdts         }
630bc36eafdSMike Gerdts     }
631bc36eafdSMike Gerdts 
632bc36eafdSMike Gerdts     if (TableCount == 0)
633bc36eafdSMike Gerdts     {
634bc36eafdSMike Gerdts         fprintf (stderr,
635bc36eafdSMike Gerdts             "Created ACPI table template for [%4.4s], "
636bc36eafdSMike Gerdts             "written to \"%s\"\n",
637bc36eafdSMike Gerdts             Signature, DisasmFilename);
638bc36eafdSMike Gerdts     }
639bc36eafdSMike Gerdts     else
640bc36eafdSMike Gerdts     {
641bc36eafdSMike Gerdts         fprintf (stderr,
642bc36eafdSMike Gerdts             "Created ACPI table templates for [%4.4s] "
643bc36eafdSMike Gerdts             "and %u [SSDT], written to \"%s\"\n",
644bc36eafdSMike Gerdts             Signature, TableCount, DisasmFilename);
645bc36eafdSMike Gerdts     }
646bc36eafdSMike Gerdts 
647bc36eafdSMike Gerdts Cleanup:
648bc36eafdSMike Gerdts     fclose (File);
649bc36eafdSMike Gerdts     AcpiOsRedirectOutput (stdout);
650bc36eafdSMike Gerdts     return (Status);
651bc36eafdSMike Gerdts }
652bc36eafdSMike Gerdts 
653bc36eafdSMike Gerdts 
654bc36eafdSMike Gerdts /*******************************************************************************
655bc36eafdSMike Gerdts  *
656bc36eafdSMike Gerdts  * FUNCTION:    DtEmitDefinitionBlock
657bc36eafdSMike Gerdts  *
658bc36eafdSMike Gerdts  * PARAMETERS:  File                - An open file for the block
659bc36eafdSMike Gerdts  *              Filename            - Filename for same, for error msg(s)
660bc36eafdSMike Gerdts  *              Signature           - ACPI signature for the block
661bc36eafdSMike Gerdts  *              Instance            - Used for multiple SSDTs in the same file
662bc36eafdSMike Gerdts  *
663bc36eafdSMike Gerdts  * RETURN:      Status from fprintf
664bc36eafdSMike Gerdts  *
665bc36eafdSMike Gerdts  * DESCRIPTION: Emit the raw ASL for a complete Definition Block (DSDT or SSDT)
666bc36eafdSMike Gerdts  *
667bc36eafdSMike Gerdts  * Note: The AMLFileName parameter for DefinitionBlock is left as a NULL
668bc36eafdSMike Gerdts  * string. This allows the compiler to create the output AML filename from
669bc36eafdSMike Gerdts  * the input filename.
670bc36eafdSMike Gerdts  *
671bc36eafdSMike Gerdts  ******************************************************************************/
672bc36eafdSMike Gerdts 
673bc36eafdSMike Gerdts static int
DtEmitDefinitionBlock(FILE * File,char * Filename,char * Signature,UINT32 Instance)674bc36eafdSMike Gerdts DtEmitDefinitionBlock (
675bc36eafdSMike Gerdts     FILE                    *File,
676bc36eafdSMike Gerdts     char                    *Filename,
677bc36eafdSMike Gerdts     char                    *Signature,
678bc36eafdSMike Gerdts     UINT32                  Instance)
679bc36eafdSMike Gerdts {
680bc36eafdSMike Gerdts     int                     Status;
681bc36eafdSMike Gerdts 
682bc36eafdSMike Gerdts 
683bc36eafdSMike Gerdts     Status = fprintf (File,
684bc36eafdSMike Gerdts         "DefinitionBlock (\"\", \"%4.4s\", 2, \"Intel\", \"_%4.4s_%.2X\", 0x00000001)\n"
685bc36eafdSMike Gerdts         "{\n"
686bc36eafdSMike Gerdts         "    Method (%2.2s%.2X)\n"
687bc36eafdSMike Gerdts         "    {\n"
688bc36eafdSMike Gerdts         "    }\n"
689bc36eafdSMike Gerdts         "}\n\n",
690bc36eafdSMike Gerdts         Signature, Signature, Instance, Signature, Instance);
691bc36eafdSMike Gerdts 
692bc36eafdSMike Gerdts     if (Status < 0)
693bc36eafdSMike Gerdts     {
694bc36eafdSMike Gerdts         fprintf (stderr,
695bc36eafdSMike Gerdts             "Could not write %4.4s to output file %s\n",
696bc36eafdSMike Gerdts             Signature, Filename);
697bc36eafdSMike Gerdts     }
698bc36eafdSMike Gerdts 
699bc36eafdSMike Gerdts     return (Status);
700bc36eafdSMike Gerdts }
701