1 /******************************************************************************
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
122 #define NAMEOF_LOCAL_NTE "__L0"
123 #define NAMEOF_ARG_NTE "__A0"
126 /* Common interfaces */
131 ACPI_WALK_STATE *WalkState);
136 ACPI_WALK_STATE *WalkState);
139 AcpiDsObjStackGetValue (
141 ACPI_WALK_STATE *WalkState);
144 AcpiDsObjStackPopObject (
145 ACPI_OPERAND_OBJECT **Object,
146 ACPI_WALK_STATE *WalkState);
149 /* dsopcode - support for late evaluation */
152 AcpiDsExecuteArguments (
153 ACPI_NAMESPACE_NODE *Node,
154 ACPI_NAMESPACE_NODE *ScopeNode,
159 AcpiDsGetBufferFieldArguments (
160 ACPI_OPERAND_OBJECT *ObjDesc);
163 AcpiDsGetRegionArguments (
164 ACPI_OPERAND_OBJECT *RgnDesc);
167 AcpiDsGetBufferArguments (
168 ACPI_OPERAND_OBJECT *ObjDesc);
171 AcpiDsGetPackageArguments (
172 ACPI_OPERAND_OBJECT *ObjDesc);
175 AcpiDsInitBufferField (
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);
184 AcpiDsEvalBufferFieldOperands (
185 ACPI_WALK_STATE *WalkState,
186 ACPI_PARSE_OBJECT *Op);
189 AcpiDsEvalRegionOperands (
190 ACPI_WALK_STATE *WalkState,
191 ACPI_PARSE_OBJECT *Op);
194 AcpiDsEvalDataObjectOperands (
195 ACPI_WALK_STATE *WalkState,
196 ACPI_PARSE_OBJECT *Op,
197 ACPI_OPERAND_OBJECT *ObjDesc);
200 AcpiDsInitializeRegion (
201 ACPI_HANDLE ObjHandle);
204 /* dsctrl - Parser/Interpreter interface, control stack routines */
208 AcpiDsExecBeginControlOp (
209 ACPI_WALK_STATE *WalkState,
210 ACPI_PARSE_OBJECT *Op);
213 AcpiDsExecEndControlOp (
214 ACPI_WALK_STATE *WalkState,
215 ACPI_PARSE_OBJECT *Op);
218 /* dsexec - Parser/Interpreter interface, method execution callbacks */
222 AcpiDsGetPredicateValue (
223 ACPI_WALK_STATE *WalkState,
224 ACPI_OPERAND_OBJECT *ResultObj);
228 ACPI_WALK_STATE *WalkState,
229 ACPI_PARSE_OBJECT **OutOp);
233 ACPI_WALK_STATE *State);
236 /* dsfield - Parser/Interpreter interface for AML fields */
239 AcpiDsGetFieldNames (
240 ACPI_CREATE_FIELD_INFO *Info,
241 ACPI_WALK_STATE *WalkState,
242 ACPI_PARSE_OBJECT *Arg);
246 ACPI_PARSE_OBJECT *Op,
247 ACPI_NAMESPACE_NODE *RegionNode,
248 ACPI_WALK_STATE *WalkState);
251 AcpiDsCreateBankField (
252 ACPI_PARSE_OBJECT *Op,
253 ACPI_NAMESPACE_NODE *RegionNode,
254 ACPI_WALK_STATE *WalkState);
257 AcpiDsCreateIndexField (
258 ACPI_PARSE_OBJECT *Op,
259 ACPI_NAMESPACE_NODE *RegionNode,
260 ACPI_WALK_STATE *WalkState);
263 AcpiDsCreateBufferField (
264 ACPI_PARSE_OBJECT *Op,
265 ACPI_WALK_STATE *WalkState);
268 AcpiDsInitFieldObjects (
269 ACPI_PARSE_OBJECT *Op,
270 ACPI_WALK_STATE *WalkState);
273 /* dsload - Parser/Interpreter interface, namespace load callbacks */
277 ACPI_WALK_STATE *WalkState,
278 ACPI_PARSE_OBJECT **OutOp);
282 ACPI_WALK_STATE *WalkState);
286 ACPI_WALK_STATE *WalkState,
287 ACPI_PARSE_OBJECT **OutOp);
291 ACPI_WALK_STATE *WalkState);
294 AcpiDsInitCallbacks (
295 ACPI_WALK_STATE *WalkState,
299 /* dsmthdat - method data (locals/args) */
303 AcpiDsStoreObjectToLocal (
306 ACPI_OPERAND_OBJECT *SrcDesc,
307 ACPI_WALK_STATE *WalkState);
310 AcpiDsMethodDataGetEntry (
313 ACPI_WALK_STATE *WalkState,
314 ACPI_OPERAND_OBJECT ***Node);
317 AcpiDsMethodDataDeleteAll (
318 ACPI_WALK_STATE *WalkState);
321 AcpiDsIsMethodValue (
322 ACPI_OPERAND_OBJECT *ObjDesc);
325 AcpiDsMethodDataGetType (
328 ACPI_WALK_STATE *WalkState);
331 AcpiDsMethodDataGetValue (
334 ACPI_WALK_STATE *WalkState,
335 ACPI_OPERAND_OBJECT **DestDesc);
338 AcpiDsMethodDataDeleteValue (
341 ACPI_WALK_STATE *WalkState);
344 AcpiDsMethodDataInitArgs (
345 ACPI_OPERAND_OBJECT **Params,
346 UINT32 MaxParamCount,
347 ACPI_WALK_STATE *WalkState);
350 AcpiDsMethodDataGetNode (
353 ACPI_WALK_STATE *WalkState,
354 ACPI_NAMESPACE_NODE **Node);
357 AcpiDsMethodDataInit (
358 ACPI_WALK_STATE *WalkState);
361 AcpiDsMethodDataSetValue (
364 ACPI_OPERAND_OBJECT *Object,
365 ACPI_WALK_STATE *WalkState);
368 /* dsmethod - Parser/Interpreter interface - control method parsing */
372 ACPI_HANDLE ObjHandle);
375 AcpiDsCallControlMethod (
376 ACPI_THREAD_STATE *Thread,
377 ACPI_WALK_STATE *WalkState,
378 ACPI_PARSE_OBJECT *Op);
381 AcpiDsRestartControlMethod (
382 ACPI_WALK_STATE *WalkState,
383 ACPI_OPERAND_OBJECT *ReturnDesc);
386 AcpiDsTerminateControlMethod (
387 ACPI_WALK_STATE *WalkState);
390 AcpiDsBeginMethodExecution (
391 ACPI_NAMESPACE_NODE *MethodNode,
392 ACPI_OPERAND_OBJECT *ObjDesc,
393 ACPI_NAMESPACE_NODE *CallingMethodNode);
396 /* dsobj - Parser/Interpreter interface - object initialization and conversion */
399 AcpiDsInitOneObject (
400 ACPI_HANDLE ObjHandle,
406 AcpiDsInitializeObjects (
407 ACPI_TABLE_DESC *TableDesc,
408 ACPI_NAMESPACE_NODE *StartNode);
411 AcpiDsBuildInternalBufferObj (
412 ACPI_WALK_STATE *WalkState,
413 ACPI_PARSE_OBJECT *Op,
415 ACPI_OPERAND_OBJECT **ObjDescPtr);
418 AcpiDsBuildInternalPackageObj (
419 ACPI_WALK_STATE *WalkState,
420 ACPI_PARSE_OBJECT *op,
421 UINT32 PackageLength,
422 ACPI_OPERAND_OBJECT **ObjDesc);
425 AcpiDsBuildInternalObject (
426 ACPI_WALK_STATE *WalkState,
427 ACPI_PARSE_OBJECT *Op,
428 ACPI_OPERAND_OBJECT **ObjDescPtr);
431 AcpiDsInitObjectFromOp (
432 ACPI_WALK_STATE *WalkState,
433 ACPI_PARSE_OBJECT *Op,
435 ACPI_OPERAND_OBJECT **ObjDesc);
439 ACPI_WALK_STATE *WalkState,
440 ACPI_NAMESPACE_NODE *Node,
441 ACPI_PARSE_OBJECT *Op);
444 /* dsutils - Parser/Interpreter interface utility routines */
448 ACPI_PARSE_OBJECT *Op,
449 ACPI_WALK_STATE *WalkState);
452 AcpiDsDeleteResultIfNotUsed (
453 ACPI_PARSE_OBJECT *Op,
454 ACPI_OPERAND_OBJECT *ResultObj,
455 ACPI_WALK_STATE *WalkState);
458 AcpiDsCreateOperand (
459 ACPI_WALK_STATE *WalkState,
460 ACPI_PARSE_OBJECT *Arg,
461 UINT32 ArgsRemaining);
464 AcpiDsCreateOperands (
465 ACPI_WALK_STATE *WalkState,
466 ACPI_PARSE_OBJECT *FirstArg);
469 AcpiDsResolveOperands (
470 ACPI_WALK_STATE *WalkState);
473 AcpiDsClearOperands (
474 ACPI_WALK_STATE *WalkState);
478 * dswscope - Scope Stack manipulation
482 AcpiDsScopeStackPush (
483 ACPI_NAMESPACE_NODE *Node,
484 ACPI_OBJECT_TYPE Type,
485 ACPI_WALK_STATE *WalkState);
489 AcpiDsScopeStackPop (
490 ACPI_WALK_STATE *WalkState);
493 AcpiDsScopeStackClear (
494 ACPI_WALK_STATE *WalkState);
497 /* dswstate - parser WALK_STATE management routines */
500 AcpiDsCreateWalkState (
501 ACPI_OWNER_ID OwnerId,
502 ACPI_PARSE_OBJECT *Origin,
503 ACPI_OPERAND_OBJECT *MthDesc,
504 ACPI_THREAD_STATE *Thread);
508 ACPI_WALK_STATE *WalkState,
509 ACPI_PARSE_OBJECT *Op,
510 ACPI_NAMESPACE_NODE *MethodNode,
513 ACPI_OPERAND_OBJECT **Params,
514 ACPI_OPERAND_OBJECT **ReturnObjDesc,
518 AcpiDsObjStackDeleteAll (
519 ACPI_WALK_STATE *WalkState);
522 AcpiDsObjStackPopAndDelete (
524 ACPI_WALK_STATE *WalkState);
527 AcpiDsDeleteWalkState (
528 ACPI_WALK_STATE *WalkState);
532 ACPI_THREAD_STATE *Thread);
535 AcpiDsPushWalkState (
536 ACPI_WALK_STATE *WalkState,
537 ACPI_THREAD_STATE *Thread);
540 AcpiDsResultStackPop (
541 ACPI_WALK_STATE *WalkState);
544 AcpiDsResultStackPush (
545 ACPI_WALK_STATE *WalkState);
548 AcpiDsResultStackClear (
549 ACPI_WALK_STATE *WalkState);
552 AcpiDsGetCurrentWalkState (
553 ACPI_THREAD_STATE *Thread);
556 AcpiDsDeleteWalkStateCache (
563 ACPI_WALK_STATE *WalkState);
567 ACPI_OPERAND_OBJECT **Object,
569 ACPI_WALK_STATE *WalkState);
573 ACPI_OPERAND_OBJECT **Object,
574 ACPI_WALK_STATE *WalkState);
578 ACPI_OPERAND_OBJECT *Object,
579 ACPI_WALK_STATE *WalkState);
582 AcpiDsResultPopFromBottom (
583 ACPI_OPERAND_OBJECT **Object,
584 ACPI_WALK_STATE *WalkState);
586 #endif /* _ACDISPAT_H_ */