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