1 /******************************************************************************
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
156 #define NAMEOF_LOCAL_NTE "__L0"
157 #define NAMEOF_ARG_NTE "__A0"
161 * dsargs - execution of dynamic arguments for static objects
164 AcpiDsGetBufferFieldArguments (
165 ACPI_OPERAND_OBJECT
*ObjDesc
);
168 AcpiDsGetBankFieldArguments (
169 ACPI_OPERAND_OBJECT
*ObjDesc
);
172 AcpiDsGetRegionArguments (
173 ACPI_OPERAND_OBJECT
*RgnDesc
);
176 AcpiDsGetBufferArguments (
177 ACPI_OPERAND_OBJECT
*ObjDesc
);
180 AcpiDsGetPackageArguments (
181 ACPI_OPERAND_OBJECT
*ObjDesc
);
185 * dscontrol - support for execution control opcodes
188 AcpiDsExecBeginControlOp (
189 ACPI_WALK_STATE
*WalkState
,
190 ACPI_PARSE_OBJECT
*Op
);
193 AcpiDsExecEndControlOp (
194 ACPI_WALK_STATE
*WalkState
,
195 ACPI_PARSE_OBJECT
*Op
);
199 * dsopcode - support for late operand evaluation
202 AcpiDsEvalBufferFieldOperands (
203 ACPI_WALK_STATE
*WalkState
,
204 ACPI_PARSE_OBJECT
*Op
);
207 AcpiDsEvalRegionOperands (
208 ACPI_WALK_STATE
*WalkState
,
209 ACPI_PARSE_OBJECT
*Op
);
212 AcpiDsEvalTableRegionOperands (
213 ACPI_WALK_STATE
*WalkState
,
214 ACPI_PARSE_OBJECT
*Op
);
217 AcpiDsEvalDataObjectOperands (
218 ACPI_WALK_STATE
*WalkState
,
219 ACPI_PARSE_OBJECT
*Op
,
220 ACPI_OPERAND_OBJECT
*ObjDesc
);
223 AcpiDsEvalBankFieldOperands (
224 ACPI_WALK_STATE
*WalkState
,
225 ACPI_PARSE_OBJECT
*Op
);
228 AcpiDsInitializeRegion (
229 ACPI_HANDLE ObjHandle
);
233 * dsexec - Parser/Interpreter interface, method execution callbacks
236 AcpiDsGetPredicateValue (
237 ACPI_WALK_STATE
*WalkState
,
238 ACPI_OPERAND_OBJECT
*ResultObj
);
242 ACPI_WALK_STATE
*WalkState
,
243 ACPI_PARSE_OBJECT
**OutOp
);
247 ACPI_WALK_STATE
*State
);
251 * dsfield - Parser/Interpreter interface for AML fields
255 ACPI_PARSE_OBJECT
*Op
,
256 ACPI_NAMESPACE_NODE
*RegionNode
,
257 ACPI_WALK_STATE
*WalkState
);
260 AcpiDsCreateBankField (
261 ACPI_PARSE_OBJECT
*Op
,
262 ACPI_NAMESPACE_NODE
*RegionNode
,
263 ACPI_WALK_STATE
*WalkState
);
266 AcpiDsCreateIndexField (
267 ACPI_PARSE_OBJECT
*Op
,
268 ACPI_NAMESPACE_NODE
*RegionNode
,
269 ACPI_WALK_STATE
*WalkState
);
272 AcpiDsCreateBufferField (
273 ACPI_PARSE_OBJECT
*Op
,
274 ACPI_WALK_STATE
*WalkState
);
277 AcpiDsInitFieldObjects (
278 ACPI_PARSE_OBJECT
*Op
,
279 ACPI_WALK_STATE
*WalkState
);
283 * dsload - Parser/Interpreter interface
286 AcpiDsInitCallbacks (
287 ACPI_WALK_STATE
*WalkState
,
290 /* dsload - pass 1 namespace load callbacks */
294 ACPI_WALK_STATE
*WalkState
,
295 ACPI_PARSE_OBJECT
**OutOp
);
299 ACPI_WALK_STATE
*WalkState
);
302 /* dsload - pass 2 namespace load callbacks */
306 ACPI_WALK_STATE
*WalkState
,
307 ACPI_PARSE_OBJECT
**OutOp
);
311 ACPI_WALK_STATE
*WalkState
);
315 * dsmthdat - method data (locals/args)
318 AcpiDsStoreObjectToLocal (
321 ACPI_OPERAND_OBJECT
*SrcDesc
,
322 ACPI_WALK_STATE
*WalkState
);
325 AcpiDsMethodDataGetEntry (
328 ACPI_WALK_STATE
*WalkState
,
329 ACPI_OPERAND_OBJECT
***Node
);
332 AcpiDsMethodDataDeleteAll (
333 ACPI_WALK_STATE
*WalkState
);
336 AcpiDsIsMethodValue (
337 ACPI_OPERAND_OBJECT
*ObjDesc
);
340 AcpiDsMethodDataGetValue (
343 ACPI_WALK_STATE
*WalkState
,
344 ACPI_OPERAND_OBJECT
**DestDesc
);
347 AcpiDsMethodDataInitArgs (
348 ACPI_OPERAND_OBJECT
**Params
,
349 UINT32 MaxParamCount
,
350 ACPI_WALK_STATE
*WalkState
);
353 AcpiDsMethodDataGetNode (
356 ACPI_WALK_STATE
*WalkState
,
357 ACPI_NAMESPACE_NODE
**Node
);
360 AcpiDsMethodDataInit (
361 ACPI_WALK_STATE
*WalkState
);
365 * dsmethod - Parser/Interpreter interface - control method parsing
368 AcpiDsAutoSerializeMethod (
369 ACPI_NAMESPACE_NODE
*Node
,
370 ACPI_OPERAND_OBJECT
*ObjDesc
);
373 AcpiDsCallControlMethod (
374 ACPI_THREAD_STATE
*Thread
,
375 ACPI_WALK_STATE
*WalkState
,
376 ACPI_PARSE_OBJECT
*Op
);
379 AcpiDsRestartControlMethod (
380 ACPI_WALK_STATE
*WalkState
,
381 ACPI_OPERAND_OBJECT
*ReturnDesc
);
384 AcpiDsTerminateControlMethod (
385 ACPI_OPERAND_OBJECT
*MethodDesc
,
386 ACPI_WALK_STATE
*WalkState
);
389 AcpiDsBeginMethodExecution (
390 ACPI_NAMESPACE_NODE
*MethodNode
,
391 ACPI_OPERAND_OBJECT
*ObjDesc
,
392 ACPI_WALK_STATE
*WalkState
);
397 ACPI_WALK_STATE
*WalkState
);
403 AcpiDsInitializeObjects (
405 ACPI_NAMESPACE_NODE
*StartNode
);
409 * dsobject - Parser/Interpreter interface - object initialization and conversion
412 AcpiDsBuildInternalBufferObj (
413 ACPI_WALK_STATE
*WalkState
,
414 ACPI_PARSE_OBJECT
*Op
,
416 ACPI_OPERAND_OBJECT
**ObjDescPtr
);
419 AcpiDsBuildInternalPackageObj (
420 ACPI_WALK_STATE
*WalkState
,
421 ACPI_PARSE_OBJECT
*op
,
422 UINT32 PackageLength
,
423 ACPI_OPERAND_OBJECT
**ObjDesc
);
426 AcpiDsInitObjectFromOp (
427 ACPI_WALK_STATE
*WalkState
,
428 ACPI_PARSE_OBJECT
*Op
,
430 ACPI_OPERAND_OBJECT
**ObjDesc
);
434 ACPI_WALK_STATE
*WalkState
,
435 ACPI_NAMESPACE_NODE
*Node
,
436 ACPI_PARSE_OBJECT
*Op
);
440 * dsutils - Parser/Interpreter interface utility routines
443 AcpiDsClearImplicitReturn (
444 ACPI_WALK_STATE
*WalkState
);
447 AcpiDsDoImplicitReturn (
448 ACPI_OPERAND_OBJECT
*ReturnDesc
,
449 ACPI_WALK_STATE
*WalkState
,
450 BOOLEAN AddReference
);
454 ACPI_PARSE_OBJECT
*Op
,
455 ACPI_WALK_STATE
*WalkState
);
458 AcpiDsDeleteResultIfNotUsed (
459 ACPI_PARSE_OBJECT
*Op
,
460 ACPI_OPERAND_OBJECT
*ResultObj
,
461 ACPI_WALK_STATE
*WalkState
);
464 AcpiDsCreateOperand (
465 ACPI_WALK_STATE
*WalkState
,
466 ACPI_PARSE_OBJECT
*Arg
,
467 UINT32 ArgsRemaining
);
470 AcpiDsCreateOperands (
471 ACPI_WALK_STATE
*WalkState
,
472 ACPI_PARSE_OBJECT
*FirstArg
);
475 AcpiDsResolveOperands (
476 ACPI_WALK_STATE
*WalkState
);
479 AcpiDsClearOperands (
480 ACPI_WALK_STATE
*WalkState
);
483 AcpiDsEvaluateNamePath (
484 ACPI_WALK_STATE
*WalkState
);
488 * dswscope - Scope Stack manipulation
491 AcpiDsScopeStackPush (
492 ACPI_NAMESPACE_NODE
*Node
,
493 ACPI_OBJECT_TYPE Type
,
494 ACPI_WALK_STATE
*WalkState
);
498 AcpiDsScopeStackPop (
499 ACPI_WALK_STATE
*WalkState
);
502 AcpiDsScopeStackClear (
503 ACPI_WALK_STATE
*WalkState
);
507 * dswstate - parser WALK_STATE management routines
512 ACPI_WALK_STATE
*WalkState
);
517 ACPI_WALK_STATE
*WalkState
);
520 AcpiDsCreateWalkState (
521 ACPI_OWNER_ID OwnerId
,
522 ACPI_PARSE_OBJECT
*Origin
,
523 ACPI_OPERAND_OBJECT
*MthDesc
,
524 ACPI_THREAD_STATE
*Thread
);
528 ACPI_WALK_STATE
*WalkState
,
529 ACPI_PARSE_OBJECT
*Op
,
530 ACPI_NAMESPACE_NODE
*MethodNode
,
533 ACPI_EVALUATE_INFO
*Info
,
537 AcpiDsObjStackPopAndDelete (
539 ACPI_WALK_STATE
*WalkState
);
542 AcpiDsDeleteWalkState (
543 ACPI_WALK_STATE
*WalkState
);
547 ACPI_THREAD_STATE
*Thread
);
550 AcpiDsPushWalkState (
551 ACPI_WALK_STATE
*WalkState
,
552 ACPI_THREAD_STATE
*Thread
);
555 AcpiDsResultStackClear (
556 ACPI_WALK_STATE
*WalkState
);
559 AcpiDsGetCurrentWalkState (
560 ACPI_THREAD_STATE
*Thread
);
564 ACPI_OPERAND_OBJECT
**Object
,
565 ACPI_WALK_STATE
*WalkState
);
569 ACPI_OPERAND_OBJECT
*Object
,
570 ACPI_WALK_STATE
*WalkState
);
574 * dsdebug - parser debugging routines
577 AcpiDsDumpMethodStack (
579 ACPI_WALK_STATE
*WalkState
,
580 ACPI_PARSE_OBJECT
*Op
);
582 #endif /* _ACDISPAT_H_ */