1 /*******************************************************************************
3 * Module Name: dsmthdat - control method arguments and local variables
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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>
50 #define _COMPONENT ACPI_DISPATCHER
51 ACPI_MODULE_NAME("dsmthdat")
53 /* Local prototypes */
55 acpi_ds_method_data_delete_value(u8 type,
56 u32 index, struct acpi_walk_state *walk_state);
59 acpi_ds_method_data_set_value(u8 type,
61 union acpi_operand_object *object,
62 struct acpi_walk_state *walk_state);
64 #ifdef ACPI_OBSOLETE_FUNCTIONS
66 acpi_ds_method_data_get_type(u16 opcode,
67 u32 index, struct acpi_walk_state *walk_state);
70 /*******************************************************************************
72 * FUNCTION: acpi_ds_method_data_init
74 * PARAMETERS: walk_state - Current walk state object
78 * DESCRIPTION: Initialize the data structures that hold the method's arguments
79 * and locals. The data struct is an array of namespace nodes for
80 * each - this allows ref_of and de_ref_of to work properly for these
83 * NOTES: walk_state fields are initialized to zero by the
84 * ACPI_ALLOCATE_ZEROED().
86 * A pseudo-Namespace Node is assigned to each argument and local
87 * so that ref_of() can return a pointer to the Node.
89 ******************************************************************************/
91 void acpi_ds_method_data_init(struct acpi_walk_state *walk_state)
95 ACPI_FUNCTION_TRACE(ds_method_data_init);
97 /* Init the method arguments */
99 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) {
100 ACPI_MOVE_32_TO_32(&walk_state->arguments[i].name,
102 walk_state->arguments[i].name.integer |= (i << 24);
103 walk_state->arguments[i].descriptor_type = ACPI_DESC_TYPE_NAMED;
104 walk_state->arguments[i].type = ACPI_TYPE_ANY;
105 walk_state->arguments[i].flags =
106 ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_ARG;
109 /* Init the method locals */
111 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) {
112 ACPI_MOVE_32_TO_32(&walk_state->local_variables[i].name,
115 walk_state->local_variables[i].name.integer |= (i << 24);
116 walk_state->local_variables[i].descriptor_type =
117 ACPI_DESC_TYPE_NAMED;
118 walk_state->local_variables[i].type = ACPI_TYPE_ANY;
119 walk_state->local_variables[i].flags =
120 ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_LOCAL;
126 /*******************************************************************************
128 * FUNCTION: acpi_ds_method_data_delete_all
130 * PARAMETERS: walk_state - Current walk state object
134 * DESCRIPTION: Delete method locals and arguments. Arguments are only
135 * deleted if this method was called from another method.
137 ******************************************************************************/
139 void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state)
143 ACPI_FUNCTION_TRACE(ds_method_data_delete_all);
145 /* Detach the locals */
147 for (index = 0; index < ACPI_METHOD_NUM_LOCALS; index++) {
148 if (walk_state->local_variables[index].object) {
149 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Local%d=%p\n",
151 walk_state->local_variables[index].
154 /* Detach object (if present) and remove a reference */
156 acpi_ns_detach_object(&walk_state->
157 local_variables[index]);
161 /* Detach the arguments */
163 for (index = 0; index < ACPI_METHOD_NUM_ARGS; index++) {
164 if (walk_state->arguments[index].object) {
165 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Arg%d=%p\n",
167 walk_state->arguments[index].object));
169 /* Detach object (if present) and remove a reference */
171 acpi_ns_detach_object(&walk_state->arguments[index]);
178 /*******************************************************************************
180 * FUNCTION: acpi_ds_method_data_init_args
182 * PARAMETERS: *Params - Pointer to a parameter list for the method
183 * max_param_count - The arg count for this method
184 * walk_state - Current walk state object
188 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
189 * of ACPI operand objects, either null terminated or whose length
190 * is defined by max_param_count.
192 ******************************************************************************/
195 acpi_ds_method_data_init_args(union acpi_operand_object **params,
197 struct acpi_walk_state *walk_state)
202 ACPI_FUNCTION_TRACE_PTR(ds_method_data_init_args, params);
205 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
206 "No param list passed to method\n"));
207 return_ACPI_STATUS(AE_OK);
210 /* Copy passed parameters into the new method stack frame */
212 while ((index < ACPI_METHOD_NUM_ARGS) &&
213 (index < max_param_count) && params[index]) {
216 * Store the argument in the method/walk descriptor.
217 * Do not copy the arg in order to implement call by reference
219 status = acpi_ds_method_data_set_value(ACPI_REFCLASS_ARG, index,
222 if (ACPI_FAILURE(status)) {
223 return_ACPI_STATUS(status);
229 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%d args passed to method\n", index));
230 return_ACPI_STATUS(AE_OK);
233 /*******************************************************************************
235 * FUNCTION: acpi_ds_method_data_get_node
237 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
239 * Index - Which Local or Arg whose type to get
240 * walk_state - Current walk state object
241 * Node - Where the node is returned.
243 * RETURN: Status and node
245 * DESCRIPTION: Get the Node associated with a local or arg.
247 ******************************************************************************/
250 acpi_ds_method_data_get_node(u8 type,
252 struct acpi_walk_state *walk_state,
253 struct acpi_namespace_node **node)
255 ACPI_FUNCTION_TRACE(ds_method_data_get_node);
258 * Method Locals and Arguments are supported
261 case ACPI_REFCLASS_LOCAL:
263 if (index > ACPI_METHOD_MAX_LOCAL) {
265 "Local index %d is invalid (max %d)",
266 index, ACPI_METHOD_MAX_LOCAL));
267 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
270 /* Return a pointer to the pseudo-node */
272 *node = &walk_state->local_variables[index];
275 case ACPI_REFCLASS_ARG:
277 if (index > ACPI_METHOD_MAX_ARG) {
279 "Arg index %d is invalid (max %d)",
280 index, ACPI_METHOD_MAX_ARG));
281 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
284 /* Return a pointer to the pseudo-node */
286 *node = &walk_state->arguments[index];
290 ACPI_ERROR((AE_INFO, "Type %d is invalid", type));
291 return_ACPI_STATUS(AE_TYPE);
294 return_ACPI_STATUS(AE_OK);
297 /*******************************************************************************
299 * FUNCTION: acpi_ds_method_data_set_value
301 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
303 * Index - Which Local or Arg to get
304 * Object - Object to be inserted into the stack entry
305 * walk_state - Current walk state object
309 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
310 * Note: There is no "implicit conversion" for locals.
312 ******************************************************************************/
315 acpi_ds_method_data_set_value(u8 type,
317 union acpi_operand_object *object,
318 struct acpi_walk_state *walk_state)
321 struct acpi_namespace_node *node;
323 ACPI_FUNCTION_TRACE(ds_method_data_set_value);
325 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
326 "NewObj %p Type %2.2X, Refs=%d [%s]\n", object,
327 type, object->common.reference_count,
328 acpi_ut_get_type_name(object->common.type)));
330 /* Get the namespace node for the arg/local */
332 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
333 if (ACPI_FAILURE(status)) {
334 return_ACPI_STATUS(status);
338 * Increment ref count so object can't be deleted while installed.
339 * NOTE: We do not copy the object in order to preserve the call by
340 * reference semantics of ACPI Control Method invocation.
341 * (See ACPI Specification 2.0_c)
343 acpi_ut_add_reference(object);
345 /* Install the object */
347 node->object = object;
348 return_ACPI_STATUS(status);
351 /*******************************************************************************
353 * FUNCTION: acpi_ds_method_data_get_value
355 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
357 * Index - Which local_var or argument to get
358 * walk_state - Current walk state object
359 * dest_desc - Where Arg or Local value is returned
363 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
364 * Used only in acpi_ex_resolve_to_value().
366 ******************************************************************************/
369 acpi_ds_method_data_get_value(u8 type,
371 struct acpi_walk_state *walk_state,
372 union acpi_operand_object **dest_desc)
375 struct acpi_namespace_node *node;
376 union acpi_operand_object *object;
378 ACPI_FUNCTION_TRACE(ds_method_data_get_value);
380 /* Validate the object descriptor */
383 ACPI_ERROR((AE_INFO, "Null object descriptor pointer"));
384 return_ACPI_STATUS(AE_BAD_PARAMETER);
387 /* Get the namespace node for the arg/local */
389 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
390 if (ACPI_FAILURE(status)) {
391 return_ACPI_STATUS(status);
394 /* Get the object from the node */
396 object = node->object;
398 /* Examine the returned object, it must be valid. */
402 * Index points to uninitialized object.
403 * This means that either 1) The expected argument was
404 * not passed to the method, or 2) A local variable
405 * was referenced by the method (via the ASL)
406 * before it was initialized. Either case is an error.
409 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
411 if (acpi_gbl_enable_interpreter_slack) {
413 acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
415 return_ACPI_STATUS(AE_NO_MEMORY);
418 object->integer.value = 0;
419 node->object = object;
422 /* Otherwise, return the error */
426 case ACPI_REFCLASS_ARG:
429 "Uninitialized Arg[%d] at node %p",
432 return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG);
434 case ACPI_REFCLASS_LOCAL:
437 "Uninitialized Local[%d] at node %p",
440 return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL);
445 "Not a Arg/Local opcode: %X",
447 return_ACPI_STATUS(AE_AML_INTERNAL);
452 * The Index points to an initialized and valid object.
453 * Return an additional reference to the object
456 acpi_ut_add_reference(object);
458 return_ACPI_STATUS(AE_OK);
461 /*******************************************************************************
463 * FUNCTION: acpi_ds_method_data_delete_value
465 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
467 * Index - Which local_var or argument to delete
468 * walk_state - Current walk state object
472 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
473 * a null into the stack slot after the object is deleted.
475 ******************************************************************************/
478 acpi_ds_method_data_delete_value(u8 type,
479 u32 index, struct acpi_walk_state *walk_state)
482 struct acpi_namespace_node *node;
483 union acpi_operand_object *object;
485 ACPI_FUNCTION_TRACE(ds_method_data_delete_value);
487 /* Get the namespace node for the arg/local */
489 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
490 if (ACPI_FAILURE(status)) {
494 /* Get the associated object */
496 object = acpi_ns_get_attached_object(node);
499 * Undefine the Arg or Local by setting its descriptor
500 * pointer to NULL. Locals/Args can contain both
501 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
506 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_OPERAND)) {
508 * There is a valid object.
509 * Decrement the reference count by one to balance the
510 * increment when the object was stored.
512 acpi_ut_remove_reference(object);
518 /*******************************************************************************
520 * FUNCTION: acpi_ds_store_object_to_local
522 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
524 * Index - Which Local or Arg to set
525 * obj_desc - Value to be stored
526 * walk_state - Current walk state
530 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
531 * as the new value for the Arg or Local and the reference count
532 * for obj_desc is incremented.
534 ******************************************************************************/
537 acpi_ds_store_object_to_local(u8 type,
539 union acpi_operand_object *obj_desc,
540 struct acpi_walk_state *walk_state)
543 struct acpi_namespace_node *node;
544 union acpi_operand_object *current_obj_desc;
545 union acpi_operand_object *new_obj_desc;
547 ACPI_FUNCTION_TRACE(ds_store_object_to_local);
548 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Type=%2.2X Index=%d Obj=%p\n",
549 type, index, obj_desc));
551 /* Parameter validation */
554 return_ACPI_STATUS(AE_BAD_PARAMETER);
557 /* Get the namespace node for the arg/local */
559 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
560 if (ACPI_FAILURE(status)) {
561 return_ACPI_STATUS(status);
564 current_obj_desc = acpi_ns_get_attached_object(node);
565 if (current_obj_desc == obj_desc) {
566 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Obj=%p already installed!\n",
568 return_ACPI_STATUS(status);
572 * If the reference count on the object is more than one, we must
573 * take a copy of the object before we store. A reference count
574 * of exactly 1 means that the object was just created during the
575 * evaluation of an expression, and we can safely use it since it
576 * is not used anywhere else.
578 new_obj_desc = obj_desc;
579 if (obj_desc->common.reference_count > 1) {
581 acpi_ut_copy_iobject_to_iobject(obj_desc, &new_obj_desc,
583 if (ACPI_FAILURE(status)) {
584 return_ACPI_STATUS(status);
589 * If there is an object already in this slot, we either
590 * have to delete it, or if this is an argument and there
591 * is an object reference stored there, we have to do
594 if (current_obj_desc) {
596 * Check for an indirect store if an argument
597 * contains an object reference (stored as an Node).
598 * We don't allow this automatic dereferencing for
599 * locals, since a store to a local should overwrite
600 * anything there, including an object reference.
602 * If both Arg0 and Local0 contain ref_of (Local4):
604 * Store (1, Arg0) - Causes indirect store to local4
605 * Store (1, Local0) - Stores 1 in local0, overwriting
606 * the reference to local4
607 * Store (1, de_refof (Local0)) - Causes indirect store to local4
611 if (type == ACPI_REFCLASS_ARG) {
613 * If we have a valid reference object that came from ref_of(),
614 * do the indirect store
616 if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc) ==
617 ACPI_DESC_TYPE_OPERAND)
618 && (current_obj_desc->common.type ==
619 ACPI_TYPE_LOCAL_REFERENCE)
620 && (current_obj_desc->reference.class ==
621 ACPI_REFCLASS_REFOF)) {
622 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
623 "Arg (%p) is an ObjRef(Node), storing in node %p\n",
628 * Store this object to the Node (perform the indirect store)
629 * NOTE: No implicit conversion is performed, as per the ACPI
630 * specification rules on storing to Locals/Args.
633 acpi_ex_store_object_to_node(new_obj_desc,
638 ACPI_NO_IMPLICIT_CONVERSION);
640 /* Remove local reference if we copied the object above */
642 if (new_obj_desc != obj_desc) {
643 acpi_ut_remove_reference(new_obj_desc);
645 return_ACPI_STATUS(status);
649 /* Delete the existing object before storing the new one */
651 acpi_ds_method_data_delete_value(type, index, walk_state);
655 * Install the Obj descriptor (*new_obj_desc) into
656 * the descriptor for the Arg or Local.
657 * (increments the object reference count by one)
660 acpi_ds_method_data_set_value(type, index, new_obj_desc,
663 /* Remove local reference if we copied the object above */
665 if (new_obj_desc != obj_desc) {
666 acpi_ut_remove_reference(new_obj_desc);
669 return_ACPI_STATUS(status);
672 #ifdef ACPI_OBSOLETE_FUNCTIONS
673 /*******************************************************************************
675 * FUNCTION: acpi_ds_method_data_get_type
677 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
678 * Index - Which Local or Arg whose type to get
679 * walk_state - Current walk state object
681 * RETURN: Data type of current value of the selected Arg or Local
683 * DESCRIPTION: Get the type of the object stored in the Local or Arg
685 ******************************************************************************/
688 acpi_ds_method_data_get_type(u16 opcode,
689 u32 index, struct acpi_walk_state *walk_state)
692 struct acpi_namespace_node *node;
693 union acpi_operand_object *object;
695 ACPI_FUNCTION_TRACE(ds_method_data_get_type);
697 /* Get the namespace node for the arg/local */
699 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
700 if (ACPI_FAILURE(status)) {
701 return_VALUE((ACPI_TYPE_NOT_FOUND));
706 object = acpi_ns_get_attached_object(node);
709 /* Uninitialized local/arg, return TYPE_ANY */
711 return_VALUE(ACPI_TYPE_ANY);
714 /* Get the object type */
716 return_VALUE(ACPI_GET_OBJECT_TYPE(object));