Home | History | Annotate | Line # | Download | only in include 
      1 /******************************************************************************
      2  *
      3  * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
      4  *
      5  *****************************************************************************/
      6 
      7 /******************************************************************************
      8  *
      9  * 1. Copyright Notice
     10  *
     11  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     12  * All rights reserved.
     13  *
     14  * 2. License
     15  *
     16  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  * rights. You may have additional license terms from the party that provided
     18  * you this software, covering your right to use that party's intellectual
     19  * property rights.
     20  *
     21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  * copy of the source code appearing in this file ("Covered Code") an
     23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  * make derivatives, distribute, use and display any portion of the Covered
     26  * Code in any form, with the right to sublicense such rights; and
     27  *
     28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  * license (with the right to sublicense), under only those claims of Intel
     30  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  * offer to sell, and import the Covered Code and derivative works thereof
     32  * solely to the minimum extent necessary to exercise the above copyright
     33  * license, and in no event shall the patent license extend to any additions
     34  * to or modifications of the Original Intel Code. No other license or right
     35  * is granted directly or by implication, estoppel or otherwise;
     36  *
     37  * The above copyright and patent license is granted only if the following
     38  * conditions are met:
     39  *
     40  * 3. Conditions
     41  *
     42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  * Redistribution of source code of any substantial portion of the Covered
     44  * Code or modification with rights to further distribute source must include
     45  * the above Copyright Notice, the above License, this list of Conditions,
     46  * and the following Disclaimer and Export Compliance provision. In addition,
     47  * Licensee must cause all Covered Code to which Licensee contributes to
     48  * contain a file documenting the changes Licensee made to create that Covered
     49  * Code and the date of any change. Licensee must include in that file the
     50  * documentation of any changes made by any predecessor Licensee. Licensee
     51  * must include a prominent statement that the modification is derived,
     52  * directly or indirectly, from Original Intel Code.
     53  *
     54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  * Redistribution of source code of any substantial portion of the Covered
     56  * Code or modification without rights to further distribute source must
     57  * include the following Disclaimer and Export Compliance provision in the
     58  * documentation and/or other materials provided with distribution. In
     59  * addition, Licensee may not authorize further sublicense of source of any
     60  * portion of the Covered Code, and must include terms to the effect that the
     61  * license from Licensee to its licensee is limited to the intellectual
     62  * property embodied in the software Licensee provides to its licensee, and
     63  * not to intellectual property embodied in modifications its licensee may
     64  * make.
     65  *
     66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  * substantial portion of the Covered Code or modification must reproduce the
     68  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  * provision in the documentation and/or other materials provided with the
     70  * distribution.
     71  *
     72  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  * Intel Code.
     74  *
     75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  * other dealings in products derived from or relating to the Covered Code
     78  * without prior written authorization from Intel.
     79  *
     80  * 4. Disclaimer and Export Compliance
     81  *
     82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  * PARTICULAR PURPOSE.
     89  *
     90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  * LIMITED REMEDY.
     98  *
     99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  * software or system incorporating such software without first obtaining any
    101  * required license or other approval from the U. S. Department of Commerce or
    102  * any other agency or department of the United States Government. In the
    103  * event Licensee exports any such software from the United States or
    104  * re-exports any such software from a foreign destination, Licensee shall
    105  * ensure that the distribution and export/re-export of the software is in
    106  * compliance with all laws, regulations, orders, or other restrictions of the
    107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  * any of its subsidiaries will export/re-export any technical data, process,
    109  * software, or service, directly or indirectly, to any country for which the
    110  * United States government or any agency thereof requires an export license,
    111  * other governmental approval, or letter of assurance, without first obtaining
    112  * such license, approval or letter.
    113  *
    114  *****************************************************************************
    115  *
    116  * Alternatively, you may choose to be licensed under the terms of the
    117  * following license:
    118  *
    119  * Redistribution and use in source and binary forms, with or without
    120  * modification, are permitted provided that the following conditions
    121  * are met:
    122  * 1. Redistributions of source code must retain the above copyright
    123  *    notice, this list of conditions, and the following disclaimer,
    124  *    without modification.
    125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126  *    substantially similar to the "NO WARRANTY" disclaimer below
    127  *    ("Disclaimer") and any redistribution must be conditioned upon
    128  *    including a substantially similar Disclaimer requirement for further
    129  *    binary redistribution.
    130  * 3. Neither the names of the above-listed copyright holders nor the names
    131  *    of any contributors may be used to endorse or promote products derived
    132  *    from this software without specific prior written permission.
    133  *
    134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  *
    146  * Alternatively, you may choose to be licensed under the terms of the
    147  * GNU General Public License ("GPL") version 2 as published by the Free
    148  * Software Foundation.
    149  *
    150  *****************************************************************************/
    151 
    152 #ifndef __ACPARSER_H__
    153 #define __ACPARSER_H__
    154 
    155 
    156 #define OP_HAS_RETURN_VALUE             1
    157 
    158 /* Variable number of arguments. This field must be 32 bits */
    159 
    160 #define ACPI_VAR_ARGS                   ACPI_UINT32_MAX
    161 
    162 
    163 #define ACPI_PARSE_DELETE_TREE          0x0001
    164 #define ACPI_PARSE_NO_TREE_DELETE       0x0000
    165 #define ACPI_PARSE_TREE_MASK            0x0001
    166 
    167 #define ACPI_PARSE_LOAD_PASS1           0x0010
    168 #define ACPI_PARSE_LOAD_PASS2           0x0020
    169 #define ACPI_PARSE_EXECUTE              0x0030
    170 #define ACPI_PARSE_MODE_MASK            0x0030
    171 
    172 #define ACPI_PARSE_DEFERRED_OP          0x0100
    173 #define ACPI_PARSE_DISASSEMBLE          0x0200
    174 
    175 #define ACPI_PARSE_MODULE_LEVEL         0x0400
    176 
    177 /******************************************************************************
    178  *
    179  * Parser interfaces
    180  *
    181  *****************************************************************************/
    182 
    183 extern const UINT8      AcpiGbl_ShortOpIndex[];
    184 extern const UINT8      AcpiGbl_LongOpIndex[];
    185 
    186 
    187 /*
    188  * psxface - Parser external interfaces
    189  */
    190 ACPI_STATUS
    191 AcpiPsExecuteMethod (
    192     ACPI_EVALUATE_INFO      *Info);
    193 
    194 ACPI_STATUS
    195 AcpiPsExecuteTable (
    196     ACPI_EVALUATE_INFO      *Info);
    197 
    198 
    199 /*
    200  * psargs - Parse AML opcode arguments
    201  */
    202 UINT8 *
    203 AcpiPsGetNextPackageEnd (
    204     ACPI_PARSE_STATE        *ParserState);
    205 
    206 char *
    207 AcpiPsGetNextNamestring (
    208     ACPI_PARSE_STATE        *ParserState);
    209 
    210 void
    211 AcpiPsGetNextSimpleArg (
    212     ACPI_PARSE_STATE        *ParserState,
    213     UINT32                  ArgType,
    214     ACPI_PARSE_OBJECT       *Arg);
    215 
    216 ACPI_STATUS
    217 AcpiPsGetNextNamepath (
    218     ACPI_WALK_STATE         *WalkState,
    219     ACPI_PARSE_STATE        *ParserState,
    220     ACPI_PARSE_OBJECT       *Arg,
    221     BOOLEAN                 PossibleMethodCall);
    222 
    223 /* Values for BOOLEAN above */
    224 
    225 #define ACPI_NOT_METHOD_CALL            FALSE
    226 #define ACPI_POSSIBLE_METHOD_CALL       TRUE
    227 
    228 ACPI_STATUS
    229 AcpiPsGetNextArg (
    230     ACPI_WALK_STATE         *WalkState,
    231     ACPI_PARSE_STATE        *ParserState,
    232     UINT32                  ArgType,
    233     ACPI_PARSE_OBJECT       **ReturnArg);
    234 
    235 
    236 /*
    237  * psfind
    238  */
    239 ACPI_PARSE_OBJECT *
    240 AcpiPsFindName (
    241     ACPI_PARSE_OBJECT       *Scope,
    242     UINT32                  Name,
    243     UINT32                  Opcode);
    244 
    245 ACPI_PARSE_OBJECT*
    246 AcpiPsGetParent (
    247     ACPI_PARSE_OBJECT       *Op);
    248 
    249 
    250 /*
    251  * psobject - support for parse object processing
    252  */
    253 ACPI_STATUS
    254 AcpiPsBuildNamedOp (
    255     ACPI_WALK_STATE         *WalkState,
    256     UINT8                   *AmlOpStart,
    257     ACPI_PARSE_OBJECT       *UnnamedOp,
    258     ACPI_PARSE_OBJECT       **Op);
    259 
    260 ACPI_STATUS
    261 AcpiPsCreateOp (
    262     ACPI_WALK_STATE         *WalkState,
    263     UINT8                   *AmlOpStart,
    264     ACPI_PARSE_OBJECT       **NewOp);
    265 
    266 ACPI_STATUS
    267 AcpiPsCompleteOp (
    268     ACPI_WALK_STATE         *WalkState,
    269     ACPI_PARSE_OBJECT       **Op,
    270     ACPI_STATUS             Status);
    271 
    272 ACPI_STATUS
    273 AcpiPsCompleteFinalOp (
    274     ACPI_WALK_STATE         *WalkState,
    275     ACPI_PARSE_OBJECT       *Op,
    276     ACPI_STATUS             Status);
    277 
    278 
    279 /*
    280  * psopinfo - AML Opcode information
    281  */
    282 const ACPI_OPCODE_INFO *
    283 AcpiPsGetOpcodeInfo (
    284     UINT16                  Opcode);
    285 
    286 const char *
    287 AcpiPsGetOpcodeName (
    288     UINT16                  Opcode);
    289 
    290 UINT8
    291 AcpiPsGetArgumentCount (
    292     UINT32                  OpType);
    293 
    294 
    295 /*
    296  * psparse - top level parsing routines
    297  */
    298 ACPI_STATUS
    299 AcpiPsParseAml (
    300     ACPI_WALK_STATE         *WalkState);
    301 
    302 UINT32
    303 AcpiPsGetOpcodeSize (
    304     UINT32                  Opcode);
    305 
    306 UINT16
    307 AcpiPsPeekOpcode (
    308     ACPI_PARSE_STATE        *state);
    309 
    310 ACPI_STATUS
    311 AcpiPsCompleteThisOp (
    312     ACPI_WALK_STATE         *WalkState,
    313     ACPI_PARSE_OBJECT       *Op);
    314 
    315 ACPI_STATUS
    316 AcpiPsNextParseState (
    317     ACPI_WALK_STATE         *WalkState,
    318     ACPI_PARSE_OBJECT       *Op,
    319     ACPI_STATUS             CallbackStatus);
    320 
    321 
    322 /*
    323  * psloop - main parse loop
    324  */
    325 ACPI_STATUS
    326 AcpiPsParseLoop (
    327     ACPI_WALK_STATE         *WalkState);
    328 
    329 
    330 /*
    331  * psscope - Scope stack management routines
    332  */
    333 ACPI_STATUS
    334 AcpiPsInitScope (
    335     ACPI_PARSE_STATE        *ParserState,
    336     ACPI_PARSE_OBJECT       *Root);
    337 
    338 ACPI_PARSE_OBJECT *
    339 AcpiPsGetParentScope (
    340     ACPI_PARSE_STATE        *state);
    341 
    342 BOOLEAN
    343 AcpiPsHasCompletedScope (
    344     ACPI_PARSE_STATE        *ParserState);
    345 
    346 void
    347 AcpiPsPopScope (
    348     ACPI_PARSE_STATE        *ParserState,
    349     ACPI_PARSE_OBJECT       **Op,
    350     UINT32                  *ArgList,
    351     UINT32                  *ArgCount);
    352 
    353 ACPI_STATUS
    354 AcpiPsPushScope (
    355     ACPI_PARSE_STATE        *ParserState,
    356     ACPI_PARSE_OBJECT       *Op,
    357     UINT32                  RemainingArgs,
    358     UINT32                  ArgCount);
    359 
    360 void
    361 AcpiPsCleanupScope (
    362     ACPI_PARSE_STATE        *state);
    363 
    364 
    365 /*
    366  * pstree - parse tree manipulation routines
    367  */
    368 void
    369 AcpiPsAppendArg(
    370     ACPI_PARSE_OBJECT       *op,
    371     ACPI_PARSE_OBJECT       *arg);
    372 
    373 ACPI_PARSE_OBJECT*
    374 AcpiPsFind (
    375     ACPI_PARSE_OBJECT       *Scope,
    376     char                    *Path,
    377     UINT16                  Opcode,
    378     UINT32                  Create);
    379 
    380 ACPI_PARSE_OBJECT *
    381 AcpiPsGetArg(
    382     ACPI_PARSE_OBJECT       *op,
    383     UINT32                   argn);
    384 
    385 ACPI_PARSE_OBJECT *
    386 AcpiPsGetDepthNext (
    387     ACPI_PARSE_OBJECT       *Origin,
    388     ACPI_PARSE_OBJECT       *Op);
    389 
    390 
    391 /*
    392  * pswalk - parse tree walk routines
    393  */
    394 ACPI_STATUS
    395 AcpiPsWalkParsedAml (
    396     ACPI_PARSE_OBJECT       *StartOp,
    397     ACPI_PARSE_OBJECT       *EndOp,
    398     ACPI_OPERAND_OBJECT     *MthDesc,
    399     ACPI_NAMESPACE_NODE     *StartNode,
    400     ACPI_OPERAND_OBJECT     **Params,
    401     ACPI_OPERAND_OBJECT     **CallerReturnDesc,
    402     ACPI_OWNER_ID           OwnerId,
    403     ACPI_PARSE_DOWNWARDS    DescendingCallback,
    404     ACPI_PARSE_UPWARDS      AscendingCallback);
    405 
    406 ACPI_STATUS
    407 AcpiPsGetNextWalkOp (
    408     ACPI_WALK_STATE         *WalkState,
    409     ACPI_PARSE_OBJECT       *Op,
    410     ACPI_PARSE_UPWARDS      AscendingCallback);
    411 
    412 ACPI_STATUS
    413 AcpiPsDeleteCompletedOp (
    414     ACPI_WALK_STATE         *WalkState);
    415 
    416 void
    417 AcpiPsDeleteParseTree (
    418     ACPI_PARSE_OBJECT       *root);
    419 
    420 
    421 /*
    422  * psutils - parser utilities
    423  */
    424 ACPI_PARSE_OBJECT *
    425 AcpiPsCreateScopeOp (
    426     UINT8                   *Aml);
    427 
    428 void
    429 AcpiPsInitOp (
    430     ACPI_PARSE_OBJECT       *op,
    431     UINT16                  opcode);
    432 
    433 ACPI_PARSE_OBJECT *
    434 AcpiPsAllocOp (
    435     UINT16                  Opcode,
    436     UINT8                   *Aml);
    437 
    438 void
    439 AcpiPsFreeOp (
    440     ACPI_PARSE_OBJECT       *Op);
    441 
    442 BOOLEAN
    443 AcpiPsIsLeadingChar (
    444     UINT32                  c);
    445 
    446 UINT32
    447 AcpiPsGetName(
    448     ACPI_PARSE_OBJECT       *op);
    449 
    450 void
    451 AcpiPsSetName(
    452     ACPI_PARSE_OBJECT       *op,
    453     UINT32                  name);
    454 
    455 
    456 /*
    457  * psdump - display parser tree
    458  */
    459 UINT32
    460 AcpiPsSprintPath (
    461     char                    *BufferStart,
    462     UINT32                  BufferSize,
    463     ACPI_PARSE_OBJECT       *Op);
    464 
    465 UINT32
    466 AcpiPsSprintOp (
    467     char                    *BufferStart,
    468     UINT32                  BufferSize,
    469     ACPI_PARSE_OBJECT       *Op);
    470 
    471 void
    472 AcpiPsShow (
    473     ACPI_PARSE_OBJECT       *op);
    474 
    475 
    476 #endif /* __ACPARSER_H__ */
    477