acdispat.h revision 1.1
1 /****************************************************************************** 2 * 3 * Name: acdispat.h - dispatcher (parser to interpreter interface) 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2010, 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 _ACDISPAT_H_ 118 #define _ACDISPAT_H_ 119 120 121 #define NAMEOF_LOCAL_NTE "__L0" 122 #define NAMEOF_ARG_NTE "__A0" 123 124 125 /* 126 * dsopcode - support for late evaluation 127 */ 128 ACPI_STATUS 129 AcpiDsGetBufferFieldArguments ( 130 ACPI_OPERAND_OBJECT *ObjDesc); 131 132 ACPI_STATUS 133 AcpiDsGetBankFieldArguments ( 134 ACPI_OPERAND_OBJECT *ObjDesc); 135 136 ACPI_STATUS 137 AcpiDsGetRegionArguments ( 138 ACPI_OPERAND_OBJECT *RgnDesc); 139 140 ACPI_STATUS 141 AcpiDsGetBufferArguments ( 142 ACPI_OPERAND_OBJECT *ObjDesc); 143 144 ACPI_STATUS 145 AcpiDsGetPackageArguments ( 146 ACPI_OPERAND_OBJECT *ObjDesc); 147 148 ACPI_STATUS 149 AcpiDsEvalBufferFieldOperands ( 150 ACPI_WALK_STATE *WalkState, 151 ACPI_PARSE_OBJECT *Op); 152 153 ACPI_STATUS 154 AcpiDsEvalRegionOperands ( 155 ACPI_WALK_STATE *WalkState, 156 ACPI_PARSE_OBJECT *Op); 157 158 ACPI_STATUS 159 AcpiDsEvalTableRegionOperands ( 160 ACPI_WALK_STATE *WalkState, 161 ACPI_PARSE_OBJECT *Op); 162 163 ACPI_STATUS 164 AcpiDsEvalDataObjectOperands ( 165 ACPI_WALK_STATE *WalkState, 166 ACPI_PARSE_OBJECT *Op, 167 ACPI_OPERAND_OBJECT *ObjDesc); 168 169 ACPI_STATUS 170 AcpiDsEvalBankFieldOperands ( 171 ACPI_WALK_STATE *WalkState, 172 ACPI_PARSE_OBJECT *Op); 173 174 ACPI_STATUS 175 AcpiDsInitializeRegion ( 176 ACPI_HANDLE ObjHandle); 177 178 179 /* 180 * dsctrl - Parser/Interpreter interface, control stack routines 181 */ 182 ACPI_STATUS 183 AcpiDsExecBeginControlOp ( 184 ACPI_WALK_STATE *WalkState, 185 ACPI_PARSE_OBJECT *Op); 186 187 ACPI_STATUS 188 AcpiDsExecEndControlOp ( 189 ACPI_WALK_STATE *WalkState, 190 ACPI_PARSE_OBJECT *Op); 191 192 193 /* 194 * dsexec - Parser/Interpreter interface, method execution callbacks 195 */ 196 ACPI_STATUS 197 AcpiDsGetPredicateValue ( 198 ACPI_WALK_STATE *WalkState, 199 ACPI_OPERAND_OBJECT *ResultObj); 200 201 ACPI_STATUS 202 AcpiDsExecBeginOp ( 203 ACPI_WALK_STATE *WalkState, 204 ACPI_PARSE_OBJECT **OutOp); 205 206 ACPI_STATUS 207 AcpiDsExecEndOp ( 208 ACPI_WALK_STATE *State); 209 210 211 /* 212 * dsfield - Parser/Interpreter interface for AML fields 213 */ 214 ACPI_STATUS 215 AcpiDsCreateField ( 216 ACPI_PARSE_OBJECT *Op, 217 ACPI_NAMESPACE_NODE *RegionNode, 218 ACPI_WALK_STATE *WalkState); 219 220 ACPI_STATUS 221 AcpiDsCreateBankField ( 222 ACPI_PARSE_OBJECT *Op, 223 ACPI_NAMESPACE_NODE *RegionNode, 224 ACPI_WALK_STATE *WalkState); 225 226 ACPI_STATUS 227 AcpiDsCreateIndexField ( 228 ACPI_PARSE_OBJECT *Op, 229 ACPI_NAMESPACE_NODE *RegionNode, 230 ACPI_WALK_STATE *WalkState); 231 232 ACPI_STATUS 233 AcpiDsCreateBufferField ( 234 ACPI_PARSE_OBJECT *Op, 235 ACPI_WALK_STATE *WalkState); 236 237 ACPI_STATUS 238 AcpiDsInitFieldObjects ( 239 ACPI_PARSE_OBJECT *Op, 240 ACPI_WALK_STATE *WalkState); 241 242 243 /* 244 * dsload - Parser/Interpreter interface, namespace load callbacks 245 */ 246 ACPI_STATUS 247 AcpiDsLoad1BeginOp ( 248 ACPI_WALK_STATE *WalkState, 249 ACPI_PARSE_OBJECT **OutOp); 250 251 ACPI_STATUS 252 AcpiDsLoad1EndOp ( 253 ACPI_WALK_STATE *WalkState); 254 255 ACPI_STATUS 256 AcpiDsLoad2BeginOp ( 257 ACPI_WALK_STATE *WalkState, 258 ACPI_PARSE_OBJECT **OutOp); 259 260 ACPI_STATUS 261 AcpiDsLoad2EndOp ( 262 ACPI_WALK_STATE *WalkState); 263 264 ACPI_STATUS 265 AcpiDsInitCallbacks ( 266 ACPI_WALK_STATE *WalkState, 267 UINT32 PassNumber); 268 269 270 /* 271 * dsmthdat - method data (locals/args) 272 */ 273 ACPI_STATUS 274 AcpiDsStoreObjectToLocal ( 275 UINT8 Type, 276 UINT32 Index, 277 ACPI_OPERAND_OBJECT *SrcDesc, 278 ACPI_WALK_STATE *WalkState); 279 280 ACPI_STATUS 281 AcpiDsMethodDataGetEntry ( 282 UINT16 Opcode, 283 UINT32 Index, 284 ACPI_WALK_STATE *WalkState, 285 ACPI_OPERAND_OBJECT ***Node); 286 287 void 288 AcpiDsMethodDataDeleteAll ( 289 ACPI_WALK_STATE *WalkState); 290 291 BOOLEAN 292 AcpiDsIsMethodValue ( 293 ACPI_OPERAND_OBJECT *ObjDesc); 294 295 ACPI_STATUS 296 AcpiDsMethodDataGetValue ( 297 UINT8 Type, 298 UINT32 Index, 299 ACPI_WALK_STATE *WalkState, 300 ACPI_OPERAND_OBJECT **DestDesc); 301 302 ACPI_STATUS 303 AcpiDsMethodDataInitArgs ( 304 ACPI_OPERAND_OBJECT **Params, 305 UINT32 MaxParamCount, 306 ACPI_WALK_STATE *WalkState); 307 308 ACPI_STATUS 309 AcpiDsMethodDataGetNode ( 310 UINT8 Type, 311 UINT32 Index, 312 ACPI_WALK_STATE *WalkState, 313 ACPI_NAMESPACE_NODE **Node); 314 315 void 316 AcpiDsMethodDataInit ( 317 ACPI_WALK_STATE *WalkState); 318 319 320 /* 321 * dsmethod - Parser/Interpreter interface - control method parsing 322 */ 323 ACPI_STATUS 324 AcpiDsParseMethod ( 325 ACPI_NAMESPACE_NODE *Node); 326 327 ACPI_STATUS 328 AcpiDsCallControlMethod ( 329 ACPI_THREAD_STATE *Thread, 330 ACPI_WALK_STATE *WalkState, 331 ACPI_PARSE_OBJECT *Op); 332 333 ACPI_STATUS 334 AcpiDsRestartControlMethod ( 335 ACPI_WALK_STATE *WalkState, 336 ACPI_OPERAND_OBJECT *ReturnDesc); 337 338 void 339 AcpiDsTerminateControlMethod ( 340 ACPI_OPERAND_OBJECT *MethodDesc, 341 ACPI_WALK_STATE *WalkState); 342 343 ACPI_STATUS 344 AcpiDsBeginMethodExecution ( 345 ACPI_NAMESPACE_NODE *MethodNode, 346 ACPI_OPERAND_OBJECT *ObjDesc, 347 ACPI_WALK_STATE *WalkState); 348 349 ACPI_STATUS 350 AcpiDsMethodError ( 351 ACPI_STATUS Status, 352 ACPI_WALK_STATE *WalkState); 353 354 /* 355 * dsinit 356 */ 357 ACPI_STATUS 358 AcpiDsInitializeObjects ( 359 UINT32 TableIndex, 360 ACPI_NAMESPACE_NODE *StartNode); 361 362 363 /* 364 * dsobject - Parser/Interpreter interface - object initialization and conversion 365 */ 366 ACPI_STATUS 367 AcpiDsBuildInternalBufferObj ( 368 ACPI_WALK_STATE *WalkState, 369 ACPI_PARSE_OBJECT *Op, 370 UINT32 BufferLength, 371 ACPI_OPERAND_OBJECT **ObjDescPtr); 372 373 ACPI_STATUS 374 AcpiDsBuildInternalPackageObj ( 375 ACPI_WALK_STATE *WalkState, 376 ACPI_PARSE_OBJECT *op, 377 UINT32 PackageLength, 378 ACPI_OPERAND_OBJECT **ObjDesc); 379 380 ACPI_STATUS 381 AcpiDsInitObjectFromOp ( 382 ACPI_WALK_STATE *WalkState, 383 ACPI_PARSE_OBJECT *Op, 384 UINT16 Opcode, 385 ACPI_OPERAND_OBJECT **ObjDesc); 386 387 ACPI_STATUS 388 AcpiDsCreateNode ( 389 ACPI_WALK_STATE *WalkState, 390 ACPI_NAMESPACE_NODE *Node, 391 ACPI_PARSE_OBJECT *Op); 392 393 394 /* 395 * dsutils - Parser/Interpreter interface utility routines 396 */ 397 void 398 AcpiDsClearImplicitReturn ( 399 ACPI_WALK_STATE *WalkState); 400 401 BOOLEAN 402 AcpiDsDoImplicitReturn ( 403 ACPI_OPERAND_OBJECT *ReturnDesc, 404 ACPI_WALK_STATE *WalkState, 405 BOOLEAN AddReference); 406 407 BOOLEAN 408 AcpiDsIsResultUsed ( 409 ACPI_PARSE_OBJECT *Op, 410 ACPI_WALK_STATE *WalkState); 411 412 void 413 AcpiDsDeleteResultIfNotUsed ( 414 ACPI_PARSE_OBJECT *Op, 415 ACPI_OPERAND_OBJECT *ResultObj, 416 ACPI_WALK_STATE *WalkState); 417 418 ACPI_STATUS 419 AcpiDsCreateOperand ( 420 ACPI_WALK_STATE *WalkState, 421 ACPI_PARSE_OBJECT *Arg, 422 UINT32 ArgsRemaining); 423 424 ACPI_STATUS 425 AcpiDsCreateOperands ( 426 ACPI_WALK_STATE *WalkState, 427 ACPI_PARSE_OBJECT *FirstArg); 428 429 ACPI_STATUS 430 AcpiDsResolveOperands ( 431 ACPI_WALK_STATE *WalkState); 432 433 void 434 AcpiDsClearOperands ( 435 ACPI_WALK_STATE *WalkState); 436 437 ACPI_STATUS 438 AcpiDsEvaluateNamePath ( 439 ACPI_WALK_STATE *WalkState); 440 441 442 /* 443 * dswscope - Scope Stack manipulation 444 */ 445 ACPI_STATUS 446 AcpiDsScopeStackPush ( 447 ACPI_NAMESPACE_NODE *Node, 448 ACPI_OBJECT_TYPE Type, 449 ACPI_WALK_STATE *WalkState); 450 451 452 ACPI_STATUS 453 AcpiDsScopeStackPop ( 454 ACPI_WALK_STATE *WalkState); 455 456 void 457 AcpiDsScopeStackClear ( 458 ACPI_WALK_STATE *WalkState); 459 460 461 /* 462 * dswstate - parser WALK_STATE management routines 463 */ 464 ACPI_STATUS 465 AcpiDsObjStackPush ( 466 void *Object, 467 ACPI_WALK_STATE *WalkState); 468 469 ACPI_STATUS 470 AcpiDsObjStackPop ( 471 UINT32 PopCount, 472 ACPI_WALK_STATE *WalkState); 473 474 ACPI_WALK_STATE * 475 AcpiDsCreateWalkState ( 476 ACPI_OWNER_ID OwnerId, 477 ACPI_PARSE_OBJECT *Origin, 478 ACPI_OPERAND_OBJECT *MthDesc, 479 ACPI_THREAD_STATE *Thread); 480 481 ACPI_STATUS 482 AcpiDsInitAmlWalk ( 483 ACPI_WALK_STATE *WalkState, 484 ACPI_PARSE_OBJECT *Op, 485 ACPI_NAMESPACE_NODE *MethodNode, 486 UINT8 *AmlStart, 487 UINT32 AmlLength, 488 ACPI_EVALUATE_INFO *Info, 489 UINT8 PassNumber); 490 491 void 492 AcpiDsObjStackPopAndDelete ( 493 UINT32 PopCount, 494 ACPI_WALK_STATE *WalkState); 495 496 void 497 AcpiDsDeleteWalkState ( 498 ACPI_WALK_STATE *WalkState); 499 500 ACPI_WALK_STATE * 501 AcpiDsPopWalkState ( 502 ACPI_THREAD_STATE *Thread); 503 504 void 505 AcpiDsPushWalkState ( 506 ACPI_WALK_STATE *WalkState, 507 ACPI_THREAD_STATE *Thread); 508 509 ACPI_STATUS 510 AcpiDsResultStackClear ( 511 ACPI_WALK_STATE *WalkState); 512 513 ACPI_WALK_STATE * 514 AcpiDsGetCurrentWalkState ( 515 ACPI_THREAD_STATE *Thread); 516 517 ACPI_STATUS 518 AcpiDsResultPop ( 519 ACPI_OPERAND_OBJECT **Object, 520 ACPI_WALK_STATE *WalkState); 521 522 ACPI_STATUS 523 AcpiDsResultPush ( 524 ACPI_OPERAND_OBJECT *Object, 525 ACPI_WALK_STATE *WalkState); 526 527 #endif /* _ACDISPAT_H_ */ 528
Indexes created Tue Sep 30 11:09:46 GMT 2025