1 /******************************************************************************
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
121 #define NAMEOF_LOCAL_NTE "__L0"
122 #define NAMEOF_ARG_NTE "__A0"
126 * dsopcode - support for late evaluation
129 AcpiDsGetBufferFieldArguments (
130 ACPI_OPERAND_OBJECT *ObjDesc);
133 AcpiDsGetBankFieldArguments (
134 ACPI_OPERAND_OBJECT *ObjDesc);
137 AcpiDsGetRegionArguments (
138 ACPI_OPERAND_OBJECT *RgnDesc);
141 AcpiDsGetBufferArguments (
142 ACPI_OPERAND_OBJECT *ObjDesc);
145 AcpiDsGetPackageArguments (
146 ACPI_OPERAND_OBJECT *ObjDesc);
149 AcpiDsEvalBufferFieldOperands (
150 ACPI_WALK_STATE *WalkState,
151 ACPI_PARSE_OBJECT *Op);
154 AcpiDsEvalRegionOperands (
155 ACPI_WALK_STATE *WalkState,
156 ACPI_PARSE_OBJECT *Op);
159 AcpiDsEvalTableRegionOperands (
160 ACPI_WALK_STATE *WalkState,
161 ACPI_PARSE_OBJECT *Op);
164 AcpiDsEvalDataObjectOperands (
165 ACPI_WALK_STATE *WalkState,
166 ACPI_PARSE_OBJECT *Op,
167 ACPI_OPERAND_OBJECT *ObjDesc);
170 AcpiDsEvalBankFieldOperands (
171 ACPI_WALK_STATE *WalkState,
172 ACPI_PARSE_OBJECT *Op);
175 AcpiDsInitializeRegion (
176 ACPI_HANDLE ObjHandle);
180 * dsctrl - Parser/Interpreter interface, control stack routines
183 AcpiDsExecBeginControlOp (
184 ACPI_WALK_STATE *WalkState,
185 ACPI_PARSE_OBJECT *Op);
188 AcpiDsExecEndControlOp (
189 ACPI_WALK_STATE *WalkState,
190 ACPI_PARSE_OBJECT *Op);
194 * dsexec - Parser/Interpreter interface, method execution callbacks
197 AcpiDsGetPredicateValue (
198 ACPI_WALK_STATE *WalkState,
199 ACPI_OPERAND_OBJECT *ResultObj);
203 ACPI_WALK_STATE *WalkState,
204 ACPI_PARSE_OBJECT **OutOp);
208 ACPI_WALK_STATE *State);
212 * dsfield - Parser/Interpreter interface for AML fields
216 ACPI_PARSE_OBJECT *Op,
217 ACPI_NAMESPACE_NODE *RegionNode,
218 ACPI_WALK_STATE *WalkState);
221 AcpiDsCreateBankField (
222 ACPI_PARSE_OBJECT *Op,
223 ACPI_NAMESPACE_NODE *RegionNode,
224 ACPI_WALK_STATE *WalkState);
227 AcpiDsCreateIndexField (
228 ACPI_PARSE_OBJECT *Op,
229 ACPI_NAMESPACE_NODE *RegionNode,
230 ACPI_WALK_STATE *WalkState);
233 AcpiDsCreateBufferField (
234 ACPI_PARSE_OBJECT *Op,
235 ACPI_WALK_STATE *WalkState);
238 AcpiDsInitFieldObjects (
239 ACPI_PARSE_OBJECT *Op,
240 ACPI_WALK_STATE *WalkState);
244 * dsload - Parser/Interpreter interface, namespace load callbacks
248 ACPI_WALK_STATE *WalkState,
249 ACPI_PARSE_OBJECT **OutOp);
253 ACPI_WALK_STATE *WalkState);
257 ACPI_WALK_STATE *WalkState,
258 ACPI_PARSE_OBJECT **OutOp);
262 ACPI_WALK_STATE *WalkState);
265 AcpiDsInitCallbacks (
266 ACPI_WALK_STATE *WalkState,
271 * dsmthdat - method data (locals/args)
274 AcpiDsStoreObjectToLocal (
277 ACPI_OPERAND_OBJECT *SrcDesc,
278 ACPI_WALK_STATE *WalkState);
281 AcpiDsMethodDataGetEntry (
284 ACPI_WALK_STATE *WalkState,
285 ACPI_OPERAND_OBJECT ***Node);
288 AcpiDsMethodDataDeleteAll (
289 ACPI_WALK_STATE *WalkState);
292 AcpiDsIsMethodValue (
293 ACPI_OPERAND_OBJECT *ObjDesc);
296 AcpiDsMethodDataGetValue (
299 ACPI_WALK_STATE *WalkState,
300 ACPI_OPERAND_OBJECT **DestDesc);
303 AcpiDsMethodDataInitArgs (
304 ACPI_OPERAND_OBJECT **Params,
305 UINT32 MaxParamCount,
306 ACPI_WALK_STATE *WalkState);
309 AcpiDsMethodDataGetNode (
312 ACPI_WALK_STATE *WalkState,
313 ACPI_NAMESPACE_NODE **Node);
316 AcpiDsMethodDataInit (
317 ACPI_WALK_STATE *WalkState);
321 * dsmethod - Parser/Interpreter interface - control method parsing
325 ACPI_NAMESPACE_NODE *Node);
328 AcpiDsCallControlMethod (
329 ACPI_THREAD_STATE *Thread,
330 ACPI_WALK_STATE *WalkState,
331 ACPI_PARSE_OBJECT *Op);
334 AcpiDsRestartControlMethod (
335 ACPI_WALK_STATE *WalkState,
336 ACPI_OPERAND_OBJECT *ReturnDesc);
339 AcpiDsTerminateControlMethod (
340 ACPI_OPERAND_OBJECT *MethodDesc,
341 ACPI_WALK_STATE *WalkState);
344 AcpiDsBeginMethodExecution (
345 ACPI_NAMESPACE_NODE *MethodNode,
346 ACPI_OPERAND_OBJECT *ObjDesc,
347 ACPI_WALK_STATE *WalkState);
352 ACPI_WALK_STATE *WalkState);
358 AcpiDsInitializeObjects (
360 ACPI_NAMESPACE_NODE *StartNode);
364 * dsobject - Parser/Interpreter interface - object initialization and conversion
367 AcpiDsBuildInternalBufferObj (
368 ACPI_WALK_STATE *WalkState,
369 ACPI_PARSE_OBJECT *Op,
371 ACPI_OPERAND_OBJECT **ObjDescPtr);
374 AcpiDsBuildInternalPackageObj (
375 ACPI_WALK_STATE *WalkState,
376 ACPI_PARSE_OBJECT *op,
377 UINT32 PackageLength,
378 ACPI_OPERAND_OBJECT **ObjDesc);
381 AcpiDsInitObjectFromOp (
382 ACPI_WALK_STATE *WalkState,
383 ACPI_PARSE_OBJECT *Op,
385 ACPI_OPERAND_OBJECT **ObjDesc);
389 ACPI_WALK_STATE *WalkState,
390 ACPI_NAMESPACE_NODE *Node,
391 ACPI_PARSE_OBJECT *Op);
395 * dsutils - Parser/Interpreter interface utility routines
398 AcpiDsClearImplicitReturn (
399 ACPI_WALK_STATE *WalkState);
402 AcpiDsDoImplicitReturn (
403 ACPI_OPERAND_OBJECT *ReturnDesc,
404 ACPI_WALK_STATE *WalkState,
405 BOOLEAN AddReference);
409 ACPI_PARSE_OBJECT *Op,
410 ACPI_WALK_STATE *WalkState);
413 AcpiDsDeleteResultIfNotUsed (
414 ACPI_PARSE_OBJECT *Op,
415 ACPI_OPERAND_OBJECT *ResultObj,
416 ACPI_WALK_STATE *WalkState);
419 AcpiDsCreateOperand (
420 ACPI_WALK_STATE *WalkState,
421 ACPI_PARSE_OBJECT *Arg,
422 UINT32 ArgsRemaining);
425 AcpiDsCreateOperands (
426 ACPI_WALK_STATE *WalkState,
427 ACPI_PARSE_OBJECT *FirstArg);
430 AcpiDsResolveOperands (
431 ACPI_WALK_STATE *WalkState);
434 AcpiDsClearOperands (
435 ACPI_WALK_STATE *WalkState);
438 AcpiDsEvaluateNamePath (
439 ACPI_WALK_STATE *WalkState);
443 * dswscope - Scope Stack manipulation
446 AcpiDsScopeStackPush (
447 ACPI_NAMESPACE_NODE *Node,
448 ACPI_OBJECT_TYPE Type,
449 ACPI_WALK_STATE *WalkState);
453 AcpiDsScopeStackPop (
454 ACPI_WALK_STATE *WalkState);
457 AcpiDsScopeStackClear (
458 ACPI_WALK_STATE *WalkState);
462 * dswstate - parser WALK_STATE management routines
467 ACPI_WALK_STATE *WalkState);
472 ACPI_WALK_STATE *WalkState);
475 AcpiDsCreateWalkState (
476 ACPI_OWNER_ID OwnerId,
477 ACPI_PARSE_OBJECT *Origin,
478 ACPI_OPERAND_OBJECT *MthDesc,
479 ACPI_THREAD_STATE *Thread);
483 ACPI_WALK_STATE *WalkState,
484 ACPI_PARSE_OBJECT *Op,
485 ACPI_NAMESPACE_NODE *MethodNode,
488 ACPI_EVALUATE_INFO *Info,
492 AcpiDsObjStackPopAndDelete (
494 ACPI_WALK_STATE *WalkState);
497 AcpiDsDeleteWalkState (
498 ACPI_WALK_STATE *WalkState);
502 ACPI_THREAD_STATE *Thread);
505 AcpiDsPushWalkState (
506 ACPI_WALK_STATE *WalkState,
507 ACPI_THREAD_STATE *Thread);
510 AcpiDsResultStackClear (
511 ACPI_WALK_STATE *WalkState);
514 AcpiDsGetCurrentWalkState (
515 ACPI_THREAD_STATE *Thread);
519 ACPI_OPERAND_OBJECT **Object,
520 ACPI_WALK_STATE *WalkState);
524 ACPI_OPERAND_OBJECT *Object,
525 ACPI_WALK_STATE *WalkState);
527 #endif /* _ACDISPAT_H_ */