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