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 - 2015, 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 #ifndef __ACPARSER_H__ 117 #define __ACPARSER_H__ 118 119 120 #define OP_HAS_RETURN_VALUE 1 121 122 /* Variable number of arguments. This field must be 32 bits */ 123 124 #define ACPI_VAR_ARGS ACPI_UINT32_MAX 125 126 127 #define ACPI_PARSE_DELETE_TREE 0x0001 128 #define ACPI_PARSE_NO_TREE_DELETE 0x0000 129 #define ACPI_PARSE_TREE_MASK 0x0001 130 131 #define ACPI_PARSE_LOAD_PASS1 0x0010 132 #define ACPI_PARSE_LOAD_PASS2 0x0020 133 #define ACPI_PARSE_EXECUTE 0x0030 134 #define ACPI_PARSE_MODE_MASK 0x0030 135 136 #define ACPI_PARSE_DEFERRED_OP 0x0100 137 #define ACPI_PARSE_DISASSEMBLE 0x0200 138 139 #define ACPI_PARSE_MODULE_LEVEL 0x0400 140 141 /****************************************************************************** 142 * 143 * Parser interfaces 144 * 145 *****************************************************************************/ 146 147 extern const UINT8 AcpiGbl_ShortOpIndex[]; 148 extern const UINT8 AcpiGbl_LongOpIndex[]; 149 150 151 /* 152 * psxface - Parser external interfaces 153 */ 154 ACPI_STATUS 155 AcpiPsExecuteMethod ( 156 ACPI_EVALUATE_INFO *Info); 157 158 159 /* 160 * psargs - Parse AML opcode arguments 161 */ 162 UINT8 * 163 AcpiPsGetNextPackageEnd ( 164 ACPI_PARSE_STATE *ParserState); 165 166 char * 167 AcpiPsGetNextNamestring ( 168 ACPI_PARSE_STATE *ParserState); 169 170 void 171 AcpiPsGetNextSimpleArg ( 172 ACPI_PARSE_STATE *ParserState, 173 UINT32 ArgType, 174 ACPI_PARSE_OBJECT *Arg); 175 176 ACPI_STATUS 177 AcpiPsGetNextNamepath ( 178 ACPI_WALK_STATE *WalkState, 179 ACPI_PARSE_STATE *ParserState, 180 ACPI_PARSE_OBJECT *Arg, 181 BOOLEAN MethodCall); 182 183 ACPI_STATUS 184 AcpiPsGetNextArg ( 185 ACPI_WALK_STATE *WalkState, 186 ACPI_PARSE_STATE *ParserState, 187 UINT32 ArgType, 188 ACPI_PARSE_OBJECT **ReturnArg); 189 190 191 /* 192 * psfind 193 */ 194 ACPI_PARSE_OBJECT * 195 AcpiPsFindName ( 196 ACPI_PARSE_OBJECT *Scope, 197 UINT32 Name, 198 UINT32 Opcode); 199 200 ACPI_PARSE_OBJECT* 201 AcpiPsGetParent ( 202 ACPI_PARSE_OBJECT *Op); 203 204 205 /* 206 * psobject - support for parse object processing 207 */ 208 ACPI_STATUS 209 AcpiPsBuildNamedOp ( 210 ACPI_WALK_STATE *WalkState, 211 UINT8 *AmlOpStart, 212 ACPI_PARSE_OBJECT *UnnamedOp, 213 ACPI_PARSE_OBJECT **Op); 214 215 ACPI_STATUS 216 AcpiPsCreateOp ( 217 ACPI_WALK_STATE *WalkState, 218 UINT8 *AmlOpStart, 219 ACPI_PARSE_OBJECT **NewOp); 220 221 ACPI_STATUS 222 AcpiPsCompleteOp ( 223 ACPI_WALK_STATE *WalkState, 224 ACPI_PARSE_OBJECT **Op, 225 ACPI_STATUS Status); 226 227 ACPI_STATUS 228 AcpiPsCompleteFinalOp ( 229 ACPI_WALK_STATE *WalkState, 230 ACPI_PARSE_OBJECT *Op, 231 ACPI_STATUS Status); 232 233 234 /* 235 * psopinfo - AML Opcode information 236 */ 237 const ACPI_OPCODE_INFO * 238 AcpiPsGetOpcodeInfo ( 239 UINT16 Opcode); 240 241 char * 242 AcpiPsGetOpcodeName ( 243 UINT16 Opcode); 244 245 UINT8 246 AcpiPsGetArgumentCount ( 247 UINT32 OpType); 248 249 250 /* 251 * psparse - top level parsing routines 252 */ 253 ACPI_STATUS 254 AcpiPsParseAml ( 255 ACPI_WALK_STATE *WalkState); 256 257 UINT32 258 AcpiPsGetOpcodeSize ( 259 UINT32 Opcode); 260 261 UINT16 262 AcpiPsPeekOpcode ( 263 ACPI_PARSE_STATE *state); 264 265 ACPI_STATUS 266 AcpiPsCompleteThisOp ( 267 ACPI_WALK_STATE *WalkState, 268 ACPI_PARSE_OBJECT *Op); 269 270 ACPI_STATUS 271 AcpiPsNextParseState ( 272 ACPI_WALK_STATE *WalkState, 273 ACPI_PARSE_OBJECT *Op, 274 ACPI_STATUS CallbackStatus); 275 276 277 /* 278 * psloop - main parse loop 279 */ 280 ACPI_STATUS 281 AcpiPsParseLoop ( 282 ACPI_WALK_STATE *WalkState); 283 284 285 /* 286 * psscope - Scope stack management routines 287 */ 288 ACPI_STATUS 289 AcpiPsInitScope ( 290 ACPI_PARSE_STATE *ParserState, 291 ACPI_PARSE_OBJECT *Root); 292 293 ACPI_PARSE_OBJECT * 294 AcpiPsGetParentScope ( 295 ACPI_PARSE_STATE *state); 296 297 BOOLEAN 298 AcpiPsHasCompletedScope ( 299 ACPI_PARSE_STATE *ParserState); 300 301 void 302 AcpiPsPopScope ( 303 ACPI_PARSE_STATE *ParserState, 304 ACPI_PARSE_OBJECT **Op, 305 UINT32 *ArgList, 306 UINT32 *ArgCount); 307 308 ACPI_STATUS 309 AcpiPsPushScope ( 310 ACPI_PARSE_STATE *ParserState, 311 ACPI_PARSE_OBJECT *Op, 312 UINT32 RemainingArgs, 313 UINT32 ArgCount); 314 315 void 316 AcpiPsCleanupScope ( 317 ACPI_PARSE_STATE *state); 318 319 320 /* 321 * pstree - parse tree manipulation routines 322 */ 323 void 324 AcpiPsAppendArg( 325 ACPI_PARSE_OBJECT *op, 326 ACPI_PARSE_OBJECT *arg); 327 328 ACPI_PARSE_OBJECT* 329 AcpiPsFind ( 330 ACPI_PARSE_OBJECT *Scope, 331 char *Path, 332 UINT16 Opcode, 333 UINT32 Create); 334 335 ACPI_PARSE_OBJECT * 336 AcpiPsGetArg( 337 ACPI_PARSE_OBJECT *op, 338 UINT32 argn); 339 340 ACPI_PARSE_OBJECT * 341 AcpiPsGetDepthNext ( 342 ACPI_PARSE_OBJECT *Origin, 343 ACPI_PARSE_OBJECT *Op); 344 345 346 /* 347 * pswalk - parse tree walk routines 348 */ 349 ACPI_STATUS 350 AcpiPsWalkParsedAml ( 351 ACPI_PARSE_OBJECT *StartOp, 352 ACPI_PARSE_OBJECT *EndOp, 353 ACPI_OPERAND_OBJECT *MthDesc, 354 ACPI_NAMESPACE_NODE *StartNode, 355 ACPI_OPERAND_OBJECT **Params, 356 ACPI_OPERAND_OBJECT **CallerReturnDesc, 357 ACPI_OWNER_ID OwnerId, 358 ACPI_PARSE_DOWNWARDS DescendingCallback, 359 ACPI_PARSE_UPWARDS AscendingCallback); 360 361 ACPI_STATUS 362 AcpiPsGetNextWalkOp ( 363 ACPI_WALK_STATE *WalkState, 364 ACPI_PARSE_OBJECT *Op, 365 ACPI_PARSE_UPWARDS AscendingCallback); 366 367 ACPI_STATUS 368 AcpiPsDeleteCompletedOp ( 369 ACPI_WALK_STATE *WalkState); 370 371 void 372 AcpiPsDeleteParseTree ( 373 ACPI_PARSE_OBJECT *root); 374 375 376 /* 377 * psutils - parser utilities 378 */ 379 ACPI_PARSE_OBJECT * 380 AcpiPsCreateScopeOp ( 381 UINT8 *Aml); 382 383 void 384 AcpiPsInitOp ( 385 ACPI_PARSE_OBJECT *op, 386 UINT16 opcode); 387 388 ACPI_PARSE_OBJECT * 389 AcpiPsAllocOp ( 390 UINT16 Opcode, 391 UINT8 *Aml); 392 393 void 394 AcpiPsFreeOp ( 395 ACPI_PARSE_OBJECT *Op); 396 397 BOOLEAN 398 AcpiPsIsLeadingChar ( 399 UINT32 c); 400 401 UINT32 402 AcpiPsGetName( 403 ACPI_PARSE_OBJECT *op); 404 405 void 406 AcpiPsSetName( 407 ACPI_PARSE_OBJECT *op, 408 UINT32 name); 409 410 411 /* 412 * psdump - display parser tree 413 */ 414 UINT32 415 AcpiPsSprintPath ( 416 char *BufferStart, 417 UINT32 BufferSize, 418 ACPI_PARSE_OBJECT *Op); 419 420 UINT32 421 AcpiPsSprintOp ( 422 char *BufferStart, 423 UINT32 BufferSize, 424 ACPI_PARSE_OBJECT *Op); 425 426 void 427 AcpiPsShow ( 428 ACPI_PARSE_OBJECT *op); 429 430 431 #endif /* __ACPARSER_H__ */ 432