1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, 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);
384 AcpiExAcquireMutexObject (
386 ACPI_OPERAND_OBJECT *ObjDesc,
387 ACPI_THREAD_ID ThreadId);
391 ACPI_OPERAND_OBJECT *ObjDesc,
392 ACPI_WALK_STATE *WalkState);
395 AcpiExReleaseMutexObject (
396 ACPI_OPERAND_OBJECT *ObjDesc);
399 AcpiExReleaseAllMutexes (
400 ACPI_THREAD_STATE *Thread);
404 ACPI_OPERAND_OBJECT *ObjDesc);
408 * exprep - ACPI AML execution - prep utilities
411 AcpiExPrepCommonFieldObject (
412 ACPI_OPERAND_OBJECT *ObjDesc,
414 UINT8 FieldAttribute,
415 UINT32 FieldBitPosition,
416 UINT32 FieldBitLength);
419 AcpiExPrepFieldValue (
420 ACPI_CREATE_FIELD_INFO *Info);
424 * exsystem - Interface to OS services
427 AcpiExSystemDoNotifyOp (
428 ACPI_OPERAND_OBJECT *Value,
429 ACPI_OPERAND_OBJECT *ObjDesc);
432 AcpiExSystemDoSuspend(
436 AcpiExSystemDoStall (
440 AcpiExSystemSignalEvent(
441 ACPI_OPERAND_OBJECT *ObjDesc);
444 AcpiExSystemWaitEvent(
445 ACPI_OPERAND_OBJECT *Time,
446 ACPI_OPERAND_OBJECT *ObjDesc);
449 AcpiExSystemResetEvent(
450 ACPI_OPERAND_OBJECT *ObjDesc);
453 AcpiExSystemWaitSemaphore (
454 ACPI_SEMAPHORE Semaphore,
458 AcpiExSystemWaitMutex (
463 * exoparg1 - ACPI AML execution, 1 operand
466 AcpiExOpcode_0A_0T_1R (
467 ACPI_WALK_STATE *WalkState);
470 AcpiExOpcode_1A_0T_0R (
471 ACPI_WALK_STATE *WalkState);
474 AcpiExOpcode_1A_0T_1R (
475 ACPI_WALK_STATE *WalkState);
478 AcpiExOpcode_1A_1T_1R (
479 ACPI_WALK_STATE *WalkState);
482 AcpiExOpcode_1A_1T_0R (
483 ACPI_WALK_STATE *WalkState);
486 * exoparg2 - ACPI AML execution, 2 operands
489 AcpiExOpcode_2A_0T_0R (
490 ACPI_WALK_STATE *WalkState);
493 AcpiExOpcode_2A_0T_1R (
494 ACPI_WALK_STATE *WalkState);
497 AcpiExOpcode_2A_1T_1R (
498 ACPI_WALK_STATE *WalkState);
501 AcpiExOpcode_2A_2T_1R (
502 ACPI_WALK_STATE *WalkState);
506 * exoparg3 - ACPI AML execution, 3 operands
509 AcpiExOpcode_3A_0T_0R (
510 ACPI_WALK_STATE *WalkState);
513 AcpiExOpcode_3A_1T_1R (
514 ACPI_WALK_STATE *WalkState);
518 * exoparg6 - ACPI AML execution, 6 operands
521 AcpiExOpcode_6A_0T_1R (
522 ACPI_WALK_STATE *WalkState);
526 * exresolv - Object resolution and get value functions
529 AcpiExResolveToValue (
530 ACPI_OPERAND_OBJECT **StackPtr,
531 ACPI_WALK_STATE *WalkState);
534 AcpiExResolveMultiple (
535 ACPI_WALK_STATE *WalkState,
536 ACPI_OPERAND_OBJECT *Operand,
537 ACPI_OBJECT_TYPE *ReturnType,
538 ACPI_OPERAND_OBJECT **ReturnDesc);
542 * exresnte - resolve namespace node
545 AcpiExResolveNodeToValue (
546 ACPI_NAMESPACE_NODE **StackPtr,
547 ACPI_WALK_STATE *WalkState);
551 * exresop - resolve operand to value
554 AcpiExResolveOperands (
556 ACPI_OPERAND_OBJECT **StackPtr,
557 ACPI_WALK_STATE *WalkState);
561 * exdump - Interpreter debug output routines
565 ACPI_OPERAND_OBJECT *ObjDesc,
570 ACPI_OPERAND_OBJECT **Operands,
571 ACPI_INTERPRETER_MODE InterpreterMode,
579 AcpiExDumpObjectDescriptor (
580 ACPI_OPERAND_OBJECT *Object,
584 AcpiExDumpNamespaceNode (
585 ACPI_NAMESPACE_NODE *Node,
590 * exnames - AML namestring support
593 AcpiExGetNameString (
594 ACPI_OBJECT_TYPE DataType,
596 char **OutNameString,
597 UINT32 *OutNameLength);
601 * exstore - Object store support
605 ACPI_OPERAND_OBJECT *ValDesc,
606 ACPI_OPERAND_OBJECT *DestDesc,
607 ACPI_WALK_STATE *WalkState);
610 AcpiExStoreObjectToNode (
611 ACPI_OPERAND_OBJECT *SourceDesc,
612 ACPI_NAMESPACE_NODE *Node,
613 ACPI_WALK_STATE *WalkState,
614 UINT8 ImplicitConversion);
616 #define ACPI_IMPLICIT_CONVERSION TRUE
617 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
621 * exstoren - resolve/store object
624 AcpiExResolveObject (
625 ACPI_OPERAND_OBJECT **SourceDescPtr,
626 ACPI_OBJECT_TYPE TargetType,
627 ACPI_WALK_STATE *WalkState);
630 AcpiExStoreObjectToObject (
631 ACPI_OPERAND_OBJECT *SourceDesc,
632 ACPI_OPERAND_OBJECT *DestDesc,
633 ACPI_OPERAND_OBJECT **NewDesc,
634 ACPI_WALK_STATE *WalkState);
638 * exstorob - store object - buffer/string
641 AcpiExStoreBufferToBuffer (
642 ACPI_OPERAND_OBJECT *SourceDesc,
643 ACPI_OPERAND_OBJECT *TargetDesc);
646 AcpiExStoreStringToString (
647 ACPI_OPERAND_OBJECT *SourceDesc,
648 ACPI_OPERAND_OBJECT *TargetDesc);
652 * excopy - object copy
655 AcpiExCopyIntegerToIndexField (
656 ACPI_OPERAND_OBJECT *SourceDesc,
657 ACPI_OPERAND_OBJECT *TargetDesc);
660 AcpiExCopyIntegerToBankField (
661 ACPI_OPERAND_OBJECT *SourceDesc,
662 ACPI_OPERAND_OBJECT *TargetDesc);
665 AcpiExCopyDataToNamedField (
666 ACPI_OPERAND_OBJECT *SourceDesc,
667 ACPI_NAMESPACE_NODE *Node);
670 AcpiExCopyIntegerToBufferField (
671 ACPI_OPERAND_OBJECT *SourceDesc,
672 ACPI_OPERAND_OBJECT *TargetDesc);
676 * exutils - interpreter/scanner utilities
679 AcpiExEnterInterpreter (
683 AcpiExExitInterpreter (
687 AcpiExReacquireInterpreter (
691 AcpiExRelinquishInterpreter (
695 AcpiExTruncateFor32bitTable (
696 ACPI_OPERAND_OBJECT *ObjDesc);
699 AcpiExAcquireGlobalLock (
703 AcpiExReleaseGlobalLock (
707 AcpiExEisaIdToString (
712 AcpiExUnsignedIntegerToString (
718 * exregion - default OpRegion handlers
721 AcpiExSystemMemorySpaceHandler (
723 ACPI_PHYSICAL_ADDRESS Address,
726 void *HandlerContext,
727 void *RegionContext);
730 AcpiExSystemIoSpaceHandler (
732 ACPI_PHYSICAL_ADDRESS Address,
735 void *HandlerContext,
736 void *RegionContext);
739 AcpiExPciConfigSpaceHandler (
741 ACPI_PHYSICAL_ADDRESS Address,
744 void *HandlerContext,
745 void *RegionContext);
748 AcpiExCmosSpaceHandler (
750 ACPI_PHYSICAL_ADDRESS Address,
753 void *HandlerContext,
754 void *RegionContext);
757 AcpiExPciBarSpaceHandler (
759 ACPI_PHYSICAL_ADDRESS Address,
762 void *HandlerContext,
763 void *RegionContext);
766 AcpiExEmbeddedControllerSpaceHandler (
768 ACPI_PHYSICAL_ADDRESS Address,
771 void *HandlerContext,
772 void *RegionContext);
775 AcpiExSmBusSpaceHandler (
777 ACPI_PHYSICAL_ADDRESS Address,
780 void *HandlerContext,
781 void *RegionContext);
785 AcpiExDataTableSpaceHandler (
787 ACPI_PHYSICAL_ADDRESS Address,
790 void *HandlerContext,
791 void *RegionContext);
793 #endif /* __INTERP_H__ */