xref: /illumos-gate/usr/src/cmd/acpi/iasl/asltransform.c (revision 35786f6866ae52207d0f1a25fe7ca5f652f32ce0)
1 /******************************************************************************
2  *
3  * Module Name: asltransform - Parse tree transforms
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 "aslcompiler.y.h"
154 
155 #define _COMPONENT          ACPI_COMPILER
156         ACPI_MODULE_NAME    ("asltransform")
157 
158 /* Local prototypes */
159 
160 static void
161 TrTransformSubtree (
162     ACPI_PARSE_OBJECT       *Op);
163 
164 static char *
165 TrAmlGetNextTempName (
166     ACPI_PARSE_OBJECT       *Op,
167     UINT8                   *TempCount);
168 
169 static void
170 TrAmlInitLineNumbers (
171     ACPI_PARSE_OBJECT       *Op,
172     ACPI_PARSE_OBJECT       *Neighbor);
173 
174 static void
175 TrAmlInitNode (
176     ACPI_PARSE_OBJECT       *Op,
177     UINT16                  ParseOpcode);
178 
179 static void
180 TrAmlSetSubtreeParent (
181     ACPI_PARSE_OBJECT       *Op,
182     ACPI_PARSE_OBJECT       *Parent);
183 
184 static void
185 TrAmlInsertPeer (
186     ACPI_PARSE_OBJECT       *Op,
187     ACPI_PARSE_OBJECT       *NewPeer);
188 
189 static void
190 TrDoDefinitionBlock (
191     ACPI_PARSE_OBJECT       *Op);
192 
193 static void
194 TrDoSwitch (
195     ACPI_PARSE_OBJECT       *StartNode);
196 
197 
198 /*******************************************************************************
199  *
200  * FUNCTION:    TrAmlGetNextTempName
201  *
202  * PARAMETERS:  Op              - Current parse op
203  *              TempCount       - Current temporary counter. Was originally
204  *                                per-module; Currently per method, could be
205  *                                expanded to per-scope.
206  *
207  * RETURN:      A pointer to name (allocated here).
208  *
209  * DESCRIPTION: Generate an ACPI name of the form _T_x. These names are
210  *              reserved for use by the ASL compiler. (_T_0 through _T_Z)
211  *
212  ******************************************************************************/
213 
214 static char *
TrAmlGetNextTempName(ACPI_PARSE_OBJECT * Op,UINT8 * TempCount)215 TrAmlGetNextTempName (
216     ACPI_PARSE_OBJECT       *Op,
217     UINT8                   *TempCount)
218 {
219     char                    *TempName;
220 
221 
222     if (*TempCount >= (10 + 26))  /* 0-35 valid: 0-9 and A-Z for TempName[3] */
223     {
224         /* Too many temps */
225 
226         AslError (ASL_ERROR, ASL_MSG_TOO_MANY_TEMPS, Op, NULL);
227         return (NULL);
228     }
229 
230     TempName = UtLocalCalloc (5);
231 
232     if (*TempCount < 10)    /* 0-9 */
233     {
234         TempName[3] = (char) (*TempCount + '0');
235     }
236     else                    /* 10-35: A-Z */
237     {
238         TempName[3] = (char) (*TempCount + ('A' - 10));
239     }
240 
241     (*TempCount)++;
242 
243     /* First three characters are always "_T_" */
244 
245     TempName[0] = '_';
246     TempName[1] = 'T';
247     TempName[2] = '_';
248 
249     return (TempName);
250 }
251 
252 
253 /*******************************************************************************
254  *
255  * FUNCTION:    TrAmlInitLineNumbers
256  *
257  * PARAMETERS:  Op              - Op to be initialized
258  *              Neighbor        - Op used for initialization values
259  *
260  * RETURN:      None
261  *
262  * DESCRIPTION: Initialized the various line numbers for a parse node.
263  *
264  ******************************************************************************/
265 
266 static void
TrAmlInitLineNumbers(ACPI_PARSE_OBJECT * Op,ACPI_PARSE_OBJECT * Neighbor)267 TrAmlInitLineNumbers (
268     ACPI_PARSE_OBJECT       *Op,
269     ACPI_PARSE_OBJECT       *Neighbor)
270 {
271 
272     Op->Asl.EndLine           = Neighbor->Asl.EndLine;
273     Op->Asl.EndLogicalLine    = Neighbor->Asl.EndLogicalLine;
274     Op->Asl.LineNumber        = Neighbor->Asl.LineNumber;
275     Op->Asl.LogicalByteOffset = Neighbor->Asl.LogicalByteOffset;
276     Op->Asl.LogicalLineNumber = Neighbor->Asl.LogicalLineNumber;
277 }
278 
279 
280 /*******************************************************************************
281  *
282  * FUNCTION:    TrAmlInitNode
283  *
284  * PARAMETERS:  Op              - Op to be initialized
285  *              ParseOpcode     - Opcode for this node
286  *
287  * RETURN:      None
288  *
289  * DESCRIPTION: Initialize a node with the parse opcode and opcode name.
290  *
291  ******************************************************************************/
292 
293 static void
TrAmlInitNode(ACPI_PARSE_OBJECT * Op,UINT16 ParseOpcode)294 TrAmlInitNode (
295     ACPI_PARSE_OBJECT       *Op,
296     UINT16                  ParseOpcode)
297 {
298 
299     Op->Asl.ParseOpcode = ParseOpcode;
300     UtSetParseOpName (Op);
301 }
302 
303 
304 /*******************************************************************************
305  *
306  * FUNCTION:    TrAmlSetSubtreeParent
307  *
308  * PARAMETERS:  Op              - First node in a list of peer nodes
309  *              Parent          - Parent of the subtree
310  *
311  * RETURN:      None
312  *
313  * DESCRIPTION: Set the parent for all peer nodes in a subtree
314  *
315  ******************************************************************************/
316 
317 static void
TrAmlSetSubtreeParent(ACPI_PARSE_OBJECT * Op,ACPI_PARSE_OBJECT * Parent)318 TrAmlSetSubtreeParent (
319     ACPI_PARSE_OBJECT       *Op,
320     ACPI_PARSE_OBJECT       *Parent)
321 {
322     ACPI_PARSE_OBJECT       *Next;
323 
324 
325     Next = Op;
326     while (Next)
327     {
328         Next->Asl.Parent = Parent;
329         Next = Next->Asl.Next;
330     }
331 }
332 
333 
334 /*******************************************************************************
335  *
336  * FUNCTION:    TrAmlInsertPeer
337  *
338  * PARAMETERS:  Op              - First node in a list of peer nodes
339  *              NewPeer         - Peer node to insert
340  *
341  * RETURN:      None
342  *
343  * DESCRIPTION: Insert a new peer node into a list of peers.
344  *
345  ******************************************************************************/
346 
347 static void
TrAmlInsertPeer(ACPI_PARSE_OBJECT * Op,ACPI_PARSE_OBJECT * NewPeer)348 TrAmlInsertPeer (
349     ACPI_PARSE_OBJECT       *Op,
350     ACPI_PARSE_OBJECT       *NewPeer)
351 {
352 
353     NewPeer->Asl.Next = Op->Asl.Next;
354     Op->Asl.Next = NewPeer;
355 }
356 
357 
358 /*******************************************************************************
359  *
360  * FUNCTION:    TrAmlTransformWalkBegin
361  *
362  * PARAMETERS:  ASL_WALK_CALLBACK
363  *
364  * RETURN:      None
365  *
366  * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
367  *              operands.
368  *
369  ******************************************************************************/
370 
371 ACPI_STATUS
TrAmlTransformWalkBegin(ACPI_PARSE_OBJECT * Op,UINT32 Level,void * Context)372 TrAmlTransformWalkBegin (
373     ACPI_PARSE_OBJECT       *Op,
374     UINT32                  Level,
375     void                    *Context)
376 {
377 
378     TrTransformSubtree (Op);
379     return (AE_OK);
380 }
381 
382 
383 /*******************************************************************************
384  *
385  * FUNCTION:    TrAmlTransformWalkEnd
386  *
387  * PARAMETERS:  ASL_WALK_CALLBACK
388  *
389  * RETURN:      None
390  *
391  * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
392  *              operands.
393  *
394  ******************************************************************************/
395 
396 ACPI_STATUS
TrAmlTransformWalkEnd(ACPI_PARSE_OBJECT * Op,UINT32 Level,void * Context)397 TrAmlTransformWalkEnd (
398     ACPI_PARSE_OBJECT       *Op,
399     UINT32                  Level,
400     void                    *Context)
401 {
402 
403     /* Save possible Externals list in the DefintionBlock Op */
404 
405     if (Op->Asl.ParseOpcode == PARSEOP_DEFINITION_BLOCK)
406     {
407         Op->Asl.Value.Arg = Gbl_ExternalsListHead;
408         Gbl_ExternalsListHead = NULL;
409     }
410 
411     return (AE_OK);
412 }
413 
414 
415 /*******************************************************************************
416  *
417  * FUNCTION:    TrTransformSubtree
418  *
419  * PARAMETERS:  Op        - The parent parse node
420  *
421  * RETURN:      None
422  *
423  * DESCRIPTION: Prepare nodes to be output as AML data and operands. The more
424  *              complex AML opcodes require processing of the child nodes
425  *              (arguments/operands).
426  *
427  ******************************************************************************/
428 
429 static void
TrTransformSubtree(ACPI_PARSE_OBJECT * Op)430 TrTransformSubtree (
431     ACPI_PARSE_OBJECT           *Op)
432 {
433     ACPI_PARSE_OBJECT           *MethodOp;
434 
435 
436     if (Op->Asl.AmlOpcode == AML_RAW_DATA_BYTE)
437     {
438         return;
439     }
440 
441     switch (Op->Asl.ParseOpcode)
442     {
443     case PARSEOP_DEFINITION_BLOCK:
444 
445         TrDoDefinitionBlock (Op);
446         break;
447 
448     case PARSEOP_SWITCH:
449 
450         TrDoSwitch (Op);
451         break;
452 
453     case PARSEOP_METHOD:
454         /*
455          * TBD: Zero the tempname (_T_x) count. Probably shouldn't be a global,
456          * however
457          */
458         Gbl_TempCount = 0;
459         break;
460 
461     case PARSEOP_EXTERNAL:
462 
463         if (Gbl_DoExternals == TRUE)
464         {
465             ExDoExternal (Op);
466         }
467 
468         break;
469 
470     case PARSEOP___METHOD__:
471 
472         /* Transform to a string op containing the parent method name */
473 
474         Op->Asl.ParseOpcode = PARSEOP_STRING_LITERAL;
475         UtSetParseOpName (Op);
476 
477         /* Find the parent control method op */
478 
479         MethodOp = Op;
480         while (MethodOp)
481         {
482             if (MethodOp->Asl.ParseOpcode == PARSEOP_METHOD)
483             {
484                 /* First child contains the method name */
485 
486                 MethodOp = MethodOp->Asl.Child;
487                 Op->Asl.Value.String = MethodOp->Asl.Value.String;
488                 return;
489             }
490 
491             MethodOp = MethodOp->Asl.Parent;
492         }
493 
494         /* At the root, invocation not within a control method */
495 
496         Op->Asl.Value.String = "\\";
497         break;
498 
499     case PARSEOP_UNLOAD:
500 
501         AslError (ASL_WARNING, ASL_MSG_UNLOAD, Op, NULL);
502         break;
503 
504     default:
505 
506         /* Nothing to do here for other opcodes */
507 
508         break;
509     }
510 }
511 
512 
513 /*******************************************************************************
514  *
515  * FUNCTION:    TrDoDefinitionBlock
516  *
517  * PARAMETERS:  Op        - Parse node
518  *
519  * RETURN:      None
520  *
521  * DESCRIPTION: Find the end of the definition block and set a global to this
522  *              node. It is used by the compiler to insert compiler-generated
523  *              names at the root level of the namespace.
524  *
525  ******************************************************************************/
526 
527 static void
TrDoDefinitionBlock(ACPI_PARSE_OBJECT * Op)528 TrDoDefinitionBlock (
529     ACPI_PARSE_OBJECT       *Op)
530 {
531     ACPI_PARSE_OBJECT       *Next;
532     UINT32                  i;
533 
534 
535     /* Reset external list when starting a definition block */
536 
537     Gbl_ExternalsListHead = NULL;
538 
539     Next = Op->Asl.Child;
540     for (i = 0; i < 5; i++)
541     {
542         Next = Next->Asl.Next;
543         if (i == 0)
544         {
545             /*
546              * This is the table signature. Only the DSDT can be assumed
547              * to be at the root of the namespace;  Therefore, namepath
548              * optimization can only be performed on the DSDT.
549              */
550             if (!ACPI_COMPARE_NAME (Next->Asl.Value.String, ACPI_SIG_DSDT))
551             {
552                 Gbl_ReferenceOptimizationFlag = FALSE;
553             }
554         }
555     }
556 
557     Gbl_FirstLevelInsertionNode = Next;
558 }
559 
560 
561 /*******************************************************************************
562  *
563  * FUNCTION:    TrDoSwitch
564  *
565  * PARAMETERS:  StartNode        - Parse node for SWITCH
566  *
567  * RETURN:      None
568  *
569  * DESCRIPTION: Translate ASL SWITCH statement to if/else pairs. There is
570  *              no actual AML opcode for SWITCH -- it must be simulated.
571  *
572  ******************************************************************************/
573 
574 static void
TrDoSwitch(ACPI_PARSE_OBJECT * StartNode)575 TrDoSwitch (
576     ACPI_PARSE_OBJECT       *StartNode)
577 {
578     ACPI_PARSE_OBJECT       *Next;
579     ACPI_PARSE_OBJECT       *CaseOp = NULL;
580     ACPI_PARSE_OBJECT       *CaseBlock = NULL;
581     ACPI_PARSE_OBJECT       *DefaultOp = NULL;
582     ACPI_PARSE_OBJECT       *CurrentParentNode;
583     ACPI_PARSE_OBJECT       *Conditional = NULL;
584     ACPI_PARSE_OBJECT       *Predicate;
585     ACPI_PARSE_OBJECT       *Peer;
586     ACPI_PARSE_OBJECT       *NewOp;
587     ACPI_PARSE_OBJECT       *NewOp2;
588     ACPI_PARSE_OBJECT       *MethodOp;
589     ACPI_PARSE_OBJECT       *StoreOp;
590     ACPI_PARSE_OBJECT       *BreakOp;
591     ACPI_PARSE_OBJECT       *BufferOp;
592     char                    *PredicateValueName;
593     UINT16                  Index;
594     UINT32                  Btype;
595 
596 
597     /* Start node is the Switch() node */
598 
599     CurrentParentNode  = StartNode;
600 
601     /* Create a new temp name of the form _T_x */
602 
603     PredicateValueName = TrAmlGetNextTempName (StartNode, &Gbl_TempCount);
604     if (!PredicateValueName)
605     {
606         return;
607     }
608 
609     /* First child is the Switch() predicate */
610 
611     Next = StartNode->Asl.Child;
612 
613     /*
614      * Examine the return type of the Switch Value -
615      * must be Integer/Buffer/String
616      */
617     Index = (UINT16) (Next->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
618     Btype = AslKeywordMapping[Index].AcpiBtype;
619     if ((Btype != ACPI_BTYPE_INTEGER) &&
620         (Btype != ACPI_BTYPE_STRING)  &&
621         (Btype != ACPI_BTYPE_BUFFER))
622     {
623         AslError (ASL_WARNING, ASL_MSG_SWITCH_TYPE, Next, NULL);
624         Btype = ACPI_BTYPE_INTEGER;
625     }
626 
627     /* CASE statements start at next child */
628 
629     Peer = Next->Asl.Next;
630     while (Peer)
631     {
632         Next = Peer;
633         Peer = Next->Asl.Next;
634 
635         if (Next->Asl.ParseOpcode == PARSEOP_CASE)
636         {
637             if (CaseOp)
638             {
639                 /* Add an ELSE to complete the previous CASE */
640 
641                 NewOp = TrCreateLeafOp (PARSEOP_ELSE);
642                 NewOp->Asl.Parent = Conditional->Asl.Parent;
643                 TrAmlInitLineNumbers (NewOp, NewOp->Asl.Parent);
644 
645                 /* Link ELSE node as a peer to the previous IF */
646 
647                 TrAmlInsertPeer (Conditional, NewOp);
648                 CurrentParentNode = NewOp;
649             }
650 
651             CaseOp = Next;
652             Conditional = CaseOp;
653             CaseBlock = CaseOp->Asl.Child->Asl.Next;
654             Conditional->Asl.Child->Asl.Next = NULL;
655             Predicate = CaseOp->Asl.Child;
656 
657             if ((Predicate->Asl.ParseOpcode == PARSEOP_PACKAGE) ||
658                 (Predicate->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE))
659             {
660                 /*
661                  * Convert the package declaration to this form:
662                  *
663                  * If (LNotEqual (Match (Package(<size>){<data>},
664                  *                       MEQ, _T_x, MTR, Zero, Zero), Ones))
665                  */
666                 NewOp2              = TrCreateLeafOp (PARSEOP_MATCHTYPE_MEQ);
667                 Predicate->Asl.Next = NewOp2;
668                 TrAmlInitLineNumbers (NewOp2, Conditional);
669 
670                 NewOp               = NewOp2;
671                 NewOp2              = TrCreateValuedLeafOp (PARSEOP_NAMESTRING,
672                                         (UINT64) ACPI_TO_INTEGER (PredicateValueName));
673                 NewOp->Asl.Next     = NewOp2;
674                 TrAmlInitLineNumbers (NewOp2, Predicate);
675 
676                 NewOp               = NewOp2;
677                 NewOp2              = TrCreateLeafOp (PARSEOP_MATCHTYPE_MTR);
678                 NewOp->Asl.Next     = NewOp2;
679                 TrAmlInitLineNumbers (NewOp2, Predicate);
680 
681                 NewOp               = NewOp2;
682                 NewOp2              = TrCreateLeafOp (PARSEOP_ZERO);
683                 NewOp->Asl.Next     = NewOp2;
684                 TrAmlInitLineNumbers (NewOp2, Predicate);
685 
686                 NewOp               = NewOp2;
687                 NewOp2              = TrCreateLeafOp (PARSEOP_ZERO);
688                 NewOp->Asl.Next     = NewOp2;
689                 TrAmlInitLineNumbers (NewOp2, Predicate);
690 
691                 NewOp2              = TrCreateLeafOp (PARSEOP_MATCH);
692                 NewOp2->Asl.Child   = Predicate;  /* PARSEOP_PACKAGE */
693                 TrAmlInitLineNumbers (NewOp2, Conditional);
694                 TrAmlSetSubtreeParent (Predicate, NewOp2);
695 
696                 NewOp               = NewOp2;
697                 NewOp2              = TrCreateLeafOp (PARSEOP_ONES);
698                 NewOp->Asl.Next     = NewOp2;
699                 TrAmlInitLineNumbers (NewOp2, Conditional);
700 
701                 NewOp2              = TrCreateLeafOp (PARSEOP_LEQUAL);
702                 NewOp2->Asl.Child   = NewOp;
703                 NewOp->Asl.Parent   = NewOp2;
704                 TrAmlInitLineNumbers (NewOp2, Conditional);
705                 TrAmlSetSubtreeParent (NewOp, NewOp2);
706 
707                 NewOp               = NewOp2;
708                 NewOp2              = TrCreateLeafOp (PARSEOP_LNOT);
709                 NewOp2->Asl.Child   = NewOp;
710                 NewOp2->Asl.Parent  = Conditional;
711                 NewOp->Asl.Parent   = NewOp2;
712                 TrAmlInitLineNumbers (NewOp2, Conditional);
713 
714                 Conditional->Asl.Child = NewOp2;
715                 NewOp2->Asl.Next = CaseBlock;
716             }
717             else
718             {
719                 /*
720                  * Integer and Buffer case.
721                  *
722                  * Change CaseOp() to:  If (LEqual (SwitchValue, CaseValue)) {...}
723                  * Note: SwitchValue is first to allow the CaseValue to be implicitly
724                  * converted to the type of SwitchValue if necessary.
725                  *
726                  * CaseOp->Child is the case value
727                  * CaseOp->Child->Peer is the beginning of the case block
728                  */
729                 NewOp = TrCreateValuedLeafOp (PARSEOP_NAMESTRING,
730                     (UINT64) ACPI_TO_INTEGER (PredicateValueName));
731                 NewOp->Asl.Next = Predicate;
732                 TrAmlInitLineNumbers (NewOp, Predicate);
733 
734                 NewOp2              = TrCreateLeafOp (PARSEOP_LEQUAL);
735                 NewOp2->Asl.Parent  = Conditional;
736                 NewOp2->Asl.Child   = NewOp;
737                 TrAmlInitLineNumbers (NewOp2, Conditional);
738 
739                 TrAmlSetSubtreeParent (NewOp, NewOp2);
740 
741                 Predicate           = NewOp2;
742                 Predicate->Asl.Next = CaseBlock;
743 
744                 TrAmlSetSubtreeParent (Predicate, Conditional);
745                 Conditional->Asl.Child = Predicate;
746             }
747 
748             /* Reinitialize the CASE node to an IF node */
749 
750             TrAmlInitNode (Conditional, PARSEOP_IF);
751 
752             /*
753              * The first CASE(IF) is not nested under an ELSE.
754              * All other CASEs are children of a parent ELSE.
755              */
756             if (CurrentParentNode == StartNode)
757             {
758                 Conditional->Asl.Next = NULL;
759             }
760             else
761             {
762                 /*
763                  * The IF is a child of previous IF/ELSE. It
764                  * is therefore without peer.
765                  */
766                 CurrentParentNode->Asl.Child = Conditional;
767                 Conditional->Asl.Parent      = CurrentParentNode;
768                 Conditional->Asl.Next        = NULL;
769             }
770         }
771         else if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT)
772         {
773             if (DefaultOp)
774             {
775                 /*
776                  * More than one Default
777                  * (Parser does not catch this, must check here)
778                  */
779                 AslError (ASL_ERROR, ASL_MSG_MULTIPLE_DEFAULT, Next, NULL);
780             }
781             else
782             {
783                 /* Save the DEFAULT node for later, after CASEs */
784 
785                 DefaultOp = Next;
786             }
787         }
788         else
789         {
790             /* Unknown peer opcode */
791 
792             AcpiOsPrintf ("Unknown parse opcode for switch statement: %s (%u)\n",
793                 Next->Asl.ParseOpName, Next->Asl.ParseOpcode);
794         }
795     }
796 
797     /* Add the default case at the end of the if/else construct */
798 
799     if (DefaultOp)
800     {
801         /* If no CASE statements, this is an error - see below */
802 
803         if (CaseOp)
804         {
805             /* Convert the DEFAULT node to an ELSE */
806 
807             TrAmlInitNode (DefaultOp, PARSEOP_ELSE);
808             DefaultOp->Asl.Parent = Conditional->Asl.Parent;
809 
810             /* Link ELSE node as a peer to the previous IF */
811 
812             TrAmlInsertPeer (Conditional, DefaultOp);
813         }
814     }
815 
816     if (!CaseOp)
817     {
818         AslError (ASL_ERROR, ASL_MSG_NO_CASES, StartNode, NULL);
819     }
820 
821 
822     /*
823      * Create a Name(_T_x, ...) statement. This statement must appear at the
824      * method level, in case a loop surrounds the switch statement and could
825      * cause the name to be created twice (error).
826      */
827 
828     /* Create the Name node */
829 
830     Predicate = StartNode->Asl.Child;
831     NewOp = TrCreateLeafOp (PARSEOP_NAME);
832     TrAmlInitLineNumbers (NewOp, StartNode);
833 
834     /* Find the parent method */
835 
836     Next = StartNode;
837     while ((Next->Asl.ParseOpcode != PARSEOP_METHOD) &&
838            (Next->Asl.ParseOpcode != PARSEOP_DEFINITION_BLOCK))
839     {
840         Next = Next->Asl.Parent;
841     }
842     MethodOp = Next;
843 
844     NewOp->Asl.CompileFlags |= OP_COMPILER_EMITTED;
845     NewOp->Asl.Parent = Next;
846 
847     /* Insert name after the method name and arguments */
848 
849     Next = Next->Asl.Child; /* Name */
850     Next = Next->Asl.Next;  /* NumArgs */
851     Next = Next->Asl.Next;  /* SerializeRule */
852 
853     /*
854      * If method is not Serialized, we must make is so, because of the way
855      * that Switch() must be implemented -- we cannot allow multiple threads
856      * to execute this method concurrently since we need to create local
857      * temporary name(s).
858      */
859     if (Next->Asl.ParseOpcode != PARSEOP_SERIALIZERULE_SERIAL)
860     {
861         AslError (ASL_REMARK, ASL_MSG_SERIALIZED, MethodOp,
862             "Due to use of Switch operator");
863         Next->Asl.ParseOpcode = PARSEOP_SERIALIZERULE_SERIAL;
864     }
865 
866     Next = Next->Asl.Next;  /* SyncLevel */
867     Next = Next->Asl.Next;  /* ReturnType */
868     Next = Next->Asl.Next;  /* ParameterTypes */
869 
870     TrAmlInsertPeer (Next, NewOp);
871     TrAmlInitLineNumbers (NewOp, Next);
872 
873     /* Create the NameSeg child for the Name node */
874 
875     NewOp2 = TrCreateValuedLeafOp (PARSEOP_NAMESEG,
876         (UINT64) ACPI_TO_INTEGER (PredicateValueName));
877     TrAmlInitLineNumbers (NewOp2, NewOp);
878     NewOp2->Asl.CompileFlags |= OP_IS_NAME_DECLARATION;
879     NewOp->Asl.Child  = NewOp2;
880 
881     /* Create the initial value for the Name. Btype was already validated above */
882 
883     switch (Btype)
884     {
885     case ACPI_BTYPE_INTEGER:
886 
887         NewOp2->Asl.Next = TrCreateValuedLeafOp (PARSEOP_ZERO,
888             (UINT64) 0);
889         TrAmlInitLineNumbers (NewOp2->Asl.Next, NewOp);
890         break;
891 
892     case ACPI_BTYPE_STRING:
893 
894         NewOp2->Asl.Next = TrCreateValuedLeafOp (PARSEOP_STRING_LITERAL,
895             (UINT64) ACPI_TO_INTEGER (""));
896         TrAmlInitLineNumbers (NewOp2->Asl.Next, NewOp);
897         break;
898 
899     case ACPI_BTYPE_BUFFER:
900 
901         (void) TrLinkPeerOp (NewOp2, TrCreateValuedLeafOp (PARSEOP_BUFFER,
902             (UINT64) 0));
903         Next = NewOp2->Asl.Next;
904         TrAmlInitLineNumbers (Next, NewOp2);
905 
906         (void) TrLinkOpChildren (Next, 1, TrCreateValuedLeafOp (PARSEOP_ZERO,
907             (UINT64) 1));
908         TrAmlInitLineNumbers (Next->Asl.Child, Next);
909 
910         BufferOp = TrCreateValuedLeafOp (PARSEOP_DEFAULT_ARG, (UINT64) 0);
911         TrAmlInitLineNumbers (BufferOp, Next->Asl.Child);
912         (void) TrLinkPeerOp (Next->Asl.Child, BufferOp);
913 
914         TrAmlSetSubtreeParent (Next->Asl.Child, Next);
915         break;
916 
917     default:
918 
919         break;
920     }
921 
922     TrAmlSetSubtreeParent (NewOp2, NewOp);
923 
924     /*
925      * Transform the Switch() into a While(One)-Break node.
926      * And create a Store() node which will be used to save the
927      * Switch() value. The store is of the form: Store (Value, _T_x)
928      * where _T_x is the temp variable.
929      */
930     TrAmlInitNode (StartNode, PARSEOP_WHILE);
931     NewOp = TrCreateLeafOp (PARSEOP_ONE);
932     TrAmlInitLineNumbers (NewOp, StartNode);
933     NewOp->Asl.Next = Predicate->Asl.Next;
934     NewOp->Asl.Parent = StartNode;
935     StartNode->Asl.Child = NewOp;
936 
937     /* Create a Store() node */
938 
939     StoreOp = TrCreateLeafOp (PARSEOP_STORE);
940     TrAmlInitLineNumbers (StoreOp, NewOp);
941     StoreOp->Asl.Parent = StartNode;
942     TrAmlInsertPeer (NewOp, StoreOp);
943 
944     /* Complete the Store subtree */
945 
946     StoreOp->Asl.Child = Predicate;
947     Predicate->Asl.Parent = StoreOp;
948 
949     NewOp = TrCreateValuedLeafOp (PARSEOP_NAMESEG,
950         (UINT64) ACPI_TO_INTEGER (PredicateValueName));
951     TrAmlInitLineNumbers (NewOp, StoreOp);
952     NewOp->Asl.Parent    = StoreOp;
953     Predicate->Asl.Next  = NewOp;
954 
955     /* Create a Break() node and insert it into the end of While() */
956 
957     Conditional = StartNode->Asl.Child;
958     while (Conditional->Asl.Next)
959     {
960         Conditional = Conditional->Asl.Next;
961     }
962 
963     BreakOp = TrCreateLeafOp (PARSEOP_BREAK);
964     TrAmlInitLineNumbers (BreakOp, NewOp);
965     BreakOp->Asl.Parent = StartNode;
966     TrAmlInsertPeer (Conditional, BreakOp);
967 }
968