xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acinterp.h (revision 35786f68)
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 - 2018, 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 
284 /*
285  * exfield - ACPI AML (p-code) execution - field manipulation
286  */
287 ACPI_STATUS
288 AcpiExCommonBufferSetup (
289     ACPI_OPERAND_OBJECT     *ObjDesc,
290     UINT32                  BufferLength,
291     UINT32                  *DatumCount);
292 
293 ACPI_STATUS
294 AcpiExWriteWithUpdateRule (
295     ACPI_OPERAND_OBJECT     *ObjDesc,
296     UINT64                  Mask,
297     UINT64                  FieldValue,
298     UINT32                  FieldDatumByteOffset);
299 
300 void
301 AcpiExGetBufferDatum(
302     UINT64                  *Datum,
303     void                    *Buffer,
304     UINT32                  BufferLength,
305     UINT32                  ByteGranularity,
306     UINT32                  BufferOffset);
307 
308 void
309 AcpiExSetBufferDatum (
310     UINT64                  MergedDatum,
311     void                    *Buffer,
312     UINT32                  BufferLength,
313     UINT32                  ByteGranularity,
314     UINT32                  BufferOffset);
315 
316 ACPI_STATUS
317 AcpiExReadDataFromField (
318     ACPI_WALK_STATE         *WalkState,
319     ACPI_OPERAND_OBJECT     *ObjDesc,
320     ACPI_OPERAND_OBJECT     **RetBufferDesc);
321 
322 ACPI_STATUS
323 AcpiExWriteDataToField (
324     ACPI_OPERAND_OBJECT     *SourceDesc,
325     ACPI_OPERAND_OBJECT     *ObjDesc,
326     ACPI_OPERAND_OBJECT     **ResultDesc);
327 
328 
329 /*
330  * exfldio - low level field I/O
331  */
332 ACPI_STATUS
333 AcpiExExtractFromField (
334     ACPI_OPERAND_OBJECT     *ObjDesc,
335     void                    *Buffer,
336     UINT32                  BufferLength);
337 
338 ACPI_STATUS
339 AcpiExInsertIntoField (
340     ACPI_OPERAND_OBJECT     *ObjDesc,
341     void                    *Buffer,
342     UINT32                  BufferLength);
343 
344 ACPI_STATUS
345 AcpiExAccessRegion (
346     ACPI_OPERAND_OBJECT     *ObjDesc,
347     UINT32                  FieldDatumByteOffset,
348     UINT64                  *Value,
349     UINT32                  ReadWrite);
350 
351 
352 /*
353  * exmisc - misc support routines
354  */
355 ACPI_STATUS
356 AcpiExGetObjectReference (
357     ACPI_OPERAND_OBJECT     *ObjDesc,
358     ACPI_OPERAND_OBJECT     **ReturnDesc,
359     ACPI_WALK_STATE         *WalkState);
360 
361 ACPI_STATUS
362 AcpiExConcatTemplate (
363     ACPI_OPERAND_OBJECT     *ObjDesc,
364     ACPI_OPERAND_OBJECT     *ObjDesc2,
365     ACPI_OPERAND_OBJECT     **ActualReturnDesc,
366     ACPI_WALK_STATE         *WalkState);
367 
368 ACPI_STATUS
369 AcpiExDoConcatenate (
370     ACPI_OPERAND_OBJECT     *ObjDesc,
371     ACPI_OPERAND_OBJECT     *ObjDesc2,
372     ACPI_OPERAND_OBJECT     **ActualReturnDesc,
373     ACPI_WALK_STATE         *WalkState);
374 
375 ACPI_STATUS
376 AcpiExDoLogicalNumericOp (
377     UINT16                  Opcode,
378     UINT64                  Integer0,
379     UINT64                  Integer1,
380     BOOLEAN                 *LogicalResult);
381 
382 ACPI_STATUS
383 AcpiExDoLogicalOp (
384     UINT16                  Opcode,
385     ACPI_OPERAND_OBJECT     *Operand0,
386     ACPI_OPERAND_OBJECT     *Operand1,
387     BOOLEAN                 *LogicalResult);
388 
389 UINT64
390 AcpiExDoMathOp (
391     UINT16                  Opcode,
392     UINT64                  Operand0,
393     UINT64                  Operand1);
394 
395 ACPI_STATUS
396 AcpiExCreateMutex (
397     ACPI_WALK_STATE         *WalkState);
398 
399 ACPI_STATUS
400 AcpiExCreateProcessor (
401     ACPI_WALK_STATE         *WalkState);
402 
403 ACPI_STATUS
404 AcpiExCreatePowerResource (
405     ACPI_WALK_STATE         *WalkState);
406 
407 ACPI_STATUS
408 AcpiExCreateRegion (
409     UINT8                   *AmlStart,
410     UINT32                  AmlLength,
411     UINT8                   RegionSpace,
412     ACPI_WALK_STATE         *WalkState);
413 
414 ACPI_STATUS
415 AcpiExCreateEvent (
416     ACPI_WALK_STATE         *WalkState);
417 
418 ACPI_STATUS
419 AcpiExCreateAlias (
420     ACPI_WALK_STATE         *WalkState);
421 
422 ACPI_STATUS
423 AcpiExCreateMethod (
424     UINT8                   *AmlStart,
425     UINT32                  AmlLength,
426     ACPI_WALK_STATE         *WalkState);
427 
428 
429 /*
430  * exconfig - dynamic table load/unload
431  */
432 ACPI_STATUS
433 AcpiExLoadOp (
434     ACPI_OPERAND_OBJECT     *ObjDesc,
435     ACPI_OPERAND_OBJECT     *Target,
436     ACPI_WALK_STATE         *WalkState);
437 
438 ACPI_STATUS
439 AcpiExLoadTableOp (
440     ACPI_WALK_STATE         *WalkState,
441     ACPI_OPERAND_OBJECT     **ReturnDesc);
442 
443 ACPI_STATUS
444 AcpiExUnloadTable (
445     ACPI_OPERAND_OBJECT     *DdbHandle);
446 
447 
448 /*
449  * exmutex - mutex support
450  */
451 ACPI_STATUS
452 AcpiExAcquireMutex (
453     ACPI_OPERAND_OBJECT     *TimeDesc,
454     ACPI_OPERAND_OBJECT     *ObjDesc,
455     ACPI_WALK_STATE         *WalkState);
456 
457 ACPI_STATUS
458 AcpiExAcquireMutexObject (
459     UINT16                  Timeout,
460     ACPI_OPERAND_OBJECT     *ObjDesc,
461     ACPI_THREAD_ID          ThreadId);
462 
463 ACPI_STATUS
464 AcpiExReleaseMutex (
465     ACPI_OPERAND_OBJECT     *ObjDesc,
466     ACPI_WALK_STATE         *WalkState);
467 
468 ACPI_STATUS
469 AcpiExReleaseMutexObject (
470     ACPI_OPERAND_OBJECT     *ObjDesc);
471 
472 void
473 AcpiExReleaseAllMutexes (
474     ACPI_THREAD_STATE       *Thread);
475 
476 void
477 AcpiExUnlinkMutex (
478     ACPI_OPERAND_OBJECT     *ObjDesc);
479 
480 
481 /*
482  * exprep - ACPI AML execution - prep utilities
483  */
484 ACPI_STATUS
485 AcpiExPrepCommonFieldObject (
486     ACPI_OPERAND_OBJECT     *ObjDesc,
487     UINT8                   FieldFlags,
488     UINT8                   FieldAttribute,
489     UINT32                  FieldBitPosition,
490     UINT32                  FieldBitLength);
491 
492 ACPI_STATUS
493 AcpiExPrepFieldValue (
494     ACPI_CREATE_FIELD_INFO  *Info);
495 
496 
497 /*
498  * exsystem - Interface to OS services
499  */
500 ACPI_STATUS
501 AcpiExSystemDoNotifyOp (
502     ACPI_OPERAND_OBJECT     *Value,
503     ACPI_OPERAND_OBJECT     *ObjDesc);
504 
505 ACPI_STATUS
506 AcpiExSystemDoSleep(
507     UINT64                  Time);
508 
509 ACPI_STATUS
510 AcpiExSystemDoStall (
511     UINT32                  Time);
512 
513 ACPI_STATUS
514 AcpiExSystemSignalEvent(
515     ACPI_OPERAND_OBJECT     *ObjDesc);
516 
517 ACPI_STATUS
518 AcpiExSystemWaitEvent(
519     ACPI_OPERAND_OBJECT     *Time,
520     ACPI_OPERAND_OBJECT     *ObjDesc);
521 
522 ACPI_STATUS
523 AcpiExSystemResetEvent(
524     ACPI_OPERAND_OBJECT     *ObjDesc);
525 
526 ACPI_STATUS
527 AcpiExSystemWaitSemaphore (
528     ACPI_SEMAPHORE          Semaphore,
529     UINT16                  Timeout);
530 
531 ACPI_STATUS
532 AcpiExSystemWaitMutex (
533     ACPI_MUTEX              Mutex,
534     UINT16                  Timeout);
535 
536 /*
537  * exoparg1 - ACPI AML execution, 1 operand
538  */
539 ACPI_STATUS
540 AcpiExOpcode_0A_0T_1R (
541     ACPI_WALK_STATE         *WalkState);
542 
543 ACPI_STATUS
544 AcpiExOpcode_1A_0T_0R (
545     ACPI_WALK_STATE         *WalkState);
546 
547 ACPI_STATUS
548 AcpiExOpcode_1A_0T_1R (
549     ACPI_WALK_STATE         *WalkState);
550 
551 ACPI_STATUS
552 AcpiExOpcode_1A_1T_1R (
553     ACPI_WALK_STATE         *WalkState);
554 
555 ACPI_STATUS
556 AcpiExOpcode_1A_1T_0R (
557     ACPI_WALK_STATE         *WalkState);
558 
559 /*
560  * exoparg2 - ACPI AML execution, 2 operands
561  */
562 ACPI_STATUS
563 AcpiExOpcode_2A_0T_0R (
564     ACPI_WALK_STATE         *WalkState);
565 
566 ACPI_STATUS
567 AcpiExOpcode_2A_0T_1R (
568     ACPI_WALK_STATE         *WalkState);
569 
570 ACPI_STATUS
571 AcpiExOpcode_2A_1T_1R (
572     ACPI_WALK_STATE         *WalkState);
573 
574 ACPI_STATUS
575 AcpiExOpcode_2A_2T_1R (
576     ACPI_WALK_STATE         *WalkState);
577 
578 
579 /*
580  * exoparg3 - ACPI AML execution, 3 operands
581  */
582 ACPI_STATUS
583 AcpiExOpcode_3A_0T_0R (
584     ACPI_WALK_STATE         *WalkState);
585 
586 ACPI_STATUS
587 AcpiExOpcode_3A_1T_1R (
588     ACPI_WALK_STATE         *WalkState);
589 
590 
591 /*
592  * exoparg6 - ACPI AML execution, 6 operands
593  */
594 ACPI_STATUS
595 AcpiExOpcode_6A_0T_1R (
596     ACPI_WALK_STATE         *WalkState);
597 
598 
599 /*
600  * exresolv - Object resolution and get value functions
601  */
602 ACPI_STATUS
603 AcpiExResolveToValue (
604     ACPI_OPERAND_OBJECT     **StackPtr,
605     ACPI_WALK_STATE         *WalkState);
606 
607 ACPI_STATUS
608 AcpiExResolveMultiple (
609     ACPI_WALK_STATE         *WalkState,
610     ACPI_OPERAND_OBJECT     *Operand,
611     ACPI_OBJECT_TYPE        *ReturnType,
612     ACPI_OPERAND_OBJECT     **ReturnDesc);
613 
614 
615 /*
616  * exresnte - resolve namespace node
617  */
618 ACPI_STATUS
619 AcpiExResolveNodeToValue (
620     ACPI_NAMESPACE_NODE     **StackPtr,
621     ACPI_WALK_STATE         *WalkState);
622 
623 
624 /*
625  * exresop - resolve operand to value
626  */
627 ACPI_STATUS
628 AcpiExResolveOperands (
629     UINT16                  Opcode,
630     ACPI_OPERAND_OBJECT     **StackPtr,
631     ACPI_WALK_STATE         *WalkState);
632 
633 
634 /*
635  * exdump - Interpreter debug output routines
636  */
637 void
638 AcpiExDumpOperand (
639     ACPI_OPERAND_OBJECT     *ObjDesc,
640     UINT32                  Depth);
641 
642 void
643 AcpiExDumpOperands (
644     ACPI_OPERAND_OBJECT     **Operands,
645     const char              *OpcodeName,
646     UINT32                  NumOpcodes);
647 
648 void
649 AcpiExDumpObjectDescriptor (
650     ACPI_OPERAND_OBJECT     *Object,
651     UINT32                  Flags);
652 
653 void
654 AcpiExDumpNamespaceNode (
655     ACPI_NAMESPACE_NODE     *Node,
656     UINT32                  Flags);
657 
658 
659 /*
660  * exnames - AML namestring support
661  */
662 ACPI_STATUS
663 AcpiExGetNameString (
664     ACPI_OBJECT_TYPE        DataType,
665     UINT8                   *InAmlAddress,
666     char                    **OutNameString,
667     UINT32                  *OutNameLength);
668 
669 
670 /*
671  * exstore - Object store support
672  */
673 ACPI_STATUS
674 AcpiExStore (
675     ACPI_OPERAND_OBJECT     *ValDesc,
676     ACPI_OPERAND_OBJECT     *DestDesc,
677     ACPI_WALK_STATE         *WalkState);
678 
679 ACPI_STATUS
680 AcpiExStoreObjectToNode (
681     ACPI_OPERAND_OBJECT     *SourceDesc,
682     ACPI_NAMESPACE_NODE     *Node,
683     ACPI_WALK_STATE         *WalkState,
684     UINT8                   ImplicitConversion);
685 
686 
687 /*
688  * exstoren - resolve/store object
689  */
690 ACPI_STATUS
691 AcpiExResolveObject (
692     ACPI_OPERAND_OBJECT     **SourceDescPtr,
693     ACPI_OBJECT_TYPE        TargetType,
694     ACPI_WALK_STATE         *WalkState);
695 
696 ACPI_STATUS
697 AcpiExStoreObjectToObject (
698     ACPI_OPERAND_OBJECT     *SourceDesc,
699     ACPI_OPERAND_OBJECT     *DestDesc,
700     ACPI_OPERAND_OBJECT     **NewDesc,
701     ACPI_WALK_STATE         *WalkState);
702 
703 
704 /*
705  * exstorob - store object - buffer/string
706  */
707 ACPI_STATUS
708 AcpiExStoreBufferToBuffer (
709     ACPI_OPERAND_OBJECT     *SourceDesc,
710     ACPI_OPERAND_OBJECT     *TargetDesc);
711 
712 ACPI_STATUS
713 AcpiExStoreStringToString (
714     ACPI_OPERAND_OBJECT     *SourceDesc,
715     ACPI_OPERAND_OBJECT     *TargetDesc);
716 
717 
718 /*
719  * excopy - object copy
720  */
721 ACPI_STATUS
722 AcpiExCopyIntegerToIndexField (
723     ACPI_OPERAND_OBJECT     *SourceDesc,
724     ACPI_OPERAND_OBJECT     *TargetDesc);
725 
726 ACPI_STATUS
727 AcpiExCopyIntegerToBankField (
728     ACPI_OPERAND_OBJECT     *SourceDesc,
729     ACPI_OPERAND_OBJECT     *TargetDesc);
730 
731 ACPI_STATUS
732 AcpiExCopyDataToNamedField (
733     ACPI_OPERAND_OBJECT     *SourceDesc,
734     ACPI_NAMESPACE_NODE     *Node);
735 
736 ACPI_STATUS
737 AcpiExCopyIntegerToBufferField (
738     ACPI_OPERAND_OBJECT     *SourceDesc,
739     ACPI_OPERAND_OBJECT     *TargetDesc);
740 
741 
742 /*
743  * exutils - interpreter/scanner utilities
744  */
745 void
746 AcpiExEnterInterpreter (
747     void);
748 
749 void
750 AcpiExExitInterpreter (
751     void);
752 
753 BOOLEAN
754 AcpiExTruncateFor32bitTable (
755     ACPI_OPERAND_OBJECT     *ObjDesc);
756 
757 void
758 AcpiExAcquireGlobalLock (
759     UINT32                  Rule);
760 
761 void
762 AcpiExReleaseGlobalLock (
763     UINT32                  Rule);
764 
765 void
766 AcpiExEisaIdToString (
767     char                    *Dest,
768     UINT64                  CompressedId);
769 
770 void
771 AcpiExIntegerToString (
772     char                    *Dest,
773     UINT64                  Value);
774 
775 void
776 AcpiExPciClsToString (
777     char                    *Dest,
778     UINT8                   ClassCode[3]);
779 
780 BOOLEAN
781 AcpiIsValidSpaceId (
782     UINT8                   SpaceId);
783 
784 
785 /*
786  * exregion - default OpRegion handlers
787  */
788 ACPI_STATUS
789 AcpiExSystemMemorySpaceHandler (
790     UINT32                  Function,
791     ACPI_PHYSICAL_ADDRESS   Address,
792     UINT32                  BitWidth,
793     UINT64                  *Value,
794     void                    *HandlerContext,
795     void                    *RegionContext);
796 
797 ACPI_STATUS
798 AcpiExSystemIoSpaceHandler (
799     UINT32                  Function,
800     ACPI_PHYSICAL_ADDRESS   Address,
801     UINT32                  BitWidth,
802     UINT64                  *Value,
803     void                    *HandlerContext,
804     void                    *RegionContext);
805 
806 ACPI_STATUS
807 AcpiExPciConfigSpaceHandler (
808     UINT32                  Function,
809     ACPI_PHYSICAL_ADDRESS   Address,
810     UINT32                  BitWidth,
811     UINT64                  *Value,
812     void                    *HandlerContext,
813     void                    *RegionContext);
814 
815 ACPI_STATUS
816 AcpiExCmosSpaceHandler (
817     UINT32                  Function,
818     ACPI_PHYSICAL_ADDRESS   Address,
819     UINT32                  BitWidth,
820     UINT64                  *Value,
821     void                    *HandlerContext,
822     void                    *RegionContext);
823 
824 ACPI_STATUS
825 AcpiExPciBarSpaceHandler (
826     UINT32                  Function,
827     ACPI_PHYSICAL_ADDRESS   Address,
828     UINT32                  BitWidth,
829     UINT64                  *Value,
830     void                    *HandlerContext,
831     void                    *RegionContext);
832 
833 ACPI_STATUS
834 AcpiExEmbeddedControllerSpaceHandler (
835     UINT32                  Function,
836     ACPI_PHYSICAL_ADDRESS   Address,
837     UINT32                  BitWidth,
838     UINT64                  *Value,
839     void                    *HandlerContext,
840     void                    *RegionContext);
841 
842 ACPI_STATUS
843 AcpiExSmBusSpaceHandler (
844     UINT32                  Function,
845     ACPI_PHYSICAL_ADDRESS   Address,
846     UINT32                  BitWidth,
847     UINT64                  *Value,
848     void                    *HandlerContext,
849     void                    *RegionContext);
850 
851 
852 ACPI_STATUS
853 AcpiExDataTableSpaceHandler (
854     UINT32                  Function,
855     ACPI_PHYSICAL_ADDRESS   Address,
856     UINT32                  BitWidth,
857     UINT64                  *Value,
858     void                    *HandlerContext,
859     void                    *RegionContext);
860 
861 #endif /* __INTERP_H__ */
862