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


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

/*
 * Copyright (C) 2000 - 2008, 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;
	acpi_integer 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 (%X%8.8X) beyond package end (%X)",
				    ACPI_FORMAT_UINT64(index),
				    operand[0]->package.count));
			status = AE_AML_PACKAGE_LIMIT;
			goto cleanup;
		}

		/* Create an integer for the return value */

		return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
		if (!return_desc) {
			status = AE_NO_MEMORY;
			goto cleanup;

		}

		/* Default return value if no match found */

		return_desc->integer.value = ACPI_INTEGER_MAX;

		/*
		 * 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_INTEGER_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 %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	*
	4	* Module Name: exoparg6 - AML execution - opcodes with 6 arguments
	5	*
	6	*****************************************************************************/
	7
	8	/*
75a44ce0	9	* Copyright (C) 2000 - 2008, Intel Corp.
1da177e4 LT	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
1da177e4	45	#include <acpi/acpi.h>
e2f7a777 LB	46	#include "accommon.h"
	47	#include "acinterp.h"
	48	#include "acparser.h"
	49	#include "amlcode.h"
1da177e4	50
1da177e4	51	#define _COMPONENT ACPI_EXECUTER
4be44fcd	52	ACPI_MODULE_NAME("exoparg6")
1da177e4 LT	53
	54	/*!
	55	* Naming convention for AML interpreter execution routines.
	56	*
	57	* The routines that begin execution of AML opcodes are named with a common
	58	* convention based upon the number of arguments, the number of target operands,
	59	* and whether or not a value is returned:
	60	*
	61	* AcpiExOpcode_xA_yT_zR
	62	*
	63	* Where:
	64	*
	65	* xA - ARGUMENTS: The number of arguments (input operands) that are
	66	* required for this opcode type (1 through 6 args).
	67	* yT - TARGETS: The number of targets (output operands) that are required
	68	* for this opcode type (0, 1, or 2 targets).
	69	* zR - RETURN VALUE: Indicates whether this opcode type returns a value
	70	* as the function return (0 or 1).
	71	*
	72	* The AcpiExOpcode* functions are called via the Dispatcher component with
	73	* fully resolved operands.
	74	!*/
44f6c012	75	/* Local prototypes */
44f6c012	76	static u8
4be44fcd LB	77	acpi_ex_do_match(u32 match_op,
	78	union acpi_operand_object *package_obj,
	79	union acpi_operand_object *match_obj);
1da177e4 LT	80
	81	/*******************************************************************************
	82	*
	83	* FUNCTION: acpi_ex_do_match
	84	*
	85	* PARAMETERS: match_op - The AML match operand
	86	* package_obj - Object from the target package
	87	* match_obj - Object to be matched
	88	*
	89	* RETURN: TRUE if the match is successful, FALSE otherwise
	90	*
	91	* DESCRIPTION: Implements the low-level match for the ASL Match operator.
	92	* Package elements will be implicitly converted to the type of
	93	* the match object (Integer/Buffer/String).
	94	*
	95	******************************************************************************/
	96
44f6c012	97	static u8
4be44fcd LB	98	acpi_ex_do_match(u32 match_op,
	99	union acpi_operand_object *package_obj,
	100	union acpi_operand_object *match_obj)
