Home | History | Annotate | Line # | Download | only in compiler
      1 NoEcho('
      2 /******************************************************************************
      3  *
      4  * Module Name: aslhelpers.y - helper and option terms
      5  *
      6  *****************************************************************************/
      7 
      8 /******************************************************************************
      9  *
     10  * 1. Copyright Notice
     11  *
     12  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     13  * All rights reserved.
     14  *
     15  * 2. License
     16  *
     17  * 2.1. This is your license from Intel Corp. under its intellectual property
     18  * rights. You may have additional license terms from the party that provided
     19  * you this software, covering your right to use that party's intellectual
     20  * property rights.
     21  *
     22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     23  * copy of the source code appearing in this file ("Covered Code") an
     24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     25  * base code distributed originally by Intel ("Original Intel Code") to copy,
     26  * make derivatives, distribute, use and display any portion of the Covered
     27  * Code in any form, with the right to sublicense such rights; and
     28  *
     29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     30  * license (with the right to sublicense), under only those claims of Intel
     31  * patents that are infringed by the Original Intel Code, to make, use, sell,
     32  * offer to sell, and import the Covered Code and derivative works thereof
     33  * solely to the minimum extent necessary to exercise the above copyright
     34  * license, and in no event shall the patent license extend to any additions
     35  * to or modifications of the Original Intel Code. No other license or right
     36  * is granted directly or by implication, estoppel or otherwise;
     37  *
     38  * The above copyright and patent license is granted only if the following
     39  * conditions are met:
     40  *
     41  * 3. Conditions
     42  *
     43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     44  * Redistribution of source code of any substantial portion of the Covered
     45  * Code or modification with rights to further distribute source must include
     46  * the above Copyright Notice, the above License, this list of Conditions,
     47  * and the following Disclaimer and Export Compliance provision. In addition,
     48  * Licensee must cause all Covered Code to which Licensee contributes to
     49  * contain a file documenting the changes Licensee made to create that Covered
     50  * Code and the date of any change. Licensee must include in that file the
     51  * documentation of any changes made by any predecessor Licensee. Licensee
     52  * must include a prominent statement that the modification is derived,
     53  * directly or indirectly, from Original Intel Code.
     54  *
     55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     56  * Redistribution of source code of any substantial portion of the Covered
     57  * Code or modification without rights to further distribute source must
     58  * include the following Disclaimer and Export Compliance provision in the
     59  * documentation and/or other materials provided with distribution. In
     60  * addition, Licensee may not authorize further sublicense of source of any
     61  * portion of the Covered Code, and must include terms to the effect that the
     62  * license from Licensee to its licensee is limited to the intellectual
     63  * property embodied in the software Licensee provides to its licensee, and
     64  * not to intellectual property embodied in modifications its licensee may
     65  * make.
     66  *
     67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     68  * substantial portion of the Covered Code or modification must reproduce the
     69  * above Copyright Notice, and the following Disclaimer and Export Compliance
     70  * provision in the documentation and/or other materials provided with the
     71  * distribution.
     72  *
     73  * 3.4. Intel retains all right, title, and interest in and to the Original
     74  * Intel Code.
     75  *
     76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     77  * Intel shall be used in advertising or otherwise to promote the sale, use or
     78  * other dealings in products derived from or relating to the Covered Code
     79  * without prior written authorization from Intel.
     80  *
     81  * 4. Disclaimer and Export Compliance
     82  *
     83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     89  * PARTICULAR PURPOSE.
     90  *
     91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     98  * LIMITED REMEDY.
     99  *
    100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    101  * software or system incorporating such software without first obtaining any
    102  * required license or other approval from the U. S. Department of Commerce or
    103  * any other agency or department of the United States Government. In the
    104  * event Licensee exports any such software from the United States or
    105  * re-exports any such software from a foreign destination, Licensee shall
    106  * ensure that the distribution and export/re-export of the software is in
    107  * compliance with all laws, regulations, orders, or other restrictions of the
    108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    109  * any of its subsidiaries will export/re-export any technical data, process,
    110  * software, or service, directly or indirectly, to any country for which the
    111  * United States government or any agency thereof requires an export license,
    112  * other governmental approval, or letter of assurance, without first obtaining
    113  * such license, approval or letter.
    114  *
    115  *****************************************************************************
    116  *
    117  * Alternatively, you may choose to be licensed under the terms of the
    118  * following license:
    119  *
    120  * Redistribution and use in source and binary forms, with or without
    121  * modification, are permitted provided that the following conditions
    122  * are met:
    123  * 1. Redistributions of source code must retain the above copyright
    124  *    notice, this list of conditions, and the following disclaimer,
    125  *    without modification.
    126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    127  *    substantially similar to the "NO WARRANTY" disclaimer below
    128  *    ("Disclaimer") and any redistribution must be conditioned upon
    129  *    including a substantially similar Disclaimer requirement for further
    130  *    binary redistribution.
    131  * 3. Neither the names of the above-listed copyright holders nor the names
    132  *    of any contributors may be used to endorse or promote products derived
    133  *    from this software without specific prior written permission.
    134  *
    135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    146  *
    147  * Alternatively, you may choose to be licensed under the terms of the
    148  * GNU General Public License ("GPL") version 2 as published by the Free
    149  * Software Foundation.
    150  *
    151  *****************************************************************************/
    152 
    153 ')
    154 
    155 
    156 /*******************************************************************************
    157  *
    158  * ASL Helper Terms
    159  *
    160  ******************************************************************************/
    161 
    162 OptionalBusMasterKeyword
    163     : ','                                   {$$ = TrCreateLeafOp (
    164                                                 PARSEOP_BUSMASTERTYPE_MASTER);}
    165     | ',' PARSEOP_BUSMASTERTYPE_MASTER      {$$ = TrCreateLeafOp (
    166                                                 PARSEOP_BUSMASTERTYPE_MASTER);}
    167     | ',' PARSEOP_BUSMASTERTYPE_NOTMASTER   {$$ = TrCreateLeafOp (
    168                                                 PARSEOP_BUSMASTERTYPE_NOTMASTER);}
    169     ;
    170 
    171 OptionalAccessAttribTerm
    172     :                               {$$ = NULL;}
    173     | ','                           {$$ = NULL;}
    174     | ',' ByteConstExpr             {$$ = $2;}
    175     | ',' AccessAttribKeyword       {$$ = $2;}
    176     ;
    177 
    178 OptionalAccessSize
    179     :                               {$$ = TrCreateValuedLeafOp (
    180                                         PARSEOP_BYTECONST, 0);}
    181     | ','                           {$$ = TrCreateValuedLeafOp (
    182                                         PARSEOP_BYTECONST, 0);}
    183     | ',' ByteConstExpr             {$$ = $2;}
    184     ;
    185 
    186 OptionalAccessTypeKeyword   /* Default: AnyAcc */
    187     :                               {$$ = TrCreateLeafOp (
    188                                         PARSEOP_ACCESSTYPE_ANY);}
    189     | ','                           {$$ = TrCreateLeafOp (
    190                                         PARSEOP_ACCESSTYPE_ANY);}
    191     | ',' AccessTypeKeyword         {$$ = $2;}
    192     ;
    193 
    194 OptionalAddressingMode
    195     : ','                           {$$ = NULL;}
    196     | ',' AddressingModeKeyword     {$$ = $2;}
    197     ;
    198 
    199 OptionalAddressRange
    200     :                               {$$ = NULL;}
    201     | ','                           {$$ = NULL;}
    202     | ',' AddressKeyword            {$$ = $2;}
    203     ;
    204 
    205 OptionalBitsPerByte
    206     : ','                           {$$ = NULL;}
    207     | ',' BitsPerByteKeyword        {$$ = $2;}
    208     ;
    209 
    210 OptionalBuffer_Last
    211     :                               {$$ = NULL;}
    212     | ','                           {$$ = NULL;}
    213     | ',' RawDataBufferTerm         {$$ = $2;}
    214     ;
    215 
    216 OptionalByteConstExpr
    217     :                               {$$ = NULL;}
    218     | ','                           {$$ = NULL;}
    219     | ',' ByteConstExpr             {$$ = $2;}
    220     ;
    221 
    222 OptionalDecodeType
    223     : ','                           {$$ = NULL;}
    224     | ',' DecodeKeyword             {$$ = $2;}
    225     ;
    226 
    227 OptionalDevicePolarity
    228     : ','                           {$$ = NULL;}
    229     | ',' DevicePolarityKeyword     {$$ = $2;}
    230     ;
    231 
    232 OptionalDWordConstExpr
    233     :                               {$$ = NULL;}
    234     | ','                           {$$ = NULL;}
    235     | ',' DWordConstExpr            {$$ = $2;}
    236     ;
    237 
    238 OptionalEndian
    239     : ','                           {$$ = NULL;}
    240     | ',' EndianKeyword             {$$ = $2;}
    241     ;
    242 
    243 OptionalFlowControl
    244     : ','                           {$$ = NULL;}
    245     | ',' FlowControlKeyword        {$$ = $2;}
    246     ;
    247 
    248 OptionalIoRestriction
    249     : ','                           {$$ = NULL;}
    250     | ',' IoRestrictionKeyword      {$$ = $2;}
    251     ;
    252 
    253 OptionalListString
    254     :                               {$$ = TrCreateValuedLeafOp (
    255                                         PARSEOP_STRING_LITERAL,
    256                                         ACPI_TO_INTEGER (""));}   /* Placeholder is a NULL string */
    257     | ','                           {$$ = TrCreateValuedLeafOp (
    258                                         PARSEOP_STRING_LITERAL,
    259                                         ACPI_TO_INTEGER (""));}   /* Placeholder is a NULL string */
    260     | ',' TermArg                   {$$ = $2;}
    261     ;
    262 
    263 OptionalLockRuleKeyword     /* Default: NoLock */
    264     :                               {$$ = TrCreateLeafOp (
    265                                         PARSEOP_LOCKRULE_NOLOCK);}
    266     | ','                           {$$ = TrCreateLeafOp (
    267                                         PARSEOP_LOCKRULE_NOLOCK);}
    268     | ',' LockRuleKeyword           {$$ = $2;}
    269     ;
    270 
    271 OptionalMaxType
    272     : ','                           {$$ = NULL;}
    273     | ',' MaxKeyword                {$$ = $2;}
    274     ;
    275 
    276 OptionalMemType
    277     : ','                           {$$ = NULL;}
    278     | ',' MemTypeKeyword            {$$ = $2;}
    279     ;
    280 
    281 OptionalMinType
    282     : ','                           {$$ = NULL;}
    283     | ',' MinKeyword                {$$ = $2;}
    284     ;
    285 
    286 OptionalNameString
    287     :                               {$$ = NULL;}
    288     | ','                           {$$ = NULL;}
    289     | ',' NameString                {$$ = $2;}
    290     ;
    291 
    292 OptionalNameString_Last
    293     :                               {$$ = NULL;}
    294     | ','                           {$$ = NULL;}
    295     | ',' NameString                {$$ = $2;}
    296     ;
    297 
    298 OptionalNameString_First
    299     :                               {$$ = TrCreateLeafOp (
    300                                         PARSEOP_ZERO);}
    301     | NameString                    {$$ = $1;}
    302     ;
    303 
    304 OptionalObjectTypeKeyword
    305     :                               {$$ = TrCreateLeafOp (
    306                                         PARSEOP_OBJECTTYPE_UNK);}
    307     | ',' ObjectTypeKeyword         {$$ = $2;}
    308     ;
    309 
    310 OptionalParityType
    311     : ','                           {$$ = NULL;}
    312     | ',' ParityTypeKeyword         {$$ = $2;}
    313     ;
    314 
    315 OptionalQWordConstExpr
    316     :                               {$$ = NULL;}
    317     | ','                           {$$ = NULL;}
    318     | ',' QWordConstExpr            {$$ = $2;}
    319     ;
    320 
    321 OptionalRangeType
    322     : ','                           {$$ = NULL;}
    323     | ',' RangeTypeKeyword          {$$ = $2;}
    324     ;
    325 
    326 OptionalReadWriteKeyword
    327     :                                   {$$ = TrCreateLeafOp (
    328                                             PARSEOP_READWRITETYPE_BOTH);}
    329     | PARSEOP_READWRITETYPE_BOTH        {$$ = TrCreateLeafOp (
    330                                             PARSEOP_READWRITETYPE_BOTH);}
    331     | PARSEOP_READWRITETYPE_READONLY    {$$ = TrCreateLeafOp (
    332                                             PARSEOP_READWRITETYPE_READONLY);}
    333     ;
    334 
    335 OptionalResourceType_First
    336     :                               {$$ = TrCreateLeafOp (
    337                                         PARSEOP_RESOURCETYPE_CONSUMER);}
    338     | ResourceTypeKeyword           {$$ = $1;}
    339     ;
    340 
    341 OptionalResourceType
    342     :                               {$$ = TrCreateLeafOp (
    343                                         PARSEOP_RESOURCETYPE_CONSUMER);}
    344     | ','                           {$$ = TrCreateLeafOp (
    345                                         PARSEOP_RESOURCETYPE_CONSUMER);}
    346     | ',' ResourceTypeKeyword       {$$ = $2;}
    347     ;
    348 
    349 /* Same as above except default is producer */
    350 OptionalProducerResourceType
    351     :                               {$$ = TrCreateLeafOp (
    352                                         PARSEOP_RESOURCETYPE_PRODUCER);}
    353     | ','                           {$$ = TrCreateLeafOp (
    354                                         PARSEOP_RESOURCETYPE_PRODUCER);}
    355     | ',' ResourceTypeKeyword       {$$ = $2;}
    356     ;
    357 
    358 OptionalSlaveMode
    359     : ','                           {$$ = NULL;}
    360     | ',' SlaveModeKeyword          {$$ = $2;}
    361     ;
    362 
    363 OptionalSlaveMode_First
    364     :                               {$$ = NULL;}
    365     | SlaveModeKeyword              {$$ = $1;}
    366     ;
    367 
    368 OptionalShareType
    369     :                               {$$ = NULL;}
    370     | ','                           {$$ = NULL;}
    371     | ',' ShareTypeKeyword          {$$ = $2;}
    372     ;
    373 
    374 OptionalShareType_First
    375     :                               {$$ = NULL;}
    376     | ShareTypeKeyword              {$$ = $1;}
    377     ;
    378 
    379 OptionalStopBits
    380     : ','                           {$$ = NULL;}
    381     | ',' StopBitsKeyword           {$$ = $2;}
    382     ;
    383 
    384 OptionalStringData
    385     :                               {$$ = NULL;}
    386     | ','                           {$$ = NULL;}
    387     | ',' StringData                {$$ = $2;}
    388     ;
    389 
    390 OptionalSyncLevel           /* Default: 0 */
    391     :                               {$$ = TrCreateValuedLeafOp (
    392                                         PARSEOP_BYTECONST, 0);}
    393     | ','                           {$$ = TrCreateValuedLeafOp (
    394                                         PARSEOP_BYTECONST, 0);}
    395     | ',' ByteConstExpr             {$$ = $2;}
    396     ;
    397 
    398 OptionalTranslationType_Last
    399     :                               {$$ = NULL;}
    400     | ','                           {$$ = NULL;}
    401     | ',' TranslationKeyword        {$$ = $2;}
    402     ;
    403 
    404 OptionalType
    405     :                               {$$ = NULL;}
    406     | ','                           {$$ = NULL;}
    407     | ',' TypeKeyword               {$$ = $2;}
    408     ;
    409 
    410 OptionalType_Last
    411     :                               {$$ = NULL;}
    412     | ','                           {$$ = NULL;}
    413     | ',' TypeKeyword               {$$ = $2;}
    414     ;
    415 
    416 OptionalUpdateRuleKeyword   /* Default: Preserve */
    417     :                               {$$ = TrCreateLeafOp (
    418                                         PARSEOP_UPDATERULE_PRESERVE);}
    419     | ','                           {$$ = TrCreateLeafOp (
    420                                         PARSEOP_UPDATERULE_PRESERVE);}
    421     | ',' UpdateRuleKeyword         {$$ = $2;}
    422     ;
    423 
    424 OptionalWireMode
    425     : ','                           {$$ = NULL;}
    426     | ',' WireModeKeyword           {$$ = $2;}
    427     ;
    428 
    429 OptionalWordConstExpr
    430     : ','                           {$$ = NULL;}
    431     | ',' WordConstExpr             {$$ = $2;}
    432     ;
    433 
    434 OptionalXferSize
    435     :                               {$$ = TrCreateValuedLeafOp (
    436                                         PARSEOP_XFERSIZE_32, 2);}
    437     | ','                           {$$ = TrCreateValuedLeafOp (
    438                                         PARSEOP_XFERSIZE_32, 2);}
    439     | ',' XferSizeKeyword           {$$ = $2;}
    440     ;
    441