Home | History | Annotate | Line # | Download | only in parser
psparse.c revision 1.1
      1  1.1  jruoho /******************************************************************************
      2  1.1  jruoho  *
      3  1.1  jruoho  * Module Name: psparse - Parser top level AML parse routines
      4  1.1  jruoho  *
      5  1.1  jruoho  *****************************************************************************/
      6  1.1  jruoho 
      7  1.1  jruoho /******************************************************************************
      8  1.1  jruoho  *
      9  1.1  jruoho  * 1. Copyright Notice
     10  1.1  jruoho  *
     11  1.1  jruoho  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
     12  1.1  jruoho  * All rights reserved.
     13  1.1  jruoho  *
     14  1.1  jruoho  * 2. License
     15  1.1  jruoho  *
     16  1.1  jruoho  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.1  jruoho  * rights.  You may have additional license terms from the party that provided
     18  1.1  jruoho  * you this software, covering your right to use that party's intellectual
     19  1.1  jruoho  * property rights.
     20  1.1  jruoho  *
     21  1.1  jruoho  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.1  jruoho  * copy of the source code appearing in this file ("Covered Code") an
     23  1.1  jruoho  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.1  jruoho  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.1  jruoho  * make derivatives, distribute, use and display any portion of the Covered
     26  1.1  jruoho  * Code in any form, with the right to sublicense such rights; and
     27  1.1  jruoho  *
     28  1.1  jruoho  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.1  jruoho  * license (with the right to sublicense), under only those claims of Intel
     30  1.1  jruoho  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.1  jruoho  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.1  jruoho  * solely to the minimum extent necessary to exercise the above copyright
     33  1.1  jruoho  * license, and in no event shall the patent license extend to any additions
     34  1.1  jruoho  * to or modifications of the Original Intel Code.  No other license or right
     35  1.1  jruoho  * is granted directly or by implication, estoppel or otherwise;
     36  1.1  jruoho  *
     37  1.1  jruoho  * The above copyright and patent license is granted only if the following
     38  1.1  jruoho  * conditions are met:
     39  1.1  jruoho  *
     40  1.1  jruoho  * 3. Conditions
     41  1.1  jruoho  *
     42  1.1  jruoho  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.1  jruoho  * Redistribution of source code of any substantial portion of the Covered
     44  1.1  jruoho  * Code or modification with rights to further distribute source must include
     45  1.1  jruoho  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.1  jruoho  * and the following Disclaimer and Export Compliance provision.  In addition,
     47  1.1  jruoho  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.1  jruoho  * contain a file documenting the changes Licensee made to create that Covered
     49  1.1  jruoho  * Code and the date of any change.  Licensee must include in that file the
     50  1.1  jruoho  * documentation of any changes made by any predecessor Licensee.  Licensee
     51  1.1  jruoho  * must include a prominent statement that the modification is derived,
     52  1.1  jruoho  * directly or indirectly, from Original Intel Code.
     53  1.1  jruoho  *
     54  1.1  jruoho  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.1  jruoho  * Redistribution of source code of any substantial portion of the Covered
     56  1.1  jruoho  * Code or modification without rights to further distribute source must
     57  1.1  jruoho  * include the following Disclaimer and Export Compliance provision in the
     58  1.1  jruoho  * documentation and/or other materials provided with distribution.  In
     59  1.1  jruoho  * addition, Licensee may not authorize further sublicense of source of any
     60  1.1  jruoho  * portion of the Covered Code, and must include terms to the effect that the
     61  1.1  jruoho  * license from Licensee to its licensee is limited to the intellectual
     62  1.1  jruoho  * property embodied in the software Licensee provides to its licensee, and
     63  1.1  jruoho  * not to intellectual property embodied in modifications its licensee may
     64  1.1  jruoho  * make.
     65  1.1  jruoho  *
     66  1.1  jruoho  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.1  jruoho  * substantial portion of the Covered Code or modification must reproduce the
     68  1.1  jruoho  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.1  jruoho  * provision in the documentation and/or other materials provided with the
     70  1.1  jruoho  * distribution.
     71  1.1  jruoho  *
     72  1.1  jruoho  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.1  jruoho  * Intel Code.
     74  1.1  jruoho  *
     75  1.1  jruoho  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.1  jruoho  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.1  jruoho  * other dealings in products derived from or relating to the Covered Code
     78  1.1  jruoho  * without prior written authorization from Intel.
     79  1.1  jruoho  *
     80  1.1  jruoho  * 4. Disclaimer and Export Compliance
     81  1.1  jruoho  *
     82  1.1  jruoho  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.1  jruoho  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.1  jruoho  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
     85  1.1  jruoho  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
     86  1.1  jruoho  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.1  jruoho  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.1  jruoho  * PARTICULAR PURPOSE.
     89  1.1  jruoho  *
     90  1.1  jruoho  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.1  jruoho  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.1  jruoho  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.1  jruoho  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.1  jruoho  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.1  jruoho  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
     96  1.1  jruoho  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.1  jruoho  * LIMITED REMEDY.
     98  1.1  jruoho  *
     99  1.1  jruoho  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.1  jruoho  * software or system incorporating such software without first obtaining any
    101  1.1  jruoho  * required license or other approval from the U. S. Department of Commerce or
    102  1.1  jruoho  * any other agency or department of the United States Government.  In the
    103  1.1  jruoho  * event Licensee exports any such software from the United States or
    104  1.1  jruoho  * re-exports any such software from a foreign destination, Licensee shall
    105  1.1  jruoho  * ensure that the distribution and export/re-export of the software is in
    106  1.1  jruoho  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.1  jruoho  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.1  jruoho  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.1  jruoho  * software, or service, directly or indirectly, to any country for which the
    110  1.1  jruoho  * United States government or any agency thereof requires an export license,
    111  1.1  jruoho  * other governmental approval, or letter of assurance, without first obtaining
    112  1.1  jruoho  * such license, approval or letter.
    113  1.1  jruoho  *
    114  1.1  jruoho  *****************************************************************************/
    115  1.1  jruoho 
    116  1.1  jruoho 
    117  1.1  jruoho /*
    118  1.1  jruoho  * Parse the AML and build an operation tree as most interpreters,
    119  1.1  jruoho  * like Perl, do.  Parsing is done by hand rather than with a YACC
    120  1.1  jruoho  * generated parser to tightly constrain stack and dynamic memory
    121  1.1  jruoho  * usage.  At the same time, parsing is kept flexible and the code
    122  1.1  jruoho  * fairly compact by parsing based on a list of AML opcode
    123  1.1  jruoho  * templates in AmlOpInfo[]
    124  1.1  jruoho  */
    125  1.1  jruoho 
    126  1.1  jruoho #include "acpi.h"
    127  1.1  jruoho #include "accommon.h"
    128  1.1  jruoho #include "acparser.h"
    129  1.1  jruoho #include "acdispat.h"
    130  1.1  jruoho #include "amlcode.h"
    131  1.1  jruoho #include "acnamesp.h"
    132  1.1  jruoho #include "acinterp.h"
    133  1.1  jruoho 
    134  1.1  jruoho #define _COMPONENT          ACPI_PARSER
    135  1.1  jruoho         ACPI_MODULE_NAME    ("psparse")
    136  1.1  jruoho 
    137  1.1  jruoho 
    138  1.1  jruoho /*******************************************************************************
    139  1.1  jruoho  *
    140  1.1  jruoho  * FUNCTION:    AcpiPsGetOpcodeSize
    141  1.1  jruoho  *
    142  1.1  jruoho  * PARAMETERS:  Opcode          - An AML opcode
    143  1.1  jruoho  *
    144  1.1  jruoho  * RETURN:      Size of the opcode, in bytes (1 or 2)
    145  1.1  jruoho  *
    146  1.1  jruoho  * DESCRIPTION: Get the size of the current opcode.
    147  1.1  jruoho  *
    148  1.1  jruoho  ******************************************************************************/
    149  1.1  jruoho 
    150  1.1  jruoho UINT32
    151  1.1  jruoho AcpiPsGetOpcodeSize (
    152  1.1  jruoho     UINT32                  Opcode)
    153  1.1  jruoho {
    154  1.1  jruoho 
    155  1.1  jruoho     /* Extended (2-byte) opcode if > 255 */
    156  1.1  jruoho 
    157  1.1  jruoho     if (Opcode > 0x00FF)
    158  1.1  jruoho     {
    159  1.1  jruoho         return (2);
    160  1.1  jruoho     }
    161  1.1  jruoho 
    162  1.1  jruoho     /* Otherwise, just a single byte opcode */
    163  1.1  jruoho 
    164  1.1  jruoho     return (1);
    165  1.1  jruoho }
    166  1.1  jruoho 
    167  1.1  jruoho 
    168  1.1  jruoho /*******************************************************************************
    169  1.1  jruoho  *
    170  1.1  jruoho  * FUNCTION:    AcpiPsPeekOpcode
    171  1.1  jruoho  *
    172  1.1  jruoho  * PARAMETERS:  ParserState         - A parser state object
    173  1.1  jruoho  *
    174  1.1  jruoho  * RETURN:      Next AML opcode
    175  1.1  jruoho  *
    176  1.1  jruoho  * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
    177  1.1  jruoho  *
    178  1.1  jruoho  ******************************************************************************/
    179  1.1  jruoho 
    180  1.1  jruoho UINT16
    181  1.1  jruoho AcpiPsPeekOpcode (
    182  1.1  jruoho     ACPI_PARSE_STATE        *ParserState)
    183  1.1  jruoho {
    184  1.1  jruoho     UINT8                   *Aml;
    185  1.1  jruoho     UINT16                  Opcode;
    186  1.1  jruoho 
    187  1.1  jruoho 
    188  1.1  jruoho     Aml = ParserState->Aml;
    189  1.1  jruoho     Opcode = (UINT16) ACPI_GET8 (Aml);
    190  1.1  jruoho 
    191  1.1  jruoho     if (Opcode == AML_EXTENDED_OP_PREFIX)
    192  1.1  jruoho     {
    193  1.1  jruoho         /* Extended opcode, get the second opcode byte */
    194  1.1  jruoho 
    195  1.1  jruoho         Aml++;
    196  1.1  jruoho         Opcode = (UINT16) ((Opcode << 8) | ACPI_GET8 (Aml));
    197  1.1  jruoho     }
    198  1.1  jruoho 
    199  1.1  jruoho     return (Opcode);
    200  1.1  jruoho }
    201  1.1  jruoho 
    202  1.1  jruoho 
    203  1.1  jruoho /*******************************************************************************
    204  1.1  jruoho  *
    205  1.1  jruoho  * FUNCTION:    AcpiPsCompleteThisOp
    206  1.1  jruoho  *
    207  1.1  jruoho  * PARAMETERS:  WalkState       - Current State
    208  1.1  jruoho  *              Op              - Op to complete
    209  1.1  jruoho  *
    210  1.1  jruoho  * RETURN:      Status
    211  1.1  jruoho  *
    212  1.1  jruoho  * DESCRIPTION: Perform any cleanup at the completion of an Op.
    213  1.1  jruoho  *
    214  1.1  jruoho  ******************************************************************************/
    215  1.1  jruoho 
    216  1.1  jruoho ACPI_STATUS
    217  1.1  jruoho AcpiPsCompleteThisOp (
    218  1.1  jruoho     ACPI_WALK_STATE         *WalkState,
    219  1.1  jruoho     ACPI_PARSE_OBJECT       *Op)
    220  1.1  jruoho {
    221  1.1  jruoho     ACPI_PARSE_OBJECT       *Prev;
    222  1.1  jruoho     ACPI_PARSE_OBJECT       *Next;
    223  1.1  jruoho     const ACPI_OPCODE_INFO  *ParentInfo;
    224  1.1  jruoho     ACPI_PARSE_OBJECT       *ReplacementOp = NULL;
    225  1.1  jruoho     ACPI_STATUS             Status = AE_OK;
    226  1.1  jruoho 
    227  1.1  jruoho 
    228  1.1  jruoho     ACPI_FUNCTION_TRACE_PTR (PsCompleteThisOp, Op);
    229  1.1  jruoho 
    230  1.1  jruoho 
    231  1.1  jruoho     /* Check for null Op, can happen if AML code is corrupt */
    232  1.1  jruoho 
    233  1.1  jruoho     if (!Op)
    234  1.1  jruoho     {
    235  1.1  jruoho         return_ACPI_STATUS (AE_OK);  /* OK for now */
    236  1.1  jruoho     }
    237  1.1  jruoho 
    238  1.1  jruoho     /* Delete this op and the subtree below it if asked to */
    239  1.1  jruoho 
    240  1.1  jruoho     if (((WalkState->ParseFlags & ACPI_PARSE_TREE_MASK) != ACPI_PARSE_DELETE_TREE) ||
    241  1.1  jruoho          (WalkState->OpInfo->Class == AML_CLASS_ARGUMENT))
    242  1.1  jruoho     {
    243  1.1  jruoho         return_ACPI_STATUS (AE_OK);
    244  1.1  jruoho     }
    245  1.1  jruoho 
    246  1.1  jruoho     /* Make sure that we only delete this subtree */
    247  1.1  jruoho 
    248  1.1  jruoho     if (Op->Common.Parent)
    249  1.1  jruoho     {
    250  1.1  jruoho         Prev = Op->Common.Parent->Common.Value.Arg;
    251  1.1  jruoho         if (!Prev)
    252  1.1  jruoho         {
    253  1.1  jruoho             /* Nothing more to do */
    254  1.1  jruoho 
    255  1.1  jruoho             goto Cleanup;
    256  1.1  jruoho         }
    257  1.1  jruoho 
    258  1.1  jruoho         /*
    259  1.1  jruoho          * Check if we need to replace the operator and its subtree
    260  1.1  jruoho          * with a return value op (placeholder op)
    261  1.1  jruoho          */
    262  1.1  jruoho         ParentInfo = AcpiPsGetOpcodeInfo (Op->Common.Parent->Common.AmlOpcode);
    263  1.1  jruoho 
    264  1.1  jruoho         switch (ParentInfo->Class)
    265  1.1  jruoho         {
    266  1.1  jruoho         case AML_CLASS_CONTROL:
    267  1.1  jruoho             break;
    268  1.1  jruoho 
    269  1.1  jruoho         case AML_CLASS_CREATE:
    270  1.1  jruoho 
    271  1.1  jruoho             /*
    272  1.1  jruoho              * These opcodes contain TermArg operands.  The current
    273  1.1  jruoho              * op must be replaced by a placeholder return op
    274  1.1  jruoho              */
    275  1.1  jruoho             ReplacementOp = AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP);
    276  1.1  jruoho             if (!ReplacementOp)
    277  1.1  jruoho             {
    278  1.1  jruoho                 Status = AE_NO_MEMORY;
    279  1.1  jruoho             }
    280  1.1  jruoho             break;
    281  1.1  jruoho 
    282  1.1  jruoho         case AML_CLASS_NAMED_OBJECT:
    283  1.1  jruoho 
    284  1.1  jruoho             /*
    285  1.1  jruoho              * These opcodes contain TermArg operands.  The current
    286  1.1  jruoho              * op must be replaced by a placeholder return op
    287  1.1  jruoho              */
    288  1.1  jruoho             if ((Op->Common.Parent->Common.AmlOpcode == AML_REGION_OP)       ||
    289  1.1  jruoho                 (Op->Common.Parent->Common.AmlOpcode == AML_DATA_REGION_OP)  ||
    290  1.1  jruoho                 (Op->Common.Parent->Common.AmlOpcode == AML_BUFFER_OP)       ||
    291  1.1  jruoho                 (Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP)      ||
    292  1.1  jruoho                 (Op->Common.Parent->Common.AmlOpcode == AML_BANK_FIELD_OP)   ||
    293  1.1  jruoho                 (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
    294  1.1  jruoho             {
    295  1.1  jruoho                 ReplacementOp = AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP);
    296  1.1  jruoho                 if (!ReplacementOp)
    297  1.1  jruoho                 {
    298  1.1  jruoho                     Status = AE_NO_MEMORY;
    299  1.1  jruoho                 }
    300  1.1  jruoho             }
    301  1.1  jruoho             else if ((Op->Common.Parent->Common.AmlOpcode == AML_NAME_OP) &&
    302  1.1  jruoho                      (WalkState->PassNumber <= ACPI_IMODE_LOAD_PASS2))
    303  1.1  jruoho             {
    304  1.1  jruoho                 if ((Op->Common.AmlOpcode == AML_BUFFER_OP) ||
    305  1.1  jruoho                     (Op->Common.AmlOpcode == AML_PACKAGE_OP) ||
    306  1.1  jruoho                     (Op->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
    307  1.1  jruoho                 {
    308  1.1  jruoho                     ReplacementOp = AcpiPsAllocOp (Op->Common.AmlOpcode);
    309  1.1  jruoho                     if (!ReplacementOp)
    310  1.1  jruoho                     {
    311  1.1  jruoho                         Status = AE_NO_MEMORY;
    312  1.1  jruoho                     }
    313  1.1  jruoho                     else
    314  1.1  jruoho                     {
    315  1.1  jruoho                         ReplacementOp->Named.Data = Op->Named.Data;
    316  1.1  jruoho                         ReplacementOp->Named.Length = Op->Named.Length;
    317  1.1  jruoho                     }
    318  1.1  jruoho                 }
    319  1.1  jruoho             }
    320  1.1  jruoho             break;
    321  1.1  jruoho 
    322  1.1  jruoho         default:
    323  1.1  jruoho 
    324  1.1  jruoho             ReplacementOp = AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP);
    325  1.1  jruoho             if (!ReplacementOp)
    326  1.1  jruoho             {
    327  1.1  jruoho                 Status = AE_NO_MEMORY;
    328  1.1  jruoho             }
    329  1.1  jruoho         }
    330  1.1  jruoho 
    331  1.1  jruoho         /* We must unlink this op from the parent tree */
    332  1.1  jruoho 
    333  1.1  jruoho         if (Prev == Op)
    334  1.1  jruoho         {
    335  1.1  jruoho             /* This op is the first in the list */
    336  1.1  jruoho 
    337  1.1  jruoho             if (ReplacementOp)
    338  1.1  jruoho             {
    339  1.1  jruoho                 ReplacementOp->Common.Parent        = Op->Common.Parent;
    340  1.1  jruoho                 ReplacementOp->Common.Value.Arg     = NULL;
    341  1.1  jruoho                 ReplacementOp->Common.Node          = Op->Common.Node;
    342  1.1  jruoho                 Op->Common.Parent->Common.Value.Arg = ReplacementOp;
    343  1.1  jruoho                 ReplacementOp->Common.Next          = Op->Common.Next;
    344  1.1  jruoho             }
    345  1.1  jruoho             else
    346  1.1  jruoho             {
    347  1.1  jruoho                 Op->Common.Parent->Common.Value.Arg = Op->Common.Next;
    348  1.1  jruoho             }
    349  1.1  jruoho         }
    350  1.1  jruoho 
    351  1.1  jruoho         /* Search the parent list */
    352  1.1  jruoho 
    353  1.1  jruoho         else while (Prev)
    354  1.1  jruoho         {
    355  1.1  jruoho             /* Traverse all siblings in the parent's argument list */
    356  1.1  jruoho 
    357  1.1  jruoho             Next = Prev->Common.Next;
    358  1.1  jruoho             if (Next == Op)
    359  1.1  jruoho             {
    360  1.1  jruoho                 if (ReplacementOp)
    361  1.1  jruoho                 {
    362  1.1  jruoho                     ReplacementOp->Common.Parent    = Op->Common.Parent;
    363  1.1  jruoho                     ReplacementOp->Common.Value.Arg = NULL;
    364  1.1  jruoho                     ReplacementOp->Common.Node      = Op->Common.Node;
    365  1.1  jruoho                     Prev->Common.Next               = ReplacementOp;
    366  1.1  jruoho                     ReplacementOp->Common.Next      = Op->Common.Next;
    367  1.1  jruoho                     Next = NULL;
    368  1.1  jruoho                 }
    369  1.1  jruoho                 else
    370  1.1  jruoho                 {
    371  1.1  jruoho                     Prev->Common.Next = Op->Common.Next;
    372  1.1  jruoho                     Next = NULL;
    373  1.1  jruoho                 }
    374  1.1  jruoho             }
    375  1.1  jruoho             Prev = Next;
    376  1.1  jruoho         }
    377  1.1  jruoho     }
    378  1.1  jruoho 
    379  1.1  jruoho 
    380  1.1  jruoho Cleanup:
    381  1.1  jruoho 
    382  1.1  jruoho     /* Now we can actually delete the subtree rooted at Op */
    383  1.1  jruoho 
    384  1.1  jruoho     AcpiPsDeleteParseTree (Op);
    385  1.1  jruoho     return_ACPI_STATUS (Status);
    386  1.1  jruoho }
    387  1.1  jruoho 
    388  1.1  jruoho 
    389  1.1  jruoho /*******************************************************************************
    390  1.1  jruoho  *
    391  1.1  jruoho  * FUNCTION:    AcpiPsNextParseState
    392  1.1  jruoho  *
    393  1.1  jruoho  * PARAMETERS:  WalkState           - Current state
    394  1.1  jruoho  *              Op                  - Current parse op
    395  1.1  jruoho  *              CallbackStatus      - Status from previous operation
    396  1.1  jruoho  *
    397  1.1  jruoho  * RETURN:      Status
    398  1.1  jruoho  *
    399  1.1  jruoho  * DESCRIPTION: Update the parser state based upon the return exception from
    400  1.1  jruoho  *              the parser callback.
    401  1.1  jruoho  *
    402  1.1  jruoho  ******************************************************************************/
    403  1.1  jruoho 
    404  1.1  jruoho ACPI_STATUS
    405  1.1  jruoho AcpiPsNextParseState (
    406  1.1  jruoho     ACPI_WALK_STATE         *WalkState,
    407  1.1  jruoho     ACPI_PARSE_OBJECT       *Op,
    408  1.1  jruoho     ACPI_STATUS             CallbackStatus)
    409  1.1  jruoho {
    410  1.1  jruoho     ACPI_PARSE_STATE        *ParserState = &WalkState->ParserState;
    411  1.1  jruoho     ACPI_STATUS             Status = AE_CTRL_PENDING;
    412  1.1  jruoho 
    413  1.1  jruoho 
    414  1.1  jruoho     ACPI_FUNCTION_TRACE_PTR (PsNextParseState, Op);
    415  1.1  jruoho 
    416  1.1  jruoho 
    417  1.1  jruoho     switch (CallbackStatus)
    418  1.1  jruoho     {
    419  1.1  jruoho     case AE_CTRL_TERMINATE:
    420  1.1  jruoho         /*
    421  1.1  jruoho          * A control method was terminated via a RETURN statement.
    422  1.1  jruoho          * The walk of this method is complete.
    423  1.1  jruoho          */
    424  1.1  jruoho         ParserState->Aml = ParserState->AmlEnd;
    425  1.1  jruoho         Status = AE_CTRL_TERMINATE;
    426  1.1  jruoho         break;
    427  1.1  jruoho 
    428  1.1  jruoho 
    429  1.1  jruoho     case AE_CTRL_BREAK:
    430  1.1  jruoho 
    431  1.1  jruoho         ParserState->Aml = WalkState->AmlLastWhile;
    432  1.1  jruoho         WalkState->ControlState->Common.Value = FALSE;
    433  1.1  jruoho         Status = AE_CTRL_BREAK;
    434  1.1  jruoho         break;
    435  1.1  jruoho 
    436  1.1  jruoho 
    437  1.1  jruoho     case AE_CTRL_CONTINUE:
    438  1.1  jruoho 
    439  1.1  jruoho         ParserState->Aml = WalkState->AmlLastWhile;
    440  1.1  jruoho         Status = AE_CTRL_CONTINUE;
    441  1.1  jruoho         break;
    442  1.1  jruoho 
    443  1.1  jruoho 
    444  1.1  jruoho     case AE_CTRL_PENDING:
    445  1.1  jruoho 
    446  1.1  jruoho         ParserState->Aml = WalkState->AmlLastWhile;
    447  1.1  jruoho         break;
    448  1.1  jruoho 
    449  1.1  jruoho #if 0
    450  1.1  jruoho     case AE_CTRL_SKIP:
    451  1.1  jruoho 
    452  1.1  jruoho         ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
    453  1.1  jruoho         Status = AE_OK;
    454  1.1  jruoho         break;
    455  1.1  jruoho #endif
    456  1.1  jruoho 
    457  1.1  jruoho     case AE_CTRL_TRUE:
    458  1.1  jruoho         /*
    459  1.1  jruoho          * Predicate of an IF was true, and we are at the matching ELSE.
    460  1.1  jruoho          * Just close out this package
    461  1.1  jruoho          */
    462  1.1  jruoho         ParserState->Aml = AcpiPsGetNextPackageEnd (ParserState);
    463  1.1  jruoho         Status = AE_CTRL_PENDING;
    464  1.1  jruoho         break;
    465  1.1  jruoho 
    466  1.1  jruoho 
    467  1.1  jruoho     case AE_CTRL_FALSE:
    468  1.1  jruoho         /*
    469  1.1  jruoho          * Either an IF/WHILE Predicate was false or we encountered a BREAK
    470  1.1  jruoho          * opcode.  In both cases, we do not execute the rest of the
    471  1.1  jruoho          * package;  We simply close out the parent (finishing the walk of
    472  1.1  jruoho          * this branch of the tree) and continue execution at the parent
    473  1.1  jruoho          * level.
    474  1.1  jruoho          */
    475  1.1  jruoho         ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
    476  1.1  jruoho 
    477  1.1  jruoho         /* In the case of a BREAK, just force a predicate (if any) to FALSE */
    478  1.1  jruoho 
    479  1.1  jruoho         WalkState->ControlState->Common.Value = FALSE;
    480  1.1  jruoho         Status = AE_CTRL_END;
    481  1.1  jruoho         break;
    482  1.1  jruoho 
    483  1.1  jruoho 
    484  1.1  jruoho     case AE_CTRL_TRANSFER:
    485  1.1  jruoho 
    486  1.1  jruoho         /* A method call (invocation) -- transfer control */
    487  1.1  jruoho 
    488  1.1  jruoho         Status = AE_CTRL_TRANSFER;
    489  1.1  jruoho         WalkState->PrevOp = Op;
    490  1.1  jruoho         WalkState->MethodCallOp = Op;
    491  1.1  jruoho         WalkState->MethodCallNode = (Op->Common.Value.Arg)->Common.Node;
    492  1.1  jruoho 
    493  1.1  jruoho         /* Will return value (if any) be used by the caller? */
    494  1.1  jruoho 
    495  1.1  jruoho         WalkState->ReturnUsed = AcpiDsIsResultUsed (Op, WalkState);
    496  1.1  jruoho         break;
    497  1.1  jruoho 
    498  1.1  jruoho 
    499  1.1  jruoho     default:
    500  1.1  jruoho 
    501  1.1  jruoho         Status = CallbackStatus;
    502  1.1  jruoho         if ((CallbackStatus & AE_CODE_MASK) == AE_CODE_CONTROL)
    503  1.1  jruoho         {
    504  1.1  jruoho             Status = AE_OK;
    505  1.1  jruoho         }
    506  1.1  jruoho         break;
    507  1.1  jruoho     }
    508  1.1  jruoho 
    509  1.1  jruoho     return_ACPI_STATUS (Status);
    510  1.1  jruoho }
    511  1.1  jruoho 
    512  1.1  jruoho 
    513  1.1  jruoho /*******************************************************************************
    514  1.1  jruoho  *
    515  1.1  jruoho  * FUNCTION:    AcpiPsParseAml
    516  1.1  jruoho  *
    517  1.1  jruoho  * PARAMETERS:  WalkState       - Current state
    518  1.1  jruoho  *
    519  1.1  jruoho  *
    520  1.1  jruoho  * RETURN:      Status
    521  1.1  jruoho  *
    522  1.1  jruoho  * DESCRIPTION: Parse raw AML and return a tree of ops
    523  1.1  jruoho  *
    524  1.1  jruoho  ******************************************************************************/
    525  1.1  jruoho 
    526  1.1  jruoho ACPI_STATUS
    527  1.1  jruoho AcpiPsParseAml (
    528  1.1  jruoho     ACPI_WALK_STATE         *WalkState)
    529  1.1  jruoho {
    530  1.1  jruoho     ACPI_STATUS             Status;
    531  1.1  jruoho     ACPI_THREAD_STATE       *Thread;
    532  1.1  jruoho     ACPI_THREAD_STATE       *PrevWalkList = AcpiGbl_CurrentWalkList;
    533  1.1  jruoho     ACPI_WALK_STATE         *PreviousWalkState;
    534  1.1  jruoho 
    535  1.1  jruoho 
    536  1.1  jruoho     ACPI_FUNCTION_TRACE (PsParseAml);
    537  1.1  jruoho 
    538  1.1  jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    539  1.1  jruoho         "Entered with WalkState=%p Aml=%p size=%X\n",
    540  1.1  jruoho         WalkState, WalkState->ParserState.Aml,
    541  1.1  jruoho         WalkState->ParserState.AmlSize));
    542  1.1  jruoho 
    543  1.1  jruoho     if (!WalkState->ParserState.Aml)
    544  1.1  jruoho     {
    545  1.1  jruoho         return_ACPI_STATUS (AE_NULL_OBJECT);
    546  1.1  jruoho     }
    547  1.1  jruoho 
    548  1.1  jruoho     /* Create and initialize a new thread state */
    549  1.1  jruoho 
    550  1.1  jruoho     Thread = AcpiUtCreateThreadState ();
    551  1.1  jruoho     if (!Thread)
    552  1.1  jruoho     {
    553  1.1  jruoho         if (WalkState->MethodDesc)
    554  1.1  jruoho         {
    555  1.1  jruoho             /* Executing a control method - additional cleanup */
    556  1.1  jruoho 
    557  1.1  jruoho             AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
    558  1.1  jruoho         }
    559  1.1  jruoho 
    560  1.1  jruoho         AcpiDsDeleteWalkState (WalkState);
    561  1.1  jruoho         return_ACPI_STATUS (AE_NO_MEMORY);
    562  1.1  jruoho     }
    563  1.1  jruoho 
    564  1.1  jruoho     WalkState->Thread = Thread;
    565  1.1  jruoho 
    566  1.1  jruoho     /*
    567  1.1  jruoho      * If executing a method, the starting SyncLevel is this method's
    568  1.1  jruoho      * SyncLevel
    569  1.1  jruoho      */
    570  1.1  jruoho     if (WalkState->MethodDesc)
    571  1.1  jruoho     {
    572  1.1  jruoho         WalkState->Thread->CurrentSyncLevel = WalkState->MethodDesc->Method.SyncLevel;
    573  1.1  jruoho     }
    574  1.1  jruoho 
    575  1.1  jruoho     AcpiDsPushWalkState (WalkState, Thread);
    576  1.1  jruoho 
    577  1.1  jruoho     /*
    578  1.1  jruoho      * This global allows the AML debugger to get a handle to the currently
    579  1.1  jruoho      * executing control method.
    580  1.1  jruoho      */
    581  1.1  jruoho     AcpiGbl_CurrentWalkList = Thread;
    582  1.1  jruoho 
    583  1.1  jruoho     /*
    584  1.1  jruoho      * Execute the walk loop as long as there is a valid Walk State.  This
    585  1.1  jruoho      * handles nested control method invocations without recursion.
    586  1.1  jruoho      */
    587  1.1  jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "State=%p\n", WalkState));
    588  1.1  jruoho 
    589  1.1  jruoho     Status = AE_OK;
    590  1.1  jruoho     while (WalkState)
    591  1.1  jruoho     {
    592  1.1  jruoho         if (ACPI_SUCCESS (Status))
    593  1.1  jruoho         {
    594  1.1  jruoho             /*
    595  1.1  jruoho              * The ParseLoop executes AML until the method terminates
    596  1.1  jruoho              * or calls another method.
    597  1.1  jruoho              */
    598  1.1  jruoho             Status = AcpiPsParseLoop (WalkState);
    599  1.1  jruoho         }
    600  1.1  jruoho 
    601  1.1  jruoho         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    602  1.1  jruoho             "Completed one call to walk loop, %s State=%p\n",
    603  1.1  jruoho             AcpiFormatException (Status), WalkState));
    604  1.1  jruoho 
    605  1.1  jruoho         if (Status == AE_CTRL_TRANSFER)
    606  1.1  jruoho         {
    607  1.1  jruoho             /*
    608  1.1  jruoho              * A method call was detected.
    609  1.1  jruoho              * Transfer control to the called control method
    610  1.1  jruoho              */
    611  1.1  jruoho             Status = AcpiDsCallControlMethod (Thread, WalkState, NULL);
    612  1.1  jruoho             if (ACPI_FAILURE (Status))
    613  1.1  jruoho             {
    614  1.1  jruoho                 Status = AcpiDsMethodError (Status, WalkState);
    615  1.1  jruoho             }
    616  1.1  jruoho 
    617  1.1  jruoho             /*
    618  1.1  jruoho              * If the transfer to the new method method call worked, a new walk
    619  1.1  jruoho              * state was created -- get it
    620  1.1  jruoho              */
    621  1.1  jruoho             WalkState = AcpiDsGetCurrentWalkState (Thread);
    622  1.1  jruoho             continue;
    623  1.1  jruoho         }
    624  1.1  jruoho         else if (Status == AE_CTRL_TERMINATE)
    625  1.1  jruoho         {
    626  1.1  jruoho             Status = AE_OK;
    627  1.1  jruoho         }
    628  1.1  jruoho         else if ((Status != AE_OK) && (WalkState->MethodDesc))
    629  1.1  jruoho         {
    630  1.1  jruoho             /* Either the method parse or actual execution failed */
    631  1.1  jruoho 
    632  1.1  jruoho             ACPI_ERROR_METHOD ("Method parse/execution failed",
    633  1.1  jruoho                 WalkState->MethodNode, NULL, Status);
    634  1.1  jruoho 
    635  1.1  jruoho             /* Check for possible multi-thread reentrancy problem */
    636  1.1  jruoho 
    637  1.1  jruoho             if ((Status == AE_ALREADY_EXISTS) &&
    638  1.1  jruoho                 (!WalkState->MethodDesc->Method.Mutex))
    639  1.1  jruoho             {
    640  1.1  jruoho                 ACPI_INFO ((AE_INFO,
    641  1.1  jruoho                     "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
    642  1.1  jruoho                     WalkState->MethodNode->Name.Ascii));
    643  1.1  jruoho 
    644  1.1  jruoho                 /*
    645  1.1  jruoho                  * Method tried to create an object twice. The probable cause is
    646  1.1  jruoho                  * that the method cannot handle reentrancy.
    647  1.1  jruoho                  *
    648  1.1  jruoho                  * The method is marked NotSerialized, but it tried to create
    649  1.1  jruoho                  * a named object, causing the second thread entrance to fail.
    650  1.1  jruoho                  * Workaround this problem by marking the method permanently
    651  1.1  jruoho                  * as Serialized.
    652  1.1  jruoho                  */
    653  1.1  jruoho                 WalkState->MethodDesc->Method.MethodFlags |= AML_METHOD_SERIALIZED;
    654  1.1  jruoho                 WalkState->MethodDesc->Method.SyncLevel = 0;
    655  1.1  jruoho             }
    656  1.1  jruoho         }
    657  1.1  jruoho 
    658  1.1  jruoho         /* We are done with this walk, move on to the parent if any */
    659  1.1  jruoho 
    660  1.1  jruoho         WalkState = AcpiDsPopWalkState (Thread);
    661  1.1  jruoho 
    662  1.1  jruoho         /* Reset the current scope to the beginning of scope stack */
    663  1.1  jruoho 
    664  1.1  jruoho         AcpiDsScopeStackClear (WalkState);
    665  1.1  jruoho 
    666  1.1  jruoho         /*
    667  1.1  jruoho          * If we just returned from the execution of a control method or if we
    668  1.1  jruoho          * encountered an error during the method parse phase, there's lots of
    669  1.1  jruoho          * cleanup to do
    670  1.1  jruoho          */
    671  1.1  jruoho         if (((WalkState->ParseFlags & ACPI_PARSE_MODE_MASK) == ACPI_PARSE_EXECUTE) ||
    672  1.1  jruoho             (ACPI_FAILURE (Status)))
    673  1.1  jruoho         {
    674  1.1  jruoho             AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
    675  1.1  jruoho         }
    676  1.1  jruoho 
    677  1.1  jruoho         /* Delete this walk state and all linked control states */
    678  1.1  jruoho 
    679  1.1  jruoho         AcpiPsCleanupScope (&WalkState->ParserState);
    680  1.1  jruoho         PreviousWalkState = WalkState;
    681  1.1  jruoho 
    682  1.1  jruoho         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    683  1.1  jruoho             "ReturnValue=%p, ImplicitValue=%p State=%p\n",
    684  1.1  jruoho             WalkState->ReturnDesc, WalkState->ImplicitReturnObj, WalkState));
    685  1.1  jruoho 
    686  1.1  jruoho         /* Check if we have restarted a preempted walk */
    687  1.1  jruoho 
    688  1.1  jruoho         WalkState = AcpiDsGetCurrentWalkState (Thread);
    689  1.1  jruoho         if (WalkState)
    690  1.1  jruoho         {
    691  1.1  jruoho             if (ACPI_SUCCESS (Status))
    692  1.1  jruoho             {
    693  1.1  jruoho                 /*
    694  1.1  jruoho                  * There is another walk state, restart it.
    695  1.1  jruoho                  * If the method return value is not used by the parent,
    696  1.1  jruoho                  * The object is deleted
    697  1.1  jruoho                  */
    698  1.1  jruoho                 if (!PreviousWalkState->ReturnDesc)
    699  1.1  jruoho                 {
    700  1.1  jruoho                     /*
    701  1.1  jruoho                      * In slack mode execution, if there is no return value
    702  1.1  jruoho                      * we should implicitly return zero (0) as a default value.
    703  1.1  jruoho                      */
    704  1.1  jruoho                     if (AcpiGbl_EnableInterpreterSlack &&
    705  1.1  jruoho                         !PreviousWalkState->ImplicitReturnObj)
    706  1.1  jruoho                     {
    707  1.1  jruoho                         PreviousWalkState->ImplicitReturnObj =
    708  1.1  jruoho                             AcpiUtCreateIntegerObject ((UINT64) 0);
    709  1.1  jruoho                         if (!PreviousWalkState->ImplicitReturnObj)
    710  1.1  jruoho                         {
    711  1.1  jruoho                             return_ACPI_STATUS (AE_NO_MEMORY);
    712  1.1  jruoho                         }
    713  1.1  jruoho                     }
    714  1.1  jruoho 
    715  1.1  jruoho                     /* Restart the calling control method */
    716  1.1  jruoho 
    717  1.1  jruoho                     Status = AcpiDsRestartControlMethod (WalkState,
    718  1.1  jruoho                                 PreviousWalkState->ImplicitReturnObj);
    719  1.1  jruoho                 }
    720  1.1  jruoho                 else
    721  1.1  jruoho                 {
    722  1.1  jruoho                     /*
    723  1.1  jruoho                      * We have a valid return value, delete any implicit
    724  1.1  jruoho                      * return value.
    725  1.1  jruoho                      */
    726  1.1  jruoho                     AcpiDsClearImplicitReturn (PreviousWalkState);
    727  1.1  jruoho 
    728  1.1  jruoho                     Status = AcpiDsRestartControlMethod (WalkState,
    729  1.1  jruoho                                 PreviousWalkState->ReturnDesc);
    730  1.1  jruoho                 }
    731  1.1  jruoho                 if (ACPI_SUCCESS (Status))
    732  1.1  jruoho                 {
    733  1.1  jruoho                     WalkState->WalkType |= ACPI_WALK_METHOD_RESTART;
    734  1.1  jruoho                 }
    735  1.1  jruoho             }
    736  1.1  jruoho             else
    737  1.1  jruoho             {
    738  1.1  jruoho                 /* On error, delete any return object or implicit return */
    739  1.1  jruoho 
    740  1.1  jruoho                 AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
    741  1.1  jruoho                 AcpiDsClearImplicitReturn (PreviousWalkState);
    742  1.1  jruoho             }
    743  1.1  jruoho         }
    744  1.1  jruoho 
    745  1.1  jruoho         /*
    746  1.1  jruoho          * Just completed a 1st-level method, save the final internal return
    747  1.1  jruoho          * value (if any)
    748  1.1  jruoho          */
    749  1.1  jruoho         else if (PreviousWalkState->CallerReturnDesc)
    750  1.1  jruoho         {
    751  1.1  jruoho             if (PreviousWalkState->ImplicitReturnObj)
    752  1.1  jruoho             {
    753  1.1  jruoho                 *(PreviousWalkState->CallerReturnDesc) =
    754  1.1  jruoho                     PreviousWalkState->ImplicitReturnObj;
    755  1.1  jruoho             }
    756  1.1  jruoho             else
    757  1.1  jruoho             {
    758  1.1  jruoho                  /* NULL if no return value */
    759  1.1  jruoho 
    760  1.1  jruoho                 *(PreviousWalkState->CallerReturnDesc) =
    761  1.1  jruoho                     PreviousWalkState->ReturnDesc;
    762  1.1  jruoho             }
    763  1.1  jruoho         }
    764  1.1  jruoho         else
    765  1.1  jruoho         {
    766  1.1  jruoho             if (PreviousWalkState->ReturnDesc)
    767  1.1  jruoho             {
    768  1.1  jruoho                 /* Caller doesn't want it, must delete it */
    769  1.1  jruoho 
    770  1.1  jruoho                 AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
    771  1.1  jruoho             }
    772  1.1  jruoho             if (PreviousWalkState->ImplicitReturnObj)
    773  1.1  jruoho             {
    774  1.1  jruoho                 /* Caller doesn't want it, must delete it */
    775  1.1  jruoho 
    776  1.1  jruoho                 AcpiUtRemoveReference (PreviousWalkState->ImplicitReturnObj);
    777  1.1  jruoho             }
    778  1.1  jruoho         }
    779  1.1  jruoho 
    780  1.1  jruoho         AcpiDsDeleteWalkState (PreviousWalkState);
    781  1.1  jruoho     }
    782  1.1  jruoho 
    783  1.1  jruoho     /* Normal exit */
    784  1.1  jruoho 
    785  1.1  jruoho     AcpiExReleaseAllMutexes (Thread);
    786  1.1  jruoho     AcpiUtDeleteGenericState (ACPI_CAST_PTR (ACPI_GENERIC_STATE, Thread));
    787  1.1  jruoho     AcpiGbl_CurrentWalkList = PrevWalkList;
    788  1.1  jruoho     return_ACPI_STATUS (Status);
    789  1.1  jruoho }
    790  1.1  jruoho 
    791  1.1  jruoho 
    792