1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #ifndef __ACINTERP_H__
118 #define __ACINTERP_H__
121 #define ACPI_WALK_OPERANDS (&(WalkState->Operands [WalkState->NumOperands -1]))
125 * exconvrt - object conversion
128 AcpiExConvertToInteger (
129 ACPI_OPERAND_OBJECT *ObjDesc,
130 ACPI_OPERAND_OBJECT **ResultDesc,
134 AcpiExConvertToBuffer (
135 ACPI_OPERAND_OBJECT *ObjDesc,
136 ACPI_OPERAND_OBJECT **ResultDesc);
139 AcpiExConvertToString (
140 ACPI_OPERAND_OBJECT *ObjDesc,
141 ACPI_OPERAND_OBJECT **ResultDesc,
144 /* Types for ->String conversion */
146 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
147 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
148 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
149 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
152 AcpiExConvertToTargetType (
153 ACPI_OBJECT_TYPE DestinationType,
154 ACPI_OPERAND_OBJECT *SourceDesc,
155 ACPI_OPERAND_OBJECT **ResultDesc,
156 ACPI_WALK_STATE *WalkState);
160 * exfield - ACPI AML (p-code) execution - field manipulation
163 AcpiExCommonBufferSetup (
164 ACPI_OPERAND_OBJECT *ObjDesc,
169 AcpiExWriteWithUpdateRule (
170 ACPI_OPERAND_OBJECT *ObjDesc,
172 ACPI_INTEGER FieldValue,
173 UINT32 FieldDatumByteOffset);
176 AcpiExGetBufferDatum(
180 UINT32 ByteGranularity,
181 UINT32 BufferOffset);
184 AcpiExSetBufferDatum (
185 ACPI_INTEGER MergedDatum,
188 UINT32 ByteGranularity,
189 UINT32 BufferOffset);
192 AcpiExReadDataFromField (
193 ACPI_WALK_STATE *WalkState,
194 ACPI_OPERAND_OBJECT *ObjDesc,
195 ACPI_OPERAND_OBJECT **RetBufferDesc);
198 AcpiExWriteDataToField (
199 ACPI_OPERAND_OBJECT *SourceDesc,
200 ACPI_OPERAND_OBJECT *ObjDesc,
201 ACPI_OPERAND_OBJECT **ResultDesc);
205 * exfldio - low level field I/O
208 AcpiExExtractFromField (
209 ACPI_OPERAND_OBJECT *ObjDesc,
211 UINT32 BufferLength);
214 AcpiExInsertIntoField (
215 ACPI_OPERAND_OBJECT *ObjDesc,
217 UINT32 BufferLength);
221 ACPI_OPERAND_OBJECT *ObjDesc,
222 UINT32 FieldDatumByteOffset,
228 * exmisc - misc support routines
231 AcpiExGetObjectReference (
232 ACPI_OPERAND_OBJECT *ObjDesc,
233 ACPI_OPERAND_OBJECT **ReturnDesc,
234 ACPI_WALK_STATE *WalkState);
237 AcpiExConcatTemplate (
238 ACPI_OPERAND_OBJECT *ObjDesc,
239 ACPI_OPERAND_OBJECT *ObjDesc2,
240 ACPI_OPERAND_OBJECT **ActualReturnDesc,
241 ACPI_WALK_STATE *WalkState);
244 AcpiExDoConcatenate (
245 ACPI_OPERAND_OBJECT *ObjDesc,
246 ACPI_OPERAND_OBJECT *ObjDesc2,
247 ACPI_OPERAND_OBJECT **ActualReturnDesc,
248 ACPI_WALK_STATE *WalkState);
251 AcpiExDoLogicalNumericOp (
253 ACPI_INTEGER Integer0,
254 ACPI_INTEGER Integer1,
255 BOOLEAN *LogicalResult);
260 ACPI_OPERAND_OBJECT *Operand0,
261 ACPI_OPERAND_OBJECT *Operand1,
262 BOOLEAN *LogicalResult);
267 ACPI_INTEGER Operand0,
268 ACPI_INTEGER Operand1);
272 ACPI_WALK_STATE *WalkState);
275 AcpiExCreateProcessor (
276 ACPI_WALK_STATE *WalkState);
279 AcpiExCreatePowerResource (
280 ACPI_WALK_STATE *WalkState);
287 ACPI_WALK_STATE *WalkState);
290 AcpiExCreateTableRegion (
291 ACPI_WALK_STATE *WalkState);
295 ACPI_WALK_STATE *WalkState);
299 ACPI_WALK_STATE *WalkState);
305 ACPI_WALK_STATE *WalkState);
309 * exconfig - dynamic table load/unload
313 ACPI_OPERAND_OBJECT *ObjDesc,
314 ACPI_OPERAND_OBJECT *Target,
315 ACPI_WALK_STATE *WalkState);
319 ACPI_WALK_STATE *WalkState,
320 ACPI_OPERAND_OBJECT **ReturnDesc);
324 ACPI_OPERAND_OBJECT *DdbHandle);
328 * exmutex - mutex support
332 ACPI_OPERAND_OBJECT *TimeDesc,
333 ACPI_OPERAND_OBJECT *ObjDesc,
334 ACPI_WALK_STATE *WalkState);
338 ACPI_OPERAND_OBJECT *ObjDesc,
339 ACPI_WALK_STATE *WalkState);
342 AcpiExReleaseAllMutexes (
343 ACPI_THREAD_STATE *Thread);
347 ACPI_OPERAND_OBJECT *ObjDesc);
351 * exprep - ACPI AML execution - prep utilities
354 AcpiExPrepCommonFieldObject (
355 ACPI_OPERAND_OBJECT *ObjDesc,
357 UINT8 FieldAttribute,
358 UINT32 FieldBitPosition,
359 UINT32 FieldBitLength);
362 AcpiExPrepFieldValue (
363 ACPI_CREATE_FIELD_INFO *Info);
367 * exsystem - Interface to OS services
370 AcpiExSystemDoNotifyOp (
371 ACPI_OPERAND_OBJECT *Value,
372 ACPI_OPERAND_OBJECT *ObjDesc);
375 AcpiExSystemDoSuspend(
379 AcpiExSystemDoStall (
383 AcpiExSystemAcquireMutex(
384 ACPI_OPERAND_OBJECT *Time,
385 ACPI_OPERAND_OBJECT *ObjDesc);
388 AcpiExSystemReleaseMutex(
389 ACPI_OPERAND_OBJECT *ObjDesc);
392 AcpiExSystemSignalEvent(
393 ACPI_OPERAND_OBJECT *ObjDesc);
396 AcpiExSystemWaitEvent(
397 ACPI_OPERAND_OBJECT *Time,
398 ACPI_OPERAND_OBJECT *ObjDesc);
401 AcpiExSystemResetEvent(
402 ACPI_OPERAND_OBJECT *ObjDesc);
405 AcpiExSystemWaitSemaphore (
406 ACPI_HANDLE Semaphore,
411 * exoparg1 - ACPI AML execution, 1 operand
414 AcpiExOpcode_0A_0T_1R (
415 ACPI_WALK_STATE *WalkState);
418 AcpiExOpcode_1A_0T_0R (
419 ACPI_WALK_STATE *WalkState);
422 AcpiExOpcode_1A_0T_1R (
423 ACPI_WALK_STATE *WalkState);
426 AcpiExOpcode_1A_1T_1R (
427 ACPI_WALK_STATE *WalkState);
430 AcpiExOpcode_1A_1T_0R (
431 ACPI_WALK_STATE *WalkState);
434 * exoparg2 - ACPI AML execution, 2 operands
437 AcpiExOpcode_2A_0T_0R (
438 ACPI_WALK_STATE *WalkState);
441 AcpiExOpcode_2A_0T_1R (
442 ACPI_WALK_STATE *WalkState);
445 AcpiExOpcode_2A_1T_1R (
446 ACPI_WALK_STATE *WalkState);
449 AcpiExOpcode_2A_2T_1R (
450 ACPI_WALK_STATE *WalkState);
454 * exoparg3 - ACPI AML execution, 3 operands
457 AcpiExOpcode_3A_0T_0R (
458 ACPI_WALK_STATE *WalkState);
461 AcpiExOpcode_3A_1T_1R (
462 ACPI_WALK_STATE *WalkState);
466 * exoparg6 - ACPI AML execution, 6 operands
469 AcpiExOpcode_6A_0T_1R (
470 ACPI_WALK_STATE *WalkState);
474 * exresolv - Object resolution and get value functions
477 AcpiExResolveToValue (
478 ACPI_OPERAND_OBJECT **StackPtr,
479 ACPI_WALK_STATE *WalkState);
482 AcpiExResolveMultiple (
483 ACPI_WALK_STATE *WalkState,
484 ACPI_OPERAND_OBJECT *Operand,
485 ACPI_OBJECT_TYPE *ReturnType,
486 ACPI_OPERAND_OBJECT **ReturnDesc);
490 * exresnte - resolve namespace node
493 AcpiExResolveNodeToValue (
494 ACPI_NAMESPACE_NODE **StackPtr,
495 ACPI_WALK_STATE *WalkState);
499 * exresop - resolve operand to value
502 AcpiExResolveOperands (
504 ACPI_OPERAND_OBJECT **StackPtr,
505 ACPI_WALK_STATE *WalkState);
509 * exdump - Interpreter debug output routines
513 ACPI_OPERAND_OBJECT *ObjDesc,
518 ACPI_OPERAND_OBJECT **Operands,
519 ACPI_INTERPRETER_MODE InterpreterMode,
527 AcpiExDumpObjectDescriptor (
528 ACPI_OPERAND_OBJECT *Object,
533 ACPI_NAMESPACE_NODE *Node,
538 * exnames - AML namestring support
541 AcpiExGetNameString (
542 ACPI_OBJECT_TYPE DataType,
544 char **OutNameString,
545 UINT32 *OutNameLength);
549 * exstore - Object store support
553 ACPI_OPERAND_OBJECT *ValDesc,
554 ACPI_OPERAND_OBJECT *DestDesc,
555 ACPI_WALK_STATE *WalkState);
558 AcpiExStoreObjectToNode (
559 ACPI_OPERAND_OBJECT *SourceDesc,
560 ACPI_NAMESPACE_NODE *Node,
561 ACPI_WALK_STATE *WalkState,
562 UINT8 ImplicitConversion);
564 #define ACPI_IMPLICIT_CONVERSION TRUE
565 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
569 * exstoren - resolve/store object
572 AcpiExResolveObject (
573 ACPI_OPERAND_OBJECT **SourceDescPtr,
574 ACPI_OBJECT_TYPE TargetType,
575 ACPI_WALK_STATE *WalkState);
578 AcpiExStoreObjectToObject (
579 ACPI_OPERAND_OBJECT *SourceDesc,
580 ACPI_OPERAND_OBJECT *DestDesc,
581 ACPI_OPERAND_OBJECT **NewDesc,
582 ACPI_WALK_STATE *WalkState);
586 * exstorob - store object - buffer/string
589 AcpiExStoreBufferToBuffer (
590 ACPI_OPERAND_OBJECT *SourceDesc,
591 ACPI_OPERAND_OBJECT *TargetDesc);
594 AcpiExStoreStringToString (
595 ACPI_OPERAND_OBJECT *SourceDesc,
596 ACPI_OPERAND_OBJECT *TargetDesc);
600 * excopy - object copy
603 AcpiExCopyIntegerToIndexField (
604 ACPI_OPERAND_OBJECT *SourceDesc,
605 ACPI_OPERAND_OBJECT *TargetDesc);
608 AcpiExCopyIntegerToBankField (
609 ACPI_OPERAND_OBJECT *SourceDesc,
610 ACPI_OPERAND_OBJECT *TargetDesc);
613 AcpiExCopyDataToNamedField (
614 ACPI_OPERAND_OBJECT *SourceDesc,
615 ACPI_NAMESPACE_NODE *Node);
618 AcpiExCopyIntegerToBufferField (
619 ACPI_OPERAND_OBJECT *SourceDesc,
620 ACPI_OPERAND_OBJECT *TargetDesc);
624 * exutils - interpreter/scanner utilities
627 AcpiExEnterInterpreter (
631 AcpiExExitInterpreter (
635 AcpiExTruncateFor32bitTable (
636 ACPI_OPERAND_OBJECT *ObjDesc);
639 AcpiExAcquireGlobalLock (
643 AcpiExReleaseGlobalLock (
647 AcpiExEisaIdToString (
652 AcpiExUnsignedIntegerToString (
658 * exregion - default OpRegion handlers
661 AcpiExSystemMemorySpaceHandler (
663 ACPI_PHYSICAL_ADDRESS Address,
666 void *HandlerContext,
667 void *RegionContext);
670 AcpiExSystemIoSpaceHandler (
672 ACPI_PHYSICAL_ADDRESS Address,
675 void *HandlerContext,
676 void *RegionContext);
679 AcpiExPciConfigSpaceHandler (
681 ACPI_PHYSICAL_ADDRESS Address,
684 void *HandlerContext,
685 void *RegionContext);
688 AcpiExCmosSpaceHandler (
690 ACPI_PHYSICAL_ADDRESS Address,
693 void *HandlerContext,
694 void *RegionContext);
697 AcpiExPciBarSpaceHandler (
699 ACPI_PHYSICAL_ADDRESS Address,
702 void *HandlerContext,
703 void *RegionContext);
706 AcpiExEmbeddedControllerSpaceHandler (
708 ACPI_PHYSICAL_ADDRESS Address,
711 void *HandlerContext,
712 void *RegionContext);
715 AcpiExSmBusSpaceHandler (
717 ACPI_PHYSICAL_ADDRESS Address,
720 void *HandlerContext,
721 void *RegionContext);
725 AcpiExDataTableSpaceHandler (
727 ACPI_PHYSICAL_ADDRESS Address,
730 void *HandlerContext,
731 void *RegionContext);
733 #endif /* __INTERP_H__ */