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