xref: /linux/drivers/acpi/acpica/exoparg6.c (revision b889fcf63cb62e7fdb7816565e28f44dbe4a76a5)
1 /******************************************************************************
2  *
3  * Module Name: exoparg6 - AML execution - opcodes with 6 arguments
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2012, Intel Corp.
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 
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acinterp.h"
47 #include "acparser.h"
48 #include "amlcode.h"
49 
50 #define _COMPONENT          ACPI_EXECUTER
51 ACPI_MODULE_NAME("exoparg6")
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 !*/
74 /* Local prototypes */
75 static u8
76 acpi_ex_do_match(u32 match_op,
77 		 union acpi_operand_object *package_obj,
78 		 union acpi_operand_object *match_obj);
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 
96 static u8
97 acpi_ex_do_match(u32 match_op,
98 		 union acpi_operand_object *package_obj,
99 		 union acpi_operand_object *match_obj)
100 {
101 	u8 logical_result = TRUE;
102 	acpi_status status;
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:
122 
123 		/*
124 		 * True if equal: (P[i] == M)
125 		 * Change to:     (M == P[i])
126 		 */
127 		status =
128 		    acpi_ex_do_logical_op(AML_LEQUAL_OP, match_obj, package_obj,
129 					  &logical_result);
130 		if (ACPI_FAILURE(status)) {
131 			return (FALSE);
132 		}
133 		break;
134 
135 	case MATCH_MLE:
136 
137 		/*
138 		 * True if less than or equal: (P[i] <= M) (P[i] not_greater than M)
139 		 * Change to:                  (M >= P[i]) (M not_less than P[i])
140 		 */
141 		status =
142 		    acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
143 					  &logical_result);
144 		if (ACPI_FAILURE(status)) {
145 			return (FALSE);
146 		}
147 		logical_result = (u8) ! logical_result;
148 		break;
149 
150 	case MATCH_MLT:
151 
152 		/*
153 		 * True if less than: (P[i] < M)
154 		 * Change to:         (M > P[i])
155 		 */
156 		status =
157 		    acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
158 					  package_obj, &logical_result);
159 		if (ACPI_FAILURE(status)) {
160 			return (FALSE);
161 		}
162 		break;
163 
164 	case MATCH_MGE:
165 
166 		/*
167 		 * True if greater than or equal: (P[i] >= M) (P[i] not_less than M)
168 		 * Change to:                     (M <= P[i]) (M not_greater than P[i])
169 		 */
170 		status =
171 		    acpi_ex_do_logical_op(AML_LGREATER_OP, match_obj,
172 					  package_obj, &logical_result);
173 		if (ACPI_FAILURE(status)) {
174 			return (FALSE);
175 		}
176 		logical_result = (u8) ! logical_result;
177 		break;
178 
179 	case MATCH_MGT:
180 
181 		/*
182 		 * True if greater than: (P[i] > M)
183 		 * Change to:            (M < P[i])
184 		 */
185 		status =
186 		    acpi_ex_do_logical_op(AML_LLESS_OP, match_obj, package_obj,
187 					  &logical_result);
188 		if (ACPI_FAILURE(status)) {
189 			return (FALSE);
190 		}
191 		break;
192 
193 	default:
194 
195 		/* Undefined */
196 
197 		return (FALSE);
198 	}
199 
200 	return (logical_result);
201 }
202 
203 /*******************************************************************************
204  *
205  * FUNCTION:    acpi_ex_opcode_6A_0T_1R
206  *
207  * PARAMETERS:  walk_state          - Current walk state
208  *
209  * RETURN:      Status
210  *
211  * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
212  *
213  ******************************************************************************/
214 
215 acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state * walk_state)
216 {
217 	union acpi_operand_object **operand = &walk_state->operands[0];
218 	union acpi_operand_object *return_desc = NULL;
219 	acpi_status status = AE_OK;
220 	u64 index;
221 	union acpi_operand_object *this_element;
222 
223 	ACPI_FUNCTION_TRACE_STR(ex_opcode_6A_0T_1R,
224 				acpi_ps_get_opcode_name(walk_state->opcode));
225 
226 	switch (walk_state->opcode) {
227 	case AML_MATCH_OP:
228 		/*
229 		 * Match (search_pkg[0], match_op1[1], match_obj1[2],
230 		 *                      match_op2[3], match_obj2[4], start_index[5])
231 		 */
232 
233 		/* Validate both Match Term Operators (MTR, MEQ, etc.) */
234 
235 		if ((operand[1]->integer.value > MAX_MATCH_OPERATOR) ||
236 		    (operand[3]->integer.value > MAX_MATCH_OPERATOR)) {
237 			ACPI_ERROR((AE_INFO, "Match operator out of range"));
238 			status = AE_AML_OPERAND_VALUE;
239 			goto cleanup;
240 		}
241 
242 		/* Get the package start_index, validate against the package length */
243 
244 		index = operand[5]->integer.value;
245 		if (index >= operand[0]->package.count) {
246 			ACPI_ERROR((AE_INFO,
247 				    "Index (0x%8.8X%8.8X) beyond package end (0x%X)",
248 				    ACPI_FORMAT_UINT64(index),
249 				    operand[0]->package.count));
250 			status = AE_AML_PACKAGE_LIMIT;
251 			goto cleanup;
252 		}
253 
254 		/* Create an integer for the return value */
255 		/* Default return value is ACPI_UINT64_MAX if no match found */
256 
257 		return_desc = acpi_ut_create_integer_object(ACPI_UINT64_MAX);
258 		if (!return_desc) {
259 			status = AE_NO_MEMORY;
260 			goto cleanup;
261 
262 		}
263 
264 		/*
265 		 * Examine each element until a match is found. Both match conditions
266 		 * must be satisfied for a match to occur. Within the loop,
267 		 * "continue" signifies that the current element does not match
268 		 * and the next should be examined.
269 		 *
270 		 * Upon finding a match, the loop will terminate via "break" at
271 		 * the bottom. If it terminates "normally", match_value will be
272 		 * ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
273 		 * match was found.
274 		 */
275 		for (; index < operand[0]->package.count; index++) {
276 
277 			/* Get the current package element */
278 
279 			this_element = operand[0]->package.elements[index];
280 
281 			/* Treat any uninitialized (NULL) elements as non-matching */
282 
283 			if (!this_element) {
284 				continue;
285 			}
286 
287 			/*
288 			 * Both match conditions must be satisfied. Execution of a continue
289 			 * (proceed to next iteration of enclosing for loop) signifies a
290 			 * non-match.
291 			 */
292 			if (!acpi_ex_do_match((u32) operand[1]->integer.value,
293 					      this_element, operand[2])) {
294 				continue;
295 			}
296 
297 			if (!acpi_ex_do_match((u32) operand[3]->integer.value,
298 					      this_element, operand[4])) {
299 				continue;
300 			}
301 
302 			/* Match found: Index is the return value */
303 
304 			return_desc->integer.value = index;
305 			break;
306 		}
307 		break;
308 
309 	case AML_LOAD_TABLE_OP:
310 
311 		status = acpi_ex_load_table_op(walk_state, &return_desc);
312 		break;
313 
314 	default:
315 
316 		ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
317 			    walk_state->opcode));
318 		status = AE_AML_BAD_OPCODE;
319 		goto cleanup;
320 	}
321 
322       cleanup:
323 
324 	/* Delete return object on error */
325 
326 	if (ACPI_FAILURE(status)) {
327 		acpi_ut_remove_reference(return_desc);
328 	}
329 
330 	/* Save return object on success */
331 
332 	else {
333 		walk_state->result_obj = return_desc;
334 	}
335 
336 	return_ACPI_STATUS(status);
337 }
338