1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 AcpiExExtractFromField (
195 ACPI_OPERAND_OBJECT *ObjDesc,
197 UINT32 BufferLength);
200 AcpiExInsertIntoField (
201 ACPI_OPERAND_OBJECT *ObjDesc,
203 UINT32 BufferLength);
207 ACPI_OPERAND_OBJECT *ObjDesc,
208 UINT32 FieldDatumByteOffset);
212 ACPI_OPERAND_OBJECT *ObjDesc,
213 UINT32 FieldDatumByteOffset,
218 AcpiExRegisterOverflow (
219 ACPI_OPERAND_OBJECT *ObjDesc,
224 ACPI_OPERAND_OBJECT *ObjDesc,
225 UINT32 FieldDatumByteOffset,
230 AcpiExWriteWithUpdateRule (
231 ACPI_OPERAND_OBJECT *ObjDesc,
233 ACPI_INTEGER FieldValue,
234 UINT32 FieldDatumByteOffset);
237 AcpiExGetBufferDatum(
241 UINT32 ByteGranularity,
242 UINT32 BufferOffset);
245 AcpiExSetBufferDatum (
246 ACPI_INTEGER MergedDatum,
249 UINT32 ByteGranularity,
250 UINT32 BufferOffset);
253 AcpiExReadDataFromField (
254 ACPI_WALK_STATE *WalkState,
255 ACPI_OPERAND_OBJECT *ObjDesc,
256 ACPI_OPERAND_OBJECT **RetBufferDesc);
259 AcpiExWriteDataToField (
260 ACPI_OPERAND_OBJECT *SourceDesc,
261 ACPI_OPERAND_OBJECT *ObjDesc,
262 ACPI_OPERAND_OBJECT **ResultDesc);
265 * exmisc - ACPI AML (p-code) execution - specific opcodes
269 AcpiExOpcode_3A_0T_0R (
270 ACPI_WALK_STATE *WalkState);
273 AcpiExOpcode_3A_1T_1R (
274 ACPI_WALK_STATE *WalkState);
277 AcpiExOpcode_6A_0T_1R (
278 ACPI_WALK_STATE *WalkState);
283 ACPI_INTEGER PackageValue,
284 ACPI_INTEGER MatchValue);
287 AcpiExGetObjectReference (
288 ACPI_OPERAND_OBJECT *ObjDesc,
289 ACPI_OPERAND_OBJECT **ReturnDesc,
290 ACPI_WALK_STATE *WalkState);
293 AcpiExResolveMultiple (
294 ACPI_WALK_STATE *WalkState,
295 ACPI_OPERAND_OBJECT *Operand,
296 ACPI_OBJECT_TYPE *ReturnType,
297 ACPI_OPERAND_OBJECT **ReturnDesc);
300 AcpiExConcatTemplate (
301 ACPI_OPERAND_OBJECT *ObjDesc,
302 ACPI_OPERAND_OBJECT *ObjDesc2,
303 ACPI_OPERAND_OBJECT **ActualReturnDesc,
304 ACPI_WALK_STATE *WalkState);
307 AcpiExDoConcatenate (
308 ACPI_OPERAND_OBJECT *ObjDesc,
309 ACPI_OPERAND_OBJECT *ObjDesc2,
310 ACPI_OPERAND_OBJECT **ActualReturnDesc,
311 ACPI_WALK_STATE *WalkState);
316 ACPI_INTEGER Operand0,
317 ACPI_INTEGER Operand1);
322 ACPI_INTEGER Operand0,
323 ACPI_INTEGER Operand1);
327 ACPI_WALK_STATE *WalkState);
330 AcpiExCreateProcessor (
331 ACPI_WALK_STATE *WalkState);
334 AcpiExCreatePowerResource (
335 ACPI_WALK_STATE *WalkState);
342 ACPI_WALK_STATE *WalkState);
345 AcpiExCreateTableRegion (
346 ACPI_WALK_STATE *WalkState);
350 ACPI_WALK_STATE *WalkState);
354 ACPI_WALK_STATE *WalkState);
360 ACPI_WALK_STATE *WalkState);
364 * exconfig - dynamic table load/unload
369 ACPI_TABLE_HEADER *Table,
370 ACPI_NAMESPACE_NODE *ParentNode,
371 ACPI_OPERAND_OBJECT **DdbHandle);
375 ACPI_OPERAND_OBJECT *ObjDesc,
376 ACPI_OPERAND_OBJECT *Target,
377 ACPI_WALK_STATE *WalkState);
381 ACPI_WALK_STATE *WalkState,
382 ACPI_OPERAND_OBJECT **ReturnDesc);
386 ACPI_OPERAND_OBJECT *DdbHandle);
390 * exmutex - mutex support
395 ACPI_OPERAND_OBJECT *TimeDesc,
396 ACPI_OPERAND_OBJECT *ObjDesc,
397 ACPI_WALK_STATE *WalkState);
401 ACPI_OPERAND_OBJECT *ObjDesc,
402 ACPI_WALK_STATE *WalkState);
405 AcpiExReleaseAllMutexes (
406 ACPI_THREAD_STATE *Thread);
410 ACPI_OPERAND_OBJECT *ObjDesc);
414 ACPI_OPERAND_OBJECT *ObjDesc,
415 ACPI_THREAD_STATE *Thread);
418 * exprep - ACPI AML (p-code) execution - prep utilities
422 AcpiExPrepCommonFieldObject (
423 ACPI_OPERAND_OBJECT *ObjDesc,
425 UINT8 FieldAttribute,
426 UINT32 FieldBitPosition,
427 UINT32 FieldBitLength);
430 AcpiExPrepFieldValue (
431 ACPI_CREATE_FIELD_INFO *Info);
434 * exsystem - Interface to OS services
438 AcpiExSystemDoNotifyOp (
439 ACPI_OPERAND_OBJECT *Value,
440 ACPI_OPERAND_OBJECT *ObjDesc);
443 AcpiExSystemDoSuspend(
447 AcpiExSystemDoStall (
451 AcpiExSystemAcquireMutex(
452 ACPI_OPERAND_OBJECT *Time,
453 ACPI_OPERAND_OBJECT *ObjDesc);
456 AcpiExSystemReleaseMutex(
457 ACPI_OPERAND_OBJECT *ObjDesc);
460 AcpiExSystemSignalEvent(
461 ACPI_OPERAND_OBJECT *ObjDesc);
464 AcpiExSystemWaitEvent(
465 ACPI_OPERAND_OBJECT *Time,
466 ACPI_OPERAND_OBJECT *ObjDesc);
469 AcpiExSystemResetEvent(
470 ACPI_OPERAND_OBJECT *ObjDesc);
473 AcpiExSystemWaitSemaphore (
474 ACPI_HANDLE Semaphore,
479 * exmonadic - ACPI AML (p-code) execution, monadic operators
483 AcpiExOpcode_1A_0T_0R (
484 ACPI_WALK_STATE *WalkState);
487 AcpiExOpcode_1A_0T_1R (
488 ACPI_WALK_STATE *WalkState);
491 AcpiExOpcode_1A_1T_1R (
492 ACPI_WALK_STATE *WalkState);
495 AcpiExOpcode_1A_1T_0R (
496 ACPI_WALK_STATE *WalkState);
499 * exdyadic - ACPI AML (p-code) execution, dyadic operators
503 AcpiExOpcode_2A_0T_0R (
504 ACPI_WALK_STATE *WalkState);
507 AcpiExOpcode_2A_0T_1R (
508 ACPI_WALK_STATE *WalkState);
511 AcpiExOpcode_2A_1T_1R (
512 ACPI_WALK_STATE *WalkState);
515 AcpiExOpcode_2A_2T_1R (
516 ACPI_WALK_STATE *WalkState);
520 * exresolv - Object resolution and get value functions
524 AcpiExResolveToValue (
525 ACPI_OPERAND_OBJECT **StackPtr,
526 ACPI_WALK_STATE *WalkState);
529 AcpiExResolveNodeToValue (
530 ACPI_NAMESPACE_NODE **StackPtr,
531 ACPI_WALK_STATE *WalkState);
534 AcpiExResolveObjectToValue (
535 ACPI_OPERAND_OBJECT **StackPtr,
536 ACPI_WALK_STATE *WalkState);
540 * exdump - Scanner debug output routines
545 ACPI_OPERAND_OBJECT *EntryDesc);
549 ACPI_OPERAND_OBJECT **Operands,
550 ACPI_INTERPRETER_MODE InterpreterMode,
558 AcpiExDumpObjectDescriptor (
559 ACPI_OPERAND_OBJECT *Object,
564 ACPI_NAMESPACE_NODE *Node,
585 ACPI_PHYSICAL_ADDRESS Value);
589 * exnames - interpreter/scanner name load/execute
593 AcpiExAllocateNameString (
603 UINT8 **InAmlAddress,
607 AcpiExGetNameString (
608 ACPI_OBJECT_TYPE DataType,
610 char **OutNameString,
611 UINT32 *OutNameLength);
615 ACPI_OBJECT_TYPE DataType,
616 ACPI_INTERPRETER_MODE LoadExecMode);
620 * exstore - Object store support
625 ACPI_OPERAND_OBJECT *ValDesc,
626 ACPI_OPERAND_OBJECT *DestDesc,
627 ACPI_WALK_STATE *WalkState);
630 AcpiExStoreObjectToIndex (
631 ACPI_OPERAND_OBJECT *ValDesc,
632 ACPI_OPERAND_OBJECT *DestDesc,
633 ACPI_WALK_STATE *WalkState);
636 AcpiExStoreObjectToNode (
637 ACPI_OPERAND_OBJECT *SourceDesc,
638 ACPI_NAMESPACE_NODE *Node,
639 ACPI_WALK_STATE *WalkState);
647 AcpiExResolveObject (
648 ACPI_OPERAND_OBJECT **SourceDescPtr,
649 ACPI_OBJECT_TYPE TargetType,
650 ACPI_WALK_STATE *WalkState);
653 AcpiExStoreObjectToObject (
654 ACPI_OPERAND_OBJECT *SourceDesc,
655 ACPI_OPERAND_OBJECT *DestDesc,
656 ACPI_OPERAND_OBJECT **NewDesc,
657 ACPI_WALK_STATE *WalkState);
661 * excopy - object copy
665 AcpiExStoreBufferToBuffer (
666 ACPI_OPERAND_OBJECT *SourceDesc,
667 ACPI_OPERAND_OBJECT *TargetDesc);
670 AcpiExStoreStringToString (
671 ACPI_OPERAND_OBJECT *SourceDesc,
672 ACPI_OPERAND_OBJECT *TargetDesc);
675 AcpiExCopyIntegerToIndexField (
676 ACPI_OPERAND_OBJECT *SourceDesc,
677 ACPI_OPERAND_OBJECT *TargetDesc);
680 AcpiExCopyIntegerToBankField (
681 ACPI_OPERAND_OBJECT *SourceDesc,
682 ACPI_OPERAND_OBJECT *TargetDesc);
685 AcpiExCopyDataToNamedField (
686 ACPI_OPERAND_OBJECT *SourceDesc,
687 ACPI_NAMESPACE_NODE *Node);
690 AcpiExCopyIntegerToBufferField (
691 ACPI_OPERAND_OBJECT *SourceDesc,
692 ACPI_OPERAND_OBJECT *TargetDesc);
695 * exutils - interpreter/scanner utilities
699 AcpiExEnterInterpreter (
703 AcpiExExitInterpreter (
707 AcpiExTruncateFor32bitTable (
708 ACPI_OPERAND_OBJECT *ObjDesc);
711 AcpiExAcquireGlobalLock (
715 AcpiExReleaseGlobalLock (
724 AcpiExEisaIdToString (
729 AcpiExUnsignedIntegerToString (
735 * exregion - default OpRegion handlers
739 AcpiExSystemMemorySpaceHandler (
741 ACPI_PHYSICAL_ADDRESS Address,
744 void *HandlerContext,
745 void *RegionContext);
748 AcpiExSystemIoSpaceHandler (
750 ACPI_PHYSICAL_ADDRESS Address,
753 void *HandlerContext,
754 void *RegionContext);
757 AcpiExPciConfigSpaceHandler (
759 ACPI_PHYSICAL_ADDRESS Address,
762 void *HandlerContext,
763 void *RegionContext);
766 AcpiExCmosSpaceHandler (
768 ACPI_PHYSICAL_ADDRESS Address,
771 void *HandlerContext,
772 void *RegionContext);
775 AcpiExPciBarSpaceHandler (
777 ACPI_PHYSICAL_ADDRESS Address,
780 void *HandlerContext,
781 void *RegionContext);
784 AcpiExEmbeddedControllerSpaceHandler (
786 ACPI_PHYSICAL_ADDRESS Address,
789 void *HandlerContext,
790 void *RegionContext);
793 AcpiExSmBusSpaceHandler (
795 ACPI_PHYSICAL_ADDRESS Address,
798 void *HandlerContext,
799 void *RegionContext);
803 AcpiExDataTableSpaceHandler (
805 ACPI_PHYSICAL_ADDRESS Address,
808 void *HandlerContext,
809 void *RegionContext);
811 #endif /* __INTERP_H__ */