[deliverable/linux.git] / drivers / acpi / acpica / exoparg6.c

/******************************************************************************
 *
 * Module Name: exoparg6 - AML execution - opcodes with 6 arguments
 *
 *****************************************************************************/

/*
 * 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.
 */

#include <acpi/acpi.h>
#include "accommon.h"
#include "acinterp.h"
#include "acparser.h"
#include "amlcode.h"

#define _COMPONENT          ACPI_EXECUTER
ACPI_MODULE_NAME("exoparg6")

/*!
 * Naming convention for AML interpreter execution routines.
 *
 * The routines that begin execution of AML opcodes are named with a common
 * convention based upon the number of arguments, the number of target operands,
 * and whether or not a value is returned:
 *
 *      AcpiExOpcode_xA_yT_zR
 *
 * Where:
 *
 * xA - ARGUMENTS:    The number of arguments (input operands) that are
 *                    required for this opcode type (1 through 6 args).
 * yT - TARGETS:      The number of targets (output operands) that are required
 *                    for this opcode type (0, 1, or 2 targets).
 * zR - RETURN VALUE: Indicates whether this opcode type returns a value
 *                    as the function return (0 or 1).
 *
 * The AcpiExOpcode* functions are called via the Dispatcher component with
 * fully resolved operands.
!*/
/* Local prototypes */
static u8
acpi_ex_do_match(u32 match_op,
		 union acpi_operand_object *package_obj,
		 union acpi_operand_object *match_obj);

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_do_match
 *
 * PARAMETERS:  match_op        - The AML match operand
 *              package_obj     - Object from the target package
 *              match_obj       - Object to be matched
 *
 * RETURN:      TRUE if the match is successful, FALSE otherwise
 *
 * DESCRIPTION: Implements the low-level match for the ASL Match operator.
 *              Package elements will be implicitly converted to the type of
 *              the match object (Integer/Buffer/String).
 *
 ******************************************************************************/

static u8
acpi_ex_do_match(u32 match_op,
		 union acpi_operand_object *package_obj,
		 union acpi_operand_object *match_obj)
{
	u8 logical_result = TRUE;
	acpi_status status;

	/*
	 * Note: Since the package_obj/match_obj ordering is opposite to that of
	 * the standard logical operators, we have to reverse them when we call
	 * do_logical_op in order to make the implicit conversion rules work
	 * correctly. However, this means we have to flip the entire equation
	 * also. A bit ugly perhaps, but overall, better than fussing the
	 * parameters around at runtime, over and over again.
	 *
	 * Below, P[i] refers to the package element, M refers to the Match object.
	 */
	switch (match_op) {
	case MATCH_MTR:

		/* Always true */

		break;

	case MATCH_MEQ:
		/*
		 * True if equal: (P[i] == M)
		 * Change to:     (M == P[i])
		 */
		status =
		    acpi_ex_do_logical_op(AML_LEQUAL_OP, match_obj, package_obj,
					  &logical_result);
		if (ACPI_FAILURE(status)) {
			return (FALSE);
		}
		break;

	case MATCH_MLE:
		/*
		 * True if less than or equal: (P[i] <= M) (P[i] not_greater than M)
		 * Change to:                  (M >= P[i]) (M not_less than P[i])
		 */
		status =
		    acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
					  &logical_result);
		if (ACPI_FAILURE(status)) {
			return (FALSE);
		}
		logical_result = (u8) ! logical_result;
		break;

