1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
117 #ifndef __ACINTERP_H__
118 #define __ACINTERP_H__
121 #define ACPI_WALK_OPERANDS (&(WalkState->Operands [WalkState->NumOperands -1]))
125 AcpiExResolveOperands (
127 ACPI_OPERAND_OBJECT **StackPtr,
128 ACPI_WALK_STATE *WalkState);
131 AcpiExCheckObjectType (
132 ACPI_OBJECT_TYPE TypeNeeded,
133 ACPI_OBJECT_TYPE ThisType,
137 * exxface - External interpreter interfaces
142 ACPI_TABLE_TYPE TableId);
145 AcpiExExecuteMethod (
146 ACPI_NAMESPACE_NODE *MethodNode,
147 ACPI_OPERAND_OBJECT **Params,
148 ACPI_OPERAND_OBJECT **ReturnObjDesc);
152 * exconvrt - object conversion
156 AcpiExConvertToInteger (
157 ACPI_OPERAND_OBJECT *ObjDesc,
158 ACPI_OPERAND_OBJECT **ResultDesc,
159 ACPI_WALK_STATE *WalkState);
162 AcpiExConvertToBuffer (
163 ACPI_OPERAND_OBJECT *ObjDesc,
164 ACPI_OPERAND_OBJECT **ResultDesc,
165 ACPI_WALK_STATE *WalkState);
168 AcpiExConvertToString (
169 ACPI_OPERAND_OBJECT *ObjDesc,
170 ACPI_OPERAND_OBJECT **ResultDesc,
173 ACPI_WALK_STATE *WalkState);
176 AcpiExConvertToTargetType (
177 ACPI_OBJECT_TYPE DestinationType,
178 ACPI_OPERAND_OBJECT *SourceDesc,
179 ACPI_OPERAND_OBJECT **ResultDesc,
180 ACPI_WALK_STATE *WalkState);
183 AcpiExConvertToAscii (
184 ACPI_INTEGER Integer,
190 * exfield - ACPI AML (p-code) execution - field manipulation
194 AcpiExCommonBufferSetup (
195 ACPI_OPERAND_OBJECT *ObjDesc,
200 AcpiExExtractFromField (
201 ACPI_OPERAND_OBJECT *ObjDesc,
203 UINT32 BufferLength);
206 AcpiExInsertIntoField (
207 ACPI_OPERAND_OBJECT *ObjDesc,
209 UINT32 BufferLength);
213 ACPI_OPERAND_OBJECT *ObjDesc,
214 UINT32 FieldDatumByteOffset);
218 ACPI_OPERAND_OBJECT *ObjDesc,
219 UINT32 FieldDatumByteOffset,
224 AcpiExRegisterOverflow (
225 ACPI_OPERAND_OBJECT *ObjDesc,
230 ACPI_OPERAND_OBJECT *ObjDesc,
231 UINT32 FieldDatumByteOffset,
236 AcpiExWriteWithUpdateRule (
237 ACPI_OPERAND_OBJECT *ObjDesc,
239 ACPI_INTEGER FieldValue,
240 UINT32 FieldDatumByteOffset);
243 AcpiExGetBufferDatum(
247 UINT32 ByteGranularity,
248 UINT32 BufferOffset);
251 AcpiExSetBufferDatum (
252 ACPI_INTEGER MergedDatum,
255 UINT32 ByteGranularity,
256 UINT32 BufferOffset);
259 AcpiExReadDataFromField (
260 ACPI_WALK_STATE *WalkState,
261 ACPI_OPERAND_OBJECT *ObjDesc,
262 ACPI_OPERAND_OBJECT **RetBufferDesc);
265 AcpiExWriteDataToField (
266 ACPI_OPERAND_OBJECT *SourceDesc,
267 ACPI_OPERAND_OBJECT *ObjDesc,
268 ACPI_OPERAND_OBJECT **ResultDesc);
271 * exmisc - ACPI AML (p-code) execution - specific opcodes
275 AcpiExOpcode_3A_0T_0R (
276 ACPI_WALK_STATE *WalkState);
279 AcpiExOpcode_3A_1T_1R (
280 ACPI_WALK_STATE *WalkState);
283 AcpiExOpcode_6A_0T_1R (
284 ACPI_WALK_STATE *WalkState);
289 ACPI_INTEGER PackageValue,
290 ACPI_INTEGER MatchValue);
293 AcpiExGetObjectReference (
294 ACPI_OPERAND_OBJECT *ObjDesc,
295 ACPI_OPERAND_OBJECT **ReturnDesc,
296 ACPI_WALK_STATE *WalkState);
299 AcpiExResolveMultiple (
300 ACPI_WALK_STATE *WalkState,
301 ACPI_OPERAND_OBJECT *Operand,
302 ACPI_OBJECT_TYPE *ReturnType,
303 ACPI_OPERAND_OBJECT **ReturnDesc);
306 AcpiExConcatTemplate (
307 ACPI_OPERAND_OBJECT *ObjDesc,
308 ACPI_OPERAND_OBJECT *ObjDesc2,
309 ACPI_OPERAND_OBJECT **ActualReturnDesc,
310 ACPI_WALK_STATE *WalkState);
313 AcpiExDoConcatenate (
314 ACPI_OPERAND_OBJECT *ObjDesc,
315 ACPI_OPERAND_OBJECT *ObjDesc2,
316 ACPI_OPERAND_OBJECT **ActualReturnDesc,
317 ACPI_WALK_STATE *WalkState);
322 ACPI_INTEGER Operand0,
323 ACPI_INTEGER Operand1);
328 ACPI_INTEGER Operand0,
329 ACPI_INTEGER Operand1);
333 ACPI_WALK_STATE *WalkState);
336 AcpiExCreateProcessor (
337 ACPI_WALK_STATE *WalkState);
340 AcpiExCreatePowerResource (
341 ACPI_WALK_STATE *WalkState);
348 ACPI_WALK_STATE *WalkState);
351 AcpiExCreateTableRegion (
352 ACPI_WALK_STATE *WalkState);
356 ACPI_WALK_STATE *WalkState);
360 ACPI_WALK_STATE *WalkState);
366 ACPI_WALK_STATE *WalkState);
370 * exconfig - dynamic table load/unload
375 ACPI_TABLE_HEADER *Table,
376 ACPI_NAMESPACE_NODE *ParentNode,
377 ACPI_OPERAND_OBJECT **DdbHandle);
381 ACPI_OPERAND_OBJECT *ObjDesc,
382 ACPI_OPERAND_OBJECT *Target,
383 ACPI_WALK_STATE *WalkState);
387 ACPI_WALK_STATE *WalkState,
388 ACPI_OPERAND_OBJECT **ReturnDesc);
392 ACPI_OPERAND_OBJECT *DdbHandle);
396 * exmutex - mutex support
401 ACPI_OPERAND_OBJECT *TimeDesc,
402 ACPI_OPERAND_OBJECT *ObjDesc,
403 ACPI_WALK_STATE *WalkState);
407 ACPI_OPERAND_OBJECT *ObjDesc,
408 ACPI_WALK_STATE *WalkState);
411 AcpiExReleaseAllMutexes (
412 ACPI_THREAD_STATE *Thread);
416 ACPI_OPERAND_OBJECT *ObjDesc);
420 ACPI_OPERAND_OBJECT *ObjDesc,
421 ACPI_THREAD_STATE *Thread);
424 * exprep - ACPI AML (p-code) execution - prep utilities
428 AcpiExPrepCommonFieldObject (
429 ACPI_OPERAND_OBJECT *ObjDesc,
431 UINT8 FieldAttribute,
432 UINT32 FieldBitPosition,
433 UINT32 FieldBitLength);
436 AcpiExPrepFieldValue (
437 ACPI_CREATE_FIELD_INFO *Info);
440 * exsystem - Interface to OS services
444 AcpiExSystemDoNotifyOp (
445 ACPI_OPERAND_OBJECT *Value,
446 ACPI_OPERAND_OBJECT *ObjDesc);
449 AcpiExSystemDoSuspend(
453 AcpiExSystemDoStall (
457 AcpiExSystemAcquireMutex(
458 ACPI_OPERAND_OBJECT *Time,
459 ACPI_OPERAND_OBJECT *ObjDesc);
462 AcpiExSystemReleaseMutex(
463 ACPI_OPERAND_OBJECT *ObjDesc);
466 AcpiExSystemSignalEvent(
467 ACPI_OPERAND_OBJECT *ObjDesc);
470 AcpiExSystemWaitEvent(
471 ACPI_OPERAND_OBJECT *Time,
472 ACPI_OPERAND_OBJECT *ObjDesc);
475 AcpiExSystemResetEvent(
476 ACPI_OPERAND_OBJECT *ObjDesc);
479 AcpiExSystemWaitSemaphore (
480 ACPI_HANDLE Semaphore,
485 * exmonadic - ACPI AML (p-code) execution, monadic operators
489 AcpiExOpcode_1A_0T_0R (
490 ACPI_WALK_STATE *WalkState);
493 AcpiExOpcode_1A_0T_1R (
494 ACPI_WALK_STATE *WalkState);
497 AcpiExOpcode_1A_1T_1R (
498 ACPI_WALK_STATE *WalkState);
501 AcpiExOpcode_1A_1T_0R (
502 ACPI_WALK_STATE *WalkState);
505 * exdyadic - ACPI AML (p-code) execution, dyadic operators
509 AcpiExOpcode_2A_0T_0R (
510 ACPI_WALK_STATE *WalkState);
513 AcpiExOpcode_2A_0T_1R (
514 ACPI_WALK_STATE *WalkState);
517 AcpiExOpcode_2A_1T_1R (
518 ACPI_WALK_STATE *WalkState);
521 AcpiExOpcode_2A_2T_1R (
522 ACPI_WALK_STATE *WalkState);
526 * exresolv - Object resolution and get value functions
530 AcpiExResolveToValue (
531 ACPI_OPERAND_OBJECT **StackPtr,
532 ACPI_WALK_STATE *WalkState);
535 AcpiExResolveNodeToValue (
536 ACPI_NAMESPACE_NODE **StackPtr,
537 ACPI_WALK_STATE *WalkState);
540 AcpiExResolveObjectToValue (
541 ACPI_OPERAND_OBJECT **StackPtr,
542 ACPI_WALK_STATE *WalkState);
546 * exdump - Scanner debug output routines
551 ACPI_OPERAND_OBJECT *EntryDesc);
555 ACPI_OPERAND_OBJECT **Operands,
556 ACPI_INTERPRETER_MODE InterpreterMode,
564 AcpiExDumpObjectDescriptor (
565 ACPI_OPERAND_OBJECT *Object,
570 ACPI_NAMESPACE_NODE *Node,
591 ACPI_PHYSICAL_ADDRESS Value);
595 * exnames - interpreter/scanner name load/execute
599 AcpiExAllocateNameString (
609 UINT8 **InAmlAddress,
613 AcpiExGetNameString (
614 ACPI_OBJECT_TYPE DataType,
616 char **OutNameString,
617 UINT32 *OutNameLength);
621 ACPI_OBJECT_TYPE DataType,
622 ACPI_INTERPRETER_MODE LoadExecMode);
626 * exstore - Object store support
631 ACPI_OPERAND_OBJECT *ValDesc,
632 ACPI_OPERAND_OBJECT *DestDesc,
633 ACPI_WALK_STATE *WalkState);
636 AcpiExStoreObjectToIndex (
637 ACPI_OPERAND_OBJECT *ValDesc,
638 ACPI_OPERAND_OBJECT *DestDesc,
639 ACPI_WALK_STATE *WalkState);
642 AcpiExStoreObjectToNode (
643 ACPI_OPERAND_OBJECT *SourceDesc,
644 ACPI_NAMESPACE_NODE *Node,
645 ACPI_WALK_STATE *WalkState,
646 UINT8 ImplicitConversion);
648 #define ACPI_IMPLICIT_CONVERSION TRUE
649 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
656 AcpiExResolveObject (
657 ACPI_OPERAND_OBJECT **SourceDescPtr,
658 ACPI_OBJECT_TYPE TargetType,
659 ACPI_WALK_STATE *WalkState);
662 AcpiExStoreObjectToObject (
663 ACPI_OPERAND_OBJECT *SourceDesc,
664 ACPI_OPERAND_OBJECT *DestDesc,
665 ACPI_OPERAND_OBJECT **NewDesc,
666 ACPI_WALK_STATE *WalkState);
670 * excopy - object copy
674 AcpiExStoreBufferToBuffer (
675 ACPI_OPERAND_OBJECT *SourceDesc,
676 ACPI_OPERAND_OBJECT *TargetDesc);
679 AcpiExStoreStringToString (
680 ACPI_OPERAND_OBJECT *SourceDesc,
681 ACPI_OPERAND_OBJECT *TargetDesc);
684 AcpiExCopyIntegerToIndexField (
685 ACPI_OPERAND_OBJECT *SourceDesc,
686 ACPI_OPERAND_OBJECT *TargetDesc);
689 AcpiExCopyIntegerToBankField (
690 ACPI_OPERAND_OBJECT *SourceDesc,
691 ACPI_OPERAND_OBJECT *TargetDesc);
694 AcpiExCopyDataToNamedField (
695 ACPI_OPERAND_OBJECT *SourceDesc,
696 ACPI_NAMESPACE_NODE *Node);
699 AcpiExCopyIntegerToBufferField (
700 ACPI_OPERAND_OBJECT *SourceDesc,
701 ACPI_OPERAND_OBJECT *TargetDesc);
704 * exutils - interpreter/scanner utilities
708 AcpiExEnterInterpreter (
712 AcpiExExitInterpreter (
716 AcpiExTruncateFor32bitTable (
717 ACPI_OPERAND_OBJECT *ObjDesc);
720 AcpiExAcquireGlobalLock (
724 AcpiExReleaseGlobalLock (
733 AcpiExEisaIdToString (
738 AcpiExUnsignedIntegerToString (
744 * exregion - default OpRegion handlers
748 AcpiExSystemMemorySpaceHandler (
750 ACPI_PHYSICAL_ADDRESS Address,
753 void *HandlerContext,
754 void *RegionContext);
757 AcpiExSystemIoSpaceHandler (
759 ACPI_PHYSICAL_ADDRESS Address,
762 void *HandlerContext,
763 void *RegionContext);
766 AcpiExPciConfigSpaceHandler (
768 ACPI_PHYSICAL_ADDRESS Address,
771 void *HandlerContext,
772 void *RegionContext);
775 AcpiExCmosSpaceHandler (
777 ACPI_PHYSICAL_ADDRESS Address,
780 void *HandlerContext,
781 void *RegionContext);
784 AcpiExPciBarSpaceHandler (
786 ACPI_PHYSICAL_ADDRESS Address,
789 void *HandlerContext,
790 void *RegionContext);
793 AcpiExEmbeddedControllerSpaceHandler (
795 ACPI_PHYSICAL_ADDRESS Address,
798 void *HandlerContext,
799 void *RegionContext);
802 AcpiExSmBusSpaceHandler (
804 ACPI_PHYSICAL_ADDRESS Address,
807 void *HandlerContext,
808 void *RegionContext);
812 AcpiExDataTableSpaceHandler (
814 ACPI_PHYSICAL_ADDRESS Address,
817 void *HandlerContext,
818 void *RegionContext);
820 #endif /* __INTERP_H__ */