1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #ifndef __ACINTERP_H__
153 #define __ACINTERP_H__
156 #define ACPI_WALK_OPERANDS (&(WalkState->Operands [WalkState->NumOperands -1]))
158 /* Macros for tables used for debug output */
160 #define ACPI_EXD_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_OPERAND_OBJECT,f)
161 #define ACPI_EXD_NSOFFSET(f) (UINT8) ACPI_OFFSET (ACPI_NAMESPACE_NODE,f)
162 #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (ACPI_EXDUMP_INFO))
165 * If possible, pack the following structures to byte alignment, since we
166 * don't care about performance for debug output. Two cases where we cannot
167 * pack the structures:
169 * 1) Hardware does not support misaligned memory transfers
170 * 2) Compiler does not support pointers within packed structures
172 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
176 typedef const struct acpi_exdump_info
184 /* Values for the Opcode field above */
186 #define ACPI_EXD_INIT 0
187 #define ACPI_EXD_TYPE 1
188 #define ACPI_EXD_UINT8 2
189 #define ACPI_EXD_UINT16 3
190 #define ACPI_EXD_UINT32 4
191 #define ACPI_EXD_UINT64 5
192 #define ACPI_EXD_LITERAL 6
193 #define ACPI_EXD_POINTER 7
194 #define ACPI_EXD_ADDRESS 8
195 #define ACPI_EXD_STRING 9
196 #define ACPI_EXD_BUFFER 10
197 #define ACPI_EXD_PACKAGE 11
198 #define ACPI_EXD_FIELD 12
199 #define ACPI_EXD_REFERENCE 13
200 #define ACPI_EXD_LIST 14 /* Operand object list */
201 #define ACPI_EXD_HDLR_LIST 15 /* Address Handler list */
202 #define ACPI_EXD_RGN_LIST 16 /* Region list */
203 #define ACPI_EXD_NODE 17 /* Namespace Node */
205 /* restore default alignment */
211 * exconvrt - object conversion
214 AcpiExConvertToInteger (
215 ACPI_OPERAND_OBJECT *ObjDesc,
216 ACPI_OPERAND_OBJECT **ResultDesc,
220 AcpiExConvertToBuffer (
221 ACPI_OPERAND_OBJECT *ObjDesc,
222 ACPI_OPERAND_OBJECT **ResultDesc);
225 AcpiExConvertToString (
226 ACPI_OPERAND_OBJECT *ObjDesc,
227 ACPI_OPERAND_OBJECT **ResultDesc,
230 /* Types for ->String conversion */
232 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
233 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
234 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
235 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
238 AcpiExConvertToTargetType (
239 ACPI_OBJECT_TYPE DestinationType,
240 ACPI_OPERAND_OBJECT *SourceDesc,
241 ACPI_OPERAND_OBJECT **ResultDesc,
242 ACPI_WALK_STATE *WalkState);
246 * exdebug - AML debug object
249 AcpiExDoDebugObject (
250 ACPI_OPERAND_OBJECT *SourceDesc,
255 AcpiExStartTraceMethod (
256 ACPI_NAMESPACE_NODE *MethodNode,
257 ACPI_OPERAND_OBJECT *ObjDesc,
258 ACPI_WALK_STATE *WalkState);
261 AcpiExStopTraceMethod (
262 ACPI_NAMESPACE_NODE *MethodNode,
263 ACPI_OPERAND_OBJECT *ObjDesc,
264 ACPI_WALK_STATE *WalkState);
267 AcpiExStartTraceOpcode (
268 ACPI_PARSE_OBJECT *Op,
269 ACPI_WALK_STATE *WalkState);
272 AcpiExStopTraceOpcode (
273 ACPI_PARSE_OBJECT *Op,
274 ACPI_WALK_STATE *WalkState);
278 ACPI_TRACE_EVENT_TYPE Type,
285 * exfield - ACPI AML (p-code) execution - field manipulation
288 AcpiExCommonBufferSetup (
289 ACPI_OPERAND_OBJECT *ObjDesc,
294 AcpiExWriteWithUpdateRule (
295 ACPI_OPERAND_OBJECT *ObjDesc,
298 UINT32 FieldDatumByteOffset);
301 AcpiExGetBufferDatum(
305 UINT32 ByteGranularity,
306 UINT32 BufferOffset);
309 AcpiExSetBufferDatum (
313 UINT32 ByteGranularity,
314 UINT32 BufferOffset);
317 AcpiExReadDataFromField (
318 ACPI_WALK_STATE *WalkState,
319 ACPI_OPERAND_OBJECT *ObjDesc,
320 ACPI_OPERAND_OBJECT **RetBufferDesc);
323 AcpiExWriteDataToField (
324 ACPI_OPERAND_OBJECT *SourceDesc,
325 ACPI_OPERAND_OBJECT *ObjDesc,
326 ACPI_OPERAND_OBJECT **ResultDesc);
330 * exfldio - low level field I/O
333 AcpiExExtractFromField (
334 ACPI_OPERAND_OBJECT *ObjDesc,
336 UINT32 BufferLength);
339 AcpiExInsertIntoField (
340 ACPI_OPERAND_OBJECT *ObjDesc,
342 UINT32 BufferLength);
346 ACPI_OPERAND_OBJECT *ObjDesc,
347 UINT32 FieldDatumByteOffset,
353 * exmisc - misc support routines
356 AcpiExGetObjectReference (
357 ACPI_OPERAND_OBJECT *ObjDesc,
358 ACPI_OPERAND_OBJECT **ReturnDesc,
359 ACPI_WALK_STATE *WalkState);
362 AcpiExConcatTemplate (
363 ACPI_OPERAND_OBJECT *ObjDesc,
364 ACPI_OPERAND_OBJECT *ObjDesc2,
365 ACPI_OPERAND_OBJECT **ActualReturnDesc,
366 ACPI_WALK_STATE *WalkState);
369 AcpiExDoConcatenate (
370 ACPI_OPERAND_OBJECT *ObjDesc,
371 ACPI_OPERAND_OBJECT *ObjDesc2,
372 ACPI_OPERAND_OBJECT **ActualReturnDesc,
373 ACPI_WALK_STATE *WalkState);
376 AcpiExDoLogicalNumericOp (
380 BOOLEAN *LogicalResult);
385 ACPI_OPERAND_OBJECT *Operand0,
386 ACPI_OPERAND_OBJECT *Operand1,
387 BOOLEAN *LogicalResult);
397 ACPI_WALK_STATE *WalkState);
400 AcpiExCreateProcessor (
401 ACPI_WALK_STATE *WalkState);
404 AcpiExCreatePowerResource (
405 ACPI_WALK_STATE *WalkState);
412 ACPI_WALK_STATE *WalkState);
416 ACPI_WALK_STATE *WalkState);
420 ACPI_WALK_STATE *WalkState);
426 ACPI_WALK_STATE *WalkState);
430 * exconfig - dynamic table load/unload
434 ACPI_OPERAND_OBJECT *ObjDesc,
435 ACPI_OPERAND_OBJECT *Target,
436 ACPI_WALK_STATE *WalkState);
440 ACPI_WALK_STATE *WalkState,
441 ACPI_OPERAND_OBJECT **ReturnDesc);
445 ACPI_OPERAND_OBJECT *DdbHandle);
449 * exmutex - mutex support
453 ACPI_OPERAND_OBJECT *TimeDesc,
454 ACPI_OPERAND_OBJECT *ObjDesc,
455 ACPI_WALK_STATE *WalkState);
458 AcpiExAcquireMutexObject (
460 ACPI_OPERAND_OBJECT *ObjDesc,
461 ACPI_THREAD_ID ThreadId);
465 ACPI_OPERAND_OBJECT *ObjDesc,
466 ACPI_WALK_STATE *WalkState);
469 AcpiExReleaseMutexObject (
470 ACPI_OPERAND_OBJECT *ObjDesc);
473 AcpiExReleaseAllMutexes (
474 ACPI_THREAD_STATE *Thread);
478 ACPI_OPERAND_OBJECT *ObjDesc);
482 * exprep - ACPI AML execution - prep utilities
485 AcpiExPrepCommonFieldObject (
486 ACPI_OPERAND_OBJECT *ObjDesc,
488 UINT8 FieldAttribute,
489 UINT32 FieldBitPosition,
490 UINT32 FieldBitLength);
493 AcpiExPrepFieldValue (
494 ACPI_CREATE_FIELD_INFO *Info);
498 * exsystem - Interface to OS services
501 AcpiExSystemDoNotifyOp (
502 ACPI_OPERAND_OBJECT *Value,
503 ACPI_OPERAND_OBJECT *ObjDesc);
510 AcpiExSystemDoStall (
514 AcpiExSystemSignalEvent(
515 ACPI_OPERAND_OBJECT *ObjDesc);
518 AcpiExSystemWaitEvent(
519 ACPI_OPERAND_OBJECT *Time,
520 ACPI_OPERAND_OBJECT *ObjDesc);
523 AcpiExSystemResetEvent(
524 ACPI_OPERAND_OBJECT *ObjDesc);
527 AcpiExSystemWaitSemaphore (
528 ACPI_SEMAPHORE Semaphore,
532 AcpiExSystemWaitMutex (
537 * exoparg1 - ACPI AML execution, 1 operand
540 AcpiExOpcode_0A_0T_1R (
541 ACPI_WALK_STATE *WalkState);
544 AcpiExOpcode_1A_0T_0R (
545 ACPI_WALK_STATE *WalkState);
548 AcpiExOpcode_1A_0T_1R (
549 ACPI_WALK_STATE *WalkState);
552 AcpiExOpcode_1A_1T_1R (
553 ACPI_WALK_STATE *WalkState);
556 AcpiExOpcode_1A_1T_0R (
557 ACPI_WALK_STATE *WalkState);
560 * exoparg2 - ACPI AML execution, 2 operands
563 AcpiExOpcode_2A_0T_0R (
564 ACPI_WALK_STATE *WalkState);
567 AcpiExOpcode_2A_0T_1R (
568 ACPI_WALK_STATE *WalkState);
571 AcpiExOpcode_2A_1T_1R (
572 ACPI_WALK_STATE *WalkState);
575 AcpiExOpcode_2A_2T_1R (
576 ACPI_WALK_STATE *WalkState);
580 * exoparg3 - ACPI AML execution, 3 operands
583 AcpiExOpcode_3A_0T_0R (
584 ACPI_WALK_STATE *WalkState);
587 AcpiExOpcode_3A_1T_1R (
588 ACPI_WALK_STATE *WalkState);
592 * exoparg6 - ACPI AML execution, 6 operands
595 AcpiExOpcode_6A_0T_1R (
596 ACPI_WALK_STATE *WalkState);
600 * exresolv - Object resolution and get value functions
603 AcpiExResolveToValue (
604 ACPI_OPERAND_OBJECT **StackPtr,
605 ACPI_WALK_STATE *WalkState);
608 AcpiExResolveMultiple (
609 ACPI_WALK_STATE *WalkState,
610 ACPI_OPERAND_OBJECT *Operand,
611 ACPI_OBJECT_TYPE *ReturnType,
612 ACPI_OPERAND_OBJECT **ReturnDesc);
616 * exresnte - resolve namespace node
619 AcpiExResolveNodeToValue (
620 ACPI_NAMESPACE_NODE **StackPtr,
621 ACPI_WALK_STATE *WalkState);
625 * exresop - resolve operand to value
628 AcpiExResolveOperands (
630 ACPI_OPERAND_OBJECT **StackPtr,
631 ACPI_WALK_STATE *WalkState);
635 * exdump - Interpreter debug output routines
639 ACPI_OPERAND_OBJECT *ObjDesc,
644 ACPI_OPERAND_OBJECT **Operands,
645 const char *OpcodeName,
649 AcpiExDumpObjectDescriptor (
650 ACPI_OPERAND_OBJECT *Object,
654 AcpiExDumpNamespaceNode (
655 ACPI_NAMESPACE_NODE *Node,
660 * exnames - AML namestring support
663 AcpiExGetNameString (
664 ACPI_OBJECT_TYPE DataType,
666 char **OutNameString,
667 UINT32 *OutNameLength);
671 * exstore - Object store support
675 ACPI_OPERAND_OBJECT *ValDesc,
676 ACPI_OPERAND_OBJECT *DestDesc,
677 ACPI_WALK_STATE *WalkState);
680 AcpiExStoreObjectToNode (
681 ACPI_OPERAND_OBJECT *SourceDesc,
682 ACPI_NAMESPACE_NODE *Node,
683 ACPI_WALK_STATE *WalkState,
684 UINT8 ImplicitConversion);
686 #define ACPI_IMPLICIT_CONVERSION TRUE
687 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
691 * exstoren - resolve/store object
694 AcpiExResolveObject (
695 ACPI_OPERAND_OBJECT **SourceDescPtr,
696 ACPI_OBJECT_TYPE TargetType,
697 ACPI_WALK_STATE *WalkState);
700 AcpiExStoreObjectToObject (
701 ACPI_OPERAND_OBJECT *SourceDesc,
702 ACPI_OPERAND_OBJECT *DestDesc,
703 ACPI_OPERAND_OBJECT **NewDesc,
704 ACPI_WALK_STATE *WalkState);
708 * exstorob - store object - buffer/string
711 AcpiExStoreBufferToBuffer (
712 ACPI_OPERAND_OBJECT *SourceDesc,
713 ACPI_OPERAND_OBJECT *TargetDesc);
716 AcpiExStoreStringToString (
717 ACPI_OPERAND_OBJECT *SourceDesc,
718 ACPI_OPERAND_OBJECT *TargetDesc);
722 * excopy - object copy
725 AcpiExCopyIntegerToIndexField (
726 ACPI_OPERAND_OBJECT *SourceDesc,
727 ACPI_OPERAND_OBJECT *TargetDesc);
730 AcpiExCopyIntegerToBankField (
731 ACPI_OPERAND_OBJECT *SourceDesc,
732 ACPI_OPERAND_OBJECT *TargetDesc);
735 AcpiExCopyDataToNamedField (
736 ACPI_OPERAND_OBJECT *SourceDesc,
737 ACPI_NAMESPACE_NODE *Node);
740 AcpiExCopyIntegerToBufferField (
741 ACPI_OPERAND_OBJECT *SourceDesc,
742 ACPI_OPERAND_OBJECT *TargetDesc);
746 * exutils - interpreter/scanner utilities
749 AcpiExEnterInterpreter (
753 AcpiExExitInterpreter (
757 AcpiExTruncateFor32bitTable (
758 ACPI_OPERAND_OBJECT *ObjDesc);
761 AcpiExAcquireGlobalLock (
765 AcpiExReleaseGlobalLock (
769 AcpiExEisaIdToString (
771 UINT64 CompressedId);
774 AcpiExIntegerToString (
779 AcpiExPciClsToString (
789 * exregion - default OpRegion handlers
792 AcpiExSystemMemorySpaceHandler (
794 ACPI_PHYSICAL_ADDRESS Address,
797 void *HandlerContext,
798 void *RegionContext);
801 AcpiExSystemIoSpaceHandler (
803 ACPI_PHYSICAL_ADDRESS Address,
806 void *HandlerContext,
807 void *RegionContext);
810 AcpiExPciConfigSpaceHandler (
812 ACPI_PHYSICAL_ADDRESS Address,
815 void *HandlerContext,
816 void *RegionContext);
819 AcpiExCmosSpaceHandler (
821 ACPI_PHYSICAL_ADDRESS Address,
824 void *HandlerContext,
825 void *RegionContext);
828 AcpiExPciBarSpaceHandler (
830 ACPI_PHYSICAL_ADDRESS Address,
833 void *HandlerContext,
834 void *RegionContext);
837 AcpiExEmbeddedControllerSpaceHandler (
839 ACPI_PHYSICAL_ADDRESS Address,
842 void *HandlerContext,
843 void *RegionContext);
846 AcpiExSmBusSpaceHandler (
848 ACPI_PHYSICAL_ADDRESS Address,
851 void *HandlerContext,
852 void *RegionContext);
856 AcpiExDataTableSpaceHandler (
858 ACPI_PHYSICAL_ADDRESS Address,
861 void *HandlerContext,
862 void *RegionContext);
864 #endif /* __INTERP_H__ */