1 /******************************************************************************
2  *
3  * Name: acdispat.h - dispatcher (parser to interpreter interface)
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2023, 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 _ACDISPAT_H_
153 #define _ACDISPAT_H_
154 
155 
156 #define NAMEOF_LOCAL_NTE    "__L0"
157 #define NAMEOF_ARG_NTE      "__A0"
158 
159 
160 /*
161  * dsargs - execution of dynamic arguments for static objects
162  */
163 ACPI_STATUS
164 AcpiDsGetBufferFieldArguments (
165     ACPI_OPERAND_OBJECT     *ObjDesc);
166 
167 ACPI_STATUS
168 AcpiDsGetBankFieldArguments (
169     ACPI_OPERAND_OBJECT     *ObjDesc);
170 
171 ACPI_STATUS
172 AcpiDsGetRegionArguments (
173     ACPI_OPERAND_OBJECT     *RgnDesc);
174 
175 ACPI_STATUS
176 AcpiDsGetBufferArguments (
177     ACPI_OPERAND_OBJECT     *ObjDesc);
178 
179 ACPI_STATUS
180 AcpiDsGetPackageArguments (
181     ACPI_OPERAND_OBJECT     *ObjDesc);
182 
183 
184 /*
185  * dscontrol - support for execution control opcodes
186  */
187 ACPI_STATUS
188 AcpiDsExecBeginControlOp (
189     ACPI_WALK_STATE         *WalkState,
190     ACPI_PARSE_OBJECT       *Op);
191 
192 ACPI_STATUS
193 AcpiDsExecEndControlOp (
194     ACPI_WALK_STATE         *WalkState,
195     ACPI_PARSE_OBJECT       *Op);
196 
197 
198 /*
199  * dsopcode - support for late operand evaluation
200  */
201 ACPI_STATUS
202 AcpiDsEvalBufferFieldOperands (
203     ACPI_WALK_STATE         *WalkState,
204     ACPI_PARSE_OBJECT       *Op);
205 
206 ACPI_STATUS
207 AcpiDsEvalRegionOperands (
208     ACPI_WALK_STATE         *WalkState,
209     ACPI_PARSE_OBJECT       *Op);
210 
211 ACPI_STATUS
212 AcpiDsEvalTableRegionOperands (
213     ACPI_WALK_STATE         *WalkState,
214     ACPI_PARSE_OBJECT       *Op);
215 
216 ACPI_STATUS
217 AcpiDsEvalDataObjectOperands (
218     ACPI_WALK_STATE         *WalkState,
219     ACPI_PARSE_OBJECT       *Op,
220     ACPI_OPERAND_OBJECT     *ObjDesc);
221 
222 ACPI_STATUS
223 AcpiDsEvalBankFieldOperands (
224     ACPI_WALK_STATE         *WalkState,
225     ACPI_PARSE_OBJECT       *Op);
226 
227 ACPI_STATUS
228 AcpiDsInitializeRegion (
229     ACPI_HANDLE             ObjHandle);
230 
231 
232 /*
233  * dsexec - Parser/Interpreter interface, method execution callbacks
234  */
235 ACPI_STATUS
236 AcpiDsGetPredicateValue (
237     ACPI_WALK_STATE         *WalkState,
238     ACPI_OPERAND_OBJECT     *ResultObj);
239 
240 ACPI_STATUS
241 AcpiDsExecBeginOp (
242     ACPI_WALK_STATE         *WalkState,
243     ACPI_PARSE_OBJECT       **OutOp);
244 
245 ACPI_STATUS
246 AcpiDsExecEndOp (
247     ACPI_WALK_STATE         *State);
248 
249 
250 /*
251  * dsfield - Parser/Interpreter interface for AML fields
252  */
253 ACPI_STATUS
254 AcpiDsCreateField (
255     ACPI_PARSE_OBJECT       *Op,
256     ACPI_NAMESPACE_NODE     *RegionNode,
257     ACPI_WALK_STATE         *WalkState);
258 
259 ACPI_STATUS
260 AcpiDsCreateBankField (
261     ACPI_PARSE_OBJECT       *Op,
262     ACPI_NAMESPACE_NODE     *RegionNode,
263     ACPI_WALK_STATE         *WalkState);
264 
265 ACPI_STATUS
266 AcpiDsCreateIndexField (
267     ACPI_PARSE_OBJECT       *Op,
268     ACPI_NAMESPACE_NODE     *RegionNode,
269     ACPI_WALK_STATE         *WalkState);
270 
271 ACPI_STATUS
272 AcpiDsCreateBufferField (
273     ACPI_PARSE_OBJECT       *Op,
274     ACPI_WALK_STATE         *WalkState);
275 
276 ACPI_STATUS
277 AcpiDsInitFieldObjects (
278     ACPI_PARSE_OBJECT       *Op,
279     ACPI_WALK_STATE         *WalkState);
280 
281 
282 /*
283  * dsload - Parser/Interpreter interface
284  */
285 ACPI_STATUS
286 AcpiDsInitCallbacks (
287     ACPI_WALK_STATE         *WalkState,
288     UINT32                  PassNumber);
289 
290 /* dsload - pass 1 namespace load callbacks */
291 
292 ACPI_STATUS
293 AcpiDsLoad1BeginOp (
294     ACPI_WALK_STATE         *WalkState,
295     ACPI_PARSE_OBJECT       **OutOp);
296 
297 ACPI_STATUS
298 AcpiDsLoad1EndOp (
299     ACPI_WALK_STATE         *WalkState);
300 
301 
302 /* dsload - pass 2 namespace load callbacks */
303 
304 ACPI_STATUS
305 AcpiDsLoad2BeginOp (
306     ACPI_WALK_STATE         *WalkState,
307     ACPI_PARSE_OBJECT       **OutOp);
308 
309 ACPI_STATUS
310 AcpiDsLoad2EndOp (
311     ACPI_WALK_STATE         *WalkState);
312 
313 
314 /*
315  * dsmthdat - method data (locals/args)
316  */
317 ACPI_STATUS
318 AcpiDsStoreObjectToLocal (
319     UINT8                   Type,
320     UINT32                  Index,
321     ACPI_OPERAND_OBJECT     *SrcDesc,
322     ACPI_WALK_STATE         *WalkState);
323 
324 ACPI_STATUS
325 AcpiDsMethodDataGetEntry (
326     UINT16                  Opcode,
327     UINT32                  Index,
328     ACPI_WALK_STATE         *WalkState,
329     ACPI_OPERAND_OBJECT     ***Node);
330 
331 void
332 AcpiDsMethodDataDeleteAll (
333     ACPI_WALK_STATE         *WalkState);
334 
335 BOOLEAN
336 AcpiDsIsMethodValue (
337     ACPI_OPERAND_OBJECT     *ObjDesc);
338 
339 ACPI_STATUS
340 AcpiDsMethodDataGetValue (
341     UINT8                   Type,
342     UINT32                  Index,
343     ACPI_WALK_STATE         *WalkState,
344     ACPI_OPERAND_OBJECT     **DestDesc);
345 
346 ACPI_STATUS
347 AcpiDsMethodDataInitArgs (
348     ACPI_OPERAND_OBJECT     **Params,
349     UINT32                  MaxParamCount,
350     ACPI_WALK_STATE         *WalkState);
351 
352 ACPI_STATUS
353 AcpiDsMethodDataGetNode (
354     UINT8                   Type,
355     UINT32                  Index,
356     ACPI_WALK_STATE         *WalkState,
357     ACPI_NAMESPACE_NODE     **Node);
358 
359 void
360 AcpiDsMethodDataInit (
361     ACPI_WALK_STATE         *WalkState);
362 
363 
364 /*
365  * dsmethod - Parser/Interpreter interface - control method parsing
366  */
367 ACPI_STATUS
368 AcpiDsAutoSerializeMethod (
369     ACPI_NAMESPACE_NODE     *Node,
370     ACPI_OPERAND_OBJECT     *ObjDesc);
371 
372 ACPI_STATUS
373 AcpiDsCallControlMethod (
374     ACPI_THREAD_STATE       *Thread,
375     ACPI_WALK_STATE         *WalkState,
376     ACPI_PARSE_OBJECT       *Op);
377 
378 ACPI_STATUS
379 AcpiDsRestartControlMethod (
380     ACPI_WALK_STATE         *WalkState,
381     ACPI_OPERAND_OBJECT     *ReturnDesc);
382 
383 void
384 AcpiDsTerminateControlMethod (
385     ACPI_OPERAND_OBJECT     *MethodDesc,
386     ACPI_WALK_STATE         *WalkState);
387 
388 ACPI_STATUS
389 AcpiDsBeginMethodExecution (
390     ACPI_NAMESPACE_NODE     *MethodNode,
391     ACPI_OPERAND_OBJECT     *ObjDesc,
392     ACPI_WALK_STATE         *WalkState);
393 
394 ACPI_STATUS
395 AcpiDsMethodError (
396     ACPI_STATUS             Status,
397     ACPI_WALK_STATE         *WalkState);
398 
399 /*
400  * dsinit
401  */
402 ACPI_STATUS
403 AcpiDsInitializeObjects (
404     UINT32                  TableIndex,
405     ACPI_NAMESPACE_NODE     *StartNode);
406 
407 
408 /*
409  * dsobject - Parser/Interpreter interface - object initialization and conversion
410  */
411 ACPI_STATUS
412 AcpiDsBuildInternalObject (
413     ACPI_WALK_STATE         *WalkState,
414     ACPI_PARSE_OBJECT       *Op,
415     ACPI_OPERAND_OBJECT     **ObjDescPtr);
416 
417 ACPI_STATUS
418 AcpiDsBuildInternalBufferObj (
419     ACPI_WALK_STATE         *WalkState,
420     ACPI_PARSE_OBJECT       *Op,
421     UINT32                  BufferLength,
422     ACPI_OPERAND_OBJECT     **ObjDescPtr);
423 
424 ACPI_STATUS
425 AcpiDsBuildInternalPackageObj (
426     ACPI_WALK_STATE         *WalkState,
427     ACPI_PARSE_OBJECT       *op,
428     UINT32                  PackageLength,
429     ACPI_OPERAND_OBJECT     **ObjDesc);
430 
431 ACPI_STATUS
432 AcpiDsInitObjectFromOp (
433     ACPI_WALK_STATE         *WalkState,
434     ACPI_PARSE_OBJECT       *Op,
435     UINT16                  Opcode,
436     ACPI_OPERAND_OBJECT     **ObjDesc);
437 
438 ACPI_STATUS
439 AcpiDsCreateNode (
440     ACPI_WALK_STATE         *WalkState,
441     ACPI_NAMESPACE_NODE     *Node,
442     ACPI_PARSE_OBJECT       *Op);
443 
444 
445 /*
446  * dspkginit - Package object initialization
447  */
448 ACPI_STATUS
449 AcpiDsInitPackageElement (
450     UINT8                   ObjectType,
451     ACPI_OPERAND_OBJECT     *SourceObject,
452     ACPI_GENERIC_STATE      *State,
453     void                    *Context);
454 
455 
456 /*
457  * dsutils - Parser/Interpreter interface utility routines
458  */
459 void
460 AcpiDsClearImplicitReturn (
461     ACPI_WALK_STATE         *WalkState);
462 
463 BOOLEAN
464 AcpiDsDoImplicitReturn (
465     ACPI_OPERAND_OBJECT     *ReturnDesc,
466     ACPI_WALK_STATE         *WalkState,
467     BOOLEAN                 AddReference);
468 
469 BOOLEAN
470 AcpiDsIsResultUsed (
471     ACPI_PARSE_OBJECT       *Op,
472     ACPI_WALK_STATE         *WalkState);
473 
474 void
475 AcpiDsDeleteResultIfNotUsed (
476     ACPI_PARSE_OBJECT       *Op,
477     ACPI_OPERAND_OBJECT     *ResultObj,
478     ACPI_WALK_STATE         *WalkState);
479 
480 ACPI_STATUS
481 AcpiDsCreateOperand (
482     ACPI_WALK_STATE         *WalkState,
483     ACPI_PARSE_OBJECT       *Arg,
484     UINT32                  ArgsRemaining);
485 
486 ACPI_STATUS
487 AcpiDsCreateOperands (
488     ACPI_WALK_STATE         *WalkState,
489     ACPI_PARSE_OBJECT       *FirstArg);
490 
491 ACPI_STATUS
492 AcpiDsResolveOperands (
493     ACPI_WALK_STATE         *WalkState);
494 
495 void
496 AcpiDsClearOperands (
497     ACPI_WALK_STATE         *WalkState);
498 
499 ACPI_STATUS
500 AcpiDsEvaluateNamePath (
501     ACPI_WALK_STATE         *WalkState);
502 
503 
504 /*
505  * dswscope - Scope Stack manipulation
506  */
507 ACPI_STATUS
508 AcpiDsScopeStackPush (
509     ACPI_NAMESPACE_NODE     *Node,
510     ACPI_OBJECT_TYPE        Type,
511     ACPI_WALK_STATE         *WalkState);
512 
513 
514 ACPI_STATUS
515 AcpiDsScopeStackPop (
516     ACPI_WALK_STATE         *WalkState);
517 
518 void
519 AcpiDsScopeStackClear (
520     ACPI_WALK_STATE         *WalkState);
521 
522 
523 /*
524  * dswstate - parser WALK_STATE management routines
525  */
526 ACPI_STATUS
527 AcpiDsObjStackPush (
528     void                    *Object,
529     ACPI_WALK_STATE         *WalkState);
530 
531 ACPI_STATUS
532 AcpiDsObjStackPop (
533     UINT32                  PopCount,
534     ACPI_WALK_STATE         *WalkState);
535 
536 ACPI_WALK_STATE *
537 AcpiDsCreateWalkState (
538     ACPI_OWNER_ID           OwnerId,
539     ACPI_PARSE_OBJECT       *Origin,
540     ACPI_OPERAND_OBJECT     *MthDesc,
541     ACPI_THREAD_STATE       *Thread);
542 
543 ACPI_STATUS
544 AcpiDsInitAmlWalk (
545     ACPI_WALK_STATE         *WalkState,
546     ACPI_PARSE_OBJECT       *Op,
547     ACPI_NAMESPACE_NODE     *MethodNode,
548     UINT8                   *AmlStart,
549     UINT32                  AmlLength,
550     ACPI_EVALUATE_INFO      *Info,
551     UINT8                   PassNumber);
552 
553 void
554 AcpiDsObjStackPopAndDelete (
555     UINT32                  PopCount,
556     ACPI_WALK_STATE         *WalkState);
557 
558 void
559 AcpiDsDeleteWalkState (
560     ACPI_WALK_STATE         *WalkState);
561 
562 ACPI_WALK_STATE *
563 AcpiDsPopWalkState (
564     ACPI_THREAD_STATE       *Thread);
565 
566 void
567 AcpiDsPushWalkState (
568     ACPI_WALK_STATE         *WalkState,
569     ACPI_THREAD_STATE       *Thread);
570 
571 ACPI_STATUS
572 AcpiDsResultStackClear (
573     ACPI_WALK_STATE         *WalkState);
574 
575 ACPI_WALK_STATE *
576 AcpiDsGetCurrentWalkState (
577     ACPI_THREAD_STATE       *Thread);
578 
579 ACPI_STATUS
580 AcpiDsResultPop (
581     ACPI_OPERAND_OBJECT     **Object,
582     ACPI_WALK_STATE         *WalkState);
583 
584 ACPI_STATUS
585 AcpiDsResultPush (
586     ACPI_OPERAND_OBJECT     *Object,
587     ACPI_WALK_STATE         *WalkState);
588 
589 
590 /*
591  * dsdebug - parser debugging routines
592  */
593 void
594 AcpiDsDumpMethodStack (
595     ACPI_STATUS             Status,
596     ACPI_WALK_STATE         *WalkState,
597     ACPI_PARSE_OBJECT       *Op);
598 
599 #endif /* _ACDISPAT_H_ */
600