1 /******************************************************************************
2 *
3 * Module Name: cvcompiler - ASL-/ASL+ converter functions
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 <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/include/acparser.h>
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acdebug.h>
156 #include <contrib/dev/acpica/include/acconvert.h>
157
158
159 /* Local prototypes */
160
161 static void
162 CvPrintInclude(
163 ACPI_FILE_NODE *FNode,
164 UINT32 Level);
165
166 static BOOLEAN
167 CvListIsSingleton (
168 ACPI_COMMENT_NODE *CommentList);
169
170
171 /*******************************************************************************
172 *
173 * FUNCTION: CvPrintOneCommentList
174 *
175 * PARAMETERS: CommentList
176 * Level
177 *
178 * RETURN: None
179 *
180 * DESCRIPTION: Prints all comments within the given list.
181 * This is referred as ASL_CV_PRINT_ONE_COMMENT_LIST.
182 *
183 ******************************************************************************/
184
185 void
CvPrintOneCommentList(ACPI_COMMENT_NODE * CommentList,UINT32 Level)186 CvPrintOneCommentList (
187 ACPI_COMMENT_NODE *CommentList,
188 UINT32 Level)
189 {
190 ACPI_COMMENT_NODE *Current = CommentList;
191 ACPI_COMMENT_NODE *Previous;
192
193
194 while (Current)
195 {
196 Previous = Current;
197 if (Current->Comment)
198 {
199 AcpiDmIndent(Level);
200 AcpiOsPrintf("%s\n", Current->Comment);
201 Current->Comment = NULL;
202 }
203
204 Current = Current->Next;
205 AcpiOsReleaseObject(AcpiGbl_RegCommentCache, Previous);
206 }
207 }
208
209
210 /*******************************************************************************
211 *
212 * FUNCTION: CvListIsSingleton
213 *
214 * PARAMETERS: CommentList - check to see if this is a single item list.
215 *
216 * RETURN: BOOLEAN
217 *
218 * DESCRIPTION: Returns TRUE if CommentList only contains 1 node.
219 *
220 ******************************************************************************/
221
222 static BOOLEAN
CvListIsSingleton(ACPI_COMMENT_NODE * CommentList)223 CvListIsSingleton (
224 ACPI_COMMENT_NODE *CommentList)
225
226 {
227
228 if (!CommentList)
229 {
230 return (FALSE);
231 }
232 else if (CommentList->Next)
233 {
234 return (FALSE);
235 }
236
237 return (TRUE);
238 }
239
240
241 /*******************************************************************************
242 *
243 * FUNCTION: CvPrintOneCommentType
244 *
245 * PARAMETERS: Op
246 * CommentType
247 * EndStr - String to print after printing the comment
248 * Level - indentation level for comment lists.
249 *
250 * RETURN: None
251 *
252 * DESCRIPTION: Prints all comments of CommentType within the given Op and
253 * clears the printed comment from the Op.
254 * This is referred as ASL_CV_PRINT_ONE_COMMENT.
255 *
256 ******************************************************************************/
257
258 void
CvPrintOneCommentType(ACPI_PARSE_OBJECT * Op,UINT8 CommentType,char * EndStr,UINT32 Level)259 CvPrintOneCommentType (
260 ACPI_PARSE_OBJECT *Op,
261 UINT8 CommentType,
262 char* EndStr,
263 UINT32 Level)
264 {
265 BOOLEAN CommentExists = FALSE;
266 char **CommentToPrint = NULL;
267
268
269 switch (CommentType)
270 {
271 case AML_COMMENT_STANDARD:
272
273 if (CvListIsSingleton (Op->Common.CommentList))
274 {
275 CvPrintOneCommentList (Op->Common.CommentList, Level);
276 AcpiOsPrintf ("\n");
277 }
278 else
279 {
280 CvPrintOneCommentList (Op->Common.CommentList, Level);
281 }
282
283 Op->Common.CommentList = NULL;
284 return;
285
286 case AML_COMMENT_ENDBLK:
287
288 if (Op->Common.EndBlkComment)
289 {
290 CvPrintOneCommentList (Op->Common.EndBlkComment, Level);
291 Op->Common.EndBlkComment = NULL;
292 AcpiDmIndent(Level);
293 }
294 return;
295
296 case AMLCOMMENT_INLINE:
297
298 CommentToPrint = &Op->Common.InlineComment;
299 break;
300
301 case AML_COMMENT_END_NODE:
302
303 CommentToPrint = &Op->Common.EndNodeComment;
304 break;
305
306 case AML_NAMECOMMENT:
307
308 CommentToPrint = &Op->Common.NameComment;
309 break;
310
311 case AML_COMMENT_CLOSE_BRACE:
312
313 CommentToPrint = &Op->Common.CloseBraceComment;
314 break;
315
316 default:
317 return;
318 }
319
320 if (*CommentToPrint)
321 {
322 CommentExists = TRUE;
323 AcpiOsPrintf ("%s", *CommentToPrint);
324 *CommentToPrint = NULL;
325 }
326
327 if (CommentExists && EndStr)
328 {
329 AcpiOsPrintf ("%s", EndStr);
330 }
331 }
332
333
334 /*******************************************************************************
335 *
336 * FUNCTION: CvCloseBraceWriteComment
337 *
338 * PARAMETERS: Op
339 * Level
340 *
341 * RETURN: None
342 *
343 * DESCRIPTION: Print a close brace } and any open brace comments associated
344 * with this parse object.
345 * This is referred as ASL_CV_CLOSE_BRACE.
346 *
347 ******************************************************************************/
348
349 void
CvCloseBraceWriteComment(ACPI_PARSE_OBJECT * Op,UINT32 Level)350 CvCloseBraceWriteComment(
351 ACPI_PARSE_OBJECT *Op,
352 UINT32 Level)
353 {
354
355 if (!AcpiGbl_CaptureComments)
356 {
357 AcpiOsPrintf ("}");
358 return;
359 }
360
361 CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level);
362 AcpiOsPrintf ("}");
363 CvPrintOneCommentType (Op, AML_COMMENT_CLOSE_BRACE, NULL, Level);
364 }
365
366
367 /*******************************************************************************
368 *
369 * FUNCTION: CvCloseParenWriteComment
370 *
371 * PARAMETERS: Op
372 * Level
373 *
374 * RETURN: None
375 *
376 * DESCRIPTION: Print a closing paren ) and any end node comments associated
377 * with this parse object.
378 * This is referred as ASL_CV_CLOSE_PAREN.
379 *
380 ******************************************************************************/
381
382 void
CvCloseParenWriteComment(ACPI_PARSE_OBJECT * Op,UINT32 Level)383 CvCloseParenWriteComment(
384 ACPI_PARSE_OBJECT *Op,
385 UINT32 Level)
386 {
387
388 if (!AcpiGbl_CaptureComments)
389 {
390 AcpiOsPrintf (")");
391 return;
392 }
393
394 /*
395 * If this op has a BLOCK_BRACE, then output the comment when the
396 * disassembler calls CvCloseBraceWriteComment
397 */
398 if (AcpiDmBlockType (Op) == BLOCK_PAREN)
399 {
400 CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level);
401 }
402
403 AcpiOsPrintf (")");
404
405 if (Op->Common.EndNodeComment)
406 {
407 CvPrintOneCommentType (Op, AML_COMMENT_END_NODE, NULL, Level);
408 }
409 else if ((Op->Common.Parent->Common.AmlOpcode == AML_IF_OP) &&
410 Op->Common.Parent->Common.EndNodeComment)
411 {
412 CvPrintOneCommentType (Op->Common.Parent,
413 AML_COMMENT_END_NODE, NULL, Level);
414 }
415 }
416
417
418 /*******************************************************************************
419 *
420 * FUNCTION: CvFileHasSwitched
421 *
422 * PARAMETERS: Op
423 *
424 * RETURN: BOOLEAN
425 *
426 * DESCRIPTION: Determine whether if a file has switched.
427 * TRUE - file has switched.
428 * FALSE - file has not switched.
429 * This is referred as ASL_CV_FILE_HAS_SWITCHED.
430 *
431 ******************************************************************************/
432
433 BOOLEAN
CvFileHasSwitched(ACPI_PARSE_OBJECT * Op)434 CvFileHasSwitched(
435 ACPI_PARSE_OBJECT *Op)
436 {
437
438 if (Op->Common.CvFilename &&
439 AcpiGbl_CurrentFilename &&
440 AcpiUtStricmp(Op->Common.CvFilename, AcpiGbl_CurrentFilename))
441 {
442 return (TRUE);
443 }
444
445 return (FALSE);
446 }
447
448
449 /*******************************************************************************
450 *
451 * FUNCTION: CvPrintInclude
452 *
453 * PARAMETERS: FNode - Write an Include statement for the file that is pointed
454 * by FNode->File.
455 * Level - indentation level
456 *
457 * RETURN: None
458 *
459 * DESCRIPTION: Write the ASL Include statement for FNode->File in the file
460 * indicated by FNode->Parent->File. Note this function emits
461 * actual ASL code rather than comments. This switches the output
462 * file to FNode->Parent->File.
463 *
464 ******************************************************************************/
465
466 static void
CvPrintInclude(ACPI_FILE_NODE * FNode,UINT32 Level)467 CvPrintInclude(
468 ACPI_FILE_NODE *FNode,
469 UINT32 Level)
470 {
471
472 if (!FNode || FNode->IncludeWritten)
473 {
474 return;
475 }
476
477 CvDbgPrint ("Writing include for %s within %s\n",
478 FNode->Filename, FNode->Parent->Filename);
479 AcpiOsRedirectOutput (FNode->Parent->File);
480 CvPrintOneCommentList (FNode->IncludeComment, Level);
481
482 AcpiDmIndent (Level);
483 AcpiOsPrintf ("Include (\"%s\")\n", FNode->Filename);
484 CvDbgPrint ("emitted the following: Include (\"%s\")\n",
485 FNode->Filename);
486 FNode->IncludeWritten = TRUE;
487 }
488
489
490 /*******************************************************************************
491 *
492 * FUNCTION: CvSwitchFiles
493 *
494 * PARAMETERS: Level - indentation level
495 * Op
496 *
497 * RETURN: None
498 *
499 * DESCRIPTION: Switch the outputfile and write ASL Include statement. Note,
500 * this function emits actual ASL code rather than comments.
501 * This is referred as ASL_CV_SWITCH_FILES.
502 *
503 ******************************************************************************/
504
505 void
CvSwitchFiles(UINT32 Level,ACPI_PARSE_OBJECT * Op)506 CvSwitchFiles(
507 UINT32 Level,
508 ACPI_PARSE_OBJECT *Op)
509 {
510 char *Filename = Op->Common.CvFilename;
511 ACPI_FILE_NODE *FNode;
512 ACPI_FILE_NODE *Current;
513
514
515 CvDbgPrint ("Switching from %s to %s\n", AcpiGbl_CurrentFilename,
516 Filename);
517 FNode = CvFilenameExists (Filename, AcpiGbl_FileTreeRoot);
518 if (!FNode)
519 {
520 /*
521 * At this point, each Filename should exist in AcpiGbl_FileTreeRoot
522 * if it does not exist, then abort.
523 */
524 FlDeleteFile (ASL_FILE_AML_OUTPUT);
525 sprintf (AslGbl_MsgBuffer, "\"Cannot find %s\" - %s",
526 Filename, strerror (errno));
527 AslCommonError (ASL_ERROR, ASL_MSG_OPEN, 0, 0, 0, 0,
528 NULL, AslGbl_MsgBuffer);
529 AslAbort ();
530 }
531
532 Current = FNode;
533
534 /*
535 * If the previous file is a descendent of the current file,
536 * make sure that Include statements from the current file
537 * to the previous have been emitted.
538 */
539 while (Current &&
540 Current->Parent &&
541 AcpiUtStricmp (Current->Filename, AcpiGbl_CurrentFilename))
542 {
543 CvPrintInclude (Current, Level);
544 Current = Current->Parent;
545 }
546
547 if (FNode)
548 {
549 /* Redirect output to Op->Common.CvFilename */
550
551 AcpiOsRedirectOutput (FNode->File);
552 AcpiGbl_CurrentFilename = FNode->Filename;
553 }
554 }
555