1 /******************************************************************************
3 * Module Name: aslhex - ASCII hex output file generation (C, ASM, and ASL)
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
154 #define _COMPONENT ACPI_COMPILER
155 ACPI_MODULE_NAME ("ashex")
158 * This module emits ASCII hex output files in either C, ASM, or ASL format
161 /* Local prototypes */
176 HxReadAmlOutputFile (
180 /*******************************************************************************
182 * FUNCTION: HxDoHexOutput
188 * DESCRIPTION: Create the hex output file. Note: data is obtained by reading
189 * the entire AML output file that was previously generated.
191 ******************************************************************************/
198 switch (Gbl_HexOutputFlag)
217 /* No other output types supported */
224 /*******************************************************************************
226 * FUNCTION: HxReadAmlOutputFile
228 * PARAMETERS: Buffer - Where to return data
232 * DESCRIPTION: Read a line of the AML output prior to formatting the data
234 ******************************************************************************/
237 HxReadAmlOutputFile (
243 Actual = fread (Buffer, 1, HEX_TABLE_LINE_SIZE,
244 Gbl_Files[ASL_FILE_AML_OUTPUT].Handle);
246 if (ferror (Gbl_Files[ASL_FILE_AML_OUTPUT].Handle))
248 FlFileError (ASL_FILE_AML_OUTPUT, ASL_MSG_READ);
256 /*******************************************************************************
258 * FUNCTION: HxDoHexOutputC
264 * DESCRIPTION: Create the hex output file. This is the same data as the AML
265 * output file, but formatted into hex/ascii bytes suitable for
266 * inclusion into a C source file.
268 ******************************************************************************/
274 UINT8 FileData[HEX_TABLE_LINE_SIZE];
281 /* Get AML size, seek back to start */
283 AmlFileSize = FlGetFileSize (ASL_FILE_AML_OUTPUT);
284 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
286 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * C source code output\n");
287 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * AML code block contains 0x%X bytes\n *\n */\n",
289 FlPrintFile (ASL_FILE_HEX_OUTPUT, "unsigned char AmlCode[] =\n{\n");
291 while (Offset < AmlFileSize)
293 /* Read enough bytes needed for one output line */
295 LineLength = HxReadAmlOutputFile (FileData);
301 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
303 for (i = 0; i < LineLength; i++)
306 * Print each hex byte.
307 * Add a comma until the very last byte of the AML file
308 * (Some C compilers complain about a trailing comma)
310 FlPrintFile (ASL_FILE_HEX_OUTPUT, "0x%2.2X", FileData[i]);
311 if ((Offset + i + 1) < AmlFileSize)
313 FlPrintFile (ASL_FILE_HEX_OUTPUT, ",");
317 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
321 /* Add fill spaces if needed for last line */
323 if (LineLength < HEX_TABLE_LINE_SIZE)
325 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s",
326 5 * (HEX_TABLE_LINE_SIZE - LineLength), " ");
329 /* Emit the offset and ascii dump for the entire line */
331 FlPrintFile (ASL_FILE_HEX_OUTPUT, " /* %8.8X", Offset);
332 LsDumpAsciiInComment (ASL_FILE_HEX_OUTPUT, LineLength, FileData);
334 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s*/\n",
335 HEX_TABLE_LINE_SIZE - LineLength + 1, " ");
337 Offset += LineLength;
340 FlPrintFile (ASL_FILE_HEX_OUTPUT, "};\n");
344 /*******************************************************************************
346 * FUNCTION: HxDoHexOutputAsl
352 * DESCRIPTION: Create the hex output file. This is the same data as the AML
353 * output file, but formatted into hex/ascii bytes suitable for
354 * inclusion into a C source file.
356 ******************************************************************************/
362 UINT8 FileData[HEX_TABLE_LINE_SIZE];
369 /* Get AML size, seek back to start */
371 AmlFileSize = FlGetFileSize (ASL_FILE_AML_OUTPUT);
372 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
374 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * ASL source code output\n");
375 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * AML code block contains 0x%X bytes\n *\n */\n",
377 FlPrintFile (ASL_FILE_HEX_OUTPUT, " Name (BUF1, Buffer()\n {\n");
379 while (Offset < AmlFileSize)
381 /* Read enough bytes needed for one output line */
383 LineLength = HxReadAmlOutputFile (FileData);
389 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
391 for (i = 0; i < LineLength; i++)
394 * Print each hex byte.
395 * Add a comma until the very last byte of the AML file
396 * (Some C compilers complain about a trailing comma)
398 FlPrintFile (ASL_FILE_HEX_OUTPUT, "0x%2.2X", FileData[i]);
399 if ((Offset + i + 1) < AmlFileSize)
401 FlPrintFile (ASL_FILE_HEX_OUTPUT, ",");
405 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
409 /* Add fill spaces if needed for last line */
411 if (LineLength < HEX_TABLE_LINE_SIZE)
413 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s",
414 5 * (HEX_TABLE_LINE_SIZE - LineLength), " ");
417 /* Emit the offset and ascii dump for the entire line */
419 FlPrintFile (ASL_FILE_HEX_OUTPUT, " /* %8.8X", Offset);
420 LsDumpAsciiInComment (ASL_FILE_HEX_OUTPUT, LineLength, FileData);
422 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s*/\n",
423 HEX_TABLE_LINE_SIZE - LineLength + 1, " ");
425 Offset += LineLength;
428 FlPrintFile (ASL_FILE_HEX_OUTPUT, " })\n");
432 /*******************************************************************************
434 * FUNCTION: HxDoHexOutputAsm
440 * DESCRIPTION: Create the hex output file. This is the same data as the AML
441 * output file, but formatted into hex/ascii bytes suitable for
442 * inclusion into a ASM source file.
444 ******************************************************************************/
450 UINT8 FileData[HEX_TABLE_LINE_SIZE];
457 /* Get AML size, seek back to start */
459 AmlFileSize = FlGetFileSize (ASL_FILE_AML_OUTPUT);
460 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
462 FlPrintFile (ASL_FILE_HEX_OUTPUT, "; Assembly code source output\n");
463 FlPrintFile (ASL_FILE_HEX_OUTPUT, "; AML code block contains 0x%X bytes\n;\n",
466 while (Offset < AmlFileSize)
468 /* Read enough bytes needed for one output line */
470 LineLength = HxReadAmlOutputFile (FileData);
476 FlPrintFile (ASL_FILE_HEX_OUTPUT, " db ");
478 for (i = 0; i < LineLength; i++)
481 * Print each hex byte.
482 * Add a comma until the last byte of the line
484 FlPrintFile (ASL_FILE_HEX_OUTPUT, "0%2.2Xh", FileData[i]);
485 if ((i + 1) < LineLength)
487 FlPrintFile (ASL_FILE_HEX_OUTPUT, ",");
491 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
493 /* Add fill spaces if needed for last line */
495 if (LineLength < HEX_TABLE_LINE_SIZE)
497 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s",
498 5 * (HEX_TABLE_LINE_SIZE - LineLength), " ");
501 /* Emit the offset and ascii dump for the entire line */
503 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ; %8.8X", Offset);
504 LsDumpAsciiInComment (ASL_FILE_HEX_OUTPUT, LineLength, FileData);
506 FlPrintFile (ASL_FILE_HEX_OUTPUT, "\n");
508 Offset += LineLength;
511 FlPrintFile (ASL_FILE_HEX_OUTPUT, "\n");