1da177e4	101	{
4be44fcd LB	102	u8 logical_result = TRUE;
4be44fcd LB	103	acpi_status status;
1da177e4 LT	104
	105	/*
	106	* Note: Since the package_obj/match_obj ordering is opposite to that of
	107	* the standard logical operators, we have to reverse them when we call
	108	* do_logical_op in order to make the implicit conversion rules work
	109	* correctly. However, this means we have to flip the entire equation
	110	* also. A bit ugly perhaps, but overall, better than fussing the
	111	* parameters around at runtime, over and over again.
	112	*
	113	* Below, P[i] refers to the package element, M refers to the Match object.
	114	*/
	115	switch (match_op) {
	116	case MATCH_MTR:
	117
	118	/* Always true */
	119
	120	break;
	121
	122	case MATCH_MEQ:
	123
	124	/*
	125	* True if equal: (P[i] == M)
	126	* Change to: (M == P[i])
	127	*/
4be44fcd LB	128	status =
	129	acpi_ex_do_logical_op(AML_LEQUAL_OP, match_obj, package_obj,
	130	&logical_result);
	131	if (ACPI_FAILURE(status)) {
1da177e4 LT	132	return (FALSE);
	133	}
	134	break;
	135
	136	case MATCH_MLE:
	137
	138	/*
	139	* True if less than or equal: (P[i] <= M) (P[i] not_greater than M)
	140	* Change to: (M >= P[i]) (M not_less than P[i])
	141	*/
4be44fcd LB	142	status =
	143	acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
	144	&logical_result);
	145	if (ACPI_FAILURE(status)) {
1da177e4 LT	146	return (FALSE);
1da177e4 LT	147	}
4be44fcd	148	logical_result = (u8) ! logical_result;
1da177e4 LT	149	break;
	150
	151	case MATCH_MLT:
	152
	153	/*
	154	* True if less than: (P[i] < M)
	155	* Change to: (M > P[i])
	156	*/
4be44fcd LB	157	status =
	158	acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
	159	package_obj, &logical_result);
	160	if (ACPI_FAILURE(status)) {
1da177e4 LT	161	return (FALSE);
	162	}
	163	break;
	164
	165	case MATCH_MGE:
	166
	167	/*
	168	* True if greater than or equal: (P[i] >= M) (P[i] not_less than M)
	169	* Change to: (M <= P[i]) (M not_greater than P[i])
	170	*/
4be44fcd LB	171	status =
	172	acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
	173	package_obj, &logical_result);
	174	if (ACPI_FAILURE(status)) {
1da177e4 LT	175	return (FALSE);
1da177e4 LT	176	}
4be44fcd	177	logical_result = (u8) ! logical_result;
1da177e4 LT	178	break;
	179
	180	case MATCH_MGT:
	181
	182	/*
	183	* True if greater than: (P[i] > M)
	184	* Change to: (M < P[i])
	185	*/
4be44fcd LB	186	status =
	187	acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
	188	&logical_result);
	189	if (ACPI_FAILURE(status)) {
1da177e4 LT	190	return (FALSE);
	191	}
	192	break;
	193
	194	default:
	195
	196	/* Undefined */
	197
	198	return (FALSE);
	199	}
	200
	201	return logical_result;
	202	}
	203
1da177e4 LT	204	/*******************************************************************************
	205	*
	206	* FUNCTION: acpi_ex_opcode_6A_0T_1R
	207	*
	208	* PARAMETERS: walk_state - Current walk state
	209	*
	210	* RETURN: Status
	211	*
	212	* DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
	213	*
	214	******************************************************************************/
	215
