1 /******************************************************************************
3 * Module Name: exresolv - AML Interpreter object resolution
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, 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 *****************************************************************************/
153 #include "accommon.h"
155 #include "acdispat.h"
156 #include "acinterp.h"
157 #include "acnamesp.h"
160 #define _COMPONENT ACPI_EXECUTER
161 ACPI_MODULE_NAME ("exresolv")
163 /* Local prototypes */
166 AcpiExResolveObjectToValue (
167 ACPI_OPERAND_OBJECT
**StackPtr
,
168 ACPI_WALK_STATE
*WalkState
);
171 /*******************************************************************************
173 * FUNCTION: AcpiExResolveToValue
175 * PARAMETERS: **StackPtr - Points to entry on ObjStack, which can
176 * be either an (ACPI_OPERAND_OBJECT *)
178 * WalkState - Current method state
182 * DESCRIPTION: Convert Reference objects to values
184 ******************************************************************************/
187 AcpiExResolveToValue (
188 ACPI_OPERAND_OBJECT
**StackPtr
,
189 ACPI_WALK_STATE
*WalkState
)
194 ACPI_FUNCTION_TRACE_PTR (ExResolveToValue
, StackPtr
);
197 if (!StackPtr
|| !*StackPtr
)
199 ACPI_ERROR ((AE_INFO
, "Internal - null pointer"));
200 return_ACPI_STATUS (AE_AML_NO_OPERAND
);
204 * The entity pointed to by the StackPtr can be either
205 * 1) A valid ACPI_OPERAND_OBJECT, or
206 * 2) A ACPI_NAMESPACE_NODE (NamedObj)
208 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr
) == ACPI_DESC_TYPE_OPERAND
)
210 Status
= AcpiExResolveObjectToValue (StackPtr
, WalkState
);
211 if (ACPI_FAILURE (Status
))
213 return_ACPI_STATUS (Status
);
218 ACPI_ERROR ((AE_INFO
, "Internal - null pointer"));
219 return_ACPI_STATUS (AE_AML_NO_OPERAND
);
224 * Object on the stack may have changed if AcpiExResolveObjectToValue()
225 * was called (i.e., we can't use an _else_ here.)
227 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr
) == ACPI_DESC_TYPE_NAMED
)
229 Status
= AcpiExResolveNodeToValue (
230 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE
, StackPtr
),
232 if (ACPI_FAILURE (Status
))
234 return_ACPI_STATUS (Status
);
238 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Resolved object %p\n", *StackPtr
));
239 return_ACPI_STATUS (AE_OK
);
243 /*******************************************************************************
245 * FUNCTION: AcpiExResolveObjectToValue
247 * PARAMETERS: StackPtr - Pointer to an internal object
248 * WalkState - Current method state
252 * DESCRIPTION: Retrieve the value from an internal object. The Reference type
253 * uses the associated AML opcode to determine the value.
255 ******************************************************************************/
258 AcpiExResolveObjectToValue (
259 ACPI_OPERAND_OBJECT
**StackPtr
,
260 ACPI_WALK_STATE
*WalkState
)
262 ACPI_STATUS Status
= AE_OK
;
263 ACPI_OPERAND_OBJECT
*StackDesc
;
264 ACPI_OPERAND_OBJECT
*ObjDesc
= NULL
;
268 ACPI_FUNCTION_TRACE (ExResolveObjectToValue
);
271 StackDesc
= *StackPtr
;
273 /* This is an object of type ACPI_OPERAND_OBJECT */
275 switch (StackDesc
->Common
.Type
)
277 case ACPI_TYPE_LOCAL_REFERENCE
:
279 RefType
= StackDesc
->Reference
.Class
;
283 case ACPI_REFCLASS_LOCAL
:
284 case ACPI_REFCLASS_ARG
:
286 * Get the local from the method's state info
287 * Note: this increments the local's object reference count
289 Status
= AcpiDsMethodDataGetValue (RefType
,
290 StackDesc
->Reference
.Value
, WalkState
, &ObjDesc
);
291 if (ACPI_FAILURE (Status
))
293 return_ACPI_STATUS (Status
);
296 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "[Arg/Local %X] ValueObj is %p\n",
297 StackDesc
->Reference
.Value
, ObjDesc
));
300 * Now we can delete the original Reference Object and
301 * replace it with the resolved value
303 AcpiUtRemoveReference (StackDesc
);
307 case ACPI_REFCLASS_INDEX
:
309 switch (StackDesc
->Reference
.TargetType
)
311 case ACPI_TYPE_BUFFER_FIELD
:
313 /* Just return - do not dereference */
316 case ACPI_TYPE_PACKAGE
:
318 /* If method call or CopyObject - do not dereference */
320 if ((WalkState
->Opcode
== AML_INT_METHODCALL_OP
) ||
321 (WalkState
->Opcode
== AML_COPY_OBJECT_OP
))
326 /* Otherwise, dereference the PackageIndex to a package element */
328 ObjDesc
= *StackDesc
->Reference
.Where
;
332 * Valid object descriptor, copy pointer to return value
333 * (i.e., dereference the package index)
334 * Delete the ref object, increment the returned object
336 AcpiUtAddReference (ObjDesc
);
342 * A NULL object descriptor means an uninitialized element of
343 * the package, can't dereference it
345 ACPI_ERROR ((AE_INFO
,
346 "Attempt to dereference an Index to "
347 "NULL package element Idx=%p",
349 Status
= AE_AML_UNINITIALIZED_ELEMENT
;
355 /* Invalid reference object */
357 ACPI_ERROR ((AE_INFO
,
358 "Unknown TargetType 0x%X in Index/Reference object %p",
359 StackDesc
->Reference
.TargetType
, StackDesc
));
360 Status
= AE_AML_INTERNAL
;
365 case ACPI_REFCLASS_REFOF
:
366 case ACPI_REFCLASS_DEBUG
:
367 case ACPI_REFCLASS_TABLE
:
369 /* Just leave the object as-is, do not dereference */
373 case ACPI_REFCLASS_NAME
: /* Reference to a named object */
375 /* Dereference the name */
377 if ((StackDesc
->Reference
.Node
->Type
== ACPI_TYPE_DEVICE
) ||
378 (StackDesc
->Reference
.Node
->Type
== ACPI_TYPE_THERMAL
))
380 /* These node types do not have 'real' subobjects */
382 *StackPtr
= (void *) StackDesc
->Reference
.Node
;
386 /* Get the object pointed to by the namespace node */
388 *StackPtr
= (StackDesc
->Reference
.Node
)->Object
;
389 AcpiUtAddReference (*StackPtr
);
392 AcpiUtRemoveReference (StackDesc
);
397 ACPI_ERROR ((AE_INFO
,
398 "Unknown Reference type 0x%X in %p",
399 RefType
, StackDesc
));
400 Status
= AE_AML_INTERNAL
;
405 case ACPI_TYPE_BUFFER
:
407 Status
= AcpiDsGetBufferArguments (StackDesc
);
410 case ACPI_TYPE_PACKAGE
:
412 Status
= AcpiDsGetPackageArguments (StackDesc
);
415 case ACPI_TYPE_BUFFER_FIELD
:
416 case ACPI_TYPE_LOCAL_REGION_FIELD
:
417 case ACPI_TYPE_LOCAL_BANK_FIELD
:
418 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
420 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
421 "FieldRead SourceDesc=%p Type=%X\n",
422 StackDesc
, StackDesc
->Common
.Type
));
424 Status
= AcpiExReadDataFromField (WalkState
, StackDesc
, &ObjDesc
);
426 /* Remove a reference to the original operand, then override */
428 AcpiUtRemoveReference (*StackPtr
);
429 *StackPtr
= (void *) ObjDesc
;
437 return_ACPI_STATUS (Status
);
441 /*******************************************************************************
443 * FUNCTION: AcpiExResolveMultiple
445 * PARAMETERS: WalkState - Current state (contains AML opcode)
446 * Operand - Starting point for resolution
447 * ReturnType - Where the object type is returned
448 * ReturnDesc - Where the resolved object is returned
452 * DESCRIPTION: Return the base object and type. Traverse a reference list if
453 * necessary to get to the base object.
455 ******************************************************************************/
458 AcpiExResolveMultiple (
459 ACPI_WALK_STATE
*WalkState
,
460 ACPI_OPERAND_OBJECT
*Operand
,
461 ACPI_OBJECT_TYPE
*ReturnType
,
462 ACPI_OPERAND_OBJECT
**ReturnDesc
)
464 ACPI_OPERAND_OBJECT
*ObjDesc
= ACPI_CAST_PTR (void, Operand
);
465 ACPI_NAMESPACE_NODE
*Node
= ACPI_CAST_PTR (ACPI_NAMESPACE_NODE
, Operand
);
466 ACPI_OBJECT_TYPE Type
;
470 ACPI_FUNCTION_TRACE (AcpiExResolveMultiple
);
473 /* Operand can be either a namespace node or an operand descriptor */
475 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
))
477 case ACPI_DESC_TYPE_OPERAND
:
479 Type
= ObjDesc
->Common
.Type
;
482 case ACPI_DESC_TYPE_NAMED
:
484 Type
= ((ACPI_NAMESPACE_NODE
*) ObjDesc
)->Type
;
485 ObjDesc
= AcpiNsGetAttachedObject (Node
);
487 /* If we had an Alias node, use the attached object for type info */
489 if (Type
== ACPI_TYPE_LOCAL_ALIAS
)
491 Type
= ((ACPI_NAMESPACE_NODE
*) ObjDesc
)->Type
;
492 ObjDesc
= AcpiNsGetAttachedObject (
493 (ACPI_NAMESPACE_NODE
*) ObjDesc
);
498 case ACPI_TYPE_DEVICE
:
499 case ACPI_TYPE_THERMAL
:
501 /* These types have no attached subobject */
506 /* All other types require a subobject */
510 ACPI_ERROR ((AE_INFO
,
511 "[%4.4s] Node is unresolved or uninitialized",
512 AcpiUtGetNodeName (Node
)));
513 return_ACPI_STATUS (AE_AML_UNINITIALIZED_NODE
);
520 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
523 /* If type is anything other than a reference, we are done */
525 if (Type
!= ACPI_TYPE_LOCAL_REFERENCE
)
531 * For reference objects created via the RefOf, Index, or Load/LoadTable
532 * operators, we need to get to the base object (as per the ACPI
533 * specification of the ObjectType and SizeOf operators). This means
534 * traversing the list of possibly many nested references.
536 while (ObjDesc
->Common
.Type
== ACPI_TYPE_LOCAL_REFERENCE
)
538 switch (ObjDesc
->Reference
.Class
)
540 case ACPI_REFCLASS_REFOF
:
541 case ACPI_REFCLASS_NAME
:
543 /* Dereference the reference pointer */
545 if (ObjDesc
->Reference
.Class
== ACPI_REFCLASS_REFOF
)
547 Node
= ObjDesc
->Reference
.Object
;
549 else /* AML_INT_NAMEPATH_OP */
551 Node
= ObjDesc
->Reference
.Node
;
554 /* All "References" point to a NS node */
556 if (ACPI_GET_DESCRIPTOR_TYPE (Node
) != ACPI_DESC_TYPE_NAMED
)
558 ACPI_ERROR ((AE_INFO
,
559 "Not a namespace node %p [%s]",
560 Node
, AcpiUtGetDescriptorName (Node
)));
561 return_ACPI_STATUS (AE_AML_INTERNAL
);
564 /* Get the attached object */
566 ObjDesc
= AcpiNsGetAttachedObject (Node
);
569 /* No object, use the NS node type */
571 Type
= AcpiNsGetType (Node
);
575 /* Check for circular references */
577 if (ObjDesc
== Operand
)
579 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE
);
583 case ACPI_REFCLASS_INDEX
:
585 /* Get the type of this reference (index into another object) */
587 Type
= ObjDesc
->Reference
.TargetType
;
588 if (Type
!= ACPI_TYPE_PACKAGE
)
594 * The main object is a package, we want to get the type
595 * of the individual package element that is referenced by
598 * This could of course in turn be another reference object.
600 ObjDesc
= *(ObjDesc
->Reference
.Where
);
603 /* NULL package elements are allowed */
605 Type
= 0; /* Uninitialized */
610 case ACPI_REFCLASS_TABLE
:
612 Type
= ACPI_TYPE_DDB_HANDLE
;
615 case ACPI_REFCLASS_LOCAL
:
616 case ACPI_REFCLASS_ARG
:
620 Status
= AcpiDsMethodDataGetValue (ObjDesc
->Reference
.Class
,
621 ObjDesc
->Reference
.Value
, WalkState
, &ObjDesc
);
622 if (ACPI_FAILURE (Status
))
624 return_ACPI_STATUS (Status
);
626 AcpiUtRemoveReference (ObjDesc
);
630 Status
= AcpiDsMethodDataGetNode (ObjDesc
->Reference
.Class
,
631 ObjDesc
->Reference
.Value
, WalkState
, &Node
);
632 if (ACPI_FAILURE (Status
))
634 return_ACPI_STATUS (Status
);
637 ObjDesc
= AcpiNsGetAttachedObject (Node
);
640 Type
= ACPI_TYPE_ANY
;
646 case ACPI_REFCLASS_DEBUG
:
648 /* The Debug Object is of type "DebugObject" */
650 Type
= ACPI_TYPE_DEBUG_OBJECT
;
655 ACPI_ERROR ((AE_INFO
,
656 "Unknown Reference Class 0x%2.2X",
657 ObjDesc
->Reference
.Class
));
658 return_ACPI_STATUS (AE_AML_INTERNAL
);
663 * Now we are guaranteed to have an object that has not been created
664 * via the RefOf or Index operators.
666 Type
= ObjDesc
->Common
.Type
;
670 /* Convert internal types to external types */
674 case ACPI_TYPE_LOCAL_REGION_FIELD
:
675 case ACPI_TYPE_LOCAL_BANK_FIELD
:
676 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
678 Type
= ACPI_TYPE_FIELD_UNIT
;
681 case ACPI_TYPE_LOCAL_SCOPE
:
683 /* Per ACPI Specification, Scope is untyped */
685 Type
= ACPI_TYPE_ANY
;
690 /* No change to Type required */
698 *ReturnDesc
= ObjDesc
;
700 return_ACPI_STATUS (AE_OK
);