acdispat.h revision 91116 
1/******************************************************************************
2 *
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
4 *       $Revision: 51 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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_OPERAND_OBJECT     *ResultObj);
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
194ACPI_STATUS
195AcpiDsCreateField (
196    ACPI_PARSE_OBJECT       *Op,
197    ACPI_NAMESPACE_NODE     *RegionNode,
198    ACPI_WALK_STATE         *WalkState);
199
200ACPI_STATUS
201AcpiDsCreateBankField (
202    ACPI_PARSE_OBJECT       *Op,
203    ACPI_NAMESPACE_NODE     *RegionNode,
204    ACPI_WALK_STATE         *WalkState);
205
206ACPI_STATUS
207AcpiDsCreateIndexField (
208    ACPI_PARSE_OBJECT       *Op,
209    ACPI_NAMESPACE_NODE     *RegionNode,
210    ACPI_WALK_STATE         *WalkState);
211
212ACPI_STATUS
213AcpiDsCreateBufferField (
214    ACPI_PARSE_OBJECT       *Op,
215    ACPI_WALK_STATE         *WalkState);
216
217ACPI_STATUS
218AcpiDsInitFieldObjects (
219    ACPI_PARSE_OBJECT       *Op,
220    ACPI_WALK_STATE         *WalkState);
221
222
223/* dsload - Parser/Interpreter interface, namespace load callbacks */
224
225ACPI_STATUS
226AcpiDsLoad1BeginOp (
227    ACPI_WALK_STATE         *WalkState,
228    ACPI_PARSE_OBJECT       **OutOp);
229
230ACPI_STATUS
231AcpiDsLoad1EndOp (
232    ACPI_WALK_STATE         *WalkState);
233
234ACPI_STATUS
235AcpiDsLoad2BeginOp (
236    ACPI_WALK_STATE         *WalkState,
237    ACPI_PARSE_OBJECT       **OutOp);
238
239ACPI_STATUS
240AcpiDsLoad2EndOp (
241    ACPI_WALK_STATE         *WalkState);
242
243ACPI_STATUS
244AcpiDsInitCallbacks (
245    ACPI_WALK_STATE         *WalkState,
246    UINT32                  PassNumber);
247
248
249/* dsmthdat - method data (locals/args) */
250
251
252ACPI_STATUS
253AcpiDsStoreObjectToLocal (
254    UINT16                  Opcode,
255    UINT32                  Index,
256    ACPI_OPERAND_OBJECT     *SrcDesc,
257    ACPI_WALK_STATE         *WalkState);
258
259ACPI_STATUS
260AcpiDsMethodDataGetEntry (
261    UINT16                  Opcode,
262    UINT32                  Index,
263    ACPI_WALK_STATE         *WalkState,
264    ACPI_OPERAND_OBJECT     ***Node);
265
266ACPI_STATUS
267AcpiDsMethodDataDeleteAll (
268    ACPI_WALK_STATE         *WalkState);
269
270BOOLEAN
271AcpiDsIsMethodValue (
272    ACPI_OPERAND_OBJECT     *ObjDesc);
273
274ACPI_OBJECT_TYPE
275AcpiDsMethodDataGetType (
276    UINT16                  Opcode,
277    UINT32                  Index,
278    ACPI_WALK_STATE         *WalkState);
279
280ACPI_STATUS
281AcpiDsMethodDataGetValue (
282    UINT16                  Opcode,
283    UINT32                  Index,
284    ACPI_WALK_STATE         *WalkState,
285    ACPI_OPERAND_OBJECT     **DestDesc);
286
287ACPI_STATUS
288AcpiDsMethodDataDeleteValue (
289    UINT16                  Opcode,
290    UINT32                  Index,
291    ACPI_WALK_STATE         *WalkState);
292
293ACPI_STATUS
294AcpiDsMethodDataInitArgs (
295    ACPI_OPERAND_OBJECT     **Params,
296    UINT32                  MaxParamCount,
297    ACPI_WALK_STATE         *WalkState);
298
299ACPI_STATUS
300AcpiDsMethodDataGetNode (
301    UINT16                  Opcode,
302    UINT32                  Index,
303    ACPI_WALK_STATE         *WalkState,
304    ACPI_NAMESPACE_NODE     **Node);
305
306ACPI_STATUS
307AcpiDsMethodDataInit (
308    ACPI_WALK_STATE         *WalkState);
309
310ACPI_STATUS
311AcpiDsMethodDataSetValue (
312    UINT16                  Opcode,
313    UINT32                  Index,
314    ACPI_OPERAND_OBJECT     *Object,
315    ACPI_WALK_STATE         *WalkState);
316
317
318/* dsmethod - Parser/Interpreter interface - control method parsing */
319
320ACPI_STATUS
321AcpiDsParseMethod (
322    ACPI_HANDLE             ObjHandle);
323
324ACPI_STATUS
325AcpiDsCallControlMethod (
326    ACPI_THREAD_STATE       *Thread,
327    ACPI_WALK_STATE         *WalkState,
328    ACPI_PARSE_OBJECT       *Op);
329
330ACPI_STATUS
331AcpiDsRestartControlMethod (
332    ACPI_WALK_STATE         *WalkState,
333    ACPI_OPERAND_OBJECT     *ReturnDesc);
334
335ACPI_STATUS
336AcpiDsTerminateControlMethod (
337    ACPI_WALK_STATE         *WalkState);
338
339ACPI_STATUS
340AcpiDsBeginMethodExecution (
341    ACPI_NAMESPACE_NODE     *MethodNode,
342    ACPI_OPERAND_OBJECT     *ObjDesc,
343    ACPI_NAMESPACE_NODE     *CallingMethodNode);
344
345
346/* dsobj - Parser/Interpreter interface - object initialization and conversion */
347
348ACPI_STATUS
349AcpiDsInitOneObject (
350    ACPI_HANDLE             ObjHandle,
351    UINT32                  Level,
352    void                    *Context,
353    void                    **ReturnValue);
354
355ACPI_STATUS
356AcpiDsInitializeObjects (
357    ACPI_TABLE_DESC         *TableDesc,
358    ACPI_NAMESPACE_NODE     *StartNode);
359
360ACPI_STATUS
361AcpiDsBuildInternalPackageObj (
362    ACPI_WALK_STATE         *WalkState,
363    ACPI_PARSE_OBJECT       *op,
364    ACPI_OPERAND_OBJECT     **ObjDesc);
365
366ACPI_STATUS
367AcpiDsBuildInternalObject (
368    ACPI_WALK_STATE         *WalkState,
369    ACPI_PARSE_OBJECT       *op,
370    ACPI_OPERAND_OBJECT     **ObjDescPtr);
371
372ACPI_STATUS
373AcpiDsInitObjectFromOp (
374    ACPI_WALK_STATE         *WalkState,
375    ACPI_PARSE_OBJECT       *Op,
376    UINT16                  Opcode,
377    ACPI_OPERAND_OBJECT     **ObjDesc);
378
379ACPI_STATUS
380AcpiDsCreateNode (
381    ACPI_WALK_STATE         *WalkState,
382    ACPI_NAMESPACE_NODE     *Node,
383    ACPI_PARSE_OBJECT       *Op);
384
385
386/* dsregn - Parser/Interpreter interface - Op Region parsing */
387
388ACPI_STATUS
389AcpiDsEvalBufferFieldOperands (
390    ACPI_WALK_STATE         *WalkState,
391    ACPI_PARSE_OBJECT       *Op);
392
393ACPI_STATUS
394AcpiDsEvalRegionOperands (
395    ACPI_WALK_STATE         *WalkState,
396    ACPI_PARSE_OBJECT       *Op);
397
398ACPI_STATUS
399AcpiDsInitializeRegion (
400    ACPI_HANDLE             ObjHandle);
401
402
403/* dsutils - Parser/Interpreter interface utility routines */
404
405BOOLEAN
406AcpiDsIsResultUsed (
407    ACPI_PARSE_OBJECT       *Op,
408    ACPI_WALK_STATE         *WalkState);
409
410void
411AcpiDsDeleteResultIfNotUsed (
412    ACPI_PARSE_OBJECT       *Op,
413    ACPI_OPERAND_OBJECT     *ResultObj,
414    ACPI_WALK_STATE         *WalkState);
415
416ACPI_STATUS
417AcpiDsCreateOperand (
418    ACPI_WALK_STATE         *WalkState,
419    ACPI_PARSE_OBJECT       *Arg,
420    UINT32                  ArgsRemaining);
421
422ACPI_STATUS
423AcpiDsCreateOperands (
424    ACPI_WALK_STATE         *WalkState,
425    ACPI_PARSE_OBJECT       *FirstArg);
426
427ACPI_STATUS
428AcpiDsResolveOperands (
429    ACPI_WALK_STATE         *WalkState);
430
431
432/*
433 * dswscope - Scope Stack manipulation
434 */
435
436ACPI_STATUS
437AcpiDsScopeStackPush (
438    ACPI_NAMESPACE_NODE     *Node,
439    ACPI_OBJECT_TYPE        Type,
440    ACPI_WALK_STATE         *WalkState);
441
442
443ACPI_STATUS
444AcpiDsScopeStackPop (
445    ACPI_WALK_STATE         *WalkState);
446
447void
448AcpiDsScopeStackClear (
449    ACPI_WALK_STATE         *WalkState);
450
451
452/* dswstate - parser WALK_STATE management routines */
453
454ACPI_WALK_STATE *
455AcpiDsCreateWalkState (
456    ACPI_OWNER_ID           OwnerId,
457    ACPI_PARSE_OBJECT       *Origin,
458    ACPI_OPERAND_OBJECT     *MthDesc,
459    ACPI_THREAD_STATE       *Thread);
460
461ACPI_STATUS
462AcpiDsInitAmlWalk (
463    ACPI_WALK_STATE         *WalkState,
464    ACPI_PARSE_OBJECT       *Op,
465    ACPI_NAMESPACE_NODE     *MethodNode,
466    UINT8                   *AmlStart,
467    UINT32                  AmlLength,
468    ACPI_OPERAND_OBJECT     **Params,
469    ACPI_OPERAND_OBJECT     **ReturnObjDesc,
470    UINT32                  PassNumber);
471
472ACPI_STATUS
473AcpiDsObjStackDeleteAll (
474    ACPI_WALK_STATE         *WalkState);
475
476ACPI_STATUS
477AcpiDsObjStackPopAndDelete (
478    UINT32                  PopCount,
479    ACPI_WALK_STATE         *WalkState);
480
481void
482AcpiDsDeleteWalkState (
483    ACPI_WALK_STATE         *WalkState);
484
485ACPI_WALK_STATE *
486AcpiDsPopWalkState (
487    ACPI_THREAD_STATE       *Thread);
488
489void
490AcpiDsPushWalkState (
491    ACPI_WALK_STATE         *WalkState,
492    ACPI_THREAD_STATE       *Thread);
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_THREAD_STATE       *Thread);
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