xref: /openbmc/linux/drivers/acpi/acpica/dsmthdat.c (revision 3371c19c)
195b482a8SLen Brown /*******************************************************************************
295b482a8SLen Brown  *
395b482a8SLen Brown  * Module Name: dsmthdat - control method arguments and local variables
495b482a8SLen Brown  *
595b482a8SLen Brown  ******************************************************************************/
695b482a8SLen Brown 
795b482a8SLen Brown /*
895b482a8SLen Brown  * Copyright (C) 2000 - 2008, Intel Corp.
995b482a8SLen Brown  * All rights reserved.
1095b482a8SLen Brown  *
1195b482a8SLen Brown  * Redistribution and use in source and binary forms, with or without
1295b482a8SLen Brown  * modification, are permitted provided that the following conditions
1395b482a8SLen Brown  * are met:
1495b482a8SLen Brown  * 1. Redistributions of source code must retain the above copyright
1595b482a8SLen Brown  *    notice, this list of conditions, and the following disclaimer,
1695b482a8SLen Brown  *    without modification.
1795b482a8SLen Brown  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1895b482a8SLen Brown  *    substantially similar to the "NO WARRANTY" disclaimer below
1995b482a8SLen Brown  *    ("Disclaimer") and any redistribution must be conditioned upon
2095b482a8SLen Brown  *    including a substantially similar Disclaimer requirement for further
2195b482a8SLen Brown  *    binary redistribution.
2295b482a8SLen Brown  * 3. Neither the names of the above-listed copyright holders nor the names
2395b482a8SLen Brown  *    of any contributors may be used to endorse or promote products derived
2495b482a8SLen Brown  *    from this software without specific prior written permission.
2595b482a8SLen Brown  *
2695b482a8SLen Brown  * Alternatively, this software may be distributed under the terms of the
2795b482a8SLen Brown  * GNU General Public License ("GPL") version 2 as published by the Free
2895b482a8SLen Brown  * Software Foundation.
2995b482a8SLen Brown  *
3095b482a8SLen Brown  * NO WARRANTY
3195b482a8SLen Brown  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
3295b482a8SLen Brown  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
3395b482a8SLen Brown  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
3495b482a8SLen Brown  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
3595b482a8SLen Brown  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3695b482a8SLen Brown  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3795b482a8SLen Brown  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3895b482a8SLen Brown  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3995b482a8SLen Brown  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
4095b482a8SLen Brown  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
4195b482a8SLen Brown  * POSSIBILITY OF SUCH DAMAGES.
4295b482a8SLen Brown  */
4395b482a8SLen Brown 
4495b482a8SLen Brown #include <acpi/acpi.h>
45e2f7a777SLen Brown #include "accommon.h"
46e2f7a777SLen Brown #include "acdispat.h"
47e2f7a777SLen Brown #include "acnamesp.h"
48e2f7a777SLen Brown #include "acinterp.h"
4995b482a8SLen Brown 
5095b482a8SLen Brown #define _COMPONENT          ACPI_DISPATCHER
5195b482a8SLen Brown ACPI_MODULE_NAME("dsmthdat")
5295b482a8SLen Brown 
5395b482a8SLen Brown /* Local prototypes */
5495b482a8SLen Brown static void
5595b482a8SLen Brown acpi_ds_method_data_delete_value(u8 type,
5695b482a8SLen Brown 				 u32 index, struct acpi_walk_state *walk_state);
5795b482a8SLen Brown 
5895b482a8SLen Brown static acpi_status
5995b482a8SLen Brown acpi_ds_method_data_set_value(u8 type,
6095b482a8SLen Brown 			      u32 index,
6195b482a8SLen Brown 			      union acpi_operand_object *object,
6295b482a8SLen Brown 			      struct acpi_walk_state *walk_state);
6395b482a8SLen Brown 
6495b482a8SLen Brown #ifdef ACPI_OBSOLETE_FUNCTIONS
6595b482a8SLen Brown acpi_object_type
6695b482a8SLen Brown acpi_ds_method_data_get_type(u16 opcode,
6795b482a8SLen Brown 			     u32 index, struct acpi_walk_state *walk_state);
6895b482a8SLen Brown #endif
6995b482a8SLen Brown 
7095b482a8SLen Brown /*******************************************************************************
7195b482a8SLen Brown  *
7295b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_init
7395b482a8SLen Brown  *
7495b482a8SLen Brown  * PARAMETERS:  walk_state          - Current walk state object
7595b482a8SLen Brown  *
7695b482a8SLen Brown  * RETURN:      Status
7795b482a8SLen Brown  *
7895b482a8SLen Brown  * DESCRIPTION: Initialize the data structures that hold the method's arguments
7995b482a8SLen Brown  *              and locals.  The data struct is an array of namespace nodes for
8095b482a8SLen Brown  *              each - this allows ref_of and de_ref_of to work properly for these
8195b482a8SLen Brown  *              special data types.
8295b482a8SLen Brown  *
8395b482a8SLen Brown  * NOTES:       walk_state fields are initialized to zero by the
8495b482a8SLen Brown  *              ACPI_ALLOCATE_ZEROED().
8595b482a8SLen Brown  *
8695b482a8SLen Brown  *              A pseudo-Namespace Node is assigned to each argument and local
8795b482a8SLen Brown  *              so that ref_of() can return a pointer to the Node.
8895b482a8SLen Brown  *
8995b482a8SLen Brown  ******************************************************************************/
9095b482a8SLen Brown 
9195b482a8SLen Brown void acpi_ds_method_data_init(struct acpi_walk_state *walk_state)
9295b482a8SLen Brown {
9395b482a8SLen Brown 	u32 i;
9495b482a8SLen Brown 
9595b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_init);
9695b482a8SLen Brown 
9795b482a8SLen Brown 	/* Init the method arguments */
9895b482a8SLen Brown 
9995b482a8SLen Brown 	for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) {
10095b482a8SLen Brown 		ACPI_MOVE_32_TO_32(&walk_state->arguments[i].name,
10195b482a8SLen Brown 				   NAMEOF_ARG_NTE);
10295b482a8SLen Brown 		walk_state->arguments[i].name.integer |= (i << 24);
10395b482a8SLen Brown 		walk_state->arguments[i].descriptor_type = ACPI_DESC_TYPE_NAMED;
10495b482a8SLen Brown 		walk_state->arguments[i].type = ACPI_TYPE_ANY;
10595b482a8SLen Brown 		walk_state->arguments[i].flags =
10695b482a8SLen Brown 		    ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_ARG;
10795b482a8SLen Brown 	}
10895b482a8SLen Brown 
10995b482a8SLen Brown 	/* Init the method locals */
11095b482a8SLen Brown 
11195b482a8SLen Brown 	for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) {
11295b482a8SLen Brown 		ACPI_MOVE_32_TO_32(&walk_state->local_variables[i].name,
11395b482a8SLen Brown 				   NAMEOF_LOCAL_NTE);
11495b482a8SLen Brown 
11595b482a8SLen Brown 		walk_state->local_variables[i].name.integer |= (i << 24);
11695b482a8SLen Brown 		walk_state->local_variables[i].descriptor_type =
11795b482a8SLen Brown 		    ACPI_DESC_TYPE_NAMED;
11895b482a8SLen Brown 		walk_state->local_variables[i].type = ACPI_TYPE_ANY;
11995b482a8SLen Brown 		walk_state->local_variables[i].flags =
12095b482a8SLen Brown 		    ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_LOCAL;
12195b482a8SLen Brown 	}
12295b482a8SLen Brown 
12395b482a8SLen Brown 	return_VOID;
12495b482a8SLen Brown }
12595b482a8SLen Brown 
12695b482a8SLen Brown /*******************************************************************************
12795b482a8SLen Brown  *
12895b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_delete_all
12995b482a8SLen Brown  *
13095b482a8SLen Brown  * PARAMETERS:  walk_state          - Current walk state object
13195b482a8SLen Brown  *
13295b482a8SLen Brown  * RETURN:      None
13395b482a8SLen Brown  *
13495b482a8SLen Brown  * DESCRIPTION: Delete method locals and arguments.  Arguments are only
13595b482a8SLen Brown  *              deleted if this method was called from another method.
13695b482a8SLen Brown  *
13795b482a8SLen Brown  ******************************************************************************/
13895b482a8SLen Brown 
13995b482a8SLen Brown void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state)
14095b482a8SLen Brown {
14195b482a8SLen Brown 	u32 index;
14295b482a8SLen Brown 
14395b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_delete_all);
14495b482a8SLen Brown 
14595b482a8SLen Brown 	/* Detach the locals */
14695b482a8SLen Brown 
14795b482a8SLen Brown 	for (index = 0; index < ACPI_METHOD_NUM_LOCALS; index++) {
14895b482a8SLen Brown 		if (walk_state->local_variables[index].object) {
14995b482a8SLen Brown 			ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Local%d=%p\n",
15095b482a8SLen Brown 					  index,
15195b482a8SLen Brown 					  walk_state->local_variables[index].
15295b482a8SLen Brown 					  object));
15395b482a8SLen Brown 
15495b482a8SLen Brown 			/* Detach object (if present) and remove a reference */
15595b482a8SLen Brown 
15695b482a8SLen Brown 			acpi_ns_detach_object(&walk_state->
15795b482a8SLen Brown 					      local_variables[index]);
15895b482a8SLen Brown 		}
15995b482a8SLen Brown 	}
16095b482a8SLen Brown 
16195b482a8SLen Brown 	/* Detach the arguments */
16295b482a8SLen Brown 
16395b482a8SLen Brown 	for (index = 0; index < ACPI_METHOD_NUM_ARGS; index++) {
16495b482a8SLen Brown 		if (walk_state->arguments[index].object) {
16595b482a8SLen Brown 			ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Arg%d=%p\n",
16695b482a8SLen Brown 					  index,
16795b482a8SLen Brown 					  walk_state->arguments[index].object));
16895b482a8SLen Brown 
16995b482a8SLen Brown 			/* Detach object (if present) and remove a reference */
17095b482a8SLen Brown 
17195b482a8SLen Brown 			acpi_ns_detach_object(&walk_state->arguments[index]);
17295b482a8SLen Brown 		}
17395b482a8SLen Brown 	}
17495b482a8SLen Brown 
17595b482a8SLen Brown 	return_VOID;
17695b482a8SLen Brown }
17795b482a8SLen Brown 
17895b482a8SLen Brown /*******************************************************************************
17995b482a8SLen Brown  *
18095b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_init_args
18195b482a8SLen Brown  *
18295b482a8SLen Brown  * PARAMETERS:  *Params         - Pointer to a parameter list for the method
18395b482a8SLen Brown  *              max_param_count - The arg count for this method
18495b482a8SLen Brown  *              walk_state      - Current walk state object
18595b482a8SLen Brown  *
18695b482a8SLen Brown  * RETURN:      Status
18795b482a8SLen Brown  *
18895b482a8SLen Brown  * DESCRIPTION: Initialize arguments for a method.  The parameter list is a list
18995b482a8SLen Brown  *              of ACPI operand objects, either null terminated or whose length
19095b482a8SLen Brown  *              is defined by max_param_count.
19195b482a8SLen Brown  *
19295b482a8SLen Brown  ******************************************************************************/
19395b482a8SLen Brown 
19495b482a8SLen Brown acpi_status
19595b482a8SLen Brown acpi_ds_method_data_init_args(union acpi_operand_object **params,
19695b482a8SLen Brown 			      u32 max_param_count,
19795b482a8SLen Brown 			      struct acpi_walk_state *walk_state)
19895b482a8SLen Brown {
19995b482a8SLen Brown 	acpi_status status;
20095b482a8SLen Brown 	u32 index = 0;
20195b482a8SLen Brown 
20295b482a8SLen Brown 	ACPI_FUNCTION_TRACE_PTR(ds_method_data_init_args, params);
20395b482a8SLen Brown 
20495b482a8SLen Brown 	if (!params) {
20595b482a8SLen Brown 		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
20695b482a8SLen Brown 				  "No param list passed to method\n"));
20795b482a8SLen Brown 		return_ACPI_STATUS(AE_OK);
20895b482a8SLen Brown 	}
20995b482a8SLen Brown 
21095b482a8SLen Brown 	/* Copy passed parameters into the new method stack frame */
21195b482a8SLen Brown 
21295b482a8SLen Brown 	while ((index < ACPI_METHOD_NUM_ARGS) &&
21395b482a8SLen Brown 	       (index < max_param_count) && params[index]) {
21495b482a8SLen Brown 		/*
21595b482a8SLen Brown 		 * A valid parameter.
21695b482a8SLen Brown 		 * Store the argument in the method/walk descriptor.
21795b482a8SLen Brown 		 * Do not copy the arg in order to implement call by reference
21895b482a8SLen Brown 		 */
21995b482a8SLen Brown 		status = acpi_ds_method_data_set_value(ACPI_REFCLASS_ARG, index,
22095b482a8SLen Brown 						       params[index],
22195b482a8SLen Brown 						       walk_state);
22295b482a8SLen Brown 		if (ACPI_FAILURE(status)) {
22395b482a8SLen Brown 			return_ACPI_STATUS(status);
22495b482a8SLen Brown 		}
22595b482a8SLen Brown 
22695b482a8SLen Brown 		index++;
22795b482a8SLen Brown 	}
22895b482a8SLen Brown 
22995b482a8SLen Brown 	ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%d args passed to method\n", index));
23095b482a8SLen Brown 	return_ACPI_STATUS(AE_OK);
23195b482a8SLen Brown }
23295b482a8SLen Brown 
23395b482a8SLen Brown /*******************************************************************************
23495b482a8SLen Brown  *
23595b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_get_node
23695b482a8SLen Brown  *
23795b482a8SLen Brown  * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
23895b482a8SLen Brown  *                                    ACPI_REFCLASS_ARG
23995b482a8SLen Brown  *              Index               - Which Local or Arg whose type to get
24095b482a8SLen Brown  *              walk_state          - Current walk state object
24195b482a8SLen Brown  *              Node                - Where the node is returned.
24295b482a8SLen Brown  *
24395b482a8SLen Brown  * RETURN:      Status and node
24495b482a8SLen Brown  *
24595b482a8SLen Brown  * DESCRIPTION: Get the Node associated with a local or arg.
24695b482a8SLen Brown  *
24795b482a8SLen Brown  ******************************************************************************/
24895b482a8SLen Brown 
24995b482a8SLen Brown acpi_status
25095b482a8SLen Brown acpi_ds_method_data_get_node(u8 type,
25195b482a8SLen Brown 			     u32 index,
25295b482a8SLen Brown 			     struct acpi_walk_state *walk_state,
25395b482a8SLen Brown 			     struct acpi_namespace_node **node)
25495b482a8SLen Brown {
25595b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_get_node);
25695b482a8SLen Brown 
25795b482a8SLen Brown 	/*
25895b482a8SLen Brown 	 * Method Locals and Arguments are supported
25995b482a8SLen Brown 	 */
26095b482a8SLen Brown 	switch (type) {
26195b482a8SLen Brown 	case ACPI_REFCLASS_LOCAL:
26295b482a8SLen Brown 
26395b482a8SLen Brown 		if (index > ACPI_METHOD_MAX_LOCAL) {
26495b482a8SLen Brown 			ACPI_ERROR((AE_INFO,
26595b482a8SLen Brown 				    "Local index %d is invalid (max %d)",
26695b482a8SLen Brown 				    index, ACPI_METHOD_MAX_LOCAL));
26795b482a8SLen Brown 			return_ACPI_STATUS(AE_AML_INVALID_INDEX);
26895b482a8SLen Brown 		}
26995b482a8SLen Brown 
27095b482a8SLen Brown 		/* Return a pointer to the pseudo-node */
27195b482a8SLen Brown 
27295b482a8SLen Brown 		*node = &walk_state->local_variables[index];
27395b482a8SLen Brown 		break;
27495b482a8SLen Brown 
27595b482a8SLen Brown 	case ACPI_REFCLASS_ARG:
27695b482a8SLen Brown 
27795b482a8SLen Brown 		if (index > ACPI_METHOD_MAX_ARG) {
27895b482a8SLen Brown 			ACPI_ERROR((AE_INFO,
27995b482a8SLen Brown 				    "Arg index %d is invalid (max %d)",
28095b482a8SLen Brown 				    index, ACPI_METHOD_MAX_ARG));
28195b482a8SLen Brown 			return_ACPI_STATUS(AE_AML_INVALID_INDEX);
28295b482a8SLen Brown 		}
28395b482a8SLen Brown 
28495b482a8SLen Brown 		/* Return a pointer to the pseudo-node */
28595b482a8SLen Brown 
28695b482a8SLen Brown 		*node = &walk_state->arguments[index];
28795b482a8SLen Brown 		break;
28895b482a8SLen Brown 
28995b482a8SLen Brown 	default:
29095b482a8SLen Brown 		ACPI_ERROR((AE_INFO, "Type %d is invalid", type));
29195b482a8SLen Brown 		return_ACPI_STATUS(AE_TYPE);
29295b482a8SLen Brown 	}
29395b482a8SLen Brown 
29495b482a8SLen Brown 	return_ACPI_STATUS(AE_OK);
29595b482a8SLen Brown }
29695b482a8SLen Brown 
29795b482a8SLen Brown /*******************************************************************************
29895b482a8SLen Brown  *
29995b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_set_value
30095b482a8SLen Brown  *
30195b482a8SLen Brown  * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
30295b482a8SLen Brown  *                                    ACPI_REFCLASS_ARG
30395b482a8SLen Brown  *              Index               - Which Local or Arg to get
30495b482a8SLen Brown  *              Object              - Object to be inserted into the stack entry
30595b482a8SLen Brown  *              walk_state          - Current walk state object
30695b482a8SLen Brown  *
30795b482a8SLen Brown  * RETURN:      Status
30895b482a8SLen Brown  *
30995b482a8SLen Brown  * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
31095b482a8SLen Brown  *              Note: There is no "implicit conversion" for locals.
31195b482a8SLen Brown  *
31295b482a8SLen Brown  ******************************************************************************/
31395b482a8SLen Brown 
31495b482a8SLen Brown static acpi_status
31595b482a8SLen Brown acpi_ds_method_data_set_value(u8 type,
31695b482a8SLen Brown 			      u32 index,
31795b482a8SLen Brown 			      union acpi_operand_object *object,
31895b482a8SLen Brown 			      struct acpi_walk_state *walk_state)
31995b482a8SLen Brown {
32095b482a8SLen Brown 	acpi_status status;
32195b482a8SLen Brown 	struct acpi_namespace_node *node;
32295b482a8SLen Brown 
32395b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_set_value);
32495b482a8SLen Brown 
32595b482a8SLen Brown 	ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
32695b482a8SLen Brown 			  "NewObj %p Type %2.2X, Refs=%d [%s]\n", object,
32795b482a8SLen Brown 			  type, object->common.reference_count,
32895b482a8SLen Brown 			  acpi_ut_get_type_name(object->common.type)));
32995b482a8SLen Brown 
33095b482a8SLen Brown 	/* Get the namespace node for the arg/local */
33195b482a8SLen Brown 
33295b482a8SLen Brown 	status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
33395b482a8SLen Brown 	if (ACPI_FAILURE(status)) {
33495b482a8SLen Brown 		return_ACPI_STATUS(status);
33595b482a8SLen Brown 	}
33695b482a8SLen Brown 
33795b482a8SLen Brown 	/*
33895b482a8SLen Brown 	 * Increment ref count so object can't be deleted while installed.
33995b482a8SLen Brown 	 * NOTE: We do not copy the object in order to preserve the call by
34095b482a8SLen Brown 	 * reference semantics of ACPI Control Method invocation.
34195b482a8SLen Brown 	 * (See ACPI Specification 2.0_c)
34295b482a8SLen Brown 	 */
34395b482a8SLen Brown 	acpi_ut_add_reference(object);
34495b482a8SLen Brown 
34595b482a8SLen Brown 	/* Install the object */
34695b482a8SLen Brown 
34795b482a8SLen Brown 	node->object = object;
34895b482a8SLen Brown 	return_ACPI_STATUS(status);
34995b482a8SLen Brown }
35095b482a8SLen Brown 
35195b482a8SLen Brown /*******************************************************************************
35295b482a8SLen Brown  *
35395b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_get_value
35495b482a8SLen Brown  *
35595b482a8SLen Brown  * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
35695b482a8SLen Brown  *                                    ACPI_REFCLASS_ARG
35795b482a8SLen Brown  *              Index               - Which local_var or argument to get
35895b482a8SLen Brown  *              walk_state          - Current walk state object
35995b482a8SLen Brown  *              dest_desc           - Where Arg or Local value is returned
36095b482a8SLen Brown  *
36195b482a8SLen Brown  * RETURN:      Status
36295b482a8SLen Brown  *
36395b482a8SLen Brown  * DESCRIPTION: Retrieve value of selected Arg or Local for this method
36495b482a8SLen Brown  *              Used only in acpi_ex_resolve_to_value().
36595b482a8SLen Brown  *
36695b482a8SLen Brown  ******************************************************************************/
36795b482a8SLen Brown 
36895b482a8SLen Brown acpi_status
36995b482a8SLen Brown acpi_ds_method_data_get_value(u8 type,
37095b482a8SLen Brown 			      u32 index,
37195b482a8SLen Brown 			      struct acpi_walk_state *walk_state,
37295b482a8SLen Brown 			      union acpi_operand_object **dest_desc)
37395b482a8SLen Brown {
37495b482a8SLen Brown 	acpi_status status;
37595b482a8SLen Brown 	struct acpi_namespace_node *node;
37695b482a8SLen Brown 	union acpi_operand_object *object;
37795b482a8SLen Brown 
37895b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_get_value);
37995b482a8SLen Brown 
38095b482a8SLen Brown 	/* Validate the object descriptor */
38195b482a8SLen Brown 
38295b482a8SLen Brown 	if (!dest_desc) {
38395b482a8SLen Brown 		ACPI_ERROR((AE_INFO, "Null object descriptor pointer"));
38495b482a8SLen Brown 		return_ACPI_STATUS(AE_BAD_PARAMETER);
38595b482a8SLen Brown 	}
38695b482a8SLen Brown 
38795b482a8SLen Brown 	/* Get the namespace node for the arg/local */
38895b482a8SLen Brown 
38995b482a8SLen Brown 	status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
39095b482a8SLen Brown 	if (ACPI_FAILURE(status)) {
39195b482a8SLen Brown 		return_ACPI_STATUS(status);
39295b482a8SLen Brown 	}
39395b482a8SLen Brown 
39495b482a8SLen Brown 	/* Get the object from the node */
39595b482a8SLen Brown 
39695b482a8SLen Brown 	object = node->object;
39795b482a8SLen Brown 
39895b482a8SLen Brown 	/* Examine the returned object, it must be valid. */
39995b482a8SLen Brown 
40095b482a8SLen Brown 	if (!object) {
40195b482a8SLen Brown 		/*
40295b482a8SLen Brown 		 * Index points to uninitialized object.
40395b482a8SLen Brown 		 * This means that either 1) The expected argument was
40495b482a8SLen Brown 		 * not passed to the method, or 2) A local variable
40595b482a8SLen Brown 		 * was referenced by the method (via the ASL)
40695b482a8SLen Brown 		 * before it was initialized.  Either case is an error.
40795b482a8SLen Brown 		 */
40895b482a8SLen Brown 
40995b482a8SLen Brown 		/* If slack enabled, init the local_x/arg_x to an Integer of value zero */
41095b482a8SLen Brown 
41195b482a8SLen Brown 		if (acpi_gbl_enable_interpreter_slack) {
41295b482a8SLen Brown 			object =
41395b482a8SLen Brown 			    acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
41495b482a8SLen Brown 			if (!object) {
41595b482a8SLen Brown 				return_ACPI_STATUS(AE_NO_MEMORY);
41695b482a8SLen Brown 			}
41795b482a8SLen Brown 
41895b482a8SLen Brown 			object->integer.value = 0;
41995b482a8SLen Brown 			node->object = object;
42095b482a8SLen Brown 		}
42195b482a8SLen Brown 
42295b482a8SLen Brown 		/* Otherwise, return the error */
42395b482a8SLen Brown 
42495b482a8SLen Brown 		else
42595b482a8SLen Brown 			switch (type) {
42695b482a8SLen Brown 			case ACPI_REFCLASS_ARG:
42795b482a8SLen Brown 
42895b482a8SLen Brown 				ACPI_ERROR((AE_INFO,
42995b482a8SLen Brown 					    "Uninitialized Arg[%d] at node %p",
43095b482a8SLen Brown 					    index, node));
43195b482a8SLen Brown 
43295b482a8SLen Brown 				return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG);
43395b482a8SLen Brown 
43495b482a8SLen Brown 			case ACPI_REFCLASS_LOCAL:
43595b482a8SLen Brown 
43695b482a8SLen Brown 				ACPI_ERROR((AE_INFO,
43795b482a8SLen Brown 					    "Uninitialized Local[%d] at node %p",
43895b482a8SLen Brown 					    index, node));
43995b482a8SLen Brown 
44095b482a8SLen Brown 				return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL);
44195b482a8SLen Brown 
44295b482a8SLen Brown 			default:
44395b482a8SLen Brown 
44495b482a8SLen Brown 				ACPI_ERROR((AE_INFO,
44595b482a8SLen Brown 					    "Not a Arg/Local opcode: %X",
44695b482a8SLen Brown 					    type));
44795b482a8SLen Brown 				return_ACPI_STATUS(AE_AML_INTERNAL);
44895b482a8SLen Brown 			}
44995b482a8SLen Brown 	}
45095b482a8SLen Brown 
45195b482a8SLen Brown 	/*
45295b482a8SLen Brown 	 * The Index points to an initialized and valid object.
45395b482a8SLen Brown 	 * Return an additional reference to the object
45495b482a8SLen Brown 	 */
45595b482a8SLen Brown 	*dest_desc = object;
45695b482a8SLen Brown 	acpi_ut_add_reference(object);
45795b482a8SLen Brown 
45895b482a8SLen Brown 	return_ACPI_STATUS(AE_OK);
45995b482a8SLen Brown }
46095b482a8SLen Brown 
46195b482a8SLen Brown /*******************************************************************************
46295b482a8SLen Brown  *
46395b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_delete_value
46495b482a8SLen Brown  *
46595b482a8SLen Brown  * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
46695b482a8SLen Brown  *                                    ACPI_REFCLASS_ARG
46795b482a8SLen Brown  *              Index               - Which local_var or argument to delete
46895b482a8SLen Brown  *              walk_state          - Current walk state object
46995b482a8SLen Brown  *
47095b482a8SLen Brown  * RETURN:      None
47195b482a8SLen Brown  *
47295b482a8SLen Brown  * DESCRIPTION: Delete the entry at Opcode:Index.  Inserts
47395b482a8SLen Brown  *              a null into the stack slot after the object is deleted.
47495b482a8SLen Brown  *
47595b482a8SLen Brown  ******************************************************************************/
47695b482a8SLen Brown 
47795b482a8SLen Brown static void
47895b482a8SLen Brown acpi_ds_method_data_delete_value(u8 type,
47995b482a8SLen Brown 				 u32 index, struct acpi_walk_state *walk_state)
48095b482a8SLen Brown {
48195b482a8SLen Brown 	acpi_status status;
48295b482a8SLen Brown 	struct acpi_namespace_node *node;
48395b482a8SLen Brown 	union acpi_operand_object *object;
48495b482a8SLen Brown 
48595b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_delete_value);
48695b482a8SLen Brown 
48795b482a8SLen Brown 	/* Get the namespace node for the arg/local */
48895b482a8SLen Brown 
48995b482a8SLen Brown 	status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
49095b482a8SLen Brown 	if (ACPI_FAILURE(status)) {
49195b482a8SLen Brown 		return_VOID;
49295b482a8SLen Brown 	}
49395b482a8SLen Brown 
49495b482a8SLen Brown 	/* Get the associated object */
49595b482a8SLen Brown 
49695b482a8SLen Brown 	object = acpi_ns_get_attached_object(node);
49795b482a8SLen Brown 
49895b482a8SLen Brown 	/*
49995b482a8SLen Brown 	 * Undefine the Arg or Local by setting its descriptor
50095b482a8SLen Brown 	 * pointer to NULL. Locals/Args can contain both
50195b482a8SLen Brown 	 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
50295b482a8SLen Brown 	 */
50395b482a8SLen Brown 	node->object = NULL;
50495b482a8SLen Brown 
50595b482a8SLen Brown 	if ((object) &&
50695b482a8SLen Brown 	    (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_OPERAND)) {
50795b482a8SLen Brown 		/*
50895b482a8SLen Brown 		 * There is a valid object.
50995b482a8SLen Brown 		 * Decrement the reference count by one to balance the
51095b482a8SLen Brown 		 * increment when the object was stored.
51195b482a8SLen Brown 		 */
51295b482a8SLen Brown 		acpi_ut_remove_reference(object);
51395b482a8SLen Brown 	}
51495b482a8SLen Brown 
51595b482a8SLen Brown 	return_VOID;
51695b482a8SLen Brown }
51795b482a8SLen Brown 
51895b482a8SLen Brown /*******************************************************************************
51995b482a8SLen Brown  *
52095b482a8SLen Brown  * FUNCTION:    acpi_ds_store_object_to_local
52195b482a8SLen Brown  *
52295b482a8SLen Brown  * PARAMETERS:  Type                - Either ACPI_REFCLASS_LOCAL or
52395b482a8SLen Brown  *                                    ACPI_REFCLASS_ARG
52495b482a8SLen Brown  *              Index               - Which Local or Arg to set
52595b482a8SLen Brown  *              obj_desc            - Value to be stored
52695b482a8SLen Brown  *              walk_state          - Current walk state
52795b482a8SLen Brown  *
52895b482a8SLen Brown  * RETURN:      Status
52995b482a8SLen Brown  *
53095b482a8SLen Brown  * DESCRIPTION: Store a value in an Arg or Local.  The obj_desc is installed
53195b482a8SLen Brown  *              as the new value for the Arg or Local and the reference count
53295b482a8SLen Brown  *              for obj_desc is incremented.
53395b482a8SLen Brown  *
53495b482a8SLen Brown  ******************************************************************************/
53595b482a8SLen Brown 
53695b482a8SLen Brown acpi_status
53795b482a8SLen Brown acpi_ds_store_object_to_local(u8 type,
53895b482a8SLen Brown 			      u32 index,
53995b482a8SLen Brown 			      union acpi_operand_object *obj_desc,
54095b482a8SLen Brown 			      struct acpi_walk_state *walk_state)
54195b482a8SLen Brown {
54295b482a8SLen Brown 	acpi_status status;
54395b482a8SLen Brown 	struct acpi_namespace_node *node;
54495b482a8SLen Brown 	union acpi_operand_object *current_obj_desc;
54595b482a8SLen Brown 	union acpi_operand_object *new_obj_desc;
54695b482a8SLen Brown 
54795b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_store_object_to_local);
54895b482a8SLen Brown 	ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Type=%2.2X Index=%d Obj=%p\n",
54995b482a8SLen Brown 			  type, index, obj_desc));
55095b482a8SLen Brown 
55195b482a8SLen Brown 	/* Parameter validation */
55295b482a8SLen Brown 
55395b482a8SLen Brown 	if (!obj_desc) {
55495b482a8SLen Brown 		return_ACPI_STATUS(AE_BAD_PARAMETER);
55595b482a8SLen Brown 	}
55695b482a8SLen Brown 
55795b482a8SLen Brown 	/* Get the namespace node for the arg/local */
55895b482a8SLen Brown 
55995b482a8SLen Brown 	status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
56095b482a8SLen Brown 	if (ACPI_FAILURE(status)) {
56195b482a8SLen Brown 		return_ACPI_STATUS(status);
56295b482a8SLen Brown 	}
56395b482a8SLen Brown 
56495b482a8SLen Brown 	current_obj_desc = acpi_ns_get_attached_object(node);
56595b482a8SLen Brown 	if (current_obj_desc == obj_desc) {
56695b482a8SLen Brown 		ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Obj=%p already installed!\n",
56795b482a8SLen Brown 				  obj_desc));
56895b482a8SLen Brown 		return_ACPI_STATUS(status);
56995b482a8SLen Brown 	}
57095b482a8SLen Brown 
57195b482a8SLen Brown 	/*
57295b482a8SLen Brown 	 * If the reference count on the object is more than one, we must
57395b482a8SLen Brown 	 * take a copy of the object before we store.  A reference count
57495b482a8SLen Brown 	 * of exactly 1 means that the object was just created during the
57595b482a8SLen Brown 	 * evaluation of an expression, and we can safely use it since it
57695b482a8SLen Brown 	 * is not used anywhere else.
57795b482a8SLen Brown 	 */
57895b482a8SLen Brown 	new_obj_desc = obj_desc;
57995b482a8SLen Brown 	if (obj_desc->common.reference_count > 1) {
58095b482a8SLen Brown 		status =
58195b482a8SLen Brown 		    acpi_ut_copy_iobject_to_iobject(obj_desc, &new_obj_desc,
58295b482a8SLen Brown 						    walk_state);
58395b482a8SLen Brown 		if (ACPI_FAILURE(status)) {
58495b482a8SLen Brown 			return_ACPI_STATUS(status);
58595b482a8SLen Brown 		}
58695b482a8SLen Brown 	}
58795b482a8SLen Brown 
58895b482a8SLen Brown 	/*
58995b482a8SLen Brown 	 * If there is an object already in this slot, we either
59095b482a8SLen Brown 	 * have to delete it, or if this is an argument and there
59195b482a8SLen Brown 	 * is an object reference stored there, we have to do
59295b482a8SLen Brown 	 * an indirect store!
59395b482a8SLen Brown 	 */
59495b482a8SLen Brown 	if (current_obj_desc) {
59595b482a8SLen Brown 		/*
59695b482a8SLen Brown 		 * Check for an indirect store if an argument
59795b482a8SLen Brown 		 * contains an object reference (stored as an Node).
59895b482a8SLen Brown 		 * We don't allow this automatic dereferencing for
59995b482a8SLen Brown 		 * locals, since a store to a local should overwrite
60095b482a8SLen Brown 		 * anything there, including an object reference.
60195b482a8SLen Brown 		 *
60295b482a8SLen Brown 		 * If both Arg0 and Local0 contain ref_of (Local4):
60395b482a8SLen Brown 		 *
60495b482a8SLen Brown 		 * Store (1, Arg0)             - Causes indirect store to local4
60595b482a8SLen Brown 		 * Store (1, Local0)           - Stores 1 in local0, overwriting
60695b482a8SLen Brown 		 *                                  the reference to local4
60795b482a8SLen Brown 		 * Store (1, de_refof (Local0)) - Causes indirect store to local4
60895b482a8SLen Brown 		 *
60995b482a8SLen Brown 		 * Weird, but true.
61095b482a8SLen Brown 		 */
61195b482a8SLen Brown 		if (type == ACPI_REFCLASS_ARG) {
61295b482a8SLen Brown 			/*
61395b482a8SLen Brown 			 * If we have a valid reference object that came from ref_of(),
61495b482a8SLen Brown 			 * do the indirect store
61595b482a8SLen Brown 			 */
61695b482a8SLen Brown 			if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc) ==
61795b482a8SLen Brown 			     ACPI_DESC_TYPE_OPERAND)
61895b482a8SLen Brown 			    && (current_obj_desc->common.type ==
61995b482a8SLen Brown 				ACPI_TYPE_LOCAL_REFERENCE)
62095b482a8SLen Brown 			    && (current_obj_desc->reference.class ==
62195b482a8SLen Brown 				ACPI_REFCLASS_REFOF)) {
62295b482a8SLen Brown 				ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
62395b482a8SLen Brown 						  "Arg (%p) is an ObjRef(Node), storing in node %p\n",
62495b482a8SLen Brown 						  new_obj_desc,
62595b482a8SLen Brown 						  current_obj_desc));
62695b482a8SLen Brown 
62795b482a8SLen Brown 				/*
62895b482a8SLen Brown 				 * Store this object to the Node (perform the indirect store)
62995b482a8SLen Brown 				 * NOTE: No implicit conversion is performed, as per the ACPI
63095b482a8SLen Brown 				 * specification rules on storing to Locals/Args.
63195b482a8SLen Brown 				 */
63295b482a8SLen Brown 				status =
63395b482a8SLen Brown 				    acpi_ex_store_object_to_node(new_obj_desc,
63495b482a8SLen Brown 								 current_obj_desc->
63595b482a8SLen Brown 								 reference.
63695b482a8SLen Brown 								 object,
63795b482a8SLen Brown 								 walk_state,
63895b482a8SLen Brown 								 ACPI_NO_IMPLICIT_CONVERSION);
63995b482a8SLen Brown 
64095b482a8SLen Brown 				/* Remove local reference if we copied the object above */
64195b482a8SLen Brown 
64295b482a8SLen Brown 				if (new_obj_desc != obj_desc) {
64395b482a8SLen Brown 					acpi_ut_remove_reference(new_obj_desc);
64495b482a8SLen Brown 				}
64595b482a8SLen Brown 				return_ACPI_STATUS(status);
64695b482a8SLen Brown 			}
64795b482a8SLen Brown 		}
64895b482a8SLen Brown 
64995b482a8SLen Brown 		/* Delete the existing object before storing the new one */
65095b482a8SLen Brown 
65195b482a8SLen Brown 		acpi_ds_method_data_delete_value(type, index, walk_state);
65295b482a8SLen Brown 	}
65395b482a8SLen Brown 
65495b482a8SLen Brown 	/*
65595b482a8SLen Brown 	 * Install the Obj descriptor (*new_obj_desc) into
65695b482a8SLen Brown 	 * the descriptor for the Arg or Local.
65795b482a8SLen Brown 	 * (increments the object reference count by one)
65895b482a8SLen Brown 	 */
65995b482a8SLen Brown 	status =
66095b482a8SLen Brown 	    acpi_ds_method_data_set_value(type, index, new_obj_desc,
66195b482a8SLen Brown 					  walk_state);
66295b482a8SLen Brown 
66395b482a8SLen Brown 	/* Remove local reference if we copied the object above */
66495b482a8SLen Brown 
66595b482a8SLen Brown 	if (new_obj_desc != obj_desc) {
66695b482a8SLen Brown 		acpi_ut_remove_reference(new_obj_desc);
66795b482a8SLen Brown 	}
66895b482a8SLen Brown 
66995b482a8SLen Brown 	return_ACPI_STATUS(status);
67095b482a8SLen Brown }
67195b482a8SLen Brown 
67295b482a8SLen Brown #ifdef ACPI_OBSOLETE_FUNCTIONS
67395b482a8SLen Brown /*******************************************************************************
67495b482a8SLen Brown  *
67595b482a8SLen Brown  * FUNCTION:    acpi_ds_method_data_get_type
67695b482a8SLen Brown  *
67795b482a8SLen Brown  * PARAMETERS:  Opcode              - Either AML_LOCAL_OP or AML_ARG_OP
67895b482a8SLen Brown  *              Index               - Which Local or Arg whose type to get
67995b482a8SLen Brown  *              walk_state          - Current walk state object
68095b482a8SLen Brown  *
68195b482a8SLen Brown  * RETURN:      Data type of current value of the selected Arg or Local
68295b482a8SLen Brown  *
68395b482a8SLen Brown  * DESCRIPTION: Get the type of the object stored in the Local or Arg
68495b482a8SLen Brown  *
68595b482a8SLen Brown  ******************************************************************************/
68695b482a8SLen Brown 
68795b482a8SLen Brown acpi_object_type
68895b482a8SLen Brown acpi_ds_method_data_get_type(u16 opcode,
68995b482a8SLen Brown 			     u32 index, struct acpi_walk_state *walk_state)
69095b482a8SLen Brown {
69195b482a8SLen Brown 	acpi_status status;
69295b482a8SLen Brown 	struct acpi_namespace_node *node;
69395b482a8SLen Brown 	union acpi_operand_object *object;
69495b482a8SLen Brown 
69595b482a8SLen Brown 	ACPI_FUNCTION_TRACE(ds_method_data_get_type);
69695b482a8SLen Brown 
69795b482a8SLen Brown 	/* Get the namespace node for the arg/local */
69895b482a8SLen Brown 
69995b482a8SLen Brown 	status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
70095b482a8SLen Brown 	if (ACPI_FAILURE(status)) {
70195b482a8SLen Brown 		return_VALUE((ACPI_TYPE_NOT_FOUND));
70295b482a8SLen Brown 	}
70395b482a8SLen Brown 
70495b482a8SLen Brown 	/* Get the object */
70595b482a8SLen Brown 
70695b482a8SLen Brown 	object = acpi_ns_get_attached_object(node);
70795b482a8SLen Brown 	if (!object) {
70895b482a8SLen Brown 
70995b482a8SLen Brown 		/* Uninitialized local/arg, return TYPE_ANY */
71095b482a8SLen Brown 
71195b482a8SLen Brown 		return_VALUE(ACPI_TYPE_ANY);
71295b482a8SLen Brown 	}
71395b482a8SLen Brown 
71495b482a8SLen Brown 	/* Get the object type */
71595b482a8SLen Brown 
7163371c19cSBob Moore 	return_VALUE(object->type);
71795b482a8SLen Brown }
71895b482a8SLen Brown #endif
719