xref: /freebsd/sys/contrib/dev/acpica/include/acinterp.h (revision b5daf675efc746611c7cfcd1fa474b8905064c4b)
1 /******************************************************************************
2  *
3  * Name: acinterp.h - Interpreter subcomponent prototypes and defines
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ACINTERP_H__
153 #define __ACINTERP_H__
154 
155 
156 #define ACPI_WALK_OPERANDS          (&(WalkState->Operands [WalkState->NumOperands -1]))
157 
158 /* Macros for tables used for debug output */
159 
160 #define ACPI_EXD_OFFSET(f)          (UINT8) ACPI_OFFSET (ACPI_OPERAND_OBJECT,f)
161 #define ACPI_EXD_NSOFFSET(f)        (UINT8) ACPI_OFFSET (ACPI_NAMESPACE_NODE,f)
162 #define ACPI_EXD_TABLE_SIZE(name)   (sizeof(name) / sizeof (ACPI_EXDUMP_INFO))
163 
164 /*
165  * If possible, pack the following structures to byte alignment, since we
166  * don't care about performance for debug output. Two cases where we cannot
167  * pack the structures:
168  *
169  * 1) Hardware does not support misaligned memory transfers
170  * 2) Compiler does not support pointers within packed structures
171  */
172 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
173 #pragma pack(1)
174 #endif
175 
176 typedef const struct acpi_exdump_info
177 {
178     UINT8                   Opcode;
179     UINT8                   Offset;
180     const char              *Name;
181 
182 } ACPI_EXDUMP_INFO;
183 
184 /* Values for the Opcode field above */
185 
186 #define ACPI_EXD_INIT                   0
187 #define ACPI_EXD_TYPE                   1
188 #define ACPI_EXD_UINT8                  2
189 #define ACPI_EXD_UINT16                 3
190 #define ACPI_EXD_UINT32                 4
191 #define ACPI_EXD_UINT64                 5
192 #define ACPI_EXD_LITERAL                6
193 #define ACPI_EXD_POINTER                7
194 #define ACPI_EXD_ADDRESS                8
195 #define ACPI_EXD_STRING                 9
196 #define ACPI_EXD_BUFFER                 10
197 #define ACPI_EXD_PACKAGE                11
198 #define ACPI_EXD_FIELD                  12
199 #define ACPI_EXD_REFERENCE              13
200 #define ACPI_EXD_LIST                   14 /* Operand object list */
201 #define ACPI_EXD_HDLR_LIST              15 /* Address Handler list */
202 #define ACPI_EXD_RGN_LIST               16 /* Region list */
203 #define ACPI_EXD_NODE                   17 /* Namespace Node */
204 
205 /* restore default alignment */
206 
207 #pragma pack()
208 
209 
210 /*
211  * exconvrt - object conversion
212  */
213 ACPI_STATUS
214 AcpiExConvertToInteger (
215     ACPI_OPERAND_OBJECT     *ObjDesc,
216     ACPI_OPERAND_OBJECT     **ResultDesc,
217     UINT32                  ImplicitConversion);
218 
219 ACPI_STATUS
220 AcpiExConvertToBuffer (
221     ACPI_OPERAND_OBJECT     *ObjDesc,
222     ACPI_OPERAND_OBJECT     **ResultDesc);
223 
224 ACPI_STATUS
225 AcpiExConvertToString (
226     ACPI_OPERAND_OBJECT     *ObjDesc,
227     ACPI_OPERAND_OBJECT     **ResultDesc,
228     UINT32                  Type);
229 
230 /* Types for ->String conversion */
231 
232 #define ACPI_EXPLICIT_BYTE_COPY         0x00000000
233 #define ACPI_EXPLICIT_CONVERT_HEX       0x00000001
234 #define ACPI_IMPLICIT_CONVERT_HEX       0x00000002
235 #define ACPI_EXPLICIT_CONVERT_DECIMAL   0x00000003
236 
237 ACPI_STATUS
238 AcpiExConvertToTargetType (
239     ACPI_OBJECT_TYPE        DestinationType,
240     ACPI_OPERAND_OBJECT     *SourceDesc,
241     ACPI_OPERAND_OBJECT     **ResultDesc,
242     ACPI_WALK_STATE         *WalkState);
243 
244 
245 /*
246  * exdebug - AML debug object
247  */
248 void
249 AcpiExDoDebugObject (
250     ACPI_OPERAND_OBJECT     *SourceDesc,
251     UINT32                  Level,
252     UINT32                  Index);
253 
254 void
255 AcpiExStartTraceMethod (
256     ACPI_NAMESPACE_NODE     *MethodNode,
257     ACPI_OPERAND_OBJECT     *ObjDesc,
258     ACPI_WALK_STATE         *WalkState);
259 
260 void
261 AcpiExStopTraceMethod (
262     ACPI_NAMESPACE_NODE     *MethodNode,
263     ACPI_OPERAND_OBJECT     *ObjDesc,
264     ACPI_WALK_STATE         *WalkState);
265 
266 void
267 AcpiExStartTraceOpcode (
268     ACPI_PARSE_OBJECT       *Op,
269     ACPI_WALK_STATE         *WalkState);
270 
271 void
272 AcpiExStopTraceOpcode (
273     ACPI_PARSE_OBJECT       *Op,
274     ACPI_WALK_STATE         *WalkState);
275 
276 void
277 AcpiExTracePoint (
278     ACPI_TRACE_EVENT_TYPE   Type,
279     BOOLEAN                 Begin,
280     UINT8                   *Aml,
281     char                    *Pathname);
282 
283 void
284 AcpiExTraceArgs(
285     ACPI_OPERAND_OBJECT     **Params,
286     UINT32                  Count);
287 
288 /*
289  * exfield - ACPI AML (p-code) execution - field manipulation
290  */
291 ACPI_STATUS
292 AcpiExGetProtocolBufferLength (
293     UINT32                  ProtocolId,
294     UINT32                  *ReturnLength);
295 
296 ACPI_STATUS
297 AcpiExCommonBufferSetup (
298     ACPI_OPERAND_OBJECT     *ObjDesc,
299     UINT32                  BufferLength,
300     UINT32                  *DatumCount);
301 
302 ACPI_STATUS
303 AcpiExWriteWithUpdateRule (
304     ACPI_OPERAND_OBJECT     *ObjDesc,
305     UINT64                  Mask,
306     UINT64                  FieldValue,
307     UINT32                  FieldDatumByteOffset);
308 
309 void
310 AcpiExGetBufferDatum(
311     UINT64                  *Datum,
312     void                    *Buffer,
313     UINT32                  BufferLength,
314     UINT32                  ByteGranularity,
315     UINT32                  BufferOffset);
316 
317 void
318 AcpiExSetBufferDatum (
319     UINT64                  MergedDatum,
320     void                    *Buffer,
321     UINT32                  BufferLength,
322     UINT32                  ByteGranularity,
323     UINT32                  BufferOffset);
324 
325 ACPI_STATUS
326 AcpiExReadDataFromField (
327     ACPI_WALK_STATE         *WalkState,
328     ACPI_OPERAND_OBJECT     *ObjDesc,
329     ACPI_OPERAND_OBJECT     **RetBufferDesc);
330 
331 ACPI_STATUS
332 AcpiExWriteDataToField (
333     ACPI_OPERAND_OBJECT     *SourceDesc,
334     ACPI_OPERAND_OBJECT     *ObjDesc,
335     ACPI_OPERAND_OBJECT     **ResultDesc);
336 
337 
338 /*
339  * exfldio - low level field I/O
340  */
341 ACPI_STATUS
342 AcpiExExtractFromField (
343     ACPI_OPERAND_OBJECT     *ObjDesc,
344     void                    *Buffer,
345     UINT32                  BufferLength);
346 
347 ACPI_STATUS
348 AcpiExInsertIntoField (
349     ACPI_OPERAND_OBJECT     *ObjDesc,
350     void                    *Buffer,
351     UINT32                  BufferLength);
352 
353 ACPI_STATUS
354 AcpiExAccessRegion (
355     ACPI_OPERAND_OBJECT     *ObjDesc,
356     UINT32                  FieldDatumByteOffset,
357     UINT64                  *Value,
358     UINT32                  ReadWrite);
359 
360 
361 /*
362  * exmisc - misc support routines
363  */
364 ACPI_STATUS
365 AcpiExGetObjectReference (
366     ACPI_OPERAND_OBJECT     *ObjDesc,
367     ACPI_OPERAND_OBJECT     **ReturnDesc,
368     ACPI_WALK_STATE         *WalkState);
369 
370 ACPI_STATUS
371 AcpiExConcatTemplate (
372     ACPI_OPERAND_OBJECT     *ObjDesc,
373     ACPI_OPERAND_OBJECT     *ObjDesc2,
374     ACPI_OPERAND_OBJECT     **ActualReturnDesc,
375     ACPI_WALK_STATE         *WalkState);
376 
377 ACPI_STATUS
378 AcpiExDoConcatenate (
379     ACPI_OPERAND_OBJECT     *ObjDesc,
380     ACPI_OPERAND_OBJECT     *ObjDesc2,
381     ACPI_OPERAND_OBJECT     **ActualReturnDesc,
382     ACPI_WALK_STATE         *WalkState);
383 
384 ACPI_STATUS
385 AcpiExDoLogicalNumericOp (
386     UINT16                  Opcode,
387     UINT64                  Integer0,
388     UINT64                  Integer1,
389     BOOLEAN                 *LogicalResult);
390 
391 ACPI_STATUS
392 AcpiExDoLogicalOp (
393     UINT16                  Opcode,
394     ACPI_OPERAND_OBJECT     *Operand0,
395     ACPI_OPERAND_OBJECT     *Operand1,
396     BOOLEAN                 *LogicalResult);
397 
398 UINT64
399 AcpiExDoMathOp (
400     UINT16                  Opcode,
401     UINT64                  Operand0,
402     UINT64                  Operand1);
403 
404 ACPI_STATUS
405 AcpiExCreateMutex (
406     ACPI_WALK_STATE         *WalkState);
407 
408 ACPI_STATUS
409 AcpiExCreateProcessor (
410     ACPI_WALK_STATE         *WalkState);
411 
412 ACPI_STATUS
413 AcpiExCreatePowerResource (
414     ACPI_WALK_STATE         *WalkState);
415 
416 ACPI_STATUS
417 AcpiExCreateRegion (
418     UINT8                   *AmlStart,
419     UINT32                  AmlLength,
420     UINT8                   RegionSpace,
421     ACPI_WALK_STATE         *WalkState);
422 
423 ACPI_STATUS
424 AcpiExCreateEvent (
425     ACPI_WALK_STATE         *WalkState);
426 
427 ACPI_STATUS
428 AcpiExCreateAlias (
429     ACPI_WALK_STATE         *WalkState);
430 
431 ACPI_STATUS
432 AcpiExCreateMethod (
433     UINT8                   *AmlStart,
434     UINT32                  AmlLength,
435     ACPI_WALK_STATE         *WalkState);
436 
437 
438 /*
439  * exconfig - dynamic table load/unload
440  */
441 ACPI_STATUS
442 AcpiExLoadOp (
443     ACPI_OPERAND_OBJECT     *ObjDesc,
444     ACPI_OPERAND_OBJECT     *Target,
445     ACPI_WALK_STATE         *WalkState);
446 
447 ACPI_STATUS
448 AcpiExLoadTableOp (
449     ACPI_WALK_STATE         *WalkState,
450     ACPI_OPERAND_OBJECT     **ReturnDesc);
451 
452 ACPI_STATUS
453 AcpiExUnloadTable (
454     ACPI_OPERAND_OBJECT     *DdbHandle);
455 
456 
457 /*
458  * exmutex - mutex support
459  */
460 ACPI_STATUS
461 AcpiExAcquireMutex (
462     ACPI_OPERAND_OBJECT     *TimeDesc,
463     ACPI_OPERAND_OBJECT     *ObjDesc,
464     ACPI_WALK_STATE         *WalkState);
465 
466 ACPI_STATUS
467 AcpiExAcquireMutexObject (
468     UINT16                  Timeout,
469     ACPI_OPERAND_OBJECT     *ObjDesc,
470     ACPI_THREAD_ID          ThreadId);
471 
472 ACPI_STATUS
473 AcpiExReleaseMutex (
474     ACPI_OPERAND_OBJECT     *ObjDesc,
475     ACPI_WALK_STATE         *WalkState);
476 
477 ACPI_STATUS
478 AcpiExReleaseMutexObject (
479     ACPI_OPERAND_OBJECT     *ObjDesc);
480 
481 void
482 AcpiExReleaseAllMutexes (
483     ACPI_THREAD_STATE       *Thread);
484 
485 void
486 AcpiExUnlinkMutex (
487     ACPI_OPERAND_OBJECT     *ObjDesc);
488 
489 
490 /*
491  * exprep - ACPI AML execution - prep utilities
492  */
493 ACPI_STATUS
494 AcpiExPrepCommonFieldObject (
495     ACPI_OPERAND_OBJECT     *ObjDesc,
496     UINT8                   FieldFlags,
497     UINT8                   FieldAttribute,
498     UINT32                  FieldBitPosition,
499     UINT32                  FieldBitLength);
500 
501 ACPI_STATUS
502 AcpiExPrepFieldValue (
503     ACPI_CREATE_FIELD_INFO  *Info);
504 
505 
506 /*
507  * exserial - FieldUnit support for serial address spaces
508  */
509 ACPI_STATUS
510 AcpiExReadSerialBus (
511     ACPI_OPERAND_OBJECT     *ObjDesc,
512     ACPI_OPERAND_OBJECT     **ReturnBuffer);
513 
514 ACPI_STATUS
515 AcpiExWriteSerialBus (
516     ACPI_OPERAND_OBJECT     *SourceDesc,
517     ACPI_OPERAND_OBJECT     *ObjDesc,
518     ACPI_OPERAND_OBJECT     **ReturnBuffer);
519 
520 ACPI_STATUS
521 AcpiExReadGpio (
522     ACPI_OPERAND_OBJECT     *ObjDesc,
523     void                    *Buffer);
524 
525 ACPI_STATUS
526 AcpiExWriteGpio (
527     ACPI_OPERAND_OBJECT     *SourceDesc,
528     ACPI_OPERAND_OBJECT     *ObjDesc,
529     ACPI_OPERAND_OBJECT     **ReturnBuffer);
530 
531 
532 /*
533  * exsystem - Interface to OS services
534  */
535 ACPI_STATUS
536 AcpiExSystemDoNotifyOp (
537     ACPI_OPERAND_OBJECT     *Value,
538     ACPI_OPERAND_OBJECT     *ObjDesc);
539 
540 ACPI_STATUS
541 AcpiExSystemDoSleep(
542     UINT64                  Time);
543 
544 ACPI_STATUS
545 AcpiExSystemDoStall (
546     UINT32                  Time);
547 
548 ACPI_STATUS
549 AcpiExSystemSignalEvent(
550     ACPI_OPERAND_OBJECT     *ObjDesc);
551 
552 ACPI_STATUS
553 AcpiExSystemWaitEvent(
554     ACPI_OPERAND_OBJECT     *Time,
555     ACPI_OPERAND_OBJECT     *ObjDesc);
556 
557 ACPI_STATUS
558 AcpiExSystemResetEvent(
559     ACPI_OPERAND_OBJECT     *ObjDesc);
560 
561 ACPI_STATUS
562 AcpiExSystemWaitSemaphore (
563     ACPI_SEMAPHORE          Semaphore,
564     UINT16                  Timeout);
565 
566 ACPI_STATUS
567 AcpiExSystemWaitMutex (
568     ACPI_MUTEX              Mutex,
569     UINT16                  Timeout);
570 
571 /*
572  * exoparg1 - ACPI AML execution, 1 operand
573  */
574 ACPI_STATUS
575 AcpiExOpcode_0A_0T_1R (
576     ACPI_WALK_STATE         *WalkState);
577 
578 ACPI_STATUS
579 AcpiExOpcode_1A_0T_0R (
580     ACPI_WALK_STATE         *WalkState);
581 
582 ACPI_STATUS
583 AcpiExOpcode_1A_0T_1R (
584     ACPI_WALK_STATE         *WalkState);
585 
586 ACPI_STATUS
587 AcpiExOpcode_1A_1T_1R (
588     ACPI_WALK_STATE         *WalkState);
589 
590 ACPI_STATUS
591 AcpiExOpcode_1A_1T_0R (
592     ACPI_WALK_STATE         *WalkState);
593 
594 /*
595  * exoparg2 - ACPI AML execution, 2 operands
596  */
597 ACPI_STATUS
598 AcpiExOpcode_2A_0T_0R (
599     ACPI_WALK_STATE         *WalkState);
600 
601 ACPI_STATUS
602 AcpiExOpcode_2A_0T_1R (
603     ACPI_WALK_STATE         *WalkState);
604 
605 ACPI_STATUS
606 AcpiExOpcode_2A_1T_1R (
607     ACPI_WALK_STATE         *WalkState);
608 
609 ACPI_STATUS
610 AcpiExOpcode_2A_2T_1R (
611     ACPI_WALK_STATE         *WalkState);
612 
613 
614 /*
615  * exoparg3 - ACPI AML execution, 3 operands
616  */
617 ACPI_STATUS
618 AcpiExOpcode_3A_0T_0R (
619     ACPI_WALK_STATE         *WalkState);
620 
621 ACPI_STATUS
622 AcpiExOpcode_3A_1T_1R (
623     ACPI_WALK_STATE         *WalkState);
624 
625 
626 /*
627  * exoparg6 - ACPI AML execution, 6 operands
628  */
629 ACPI_STATUS
630 AcpiExOpcode_6A_0T_1R (
631     ACPI_WALK_STATE         *WalkState);
632 
633 
634 /*
635  * exresolv - Object resolution and get value functions
636  */
637 ACPI_STATUS
638 AcpiExResolveToValue (
639     ACPI_OPERAND_OBJECT     **StackPtr,
640     ACPI_WALK_STATE         *WalkState);
641 
642 ACPI_STATUS
643 AcpiExResolveMultiple (
644     ACPI_WALK_STATE         *WalkState,
645     ACPI_OPERAND_OBJECT     *Operand,
646     ACPI_OBJECT_TYPE        *ReturnType,
647     ACPI_OPERAND_OBJECT     **ReturnDesc);
648 
649 
650 /*
651  * exresnte - resolve namespace node
652  */
653 ACPI_STATUS
654 AcpiExResolveNodeToValue (
655     ACPI_NAMESPACE_NODE     **StackPtr,
656     ACPI_WALK_STATE         *WalkState);
657 
658 
659 /*
660  * exresop - resolve operand to value
661  */
662 ACPI_STATUS
663 AcpiExResolveOperands (
664     UINT16                  Opcode,
665     ACPI_OPERAND_OBJECT     **StackPtr,
666     ACPI_WALK_STATE         *WalkState);
667 
668 
669 /*
670  * exdump - Interpreter debug output routines
671  */
672 void
673 AcpiExDumpOperand (
674     ACPI_OPERAND_OBJECT     *ObjDesc,
675     UINT32                  Depth);
676 
677 void
678 AcpiExDumpOperands (
679     ACPI_OPERAND_OBJECT     **Operands,
680     const char              *OpcodeName,
681     UINT32                  NumOpcodes);
682 
683 void
684 AcpiExDumpObjectDescriptor (
685     ACPI_OPERAND_OBJECT     *Object,
686     UINT32                  Flags);
687 
688 void
689 AcpiExDumpNamespaceNode (
690     ACPI_NAMESPACE_NODE     *Node,
691     UINT32                  Flags);
692 
693 
694 /*
695  * exnames - AML namestring support
696  */
697 ACPI_STATUS
698 AcpiExGetNameString (
699     ACPI_OBJECT_TYPE        DataType,
700     UINT8                   *InAmlAddress,
701     char                    **OutNameString,
702     UINT32                  *OutNameLength);
703 
704 
705 /*
706  * exstore - Object store support
707  */
708 ACPI_STATUS
709 AcpiExStore (
710     ACPI_OPERAND_OBJECT     *ValDesc,
711     ACPI_OPERAND_OBJECT     *DestDesc,
712     ACPI_WALK_STATE         *WalkState);
713 
714 ACPI_STATUS
715 AcpiExStoreObjectToNode (
716     ACPI_OPERAND_OBJECT     *SourceDesc,
717     ACPI_NAMESPACE_NODE     *Node,
718     ACPI_WALK_STATE         *WalkState,
719     UINT8                   ImplicitConversion);
720 
721 
722 /*
723  * exstoren - resolve/store object
724  */
725 ACPI_STATUS
726 AcpiExResolveObject (
727     ACPI_OPERAND_OBJECT     **SourceDescPtr,
728     ACPI_OBJECT_TYPE        TargetType,
729     ACPI_WALK_STATE         *WalkState);
730 
731 ACPI_STATUS
732 AcpiExStoreObjectToObject (
733     ACPI_OPERAND_OBJECT     *SourceDesc,
734     ACPI_OPERAND_OBJECT     *DestDesc,
735     ACPI_OPERAND_OBJECT     **NewDesc,
736     ACPI_WALK_STATE         *WalkState);
737 
738 
739 /*
740  * exstorob - store object - buffer/string
741  */
742 ACPI_STATUS
743 AcpiExStoreBufferToBuffer (
744     ACPI_OPERAND_OBJECT     *SourceDesc,
745     ACPI_OPERAND_OBJECT     *TargetDesc);
746 
747 ACPI_STATUS
748 AcpiExStoreStringToString (
749     ACPI_OPERAND_OBJECT     *SourceDesc,
750     ACPI_OPERAND_OBJECT     *TargetDesc);
751 
752 
753 /*
754  * excopy - object copy
755  */
756 ACPI_STATUS
757 AcpiExCopyIntegerToIndexField (
758     ACPI_OPERAND_OBJECT     *SourceDesc,
759     ACPI_OPERAND_OBJECT     *TargetDesc);
760 
761 ACPI_STATUS
762 AcpiExCopyIntegerToBankField (
763     ACPI_OPERAND_OBJECT     *SourceDesc,
764     ACPI_OPERAND_OBJECT     *TargetDesc);
765 
766 ACPI_STATUS
767 AcpiExCopyDataToNamedField (
768     ACPI_OPERAND_OBJECT     *SourceDesc,
769     ACPI_NAMESPACE_NODE     *Node);
770 
771 ACPI_STATUS
772 AcpiExCopyIntegerToBufferField (
773     ACPI_OPERAND_OBJECT     *SourceDesc,
774     ACPI_OPERAND_OBJECT     *TargetDesc);
775 
776 
777 /*
778  * exutils - interpreter/scanner utilities
779  */
780 void
781 AcpiExEnterInterpreter (
782     void);
783 
784 void
785 AcpiExExitInterpreter (
786     void);
787 
788 BOOLEAN
789 AcpiExTruncateFor32bitTable (
790     ACPI_OPERAND_OBJECT     *ObjDesc);
791 
792 void
793 AcpiExAcquireGlobalLock (
794     UINT32                  Rule);
795 
796 void
797 AcpiExReleaseGlobalLock (
798     UINT32                  Rule);
799 
800 void
801 AcpiExEisaIdToString (
802     char                    *Dest,
803     UINT64                  CompressedId);
804 
805 void
806 AcpiExIntegerToString (
807     char                    *Dest,
808     UINT64                  Value);
809 
810 void
811 AcpiExPciClsToString (
812     char                    *Dest,
813     UINT8                   ClassCode[3]);
814 
815 BOOLEAN
816 AcpiIsValidSpaceId (
817     UINT8                   SpaceId);
818 
819 
820 /*
821  * exregion - default OpRegion handlers
822  */
823 ACPI_STATUS
824 AcpiExSystemMemorySpaceHandler (
825     UINT32                  Function,
826     ACPI_PHYSICAL_ADDRESS   Address,
827     UINT32                  BitWidth,
828     UINT64                  *Value,
829     void                    *HandlerContext,
830     void                    *RegionContext);
831 
832 ACPI_STATUS
833 AcpiExSystemIoSpaceHandler (
834     UINT32                  Function,
835     ACPI_PHYSICAL_ADDRESS   Address,
836     UINT32                  BitWidth,
837     UINT64                  *Value,
838     void                    *HandlerContext,
839     void                    *RegionContext);
840 
841 ACPI_STATUS
842 AcpiExPciConfigSpaceHandler (
843     UINT32                  Function,
844     ACPI_PHYSICAL_ADDRESS   Address,
845     UINT32                  BitWidth,
846     UINT64                  *Value,
847     void                    *HandlerContext,
848     void                    *RegionContext);
849 
850 ACPI_STATUS
851 AcpiExCmosSpaceHandler (
852     UINT32                  Function,
853     ACPI_PHYSICAL_ADDRESS   Address,
854     UINT32                  BitWidth,
855     UINT64                  *Value,
856     void                    *HandlerContext,
857     void                    *RegionContext);
858 
859 ACPI_STATUS
860 AcpiExPciBarSpaceHandler (
861     UINT32                  Function,
862     ACPI_PHYSICAL_ADDRESS   Address,
863     UINT32                  BitWidth,
864     UINT64                  *Value,
865     void                    *HandlerContext,
866     void                    *RegionContext);
867 
868 ACPI_STATUS
869 AcpiExEmbeddedControllerSpaceHandler (
870     UINT32                  Function,
871     ACPI_PHYSICAL_ADDRESS   Address,
872     UINT32                  BitWidth,
873     UINT64                  *Value,
874     void                    *HandlerContext,
875     void                    *RegionContext);
876 
877 ACPI_STATUS
878 AcpiExSmBusSpaceHandler (
879     UINT32                  Function,
880     ACPI_PHYSICAL_ADDRESS   Address,
881     UINT32                  BitWidth,
882     UINT64                  *Value,
883     void                    *HandlerContext,
884     void                    *RegionContext);
885 
886 
887 ACPI_STATUS
888 AcpiExDataTableSpaceHandler (
889     UINT32                  Function,
890     ACPI_PHYSICAL_ADDRESS   Address,
891     UINT32                  BitWidth,
892     UINT64                  *Value,
893     void                    *HandlerContext,
894     void                    *RegionContext);
895 
896 #endif /* __INTERP_H__ */
897