Home | History | Annotate | Line # | Download | only in parser
psloop.c revision 1.1.1.13
      1       1.1    jruoho /******************************************************************************
      2       1.1    jruoho  *
      3       1.1    jruoho  * Module Name: psloop - Main AML parse loop
      4       1.1    jruoho  *
      5       1.1    jruoho  *****************************************************************************/
      6       1.1    jruoho 
      7   1.1.1.2    jruoho /*
      8  1.1.1.11  christos  * Copyright (C) 2000 - 2018, Intel Corp.
      9       1.1    jruoho  * All rights reserved.
     10       1.1    jruoho  *
     11   1.1.1.2    jruoho  * Redistribution and use in source and binary forms, with or without
     12   1.1.1.2    jruoho  * modification, are permitted provided that the following conditions
     13   1.1.1.2    jruoho  * are met:
     14   1.1.1.2    jruoho  * 1. Redistributions of source code must retain the above copyright
     15   1.1.1.2    jruoho  *    notice, this list of conditions, and the following disclaimer,
     16   1.1.1.2    jruoho  *    without modification.
     17   1.1.1.2    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18   1.1.1.2    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     19   1.1.1.2    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     20   1.1.1.2    jruoho  *    including a substantially similar Disclaimer requirement for further
     21   1.1.1.2    jruoho  *    binary redistribution.
     22   1.1.1.2    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     23   1.1.1.2    jruoho  *    of any contributors may be used to endorse or promote products derived
     24   1.1.1.2    jruoho  *    from this software without specific prior written permission.
     25   1.1.1.2    jruoho  *
     26   1.1.1.2    jruoho  * Alternatively, this software may be distributed under the terms of the
     27   1.1.1.2    jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     28   1.1.1.2    jruoho  * Software Foundation.
     29   1.1.1.2    jruoho  *
     30   1.1.1.2    jruoho  * NO WARRANTY
     31   1.1.1.2    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32   1.1.1.2    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33   1.1.1.2    jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34   1.1.1.2    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35   1.1.1.2    jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36   1.1.1.2    jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37   1.1.1.2    jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38   1.1.1.2    jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39   1.1.1.2    jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40   1.1.1.2    jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41   1.1.1.2    jruoho  * POSSIBILITY OF SUCH DAMAGES.
     42   1.1.1.2    jruoho  */
     43       1.1    jruoho 
     44       1.1    jruoho /*
     45       1.1    jruoho  * Parse the AML and build an operation tree as most interpreters, (such as
     46       1.1    jruoho  * Perl) do. Parsing is done by hand rather than with a YACC generated parser
     47       1.1    jruoho  * to tightly constrain stack and dynamic memory usage. Parsing is kept
     48       1.1    jruoho  * flexible and the code fairly compact by parsing based on a list of AML
     49       1.1    jruoho  * opcode templates in AmlOpInfo[].
     50       1.1    jruoho  */
     51       1.1    jruoho 
     52       1.1    jruoho #include "acpi.h"
     53       1.1    jruoho #include "accommon.h"
     54   1.1.1.6  christos #include "acinterp.h"
     55       1.1    jruoho #include "acparser.h"
     56       1.1    jruoho #include "acdispat.h"
     57       1.1    jruoho #include "amlcode.h"
     58   1.1.1.9  christos #include "acconvert.h"
     59  1.1.1.12  christos #include "acnamesp.h"
     60       1.1    jruoho 
     61       1.1    jruoho #define _COMPONENT          ACPI_PARSER
     62       1.1    jruoho         ACPI_MODULE_NAME    ("psloop")
     63       1.1    jruoho 
     64       1.1    jruoho 
     65       1.1    jruoho /* Local prototypes */
     66       1.1    jruoho 
     67       1.1    jruoho static ACPI_STATUS
     68       1.1    jruoho AcpiPsGetArguments (
     69       1.1    jruoho     ACPI_WALK_STATE         *WalkState,
     70       1.1    jruoho     UINT8                   *AmlOpStart,
     71       1.1    jruoho     ACPI_PARSE_OBJECT       *Op);
     72       1.1    jruoho 
     73       1.1    jruoho static void
     74       1.1    jruoho AcpiPsLinkModuleCode (
     75       1.1    jruoho     ACPI_PARSE_OBJECT       *ParentOp,
     76       1.1    jruoho     UINT8                   *AmlStart,
     77       1.1    jruoho     UINT32                  AmlLength,
     78       1.1    jruoho     ACPI_OWNER_ID           OwnerId);
     79       1.1    jruoho 
     80       1.1    jruoho 
     81       1.1    jruoho /*******************************************************************************
     82       1.1    jruoho  *
     83       1.1    jruoho  * FUNCTION:    AcpiPsGetArguments
     84       1.1    jruoho  *
     85       1.1    jruoho  * PARAMETERS:  WalkState           - Current state
     86       1.1    jruoho  *              AmlOpStart          - Op start in AML
     87       1.1    jruoho  *              Op                  - Current Op
     88       1.1    jruoho  *
     89       1.1    jruoho  * RETURN:      Status
     90       1.1    jruoho  *
     91       1.1    jruoho  * DESCRIPTION: Get arguments for passed Op.
     92       1.1    jruoho  *
     93       1.1    jruoho  ******************************************************************************/
     94       1.1    jruoho 
     95       1.1    jruoho static ACPI_STATUS
     96       1.1    jruoho AcpiPsGetArguments (
     97       1.1    jruoho     ACPI_WALK_STATE         *WalkState,
     98       1.1    jruoho     UINT8                   *AmlOpStart,
     99       1.1    jruoho     ACPI_PARSE_OBJECT       *Op)
    100       1.1    jruoho {
    101       1.1    jruoho     ACPI_STATUS             Status = AE_OK;
    102       1.1    jruoho     ACPI_PARSE_OBJECT       *Arg = NULL;
    103       1.1    jruoho     const ACPI_OPCODE_INFO  *OpInfo;
    104       1.1    jruoho 
    105       1.1    jruoho 
    106       1.1    jruoho     ACPI_FUNCTION_TRACE_PTR (PsGetArguments, WalkState);
    107       1.1    jruoho 
    108       1.1    jruoho 
    109   1.1.1.8  christos     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    110   1.1.1.8  christos         "Get arguments for opcode [%s]\n", Op->Common.AmlOpName));
    111   1.1.1.8  christos 
    112       1.1    jruoho     switch (Op->Common.AmlOpcode)
    113       1.1    jruoho     {
    114       1.1    jruoho     case AML_BYTE_OP:       /* AML_BYTEDATA_ARG */
    115       1.1    jruoho     case AML_WORD_OP:       /* AML_WORDDATA_ARG */
    116       1.1    jruoho     case AML_DWORD_OP:      /* AML_DWORDATA_ARG */
    117       1.1    jruoho     case AML_QWORD_OP:      /* AML_QWORDATA_ARG */
    118       1.1    jruoho     case AML_STRING_OP:     /* AML_ASCIICHARLIST_ARG */
    119       1.1    jruoho 
    120       1.1    jruoho         /* Fill in constant or string argument directly */
    121       1.1    jruoho 
    122       1.1    jruoho         AcpiPsGetNextSimpleArg (&(WalkState->ParserState),
    123       1.1    jruoho             GET_CURRENT_ARG_TYPE (WalkState->ArgTypes), Op);
    124       1.1    jruoho         break;
    125       1.1    jruoho 
    126       1.1    jruoho     case AML_INT_NAMEPATH_OP:   /* AML_NAMESTRING_ARG */
    127       1.1    jruoho 
    128   1.1.1.7  christos         Status = AcpiPsGetNextNamepath (WalkState,
    129   1.1.1.7  christos             &(WalkState->ParserState), Op, ACPI_POSSIBLE_METHOD_CALL);
    130       1.1    jruoho         if (ACPI_FAILURE (Status))
    131       1.1    jruoho         {
    132       1.1    jruoho             return_ACPI_STATUS (Status);
    133       1.1    jruoho         }
    134       1.1    jruoho 
    135       1.1    jruoho         WalkState->ArgTypes = 0;
    136       1.1    jruoho         break;
    137       1.1    jruoho 
    138       1.1    jruoho     default:
    139       1.1    jruoho         /*
    140       1.1    jruoho          * Op is not a constant or string, append each argument to the Op
    141       1.1    jruoho          */
    142   1.1.1.7  christos         while (GET_CURRENT_ARG_TYPE (WalkState->ArgTypes) &&
    143   1.1.1.7  christos             !WalkState->ArgCount)
    144       1.1    jruoho         {
    145   1.1.1.6  christos             WalkState->Aml = WalkState->ParserState.Aml;
    146       1.1    jruoho 
    147   1.1.1.9  christos             switch (Op->Common.AmlOpcode)
    148   1.1.1.9  christos             {
    149   1.1.1.9  christos             case AML_METHOD_OP:
    150   1.1.1.9  christos             case AML_BUFFER_OP:
    151   1.1.1.9  christos             case AML_PACKAGE_OP:
    152   1.1.1.9  christos             case AML_VARIABLE_PACKAGE_OP:
    153   1.1.1.9  christos             case AML_WHILE_OP:
    154   1.1.1.9  christos 
    155   1.1.1.9  christos                 break;
    156   1.1.1.9  christos 
    157   1.1.1.9  christos             default:
    158   1.1.1.9  christos 
    159   1.1.1.9  christos                 ASL_CV_CAPTURE_COMMENTS (WalkState);
    160   1.1.1.9  christos                 break;
    161   1.1.1.9  christos             }
    162   1.1.1.9  christos 
    163       1.1    jruoho             Status = AcpiPsGetNextArg (WalkState, &(WalkState->ParserState),
    164   1.1.1.7  christos                 GET_CURRENT_ARG_TYPE (WalkState->ArgTypes), &Arg);
    165       1.1    jruoho             if (ACPI_FAILURE (Status))
    166       1.1    jruoho             {
    167       1.1    jruoho                 return_ACPI_STATUS (Status);
    168       1.1    jruoho             }
    169       1.1    jruoho 
    170       1.1    jruoho             if (Arg)
    171       1.1    jruoho             {
    172       1.1    jruoho                 AcpiPsAppendArg (Op, Arg);
    173       1.1    jruoho             }
    174       1.1    jruoho 
    175       1.1    jruoho             INCREMENT_ARG_LIST (WalkState->ArgTypes);
    176       1.1    jruoho         }
    177       1.1    jruoho 
    178  1.1.1.10  christos         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    179  1.1.1.11  christos             "Final argument count: %8.8X pass %u\n",
    180  1.1.1.10  christos             WalkState->ArgCount, WalkState->PassNumber));
    181       1.1    jruoho 
    182       1.1    jruoho         /*
    183  1.1.1.11  christos          * This case handles the legacy option that groups all module-level
    184  1.1.1.11  christos          * code blocks together and defers execution until all of the tables
    185  1.1.1.11  christos          * are loaded. Execute all of these blocks at this time.
    186  1.1.1.11  christos          * Execute any module-level code that was detected during the table
    187  1.1.1.11  christos          * load phase.
    188  1.1.1.11  christos          *
    189  1.1.1.11  christos          * Note: this option is deprecated and will be eliminated in the
    190  1.1.1.11  christos          * future. Use of this option can cause problems with AML code that
    191  1.1.1.11  christos          * depends upon in-order immediate execution of module-level code.
    192       1.1    jruoho          */
    193  1.1.1.13  christos         if (!AcpiGbl_ExecuteTablesAsMethods &&
    194  1.1.1.11  christos             (WalkState->PassNumber <= ACPI_IMODE_LOAD_PASS2) &&
    195       1.1    jruoho             ((WalkState->ParseFlags & ACPI_PARSE_DISASSEMBLE) == 0))
    196       1.1    jruoho         {
    197       1.1    jruoho             /*
    198       1.1    jruoho              * We want to skip If/Else/While constructs during Pass1 because we
    199       1.1    jruoho              * want to actually conditionally execute the code during Pass2.
    200       1.1    jruoho              *
    201       1.1    jruoho              * Except for disassembly, where we always want to walk the
    202       1.1    jruoho              * If/Else/While packages
    203       1.1    jruoho              */
    204       1.1    jruoho             switch (Op->Common.AmlOpcode)
    205       1.1    jruoho             {
    206       1.1    jruoho             case AML_IF_OP:
    207       1.1    jruoho             case AML_ELSE_OP:
    208       1.1    jruoho             case AML_WHILE_OP:
    209       1.1    jruoho                 /*
    210       1.1    jruoho                  * Currently supported module-level opcodes are:
    211       1.1    jruoho                  * IF/ELSE/WHILE. These appear to be the most common,
    212       1.1    jruoho                  * and easiest to support since they open an AML
    213       1.1    jruoho                  * package.
    214       1.1    jruoho                  */
    215       1.1    jruoho                 if (WalkState->PassNumber == ACPI_IMODE_LOAD_PASS1)
    216       1.1    jruoho                 {
    217       1.1    jruoho                     AcpiPsLinkModuleCode (Op->Common.Parent, AmlOpStart,
    218       1.1    jruoho                         (UINT32) (WalkState->ParserState.PkgEnd - AmlOpStart),
    219       1.1    jruoho                         WalkState->OwnerId);
    220       1.1    jruoho                 }
    221       1.1    jruoho 
    222       1.1    jruoho                 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    223       1.1    jruoho                     "Pass1: Skipping an If/Else/While body\n"));
    224       1.1    jruoho 
    225       1.1    jruoho                 /* Skip body of if/else/while in pass 1 */
    226       1.1    jruoho 
    227       1.1    jruoho                 WalkState->ParserState.Aml = WalkState->ParserState.PkgEnd;
    228       1.1    jruoho                 WalkState->ArgCount = 0;
    229       1.1    jruoho                 break;
    230       1.1    jruoho 
    231       1.1    jruoho             default:
    232       1.1    jruoho                 /*
    233       1.1    jruoho                  * Check for an unsupported executable opcode at module
    234       1.1    jruoho                  * level. We must be in PASS1, the parent must be a SCOPE,
    235       1.1    jruoho                  * The opcode class must be EXECUTE, and the opcode must
    236       1.1    jruoho                  * not be an argument to another opcode.
    237       1.1    jruoho                  */
    238       1.1    jruoho                 if ((WalkState->PassNumber == ACPI_IMODE_LOAD_PASS1) &&
    239       1.1    jruoho                     (Op->Common.Parent->Common.AmlOpcode == AML_SCOPE_OP))
    240       1.1    jruoho                 {
    241       1.1    jruoho                     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
    242       1.1    jruoho                     if ((OpInfo->Class == AML_CLASS_EXECUTE) &&
    243       1.1    jruoho                         (!Arg))
    244       1.1    jruoho                     {
    245       1.1    jruoho                         ACPI_WARNING ((AE_INFO,
    246   1.1.1.3  christos                             "Unsupported module-level executable opcode "
    247   1.1.1.3  christos                             "0x%.2X at table offset 0x%.4X",
    248       1.1    jruoho                             Op->Common.AmlOpcode,
    249       1.1    jruoho                             (UINT32) (ACPI_PTR_DIFF (AmlOpStart,
    250       1.1    jruoho                                 WalkState->ParserState.AmlStart) +
    251       1.1    jruoho                                 sizeof (ACPI_TABLE_HEADER))));
    252       1.1    jruoho                     }
    253       1.1    jruoho                 }
    254       1.1    jruoho                 break;
    255       1.1    jruoho             }
    256       1.1    jruoho         }
    257       1.1    jruoho 
    258       1.1    jruoho         /* Special processing for certain opcodes */
    259       1.1    jruoho 
    260       1.1    jruoho         switch (Op->Common.AmlOpcode)
    261       1.1    jruoho         {
    262       1.1    jruoho         case AML_METHOD_OP:
    263       1.1    jruoho             /*
    264       1.1    jruoho              * Skip parsing of control method because we don't have enough
    265       1.1    jruoho              * info in the first pass to parse it correctly.
    266       1.1    jruoho              *
    267       1.1    jruoho              * Save the length and address of the body
    268       1.1    jruoho              */
    269       1.1    jruoho             Op->Named.Data = WalkState->ParserState.Aml;
    270       1.1    jruoho             Op->Named.Length = (UINT32)
    271       1.1    jruoho                 (WalkState->ParserState.PkgEnd - WalkState->ParserState.Aml);
    272       1.1    jruoho 
    273       1.1    jruoho             /* Skip body of method */
    274       1.1    jruoho 
    275       1.1    jruoho             WalkState->ParserState.Aml = WalkState->ParserState.PkgEnd;
    276       1.1    jruoho             WalkState->ArgCount = 0;
    277       1.1    jruoho             break;
    278       1.1    jruoho 
    279       1.1    jruoho         case AML_BUFFER_OP:
    280       1.1    jruoho         case AML_PACKAGE_OP:
    281   1.1.1.9  christos         case AML_VARIABLE_PACKAGE_OP:
    282       1.1    jruoho 
    283       1.1    jruoho             if ((Op->Common.Parent) &&
    284       1.1    jruoho                 (Op->Common.Parent->Common.AmlOpcode == AML_NAME_OP) &&
    285       1.1    jruoho                 (WalkState->PassNumber <= ACPI_IMODE_LOAD_PASS2))
    286       1.1    jruoho             {
    287  1.1.1.10  christos                 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    288  1.1.1.10  christos                     "Setup Package/Buffer: Pass %u, AML Ptr: %p\n",
    289  1.1.1.10  christos                     WalkState->PassNumber, AmlOpStart));
    290  1.1.1.10  christos 
    291       1.1    jruoho                 /*
    292       1.1    jruoho                  * Skip parsing of Buffers and Packages because we don't have
    293       1.1    jruoho                  * enough info in the first pass to parse them correctly.
    294       1.1    jruoho                  */
    295       1.1    jruoho                 Op->Named.Data = AmlOpStart;
    296       1.1    jruoho                 Op->Named.Length = (UINT32)
    297       1.1    jruoho                     (WalkState->ParserState.PkgEnd - AmlOpStart);
    298       1.1    jruoho 
    299       1.1    jruoho                 /* Skip body */
    300       1.1    jruoho 
    301       1.1    jruoho                 WalkState->ParserState.Aml = WalkState->ParserState.PkgEnd;
    302       1.1    jruoho                 WalkState->ArgCount = 0;
    303       1.1    jruoho             }
    304       1.1    jruoho             break;
    305       1.1    jruoho 
    306       1.1    jruoho         case AML_WHILE_OP:
    307       1.1    jruoho 
    308       1.1    jruoho             if (WalkState->ControlState)
    309       1.1    jruoho             {
    310       1.1    jruoho                 WalkState->ControlState->Control.PackageEnd =
    311       1.1    jruoho                     WalkState->ParserState.PkgEnd;
    312       1.1    jruoho             }
    313       1.1    jruoho             break;
    314       1.1    jruoho 
    315       1.1    jruoho         default:
    316       1.1    jruoho 
    317       1.1    jruoho             /* No action for all other opcodes */
    318   1.1.1.3  christos 
    319       1.1    jruoho             break;
    320       1.1    jruoho         }
    321       1.1    jruoho 
    322       1.1    jruoho         break;
    323       1.1    jruoho     }
    324       1.1    jruoho 
    325       1.1    jruoho     return_ACPI_STATUS (AE_OK);
    326       1.1    jruoho }
    327       1.1    jruoho 
    328       1.1    jruoho 
    329       1.1    jruoho /*******************************************************************************
    330       1.1    jruoho  *
    331       1.1    jruoho  * FUNCTION:    AcpiPsLinkModuleCode
    332       1.1    jruoho  *
    333       1.1    jruoho  * PARAMETERS:  ParentOp            - Parent parser op
    334       1.1    jruoho  *              AmlStart            - Pointer to the AML
    335       1.1    jruoho  *              AmlLength           - Length of executable AML
    336       1.1    jruoho  *              OwnerId             - OwnerId of module level code
    337       1.1    jruoho  *
    338       1.1    jruoho  * RETURN:      None.
    339       1.1    jruoho  *
    340       1.1    jruoho  * DESCRIPTION: Wrap the module-level code with a method object and link the
    341       1.1    jruoho  *              object to the global list. Note, the mutex field of the method
    342       1.1    jruoho  *              object is used to link multiple module-level code objects.
    343       1.1    jruoho  *
    344  1.1.1.11  christos  * NOTE: In this legacy option, each block of detected executable AML
    345  1.1.1.11  christos  * code that is outside of any control method is wrapped with a temporary
    346  1.1.1.11  christos  * control method object and placed on a global list below.
    347  1.1.1.11  christos  *
    348  1.1.1.11  christos  * This function executes the module-level code for all tables only after
    349  1.1.1.11  christos  * all of the tables have been loaded. It is a legacy option and is
    350  1.1.1.11  christos  * not compatible with other ACPI implementations. See AcpiNsLoadTable.
    351  1.1.1.11  christos  *
    352  1.1.1.11  christos  * This function will be removed when the legacy option is removed.
    353  1.1.1.11  christos  *
    354       1.1    jruoho  ******************************************************************************/
    355       1.1    jruoho 
    356       1.1    jruoho static void
    357       1.1    jruoho AcpiPsLinkModuleCode (
    358       1.1    jruoho     ACPI_PARSE_OBJECT       *ParentOp,
    359       1.1    jruoho     UINT8                   *AmlStart,
    360       1.1    jruoho     UINT32                  AmlLength,
    361       1.1    jruoho     ACPI_OWNER_ID           OwnerId)
    362       1.1    jruoho {
    363       1.1    jruoho     ACPI_OPERAND_OBJECT     *Prev;
    364       1.1    jruoho     ACPI_OPERAND_OBJECT     *Next;
    365       1.1    jruoho     ACPI_OPERAND_OBJECT     *MethodObj;
    366       1.1    jruoho     ACPI_NAMESPACE_NODE     *ParentNode;
    367       1.1    jruoho 
    368       1.1    jruoho 
    369   1.1.1.7  christos     ACPI_FUNCTION_TRACE (PsLinkModuleCode);
    370   1.1.1.7  christos 
    371   1.1.1.7  christos 
    372       1.1    jruoho     /* Get the tail of the list */
    373       1.1    jruoho 
    374       1.1    jruoho     Prev = Next = AcpiGbl_ModuleCodeList;
    375       1.1    jruoho     while (Next)
    376       1.1    jruoho     {
    377       1.1    jruoho         Prev = Next;
    378       1.1    jruoho         Next = Next->Method.Mutex;
    379       1.1    jruoho     }
    380       1.1    jruoho 
    381       1.1    jruoho     /*
    382       1.1    jruoho      * Insert the module level code into the list. Merge it if it is
    383       1.1    jruoho      * adjacent to the previous element.
    384       1.1    jruoho      */
    385       1.1    jruoho     if (!Prev ||
    386       1.1    jruoho        ((Prev->Method.AmlStart + Prev->Method.AmlLength) != AmlStart))
    387       1.1    jruoho     {
    388       1.1    jruoho         /* Create, initialize, and link a new temporary method object */
    389       1.1    jruoho 
    390       1.1    jruoho         MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
    391       1.1    jruoho         if (!MethodObj)
    392       1.1    jruoho         {
    393   1.1.1.7  christos             return_VOID;
    394       1.1    jruoho         }
    395       1.1    jruoho 
    396   1.1.1.7  christos         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    397   1.1.1.7  christos             "Create/Link new code block: %p\n", MethodObj));
    398   1.1.1.7  christos 
    399       1.1    jruoho         if (ParentOp->Common.Node)
    400       1.1    jruoho         {
    401       1.1    jruoho             ParentNode = ParentOp->Common.Node;
    402       1.1    jruoho         }
    403       1.1    jruoho         else
    404       1.1    jruoho         {
    405       1.1    jruoho             ParentNode = AcpiGbl_RootNode;
    406       1.1    jruoho         }
    407       1.1    jruoho 
    408       1.1    jruoho         MethodObj->Method.AmlStart = AmlStart;
    409       1.1    jruoho         MethodObj->Method.AmlLength = AmlLength;
    410       1.1    jruoho         MethodObj->Method.OwnerId = OwnerId;
    411   1.1.1.2    jruoho         MethodObj->Method.InfoFlags |= ACPI_METHOD_MODULE_LEVEL;
    412       1.1    jruoho 
    413       1.1    jruoho         /*
    414       1.1    jruoho          * Save the parent node in NextObject. This is cheating, but we
    415       1.1    jruoho          * don't want to expand the method object.
    416       1.1    jruoho          */
    417       1.1    jruoho         MethodObj->Method.NextObject =
    418       1.1    jruoho             ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, ParentNode);
    419       1.1    jruoho 
    420       1.1    jruoho         if (!Prev)
    421       1.1    jruoho         {
    422       1.1    jruoho             AcpiGbl_ModuleCodeList = MethodObj;
    423       1.1    jruoho         }
    424       1.1    jruoho         else
    425       1.1    jruoho         {
    426       1.1    jruoho             Prev->Method.Mutex = MethodObj;
    427       1.1    jruoho         }
    428       1.1    jruoho     }
    429       1.1    jruoho     else
    430       1.1    jruoho     {
    431   1.1.1.7  christos         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    432   1.1.1.7  christos             "Appending to existing code block: %p\n", Prev));
    433   1.1.1.7  christos 
    434       1.1    jruoho         Prev->Method.AmlLength += AmlLength;
    435       1.1    jruoho     }
    436   1.1.1.7  christos 
    437   1.1.1.7  christos     return_VOID;
    438       1.1    jruoho }
    439       1.1    jruoho 
    440       1.1    jruoho /*******************************************************************************
    441       1.1    jruoho  *
    442       1.1    jruoho  * FUNCTION:    AcpiPsParseLoop
    443       1.1    jruoho  *
    444       1.1    jruoho  * PARAMETERS:  WalkState           - Current state
    445       1.1    jruoho  *
    446       1.1    jruoho  * RETURN:      Status
    447       1.1    jruoho  *
    448       1.1    jruoho  * DESCRIPTION: Parse AML (pointed to by the current parser state) and return
    449       1.1    jruoho  *              a tree of ops.
    450       1.1    jruoho  *
    451       1.1    jruoho  ******************************************************************************/
    452       1.1    jruoho 
    453       1.1    jruoho ACPI_STATUS
    454       1.1    jruoho AcpiPsParseLoop (
    455       1.1    jruoho     ACPI_WALK_STATE         *WalkState)
    456       1.1    jruoho {
    457       1.1    jruoho     ACPI_STATUS             Status = AE_OK;
    458       1.1    jruoho     ACPI_PARSE_OBJECT       *Op = NULL;     /* current op */
    459       1.1    jruoho     ACPI_PARSE_STATE        *ParserState;
    460       1.1    jruoho     UINT8                   *AmlOpStart = NULL;
    461  1.1.1.13  christos     UINT8                   OpcodeLength;
    462       1.1    jruoho 
    463       1.1    jruoho 
    464       1.1    jruoho     ACPI_FUNCTION_TRACE_PTR (PsParseLoop, WalkState);
    465       1.1    jruoho 
    466       1.1    jruoho 
    467       1.1    jruoho     if (WalkState->DescendingCallback == NULL)
    468       1.1    jruoho     {
    469       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    470       1.1    jruoho     }
    471       1.1    jruoho 
    472       1.1    jruoho     ParserState = &WalkState->ParserState;
    473       1.1    jruoho     WalkState->ArgTypes = 0;
    474       1.1    jruoho 
    475  1.1.1.13  christos #ifndef ACPI_CONSTANT_EVAL_ONLY
    476       1.1    jruoho 
    477       1.1    jruoho     if (WalkState->WalkType & ACPI_WALK_METHOD_RESTART)
    478       1.1    jruoho     {
    479       1.1    jruoho         /* We are restarting a preempted control method */
    480       1.1    jruoho 
    481       1.1    jruoho         if (AcpiPsHasCompletedScope (ParserState))
    482       1.1    jruoho         {
    483       1.1    jruoho             /*
    484       1.1    jruoho              * We must check if a predicate to an IF or WHILE statement
    485       1.1    jruoho              * was just completed
    486       1.1    jruoho              */
    487       1.1    jruoho             if ((ParserState->Scope->ParseScope.Op) &&
    488       1.1    jruoho                ((ParserState->Scope->ParseScope.Op->Common.AmlOpcode == AML_IF_OP) ||
    489       1.1    jruoho                 (ParserState->Scope->ParseScope.Op->Common.AmlOpcode == AML_WHILE_OP)) &&
    490       1.1    jruoho                 (WalkState->ControlState) &&
    491       1.1    jruoho                 (WalkState->ControlState->Common.State ==
    492       1.1    jruoho                     ACPI_CONTROL_PREDICATE_EXECUTING))
    493       1.1    jruoho             {
    494       1.1    jruoho                 /*
    495       1.1    jruoho                  * A predicate was just completed, get the value of the
    496       1.1    jruoho                  * predicate and branch based on that value
    497       1.1    jruoho                  */
    498       1.1    jruoho                 WalkState->Op = NULL;
    499       1.1    jruoho                 Status = AcpiDsGetPredicateValue (WalkState, ACPI_TO_POINTER (TRUE));
    500       1.1    jruoho                 if (ACPI_FAILURE (Status) &&
    501       1.1    jruoho                     ((Status & AE_CODE_MASK) != AE_CODE_CONTROL))
    502       1.1    jruoho                 {
    503       1.1    jruoho                     if (Status == AE_AML_NO_RETURN_VALUE)
    504       1.1    jruoho                     {
    505       1.1    jruoho                         ACPI_EXCEPTION ((AE_INFO, Status,
    506       1.1    jruoho                             "Invoked method did not return a value"));
    507       1.1    jruoho                     }
    508       1.1    jruoho 
    509       1.1    jruoho                     ACPI_EXCEPTION ((AE_INFO, Status, "GetPredicate Failed"));
    510       1.1    jruoho                     return_ACPI_STATUS (Status);
    511       1.1    jruoho                 }
    512       1.1    jruoho 
    513       1.1    jruoho                 Status = AcpiPsNextParseState (WalkState, Op, Status);
    514       1.1    jruoho             }
    515       1.1    jruoho 
    516       1.1    jruoho             AcpiPsPopScope (ParserState, &Op,
    517       1.1    jruoho                 &WalkState->ArgTypes, &WalkState->ArgCount);
    518       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Popped scope, Op=%p\n", Op));
    519       1.1    jruoho         }
    520       1.1    jruoho         else if (WalkState->PrevOp)
    521       1.1    jruoho         {
    522       1.1    jruoho             /* We were in the middle of an op */
    523       1.1    jruoho 
    524       1.1    jruoho             Op = WalkState->PrevOp;
    525       1.1    jruoho             WalkState->ArgTypes = WalkState->PrevArgTypes;
    526       1.1    jruoho         }
    527       1.1    jruoho     }
    528       1.1    jruoho #endif
    529       1.1    jruoho 
    530       1.1    jruoho     /* Iterative parsing loop, while there is more AML to process: */
    531       1.1    jruoho 
    532       1.1    jruoho     while ((ParserState->Aml < ParserState->AmlEnd) || (Op))
    533       1.1    jruoho     {
    534   1.1.1.9  christos         ASL_CV_CAPTURE_COMMENTS (WalkState);
    535   1.1.1.9  christos 
    536       1.1    jruoho         AmlOpStart = ParserState->Aml;
    537       1.1    jruoho         if (!Op)
    538       1.1    jruoho         {
    539       1.1    jruoho             Status = AcpiPsCreateOp (WalkState, AmlOpStart, &Op);
    540       1.1    jruoho             if (ACPI_FAILURE (Status))
    541       1.1    jruoho             {
    542  1.1.1.12  christos                 /*
    543  1.1.1.12  christos                  * ACPI_PARSE_MODULE_LEVEL means that we are loading a table by
    544  1.1.1.12  christos                  * executing it as a control method. However, if we encounter
    545  1.1.1.12  christos                  * an error while loading the table, we need to keep trying to
    546  1.1.1.12  christos                  * load the table rather than aborting the table load. Set the
    547  1.1.1.12  christos                  * status to AE_OK to proceed with the table load.
    548  1.1.1.12  christos                  */
    549  1.1.1.12  christos                 if ((WalkState->ParseFlags & ACPI_PARSE_MODULE_LEVEL) &&
    550  1.1.1.13  christos                     ((Status == AE_ALREADY_EXISTS) || (Status == AE_NOT_FOUND)))
    551  1.1.1.12  christos                 {
    552  1.1.1.12  christos                     Status = AE_OK;
    553  1.1.1.12  christos                 }
    554       1.1    jruoho                 if (Status == AE_CTRL_PARSE_CONTINUE)
    555       1.1    jruoho                 {
    556       1.1    jruoho                     continue;
    557       1.1    jruoho                 }
    558       1.1    jruoho 
    559       1.1    jruoho                 if (Status == AE_CTRL_PARSE_PENDING)
    560       1.1    jruoho                 {
    561       1.1    jruoho                     Status = AE_OK;
    562       1.1    jruoho                 }
    563       1.1    jruoho 
    564   1.1.1.4  christos                 if (Status == AE_CTRL_TERMINATE)
    565   1.1.1.4  christos                 {
    566   1.1.1.4  christos                     return_ACPI_STATUS (Status);
    567   1.1.1.4  christos                 }
    568   1.1.1.4  christos 
    569       1.1    jruoho                 Status = AcpiPsCompleteOp (WalkState, &Op, Status);
    570       1.1    jruoho                 if (ACPI_FAILURE (Status))
    571       1.1    jruoho                 {
    572       1.1    jruoho                     return_ACPI_STATUS (Status);
    573       1.1    jruoho                 }
    574  1.1.1.12  christos                 if (AcpiNsOpensScope (
    575  1.1.1.12  christos                     AcpiPsGetOpcodeInfo (WalkState->Opcode)->ObjectType))
    576  1.1.1.12  christos                 {
    577  1.1.1.12  christos                     /*
    578  1.1.1.12  christos                      * If the scope/device op fails to parse, skip the body of
    579  1.1.1.12  christos                      * the scope op because the parse failure indicates that
    580  1.1.1.12  christos                      * the device may not exist.
    581  1.1.1.12  christos                      */
    582  1.1.1.13  christos                     ACPI_INFO (("Skipping parse of AML opcode: %s (0x%4.4X)",
    583  1.1.1.13  christos                         AcpiPsGetOpcodeName (WalkState->Opcode), WalkState->Opcode));
    584  1.1.1.13  christos 
    585  1.1.1.13  christos                     /*
    586  1.1.1.13  christos                      * Determine the opcode length before skipping the opcode.
    587  1.1.1.13  christos                      * An opcode can be 1 byte or 2 bytes in length.
    588  1.1.1.13  christos                      */
    589  1.1.1.13  christos                     OpcodeLength = 1;
    590  1.1.1.13  christos                     if ((WalkState->Opcode & 0xFF00) == AML_EXTENDED_OPCODE)
    591  1.1.1.13  christos                     {
    592  1.1.1.13  christos                         OpcodeLength = 2;
    593  1.1.1.13  christos                     }
    594  1.1.1.13  christos                     WalkState->ParserState.Aml = WalkState->Aml + OpcodeLength;
    595  1.1.1.13  christos 
    596  1.1.1.12  christos                     WalkState->ParserState.Aml =
    597  1.1.1.12  christos                         AcpiPsGetNextPackageEnd(&WalkState->ParserState);
    598  1.1.1.12  christos                     WalkState->Aml = WalkState->ParserState.Aml;
    599  1.1.1.12  christos                 }
    600       1.1    jruoho 
    601       1.1    jruoho                 continue;
    602       1.1    jruoho             }
    603       1.1    jruoho 
    604   1.1.1.6  christos             AcpiExStartTraceOpcode (Op, WalkState);
    605       1.1    jruoho         }
    606       1.1    jruoho 
    607       1.1    jruoho         /*
    608       1.1    jruoho          * Start ArgCount at zero because we don't know if there are
    609       1.1    jruoho          * any args yet
    610       1.1    jruoho          */
    611   1.1.1.9  christos         WalkState->ArgCount = 0;
    612   1.1.1.9  christos 
    613   1.1.1.9  christos         switch (Op->Common.AmlOpcode)
    614   1.1.1.9  christos         {
    615   1.1.1.9  christos         case AML_BYTE_OP:
    616   1.1.1.9  christos         case AML_WORD_OP:
    617   1.1.1.9  christos         case AML_DWORD_OP:
    618   1.1.1.9  christos         case AML_QWORD_OP:
    619   1.1.1.9  christos 
    620   1.1.1.9  christos             break;
    621   1.1.1.9  christos 
    622   1.1.1.9  christos         default:
    623   1.1.1.9  christos 
    624   1.1.1.9  christos             ASL_CV_CAPTURE_COMMENTS (WalkState);
    625   1.1.1.9  christos             break;
    626   1.1.1.9  christos         }
    627       1.1    jruoho 
    628       1.1    jruoho         /* Are there any arguments that must be processed? */
    629       1.1    jruoho 
    630       1.1    jruoho         if (WalkState->ArgTypes)
    631       1.1    jruoho         {
    632       1.1    jruoho             /* Get arguments */
    633       1.1    jruoho 
    634       1.1    jruoho             Status = AcpiPsGetArguments (WalkState, AmlOpStart, Op);
    635       1.1    jruoho             if (ACPI_FAILURE (Status))
    636       1.1    jruoho             {
    637       1.1    jruoho                 Status = AcpiPsCompleteOp (WalkState, &Op, Status);
    638       1.1    jruoho                 if (ACPI_FAILURE (Status))
    639       1.1    jruoho                 {
    640       1.1    jruoho                     return_ACPI_STATUS (Status);
    641       1.1    jruoho                 }
    642  1.1.1.12  christos                 if ((WalkState->ControlState) &&
    643  1.1.1.12  christos                     ((WalkState->ControlState->Control.Opcode == AML_IF_OP) ||
    644  1.1.1.12  christos                     (WalkState->ControlState->Control.Opcode == AML_WHILE_OP)))
    645  1.1.1.12  christos                 {
    646  1.1.1.12  christos                     /*
    647  1.1.1.12  christos                      * If the if/while op fails to parse, we will skip parsing
    648  1.1.1.12  christos                      * the body of the op.
    649  1.1.1.12  christos                      */
    650  1.1.1.12  christos                     ParserState->Aml =
    651  1.1.1.12  christos                         WalkState->ControlState->Control.AmlPredicateStart + 1;
    652  1.1.1.12  christos                     ParserState->Aml =
    653  1.1.1.12  christos                         AcpiPsGetNextPackageEnd (ParserState);
    654  1.1.1.12  christos                     WalkState->Aml = ParserState->Aml;
    655       1.1    jruoho 
    656  1.1.1.12  christos                     ACPI_ERROR ((AE_INFO, "Skipping While/If block"));
    657  1.1.1.12  christos                     if (*WalkState->Aml == AML_ELSE_OP)
    658  1.1.1.12  christos                     {
    659  1.1.1.12  christos                         ACPI_ERROR ((AE_INFO, "Skipping Else block"));
    660  1.1.1.12  christos                         WalkState->ParserState.Aml = WalkState->Aml + 1;
    661  1.1.1.12  christos                         WalkState->ParserState.Aml =
    662  1.1.1.12  christos                             AcpiPsGetNextPackageEnd (ParserState);
    663  1.1.1.12  christos                         WalkState->Aml = ParserState->Aml;
    664  1.1.1.12  christos                     }
    665  1.1.1.12  christos                     ACPI_FREE(AcpiUtPopGenericState (&WalkState->ControlState));
    666  1.1.1.12  christos                 }
    667  1.1.1.12  christos                 Op = NULL;
    668       1.1    jruoho                 continue;
    669       1.1    jruoho             }
    670       1.1    jruoho         }
    671       1.1    jruoho 
    672       1.1    jruoho         /* Check for arguments that need to be processed */
    673       1.1    jruoho 
    674  1.1.1.10  christos         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
    675  1.1.1.11  christos             "Parseloop: argument count: %8.8X\n", WalkState->ArgCount));
    676  1.1.1.10  christos 
    677       1.1    jruoho         if (WalkState->ArgCount)
    678       1.1    jruoho         {
    679       1.1    jruoho             /*
    680       1.1    jruoho              * There are arguments (complex ones), push Op and
    681       1.1    jruoho              * prepare for argument
    682       1.1    jruoho              */
    683       1.1    jruoho             Status = AcpiPsPushScope (ParserState, Op,
    684   1.1.1.7  christos                 WalkState->ArgTypes, WalkState->ArgCount);
    685       1.1    jruoho             if (ACPI_FAILURE (Status))
    686       1.1    jruoho             {
    687       1.1    jruoho                 Status = AcpiPsCompleteOp (WalkState, &Op, Status);
    688       1.1    jruoho                 if (ACPI_FAILURE (Status))
    689       1.1    jruoho                 {
    690       1.1    jruoho                     return_ACPI_STATUS (Status);
    691       1.1    jruoho                 }
    692       1.1    jruoho 
    693       1.1    jruoho                 continue;
    694       1.1    jruoho             }
    695       1.1    jruoho 
    696       1.1    jruoho             Op = NULL;
    697       1.1    jruoho             continue;
    698       1.1    jruoho         }
    699       1.1    jruoho 
    700       1.1    jruoho         /*
    701       1.1    jruoho          * All arguments have been processed -- Op is complete,
    702       1.1    jruoho          * prepare for next
    703       1.1    jruoho          */
    704       1.1    jruoho         WalkState->OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
    705       1.1    jruoho         if (WalkState->OpInfo->Flags & AML_NAMED)
    706       1.1    jruoho         {
    707       1.1    jruoho             if (Op->Common.AmlOpcode == AML_REGION_OP ||
    708       1.1    jruoho                 Op->Common.AmlOpcode == AML_DATA_REGION_OP)
    709       1.1    jruoho             {
    710       1.1    jruoho                 /*
    711       1.1    jruoho                  * Skip parsing of control method or opregion body,
    712       1.1    jruoho                  * because we don't have enough info in the first pass
    713       1.1    jruoho                  * to parse them correctly.
    714       1.1    jruoho                  *
    715       1.1    jruoho                  * Completed parsing an OpRegion declaration, we now
    716       1.1    jruoho                  * know the length.
    717       1.1    jruoho                  */
    718       1.1    jruoho                 Op->Named.Length = (UINT32) (ParserState->Aml - Op->Named.Data);
    719       1.1    jruoho             }
    720       1.1    jruoho         }
    721       1.1    jruoho 
    722       1.1    jruoho         if (WalkState->OpInfo->Flags & AML_CREATE)
    723       1.1    jruoho         {
    724       1.1    jruoho             /*
    725       1.1    jruoho              * Backup to beginning of CreateXXXfield declaration (1 for
    726       1.1    jruoho              * Opcode)
    727       1.1    jruoho              *
    728       1.1    jruoho              * BodyLength is unknown until we parse the body
    729       1.1    jruoho              */
    730       1.1    jruoho             Op->Named.Length = (UINT32) (ParserState->Aml - Op->Named.Data);
    731       1.1    jruoho         }
    732       1.1    jruoho 
    733       1.1    jruoho         if (Op->Common.AmlOpcode == AML_BANK_FIELD_OP)
    734       1.1    jruoho         {
    735       1.1    jruoho             /*
    736       1.1    jruoho              * Backup to beginning of BankField declaration
    737       1.1    jruoho              *
    738       1.1    jruoho              * BodyLength is unknown until we parse the body
    739       1.1    jruoho              */
    740       1.1    jruoho             Op->Named.Length = (UINT32) (ParserState->Aml - Op->Named.Data);
    741       1.1    jruoho         }
    742       1.1    jruoho 
    743       1.1    jruoho         /* This op complete, notify the dispatcher */
    744       1.1    jruoho 
    745       1.1    jruoho         if (WalkState->AscendingCallback != NULL)
    746       1.1    jruoho         {
    747       1.1    jruoho             WalkState->Op = Op;
    748       1.1    jruoho             WalkState->Opcode = Op->Common.AmlOpcode;
    749       1.1    jruoho 
    750       1.1    jruoho             Status = WalkState->AscendingCallback (WalkState);
    751       1.1    jruoho             Status = AcpiPsNextParseState (WalkState, Op, Status);
    752       1.1    jruoho             if (Status == AE_CTRL_PENDING)
    753       1.1    jruoho             {
    754       1.1    jruoho                 Status = AE_OK;
    755       1.1    jruoho             }
    756  1.1.1.12  christos             else if ((WalkState->ParseFlags & ACPI_PARSE_MODULE_LEVEL) &&
    757  1.1.1.12  christos                 (ACPI_AML_EXCEPTION(Status) || Status == AE_ALREADY_EXISTS ||
    758  1.1.1.12  christos                 Status == AE_NOT_FOUND))
    759  1.1.1.12  christos             {
    760  1.1.1.12  christos                 /*
    761  1.1.1.12  christos                  * ACPI_PARSE_MODULE_LEVEL flag means that we are currently
    762  1.1.1.12  christos                  * loading a table by executing it as a control method.
    763  1.1.1.12  christos                  * However, if we encounter an error while loading the table,
    764  1.1.1.12  christos                  * we need to keep trying to load the table rather than
    765  1.1.1.12  christos                  * aborting the table load (setting the status to AE_OK
    766  1.1.1.12  christos                  * continues the table load). If we get a failure at this
    767  1.1.1.12  christos                  * point, it means that the dispatcher got an error while
    768  1.1.1.12  christos                  * trying to execute the Op.
    769  1.1.1.12  christos                  */
    770  1.1.1.12  christos                 Status = AE_OK;
    771  1.1.1.12  christos             }
    772       1.1    jruoho         }
    773       1.1    jruoho 
    774       1.1    jruoho         Status = AcpiPsCompleteOp (WalkState, &Op, Status);
    775       1.1    jruoho         if (ACPI_FAILURE (Status))
    776       1.1    jruoho         {
    777       1.1    jruoho             return_ACPI_STATUS (Status);
    778       1.1    jruoho         }
    779       1.1    jruoho 
    780       1.1    jruoho     } /* while ParserState->Aml */
    781       1.1    jruoho 
    782       1.1    jruoho     Status = AcpiPsCompleteFinalOp (WalkState, Op, Status);
    783       1.1    jruoho     return_ACPI_STATUS (Status);
    784       1.1    jruoho }
    785