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