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