2 /******************************************************************************
4 * Module Name: exresolv - AML Interpreter object resolution
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __EXRESOLV_C__
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/amlcode.h>
122 #include <contrib/dev/acpica/acdispat.h>
123 #include <contrib/dev/acpica/acinterp.h>
124 #include <contrib/dev/acpica/acnamesp.h>
125 #include <contrib/dev/acpica/acparser.h>
128 #define _COMPONENT ACPI_EXECUTER
129 ACPI_MODULE_NAME ("exresolv")
131 /* Local prototypes */
134 AcpiExResolveObjectToValue (
135 ACPI_OPERAND_OBJECT **StackPtr,
136 ACPI_WALK_STATE *WalkState);
139 /*******************************************************************************
141 * FUNCTION: AcpiExResolveToValue
143 * PARAMETERS: **StackPtr - Points to entry on ObjStack, which can
144 * be either an (ACPI_OPERAND_OBJECT *)
146 * WalkState - Current method state
150 * DESCRIPTION: Convert Reference objects to values
152 ******************************************************************************/
155 AcpiExResolveToValue (
156 ACPI_OPERAND_OBJECT **StackPtr,
157 ACPI_WALK_STATE *WalkState)
162 ACPI_FUNCTION_TRACE_PTR ("ExResolveToValue", StackPtr);
165 if (!StackPtr || !*StackPtr)
167 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - null pointer\n"));
168 return_ACPI_STATUS (AE_AML_NO_OPERAND);
172 * The entity pointed to by the StackPtr can be either
173 * 1) A valid ACPI_OPERAND_OBJECT, or
174 * 2) A ACPI_NAMESPACE_NODE (NamedObj)
176 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_OPERAND)
178 Status = AcpiExResolveObjectToValue (StackPtr, WalkState);
179 if (ACPI_FAILURE (Status))
181 return_ACPI_STATUS (Status);
186 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - null pointer\n"));
187 return_ACPI_STATUS (AE_AML_NO_OPERAND);
192 * Object on the stack may have changed if AcpiExResolveObjectToValue()
193 * was called (i.e., we can't use an _else_ here.)
195 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_NAMED)
197 Status = AcpiExResolveNodeToValue (
198 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, StackPtr),
200 if (ACPI_FAILURE (Status))
202 return_ACPI_STATUS (Status);
206 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Resolved object %p\n", *StackPtr));
207 return_ACPI_STATUS (AE_OK);
211 /*******************************************************************************
213 * FUNCTION: AcpiExResolveObjectToValue
215 * PARAMETERS: StackPtr - Pointer to an internal object
216 * WalkState - Current method state
220 * DESCRIPTION: Retrieve the value from an internal object. The Reference type
221 * uses the associated AML opcode to determine the value.
223 ******************************************************************************/
226 AcpiExResolveObjectToValue (
227 ACPI_OPERAND_OBJECT **StackPtr,
228 ACPI_WALK_STATE *WalkState)
230 ACPI_STATUS Status = AE_OK;
231 ACPI_OPERAND_OBJECT *StackDesc;
233 ACPI_OPERAND_OBJECT *ObjDesc;
237 ACPI_FUNCTION_TRACE ("ExResolveObjectToValue");
240 StackDesc = *StackPtr;
242 /* This is an ACPI_OPERAND_OBJECT */
244 switch (ACPI_GET_OBJECT_TYPE (StackDesc))
246 case ACPI_TYPE_LOCAL_REFERENCE:
248 Opcode = StackDesc->Reference.Opcode;
255 * Convert name reference to a namespace node
256 * Then, AcpiExResolveNodeToValue can be used to get the value
258 TempNode = StackDesc->Reference.Object;
260 /* Delete the Reference Object */
262 AcpiUtRemoveReference (StackDesc);
264 /* Return the namespace node */
266 (*StackPtr) = TempNode;
274 * Get the local from the method's state info
275 * Note: this increments the local's object reference count
277 Status = AcpiDsMethodDataGetValue (Opcode,
278 StackDesc->Reference.Offset, WalkState, &ObjDesc);
279 if (ACPI_FAILURE (Status))
281 return_ACPI_STATUS (Status);
284 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Arg/Local %X] ValueObj is %p\n",
285 StackDesc->Reference.Offset, ObjDesc));
288 * Now we can delete the original Reference Object and
289 * replace it with the resolved value
291 AcpiUtRemoveReference (StackDesc);
298 switch (StackDesc->Reference.TargetType)
300 case ACPI_TYPE_BUFFER_FIELD:
302 /* Just return - leave the Reference on the stack */
306 case ACPI_TYPE_PACKAGE:
308 ObjDesc = *StackDesc->Reference.Where;
312 * Valid obj descriptor, copy pointer to return value
313 * (i.e., dereference the package index)
314 * Delete the ref object, increment the returned object
316 AcpiUtRemoveReference (StackDesc);
317 AcpiUtAddReference (ObjDesc);
323 * A NULL object descriptor means an unitialized element of
324 * the package, can't dereference it
326 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
327 "Attempt to deref an Index to NULL pkg element Idx=%p\n",
329 Status = AE_AML_UNINITIALIZED_ELEMENT;
336 /* Invalid reference object */
339 "During resolve, Unknown TargetType %X in Index/Reference obj %p\n",
340 StackDesc->Reference.TargetType, StackDesc));
341 Status = AE_AML_INTERNAL;
351 /* Just leave the object as-is */
355 case AML_INT_NAMEPATH_OP: /* Reference to a named object */
357 /* Get the object pointed to by the namespace node */
359 *StackPtr = (StackDesc->Reference.Node)->Object;
360 AcpiUtAddReference (*StackPtr);
361 AcpiUtRemoveReference (StackDesc);
367 "During resolve, Unknown Reference opcode %X (%s) in %p\n",
368 Opcode, AcpiPsGetOpcodeName (Opcode), StackDesc));
369 Status = AE_AML_INTERNAL;
375 case ACPI_TYPE_BUFFER:
377 Status = AcpiDsGetBufferArguments (StackDesc);
381 case ACPI_TYPE_PACKAGE:
383 Status = AcpiDsGetPackageArguments (StackDesc);
387 /* These cases may never happen here, but just in case.. */
389 case ACPI_TYPE_BUFFER_FIELD:
390 case ACPI_TYPE_LOCAL_REGION_FIELD:
391 case ACPI_TYPE_LOCAL_BANK_FIELD:
392 case ACPI_TYPE_LOCAL_INDEX_FIELD:
394 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "FieldRead SourceDesc=%p Type=%X\n",
395 StackDesc, ACPI_GET_OBJECT_TYPE (StackDesc)));
397 Status = AcpiExReadDataFromField (WalkState, StackDesc, &ObjDesc);
398 *StackPtr = (void *) ObjDesc;
405 return_ACPI_STATUS (Status);
409 /*******************************************************************************
411 * FUNCTION: AcpiExResolveMultiple
413 * PARAMETERS: WalkState - Current state (contains AML opcode)
414 * Operand - Starting point for resolution
415 * ReturnType - Where the object type is returned
416 * ReturnDesc - Where the resolved object is returned
420 * DESCRIPTION: Return the base object and type. Traverse a reference list if
421 * necessary to get to the base object.
423 ******************************************************************************/
426 AcpiExResolveMultiple (
427 ACPI_WALK_STATE *WalkState,
428 ACPI_OPERAND_OBJECT *Operand,
429 ACPI_OBJECT_TYPE *ReturnType,
430 ACPI_OPERAND_OBJECT **ReturnDesc)
432 ACPI_OPERAND_OBJECT *ObjDesc = (void *) Operand;
433 ACPI_NAMESPACE_NODE *Node;
434 ACPI_OBJECT_TYPE Type;
438 ACPI_FUNCTION_TRACE ("AcpiExResolveMultiple");
441 /* Operand can be either a namespace node or an operand descriptor */
443 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
445 case ACPI_DESC_TYPE_OPERAND:
446 Type = ObjDesc->Common.Type;
449 case ACPI_DESC_TYPE_NAMED:
450 Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
451 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
453 /* If we had an Alias node, use the attached object for type info */
455 if (Type == ACPI_TYPE_LOCAL_ALIAS)
457 Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
458 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
463 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
466 /* If type is anything other than a reference, we are done */
468 if (Type != ACPI_TYPE_LOCAL_REFERENCE)
474 * For reference objects created via the RefOf or Index operators,
475 * we need to get to the base object (as per the ACPI specification
476 * of the ObjectType and SizeOf operators). This means traversing
477 * the list of possibly many nested references.
479 while (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REFERENCE)
481 switch (ObjDesc->Reference.Opcode)
485 /* Dereference the reference pointer */
487 Node = ObjDesc->Reference.Object;
489 /* All "References" point to a NS node */
491 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
494 "AcpiExResolveMultiple: Not a NS node %p [%s]\n",
495 Node, AcpiUtGetDescriptorName (Node)));
496 return_ACPI_STATUS (AE_AML_INTERNAL);
499 /* Get the attached object */
501 ObjDesc = AcpiNsGetAttachedObject (Node);
504 /* No object, use the NS node type */
506 Type = AcpiNsGetType (Node);
510 /* Check for circular references */
512 if (ObjDesc == Operand)
514 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
521 /* Get the type of this reference (index into another object) */
523 Type = ObjDesc->Reference.TargetType;
524 if (Type != ACPI_TYPE_PACKAGE)
530 * The main object is a package, we want to get the type
531 * of the individual package element that is referenced by
534 * This could of course in turn be another reference object.
536 ObjDesc = *(ObjDesc->Reference.Where);
539 /* NULL package elements are allowed */
541 Type = 0; /* Uninitialized */
547 case AML_INT_NAMEPATH_OP:
549 /* Dereference the reference pointer */
551 Node = ObjDesc->Reference.Node;
553 /* All "References" point to a NS node */
555 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
558 "AcpiExResolveMultiple: Not a NS node %p [%s]\n",
559 Node, AcpiUtGetDescriptorName (Node)));
560 return_ACPI_STATUS (AE_AML_INTERNAL);
563 /* Get the attached object */
565 ObjDesc = AcpiNsGetAttachedObject (Node);
568 /* No object, use the NS node type */
570 Type = AcpiNsGetType (Node);
574 /* Check for circular references */
576 if (ObjDesc == Operand)
578 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
588 Status = AcpiDsMethodDataGetValue (ObjDesc->Reference.Opcode,
589 ObjDesc->Reference.Offset, WalkState, &ObjDesc);
590 if (ACPI_FAILURE (Status))
592 return_ACPI_STATUS (Status);
594 AcpiUtRemoveReference (ObjDesc);
598 Status = AcpiDsMethodDataGetNode (ObjDesc->Reference.Opcode,
599 ObjDesc->Reference.Offset, WalkState, &Node);
600 if (ACPI_FAILURE (Status))
602 return_ACPI_STATUS (Status);
605 ObjDesc = AcpiNsGetAttachedObject (Node);
608 Type = ACPI_TYPE_ANY;
617 /* The Debug Object is of type "DebugObject" */
619 Type = ACPI_TYPE_DEBUG_OBJECT;
626 "AcpiExResolveMultiple: Unknown Reference subtype %X\n",
627 ObjDesc->Reference.Opcode));
628 return_ACPI_STATUS (AE_AML_INTERNAL);
633 * Now we are guaranteed to have an object that has not been created
634 * via the RefOf or Index operators.
636 Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
640 /* Convert internal types to external types */
644 case ACPI_TYPE_LOCAL_REGION_FIELD:
645 case ACPI_TYPE_LOCAL_BANK_FIELD:
646 case ACPI_TYPE_LOCAL_INDEX_FIELD:
648 Type = ACPI_TYPE_FIELD_UNIT;
651 case ACPI_TYPE_LOCAL_SCOPE:
653 /* Per ACPI Specification, Scope is untyped */
655 Type = ACPI_TYPE_ANY;
659 /* No change to Type required */
666 *ReturnDesc = ObjDesc;
668 return_ACPI_STATUS (AE_OK);