2 /******************************************************************************
4 * Module Name: exmisc - ACPI AML (p-code) execution - specific opcodes
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acinterp.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/amlresrc.h>
50 #define _COMPONENT ACPI_EXECUTER
51 ACPI_MODULE_NAME("exmisc")
53 /*******************************************************************************
55 * FUNCTION: acpi_ex_get_object_reference
57 * PARAMETERS: obj_desc - Create a reference to this object
58 * return_desc - Where to store the reference
59 * walk_state - Current state
63 * DESCRIPTION: Obtain and return a "reference" to the target object
64 * Common code for the ref_of_op and the cond_ref_of_op.
66 ******************************************************************************/
68 acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
69 union acpi_operand_object **return_desc,
70 struct acpi_walk_state *walk_state)
72 union acpi_operand_object *reference_obj;
73 union acpi_operand_object *referenced_obj;
75 ACPI_FUNCTION_TRACE_PTR(ex_get_object_reference, obj_desc);
79 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
80 case ACPI_DESC_TYPE_OPERAND:
82 if (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_LOCAL_REFERENCE) {
83 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
87 * Must be a reference to a Local or Arg
89 switch (obj_desc->reference.class) {
90 case ACPI_REFCLASS_LOCAL:
91 case ACPI_REFCLASS_ARG:
92 case ACPI_REFCLASS_DEBUG:
94 /* The referenced object is the pseudo-node for the local/arg */
96 referenced_obj = obj_desc->reference.object;
101 ACPI_ERROR((AE_INFO, "Unknown Reference Class %2.2X",
102 obj_desc->reference.class));
103 return_ACPI_STATUS(AE_AML_INTERNAL);
107 case ACPI_DESC_TYPE_NAMED:
110 * A named reference that has already been resolved to a Node
112 referenced_obj = obj_desc;
117 ACPI_ERROR((AE_INFO, "Invalid descriptor type %X",
118 ACPI_GET_DESCRIPTOR_TYPE(obj_desc)));
119 return_ACPI_STATUS(AE_TYPE);
122 /* Create a new reference object */
125 acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE);
126 if (!reference_obj) {
127 return_ACPI_STATUS(AE_NO_MEMORY);
130 reference_obj->reference.class = ACPI_REFCLASS_REFOF;
131 reference_obj->reference.object = referenced_obj;
132 *return_desc = reference_obj;
134 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
135 "Object %p Type [%s], returning Reference %p\n",
136 obj_desc, acpi_ut_get_object_type_name(obj_desc),
139 return_ACPI_STATUS(AE_OK);
142 /*******************************************************************************
144 * FUNCTION: acpi_ex_concat_template
146 * PARAMETERS: Operand0 - First source object
147 * Operand1 - Second source object
148 * actual_return_desc - Where to place the return object
149 * walk_state - Current walk state
153 * DESCRIPTION: Concatenate two resource templates
155 ******************************************************************************/
158 acpi_ex_concat_template(union acpi_operand_object *operand0,
159 union acpi_operand_object *operand1,
160 union acpi_operand_object **actual_return_desc,
161 struct acpi_walk_state *walk_state)
164 union acpi_operand_object *return_desc;
169 acpi_size new_length;
171 ACPI_FUNCTION_TRACE(ex_concat_template);
174 * Find the end_tag descriptor in each resource template.
175 * Note1: returned pointers point TO the end_tag, not past it.
176 * Note2: zero-length buffers are allowed; treated like one end_tag
179 /* Get the length of the first resource template */
181 status = acpi_ut_get_resource_end_tag(operand0, &end_tag);
182 if (ACPI_FAILURE(status)) {
183 return_ACPI_STATUS(status);
186 length0 = ACPI_PTR_DIFF(end_tag, operand0->buffer.pointer);
188 /* Get the length of the second resource template */
190 status = acpi_ut_get_resource_end_tag(operand1, &end_tag);
191 if (ACPI_FAILURE(status)) {
192 return_ACPI_STATUS(status);
195 length1 = ACPI_PTR_DIFF(end_tag, operand1->buffer.pointer);
197 /* Combine both lengths, minimum size will be 2 for end_tag */
199 new_length = length0 + length1 + sizeof(struct aml_resource_end_tag);
201 /* Create a new buffer object for the result (with one end_tag) */
203 return_desc = acpi_ut_create_buffer_object(new_length);
205 return_ACPI_STATUS(AE_NO_MEMORY);
209 * Copy the templates to the new buffer, 0 first, then 1 follows. One
210 * end_tag descriptor is copied from Operand1.
212 new_buf = return_desc->buffer.pointer;
213 ACPI_MEMCPY(new_buf, operand0->buffer.pointer, length0);
214 ACPI_MEMCPY(new_buf + length0, operand1->buffer.pointer, length1);
216 /* Insert end_tag and set the checksum to zero, means "ignore checksum" */
218 new_buf[new_length - 1] = 0;
219 new_buf[new_length - 2] = ACPI_RESOURCE_NAME_END_TAG | 1;
221 /* Return the completed resource template */
223 *actual_return_desc = return_desc;
224 return_ACPI_STATUS(AE_OK);
227 /*******************************************************************************
229 * FUNCTION: acpi_ex_do_concatenate
231 * PARAMETERS: Operand0 - First source object
232 * Operand1 - Second source object
233 * actual_return_desc - Where to place the return object
234 * walk_state - Current walk state
238 * DESCRIPTION: Concatenate two objects OF THE SAME TYPE.
240 ******************************************************************************/
243 acpi_ex_do_concatenate(union acpi_operand_object *operand0,
244 union acpi_operand_object *operand1,
245 union acpi_operand_object **actual_return_desc,
246 struct acpi_walk_state *walk_state)
248 union acpi_operand_object *local_operand1 = operand1;
249 union acpi_operand_object *return_desc;
253 ACPI_FUNCTION_TRACE(ex_do_concatenate);
256 * Convert the second operand if necessary. The first operand
257 * determines the type of the second operand, (See the Data Types
258 * section of the ACPI specification.) Both object types are
259 * guaranteed to be either Integer/String/Buffer by the operand
260 * resolution mechanism.
262 switch (ACPI_GET_OBJECT_TYPE(operand0)) {
263 case ACPI_TYPE_INTEGER:
265 acpi_ex_convert_to_integer(operand1, &local_operand1, 16);
268 case ACPI_TYPE_STRING:
269 status = acpi_ex_convert_to_string(operand1, &local_operand1,
270 ACPI_IMPLICIT_CONVERT_HEX);
273 case ACPI_TYPE_BUFFER:
274 status = acpi_ex_convert_to_buffer(operand1, &local_operand1);
278 ACPI_ERROR((AE_INFO, "Invalid object type: %X",
279 ACPI_GET_OBJECT_TYPE(operand0)));
280 status = AE_AML_INTERNAL;
283 if (ACPI_FAILURE(status)) {
288 * Both operands are now known to be the same object type
289 * (Both are Integer, String, or Buffer), and we can now perform the
294 * There are three cases to handle:
296 * 1) Two Integers concatenated to produce a new Buffer
297 * 2) Two Strings concatenated to produce a new String
298 * 3) Two Buffers concatenated to produce a new Buffer
300 switch (ACPI_GET_OBJECT_TYPE(operand0)) {
301 case ACPI_TYPE_INTEGER:
303 /* Result of two Integers is a Buffer */
304 /* Need enough buffer space for two integers */
306 return_desc = acpi_ut_create_buffer_object((acpi_size)
308 (acpi_gbl_integer_byte_width));
310 status = AE_NO_MEMORY;
314 new_buf = (char *)return_desc->buffer.pointer;
316 /* Copy the first integer, LSB first */
318 ACPI_MEMCPY(new_buf, &operand0->integer.value,
319 acpi_gbl_integer_byte_width);
321 /* Copy the second integer (LSB first) after the first */
323 ACPI_MEMCPY(new_buf + acpi_gbl_integer_byte_width,
324 &local_operand1->integer.value,
325 acpi_gbl_integer_byte_width);
328 case ACPI_TYPE_STRING:
330 /* Result of two Strings is a String */
332 return_desc = acpi_ut_create_string_object(((acpi_size)
338 status = AE_NO_MEMORY;
342 new_buf = return_desc->string.pointer;
344 /* Concatenate the strings */
346 ACPI_STRCPY(new_buf, operand0->string.pointer);
347 ACPI_STRCPY(new_buf + operand0->string.length,
348 local_operand1->string.pointer);
351 case ACPI_TYPE_BUFFER:
353 /* Result of two Buffers is a Buffer */
355 return_desc = acpi_ut_create_buffer_object(((acpi_size)
361 status = AE_NO_MEMORY;
365 new_buf = (char *)return_desc->buffer.pointer;
367 /* Concatenate the buffers */
369 ACPI_MEMCPY(new_buf, operand0->buffer.pointer,
370 operand0->buffer.length);
371 ACPI_MEMCPY(new_buf + operand0->buffer.length,
372 local_operand1->buffer.pointer,
373 local_operand1->buffer.length);
378 /* Invalid object type, should not happen here */
380 ACPI_ERROR((AE_INFO, "Invalid object type: %X",
381 ACPI_GET_OBJECT_TYPE(operand0)));
382 status = AE_AML_INTERNAL;
386 *actual_return_desc = return_desc;
389 if (local_operand1 != operand1) {
390 acpi_ut_remove_reference(local_operand1);
392 return_ACPI_STATUS(status);
395 /*******************************************************************************
397 * FUNCTION: acpi_ex_do_math_op
399 * PARAMETERS: Opcode - AML opcode
400 * Integer0 - Integer operand #0
401 * Integer1 - Integer operand #1
403 * RETURN: Integer result of the operation
405 * DESCRIPTION: Execute a math AML opcode. The purpose of having all of the
406 * math functions here is to prevent a lot of pointer dereferencing
407 * to obtain the operands.
409 ******************************************************************************/
412 acpi_ex_do_math_op(u16 opcode, acpi_integer integer0, acpi_integer integer1)
415 ACPI_FUNCTION_ENTRY();
418 case AML_ADD_OP: /* Add (Integer0, Integer1, Result) */
420 return (integer0 + integer1);
422 case AML_BIT_AND_OP: /* And (Integer0, Integer1, Result) */
424 return (integer0 & integer1);
426 case AML_BIT_NAND_OP: /* NAnd (Integer0, Integer1, Result) */
428 return (~(integer0 & integer1));
430 case AML_BIT_OR_OP: /* Or (Integer0, Integer1, Result) */
432 return (integer0 | integer1);
434 case AML_BIT_NOR_OP: /* NOr (Integer0, Integer1, Result) */
436 return (~(integer0 | integer1));
438 case AML_BIT_XOR_OP: /* XOr (Integer0, Integer1, Result) */
440 return (integer0 ^ integer1);
442 case AML_MULTIPLY_OP: /* Multiply (Integer0, Integer1, Result) */
444 return (integer0 * integer1);
446 case AML_SHIFT_LEFT_OP: /* shift_left (Operand, shift_count, Result) */
449 * We need to check if the shiftcount is larger than the integer bit
450 * width since the behavior of this is not well-defined in the C language.
452 if (integer1 >= acpi_gbl_integer_bit_width) {
455 return (integer0 << integer1);
457 case AML_SHIFT_RIGHT_OP: /* shift_right (Operand, shift_count, Result) */
460 * We need to check if the shiftcount is larger than the integer bit
461 * width since the behavior of this is not well-defined in the C language.
463 if (integer1 >= acpi_gbl_integer_bit_width) {
466 return (integer0 >> integer1);
468 case AML_SUBTRACT_OP: /* Subtract (Integer0, Integer1, Result) */
470 return (integer0 - integer1);
478 /*******************************************************************************
480 * FUNCTION: acpi_ex_do_logical_numeric_op
482 * PARAMETERS: Opcode - AML opcode
483 * Integer0 - Integer operand #0
484 * Integer1 - Integer operand #1
485 * logical_result - TRUE/FALSE result of the operation
489 * DESCRIPTION: Execute a logical "Numeric" AML opcode. For these Numeric
490 * operators (LAnd and LOr), both operands must be integers.
492 * Note: cleanest machine code seems to be produced by the code
493 * below, rather than using statements of the form:
494 * Result = (Integer0 && Integer1);
496 ******************************************************************************/
499 acpi_ex_do_logical_numeric_op(u16 opcode,
500 acpi_integer integer0,
501 acpi_integer integer1, u8 * logical_result)
503 acpi_status status = AE_OK;
504 u8 local_result = FALSE;
506 ACPI_FUNCTION_TRACE(ex_do_logical_numeric_op);
509 case AML_LAND_OP: /* LAnd (Integer0, Integer1) */
511 if (integer0 && integer1) {
516 case AML_LOR_OP: /* LOr (Integer0, Integer1) */
518 if (integer0 || integer1) {
524 status = AE_AML_INTERNAL;
528 /* Return the logical result and status */
530 *logical_result = local_result;
531 return_ACPI_STATUS(status);
534 /*******************************************************************************
536 * FUNCTION: acpi_ex_do_logical_op
538 * PARAMETERS: Opcode - AML opcode
539 * Operand0 - operand #0
540 * Operand1 - operand #1
541 * logical_result - TRUE/FALSE result of the operation
545 * DESCRIPTION: Execute a logical AML opcode. The purpose of having all of the
546 * functions here is to prevent a lot of pointer dereferencing
547 * to obtain the operands and to simplify the generation of the
548 * logical value. For the Numeric operators (LAnd and LOr), both
549 * operands must be integers. For the other logical operators,
550 * operands can be any combination of Integer/String/Buffer. The
551 * first operand determines the type to which the second operand
554 * Note: cleanest machine code seems to be produced by the code
555 * below, rather than using statements of the form:
556 * Result = (Operand0 == Operand1);
558 ******************************************************************************/
561 acpi_ex_do_logical_op(u16 opcode,
562 union acpi_operand_object *operand0,
563 union acpi_operand_object *operand1, u8 * logical_result)
565 union acpi_operand_object *local_operand1 = operand1;
566 acpi_integer integer0;
567 acpi_integer integer1;
570 acpi_status status = AE_OK;
571 u8 local_result = FALSE;
574 ACPI_FUNCTION_TRACE(ex_do_logical_op);
577 * Convert the second operand if necessary. The first operand
578 * determines the type of the second operand, (See the Data Types
579 * section of the ACPI 3.0+ specification.) Both object types are
580 * guaranteed to be either Integer/String/Buffer by the operand
581 * resolution mechanism.
583 switch (ACPI_GET_OBJECT_TYPE(operand0)) {
584 case ACPI_TYPE_INTEGER:
586 acpi_ex_convert_to_integer(operand1, &local_operand1, 16);
589 case ACPI_TYPE_STRING:
590 status = acpi_ex_convert_to_string(operand1, &local_operand1,
591 ACPI_IMPLICIT_CONVERT_HEX);
594 case ACPI_TYPE_BUFFER:
595 status = acpi_ex_convert_to_buffer(operand1, &local_operand1);
599 status = AE_AML_INTERNAL;
603 if (ACPI_FAILURE(status)) {
608 * Two cases: 1) Both Integers, 2) Both Strings or Buffers
610 if (ACPI_GET_OBJECT_TYPE(operand0) == ACPI_TYPE_INTEGER) {
612 * 1) Both operands are of type integer
613 * Note: local_operand1 may have changed above
615 integer0 = operand0->integer.value;
616 integer1 = local_operand1->integer.value;
619 case AML_LEQUAL_OP: /* LEqual (Operand0, Operand1) */
621 if (integer0 == integer1) {
626 case AML_LGREATER_OP: /* LGreater (Operand0, Operand1) */
628 if (integer0 > integer1) {
633 case AML_LLESS_OP: /* LLess (Operand0, Operand1) */
635 if (integer0 < integer1) {
641 status = AE_AML_INTERNAL;
646 * 2) Both operands are Strings or both are Buffers
647 * Note: Code below takes advantage of common Buffer/String
648 * object fields. local_operand1 may have changed above. Use
649 * memcmp to handle nulls in buffers.
651 length0 = operand0->buffer.length;
652 length1 = local_operand1->buffer.length;
654 /* Lexicographic compare: compare the data bytes */
656 compare = ACPI_MEMCMP(operand0->buffer.pointer,
657 local_operand1->buffer.pointer,
658 (length0 > length1) ? length1 : length0);
661 case AML_LEQUAL_OP: /* LEqual (Operand0, Operand1) */
663 /* Length and all bytes must be equal */
665 if ((length0 == length1) && (compare == 0)) {
667 /* Length and all bytes match ==> TRUE */
673 case AML_LGREATER_OP: /* LGreater (Operand0, Operand1) */
677 goto cleanup; /* TRUE */
680 goto cleanup; /* FALSE */
683 /* Bytes match (to shortest length), compare lengths */
685 if (length0 > length1) {
690 case AML_LLESS_OP: /* LLess (Operand0, Operand1) */
693 goto cleanup; /* FALSE */
697 goto cleanup; /* TRUE */
700 /* Bytes match (to shortest length), compare lengths */
702 if (length0 < length1) {
708 status = AE_AML_INTERNAL;
715 /* New object was created if implicit conversion performed - delete */
717 if (local_operand1 != operand1) {
718 acpi_ut_remove_reference(local_operand1);
721 /* Return the logical result and status */
723 *logical_result = local_result;
724 return_ACPI_STATUS(status);