xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acdispat.h (revision 30082d0c)
1 /******************************************************************************
2  *
3  * Name: acdispat.h - dispatcher (parser to interpreter interface)
4  *       $Revision: 1.69 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 /*
127  * dsopcode - support for late evaluation
128  */
129 ACPI_STATUS
130 AcpiDsGetBufferFieldArguments (
131     ACPI_OPERAND_OBJECT     *ObjDesc);
132 
133 ACPI_STATUS
134 AcpiDsGetRegionArguments (
135     ACPI_OPERAND_OBJECT     *RgnDesc);
136 
137 ACPI_STATUS
138 AcpiDsGetBufferArguments (
139     ACPI_OPERAND_OBJECT     *ObjDesc);
140 
141 ACPI_STATUS
142 AcpiDsGetPackageArguments (
143     ACPI_OPERAND_OBJECT     *ObjDesc);
144 
145 ACPI_STATUS
146 AcpiDsEvalBufferFieldOperands (
147     ACPI_WALK_STATE         *WalkState,
148     ACPI_PARSE_OBJECT       *Op);
149 
150 ACPI_STATUS
151 AcpiDsEvalRegionOperands (
152     ACPI_WALK_STATE         *WalkState,
153     ACPI_PARSE_OBJECT       *Op);
154 
155 ACPI_STATUS
156 AcpiDsEvalDataObjectOperands (
157     ACPI_WALK_STATE         *WalkState,
158     ACPI_PARSE_OBJECT       *Op,
159     ACPI_OPERAND_OBJECT     *ObjDesc);
160 
161 ACPI_STATUS
162 AcpiDsInitializeRegion (
163     ACPI_HANDLE             ObjHandle);
164 
165 
166 /*
167  * dsctrl - Parser/Interpreter interface, control stack routines
168  */
169 ACPI_STATUS
170 AcpiDsExecBeginControlOp (
171     ACPI_WALK_STATE         *WalkState,
172     ACPI_PARSE_OBJECT       *Op);
173 
174 ACPI_STATUS
175 AcpiDsExecEndControlOp (
176     ACPI_WALK_STATE         *WalkState,
177     ACPI_PARSE_OBJECT       *Op);
178 
179 
180 /*
181  * dsexec - Parser/Interpreter interface, method execution callbacks
182  */
183 ACPI_STATUS
184 AcpiDsGetPredicateValue (
185     ACPI_WALK_STATE         *WalkState,
186     ACPI_OPERAND_OBJECT     *ResultObj);
187 
188 ACPI_STATUS
189 AcpiDsExecBeginOp (
190     ACPI_WALK_STATE         *WalkState,
191     ACPI_PARSE_OBJECT       **OutOp);
192 
193 ACPI_STATUS
194 AcpiDsExecEndOp (
195     ACPI_WALK_STATE         *State);
196 
197 
198 /*
199  * dsfield - Parser/Interpreter interface for AML fields
200  */
201 ACPI_STATUS
202 AcpiDsCreateField (
203     ACPI_PARSE_OBJECT       *Op,
204     ACPI_NAMESPACE_NODE     *RegionNode,
205     ACPI_WALK_STATE         *WalkState);
206 
207 ACPI_STATUS
208 AcpiDsCreateBankField (
209     ACPI_PARSE_OBJECT       *Op,
210     ACPI_NAMESPACE_NODE     *RegionNode,
211     ACPI_WALK_STATE         *WalkState);
212 
213 ACPI_STATUS
214 AcpiDsCreateIndexField (
215     ACPI_PARSE_OBJECT       *Op,
216     ACPI_NAMESPACE_NODE     *RegionNode,
217     ACPI_WALK_STATE         *WalkState);
218 
219 ACPI_STATUS
220 AcpiDsCreateBufferField (
221     ACPI_PARSE_OBJECT       *Op,
222     ACPI_WALK_STATE         *WalkState);
223 
224 ACPI_STATUS
225 AcpiDsInitFieldObjects (
226     ACPI_PARSE_OBJECT       *Op,
227     ACPI_WALK_STATE         *WalkState);
228 
229 
230 /*
231  * dsload - Parser/Interpreter interface, namespace load callbacks
232  */
233 ACPI_STATUS
234 AcpiDsLoad1BeginOp (
235     ACPI_WALK_STATE         *WalkState,
236     ACPI_PARSE_OBJECT       **OutOp);
237 
238 ACPI_STATUS
239 AcpiDsLoad1EndOp (
240     ACPI_WALK_STATE         *WalkState);
241 
242 ACPI_STATUS
243 AcpiDsLoad2BeginOp (
244     ACPI_WALK_STATE         *WalkState,
245     ACPI_PARSE_OBJECT       **OutOp);
246 
247 ACPI_STATUS
248 AcpiDsLoad2EndOp (
249     ACPI_WALK_STATE         *WalkState);
250 
251 ACPI_STATUS
252 AcpiDsInitCallbacks (
253     ACPI_WALK_STATE         *WalkState,
254     UINT32                  PassNumber);
255 
256 
257 /*
258  * dsmthdat - method data (locals/args)
259  */
260 ACPI_STATUS
261 AcpiDsStoreObjectToLocal (
262     UINT16                  Opcode,
263     UINT32                  Index,
264     ACPI_OPERAND_OBJECT     *SrcDesc,
265     ACPI_WALK_STATE         *WalkState);
266 
267 ACPI_STATUS
268 AcpiDsMethodDataGetEntry (
269     UINT16                  Opcode,
270     UINT32                  Index,
271     ACPI_WALK_STATE         *WalkState,
272     ACPI_OPERAND_OBJECT     ***Node);
273 
274 void
275 AcpiDsMethodDataDeleteAll (
276     ACPI_WALK_STATE         *WalkState);
277 
278 BOOLEAN
279 AcpiDsIsMethodValue (
280     ACPI_OPERAND_OBJECT     *ObjDesc);
281 
282 ACPI_STATUS
283 AcpiDsMethodDataGetValue (
284     UINT16                  Opcode,
285     UINT32                  Index,
286     ACPI_WALK_STATE         *WalkState,
287     ACPI_OPERAND_OBJECT     **DestDesc);
288 
289 ACPI_STATUS
290 AcpiDsMethodDataInitArgs (
291     ACPI_OPERAND_OBJECT     **Params,
292     UINT32                  MaxParamCount,
293     ACPI_WALK_STATE         *WalkState);
294 
295 ACPI_STATUS
296 AcpiDsMethodDataGetNode (
297     UINT16                  Opcode,
298     UINT32                  Index,
299     ACPI_WALK_STATE         *WalkState,
300     ACPI_NAMESPACE_NODE     **Node);
301 
302 void
303 AcpiDsMethodDataInit (
304     ACPI_WALK_STATE         *WalkState);
305 
306 
307 /*
308  * dsmethod - Parser/Interpreter interface - control method parsing
309  */
310 ACPI_STATUS
311 AcpiDsParseMethod (
312     ACPI_NAMESPACE_NODE     *Node);
313 
314 ACPI_STATUS
315 AcpiDsCallControlMethod (
316     ACPI_THREAD_STATE       *Thread,
317     ACPI_WALK_STATE         *WalkState,
318     ACPI_PARSE_OBJECT       *Op);
319 
320 ACPI_STATUS
321 AcpiDsRestartControlMethod (
322     ACPI_WALK_STATE         *WalkState,
323     ACPI_OPERAND_OBJECT     *ReturnDesc);
324 
325 void
326 AcpiDsTerminateControlMethod (
327     ACPI_WALK_STATE         *WalkState);
328 
329 ACPI_STATUS
330 AcpiDsBeginMethodExecution (
331     ACPI_NAMESPACE_NODE     *MethodNode,
332     ACPI_OPERAND_OBJECT     *ObjDesc,
333     ACPI_NAMESPACE_NODE     *CallingMethodNode);
334 
335 ACPI_STATUS
336 AcpiDsMethodError (
337     ACPI_STATUS             Status,
338     ACPI_WALK_STATE         *WalkState);
339 
340 /*
341  * dsinit
342  */
343 ACPI_STATUS
344 AcpiDsInitializeObjects (
345     ACPI_TABLE_DESC         *TableDesc,
346     ACPI_NAMESPACE_NODE     *StartNode);
347 
348 
349 /*
350  * dsobject - Parser/Interpreter interface - object initialization and conversion
351  */
352 ACPI_STATUS
353 AcpiDsBuildInternalBufferObj (
354     ACPI_WALK_STATE         *WalkState,
355     ACPI_PARSE_OBJECT       *Op,
356     UINT32                  BufferLength,
357     ACPI_OPERAND_OBJECT     **ObjDescPtr);
358 
359 ACPI_STATUS
360 AcpiDsBuildInternalPackageObj (
361     ACPI_WALK_STATE         *WalkState,
362     ACPI_PARSE_OBJECT       *op,
363     UINT32                  PackageLength,
364     ACPI_OPERAND_OBJECT     **ObjDesc);
365 
366 ACPI_STATUS
367 AcpiDsInitObjectFromOp (
368     ACPI_WALK_STATE         *WalkState,
369     ACPI_PARSE_OBJECT       *Op,
370     UINT16                  Opcode,
371     ACPI_OPERAND_OBJECT     **ObjDesc);
372 
373 ACPI_STATUS
374 AcpiDsCreateNode (
375     ACPI_WALK_STATE         *WalkState,
376     ACPI_NAMESPACE_NODE     *Node,
377     ACPI_PARSE_OBJECT       *Op);
378 
379 
380 /*
381  * dsutils - Parser/Interpreter interface utility routines
382  */
383 void
384 AcpiDsClearImplicitReturn (
385     ACPI_WALK_STATE         *WalkState);
386 
387 BOOLEAN
388 AcpiDsDoImplicitReturn (
389     ACPI_OPERAND_OBJECT     *ReturnDesc,
390     ACPI_WALK_STATE         *WalkState,
391     BOOLEAN                 AddReference);
392 
393 BOOLEAN
394 AcpiDsIsResultUsed (
395     ACPI_PARSE_OBJECT       *Op,
396     ACPI_WALK_STATE         *WalkState);
397 
398 void
399 AcpiDsDeleteResultIfNotUsed (
400     ACPI_PARSE_OBJECT       *Op,
401     ACPI_OPERAND_OBJECT     *ResultObj,
402     ACPI_WALK_STATE         *WalkState);
403 
404 ACPI_STATUS
405 AcpiDsCreateOperand (
406     ACPI_WALK_STATE         *WalkState,
407     ACPI_PARSE_OBJECT       *Arg,
408     UINT32                  ArgsRemaining);
409 
410 ACPI_STATUS
411 AcpiDsCreateOperands (
412     ACPI_WALK_STATE         *WalkState,
413     ACPI_PARSE_OBJECT       *FirstArg);
414 
415 ACPI_STATUS
416 AcpiDsResolveOperands (
417     ACPI_WALK_STATE         *WalkState);
418 
419 void
420 AcpiDsClearOperands (
421     ACPI_WALK_STATE         *WalkState);
422 
423 
424 /*
425  * dswscope - Scope Stack manipulation
426  */
427 ACPI_STATUS
428 AcpiDsScopeStackPush (
429     ACPI_NAMESPACE_NODE     *Node,
430     ACPI_OBJECT_TYPE        Type,
431     ACPI_WALK_STATE         *WalkState);
432 
433 
434 ACPI_STATUS
435 AcpiDsScopeStackPop (
436     ACPI_WALK_STATE         *WalkState);
437 
438 void
439 AcpiDsScopeStackClear (
440     ACPI_WALK_STATE         *WalkState);
441 
442 
443 /*
444  * dswstate - parser WALK_STATE management routines
445  */
446 ACPI_STATUS
447 AcpiDsObjStackPush (
448     void                    *Object,
449     ACPI_WALK_STATE         *WalkState);
450 
451 ACPI_STATUS
452 AcpiDsObjStackPop (
453     UINT32                  PopCount,
454     ACPI_WALK_STATE         *WalkState);
455 
456 ACPI_WALK_STATE *
457 AcpiDsCreateWalkState (
458     ACPI_OWNER_ID           OwnerId,
459     ACPI_PARSE_OBJECT       *Origin,
460     ACPI_OPERAND_OBJECT     *MthDesc,
461     ACPI_THREAD_STATE       *Thread);
462 
463 ACPI_STATUS
464 AcpiDsInitAmlWalk (
465     ACPI_WALK_STATE         *WalkState,
466     ACPI_PARSE_OBJECT       *Op,
467     ACPI_NAMESPACE_NODE     *MethodNode,
468     UINT8                   *AmlStart,
469     UINT32                  AmlLength,
470     ACPI_PARAMETER_INFO     *Info,
471     UINT8                   PassNumber);
472 
473 ACPI_STATUS
474 AcpiDsObjStackPopAndDelete (
475     UINT32                  PopCount,
476     ACPI_WALK_STATE         *WalkState);
477 
478 void
479 AcpiDsDeleteWalkState (
480     ACPI_WALK_STATE         *WalkState);
481 
482 ACPI_WALK_STATE *
483 AcpiDsPopWalkState (
484     ACPI_THREAD_STATE       *Thread);
485 
486 void
487 AcpiDsPushWalkState (
488     ACPI_WALK_STATE         *WalkState,
489     ACPI_THREAD_STATE       *Thread);
490 
491 ACPI_STATUS
492 AcpiDsResultStackPop (
493     ACPI_WALK_STATE         *WalkState);
494 
495 ACPI_STATUS
496 AcpiDsResultStackPush (
497     ACPI_WALK_STATE         *WalkState);
498 
499 ACPI_STATUS
500 AcpiDsResultStackClear (
501     ACPI_WALK_STATE         *WalkState);
502 
503 ACPI_WALK_STATE *
504 AcpiDsGetCurrentWalkState (
505     ACPI_THREAD_STATE       *Thread);
506 
507 ACPI_STATUS
508 AcpiDsResultRemove (
509     ACPI_OPERAND_OBJECT     **Object,
510     UINT32                  Index,
511     ACPI_WALK_STATE         *WalkState);
512 
513 ACPI_STATUS
514 AcpiDsResultPop (
515     ACPI_OPERAND_OBJECT     **Object,
516     ACPI_WALK_STATE         *WalkState);
517 
518 ACPI_STATUS
519 AcpiDsResultPush (
520     ACPI_OPERAND_OBJECT     *Object,
521     ACPI_WALK_STATE         *WalkState);
522 
523 ACPI_STATUS
524 AcpiDsResultPopFromBottom (
525     ACPI_OPERAND_OBJECT     **Object,
526     ACPI_WALK_STATE         *WalkState);
527 
528 #endif /* _ACDISPAT_H_ */
529