1 /*******************************************************************************
3 * Module Name: dsmthdat - control method arguments and local variables
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2013, 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
= 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
,
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
= ANOBJ_METHOD_LOCAL
;
124 /*******************************************************************************
126 * FUNCTION: acpi_ds_method_data_delete_all
128 * PARAMETERS: walk_state - Current walk state object
132 * DESCRIPTION: Delete method locals and arguments. Arguments are only
133 * deleted if this method was called from another method.
135 ******************************************************************************/
137 void acpi_ds_method_data_delete_all(struct acpi_walk_state
*walk_state
)
141 ACPI_FUNCTION_TRACE(ds_method_data_delete_all
);
143 /* Detach the locals */
145 for (index
= 0; index
< ACPI_METHOD_NUM_LOCALS
; index
++) {
146 if (walk_state
->local_variables
[index
].object
) {
147 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Deleting Local%u=%p\n",
149 walk_state
->local_variables
[index
].
152 /* Detach object (if present) and remove a reference */
154 acpi_ns_detach_object(&walk_state
->
155 local_variables
[index
]);
159 /* Detach the arguments */
161 for (index
= 0; index
< ACPI_METHOD_NUM_ARGS
; index
++) {
162 if (walk_state
->arguments
[index
].object
) {
163 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Deleting Arg%u=%p\n",
165 walk_state
->arguments
[index
].object
));
167 /* Detach object (if present) and remove a reference */
169 acpi_ns_detach_object(&walk_state
->arguments
[index
]);
176 /*******************************************************************************
178 * FUNCTION: acpi_ds_method_data_init_args
180 * PARAMETERS: *params - Pointer to a parameter list for the method
181 * max_param_count - The arg count for this method
182 * walk_state - Current walk state object
186 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
187 * of ACPI operand objects, either null terminated or whose length
188 * is defined by max_param_count.
190 ******************************************************************************/
193 acpi_ds_method_data_init_args(union acpi_operand_object
**params
,
195 struct acpi_walk_state
*walk_state
)
200 ACPI_FUNCTION_TRACE_PTR(ds_method_data_init_args
, params
);
203 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
204 "No param list passed to method\n"));
205 return_ACPI_STATUS(AE_OK
);
208 /* Copy passed parameters into the new method stack frame */
210 while ((index
< ACPI_METHOD_NUM_ARGS
) &&
211 (index
< max_param_count
) && params
[index
]) {
214 * Store the argument in the method/walk descriptor.
215 * Do not copy the arg in order to implement call by reference
217 status
= acpi_ds_method_data_set_value(ACPI_REFCLASS_ARG
, index
,
220 if (ACPI_FAILURE(status
)) {
221 return_ACPI_STATUS(status
);
227 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "%u args passed to method\n", index
));
228 return_ACPI_STATUS(AE_OK
);
231 /*******************************************************************************
233 * FUNCTION: acpi_ds_method_data_get_node
235 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
237 * index - Which Local or Arg whose type to get
238 * walk_state - Current walk state object
239 * node - Where the node is returned.
241 * RETURN: Status and node
243 * DESCRIPTION: Get the Node associated with a local or arg.
245 ******************************************************************************/
248 acpi_ds_method_data_get_node(u8 type
,
250 struct acpi_walk_state
*walk_state
,
251 struct acpi_namespace_node
**node
)
253 ACPI_FUNCTION_TRACE(ds_method_data_get_node
);
256 * Method Locals and Arguments are supported
259 case ACPI_REFCLASS_LOCAL
:
261 if (index
> ACPI_METHOD_MAX_LOCAL
) {
263 "Local index %u is invalid (max %u)",
264 index
, ACPI_METHOD_MAX_LOCAL
));
265 return_ACPI_STATUS(AE_AML_INVALID_INDEX
);
268 /* Return a pointer to the pseudo-node */
270 *node
= &walk_state
->local_variables
[index
];
273 case ACPI_REFCLASS_ARG
:
275 if (index
> ACPI_METHOD_MAX_ARG
) {
277 "Arg index %u is invalid (max %u)",
278 index
, ACPI_METHOD_MAX_ARG
));
279 return_ACPI_STATUS(AE_AML_INVALID_INDEX
);
282 /* Return a pointer to the pseudo-node */
284 *node
= &walk_state
->arguments
[index
];
289 ACPI_ERROR((AE_INFO
, "Type %u 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
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
308 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
309 * Note: There is no "implicit conversion" for locals.
311 ******************************************************************************/
314 acpi_ds_method_data_set_value(u8 type
,
316 union acpi_operand_object
*object
,
317 struct acpi_walk_state
*walk_state
)
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=%u [%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.0C)
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
356 * index - Which localVar or argument to get
357 * walk_state - Current walk state object
358 * dest_desc - Where Arg or Local value is returned
362 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
363 * Used only in acpi_ex_resolve_to_value().
365 ******************************************************************************/
368 acpi_ds_method_data_get_value(u8 type
,
370 struct acpi_walk_state
*walk_state
,
371 union acpi_operand_object
**dest_desc
)
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 */
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. */
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
= acpi_ut_create_integer_object((u64
) 0);
413 return_ACPI_STATUS(AE_NO_MEMORY
);
416 node
->object
= object
;
419 /* Otherwise, return the error */
423 case ACPI_REFCLASS_ARG
:
426 "Uninitialized Arg[%u] at node %p",
429 return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG
);
431 case ACPI_REFCLASS_LOCAL
:
433 * No error message for this case, will be trapped again later to
434 * detect and ignore cases of Store(local_x,local_x)
436 return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL
);
441 "Not a Arg/Local opcode: 0x%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: type - Either ACPI_REFCLASS_LOCAL or
463 * index - Which localVar or argument to delete
464 * walk_state - Current walk state object
468 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
469 * a null into the stack slot after the object is deleted.
471 ******************************************************************************/
474 acpi_ds_method_data_delete_value(u8 type
,
475 u32 index
, struct acpi_walk_state
*walk_state
)
478 struct acpi_namespace_node
*node
;
479 union acpi_operand_object
*object
;
481 ACPI_FUNCTION_TRACE(ds_method_data_delete_value
);
483 /* Get the namespace node for the arg/local */
485 status
= acpi_ds_method_data_get_node(type
, index
, walk_state
, &node
);
486 if (ACPI_FAILURE(status
)) {
490 /* Get the associated object */
492 object
= acpi_ns_get_attached_object(node
);
495 * Undefine the Arg or Local by setting its descriptor
496 * pointer to NULL. Locals/Args can contain both
497 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
502 (ACPI_GET_DESCRIPTOR_TYPE(object
) == ACPI_DESC_TYPE_OPERAND
)) {
504 * There is a valid object.
505 * Decrement the reference count by one to balance the
506 * increment when the object was stored.
508 acpi_ut_remove_reference(object
);
514 /*******************************************************************************
516 * FUNCTION: acpi_ds_store_object_to_local
518 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
520 * index - Which Local or Arg to set
521 * obj_desc - Value to be stored
522 * walk_state - Current walk state
526 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
527 * as the new value for the Arg or Local and the reference count
528 * for obj_desc is incremented.
530 ******************************************************************************/
533 acpi_ds_store_object_to_local(u8 type
,
535 union acpi_operand_object
*obj_desc
,
536 struct acpi_walk_state
*walk_state
)
539 struct acpi_namespace_node
*node
;
540 union acpi_operand_object
*current_obj_desc
;
541 union acpi_operand_object
*new_obj_desc
;
543 ACPI_FUNCTION_TRACE(ds_store_object_to_local
);
544 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Type=%2.2X Index=%u Obj=%p\n",
545 type
, index
, obj_desc
));
547 /* Parameter validation */
550 return_ACPI_STATUS(AE_BAD_PARAMETER
);
553 /* Get the namespace node for the arg/local */
555 status
= acpi_ds_method_data_get_node(type
, index
, walk_state
, &node
);
556 if (ACPI_FAILURE(status
)) {
557 return_ACPI_STATUS(status
);
560 current_obj_desc
= acpi_ns_get_attached_object(node
);
561 if (current_obj_desc
== obj_desc
) {
562 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Obj=%p already installed!\n",
564 return_ACPI_STATUS(status
);
568 * If the reference count on the object is more than one, we must
569 * take a copy of the object before we store. A reference count
570 * of exactly 1 means that the object was just created during the
571 * evaluation of an expression, and we can safely use it since it
572 * is not used anywhere else.
574 new_obj_desc
= obj_desc
;
575 if (obj_desc
->common
.reference_count
> 1) {
577 acpi_ut_copy_iobject_to_iobject(obj_desc
, &new_obj_desc
,
579 if (ACPI_FAILURE(status
)) {
580 return_ACPI_STATUS(status
);
585 * If there is an object already in this slot, we either
586 * have to delete it, or if this is an argument and there
587 * is an object reference stored there, we have to do
590 if (current_obj_desc
) {
592 * Check for an indirect store if an argument
593 * contains an object reference (stored as an Node).
594 * We don't allow this automatic dereferencing for
595 * locals, since a store to a local should overwrite
596 * anything there, including an object reference.
598 * If both Arg0 and Local0 contain ref_of (Local4):
600 * Store (1, Arg0) - Causes indirect store to local4
601 * Store (1, Local0) - Stores 1 in local0, overwriting
602 * the reference to local4
603 * Store (1, de_refof (Local0)) - Causes indirect store to local4
607 if (type
== ACPI_REFCLASS_ARG
) {
609 * If we have a valid reference object that came from ref_of(),
610 * do the indirect store
612 if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc
) ==
613 ACPI_DESC_TYPE_OPERAND
)
614 && (current_obj_desc
->common
.type
==
615 ACPI_TYPE_LOCAL_REFERENCE
)
616 && (current_obj_desc
->reference
.class ==
617 ACPI_REFCLASS_REFOF
)) {
618 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
619 "Arg (%p) is an ObjRef(Node), storing in node %p\n",
624 * Store this object to the Node (perform the indirect store)
625 * NOTE: No implicit conversion is performed, as per the ACPI
626 * specification rules on storing to Locals/Args.
629 acpi_ex_store_object_to_node(new_obj_desc
,
634 ACPI_NO_IMPLICIT_CONVERSION
);
636 /* Remove local reference if we copied the object above */
638 if (new_obj_desc
!= obj_desc
) {
639 acpi_ut_remove_reference(new_obj_desc
);
641 return_ACPI_STATUS(status
);
645 /* Delete the existing object before storing the new one */
647 acpi_ds_method_data_delete_value(type
, 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(type
, 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(object
->type
);