acdispat.h revision 70243 
1254721Semaste/******************************************************************************
2254721Semaste *
3254721Semaste * Name: acdispat.h - dispatcher (parser to interpreter interface)
4254721Semaste *       $Revision: 34 $
5254721Semaste *
6254721Semaste *****************************************************************************/
7254721Semaste
8254721Semaste/******************************************************************************
9254721Semaste *
10254721Semaste * 1. Copyright Notice
11254721Semaste *
12254721Semaste * Some or all of this work - Copyright (c) 1999, 2000, Intel Corp.
13254721Semaste * All rights reserved.
14254721Semaste *
15254721Semaste * 2. License
16254721Semaste *
17254721Semaste * 2.1. This is your license from Intel Corp. under its intellectual property
18254721Semaste * rights.  You may have additional license terms from the party that provided
19254721Semaste * you this software, covering your right to use that party's intellectual
20254721Semaste * property rights.
21254721Semaste *
22254721Semaste * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23254721Semaste * copy of the source code appearing in this file ("Covered Code") an
24254721Semaste * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25254721Semaste * base code distributed originally by Intel ("Original Intel Code") to copy,
26254721Semaste * make derivatives, distribute, use and display any portion of the Covered
27254721Semaste * Code in any form, with the right to sublicense such rights; and
28254721Semaste *
29254721Semaste * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30254721Semaste * license (with the right to sublicense), under only those claims of Intel
31254721Semaste * patents that are infringed by the Original Intel Code, to make, use, sell,
32254721Semaste * offer to sell, and import the Covered Code and derivative works thereof
33254721Semaste * solely to the minimum extent necessary to exercise the above copyright
34254721Semaste * license, and in no event shall the patent license extend to any additions
35254721Semaste * to or modifications of the Original Intel Code.  No other license or right
36254721Semaste * is granted directly or by implication, estoppel or otherwise;
37254721Semaste *
38254721Semaste * The above copyright and patent license is granted only if the following
39254721Semaste * conditions are met:
40254721Semaste *
41254721Semaste * 3. Conditions
42254721Semaste *
43254721Semaste * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44254721Semaste * Redistribution of source code of any substantial portion of the Covered
45254721Semaste * Code or modification with rights to further distribute source must include
46254721Semaste * the above Copyright Notice, the above License, this list of Conditions,
47254721Semaste * and the following Disclaimer and Export Compliance provision.  In addition,
48254721Semaste * Licensee must cause all Covered Code to which Licensee contributes to
49254721Semaste * contain a file documenting the changes Licensee made to create that Covered
50254721Semaste * Code and the date of any change.  Licensee must include in that file the
51254721Semaste * documentation of any changes made by any predecessor Licensee.  Licensee
52254721Semaste * must include a prominent statement that the modification is derived,
53254721Semaste * directly or indirectly, from Original Intel Code.
54254721Semaste *
55254721Semaste * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56254721Semaste * Redistribution of source code of any substantial portion of the Covered
57254721Semaste * Code or modification without rights to further distribute source must
58254721Semaste * include the following Disclaimer and Export Compliance provision in the
59254721Semaste * documentation and/or other materials provided with distribution.  In
60254721Semaste * addition, Licensee may not authorize further sublicense of source of any
61254721Semaste * portion of the Covered Code, and must include terms to the effect that the
62254721Semaste * license from Licensee to its licensee is limited to the intellectual
63254721Semaste * property embodied in the software Licensee provides to its licensee, and
64254721Semaste * not to intellectual property embodied in modifications its licensee may
65254721Semaste * make.
66254721Semaste *
67254721Semaste * 3.3. Redistribution of Executable. Redistribution in executable form of any
68254721Semaste * substantial portion of the Covered Code or modification must reproduce the
69254721Semaste * above Copyright Notice, and the following Disclaimer and Export Compliance
70254721Semaste * provision in the documentation and/or other materials provided with the
71254721Semaste * distribution.
72254721Semaste *
73254721Semaste * 3.4. Intel retains all right, title, and interest in and to the Original
74254721Semaste * Intel Code.
75254721Semaste *
76254721Semaste * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77254721Semaste * Intel shall be used in advertising or otherwise to promote the sale, use or
78254721Semaste * other dealings in products derived from or relating to the Covered Code
79254721Semaste * without prior written authorization from Intel.
80254721Semaste *
81254721Semaste * 4. Disclaimer and Export Compliance
82254721Semaste *
83254721Semaste * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84254721Semaste * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85254721Semaste * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86254721Semaste * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87254721Semaste * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88254721Semaste * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89254721Semaste * PARTICULAR PURPOSE.
90254721Semaste *
91254721Semaste * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92254721Semaste * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93254721Semaste * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94254721Semaste * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95254721Semaste * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96254721Semaste * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97254721Semaste * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98254721Semaste * LIMITED REMEDY.
99254721Semaste *
100254721Semaste * 4.3. Licensee shall not export, either directly or indirectly, any of this
101254721Semaste * software or system incorporating such software without first obtaining any
102254721Semaste * required license or other approval from the U. S. Department of Commerce or
103254721Semaste * any other agency or department of the United States Government.  In the
104254721Semaste * event Licensee exports any such software from the United States or
105254721Semaste * re-exports any such software from a foreign destination, Licensee shall
106254721Semaste * ensure that the distribution and export/re-export of the software is in
107254721Semaste * compliance with all laws, regulations, orders, or other restrictions of the
108254721Semaste * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109254721Semaste * any of its subsidiaries will export/re-export any technical data, process,
110254721Semaste * software, or service, directly or indirectly, to any country for which the
111254721Semaste * United States government or any agency thereof requires an export license,
112254721Semaste * other governmental approval, or letter of assurance, without first obtaining
113254721Semaste * such license, approval or letter.
114254721Semaste *
115254721Semaste *****************************************************************************/
116254721Semaste
117254721Semaste
118254721Semaste#ifndef _ACDISPAT_H_
119254721Semaste#define _ACDISPAT_H_
120254721Semaste
121254721Semaste
122254721Semaste#define NAMEOF_LOCAL_NTE    "__L0"
123254721Semaste#define NAMEOF_ARG_NTE      "__A0"
124254721Semaste
125254721Semaste
126254721Semaste/* For AcpiDsMethodDataSetValue */
127254721Semaste
128254721Semaste#define MTH_TYPE_LOCAL              0
129254721Semaste#define MTH_TYPE_ARG                1
130254721Semaste
131254721Semaste
132254721Semaste/* Common interfaces */
133254721Semaste
134254721SemasteACPI_STATUS
135254721SemasteAcpiDsObjStackPush (
136254721Semaste    void                    *Object,
137254721Semaste    ACPI_WALK_STATE         *WalkState);
138254721Semaste
139254721SemasteACPI_STATUS
140254721SemasteAcpiDsObjStackPop (
141254721Semaste    UINT32                  PopCount,
142254721Semaste    ACPI_WALK_STATE         *WalkState);
143254721Semaste
144254721Semastevoid *
145254721SemasteAcpiDsObjStackGetValue (
146254721Semaste    UINT32                  Index,
147254721Semaste    ACPI_WALK_STATE         *WalkState);
148254721Semaste
149254721SemasteACPI_STATUS
150254721SemasteAcpiDsObjStackPopObject (
151254721Semaste    ACPI_OPERAND_OBJECT     **Object,
152254721Semaste    ACPI_WALK_STATE         *WalkState);
153254721Semaste
154254721Semaste
155254721Semaste/* dsopcode - support for late evaluation */
156254721Semaste
157254721SemasteACPI_STATUS
158254721SemasteAcpiDsGetFieldUnitArguments (
159254721Semaste    ACPI_OPERAND_OBJECT     *ObjDesc);
160254721Semaste
161254721SemasteACPI_STATUS
162254721SemasteAcpiDsGetRegionArguments (
163254721Semaste    ACPI_OPERAND_OBJECT     *RgnDesc);
164254721Semaste
165254721Semaste
166254721Semaste/* dsctrl - Parser/Interpreter interface, control stack routines */
167254721Semaste
168254721Semaste
169254721SemasteACPI_STATUS
170254721SemasteAcpiDsExecBeginControlOp (
171254721Semaste    ACPI_WALK_STATE         *WalkState,
172254721Semaste    ACPI_PARSE_OBJECT       *Op);
173254721Semaste
174254721SemasteACPI_STATUS
175254721SemasteAcpiDsExecEndControlOp (
176254721Semaste    ACPI_WALK_STATE         *WalkState,
177254721Semaste    ACPI_PARSE_OBJECT       *Op);
178254721Semaste
179254721Semaste
180254721Semaste/* dsexec - Parser/Interpreter interface, method execution callbacks */
181254721Semaste
182254721Semaste
183254721SemasteACPI_STATUS
184254721SemasteAcpiDsGetPredicateValue (
185254721Semaste    ACPI_WALK_STATE         *WalkState,
186254721Semaste    ACPI_PARSE_OBJECT       *Op,
187254721Semaste    UINT32                  HasResultObj);
188254721Semaste
189254721SemasteACPI_STATUS
190254721SemasteAcpiDsExecBeginOp (
191254721Semaste    UINT16                  Opcode,
192254721Semaste    ACPI_PARSE_OBJECT       *Op,
193254721Semaste    ACPI_WALK_STATE         *WalkState,
194254721Semaste    ACPI_PARSE_OBJECT       **OutOp);
195254721Semaste
196254721SemasteACPI_STATUS
197254721SemasteAcpiDsExecEndOp (
198254721Semaste    ACPI_WALK_STATE         *State,
199254721Semaste    ACPI_PARSE_OBJECT       *Op);
200254721Semaste
201254721Semaste
202254721Semaste/* dsfield - Parser/Interpreter interface for AML fields */
203254721Semaste
204254721Semaste
205254721SemasteACPI_STATUS
206254721SemasteAcpiDsCreateField (
207254721Semaste    ACPI_PARSE_OBJECT       *Op,
208254721Semaste    ACPI_NAMESPACE_NODE     *RegionNode,
209254721Semaste    ACPI_WALK_STATE         *WalkState);
210254721Semaste
211254721SemasteACPI_STATUS
212254721SemasteAcpiDsCreateBankField (
213254721Semaste    ACPI_PARSE_OBJECT       *Op,
214254721Semaste    ACPI_NAMESPACE_NODE     *RegionNode,
215254721Semaste    ACPI_WALK_STATE         *WalkState);
216254721Semaste
217254721SemasteACPI_STATUS
218254721SemasteAcpiDsCreateIndexField (
219254721Semaste    ACPI_PARSE_OBJECT       *Op,
220254721Semaste    ACPI_HANDLE             RegionNode,
221254721Semaste    ACPI_WALK_STATE         *WalkState);
222254721Semaste
223254721Semaste
224254721Semaste/* dsload - Parser/Interpreter interface, namespace load callbacks */
225254721Semaste
226254721SemasteACPI_STATUS
227254721SemasteAcpiDsLoad1BeginOp (
228254721Semaste    UINT16                  Opcode,
229254721Semaste    ACPI_PARSE_OBJECT       *Op,
230254721Semaste    ACPI_WALK_STATE         *WalkState,
231254721Semaste    ACPI_PARSE_OBJECT       **OutOp);
232254721Semaste
233254721SemasteACPI_STATUS
234254721SemasteAcpiDsLoad1EndOp (
235254721Semaste    ACPI_WALK_STATE         *WalkState,
236254721Semaste    ACPI_PARSE_OBJECT       *Op);
237254721Semaste
238254721SemasteACPI_STATUS
239254721SemasteAcpiDsLoad2BeginOp (
240254721Semaste    UINT16                  Opcode,
241254721Semaste    ACPI_PARSE_OBJECT       *Op,
242254721Semaste    ACPI_WALK_STATE         *WalkState,
243254721Semaste    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