[linux-2.6-block.git] / drivers / acpi / acpica / nspredef.c

/******************************************************************************
 *
 * Module Name: nspredef - Validation of ACPI predefined methods and objects
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2013, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#define ACPI_CREATE_PREDEFINED_TABLE

#include <acpi/acpi.h>
#include "accommon.h"
#include "acnamesp.h"
#include "acpredef.h"

#define _COMPONENT          ACPI_NAMESPACE
ACPI_MODULE_NAME("nspredef")

/*******************************************************************************
 *
 * This module validates predefined ACPI objects that appear in the namespace,
 * at the time they are evaluated (via acpi_evaluate_object). The purpose of this
 * validation is to detect problems with BIOS-exposed predefined ACPI objects
 * before the results are returned to the ACPI-related drivers.
 *
 * There are several areas that are validated:
 *
 *  1) The number of input arguments as defined by the method/object in the
 *     ASL is validated against the ACPI specification.
 *  2) The type of the return object (if any) is validated against the ACPI
 *     specification.
 *  3) For returned package objects, the count of package elements is
 *     validated, as well as the type of each package element. Nested
 *     packages are supported.
 *
 * For any problems found, a warning message is issued.
 *
 ******************************************************************************/
/* Local prototypes */
static acpi_status
acpi_ns_check_reference(struct acpi_evaluate_info *info,
			union acpi_operand_object *return_object);

static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object);

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_check_return_value
 *
 * PARAMETERS:  node            - Namespace node for the method/object
 *              info            - Method execution information block
 *              user_param_count - Number of parameters actually passed
 *              return_status   - Status from the object evaluation
 *              return_object_ptr - Pointer to the object returned from the
 *                                evaluation of a method or object
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Check the value returned from a predefined name.
 *
 ******************************************************************************/

acpi_status
acpi_ns_check_return_value(struct acpi_namespace_node *node,
			   struct acpi_evaluate_info *info,
			   u32 user_param_count,
			   acpi_status return_status,
			   union acpi_operand_object **return_object_ptr)
{
	acpi_status status;
	const union acpi_predefined_info *predefined;

	/* If not a predefined name, we cannot validate the return object */

	predefined = info->predefined;
	if (!predefined) {
		return (AE_OK);
	}

	/*
	 * If the method failed or did not actually return an object, we cannot
	 * validate the return object
	 */
	if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) {
		return (AE_OK);
	}

	/*
	 * Return value validation and possible repair.
	 *
	 * 1) Don't perform return value validation/repair if this feature
	 * has been disabled via a global option.
	 *
	 * 2) We have a return value, but if one wasn't expected, just exit,
	 * this is not a problem. For example, if the "Implicit Return"
	 * feature is enabled, methods will always return a value.
	 *
	 * 3) If the return value can be of any type, then we cannot perform
	 * any validation, just exit.
	 */
	if (acpi_gbl_disable_auto_repair ||
	    (!predefined->info.expected_btypes) ||
	    (predefined->info.expected_btypes == ACPI_RTYPE_ALL)) {
		return (AE_OK);
	}

	/*
	 * Check that the type of the main return object is what is expected
	 * for this predefined name
	 */
	status = acpi_ns_check_object_type(info, return_object_ptr,
					   predefined->info.expected_btypes,
					   ACPI_NOT_PACKAGE_ELEMENT);
	if (ACPI_FAILURE(status)) {
		goto exit;
	}

	/*
	 *
	 * 4) If there is no return value and it is optional, just return
	 * AE_OK (_WAK).
	 */
	if (!(*return_object_ptr)) {
		goto exit;
	}

	/*
	 * For returned Package objects, check the type of all sub-objects.
	 * Note: Package may have been newly created by call above.
	 */
	if ((*return_object_ptr)->common.type == ACPI_TYPE_PACKAGE) {
		info->parent_package = *return_object_ptr;
		status = acpi_ns_check_package(info, return_object_ptr);
		if (ACPI_FAILURE(status)) {

			/* We might be able to fix some errors */

			if ((status != AE_AML_OPERAND_TYPE) &&
			    (status != AE_AML_OPERAND_VALUE)) {
				goto exit;
			}
		}
	}

	/*
	 * The return object was OK, or it was successfully repaired above.
	 * Now make some additional checks such as verifying that package
	 * objects are sorted correctly (if required) or buffer objects have
	 * the correct data width (bytes vs. dwords). These repairs are
	 * performed on a per-name basis, i.e., the code is specific to
	 * particular predefined names.
	 */
	status = acpi_ns_complex_repairs(info, node, status, return_object_ptr);

