acparser.h revision 70243
1213496Scognet/****************************************************************************** 2213496Scognet * 3213496Scognet * Module Name: acparser.h - AML Parser subcomponent prototypes and defines 4213496Scognet * $Revision: 48 $ 5213496Scognet * 6213496Scognet *****************************************************************************/ 7213496Scognet 8213496Scognet/****************************************************************************** 9213496Scognet * 10213496Scognet * 1. Copyright Notice 11213496Scognet * 12213496Scognet * Some or all of this work - Copyright (c) 1999, 2000, Intel Corp. 13213496Scognet * All rights reserved. 14213496Scognet * 15213496Scognet * 2. License 16213496Scognet * 17213496Scognet * 2.1. This is your license from Intel Corp. under its intellectual property 18213496Scognet * rights. You may have additional license terms from the party that provided 19213496Scognet * you this software, covering your right to use that party's intellectual 20213496Scognet * property rights. 21213496Scognet * 22213496Scognet * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23213496Scognet * copy of the source code appearing in this file ("Covered Code") an 24213496Scognet * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25213496Scognet * base code distributed originally by Intel ("Original Intel Code") to copy, 26213496Scognet * make derivatives, distribute, use and display any portion of the Covered 27213496Scognet * Code in any form, with the right to sublicense such rights; and 28238369Simp * 29238369Simp * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30213496Scognet * license (with the right to sublicense), under only those claims of Intel 31213496Scognet * patents that are infringed by the Original Intel Code, to make, use, sell, 32213496Scognet * offer to sell, and import the Covered Code and derivative works thereof 33213496Scognet * solely to the minimum extent necessary to exercise the above copyright 34213496Scognet * license, and in no event shall the patent license extend to any additions 35213496Scognet * to or modifications of the Original Intel Code. No other license or right 36213496Scognet * is granted directly or by implication, estoppel or otherwise; 37213496Scognet * 38213496Scognet * The above copyright and patent license is granted only if the following 39213496Scognet * conditions are met: 40213496Scognet * 41213496Scognet * 3. Conditions 42213496Scognet * 43213496Scognet * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44213496Scognet * Redistribution of source code of any substantial portion of the Covered 45213496Scognet * Code or modification with rights to further distribute source must include 46213496Scognet * the above Copyright Notice, the above License, this list of Conditions, 47213496Scognet * and the following Disclaimer and Export Compliance provision. In addition, 48213496Scognet * Licensee must cause all Covered Code to which Licensee contributes to 49213496Scognet * contain a file documenting the changes Licensee made to create that Covered 50213496Scognet * Code and the date of any change. Licensee must include in that file the 51213496Scognet * documentation of any changes made by any predecessor Licensee. Licensee 52213496Scognet * must include a prominent statement that the modification is derived, 53213496Scognet * directly or indirectly, from Original Intel Code. 54213496Scognet * 55213496Scognet * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56213496Scognet * Redistribution of source code of any substantial portion of the Covered 57213496Scognet * Code or modification without rights to further distribute source must 58213496Scognet * include the following Disclaimer and Export Compliance provision in the 59238369Simp * documentation and/or other materials provided with distribution. In 60238369Simp * addition, Licensee may not authorize further sublicense of source of any 61238369Simp * portion of the Covered Code, and must include terms to the effect that the 62238369Simp * license from Licensee to its licensee is limited to the intellectual 63238369Simp * 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/* psapi - Parser external interfaces */ 143 144ACPI_STATUS 145AcpiPsxLoadTable ( 146 UINT8 *PcodeAddr, 147 UINT32 PcodeLength); 148 149ACPI_STATUS 150AcpiPsxExecute ( 151 ACPI_NAMESPACE_NODE *MethodNode, 152 ACPI_OPERAND_OBJECT **Params, 153 ACPI_OPERAND_OBJECT **ReturnObjDesc); 154 155 156BOOLEAN 157AcpiPsIsNamespaceObjectOp ( 158 UINT16 Opcode); 159BOOLEAN 160AcpiPsIsNamespaceOp ( 161 UINT16 Opcode); 162 163 164/****************************************************************************** 165 * 166 * Parser interfaces 167 * 168 *****************************************************************************/ 169 170 171/* psargs - Parse AML opcode arguments */ 172 173UINT8 * 174AcpiPsGetNextPackageEnd ( 175 ACPI_PARSE_STATE *ParserState); 176 177UINT32 178AcpiPsGetNextPackageLength ( 179 ACPI_PARSE_STATE *ParserState); 180 181NATIVE_CHAR * 182AcpiPsGetNextNamestring ( 183 ACPI_PARSE_STATE *ParserState); 184 185void 186AcpiPsGetNextSimpleArg ( 187 ACPI_PARSE_STATE *ParserState, 188 UINT32 ArgType, /* type of argument */ 189 ACPI_PARSE_OBJECT *Arg); /* (OUT) argument data */ 190 191void 192AcpiPsGetNextNamepath ( 193 ACPI_PARSE_STATE *ParserState, 194 ACPI_PARSE_OBJECT *Arg, 195 UINT32 *ArgCount, 196 BOOLEAN MethodCall); 197 198ACPI_PARSE_OBJECT * 199AcpiPsGetNextField ( 200 ACPI_PARSE_STATE *ParserState); 201 202ACPI_PARSE_OBJECT * 203AcpiPsGetNextArg ( 204 ACPI_PARSE_STATE *ParserState, 205 UINT32 ArgType, 206 UINT32 *ArgCount); 207 208 209/* psopcode - AML Opcode information */ 210 211ACPI_OPCODE_INFO * 212AcpiPsGetOpcodeInfo ( 213 UINT16 Opcode); 214 215NATIVE_CHAR * 216AcpiPsGetOpcodeName ( 217 UINT16 Opcode); 218 219 220/* psparse - top level parsing routines */ 221 222ACPI_STATUS 223AcpiPsFindObject ( 224 UINT16 Opcode, 225 ACPI_PARSE_OBJECT *Op, 226 ACPI_WALK_STATE *WalkState, 227 ACPI_PARSE_OBJECT **OutOp); 228 229void 230AcpiPsDeleteParseTree ( 231 ACPI_PARSE_OBJECT *root); 232 233ACPI_STATUS 234AcpiPsParseLoop ( 235 ACPI_WALK_STATE *WalkState); 236 237ACPI_STATUS 238AcpiPsParseAml ( 239 ACPI_PARSE_OBJECT *StartScope, 240 UINT8 *Aml, 241 UINT32 AmlSize, 242 UINT32 ParseFlags, 243 ACPI_NAMESPACE_NODE *MethodNode, 244 ACPI_OPERAND_OBJECT **Params, 245 ACPI_OPERAND_OBJECT **CallerReturnDesc, 246 ACPI_PARSE_DOWNWARDS DescendingCallback, 247 ACPI_PARSE_UPWARDS AscendingCallback); 248 249ACPI_STATUS 250AcpiPsParseTable ( 251 UINT8 *aml, 252 UINT32 amlSize, 253 ACPI_PARSE_DOWNWARDS DescendingCallback, 254 ACPI_PARSE_UPWARDS AscendingCallback, 255 ACPI_PARSE_OBJECT **RootObject); 256 257UINT16 258AcpiPsPeekOpcode ( 259 ACPI_PARSE_STATE *state); 260 261 262/* psscope - Scope stack management routines */ 263 264 265ACPI_STATUS 266AcpiPsInitScope ( 267 ACPI_PARSE_STATE *ParserState, 268 ACPI_PARSE_OBJECT *Root); 269 270ACPI_PARSE_OBJECT * 271AcpiPsGetParentScope ( 272 ACPI_PARSE_STATE *state); 273 274BOOLEAN 275AcpiPsHasCompletedScope ( 276 ACPI_PARSE_STATE *ParserState); 277 278void 279AcpiPsPopScope ( 280 ACPI_PARSE_STATE *ParserState, 281 ACPI_PARSE_OBJECT **Op, 282 UINT32 *ArgList, 283 UINT32 *ArgCount); 284 285ACPI_STATUS 286AcpiPsPushScope ( 287 ACPI_PARSE_STATE *ParserState, 288 ACPI_PARSE_OBJECT *Op, 289 UINT32 RemainingArgs, 290 UINT32 ArgCount); 291 292void 293AcpiPsCleanupScope ( 294 ACPI_PARSE_STATE *state); 295 296 297/* pstree - parse tree manipulation routines */ 298 299void 300AcpiPsAppendArg( 301 ACPI_PARSE_OBJECT *op, 302 ACPI_PARSE_OBJECT *arg); 303 304ACPI_PARSE_OBJECT* 305AcpiPsFind ( 306 ACPI_PARSE_OBJECT *Scope, 307 NATIVE_CHAR *Path, 308 UINT16 Opcode, 309 UINT32 Create); 310 311ACPI_PARSE_OBJECT * 312AcpiPsGetArg( 313 ACPI_PARSE_OBJECT *op, 314 UINT32 argn); 315 316ACPI_PARSE_OBJECT * 317AcpiPsGetChild ( 318 ACPI_PARSE_OBJECT *op); 319 320ACPI_PARSE_OBJECT * 321AcpiPsGetDepthNext ( 322 ACPI_PARSE_OBJECT *Origin, 323 ACPI_PARSE_OBJECT *Op); 324 325 326/* pswalk - parse tree walk routines */ 327 328ACPI_STATUS 329AcpiPsWalkParsedAml ( 330 ACPI_PARSE_OBJECT *StartOp, 331 ACPI_PARSE_OBJECT *EndOp, 332 ACPI_OPERAND_OBJECT *MthDesc, 333 ACPI_NAMESPACE_NODE *StartNode, 334 ACPI_OPERAND_OBJECT **Params, 335 ACPI_OPERAND_OBJECT **CallerReturnDesc, 336 ACPI_OWNER_ID OwnerId, 337 ACPI_PARSE_DOWNWARDS DescendingCallback, 338 ACPI_PARSE_UPWARDS AscendingCallback); 339 340ACPI_STATUS 341AcpiPsGetNextWalkOp ( 342 ACPI_WALK_STATE *WalkState, 343 ACPI_PARSE_OBJECT *Op, 344 ACPI_PARSE_UPWARDS AscendingCallback); 345 346 347/* psutils - parser utilities */ 348 349 350ACPI_PARSE_STATE * 351AcpiPsCreateState ( 352 UINT8 *Aml, 353 UINT32 AmlSize); 354 355void 356AcpiPsInitOp ( 357 ACPI_PARSE_OBJECT *op, 358 UINT16 opcode); 359 360ACPI_PARSE_OBJECT * 361AcpiPsAllocOp ( 362 UINT16 opcode); 363 364void 365AcpiPsFreeOp ( 366 ACPI_PARSE_OBJECT *Op); 367 368void 369AcpiPsDeleteParseCache ( 370 void); 371 372BOOLEAN 373AcpiPsIsLeadingChar ( 374 UINT32 c); 375 376BOOLEAN 377AcpiPsIsPrefixChar ( 378 UINT32 c); 379 380BOOLEAN 381AcpiPsIsNamedOp ( 382 UINT16 opcode); 383 384BOOLEAN 385AcpiPsIsNodeOp ( 386 UINT16 opcode); 387 388BOOLEAN 389AcpiPsIsDeferredOp ( 390 UINT16 opcode); 391 392BOOLEAN 393AcpiPsIsBytelistOp( 394 UINT16 opcode); 395 396BOOLEAN 397AcpiPsIsFieldOp( 398 UINT16 opcode); 399 400BOOLEAN 401AcpiPsIsCreateFieldOp ( 402 UINT16 Opcode); 403 404ACPI_PARSE2_OBJECT* 405AcpiPsToExtendedOp( 406 ACPI_PARSE_OBJECT *op); 407 408UINT32 409AcpiPsGetName( 410 ACPI_PARSE_OBJECT *op); 411 412void 413AcpiPsSetName( 414 ACPI_PARSE_OBJECT *op, 415 UINT32 name); 416 417 418/* psdump - display parser tree */ 419 420UINT32 421AcpiPsSprintPath ( 422 NATIVE_CHAR *BufferStart, 423 UINT32 BufferSize, 424 ACPI_PARSE_OBJECT *Op); 425 426UINT32 427AcpiPsSprintOp ( 428 NATIVE_CHAR *BufferStart, 429 UINT32 BufferSize, 430 ACPI_PARSE_OBJECT *Op); 431 432void 433AcpiPsShow ( 434 ACPI_PARSE_OBJECT *op); 435 436 437#endif /* __ACPARSER_H__ */ 438