1 /******************************************************************************
3 * Module Name: exresolv - AML Interpreter object resolution
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2015, 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 *****************************************************************************/
117 #include "accommon.h"
119 #include "acdispat.h"
120 #include "acinterp.h"
121 #include "acnamesp.h"
124 #define _COMPONENT ACPI_EXECUTER
125 ACPI_MODULE_NAME ("exresolv")
127 /* Local prototypes */
130 AcpiExResolveObjectToValue (
131 ACPI_OPERAND_OBJECT
**StackPtr
,
132 ACPI_WALK_STATE
*WalkState
);
135 /*******************************************************************************
137 * FUNCTION: AcpiExResolveToValue
139 * PARAMETERS: **StackPtr - Points to entry on ObjStack, which can
140 * be either an (ACPI_OPERAND_OBJECT *)
142 * WalkState - Current method state
146 * DESCRIPTION: Convert Reference objects to values
148 ******************************************************************************/
151 AcpiExResolveToValue (
152 ACPI_OPERAND_OBJECT
**StackPtr
,
153 ACPI_WALK_STATE
*WalkState
)
158 ACPI_FUNCTION_TRACE_PTR (ExResolveToValue
, StackPtr
);
161 if (!StackPtr
|| !*StackPtr
)
163 ACPI_ERROR ((AE_INFO
, "Internal - null pointer"));
164 return_ACPI_STATUS (AE_AML_NO_OPERAND
);
168 * The entity pointed to by the StackPtr can be either
169 * 1) A valid ACPI_OPERAND_OBJECT, or
170 * 2) A ACPI_NAMESPACE_NODE (NamedObj)
172 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr
) == ACPI_DESC_TYPE_OPERAND
)
174 Status
= AcpiExResolveObjectToValue (StackPtr
, WalkState
);
175 if (ACPI_FAILURE (Status
))
177 return_ACPI_STATUS (Status
);
182 ACPI_ERROR ((AE_INFO
, "Internal - null pointer"));
183 return_ACPI_STATUS (AE_AML_NO_OPERAND
);
188 * Object on the stack may have changed if AcpiExResolveObjectToValue()
189 * was called (i.e., we can't use an _else_ here.)
191 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr
) == ACPI_DESC_TYPE_NAMED
)
193 Status
= AcpiExResolveNodeToValue (
194 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE
, StackPtr
),
196 if (ACPI_FAILURE (Status
))
198 return_ACPI_STATUS (Status
);
202 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Resolved object %p\n", *StackPtr
));
203 return_ACPI_STATUS (AE_OK
);
207 /*******************************************************************************
209 * FUNCTION: AcpiExResolveObjectToValue
211 * PARAMETERS: StackPtr - Pointer to an internal object
212 * WalkState - Current method state
216 * DESCRIPTION: Retrieve the value from an internal object. The Reference type
217 * uses the associated AML opcode to determine the value.
219 ******************************************************************************/
222 AcpiExResolveObjectToValue (
223 ACPI_OPERAND_OBJECT
**StackPtr
,
224 ACPI_WALK_STATE
*WalkState
)
226 ACPI_STATUS Status
= AE_OK
;
227 ACPI_OPERAND_OBJECT
*StackDesc
;
228 ACPI_OPERAND_OBJECT
*ObjDesc
= NULL
;
232 ACPI_FUNCTION_TRACE (ExResolveObjectToValue
);
235 StackDesc
= *StackPtr
;
237 /* This is an object of type ACPI_OPERAND_OBJECT */
239 switch (StackDesc
->Common
.Type
)
241 case ACPI_TYPE_LOCAL_REFERENCE
:
243 RefType
= StackDesc
->Reference
.Class
;
247 case ACPI_REFCLASS_LOCAL
:
248 case ACPI_REFCLASS_ARG
:
250 * Get the local from the method's state info
251 * Note: this increments the local's object reference count
253 Status
= AcpiDsMethodDataGetValue (RefType
,
254 StackDesc
->Reference
.Value
, WalkState
, &ObjDesc
);
255 if (ACPI_FAILURE (Status
))
257 return_ACPI_STATUS (Status
);
260 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "[Arg/Local %X] ValueObj is %p\n",
261 StackDesc
->Reference
.Value
, ObjDesc
));
264 * Now we can delete the original Reference Object and
265 * replace it with the resolved value
267 AcpiUtRemoveReference (StackDesc
);
271 case ACPI_REFCLASS_INDEX
:
273 switch (StackDesc
->Reference
.TargetType
)
275 case ACPI_TYPE_BUFFER_FIELD
:
277 /* Just return - do not dereference */
280 case ACPI_TYPE_PACKAGE
:
282 /* If method call or CopyObject - do not dereference */
284 if ((WalkState
->Opcode
== AML_INT_METHODCALL_OP
) ||
285 (WalkState
->Opcode
== AML_COPY_OP
))
290 /* Otherwise, dereference the PackageIndex to a package element */
292 ObjDesc
= *StackDesc
->Reference
.Where
;
296 * Valid object descriptor, copy pointer to return value
297 * (i.e., dereference the package index)
298 * Delete the ref object, increment the returned object
300 AcpiUtAddReference (ObjDesc
);
306 * A NULL object descriptor means an uninitialized element of
307 * the package, can't dereference it
309 ACPI_ERROR ((AE_INFO
,
310 "Attempt to dereference an Index to NULL package element Idx=%p",
312 Status
= AE_AML_UNINITIALIZED_ELEMENT
;
318 /* Invalid reference object */
320 ACPI_ERROR ((AE_INFO
,
321 "Unknown TargetType 0x%X in Index/Reference object %p",
322 StackDesc
->Reference
.TargetType
, StackDesc
));
323 Status
= AE_AML_INTERNAL
;
328 case ACPI_REFCLASS_REFOF
:
329 case ACPI_REFCLASS_DEBUG
:
330 case ACPI_REFCLASS_TABLE
:
332 /* Just leave the object as-is, do not dereference */
336 case ACPI_REFCLASS_NAME
: /* Reference to a named object */
338 /* Dereference the name */
340 if ((StackDesc
->Reference
.Node
->Type
== ACPI_TYPE_DEVICE
) ||
341 (StackDesc
->Reference
.Node
->Type
== ACPI_TYPE_THERMAL
))
343 /* These node types do not have 'real' subobjects */
345 *StackPtr
= (void *) StackDesc
->Reference
.Node
;
349 /* Get the object pointed to by the namespace node */
351 *StackPtr
= (StackDesc
->Reference
.Node
)->Object
;
352 AcpiUtAddReference (*StackPtr
);
355 AcpiUtRemoveReference (StackDesc
);
360 ACPI_ERROR ((AE_INFO
,
361 "Unknown Reference type 0x%X in %p", RefType
, StackDesc
));
362 Status
= AE_AML_INTERNAL
;
367 case ACPI_TYPE_BUFFER
:
369 Status
= AcpiDsGetBufferArguments (StackDesc
);
372 case ACPI_TYPE_PACKAGE
:
374 Status
= AcpiDsGetPackageArguments (StackDesc
);
377 case ACPI_TYPE_BUFFER_FIELD
:
378 case ACPI_TYPE_LOCAL_REGION_FIELD
:
379 case ACPI_TYPE_LOCAL_BANK_FIELD
:
380 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
382 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "FieldRead SourceDesc=%p Type=%X\n",
383 StackDesc
, StackDesc
->Common
.Type
));
385 Status
= AcpiExReadDataFromField (WalkState
, StackDesc
, &ObjDesc
);
387 /* Remove a reference to the original operand, then override */
389 AcpiUtRemoveReference (*StackPtr
);
390 *StackPtr
= (void *) ObjDesc
;
398 return_ACPI_STATUS (Status
);
402 /*******************************************************************************
404 * FUNCTION: AcpiExResolveMultiple
406 * PARAMETERS: WalkState - Current state (contains AML opcode)
407 * Operand - Starting point for resolution
408 * ReturnType - Where the object type is returned
409 * ReturnDesc - Where the resolved object is returned
413 * DESCRIPTION: Return the base object and type. Traverse a reference list if
414 * necessary to get to the base object.
416 ******************************************************************************/
419 AcpiExResolveMultiple (
420 ACPI_WALK_STATE
*WalkState
,
421 ACPI_OPERAND_OBJECT
*Operand
,
422 ACPI_OBJECT_TYPE
*ReturnType
,
423 ACPI_OPERAND_OBJECT
**ReturnDesc
)
425 ACPI_OPERAND_OBJECT
*ObjDesc
= ACPI_CAST_PTR (void, Operand
);
426 ACPI_NAMESPACE_NODE
*Node
= ACPI_CAST_PTR (ACPI_NAMESPACE_NODE
, Operand
);
427 ACPI_OBJECT_TYPE Type
;
431 ACPI_FUNCTION_TRACE (AcpiExResolveMultiple
);
434 /* Operand can be either a namespace node or an operand descriptor */
436 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
))
438 case ACPI_DESC_TYPE_OPERAND
:
440 Type
= ObjDesc
->Common
.Type
;
443 case ACPI_DESC_TYPE_NAMED
:
445 Type
= ((ACPI_NAMESPACE_NODE
*) ObjDesc
)->Type
;
446 ObjDesc
= AcpiNsGetAttachedObject (Node
);
448 /* If we had an Alias node, use the attached object for type info */
450 if (Type
== ACPI_TYPE_LOCAL_ALIAS
)
452 Type
= ((ACPI_NAMESPACE_NODE
*) ObjDesc
)->Type
;
453 ObjDesc
= AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE
*) ObjDesc
);
458 ACPI_ERROR ((AE_INFO
,
459 "[%4.4s] Node is unresolved or uninitialized",
460 AcpiUtGetNodeName (Node
)));
461 return_ACPI_STATUS (AE_AML_UNINITIALIZED_NODE
);
466 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
469 /* If type is anything other than a reference, we are done */
471 if (Type
!= ACPI_TYPE_LOCAL_REFERENCE
)
477 * For reference objects created via the RefOf, Index, or Load/LoadTable
478 * operators, we need to get to the base object (as per the ACPI
479 * specification of the ObjectType and SizeOf operators). This means
480 * traversing the list of possibly many nested references.
482 while (ObjDesc
->Common
.Type
== ACPI_TYPE_LOCAL_REFERENCE
)
484 switch (ObjDesc
->Reference
.Class
)
486 case ACPI_REFCLASS_REFOF
:
487 case ACPI_REFCLASS_NAME
:
489 /* Dereference the reference pointer */
491 if (ObjDesc
->Reference
.Class
== ACPI_REFCLASS_REFOF
)
493 Node
= ObjDesc
->Reference
.Object
;
495 else /* AML_INT_NAMEPATH_OP */
497 Node
= ObjDesc
->Reference
.Node
;
500 /* All "References" point to a NS node */
502 if (ACPI_GET_DESCRIPTOR_TYPE (Node
) != ACPI_DESC_TYPE_NAMED
)
504 ACPI_ERROR ((AE_INFO
,
505 "Not a namespace node %p [%s]",
506 Node
, AcpiUtGetDescriptorName (Node
)));
507 return_ACPI_STATUS (AE_AML_INTERNAL
);
510 /* Get the attached object */
512 ObjDesc
= AcpiNsGetAttachedObject (Node
);
515 /* No object, use the NS node type */
517 Type
= AcpiNsGetType (Node
);
521 /* Check for circular references */
523 if (ObjDesc
== Operand
)
525 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE
);
529 case ACPI_REFCLASS_INDEX
:
531 /* Get the type of this reference (index into another object) */
533 Type
= ObjDesc
->Reference
.TargetType
;
534 if (Type
!= ACPI_TYPE_PACKAGE
)
540 * The main object is a package, we want to get the type
541 * of the individual package element that is referenced by
544 * This could of course in turn be another reference object.
546 ObjDesc
= *(ObjDesc
->Reference
.Where
);
549 /* NULL package elements are allowed */
551 Type
= 0; /* Uninitialized */
556 case ACPI_REFCLASS_TABLE
:
558 Type
= ACPI_TYPE_DDB_HANDLE
;
561 case ACPI_REFCLASS_LOCAL
:
562 case ACPI_REFCLASS_ARG
:
566 Status
= AcpiDsMethodDataGetValue (ObjDesc
->Reference
.Class
,
567 ObjDesc
->Reference
.Value
, WalkState
, &ObjDesc
);
568 if (ACPI_FAILURE (Status
))
570 return_ACPI_STATUS (Status
);
572 AcpiUtRemoveReference (ObjDesc
);
576 Status
= AcpiDsMethodDataGetNode (ObjDesc
->Reference
.Class
,
577 ObjDesc
->Reference
.Value
, WalkState
, &Node
);
578 if (ACPI_FAILURE (Status
))
580 return_ACPI_STATUS (Status
);
583 ObjDesc
= AcpiNsGetAttachedObject (Node
);
586 Type
= ACPI_TYPE_ANY
;
592 case ACPI_REFCLASS_DEBUG
:
594 /* The Debug Object is of type "DebugObject" */
596 Type
= ACPI_TYPE_DEBUG_OBJECT
;
601 ACPI_ERROR ((AE_INFO
,
602 "Unknown Reference Class 0x%2.2X", ObjDesc
->Reference
.Class
));
603 return_ACPI_STATUS (AE_AML_INTERNAL
);
608 * Now we are guaranteed to have an object that has not been created
609 * via the RefOf or Index operators.
611 Type
= ObjDesc
->Common
.Type
;
615 /* Convert internal types to external types */
619 case ACPI_TYPE_LOCAL_REGION_FIELD
:
620 case ACPI_TYPE_LOCAL_BANK_FIELD
:
621 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
623 Type
= ACPI_TYPE_FIELD_UNIT
;
626 case ACPI_TYPE_LOCAL_SCOPE
:
628 /* Per ACPI Specification, Scope is untyped */
630 Type
= ACPI_TYPE_ANY
;
635 /* No change to Type required */
643 *ReturnDesc
= ObjDesc
;
645 return_ACPI_STATUS (AE_OK
);