exit:
	/*
	 * If the object validation failed or if we successfully repaired one
	 * or more objects, mark the parent node to suppress further warning
	 * messages during the next evaluation of the same method/object.
	 */
	if (ACPI_FAILURE(status) || (info->return_flags & ACPI_OBJECT_REPAIRED)) {
		node->flags |= ANOBJ_EVALUATED;
	}

	return (status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_check_object_type
 *
 * PARAMETERS:  info            - Method execution information block
 *              return_object_ptr - Pointer to the object returned from the
 *                                evaluation of a method or object
 *              expected_btypes - Bitmap of expected return type(s)
 *              package_index   - Index of object within parent package (if
 *                                applicable - ACPI_NOT_PACKAGE_ELEMENT
 *                                otherwise)
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Check the type of the return object against the expected object
 *              type(s). Use of Btype allows multiple expected object types.
 *
 ******************************************************************************/

acpi_status
acpi_ns_check_object_type(struct acpi_evaluate_info *info,
			  union acpi_operand_object **return_object_ptr,
			  u32 expected_btypes, u32 package_index)
{
	union acpi_operand_object *return_object = *return_object_ptr;
	acpi_status status = AE_OK;
	char type_buffer[48];	/* Room for 5 types */

	/* A Namespace node should not get here, but make sure */

	if (return_object &&
	    ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) {
		ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
				      info->node_flags,
				      "Invalid return type - Found a Namespace node [%4.4s] type %s",
				      return_object->node.name.ascii,
				      acpi_ut_get_type_name(return_object->node.
							    type)));
		return (AE_AML_OPERAND_TYPE);
	}

	/*
	 * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
	 * The bitmapped type allows multiple possible return types.
	 *
	 * Note, the cases below must handle all of the possible types returned
	 * from all of the predefined names (including elements of returned
	 * packages)
	 */
	info->return_btype = acpi_ns_get_bitmapped_type(return_object);
	if (info->return_btype == ACPI_RTYPE_ANY) {

		/* Not one of the supported objects, must be incorrect */
		goto type_error_exit;
	}

	/* For reference objects, check that the reference type is correct */

	if ((info->return_btype & expected_btypes) == ACPI_RTYPE_REFERENCE) {
		status = acpi_ns_check_reference(info, return_object);
		return (status);
	}

	/* Attempt simple repair of the returned object if necessary */

	status = acpi_ns_simple_repair(info, expected_btypes,
				       package_index, return_object_ptr);
	if (ACPI_SUCCESS(status)) {
		return (AE_OK);	/* Successful repair */
	}

type_error_exit:

	/* Create a string with all expected types for this predefined object */

	acpi_ut_get_expected_return_types(type_buffer, expected_btypes);

	if (!return_object) {
		ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
				      info->node_flags,
				      "Expected return object of type %s",
				      type_buffer));
	} else if (package_index == ACPI_NOT_PACKAGE_ELEMENT) {
		ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
				      info->node_flags,
				      "Return type mismatch - found %s, expected %s",
				      acpi_ut_get_object_type_name
				      (return_object), type_buffer));
	} else {
		ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
				      info->node_flags,
				      "Return Package type mismatch at index %u - "
				      "found %s, expected %s", package_index,
				      acpi_ut_get_object_type_name
				      (return_object), type_buffer));
	}

	return (AE_AML_OPERAND_TYPE);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_check_reference
 *
 * PARAMETERS:  info            - Method execution information block
 *              return_object   - Object returned from the evaluation of a
 *                                method or object
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Check a returned reference object for the correct reference
 *              type. The only reference type that can be returned from a
 *              predefined method is a named reference. All others are invalid.
 *
 ******************************************************************************/

static acpi_status
acpi_ns_check_reference(struct acpi_evaluate_info *info,
			union acpi_operand_object *return_object)
{

