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