	case MATCH_MLT:
		/*
		 * True if less than: (P[i] < M)
		 * Change to:         (M > P[i])
		 */
		status =
		    acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
					  package_obj, &logical_result);
		if (ACPI_FAILURE(status)) {
			return (FALSE);
		}
		break;

	case MATCH_MGE:
		/*
		 * True if greater than or equal: (P[i] >= M) (P[i] not_less than M)
		 * Change to:                     (M <= P[i]) (M not_greater than P[i])
		 */
		status =
		    acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
					  package_obj, &logical_result);
		if (ACPI_FAILURE(status)) {
			return (FALSE);
		}
		logical_result = (u8) ! logical_result;
		break;

	case MATCH_MGT:
		/*
		 * True if greater than: (P[i] > M)
		 * Change to:            (M < P[i])
		 */
		status =
		    acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
					  &logical_result);
		if (ACPI_FAILURE(status)) {
			return (FALSE);
		}
		break;

	default:

		/* Undefined */

		return (FALSE);
	}

	return (logical_result);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_opcode_6A_0T_1R
 *
 * PARAMETERS:  walk_state          - Current walk state
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
 *
 ******************************************************************************/

acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state * walk_state)
{
	union acpi_operand_object **operand = &walk_state->operands[0];
	union acpi_operand_object *return_desc = NULL;
	acpi_status status = AE_OK;
	u64 index;
	union acpi_operand_object *this_element;

	ACPI_FUNCTION_TRACE_STR(ex_opcode_6A_0T_1R,
				acpi_ps_get_opcode_name(walk_state->opcode));

	switch (walk_state->opcode) {
	case AML_MATCH_OP:
		/*
		 * Match (search_pkg[0], match_op1[1], match_obj1[2],
		 *                      match_op2[3], match_obj2[4], start_index[5])
		 */

		/* Validate both Match Term Operators (MTR, MEQ, etc.) */

		if ((operand[1]->integer.value > MAX_MATCH_OPERATOR) ||
		    (operand[3]->integer.value > MAX_MATCH_OPERATOR)) {
			ACPI_ERROR((AE_INFO, "Match operator out of range"));
			status = AE_AML_OPERAND_VALUE;
			goto cleanup;
		}

		/* Get the package start_index, validate against the package length */

		index = operand[5]->integer.value;
		if (index >= operand[0]->package.count) {
			ACPI_ERROR((AE_INFO,
				    "Index (0x%8.8X%8.8X) beyond package end (0x%X)",
				    ACPI_FORMAT_UINT64(index),
				    operand[0]->package.count));
			status = AE_AML_PACKAGE_LIMIT;
			goto cleanup;
		}

		/* Create an integer for the return value */
		/* Default return value is ACPI_UINT64_MAX if no match found */

		return_desc = acpi_ut_create_integer_object(ACPI_UINT64_MAX);
		if (!return_desc) {
			status = AE_NO_MEMORY;
			goto cleanup;

		}

		/*
		 * Examine each element until a match is found. Both match conditions
		 * must be satisfied for a match to occur. Within the loop,
		 * "continue" signifies that the current element does not match
		 * and the next should be examined.
		 *
		 * Upon finding a match, the loop will terminate via "break" at
		 * the bottom. If it terminates "normally", match_value will be
		 * ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
		 * match was found.
		 */
		for (; index < operand[0]->package.count; index++) {

			/* Get the current package element */

			this_element = operand[0]->package.elements[index];

			/* Treat any uninitialized (NULL) elements as non-matching */

			if (!this_element) {
				continue;
			}

			/*
			 * Both match conditions must be satisfied. Execution of a continue
			 * (proceed to next iteration of enclosing for loop) signifies a
			 * non-match.
			 */
			if (!acpi_ex_do_match((u32) operand[1]->integer.value,
					      this_element, operand[2])) {
				continue;
			}

			if (!acpi_ex_do_match((u32) operand[3]->integer.value,
					      this_element, operand[4])) {
				continue;
			}

			/* Match found: Index is the return value */

			return_desc->integer.value = index;
			break;
		}
		break;

	case AML_LOAD_TABLE_OP:

		status = acpi_ex_load_table_op(walk_state, &return_desc);
		break;

	default:

		ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
			    walk_state->opcode));
		status = AE_AML_BAD_OPCODE;
		goto cleanup;
	}

