drivers/acpi/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 - 2009, 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
0117 #ifndef __ACPARSER_H__
0118 #define __ACPARSER_H__
0119
0120
0121 #define OP_HAS_RETURN_VALUE             1
0122
0123 /* Variable number of arguments. This field must be 32 bits */
0124
0125 #define ACPI_VAR_ARGS                   ACPI_UINT32_MAX
0126
0127
0128 #define ACPI_PARSE_DELETE_TREE          0x0001
0129 #define ACPI_PARSE_NO_TREE_DELETE       0x0000
0130 #define ACPI_PARSE_TREE_MASK            0x0001
0131
0132 #define ACPI_PARSE_LOAD_PASS1           0x0010
0133 #define ACPI_PARSE_LOAD_PASS2           0x0020
0134 #define ACPI_PARSE_EXECUTE              0x0030
0135 #define ACPI_PARSE_MODE_MASK            0x0030
0136
0137 #define ACPI_PARSE_DEFERRED_OP          0x0100
0138 #define ACPI_PARSE_DISASSEMBLE          0x0200
0139
0140
0141 /******************************************************************************
0142  *
0143  * Parser interfaces
0144  *
0145  *****************************************************************************/
0146
0147
0148 /*
0149  * psxface - Parser external interfaces
0150  */
0151 ACPI_STATUS
0152 AcpiPsExecuteMethod (
0153     ACPI_EVALUATE_INFO      *Info);
0154
0155
0156 /*
0157  * psargs - Parse AML opcode arguments
0158  */
0159 UINT8 *
0160 AcpiPsGetNextPackageEnd (
0161     ACPI_PARSE_STATE        *ParserState);
0162
0163 char *
0164 AcpiPsGetNextNamestring (
0165     ACPI_PARSE_STATE        *ParserState);
0166
0167 void
0168 AcpiPsGetNextSimpleArg (
0169     ACPI_PARSE_STATE        *ParserState,
0170     UINT32                  ArgType,
0171     ACPI_PARSE_OBJECT       *Arg);
0172
0173 ACPI_STATUS
0174 AcpiPsGetNextNamepath (
0175     ACPI_WALK_STATE         *WalkState,
0176     ACPI_PARSE_STATE        *ParserState,
0177     ACPI_PARSE_OBJECT       *Arg,
0178     BOOLEAN                 MethodCall);
0179
0180 ACPI_STATUS
0181 AcpiPsGetNextArg (
0182     ACPI_WALK_STATE         *WalkState,
0183     ACPI_PARSE_STATE        *ParserState,
0184     UINT32                  ArgType,
0185     ACPI_PARSE_OBJECT       **ReturnArg);
0186
0187
0188 /*
0189  * psfind
0190  */
0191 ACPI_PARSE_OBJECT *
0192 AcpiPsFindName (
0193     ACPI_PARSE_OBJECT       *Scope,
0194     UINT32                  Name,
0195     UINT32                  Opcode);
0196
0197 ACPI_PARSE_OBJECT*
0198 AcpiPsGetParent (
0199     ACPI_PARSE_OBJECT       *Op);
0200
0201
0202 /*
0203  * psopcode - AML Opcode information
0204  */
0205 const ACPI_OPCODE_INFO *
0206 AcpiPsGetOpcodeInfo (
0207     UINT16                  Opcode);
0208
0209 char *
0210 AcpiPsGetOpcodeName (
0211     UINT16                  Opcode);
0212
0213 UINT8
0214 AcpiPsGetArgumentCount (
0215     UINT32                  OpType);
0216
0217
0218 /*
0219  * psparse - top level parsing routines
0220  */
0221 ACPI_STATUS
0222 AcpiPsParseAml (
0223     ACPI_WALK_STATE         *WalkState);
0224
0225 UINT32
0226 AcpiPsGetOpcodeSize (
0227     UINT32                  Opcode);
0228
0229 UINT16
0230 AcpiPsPeekOpcode (
0231     ACPI_PARSE_STATE        *state);
0232
0233 ACPI_STATUS
0234 AcpiPsCompleteThisOp (
0235     ACPI_WALK_STATE         *WalkState,
0236     ACPI_PARSE_OBJECT       *Op);
0237
0238 ACPI_STATUS
0239 AcpiPsNextParseState (
0240     ACPI_WALK_STATE         *WalkState,
0241     ACPI_PARSE_OBJECT       *Op,
0242     ACPI_STATUS             CallbackStatus);
0243
0244
0245 /*
0246  * psloop - main parse loop
0247  */
0248 ACPI_STATUS
0249 AcpiPsParseLoop (
0250     ACPI_WALK_STATE         *WalkState);
0251
0252
0253 /*
0254  * psscope - Scope stack management routines
0255  */
0256 ACPI_STATUS
0257 AcpiPsInitScope (
0258     ACPI_PARSE_STATE        *ParserState,
0259     ACPI_PARSE_OBJECT       *Root);
0260
0261 ACPI_PARSE_OBJECT *
0262 AcpiPsGetParentScope (
0263     ACPI_PARSE_STATE        *state);
0264
0265 BOOLEAN
0266 AcpiPsHasCompletedScope (
0267     ACPI_PARSE_STATE        *ParserState);
0268
0269 void
0270 AcpiPsPopScope (
0271     ACPI_PARSE_STATE        *ParserState,
0272     ACPI_PARSE_OBJECT       **Op,
0273     UINT32                  *ArgList,
0274     UINT32                  *ArgCount);
0275
0276 ACPI_STATUS
0277 AcpiPsPushScope (
0278     ACPI_PARSE_STATE        *ParserState,
0279     ACPI_PARSE_OBJECT       *Op,
0280     UINT32                  RemainingArgs,
0281     UINT32                  ArgCount);
0282
0283 void
0284 AcpiPsCleanupScope (
0285     ACPI_PARSE_STATE        *state);
0286
0287
0288 /*
0289  * pstree - parse tree manipulation routines
0290  */
0291 void
0292 AcpiPsAppendArg(
0293     ACPI_PARSE_OBJECT       *op,
0294     ACPI_PARSE_OBJECT       *arg);
0295
0296 ACPI_PARSE_OBJECT*
0297 AcpiPsFind (
0298     ACPI_PARSE_OBJECT       *Scope,
0299     char                    *Path,
0300     UINT16                  Opcode,
0301     UINT32                  Create);
0302
0303 ACPI_PARSE_OBJECT *
0304 AcpiPsGetArg(
0305     ACPI_PARSE_OBJECT       *op,
0306     UINT32                   argn);
0307
0308 ACPI_PARSE_OBJECT *
0309 AcpiPsGetDepthNext (
0310     ACPI_PARSE_OBJECT       *Origin,
0311     ACPI_PARSE_OBJECT       *Op);
0312
0313
0314 /*
0315  * pswalk - parse tree walk routines
0316  */
0317 ACPI_STATUS
0318 AcpiPsWalkParsedAml (
0319     ACPI_PARSE_OBJECT       *StartOp,
0320     ACPI_PARSE_OBJECT       *EndOp,
0321     ACPI_OPERAND_OBJECT     *MthDesc,
0322     ACPI_NAMESPACE_NODE     *StartNode,
0323     ACPI_OPERAND_OBJECT     **Params,
0324     ACPI_OPERAND_OBJECT     **CallerReturnDesc,
0325     ACPI_OWNER_ID           OwnerId,
0326     ACPI_PARSE_DOWNWARDS    DescendingCallback,
0327     ACPI_PARSE_UPWARDS      AscendingCallback);
0328
0329 ACPI_STATUS
0330 AcpiPsGetNextWalkOp (
0331     ACPI_WALK_STATE         *WalkState,
0332     ACPI_PARSE_OBJECT       *Op,
0333     ACPI_PARSE_UPWARDS      AscendingCallback);
0334
0335 ACPI_STATUS
0336 AcpiPsDeleteCompletedOp (
0337     ACPI_WALK_STATE         *WalkState);
0338
0339 void
0340 AcpiPsDeleteParseTree (
0341     ACPI_PARSE_OBJECT       *root);
0342
0343
0344 /*
0345  * psutils - parser utilities
0346  */
0347 ACPI_PARSE_OBJECT *
0348 AcpiPsCreateScopeOp (
0349     void);
0350
0351 void
0352 AcpiPsInitOp (
0353     ACPI_PARSE_OBJECT       *op,
0354     UINT16                  opcode);
0355
0356 ACPI_PARSE_OBJECT *
0357 AcpiPsAllocOp (
0358     UINT16                  opcode);
0359
0360 void
0361 AcpiPsFreeOp (
0362     ACPI_PARSE_OBJECT       *Op);
0363
0364 BOOLEAN
0365 AcpiPsIsLeadingChar (
0366     UINT32                  c);
0367
0368 BOOLEAN
0369 AcpiPsIsPrefixChar (
0370     UINT32                  c);
0371
0372 UINT32
0373 AcpiPsGetName(
0374     ACPI_PARSE_OBJECT       *op);
0375
0376 void
0377 AcpiPsSetName(
0378     ACPI_PARSE_OBJECT       *op,
0379     UINT32                  name);
0380
0381
0382 /*
0383  * psdump - display parser tree
0384  */
0385 UINT32
0386 AcpiPsSprintPath (
0387     char                    *BufferStart,
0388     UINT32                  BufferSize,
0389     ACPI_PARSE_OBJECT       *Op);
0390
0391 UINT32
0392 AcpiPsSprintOp (
0393     char                    *BufferStart,
0394     UINT32                  BufferSize,
0395     ACPI_PARSE_OBJECT       *Op);
0396
0397 void
0398 AcpiPsShow (
0399     ACPI_PARSE_OBJECT       *op);
0400
0401
0402 #endif /* __ACPARSER_H__ */