2 /******************************************************************************
4 * Module Name: exresolv - AML Interpreter object resolution
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
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>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("exresolv")
54 /* Local prototypes */
56 acpi_ex_resolve_object_to_value(union acpi_operand_object
**stack_ptr
,
57 struct acpi_walk_state
*walk_state
);
59 /*******************************************************************************
61 * FUNCTION: acpi_ex_resolve_to_value
63 * PARAMETERS: **stack_ptr - Points to entry on obj_stack, which can
64 * be either an (union acpi_operand_object *)
66 * walk_state - Current method state
70 * DESCRIPTION: Convert Reference objects to values
72 ******************************************************************************/
75 acpi_ex_resolve_to_value(union acpi_operand_object
**stack_ptr
,
76 struct acpi_walk_state
*walk_state
)
80 ACPI_FUNCTION_TRACE_PTR(ex_resolve_to_value
, stack_ptr
);
82 if (!stack_ptr
|| !*stack_ptr
) {
83 ACPI_ERROR((AE_INFO
, "Internal - null pointer"));
84 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
88 * The entity pointed to by the stack_ptr can be either
89 * 1) A valid union acpi_operand_object, or
90 * 2) A struct acpi_namespace_node (named_obj)
92 if (ACPI_GET_DESCRIPTOR_TYPE(*stack_ptr
) == ACPI_DESC_TYPE_OPERAND
) {
93 status
= acpi_ex_resolve_object_to_value(stack_ptr
, walk_state
);
94 if (ACPI_FAILURE(status
)) {
95 return_ACPI_STATUS(status
);
99 ACPI_ERROR((AE_INFO
, "Internal - null pointer"));
100 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
105 * Object on the stack may have changed if acpi_ex_resolve_object_to_value()
106 * was called (i.e., we can't use an _else_ here.)
108 if (ACPI_GET_DESCRIPTOR_TYPE(*stack_ptr
) == ACPI_DESC_TYPE_NAMED
) {
110 acpi_ex_resolve_node_to_value(ACPI_CAST_INDIRECT_PTR
111 (struct acpi_namespace_node
,
112 stack_ptr
), walk_state
);
113 if (ACPI_FAILURE(status
)) {
114 return_ACPI_STATUS(status
);
118 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Resolved object %p\n", *stack_ptr
));
119 return_ACPI_STATUS(AE_OK
);
122 /*******************************************************************************
124 * FUNCTION: acpi_ex_resolve_object_to_value
126 * PARAMETERS: stack_ptr - Pointer to an internal object
127 * walk_state - Current method state
131 * DESCRIPTION: Retrieve the value from an internal object. The Reference type
132 * uses the associated AML opcode to determine the value.
134 ******************************************************************************/
137 acpi_ex_resolve_object_to_value(union acpi_operand_object
**stack_ptr
,
138 struct acpi_walk_state
*walk_state
)
140 acpi_status status
= AE_OK
;
141 union acpi_operand_object
*stack_desc
;
142 union acpi_operand_object
*obj_desc
= NULL
;
145 ACPI_FUNCTION_TRACE(ex_resolve_object_to_value
);
147 stack_desc
= *stack_ptr
;
149 /* This is an union acpi_operand_object */
151 switch (ACPI_GET_OBJECT_TYPE(stack_desc
)) {
152 case ACPI_TYPE_LOCAL_REFERENCE
:
154 ref_type
= stack_desc
->reference
.class;
157 case ACPI_REFCLASS_LOCAL
:
158 case ACPI_REFCLASS_ARG
:
161 * Get the local from the method's state info
162 * Note: this increments the local's object reference count
164 status
= acpi_ds_method_data_get_value(ref_type
,
169 if (ACPI_FAILURE(status
)) {
170 return_ACPI_STATUS(status
);
173 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
174 "[Arg/Local %X] ValueObj is %p\n",
175 stack_desc
->reference
.value
,
179 * Now we can delete the original Reference Object and
180 * replace it with the resolved value
182 acpi_ut_remove_reference(stack_desc
);
183 *stack_ptr
= obj_desc
;
186 case ACPI_REFCLASS_INDEX
:
188 switch (stack_desc
->reference
.target_type
) {
189 case ACPI_TYPE_BUFFER_FIELD
:
191 /* Just return - do not dereference */
194 case ACPI_TYPE_PACKAGE
:
196 /* If method call or copy_object - do not dereference */
198 if ((walk_state
->opcode
==
199 AML_INT_METHODCALL_OP
)
200 || (walk_state
->opcode
== AML_COPY_OP
)) {
204 /* Otherwise, dereference the package_index to a package element */
206 obj_desc
= *stack_desc
->reference
.where
;
209 * Valid object descriptor, copy pointer to return value
210 * (i.e., dereference the package index)
211 * Delete the ref object, increment the returned object
213 acpi_ut_remove_reference(stack_desc
);
214 acpi_ut_add_reference(obj_desc
);
215 *stack_ptr
= obj_desc
;
218 * A NULL object descriptor means an uninitialized element of
219 * the package, can't dereference it
222 "Attempt to dereference an Index to NULL package element Idx=%p",
224 status
= AE_AML_UNINITIALIZED_ELEMENT
;
230 /* Invalid reference object */
233 "Unknown TargetType %X in Index/Reference object %p",
234 stack_desc
->reference
.target_type
,
236 status
= AE_AML_INTERNAL
;
241 case ACPI_REFCLASS_REFOF
:
242 case ACPI_REFCLASS_DEBUG
:
243 case ACPI_REFCLASS_TABLE
:
245 /* Just leave the object as-is, do not dereference */
249 case ACPI_REFCLASS_NAME
: /* Reference to a named object */
251 /* Dereference the name */
253 if ((stack_desc
->reference
.node
->type
==
255 || (stack_desc
->reference
.node
->type
==
256 ACPI_TYPE_THERMAL
)) {
258 /* These node types do not have 'real' subobjects */
260 *stack_ptr
= (void *)stack_desc
->reference
.node
;
262 /* Get the object pointed to by the namespace node */
265 (stack_desc
->reference
.node
)->object
;
266 acpi_ut_add_reference(*stack_ptr
);
269 acpi_ut_remove_reference(stack_desc
);
275 "Unknown Reference type %X in %p", ref_type
,
277 status
= AE_AML_INTERNAL
;
282 case ACPI_TYPE_BUFFER
:
284 status
= acpi_ds_get_buffer_arguments(stack_desc
);
287 case ACPI_TYPE_PACKAGE
:
289 status
= acpi_ds_get_package_arguments(stack_desc
);
292 case ACPI_TYPE_BUFFER_FIELD
:
293 case ACPI_TYPE_LOCAL_REGION_FIELD
:
294 case ACPI_TYPE_LOCAL_BANK_FIELD
:
295 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
297 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
298 "FieldRead SourceDesc=%p Type=%X\n",
300 ACPI_GET_OBJECT_TYPE(stack_desc
)));
303 acpi_ex_read_data_from_field(walk_state
, stack_desc
,
306 /* Remove a reference to the original operand, then override */
308 acpi_ut_remove_reference(*stack_ptr
);
309 *stack_ptr
= (void *)obj_desc
;
316 return_ACPI_STATUS(status
);
319 /*******************************************************************************
321 * FUNCTION: acpi_ex_resolve_multiple
323 * PARAMETERS: walk_state - Current state (contains AML opcode)
324 * Operand - Starting point for resolution
325 * return_type - Where the object type is returned
326 * return_desc - Where the resolved object is returned
330 * DESCRIPTION: Return the base object and type. Traverse a reference list if
331 * necessary to get to the base object.
333 ******************************************************************************/
336 acpi_ex_resolve_multiple(struct acpi_walk_state
*walk_state
,
337 union acpi_operand_object
*operand
,
338 acpi_object_type
* return_type
,
339 union acpi_operand_object
**return_desc
)
341 union acpi_operand_object
*obj_desc
= (void *)operand
;
342 struct acpi_namespace_node
*node
;
343 acpi_object_type type
;
346 ACPI_FUNCTION_TRACE(acpi_ex_resolve_multiple
);
348 /* Operand can be either a namespace node or an operand descriptor */
350 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
)) {
351 case ACPI_DESC_TYPE_OPERAND
:
352 type
= obj_desc
->common
.type
;
355 case ACPI_DESC_TYPE_NAMED
:
356 type
= ((struct acpi_namespace_node
*)obj_desc
)->type
;
358 acpi_ns_get_attached_object((struct acpi_namespace_node
*)
361 /* If we had an Alias node, use the attached object for type info */
363 if (type
== ACPI_TYPE_LOCAL_ALIAS
) {
364 type
= ((struct acpi_namespace_node
*)obj_desc
)->type
;
366 acpi_ns_get_attached_object((struct
367 acpi_namespace_node
*)
373 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
376 /* If type is anything other than a reference, we are done */
378 if (type
!= ACPI_TYPE_LOCAL_REFERENCE
) {
383 * For reference objects created via the ref_of, Index, or Load/load_table
384 * operators, we need to get to the base object (as per the ACPI
385 * specification of the object_type and size_of operators). This means
386 * traversing the list of possibly many nested references.
388 while (ACPI_GET_OBJECT_TYPE(obj_desc
) == ACPI_TYPE_LOCAL_REFERENCE
) {
389 switch (obj_desc
->reference
.class) {
390 case ACPI_REFCLASS_REFOF
:
391 case ACPI_REFCLASS_NAME
:
393 /* Dereference the reference pointer */
395 if (obj_desc
->reference
.class == ACPI_REFCLASS_REFOF
) {
396 node
= obj_desc
->reference
.object
;
397 } else { /* AML_INT_NAMEPATH_OP */
399 node
= obj_desc
->reference
.node
;
402 /* All "References" point to a NS node */
404 if (ACPI_GET_DESCRIPTOR_TYPE(node
) !=
405 ACPI_DESC_TYPE_NAMED
) {
406 ACPI_ERROR((AE_INFO
, "Not a NS node %p [%s]",
408 acpi_ut_get_descriptor_name(node
)));
409 return_ACPI_STATUS(AE_AML_INTERNAL
);
412 /* Get the attached object */
414 obj_desc
= acpi_ns_get_attached_object(node
);
417 /* No object, use the NS node type */
419 type
= acpi_ns_get_type(node
);
423 /* Check for circular references */
425 if (obj_desc
== operand
) {
426 return_ACPI_STATUS(AE_AML_CIRCULAR_REFERENCE
);
430 case ACPI_REFCLASS_INDEX
:
432 /* Get the type of this reference (index into another object) */
434 type
= obj_desc
->reference
.target_type
;
435 if (type
!= ACPI_TYPE_PACKAGE
) {
440 * The main object is a package, we want to get the type
441 * of the individual package element that is referenced by
444 * This could of course in turn be another reference object.
446 obj_desc
= *(obj_desc
->reference
.where
);
449 /* NULL package elements are allowed */
451 type
= 0; /* Uninitialized */
456 case ACPI_REFCLASS_TABLE
:
458 type
= ACPI_TYPE_DDB_HANDLE
;
461 case ACPI_REFCLASS_LOCAL
:
462 case ACPI_REFCLASS_ARG
:
466 acpi_ds_method_data_get_value(obj_desc
->
474 if (ACPI_FAILURE(status
)) {
475 return_ACPI_STATUS(status
);
477 acpi_ut_remove_reference(obj_desc
);
480 acpi_ds_method_data_get_node(obj_desc
->
488 if (ACPI_FAILURE(status
)) {
489 return_ACPI_STATUS(status
);
492 obj_desc
= acpi_ns_get_attached_object(node
);
494 type
= ACPI_TYPE_ANY
;
500 case ACPI_REFCLASS_DEBUG
:
502 /* The Debug Object is of type "DebugObject" */
504 type
= ACPI_TYPE_DEBUG_OBJECT
;
510 "Unknown Reference Class %2.2X",
511 obj_desc
->reference
.class));
512 return_ACPI_STATUS(AE_AML_INTERNAL
);
517 * Now we are guaranteed to have an object that has not been created
518 * via the ref_of or Index operators.
520 type
= ACPI_GET_OBJECT_TYPE(obj_desc
);
523 /* Convert internal types to external types */
526 case ACPI_TYPE_LOCAL_REGION_FIELD
:
527 case ACPI_TYPE_LOCAL_BANK_FIELD
:
528 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
530 type
= ACPI_TYPE_FIELD_UNIT
;
533 case ACPI_TYPE_LOCAL_SCOPE
:
535 /* Per ACPI Specification, Scope is untyped */
537 type
= ACPI_TYPE_ANY
;
541 /* No change to Type required */
547 *return_desc
= obj_desc
;
549 return_ACPI_STATUS(AE_OK
);