1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acinterp.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
118 #ifndef __ACINTERP_H__
119 #define __ACINTERP_H__
122 #define ACPI_WALK_OPERANDS (&(WalkState->Operands [WalkState->NumOperands -1]))
126 AcpiExResolveOperands (
128 ACPI_OPERAND_OBJECT **StackPtr,
129 ACPI_WALK_STATE *WalkState);
132 AcpiExCheckObjectType (
133 ACPI_OBJECT_TYPE TypeNeeded,
134 ACPI_OBJECT_TYPE ThisType,
138 * exxface - External interpreter interfaces
143 ACPI_TABLE_TYPE TableId);
146 AcpiExExecuteMethod (
147 ACPI_NAMESPACE_NODE *MethodNode,
148 ACPI_OPERAND_OBJECT **Params,
149 ACPI_OPERAND_OBJECT **ReturnObjDesc);
153 * exconvrt - object conversion
157 AcpiExConvertToInteger (
158 ACPI_OPERAND_OBJECT *ObjDesc,
159 ACPI_OPERAND_OBJECT **ResultDesc,
160 ACPI_WALK_STATE *WalkState);
163 AcpiExConvertToBuffer (
164 ACPI_OPERAND_OBJECT *ObjDesc,
165 ACPI_OPERAND_OBJECT **ResultDesc,
166 ACPI_WALK_STATE *WalkState);
169 AcpiExConvertToString (
170 ACPI_OPERAND_OBJECT *ObjDesc,
171 ACPI_OPERAND_OBJECT **ResultDesc,
174 ACPI_WALK_STATE *WalkState);
177 AcpiExConvertToTargetType (
178 ACPI_OBJECT_TYPE DestinationType,
179 ACPI_OPERAND_OBJECT *SourceDesc,
180 ACPI_OPERAND_OBJECT **ResultDesc,
181 ACPI_WALK_STATE *WalkState);
184 AcpiExConvertToAscii (
185 ACPI_INTEGER Integer,
191 * exfield - ACPI AML (p-code) execution - field manipulation
195 AcpiExExtractFromField (
196 ACPI_OPERAND_OBJECT *ObjDesc,
198 UINT32 BufferLength);
201 AcpiExInsertIntoField (
202 ACPI_OPERAND_OBJECT *ObjDesc,
204 UINT32 BufferLength);
208 ACPI_OPERAND_OBJECT *ObjDesc,
209 UINT32 FieldDatumByteOffset);
213 ACPI_OPERAND_OBJECT *ObjDesc,
214 UINT32 FieldDatumByteOffset,
219 AcpiExRegisterOverflow (
220 ACPI_OPERAND_OBJECT *ObjDesc,
225 ACPI_OPERAND_OBJECT *ObjDesc,
226 UINT32 FieldDatumByteOffset,
231 AcpiExWriteWithUpdateRule (
232 ACPI_OPERAND_OBJECT *ObjDesc,
234 ACPI_INTEGER FieldValue,
235 UINT32 FieldDatumByteOffset);
238 AcpiExGetBufferDatum(
241 UINT32 ByteGranularity,
245 AcpiExSetBufferDatum (
246 ACPI_INTEGER MergedDatum,
248 UINT32 ByteGranularity,
252 AcpiExReadDataFromField (
253 ACPI_WALK_STATE *WalkState,
254 ACPI_OPERAND_OBJECT *ObjDesc,
255 ACPI_OPERAND_OBJECT **RetBufferDesc);
258 AcpiExWriteDataToField (
259 ACPI_OPERAND_OBJECT *SourceDesc,
260 ACPI_OPERAND_OBJECT *ObjDesc,
261 ACPI_OPERAND_OBJECT **ResultDesc);
264 * exmisc - ACPI AML (p-code) execution - specific opcodes
268 AcpiExOpcode_3A_0T_0R (
269 ACPI_WALK_STATE *WalkState);
272 AcpiExOpcode_3A_1T_1R (
273 ACPI_WALK_STATE *WalkState);
276 AcpiExOpcode_6A_0T_1R (
277 ACPI_WALK_STATE *WalkState);
282 ACPI_INTEGER PackageValue,
283 ACPI_INTEGER MatchValue);
286 AcpiExGetObjectReference (
287 ACPI_OPERAND_OBJECT *ObjDesc,
288 ACPI_OPERAND_OBJECT **ReturnDesc,
289 ACPI_WALK_STATE *WalkState);
292 AcpiExResolveMultiple (
293 ACPI_WALK_STATE *WalkState,
294 ACPI_OPERAND_OBJECT *Operand,
295 ACPI_OBJECT_TYPE *ReturnType,
296 ACPI_OPERAND_OBJECT **ReturnDesc);
299 AcpiExConcatTemplate (
300 ACPI_OPERAND_OBJECT *ObjDesc,
301 ACPI_OPERAND_OBJECT *ObjDesc2,
302 ACPI_OPERAND_OBJECT **ActualReturnDesc,
303 ACPI_WALK_STATE *WalkState);
306 AcpiExDoConcatenate (
307 ACPI_OPERAND_OBJECT *ObjDesc,
308 ACPI_OPERAND_OBJECT *ObjDesc2,
309 ACPI_OPERAND_OBJECT **ActualReturnDesc,
310 ACPI_WALK_STATE *WalkState);
315 ACPI_INTEGER Operand0,
316 ACPI_INTEGER Operand1);
321 ACPI_INTEGER Operand0,
322 ACPI_INTEGER Operand1);
326 ACPI_WALK_STATE *WalkState);
329 AcpiExCreateProcessor (
330 ACPI_WALK_STATE *WalkState);
333 AcpiExCreatePowerResource (
334 ACPI_WALK_STATE *WalkState);
341 ACPI_WALK_STATE *WalkState);
344 AcpiExCreateTableRegion (
345 ACPI_WALK_STATE *WalkState);
349 ACPI_WALK_STATE *WalkState);
353 ACPI_WALK_STATE *WalkState);
359 ACPI_WALK_STATE *WalkState);
363 * exconfig - dynamic table load/unload
368 ACPI_TABLE_HEADER *Table,
369 ACPI_NAMESPACE_NODE *ParentNode,
370 ACPI_OPERAND_OBJECT **DdbHandle);
374 ACPI_OPERAND_OBJECT *ObjDesc,
375 ACPI_OPERAND_OBJECT *Target,
376 ACPI_WALK_STATE *WalkState);
380 ACPI_WALK_STATE *WalkState,
381 ACPI_OPERAND_OBJECT **ReturnDesc);
385 ACPI_OPERAND_OBJECT *DdbHandle);
389 * exmutex - mutex support
394 ACPI_OPERAND_OBJECT *TimeDesc,
395 ACPI_OPERAND_OBJECT *ObjDesc,
396 ACPI_WALK_STATE *WalkState);
400 ACPI_OPERAND_OBJECT *ObjDesc,
401 ACPI_WALK_STATE *WalkState);
404 AcpiExReleaseAllMutexes (
405 ACPI_THREAD_STATE *Thread);
409 ACPI_OPERAND_OBJECT *ObjDesc);
413 ACPI_OPERAND_OBJECT *ObjDesc,
414 ACPI_THREAD_STATE *Thread);
417 * exprep - ACPI AML (p-code) execution - prep utilities
421 AcpiExPrepCommonFieldObject (
422 ACPI_OPERAND_OBJECT *ObjDesc,
424 UINT8 FieldAttribute,
425 UINT32 FieldBitPosition,
426 UINT32 FieldBitLength);
429 AcpiExPrepFieldValue (
430 ACPI_CREATE_FIELD_INFO *Info);
433 * exsystem - Interface to OS services
437 AcpiExSystemDoNotifyOp (
438 ACPI_OPERAND_OBJECT *Value,
439 ACPI_OPERAND_OBJECT *ObjDesc);
442 AcpiExSystemDoSuspend(
446 AcpiExSystemDoStall (
450 AcpiExSystemAcquireMutex(
451 ACPI_OPERAND_OBJECT *Time,
452 ACPI_OPERAND_OBJECT *ObjDesc);
455 AcpiExSystemReleaseMutex(
456 ACPI_OPERAND_OBJECT *ObjDesc);
459 AcpiExSystemSignalEvent(
460 ACPI_OPERAND_OBJECT *ObjDesc);
463 AcpiExSystemWaitEvent(
464 ACPI_OPERAND_OBJECT *Time,
465 ACPI_OPERAND_OBJECT *ObjDesc);
468 AcpiExSystemResetEvent(
469 ACPI_OPERAND_OBJECT *ObjDesc);
472 AcpiExSystemWaitSemaphore (
473 ACPI_HANDLE Semaphore,
478 * exmonadic - ACPI AML (p-code) execution, monadic operators
482 AcpiExOpcode_1A_0T_0R (
483 ACPI_WALK_STATE *WalkState);
486 AcpiExOpcode_1A_0T_1R (
487 ACPI_WALK_STATE *WalkState);
490 AcpiExOpcode_1A_1T_1R (
491 ACPI_WALK_STATE *WalkState);
494 AcpiExOpcode_1A_1T_0R (
495 ACPI_WALK_STATE *WalkState);
498 * exdyadic - ACPI AML (p-code) execution, dyadic operators
502 AcpiExOpcode_2A_0T_0R (
503 ACPI_WALK_STATE *WalkState);
506 AcpiExOpcode_2A_0T_1R (
507 ACPI_WALK_STATE *WalkState);
510 AcpiExOpcode_2A_1T_1R (
511 ACPI_WALK_STATE *WalkState);
514 AcpiExOpcode_2A_2T_1R (
515 ACPI_WALK_STATE *WalkState);
519 * exresolv - Object resolution and get value functions
523 AcpiExResolveToValue (
524 ACPI_OPERAND_OBJECT **StackPtr,
525 ACPI_WALK_STATE *WalkState);
528 AcpiExResolveNodeToValue (
529 ACPI_NAMESPACE_NODE **StackPtr,
530 ACPI_WALK_STATE *WalkState);
533 AcpiExResolveObjectToValue (
534 ACPI_OPERAND_OBJECT **StackPtr,
535 ACPI_WALK_STATE *WalkState);
539 * exdump - Scanner debug output routines
544 ACPI_OPERAND_OBJECT *EntryDesc);
548 ACPI_OPERAND_OBJECT **Operands,
549 ACPI_INTERPRETER_MODE InterpreterMode,
557 AcpiExDumpObjectDescriptor (
558 ACPI_OPERAND_OBJECT *Object,
563 ACPI_NAMESPACE_NODE *Node,
584 ACPI_PHYSICAL_ADDRESS Value);
588 * exnames - interpreter/scanner name load/execute
592 AcpiExAllocateNameString (
602 UINT8 **InAmlAddress,
606 AcpiExGetNameString (
607 ACPI_OBJECT_TYPE DataType,
609 char **OutNameString,
610 UINT32 *OutNameLength);
614 ACPI_OBJECT_TYPE DataType,
615 ACPI_INTERPRETER_MODE LoadExecMode);
619 * exstore - Object store support
624 ACPI_OPERAND_OBJECT *ValDesc,
625 ACPI_OPERAND_OBJECT *DestDesc,
626 ACPI_WALK_STATE *WalkState);
629 AcpiExStoreObjectToIndex (
630 ACPI_OPERAND_OBJECT *ValDesc,
631 ACPI_OPERAND_OBJECT *DestDesc,
632 ACPI_WALK_STATE *WalkState);
635 AcpiExStoreObjectToNode (
636 ACPI_OPERAND_OBJECT *SourceDesc,
637 ACPI_NAMESPACE_NODE *Node,
638 ACPI_WALK_STATE *WalkState);
646 AcpiExResolveObject (
647 ACPI_OPERAND_OBJECT **SourceDescPtr,
648 ACPI_OBJECT_TYPE TargetType,
649 ACPI_WALK_STATE *WalkState);
652 AcpiExStoreObjectToObject (
653 ACPI_OPERAND_OBJECT *SourceDesc,
654 ACPI_OPERAND_OBJECT *DestDesc,
655 ACPI_OPERAND_OBJECT **NewDesc,
656 ACPI_WALK_STATE *WalkState);
660 * excopy - object copy
664 AcpiExStoreBufferToBuffer (
665 ACPI_OPERAND_OBJECT *SourceDesc,
666 ACPI_OPERAND_OBJECT *TargetDesc);
669 AcpiExStoreStringToString (
670 ACPI_OPERAND_OBJECT *SourceDesc,
671 ACPI_OPERAND_OBJECT *TargetDesc);
674 AcpiExCopyIntegerToIndexField (
675 ACPI_OPERAND_OBJECT *SourceDesc,
676 ACPI_OPERAND_OBJECT *TargetDesc);
679 AcpiExCopyIntegerToBankField (
680 ACPI_OPERAND_OBJECT *SourceDesc,
681 ACPI_OPERAND_OBJECT *TargetDesc);
684 AcpiExCopyDataToNamedField (
685 ACPI_OPERAND_OBJECT *SourceDesc,
686 ACPI_NAMESPACE_NODE *Node);
689 AcpiExCopyIntegerToBufferField (
690 ACPI_OPERAND_OBJECT *SourceDesc,
691 ACPI_OPERAND_OBJECT *TargetDesc);
694 * exutils - interpreter/scanner utilities
698 AcpiExEnterInterpreter (
702 AcpiExExitInterpreter (
706 AcpiExTruncateFor32bitTable (
707 ACPI_OPERAND_OBJECT *ObjDesc);
710 AcpiExAcquireGlobalLock (
714 AcpiExReleaseGlobalLock (
723 AcpiExEisaIdToString (
728 AcpiExUnsignedIntegerToString (
734 * exregion - default OpRegion handlers
738 AcpiExSystemMemorySpaceHandler (
740 ACPI_PHYSICAL_ADDRESS Address,
743 void *HandlerContext,
744 void *RegionContext);
747 AcpiExSystemIoSpaceHandler (
749 ACPI_PHYSICAL_ADDRESS Address,
752 void *HandlerContext,
753 void *RegionContext);
756 AcpiExPciConfigSpaceHandler (
758 ACPI_PHYSICAL_ADDRESS Address,
761 void *HandlerContext,
762 void *RegionContext);
765 AcpiExCmosSpaceHandler (
767 ACPI_PHYSICAL_ADDRESS Address,
770 void *HandlerContext,
771 void *RegionContext);
774 AcpiExPciBarSpaceHandler (
776 ACPI_PHYSICAL_ADDRESS Address,
779 void *HandlerContext,
780 void *RegionContext);
783 AcpiExEmbeddedControllerSpaceHandler (
785 ACPI_PHYSICAL_ADDRESS Address,
788 void *HandlerContext,
789 void *RegionContext);
792 AcpiExSmBusSpaceHandler (
794 ACPI_PHYSICAL_ADDRESS Address,
797 void *HandlerContext,
798 void *RegionContext);
802 AcpiExDataTableSpaceHandler (
804 ACPI_PHYSICAL_ADDRESS Address,
807 void *HandlerContext,
808 void *RegionContext);
810 #endif /* __INTERP_H__ */