sys/contrib/dev/acpica/acparser.h

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