	/*
	 * Check the reference object for the correct reference type (opcode).
	 * The only type of reference that can be converted to an union acpi_object is
	 * a reference to a named object (reference class: NAME)
	 */
	if (return_object->reference.class == ACPI_REFCLASS_NAME) {
		return (AE_OK);
	}

	ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname, info->node_flags,
			      "Return type mismatch - unexpected reference object type [%s] %2.2X",
			      acpi_ut_get_reference_name(return_object),
			      return_object->reference.class));

	return (AE_AML_OPERAND_TYPE);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_get_bitmapped_type
 *
 * PARAMETERS:  return_object   - Object returned from method/obj evaluation
 *
 * RETURN:      Object return type. ACPI_RTYPE_ANY indicates that the object
 *              type is not supported. ACPI_RTYPE_NONE indicates that no
 *              object was returned (return_object is NULL).
 *
 * DESCRIPTION: Convert object type into a bitmapped object return type.
 *
 ******************************************************************************/

static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object)
{
	u32 return_btype;

	if (!return_object) {
		return (ACPI_RTYPE_NONE);
	}

	/* Map acpi_object_type to internal bitmapped type */

	switch (return_object->common.type) {
	case ACPI_TYPE_INTEGER:

		return_btype = ACPI_RTYPE_INTEGER;
		break;

	case ACPI_TYPE_BUFFER:

		return_btype = ACPI_RTYPE_BUFFER;
		break;

	case ACPI_TYPE_STRING:

		return_btype = ACPI_RTYPE_STRING;
		break;

	case ACPI_TYPE_PACKAGE:

		return_btype = ACPI_RTYPE_PACKAGE;
		break;

	case ACPI_TYPE_LOCAL_REFERENCE:

		return_btype = ACPI_RTYPE_REFERENCE;
		break;

	default:

		/* Not one of the supported objects, must be incorrect */

		return_btype = ACPI_RTYPE_ANY;
		break;
	}

	return (return_btype);
}
Commit	Line	Data
e8707b34 BM	1	/******************************************************************************
	2	*
	3	* Module Name: nspredef - Validation of ACPI predefined methods and objects
e8707b34 BM	4	*
	5	*****************************************************************************/
	6
	7	/*
25f044e6	8	* Copyright (C) 2000 - 2013, Intel Corp.
e8707b34 BM	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	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.
	25	*
	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.
	29	*
	30	* NO WARRANTY
	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.
	42	*/
	43
999e08f9 BM	44	#define ACPI_CREATE_PREDEFINED_TABLE
999e08f9 BM	45
e8707b34	46	#include <acpi/acpi.h>
e2f7a777 LB	47	#include "accommon.h"
	48	#include "acnamesp.h"
	49	#include "acpredef.h"
e8707b34 BM	50
	51	#define _COMPONENT ACPI_NAMESPACE
	52	ACPI_MODULE_NAME("nspredef")
	53
	54	/*******************************************************************************
	55	*
	56	* This module validates predefined ACPI objects that appear in the namespace,
	57	* at the time they are evaluated (via acpi_evaluate_object). The purpose of this
	58	* validation is to detect problems with BIOS-exposed predefined ACPI objects
	59	* before the results are returned to the ACPI-related drivers.
	60	*
	61	* There are several areas that are validated:
	62	*
	63	* 1) The number of input arguments as defined by the method/object in the
29a241cc	64	* ASL is validated against the ACPI specification.
e8707b34	65	* 2) The type of the return object (if any) is validated against the ACPI
29a241cc	66	* specification.
e8707b34	67	* 3) For returned package objects, the count of package elements is
29a241cc BM	68	* validated, as well as the type of each package element. Nested
29a241cc BM	69	* packages are supported.
e8707b34 BM	70	*
	71	* For any problems found, a warning message is issued.
	72	*
	73	******************************************************************************/
	74	/* Local prototypes */
e8707b34	75	static acpi_status
29a241cc	76	acpi_ns_check_reference(struct acpi_evaluate_info *info,
e8707b34 BM	77	union acpi_operand_object *return_object);
e8707b34 BM	78
d5a36100 BM	79	static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object);
d5a36100 BM	80
e8707b34 BM	81	/*******************************************************************************
e8707b34 BM	82	*
29a241cc	83	* FUNCTION: acpi_ns_check_return_value
e8707b34	84	*
ba494bee	85	* PARAMETERS: node - Namespace node for the method/object
29a241cc	86	* info - Method execution information block
0444e8f6 BM	87	* user_param_count - Number of parameters actually passed
0444e8f6 BM	88	* return_status - Status from the object evaluation
a647b5c3 BM	89	* return_object_ptr - Pointer to the object returned from the
a647b5c3 BM	90	* evaluation of a method or object
e8707b34 BM	91	*
	92	* RETURN: Status
	93	*
29a241cc	94	* DESCRIPTION: Check the value returned from a predefined name.
e8707b34 BM	95	*
	96	******************************************************************************/
	97
	98	acpi_status
