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