2 /******************************************************************************
4 * Module Name: exresolv - AML Interpreter object resolution
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acdispat.h>
48 #include <acpi/acinterp.h>
49 #include <acpi/acnamesp.h>
50 #include <acpi/acparser.h>
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME("exresolv")
55 /* Local prototypes */
57 acpi_ex_resolve_object_to_value(union acpi_operand_object **stack_ptr,
58 struct acpi_walk_state *walk_state);
60 /*******************************************************************************
62 * FUNCTION: acpi_ex_resolve_to_value
64 * PARAMETERS: **stack_ptr - Points to entry on obj_stack, which can
65 * be either an (union acpi_operand_object *)
67 * walk_state - Current method state
71 * DESCRIPTION: Convert Reference objects to values
73 ******************************************************************************/
76 acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
77 struct acpi_walk_state *walk_state)
81 ACPI_FUNCTION_TRACE_PTR("ex_resolve_to_value", stack_ptr);
83 if (!stack_ptr || !*stack_ptr) {
84 ACPI_REPORT_ERROR(("Internal - null pointer\n"));
85 return_ACPI_STATUS(AE_AML_NO_OPERAND);
89 * The entity pointed to by the stack_ptr can be either
90 * 1) A valid union acpi_operand_object, or
91 * 2) A struct acpi_namespace_node (named_obj)
93 if (ACPI_GET_DESCRIPTOR_TYPE(*stack_ptr) == ACPI_DESC_TYPE_OPERAND) {
94 status = acpi_ex_resolve_object_to_value(stack_ptr, walk_state);
95 if (ACPI_FAILURE(status)) {
96 return_ACPI_STATUS(status);
100 ACPI_REPORT_ERROR(("Internal - null pointer\n"));
101 return_ACPI_STATUS(AE_AML_NO_OPERAND);
106 * Object on the stack may have changed if acpi_ex_resolve_object_to_value()
107 * was called (i.e., we can't use an _else_ here.)
109 if (ACPI_GET_DESCRIPTOR_TYPE(*stack_ptr) == ACPI_DESC_TYPE_NAMED) {
111 acpi_ex_resolve_node_to_value(ACPI_CAST_INDIRECT_PTR
112 (struct acpi_namespace_node,
113 stack_ptr), walk_state);
114 if (ACPI_FAILURE(status)) {
115 return_ACPI_STATUS(status);
119 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Resolved object %p\n", *stack_ptr));
120 return_ACPI_STATUS(AE_OK);
123 /*******************************************************************************
125 * FUNCTION: acpi_ex_resolve_object_to_value
127 * PARAMETERS: stack_ptr - Pointer to an internal object
128 * walk_state - Current method state
132 * DESCRIPTION: Retrieve the value from an internal object. The Reference type
133 * uses the associated AML opcode to determine the value.
135 ******************************************************************************/
138 acpi_ex_resolve_object_to_value(union acpi_operand_object **stack_ptr,
139 struct acpi_walk_state *walk_state)
141 acpi_status status = AE_OK;
142 union acpi_operand_object *stack_desc;
144 union acpi_operand_object *obj_desc;
147 ACPI_FUNCTION_TRACE("ex_resolve_object_to_value");
149 stack_desc = *stack_ptr;
151 /* This is an union acpi_operand_object */
153 switch (ACPI_GET_OBJECT_TYPE(stack_desc)) {
154 case ACPI_TYPE_LOCAL_REFERENCE:
156 opcode = stack_desc->reference.opcode;
162 * Convert name reference to a namespace node
163 * Then, acpi_ex_resolve_node_to_value can be used to get the value
165 temp_node = stack_desc->reference.object;
167 /* Delete the Reference Object */
169 acpi_ut_remove_reference(stack_desc);
171 /* Return the namespace node */
173 (*stack_ptr) = temp_node;
180 * Get the local from the method's state info
181 * Note: this increments the local's object reference count
183 status = acpi_ds_method_data_get_value(opcode,
188 if (ACPI_FAILURE(status)) {
189 return_ACPI_STATUS(status);
192 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
193 "[Arg/Local %X] value_obj is %p\n",
194 stack_desc->reference.offset,
198 * Now we can delete the original Reference Object and
199 * replace it with the resolved value
201 acpi_ut_remove_reference(stack_desc);
202 *stack_ptr = obj_desc;
207 switch (stack_desc->reference.target_type) {
208 case ACPI_TYPE_BUFFER_FIELD:
210 /* Just return - leave the Reference on the stack */
213 case ACPI_TYPE_PACKAGE:
215 obj_desc = *stack_desc->reference.where;
218 * Valid obj descriptor, copy pointer to return value
219 * (i.e., dereference the package index)
220 * Delete the ref object, increment the returned object
222 acpi_ut_remove_reference(stack_desc);
223 acpi_ut_add_reference(obj_desc);
224 *stack_ptr = obj_desc;
227 * A NULL object descriptor means an unitialized element of
228 * the package, can't dereference it
230 ACPI_REPORT_ERROR(("Attempt to deref an Index to NULL pkg element Idx=%p\n", stack_desc));
231 status = AE_AML_UNINITIALIZED_ELEMENT;
237 /* Invalid reference object */
239 ACPI_REPORT_ERROR(("Unknown target_type %X in Index/Reference obj %p\n", stack_desc->reference.target_type, stack_desc));
240 status = AE_AML_INTERNAL;
249 /* Just leave the object as-is */
253 case AML_INT_NAMEPATH_OP: /* Reference to a named object */
255 /* Get the object pointed to by the namespace node */
257 *stack_ptr = (stack_desc->reference.node)->object;
258 acpi_ut_add_reference(*stack_ptr);
259 acpi_ut_remove_reference(stack_desc);
264 ACPI_REPORT_ERROR(("Unknown Reference opcode %X (%s) in %p\n", opcode, acpi_ps_get_opcode_name(opcode), stack_desc));
265 status = AE_AML_INTERNAL;
270 case ACPI_TYPE_BUFFER:
272 status = acpi_ds_get_buffer_arguments(stack_desc);
275 case ACPI_TYPE_PACKAGE:
277 status = acpi_ds_get_package_arguments(stack_desc);
280 /* These cases may never happen here, but just in case.. */
282 case ACPI_TYPE_BUFFER_FIELD:
283 case ACPI_TYPE_LOCAL_REGION_FIELD:
284 case ACPI_TYPE_LOCAL_BANK_FIELD:
285 case ACPI_TYPE_LOCAL_INDEX_FIELD:
287 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
288 "field_read source_desc=%p Type=%X\n",
290 ACPI_GET_OBJECT_TYPE(stack_desc)));
293 acpi_ex_read_data_from_field(walk_state, stack_desc,
295 *stack_ptr = (void *)obj_desc;
302 return_ACPI_STATUS(status);
305 /*******************************************************************************
307 * FUNCTION: acpi_ex_resolve_multiple
309 * PARAMETERS: walk_state - Current state (contains AML opcode)
310 * Operand - Starting point for resolution
311 * return_type - Where the object type is returned
312 * return_desc - Where the resolved object is returned
316 * DESCRIPTION: Return the base object and type. Traverse a reference list if
317 * necessary to get to the base object.
319 ******************************************************************************/
322 acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
323 union acpi_operand_object *operand,
324 acpi_object_type * return_type,
325 union acpi_operand_object **return_desc)
327 union acpi_operand_object *obj_desc = (void *)operand;
328 struct acpi_namespace_node *node;
329 acpi_object_type type;
332 ACPI_FUNCTION_TRACE("acpi_ex_resolve_multiple");
334 /* Operand can be either a namespace node or an operand descriptor */
336 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
337 case ACPI_DESC_TYPE_OPERAND:
338 type = obj_desc->common.type;
341 case ACPI_DESC_TYPE_NAMED:
342 type = ((struct acpi_namespace_node *)obj_desc)->type;
344 acpi_ns_get_attached_object((struct acpi_namespace_node *)
347 /* If we had an Alias node, use the attached object for type info */
349 if (type == ACPI_TYPE_LOCAL_ALIAS) {
350 type = ((struct acpi_namespace_node *)obj_desc)->type;
352 acpi_ns_get_attached_object((struct
353 acpi_namespace_node *)
359 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
362 /* If type is anything other than a reference, we are done */
364 if (type != ACPI_TYPE_LOCAL_REFERENCE) {
369 * For reference objects created via the ref_of or Index operators,
370 * we need to get to the base object (as per the ACPI specification
371 * of the object_type and size_of operators). This means traversing
372 * the list of possibly many nested references.
374 while (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_REFERENCE) {
375 switch (obj_desc->reference.opcode) {
378 /* Dereference the reference pointer */
380 node = obj_desc->reference.object;
382 /* All "References" point to a NS node */
384 if (ACPI_GET_DESCRIPTOR_TYPE(node) !=
385 ACPI_DESC_TYPE_NAMED) {
386 ACPI_REPORT_ERROR(("Not a NS node %p [%s]\n",
388 acpi_ut_get_descriptor_name
390 return_ACPI_STATUS(AE_AML_INTERNAL);
393 /* Get the attached object */
395 obj_desc = acpi_ns_get_attached_object(node);
397 /* No object, use the NS node type */
399 type = acpi_ns_get_type(node);
403 /* Check for circular references */
405 if (obj_desc == operand) {
406 return_ACPI_STATUS(AE_AML_CIRCULAR_REFERENCE);
412 /* Get the type of this reference (index into another object) */
414 type = obj_desc->reference.target_type;
415 if (type != ACPI_TYPE_PACKAGE) {
420 * The main object is a package, we want to get the type
421 * of the individual package element that is referenced by
424 * This could of course in turn be another reference object.
426 obj_desc = *(obj_desc->reference.where);
428 /* NULL package elements are allowed */
430 type = 0; /* Uninitialized */
435 case AML_INT_NAMEPATH_OP:
437 /* Dereference the reference pointer */
439 node = obj_desc->reference.node;
441 /* All "References" point to a NS node */
443 if (ACPI_GET_DESCRIPTOR_TYPE(node) !=
444 ACPI_DESC_TYPE_NAMED) {
445 ACPI_REPORT_ERROR(("Not a NS node %p [%s]\n",
447 acpi_ut_get_descriptor_name
449 return_ACPI_STATUS(AE_AML_INTERNAL);
452 /* Get the attached object */
454 obj_desc = acpi_ns_get_attached_object(node);
456 /* No object, use the NS node type */
458 type = acpi_ns_get_type(node);
462 /* Check for circular references */
464 if (obj_desc == operand) {
465 return_ACPI_STATUS(AE_AML_CIRCULAR_REFERENCE);
474 acpi_ds_method_data_get_value(obj_desc->
482 if (ACPI_FAILURE(status)) {
483 return_ACPI_STATUS(status);
485 acpi_ut_remove_reference(obj_desc);
488 acpi_ds_method_data_get_node(obj_desc->
496 if (ACPI_FAILURE(status)) {
497 return_ACPI_STATUS(status);
500 obj_desc = acpi_ns_get_attached_object(node);
502 type = ACPI_TYPE_ANY;
510 /* The Debug Object is of type "debug_object" */
512 type = ACPI_TYPE_DEBUG_OBJECT;
517 ACPI_REPORT_ERROR(("Unknown Reference subtype %X\n",
518 obj_desc->reference.opcode));
519 return_ACPI_STATUS(AE_AML_INTERNAL);
524 * Now we are guaranteed to have an object that has not been created
525 * via the ref_of or Index operators.
527 type = ACPI_GET_OBJECT_TYPE(obj_desc);
530 /* Convert internal types to external types */
533 case ACPI_TYPE_LOCAL_REGION_FIELD:
534 case ACPI_TYPE_LOCAL_BANK_FIELD:
535 case ACPI_TYPE_LOCAL_INDEX_FIELD:
537 type = ACPI_TYPE_FIELD_UNIT;
540 case ACPI_TYPE_LOCAL_SCOPE:
542 /* Per ACPI Specification, Scope is untyped */
544 type = ACPI_TYPE_ANY;
548 /* No change to Type required */
554 *return_desc = obj_desc;
556 return_ACPI_STATUS(AE_OK);