cleanup:

	/* Delete return object on error */

	if (ACPI_FAILURE(status)) {
		acpi_ut_remove_reference(return_desc);
	}

	/* Save return object on success */

	else {
		walk_state->result_obj = return_desc;
	}

	return_ACPI_STATUS(status);
}
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: exoparg6 - AML execution - opcodes with 6 arguments
	4	*
	5	*****************************************************************************/
	6
	7	/*
25f044e6	8	* Copyright (C) 2000 - 2013, Intel Corp.
1da177e4 LT	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
1da177e4	44	#include <acpi/acpi.h>
e2f7a777 LB	45	#include "accommon.h"
	46	#include "acinterp.h"
	47	#include "acparser.h"
	48	#include "amlcode.h"
1da177e4	49
1da177e4	50	#define _COMPONENT ACPI_EXECUTER
4be44fcd	51	ACPI_MODULE_NAME("exoparg6")
1da177e4 LT	52
	53	/*!
	54	* Naming convention for AML interpreter execution routines.
	55	*
	56	* The routines that begin execution of AML opcodes are named with a common
	57	* convention based upon the number of arguments, the number of target operands,
	58	* and whether or not a value is returned:
	59	*
	60	* AcpiExOpcode_xA_yT_zR
	61	*
	62	* Where:
	63	*
	64	* xA - ARGUMENTS: The number of arguments (input operands) that are
	65	* required for this opcode type (1 through 6 args).
	66	* yT - TARGETS: The number of targets (output operands) that are required
	67	* for this opcode type (0, 1, or 2 targets).
	68	* zR - RETURN VALUE: Indicates whether this opcode type returns a value
	69	* as the function return (0 or 1).
	70	*
	71	* The AcpiExOpcode* functions are called via the Dispatcher component with
	72	* fully resolved operands.
	73	!*/
44f6c012	74	/* Local prototypes */
44f6c012	75	static u8
4be44fcd LB	76	acpi_ex_do_match(u32 match_op,
	77	union acpi_operand_object *package_obj,
	78	union acpi_operand_object *match_obj);
1da177e4 LT	79
	80	/*******************************************************************************
	81	*
	82	* FUNCTION: acpi_ex_do_match
	83	*
	84	* PARAMETERS: match_op - The AML match operand
	85	* package_obj - Object from the target package
	86	* match_obj - Object to be matched
	87	*
	88	* RETURN: TRUE if the match is successful, FALSE otherwise
	89	*
	90	* DESCRIPTION: Implements the low-level match for the ASL Match operator.
	91	* Package elements will be implicitly converted to the type of
	92	* the match object (Integer/Buffer/String).
	93	*
	94	******************************************************************************/
	95
44f6c012	96	static u8
4be44fcd LB	97	acpi_ex_do_match(u32 match_op,
	98	union acpi_operand_object *package_obj,
	99	union acpi_operand_object *match_obj)