29a241cc BM	99	acpi_ns_check_return_value(struct acpi_namespace_node *node,
	100	struct acpi_evaluate_info *info,
	101	u32 user_param_count,
	102	acpi_status return_status,
	103	union acpi_operand_object **return_object_ptr)
e8707b34	104	{
29a241cc	105	acpi_status status;
e8707b34	106	const union acpi_predefined_info *predefined;
eeb4437e BM	107
	108	/* If not a predefined name, we cannot validate the return object */
	109
43e5318f	110	predefined = info->predefined;
eeb4437e	111	if (!predefined) {
29a241cc	112	return (AE_OK);
eeb4437e BM	113	}
	114
	115	/*
0444e8f6 BM	116	* If the method failed or did not actually return an object, we cannot
0444e8f6 BM	117	* validate the return object
e8707b34	118	*/
0444e8f6	119	if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) {
29a241cc	120	return (AE_OK);
eeb4437e BM	121	}
eeb4437e BM	122
e8707b34	123	/*
d57b23ad	124	* Return value validation and possible repair.
307a0424	125	*
d57b23ad BM	126	* 1) Don't perform return value validation/repair if this feature
	127	* has been disabled via a global option.
	128	*
	129	* 2) We have a return value, but if one wasn't expected, just exit,
	130	* this is not a problem. For example, if the "Implicit Return"
	131	* feature is enabled, methods will always return a value.
	132	*
	133	* 3) If the return value can be of any type, then we cannot perform
	134	* any validation, just exit.
e8707b34	135	*/
d57b23ad BM	136	if (acpi_gbl_disable_auto_repair \|\|
d57b23ad BM	137	(!predefined->info.expected_btypes) \|\|
307a0424	138	(predefined->info.expected_btypes == ACPI_RTYPE_ALL)) {
29a241cc	139	return (AE_OK);
e8707b34 BM	140	}
	141
	142	/*
465da9eb BM	143	* Check that the type of the main return object is what is expected
465da9eb BM	144	* for this predefined name
e8707b34	145	*/
29a241cc	146	status = acpi_ns_check_object_type(info, return_object_ptr,
e8707b34	147	predefined->info.expected_btypes,
0444e8f6	148	ACPI_NOT_PACKAGE_ELEMENT);
465da9eb BM	149	if (ACPI_FAILURE(status)) {
	150	goto exit;
	151	}
	152
bf0dd264 BM	153	/*
	154	*
	155	* 4) If there is no return value and it is optional, just return
	156	* AE_OK (_WAK).
	157	*/
	158	if (!(*return_object_ptr)) {
	159	goto exit;
	160	}
	161
465da9eb BM	162	/*
	163	* For returned Package objects, check the type of all sub-objects.
	164	* Note: Package may have been newly created by call above.
	165	*/
	166	if ((*return_object_ptr)->common.type == ACPI_TYPE_PACKAGE) {
29a241cc BM	167	info->parent_package = *return_object_ptr;
29a241cc BM	168	status = acpi_ns_check_package(info, return_object_ptr);
465da9eb	169	if (ACPI_FAILURE(status)) {
aa6329c4	170
5a9792f3	171	/* We might be able to fix some errors */
aa6329c4	172
5a9792f3 LZ	173	if ((status != AE_AML_OPERAND_TYPE) &&
5a9792f3 LZ	174	(status != AE_AML_OPERAND_VALUE)) {
aa6329c4 LZ	175	goto exit;
aa6329c4 LZ	176	}
34c39c75	177	}
e8707b34 BM	178	}
e8707b34 BM	179
ad5babee	180	/*
465da9eb BM	181	* The return object was OK, or it was successfully repaired above.
	182	* Now make some additional checks such as verifying that package
	183	* objects are sorted correctly (if required) or buffer objects have
	184	* the correct data width (bytes vs. dwords). These repairs are
	185	* performed on a per-name basis, i.e., the code is specific to
	186	* particular predefined names.
ad5babee	187	*/
29a241cc	188	status = acpi_ns_complex_repairs(info, node, status, return_object_ptr);
ad5babee	189
465da9eb	190	exit:
0444e8f6 BM	191	/*
	192	* If the object validation failed or if we successfully repaired one
	193	* or more objects, mark the parent node to suppress further warning
	194	* messages during the next evaluation of the same method/object.
	195	*/
