reactos/drivers/bus/acpi/acpica/include/acdispat.h

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