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