1 /******************************************************************************
3 * Module Name: dttemplate - ACPI table template generation
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include "aslcompiler.h"
154 #include "dttemplate.h" /* Contains the hex ACPI table templates */
156 #define _COMPONENT DT_COMPILER
157 ACPI_MODULE_NAME ("dttemplate")
160 /* Local prototypes */
163 AcpiUtIsSpecialTable (
167 DtCreateOneTemplateFile (
172 DtCreateOneTemplate (
175 const ACPI_DMTABLE_DATA
*TableData
);
178 DtCreateAllTemplates (
182 DtEmitDefinitionBlock (
189 /*******************************************************************************
191 * FUNCTION: AcpiUtIsSpecialTable
193 * PARAMETERS: Signature - ACPI table signature
195 * RETURN: TRUE if signature is a special ACPI table
197 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
198 * table data structure (AcpiDmTableData).
200 ******************************************************************************/
203 AcpiUtIsSpecialTable (
207 if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_DSDT
) ||
208 ACPI_COMPARE_NAME (Signature
, ACPI_SIG_OSDT
) ||
209 ACPI_COMPARE_NAME (Signature
, ACPI_SIG_SSDT
) ||
210 ACPI_COMPARE_NAME (Signature
, ACPI_SIG_FACS
) ||
211 ACPI_COMPARE_NAME (Signature
, ACPI_RSDP_NAME
))
220 /*******************************************************************************
222 * FUNCTION: DtCreateTemplates
224 * PARAMETERS: argv - Standard command line arguments
228 * DESCRIPTION: Create one or more template files.
230 ******************************************************************************/
238 unsigned long TableCount
;
239 ACPI_STATUS Status
= AE_OK
;
242 AslInitializeGlobals ();
244 Status
= AdInitialize ();
245 if (ACPI_FAILURE (Status
))
251 * Special cases for DSDT, ALL, and '*'
254 /* Default (no signature option) is DSDT */
256 if (AcpiGbl_Optind
< 3)
258 Status
= DtCreateOneTemplateFile (ACPI_SIG_DSDT
, 0);
263 Signature
= argv
[AcpiGbl_Optind
];
264 AcpiUtStrupr (Signature
);
267 * Multiple SSDT support (-T <ssdt count>)
269 TableCount
= strtoul (Signature
, &End
, 0);
270 if (Signature
!= End
)
272 /* The count is used for table ID and method name - max is 254(+1) */
274 if (TableCount
> 254)
276 fprintf (stderr
, "%u SSDTs requested, maximum is 254\n",
277 (unsigned int) TableCount
);
283 Status
= DtCreateOneTemplateFile (ACPI_SIG_DSDT
, TableCount
);
287 if (!strcmp (Signature
, "ALL"))
289 /* Create all available/known templates */
291 Status
= DtCreateAllTemplates ();
296 * Normal case: Create template for each signature
298 while (argv
[AcpiGbl_Optind
])
300 Signature
= argv
[AcpiGbl_Optind
];
301 AcpiUtStrupr (Signature
);
303 Status
= DtCreateOneTemplateFile (Signature
, 0);
304 if (ACPI_FAILURE (Status
))
314 /* Shutdown ACPICA subsystem */
316 (void) AcpiTerminate ();
317 UtDeleteLocalCaches ();
322 /*******************************************************************************
324 * FUNCTION: DtCreateOneTemplateFile
326 * PARAMETERS: Signature - ACPI table signature
330 * DESCRIPTION: Create one template file of the requested signature.
332 ******************************************************************************/
335 DtCreateOneTemplateFile (
339 const ACPI_DMTABLE_DATA
*TableData
;
344 * Validate signature and get the template data:
345 * 1) Signature must be 4 characters
346 * 2) Signature must be a recognized ACPI table
347 * 3) There must be a template associated with the signature
349 if (strlen (Signature
) != ACPI_NAME_SIZE
)
352 "%s: Invalid ACPI table signature "
353 "(length must be 4 characters)\n", Signature
);
358 * Some slack for the two strange tables whose name is different than
359 * their signatures: MADT->APIC and FADT->FACP.
361 if (!strcmp (Signature
, "MADT"))
365 else if (!strcmp (Signature
, "FADT"))
370 /* TableData will point to the template */
372 TableData
= AcpiDmGetTableData (Signature
);
375 if (!TableData
->Template
)
377 fprintf (stderr
, "%4.4s: No template available\n", Signature
);
381 else if (!AcpiUtIsSpecialTable (Signature
))
384 "%4.4s: Unrecognized ACPI table signature\n", Signature
);
388 Status
= DtCreateOneTemplate (Signature
, TableCount
, TableData
);
393 /*******************************************************************************
395 * FUNCTION: DtCreateAllTemplates
401 * DESCRIPTION: Create all currently defined template files
403 ******************************************************************************/
406 DtCreateAllTemplates (
409 const ACPI_DMTABLE_DATA
*TableData
;
413 fprintf (stderr
, "Creating all supported Template files\n");
415 /* Walk entire ACPI table data structure */
417 for (TableData
= AcpiDmTableData
; TableData
->Signature
; TableData
++)
419 /* If table has a template, create the template file */
421 if (TableData
->Template
)
423 Status
= DtCreateOneTemplate (TableData
->Signature
,
425 if (ACPI_FAILURE (Status
))
433 * Create the special ACPI tables:
434 * 1) DSDT/SSDT are AML tables, not data tables
435 * 2) FACS and RSDP have non-standard headers
437 Status
= DtCreateOneTemplate (ACPI_SIG_DSDT
, 0, NULL
);
438 if (ACPI_FAILURE (Status
))
443 Status
= DtCreateOneTemplate (ACPI_SIG_SSDT
, 0, NULL
);
444 if (ACPI_FAILURE (Status
))
449 Status
= DtCreateOneTemplate (ACPI_SIG_OSDT
, 0, NULL
);
450 if (ACPI_FAILURE (Status
))
455 Status
= DtCreateOneTemplate (ACPI_SIG_FACS
, 0, NULL
);
456 if (ACPI_FAILURE (Status
))
461 Status
= DtCreateOneTemplate (ACPI_RSDP_NAME
, 0, NULL
);
462 if (ACPI_FAILURE (Status
))
471 /*******************************************************************************
473 * FUNCTION: DtCreateOneTemplate
475 * PARAMETERS: Signature - ACPI signature, NULL terminated.
476 * TableCount - Used for SSDTs in same file as DSDT
477 * TableData - Entry in ACPI table data structure.
478 * NULL if a special ACPI table.
482 * DESCRIPTION: Create one template source file for the requested ACPI table.
484 ******************************************************************************/
487 DtCreateOneTemplate (
490 const ACPI_DMTABLE_DATA
*TableData
)
492 char *DisasmFilename
;
494 ACPI_STATUS Status
= AE_OK
;
499 /* New file will have a .asl suffix */
501 DisasmFilename
= FlGenerateFilename (
502 Signature
, FILE_SUFFIX_ASL_CODE
);
505 fprintf (stderr
, "Could not generate output filename\n");
509 AcpiUtStrlwr (DisasmFilename
);
510 if (!UtQueryForOverwrite (DisasmFilename
))
515 File
= fopen (DisasmFilename
, "w+");
518 fprintf (stderr
, "Could not open output file %s\n",
523 /* Emit the common file header */
525 AcpiOsRedirectOutput (File
);
527 AcpiOsPrintf ("/*\n");
528 AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
532 AcpiOsPrintf (" * Template for [%4.4s] ACPI Table",
537 AcpiOsPrintf (" * Template for [%4.4s] and %u [SSDT] ACPI Tables",
538 Signature
, TableCount
);
541 /* Dump the actual ACPI table */
545 /* Normal case, tables that appear in AcpiDmTableData */
547 AcpiOsPrintf (" (static data table)\n");
549 if (AslGbl_VerboseTemplates
)
551 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
552 " FieldName : HexFieldValue\n */\n\n");
556 AcpiOsPrintf (" * Format: [ByteLength]"
557 " FieldName : HexFieldValue\n */\n");
560 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER
,
561 TableData
->Template
));
565 /* Special ACPI tables - DSDT, SSDT, OSDT, FACS, RSDP */
567 AcpiOsPrintf (" (AML byte code table)\n");
568 AcpiOsPrintf (" */\n");
570 if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_DSDT
))
572 Actual
= DtEmitDefinitionBlock (
573 File
, DisasmFilename
, ACPI_SIG_DSDT
, 1);
580 /* Emit any requested SSDTs into the same file */
582 for (i
= 1; i
<= TableCount
; i
++)
584 Actual
= DtEmitDefinitionBlock (
585 File
, DisasmFilename
, ACPI_SIG_SSDT
, i
+ 1);
593 else if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_SSDT
))
595 Actual
= DtEmitDefinitionBlock (
596 File
, DisasmFilename
, ACPI_SIG_SSDT
, 1);
603 else if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_OSDT
))
605 Actual
= DtEmitDefinitionBlock (
606 File
, DisasmFilename
, ACPI_SIG_OSDT
, 1);
613 else if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_FACS
))
615 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER
,
618 else if (ACPI_COMPARE_NAME (Signature
, ACPI_RSDP_NAME
))
620 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER
,
626 "%4.4s, Unrecognized ACPI table signature\n", Signature
);
635 "Created ACPI table template for [%4.4s], "
636 "written to \"%s\"\n",
637 Signature
, DisasmFilename
);
642 "Created ACPI table templates for [%4.4s] "
643 "and %u [SSDT], written to \"%s\"\n",
644 Signature
, TableCount
, DisasmFilename
);
649 AcpiOsRedirectOutput (stdout
);
654 /*******************************************************************************
656 * FUNCTION: DtEmitDefinitionBlock
658 * PARAMETERS: File - An open file for the block
659 * Filename - Filename for same, for error msg(s)
660 * Signature - ACPI signature for the block
661 * Instance - Used for multiple SSDTs in the same file
663 * RETURN: Status from fprintf
665 * DESCRIPTION: Emit the raw ASL for a complete Definition Block (DSDT or SSDT)
667 * Note: The AMLFileName parameter for DefinitionBlock is left as a NULL
668 * string. This allows the compiler to create the output AML filename from
669 * the input filename.
671 ******************************************************************************/
674 DtEmitDefinitionBlock (
683 Status
= fprintf (File
,
684 "DefinitionBlock (\"\", \"%4.4s\", 2, \"Intel\", \"_%4.4s_%.2X\", 0x00000001)\n"
686 " Method (%2.2s%.2X)\n"
690 Signature
, Signature
, Instance
, Signature
, Instance
);
695 "Could not write %4.4s to output file %s\n",
696 Signature
, Filename
);