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