ACPICA: Cleanup for internal Reference Object
[linux-2.6/mini2440.git] / drivers / acpi / dispatcher / dsmthdat.c
blobd03f81bd1bcb01f02cd6704732c37d54a2ae6822
1 /*******************************************************************************
3 * Module Name: dsmthdat - control method arguments and local variables
5 ******************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2008, 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 <acpi/acdispat.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acinterp.h>
49 #define _COMPONENT ACPI_DISPATCHER
50 ACPI_MODULE_NAME("dsmthdat")
52 /* Local prototypes */
53 static void
54 acpi_ds_method_data_delete_value(u8 type,
55 u32 index, struct acpi_walk_state *walk_state);
57 static acpi_status
58 acpi_ds_method_data_set_value(u8 type,
59 u32 index,
60 union acpi_operand_object *object,
61 struct acpi_walk_state *walk_state);
63 #ifdef ACPI_OBSOLETE_FUNCTIONS
64 acpi_object_type
65 acpi_ds_method_data_get_type(u16 opcode,
66 u32 index, struct acpi_walk_state *walk_state);
67 #endif
69 /*******************************************************************************
71 * FUNCTION: acpi_ds_method_data_init
73 * PARAMETERS: walk_state - Current walk state object
75 * RETURN: Status
77 * DESCRIPTION: Initialize the data structures that hold the method's arguments
78 * and locals. The data struct is an array of namespace nodes for
79 * each - this allows ref_of and de_ref_of to work properly for these
80 * special data types.
82 * NOTES: walk_state fields are initialized to zero by the
83 * ACPI_ALLOCATE_ZEROED().
85 * A pseudo-Namespace Node is assigned to each argument and local
86 * so that ref_of() can return a pointer to the Node.
88 ******************************************************************************/
90 void acpi_ds_method_data_init(struct acpi_walk_state *walk_state)
92 u32 i;
94 ACPI_FUNCTION_TRACE(ds_method_data_init);
96 /* Init the method arguments */
98 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) {
99 ACPI_MOVE_32_TO_32(&walk_state->arguments[i].name,
100 NAMEOF_ARG_NTE);
101 walk_state->arguments[i].name.integer |= (i << 24);
102 walk_state->arguments[i].descriptor_type = ACPI_DESC_TYPE_NAMED;
103 walk_state->arguments[i].type = ACPI_TYPE_ANY;
104 walk_state->arguments[i].flags =
105 ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_ARG;
108 /* Init the method locals */
110 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) {
111 ACPI_MOVE_32_TO_32(&walk_state->local_variables[i].name,
112 NAMEOF_LOCAL_NTE);
114 walk_state->local_variables[i].name.integer |= (i << 24);
115 walk_state->local_variables[i].descriptor_type =
116 ACPI_DESC_TYPE_NAMED;
117 walk_state->local_variables[i].type = ACPI_TYPE_ANY;
118 walk_state->local_variables[i].flags =
119 ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_LOCAL;
122 return_VOID;
125 /*******************************************************************************
127 * FUNCTION: acpi_ds_method_data_delete_all
129 * PARAMETERS: walk_state - Current walk state object
131 * RETURN: None
133 * DESCRIPTION: Delete method locals and arguments. Arguments are only
134 * deleted if this method was called from another method.
136 ******************************************************************************/
138 void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state)
140 u32 index;
142 ACPI_FUNCTION_TRACE(ds_method_data_delete_all);
144 /* Detach the locals */
146 for (index = 0; index < ACPI_METHOD_NUM_LOCALS; index++) {
147 if (walk_state->local_variables[index].object) {
148 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Local%d=%p\n",
149 index,
150 walk_state->local_variables[index].
151 object));
153 /* Detach object (if present) and remove a reference */
155 acpi_ns_detach_object(&walk_state->
156 local_variables[index]);
160 /* Detach the arguments */
162 for (index = 0; index < ACPI_METHOD_NUM_ARGS; index++) {
163 if (walk_state->arguments[index].object) {
164 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Arg%d=%p\n",
165 index,
166 walk_state->arguments[index].object));
168 /* Detach object (if present) and remove a reference */
170 acpi_ns_detach_object(&walk_state->arguments[index]);
174 return_VOID;
177 /*******************************************************************************
179 * FUNCTION: acpi_ds_method_data_init_args
181 * PARAMETERS: *Params - Pointer to a parameter list for the method
182 * max_param_count - The arg count for this method
183 * walk_state - Current walk state object
185 * RETURN: Status
187 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
188 * of ACPI operand objects, either null terminated or whose length
189 * is defined by max_param_count.
191 ******************************************************************************/
193 acpi_status
194 acpi_ds_method_data_init_args(union acpi_operand_object **params,
195 u32 max_param_count,
196 struct acpi_walk_state *walk_state)
198 acpi_status status;
199 u32 index = 0;
201 ACPI_FUNCTION_TRACE_PTR(ds_method_data_init_args, params);
203 if (!params) {
204 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
205 "No param list passed to method\n"));
206 return_ACPI_STATUS(AE_OK);
209 /* Copy passed parameters into the new method stack frame */
211 while ((index < ACPI_METHOD_NUM_ARGS) &&
212 (index < max_param_count) && params[index]) {
214 * A valid parameter.
215 * Store the argument in the method/walk descriptor.
216 * Do not copy the arg in order to implement call by reference
218 status = acpi_ds_method_data_set_value(ACPI_REFCLASS_ARG, index,
219 params[index],
220 walk_state);
221 if (ACPI_FAILURE(status)) {
222 return_ACPI_STATUS(status);
225 index++;
228 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%d args passed to method\n", index));
229 return_ACPI_STATUS(AE_OK);
232 /*******************************************************************************
234 * FUNCTION: acpi_ds_method_data_get_node
236 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
237 * ACPI_REFCLASS_ARG
238 * Index - Which Local or Arg whose type to get
239 * walk_state - Current walk state object
240 * Node - Where the node is returned.
242 * RETURN: Status and node
244 * DESCRIPTION: Get the Node associated with a local or arg.
246 ******************************************************************************/
248 acpi_status
249 acpi_ds_method_data_get_node(u8 type,
250 u32 index,
251 struct acpi_walk_state *walk_state,
252 struct acpi_namespace_node **node)
254 ACPI_FUNCTION_TRACE(ds_method_data_get_node);
257 * Method Locals and Arguments are supported
259 switch (type) {
260 case ACPI_REFCLASS_LOCAL:
262 if (index > ACPI_METHOD_MAX_LOCAL) {
263 ACPI_ERROR((AE_INFO,
264 "Local index %d is invalid (max %d)",
265 index, ACPI_METHOD_MAX_LOCAL));
266 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
269 /* Return a pointer to the pseudo-node */
271 *node = &walk_state->local_variables[index];
272 break;
274 case ACPI_REFCLASS_ARG:
276 if (index > ACPI_METHOD_MAX_ARG) {
277 ACPI_ERROR((AE_INFO,
278 "Arg index %d is invalid (max %d)",
279 index, ACPI_METHOD_MAX_ARG));
280 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
283 /* Return a pointer to the pseudo-node */
285 *node = &walk_state->arguments[index];
286 break;
288 default:
289 ACPI_ERROR((AE_INFO, "Type %d is invalid", type));
290 return_ACPI_STATUS(AE_TYPE);
293 return_ACPI_STATUS(AE_OK);
296 /*******************************************************************************
298 * FUNCTION: acpi_ds_method_data_set_value
300 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
301 * ACPI_REFCLASS_ARG
302 * Index - Which Local or Arg to get
303 * Object - Object to be inserted into the stack entry
304 * walk_state - Current walk state object
306 * RETURN: Status
308 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
309 * Note: There is no "implicit conversion" for locals.
311 ******************************************************************************/
313 static acpi_status
314 acpi_ds_method_data_set_value(u8 type,
315 u32 index,
316 union acpi_operand_object *object,
317 struct acpi_walk_state *walk_state)
319 acpi_status status;
320 struct acpi_namespace_node *node;
322 ACPI_FUNCTION_TRACE(ds_method_data_set_value);
324 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
325 "NewObj %p Type %2.2X, Refs=%d [%s]\n", object,
326 type, object->common.reference_count,
327 acpi_ut_get_type_name(object->common.type)));
329 /* Get the namespace node for the arg/local */
331 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
332 if (ACPI_FAILURE(status)) {
333 return_ACPI_STATUS(status);
337 * Increment ref count so object can't be deleted while installed.
338 * NOTE: We do not copy the object in order to preserve the call by
339 * reference semantics of ACPI Control Method invocation.
340 * (See ACPI Specification 2.0_c)
342 acpi_ut_add_reference(object);
344 /* Install the object */
346 node->object = object;
347 return_ACPI_STATUS(status);
350 /*******************************************************************************
352 * FUNCTION: acpi_ds_method_data_get_value
354 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
355 * ACPI_REFCLASS_ARG
356 * Index - Which local_var or argument to get
357 * walk_state - Current walk state object
358 * dest_desc - Where Arg or Local value is returned
360 * RETURN: Status
362 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
363 * Used only in acpi_ex_resolve_to_value().
365 ******************************************************************************/
367 acpi_status
368 acpi_ds_method_data_get_value(u8 type,
369 u32 index,
370 struct acpi_walk_state *walk_state,
371 union acpi_operand_object **dest_desc)
373 acpi_status status;
374 struct acpi_namespace_node *node;
375 union acpi_operand_object *object;
377 ACPI_FUNCTION_TRACE(ds_method_data_get_value);
379 /* Validate the object descriptor */
381 if (!dest_desc) {
382 ACPI_ERROR((AE_INFO, "Null object descriptor pointer"));
383 return_ACPI_STATUS(AE_BAD_PARAMETER);
386 /* Get the namespace node for the arg/local */
388 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
389 if (ACPI_FAILURE(status)) {
390 return_ACPI_STATUS(status);
393 /* Get the object from the node */
395 object = node->object;
397 /* Examine the returned object, it must be valid. */
399 if (!object) {
401 * Index points to uninitialized object.
402 * This means that either 1) The expected argument was
403 * not passed to the method, or 2) A local variable
404 * was referenced by the method (via the ASL)
405 * before it was initialized. Either case is an error.
408 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
410 if (acpi_gbl_enable_interpreter_slack) {
411 object =
412 acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
413 if (!object) {
414 return_ACPI_STATUS(AE_NO_MEMORY);
417 object->integer.value = 0;
418 node->object = object;
421 /* Otherwise, return the error */
423 else
424 switch (type) {
425 case ACPI_REFCLASS_ARG:
427 ACPI_ERROR((AE_INFO,
428 "Uninitialized Arg[%d] at node %p",
429 index, node));
431 return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG);
433 case ACPI_REFCLASS_LOCAL:
435 ACPI_ERROR((AE_INFO,
436 "Uninitialized Local[%d] at node %p",
437 index, node));
439 return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL);
441 default:
443 ACPI_ERROR((AE_INFO,
444 "Not a Arg/Local opcode: %X",
445 type));
446 return_ACPI_STATUS(AE_AML_INTERNAL);
451 * The Index points to an initialized and valid object.
452 * Return an additional reference to the object
454 *dest_desc = object;
455 acpi_ut_add_reference(object);
457 return_ACPI_STATUS(AE_OK);
460 /*******************************************************************************
462 * FUNCTION: acpi_ds_method_data_delete_value
464 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
465 * ACPI_REFCLASS_ARG
466 * Index - Which local_var or argument to delete
467 * walk_state - Current walk state object
469 * RETURN: None
471 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
472 * a null into the stack slot after the object is deleted.
474 ******************************************************************************/
476 static void
477 acpi_ds_method_data_delete_value(u8 type,
478 u32 index, struct acpi_walk_state *walk_state)
480 acpi_status status;
481 struct acpi_namespace_node *node;
482 union acpi_operand_object *object;
484 ACPI_FUNCTION_TRACE(ds_method_data_delete_value);
486 /* Get the namespace node for the arg/local */
488 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
489 if (ACPI_FAILURE(status)) {
490 return_VOID;
493 /* Get the associated object */
495 object = acpi_ns_get_attached_object(node);
498 * Undefine the Arg or Local by setting its descriptor
499 * pointer to NULL. Locals/Args can contain both
500 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
502 node->object = NULL;
504 if ((object) &&
505 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_OPERAND)) {
507 * There is a valid object.
508 * Decrement the reference count by one to balance the
509 * increment when the object was stored.
511 acpi_ut_remove_reference(object);
514 return_VOID;
517 /*******************************************************************************
519 * FUNCTION: acpi_ds_store_object_to_local
521 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
522 * ACPI_REFCLASS_ARG
523 * Index - Which Local or Arg to set
524 * obj_desc - Value to be stored
525 * walk_state - Current walk state
527 * RETURN: Status
529 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
530 * as the new value for the Arg or Local and the reference count
531 * for obj_desc is incremented.
533 ******************************************************************************/
535 acpi_status
536 acpi_ds_store_object_to_local(u8 type,
537 u32 index,
538 union acpi_operand_object *obj_desc,
539 struct acpi_walk_state *walk_state)
541 acpi_status status;
542 struct acpi_namespace_node *node;
543 union acpi_operand_object *current_obj_desc;
544 union acpi_operand_object *new_obj_desc;
546 ACPI_FUNCTION_TRACE(ds_store_object_to_local);
547 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Type=%2.2X Index=%d Obj=%p\n",
548 type, index, obj_desc));
550 /* Parameter validation */
552 if (!obj_desc) {
553 return_ACPI_STATUS(AE_BAD_PARAMETER);
556 /* Get the namespace node for the arg/local */
558 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
559 if (ACPI_FAILURE(status)) {
560 return_ACPI_STATUS(status);
563 current_obj_desc = acpi_ns_get_attached_object(node);
564 if (current_obj_desc == obj_desc) {
565 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Obj=%p already installed!\n",
566 obj_desc));
567 return_ACPI_STATUS(status);
571 * If the reference count on the object is more than one, we must
572 * take a copy of the object before we store. A reference count
573 * of exactly 1 means that the object was just created during the
574 * evaluation of an expression, and we can safely use it since it
575 * is not used anywhere else.
577 new_obj_desc = obj_desc;
578 if (obj_desc->common.reference_count > 1) {
579 status =
580 acpi_ut_copy_iobject_to_iobject(obj_desc, &new_obj_desc,
581 walk_state);
582 if (ACPI_FAILURE(status)) {
583 return_ACPI_STATUS(status);
588 * If there is an object already in this slot, we either
589 * have to delete it, or if this is an argument and there
590 * is an object reference stored there, we have to do
591 * an indirect store!
593 if (current_obj_desc) {
595 * Check for an indirect store if an argument
596 * contains an object reference (stored as an Node).
597 * We don't allow this automatic dereferencing for
598 * locals, since a store to a local should overwrite
599 * anything there, including an object reference.
601 * If both Arg0 and Local0 contain ref_of (Local4):
603 * Store (1, Arg0) - Causes indirect store to local4
604 * Store (1, Local0) - Stores 1 in local0, overwriting
605 * the reference to local4
606 * Store (1, de_refof (Local0)) - Causes indirect store to local4
608 * Weird, but true.
610 if (type == ACPI_REFCLASS_ARG) {
612 * If we have a valid reference object that came from ref_of(),
613 * do the indirect store
615 if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc) ==
616 ACPI_DESC_TYPE_OPERAND)
617 && (current_obj_desc->common.type ==
618 ACPI_TYPE_LOCAL_REFERENCE)
619 && (current_obj_desc->reference.class ==
620 ACPI_REFCLASS_REFOF)) {
621 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
622 "Arg (%p) is an ObjRef(Node), storing in node %p\n",
623 new_obj_desc,
624 current_obj_desc));
627 * Store this object to the Node (perform the indirect store)
628 * NOTE: No implicit conversion is performed, as per the ACPI
629 * specification rules on storing to Locals/Args.
631 status =
632 acpi_ex_store_object_to_node(new_obj_desc,
633 current_obj_desc->
634 reference.
635 object,
636 walk_state,
637 ACPI_NO_IMPLICIT_CONVERSION);
639 /* Remove local reference if we copied the object above */
641 if (new_obj_desc != obj_desc) {
642 acpi_ut_remove_reference(new_obj_desc);
644 return_ACPI_STATUS(status);
648 /* Delete the existing object before storing the new one */
650 acpi_ds_method_data_delete_value(type, index, walk_state);
654 * Install the Obj descriptor (*new_obj_desc) into
655 * the descriptor for the Arg or Local.
656 * (increments the object reference count by one)
658 status =
659 acpi_ds_method_data_set_value(type, index, new_obj_desc,
660 walk_state);
662 /* Remove local reference if we copied the object above */
664 if (new_obj_desc != obj_desc) {
665 acpi_ut_remove_reference(new_obj_desc);
668 return_ACPI_STATUS(status);
671 #ifdef ACPI_OBSOLETE_FUNCTIONS
672 /*******************************************************************************
674 * FUNCTION: acpi_ds_method_data_get_type
676 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
677 * Index - Which Local or Arg whose type to get
678 * walk_state - Current walk state object
680 * RETURN: Data type of current value of the selected Arg or Local
682 * DESCRIPTION: Get the type of the object stored in the Local or Arg
684 ******************************************************************************/
686 acpi_object_type
687 acpi_ds_method_data_get_type(u16 opcode,
688 u32 index, struct acpi_walk_state *walk_state)
690 acpi_status status;
691 struct acpi_namespace_node *node;
692 union acpi_operand_object *object;
694 ACPI_FUNCTION_TRACE(ds_method_data_get_type);
696 /* Get the namespace node for the arg/local */
698 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
699 if (ACPI_FAILURE(status)) {
700 return_VALUE((ACPI_TYPE_NOT_FOUND));
703 /* Get the object */
705 object = acpi_ns_get_attached_object(node);
706 if (!object) {
708 /* Uninitialized local/arg, return TYPE_ANY */
710 return_VALUE(ACPI_TYPE_ANY);
713 /* Get the object type */
715 return_VALUE(ACPI_GET_OBJECT_TYPE(object));
717 #endif