1/******************************************************************************
2 *
3 * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, 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 "acparser.h"
47#include "acinterp.h"
48#include "acevents.h"
49#include "amlcode.h"
50
51#define _COMPONENT          ACPI_EXECUTER
52ACPI_MODULE_NAME("exoparg2")
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!*/
75/*******************************************************************************
76 *
77 * FUNCTION:    acpi_ex_opcode_2A_0T_0R
78 *
79 * PARAMETERS:  walk_state          - Current walk state
80 *
81 * RETURN:      Status
82 *
83 * DESCRIPTION: Execute opcode with two arguments, no target, and no return
84 *              value.
85 *
86 * ALLOCATION:  Deletes both operands
87 *
88 ******************************************************************************/
89acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state)
90{
91	union acpi_operand_object **operand = &walk_state->operands[0];
92	struct acpi_namespace_node *node;
93	u32 value;
94	acpi_status status = AE_OK;
95
96	ACPI_FUNCTION_TRACE_STR(ex_opcode_2A_0T_0R,
97				acpi_ps_get_opcode_name(walk_state->opcode));
98
99	/* Examine the opcode */
100
101	switch (walk_state->opcode) {
102	case AML_NOTIFY_OP:	/* Notify (notify_object, notify_value) */
103
104		/* The first operand is a namespace node */
105
106		node = (struct acpi_namespace_node *)operand[0];
107
108		/* Second value is the notify value */
109
110		value = (u32) operand[1]->integer.value;
111
112		/* Are notifies allowed on this object? */
113
114		if (!acpi_ev_is_notify_object(node)) {
115			ACPI_ERROR((AE_INFO,
116				    "Unexpected notify object type [%s]",
117				    acpi_ut_get_type_name(node->type)));
118
119			status = AE_AML_OPERAND_TYPE;
120			break;
121		}
122
123		/*
124		 * Dispatch the notify to the appropriate handler
125		 * NOTE: the request is queued for execution after this method
126		 * completes. The notify handlers are NOT invoked synchronously
127		 * from this thread -- because handlers may in turn run other
128		 * control methods.
129		 */
130		status = acpi_ev_queue_notify_request(node, value);
131		break;
132
133	default:
134
135		ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
136			    walk_state->opcode));
137		status = AE_AML_BAD_OPCODE;
138	}
139
140	return_ACPI_STATUS(status);
141}
142
143/*******************************************************************************
144 *
145 * FUNCTION:    acpi_ex_opcode_2A_2T_1R
146 *
147 * PARAMETERS:  walk_state          - Current walk state
148 *
149 * RETURN:      Status
150 *
151 * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
152 *              and one implicit return value.
153 *
154 ******************************************************************************/
155
156acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state)
157{
158	union acpi_operand_object **operand = &walk_state->operands[0];
159	union acpi_operand_object *return_desc1 = NULL;
160	union acpi_operand_object *return_desc2 = NULL;
161	acpi_status status;
162
163	ACPI_FUNCTION_TRACE_STR(ex_opcode_2A_2T_1R,
164				acpi_ps_get_opcode_name(walk_state->opcode));
165
166	/* Execute the opcode */
167
168	switch (walk_state->opcode) {
169	case AML_DIVIDE_OP:
170
171		/* Divide (Dividend, Divisor, remainder_result quotient_result) */
172
173		return_desc1 =
174		    acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
175		if (!return_desc1) {
176			status = AE_NO_MEMORY;
177			goto cleanup;
178		}
179
180		return_desc2 =
181		    acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
182		if (!return_desc2) {
183			status = AE_NO_MEMORY;
184			goto cleanup;
185		}
186
187		/* Quotient to return_desc1, remainder to return_desc2 */
188
189		status = acpi_ut_divide(operand[0]->integer.value,
190					operand[1]->integer.value,
191					&return_desc1->integer.value,
192					&return_desc2->integer.value);
193		if (ACPI_FAILURE(status)) {
194			goto cleanup;
195		}
196		break;
197
198	default:
199
200		ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
201			    walk_state->opcode));
202		status = AE_AML_BAD_OPCODE;
203		goto cleanup;
204	}
205
206	/* Store the results to the target reference operands */
207
208	status = acpi_ex_store(return_desc2, operand[2], walk_state);
209	if (ACPI_FAILURE(status)) {
210		goto cleanup;
211	}
212
213	status = acpi_ex_store(return_desc1, operand[3], walk_state);
214	if (ACPI_FAILURE(status)) {
215		goto cleanup;
216	}
217
218cleanup:
219	/*
220	 * Since the remainder is not returned indirectly, remove a reference to
221	 * it. Only the quotient is returned indirectly.
222	 */
223	acpi_ut_remove_reference(return_desc2);
224
225	if (ACPI_FAILURE(status)) {
226
227		/* Delete the return object */
228
229		acpi_ut_remove_reference(return_desc1);
230	}
231
232	/* Save return object (the remainder) on success */
233
234	else {
235		walk_state->result_obj = return_desc1;
236	}
237
238	return_ACPI_STATUS(status);
239}
240
241/*******************************************************************************
242 *
243 * FUNCTION:    acpi_ex_opcode_2A_1T_1R
244 *
245 * PARAMETERS:  walk_state          - Current walk state
246 *
247 * RETURN:      Status
248 *
249 * DESCRIPTION: Execute opcode with two arguments, one target, and a return
250 *              value.
251 *
252 ******************************************************************************/
253
254acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state)
255{
256	union acpi_operand_object **operand = &walk_state->operands[0];
257	union acpi_operand_object *return_desc = NULL;
258	u64 index;
259	acpi_status status = AE_OK;
260	acpi_size length = 0;
261
262	ACPI_FUNCTION_TRACE_STR(ex_opcode_2A_1T_1R,
263				acpi_ps_get_opcode_name(walk_state->opcode));
264
265	/* Execute the opcode */
266
267	if (walk_state->op_info->flags & AML_MATH) {
268
269		/* All simple math opcodes (add, etc.) */
270
271		return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
272		if (!return_desc) {
273			status = AE_NO_MEMORY;
274			goto cleanup;
275		}
276
277		return_desc->integer.value =
278		    acpi_ex_do_math_op(walk_state->opcode,
279				       operand[0]->integer.value,
280				       operand[1]->integer.value);
281		goto store_result_to_target;
282	}
283
284	switch (walk_state->opcode) {
285	case AML_MOD_OP:	/* Mod (Dividend, Divisor, remainder_result (ACPI 2.0) */
286
287		return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
288		if (!return_desc) {
289			status = AE_NO_MEMORY;
290			goto cleanup;
291		}
292
293		/* return_desc will contain the remainder */
294
295		status = acpi_ut_divide(operand[0]->integer.value,
296					operand[1]->integer.value,
297					NULL, &return_desc->integer.value);
298		break;
299
300	case AML_CONCAT_OP:	/* Concatenate (Data1, Data2, Result) */
301
302		status = acpi_ex_do_concatenate(operand[0], operand[1],
303						&return_desc, walk_state);
304		break;
305
306	case AML_TO_STRING_OP:	/* to_string (Buffer, Length, Result) (ACPI 2.0) */
307		/*
308		 * Input object is guaranteed to be a buffer at this point (it may have
309		 * been converted.)  Copy the raw buffer data to a new object of
310		 * type String.
311		 */
312
313		/*
314		 * Get the length of the new string. It is the smallest of:
315		 * 1) Length of the input buffer
316		 * 2) Max length as specified in the to_string operator
317		 * 3) Length of input buffer up to a zero byte (null terminator)
318		 *
319		 * NOTE: A length of zero is ok, and will create a zero-length, null
320		 *       terminated string.
321		 */
322		while ((length < operand[0]->buffer.length) &&
323		       (length < operand[1]->integer.value) &&
324		       (operand[0]->buffer.pointer[length])) {
325			length++;
326		}
327
328		/* Allocate a new string object */
329
330		return_desc = acpi_ut_create_string_object(length);
331		if (!return_desc) {
332			status = AE_NO_MEMORY;
333			goto cleanup;
334		}
335
336		/*
337		 * Copy the raw buffer data with no transform.
338		 * (NULL terminated already)
339		 */
340		memcpy(return_desc->string.pointer,
341		       operand[0]->buffer.pointer, length);
342		break;
343
344	case AML_CONCAT_RES_OP:
345
346		/* concatenate_res_template (Buffer, Buffer, Result) (ACPI 2.0) */
347
348		status = acpi_ex_concat_template(operand[0], operand[1],
349						 &return_desc, walk_state);
350		break;
351
352	case AML_INDEX_OP:	/* Index (Source Index Result) */
353
354		/* Create the internal return object */
355
356		return_desc =
357		    acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE);
358		if (!return_desc) {
359			status = AE_NO_MEMORY;
360			goto cleanup;
361		}
362
363		/* Initialize the Index reference object */
364
365		index = operand[1]->integer.value;
366		return_desc->reference.value = (u32) index;
367		return_desc->reference.class = ACPI_REFCLASS_INDEX;
368
369		/*
370		 * At this point, the Source operand is a String, Buffer, or Package.
371		 * Verify that the index is within range.
372		 */
373		switch ((operand[0])->common.type) {
374		case ACPI_TYPE_STRING:
375
376			if (index >= operand[0]->string.length) {
377				length = operand[0]->string.length;
378				status = AE_AML_STRING_LIMIT;
379			}
380
381			return_desc->reference.target_type =
382			    ACPI_TYPE_BUFFER_FIELD;
383			return_desc->reference.index_pointer =
384			    &(operand[0]->buffer.pointer[index]);
385			break;
386
387		case ACPI_TYPE_BUFFER:
388
389			if (index >= operand[0]->buffer.length) {
390				length = operand[0]->buffer.length;
391				status = AE_AML_BUFFER_LIMIT;
392			}
393
394			return_desc->reference.target_type =
395			    ACPI_TYPE_BUFFER_FIELD;
396			return_desc->reference.index_pointer =
397			    &(operand[0]->buffer.pointer[index]);
398			break;
399
400		case ACPI_TYPE_PACKAGE:
401
402			if (index >= operand[0]->package.count) {
403				length = operand[0]->package.count;
404				status = AE_AML_PACKAGE_LIMIT;
405			}
406
407			return_desc->reference.target_type = ACPI_TYPE_PACKAGE;
408			return_desc->reference.where =
409			    &operand[0]->package.elements[index];
410			break;
411
412		default:
413
414			status = AE_AML_INTERNAL;
415			goto cleanup;
416		}
417
418		/* Failure means that the Index was beyond the end of the object */
419
420		if (ACPI_FAILURE(status)) {
421			ACPI_EXCEPTION((AE_INFO, status,
422					"Index (0x%X%8.8X) is beyond end of object (length 0x%X)",
423					ACPI_FORMAT_UINT64(index),
424					(u32)length));
425			goto cleanup;
426		}
427
428		/*
429		 * Save the target object and add a reference to it for the life
430		 * of the index
431		 */
432		return_desc->reference.object = operand[0];
433		acpi_ut_add_reference(operand[0]);
434
435		/* Store the reference to the Target */
436
437		status = acpi_ex_store(return_desc, operand[2], walk_state);
438
439		/* Return the reference */
440
441		walk_state->result_obj = return_desc;
442		goto cleanup;
443
444	default:
445
446		ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
447			    walk_state->opcode));
448		status = AE_AML_BAD_OPCODE;
449		break;
450	}
451
452store_result_to_target:
453
454	if (ACPI_SUCCESS(status)) {
455		/*
456		 * Store the result of the operation (which is now in return_desc) into
457		 * the Target descriptor.
458		 */
459		status = acpi_ex_store(return_desc, operand[2], walk_state);
460		if (ACPI_FAILURE(status)) {
461			goto cleanup;
462		}
463
464		if (!walk_state->result_obj) {
465			walk_state->result_obj = return_desc;
466		}
467	}
468
469cleanup:
470
471	/* Delete return object on error */
472
473	if (ACPI_FAILURE(status)) {
474		acpi_ut_remove_reference(return_desc);
475		walk_state->result_obj = NULL;
476	}
477
478	return_ACPI_STATUS(status);
479}
480
481/*******************************************************************************
482 *
483 * FUNCTION:    acpi_ex_opcode_2A_0T_1R
484 *
485 * PARAMETERS:  walk_state          - Current walk state
486 *
487 * RETURN:      Status
488 *
489 * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
490 *
491 ******************************************************************************/
492
493acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state)
494{
495	union acpi_operand_object **operand = &walk_state->operands[0];
496	union acpi_operand_object *return_desc = NULL;
497	acpi_status status = AE_OK;
498	u8 logical_result = FALSE;
499
500	ACPI_FUNCTION_TRACE_STR(ex_opcode_2A_0T_1R,
501				acpi_ps_get_opcode_name(walk_state->opcode));
502
503	/* Create the internal return object */
504
505	return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
506	if (!return_desc) {
507		status = AE_NO_MEMORY;
508		goto cleanup;
509	}
510
511	/* Execute the Opcode */
512
513	if (walk_state->op_info->flags & AML_LOGICAL_NUMERIC) {
514
515		/* logical_op (Operand0, Operand1) */
516
517		status = acpi_ex_do_logical_numeric_op(walk_state->opcode,
518						       operand[0]->integer.
519						       value,
520						       operand[1]->integer.
521						       value, &logical_result);
522		goto store_logical_result;
523	} else if (walk_state->op_info->flags & AML_LOGICAL) {
524
525		/* logical_op (Operand0, Operand1) */
526
527		status = acpi_ex_do_logical_op(walk_state->opcode, operand[0],
528					       operand[1], &logical_result);
529		goto store_logical_result;
530	}
531
532	switch (walk_state->opcode) {
533	case AML_ACQUIRE_OP:	/* Acquire (mutex_object, Timeout) */
534
535		status =
536		    acpi_ex_acquire_mutex(operand[1], operand[0], walk_state);
537		if (status == AE_TIME) {
538			logical_result = TRUE;	/* TRUE = Acquire timed out */
539			status = AE_OK;
540		}
541		break;
542
543	case AML_WAIT_OP:	/* Wait (event_object, Timeout) */
544
545		status = acpi_ex_system_wait_event(operand[1], operand[0]);
546		if (status == AE_TIME) {
547			logical_result = TRUE;	/* TRUE, Wait timed out */
548			status = AE_OK;
549		}
550		break;
551
552	default:
553
554		ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
555			    walk_state->opcode));
556		status = AE_AML_BAD_OPCODE;
557		goto cleanup;
558	}
559
560store_logical_result:
561	/*
562	 * Set return value to according to logical_result. logical TRUE (all ones)
563	 * Default is FALSE (zero)
564	 */
565	if (logical_result) {
566		return_desc->integer.value = ACPI_UINT64_MAX;
567	}
568
569cleanup:
570
571	/* Delete return object on error */
572
573	if (ACPI_FAILURE(status)) {
574		acpi_ut_remove_reference(return_desc);
575	}
576
577	/* Save return object on success */
578
579	else {
580		walk_state->result_obj = return_desc;
581	}
582
583	return_ACPI_STATUS(status);
584}
585