sys/contrib/dev/acpica/source/compiler/asltransform.c

   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 *
 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
 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
 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
 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
 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
 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
 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
 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     default:
 500
 501         /* Nothing to do here for other opcodes */
 502
 503         break;
 504     }
 505 }
 506
 507
 508 /*******************************************************************************
 509  *
 510  * FUNCTION:    TrDoDefinitionBlock
 511  *
 512  * PARAMETERS:  Op        - Parse node
 513  *
 514  * RETURN:      None
 515  *
 516  * DESCRIPTION: Find the end of the definition block and set a global to this
 517  *              node. It is used by the compiler to insert compiler-generated
 518  *              names at the root level of the namespace.
 519  *
 520  ******************************************************************************/
 521
 522 static void
 523 TrDoDefinitionBlock (
 524     ACPI_PARSE_OBJECT       *Op)
 525 {
 526     ACPI_PARSE_OBJECT       *Next;
 527     UINT32                  i;
 528
 529
 530     /* Reset external list when starting a definition block */
 531
 532     Gbl_ExternalsListHead = NULL;
 533
 534     Next = Op->Asl.Child;
 535     for (i = 0; i < 5; i++)
 536     {
 537         Next = Next->Asl.Next;
 538         if (i == 0)
 539         {
 540             /*
 541              * This is the table signature. Only the DSDT can be assumed
 542              * to be at the root of the namespace;  Therefore, namepath
 543              * optimization can only be performed on the DSDT.
 544              */
 545             if (!ACPI_COMPARE_NAME (Next->Asl.Value.String, ACPI_SIG_DSDT))
 546             {
 547                 Gbl_ReferenceOptimizationFlag = FALSE;
 548             }
 549         }
 550     }
 551
 552     Gbl_FirstLevelInsertionNode = Next;
 553 }
 554
 555
 556 /*******************************************************************************
 557  *
 558  * FUNCTION:    TrDoSwitch
 559  *
 560  * PARAMETERS:  StartNode        - Parse node for SWITCH
 561  *
 562  * RETURN:      None
 563  *
 564  * DESCRIPTION: Translate ASL SWITCH statement to if/else pairs. There is
 565  *              no actual AML opcode for SWITCH -- it must be simulated.
 566  *
 567  ******************************************************************************/
 568
 569 static void
 570 TrDoSwitch (
 571     ACPI_PARSE_OBJECT       *StartNode)
 572 {
 573     ACPI_PARSE_OBJECT       *Next;
 574     ACPI_PARSE_OBJECT       *CaseOp = NULL;
 575     ACPI_PARSE_OBJECT       *CaseBlock = NULL;
 576     ACPI_PARSE_OBJECT       *DefaultOp = NULL;
 577     ACPI_PARSE_OBJECT       *CurrentParentNode;
 578     ACPI_PARSE_OBJECT       *Conditional = NULL;
 579     ACPI_PARSE_OBJECT       *Predicate;
 580     ACPI_PARSE_OBJECT       *Peer;
 581     ACPI_PARSE_OBJECT       *NewOp;
 582     ACPI_PARSE_OBJECT       *NewOp2;
 583     ACPI_PARSE_OBJECT       *MethodOp;
 584     ACPI_PARSE_OBJECT       *StoreOp;
 585     ACPI_PARSE_OBJECT       *BreakOp;
 586     ACPI_PARSE_OBJECT       *BufferOp;
 587     char                    *PredicateValueName;
 588     UINT16                  Index;
 589     UINT32                  Btype;
 590
 591
 592     /* Start node is the Switch() node */
 593
 594     CurrentParentNode  = StartNode;
 595
 596     /* Create a new temp name of the form _T_x */
 597
 598     PredicateValueName = TrAmlGetNextTempName (StartNode, &Gbl_TempCount);
 599     if (!PredicateValueName)
 600     {
 601         return;
 602     }
 603
 604     /* First child is the Switch() predicate */
 605
 606     Next = StartNode->Asl.Child;
 607
 608     /*
 609      * Examine the return type of the Switch Value -
 610      * must be Integer/Buffer/String
 611      */
 612     Index = (UINT16) (Next->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
 613     Btype = AslKeywordMapping[Index].AcpiBtype;
 614     if ((Btype != ACPI_BTYPE_INTEGER) &&
 615         (Btype != ACPI_BTYPE_STRING)  &&
 616         (Btype != ACPI_BTYPE_BUFFER))
 617     {
 618         AslError (ASL_WARNING, ASL_MSG_SWITCH_TYPE, Next, NULL);
 619         Btype = ACPI_BTYPE_INTEGER;
 620     }
 621
 622     /* CASE statements start at next child */
 623
 624     Peer = Next->Asl.Next;
 625     while (Peer)
 626     {
 627         Next = Peer;
 628         Peer = Next->Asl.Next;
 629
 630         if (Next->Asl.ParseOpcode == PARSEOP_CASE)
 631         {
 632             if (CaseOp)
 633             {
 634                 /* Add an ELSE to complete the previous CASE */
 635
 636                 NewOp = TrCreateLeafOp (PARSEOP_ELSE);
 637                 NewOp->Asl.Parent = Conditional->Asl.Parent;
 638                 TrAmlInitLineNumbers (NewOp, NewOp->Asl.Parent);
 639
 640                 /* Link ELSE node as a peer to the previous IF */
 641
 642                 TrAmlInsertPeer (Conditional, NewOp);
 643                 CurrentParentNode = NewOp;
 644             }
 645
 646             CaseOp = Next;
 647             Conditional = CaseOp;
 648             CaseBlock = CaseOp->Asl.Child->Asl.Next;
 649             Conditional->Asl.Child->Asl.Next = NULL;
 650             Predicate = CaseOp->Asl.Child;
 651
 652             if ((Predicate->Asl.ParseOpcode == PARSEOP_PACKAGE) ||
 653                 (Predicate->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE))
 654             {
 655                 /*
 656                  * Convert the package declaration to this form:
 657                  *
 658                  * If (LNotEqual (Match (Package(<size>){<data>},
 659                  *                       MEQ, _T_x, MTR, Zero, Zero), Ones))
 660                  */
 661                 NewOp2              = TrCreateLeafOp (PARSEOP_MATCHTYPE_MEQ);
 662                 Predicate->Asl.Next = NewOp2;
 663                 TrAmlInitLineNumbers (NewOp2, Conditional);
 664
 665                 NewOp               = NewOp2;
 666                 NewOp2              = TrCreateValuedLeafOp (PARSEOP_NAMESTRING,
 667                                         (UINT64) ACPI_TO_INTEGER (PredicateValueName));
 668                 NewOp->Asl.Next     = NewOp2;
 669                 TrAmlInitLineNumbers (NewOp2, Predicate);
 670
 671                 NewOp               = NewOp2;
 672                 NewOp2              = TrCreateLeafOp (PARSEOP_MATCHTYPE_MTR);
 673                 NewOp->Asl.Next     = NewOp2;
 674                 TrAmlInitLineNumbers (NewOp2, Predicate);
 675
 676                 NewOp               = NewOp2;
 677                 NewOp2              = TrCreateLeafOp (PARSEOP_ZERO);
 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                 NewOp2              = TrCreateLeafOp (PARSEOP_MATCH);
 687                 NewOp2->Asl.Child   = Predicate;  /* PARSEOP_PACKAGE */
 688                 TrAmlInitLineNumbers (NewOp2, Conditional);
 689                 TrAmlSetSubtreeParent (Predicate, NewOp2);
 690
 691                 NewOp               = NewOp2;
 692                 NewOp2              = TrCreateLeafOp (PARSEOP_ONES);
 693                 NewOp->Asl.Next     = NewOp2;
 694                 TrAmlInitLineNumbers (NewOp2, Conditional);
 695
 696                 NewOp2              = TrCreateLeafOp (PARSEOP_LEQUAL);
 697                 NewOp2->Asl.Child   = NewOp;
 698                 NewOp->Asl.Parent   = NewOp2;
 699                 TrAmlInitLineNumbers (NewOp2, Conditional);
 700                 TrAmlSetSubtreeParent (NewOp, NewOp2);
 701
 702                 NewOp               = NewOp2;
 703                 NewOp2              = TrCreateLeafOp (PARSEOP_LNOT);
 704                 NewOp2->Asl.Child   = NewOp;
 705                 NewOp2->Asl.Parent  = Conditional;
 706                 NewOp->Asl.Parent   = NewOp2;
 707                 TrAmlInitLineNumbers (NewOp2, Conditional);
 708
 709                 Conditional->Asl.Child = NewOp2;
 710                 NewOp2->Asl.Next = CaseBlock;
 711             }
 712             else
 713             {
 714                 /*
 715                  * Integer and Buffer case.
 716                  *
 717                  * Change CaseOp() to:  If (LEqual (SwitchValue, CaseValue)) {...}
 718                  * Note: SwitchValue is first to allow the CaseValue to be implicitly
 719                  * converted to the type of SwitchValue if necessary.
 720                  *
 721                  * CaseOp->Child is the case value
 722                  * CaseOp->Child->Peer is the beginning of the case block
 723                  */
 724                 NewOp = TrCreateValuedLeafOp (PARSEOP_NAMESTRING,
 725                     (UINT64) ACPI_TO_INTEGER (PredicateValueName));
 726                 NewOp->Asl.Next = Predicate;
 727                 TrAmlInitLineNumbers (NewOp, Predicate);
 728
 729                 NewOp2              = TrCreateLeafOp (PARSEOP_LEQUAL);
 730                 NewOp2->Asl.Parent  = Conditional;
 731                 NewOp2->Asl.Child   = NewOp;
 732                 TrAmlInitLineNumbers (NewOp2, Conditional);
 733
 734                 TrAmlSetSubtreeParent (NewOp, NewOp2);
 735
 736                 Predicate           = NewOp2;
 737                 Predicate->Asl.Next = CaseBlock;
 738
 739                 TrAmlSetSubtreeParent (Predicate, Conditional);
 740                 Conditional->Asl.Child = Predicate;
 741             }
 742
 743             /* Reinitialize the CASE node to an IF node */
 744
 745             TrAmlInitNode (Conditional, PARSEOP_IF);
 746
 747             /*
 748              * The first CASE(IF) is not nested under an ELSE.
 749              * All other CASEs are children of a parent ELSE.
 750              */
 751             if (CurrentParentNode == StartNode)
 752             {
 753                 Conditional->Asl.Next = NULL;
 754             }
 755             else
 756             {
 757                 /*
 758                  * The IF is a child of previous IF/ELSE. It
 759                  * is therefore without peer.
 760                  */
 761                 CurrentParentNode->Asl.Child = Conditional;
 762                 Conditional->Asl.Parent      = CurrentParentNode;
 763                 Conditional->Asl.Next        = NULL;
 764             }
 765         }
 766         else if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT)
 767         {
 768             if (DefaultOp)
 769             {
 770                 /*
 771                  * More than one Default
 772                  * (Parser does not catch this, must check here)
 773                  */
 774                 AslError (ASL_ERROR, ASL_MSG_MULTIPLE_DEFAULT, Next, NULL);
 775             }
 776             else
 777             {
 778                 /* Save the DEFAULT node for later, after CASEs */
 779
 780                 DefaultOp = Next;
 781             }
 782         }
 783         else
 784         {
 785             /* Unknown peer opcode */
 786
 787             AcpiOsPrintf ("Unknown parse opcode for switch statement: %s (%u)\n",
 788                 Next->Asl.ParseOpName, Next->Asl.ParseOpcode);
 789         }
 790     }
 791
 792     /* Add the default case at the end of the if/else construct */
 793
 794     if (DefaultOp)
 795     {
 796         /* If no CASE statements, this is an error - see below */
 797
 798         if (CaseOp)
 799         {
 800             /* Convert the DEFAULT node to an ELSE */
 801
 802             TrAmlInitNode (DefaultOp, PARSEOP_ELSE);
 803             DefaultOp->Asl.Parent = Conditional->Asl.Parent;
 804
 805             /* Link ELSE node as a peer to the previous IF */
 806
 807             TrAmlInsertPeer (Conditional, DefaultOp);
 808         }
 809     }
 810
 811     if (!CaseOp)
 812     {
 813         AslError (ASL_ERROR, ASL_MSG_NO_CASES, StartNode, NULL);
 814     }
 815
 816
 817     /*
 818      * Create a Name(_T_x, ...) statement. This statement must appear at the
 819      * method level, in case a loop surrounds the switch statement and could
 820      * cause the name to be created twice (error).
 821      */
 822
 823     /* Create the Name node */
 824
 825     Predicate = StartNode->Asl.Child;
 826     NewOp = TrCreateLeafOp (PARSEOP_NAME);
 827     TrAmlInitLineNumbers (NewOp, StartNode);
 828
 829     /* Find the parent method */
 830
 831     Next = StartNode;
 832     while ((Next->Asl.ParseOpcode != PARSEOP_METHOD) &&
 833            (Next->Asl.ParseOpcode != PARSEOP_DEFINITION_BLOCK))
 834     {
 835         Next = Next->Asl.Parent;
 836     }
 837     MethodOp = Next;
 838
 839     NewOp->Asl.CompileFlags |= OP_COMPILER_EMITTED;
 840     NewOp->Asl.Parent = Next;
 841
 842     /* Insert name after the method name and arguments */
 843
 844     Next = Next->Asl.Child; /* Name */
 845     Next = Next->Asl.Next;  /* NumArgs */
 846     Next = Next->Asl.Next;  /* SerializeRule */
 847
 848     /*
 849      * If method is not Serialized, we must make is so, because of the way
 850      * that Switch() must be implemented -- we cannot allow multiple threads
 851      * to execute this method concurrently since we need to create local
 852      * temporary name(s).
 853      */
 854     if (Next->Asl.ParseOpcode != PARSEOP_SERIALIZERULE_SERIAL)
 855     {
 856         AslError (ASL_REMARK, ASL_MSG_SERIALIZED, MethodOp,
 857             "Due to use of Switch operator");
 858         Next->Asl.ParseOpcode = PARSEOP_SERIALIZERULE_SERIAL;
 859     }
 860
 861     Next = Next->Asl.Next;  /* SyncLevel */
 862     Next = Next->Asl.Next;  /* ReturnType */
 863     Next = Next->Asl.Next;  /* ParameterTypes */
 864
 865     TrAmlInsertPeer (Next, NewOp);
 866     TrAmlInitLineNumbers (NewOp, Next);
 867
 868     /* Create the NameSeg child for the Name node */
 869
 870     NewOp2 = TrCreateValuedLeafOp (PARSEOP_NAMESEG,
 871         (UINT64) ACPI_TO_INTEGER (PredicateValueName));
 872     TrAmlInitLineNumbers (NewOp2, NewOp);
 873     NewOp2->Asl.CompileFlags |= OP_IS_NAME_DECLARATION;
 874     NewOp->Asl.Child  = NewOp2;
 875
 876     /* Create the initial value for the Name. Btype was already validated above */
 877
 878     switch (Btype)
 879     {
 880     case ACPI_BTYPE_INTEGER:
 881
 882         NewOp2->Asl.Next = TrCreateValuedLeafOp (PARSEOP_ZERO,
 883             (UINT64) 0);
 884         TrAmlInitLineNumbers (NewOp2->Asl.Next, NewOp);
 885         break;
 886
 887     case ACPI_BTYPE_STRING:
 888
 889         NewOp2->Asl.Next = TrCreateValuedLeafOp (PARSEOP_STRING_LITERAL,
 890             (UINT64) ACPI_TO_INTEGER (""));
 891         TrAmlInitLineNumbers (NewOp2->Asl.Next, NewOp);
 892         break;
 893
 894     case ACPI_BTYPE_BUFFER:
 895
 896         (void) TrLinkPeerOp (NewOp2, TrCreateValuedLeafOp (PARSEOP_BUFFER,
 897             (UINT64) 0));
 898         Next = NewOp2->Asl.Next;
 899         TrAmlInitLineNumbers (Next, NewOp2);
 900
 901         (void) TrLinkOpChildren (Next, 1, TrCreateValuedLeafOp (PARSEOP_ZERO,
 902             (UINT64) 1));
 903         TrAmlInitLineNumbers (Next->Asl.Child, Next);
 904
 905         BufferOp = TrCreateValuedLeafOp (PARSEOP_DEFAULT_ARG, (UINT64) 0);
 906         TrAmlInitLineNumbers (BufferOp, Next->Asl.Child);
 907         (void) TrLinkPeerOp (Next->Asl.Child, BufferOp);
 908
 909         TrAmlSetSubtreeParent (Next->Asl.Child, Next);
 910         break;
 911
 912     default:
 913
 914         break;
 915     }
 916
 917     TrAmlSetSubtreeParent (NewOp2, NewOp);
 918
 919     /*
 920      * Transform the Switch() into a While(One)-Break node.
 921      * And create a Store() node which will be used to save the
 922      * Switch() value. The store is of the form: Store (Value, _T_x)
 923      * where _T_x is the temp variable.
 924      */
 925     TrAmlInitNode (StartNode, PARSEOP_WHILE);
 926     NewOp = TrCreateLeafOp (PARSEOP_ONE);
 927     TrAmlInitLineNumbers (NewOp, StartNode);
 928     NewOp->Asl.Next = Predicate->Asl.Next;
 929     NewOp->Asl.Parent = StartNode;
 930     StartNode->Asl.Child = NewOp;
 931
 932     /* Create a Store() node */
 933
 934     StoreOp = TrCreateLeafOp (PARSEOP_STORE);
 935     TrAmlInitLineNumbers (StoreOp, NewOp);
 936     StoreOp->Asl.Parent = StartNode;
 937     TrAmlInsertPeer (NewOp, StoreOp);
 938
 939     /* Complete the Store subtree */
 940
 941     StoreOp->Asl.Child = Predicate;
 942     Predicate->Asl.Parent = StoreOp;
 943
 944     NewOp = TrCreateValuedLeafOp (PARSEOP_NAMESEG,
 945         (UINT64) ACPI_TO_INTEGER (PredicateValueName));
 946     TrAmlInitLineNumbers (NewOp, StoreOp);
 947     NewOp->Asl.Parent    = StoreOp;
 948     Predicate->Asl.Next  = NewOp;
 949
 950     /* Create a Break() node and insert it into the end of While() */
 951
 952     Conditional = StartNode->Asl.Child;
 953     while (Conditional->Asl.Next)
 954     {
 955         Conditional = Conditional->Asl.Next;
 956     }
 957
 958     BreakOp = TrCreateLeafOp (PARSEOP_BREAK);
 959     TrAmlInitLineNumbers (BreakOp, NewOp);
 960     BreakOp->Asl.Parent = StartNode;
 961     TrAmlInsertPeer (Conditional, BreakOp);
 962 }