1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, 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
165 /* restore default alignment */
171 * exconvrt - object conversion
174 AcpiExConvertToInteger (
175 ACPI_OPERAND_OBJECT
*ObjDesc
,
176 ACPI_OPERAND_OBJECT
**ResultDesc
,
180 AcpiExConvertToBuffer (
181 ACPI_OPERAND_OBJECT
*ObjDesc
,
182 ACPI_OPERAND_OBJECT
**ResultDesc
);
185 AcpiExConvertToString (
186 ACPI_OPERAND_OBJECT
*ObjDesc
,
187 ACPI_OPERAND_OBJECT
**ResultDesc
,
190 /* Types for ->String conversion */
192 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
193 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
194 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
195 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
198 AcpiExConvertToTargetType (
199 ACPI_OBJECT_TYPE DestinationType
,
200 ACPI_OPERAND_OBJECT
*SourceDesc
,
201 ACPI_OPERAND_OBJECT
**ResultDesc
,
202 ACPI_WALK_STATE
*WalkState
);
206 * exdebug - AML debug object
209 AcpiExDoDebugObject (
210 ACPI_OPERAND_OBJECT
*SourceDesc
,
216 * exfield - ACPI AML (p-code) execution - field manipulation
219 AcpiExCommonBufferSetup (
220 ACPI_OPERAND_OBJECT
*ObjDesc
,
225 AcpiExWriteWithUpdateRule (
226 ACPI_OPERAND_OBJECT
*ObjDesc
,
229 UINT32 FieldDatumByteOffset
);
232 AcpiExGetBufferDatum(
236 UINT32 ByteGranularity
,
237 UINT32 BufferOffset
);
240 AcpiExSetBufferDatum (
244 UINT32 ByteGranularity
,
245 UINT32 BufferOffset
);
248 AcpiExReadDataFromField (
249 ACPI_WALK_STATE
*WalkState
,
250 ACPI_OPERAND_OBJECT
*ObjDesc
,
251 ACPI_OPERAND_OBJECT
**RetBufferDesc
);
254 AcpiExWriteDataToField (
255 ACPI_OPERAND_OBJECT
*SourceDesc
,
256 ACPI_OPERAND_OBJECT
*ObjDesc
,
257 ACPI_OPERAND_OBJECT
**ResultDesc
);
261 * exfldio - low level field I/O
264 AcpiExExtractFromField (
265 ACPI_OPERAND_OBJECT
*ObjDesc
,
267 UINT32 BufferLength
);
270 AcpiExInsertIntoField (
271 ACPI_OPERAND_OBJECT
*ObjDesc
,
273 UINT32 BufferLength
);
277 ACPI_OPERAND_OBJECT
*ObjDesc
,
278 UINT32 FieldDatumByteOffset
,
284 * exmisc - misc support routines
287 AcpiExGetObjectReference (
288 ACPI_OPERAND_OBJECT
*ObjDesc
,
289 ACPI_OPERAND_OBJECT
**ReturnDesc
,
290 ACPI_WALK_STATE
*WalkState
);
293 AcpiExConcatTemplate (
294 ACPI_OPERAND_OBJECT
*ObjDesc
,
295 ACPI_OPERAND_OBJECT
*ObjDesc2
,
296 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
297 ACPI_WALK_STATE
*WalkState
);
300 AcpiExDoConcatenate (
301 ACPI_OPERAND_OBJECT
*ObjDesc
,
302 ACPI_OPERAND_OBJECT
*ObjDesc2
,
303 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
304 ACPI_WALK_STATE
*WalkState
);
307 AcpiExDoLogicalNumericOp (
311 BOOLEAN
*LogicalResult
);
316 ACPI_OPERAND_OBJECT
*Operand0
,
317 ACPI_OPERAND_OBJECT
*Operand1
,
318 BOOLEAN
*LogicalResult
);
328 ACPI_WALK_STATE
*WalkState
);
331 AcpiExCreateProcessor (
332 ACPI_WALK_STATE
*WalkState
);
335 AcpiExCreatePowerResource (
336 ACPI_WALK_STATE
*WalkState
);
343 ACPI_WALK_STATE
*WalkState
);
347 ACPI_WALK_STATE
*WalkState
);
351 ACPI_WALK_STATE
*WalkState
);
357 ACPI_WALK_STATE
*WalkState
);
361 * exconfig - dynamic table load/unload
365 ACPI_OPERAND_OBJECT
*ObjDesc
,
366 ACPI_OPERAND_OBJECT
*Target
,
367 ACPI_WALK_STATE
*WalkState
);
371 ACPI_WALK_STATE
*WalkState
,
372 ACPI_OPERAND_OBJECT
**ReturnDesc
);
376 ACPI_OPERAND_OBJECT
*DdbHandle
);
380 * exmutex - mutex support
384 ACPI_OPERAND_OBJECT
*TimeDesc
,
385 ACPI_OPERAND_OBJECT
*ObjDesc
,
386 ACPI_WALK_STATE
*WalkState
);
389 AcpiExAcquireMutexObject (
391 ACPI_OPERAND_OBJECT
*ObjDesc
,
392 ACPI_THREAD_ID ThreadId
);
396 ACPI_OPERAND_OBJECT
*ObjDesc
,
397 ACPI_WALK_STATE
*WalkState
);
400 AcpiExReleaseMutexObject (
401 ACPI_OPERAND_OBJECT
*ObjDesc
);
404 AcpiExReleaseAllMutexes (
405 ACPI_THREAD_STATE
*Thread
);
409 ACPI_OPERAND_OBJECT
*ObjDesc
);
413 * exprep - ACPI AML execution - prep utilities
416 AcpiExPrepCommonFieldObject (
417 ACPI_OPERAND_OBJECT
*ObjDesc
,
419 UINT8 FieldAttribute
,
420 UINT32 FieldBitPosition
,
421 UINT32 FieldBitLength
);
424 AcpiExPrepFieldValue (
425 ACPI_CREATE_FIELD_INFO
*Info
);
429 * exsystem - Interface to OS services
432 AcpiExSystemDoNotifyOp (
433 ACPI_OPERAND_OBJECT
*Value
,
434 ACPI_OPERAND_OBJECT
*ObjDesc
);
441 AcpiExSystemDoStall (
445 AcpiExSystemSignalEvent(
446 ACPI_OPERAND_OBJECT
*ObjDesc
);
449 AcpiExSystemWaitEvent(
450 ACPI_OPERAND_OBJECT
*Time
,
451 ACPI_OPERAND_OBJECT
*ObjDesc
);
454 AcpiExSystemResetEvent(
455 ACPI_OPERAND_OBJECT
*ObjDesc
);
458 AcpiExSystemWaitSemaphore (
459 ACPI_SEMAPHORE Semaphore
,
463 AcpiExSystemWaitMutex (
468 * exoparg1 - ACPI AML execution, 1 operand
471 AcpiExOpcode_0A_0T_1R (
472 ACPI_WALK_STATE
*WalkState
);
475 AcpiExOpcode_1A_0T_0R (
476 ACPI_WALK_STATE
*WalkState
);
479 AcpiExOpcode_1A_0T_1R (
480 ACPI_WALK_STATE
*WalkState
);
483 AcpiExOpcode_1A_1T_1R (
484 ACPI_WALK_STATE
*WalkState
);
487 AcpiExOpcode_1A_1T_0R (
488 ACPI_WALK_STATE
*WalkState
);
491 * exoparg2 - ACPI AML execution, 2 operands
494 AcpiExOpcode_2A_0T_0R (
495 ACPI_WALK_STATE
*WalkState
);
498 AcpiExOpcode_2A_0T_1R (
499 ACPI_WALK_STATE
*WalkState
);
502 AcpiExOpcode_2A_1T_1R (
503 ACPI_WALK_STATE
*WalkState
);
506 AcpiExOpcode_2A_2T_1R (
507 ACPI_WALK_STATE
*WalkState
);
511 * exoparg3 - ACPI AML execution, 3 operands
514 AcpiExOpcode_3A_0T_0R (
515 ACPI_WALK_STATE
*WalkState
);
518 AcpiExOpcode_3A_1T_1R (
519 ACPI_WALK_STATE
*WalkState
);
523 * exoparg6 - ACPI AML execution, 6 operands
526 AcpiExOpcode_6A_0T_1R (
527 ACPI_WALK_STATE
*WalkState
);
531 * exresolv - Object resolution and get value functions
534 AcpiExResolveToValue (
535 ACPI_OPERAND_OBJECT
**StackPtr
,
536 ACPI_WALK_STATE
*WalkState
);
539 AcpiExResolveMultiple (
540 ACPI_WALK_STATE
*WalkState
,
541 ACPI_OPERAND_OBJECT
*Operand
,
542 ACPI_OBJECT_TYPE
*ReturnType
,
543 ACPI_OPERAND_OBJECT
**ReturnDesc
);
547 * exresnte - resolve namespace node
550 AcpiExResolveNodeToValue (
551 ACPI_NAMESPACE_NODE
**StackPtr
,
552 ACPI_WALK_STATE
*WalkState
);
556 * exresop - resolve operand to value
559 AcpiExResolveOperands (
561 ACPI_OPERAND_OBJECT
**StackPtr
,
562 ACPI_WALK_STATE
*WalkState
);
566 * exdump - Interpreter debug output routines
570 ACPI_OPERAND_OBJECT
*ObjDesc
,
575 ACPI_OPERAND_OBJECT
**Operands
,
576 const char *OpcodeName
,
580 AcpiExDumpObjectDescriptor (
581 ACPI_OPERAND_OBJECT
*Object
,
585 AcpiExDumpNamespaceNode (
586 ACPI_NAMESPACE_NODE
*Node
,
591 * exnames - AML namestring support
594 AcpiExGetNameString (
595 ACPI_OBJECT_TYPE DataType
,
597 char **OutNameString
,
598 UINT32
*OutNameLength
);
602 * exstore - Object store support
606 ACPI_OPERAND_OBJECT
*ValDesc
,
607 ACPI_OPERAND_OBJECT
*DestDesc
,
608 ACPI_WALK_STATE
*WalkState
);
611 AcpiExStoreObjectToNode (
612 ACPI_OPERAND_OBJECT
*SourceDesc
,
613 ACPI_NAMESPACE_NODE
*Node
,
614 ACPI_WALK_STATE
*WalkState
,
615 UINT8 ImplicitConversion
);
617 #define ACPI_IMPLICIT_CONVERSION TRUE
618 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
622 * exstoren - resolve/store object
625 AcpiExResolveObject (
626 ACPI_OPERAND_OBJECT
**SourceDescPtr
,
627 ACPI_OBJECT_TYPE TargetType
,
628 ACPI_WALK_STATE
*WalkState
);
631 AcpiExStoreObjectToObject (
632 ACPI_OPERAND_OBJECT
*SourceDesc
,
633 ACPI_OPERAND_OBJECT
*DestDesc
,
634 ACPI_OPERAND_OBJECT
**NewDesc
,
635 ACPI_WALK_STATE
*WalkState
);
639 * exstorob - store object - buffer/string
642 AcpiExStoreBufferToBuffer (
643 ACPI_OPERAND_OBJECT
*SourceDesc
,
644 ACPI_OPERAND_OBJECT
*TargetDesc
);
647 AcpiExStoreStringToString (
648 ACPI_OPERAND_OBJECT
*SourceDesc
,
649 ACPI_OPERAND_OBJECT
*TargetDesc
);
653 * excopy - object copy
656 AcpiExCopyIntegerToIndexField (
657 ACPI_OPERAND_OBJECT
*SourceDesc
,
658 ACPI_OPERAND_OBJECT
*TargetDesc
);
661 AcpiExCopyIntegerToBankField (
662 ACPI_OPERAND_OBJECT
*SourceDesc
,
663 ACPI_OPERAND_OBJECT
*TargetDesc
);
666 AcpiExCopyDataToNamedField (
667 ACPI_OPERAND_OBJECT
*SourceDesc
,
668 ACPI_NAMESPACE_NODE
*Node
);
671 AcpiExCopyIntegerToBufferField (
672 ACPI_OPERAND_OBJECT
*SourceDesc
,
673 ACPI_OPERAND_OBJECT
*TargetDesc
);
677 * exutils - interpreter/scanner utilities
680 AcpiExEnterInterpreter (
684 AcpiExExitInterpreter (
688 AcpiExReacquireInterpreter (
692 AcpiExRelinquishInterpreter (
696 AcpiExTruncateFor32bitTable (
697 ACPI_OPERAND_OBJECT
*ObjDesc
);
700 AcpiExAcquireGlobalLock (
704 AcpiExReleaseGlobalLock (
708 AcpiExEisaIdToString (
710 UINT64 CompressedId
);
713 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__ */