1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2006, 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]))
123 /* Macros for tables used for debug output */
125 #define ACPI_EXD_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_OPERAND_OBJECT,f)
126 #define ACPI_EXD_NSOFFSET(f) (UINT8) ACPI_OFFSET (ACPI_NAMESPACE_NODE,f)
127 #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (ACPI_EXDUMP_INFO))
130 * If possible, pack the following structures to byte alignment, since we
131 * don't care about performance for debug output. Two cases where we cannot
132 * pack the structures:
134 * 1) Hardware does not support misaligned memory transfers
135 * 2) Compiler does not support pointers within packed structures
137 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
141 typedef const struct acpi_exdump_info
149 /* Values for the Opcode field above */
151 #define ACPI_EXD_INIT 0
152 #define ACPI_EXD_TYPE 1
153 #define ACPI_EXD_UINT8 2
154 #define ACPI_EXD_UINT16 3
155 #define ACPI_EXD_UINT32 4
156 #define ACPI_EXD_UINT64 5
157 #define ACPI_EXD_LITERAL 6
158 #define ACPI_EXD_POINTER 7
159 #define ACPI_EXD_ADDRESS 8
160 #define ACPI_EXD_STRING 9
161 #define ACPI_EXD_BUFFER 10
162 #define ACPI_EXD_PACKAGE 11
163 #define ACPI_EXD_FIELD 12
164 #define ACPI_EXD_REFERENCE 13
166 /* restore default alignment */
172 * exconvrt - object conversion
175 AcpiExConvertToInteger (
176 ACPI_OPERAND_OBJECT *ObjDesc,
177 ACPI_OPERAND_OBJECT **ResultDesc,
181 AcpiExConvertToBuffer (
182 ACPI_OPERAND_OBJECT *ObjDesc,
183 ACPI_OPERAND_OBJECT **ResultDesc);
186 AcpiExConvertToString (
187 ACPI_OPERAND_OBJECT *ObjDesc,
188 ACPI_OPERAND_OBJECT **ResultDesc,
191 /* Types for ->String conversion */
193 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
194 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
195 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
196 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
199 AcpiExConvertToTargetType (
200 ACPI_OBJECT_TYPE DestinationType,
201 ACPI_OPERAND_OBJECT *SourceDesc,
202 ACPI_OPERAND_OBJECT **ResultDesc,
203 ACPI_WALK_STATE *WalkState);
207 * exfield - ACPI AML (p-code) execution - field manipulation
210 AcpiExCommonBufferSetup (
211 ACPI_OPERAND_OBJECT *ObjDesc,
216 AcpiExWriteWithUpdateRule (
217 ACPI_OPERAND_OBJECT *ObjDesc,
219 ACPI_INTEGER FieldValue,
220 UINT32 FieldDatumByteOffset);
223 AcpiExGetBufferDatum(
227 UINT32 ByteGranularity,
228 UINT32 BufferOffset);
231 AcpiExSetBufferDatum (
232 ACPI_INTEGER MergedDatum,
235 UINT32 ByteGranularity,
236 UINT32 BufferOffset);
239 AcpiExReadDataFromField (
240 ACPI_WALK_STATE *WalkState,
241 ACPI_OPERAND_OBJECT *ObjDesc,
242 ACPI_OPERAND_OBJECT **RetBufferDesc);
245 AcpiExWriteDataToField (
246 ACPI_OPERAND_OBJECT *SourceDesc,
247 ACPI_OPERAND_OBJECT *ObjDesc,
248 ACPI_OPERAND_OBJECT **ResultDesc);
252 * exfldio - low level field I/O
255 AcpiExExtractFromField (
256 ACPI_OPERAND_OBJECT *ObjDesc,
258 UINT32 BufferLength);
261 AcpiExInsertIntoField (
262 ACPI_OPERAND_OBJECT *ObjDesc,
264 UINT32 BufferLength);
268 ACPI_OPERAND_OBJECT *ObjDesc,
269 UINT32 FieldDatumByteOffset,
275 * exmisc - misc support routines
278 AcpiExGetObjectReference (
279 ACPI_OPERAND_OBJECT *ObjDesc,
280 ACPI_OPERAND_OBJECT **ReturnDesc,
281 ACPI_WALK_STATE *WalkState);
284 AcpiExConcatTemplate (
285 ACPI_OPERAND_OBJECT *ObjDesc,
286 ACPI_OPERAND_OBJECT *ObjDesc2,
287 ACPI_OPERAND_OBJECT **ActualReturnDesc,
288 ACPI_WALK_STATE *WalkState);
291 AcpiExDoConcatenate (
292 ACPI_OPERAND_OBJECT *ObjDesc,
293 ACPI_OPERAND_OBJECT *ObjDesc2,
294 ACPI_OPERAND_OBJECT **ActualReturnDesc,
295 ACPI_WALK_STATE *WalkState);
298 AcpiExDoLogicalNumericOp (
300 ACPI_INTEGER Integer0,
301 ACPI_INTEGER Integer1,
302 BOOLEAN *LogicalResult);
307 ACPI_OPERAND_OBJECT *Operand0,
308 ACPI_OPERAND_OBJECT *Operand1,
309 BOOLEAN *LogicalResult);
314 ACPI_INTEGER Operand0,
315 ACPI_INTEGER Operand1);
319 ACPI_WALK_STATE *WalkState);
322 AcpiExCreateProcessor (
323 ACPI_WALK_STATE *WalkState);
326 AcpiExCreatePowerResource (
327 ACPI_WALK_STATE *WalkState);
334 ACPI_WALK_STATE *WalkState);
337 AcpiExCreateTableRegion (
338 ACPI_WALK_STATE *WalkState);
342 ACPI_WALK_STATE *WalkState);
346 ACPI_WALK_STATE *WalkState);
352 ACPI_WALK_STATE *WalkState);
356 * exconfig - dynamic table load/unload
360 ACPI_OPERAND_OBJECT *ObjDesc,
361 ACPI_OPERAND_OBJECT *Target,
362 ACPI_WALK_STATE *WalkState);
366 ACPI_WALK_STATE *WalkState,
367 ACPI_OPERAND_OBJECT **ReturnDesc);
371 ACPI_OPERAND_OBJECT *DdbHandle);
375 * exmutex - mutex support
379 ACPI_OPERAND_OBJECT *TimeDesc,
380 ACPI_OPERAND_OBJECT *ObjDesc,
381 ACPI_WALK_STATE *WalkState);
385 ACPI_OPERAND_OBJECT *ObjDesc,
386 ACPI_WALK_STATE *WalkState);
389 AcpiExReleaseAllMutexes (
390 ACPI_THREAD_STATE *Thread);
394 ACPI_OPERAND_OBJECT *ObjDesc);
398 * exprep - ACPI AML execution - prep utilities
401 AcpiExPrepCommonFieldObject (
402 ACPI_OPERAND_OBJECT *ObjDesc,
404 UINT8 FieldAttribute,
405 UINT32 FieldBitPosition,
406 UINT32 FieldBitLength);
409 AcpiExPrepFieldValue (
410 ACPI_CREATE_FIELD_INFO *Info);
414 * exsystem - Interface to OS services
417 AcpiExSystemDoNotifyOp (
418 ACPI_OPERAND_OBJECT *Value,
419 ACPI_OPERAND_OBJECT *ObjDesc);
422 AcpiExSystemDoSuspend(
426 AcpiExSystemDoStall (
430 AcpiExSystemSignalEvent(
431 ACPI_OPERAND_OBJECT *ObjDesc);
434 AcpiExSystemWaitEvent(
435 ACPI_OPERAND_OBJECT *Time,
436 ACPI_OPERAND_OBJECT *ObjDesc);
439 AcpiExSystemResetEvent(
440 ACPI_OPERAND_OBJECT *ObjDesc);
443 AcpiExSystemWaitSemaphore (
444 ACPI_SEMAPHORE Semaphore,
448 AcpiExSystemWaitMutex (
453 * exoparg1 - ACPI AML execution, 1 operand
456 AcpiExOpcode_0A_0T_1R (
457 ACPI_WALK_STATE *WalkState);
460 AcpiExOpcode_1A_0T_0R (
461 ACPI_WALK_STATE *WalkState);
464 AcpiExOpcode_1A_0T_1R (
465 ACPI_WALK_STATE *WalkState);
468 AcpiExOpcode_1A_1T_1R (
469 ACPI_WALK_STATE *WalkState);
472 AcpiExOpcode_1A_1T_0R (
473 ACPI_WALK_STATE *WalkState);
476 * exoparg2 - ACPI AML execution, 2 operands
479 AcpiExOpcode_2A_0T_0R (
480 ACPI_WALK_STATE *WalkState);
483 AcpiExOpcode_2A_0T_1R (
484 ACPI_WALK_STATE *WalkState);
487 AcpiExOpcode_2A_1T_1R (
488 ACPI_WALK_STATE *WalkState);
491 AcpiExOpcode_2A_2T_1R (
492 ACPI_WALK_STATE *WalkState);
496 * exoparg3 - ACPI AML execution, 3 operands
499 AcpiExOpcode_3A_0T_0R (
500 ACPI_WALK_STATE *WalkState);
503 AcpiExOpcode_3A_1T_1R (
504 ACPI_WALK_STATE *WalkState);
508 * exoparg6 - ACPI AML execution, 6 operands
511 AcpiExOpcode_6A_0T_1R (
512 ACPI_WALK_STATE *WalkState);
516 * exresolv - Object resolution and get value functions
519 AcpiExResolveToValue (
520 ACPI_OPERAND_OBJECT **StackPtr,
521 ACPI_WALK_STATE *WalkState);
524 AcpiExResolveMultiple (
525 ACPI_WALK_STATE *WalkState,
526 ACPI_OPERAND_OBJECT *Operand,
527 ACPI_OBJECT_TYPE *ReturnType,
528 ACPI_OPERAND_OBJECT **ReturnDesc);
532 * exresnte - resolve namespace node
535 AcpiExResolveNodeToValue (
536 ACPI_NAMESPACE_NODE **StackPtr,
537 ACPI_WALK_STATE *WalkState);
541 * exresop - resolve operand to value
544 AcpiExResolveOperands (
546 ACPI_OPERAND_OBJECT **StackPtr,
547 ACPI_WALK_STATE *WalkState);
551 * exdump - Interpreter debug output routines
555 ACPI_OPERAND_OBJECT *ObjDesc,
560 ACPI_OPERAND_OBJECT **Operands,
561 ACPI_INTERPRETER_MODE InterpreterMode,
569 AcpiExDumpObjectDescriptor (
570 ACPI_OPERAND_OBJECT *Object,
574 AcpiExDumpNamespaceNode (
575 ACPI_NAMESPACE_NODE *Node,
580 * exnames - AML namestring support
583 AcpiExGetNameString (
584 ACPI_OBJECT_TYPE DataType,
586 char **OutNameString,
587 UINT32 *OutNameLength);
591 * exstore - Object store support
595 ACPI_OPERAND_OBJECT *ValDesc,
596 ACPI_OPERAND_OBJECT *DestDesc,
597 ACPI_WALK_STATE *WalkState);
600 AcpiExStoreObjectToNode (
601 ACPI_OPERAND_OBJECT *SourceDesc,
602 ACPI_NAMESPACE_NODE *Node,
603 ACPI_WALK_STATE *WalkState,
604 UINT8 ImplicitConversion);
606 #define ACPI_IMPLICIT_CONVERSION TRUE
607 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
611 * exstoren - resolve/store object
614 AcpiExResolveObject (
615 ACPI_OPERAND_OBJECT **SourceDescPtr,
616 ACPI_OBJECT_TYPE TargetType,
617 ACPI_WALK_STATE *WalkState);
620 AcpiExStoreObjectToObject (
621 ACPI_OPERAND_OBJECT *SourceDesc,
622 ACPI_OPERAND_OBJECT *DestDesc,
623 ACPI_OPERAND_OBJECT **NewDesc,
624 ACPI_WALK_STATE *WalkState);
628 * exstorob - store object - buffer/string
631 AcpiExStoreBufferToBuffer (
632 ACPI_OPERAND_OBJECT *SourceDesc,
633 ACPI_OPERAND_OBJECT *TargetDesc);
636 AcpiExStoreStringToString (
637 ACPI_OPERAND_OBJECT *SourceDesc,
638 ACPI_OPERAND_OBJECT *TargetDesc);
642 * excopy - object copy
645 AcpiExCopyIntegerToIndexField (
646 ACPI_OPERAND_OBJECT *SourceDesc,
647 ACPI_OPERAND_OBJECT *TargetDesc);
650 AcpiExCopyIntegerToBankField (
651 ACPI_OPERAND_OBJECT *SourceDesc,
652 ACPI_OPERAND_OBJECT *TargetDesc);
655 AcpiExCopyDataToNamedField (
656 ACPI_OPERAND_OBJECT *SourceDesc,
657 ACPI_NAMESPACE_NODE *Node);
660 AcpiExCopyIntegerToBufferField (
661 ACPI_OPERAND_OBJECT *SourceDesc,
662 ACPI_OPERAND_OBJECT *TargetDesc);
666 * exutils - interpreter/scanner utilities
669 AcpiExEnterInterpreter (
673 AcpiExExitInterpreter (
677 AcpiExReacquireInterpreter (
681 AcpiExRelinquishInterpreter (
685 AcpiExTruncateFor32bitTable (
686 ACPI_OPERAND_OBJECT *ObjDesc);
689 AcpiExAcquireGlobalLock (
693 AcpiExReleaseGlobalLock (
697 AcpiExEisaIdToString (
702 AcpiExUnsignedIntegerToString (
708 * exregion - default OpRegion handlers
711 AcpiExSystemMemorySpaceHandler (
713 ACPI_PHYSICAL_ADDRESS Address,
716 void *HandlerContext,
717 void *RegionContext);
720 AcpiExSystemIoSpaceHandler (
722 ACPI_PHYSICAL_ADDRESS Address,
725 void *HandlerContext,
726 void *RegionContext);
729 AcpiExPciConfigSpaceHandler (
731 ACPI_PHYSICAL_ADDRESS Address,
734 void *HandlerContext,
735 void *RegionContext);
738 AcpiExCmosSpaceHandler (
740 ACPI_PHYSICAL_ADDRESS Address,
743 void *HandlerContext,
744 void *RegionContext);
747 AcpiExPciBarSpaceHandler (
749 ACPI_PHYSICAL_ADDRESS Address,
752 void *HandlerContext,
753 void *RegionContext);
756 AcpiExEmbeddedControllerSpaceHandler (
758 ACPI_PHYSICAL_ADDRESS Address,
761 void *HandlerContext,
762 void *RegionContext);
765 AcpiExSmBusSpaceHandler (
767 ACPI_PHYSICAL_ADDRESS Address,
770 void *HandlerContext,
771 void *RegionContext);
775 AcpiExDataTableSpaceHandler (
777 ACPI_PHYSICAL_ADDRESS Address,
780 void *HandlerContext,
781 void *RegionContext);
783 #endif /* __INTERP_H__ */