1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2009, 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 * exfield - ACPI AML (p-code) execution - field manipulation
209 AcpiExCommonBufferSetup (
210 ACPI_OPERAND_OBJECT
*ObjDesc
,
215 AcpiExWriteWithUpdateRule (
216 ACPI_OPERAND_OBJECT
*ObjDesc
,
218 ACPI_INTEGER FieldValue
,
219 UINT32 FieldDatumByteOffset
);
222 AcpiExGetBufferDatum(
226 UINT32 ByteGranularity
,
227 UINT32 BufferOffset
);
230 AcpiExSetBufferDatum (
231 ACPI_INTEGER MergedDatum
,
234 UINT32 ByteGranularity
,
235 UINT32 BufferOffset
);
238 AcpiExReadDataFromField (
239 ACPI_WALK_STATE
*WalkState
,
240 ACPI_OPERAND_OBJECT
*ObjDesc
,
241 ACPI_OPERAND_OBJECT
**RetBufferDesc
);
244 AcpiExWriteDataToField (
245 ACPI_OPERAND_OBJECT
*SourceDesc
,
246 ACPI_OPERAND_OBJECT
*ObjDesc
,
247 ACPI_OPERAND_OBJECT
**ResultDesc
);
251 * exfldio - low level field I/O
254 AcpiExExtractFromField (
255 ACPI_OPERAND_OBJECT
*ObjDesc
,
257 UINT32 BufferLength
);
260 AcpiExInsertIntoField (
261 ACPI_OPERAND_OBJECT
*ObjDesc
,
263 UINT32 BufferLength
);
267 ACPI_OPERAND_OBJECT
*ObjDesc
,
268 UINT32 FieldDatumByteOffset
,
274 * exmisc - misc support routines
277 AcpiExGetObjectReference (
278 ACPI_OPERAND_OBJECT
*ObjDesc
,
279 ACPI_OPERAND_OBJECT
**ReturnDesc
,
280 ACPI_WALK_STATE
*WalkState
);
283 AcpiExConcatTemplate (
284 ACPI_OPERAND_OBJECT
*ObjDesc
,
285 ACPI_OPERAND_OBJECT
*ObjDesc2
,
286 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
287 ACPI_WALK_STATE
*WalkState
);
290 AcpiExDoConcatenate (
291 ACPI_OPERAND_OBJECT
*ObjDesc
,
292 ACPI_OPERAND_OBJECT
*ObjDesc2
,
293 ACPI_OPERAND_OBJECT
**ActualReturnDesc
,
294 ACPI_WALK_STATE
*WalkState
);
297 AcpiExDoLogicalNumericOp (
299 ACPI_INTEGER Integer0
,
300 ACPI_INTEGER Integer1
,
301 BOOLEAN
*LogicalResult
);
306 ACPI_OPERAND_OBJECT
*Operand0
,
307 ACPI_OPERAND_OBJECT
*Operand1
,
308 BOOLEAN
*LogicalResult
);
313 ACPI_INTEGER Operand0
,
314 ACPI_INTEGER Operand1
);
318 ACPI_WALK_STATE
*WalkState
);
321 AcpiExCreateProcessor (
322 ACPI_WALK_STATE
*WalkState
);
325 AcpiExCreatePowerResource (
326 ACPI_WALK_STATE
*WalkState
);
333 ACPI_WALK_STATE
*WalkState
);
337 ACPI_WALK_STATE
*WalkState
);
341 ACPI_WALK_STATE
*WalkState
);
347 ACPI_WALK_STATE
*WalkState
);
351 * exconfig - dynamic table load/unload
355 ACPI_OPERAND_OBJECT
*ObjDesc
,
356 ACPI_OPERAND_OBJECT
*Target
,
357 ACPI_WALK_STATE
*WalkState
);
361 ACPI_WALK_STATE
*WalkState
,
362 ACPI_OPERAND_OBJECT
**ReturnDesc
);
366 ACPI_OPERAND_OBJECT
*DdbHandle
);
370 * exmutex - mutex support
374 ACPI_OPERAND_OBJECT
*TimeDesc
,
375 ACPI_OPERAND_OBJECT
*ObjDesc
,
376 ACPI_WALK_STATE
*WalkState
);
379 AcpiExAcquireMutexObject (
381 ACPI_OPERAND_OBJECT
*ObjDesc
,
382 ACPI_THREAD_ID ThreadId
);
386 ACPI_OPERAND_OBJECT
*ObjDesc
,
387 ACPI_WALK_STATE
*WalkState
);
390 AcpiExReleaseMutexObject (
391 ACPI_OPERAND_OBJECT
*ObjDesc
);
394 AcpiExReleaseAllMutexes (
395 ACPI_THREAD_STATE
*Thread
);
399 ACPI_OPERAND_OBJECT
*ObjDesc
);
403 * exprep - ACPI AML execution - prep utilities
406 AcpiExPrepCommonFieldObject (
407 ACPI_OPERAND_OBJECT
*ObjDesc
,
409 UINT8 FieldAttribute
,
410 UINT32 FieldBitPosition
,
411 UINT32 FieldBitLength
);
414 AcpiExPrepFieldValue (
415 ACPI_CREATE_FIELD_INFO
*Info
);
419 * exsystem - Interface to OS services
422 AcpiExSystemDoNotifyOp (
423 ACPI_OPERAND_OBJECT
*Value
,
424 ACPI_OPERAND_OBJECT
*ObjDesc
);
427 AcpiExSystemDoSuspend(
431 AcpiExSystemDoStall (
435 AcpiExSystemSignalEvent(
436 ACPI_OPERAND_OBJECT
*ObjDesc
);
439 AcpiExSystemWaitEvent(
440 ACPI_OPERAND_OBJECT
*Time
,
441 ACPI_OPERAND_OBJECT
*ObjDesc
);
444 AcpiExSystemResetEvent(
445 ACPI_OPERAND_OBJECT
*ObjDesc
);
448 AcpiExSystemWaitSemaphore (
449 ACPI_SEMAPHORE Semaphore
,
453 AcpiExSystemWaitMutex (
458 * exoparg1 - ACPI AML execution, 1 operand
461 AcpiExOpcode_0A_0T_1R (
462 ACPI_WALK_STATE
*WalkState
);
465 AcpiExOpcode_1A_0T_0R (
466 ACPI_WALK_STATE
*WalkState
);
469 AcpiExOpcode_1A_0T_1R (
470 ACPI_WALK_STATE
*WalkState
);
473 AcpiExOpcode_1A_1T_1R (
474 ACPI_WALK_STATE
*WalkState
);
477 AcpiExOpcode_1A_1T_0R (
478 ACPI_WALK_STATE
*WalkState
);
481 * exoparg2 - ACPI AML execution, 2 operands
484 AcpiExOpcode_2A_0T_0R (
485 ACPI_WALK_STATE
*WalkState
);
488 AcpiExOpcode_2A_0T_1R (
489 ACPI_WALK_STATE
*WalkState
);
492 AcpiExOpcode_2A_1T_1R (
493 ACPI_WALK_STATE
*WalkState
);
496 AcpiExOpcode_2A_2T_1R (
497 ACPI_WALK_STATE
*WalkState
);
501 * exoparg3 - ACPI AML execution, 3 operands
504 AcpiExOpcode_3A_0T_0R (
505 ACPI_WALK_STATE
*WalkState
);
508 AcpiExOpcode_3A_1T_1R (
509 ACPI_WALK_STATE
*WalkState
);
513 * exoparg6 - ACPI AML execution, 6 operands
516 AcpiExOpcode_6A_0T_1R (
517 ACPI_WALK_STATE
*WalkState
);
521 * exresolv - Object resolution and get value functions
524 AcpiExResolveToValue (
525 ACPI_OPERAND_OBJECT
**StackPtr
,
526 ACPI_WALK_STATE
*WalkState
);
529 AcpiExResolveMultiple (
530 ACPI_WALK_STATE
*WalkState
,
531 ACPI_OPERAND_OBJECT
*Operand
,
532 ACPI_OBJECT_TYPE
*ReturnType
,
533 ACPI_OPERAND_OBJECT
**ReturnDesc
);
537 * exresnte - resolve namespace node
540 AcpiExResolveNodeToValue (
541 ACPI_NAMESPACE_NODE
**StackPtr
,
542 ACPI_WALK_STATE
*WalkState
);
546 * exresop - resolve operand to value
549 AcpiExResolveOperands (
551 ACPI_OPERAND_OBJECT
**StackPtr
,
552 ACPI_WALK_STATE
*WalkState
);
556 * exdump - Interpreter debug output routines
560 ACPI_OPERAND_OBJECT
*ObjDesc
,
565 ACPI_OPERAND_OBJECT
**Operands
,
566 const char *OpcodeName
,
570 AcpiExDumpObjectDescriptor (
571 ACPI_OPERAND_OBJECT
*Object
,
575 AcpiExDumpNamespaceNode (
576 ACPI_NAMESPACE_NODE
*Node
,
581 * exnames - AML namestring support
584 AcpiExGetNameString (
585 ACPI_OBJECT_TYPE DataType
,
587 char **OutNameString
,
588 UINT32
*OutNameLength
);
592 * exstore - Object store support
596 ACPI_OPERAND_OBJECT
*ValDesc
,
597 ACPI_OPERAND_OBJECT
*DestDesc
,
598 ACPI_WALK_STATE
*WalkState
);
601 AcpiExStoreObjectToNode (
602 ACPI_OPERAND_OBJECT
*SourceDesc
,
603 ACPI_NAMESPACE_NODE
*Node
,
604 ACPI_WALK_STATE
*WalkState
,
605 UINT8 ImplicitConversion
);
607 #define ACPI_IMPLICIT_CONVERSION TRUE
608 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
612 * exstoren - resolve/store object
615 AcpiExResolveObject (
616 ACPI_OPERAND_OBJECT
**SourceDescPtr
,
617 ACPI_OBJECT_TYPE TargetType
,
618 ACPI_WALK_STATE
*WalkState
);
621 AcpiExStoreObjectToObject (
622 ACPI_OPERAND_OBJECT
*SourceDesc
,
623 ACPI_OPERAND_OBJECT
*DestDesc
,
624 ACPI_OPERAND_OBJECT
**NewDesc
,
625 ACPI_WALK_STATE
*WalkState
);
629 * exstorob - store object - buffer/string
632 AcpiExStoreBufferToBuffer (
633 ACPI_OPERAND_OBJECT
*SourceDesc
,
634 ACPI_OPERAND_OBJECT
*TargetDesc
);
637 AcpiExStoreStringToString (
638 ACPI_OPERAND_OBJECT
*SourceDesc
,
639 ACPI_OPERAND_OBJECT
*TargetDesc
);
643 * excopy - object copy
646 AcpiExCopyIntegerToIndexField (
647 ACPI_OPERAND_OBJECT
*SourceDesc
,
648 ACPI_OPERAND_OBJECT
*TargetDesc
);
651 AcpiExCopyIntegerToBankField (
652 ACPI_OPERAND_OBJECT
*SourceDesc
,
653 ACPI_OPERAND_OBJECT
*TargetDesc
);
656 AcpiExCopyDataToNamedField (
657 ACPI_OPERAND_OBJECT
*SourceDesc
,
658 ACPI_NAMESPACE_NODE
*Node
);
661 AcpiExCopyIntegerToBufferField (
662 ACPI_OPERAND_OBJECT
*SourceDesc
,
663 ACPI_OPERAND_OBJECT
*TargetDesc
);
667 * exutils - interpreter/scanner utilities
670 AcpiExEnterInterpreter (
674 AcpiExExitInterpreter (
678 AcpiExReacquireInterpreter (
682 AcpiExRelinquishInterpreter (
686 AcpiExTruncateFor32bitTable (
687 ACPI_OPERAND_OBJECT
*ObjDesc
);
690 AcpiExAcquireGlobalLock (
694 AcpiExReleaseGlobalLock (
698 AcpiExEisaIdToString (
700 ACPI_INTEGER CompressedId
);
703 AcpiExIntegerToString (
709 * exregion - default OpRegion handlers
712 AcpiExSystemMemorySpaceHandler (
714 ACPI_PHYSICAL_ADDRESS Address
,
717 void *HandlerContext
,
718 void *RegionContext
);
721 AcpiExSystemIoSpaceHandler (
723 ACPI_PHYSICAL_ADDRESS Address
,
726 void *HandlerContext
,
727 void *RegionContext
);
730 AcpiExPciConfigSpaceHandler (
732 ACPI_PHYSICAL_ADDRESS Address
,
735 void *HandlerContext
,
736 void *RegionContext
);
739 AcpiExCmosSpaceHandler (
741 ACPI_PHYSICAL_ADDRESS Address
,
744 void *HandlerContext
,
745 void *RegionContext
);
748 AcpiExPciBarSpaceHandler (
750 ACPI_PHYSICAL_ADDRESS Address
,
753 void *HandlerContext
,
754 void *RegionContext
);
757 AcpiExEmbeddedControllerSpaceHandler (
759 ACPI_PHYSICAL_ADDRESS Address
,
762 void *HandlerContext
,
763 void *RegionContext
);
766 AcpiExSmBusSpaceHandler (
768 ACPI_PHYSICAL_ADDRESS Address
,
771 void *HandlerContext
,
772 void *RegionContext
);
776 AcpiExDataTableSpaceHandler (
778 ACPI_PHYSICAL_ADDRESS Address
,
781 void *HandlerContext
,
782 void *RegionContext
);
784 #endif /* __INTERP_H__ */