Home | History | Annotate | Line # | Download | only in compiler
aslanalyze.c revision 1.17.6.1
      1       1.1    jruoho /******************************************************************************
      2       1.1    jruoho  *
      3       1.2  christos  * Module Name: aslanalyze.c - Support functions for parse tree walks
      4       1.1    jruoho  *
      5       1.1    jruoho  *****************************************************************************/
      6       1.1    jruoho 
      7  1.17.6.1  perseant /******************************************************************************
      8  1.17.6.1  perseant  *
      9  1.17.6.1  perseant  * 1. Copyright Notice
     10  1.17.6.1  perseant  *
     11  1.17.6.1  perseant  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
     12       1.1    jruoho  * All rights reserved.
     13       1.1    jruoho  *
     14  1.17.6.1  perseant  * 2. License
     15  1.17.6.1  perseant  *
     16  1.17.6.1  perseant  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.17.6.1  perseant  * rights. You may have additional license terms from the party that provided
     18  1.17.6.1  perseant  * you this software, covering your right to use that party's intellectual
     19  1.17.6.1  perseant  * property rights.
     20  1.17.6.1  perseant  *
     21  1.17.6.1  perseant  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.17.6.1  perseant  * copy of the source code appearing in this file ("Covered Code") an
     23  1.17.6.1  perseant  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.17.6.1  perseant  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.17.6.1  perseant  * make derivatives, distribute, use and display any portion of the Covered
     26  1.17.6.1  perseant  * Code in any form, with the right to sublicense such rights; and
     27  1.17.6.1  perseant  *
     28  1.17.6.1  perseant  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.17.6.1  perseant  * license (with the right to sublicense), under only those claims of Intel
     30  1.17.6.1  perseant  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.17.6.1  perseant  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.17.6.1  perseant  * solely to the minimum extent necessary to exercise the above copyright
     33  1.17.6.1  perseant  * license, and in no event shall the patent license extend to any additions
     34  1.17.6.1  perseant  * to or modifications of the Original Intel Code. No other license or right
     35  1.17.6.1  perseant  * is granted directly or by implication, estoppel or otherwise;
     36  1.17.6.1  perseant  *
     37  1.17.6.1  perseant  * The above copyright and patent license is granted only if the following
     38  1.17.6.1  perseant  * conditions are met:
     39  1.17.6.1  perseant  *
     40  1.17.6.1  perseant  * 3. Conditions
     41  1.17.6.1  perseant  *
     42  1.17.6.1  perseant  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.17.6.1  perseant  * Redistribution of source code of any substantial portion of the Covered
     44  1.17.6.1  perseant  * Code or modification with rights to further distribute source must include
     45  1.17.6.1  perseant  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.17.6.1  perseant  * and the following Disclaimer and Export Compliance provision. In addition,
     47  1.17.6.1  perseant  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.17.6.1  perseant  * contain a file documenting the changes Licensee made to create that Covered
     49  1.17.6.1  perseant  * Code and the date of any change. Licensee must include in that file the
     50  1.17.6.1  perseant  * documentation of any changes made by any predecessor Licensee. Licensee
     51  1.17.6.1  perseant  * must include a prominent statement that the modification is derived,
     52  1.17.6.1  perseant  * directly or indirectly, from Original Intel Code.
     53  1.17.6.1  perseant  *
     54  1.17.6.1  perseant  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.17.6.1  perseant  * Redistribution of source code of any substantial portion of the Covered
     56  1.17.6.1  perseant  * Code or modification without rights to further distribute source must
     57  1.17.6.1  perseant  * include the following Disclaimer and Export Compliance provision in the
     58  1.17.6.1  perseant  * documentation and/or other materials provided with distribution. In
     59  1.17.6.1  perseant  * addition, Licensee may not authorize further sublicense of source of any
     60  1.17.6.1  perseant  * portion of the Covered Code, and must include terms to the effect that the
     61  1.17.6.1  perseant  * license from Licensee to its licensee is limited to the intellectual
     62  1.17.6.1  perseant  * property embodied in the software Licensee provides to its licensee, and
     63  1.17.6.1  perseant  * not to intellectual property embodied in modifications its licensee may
     64  1.17.6.1  perseant  * make.
     65  1.17.6.1  perseant  *
     66  1.17.6.1  perseant  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.17.6.1  perseant  * substantial portion of the Covered Code or modification must reproduce the
     68  1.17.6.1  perseant  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.17.6.1  perseant  * provision in the documentation and/or other materials provided with the
     70  1.17.6.1  perseant  * distribution.
     71  1.17.6.1  perseant  *
     72  1.17.6.1  perseant  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.17.6.1  perseant  * Intel Code.
     74  1.17.6.1  perseant  *
     75  1.17.6.1  perseant  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.17.6.1  perseant  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.17.6.1  perseant  * other dealings in products derived from or relating to the Covered Code
     78  1.17.6.1  perseant  * without prior written authorization from Intel.
     79  1.17.6.1  perseant  *
     80  1.17.6.1  perseant  * 4. Disclaimer and Export Compliance
     81  1.17.6.1  perseant  *
     82  1.17.6.1  perseant  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.17.6.1  perseant  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.17.6.1  perseant  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  1.17.6.1  perseant  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  1.17.6.1  perseant  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.17.6.1  perseant  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.17.6.1  perseant  * PARTICULAR PURPOSE.
     89  1.17.6.1  perseant  *
     90  1.17.6.1  perseant  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.17.6.1  perseant  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.17.6.1  perseant  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.17.6.1  perseant  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.17.6.1  perseant  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.17.6.1  perseant  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  1.17.6.1  perseant  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.17.6.1  perseant  * LIMITED REMEDY.
     98  1.17.6.1  perseant  *
     99  1.17.6.1  perseant  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.17.6.1  perseant  * software or system incorporating such software without first obtaining any
    101  1.17.6.1  perseant  * required license or other approval from the U. S. Department of Commerce or
    102  1.17.6.1  perseant  * any other agency or department of the United States Government. In the
    103  1.17.6.1  perseant  * event Licensee exports any such software from the United States or
    104  1.17.6.1  perseant  * re-exports any such software from a foreign destination, Licensee shall
    105  1.17.6.1  perseant  * ensure that the distribution and export/re-export of the software is in
    106  1.17.6.1  perseant  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.17.6.1  perseant  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.17.6.1  perseant  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.17.6.1  perseant  * software, or service, directly or indirectly, to any country for which the
    110  1.17.6.1  perseant  * United States government or any agency thereof requires an export license,
    111  1.17.6.1  perseant  * other governmental approval, or letter of assurance, without first obtaining
    112  1.17.6.1  perseant  * such license, approval or letter.
    113  1.17.6.1  perseant  *
    114  1.17.6.1  perseant  *****************************************************************************
    115  1.17.6.1  perseant  *
    116  1.17.6.1  perseant  * Alternatively, you may choose to be licensed under the terms of the
    117  1.17.6.1  perseant  * following license:
    118  1.17.6.1  perseant  *
    119       1.2  christos  * Redistribution and use in source and binary forms, with or without
    120       1.2  christos  * modification, are permitted provided that the following conditions
    121       1.2  christos  * are met:
    122       1.2  christos  * 1. Redistributions of source code must retain the above copyright
    123       1.2  christos  *    notice, this list of conditions, and the following disclaimer,
    124       1.2  christos  *    without modification.
    125       1.2  christos  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126       1.2  christos  *    substantially similar to the "NO WARRANTY" disclaimer below
    127       1.2  christos  *    ("Disclaimer") and any redistribution must be conditioned upon
    128       1.2  christos  *    including a substantially similar Disclaimer requirement for further
    129       1.2  christos  *    binary redistribution.
    130       1.2  christos  * 3. Neither the names of the above-listed copyright holders nor the names
    131       1.2  christos  *    of any contributors may be used to endorse or promote products derived
    132       1.2  christos  *    from this software without specific prior written permission.
    133       1.2  christos  *
    134       1.2  christos  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135       1.2  christos  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136      1.15  christos  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137       1.2  christos  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  1.17.6.1  perseant  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  1.17.6.1  perseant  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  1.17.6.1  perseant  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  1.17.6.1  perseant  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  1.17.6.1  perseant  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  1.17.6.1  perseant  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  1.17.6.1  perseant  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  1.17.6.1  perseant  *
    146  1.17.6.1  perseant  * Alternatively, you may choose to be licensed under the terms of the
    147  1.17.6.1  perseant  * GNU General Public License ("GPL") version 2 as published by the Free
    148  1.17.6.1  perseant  * Software Foundation.
    149  1.17.6.1  perseant  *
    150  1.17.6.1  perseant  *****************************************************************************/
    151       1.1    jruoho 
    152       1.1    jruoho #include "aslcompiler.h"
    153       1.1    jruoho #include "aslcompiler.y.h"
    154      1.14  christos #include "acnamesp.h"
    155       1.2  christos #include <string.h>
    156       1.2  christos 
    157       1.1    jruoho 
    158       1.1    jruoho #define _COMPONENT          ACPI_COMPILER
    159       1.1    jruoho         ACPI_MODULE_NAME    ("aslanalyze")
    160       1.1    jruoho 
    161       1.1    jruoho 
    162       1.7  christos /* Local Prototypes */
    163       1.7  christos 
    164       1.7  christos static ACPI_STATUS
    165       1.7  christos ApDeviceSubtreeWalk (
    166       1.7  christos     ACPI_PARSE_OBJECT       *Op,
    167       1.7  christos     UINT32                  Level,
    168       1.7  christos     void                    *Context);
    169       1.7  christos 
    170       1.7  christos 
    171       1.1    jruoho /*******************************************************************************
    172       1.1    jruoho  *
    173       1.1    jruoho  * FUNCTION:    AnIsInternalMethod
    174       1.1    jruoho  *
    175       1.2  christos  * PARAMETERS:  Op                  - Current op
    176       1.1    jruoho  *
    177       1.1    jruoho  * RETURN:      Boolean
    178       1.1    jruoho  *
    179       1.1    jruoho  * DESCRIPTION: Check for an internal control method.
    180       1.1    jruoho  *
    181       1.1    jruoho  ******************************************************************************/
    182       1.1    jruoho 
    183       1.2  christos BOOLEAN
    184       1.1    jruoho AnIsInternalMethod (
    185       1.1    jruoho     ACPI_PARSE_OBJECT       *Op)
    186       1.1    jruoho {
    187       1.1    jruoho 
    188       1.5  christos     if ((!strcmp (Op->Asl.ExternalName, "\\_OSI")) ||
    189       1.5  christos         (!strcmp (Op->Asl.ExternalName, "_OSI")))
    190       1.1    jruoho     {
    191       1.1    jruoho         return (TRUE);
    192       1.1    jruoho     }
    193       1.1    jruoho 
    194       1.1    jruoho     return (FALSE);
    195       1.1    jruoho }
    196       1.1    jruoho 
    197       1.1    jruoho 
    198       1.1    jruoho /*******************************************************************************
    199       1.1    jruoho  *
    200       1.1    jruoho  * FUNCTION:    AnGetInternalMethodReturnType
    201       1.1    jruoho  *
    202       1.2  christos  * PARAMETERS:  Op                  - Current op
    203       1.1    jruoho  *
    204       1.1    jruoho  * RETURN:      Btype
    205       1.1    jruoho  *
    206       1.1    jruoho  * DESCRIPTION: Get the return type of an internal method
    207       1.1    jruoho  *
    208       1.1    jruoho  ******************************************************************************/
    209       1.1    jruoho 
    210       1.2  christos UINT32
    211       1.1    jruoho AnGetInternalMethodReturnType (
    212       1.1    jruoho     ACPI_PARSE_OBJECT       *Op)
    213       1.1    jruoho {
    214       1.1    jruoho 
    215       1.5  christos     if ((!strcmp (Op->Asl.ExternalName, "\\_OSI")) ||
    216       1.5  christos         (!strcmp (Op->Asl.ExternalName, "_OSI")))
    217       1.1    jruoho     {
    218       1.1    jruoho         return (ACPI_BTYPE_STRING);
    219       1.1    jruoho     }
    220       1.1    jruoho 
    221       1.1    jruoho     return (0);
    222       1.1    jruoho }
    223       1.1    jruoho 
    224       1.1    jruoho 
    225       1.1    jruoho /*******************************************************************************
    226       1.1    jruoho  *
    227       1.2  christos  * FUNCTION:    AnCheckId
    228       1.1    jruoho  *
    229       1.2  christos  * PARAMETERS:  Op                  - Current parse op
    230       1.2  christos  *              Type                - HID or CID
    231       1.1    jruoho  *
    232       1.2  christos  * RETURN:      None
    233       1.1    jruoho  *
    234       1.2  christos  * DESCRIPTION: Perform various checks on _HID and _CID strings. Only limited
    235       1.2  christos  *              checks can be performed on _CID strings.
    236       1.1    jruoho  *
    237       1.1    jruoho  ******************************************************************************/
    238       1.1    jruoho 
    239       1.2  christos void
    240       1.2  christos AnCheckId (
    241       1.2  christos     ACPI_PARSE_OBJECT       *Op,
    242       1.2  christos     ACPI_NAME               Type)
    243       1.1    jruoho {
    244       1.2  christos     UINT32                  i;
    245       1.2  christos     ACPI_SIZE               Length;
    246       1.1    jruoho 
    247       1.1    jruoho 
    248       1.2  christos     /* Only care about string versions of _HID/_CID (integers are legal) */
    249       1.1    jruoho 
    250       1.2  christos     if (Op->Asl.ParseOpcode != PARSEOP_STRING_LITERAL)
    251       1.1    jruoho     {
    252       1.2  christos         return;
    253       1.1    jruoho     }
    254       1.1    jruoho 
    255       1.2  christos     /* For both _HID and _CID, the string must be non-null */
    256       1.1    jruoho 
    257       1.2  christos     Length = strlen (Op->Asl.Value.String);
    258       1.2  christos     if (!Length)
    259       1.1    jruoho     {
    260       1.6  christos         AslError (ASL_ERROR, ASL_MSG_NULL_STRING, Op, NULL);
    261       1.2  christos         return;
    262       1.1    jruoho     }
    263       1.1    jruoho 
    264       1.2  christos     /*
    265       1.2  christos      * One of the things we want to catch here is the use of a leading
    266       1.2  christos      * asterisk in the string -- an odd construct that certain platform
    267       1.2  christos      * manufacturers are fond of. Technically, a leading asterisk is OK
    268       1.2  christos      * for _CID, but a valid use of this has not been seen.
    269       1.2  christos      */
    270       1.2  christos     if (*Op->Asl.Value.String == '*')
    271       1.1    jruoho     {
    272       1.2  christos         AslError (ASL_ERROR, ASL_MSG_LEADING_ASTERISK,
    273       1.2  christos             Op, Op->Asl.Value.String);
    274       1.2  christos         return;
    275       1.1    jruoho     }
    276       1.1    jruoho 
    277       1.2  christos     /* _CID strings are bus-specific, no more checks can be performed */
    278       1.1    jruoho 
    279       1.2  christos     if (Type == ASL_TYPE_CID)
    280       1.1    jruoho     {
    281       1.1    jruoho         return;
    282       1.1    jruoho     }
    283       1.1    jruoho 
    284       1.2  christos     /* For _HID, all characters must be alphanumeric */
    285       1.1    jruoho 
    286       1.2  christos     for (i = 0; Op->Asl.Value.String[i]; i++)
    287       1.1    jruoho     {
    288       1.2  christos         if (!isalnum ((int) Op->Asl.Value.String[i]))
    289       1.1    jruoho         {
    290       1.2  christos             AslError (ASL_ERROR, ASL_MSG_ALPHANUMERIC_STRING,
    291       1.2  christos                 Op, Op->Asl.Value.String);
    292       1.2  christos             return;
    293       1.1    jruoho         }
    294       1.1    jruoho     }
    295       1.1    jruoho 
    296       1.2  christos     /*
    297       1.2  christos      * _HID String must be one of these forms:
    298       1.2  christos      *
    299       1.2  christos      * "AAA####"    A is an uppercase letter and # is a hex digit
    300       1.2  christos      * "ACPI####"   # is a hex digit
    301       1.2  christos      * "NNNN####"   N is an uppercase letter or decimal digit (0-9)
    302       1.2  christos      *              # is a hex digit (ACPI 5.0)
    303       1.2  christos      */
    304       1.2  christos     if ((Length < 7) || (Length > 8))
    305       1.1    jruoho     {
    306       1.2  christos         AslError (ASL_ERROR, ASL_MSG_HID_LENGTH,
    307       1.2  christos             Op, Op->Asl.Value.String);
    308       1.2  christos         return;
    309       1.1    jruoho     }
    310       1.1    jruoho 
    311       1.6  christos     /* _HID Length is valid (7 or 8), now check prefix (first 3 or 4 chars) */
    312       1.1    jruoho 
    313       1.2  christos     if (Length == 7)
    314       1.1    jruoho     {
    315       1.2  christos         /* AAA####: Ensure the alphabetic prefix is all uppercase */
    316       1.1    jruoho 
    317       1.2  christos         for (i = 0; i < 3; i++)
    318       1.1    jruoho         {
    319       1.2  christos             if (!isupper ((int) Op->Asl.Value.String[i]))
    320       1.1    jruoho             {
    321       1.2  christos                 AslError (ASL_ERROR, ASL_MSG_UPPER_CASE,
    322       1.2  christos                     Op, &Op->Asl.Value.String[i]);
    323       1.2  christos                 return;
    324       1.1    jruoho             }
    325       1.1    jruoho         }
    326       1.1    jruoho     }
    327       1.2  christos     else /* Length == 8 */
    328       1.1    jruoho     {
    329       1.1    jruoho         /*
    330       1.2  christos          * ACPI#### or NNNN####:
    331       1.2  christos          * Ensure the prefix contains only uppercase alpha or decimal digits
    332       1.1    jruoho          */
    333       1.2  christos         for (i = 0; i < 4; i++)
    334       1.1    jruoho         {
    335       1.2  christos             if (!isupper ((int) Op->Asl.Value.String[i]) &&
    336       1.2  christos                 !isdigit ((int) Op->Asl.Value.String[i]))
    337       1.2  christos             {
    338       1.2  christos                 AslError (ASL_ERROR, ASL_MSG_HID_PREFIX,
    339       1.2  christos                     Op, &Op->Asl.Value.String[i]);
    340       1.2  christos                 return;
    341       1.2  christos             }
    342       1.1    jruoho         }
    343       1.2  christos     }
    344       1.1    jruoho 
    345       1.2  christos     /* Remaining characters (suffix) must be hex digits */
    346       1.1    jruoho 
    347       1.2  christos     for (; i < Length; i++)
    348       1.2  christos     {
    349       1.2  christos         if (!isxdigit ((int) Op->Asl.Value.String[i]))
    350       1.1    jruoho         {
    351       1.6  christos             AslError (ASL_ERROR, ASL_MSG_HID_SUFFIX,
    352       1.6  christos                 Op, &Op->Asl.Value.String[i]);
    353       1.2  christos             break;
    354       1.1    jruoho         }
    355       1.1    jruoho     }
    356       1.1    jruoho }
    357       1.1    jruoho 
    358       1.1    jruoho 
    359       1.1    jruoho /*******************************************************************************
    360       1.1    jruoho  *
    361       1.2  christos  * FUNCTION:    AnLastStatementIsReturn
    362       1.1    jruoho  *
    363       1.2  christos  * PARAMETERS:  Op                  - A method parse node
    364       1.1    jruoho  *
    365       1.2  christos  * RETURN:      TRUE if last statement is an ASL RETURN. False otherwise
    366       1.1    jruoho  *
    367       1.2  christos  * DESCRIPTION: Walk down the list of top level statements within a method
    368       1.2  christos  *              to find the last one. Check if that last statement is in
    369       1.2  christos  *              fact a RETURN statement.
    370       1.1    jruoho  *
    371       1.1    jruoho  ******************************************************************************/
    372       1.1    jruoho 
    373       1.2  christos BOOLEAN
    374       1.2  christos AnLastStatementIsReturn (
    375       1.2  christos     ACPI_PARSE_OBJECT       *Op)
    376       1.1    jruoho {
    377       1.2  christos     ACPI_PARSE_OBJECT       *Next;
    378       1.1    jruoho 
    379       1.1    jruoho 
    380       1.2  christos     /* Check if last statement is a return */
    381       1.1    jruoho 
    382       1.2  christos     Next = ASL_GET_CHILD_NODE (Op);
    383       1.2  christos     while (Next)
    384       1.1    jruoho     {
    385       1.2  christos         if ((!Next->Asl.Next) &&
    386       1.2  christos             (Next->Asl.ParseOpcode == PARSEOP_RETURN))
    387       1.1    jruoho         {
    388       1.2  christos             return (TRUE);
    389       1.1    jruoho         }
    390       1.1    jruoho 
    391       1.2  christos         Next = ASL_GET_PEER_NODE (Next);
    392       1.1    jruoho     }
    393       1.1    jruoho 
    394       1.2  christos     return (FALSE);
    395       1.1    jruoho }
    396       1.1    jruoho 
    397       1.1    jruoho 
    398       1.1    jruoho /*******************************************************************************
    399       1.1    jruoho  *
    400       1.1    jruoho  * FUNCTION:    AnCheckMethodReturnValue
    401       1.1    jruoho  *
    402       1.1    jruoho  * PARAMETERS:  Op                  - Parent
    403       1.1    jruoho  *              OpInfo              - Parent info
    404       1.1    jruoho  *              ArgOp               - Method invocation op
    405       1.1    jruoho  *              RequiredBtypes      - What caller requires
    406       1.1    jruoho  *              ThisNodeBtype       - What this node returns (if anything)
    407       1.1    jruoho  *
    408       1.1    jruoho  * RETURN:      None
    409       1.1    jruoho  *
    410       1.1    jruoho  * DESCRIPTION: Check a method invocation for 1) A return value and if it does
    411       1.1    jruoho  *              in fact return a value, 2) check the type of the return value.
    412       1.1    jruoho  *
    413       1.1    jruoho  ******************************************************************************/
    414       1.1    jruoho 
    415       1.2  christos void
    416       1.1    jruoho AnCheckMethodReturnValue (
    417       1.1    jruoho     ACPI_PARSE_OBJECT       *Op,
    418       1.1    jruoho     const ACPI_OPCODE_INFO  *OpInfo,
    419       1.1    jruoho     ACPI_PARSE_OBJECT       *ArgOp,
    420       1.1    jruoho     UINT32                  RequiredBtypes,
    421       1.1    jruoho     UINT32                  ThisNodeBtype)
    422       1.1    jruoho {
    423       1.1    jruoho     ACPI_PARSE_OBJECT       *OwningOp;
    424       1.1    jruoho     ACPI_NAMESPACE_NODE     *Node;
    425      1.14  christos     char                    *ExternalPath;
    426       1.1    jruoho 
    427       1.1    jruoho 
    428       1.1    jruoho     Node = ArgOp->Asl.Node;
    429       1.1    jruoho 
    430       1.7  christos     if (!Node)
    431       1.7  christos     {
    432       1.7  christos         /* No error message, this can happen and is OK */
    433       1.7  christos 
    434       1.7  christos         return;
    435       1.7  christos     }
    436       1.1    jruoho 
    437       1.1    jruoho     /* Examine the parent op of this method */
    438       1.1    jruoho 
    439       1.1    jruoho     OwningOp = Node->Op;
    440      1.14  christos     ExternalPath = AcpiNsGetNormalizedPathname (Node, TRUE);
    441      1.14  christos 
    442       1.9  christos     if (OwningOp->Asl.CompileFlags & OP_METHOD_NO_RETVAL)
    443       1.1    jruoho     {
    444       1.1    jruoho         /* Method NEVER returns a value */
    445       1.1    jruoho 
    446      1.14  christos         AslError (ASL_ERROR, ASL_MSG_NO_RETVAL, Op, ExternalPath);
    447       1.1    jruoho     }
    448       1.9  christos     else if (OwningOp->Asl.CompileFlags & OP_METHOD_SOME_NO_RETVAL)
    449       1.1    jruoho     {
    450       1.1    jruoho         /* Method SOMETIMES returns a value, SOMETIMES not */
    451       1.1    jruoho 
    452      1.14  christos         AslError (ASL_WARNING, ASL_MSG_SOME_NO_RETVAL, Op, ExternalPath);
    453       1.1    jruoho     }
    454       1.1    jruoho     else if (!(ThisNodeBtype & RequiredBtypes))
    455       1.1    jruoho     {
    456       1.1    jruoho         /* Method returns a value, but the type is wrong */
    457       1.1    jruoho 
    458      1.11  christos         AnFormatBtype (AslGbl_StringBuffer, ThisNodeBtype);
    459      1.11  christos         AnFormatBtype (AslGbl_StringBuffer2, RequiredBtypes);
    460       1.1    jruoho 
    461       1.1    jruoho         /*
    462       1.1    jruoho          * The case where the method does not return any value at all
    463       1.1    jruoho          * was already handled in the namespace cross reference
    464       1.1    jruoho          * -- Only issue an error if the method in fact returns a value,
    465       1.1    jruoho          * but it is of the wrong type
    466       1.1    jruoho          */
    467       1.1    jruoho         if (ThisNodeBtype != 0)
    468       1.1    jruoho         {
    469      1.11  christos             snprintf (AslGbl_MsgBuffer, sizeof(AslGbl_MsgBuffer),
    470       1.1    jruoho                 "Method returns [%s], %s operator requires [%s]",
    471      1.11  christos                 AslGbl_StringBuffer, OpInfo->Name, AslGbl_StringBuffer2);
    472       1.1    jruoho 
    473      1.15  christos             AslError (ASL_WARNING, ASL_MSG_INVALID_TYPE, ArgOp, AslGbl_MsgBuffer);
    474       1.1    jruoho         }
    475       1.1    jruoho     }
    476      1.14  christos 
    477      1.14  christos     if (ExternalPath)
    478      1.14  christos     {
    479      1.14  christos         ACPI_FREE (ExternalPath);
    480      1.14  christos     }
    481       1.1    jruoho }
    482       1.1    jruoho 
    483       1.1    jruoho 
    484       1.1    jruoho /*******************************************************************************
    485       1.1    jruoho  *
    486       1.1    jruoho  * FUNCTION:    AnIsResultUsed
    487       1.1    jruoho  *
    488       1.2  christos  * PARAMETERS:  Op                  - Parent op for the operator
    489       1.1    jruoho  *
    490       1.1    jruoho  * RETURN:      TRUE if result from this operation is actually consumed
    491       1.1    jruoho  *
    492       1.1    jruoho  * DESCRIPTION: Determine if the function result value from an operator is
    493       1.1    jruoho  *              used.
    494       1.1    jruoho  *
    495       1.1    jruoho  ******************************************************************************/
    496       1.1    jruoho 
    497       1.1    jruoho BOOLEAN
    498       1.1    jruoho AnIsResultUsed (
    499       1.1    jruoho     ACPI_PARSE_OBJECT       *Op)
    500       1.1    jruoho {
    501       1.1    jruoho     ACPI_PARSE_OBJECT       *Parent;
    502       1.1    jruoho 
    503       1.1    jruoho 
    504       1.1    jruoho     switch (Op->Asl.ParseOpcode)
    505       1.1    jruoho     {
    506       1.1    jruoho     case PARSEOP_INCREMENT:
    507       1.1    jruoho     case PARSEOP_DECREMENT:
    508       1.1    jruoho 
    509       1.1    jruoho         /* These are standalone operators, no return value */
    510       1.1    jruoho 
    511       1.1    jruoho         return (TRUE);
    512       1.1    jruoho 
    513       1.1    jruoho     default:
    514       1.2  christos 
    515       1.1    jruoho         break;
    516       1.1    jruoho     }
    517       1.1    jruoho 
    518       1.1    jruoho     /* Examine parent to determine if the return value is used */
    519       1.1    jruoho 
    520       1.1    jruoho     Parent = Op->Asl.Parent;
    521       1.1    jruoho     switch (Parent->Asl.ParseOpcode)
    522       1.1    jruoho     {
    523       1.1    jruoho     /* If/While - check if the operator is the predicate */
    524       1.1    jruoho 
    525       1.1    jruoho     case PARSEOP_IF:
    526       1.1    jruoho     case PARSEOP_WHILE:
    527       1.1    jruoho 
    528       1.1    jruoho         /* First child is the predicate */
    529       1.1    jruoho 
    530       1.1    jruoho         if (Parent->Asl.Child == Op)
    531       1.1    jruoho         {
    532       1.1    jruoho             return (TRUE);
    533       1.1    jruoho         }
    534       1.6  christos 
    535       1.1    jruoho         return (FALSE);
    536       1.1    jruoho 
    537       1.1    jruoho     /* Not used if one of these is the parent */
    538       1.1    jruoho 
    539       1.1    jruoho     case PARSEOP_METHOD:
    540       1.6  christos     case PARSEOP_DEFINITION_BLOCK:
    541       1.1    jruoho     case PARSEOP_ELSE:
    542       1.1    jruoho 
    543       1.1    jruoho         return (FALSE);
    544       1.1    jruoho 
    545       1.1    jruoho     default:
    546       1.2  christos 
    547       1.1    jruoho         /* Any other type of parent means that the result is used */
    548       1.1    jruoho 
    549       1.1    jruoho         return (TRUE);
    550       1.1    jruoho     }
    551       1.1    jruoho }
    552       1.1    jruoho 
    553       1.1    jruoho 
    554       1.1    jruoho /*******************************************************************************
    555       1.1    jruoho  *
    556       1.2  christos  * FUNCTION:    ApCheckForGpeNameConflict
    557       1.1    jruoho  *
    558       1.2  christos  * PARAMETERS:  Op                  - Current parse op
    559       1.1    jruoho  *
    560       1.2  christos  * RETURN:      None
    561       1.1    jruoho  *
    562       1.2  christos  * DESCRIPTION: Check for a conflict between GPE names within this scope.
    563       1.2  christos  *              Conflict means two GPE names with the same GPE number, but
    564       1.2  christos  *              different types -- such as _L1C and _E1C.
    565       1.1    jruoho  *
    566       1.1    jruoho  ******************************************************************************/
    567       1.1    jruoho 
    568       1.2  christos void
    569       1.2  christos ApCheckForGpeNameConflict (
    570       1.2  christos     ACPI_PARSE_OBJECT       *Op)
    571       1.1    jruoho {
    572       1.2  christos     ACPI_PARSE_OBJECT       *NextOp;
    573       1.2  christos     UINT32                  GpeNumber;
    574      1.12  christos     char                    Name[ACPI_NAMESEG_SIZE + 1];
    575      1.12  christos     char                    Target[ACPI_NAMESEG_SIZE];
    576       1.1    jruoho 
    577       1.1    jruoho 
    578       1.2  christos     /* Need a null-terminated string version of NameSeg */
    579       1.2  christos 
    580      1.13  christos     ACPI_MOVE_32_TO_32 (Name, Op->Asl.NameSeg);
    581      1.12  christos     Name[ACPI_NAMESEG_SIZE] = 0;
    582       1.1    jruoho 
    583       1.1    jruoho     /*
    584       1.2  christos      * For a GPE method:
    585       1.2  christos      * 1st char must be underscore
    586       1.2  christos      * 2nd char must be L or E
    587       1.2  christos      * 3rd/4th chars must be a hex number
    588       1.1    jruoho      */
    589       1.2  christos     if ((Name[0] != '_') ||
    590       1.2  christos        ((Name[1] != 'L') && (Name[1] != 'E')))
    591       1.1    jruoho     {
    592       1.2  christos         return;
    593       1.2  christos     }
    594       1.1    jruoho 
    595       1.2  christos     /* Verify 3rd/4th chars are a valid hex value */
    596       1.1    jruoho 
    597       1.5  christos     GpeNumber = strtoul (&Name[2], NULL, 16);
    598       1.2  christos     if (GpeNumber == ACPI_UINT32_MAX)
    599       1.2  christos     {
    600       1.2  christos         return;
    601       1.1    jruoho     }
    602       1.1    jruoho 
    603       1.1    jruoho     /*
    604       1.2  christos      * We are now sure we have an _Lxx or _Exx.
    605       1.2  christos      * Create the target name that would cause collision (Flip E/L)
    606       1.1    jruoho      */
    607       1.2  christos     ACPI_MOVE_32_TO_32 (Target, Name);
    608       1.1    jruoho 
    609       1.2  christos     /* Inject opposite letter ("L" versus "E") */
    610       1.1    jruoho 
    611       1.2  christos     if (Name[1] == 'L')
    612       1.2  christos     {
    613       1.2  christos         Target[1] = 'E';
    614       1.2  christos     }
    615       1.2  christos     else /* Name[1] == 'E' */
    616       1.2  christos     {
    617       1.2  christos         Target[1] = 'L';
    618       1.2  christos     }
    619       1.1    jruoho 
    620       1.2  christos     /* Search all peers (objects within this scope) for target match */
    621       1.1    jruoho 
    622       1.2  christos     NextOp = Op->Asl.Next;
    623       1.2  christos     while (NextOp)
    624       1.2  christos     {
    625       1.1    jruoho         /*
    626       1.2  christos          * We mostly care about methods, but check Name() constructs also,
    627       1.2  christos          * even though they will get another error for not being a method.
    628       1.2  christos          * All GPE names must be defined as control methods.
    629       1.1    jruoho          */
    630       1.2  christos         if ((NextOp->Asl.ParseOpcode == PARSEOP_METHOD) ||
    631       1.2  christos             (NextOp->Asl.ParseOpcode == PARSEOP_NAME))
    632       1.1    jruoho         {
    633      1.12  christos             if (ACPI_COMPARE_NAMESEG (Target, NextOp->Asl.NameSeg))
    634       1.2  christos             {
    635       1.2  christos                 /* Found both _Exy and _Lxy in the same scope, error */
    636       1.1    jruoho 
    637       1.2  christos                 AslError (ASL_ERROR, ASL_MSG_GPE_NAME_CONFLICT, NextOp,
    638       1.2  christos                     Name);
    639       1.2  christos                 return;
    640       1.2  christos             }
    641       1.1    jruoho         }
    642       1.1    jruoho 
    643       1.2  christos         NextOp = NextOp->Asl.Next;
    644       1.1    jruoho     }
    645       1.1    jruoho 
    646       1.2  christos     /* OK, no conflict found */
    647       1.2  christos 
    648       1.2  christos     return;
    649       1.1    jruoho }
    650       1.1    jruoho 
    651       1.1    jruoho 
    652       1.1    jruoho /*******************************************************************************
    653       1.1    jruoho  *
    654       1.2  christos  * FUNCTION:    ApCheckRegMethod
    655       1.1    jruoho  *
    656       1.2  christos  * PARAMETERS:  Op                  - Current parse op
    657       1.1    jruoho  *
    658       1.2  christos  * RETURN:      None
    659       1.1    jruoho  *
    660       1.2  christos  * DESCRIPTION: Ensure that a _REG method has a corresponding Operation
    661       1.2  christos  *              Region declaration within the same scope. Note: _REG is defined
    662       1.2  christos  *              to have two arguments and must therefore be defined as a
    663       1.2  christos  *              control method.
    664       1.1    jruoho  *
    665       1.1    jruoho  ******************************************************************************/
    666       1.1    jruoho 
    667       1.2  christos void
    668       1.2  christos ApCheckRegMethod (
    669       1.2  christos     ACPI_PARSE_OBJECT       *Op)
    670       1.1    jruoho {
    671       1.2  christos     ACPI_PARSE_OBJECT       *Next;
    672       1.2  christos     ACPI_PARSE_OBJECT       *Parent;
    673       1.1    jruoho 
    674       1.1    jruoho 
    675       1.2  christos     /* We are only interested in _REG methods */
    676       1.1    jruoho 
    677      1.12  christos     if (!ACPI_COMPARE_NAMESEG (METHOD_NAME__REG, &Op->Asl.NameSeg))
    678       1.2  christos     {
    679       1.2  christos         return;
    680       1.2  christos     }
    681       1.1    jruoho 
    682       1.2  christos     /* Get the start of the current scope */
    683       1.1    jruoho 
    684       1.2  christos     Parent = Op->Asl.Parent;
    685       1.2  christos     Next = Parent->Asl.Child;
    686       1.1    jruoho 
    687       1.2  christos     /* Search entire scope for an operation region declaration */
    688       1.1    jruoho 
    689       1.2  christos     while (Next)
    690       1.1    jruoho     {
    691       1.2  christos         if (Next->Asl.ParseOpcode == PARSEOP_OPERATIONREGION)
    692       1.2  christos         {
    693       1.2  christos             return; /* Found region, OK */
    694       1.2  christos         }
    695       1.2  christos 
    696       1.2  christos         Next = Next->Asl.Next;
    697       1.1    jruoho     }
    698       1.1    jruoho 
    699       1.2  christos     /* No region found, issue warning */
    700       1.1    jruoho 
    701       1.2  christos     AslError (ASL_WARNING, ASL_MSG_NO_REGION, Op, NULL);
    702       1.1    jruoho }
    703       1.3  christos 
    704       1.3  christos 
    705       1.3  christos /*******************************************************************************
    706       1.3  christos  *
    707       1.7  christos  * FUNCTION:    ApFindNameInDeviceTree
    708       1.7  christos  *
    709       1.7  christos  * PARAMETERS:  Name                - Name to search for
    710       1.7  christos  *              Op                  - Current parse op
    711       1.7  christos  *
    712       1.7  christos  * RETURN:      TRUE if name found in the same scope as Op.
    713       1.7  christos  *
    714       1.7  christos  * DESCRIPTION: Determine if a name appears in the same scope as Op, as either
    715       1.7  christos  *              a Method() or a Name(). "Same scope" can mean under an If or
    716       1.7  christos  *              Else statement.
    717       1.7  christos  *
    718       1.7  christos  * NOTE: Detects _HID/_ADR in this type of construct (legal in ACPI 6.1+)
    719       1.7  christos  *
    720       1.7  christos  * Scope (\_SB.PCI0)
    721       1.7  christos  * {
    722       1.7  christos  *     Device (I2C0)
    723       1.7  christos  *     {
    724       1.7  christos  *         If (SMD0 != 4) {
    725       1.7  christos  *             Name (_HID, "INT3442")
    726       1.7  christos  *         } Else {
    727       1.7  christos  *             Name (_ADR, 0x400)
    728       1.7  christos  *         }
    729       1.7  christos  *     }
    730       1.7  christos  * }
    731       1.7  christos  ******************************************************************************/
    732       1.7  christos 
    733       1.7  christos BOOLEAN
    734       1.7  christos ApFindNameInDeviceTree (
    735       1.7  christos     char                    *Name,
    736       1.7  christos     ACPI_PARSE_OBJECT       *Op)
    737       1.7  christos {
    738       1.7  christos     ACPI_STATUS             Status;
    739       1.7  christos 
    740       1.7  christos 
    741       1.7  christos     Status = TrWalkParseTree (Op, ASL_WALK_VISIT_DOWNWARD,
    742       1.7  christos         ApDeviceSubtreeWalk, NULL, Name);
    743       1.7  christos 
    744       1.7  christos     if (Status == AE_CTRL_TRUE)
    745       1.7  christos     {
    746       1.7  christos         return (TRUE);  /* Found a match */
    747       1.7  christos     }
    748       1.7  christos 
    749       1.7  christos     return (FALSE);
    750       1.7  christos }
    751       1.7  christos 
    752       1.7  christos 
    753       1.7  christos /* Callback function for interface above */
    754       1.7  christos 
    755       1.7  christos static ACPI_STATUS
    756       1.7  christos ApDeviceSubtreeWalk (
    757       1.7  christos     ACPI_PARSE_OBJECT       *Op,
    758       1.7  christos     UINT32                  Level,
    759       1.7  christos     void                    *Context)
    760       1.7  christos {
    761       1.7  christos     char                    *Name = ACPI_CAST_PTR (char, Context);
    762       1.7  christos 
    763       1.7  christos 
    764       1.7  christos     switch (Op->Asl.ParseOpcode)
    765       1.7  christos     {
    766       1.7  christos     case PARSEOP_DEVICE:
    767       1.7  christos 
    768       1.7  christos         /* Level 0 is the starting device, ignore it */
    769       1.7  christos 
    770       1.7  christos         if (Level > 0)
    771       1.7  christos         {
    772       1.7  christos             /* Ignore sub-devices */
    773       1.7  christos 
    774       1.7  christos             return (AE_CTRL_DEPTH);
    775       1.7  christos         }
    776       1.7  christos         break;
    777       1.7  christos 
    778       1.7  christos     case PARSEOP_NAME:
    779       1.7  christos     case PARSEOP_METHOD:
    780       1.7  christos 
    781       1.7  christos         /* These are what we are looking for */
    782       1.7  christos 
    783      1.12  christos         if (ACPI_COMPARE_NAMESEG (Name, Op->Asl.NameSeg))
    784       1.7  christos         {
    785       1.7  christos             return (AE_CTRL_TRUE);
    786       1.7  christos         }
    787       1.7  christos         return (AE_CTRL_DEPTH);
    788       1.7  christos 
    789       1.7  christos     case PARSEOP_SCOPE:
    790       1.7  christos     case PARSEOP_FIELD:
    791       1.7  christos     case PARSEOP_OPERATIONREGION:
    792       1.7  christos 
    793       1.7  christos         /*
    794       1.7  christos          * We want to ignore these, because either they can be large
    795       1.7  christos          * subtrees or open a scope to somewhere else.
    796       1.7  christos          */
    797       1.7  christos         return (AE_CTRL_DEPTH);
    798       1.7  christos 
    799       1.7  christos     default:
    800       1.7  christos         break;
    801       1.7  christos     }
    802       1.7  christos 
    803       1.7  christos     return (AE_OK);
    804       1.7  christos }
    805       1.7  christos 
    806       1.7  christos 
    807       1.7  christos /*******************************************************************************
    808       1.7  christos  *
    809       1.3  christos  * FUNCTION:    ApFindNameInScope
    810       1.3  christos  *
    811       1.3  christos  * PARAMETERS:  Name                - Name to search for
    812       1.3  christos  *              Op                  - Current parse op
    813       1.3  christos  *
    814       1.3  christos  * RETURN:      TRUE if name found in the same scope as Op.
    815       1.3  christos  *
    816       1.3  christos  * DESCRIPTION: Determine if a name appears in the same scope as Op, as either
    817       1.3  christos  *              a Method() or a Name().
    818       1.3  christos  *
    819       1.3  christos  ******************************************************************************/
    820       1.3  christos 
    821       1.3  christos BOOLEAN
    822       1.3  christos ApFindNameInScope (
    823       1.3  christos     char                    *Name,
    824       1.3  christos     ACPI_PARSE_OBJECT       *Op)
    825       1.3  christos {
    826       1.3  christos     ACPI_PARSE_OBJECT       *Next;
    827       1.3  christos     ACPI_PARSE_OBJECT       *Parent;
    828       1.3  christos 
    829       1.3  christos 
    830       1.3  christos     /* Get the start of the current scope */
    831       1.3  christos 
    832       1.3  christos     Parent = Op->Asl.Parent;
    833       1.3  christos     Next = Parent->Asl.Child;
    834       1.3  christos 
    835       1.3  christos     /* Search entire scope for a match to the name */
    836       1.3  christos 
    837       1.3  christos     while (Next)
    838       1.3  christos     {
    839       1.3  christos         if ((Next->Asl.ParseOpcode == PARSEOP_METHOD) ||
    840       1.3  christos             (Next->Asl.ParseOpcode == PARSEOP_NAME))
    841       1.3  christos         {
    842      1.12  christos             if (ACPI_COMPARE_NAMESEG (Name, Next->Asl.NameSeg))
    843       1.3  christos             {
    844       1.3  christos                 return (TRUE);
    845       1.3  christos             }
    846       1.3  christos         }
    847       1.3  christos 
    848       1.3  christos         Next = Next->Asl.Next;
    849       1.3  christos     }
    850       1.3  christos 
    851       1.3  christos     return (FALSE);
    852       1.3  christos }
    853