acdispat.h revision 71867 
1/******************************************************************************
2 *
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
4 *       $Revision: 35 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
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
20 * property rights.
21 *
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
28 *
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;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
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.
54 *
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
65 * make.
66 *
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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117
118#ifndef _ACDISPAT_H_
119#define _ACDISPAT_H_
120
121
122#define NAMEOF_LOCAL_NTE    "__L0"
123#define NAMEOF_ARG_NTE      "__A0"
124
125
126/* For AcpiDsMethodDataSetValue */
127
128#define MTH_TYPE_LOCAL              0
129#define MTH_TYPE_ARG                1
130
131
132/* Common interfaces */
133
134ACPI_STATUS
135AcpiDsObjStackPush (
136    void                    *Object,
137    ACPI_WALK_STATE         *WalkState);
138
139ACPI_STATUS
140AcpiDsObjStackPop (
141    UINT32                  PopCount,
142    ACPI_WALK_STATE         *WalkState);
143
144void *
145AcpiDsObjStackGetValue (
146    UINT32                  Index,
147    ACPI_WALK_STATE         *WalkState);
148
149ACPI_STATUS
150AcpiDsObjStackPopObject (
151    ACPI_OPERAND_OBJECT     **Object,
152    ACPI_WALK_STATE         *WalkState);
153
154
155/* dsopcode - support for late evaluation */
156
157ACPI_STATUS
158AcpiDsGetFieldUnitArguments (
159    ACPI_OPERAND_OBJECT     *ObjDesc);
160
161ACPI_STATUS
162AcpiDsGetRegionArguments (
163    ACPI_OPERAND_OBJECT     *RgnDesc);
164
165
166/* dsctrl - Parser/Interpreter interface, control stack routines */
167
168
169ACPI_STATUS
170AcpiDsExecBeginControlOp (
171    ACPI_WALK_STATE         *WalkState,
172    ACPI_PARSE_OBJECT       *Op);
173
174ACPI_STATUS
175AcpiDsExecEndControlOp (
176    ACPI_WALK_STATE         *WalkState,
177    ACPI_PARSE_OBJECT       *Op);
178
179
180/* dsexec - Parser/Interpreter interface, method execution callbacks */
181
182
183ACPI_STATUS
184AcpiDsGetPredicateValue (
185    ACPI_WALK_STATE         *WalkState,
186    ACPI_PARSE_OBJECT       *Op,
187    UINT32                  HasResultObj);
188
189ACPI_STATUS
190AcpiDsExecBeginOp (
191    UINT16                  Opcode,
192    ACPI_PARSE_OBJECT       *Op,
193    ACPI_WALK_STATE         *WalkState,
194    ACPI_PARSE_OBJECT       **OutOp);
195
196ACPI_STATUS
197AcpiDsExecEndOp (
198    ACPI_WALK_STATE         *State,
199    ACPI_PARSE_OBJECT       *Op);
200
201
202/* dsfield - Parser/Interpreter interface for AML fields */
203
204
205ACPI_STATUS
206AcpiDsCreateField (
207    ACPI_PARSE_OBJECT       *Op,
208    ACPI_NAMESPACE_NODE     *RegionNode,
209    ACPI_WALK_STATE         *WalkState);
210
211ACPI_STATUS
212AcpiDsCreateBankField (
213    ACPI_PARSE_OBJECT       *Op,
214    ACPI_NAMESPACE_NODE     *RegionNode,
215    ACPI_WALK_STATE         *WalkState);
216
217ACPI_STATUS
218AcpiDsCreateIndexField (
219    ACPI_PARSE_OBJECT       *Op,
220    ACPI_HANDLE             RegionNode,
221    ACPI_WALK_STATE         *WalkState);
222
223
224/* dsload - Parser/Interpreter interface, namespace load callbacks */
225
226ACPI_STATUS
227AcpiDsLoad1BeginOp (
228    UINT16                  Opcode,
229    ACPI_PARSE_OBJECT       *Op,
230    ACPI_WALK_STATE         *WalkState,
231    ACPI_PARSE_OBJECT       **OutOp);
232
233ACPI_STATUS
234AcpiDsLoad1EndOp (
235    ACPI_WALK_STATE         *WalkState,
236    ACPI_PARSE_OBJECT       *Op);
237
238ACPI_STATUS
239AcpiDsLoad2BeginOp (
240    UINT16                  Opcode,
241    ACPI_PARSE_OBJECT       *Op,
242    ACPI_WALK_STATE         *WalkState,
243    ACPI_PARSE_OBJECT       **OutOp);
244
245ACPI_STATUS
246AcpiDsLoad2EndOp (
247    ACPI_WALK_STATE         *State,
248    ACPI_PARSE_OBJECT       *Op);
249
250ACPI_STATUS
251AcpiDsLoad3BeginOp (
252    UINT16                  Opcode,
253    ACPI_PARSE_OBJECT       *Op,
254    ACPI_WALK_STATE         *WalkState,
255    ACPI_PARSE_OBJECT       **OutOp);
256
257ACPI_STATUS
258AcpiDsLoad3EndOp (
259    ACPI_WALK_STATE         *State,
260    ACPI_PARSE_OBJECT       *Op);
261
262
263/* dsmthdat - method data (locals/args) */
264
265
266ACPI_STATUS
267AcpiDsMethodDataGetEntry (
268    UINT32                  Type,
269    UINT32                  Index,
270    ACPI_WALK_STATE         *WalkState,
271    ACPI_OPERAND_OBJECT     ***Node);
272
273ACPI_STATUS
274AcpiDsMethodDataDeleteAll (
275    ACPI_WALK_STATE         *WalkState);
276
277BOOLEAN
278AcpiDsIsMethodValue (
279    ACPI_OPERAND_OBJECT     *ObjDesc);
280
281OBJECT_TYPE_INTERNAL
282AcpiDsMethodDataGetType (
283    UINT32                  Type,
284    UINT32                  Index,
285    ACPI_WALK_STATE         *WalkState);
286
287ACPI_STATUS
288AcpiDsMethodDataGetValue (
289    UINT32                  Type,
290    UINT32                  Index,
291    ACPI_WALK_STATE         *WalkState,
292    ACPI_OPERAND_OBJECT     **DestDesc);
293
294ACPI_STATUS
295AcpiDsMethodDataSetValue (
296    UINT32                  Type,
297    UINT32                  Index,
298    ACPI_OPERAND_OBJECT     *SrcDesc,
299    ACPI_WALK_STATE         *WalkState);
300
301ACPI_STATUS
302AcpiDsMethodDataDeleteValue (
303    UINT32                  Type,
304    UINT32                  Index,
305    ACPI_WALK_STATE         *WalkState);
306
307ACPI_STATUS
308AcpiDsMethodDataInitArgs (
309    ACPI_OPERAND_OBJECT     **Params,
310    UINT32                  MaxParamCount,
311    ACPI_WALK_STATE         *WalkState);
312
313ACPI_NAMESPACE_NODE *
314AcpiDsMethodDataGetNte (
315    UINT32                  Type,
316    UINT32                  Index,
317    ACPI_WALK_STATE         *WalkState);
318
319ACPI_STATUS
320AcpiDsMethodDataInit (
321    ACPI_WALK_STATE         *WalkState);
322
323ACPI_STATUS
324AcpiDsMethodDataSetEntry (
325    UINT32                  Type,
326    UINT32                  Index,
327    ACPI_OPERAND_OBJECT     *Object,
328    ACPI_WALK_STATE         *WalkState);
329
330
331/* dsmethod - Parser/Interpreter interface - control method parsing */
332
333ACPI_STATUS
334AcpiDsParseMethod (
335    ACPI_HANDLE             ObjHandle);
336
337ACPI_STATUS
338AcpiDsCallControlMethod (
339    ACPI_WALK_LIST          *WalkList,
340    ACPI_WALK_STATE         *WalkState,
341    ACPI_PARSE_OBJECT       *Op);
342
343ACPI_STATUS
344AcpiDsRestartControlMethod (
345    ACPI_WALK_STATE         *WalkState,
346    ACPI_OPERAND_OBJECT     *ReturnDesc);
347
348ACPI_STATUS
349AcpiDsTerminateControlMethod (
350    ACPI_WALK_STATE         *WalkState);
351
352ACPI_STATUS
353AcpiDsBeginMethodExecution (
354    ACPI_NAMESPACE_NODE     *MethodNode,
355    ACPI_OPERAND_OBJECT     *ObjDesc);
356
357
358/* dsobj - Parser/Interpreter interface - object initialization and conversion */
359
360ACPI_STATUS
361AcpiDsInitOneObject (
362    ACPI_HANDLE             ObjHandle,
363    UINT32                  Level,
364    void                    *Context,
365    void                    **ReturnValue);
366
367ACPI_STATUS
368AcpiDsInitializeObjects (
369    ACPI_TABLE_DESC         *TableDesc,
370    ACPI_NAMESPACE_NODE     *StartNode);
371
372ACPI_STATUS
373AcpiDsBuildInternalPackageObj (
374    ACPI_WALK_STATE         *WalkState,
375    ACPI_PARSE_OBJECT       *op,
376    ACPI_OPERAND_OBJECT     **ObjDesc);
377
378ACPI_STATUS
379AcpiDsBuildInternalObject (
380    ACPI_WALK_STATE         *WalkState,
381    ACPI_PARSE_OBJECT       *op,
382    ACPI_OPERAND_OBJECT     **ObjDescPtr);
383
384ACPI_STATUS
385AcpiDsInitObjectFromOp (
386    ACPI_WALK_STATE         *WalkState,
387    ACPI_PARSE_OBJECT       *Op,
388    UINT16                  Opcode,
389    ACPI_OPERAND_OBJECT     **ObjDesc);
390
391ACPI_STATUS
392AcpiDsCreateNode (
393    ACPI_WALK_STATE         *WalkState,
394    ACPI_NAMESPACE_NODE     *Node,
395    ACPI_PARSE_OBJECT       *Op);
396
397
398/* dsregn - Parser/Interpreter interface - Op Region parsing */
399
400ACPI_STATUS
401AcpiDsEvalFieldUnitOperands (
402    ACPI_WALK_STATE         *WalkState,
403    ACPI_PARSE_OBJECT       *Op);
404
405ACPI_STATUS
406AcpiDsEvalRegionOperands (
407    ACPI_WALK_STATE         *WalkState,
408    ACPI_PARSE_OBJECT       *Op);
409
410ACPI_STATUS
411AcpiDsInitializeRegion (
412    ACPI_HANDLE             ObjHandle);
413
414
415/* dsutils - Parser/Interpreter interface utility routines */
416
417BOOLEAN
418AcpiDsIsResultUsed (
419    ACPI_PARSE_OBJECT       *Op,
420    ACPI_WALK_STATE         *WalkState);
421
422void
423AcpiDsDeleteResultIfNotUsed (
424    ACPI_PARSE_OBJECT       *Op,
425    ACPI_OPERAND_OBJECT     *ResultObj,
426    ACPI_WALK_STATE         *WalkState);
427
428ACPI_STATUS
429AcpiDsCreateOperand (
430    ACPI_WALK_STATE         *WalkState,
431    ACPI_PARSE_OBJECT       *Arg,
432    UINT32                  ArgsRemaining);
433
434ACPI_STATUS
435AcpiDsCreateOperands (
436    ACPI_WALK_STATE         *WalkState,
437    ACPI_PARSE_OBJECT       *FirstArg);
438
439ACPI_STATUS
440AcpiDsResolveOperands (
441    ACPI_WALK_STATE         *WalkState);
442
443OBJECT_TYPE_INTERNAL
444AcpiDsMapOpcodeToDataType (
445    UINT16                  Opcode,
446    UINT32                  *OutFlags);
447
448OBJECT_TYPE_INTERNAL
449AcpiDsMapNamedOpcodeToDataType (
450    UINT16                  Opcode);
451
452
453/*
454 * dswscope - Scope Stack manipulation
455 */
456
457ACPI_STATUS
458AcpiDsScopeStackPush (
459    ACPI_NAMESPACE_NODE     *Node,
460    OBJECT_TYPE_INTERNAL    Type,
461    ACPI_WALK_STATE         *WalkState);
462
463
464ACPI_STATUS
465AcpiDsScopeStackPop (
466    ACPI_WALK_STATE         *WalkState);
467
468void
469AcpiDsScopeStackClear (
470    ACPI_WALK_STATE         *WalkState);
471
472
473/* AcpiDswstate - parser WALK_STATE management routines */
474
475ACPI_WALK_STATE *
476AcpiDsCreateWalkState (
477    ACPI_OWNER_ID           OwnerId,
478    ACPI_PARSE_OBJECT       *Origin,
479    ACPI_OPERAND_OBJECT     *MthDesc,
480    ACPI_WALK_LIST          *WalkList);
481
482ACPI_STATUS
483AcpiDsObjStackDeleteAll (
484    ACPI_WALK_STATE         *WalkState);
485
486ACPI_STATUS
487AcpiDsObjStackPopAndDelete (
488    UINT32                  PopCount,
489    ACPI_WALK_STATE         *WalkState);
490
491void
492AcpiDsDeleteWalkState (
493    ACPI_WALK_STATE         *WalkState);
494
495ACPI_WALK_STATE *
496AcpiDsPopWalkState (
497    ACPI_WALK_LIST          *WalkList);
498
499ACPI_STATUS
500AcpiDsResultStackPop (
501    ACPI_WALK_STATE         *WalkState);
502
503ACPI_STATUS
504AcpiDsResultStackPush (
505    ACPI_WALK_STATE         *WalkState);
506
507ACPI_STATUS
508AcpiDsResultStackClear (
509    ACPI_WALK_STATE         *WalkState);
510
511ACPI_WALK_STATE *
512AcpiDsGetCurrentWalkState (
513    ACPI_WALK_LIST          *WalkList);
514
515void
516AcpiDsDeleteWalkStateCache (
517    void);
518
519ACPI_STATUS
520AcpiDsResultInsert (
521    void                    *Object,
522    UINT32                  Index,
523    ACPI_WALK_STATE         *WalkState);
524
525ACPI_STATUS
526AcpiDsResultRemove (
527    ACPI_OPERAND_OBJECT     **Object,
528    UINT32                  Index,
529    ACPI_WALK_STATE         *WalkState);
530
531ACPI_STATUS
532AcpiDsResultPop (
533    ACPI_OPERAND_OBJECT     **Object,
534    ACPI_WALK_STATE         *WalkState);
535
536ACPI_STATUS
537AcpiDsResultPush (
538    ACPI_OPERAND_OBJECT     *Object,
539    ACPI_WALK_STATE         *WalkState);
540
541ACPI_STATUS
542AcpiDsResultPopFromBottom (
543    ACPI_OPERAND_OBJECT     **Object,
544    ACPI_WALK_STATE         *WalkState);
545
546#endif /* _ACDISPAT_H_ */
547