4be44fcd	216	acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state * walk_state)
1da177e4	217	{
4be44fcd LB	218	union acpi_operand_object **operand = &walk_state->operands[0];
	219	union acpi_operand_object *return_desc = NULL;
	220	acpi_status status = AE_OK;
	221	acpi_integer index;
	222	union acpi_operand_object *this_element;
1da177e4	223
b229cf92	224	ACPI_FUNCTION_TRACE_STR(ex_opcode_6A_0T_1R,
4be44fcd	225	acpi_ps_get_opcode_name(walk_state->opcode));
1da177e4 LT	226
	227	switch (walk_state->opcode) {
	228	case AML_MATCH_OP:
	229	/*
	230	* Match (search_pkg[0], match_op1[1], match_obj1[2],
	231	* match_op2[3], match_obj2[4], start_index[5])
	232	*/
	233
	234	/* Validate both Match Term Operators (MTR, MEQ, etc.) */
	235
	236	if ((operand[1]->integer.value > MAX_MATCH_OPERATOR) \|\|
4be44fcd	237	(operand[3]->integer.value > MAX_MATCH_OPERATOR)) {
b8e4d893	238	ACPI_ERROR((AE_INFO, "Match operator out of range"));
1da177e4 LT	239	status = AE_AML_OPERAND_VALUE;
	240	goto cleanup;
	241	}
	242
	243	/* Get the package start_index, validate against the package length */
	244
44f6c012 RM	245	index = operand[5]->integer.value;
44f6c012 RM	246	if (index >= operand[0]->package.count) {
b8e4d893 BM	247	ACPI_ERROR((AE_INFO,
	248	"Index (%X%8.8X) beyond package end (%X)",
	249	ACPI_FORMAT_UINT64(index),
	250	operand[0]->package.count));
1da177e4 LT	251	status = AE_AML_PACKAGE_LIMIT;
	252	goto cleanup;
	253	}
	254
	255	/* Create an integer for the return value */
	256
4be44fcd	257	return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
1da177e4 LT	258	if (!return_desc) {
	259	status = AE_NO_MEMORY;
	260	goto cleanup;
	261
	262	}
	263
	264	/* Default return value if no match found */
	265
	266	return_desc->integer.value = ACPI_INTEGER_MAX;
	267
	268	/*
	269	* Examine each element until a match is found. Both match conditions
	270	* must be satisfied for a match to occur. Within the loop,
	271	* "continue" signifies that the current element does not match
	272	* and the next should be examined.
	273	*
	274	* Upon finding a match, the loop will terminate via "break" at
	275	* the bottom. If it terminates "normally", match_value will be
	276	* ACPI_INTEGER_MAX (Ones) (its initial value) indicating that no
	277	* match was found.
	278	*/
4be44fcd	279	for (; index < operand[0]->package.count; index++) {
52fc0b02	280
1da177e4 LT	281	/* Get the current package element */
	282
	283	this_element = operand[0]->package.elements[index];
	284
	285	/* Treat any uninitialized (NULL) elements as non-matching */
	286
	287	if (!this_element) {
	288	continue;
	289	}
	290
	291	/*
	292	* Both match conditions must be satisfied. Execution of a continue
	293	* (proceed to next iteration of enclosing for loop) signifies a
	294	* non-match.
	295	*/
4be44fcd LB	296	if (!acpi_ex_do_match((u32) operand[1]->integer.value,
4be44fcd LB	297	this_element, operand[2])) {
1da177e4 LT	298	continue;
	299	}
	300
4be44fcd LB	301	if (!acpi_ex_do_match((u32) operand[3]->integer.value,
4be44fcd LB	302	this_element, operand[4])) {
1da177e4 LT	303	continue;
	304	}
	305
	306	/* Match found: Index is the return value */
	307
	308	return_desc->integer.value = index;
	309	break;
	310	}
	311	break;
	312
1da177e4 LT	313	case AML_LOAD_TABLE_OP:
1da177e4 LT	314
4be44fcd	315	status = acpi_ex_load_table_op(walk_state, &return_desc);
1da177e4 LT	316	break;
1da177e4 LT	317
1da177e4 LT	318	default:
1da177e4 LT	319
b8e4d893 BM	320	ACPI_ERROR((AE_INFO, "Unknown AML opcode %X",
b8e4d893 BM	321	walk_state->opcode));
1da177e4 LT	322	status = AE_AML_BAD_OPCODE;
	323	goto cleanup;
	324	}
	325
4be44fcd	326	cleanup:
1da177e4 LT	327
	328	/* Delete return object on error */
	329
4be44fcd LB	330	if (ACPI_FAILURE(status)) {
4be44fcd LB	331	acpi_ut_remove_reference(return_desc);
1da177e4 LT	332	}
1da177e4 LT	333
4b6e16cf BM	334	/* Save return object on success */
	335
	336	else {
	337	walk_state->result_obj = return_desc;
	338	}
	339
4be44fcd	340	return_ACPI_STATUS(status);
1da177e4	341	}