fat: provide option for setting timezone offset
[linux-2.6/libata-dev.git] / drivers / acpi / acpica / exresolv.c
blobcc176b245e22063bccb92bfa48ed0b8fb7a6df8d
1 /******************************************************************************
3 * Module Name: exresolv - AML Interpreter object resolution
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2012, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "amlcode.h"
47 #include "acdispat.h"
48 #include "acinterp.h"
49 #include "acnamesp.h"
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("exresolv")
54 /* Local prototypes */
55 static acpi_status
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 *)
65 * or an acpi_handle.
66 * walk_state - Current method state
68 * RETURN: Status
70 * DESCRIPTION: Convert Reference objects to values
72 ******************************************************************************/
74 acpi_status
75 acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
76 struct acpi_walk_state *walk_state)
78 acpi_status status;
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);
98 if (!*stack_ptr) {
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) {
109 status =
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
129 * RETURN: Status
131 * DESCRIPTION: Retrieve the value from an internal object. The Reference type
132 * uses the associated AML opcode to determine the value.
134 ******************************************************************************/
136 static acpi_status
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;
143 u8 ref_type;
145 ACPI_FUNCTION_TRACE(ex_resolve_object_to_value);
147 stack_desc = *stack_ptr;
149 /* This is an object of type union acpi_operand_object */
151 switch (stack_desc->common.type) {
152 case ACPI_TYPE_LOCAL_REFERENCE:
154 ref_type = stack_desc->reference.class;
156 switch (ref_type) {
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,
165 stack_desc->
166 reference.value,
167 walk_state,
168 &obj_desc);
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,
176 obj_desc));
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;
184 break;
186 case ACPI_REFCLASS_INDEX:
188 switch (stack_desc->reference.target_type) {
189 case ACPI_TYPE_BUFFER_FIELD:
191 /* Just return - do not dereference */
192 break;
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)) {
201 break;
204 /* Otherwise, dereference the package_index to a package element */
206 obj_desc = *stack_desc->reference.where;
207 if (obj_desc) {
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;
216 } else {
218 * A NULL object descriptor means an uninitialized element of
219 * the package, can't dereference it
221 ACPI_ERROR((AE_INFO,
222 "Attempt to dereference an Index to NULL package element Idx=%p",
223 stack_desc));
224 status = AE_AML_UNINITIALIZED_ELEMENT;
226 break;
228 default:
230 /* Invalid reference object */
232 ACPI_ERROR((AE_INFO,
233 "Unknown TargetType 0x%X in Index/Reference object %p",
234 stack_desc->reference.target_type,
235 stack_desc));
236 status = AE_AML_INTERNAL;
237 break;
239 break;
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 */
247 break;
249 case ACPI_REFCLASS_NAME: /* Reference to a named object */
251 /* Dereference the name */
253 if ((stack_desc->reference.node->type ==
254 ACPI_TYPE_DEVICE)
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;
261 } else {
262 /* Get the object pointed to by the namespace node */
264 *stack_ptr =
265 (stack_desc->reference.node)->object;
266 acpi_ut_add_reference(*stack_ptr);
269 acpi_ut_remove_reference(stack_desc);
270 break;
272 default:
274 ACPI_ERROR((AE_INFO,
275 "Unknown Reference type 0x%X in %p",
276 ref_type, stack_desc));
277 status = AE_AML_INTERNAL;
278 break;
280 break;
282 case ACPI_TYPE_BUFFER:
284 status = acpi_ds_get_buffer_arguments(stack_desc);
285 break;
287 case ACPI_TYPE_PACKAGE:
289 status = acpi_ds_get_package_arguments(stack_desc);
290 break;
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",
299 stack_desc, stack_desc->common.type));
301 status =
302 acpi_ex_read_data_from_field(walk_state, stack_desc,
303 &obj_desc);
305 /* Remove a reference to the original operand, then override */
307 acpi_ut_remove_reference(*stack_ptr);
308 *stack_ptr = (void *)obj_desc;
309 break;
311 default:
312 break;
315 return_ACPI_STATUS(status);
318 /*******************************************************************************
320 * FUNCTION: acpi_ex_resolve_multiple
322 * PARAMETERS: walk_state - Current state (contains AML opcode)
323 * operand - Starting point for resolution
324 * return_type - Where the object type is returned
325 * return_desc - Where the resolved object is returned
327 * RETURN: Status
329 * DESCRIPTION: Return the base object and type. Traverse a reference list if
330 * necessary to get to the base object.
332 ******************************************************************************/
334 acpi_status
335 acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
336 union acpi_operand_object *operand,
337 acpi_object_type * return_type,
338 union acpi_operand_object **return_desc)
340 union acpi_operand_object *obj_desc = (void *)operand;
341 struct acpi_namespace_node *node;
342 acpi_object_type type;
343 acpi_status status;
345 ACPI_FUNCTION_TRACE(acpi_ex_resolve_multiple);
347 /* Operand can be either a namespace node or an operand descriptor */
349 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
350 case ACPI_DESC_TYPE_OPERAND:
351 type = obj_desc->common.type;
352 break;
354 case ACPI_DESC_TYPE_NAMED:
355 type = ((struct acpi_namespace_node *)obj_desc)->type;
356 obj_desc =
357 acpi_ns_get_attached_object((struct acpi_namespace_node *)
358 obj_desc);
360 /* If we had an Alias node, use the attached object for type info */
362 if (type == ACPI_TYPE_LOCAL_ALIAS) {
363 type = ((struct acpi_namespace_node *)obj_desc)->type;
364 obj_desc =
365 acpi_ns_get_attached_object((struct
366 acpi_namespace_node *)
367 obj_desc);
369 break;
371 default:
372 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
375 /* If type is anything other than a reference, we are done */
377 if (type != ACPI_TYPE_LOCAL_REFERENCE) {
378 goto exit;
382 * For reference objects created via the ref_of, Index, or Load/load_table
383 * operators, we need to get to the base object (as per the ACPI
384 * specification of the object_type and size_of operators). This means
385 * traversing the list of possibly many nested references.
387 while (obj_desc->common.type == ACPI_TYPE_LOCAL_REFERENCE) {
388 switch (obj_desc->reference.class) {
389 case ACPI_REFCLASS_REFOF:
390 case ACPI_REFCLASS_NAME:
392 /* Dereference the reference pointer */
394 if (obj_desc->reference.class == ACPI_REFCLASS_REFOF) {
395 node = obj_desc->reference.object;
396 } else { /* AML_INT_NAMEPATH_OP */
398 node = obj_desc->reference.node;
401 /* All "References" point to a NS node */
403 if (ACPI_GET_DESCRIPTOR_TYPE(node) !=
404 ACPI_DESC_TYPE_NAMED) {
405 ACPI_ERROR((AE_INFO,
406 "Not a namespace node %p [%s]",
407 node,
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);
415 if (!obj_desc) {
417 /* No object, use the NS node type */
419 type = acpi_ns_get_type(node);
420 goto exit;
423 /* Check for circular references */
425 if (obj_desc == operand) {
426 return_ACPI_STATUS(AE_AML_CIRCULAR_REFERENCE);
428 break;
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) {
436 goto exit;
440 * The main object is a package, we want to get the type
441 * of the individual package element that is referenced by
442 * the index.
444 * This could of course in turn be another reference object.
446 obj_desc = *(obj_desc->reference.where);
447 if (!obj_desc) {
449 /* NULL package elements are allowed */
451 type = 0; /* Uninitialized */
452 goto exit;
454 break;
456 case ACPI_REFCLASS_TABLE:
458 type = ACPI_TYPE_DDB_HANDLE;
459 goto exit;
461 case ACPI_REFCLASS_LOCAL:
462 case ACPI_REFCLASS_ARG:
464 if (return_desc) {
465 status =
466 acpi_ds_method_data_get_value(obj_desc->
467 reference.
468 class,
469 obj_desc->
470 reference.
471 value,
472 walk_state,
473 &obj_desc);
474 if (ACPI_FAILURE(status)) {
475 return_ACPI_STATUS(status);
477 acpi_ut_remove_reference(obj_desc);
478 } else {
479 status =
480 acpi_ds_method_data_get_node(obj_desc->
481 reference.
482 class,
483 obj_desc->
484 reference.
485 value,
486 walk_state,
487 &node);
488 if (ACPI_FAILURE(status)) {
489 return_ACPI_STATUS(status);
492 obj_desc = acpi_ns_get_attached_object(node);
493 if (!obj_desc) {
494 type = ACPI_TYPE_ANY;
495 goto exit;
498 break;
500 case ACPI_REFCLASS_DEBUG:
502 /* The Debug Object is of type "DebugObject" */
504 type = ACPI_TYPE_DEBUG_OBJECT;
505 goto exit;
507 default:
509 ACPI_ERROR((AE_INFO,
510 "Unknown Reference Class 0x%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 = obj_desc->common.type;
522 exit:
523 /* Convert internal types to external types */
525 switch (type) {
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;
531 break;
533 case ACPI_TYPE_LOCAL_SCOPE:
535 /* Per ACPI Specification, Scope is untyped */
537 type = ACPI_TYPE_ANY;
538 break;
540 default:
541 /* No change to Type required */
542 break;
545 *return_type = type;
546 if (return_desc) {
547 *return_desc = obj_desc;
549 return_ACPI_STATUS(AE_OK);