src/add-ons/kernel/bus_managers/acpi/acpica/include/acparser.h

   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 - 2014, 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
 117 #ifndef __ACPARSER_H__
 118 #define __ACPARSER_H__
 119
 120
 121 #define OP_HAS_RETURN_VALUE             1
 122
 123 /* Variable number of arguments. This field must be 32 bits */
 124
 125 #define ACPI_VAR_ARGS                   ACPI_UINT32_MAX
 126
 127
 128 #define ACPI_PARSE_DELETE_TREE          0x0001
 129 #define ACPI_PARSE_NO_TREE_DELETE       0x0000
 130 #define ACPI_PARSE_TREE_MASK            0x0001
 131
 132 #define ACPI_PARSE_LOAD_PASS1           0x0010
 133 #define ACPI_PARSE_LOAD_PASS2           0x0020
 134 #define ACPI_PARSE_EXECUTE              0x0030
 135 #define ACPI_PARSE_MODE_MASK            0x0030
 136
 137 #define ACPI_PARSE_DEFERRED_OP          0x0100
 138 #define ACPI_PARSE_DISASSEMBLE          0x0200
 139
 140 #define ACPI_PARSE_MODULE_LEVEL         0x0400
 141
 142 /******************************************************************************
 143  *
 144  * Parser interfaces
 145  *
 146  *****************************************************************************/
 147
 148
 149 /*
 150  * psxface - Parser external interfaces
 151  */
 152 ACPI_STATUS
 153 AcpiPsExecuteMethod (
 154     ACPI_EVALUATE_INFO      *Info);
 155
 156
 157 /*
 158  * psargs - Parse AML opcode arguments
 159  */
 160 UINT8 *
 161 AcpiPsGetNextPackageEnd (
 162     ACPI_PARSE_STATE        *ParserState);
 163
 164 char *
 165 AcpiPsGetNextNamestring (
 166     ACPI_PARSE_STATE        *ParserState);
 167
 168 void
 169 AcpiPsGetNextSimpleArg (
 170     ACPI_PARSE_STATE        *ParserState,
 171     UINT32                  ArgType,
 172     ACPI_PARSE_OBJECT       *Arg);
 173
 174 ACPI_STATUS
 175 AcpiPsGetNextNamepath (
 176     ACPI_WALK_STATE         *WalkState,
 177     ACPI_PARSE_STATE        *ParserState,
 178     ACPI_PARSE_OBJECT       *Arg,
 179     BOOLEAN                 MethodCall);
 180
 181 ACPI_STATUS
 182 AcpiPsGetNextArg (
 183     ACPI_WALK_STATE         *WalkState,
 184     ACPI_PARSE_STATE        *ParserState,
 185     UINT32                  ArgType,
 186     ACPI_PARSE_OBJECT       **ReturnArg);
 187
 188
 189 /*
 190  * psfind
 191  */
 192 ACPI_PARSE_OBJECT *
 193 AcpiPsFindName (
 194     ACPI_PARSE_OBJECT       *Scope,
 195     UINT32                  Name,
 196     UINT32                  Opcode);
 197
 198 ACPI_PARSE_OBJECT*
 199 AcpiPsGetParent (
 200     ACPI_PARSE_OBJECT       *Op);
 201
 202
 203 /*
 204  * psobject - support for parse object processing
 205  */
 206 ACPI_STATUS
 207 AcpiPsBuildNamedOp (
 208     ACPI_WALK_STATE         *WalkState,
 209     UINT8                   *AmlOpStart,
 210     ACPI_PARSE_OBJECT       *UnnamedOp,
 211     ACPI_PARSE_OBJECT       **Op);
 212
 213 ACPI_STATUS
 214 AcpiPsCreateOp (
 215     ACPI_WALK_STATE         *WalkState,
 216     UINT8                   *AmlOpStart,
 217     ACPI_PARSE_OBJECT       **NewOp);
 218
 219 ACPI_STATUS
 220 AcpiPsCompleteOp (
 221     ACPI_WALK_STATE         *WalkState,
 222     ACPI_PARSE_OBJECT       **Op,
 223     ACPI_STATUS             Status);
 224
 225 ACPI_STATUS
 226 AcpiPsCompleteFinalOp (
 227     ACPI_WALK_STATE         *WalkState,
 228     ACPI_PARSE_OBJECT       *Op,
 229     ACPI_STATUS             Status);
 230
 231
 232 /*
 233  * psopinfo - AML Opcode information
 234  */
 235 const ACPI_OPCODE_INFO *
 236 AcpiPsGetOpcodeInfo (
 237     UINT16                  Opcode);
 238
 239 char *
 240 AcpiPsGetOpcodeName (
 241     UINT16                  Opcode);
 242
 243 UINT8
 244 AcpiPsGetArgumentCount (
 245     UINT32                  OpType);
 246
 247
 248 /*
 249  * psparse - top level parsing routines
 250  */
 251 ACPI_STATUS
 252 AcpiPsParseAml (
 253     ACPI_WALK_STATE         *WalkState);
 254
 255 UINT32
 256 AcpiPsGetOpcodeSize (
 257     UINT32                  Opcode);
 258
 259 UINT16
 260 AcpiPsPeekOpcode (
 261     ACPI_PARSE_STATE        *state);
 262
 263 ACPI_STATUS
 264 AcpiPsCompleteThisOp (
 265     ACPI_WALK_STATE         *WalkState,
 266     ACPI_PARSE_OBJECT       *Op);
 267
 268 ACPI_STATUS
 269 AcpiPsNextParseState (
 270     ACPI_WALK_STATE         *WalkState,
 271     ACPI_PARSE_OBJECT       *Op,
 272     ACPI_STATUS             CallbackStatus);
 273
 274
 275 /*
 276  * psloop - main parse loop
 277  */
 278 ACPI_STATUS
 279 AcpiPsParseLoop (
 280     ACPI_WALK_STATE         *WalkState);
 281
 282
 283 /*
 284  * psscope - Scope stack management routines
 285  */
 286 ACPI_STATUS
 287 AcpiPsInitScope (
 288     ACPI_PARSE_STATE        *ParserState,
 289     ACPI_PARSE_OBJECT       *Root);
 290
 291 ACPI_PARSE_OBJECT *
 292 AcpiPsGetParentScope (
 293     ACPI_PARSE_STATE        *state);
 294
 295 BOOLEAN
 296 AcpiPsHasCompletedScope (
 297     ACPI_PARSE_STATE        *ParserState);
 298
 299 void
 300 AcpiPsPopScope (
 301     ACPI_PARSE_STATE        *ParserState,
 302     ACPI_PARSE_OBJECT       **Op,
 303     UINT32                  *ArgList,
 304     UINT32                  *ArgCount);
 305
 306 ACPI_STATUS
 307 AcpiPsPushScope (
 308     ACPI_PARSE_STATE        *ParserState,
 309     ACPI_PARSE_OBJECT       *Op,
 310     UINT32                  RemainingArgs,
 311     UINT32                  ArgCount);
 312
 313 void
 314 AcpiPsCleanupScope (
 315     ACPI_PARSE_STATE        *state);
 316
 317
 318 /*
 319  * pstree - parse tree manipulation routines
 320  */
 321 void
 322 AcpiPsAppendArg(
 323     ACPI_PARSE_OBJECT       *op,
 324     ACPI_PARSE_OBJECT       *arg);
 325
 326 ACPI_PARSE_OBJECT*
 327 AcpiPsFind (
 328     ACPI_PARSE_OBJECT       *Scope,
 329     char                    *Path,
 330     UINT16                  Opcode,
 331     UINT32                  Create);
 332
 333 ACPI_PARSE_OBJECT *
 334 AcpiPsGetArg(
 335     ACPI_PARSE_OBJECT       *op,
 336     UINT32                   argn);
 337
 338 ACPI_PARSE_OBJECT *
 339 AcpiPsGetDepthNext (
 340     ACPI_PARSE_OBJECT       *Origin,
 341     ACPI_PARSE_OBJECT       *Op);
 342
 343
 344 /*
 345  * pswalk - parse tree walk routines
 346  */
 347 ACPI_STATUS
 348 AcpiPsWalkParsedAml (
 349     ACPI_PARSE_OBJECT       *StartOp,
 350     ACPI_PARSE_OBJECT       *EndOp,
 351     ACPI_OPERAND_OBJECT     *MthDesc,
 352     ACPI_NAMESPACE_NODE     *StartNode,
 353     ACPI_OPERAND_OBJECT     **Params,
 354     ACPI_OPERAND_OBJECT     **CallerReturnDesc,
 355     ACPI_OWNER_ID           OwnerId,
 356     ACPI_PARSE_DOWNWARDS    DescendingCallback,
 357     ACPI_PARSE_UPWARDS      AscendingCallback);
 358
 359 ACPI_STATUS
 360 AcpiPsGetNextWalkOp (
 361     ACPI_WALK_STATE         *WalkState,
 362     ACPI_PARSE_OBJECT       *Op,
 363     ACPI_PARSE_UPWARDS      AscendingCallback);
 364
 365 ACPI_STATUS
 366 AcpiPsDeleteCompletedOp (
 367     ACPI_WALK_STATE         *WalkState);
 368
 369 void
 370 AcpiPsDeleteParseTree (
 371     ACPI_PARSE_OBJECT       *root);
 372
 373
 374 /*
 375  * psutils - parser utilities
 376  */
 377 ACPI_PARSE_OBJECT *
 378 AcpiPsCreateScopeOp (
 379     void);
 380
 381 void
 382 AcpiPsInitOp (
 383     ACPI_PARSE_OBJECT       *op,
 384     UINT16                  opcode);
 385
 386 ACPI_PARSE_OBJECT *
 387 AcpiPsAllocOp (
 388     UINT16                  opcode);
 389
 390 void
 391 AcpiPsFreeOp (
 392     ACPI_PARSE_OBJECT       *Op);
 393
 394 BOOLEAN
 395 AcpiPsIsLeadingChar (
 396     UINT32                  c);
 397
 398 UINT32
 399 AcpiPsGetName(
 400     ACPI_PARSE_OBJECT       *op);
 401
 402 void
 403 AcpiPsSetName(
 404     ACPI_PARSE_OBJECT       *op,
 405     UINT32                  name);
 406
 407
 408 /*
 409  * psdump - display parser tree
 410  */
 411 UINT32
 412 AcpiPsSprintPath (
 413     char                    *BufferStart,
 414     UINT32                  BufferSize,
 415     ACPI_PARSE_OBJECT       *Op);
 416
 417 UINT32
 418 AcpiPsSprintOp (
 419     char                    *BufferStart,
 420     UINT32                  BufferSize,
 421     ACPI_PARSE_OBJECT       *Op);
 422
 423 void
 424 AcpiPsShow (
 425     ACPI_PARSE_OBJECT       *op);
 426
 427
 428 #endif /* __ACPARSER_H__ */