acpi/acpica/acparser.h

0001 /******************************************************************************
0002  *
0003  * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #ifndef __ACPARSER_H__
0153 #define __ACPARSER_H__
0154
0155
0156 #define OP_HAS_RETURN_VALUE             1
0157
0158 /* Variable number of arguments. This field must be 32 bits */
0159
0160 #define ACPI_VAR_ARGS                   ACPI_UINT32_MAX
0161
0162
0163 #define ACPI_PARSE_DELETE_TREE          0x0001
0164 #define ACPI_PARSE_NO_TREE_DELETE       0x0000
0165 #define ACPI_PARSE_TREE_MASK            0x0001
0166
0167 #define ACPI_PARSE_LOAD_PASS1           0x0010
0168 #define ACPI_PARSE_LOAD_PASS2           0x0020
0169 #define ACPI_PARSE_EXECUTE              0x0030
0170 #define ACPI_PARSE_MODE_MASK            0x0030
0171
0172 #define ACPI_PARSE_DEFERRED_OP          0x0100
0173 #define ACPI_PARSE_DISASSEMBLE          0x0200
0174
0175 #define ACPI_PARSE_MODULE_LEVEL         0x0400
0176
0177 /******************************************************************************
0178  *
0179  * Parser interfaces
0180  *
0181  *****************************************************************************/
0182
0183 extern const UINT8      AcpiGbl_ShortOpIndex[];
0184 extern const UINT8      AcpiGbl_LongOpIndex[];
0185
0186
0187 /*
0188  * psxface - Parser external interfaces
0189  */
0190 ACPI_STATUS
0191 AcpiPsExecuteMethod (
0192     ACPI_EVALUATE_INFO      *Info);
0193
0194 ACPI_STATUS
0195 AcpiPsExecuteTable (
0196     ACPI_EVALUATE_INFO      *Info);
0197
0198
0199 /*
0200  * psargs - Parse AML opcode arguments
0201  */
0202 UINT8 *
0203 AcpiPsGetNextPackageEnd (
0204     ACPI_PARSE_STATE        *ParserState);
0205
0206 char *
0207 AcpiPsGetNextNamestring (
0208     ACPI_PARSE_STATE        *ParserState);
0209
0210 void
0211 AcpiPsGetNextSimpleArg (
0212     ACPI_PARSE_STATE        *ParserState,
0213     UINT32                  ArgType,
0214     ACPI_PARSE_OBJECT       *Arg);
0215
0216 ACPI_STATUS
0217 AcpiPsGetNextNamepath (
0218     ACPI_WALK_STATE         *WalkState,
0219     ACPI_PARSE_STATE        *ParserState,
0220     ACPI_PARSE_OBJECT       *Arg,
0221     BOOLEAN                 PossibleMethodCall);
0222
0223 /* Values for BOOLEAN above */
0224
0225 #define ACPI_NOT_METHOD_CALL            FALSE
0226 #define ACPI_POSSIBLE_METHOD_CALL       TRUE
0227
0228 ACPI_STATUS
0229 AcpiPsGetNextArg (
0230     ACPI_WALK_STATE         *WalkState,
0231     ACPI_PARSE_STATE        *ParserState,
0232     UINT32                  ArgType,
0233     ACPI_PARSE_OBJECT       **ReturnArg);
0234
0235
0236 /*
0237  * psfind
0238  */
0239 ACPI_PARSE_OBJECT *
0240 AcpiPsFindName (
0241     ACPI_PARSE_OBJECT       *Scope,
0242     UINT32                  Name,
0243     UINT32                  Opcode);
0244
0245 ACPI_PARSE_OBJECT*
0246 AcpiPsGetParent (
0247     ACPI_PARSE_OBJECT       *Op);
0248
0249
0250 /*
0251  * psobject - support for parse object processing
0252  */
0253 ACPI_STATUS
0254 AcpiPsBuildNamedOp (
0255     ACPI_WALK_STATE         *WalkState,
0256     UINT8                   *AmlOpStart,
0257     ACPI_PARSE_OBJECT       *UnnamedOp,
0258     ACPI_PARSE_OBJECT       **Op);
0259
0260 ACPI_STATUS
0261 AcpiPsCreateOp (
0262     ACPI_WALK_STATE         *WalkState,
0263     UINT8                   *AmlOpStart,
0264     ACPI_PARSE_OBJECT       **NewOp);
0265
0266 ACPI_STATUS
0267 AcpiPsCompleteOp (
0268     ACPI_WALK_STATE         *WalkState,
0269     ACPI_PARSE_OBJECT       **Op,
0270     ACPI_STATUS             Status);
0271
0272 ACPI_STATUS
0273 AcpiPsCompleteFinalOp (
0274     ACPI_WALK_STATE         *WalkState,
0275     ACPI_PARSE_OBJECT       *Op,
0276     ACPI_STATUS             Status);
0277
0278
0279 /*
0280  * psopinfo - AML Opcode information
0281  */
0282 const ACPI_OPCODE_INFO *
0283 AcpiPsGetOpcodeInfo (
0284     UINT16                  Opcode);
0285
0286 const char *
0287 AcpiPsGetOpcodeName (
0288     UINT16                  Opcode);
0289
0290 UINT8
0291 AcpiPsGetArgumentCount (
0292     UINT32                  OpType);
0293
0294
0295 /*
0296  * psparse - top level parsing routines
0297  */
0298 ACPI_STATUS
0299 AcpiPsParseAml (
0300     ACPI_WALK_STATE         *WalkState);
0301
0302 UINT32
0303 AcpiPsGetOpcodeSize (
0304     UINT32                  Opcode);
0305
0306 UINT16
0307 AcpiPsPeekOpcode (
0308     ACPI_PARSE_STATE        *state);
0309
0310 ACPI_STATUS
0311 AcpiPsCompleteThisOp (
0312     ACPI_WALK_STATE         *WalkState,
0313     ACPI_PARSE_OBJECT       *Op);
0314
0315 ACPI_STATUS
0316 AcpiPsNextParseState (
0317     ACPI_WALK_STATE         *WalkState,
0318     ACPI_PARSE_OBJECT       *Op,
0319     ACPI_STATUS             CallbackStatus);
0320
0321
0322 /*
0323  * psloop - main parse loop
0324  */
0325 ACPI_STATUS
0326 AcpiPsParseLoop (
0327     ACPI_WALK_STATE         *WalkState);
0328
0329
0330 /*
0331  * psscope - Scope stack management routines
0332  */
0333 ACPI_STATUS
0334 AcpiPsInitScope (
0335     ACPI_PARSE_STATE        *ParserState,
0336     ACPI_PARSE_OBJECT       *Root);
0337
0338 ACPI_PARSE_OBJECT *
0339 AcpiPsGetParentScope (
0340     ACPI_PARSE_STATE        *state);
0341
0342 BOOLEAN
0343 AcpiPsHasCompletedScope (
0344     ACPI_PARSE_STATE        *ParserState);
0345
0346 void
0347 AcpiPsPopScope (
0348     ACPI_PARSE_STATE        *ParserState,
0349     ACPI_PARSE_OBJECT       **Op,
0350     UINT32                  *ArgList,
0351     UINT32                  *ArgCount);
0352
0353 ACPI_STATUS
0354 AcpiPsPushScope (
0355     ACPI_PARSE_STATE        *ParserState,
0356     ACPI_PARSE_OBJECT       *Op,
0357     UINT32                  RemainingArgs,
0358     UINT32                  ArgCount);
0359
0360 void
0361 AcpiPsCleanupScope (
0362     ACPI_PARSE_STATE        *state);
0363
0364
0365 /*
0366  * pstree - parse tree manipulation routines
0367  */
0368 void
0369 AcpiPsAppendArg(
0370     ACPI_PARSE_OBJECT       *op,
0371     ACPI_PARSE_OBJECT       *arg);
0372
0373 ACPI_PARSE_OBJECT*
0374 AcpiPsFind (
0375     ACPI_PARSE_OBJECT       *Scope,
0376     char                    *Path,
0377     UINT16                  Opcode,
0378     UINT32                  Create);
0379
0380 ACPI_PARSE_OBJECT *
0381 AcpiPsGetArg(
0382     ACPI_PARSE_OBJECT       *op,
0383     UINT32                   argn);
0384
0385 ACPI_PARSE_OBJECT *
0386 AcpiPsGetDepthNext (
0387     ACPI_PARSE_OBJECT       *Origin,
0388     ACPI_PARSE_OBJECT       *Op);
0389
0390
0391 /*
0392  * pswalk - parse tree walk routines
0393  */
0394 ACPI_STATUS
0395 AcpiPsWalkParsedAml (
0396     ACPI_PARSE_OBJECT       *StartOp,
0397     ACPI_PARSE_OBJECT       *EndOp,
0398     ACPI_OPERAND_OBJECT     *MthDesc,
0399     ACPI_NAMESPACE_NODE     *StartNode,
0400     ACPI_OPERAND_OBJECT     **Params,
0401     ACPI_OPERAND_OBJECT     **CallerReturnDesc,
0402     ACPI_OWNER_ID           OwnerId,
0403     ACPI_PARSE_DOWNWARDS    DescendingCallback,
0404     ACPI_PARSE_UPWARDS      AscendingCallback);
0405
0406 ACPI_STATUS
0407 AcpiPsGetNextWalkOp (
0408     ACPI_WALK_STATE         *WalkState,
0409     ACPI_PARSE_OBJECT       *Op,
0410     ACPI_PARSE_UPWARDS      AscendingCallback);
0411
0412 ACPI_STATUS
0413 AcpiPsDeleteCompletedOp (
0414     ACPI_WALK_STATE         *WalkState);
0415
0416 void
0417 AcpiPsDeleteParseTree (
0418     ACPI_PARSE_OBJECT       *root);
0419
0420
0421 /*
0422  * psutils - parser utilities
0423  */
0424 ACPI_PARSE_OBJECT *
0425 AcpiPsCreateScopeOp (
0426     UINT8                   *Aml);
0427
0428 void
0429 AcpiPsInitOp (
0430     ACPI_PARSE_OBJECT       *op,
0431     UINT16                  opcode);
0432
0433 ACPI_PARSE_OBJECT *
0434 AcpiPsAllocOp (
0435     UINT16                  Opcode,
0436     UINT8                   *Aml);
0437
0438 void
0439 AcpiPsFreeOp (
0440     ACPI_PARSE_OBJECT       *Op);
0441
0442 BOOLEAN
0443 AcpiPsIsLeadingChar (
0444     UINT32                  c);
0445
0446 UINT32
0447 AcpiPsGetName(
0448     ACPI_PARSE_OBJECT       *op);
0449
0450 void
0451 AcpiPsSetName(
0452     ACPI_PARSE_OBJECT       *op,
0453     UINT32                  name);
0454
0455
0456 /*
0457  * psdump - display parser tree
0458  */
0459 UINT32
0460 AcpiPsSprintPath (
0461     char                    *BufferStart,
0462     UINT32                  BufferSize,
0463     ACPI_PARSE_OBJECT       *Op);
0464
0465 UINT32
0466 AcpiPsSprintOp (
0467     char                    *BufferStart,
0468     UINT32                  BufferSize,
0469     ACPI_PARSE_OBJECT       *Op);
0470
0471 void
0472 AcpiPsShow (
0473     ACPI_PARSE_OBJECT       *op);
0474
0475
0476 #endif /* __ACPARSER_H__ */