1 /******************************************************************************
2 *
3 * Module Name: dttemplate - ACPI table template generation
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
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
19 * property rights.
20 *
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
27 *
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;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
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.
53 *
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
64 * make.
65 *
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
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
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.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
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
88 * PARTICULAR PURPOSE.
89 *
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
97 * LIMITED REMEDY.
98 *
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.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
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.
133 *
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.
145 *
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.
149 *
150 *****************************************************************************/
151
152 #include "aslcompiler.h"
153 #include "acapps.h"
154 #include "dttemplate.h" /* Contains the hex ACPI table templates */
155
156 #define _COMPONENT DT_COMPILER
157 ACPI_MODULE_NAME ("dttemplate")
158
159
160 /* Local prototypes */
161
162 static BOOLEAN
163 AcpiUtIsSpecialTable (
164 char *Signature);
165
166 static ACPI_STATUS
167 DtCreateOneTemplateFile (
168 char *Signature,
169 UINT32 TableCount);
170
171 static ACPI_STATUS
172 DtCreateOneTemplate (
173 char *Signature,
174 UINT32 TableCount,
175 const ACPI_DMTABLE_DATA *TableData);
176
177 static ACPI_STATUS
178 DtCreateAllTemplates (
179 void);
180
181 static int
182 DtEmitDefinitionBlock (
183 FILE *File,
184 char *Filename,
185 char *Signature,
186 UINT32 Instance);
187
188
189 /*******************************************************************************
190 *
191 * FUNCTION: AcpiUtIsSpecialTable
192 *
193 * PARAMETERS: Signature - ACPI table signature
194 *
195 * RETURN: TRUE if signature is a special ACPI table
196 *
197 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI
198 * table data structure (AcpiDmTableData).
199 *
200 ******************************************************************************/
201
202 static BOOLEAN
AcpiUtIsSpecialTable(char * Signature)203 AcpiUtIsSpecialTable (
204 char *Signature)
205 {
206
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))
212 {
213 return (TRUE);
214 }
215
216 return (FALSE);
217 }
218
219
220 /*******************************************************************************
221 *
222 * FUNCTION: DtCreateTemplates
223 *
224 * PARAMETERS: argv - Standard command line arguments
225 *
226 * RETURN: Status
227 *
228 * DESCRIPTION: Create one or more template files.
229 *
230 ******************************************************************************/
231
232 ACPI_STATUS
DtCreateTemplates(char ** argv)233 DtCreateTemplates (
234 char **argv)
235 {
236 char *Signature;
237 char *End;
238 unsigned long TableCount;
239 ACPI_STATUS Status = AE_OK;
240
241
242 AslInitializeGlobals ();
243
244 Status = AdInitialize ();
245 if (ACPI_FAILURE (Status))
246 {
247 return (Status);
248 }
249
250 /*
251 * Special cases for DSDT, ALL, and '*'
252 */
253
254 /* Default (no signature option) is DSDT */
255
256 if (AcpiGbl_Optind < 3)
257 {
258 Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, 0);
259 goto Exit;
260 }
261
262 AcpiGbl_Optind--;
263 Signature = argv[AcpiGbl_Optind];
264 AcpiUtStrupr (Signature);
265
266 /*
267 * Multiple SSDT support (-T <ssdt count>)
268 */
269 TableCount = strtoul (Signature, &End, 0);
270 if (Signature != End)
271 {
272 /* The count is used for table ID and method name - max is 254(+1) */
273
274 if (TableCount > 254)
275 {
276 fprintf (stderr, "%u SSDTs requested, maximum is 254\n",
277 (unsigned int) TableCount);
278
279 Status = AE_LIMIT;
280 goto Exit;
281 }
282
283 Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, TableCount);
284 goto Exit;
285 }
286
287 if (!strcmp (Signature, "ALL"))
288 {
289 /* Create all available/known templates */
290
291 Status = DtCreateAllTemplates ();
292 goto Exit;
293 }
294
295 /*
296 * Normal case: Create template for each signature
297 */
298 while (argv[AcpiGbl_Optind])
299 {
300 Signature = argv[AcpiGbl_Optind];
301 AcpiUtStrupr (Signature);
302
303 Status = DtCreateOneTemplateFile (Signature, 0);
304 if (ACPI_FAILURE (Status))
305 {
306 goto Exit;
307 }
308
309 AcpiGbl_Optind++;
310 }
311
312
313 Exit:
314 /* Shutdown ACPICA subsystem */
315
316 (void) AcpiTerminate ();
317 UtDeleteLocalCaches ();
318 return (Status);
319 }
320
321
322 /*******************************************************************************
323 *
324 * FUNCTION: DtCreateOneTemplateFile
325 *
326 * PARAMETERS: Signature - ACPI table signature
327 *
328 * RETURN: Status
329 *
330 * DESCRIPTION: Create one template file of the requested signature.
331 *
332 ******************************************************************************/
333
334 static ACPI_STATUS
DtCreateOneTemplateFile(char * Signature,UINT32 TableCount)335 DtCreateOneTemplateFile (
336 char *Signature,
337 UINT32 TableCount)
338 {
339 const ACPI_DMTABLE_DATA *TableData;
340 ACPI_STATUS Status;
341
342
343 /*
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
348 */
349 if (strlen (Signature) != ACPI_NAME_SIZE)
350 {
351 fprintf (stderr,
352 "%s: Invalid ACPI table signature "
353 "(length must be 4 characters)\n", Signature);
354 return (AE_ERROR);
355 }
356
357 /*
358 * Some slack for the two strange tables whose name is different than
359 * their signatures: MADT->APIC and FADT->FACP.
360 */
361 if (!strcmp (Signature, "MADT"))
362 {
363 Signature = "APIC";
364 }
365 else if (!strcmp (Signature, "FADT"))
366 {
367 Signature = "FACP";
368 }
369
370 /* TableData will point to the template */
371
372 TableData = AcpiDmGetTableData (Signature);
373 if (TableData)
374 {
375 if (!TableData->Template)
376 {
377 fprintf (stderr, "%4.4s: No template available\n", Signature);
378 return (AE_ERROR);
379 }
380 }
381 else if (!AcpiUtIsSpecialTable (Signature))
382 {
383 fprintf (stderr,
384 "%4.4s: Unrecognized ACPI table signature\n", Signature);
385 return (AE_ERROR);
386 }
387
388 Status = DtCreateOneTemplate (Signature, TableCount, TableData);
389 return (Status);
390 }
391
392
393 /*******************************************************************************
394 *
395 * FUNCTION: DtCreateAllTemplates
396 *
397 * PARAMETERS: None
398 *
399 * RETURN: Status
400 *
401 * DESCRIPTION: Create all currently defined template files
402 *
403 ******************************************************************************/
404
405 static ACPI_STATUS
DtCreateAllTemplates(void)406 DtCreateAllTemplates (
407 void)
408 {
409 const ACPI_DMTABLE_DATA *TableData;
410 ACPI_STATUS Status;
411
412
413 fprintf (stderr, "Creating all supported Template files\n");
414
415 /* Walk entire ACPI table data structure */
416
417 for (TableData = AcpiDmTableData; TableData->Signature; TableData++)
418 {
419 /* If table has a template, create the template file */
420
421 if (TableData->Template)
422 {
423 Status = DtCreateOneTemplate (TableData->Signature,
424 0, TableData);
425 if (ACPI_FAILURE (Status))
426 {
427 return (Status);
428 }
429 }
430 }
431
432 /*
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
436 */
437 Status = DtCreateOneTemplate (ACPI_SIG_DSDT, 0, NULL);
438 if (ACPI_FAILURE (Status))
439 {
440 return (Status);
441 }
442
443 Status = DtCreateOneTemplate (ACPI_SIG_SSDT, 0, NULL);
444 if (ACPI_FAILURE (Status))
445 {
446 return (Status);
447 }
448
449 Status = DtCreateOneTemplate (ACPI_SIG_OSDT, 0, NULL);
450 if (ACPI_FAILURE (Status))
451 {
452 return (Status);
453 }
454
455 Status = DtCreateOneTemplate (ACPI_SIG_FACS, 0, NULL);
456 if (ACPI_FAILURE (Status))
457 {
458 return (Status);
459 }
460
461 Status = DtCreateOneTemplate (ACPI_RSDP_NAME, 0, NULL);
462 if (ACPI_FAILURE (Status))
463 {
464 return (Status);
465 }
466
467 return (AE_OK);
468 }
469
470
471 /*******************************************************************************
472 *
473 * FUNCTION: DtCreateOneTemplate
474 *
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.
479 *
480 * RETURN: Status
481 *
482 * DESCRIPTION: Create one template source file for the requested ACPI table.
483 *
484 ******************************************************************************/
485
486 static ACPI_STATUS
DtCreateOneTemplate(char * Signature,UINT32 TableCount,const ACPI_DMTABLE_DATA * TableData)487 DtCreateOneTemplate (
488 char *Signature,
489 UINT32 TableCount,
490 const ACPI_DMTABLE_DATA *TableData)
491 {
492 char *DisasmFilename;
493 FILE *File;
494 ACPI_STATUS Status = AE_OK;
495 int Actual;
496 UINT32 i;
497
498
499 /* New file will have a .asl suffix */
500
501 DisasmFilename = FlGenerateFilename (
502 Signature, FILE_SUFFIX_ASL_CODE);
503 if (!DisasmFilename)
504 {
505 fprintf (stderr, "Could not generate output filename\n");
506 return (AE_ERROR);
507 }
508
509 AcpiUtStrlwr (DisasmFilename);
510 if (!UtQueryForOverwrite (DisasmFilename))
511 {
512 return (AE_ERROR);
513 }
514
515 File = fopen (DisasmFilename, "w+");
516 if (!File)
517 {
518 fprintf (stderr, "Could not open output file %s\n",
519 DisasmFilename);
520 return (AE_ERROR);
521 }
522
523 /* Emit the common file header */
524
525 AcpiOsRedirectOutput (File);
526
527 AcpiOsPrintf ("/*\n");
528 AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));
529
530 if (TableCount == 0)
531 {
532 AcpiOsPrintf (" * Template for [%4.4s] ACPI Table",
533 Signature);
534 }
535 else
536 {
537 AcpiOsPrintf (" * Template for [%4.4s] and %u [SSDT] ACPI Tables",
538 Signature, TableCount);
539 }
540
541 /* Dump the actual ACPI table */
542
543 if (TableData)
544 {
545 /* Normal case, tables that appear in AcpiDmTableData */
546
547 AcpiOsPrintf (" (static data table)\n");
548
549 if (Gbl_VerboseTemplates)
550 {
551 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"
552 " FieldName : HexFieldValue\n */\n\n");
553 }
554 else
555 {
556 AcpiOsPrintf (" * Format: [ByteLength]"
557 " FieldName : HexFieldValue\n */\n");
558 }
559
560 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
561 TableData->Template));
562 }
563 else
564 {
565 /* Special ACPI tables - DSDT, SSDT, OSDT, FACS, RSDP */
566
567 AcpiOsPrintf (" (AML byte code table)\n");
568 AcpiOsPrintf (" */\n");
569
570 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))
571 {
572 Actual = DtEmitDefinitionBlock (
573 File, DisasmFilename, ACPI_SIG_DSDT, 1);
574 if (Actual < 0)
575 {
576 Status = AE_ERROR;
577 goto Cleanup;
578 }
579
580 /* Emit any requested SSDTs into the same file */
581
582 for (i = 1; i <= TableCount; i++)
583 {
584 Actual = DtEmitDefinitionBlock (
585 File, DisasmFilename, ACPI_SIG_SSDT, i + 1);
586 if (Actual < 0)
587 {
588 Status = AE_ERROR;
589 goto Cleanup;
590 }
591 }
592 }
593 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))
594 {
595 Actual = DtEmitDefinitionBlock (
596 File, DisasmFilename, ACPI_SIG_SSDT, 1);
597 if (Actual < 0)
598 {
599 Status = AE_ERROR;
600 goto Cleanup;
601 }
602 }
603 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_OSDT))
604 {
605 Actual = DtEmitDefinitionBlock (
606 File, DisasmFilename, ACPI_SIG_OSDT, 1);
607 if (Actual < 0)
608 {
609 Status = AE_ERROR;
610 goto Cleanup;
611 }
612 }
613 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
614 {
615 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
616 TemplateFacs));
617 }
618 else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))
619 {
620 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,
621 TemplateRsdp));
622 }
623 else
624 {
625 fprintf (stderr,
626 "%4.4s, Unrecognized ACPI table signature\n", Signature);
627 Status = AE_ERROR;
628 goto Cleanup;
629 }
630 }
631
632 if (TableCount == 0)
633 {
634 fprintf (stderr,
635 "Created ACPI table template for [%4.4s], "
636 "written to \"%s\"\n",
637 Signature, DisasmFilename);
638 }
639 else
640 {
641 fprintf (stderr,
642 "Created ACPI table templates for [%4.4s] "
643 "and %u [SSDT], written to \"%s\"\n",
644 Signature, TableCount, DisasmFilename);
645 }
646
647 Cleanup:
648 fclose (File);
649 AcpiOsRedirectOutput (stdout);
650 return (Status);
651 }
652
653
654 /*******************************************************************************
655 *
656 * FUNCTION: DtEmitDefinitionBlock
657 *
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
662 *
663 * RETURN: Status from fprintf
664 *
665 * DESCRIPTION: Emit the raw ASL for a complete Definition Block (DSDT or SSDT)
666 *
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.
670 *
671 ******************************************************************************/
672
673 static int
DtEmitDefinitionBlock(FILE * File,char * Filename,char * Signature,UINT32 Instance)674 DtEmitDefinitionBlock (
675 FILE *File,
676 char *Filename,
677 char *Signature,
678 UINT32 Instance)
679 {
680 int Status;
681
682
683 Status = fprintf (File,
684 "DefinitionBlock (\"\", \"%4.4s\", 2, \"Intel\", \"_%4.4s_%.2X\", 0x00000001)\n"
685 "{\n"
686 " Method (%2.2s%.2X)\n"
687 " {\n"
688 " }\n"
689 "}\n\n",
690 Signature, Signature, Instance, Signature, Instance);
691
692 if (Status < 0)
693 {
694 fprintf (stderr,
695 "Could not write %4.4s to output file %s\n",
696 Signature, Filename);
697 }
698
699 return (Status);
700 }
701