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,
162 AcpiExConvertToBuffer (
163 ACPI_OPERAND_OBJECT *ObjDesc,
164 ACPI_OPERAND_OBJECT **ResultDesc);
167 AcpiExConvertToString (
168 ACPI_OPERAND_OBJECT *ObjDesc,
169 ACPI_OPERAND_OBJECT **ResultDesc,
172 /* Types for ->String conversion */
174 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
175 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
176 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
177 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
180 AcpiExConvertToTargetType (
181 ACPI_OBJECT_TYPE DestinationType,
182 ACPI_OPERAND_OBJECT *SourceDesc,
183 ACPI_OPERAND_OBJECT **ResultDesc,
184 ACPI_WALK_STATE *WalkState);
187 AcpiExConvertToAscii (
188 ACPI_INTEGER Integer,
194 * exfield - ACPI AML (p-code) execution - field manipulation
198 AcpiExCommonBufferSetup (
199 ACPI_OPERAND_OBJECT *ObjDesc,
204 AcpiExExtractFromField (
205 ACPI_OPERAND_OBJECT *ObjDesc,
207 UINT32 BufferLength);
210 AcpiExInsertIntoField (
211 ACPI_OPERAND_OBJECT *ObjDesc,
213 UINT32 BufferLength);
217 ACPI_OPERAND_OBJECT *ObjDesc,
218 UINT32 FieldDatumByteOffset);
222 ACPI_OPERAND_OBJECT *ObjDesc,
223 UINT32 FieldDatumByteOffset,
228 AcpiExRegisterOverflow (
229 ACPI_OPERAND_OBJECT *ObjDesc,
234 ACPI_OPERAND_OBJECT *ObjDesc,
235 UINT32 FieldDatumByteOffset,
240 AcpiExWriteWithUpdateRule (
241 ACPI_OPERAND_OBJECT *ObjDesc,
243 ACPI_INTEGER FieldValue,
244 UINT32 FieldDatumByteOffset);
247 AcpiExGetBufferDatum(
251 UINT32 ByteGranularity,
252 UINT32 BufferOffset);
255 AcpiExSetBufferDatum (
256 ACPI_INTEGER MergedDatum,
259 UINT32 ByteGranularity,
260 UINT32 BufferOffset);
263 AcpiExReadDataFromField (
264 ACPI_WALK_STATE *WalkState,
265 ACPI_OPERAND_OBJECT *ObjDesc,
266 ACPI_OPERAND_OBJECT **RetBufferDesc);
269 AcpiExWriteDataToField (
270 ACPI_OPERAND_OBJECT *SourceDesc,
271 ACPI_OPERAND_OBJECT *ObjDesc,
272 ACPI_OPERAND_OBJECT **ResultDesc);
275 * exmisc - ACPI AML (p-code) execution - specific opcodes
279 AcpiExOpcode_3A_0T_0R (
280 ACPI_WALK_STATE *WalkState);
283 AcpiExOpcode_3A_1T_1R (
284 ACPI_WALK_STATE *WalkState);
287 AcpiExOpcode_6A_0T_1R (
288 ACPI_WALK_STATE *WalkState);
293 ACPI_INTEGER PackageValue,
294 ACPI_INTEGER MatchValue);
297 AcpiExGetObjectReference (
298 ACPI_OPERAND_OBJECT *ObjDesc,
299 ACPI_OPERAND_OBJECT **ReturnDesc,
300 ACPI_WALK_STATE *WalkState);
303 AcpiExResolveMultiple (
304 ACPI_WALK_STATE *WalkState,
305 ACPI_OPERAND_OBJECT *Operand,
306 ACPI_OBJECT_TYPE *ReturnType,
307 ACPI_OPERAND_OBJECT **ReturnDesc);
310 AcpiExConcatTemplate (
311 ACPI_OPERAND_OBJECT *ObjDesc,
312 ACPI_OPERAND_OBJECT *ObjDesc2,
313 ACPI_OPERAND_OBJECT **ActualReturnDesc,
314 ACPI_WALK_STATE *WalkState);
317 AcpiExDoConcatenate (
318 ACPI_OPERAND_OBJECT *ObjDesc,
319 ACPI_OPERAND_OBJECT *ObjDesc2,
320 ACPI_OPERAND_OBJECT **ActualReturnDesc,
321 ACPI_WALK_STATE *WalkState);
324 AcpiExDoLogicalNumericOp (
326 ACPI_INTEGER Integer0,
327 ACPI_INTEGER Integer1,
328 BOOLEAN *LogicalResult);
333 ACPI_OPERAND_OBJECT *Operand0,
334 ACPI_OPERAND_OBJECT *Operand1,
335 BOOLEAN *LogicalResult);
340 ACPI_INTEGER Operand0,
341 ACPI_INTEGER Operand1);
345 ACPI_WALK_STATE *WalkState);
348 AcpiExCreateProcessor (
349 ACPI_WALK_STATE *WalkState);
352 AcpiExCreatePowerResource (
353 ACPI_WALK_STATE *WalkState);
360 ACPI_WALK_STATE *WalkState);
363 AcpiExCreateTableRegion (
364 ACPI_WALK_STATE *WalkState);
368 ACPI_WALK_STATE *WalkState);
372 ACPI_WALK_STATE *WalkState);
378 ACPI_WALK_STATE *WalkState);
382 * exconfig - dynamic table load/unload
387 ACPI_TABLE_HEADER *Table,
388 ACPI_NAMESPACE_NODE *ParentNode,
389 ACPI_OPERAND_OBJECT **DdbHandle);
393 ACPI_OPERAND_OBJECT *ObjDesc,
394 ACPI_OPERAND_OBJECT *Target,
395 ACPI_WALK_STATE *WalkState);
399 ACPI_WALK_STATE *WalkState,
400 ACPI_OPERAND_OBJECT **ReturnDesc);
404 ACPI_OPERAND_OBJECT *DdbHandle);
408 * exmutex - mutex support
413 ACPI_OPERAND_OBJECT *TimeDesc,
414 ACPI_OPERAND_OBJECT *ObjDesc,
415 ACPI_WALK_STATE *WalkState);
419 ACPI_OPERAND_OBJECT *ObjDesc,
420 ACPI_WALK_STATE *WalkState);
423 AcpiExReleaseAllMutexes (
424 ACPI_THREAD_STATE *Thread);
428 ACPI_OPERAND_OBJECT *ObjDesc);
432 ACPI_OPERAND_OBJECT *ObjDesc,
433 ACPI_THREAD_STATE *Thread);
436 * exprep - ACPI AML (p-code) execution - prep utilities
440 AcpiExPrepCommonFieldObject (
441 ACPI_OPERAND_OBJECT *ObjDesc,
443 UINT8 FieldAttribute,
444 UINT32 FieldBitPosition,
445 UINT32 FieldBitLength);
448 AcpiExPrepFieldValue (
449 ACPI_CREATE_FIELD_INFO *Info);
452 * exsystem - Interface to OS services
456 AcpiExSystemDoNotifyOp (
457 ACPI_OPERAND_OBJECT *Value,
458 ACPI_OPERAND_OBJECT *ObjDesc);
461 AcpiExSystemDoSuspend(
465 AcpiExSystemDoStall (
469 AcpiExSystemAcquireMutex(
470 ACPI_OPERAND_OBJECT *Time,
471 ACPI_OPERAND_OBJECT *ObjDesc);
474 AcpiExSystemReleaseMutex(
475 ACPI_OPERAND_OBJECT *ObjDesc);
478 AcpiExSystemSignalEvent(
479 ACPI_OPERAND_OBJECT *ObjDesc);
482 AcpiExSystemWaitEvent(
483 ACPI_OPERAND_OBJECT *Time,
484 ACPI_OPERAND_OBJECT *ObjDesc);
487 AcpiExSystemResetEvent(
488 ACPI_OPERAND_OBJECT *ObjDesc);
491 AcpiExSystemWaitSemaphore (
492 ACPI_HANDLE Semaphore,
497 * exmonadic - ACPI AML (p-code) execution, monadic operators
501 AcpiExOpcode_0A_0T_1R (
502 ACPI_WALK_STATE *WalkState);
505 AcpiExOpcode_1A_0T_0R (
506 ACPI_WALK_STATE *WalkState);
509 AcpiExOpcode_1A_0T_1R (
510 ACPI_WALK_STATE *WalkState);
513 AcpiExOpcode_1A_1T_1R (
514 ACPI_WALK_STATE *WalkState);
517 AcpiExOpcode_1A_1T_0R (
518 ACPI_WALK_STATE *WalkState);
521 * exdyadic - ACPI AML (p-code) execution, dyadic operators
525 AcpiExOpcode_2A_0T_0R (
526 ACPI_WALK_STATE *WalkState);
529 AcpiExOpcode_2A_0T_1R (
530 ACPI_WALK_STATE *WalkState);
533 AcpiExOpcode_2A_1T_1R (
534 ACPI_WALK_STATE *WalkState);
537 AcpiExOpcode_2A_2T_1R (
538 ACPI_WALK_STATE *WalkState);
542 * exresolv - Object resolution and get value functions
546 AcpiExResolveToValue (
547 ACPI_OPERAND_OBJECT **StackPtr,
548 ACPI_WALK_STATE *WalkState);
551 AcpiExResolveNodeToValue (
552 ACPI_NAMESPACE_NODE **StackPtr,
553 ACPI_WALK_STATE *WalkState);
556 AcpiExResolveObjectToValue (
557 ACPI_OPERAND_OBJECT **StackPtr,
558 ACPI_WALK_STATE *WalkState);
562 * exdump - Interpreter debug output routines
567 ACPI_OPERAND_OBJECT *ObjDesc,
572 ACPI_OPERAND_OBJECT **Operands,
573 ACPI_INTERPRETER_MODE InterpreterMode,
581 AcpiExDumpObjectDescriptor (
582 ACPI_OPERAND_OBJECT *Object,
587 ACPI_NAMESPACE_NODE *Node,
608 ACPI_PHYSICAL_ADDRESS Value);
612 * exnames - interpreter/scanner name load/execute
616 AcpiExAllocateNameString (
626 UINT8 **InAmlAddress,
630 AcpiExGetNameString (
631 ACPI_OBJECT_TYPE DataType,
633 char **OutNameString,
634 UINT32 *OutNameLength);
638 ACPI_OBJECT_TYPE DataType,
639 ACPI_INTERPRETER_MODE LoadExecMode);
643 * exstore - Object store support
648 ACPI_OPERAND_OBJECT *ValDesc,
649 ACPI_OPERAND_OBJECT *DestDesc,
650 ACPI_WALK_STATE *WalkState);
653 AcpiExStoreObjectToIndex (
654 ACPI_OPERAND_OBJECT *ValDesc,
655 ACPI_OPERAND_OBJECT *DestDesc,
656 ACPI_WALK_STATE *WalkState);
659 AcpiExStoreObjectToNode (
660 ACPI_OPERAND_OBJECT *SourceDesc,
661 ACPI_NAMESPACE_NODE *Node,
662 ACPI_WALK_STATE *WalkState,
663 UINT8 ImplicitConversion);
665 #define ACPI_IMPLICIT_CONVERSION TRUE
666 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
673 AcpiExResolveObject (
674 ACPI_OPERAND_OBJECT **SourceDescPtr,
675 ACPI_OBJECT_TYPE TargetType,
676 ACPI_WALK_STATE *WalkState);
679 AcpiExStoreObjectToObject (
680 ACPI_OPERAND_OBJECT *SourceDesc,
681 ACPI_OPERAND_OBJECT *DestDesc,
682 ACPI_OPERAND_OBJECT **NewDesc,
683 ACPI_WALK_STATE *WalkState);
687 * excopy - object copy
691 AcpiExStoreBufferToBuffer (
692 ACPI_OPERAND_OBJECT *SourceDesc,
693 ACPI_OPERAND_OBJECT *TargetDesc);
696 AcpiExStoreStringToString (
697 ACPI_OPERAND_OBJECT *SourceDesc,
698 ACPI_OPERAND_OBJECT *TargetDesc);
701 AcpiExCopyIntegerToIndexField (
702 ACPI_OPERAND_OBJECT *SourceDesc,
703 ACPI_OPERAND_OBJECT *TargetDesc);
706 AcpiExCopyIntegerToBankField (
707 ACPI_OPERAND_OBJECT *SourceDesc,
708 ACPI_OPERAND_OBJECT *TargetDesc);
711 AcpiExCopyDataToNamedField (
712 ACPI_OPERAND_OBJECT *SourceDesc,
713 ACPI_NAMESPACE_NODE *Node);
716 AcpiExCopyIntegerToBufferField (
717 ACPI_OPERAND_OBJECT *SourceDesc,
718 ACPI_OPERAND_OBJECT *TargetDesc);
721 * exutils - interpreter/scanner utilities
725 AcpiExEnterInterpreter (
729 AcpiExExitInterpreter (
733 AcpiExTruncateFor32bitTable (
734 ACPI_OPERAND_OBJECT *ObjDesc);
737 AcpiExAcquireGlobalLock (
741 AcpiExReleaseGlobalLock (
750 AcpiExEisaIdToString (
755 AcpiExUnsignedIntegerToString (
761 * exregion - default OpRegion handlers
765 AcpiExSystemMemorySpaceHandler (
767 ACPI_PHYSICAL_ADDRESS Address,
770 void *HandlerContext,
771 void *RegionContext);
774 AcpiExSystemIoSpaceHandler (
776 ACPI_PHYSICAL_ADDRESS Address,
779 void *HandlerContext,
780 void *RegionContext);
783 AcpiExPciConfigSpaceHandler (
785 ACPI_PHYSICAL_ADDRESS Address,
788 void *HandlerContext,
789 void *RegionContext);
792 AcpiExCmosSpaceHandler (
794 ACPI_PHYSICAL_ADDRESS Address,
797 void *HandlerContext,
798 void *RegionContext);
801 AcpiExPciBarSpaceHandler (
803 ACPI_PHYSICAL_ADDRESS Address,
806 void *HandlerContext,
807 void *RegionContext);
810 AcpiExEmbeddedControllerSpaceHandler (
812 ACPI_PHYSICAL_ADDRESS Address,
815 void *HandlerContext,
816 void *RegionContext);
819 AcpiExSmBusSpaceHandler (
821 ACPI_PHYSICAL_ADDRESS Address,
824 void *HandlerContext,
825 void *RegionContext);
829 AcpiExDataTableSpaceHandler (
831 ACPI_PHYSICAL_ADDRESS Address,
834 void *HandlerContext,
835 void *RegionContext);
837 #endif /* __INTERP_H__ */