1da177e4	100	{
4be44fcd LB	101	u8 logical_result = TRUE;
4be44fcd LB	102	acpi_status status;
1da177e4 LT	103
	104	/*
	105	* Note: Since the package_obj/match_obj ordering is opposite to that of
	106	* the standard logical operators, we have to reverse them when we call
	107	* do_logical_op in order to make the implicit conversion rules work
	108	* correctly. However, this means we have to flip the entire equation
	109	* also. A bit ugly perhaps, but overall, better than fussing the
	110	* parameters around at runtime, over and over again.
	111	*
	112	* Below, P[i] refers to the package element, M refers to the Match object.
	113	*/
	114	switch (match_op) {
	115	case MATCH_MTR:
	116
	117	/* Always true */
	118
	119	break;
	120
	121	case MATCH_MEQ:
1da177e4 LT	122	/*
	123	* True if equal: (P[i] == M)
	124	* Change to: (M == P[i])
	125	*/
4be44fcd LB	126	status =
	127	acpi_ex_do_logical_op(AML_LEQUAL_OP, match_obj, package_obj,
	128	&logical_result);
	129	if (ACPI_FAILURE(status)) {
1da177e4 LT	130	return (FALSE);
	131	}
	132	break;
	133
	134	case MATCH_MLE:
1da177e4 LT	135	/*
	136	* True if less than or equal: (P[i] <= M) (P[i] not_greater than M)
	137	* Change to: (M >= P[i]) (M not_less than P[i])
	138	*/
4be44fcd LB	139	status =
	140	acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
	141	&logical_result);
	142	if (ACPI_FAILURE(status)) {
1da177e4 LT	143	return (FALSE);
1da177e4 LT	144	}
4be44fcd	145	logical_result = (u8) ! logical_result;
1da177e4 LT	146	break;
	147
	148	case MATCH_MLT:
1da177e4 LT	149	/*
	150	* True if less than: (P[i] < M)
	151	* Change to: (M > P[i])
	152	*/
4be44fcd LB	153	status =
	154	acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
	155	package_obj, &logical_result);
	156	if (ACPI_FAILURE(status)) {
1da177e4 LT	157	return (FALSE);
	158	}
	159	break;
	160
	161	case MATCH_MGE:
1da177e4 LT	162	/*
	163	* True if greater than or equal: (P[i] >= M) (P[i] not_less than M)
	164	* Change to: (M <= P[i]) (M not_greater than P[i])
	165	*/
4be44fcd LB	166	status =
	167	acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
	168	package_obj, &logical_result);
	169	if (ACPI_FAILURE(status)) {
1da177e4 LT	170	return (FALSE);
1da177e4 LT	171	}
4be44fcd	172	logical_result = (u8) ! logical_result;
1da177e4 LT	173	break;
	174
	175	case MATCH_MGT:
1da177e4 LT	176	/*
	177	* True if greater than: (P[i] > M)
	178	* Change to: (M < P[i])
	179	*/
4be44fcd LB	180	status =
	181	acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
	182	&logical_result);
	183	if (ACPI_FAILURE(status)) {
1da177e4 LT	184	return (FALSE);
	185	}
	186	break;
	187
	188	default:
	189
	190	/* Undefined */
	191
	192	return (FALSE);
	193	}
	194
68aafc35	195	return (logical_result);
1da177e4 LT	196	}
1da177e4 LT	197
1da177e4 LT	198	/*******************************************************************************
	199	*
	200	* FUNCTION: acpi_ex_opcode_6A_0T_1R
	201	*
	202	* PARAMETERS: walk_state - Current walk state
	203	*
	204	* RETURN: Status
	205	*
	206	* DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
	207	*
	208	******************************************************************************/
	209