29a241cc	196	if (ACPI_FAILURE(status) \|\| (info->return_flags & ACPI_OBJECT_REPAIRED)) {
0444e8f6 BM	197	node->flags \|= ANOBJ_EVALUATED;
0444e8f6 BM	198	}
0444e8f6	199
e8707b34 BM	200	return (status);
	201	}
	202
e8707b34 BM	203	/*******************************************************************************
	204	*
	205	* FUNCTION: acpi_ns_check_object_type
	206	*
29a241cc	207	* PARAMETERS: info - Method execution information block
a647b5c3 BM	208	* return_object_ptr - Pointer to the object returned from the
a647b5c3 BM	209	* evaluation of a method or object
e8707b34 BM	210	* expected_btypes - Bitmap of expected return type(s)
e8707b34 BM	211	* package_index - Index of object within parent package (if
0444e8f6 BM	212	* applicable - ACPI_NOT_PACKAGE_ELEMENT
0444e8f6 BM	213	* otherwise)
e8707b34 BM	214	*
	215	* RETURN: Status
	216	*
	217	* DESCRIPTION: Check the type of the return object against the expected object
	218	* type(s). Use of Btype allows multiple expected object types.
	219	*
	220	******************************************************************************/
	221
42f8fb75	222	acpi_status
29a241cc	223	acpi_ns_check_object_type(struct acpi_evaluate_info *info,
a647b5c3	224	union acpi_operand_object **return_object_ptr,
e8707b34 BM	225	u32 expected_btypes, u32 package_index)
e8707b34 BM	226	{
a647b5c3	227	union acpi_operand_object return_object = return_object_ptr;
e8707b34	228	acpi_status status = AE_OK;
e8707b34	229	char type_buffer[48]; /* Room for 5 types */
e8707b34	230
e8707b34 BM	231	/* A Namespace node should not get here, but make sure */
e8707b34 BM	232
d5a36100 BM	233	if (return_object &&
d5a36100 BM	234	ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) {
29a241cc BM	235	ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
29a241cc BM	236	info->node_flags,
0444e8f6 BM	237	"Invalid return type - Found a Namespace node [%4.4s] type %s",
	238	return_object->node.name.ascii,
	239	acpi_ut_get_type_name(return_object->node.
	240	type)));
e8707b34 BM	241	return (AE_AML_OPERAND_TYPE);
	242	}
	243
	244	/*
	245	* Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
	246	* The bitmapped type allows multiple possible return types.
	247	*
	248	* Note, the cases below must handle all of the possible types returned
	249	* from all of the predefined names (including elements of returned
	250	* packages)
	251	*/
29a241cc BM	252	info->return_btype = acpi_ns_get_bitmapped_type(return_object);
29a241cc BM	253	if (info->return_btype == ACPI_RTYPE_ANY) {
e8707b34	254
e8707b34	255	/* Not one of the supported objects, must be incorrect */
e8707b34 BM	256	goto type_error_exit;
	257	}
	258
d5a36100	259	/* For reference objects, check that the reference type is correct */
2147d3f0	260
29a241cc BM	261	if ((info->return_btype & expected_btypes) == ACPI_RTYPE_REFERENCE) {
29a241cc BM	262	status = acpi_ns_check_reference(info, return_object);
2147d3f0	263	return (status);
e8707b34 BM	264	}
e8707b34 BM	265
d5a36100	266	/* Attempt simple repair of the returned object if necessary */
e8707b34	267
29a241cc	268	status = acpi_ns_simple_repair(info, expected_btypes,
2147d3f0	269	package_index, return_object_ptr);
29a241cc BM	270	if (ACPI_SUCCESS(status)) {
	271	return (AE_OK); /* Successful repair */
	272	}
e8707b34	273
10622bf8	274	type_error_exit:
e8707b34 BM	275
	276	/* Create a string with all expected types for this predefined object */
	277
