1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #ifndef __ACINTERP_H__
117 #define __ACINTERP_H__
120 #define ACPI_WALK_OPERANDS (&(WalkState->Operands [WalkState->NumOperands -1]))
122 /* Macros for tables used for debug output */
124 #define ACPI_EXD_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_OPERAND_OBJECT,f)
125 #define ACPI_EXD_NSOFFSET(f) (UINT8) ACPI_OFFSET (ACPI_NAMESPACE_NODE,f)
126 #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (ACPI_EXDUMP_INFO))
129 * If possible, pack the following structures to byte alignment, since we
130 * don't care about performance for debug output. Two cases where we cannot
131 * pack the structures:
133 * 1) Hardware does not support misaligned memory transfers
134 * 2) Compiler does not support pointers within packed structures
136 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
140 typedef const struct acpi_exdump_info
148 /* Values for the Opcode field above */
150 #define ACPI_EXD_INIT 0
151 #define ACPI_EXD_TYPE 1
152 #define ACPI_EXD_UINT8 2
153 #define ACPI_EXD_UINT16 3
154 #define ACPI_EXD_UINT32 4
155 #define ACPI_EXD_UINT64 5
156 #define ACPI_EXD_LITERAL 6
157 #define ACPI_EXD_POINTER 7
158 #define ACPI_EXD_ADDRESS 8
159 #define ACPI_EXD_STRING 9
160 #define ACPI_EXD_BUFFER 10
161 #define ACPI_EXD_PACKAGE 11
162 #define ACPI_EXD_FIELD 12
163 #define ACPI_EXD_REFERENCE 13
164 #define ACPI_EXD_LIST 14 /* Operand object list */
165 #define ACPI_EXD_HDLR_LIST 15 /* Address Handler list */
166 #define ACPI_EXD_RGN_LIST 16 /* Region list */
167 #define ACPI_EXD_NODE 17 /* Namespace Node */
169 /* restore default alignment */
175 * exconvrt - object conversion
178 AcpiExConvertToInteger (
179 ACPI_OPERAND_OBJECT
*ObjDesc
,
180 ACPI_OPERAND_OBJECT
**ResultDesc
,
184 AcpiExConvertToBuffer (
185 ACPI_OPERAND_OBJECT
*ObjDesc
,
186 ACPI_OPERAND_OBJECT
**ResultDesc
);
189 AcpiExConvertToString (
190 ACPI_OPERAND_OBJECT
*ObjDesc
,
191 ACPI_OPERAND_OBJECT
**ResultDesc
,
194 /* Types for ->String conversion */
196 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
197 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
198 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
199 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
202 AcpiExConvertToTargetType (
203 ACPI_OBJECT_TYPE DestinationType
,
204 ACPI_OPERAND_OBJECT
*SourceDesc
,
205 ACPI_OPERAND_OBJECT
**ResultDesc
,
206 ACPI_WALK_STATE
*WalkState
);
210 * exdebug - AML debug object
213 AcpiExDoDebugObject (
214 ACPI_OPERAND_OBJECT
*SourceDesc
,
220 * exfield - ACPI AML (p-code) execution - field manipulation
223 AcpiExCommonBufferSetup (
224 ACPI_OPERAND_OBJECT
*ObjDesc
,
229 AcpiExWriteWithUpdateRule (
230 ACPI_OPERAND_OBJECT
*ObjDesc
,
233 UINT32 FieldDatumByteOffset
);
236 AcpiExGetBufferDatum(
240 UINT32 ByteGranularity
,
241 UINT32 BufferOffset
);
244 AcpiExSetBufferDatum (
248 UINT32 ByteGranularity
,
249 UINT32 BufferOffset
);
252 AcpiExReadDataFromField (
253 ACPI_WALK_STATE
*WalkState
,
254 ACPI_OPERAND_OBJECT
*ObjDesc
,
255 ACPI_OPERAND_OBJECT
**RetBufferDesc
);
258 AcpiExWriteDataToField (
259 ACPI_OPERAND_OBJECT
*SourceDesc
,
260 ACPI_OPERAND_OBJECT
*ObjDesc
,
261 ACPI_OPERAND_OBJECT
**ResultDesc
);
265 * exfldio - low level field I/O
268 AcpiExExtractFromField (
269 ACPI_OPERAND_OBJECT
*ObjDesc
,
271 UINT32 BufferLength
);
274 AcpiExInsertIntoField (
275 ACPI_OPERAND_OBJECT
*ObjDesc
,
277 UINT32 BufferLength
);
281 ACPI_OPERAND_OBJECT
*ObjDesc
,
282 UINT32 FieldDatumByteOffset
,
288 * exmisc - misc support routines
291 AcpiExGetObjectReference (
292 ACPI_OPERAND_OBJECT
*ObjDesc
,
293 ACPI_OPERAND_OBJECT
**ReturnDesc
,
294 ACPI_WALK_STATE
*WalkState
);
297 AcpiExConcatTemplate (
298 ACPI_OPERAND_OBJECT
*ObjDesc
,
299 ACPI_OPERAND_OBJECT
*ObjDesc2
,
300 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
301 ACPI_WALK_STATE
*WalkState
);
304 AcpiExDoConcatenate (
305 ACPI_OPERAND_OBJECT
*ObjDesc
,
306 ACPI_OPERAND_OBJECT
*ObjDesc2
,
307 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
308 ACPI_WALK_STATE
*WalkState
);
311 AcpiExDoLogicalNumericOp (
315 BOOLEAN
*LogicalResult
);
320 ACPI_OPERAND_OBJECT
*Operand0
,
321 ACPI_OPERAND_OBJECT
*Operand1
,
322 BOOLEAN
*LogicalResult
);
332 ACPI_WALK_STATE
*WalkState
);
335 AcpiExCreateProcessor (
336 ACPI_WALK_STATE
*WalkState
);
339 AcpiExCreatePowerResource (
340 ACPI_WALK_STATE
*WalkState
);
347 ACPI_WALK_STATE
*WalkState
);
351 ACPI_WALK_STATE
*WalkState
);
355 ACPI_WALK_STATE
*WalkState
);
361 ACPI_WALK_STATE
*WalkState
);
365 * exconfig - dynamic table load/unload
369 ACPI_OPERAND_OBJECT
*ObjDesc
,
370 ACPI_OPERAND_OBJECT
*Target
,
371 ACPI_WALK_STATE
*WalkState
);
375 ACPI_WALK_STATE
*WalkState
,
376 ACPI_OPERAND_OBJECT
**ReturnDesc
);
380 ACPI_OPERAND_OBJECT
*DdbHandle
);
384 * exmutex - mutex support
388 ACPI_OPERAND_OBJECT
*TimeDesc
,
389 ACPI_OPERAND_OBJECT
*ObjDesc
,
390 ACPI_WALK_STATE
*WalkState
);
393 AcpiExAcquireMutexObject (
395 ACPI_OPERAND_OBJECT
*ObjDesc
,
396 ACPI_THREAD_ID ThreadId
);
400 ACPI_OPERAND_OBJECT
*ObjDesc
,
401 ACPI_WALK_STATE
*WalkState
);
404 AcpiExReleaseMutexObject (
405 ACPI_OPERAND_OBJECT
*ObjDesc
);
408 AcpiExReleaseAllMutexes (
409 ACPI_THREAD_STATE
*Thread
);
413 ACPI_OPERAND_OBJECT
*ObjDesc
);
417 * exprep - ACPI AML execution - prep utilities
420 AcpiExPrepCommonFieldObject (
421 ACPI_OPERAND_OBJECT
*ObjDesc
,
423 UINT8 FieldAttribute
,
424 UINT32 FieldBitPosition
,
425 UINT32 FieldBitLength
);
428 AcpiExPrepFieldValue (
429 ACPI_CREATE_FIELD_INFO
*Info
);
433 * exsystem - Interface to OS services
436 AcpiExSystemDoNotifyOp (
437 ACPI_OPERAND_OBJECT
*Value
,
438 ACPI_OPERAND_OBJECT
*ObjDesc
);
445 AcpiExSystemDoStall (
449 AcpiExSystemSignalEvent(
450 ACPI_OPERAND_OBJECT
*ObjDesc
);
453 AcpiExSystemWaitEvent(
454 ACPI_OPERAND_OBJECT
*Time
,
455 ACPI_OPERAND_OBJECT
*ObjDesc
);
458 AcpiExSystemResetEvent(
459 ACPI_OPERAND_OBJECT
*ObjDesc
);
462 AcpiExSystemWaitSemaphore (
463 ACPI_SEMAPHORE Semaphore
,
467 AcpiExSystemWaitMutex (
472 * exoparg1 - ACPI AML execution, 1 operand
475 AcpiExOpcode_0A_0T_1R (
476 ACPI_WALK_STATE
*WalkState
);
479 AcpiExOpcode_1A_0T_0R (
480 ACPI_WALK_STATE
*WalkState
);
483 AcpiExOpcode_1A_0T_1R (
484 ACPI_WALK_STATE
*WalkState
);
487 AcpiExOpcode_1A_1T_1R (
488 ACPI_WALK_STATE
*WalkState
);
491 AcpiExOpcode_1A_1T_0R (
492 ACPI_WALK_STATE
*WalkState
);
495 * exoparg2 - ACPI AML execution, 2 operands
498 AcpiExOpcode_2A_0T_0R (
499 ACPI_WALK_STATE
*WalkState
);
502 AcpiExOpcode_2A_0T_1R (
503 ACPI_WALK_STATE
*WalkState
);
506 AcpiExOpcode_2A_1T_1R (
507 ACPI_WALK_STATE
*WalkState
);
510 AcpiExOpcode_2A_2T_1R (
511 ACPI_WALK_STATE
*WalkState
);
515 * exoparg3 - ACPI AML execution, 3 operands
518 AcpiExOpcode_3A_0T_0R (
519 ACPI_WALK_STATE
*WalkState
);
522 AcpiExOpcode_3A_1T_1R (
523 ACPI_WALK_STATE
*WalkState
);
527 * exoparg6 - ACPI AML execution, 6 operands
530 AcpiExOpcode_6A_0T_1R (
531 ACPI_WALK_STATE
*WalkState
);
535 * exresolv - Object resolution and get value functions
538 AcpiExResolveToValue (
539 ACPI_OPERAND_OBJECT
**StackPtr
,
540 ACPI_WALK_STATE
*WalkState
);
543 AcpiExResolveMultiple (
544 ACPI_WALK_STATE
*WalkState
,
545 ACPI_OPERAND_OBJECT
*Operand
,
546 ACPI_OBJECT_TYPE
*ReturnType
,
547 ACPI_OPERAND_OBJECT
**ReturnDesc
);
551 * exresnte - resolve namespace node
554 AcpiExResolveNodeToValue (
555 ACPI_NAMESPACE_NODE
**StackPtr
,
556 ACPI_WALK_STATE
*WalkState
);
560 * exresop - resolve operand to value
563 AcpiExResolveOperands (
565 ACPI_OPERAND_OBJECT
**StackPtr
,
566 ACPI_WALK_STATE
*WalkState
);
570 * exdump - Interpreter debug output routines
574 ACPI_OPERAND_OBJECT
*ObjDesc
,
579 ACPI_OPERAND_OBJECT
**Operands
,
580 const char *OpcodeName
,
584 AcpiExDumpObjectDescriptor (
585 ACPI_OPERAND_OBJECT
*Object
,
589 AcpiExDumpNamespaceNode (
590 ACPI_NAMESPACE_NODE
*Node
,
595 * exnames - AML namestring support
598 AcpiExGetNameString (
599 ACPI_OBJECT_TYPE DataType
,
601 char **OutNameString
,
602 UINT32
*OutNameLength
);
606 * exstore - Object store support
610 ACPI_OPERAND_OBJECT
*ValDesc
,
611 ACPI_OPERAND_OBJECT
*DestDesc
,
612 ACPI_WALK_STATE
*WalkState
);
615 AcpiExStoreObjectToNode (
616 ACPI_OPERAND_OBJECT
*SourceDesc
,
617 ACPI_NAMESPACE_NODE
*Node
,
618 ACPI_WALK_STATE
*WalkState
,
619 UINT8 ImplicitConversion
);
621 #define ACPI_IMPLICIT_CONVERSION TRUE
622 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
626 * exstoren - resolve/store object
629 AcpiExResolveObject (
630 ACPI_OPERAND_OBJECT
**SourceDescPtr
,
631 ACPI_OBJECT_TYPE TargetType
,
632 ACPI_WALK_STATE
*WalkState
);
635 AcpiExStoreObjectToObject (
636 ACPI_OPERAND_OBJECT
*SourceDesc
,
637 ACPI_OPERAND_OBJECT
*DestDesc
,
638 ACPI_OPERAND_OBJECT
**NewDesc
,
639 ACPI_WALK_STATE
*WalkState
);
643 * exstorob - store object - buffer/string
646 AcpiExStoreBufferToBuffer (
647 ACPI_OPERAND_OBJECT
*SourceDesc
,
648 ACPI_OPERAND_OBJECT
*TargetDesc
);
651 AcpiExStoreStringToString (
652 ACPI_OPERAND_OBJECT
*SourceDesc
,
653 ACPI_OPERAND_OBJECT
*TargetDesc
);
657 * excopy - object copy
660 AcpiExCopyIntegerToIndexField (
661 ACPI_OPERAND_OBJECT
*SourceDesc
,
662 ACPI_OPERAND_OBJECT
*TargetDesc
);
665 AcpiExCopyIntegerToBankField (
666 ACPI_OPERAND_OBJECT
*SourceDesc
,
667 ACPI_OPERAND_OBJECT
*TargetDesc
);
670 AcpiExCopyDataToNamedField (
671 ACPI_OPERAND_OBJECT
*SourceDesc
,
672 ACPI_NAMESPACE_NODE
*Node
);
675 AcpiExCopyIntegerToBufferField (
676 ACPI_OPERAND_OBJECT
*SourceDesc
,
677 ACPI_OPERAND_OBJECT
*TargetDesc
);
681 * exutils - interpreter/scanner utilities
684 AcpiExEnterInterpreter (
688 AcpiExExitInterpreter (
692 AcpiExTruncateFor32bitTable (
693 ACPI_OPERAND_OBJECT
*ObjDesc
);
696 AcpiExAcquireGlobalLock (
700 AcpiExReleaseGlobalLock (
704 AcpiExEisaIdToString (
706 UINT64 CompressedId
);
709 AcpiExIntegerToString (
719 * exregion - default OpRegion handlers
722 AcpiExSystemMemorySpaceHandler (
724 ACPI_PHYSICAL_ADDRESS Address
,
727 void *HandlerContext
,
728 void *RegionContext
);
731 AcpiExSystemIoSpaceHandler (
733 ACPI_PHYSICAL_ADDRESS Address
,
736 void *HandlerContext
,
737 void *RegionContext
);
740 AcpiExPciConfigSpaceHandler (
742 ACPI_PHYSICAL_ADDRESS Address
,
745 void *HandlerContext
,
746 void *RegionContext
);
749 AcpiExCmosSpaceHandler (
751 ACPI_PHYSICAL_ADDRESS Address
,
754 void *HandlerContext
,
755 void *RegionContext
);
758 AcpiExPciBarSpaceHandler (
760 ACPI_PHYSICAL_ADDRESS Address
,
763 void *HandlerContext
,
764 void *RegionContext
);
767 AcpiExEmbeddedControllerSpaceHandler (
769 ACPI_PHYSICAL_ADDRESS Address
,
772 void *HandlerContext
,
773 void *RegionContext
);
776 AcpiExSmBusSpaceHandler (
778 ACPI_PHYSICAL_ADDRESS Address
,
781 void *HandlerContext
,
782 void *RegionContext
);
786 AcpiExDataTableSpaceHandler (
788 ACPI_PHYSICAL_ADDRESS Address
,
791 void *HandlerContext
,
792 void *RegionContext
);
794 #endif /* __INTERP_H__ */