4be44fcd	210	acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state * walk_state)
1da177e4	211	{
4be44fcd LB	212	union acpi_operand_object **operand = &walk_state->operands[0];
	213	union acpi_operand_object *return_desc = NULL;
	214	acpi_status status = AE_OK;
5df7e6cb	215	u64 index;
4be44fcd	216	union acpi_operand_object *this_element;
1da177e4	217
b229cf92	218	ACPI_FUNCTION_TRACE_STR(ex_opcode_6A_0T_1R,
4be44fcd	219	acpi_ps_get_opcode_name(walk_state->opcode));
1da177e4 LT	220
	221	switch (walk_state->opcode) {
	222	case AML_MATCH_OP:
	223	/*
	224	* Match (search_pkg[0], match_op1[1], match_obj1[2],
	225	* match_op2[3], match_obj2[4], start_index[5])
	226	*/
	227
	228	/* Validate both Match Term Operators (MTR, MEQ, etc.) */
	229
	230	if ((operand[1]->integer.value > MAX_MATCH_OPERATOR) \|\|
4be44fcd	231	(operand[3]->integer.value > MAX_MATCH_OPERATOR)) {
b8e4d893	232	ACPI_ERROR((AE_INFO, "Match operator out of range"));
1da177e4 LT	233	status = AE_AML_OPERAND_VALUE;
	234	goto cleanup;
	235	}
	236
	237	/* Get the package start_index, validate against the package length */
	238
44f6c012 RM	239	index = operand[5]->integer.value;
44f6c012 RM	240	if (index >= operand[0]->package.count) {
b8e4d893	241	ACPI_ERROR((AE_INFO,
f6a22b0b	242	"Index (0x%8.8X%8.8X) beyond package end (0x%X)",
b8e4d893 BM	243	ACPI_FORMAT_UINT64(index),
b8e4d893 BM	244	operand[0]->package.count));
1da177e4 LT	245	status = AE_AML_PACKAGE_LIMIT;
	246	goto cleanup;
	247	}
	248
	249	/* Create an integer for the return value */
5df7e6cb	250	/* Default return value is ACPI_UINT64_MAX if no match found */
1da177e4	251
5df7e6cb	252	return_desc = acpi_ut_create_integer_object(ACPI_UINT64_MAX);
1da177e4 LT	253	if (!return_desc) {
	254	status = AE_NO_MEMORY;
	255	goto cleanup;
	256
	257	}
	258
1da177e4 LT	259	/*
	260	* Examine each element until a match is found. Both match conditions
	261	* must be satisfied for a match to occur. Within the loop,
	262	* "continue" signifies that the current element does not match
	263	* and the next should be examined.
	264	*
	265	* Upon finding a match, the loop will terminate via "break" at
73a3090a	266	* the bottom. If it terminates "normally", match_value will be
5df7e6cb	267	* ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
1da177e4 LT	268	* match was found.
1da177e4 LT	269	*/
4be44fcd	270	for (; index < operand[0]->package.count; index++) {
52fc0b02	271
1da177e4 LT	272	/* Get the current package element */
	273
	274	this_element = operand[0]->package.elements[index];
	275
	276	/* Treat any uninitialized (NULL) elements as non-matching */
	277
	278	if (!this_element) {
	279	continue;
	280	}
	281
	282	/*
	283	* Both match conditions must be satisfied. Execution of a continue
	284	* (proceed to next iteration of enclosing for loop) signifies a
	285	* non-match.
	286	*/
4be44fcd LB	287	if (!acpi_ex_do_match((u32) operand[1]->integer.value,
4be44fcd LB	288	this_element, operand[2])) {
1da177e4 LT	289	continue;
	290	}
	291
4be44fcd LB	292	if (!acpi_ex_do_match((u32) operand[3]->integer.value,
4be44fcd LB	293	this_element, operand[4])) {
1da177e4 LT	294	continue;
	295	}
	296
	297	/* Match found: Index is the return value */
	298
	299	return_desc->integer.value = index;
	300	break;
	301	}
	302	break;
	303
1da177e4 LT	304	case AML_LOAD_TABLE_OP:
1da177e4 LT	305
4be44fcd	306	status = acpi_ex_load_table_op(walk_state, &return_desc);
1da177e4 LT	307	break;
1da177e4 LT	308
1da177e4 LT	309	default:
1da177e4 LT	310
f6a22b0b	311	ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
b8e4d893	312	walk_state->opcode));
1da177e4 LT	313	status = AE_AML_BAD_OPCODE;
	314	goto cleanup;
	315	}
	316
10622bf8	317	cleanup:
1da177e4 LT	318
	319	/* Delete return object on error */
	320
4be44fcd LB	321	if (ACPI_FAILURE(status)) {
4be44fcd LB	322	acpi_ut_remove_reference(return_desc);
1da177e4 LT	323	}
1da177e4 LT	324
4b6e16cf BM	325	/* Save return object on success */
	326
	327	else {
	328	walk_state->result_obj = return_desc;
	329	}
	330
4be44fcd	331	return_ACPI_STATUS(status);
1da177e4	332	}