xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/dispatcher/dsargs.c (revision f2df0cfe93a902842f6f4629ff614f5b3f9bf687)
1 /******************************************************************************
2  *
3  * Module Name: dsargs - Support for execution of dynamic arguments for static
4  *                       objects (regions, fields, buffer fields, etc.)
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2016, 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 #include "acpi.h"
118 #include "accommon.h"
119 #include "acparser.h"
120 #include "amlcode.h"
121 #include "acdispat.h"
122 #include "acnamesp.h"
123 
124 #define _COMPONENT          ACPI_DISPATCHER
125         ACPI_MODULE_NAME    ("dsargs")
126 
127 /* Local prototypes */
128 
129 static ACPI_STATUS
130 AcpiDsExecuteArguments (
131     ACPI_NAMESPACE_NODE     *Node,
132     ACPI_NAMESPACE_NODE     *ScopeNode,
133     UINT32                  AmlLength,
134     UINT8                   *AmlStart);
135 
136 
137 /*******************************************************************************
138  *
139  * FUNCTION:    AcpiDsExecuteArguments
140  *
141  * PARAMETERS:  Node                - Object NS node
142  *              ScopeNode           - Parent NS node
143  *              AmlLength           - Length of executable AML
144  *              AmlStart            - Pointer to the AML
145  *
146  * RETURN:      Status.
147  *
148  * DESCRIPTION: Late (deferred) execution of region or field arguments
149  *
150  ******************************************************************************/
151 
152 static ACPI_STATUS
153 AcpiDsExecuteArguments (
154     ACPI_NAMESPACE_NODE     *Node,
155     ACPI_NAMESPACE_NODE     *ScopeNode,
156     UINT32                  AmlLength,
157     UINT8                   *AmlStart)
158 {
159     ACPI_STATUS             Status;
160     ACPI_PARSE_OBJECT       *Op;
161     ACPI_WALK_STATE         *WalkState;
162 
163 
164     ACPI_FUNCTION_TRACE (DsExecuteArguments);
165 
166 
167     /* Allocate a new parser op to be the root of the parsed tree */
168 
169     Op = AcpiPsAllocOp (AML_INT_EVAL_SUBTREE_OP, AmlStart);
170     if (!Op)
171     {
172         return_ACPI_STATUS (AE_NO_MEMORY);
173     }
174 
175     /* Save the Node for use in AcpiPsParseAml */
176 
177     Op->Common.Node = ScopeNode;
178 
179     /* Create and initialize a new parser state */
180 
181     WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
182     if (!WalkState)
183     {
184         Status = AE_NO_MEMORY;
185         goto Cleanup;
186     }
187 
188     Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, AmlStart,
189         AmlLength, NULL, ACPI_IMODE_LOAD_PASS1);
190     if (ACPI_FAILURE (Status))
191     {
192         AcpiDsDeleteWalkState (WalkState);
193         goto Cleanup;
194     }
195 
196     /* Mark this parse as a deferred opcode */
197 
198     WalkState->ParseFlags = ACPI_PARSE_DEFERRED_OP;
199     WalkState->DeferredNode = Node;
200 
201     /* Pass1: Parse the entire declaration */
202 
203     Status = AcpiPsParseAml (WalkState);
204     if (ACPI_FAILURE (Status))
205     {
206         goto Cleanup;
207     }
208 
209     /* Get and init the Op created above */
210 
211     Op->Common.Node = Node;
212     AcpiPsDeleteParseTree (Op);
213 
214     /* Evaluate the deferred arguments */
215 
216     Op = AcpiPsAllocOp (AML_INT_EVAL_SUBTREE_OP, AmlStart);
217     if (!Op)
218     {
219         return_ACPI_STATUS (AE_NO_MEMORY);
220     }
221 
222     Op->Common.Node = ScopeNode;
223 
224     /* Create and initialize a new parser state */
225 
226     WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
227     if (!WalkState)
228     {
229         Status = AE_NO_MEMORY;
230         goto Cleanup;
231     }
232 
233     /* Execute the opcode and arguments */
234 
235     Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, AmlStart,
236         AmlLength, NULL, ACPI_IMODE_EXECUTE);
237     if (ACPI_FAILURE (Status))
238     {
239         AcpiDsDeleteWalkState (WalkState);
240         goto Cleanup;
241     }
242 
243     /* Mark this execution as a deferred opcode */
244 
245     WalkState->DeferredNode = Node;
246     Status = AcpiPsParseAml (WalkState);
247 
248 Cleanup:
249     AcpiPsDeleteParseTree (Op);
250     return_ACPI_STATUS (Status);
251 }
252 
253 
254 /*******************************************************************************
255  *
256  * FUNCTION:    AcpiDsGetBufferFieldArguments
257  *
258  * PARAMETERS:  ObjDesc         - A valid BufferField object
259  *
260  * RETURN:      Status.
261  *
262  * DESCRIPTION: Get BufferField Buffer and Index. This implements the late
263  *              evaluation of these field attributes.
264  *
265  ******************************************************************************/
266 
267 ACPI_STATUS
268 AcpiDsGetBufferFieldArguments (
269     ACPI_OPERAND_OBJECT     *ObjDesc)
270 {
271     ACPI_OPERAND_OBJECT     *ExtraDesc;
272     ACPI_NAMESPACE_NODE     *Node;
273     ACPI_STATUS             Status;
274 
275 
276     ACPI_FUNCTION_TRACE_PTR (DsGetBufferFieldArguments, ObjDesc);
277 
278 
279     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
280     {
281         return_ACPI_STATUS (AE_OK);
282     }
283 
284     /* Get the AML pointer (method object) and BufferField node */
285 
286     ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
287     Node = ObjDesc->BufferField.Node;
288 
289     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
290         ACPI_TYPE_BUFFER_FIELD, Node, NULL));
291 
292     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s] BufferField Arg Init\n",
293         AcpiUtGetNodeName (Node)));
294 
295     /* Execute the AML code for the TermArg arguments */
296 
297     Status = AcpiDsExecuteArguments (Node, Node->Parent,
298         ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
299     return_ACPI_STATUS (Status);
300 }
301 
302 
303 /*******************************************************************************
304  *
305  * FUNCTION:    AcpiDsGetBankFieldArguments
306  *
307  * PARAMETERS:  ObjDesc         - A valid BankField object
308  *
309  * RETURN:      Status.
310  *
311  * DESCRIPTION: Get BankField BankValue. This implements the late
312  *              evaluation of these field attributes.
313  *
314  ******************************************************************************/
315 
316 ACPI_STATUS
317 AcpiDsGetBankFieldArguments (
318     ACPI_OPERAND_OBJECT     *ObjDesc)
319 {
320     ACPI_OPERAND_OBJECT     *ExtraDesc;
321     ACPI_NAMESPACE_NODE     *Node;
322     ACPI_STATUS             Status;
323 
324 
325     ACPI_FUNCTION_TRACE_PTR (DsGetBankFieldArguments, ObjDesc);
326 
327 
328     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
329     {
330         return_ACPI_STATUS (AE_OK);
331     }
332 
333     /* Get the AML pointer (method object) and BankField node */
334 
335     ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
336     Node = ObjDesc->BankField.Node;
337 
338     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
339         ACPI_TYPE_LOCAL_BANK_FIELD, Node, NULL));
340 
341     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s] BankField Arg Init\n",
342         AcpiUtGetNodeName (Node)));
343 
344     /* Execute the AML code for the TermArg arguments */
345 
346     Status = AcpiDsExecuteArguments (Node, Node->Parent,
347         ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
348     return_ACPI_STATUS (Status);
349 }
350 
351 
352 /*******************************************************************************
353  *
354  * FUNCTION:    AcpiDsGetBufferArguments
355  *
356  * PARAMETERS:  ObjDesc         - A valid Buffer object
357  *
358  * RETURN:      Status.
359  *
360  * DESCRIPTION: Get Buffer length and initializer byte list. This implements
361  *              the late evaluation of these attributes.
362  *
363  ******************************************************************************/
364 
365 ACPI_STATUS
366 AcpiDsGetBufferArguments (
367     ACPI_OPERAND_OBJECT     *ObjDesc)
368 {
369     ACPI_NAMESPACE_NODE     *Node;
370     ACPI_STATUS             Status;
371 
372 
373     ACPI_FUNCTION_TRACE_PTR (DsGetBufferArguments, ObjDesc);
374 
375 
376     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
377     {
378         return_ACPI_STATUS (AE_OK);
379     }
380 
381     /* Get the Buffer node */
382 
383     Node = ObjDesc->Buffer.Node;
384     if (!Node)
385     {
386         ACPI_ERROR ((AE_INFO,
387             "No pointer back to namespace node in buffer object %p",
388             ObjDesc));
389         return_ACPI_STATUS (AE_AML_INTERNAL);
390     }
391 
392     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Buffer Arg Init\n"));
393 
394     /* Execute the AML code for the TermArg arguments */
395 
396     Status = AcpiDsExecuteArguments (Node, Node,
397         ObjDesc->Buffer.AmlLength, ObjDesc->Buffer.AmlStart);
398     return_ACPI_STATUS (Status);
399 }
400 
401 
402 /*******************************************************************************
403  *
404  * FUNCTION:    AcpiDsGetPackageArguments
405  *
406  * PARAMETERS:  ObjDesc         - A valid Package object
407  *
408  * RETURN:      Status.
409  *
410  * DESCRIPTION: Get Package length and initializer byte list. This implements
411  *              the late evaluation of these attributes.
412  *
413  ******************************************************************************/
414 
415 ACPI_STATUS
416 AcpiDsGetPackageArguments (
417     ACPI_OPERAND_OBJECT     *ObjDesc)
418 {
419     ACPI_NAMESPACE_NODE     *Node;
420     ACPI_STATUS             Status;
421 
422 
423     ACPI_FUNCTION_TRACE_PTR (DsGetPackageArguments, ObjDesc);
424 
425 
426     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
427     {
428         return_ACPI_STATUS (AE_OK);
429     }
430 
431     /* Get the Package node */
432 
433     Node = ObjDesc->Package.Node;
434     if (!Node)
435     {
436         ACPI_ERROR ((AE_INFO,
437             "No pointer back to namespace node in package %p", ObjDesc));
438         return_ACPI_STATUS (AE_AML_INTERNAL);
439     }
440 
441     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Package Arg Init\n"));
442 
443     /* Execute the AML code for the TermArg arguments */
444 
445     Status = AcpiDsExecuteArguments (Node, Node,
446         ObjDesc->Package.AmlLength, ObjDesc->Package.AmlStart);
447     return_ACPI_STATUS (Status);
448 }
449 
450 
451 /*******************************************************************************
452  *
453  * FUNCTION:    AcpiDsGetRegionArguments
454  *
455  * PARAMETERS:  ObjDesc         - A valid region object
456  *
457  * RETURN:      Status.
458  *
459  * DESCRIPTION: Get region address and length. This implements the late
460  *              evaluation of these region attributes.
461  *
462  ******************************************************************************/
463 
464 ACPI_STATUS
465 AcpiDsGetRegionArguments (
466     ACPI_OPERAND_OBJECT     *ObjDesc)
467 {
468     ACPI_NAMESPACE_NODE     *Node;
469     ACPI_STATUS             Status;
470     ACPI_OPERAND_OBJECT     *ExtraDesc;
471 
472 
473     ACPI_FUNCTION_TRACE_PTR (DsGetRegionArguments, ObjDesc);
474 
475 
476     if (ObjDesc->Region.Flags & AOPOBJ_DATA_VALID)
477     {
478         return_ACPI_STATUS (AE_OK);
479     }
480 
481     ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
482     if (!ExtraDesc)
483     {
484         return_ACPI_STATUS (AE_NOT_EXIST);
485     }
486 
487     /* Get the Region node */
488 
489     Node = ObjDesc->Region.Node;
490 
491     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
492         ACPI_TYPE_REGION, Node, NULL));
493 
494     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
495         "[%4.4s] OpRegion Arg Init at AML %p\n",
496         AcpiUtGetNodeName (Node), ExtraDesc->Extra.AmlStart));
497 
498     /* Execute the argument AML */
499 
500     Status = AcpiDsExecuteArguments (Node, ExtraDesc->Extra.ScopeNode,
501         ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
502     if (ACPI_FAILURE (Status))
503     {
504         return_ACPI_STATUS (Status);
505     }
506 
507     Status = AcpiUtAddAddressRange (ObjDesc->Region.SpaceId,
508         ObjDesc->Region.Address, ObjDesc->Region.Length, Node);
509     return_ACPI_STATUS (Status);
510 }
511