sys/contrib/dev/acpica/acdispat.h

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