2 /******************************************************************************
4 * Module Name: exresolv - AML Interpreter object resolution
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2007, 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_ERROR ((AE_INFO, "Internal - null pointer"));
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_ERROR ((AE_INFO, "Internal - null pointer"));
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;
232 ACPI_OPERAND_OBJECT *ObjDesc = NULL;
236 ACPI_FUNCTION_TRACE (ExResolveObjectToValue);
239 StackDesc = *StackPtr;
241 /* This is an ACPI_OPERAND_OBJECT */
243 switch (ACPI_GET_OBJECT_TYPE (StackDesc))
245 case ACPI_TYPE_LOCAL_REFERENCE:
247 Opcode = StackDesc->Reference.Opcode;
255 * Get the local from the method's state info
256 * Note: this increments the local's object reference count
258 Status = AcpiDsMethodDataGetValue (Opcode,
259 StackDesc->Reference.Offset, WalkState, &ObjDesc);
260 if (ACPI_FAILURE (Status))
262 return_ACPI_STATUS (Status);
265 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Arg/Local %X] ValueObj is %p\n",
266 StackDesc->Reference.Offset, ObjDesc));
269 * Now we can delete the original Reference Object and
270 * replace it with the resolved value
272 AcpiUtRemoveReference (StackDesc);
279 switch (StackDesc->Reference.TargetType)
281 case ACPI_TYPE_BUFFER_FIELD:
283 /* Just return - leave the Reference on the stack */
287 case ACPI_TYPE_PACKAGE:
289 ObjDesc = *StackDesc->Reference.Where;
293 * Valid obj descriptor, copy pointer to return value
294 * (i.e., dereference the package index)
295 * Delete the ref object, increment the returned object
297 AcpiUtRemoveReference (StackDesc);
298 AcpiUtAddReference (ObjDesc);
304 * A NULL object descriptor means an unitialized element of
305 * the package, can't dereference it
307 ACPI_ERROR ((AE_INFO,
308 "Attempt to deref an Index to NULL pkg element Idx=%p",
310 Status = AE_AML_UNINITIALIZED_ELEMENT;
317 /* Invalid reference object */
319 ACPI_ERROR ((AE_INFO,
320 "Unknown TargetType %X in Index/Reference obj %p",
321 StackDesc->Reference.TargetType, StackDesc));
322 Status = AE_AML_INTERNAL;
332 /* Just leave the object as-is */
336 case AML_INT_NAMEPATH_OP: /* 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 opcode %X (%s) in %p",
362 Opcode, AcpiPsGetOpcodeName (Opcode), StackDesc));
363 Status = AE_AML_INTERNAL;
369 case ACPI_TYPE_BUFFER:
371 Status = AcpiDsGetBufferArguments (StackDesc);
375 case ACPI_TYPE_PACKAGE:
377 Status = AcpiDsGetPackageArguments (StackDesc);
381 case ACPI_TYPE_BUFFER_FIELD:
382 case ACPI_TYPE_LOCAL_REGION_FIELD:
383 case ACPI_TYPE_LOCAL_BANK_FIELD:
384 case ACPI_TYPE_LOCAL_INDEX_FIELD:
386 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "FieldRead SourceDesc=%p Type=%X\n",
387 StackDesc, ACPI_GET_OBJECT_TYPE (StackDesc)));
389 Status = AcpiExReadDataFromField (WalkState, StackDesc, &ObjDesc);
391 /* Remove a reference to the original operand, then override */
393 AcpiUtRemoveReference (*StackPtr);
394 *StackPtr = (void *) ObjDesc;
401 return_ACPI_STATUS (Status);
405 /*******************************************************************************
407 * FUNCTION: AcpiExResolveMultiple
409 * PARAMETERS: WalkState - Current state (contains AML opcode)
410 * Operand - Starting point for resolution
411 * ReturnType - Where the object type is returned
412 * ReturnDesc - Where the resolved object is returned
416 * DESCRIPTION: Return the base object and type. Traverse a reference list if
417 * necessary to get to the base object.
419 ******************************************************************************/
422 AcpiExResolveMultiple (
423 ACPI_WALK_STATE *WalkState,
424 ACPI_OPERAND_OBJECT *Operand,
425 ACPI_OBJECT_TYPE *ReturnType,
426 ACPI_OPERAND_OBJECT **ReturnDesc)
428 ACPI_OPERAND_OBJECT *ObjDesc = (void *) Operand;
429 ACPI_NAMESPACE_NODE *Node;
430 ACPI_OBJECT_TYPE Type;
434 ACPI_FUNCTION_TRACE (AcpiExResolveMultiple);
437 /* Operand can be either a namespace node or an operand descriptor */
439 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
441 case ACPI_DESC_TYPE_OPERAND:
442 Type = ObjDesc->Common.Type;
445 case ACPI_DESC_TYPE_NAMED:
446 Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
447 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
449 /* If we had an Alias node, use the attached object for type info */
451 if (Type == ACPI_TYPE_LOCAL_ALIAS)
453 Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
454 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
459 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
462 /* If type is anything other than a reference, we are done */
464 if (Type != ACPI_TYPE_LOCAL_REFERENCE)
470 * For reference objects created via the RefOf or Index operators,
471 * we need to get to the base object (as per the ACPI specification
472 * of the ObjectType and SizeOf operators). This means traversing
473 * the list of possibly many nested references.
475 while (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REFERENCE)
477 switch (ObjDesc->Reference.Opcode)
480 case AML_INT_NAMEPATH_OP:
482 /* Dereference the reference pointer */
484 if (ObjDesc->Reference.Opcode == AML_REF_OF_OP)
486 Node = ObjDesc->Reference.Object;
488 else /* AML_INT_NAMEPATH_OP */
490 Node = ObjDesc->Reference.Node;
493 /* All "References" point to a NS node */
495 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
497 ACPI_ERROR ((AE_INFO,
498 "Not a NS node %p [%s]",
499 Node, AcpiUtGetDescriptorName (Node)));
500 return_ACPI_STATUS (AE_AML_INTERNAL);
503 /* Get the attached object */
505 ObjDesc = AcpiNsGetAttachedObject (Node);
508 /* No object, use the NS node type */
510 Type = AcpiNsGetType (Node);
514 /* Check for circular references */
516 if (ObjDesc == Operand)
518 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
525 /* Get the type of this reference (index into another object) */
527 Type = ObjDesc->Reference.TargetType;
528 if (Type != ACPI_TYPE_PACKAGE)
534 * The main object is a package, we want to get the type
535 * of the individual package element that is referenced by
538 * This could of course in turn be another reference object.
540 ObjDesc = *(ObjDesc->Reference.Where);
543 /* NULL package elements are allowed */
545 Type = 0; /* Uninitialized */
556 Status = AcpiDsMethodDataGetValue (ObjDesc->Reference.Opcode,
557 ObjDesc->Reference.Offset, WalkState, &ObjDesc);
558 if (ACPI_FAILURE (Status))
560 return_ACPI_STATUS (Status);
562 AcpiUtRemoveReference (ObjDesc);
566 Status = AcpiDsMethodDataGetNode (ObjDesc->Reference.Opcode,
567 ObjDesc->Reference.Offset, WalkState, &Node);
568 if (ACPI_FAILURE (Status))
570 return_ACPI_STATUS (Status);
573 ObjDesc = AcpiNsGetAttachedObject (Node);
576 Type = ACPI_TYPE_ANY;
585 /* The Debug Object is of type "DebugObject" */
587 Type = ACPI_TYPE_DEBUG_OBJECT;
593 ACPI_ERROR ((AE_INFO,
594 "Unknown Reference subtype %X",
595 ObjDesc->Reference.Opcode));
596 return_ACPI_STATUS (AE_AML_INTERNAL);
601 * Now we are guaranteed to have an object that has not been created
602 * via the RefOf or Index operators.
604 Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
608 /* Convert internal types to external types */
612 case ACPI_TYPE_LOCAL_REGION_FIELD:
613 case ACPI_TYPE_LOCAL_BANK_FIELD:
614 case ACPI_TYPE_LOCAL_INDEX_FIELD:
616 Type = ACPI_TYPE_FIELD_UNIT;
619 case ACPI_TYPE_LOCAL_SCOPE:
621 /* Per ACPI Specification, Scope is untyped */
623 Type = ACPI_TYPE_ANY;
627 /* No change to Type required */
634 *ReturnDesc = ObjDesc;
636 return_ACPI_STATUS (AE_OK);