sys/contrib/dev/acpica/acdispat.h

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