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 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the
118 * following license:
119 *
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
122 * are met:
123 * 1. Redistributions of source code must retain the above copyright
124 * notice, this list of conditions, and the following disclaimer,
125 * without modification.
126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127 * substantially similar to the "NO WARRANTY" disclaimer below
128 * ("Disclaimer") and any redistribution must be conditioned upon
129 * including a substantially similar Disclaimer requirement for further
130 * binary redistribution.
131 * 3. Neither the names of the above-listed copyright holders nor the names
132 * of any contributors may be used to endorse or promote products derived
133 * from this software without specific prior written permission.
134 *
135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 *
147 * Alternatively, you may choose to be licensed under the terms of the
148 * GNU General Public License ("GPL") version 2 as published by the Free
149 * Software Foundation.
150 *
151 *****************************************************************************/
152
153 #include "acpi.h"
154 #include "accommon.h"
155 #include "acparser.h"
156 #include "amlcode.h"
157 #include "acdispat.h"
158 #include "acnamesp.h"
159
160 #define _COMPONENT ACPI_DISPATCHER
161 ACPI_MODULE_NAME ("dsargs")
162
163 /* Local prototypes */
164
165 static ACPI_STATUS
166 AcpiDsExecuteArguments (
167 ACPI_NAMESPACE_NODE *Node,
168 ACPI_NAMESPACE_NODE *ScopeNode,
169 UINT32 AmlLength,
170 UINT8 *AmlStart);
171
172
173 /*******************************************************************************
174 *
175 * FUNCTION: AcpiDsExecuteArguments
176 *
177 * PARAMETERS: Node - Object NS node
178 * ScopeNode - Parent NS node
179 * AmlLength - Length of executable AML
180 * AmlStart - Pointer to the AML
181 *
182 * RETURN: Status.
183 *
184 * DESCRIPTION: Late (deferred) execution of region or field arguments
185 *
186 ******************************************************************************/
187
188 static ACPI_STATUS
AcpiDsExecuteArguments(ACPI_NAMESPACE_NODE * Node,ACPI_NAMESPACE_NODE * ScopeNode,UINT32 AmlLength,UINT8 * AmlStart)189 AcpiDsExecuteArguments (
190 ACPI_NAMESPACE_NODE *Node,
191 ACPI_NAMESPACE_NODE *ScopeNode,
192 UINT32 AmlLength,
193 UINT8 *AmlStart)
194 {
195 ACPI_STATUS Status;
196 ACPI_PARSE_OBJECT *Op;
197 ACPI_WALK_STATE *WalkState;
198
199
200 ACPI_FUNCTION_TRACE_PTR (DsExecuteArguments, AmlStart);
201
202
203 /* Allocate a new parser op to be the root of the parsed tree */
204
205 Op = AcpiPsAllocOp (AML_INT_EVAL_SUBTREE_OP, AmlStart);
206 if (!Op)
207 {
208 return_ACPI_STATUS (AE_NO_MEMORY);
209 }
210
211 /* Save the Node for use in AcpiPsParseAml */
212
213 Op->Common.Node = ScopeNode;
214
215 /* Create and initialize a new parser state */
216
217 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
218 if (!WalkState)
219 {
220 Status = AE_NO_MEMORY;
221 goto Cleanup;
222 }
223
224 Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, AmlStart,
225 AmlLength, NULL, ACPI_IMODE_LOAD_PASS1);
226 if (ACPI_FAILURE (Status))
227 {
228 AcpiDsDeleteWalkState (WalkState);
229 goto Cleanup;
230 }
231
232 /* Mark this parse as a deferred opcode */
233
234 WalkState->ParseFlags = ACPI_PARSE_DEFERRED_OP;
235 WalkState->DeferredNode = Node;
236
237 /* Pass1: Parse the entire declaration */
238
239 Status = AcpiPsParseAml (WalkState);
240 if (ACPI_FAILURE (Status))
241 {
242 goto Cleanup;
243 }
244
245 /* Get and init the Op created above */
246
247 Op->Common.Node = Node;
248 AcpiPsDeleteParseTree (Op);
249
250 /* Evaluate the deferred arguments */
251
252 Op = AcpiPsAllocOp (AML_INT_EVAL_SUBTREE_OP, AmlStart);
253 if (!Op)
254 {
255 return_ACPI_STATUS (AE_NO_MEMORY);
256 }
257
258 Op->Common.Node = ScopeNode;
259
260 /* Create and initialize a new parser state */
261
262 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
263 if (!WalkState)
264 {
265 Status = AE_NO_MEMORY;
266 goto Cleanup;
267 }
268
269 /* Execute the opcode and arguments */
270
271 Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, AmlStart,
272 AmlLength, NULL, ACPI_IMODE_EXECUTE);
273 if (ACPI_FAILURE (Status))
274 {
275 AcpiDsDeleteWalkState (WalkState);
276 goto Cleanup;
277 }
278
279 /* Mark this execution as a deferred opcode */
280
281 WalkState->DeferredNode = Node;
282 Status = AcpiPsParseAml (WalkState);
283
284 Cleanup:
285 AcpiPsDeleteParseTree (Op);
286 return_ACPI_STATUS (Status);
287 }
288
289
290 /*******************************************************************************
291 *
292 * FUNCTION: AcpiDsGetBufferFieldArguments
293 *
294 * PARAMETERS: ObjDesc - A valid BufferField object
295 *
296 * RETURN: Status.
297 *
298 * DESCRIPTION: Get BufferField Buffer and Index. This implements the late
299 * evaluation of these field attributes.
300 *
301 ******************************************************************************/
302
303 ACPI_STATUS
AcpiDsGetBufferFieldArguments(ACPI_OPERAND_OBJECT * ObjDesc)304 AcpiDsGetBufferFieldArguments (
305 ACPI_OPERAND_OBJECT *ObjDesc)
306 {
307 ACPI_OPERAND_OBJECT *ExtraDesc;
308 ACPI_NAMESPACE_NODE *Node;
309 ACPI_STATUS Status;
310
311
312 ACPI_FUNCTION_TRACE_PTR (DsGetBufferFieldArguments, ObjDesc);
313
314
315 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
316 {
317 return_ACPI_STATUS (AE_OK);
318 }
319
320 /* Get the AML pointer (method object) and BufferField node */
321
322 ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
323 Node = ObjDesc->BufferField.Node;
324
325 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
326 ACPI_TYPE_BUFFER_FIELD, Node, NULL));
327
328 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s] BufferField Arg Init\n",
329 AcpiUtGetNodeName (Node)));
330
331 /* Execute the AML code for the TermArg arguments */
332
333 Status = AcpiDsExecuteArguments (Node, Node->Parent,
334 ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
335 return_ACPI_STATUS (Status);
336 }
337
338
339 /*******************************************************************************
340 *
341 * FUNCTION: AcpiDsGetBankFieldArguments
342 *
343 * PARAMETERS: ObjDesc - A valid BankField object
344 *
345 * RETURN: Status.
346 *
347 * DESCRIPTION: Get BankField BankValue. This implements the late
348 * evaluation of these field attributes.
349 *
350 ******************************************************************************/
351
352 ACPI_STATUS
AcpiDsGetBankFieldArguments(ACPI_OPERAND_OBJECT * ObjDesc)353 AcpiDsGetBankFieldArguments (
354 ACPI_OPERAND_OBJECT *ObjDesc)
355 {
356 ACPI_OPERAND_OBJECT *ExtraDesc;
357 ACPI_NAMESPACE_NODE *Node;
358 ACPI_STATUS Status;
359
360
361 ACPI_FUNCTION_TRACE_PTR (DsGetBankFieldArguments, ObjDesc);
362
363
364 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
365 {
366 return_ACPI_STATUS (AE_OK);
367 }
368
369 /* Get the AML pointer (method object) and BankField node */
370
371 ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
372 Node = ObjDesc->BankField.Node;
373
374 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
375 ACPI_TYPE_LOCAL_BANK_FIELD, Node, NULL));
376
377 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s] BankField Arg Init\n",
378 AcpiUtGetNodeName (Node)));
379
380 /* Execute the AML code for the TermArg arguments */
381
382 Status = AcpiDsExecuteArguments (Node, Node->Parent,
383 ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
384 return_ACPI_STATUS (Status);
385 }
386
387
388 /*******************************************************************************
389 *
390 * FUNCTION: AcpiDsGetBufferArguments
391 *
392 * PARAMETERS: ObjDesc - A valid Buffer object
393 *
394 * RETURN: Status.
395 *
396 * DESCRIPTION: Get Buffer length and initializer byte list. This implements
397 * the late evaluation of these attributes.
398 *
399 ******************************************************************************/
400
401 ACPI_STATUS
AcpiDsGetBufferArguments(ACPI_OPERAND_OBJECT * ObjDesc)402 AcpiDsGetBufferArguments (
403 ACPI_OPERAND_OBJECT *ObjDesc)
404 {
405 ACPI_NAMESPACE_NODE *Node;
406 ACPI_STATUS Status;
407
408
409 ACPI_FUNCTION_TRACE_PTR (DsGetBufferArguments, ObjDesc);
410
411
412 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
413 {
414 return_ACPI_STATUS (AE_OK);
415 }
416
417 /* Get the Buffer node */
418
419 Node = ObjDesc->Buffer.Node;
420 if (!Node)
421 {
422 ACPI_ERROR ((AE_INFO,
423 "No pointer back to namespace node in buffer object %p",
424 ObjDesc));
425 return_ACPI_STATUS (AE_AML_INTERNAL);
426 }
427
428 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Buffer Arg Init\n"));
429
430 /* Execute the AML code for the TermArg arguments */
431
432 Status = AcpiDsExecuteArguments (Node, Node,
433 ObjDesc->Buffer.AmlLength, ObjDesc->Buffer.AmlStart);
434 return_ACPI_STATUS (Status);
435 }
436
437
438 /*******************************************************************************
439 *
440 * FUNCTION: AcpiDsGetPackageArguments
441 *
442 * PARAMETERS: ObjDesc - A valid Package object
443 *
444 * RETURN: Status.
445 *
446 * DESCRIPTION: Get Package length and initializer byte list. This implements
447 * the late evaluation of these attributes.
448 *
449 ******************************************************************************/
450
451 ACPI_STATUS
AcpiDsGetPackageArguments(ACPI_OPERAND_OBJECT * ObjDesc)452 AcpiDsGetPackageArguments (
453 ACPI_OPERAND_OBJECT *ObjDesc)
454 {
455 ACPI_NAMESPACE_NODE *Node;
456 ACPI_STATUS Status;
457
458
459 ACPI_FUNCTION_TRACE_PTR (DsGetPackageArguments, ObjDesc);
460
461
462 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
463 {
464 return_ACPI_STATUS (AE_OK);
465 }
466
467 /* Get the Package node */
468
469 Node = ObjDesc->Package.Node;
470 if (!Node)
471 {
472 ACPI_ERROR ((AE_INFO,
473 "No pointer back to namespace node in package %p", ObjDesc));
474 return_ACPI_STATUS (AE_AML_INTERNAL);
475 }
476
477 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Package Argument Init, AML Ptr: %p\n",
478 ObjDesc->Package.AmlStart));
479
480 /* Execute the AML code for the TermArg arguments */
481
482 Status = AcpiDsExecuteArguments (Node, Node,
483 ObjDesc->Package.AmlLength, ObjDesc->Package.AmlStart);
484
485 return_ACPI_STATUS (Status);
486 }
487
488
489 /*******************************************************************************
490 *
491 * FUNCTION: AcpiDsGetRegionArguments
492 *
493 * PARAMETERS: ObjDesc - A valid region object
494 *
495 * RETURN: Status.
496 *
497 * DESCRIPTION: Get region address and length. This implements the late
498 * evaluation of these region attributes.
499 *
500 ******************************************************************************/
501
502 ACPI_STATUS
AcpiDsGetRegionArguments(ACPI_OPERAND_OBJECT * ObjDesc)503 AcpiDsGetRegionArguments (
504 ACPI_OPERAND_OBJECT *ObjDesc)
505 {
506 ACPI_NAMESPACE_NODE *Node;
507 ACPI_STATUS Status;
508 ACPI_OPERAND_OBJECT *ExtraDesc;
509
510
511 ACPI_FUNCTION_TRACE_PTR (DsGetRegionArguments, ObjDesc);
512
513
514 if (ObjDesc->Region.Flags & AOPOBJ_DATA_VALID)
515 {
516 return_ACPI_STATUS (AE_OK);
517 }
518
519 ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
520 if (!ExtraDesc)
521 {
522 return_ACPI_STATUS (AE_NOT_EXIST);
523 }
524
525 /* Get the Region node */
526
527 Node = ObjDesc->Region.Node;
528
529 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
530 ACPI_TYPE_REGION, Node, NULL));
531
532 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
533 "[%4.4s] OpRegion Arg Init at AML %p\n",
534 AcpiUtGetNodeName (Node), ExtraDesc->Extra.AmlStart));
535
536 /* Execute the argument AML */
537
538 Status = AcpiDsExecuteArguments (Node, ExtraDesc->Extra.ScopeNode,
539 ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
540 if (ACPI_FAILURE (Status))
541 {
542 return_ACPI_STATUS (Status);
543 }
544
545 Status = AcpiUtAddAddressRange (ObjDesc->Region.SpaceId,
546 ObjDesc->Region.Address, ObjDesc->Region.Length, Node);
547 return_ACPI_STATUS (Status);
548 }
549
