1 /******************************************************************************
2 *
3 * Module Name: aslhex - ASCII hex output file generation (C, ASM, and ASL)
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, 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
155 #define _COMPONENT ACPI_COMPILER
156 ACPI_MODULE_NAME ("ashex")
157
158 /*
159 * This module emits ASCII hex output files in either C, ASM, or ASL format
160 */
161
162 /* Local prototypes */
163
164 static void
165 HxDoHexOutputC (
166 void);
167
168 static void
169 HxDoHexOutputAsl (
170 void);
171
172 static void
173 HxDoHexOutputAsm (
174 void);
175
176 static UINT32
177 HxReadAmlOutputFile (
178 UINT8 *Buffer);
179
180
181 /*******************************************************************************
182 *
183 * FUNCTION: HxDoHexOutput
184 *
185 * PARAMETERS: None
186 *
187 * RETURN: None
188 *
189 * DESCRIPTION: Create the hex output file. Note: data is obtained by reading
190 * the entire AML output file that was previously generated.
191 *
192 ******************************************************************************/
193
194 void
HxDoHexOutput(void)195 HxDoHexOutput (
196 void)
197 {
198
199 switch (AslGbl_HexOutputFlag)
200 {
201 case HEX_OUTPUT_C:
202
203 HxDoHexOutputC ();
204 break;
205
206 case HEX_OUTPUT_ASM:
207
208 HxDoHexOutputAsm ();
209 break;
210
211 case HEX_OUTPUT_ASL:
212
213 HxDoHexOutputAsl ();
214 break;
215
216 default:
217
218 /* No other output types supported */
219
220 break;
221 }
222 }
223
224
225 /*******************************************************************************
226 *
227 * FUNCTION: HxReadAmlOutputFile
228 *
229 * PARAMETERS: Buffer - Where to return data
230 *
231 * RETURN: None
232 *
233 * DESCRIPTION: Read a line of the AML output prior to formatting the data
234 *
235 ******************************************************************************/
236
237 static UINT32
HxReadAmlOutputFile(UINT8 * Buffer)238 HxReadAmlOutputFile (
239 UINT8 *Buffer)
240 {
241 UINT32 Actual;
242
243
244 Actual = fread (Buffer, 1, HEX_TABLE_LINE_SIZE,
245 AslGbl_Files[ASL_FILE_AML_OUTPUT].Handle);
246
247 if (ferror (AslGbl_Files[ASL_FILE_AML_OUTPUT].Handle))
248 {
249 FlFileError (ASL_FILE_AML_OUTPUT, ASL_MSG_READ);
250 AslAbort ();
251 }
252
253 return (Actual);
254 }
255
256
257 /*******************************************************************************
258 *
259 * FUNCTION: HxDoHexOutputC
260 *
261 * PARAMETERS: None
262 *
263 * RETURN: None
264 *
265 * DESCRIPTION: Create the hex output file. This is the same data as the AML
266 * output file, but formatted into hex/ascii bytes suitable for
267 * inclusion into a C source file.
268 *
269 * Note: the base name of the hex output file is prepended to
270 * all symbols as they are output to the file.
271 *
272 ******************************************************************************/
273
274 static void
HxDoHexOutputC(void)275 HxDoHexOutputC (
276 void)
277 {
278 UINT8 FileData[HEX_TABLE_LINE_SIZE];
279 UINT32 LineLength;
280 UINT32 Offset = 0;
281 UINT32 AmlFileSize;
282 UINT32 i;
283 char *FileBasename;
284
285
286 /* Obtain the file basename (filename with no extension) */
287
288 FileBasename = FlGetFileBasename (AslGbl_Files [ASL_FILE_HEX_OUTPUT].Filename);
289
290 /* Get AML size, seek back to start */
291
292 AmlFileSize = FlGetFileSize (ASL_FILE_AML_OUTPUT);
293 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
294
295 /* Finish the file header and emit the non-data symbols */
296
297 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * C source code output\n");
298 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * AML code block contains 0x%X bytes\n *\n */\n",
299 AmlFileSize);
300
301 FlPrintFile (ASL_FILE_HEX_OUTPUT, "#ifndef __%s_HEX__\n", FileBasename);
302 FlPrintFile (ASL_FILE_HEX_OUTPUT, "#define __%s_HEX__\n\n", FileBasename);
303
304 AcpiUtStrlwr (FileBasename);
305 FlPrintFile (ASL_FILE_HEX_OUTPUT, "unsigned char %s_aml_code[] =\n{\n", FileBasename);
306
307 while (Offset < AmlFileSize)
308 {
309 /* Read enough bytes needed for one output line */
310
311 LineLength = HxReadAmlOutputFile (FileData);
312 if (!LineLength)
313 {
314 break;
315 }
316
317 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
318
319 for (i = 0; i < LineLength; i++)
320 {
321 /*
322 * Output each hex byte in the form: "0xnn,"
323 * Add a comma until the very last byte of the AML file
324 * (Some C compilers complain about a trailing comma)
325 */
326 FlPrintFile (ASL_FILE_HEX_OUTPUT, "0x%2.2X", FileData[i]);
327 if ((Offset + i + 1) < AmlFileSize)
328 {
329 FlPrintFile (ASL_FILE_HEX_OUTPUT, ",");
330 }
331 else
332 {
333 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
334 }
335 }
336
337 /* Add fill spaces if needed for last line */
338
339 if (LineLength < HEX_TABLE_LINE_SIZE)
340 {
341 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s",
342 5 * (HEX_TABLE_LINE_SIZE - LineLength), " ");
343 }
344
345 /* Emit the offset and ascii dump for the entire line */
346
347 FlPrintFile (ASL_FILE_HEX_OUTPUT, " /* %8.8X", Offset);
348 LsDumpAsciiInComment (ASL_FILE_HEX_OUTPUT, LineLength, FileData);
349
350 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s*/\n",
351 HEX_TABLE_LINE_SIZE - LineLength + 1, " ");
352
353 Offset += LineLength;
354 }
355
356 FlPrintFile (ASL_FILE_HEX_OUTPUT, "};\n\n");
357 FlPrintFile (ASL_FILE_HEX_OUTPUT, "#endif\n");
358 }
359
360
361 /*******************************************************************************
362 *
363 * FUNCTION: HxDoHexOutputAsl
364 *
365 * PARAMETERS: None
366 *
367 * RETURN: None
368 *
369 * DESCRIPTION: Create the hex output file. This is the same data as the AML
370 * output file, but formatted into hex/ascii bytes suitable for
371 * inclusion into a C source file.
372 *
373 ******************************************************************************/
374
375 static void
HxDoHexOutputAsl(void)376 HxDoHexOutputAsl (
377 void)
378 {
379 UINT8 FileData[HEX_TABLE_LINE_SIZE];
380 UINT32 LineLength;
381 UINT32 Offset = 0;
382 UINT32 AmlFileSize;
383 UINT32 i;
384
385
386 /* Get AML size, seek back to start */
387
388 AmlFileSize = FlGetFileSize (ASL_FILE_AML_OUTPUT);
389 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
390
391 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * ASL source code output\n");
392 FlPrintFile (ASL_FILE_HEX_OUTPUT, " * AML code block contains 0x%X bytes\n *\n */\n",
393 AmlFileSize);
394 FlPrintFile (ASL_FILE_HEX_OUTPUT, " Name (BUF1, Buffer()\n {\n");
395
396 while (Offset < AmlFileSize)
397 {
398 /* Read enough bytes needed for one output line */
399
400 LineLength = HxReadAmlOutputFile (FileData);
401 if (!LineLength)
402 {
403 break;
404 }
405
406 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
407
408 for (i = 0; i < LineLength; i++)
409 {
410 /*
411 * Print each hex byte.
412 * Add a comma until the very last byte of the AML file
413 * (Some C compilers complain about a trailing comma)
414 */
415 FlPrintFile (ASL_FILE_HEX_OUTPUT, "0x%2.2X", FileData[i]);
416 if ((Offset + i + 1) < AmlFileSize)
417 {
418 FlPrintFile (ASL_FILE_HEX_OUTPUT, ",");
419 }
420 else
421 {
422 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
423 }
424 }
425
426 /* Add fill spaces if needed for last line */
427
428 if (LineLength < HEX_TABLE_LINE_SIZE)
429 {
430 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s",
431 5 * (HEX_TABLE_LINE_SIZE - LineLength), " ");
432 }
433
434 /* Emit the offset and ascii dump for the entire line */
435
436 FlPrintFile (ASL_FILE_HEX_OUTPUT, " /* %8.8X", Offset);
437 LsDumpAsciiInComment (ASL_FILE_HEX_OUTPUT, LineLength, FileData);
438
439 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s*/\n",
440 HEX_TABLE_LINE_SIZE - LineLength + 1, " ");
441
442 Offset += LineLength;
443 }
444
445 FlPrintFile (ASL_FILE_HEX_OUTPUT, " })\n");
446 }
447
448
449 /*******************************************************************************
450 *
451 * FUNCTION: HxDoHexOutputAsm
452 *
453 * PARAMETERS: None
454 *
455 * RETURN: None
456 *
457 * DESCRIPTION: Create the hex output file. This is the same data as the AML
458 * output file, but formatted into hex/ascii bytes suitable for
459 * inclusion into a ASM source file.
460 *
461 ******************************************************************************/
462
463 static void
HxDoHexOutputAsm(void)464 HxDoHexOutputAsm (
465 void)
466 {
467 UINT8 FileData[HEX_TABLE_LINE_SIZE];
468 UINT32 LineLength;
469 UINT32 Offset = 0;
470 UINT32 AmlFileSize;
471 UINT32 i;
472
473
474 /* Get AML size, seek back to start */
475
476 AmlFileSize = FlGetFileSize (ASL_FILE_AML_OUTPUT);
477 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
478
479 FlPrintFile (ASL_FILE_HEX_OUTPUT, "; Assembly code source output\n");
480 FlPrintFile (ASL_FILE_HEX_OUTPUT, "; AML code block contains 0x%X bytes\n;\n",
481 AmlFileSize);
482
483 while (Offset < AmlFileSize)
484 {
485 /* Read enough bytes needed for one output line */
486
487 LineLength = HxReadAmlOutputFile (FileData);
488 if (!LineLength)
489 {
490 break;
491 }
492
493 FlPrintFile (ASL_FILE_HEX_OUTPUT, " db ");
494
495 for (i = 0; i < LineLength; i++)
496 {
497 /*
498 * Print each hex byte.
499 * Add a comma until the last byte of the line
500 */
501 FlPrintFile (ASL_FILE_HEX_OUTPUT, "0%2.2Xh", FileData[i]);
502 if ((i + 1) < LineLength)
503 {
504 FlPrintFile (ASL_FILE_HEX_OUTPUT, ",");
505 }
506 }
507
508 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ");
509
510 /* Add fill spaces if needed for last line */
511
512 if (LineLength < HEX_TABLE_LINE_SIZE)
513 {
514 FlPrintFile (ASL_FILE_HEX_OUTPUT, "%*s",
515 5 * (HEX_TABLE_LINE_SIZE - LineLength), " ");
516 }
517
518 /* Emit the offset and ascii dump for the entire line */
519
520 FlPrintFile (ASL_FILE_HEX_OUTPUT, " ; %8.8X", Offset);
521 LsDumpAsciiInComment (ASL_FILE_HEX_OUTPUT, LineLength, FileData);
522
523 FlPrintFile (ASL_FILE_HEX_OUTPUT, "\n");
524
525 Offset += LineLength;
526 }
527
528 FlPrintFile (ASL_FILE_HEX_OUTPUT, "\n");
529 }
530
