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>
45 #include <acpi/acdispat.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/acinterp.h>
50 #define _COMPONENT ACPI_DISPATCHER
51 ACPI_MODULE_NAME("dsmthdat")
53 /* Local prototypes */
55 acpi_ds_method_data_delete_value(u16 opcode,
56 u32 index, struct acpi_walk_state *walk_state);
59 acpi_ds_method_data_set_value(u16 opcode,
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(AML_ARG_OP, 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: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
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 ******************************************************************************/
249 acpi_ds_method_data_get_node(u16 opcode,
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
262 if (index > ACPI_METHOD_MAX_LOCAL) {
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];
276 if (index > ACPI_METHOD_MAX_ARG) {
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];
289 ACPI_ERROR((AE_INFO, "Opcode %d is invalid", opcode));
290 return_ACPI_STATUS(AE_AML_BAD_OPCODE);
293 return_ACPI_STATUS(AE_OK);
296 /*******************************************************************************
298 * FUNCTION: acpi_ds_method_data_set_value
300 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
301 * Index - Which Local or Arg to get
302 * Object - Object to be inserted into the stack entry
303 * walk_state - Current walk state object
307 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
308 * Note: There is no "implicit conversion" for locals.
310 ******************************************************************************/
313 acpi_ds_method_data_set_value(u16 opcode,
315 union acpi_operand_object *object,
316 struct acpi_walk_state *walk_state)
319 struct acpi_namespace_node *node;
321 ACPI_FUNCTION_TRACE(ds_method_data_set_value);
323 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
324 "NewObj %p Opcode %X, Refs=%d [%s]\n", object,
325 opcode, object->common.reference_count,
326 acpi_ut_get_type_name(object->common.type)));
328 /* Get the namespace node for the arg/local */
330 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
331 if (ACPI_FAILURE(status)) {
332 return_ACPI_STATUS(status);
336 * Increment ref count so object can't be deleted while installed.
337 * NOTE: We do not copy the object in order to preserve the call by
338 * reference semantics of ACPI Control Method invocation.
339 * (See ACPI Specification 2.0_c)
341 acpi_ut_add_reference(object);
343 /* Install the object */
345 node->object = object;
346 return_ACPI_STATUS(status);
349 /*******************************************************************************
351 * FUNCTION: acpi_ds_method_data_get_value
353 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
354 * Index - Which local_var or argument to get
355 * walk_state - Current walk state object
356 * dest_desc - Where Arg or Local value is returned
360 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
361 * Used only in acpi_ex_resolve_to_value().
363 ******************************************************************************/
366 acpi_ds_method_data_get_value(u16 opcode,
368 struct acpi_walk_state *walk_state,
369 union acpi_operand_object **dest_desc)
372 struct acpi_namespace_node *node;
373 union acpi_operand_object *object;
375 ACPI_FUNCTION_TRACE(ds_method_data_get_value);
377 /* Validate the object descriptor */
380 ACPI_ERROR((AE_INFO, "Null object descriptor pointer"));
381 return_ACPI_STATUS(AE_BAD_PARAMETER);
384 /* Get the namespace node for the arg/local */
386 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
387 if (ACPI_FAILURE(status)) {
388 return_ACPI_STATUS(status);
391 /* Get the object from the node */
393 object = node->object;
395 /* Examine the returned object, it must be valid. */
399 * Index points to uninitialized object.
400 * This means that either 1) The expected argument was
401 * not passed to the method, or 2) A local variable
402 * was referenced by the method (via the ASL)
403 * before it was initialized. Either case is an error.
406 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
408 if (acpi_gbl_enable_interpreter_slack) {
410 acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
412 return_ACPI_STATUS(AE_NO_MEMORY);
415 object->integer.value = 0;
416 node->object = object;
419 /* Otherwise, return the error */
426 "Uninitialized Arg[%d] at node %p",
429 return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG);
434 "Uninitialized Local[%d] at node %p",
437 return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL);
441 "Not a Arg/Local opcode: %X",
443 return_ACPI_STATUS(AE_AML_INTERNAL);
448 * The Index points to an initialized and valid object.
449 * Return an additional reference to the object
452 acpi_ut_add_reference(object);
454 return_ACPI_STATUS(AE_OK);
457 /*******************************************************************************
459 * FUNCTION: acpi_ds_method_data_delete_value
461 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
462 * Index - Which local_var or argument to delete
463 * walk_state - Current walk state object
467 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
468 * a null into the stack slot after the object is deleted.
470 ******************************************************************************/
473 acpi_ds_method_data_delete_value(u16 opcode,
474 u32 index, struct acpi_walk_state *walk_state)
477 struct acpi_namespace_node *node;
478 union acpi_operand_object *object;
480 ACPI_FUNCTION_TRACE(ds_method_data_delete_value);
482 /* Get the namespace node for the arg/local */
484 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
485 if (ACPI_FAILURE(status)) {
489 /* Get the associated object */
491 object = acpi_ns_get_attached_object(node);
494 * Undefine the Arg or Local by setting its descriptor
495 * pointer to NULL. Locals/Args can contain both
496 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
501 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_OPERAND)) {
503 * There is a valid object.
504 * Decrement the reference count by one to balance the
505 * increment when the object was stored.
507 acpi_ut_remove_reference(object);
513 /*******************************************************************************
515 * FUNCTION: acpi_ds_store_object_to_local
517 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
518 * Index - Which Local or Arg to set
519 * obj_desc - Value to be stored
520 * walk_state - Current walk state
524 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
525 * as the new value for the Arg or Local and the reference count
526 * for obj_desc is incremented.
528 ******************************************************************************/
531 acpi_ds_store_object_to_local(u16 opcode,
533 union acpi_operand_object *obj_desc,
534 struct acpi_walk_state *walk_state)
537 struct acpi_namespace_node *node;
538 union acpi_operand_object *current_obj_desc;
539 union acpi_operand_object *new_obj_desc;
541 ACPI_FUNCTION_TRACE(ds_store_object_to_local);
542 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Opcode=%X Index=%d Obj=%p\n",
543 opcode, index, obj_desc));
545 /* Parameter validation */
548 return_ACPI_STATUS(AE_BAD_PARAMETER);
551 /* Get the namespace node for the arg/local */
553 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
554 if (ACPI_FAILURE(status)) {
555 return_ACPI_STATUS(status);
558 current_obj_desc = acpi_ns_get_attached_object(node);
559 if (current_obj_desc == obj_desc) {
560 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Obj=%p already installed!\n",
562 return_ACPI_STATUS(status);
566 * If the reference count on the object is more than one, we must
567 * take a copy of the object before we store. A reference count
568 * of exactly 1 means that the object was just created during the
569 * evaluation of an expression, and we can safely use it since it
570 * is not used anywhere else.
572 new_obj_desc = obj_desc;
573 if (obj_desc->common.reference_count > 1) {
575 acpi_ut_copy_iobject_to_iobject(obj_desc, &new_obj_desc,
577 if (ACPI_FAILURE(status)) {
578 return_ACPI_STATUS(status);
583 * If there is an object already in this slot, we either
584 * have to delete it, or if this is an argument and there
585 * is an object reference stored there, we have to do
588 if (current_obj_desc) {
590 * Check for an indirect store if an argument
591 * contains an object reference (stored as an Node).
592 * We don't allow this automatic dereferencing for
593 * locals, since a store to a local should overwrite
594 * anything there, including an object reference.
596 * If both Arg0 and Local0 contain ref_of (Local4):
598 * Store (1, Arg0) - Causes indirect store to local4
599 * Store (1, Local0) - Stores 1 in local0, overwriting
600 * the reference to local4
601 * Store (1, de_refof (Local0)) - Causes indirect store to local4
605 if (opcode == AML_ARG_OP) {
607 * If we have a valid reference object that came from ref_of(),
608 * do the indirect store
610 if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc) ==
611 ACPI_DESC_TYPE_OPERAND)
612 && (current_obj_desc->common.type ==
613 ACPI_TYPE_LOCAL_REFERENCE)
614 && (current_obj_desc->reference.opcode ==
616 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
617 "Arg (%p) is an ObjRef(Node), storing in node %p\n",
622 * Store this object to the Node (perform the indirect store)
623 * NOTE: No implicit conversion is performed, as per the ACPI
624 * specification rules on storing to Locals/Args.
627 acpi_ex_store_object_to_node(new_obj_desc,
632 ACPI_NO_IMPLICIT_CONVERSION);
634 /* Remove local reference if we copied the object above */
636 if (new_obj_desc != obj_desc) {
637 acpi_ut_remove_reference(new_obj_desc);
639 return_ACPI_STATUS(status);
644 * Delete the existing object
645 * before storing the new one
647 acpi_ds_method_data_delete_value(opcode, index, walk_state);
651 * Install the Obj descriptor (*new_obj_desc) into
652 * the descriptor for the Arg or Local.
653 * (increments the object reference count by one)
656 acpi_ds_method_data_set_value(opcode, index, new_obj_desc,
659 /* Remove local reference if we copied the object above */
661 if (new_obj_desc != obj_desc) {
662 acpi_ut_remove_reference(new_obj_desc);
665 return_ACPI_STATUS(status);
668 #ifdef ACPI_OBSOLETE_FUNCTIONS
669 /*******************************************************************************
671 * FUNCTION: acpi_ds_method_data_get_type
673 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
674 * Index - Which Local or Arg whose type to get
675 * walk_state - Current walk state object
677 * RETURN: Data type of current value of the selected Arg or Local
679 * DESCRIPTION: Get the type of the object stored in the Local or Arg
681 ******************************************************************************/
684 acpi_ds_method_data_get_type(u16 opcode,
685 u32 index, struct acpi_walk_state *walk_state)
688 struct acpi_namespace_node *node;
689 union acpi_operand_object *object;
691 ACPI_FUNCTION_TRACE(ds_method_data_get_type);
693 /* Get the namespace node for the arg/local */
695 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
696 if (ACPI_FAILURE(status)) {
697 return_VALUE((ACPI_TYPE_NOT_FOUND));
702 object = acpi_ns_get_attached_object(node);
705 /* Uninitialized local/arg, return TYPE_ANY */
707 return_VALUE(ACPI_TYPE_ANY);
710 /* Get the object type */
712 return_VALUE(ACPI_GET_OBJECT_TYPE(object));