c34c82bc	278	acpi_ut_get_expected_return_types(type_buffer, expected_btypes);
e8707b34	279
bf0dd264 BM	280	if (!return_object) {
	281	ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
	282	info->node_flags,
	283	"Expected return object of type %s",
	284	type_buffer));
	285	} else if (package_index == ACPI_NOT_PACKAGE_ELEMENT) {
29a241cc BM	286	ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
29a241cc BM	287	info->node_flags,
0444e8f6 BM	288	"Return type mismatch - found %s, expected %s",
	289	acpi_ut_get_object_type_name
	290	(return_object), type_buffer));
e8707b34	291	} else {
29a241cc BM	292	ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname,
29a241cc BM	293	info->node_flags,
0444e8f6 BM	294	"Return Package type mismatch at index %u - "
	295	"found %s, expected %s", package_index,
	296	acpi_ut_get_object_type_name
	297	(return_object), type_buffer));
e8707b34 BM	298	}
	299
	300	return (AE_AML_OPERAND_TYPE);
	301	}
	302
	303	/*******************************************************************************
	304	*
	305	* FUNCTION: acpi_ns_check_reference
	306	*
29a241cc	307	* PARAMETERS: info - Method execution information block
e8707b34 BM	308	* return_object - Object returned from the evaluation of a
	309	* method or object
	310	*
	311	* RETURN: Status
	312	*
	313	* DESCRIPTION: Check a returned reference object for the correct reference
	314	* type. The only reference type that can be returned from a
	315	* predefined method is a named reference. All others are invalid.
	316	*
	317	******************************************************************************/
	318
	319	static acpi_status
29a241cc	320	acpi_ns_check_reference(struct acpi_evaluate_info *info,
e8707b34 BM	321	union acpi_operand_object *return_object)
	322	{
	323
	324	/*
	325	* Check the reference object for the correct reference type (opcode).
	326	* The only type of reference that can be converted to an union acpi_object is
	327	* a reference to a named object (reference class: NAME)
	328	*/
	329	if (return_object->reference.class == ACPI_REFCLASS_NAME) {
	330	return (AE_OK);
	331	}
	332
29a241cc	333	ACPI_WARN_PREDEFINED((AE_INFO, info->full_pathname, info->node_flags,
0444e8f6 BM	334	"Return type mismatch - unexpected reference object type [%s] %2.2X",
	335	acpi_ut_get_reference_name(return_object),
	336	return_object->reference.class));
e8707b34 BM	337
	338	return (AE_AML_OPERAND_TYPE);
	339	}
a647b5c3	340
d5a36100 BM	341	/*******************************************************************************
	342	*
	343	* FUNCTION: acpi_ns_get_bitmapped_type
	344	*
	345	* PARAMETERS: return_object - Object returned from method/obj evaluation
	346	*
	347	* RETURN: Object return type. ACPI_RTYPE_ANY indicates that the object
	348	* type is not supported. ACPI_RTYPE_NONE indicates that no
	349	* object was returned (return_object is NULL).
	350	*
	351	* DESCRIPTION: Convert object type into a bitmapped object return type.
	352	*
	353	******************************************************************************/
	354
	355	static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object)
	356	{
	357	u32 return_btype;
	358
	359	if (!return_object) {
	360	return (ACPI_RTYPE_NONE);
	361	}
	362
	363	/* Map acpi_object_type to internal bitmapped type */
	364
	365	switch (return_object->common.type) {
	366	case ACPI_TYPE_INTEGER:
1d1ea1b7	367
d5a36100 BM	368	return_btype = ACPI_RTYPE_INTEGER;
	369	break;
	370
	371	case ACPI_TYPE_BUFFER:
1d1ea1b7	372
d5a36100 BM	373	return_btype = ACPI_RTYPE_BUFFER;
	374	break;
	375
	376	case ACPI_TYPE_STRING:
1d1ea1b7	377
d5a36100 BM	378	return_btype = ACPI_RTYPE_STRING;
	379	break;
	380
	381	case ACPI_TYPE_PACKAGE:
1d1ea1b7	382
d5a36100 BM	383	return_btype = ACPI_RTYPE_PACKAGE;
	384	break;
	385
	386	case ACPI_TYPE_LOCAL_REFERENCE:
1d1ea1b7	387
d5a36100 BM	388	return_btype = ACPI_RTYPE_REFERENCE;
	389	break;
	390
	391	default:
1d1ea1b7	392
d5a36100 BM	393	/* Not one of the supported objects, must be incorrect */
	394
	395	return_btype = ACPI_RTYPE_ANY;
	396	break;
	397	}
	398
	399	return (return_btype);
	400	}