1 /*******************************************************************************
3 * Module Name: dsmthdat - control method arguments and local variables
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acdispat.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acinterp.h>
52 #define _COMPONENT ACPI_DISPATCHER
53 ACPI_MODULE_NAME ("dsmthdat")
55 /* Local prototypes */
58 acpi_ds_method_data_delete_value (
61 struct acpi_walk_state
*walk_state
);
64 acpi_ds_method_data_set_value (
67 union acpi_operand_object
*object
,
68 struct acpi_walk_state
*walk_state
);
70 #ifdef ACPI_OBSOLETE_FUNCTIONS
72 acpi_ds_method_data_get_type (
75 struct acpi_walk_state
*walk_state
);
79 /*******************************************************************************
81 * FUNCTION: acpi_ds_method_data_init
83 * PARAMETERS: walk_state - Current walk state object
87 * DESCRIPTION: Initialize the data structures that hold the method's arguments
88 * and locals. The data struct is an array of namespace nodes for
89 * each - this allows ref_of and de_ref_of to work properly for these
92 * NOTES: walk_state fields are initialized to zero by the
93 * ACPI_MEM_CALLOCATE().
95 * A pseudo-Namespace Node is assigned to each argument and local
96 * so that ref_of() can return a pointer to the Node.
98 ******************************************************************************/
101 acpi_ds_method_data_init (
102 struct acpi_walk_state
*walk_state
)
107 ACPI_FUNCTION_TRACE ("ds_method_data_init");
110 /* Init the method arguments */
112 for (i
= 0; i
< ACPI_METHOD_NUM_ARGS
; i
++) {
113 ACPI_MOVE_32_TO_32 (&walk_state
->arguments
[i
].name
,
115 walk_state
->arguments
[i
].name
.integer
|= (i
<< 24);
116 walk_state
->arguments
[i
].descriptor
= ACPI_DESC_TYPE_NAMED
;
117 walk_state
->arguments
[i
].type
= ACPI_TYPE_ANY
;
118 walk_state
->arguments
[i
].flags
= ANOBJ_END_OF_PEER_LIST
|
122 /* Init the method locals */
124 for (i
= 0; i
< ACPI_METHOD_NUM_LOCALS
; i
++) {
125 ACPI_MOVE_32_TO_32 (&walk_state
->local_variables
[i
].name
,
128 walk_state
->local_variables
[i
].name
.integer
|= (i
<< 24);
129 walk_state
->local_variables
[i
].descriptor
= ACPI_DESC_TYPE_NAMED
;
130 walk_state
->local_variables
[i
].type
= ACPI_TYPE_ANY
;
131 walk_state
->local_variables
[i
].flags
= ANOBJ_END_OF_PEER_LIST
|
139 /*******************************************************************************
141 * FUNCTION: acpi_ds_method_data_delete_all
143 * PARAMETERS: walk_state - Current walk state object
147 * DESCRIPTION: Delete method locals and arguments. Arguments are only
148 * deleted if this method was called from another method.
150 ******************************************************************************/
153 acpi_ds_method_data_delete_all (
154 struct acpi_walk_state
*walk_state
)
159 ACPI_FUNCTION_TRACE ("ds_method_data_delete_all");
162 /* Detach the locals */
164 for (index
= 0; index
< ACPI_METHOD_NUM_LOCALS
; index
++) {
165 if (walk_state
->local_variables
[index
].object
) {
166 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Deleting Local%d=%p\n",
167 index
, walk_state
->local_variables
[index
].object
));
169 /* Detach object (if present) and remove a reference */
171 acpi_ns_detach_object (&walk_state
->local_variables
[index
]);
175 /* Detach the arguments */
177 for (index
= 0; index
< ACPI_METHOD_NUM_ARGS
; index
++) {
178 if (walk_state
->arguments
[index
].object
) {
179 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Deleting Arg%d=%p\n",
180 index
, walk_state
->arguments
[index
].object
));
182 /* Detach object (if present) and remove a reference */
184 acpi_ns_detach_object (&walk_state
->arguments
[index
]);
192 /*******************************************************************************
194 * FUNCTION: acpi_ds_method_data_init_args
196 * PARAMETERS: *Params - Pointer to a parameter list for the method
197 * max_param_count - The arg count for this method
198 * walk_state - Current walk state object
202 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
203 * of ACPI operand objects, either null terminated or whose length
204 * is defined by max_param_count.
206 ******************************************************************************/
209 acpi_ds_method_data_init_args (
210 union acpi_operand_object
**params
,
212 struct acpi_walk_state
*walk_state
)
218 ACPI_FUNCTION_TRACE_PTR ("ds_method_data_init_args", params
);
222 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "No param list passed to method\n"));
223 return_ACPI_STATUS (AE_OK
);
226 /* Copy passed parameters into the new method stack frame */
228 while ((index
< ACPI_METHOD_NUM_ARGS
) &&
229 (index
< max_param_count
) &&
233 * Store the argument in the method/walk descriptor.
234 * Do not copy the arg in order to implement call by reference
236 status
= acpi_ds_method_data_set_value (AML_ARG_OP
, index
,
237 params
[index
], walk_state
);
238 if (ACPI_FAILURE (status
)) {
239 return_ACPI_STATUS (status
);
245 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "%d args passed to method\n", index
));
246 return_ACPI_STATUS (AE_OK
);
250 /*******************************************************************************
252 * FUNCTION: acpi_ds_method_data_get_node
254 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
255 * Index - Which Local or Arg whose type to get
256 * walk_state - Current walk state object
257 * Node - Where the node is returned.
259 * RETURN: Status and node
261 * DESCRIPTION: Get the Node associated with a local or arg.
263 ******************************************************************************/
266 acpi_ds_method_data_get_node (
269 struct acpi_walk_state
*walk_state
,
270 struct acpi_namespace_node
**node
)
272 ACPI_FUNCTION_TRACE ("ds_method_data_get_node");
276 * Method Locals and Arguments are supported
281 if (index
> ACPI_METHOD_MAX_LOCAL
) {
282 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
283 "Local index %d is invalid (max %d)\n",
284 index
, ACPI_METHOD_MAX_LOCAL
));
285 return_ACPI_STATUS (AE_AML_INVALID_INDEX
);
288 /* Return a pointer to the pseudo-node */
290 *node
= &walk_state
->local_variables
[index
];
295 if (index
> ACPI_METHOD_MAX_ARG
) {
296 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
297 "Arg index %d is invalid (max %d)\n",
298 index
, ACPI_METHOD_MAX_ARG
));
299 return_ACPI_STATUS (AE_AML_INVALID_INDEX
);
302 /* Return a pointer to the pseudo-node */
304 *node
= &walk_state
->arguments
[index
];
308 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
, "Opcode %d is invalid\n", opcode
));
309 return_ACPI_STATUS (AE_AML_BAD_OPCODE
);
312 return_ACPI_STATUS (AE_OK
);
316 /*******************************************************************************
318 * FUNCTION: acpi_ds_method_data_set_value
320 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
321 * Index - Which Local or Arg to get
322 * Object - Object to be inserted into the stack entry
323 * walk_state - Current walk state object
327 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
328 * Note: There is no "implicit conversion" for locals.
330 ******************************************************************************/
333 acpi_ds_method_data_set_value (
336 union acpi_operand_object
*object
,
337 struct acpi_walk_state
*walk_state
)
340 struct acpi_namespace_node
*node
;
343 ACPI_FUNCTION_TRACE ("ds_method_data_set_value");
346 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
347 "new_obj %p Opcode %X, Refs=%d [%s]\n", object
,
348 opcode
, object
->common
.reference_count
,
349 acpi_ut_get_type_name (object
->common
.type
)));
351 /* Get the namespace node for the arg/local */
353 status
= acpi_ds_method_data_get_node (opcode
, index
, walk_state
, &node
);
354 if (ACPI_FAILURE (status
)) {
355 return_ACPI_STATUS (status
);
359 * Increment ref count so object can't be deleted while installed.
360 * NOTE: We do not copy the object in order to preserve the call by
361 * reference semantics of ACPI Control Method invocation.
362 * (See ACPI specification 2.0_c)
364 acpi_ut_add_reference (object
);
366 /* Install the object */
368 node
->object
= object
;
369 return_ACPI_STATUS (status
);
373 /*******************************************************************************
375 * FUNCTION: acpi_ds_method_data_get_value
377 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
378 * Index - which local_var or argument to get
379 * walk_state - Current walk state object
380 * dest_desc - Where Arg or Local value is returned
384 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
385 * Used only in acpi_ex_resolve_to_value().
387 ******************************************************************************/
390 acpi_ds_method_data_get_value (
393 struct acpi_walk_state
*walk_state
,
394 union acpi_operand_object
**dest_desc
)
397 struct acpi_namespace_node
*node
;
398 union acpi_operand_object
*object
;
401 ACPI_FUNCTION_TRACE ("ds_method_data_get_value");
404 /* Validate the object descriptor */
407 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
, "Null object descriptor pointer\n"));
408 return_ACPI_STATUS (AE_BAD_PARAMETER
);
411 /* Get the namespace node for the arg/local */
413 status
= acpi_ds_method_data_get_node (opcode
, index
, walk_state
, &node
);
414 if (ACPI_FAILURE (status
)) {
415 return_ACPI_STATUS (status
);
418 /* Get the object from the node */
420 object
= node
->object
;
422 /* Examine the returned object, it must be valid. */
426 * Index points to uninitialized object.
427 * This means that either 1) The expected argument was
428 * not passed to the method, or 2) A local variable
429 * was referenced by the method (via the ASL)
430 * before it was initialized. Either case is an error.
433 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
435 if (acpi_gbl_enable_interpreter_slack
) {
436 object
= acpi_ut_create_internal_object (ACPI_TYPE_INTEGER
);
438 return_ACPI_STATUS (AE_NO_MEMORY
);
441 object
->integer
.value
= 0;
442 node
->object
= object
;
445 /* Otherwise, return the error */
447 else switch (opcode
) {
450 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
451 "Uninitialized Arg[%d] at node %p\n",
454 return_ACPI_STATUS (AE_AML_UNINITIALIZED_ARG
);
458 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
459 "Uninitialized Local[%d] at node %p\n",
462 return_ACPI_STATUS (AE_AML_UNINITIALIZED_LOCAL
);
465 ACPI_REPORT_ERROR (("Not Arg/Local opcode: %X\n", opcode
));
466 return_ACPI_STATUS (AE_AML_INTERNAL
);
471 * The Index points to an initialized and valid object.
472 * Return an additional reference to the object
475 acpi_ut_add_reference (object
);
477 return_ACPI_STATUS (AE_OK
);
481 /*******************************************************************************
483 * FUNCTION: acpi_ds_method_data_delete_value
485 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
486 * Index - which local_var or argument to delete
487 * walk_state - Current walk state object
491 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
492 * a null into the stack slot after the object is deleted.
494 ******************************************************************************/
497 acpi_ds_method_data_delete_value (
500 struct acpi_walk_state
*walk_state
)
503 struct acpi_namespace_node
*node
;
504 union acpi_operand_object
*object
;
507 ACPI_FUNCTION_TRACE ("ds_method_data_delete_value");
510 /* Get the namespace node for the arg/local */
512 status
= acpi_ds_method_data_get_node (opcode
, index
, walk_state
, &node
);
513 if (ACPI_FAILURE (status
)) {
517 /* Get the associated object */
519 object
= acpi_ns_get_attached_object (node
);
522 * Undefine the Arg or Local by setting its descriptor
523 * pointer to NULL. Locals/Args can contain both
524 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
529 (ACPI_GET_DESCRIPTOR_TYPE (object
) == ACPI_DESC_TYPE_OPERAND
)) {
531 * There is a valid object.
532 * Decrement the reference count by one to balance the
533 * increment when the object was stored.
535 acpi_ut_remove_reference (object
);
542 /*******************************************************************************
544 * FUNCTION: acpi_ds_store_object_to_local
546 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
547 * Index - Which Local or Arg to set
548 * obj_desc - Value to be stored
549 * walk_state - Current walk state
553 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
554 * as the new value for the Arg or Local and the reference count
555 * for obj_desc is incremented.
557 ******************************************************************************/
560 acpi_ds_store_object_to_local (
563 union acpi_operand_object
*obj_desc
,
564 struct acpi_walk_state
*walk_state
)
567 struct acpi_namespace_node
*node
;
568 union acpi_operand_object
*current_obj_desc
;
569 union acpi_operand_object
*new_obj_desc
;
572 ACPI_FUNCTION_TRACE ("ds_store_object_to_local");
573 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Opcode=%X Index=%d Obj=%p\n",
574 opcode
, index
, obj_desc
));
576 /* Parameter validation */
579 return_ACPI_STATUS (AE_BAD_PARAMETER
);
582 /* Get the namespace node for the arg/local */
584 status
= acpi_ds_method_data_get_node (opcode
, index
, walk_state
, &node
);
585 if (ACPI_FAILURE (status
)) {
586 return_ACPI_STATUS (status
);
589 current_obj_desc
= acpi_ns_get_attached_object (node
);
590 if (current_obj_desc
== obj_desc
) {
591 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Obj=%p already installed!\n",
593 return_ACPI_STATUS (status
);
597 * If the reference count on the object is more than one, we must
598 * take a copy of the object before we store. A reference count
599 * of exactly 1 means that the object was just created during the
600 * evaluation of an expression, and we can safely use it since it
601 * is not used anywhere else.
603 new_obj_desc
= obj_desc
;
604 if (obj_desc
->common
.reference_count
> 1) {
605 status
= acpi_ut_copy_iobject_to_iobject (obj_desc
, &new_obj_desc
, walk_state
);
606 if (ACPI_FAILURE (status
)) {
607 return_ACPI_STATUS (status
);
612 * If there is an object already in this slot, we either
613 * have to delete it, or if this is an argument and there
614 * is an object reference stored there, we have to do
617 if (current_obj_desc
) {
619 * Check for an indirect store if an argument
620 * contains an object reference (stored as an Node).
621 * We don't allow this automatic dereferencing for
622 * locals, since a store to a local should overwrite
623 * anything there, including an object reference.
625 * If both Arg0 and Local0 contain ref_of (Local4):
627 * Store (1, Arg0) - Causes indirect store to local4
628 * Store (1, Local0) - Stores 1 in local0, overwriting
629 * the reference to local4
630 * Store (1, de_refof (Local0)) - Causes indirect store to local4
634 if (opcode
== AML_ARG_OP
) {
636 * Make sure that the object is the correct type. This may be
637 * overkill, butit is here because references were NS nodes in
638 * the past. Now they are operand objects of type Reference.
640 if (ACPI_GET_DESCRIPTOR_TYPE (current_obj_desc
) != ACPI_DESC_TYPE_OPERAND
) {
642 "Invalid descriptor type while storing to method arg: [%s]\n",
643 acpi_ut_get_descriptor_name (current_obj_desc
)));
644 return_ACPI_STATUS (AE_AML_INTERNAL
);
648 * If we have a valid reference object that came from ref_of(),
649 * do the indirect store
651 if ((current_obj_desc
->common
.type
== ACPI_TYPE_LOCAL_REFERENCE
) &&
652 (current_obj_desc
->reference
.opcode
== AML_REF_OF_OP
)) {
653 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
654 "Arg (%p) is an obj_ref(Node), storing in node %p\n",
655 new_obj_desc
, current_obj_desc
));
658 * Store this object to the Node (perform the indirect store)
659 * NOTE: No implicit conversion is performed, as per the ACPI
660 * specification rules on storing to Locals/Args.
662 status
= acpi_ex_store_object_to_node (new_obj_desc
,
663 current_obj_desc
->reference
.object
, walk_state
,
664 ACPI_NO_IMPLICIT_CONVERSION
);
666 /* Remove local reference if we copied the object above */
668 if (new_obj_desc
!= obj_desc
) {
669 acpi_ut_remove_reference (new_obj_desc
);
671 return_ACPI_STATUS (status
);
676 * Delete the existing object
677 * before storing the new one
679 acpi_ds_method_data_delete_value (opcode
, index
, walk_state
);
683 * Install the Obj descriptor (*new_obj_desc) into
684 * the descriptor for the Arg or Local.
685 * (increments the object reference count by one)
687 status
= acpi_ds_method_data_set_value (opcode
, index
, new_obj_desc
, walk_state
);
689 /* Remove local reference if we copied the object above */
691 if (new_obj_desc
!= obj_desc
) {
692 acpi_ut_remove_reference (new_obj_desc
);
695 return_ACPI_STATUS (status
);
699 #ifdef ACPI_OBSOLETE_FUNCTIONS
700 /*******************************************************************************
702 * FUNCTION: acpi_ds_method_data_get_type
704 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
705 * Index - Which Local or Arg whose type to get
706 * walk_state - Current walk state object
708 * RETURN: Data type of current value of the selected Arg or Local
710 * DESCRIPTION: Get the type of the object stored in the Local or Arg
712 ******************************************************************************/
715 acpi_ds_method_data_get_type (
718 struct acpi_walk_state
*walk_state
)
721 struct acpi_namespace_node
*node
;
722 union acpi_operand_object
*object
;
725 ACPI_FUNCTION_TRACE ("ds_method_data_get_type");
728 /* Get the namespace node for the arg/local */
730 status
= acpi_ds_method_data_get_node (opcode
, index
, walk_state
, &node
);
731 if (ACPI_FAILURE (status
)) {
732 return_VALUE ((ACPI_TYPE_NOT_FOUND
));
737 object
= acpi_ns_get_attached_object (node
);
739 /* Uninitialized local/arg, return TYPE_ANY */
741 return_VALUE (ACPI_TYPE_ANY
);
744 /* Get the object type */
746 return_VALUE (ACPI_GET_OBJECT_TYPE (object
));