1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACINTERP_H__
45 #define __ACINTERP_H__
48 #define ACPI_WALK_OPERANDS (&(WalkState->Operands [WalkState->NumOperands -1]))
50 /* Macros for tables used for debug output */
52 #define ACPI_EXD_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_OPERAND_OBJECT,f)
53 #define ACPI_EXD_NSOFFSET(f) (UINT8) ACPI_OFFSET (ACPI_NAMESPACE_NODE,f)
54 #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (ACPI_EXDUMP_INFO))
57 * If possible, pack the following structures to byte alignment, since we
58 * don't care about performance for debug output. Two cases where we cannot
59 * pack the structures:
61 * 1) Hardware does not support misaligned memory transfers
62 * 2) Compiler does not support pointers within packed structures
64 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
68 typedef const struct acpi_exdump_info
76 /* Values for the Opcode field above */
78 #define ACPI_EXD_INIT 0
79 #define ACPI_EXD_TYPE 1
80 #define ACPI_EXD_UINT8 2
81 #define ACPI_EXD_UINT16 3
82 #define ACPI_EXD_UINT32 4
83 #define ACPI_EXD_UINT64 5
84 #define ACPI_EXD_LITERAL 6
85 #define ACPI_EXD_POINTER 7
86 #define ACPI_EXD_ADDRESS 8
87 #define ACPI_EXD_STRING 9
88 #define ACPI_EXD_BUFFER 10
89 #define ACPI_EXD_PACKAGE 11
90 #define ACPI_EXD_FIELD 12
91 #define ACPI_EXD_REFERENCE 13
92 #define ACPI_EXD_LIST 14 /* Operand object list */
93 #define ACPI_EXD_HDLR_LIST 15 /* Address Handler list */
94 #define ACPI_EXD_RGN_LIST 16 /* Region list */
95 #define ACPI_EXD_NODE 17 /* Namespace Node */
97 /* restore default alignment */
103 * exconvrt - object conversion
106 AcpiExConvertToInteger (
107 ACPI_OPERAND_OBJECT *ObjDesc,
108 ACPI_OPERAND_OBJECT **ResultDesc,
112 AcpiExConvertToBuffer (
113 ACPI_OPERAND_OBJECT *ObjDesc,
114 ACPI_OPERAND_OBJECT **ResultDesc);
117 AcpiExConvertToString (
118 ACPI_OPERAND_OBJECT *ObjDesc,
119 ACPI_OPERAND_OBJECT **ResultDesc,
122 /* Types for ->String conversion */
124 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
125 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
126 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
127 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
130 AcpiExConvertToTargetType (
131 ACPI_OBJECT_TYPE DestinationType,
132 ACPI_OPERAND_OBJECT *SourceDesc,
133 ACPI_OPERAND_OBJECT **ResultDesc,
134 ACPI_WALK_STATE *WalkState);
138 * exdebug - AML debug object
141 AcpiExDoDebugObject (
142 ACPI_OPERAND_OBJECT *SourceDesc,
148 * exfield - ACPI AML (p-code) execution - field manipulation
151 AcpiExCommonBufferSetup (
152 ACPI_OPERAND_OBJECT *ObjDesc,
157 AcpiExWriteWithUpdateRule (
158 ACPI_OPERAND_OBJECT *ObjDesc,
161 UINT32 FieldDatumByteOffset);
164 AcpiExGetBufferDatum(
168 UINT32 ByteGranularity,
169 UINT32 BufferOffset);
172 AcpiExSetBufferDatum (
176 UINT32 ByteGranularity,
177 UINT32 BufferOffset);
180 AcpiExReadDataFromField (
181 ACPI_WALK_STATE *WalkState,
182 ACPI_OPERAND_OBJECT *ObjDesc,
183 ACPI_OPERAND_OBJECT **RetBufferDesc);
186 AcpiExWriteDataToField (
187 ACPI_OPERAND_OBJECT *SourceDesc,
188 ACPI_OPERAND_OBJECT *ObjDesc,
189 ACPI_OPERAND_OBJECT **ResultDesc);
193 * exfldio - low level field I/O
196 AcpiExExtractFromField (
197 ACPI_OPERAND_OBJECT *ObjDesc,
199 UINT32 BufferLength);
202 AcpiExInsertIntoField (
203 ACPI_OPERAND_OBJECT *ObjDesc,
205 UINT32 BufferLength);
209 ACPI_OPERAND_OBJECT *ObjDesc,
210 UINT32 FieldDatumByteOffset,
216 * exmisc - misc support routines
219 AcpiExGetObjectReference (
220 ACPI_OPERAND_OBJECT *ObjDesc,
221 ACPI_OPERAND_OBJECT **ReturnDesc,
222 ACPI_WALK_STATE *WalkState);
225 AcpiExConcatTemplate (
226 ACPI_OPERAND_OBJECT *ObjDesc,
227 ACPI_OPERAND_OBJECT *ObjDesc2,
228 ACPI_OPERAND_OBJECT **ActualReturnDesc,
229 ACPI_WALK_STATE *WalkState);
232 AcpiExDoConcatenate (
233 ACPI_OPERAND_OBJECT *ObjDesc,
234 ACPI_OPERAND_OBJECT *ObjDesc2,
235 ACPI_OPERAND_OBJECT **ActualReturnDesc,
236 ACPI_WALK_STATE *WalkState);
239 AcpiExDoLogicalNumericOp (
243 BOOLEAN *LogicalResult);
248 ACPI_OPERAND_OBJECT *Operand0,
249 ACPI_OPERAND_OBJECT *Operand1,
250 BOOLEAN *LogicalResult);
260 ACPI_WALK_STATE *WalkState);
263 AcpiExCreateProcessor (
264 ACPI_WALK_STATE *WalkState);
267 AcpiExCreatePowerResource (
268 ACPI_WALK_STATE *WalkState);
275 ACPI_WALK_STATE *WalkState);
279 ACPI_WALK_STATE *WalkState);
283 ACPI_WALK_STATE *WalkState);
289 ACPI_WALK_STATE *WalkState);
293 * exconfig - dynamic table load/unload
297 ACPI_OPERAND_OBJECT *ObjDesc,
298 ACPI_OPERAND_OBJECT *Target,
299 ACPI_WALK_STATE *WalkState);
303 ACPI_WALK_STATE *WalkState,
304 ACPI_OPERAND_OBJECT **ReturnDesc);
308 ACPI_OPERAND_OBJECT *DdbHandle);
312 * exmutex - mutex support
316 ACPI_OPERAND_OBJECT *TimeDesc,
317 ACPI_OPERAND_OBJECT *ObjDesc,
318 ACPI_WALK_STATE *WalkState);
321 AcpiExAcquireMutexObject (
323 ACPI_OPERAND_OBJECT *ObjDesc,
324 ACPI_THREAD_ID ThreadId);
328 ACPI_OPERAND_OBJECT *ObjDesc,
329 ACPI_WALK_STATE *WalkState);
332 AcpiExReleaseMutexObject (
333 ACPI_OPERAND_OBJECT *ObjDesc);
336 AcpiExReleaseAllMutexes (
337 ACPI_THREAD_STATE *Thread);
341 ACPI_OPERAND_OBJECT *ObjDesc);
345 * exprep - ACPI AML execution - prep utilities
348 AcpiExPrepCommonFieldObject (
349 ACPI_OPERAND_OBJECT *ObjDesc,
351 UINT8 FieldAttribute,
352 UINT32 FieldBitPosition,
353 UINT32 FieldBitLength);
356 AcpiExPrepFieldValue (
357 ACPI_CREATE_FIELD_INFO *Info);
361 * exsystem - Interface to OS services
364 AcpiExSystemDoNotifyOp (
365 ACPI_OPERAND_OBJECT *Value,
366 ACPI_OPERAND_OBJECT *ObjDesc);
373 AcpiExSystemDoStall (
377 AcpiExSystemSignalEvent(
378 ACPI_OPERAND_OBJECT *ObjDesc);
381 AcpiExSystemWaitEvent(
382 ACPI_OPERAND_OBJECT *Time,
383 ACPI_OPERAND_OBJECT *ObjDesc);
386 AcpiExSystemResetEvent(
387 ACPI_OPERAND_OBJECT *ObjDesc);
390 AcpiExSystemWaitSemaphore (
391 ACPI_SEMAPHORE Semaphore,
395 AcpiExSystemWaitMutex (
400 * exoparg1 - ACPI AML execution, 1 operand
403 AcpiExOpcode_0A_0T_1R (
404 ACPI_WALK_STATE *WalkState);
407 AcpiExOpcode_1A_0T_0R (
408 ACPI_WALK_STATE *WalkState);
411 AcpiExOpcode_1A_0T_1R (
412 ACPI_WALK_STATE *WalkState);
415 AcpiExOpcode_1A_1T_1R (
416 ACPI_WALK_STATE *WalkState);
419 AcpiExOpcode_1A_1T_0R (
420 ACPI_WALK_STATE *WalkState);
423 * exoparg2 - ACPI AML execution, 2 operands
426 AcpiExOpcode_2A_0T_0R (
427 ACPI_WALK_STATE *WalkState);
430 AcpiExOpcode_2A_0T_1R (
431 ACPI_WALK_STATE *WalkState);
434 AcpiExOpcode_2A_1T_1R (
435 ACPI_WALK_STATE *WalkState);
438 AcpiExOpcode_2A_2T_1R (
439 ACPI_WALK_STATE *WalkState);
443 * exoparg3 - ACPI AML execution, 3 operands
446 AcpiExOpcode_3A_0T_0R (
447 ACPI_WALK_STATE *WalkState);
450 AcpiExOpcode_3A_1T_1R (
451 ACPI_WALK_STATE *WalkState);
455 * exoparg6 - ACPI AML execution, 6 operands
458 AcpiExOpcode_6A_0T_1R (
459 ACPI_WALK_STATE *WalkState);
463 * exresolv - Object resolution and get value functions
466 AcpiExResolveToValue (
467 ACPI_OPERAND_OBJECT **StackPtr,
468 ACPI_WALK_STATE *WalkState);
471 AcpiExResolveMultiple (
472 ACPI_WALK_STATE *WalkState,
473 ACPI_OPERAND_OBJECT *Operand,
474 ACPI_OBJECT_TYPE *ReturnType,
475 ACPI_OPERAND_OBJECT **ReturnDesc);
479 * exresnte - resolve namespace node
482 AcpiExResolveNodeToValue (
483 ACPI_NAMESPACE_NODE **StackPtr,
484 ACPI_WALK_STATE *WalkState);
488 * exresop - resolve operand to value
491 AcpiExResolveOperands (
493 ACPI_OPERAND_OBJECT **StackPtr,
494 ACPI_WALK_STATE *WalkState);
498 * exdump - Interpreter debug output routines
502 ACPI_OPERAND_OBJECT *ObjDesc,
507 ACPI_OPERAND_OBJECT **Operands,
508 const char *OpcodeName,
512 AcpiExDumpObjectDescriptor (
513 ACPI_OPERAND_OBJECT *Object,
517 AcpiExDumpNamespaceNode (
518 ACPI_NAMESPACE_NODE *Node,
523 * exnames - AML namestring support
526 AcpiExGetNameString (
527 ACPI_OBJECT_TYPE DataType,
529 char **OutNameString,
530 UINT32 *OutNameLength);
534 * exstore - Object store support
538 ACPI_OPERAND_OBJECT *ValDesc,
539 ACPI_OPERAND_OBJECT *DestDesc,
540 ACPI_WALK_STATE *WalkState);
543 AcpiExStoreObjectToNode (
544 ACPI_OPERAND_OBJECT *SourceDesc,
545 ACPI_NAMESPACE_NODE *Node,
546 ACPI_WALK_STATE *WalkState,
547 UINT8 ImplicitConversion);
549 #define ACPI_IMPLICIT_CONVERSION TRUE
550 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
554 * exstoren - resolve/store object
557 AcpiExResolveObject (
558 ACPI_OPERAND_OBJECT **SourceDescPtr,
559 ACPI_OBJECT_TYPE TargetType,
560 ACPI_WALK_STATE *WalkState);
563 AcpiExStoreObjectToObject (
564 ACPI_OPERAND_OBJECT *SourceDesc,
565 ACPI_OPERAND_OBJECT *DestDesc,
566 ACPI_OPERAND_OBJECT **NewDesc,
567 ACPI_WALK_STATE *WalkState);
571 * exstorob - store object - buffer/string
574 AcpiExStoreBufferToBuffer (
575 ACPI_OPERAND_OBJECT *SourceDesc,
576 ACPI_OPERAND_OBJECT *TargetDesc);
579 AcpiExStoreStringToString (
580 ACPI_OPERAND_OBJECT *SourceDesc,
581 ACPI_OPERAND_OBJECT *TargetDesc);
585 * excopy - object copy
588 AcpiExCopyIntegerToIndexField (
589 ACPI_OPERAND_OBJECT *SourceDesc,
590 ACPI_OPERAND_OBJECT *TargetDesc);
593 AcpiExCopyIntegerToBankField (
594 ACPI_OPERAND_OBJECT *SourceDesc,
595 ACPI_OPERAND_OBJECT *TargetDesc);
598 AcpiExCopyDataToNamedField (
599 ACPI_OPERAND_OBJECT *SourceDesc,
600 ACPI_NAMESPACE_NODE *Node);
603 AcpiExCopyIntegerToBufferField (
604 ACPI_OPERAND_OBJECT *SourceDesc,
605 ACPI_OPERAND_OBJECT *TargetDesc);
609 * exutils - interpreter/scanner utilities
612 AcpiExEnterInterpreter (
616 AcpiExExitInterpreter (
620 AcpiExTruncateFor32bitTable (
621 ACPI_OPERAND_OBJECT *ObjDesc);
624 AcpiExAcquireGlobalLock (
628 AcpiExReleaseGlobalLock (
632 AcpiExEisaIdToString (
634 UINT64 CompressedId);
637 AcpiExIntegerToString (
647 * exregion - default OpRegion handlers
650 AcpiExSystemMemorySpaceHandler (
652 ACPI_PHYSICAL_ADDRESS Address,
655 void *HandlerContext,
656 void *RegionContext);
659 AcpiExSystemIoSpaceHandler (
661 ACPI_PHYSICAL_ADDRESS Address,
664 void *HandlerContext,
665 void *RegionContext);
668 AcpiExPciConfigSpaceHandler (
670 ACPI_PHYSICAL_ADDRESS Address,
673 void *HandlerContext,
674 void *RegionContext);
677 AcpiExCmosSpaceHandler (
679 ACPI_PHYSICAL_ADDRESS Address,
682 void *HandlerContext,
683 void *RegionContext);
686 AcpiExPciBarSpaceHandler (
688 ACPI_PHYSICAL_ADDRESS Address,
691 void *HandlerContext,
692 void *RegionContext);
695 AcpiExEmbeddedControllerSpaceHandler (
697 ACPI_PHYSICAL_ADDRESS Address,
700 void *HandlerContext,
701 void *RegionContext);
704 AcpiExSmBusSpaceHandler (
706 ACPI_PHYSICAL_ADDRESS Address,
709 void *HandlerContext,
710 void *RegionContext);
714 AcpiExDataTableSpaceHandler (
716 ACPI_PHYSICAL_ADDRESS Address,
719 void *HandlerContext,
720 void *RegionContext);
722 #endif /* __INTERP_H__ */