1 /******************************************************************************
3 * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acparser.h>
47 #include <acpi/acinterp.h>
48 #include <acpi/acevents.h>
49 #include <acpi/amlcode.h>
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME ("exoparg2")
57 * Naming convention for AML interpreter execution routines.
59 * The routines that begin execution of AML opcodes are named with a common
60 * convention based upon the number of arguments, the number of target operands,
61 * and whether or not a value is returned:
63 * AcpiExOpcode_xA_yT_zR
67 * xA - ARGUMENTS: The number of arguments (input operands) that are
68 * required for this opcode type (1 through 6 args).
69 * yT - TARGETS: The number of targets (output operands) that are required
70 * for this opcode type (0, 1, or 2 targets).
71 * zR - RETURN VALUE: Indicates whether this opcode type returns a value
72 * as the function return (0 or 1).
74 * The AcpiExOpcode* functions are called via the Dispatcher component with
75 * fully resolved operands.
79 /*******************************************************************************
81 * FUNCTION: acpi_ex_opcode_2A_0T_0R
83 * PARAMETERS: walk_state - Current walk state
87 * DESCRIPTION: Execute opcode with two arguments, no target, and no return
90 * ALLOCATION: Deletes both operands
92 ******************************************************************************/
95 acpi_ex_opcode_2A_0T_0R (
96 struct acpi_walk_state
*walk_state
)
98 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
99 struct acpi_namespace_node
*node
;
101 acpi_status status
= AE_OK
;
104 ACPI_FUNCTION_TRACE_STR ("ex_opcode_2A_0T_0R",
105 acpi_ps_get_opcode_name (walk_state
->opcode
));
108 /* Examine the opcode */
110 switch (walk_state
->opcode
) {
111 case AML_NOTIFY_OP
: /* Notify (notify_object, notify_value) */
113 /* The first operand is a namespace node */
115 node
= (struct acpi_namespace_node
*) operand
[0];
117 /* Second value is the notify value */
119 value
= (u32
) operand
[1]->integer
.value
;
121 /* Notifies allowed on this object? */
123 if (!acpi_ev_is_notify_object (node
)) {
124 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
125 "Unexpected notify object type [%s]\n",
126 acpi_ut_get_type_name (node
->type
)));
128 status
= AE_AML_OPERAND_TYPE
;
132 #ifdef ACPI_GPE_NOTIFY_CHECK
134 * GPE method wake/notify check. Here, we want to ensure that we
135 * don't receive any "device_wake" Notifies from a GPE _Lxx or _Exx
136 * GPE method during system runtime. If we do, the GPE is marked
137 * as "wake-only" and disabled.
139 * 1) Is the Notify() value == device_wake?
140 * 2) Is this a GPE deferred method? (An _Lxx or _Exx method)
141 * 3) Did the original GPE happen at system runtime?
142 * (versus during wake)
144 * If all three cases are true, this is a wake-only GPE that should
145 * be disabled at runtime.
147 if (value
== 2) /* device_wake */ {
148 status
= acpi_ev_check_for_wake_only_gpe (walk_state
->gpe_event_info
);
149 if (ACPI_FAILURE (status
)) {
150 /* AE_WAKE_ONLY_GPE only error, means ignore this notify */
152 return_ACPI_STATUS (AE_OK
)
158 * Dispatch the notify to the appropriate handler
159 * NOTE: the request is queued for execution after this method
160 * completes. The notify handlers are NOT invoked synchronously
161 * from this thread -- because handlers may in turn run other
164 status
= acpi_ev_queue_notify_request (node
, value
);
170 ACPI_REPORT_ERROR (("acpi_ex_opcode_2A_0T_0R: Unknown opcode %X\n",
171 walk_state
->opcode
));
172 status
= AE_AML_BAD_OPCODE
;
175 return_ACPI_STATUS (status
);
179 /*******************************************************************************
181 * FUNCTION: acpi_ex_opcode_2A_2T_1R
183 * PARAMETERS: walk_state - Current walk state
187 * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
188 * and one implicit return value.
190 ******************************************************************************/
193 acpi_ex_opcode_2A_2T_1R (
194 struct acpi_walk_state
*walk_state
)
196 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
197 union acpi_operand_object
*return_desc1
= NULL
;
198 union acpi_operand_object
*return_desc2
= NULL
;
202 ACPI_FUNCTION_TRACE_STR ("ex_opcode_2A_2T_1R",
203 acpi_ps_get_opcode_name (walk_state
->opcode
));
209 switch (walk_state
->opcode
) {
210 case AML_DIVIDE_OP
: /* Divide (Dividend, Divisor, remainder_result quotient_result) */
212 return_desc1
= acpi_ut_create_internal_object (ACPI_TYPE_INTEGER
);
214 status
= AE_NO_MEMORY
;
218 return_desc2
= acpi_ut_create_internal_object (ACPI_TYPE_INTEGER
);
220 status
= AE_NO_MEMORY
;
224 /* Quotient to return_desc1, remainder to return_desc2 */
226 status
= acpi_ut_divide (operand
[0]->integer
.value
,
227 operand
[1]->integer
.value
,
228 &return_desc1
->integer
.value
,
229 &return_desc2
->integer
.value
);
230 if (ACPI_FAILURE (status
)) {
238 ACPI_REPORT_ERROR (("acpi_ex_opcode_2A_2T_1R: Unknown opcode %X\n",
239 walk_state
->opcode
));
240 status
= AE_AML_BAD_OPCODE
;
245 /* Store the results to the target reference operands */
247 status
= acpi_ex_store (return_desc2
, operand
[2], walk_state
);
248 if (ACPI_FAILURE (status
)) {
252 status
= acpi_ex_store (return_desc1
, operand
[3], walk_state
);
253 if (ACPI_FAILURE (status
)) {
257 /* Return the remainder */
259 walk_state
->result_obj
= return_desc1
;
264 * Since the remainder is not returned indirectly, remove a reference to
265 * it. Only the quotient is returned indirectly.
267 acpi_ut_remove_reference (return_desc2
);
269 if (ACPI_FAILURE (status
)) {
270 /* Delete the return object */
272 acpi_ut_remove_reference (return_desc1
);
275 return_ACPI_STATUS (status
);
279 /*******************************************************************************
281 * FUNCTION: acpi_ex_opcode_2A_1T_1R
283 * PARAMETERS: walk_state - Current walk state
287 * DESCRIPTION: Execute opcode with two arguments, one target, and a return
290 ******************************************************************************/
293 acpi_ex_opcode_2A_1T_1R (
294 struct acpi_walk_state
*walk_state
)
296 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
297 union acpi_operand_object
*return_desc
= NULL
;
299 acpi_status status
= AE_OK
;
303 ACPI_FUNCTION_TRACE_STR ("ex_opcode_2A_1T_1R",
304 acpi_ps_get_opcode_name (walk_state
->opcode
));
310 if (walk_state
->op_info
->flags
& AML_MATH
) {
311 /* All simple math opcodes (add, etc.) */
313 return_desc
= acpi_ut_create_internal_object (ACPI_TYPE_INTEGER
);
315 status
= AE_NO_MEMORY
;
319 return_desc
->integer
.value
= acpi_ex_do_math_op (walk_state
->opcode
,
320 operand
[0]->integer
.value
,
321 operand
[1]->integer
.value
);
322 goto store_result_to_target
;
326 switch (walk_state
->opcode
) {
327 case AML_MOD_OP
: /* Mod (Dividend, Divisor, remainder_result (ACPI 2.0) */
329 return_desc
= acpi_ut_create_internal_object (ACPI_TYPE_INTEGER
);
331 status
= AE_NO_MEMORY
;
335 /* return_desc will contain the remainder */
337 status
= acpi_ut_divide (operand
[0]->integer
.value
,
338 operand
[1]->integer
.value
,
340 &return_desc
->integer
.value
);
344 case AML_CONCAT_OP
: /* Concatenate (Data1, Data2, Result) */
346 status
= acpi_ex_do_concatenate (operand
[0], operand
[1],
347 &return_desc
, walk_state
);
351 case AML_TO_STRING_OP
: /* to_string (Buffer, Length, Result) (ACPI 2.0) */
354 * Input object is guaranteed to be a buffer at this point (it may have
355 * been converted.) Copy the raw buffer data to a new object of type String.
359 * Get the length of the new string. It is the smallest of:
360 * 1) Length of the input buffer
361 * 2) Max length as specified in the to_string operator
362 * 3) Length of input buffer up to a zero byte (null terminator)
364 * NOTE: A length of zero is ok, and will create a zero-length, null
368 while ((length
< operand
[0]->buffer
.length
) &&
369 (length
< operand
[1]->integer
.value
) &&
370 (operand
[0]->buffer
.pointer
[length
])) {
372 if (length
> ACPI_MAX_STRING_CONVERSION
) {
373 status
= AE_AML_STRING_LIMIT
;
378 /* Allocate a new string object */
380 return_desc
= acpi_ut_create_string_object (length
);
382 status
= AE_NO_MEMORY
;
386 /* Copy the raw buffer data with no transform. NULL terminated already. */
388 ACPI_MEMCPY (return_desc
->string
.pointer
,
389 operand
[0]->buffer
.pointer
, length
);
393 case AML_CONCAT_RES_OP
: /* concatenate_res_template (Buffer, Buffer, Result) (ACPI 2.0) */
395 status
= acpi_ex_concat_template (operand
[0], operand
[1],
396 &return_desc
, walk_state
);
400 case AML_INDEX_OP
: /* Index (Source Index Result) */
402 /* Create the internal return object */
404 return_desc
= acpi_ut_create_internal_object (ACPI_TYPE_LOCAL_REFERENCE
);
406 status
= AE_NO_MEMORY
;
410 index
= (u32
) operand
[1]->integer
.value
;
413 * At this point, the Source operand is a Package, Buffer, or String
415 if (ACPI_GET_OBJECT_TYPE (operand
[0]) == ACPI_TYPE_PACKAGE
) {
416 /* Object to be indexed is a Package */
418 if (index
>= operand
[0]->package
.count
) {
419 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
420 "Index value (%X) beyond package end (%X)\n",
421 index
, operand
[0]->package
.count
));
422 status
= AE_AML_PACKAGE_LIMIT
;
426 return_desc
->reference
.target_type
= ACPI_TYPE_PACKAGE
;
427 return_desc
->reference
.object
= operand
[0];
428 return_desc
->reference
.where
= &operand
[0]->package
.elements
[index
];
431 /* Object to be indexed is a Buffer/String */
433 if (index
>= operand
[0]->buffer
.length
) {
434 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
435 "Index value (%X) beyond end of buffer (%X)\n",
436 index
, operand
[0]->buffer
.length
));
437 status
= AE_AML_BUFFER_LIMIT
;
441 return_desc
->reference
.target_type
= ACPI_TYPE_BUFFER_FIELD
;
442 return_desc
->reference
.object
= operand
[0];
446 * Add a reference to the target package/buffer/string for the life
449 acpi_ut_add_reference (operand
[0]);
451 /* Complete the Index reference object */
453 return_desc
->reference
.opcode
= AML_INDEX_OP
;
454 return_desc
->reference
.offset
= index
;
456 /* Store the reference to the Target */
458 status
= acpi_ex_store (return_desc
, operand
[2], walk_state
);
460 /* Return the reference */
462 walk_state
->result_obj
= return_desc
;
468 ACPI_REPORT_ERROR (("acpi_ex_opcode_2A_1T_1R: Unknown opcode %X\n",
469 walk_state
->opcode
));
470 status
= AE_AML_BAD_OPCODE
;
475 store_result_to_target
:
477 if (ACPI_SUCCESS (status
)) {
479 * Store the result of the operation (which is now in return_desc) into
480 * the Target descriptor.
482 status
= acpi_ex_store (return_desc
, operand
[2], walk_state
);
483 if (ACPI_FAILURE (status
)) {
487 if (!walk_state
->result_obj
) {
488 walk_state
->result_obj
= return_desc
;
495 /* Delete return object on error */
497 if (ACPI_FAILURE (status
)) {
498 acpi_ut_remove_reference (return_desc
);
501 return_ACPI_STATUS (status
);
505 /*******************************************************************************
507 * FUNCTION: acpi_ex_opcode_2A_0T_1R
509 * PARAMETERS: walk_state - Current walk state
513 * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
515 ******************************************************************************/
518 acpi_ex_opcode_2A_0T_1R (
519 struct acpi_walk_state
*walk_state
)
521 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
522 union acpi_operand_object
*return_desc
= NULL
;
523 acpi_status status
= AE_OK
;
524 u8 logical_result
= FALSE
;
527 ACPI_FUNCTION_TRACE_STR ("ex_opcode_2A_0T_1R",
528 acpi_ps_get_opcode_name (walk_state
->opcode
));
531 /* Create the internal return object */
533 return_desc
= acpi_ut_create_internal_object (ACPI_TYPE_INTEGER
);
535 status
= AE_NO_MEMORY
;
542 if (walk_state
->op_info
->flags
& AML_LOGICAL_NUMERIC
) /* logical_op (Operand0, Operand1) */ {
543 status
= acpi_ex_do_logical_numeric_op (walk_state
->opcode
,
544 operand
[0]->integer
.value
, operand
[1]->integer
.value
,
546 goto store_logical_result
;
548 else if (walk_state
->op_info
->flags
& AML_LOGICAL
) /* logical_op (Operand0, Operand1) */ {
549 status
= acpi_ex_do_logical_op (walk_state
->opcode
, operand
[0],
550 operand
[1], &logical_result
);
551 goto store_logical_result
;
555 switch (walk_state
->opcode
) {
556 case AML_ACQUIRE_OP
: /* Acquire (mutex_object, Timeout) */
558 status
= acpi_ex_acquire_mutex (operand
[1], operand
[0], walk_state
);
559 if (status
== AE_TIME
) {
560 logical_result
= TRUE
; /* TRUE = Acquire timed out */
566 case AML_WAIT_OP
: /* Wait (event_object, Timeout) */
568 status
= acpi_ex_system_wait_event (operand
[1], operand
[0]);
569 if (status
== AE_TIME
) {
570 logical_result
= TRUE
; /* TRUE, Wait timed out */
578 ACPI_REPORT_ERROR (("acpi_ex_opcode_2A_0T_1R: Unknown opcode %X\n",
579 walk_state
->opcode
));
580 status
= AE_AML_BAD_OPCODE
;
585 store_logical_result
:
587 * Set return value to according to logical_result. logical TRUE (all ones)
588 * Default is FALSE (zero)
590 if (logical_result
) {
591 return_desc
->integer
.value
= ACPI_INTEGER_MAX
;
594 walk_state
->result_obj
= return_desc
;
599 /* Delete return object on error */
601 if (ACPI_FAILURE (status
)) {
602 acpi_ut_remove_reference (return_desc
);
605 return_ACPI_STATUS (status
);