[ACPI] ACPICA 20051021
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / acpi / executer / exmisc.c
blob1899ab2513931e3c73577796f8fb5db12486f68e
2 /******************************************************************************
4 * Module Name: exmisc - ACPI AML (p-code) execution - specific opcodes
6 *****************************************************************************/
8 /*
9 * Copyright (C) 2000 - 2005, R. Byron Moore
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
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.
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.
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acinterp.h>
47 #include <acpi/amlcode.h>
49 #define _COMPONENT ACPI_EXECUTER
50 ACPI_MODULE_NAME("exmisc")
52 /*******************************************************************************
54 * FUNCTION: acpi_ex_get_object_reference
56 * PARAMETERS: obj_desc - Create a reference to this object
57 * return_desc - Where to store the reference
58 * walk_state - Current state
60 * RETURN: Status
62 * DESCRIPTION: Obtain and return a "reference" to the target object
63 * Common code for the ref_of_op and the cond_ref_of_op.
65 ******************************************************************************/
66 acpi_status
67 acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
68 union acpi_operand_object **return_desc,
69 struct acpi_walk_state *walk_state)
71 union acpi_operand_object *reference_obj;
72 union acpi_operand_object *referenced_obj;
74 ACPI_FUNCTION_TRACE_PTR("ex_get_object_reference", obj_desc);
76 *return_desc = NULL;
78 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
79 case ACPI_DESC_TYPE_OPERAND:
81 if (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_LOCAL_REFERENCE) {
82 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
86 * Must be a reference to a Local or Arg
88 switch (obj_desc->reference.opcode) {
89 case AML_LOCAL_OP:
90 case AML_ARG_OP:
91 case AML_DEBUG_OP:
93 /* The referenced object is the pseudo-node for the local/arg */
95 referenced_obj = obj_desc->reference.object;
96 break;
98 default:
100 ACPI_REPORT_ERROR(("Unknown Reference opcode in get_reference %X\n", obj_desc->reference.opcode));
101 return_ACPI_STATUS(AE_AML_INTERNAL);
103 break;
105 case ACPI_DESC_TYPE_NAMED:
108 * A named reference that has already been resolved to a Node
110 referenced_obj = obj_desc;
111 break;
113 default:
115 ACPI_REPORT_ERROR(("Invalid descriptor type in get_reference: %X\n", ACPI_GET_DESCRIPTOR_TYPE(obj_desc)));
116 return_ACPI_STATUS(AE_TYPE);
119 /* Create a new reference object */
121 reference_obj =
122 acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE);
123 if (!reference_obj) {
124 return_ACPI_STATUS(AE_NO_MEMORY);
127 reference_obj->reference.opcode = AML_REF_OF_OP;
128 reference_obj->reference.object = referenced_obj;
129 *return_desc = reference_obj;
131 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
132 "Object %p Type [%s], returning Reference %p\n",
133 obj_desc, acpi_ut_get_object_type_name(obj_desc),
134 *return_desc));
136 return_ACPI_STATUS(AE_OK);
139 /*******************************************************************************
141 * FUNCTION: acpi_ex_concat_template
143 * PARAMETERS: Operand0 - First source object
144 * Operand1 - Second source object
145 * actual_return_desc - Where to place the return object
146 * walk_state - Current walk state
148 * RETURN: Status
150 * DESCRIPTION: Concatenate two resource templates
152 ******************************************************************************/
154 acpi_status
155 acpi_ex_concat_template(union acpi_operand_object *operand0,
156 union acpi_operand_object *operand1,
157 union acpi_operand_object **actual_return_desc,
158 struct acpi_walk_state *walk_state)
160 union acpi_operand_object *return_desc;
161 u8 *new_buf;
162 u8 *end_tag1;
163 u8 *end_tag2;
164 acpi_size length1;
165 acpi_size length2;
167 ACPI_FUNCTION_TRACE("ex_concat_template");
169 /* Find the end_tags in each resource template */
171 end_tag1 = acpi_ut_get_resource_end_tag(operand0);
172 end_tag2 = acpi_ut_get_resource_end_tag(operand1);
173 if (!end_tag1 || !end_tag2) {
174 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
177 /* Compute the length of each part */
179 length1 = ACPI_PTR_DIFF(end_tag1, operand0->buffer.pointer);
180 length2 = ACPI_PTR_DIFF(end_tag2, operand1->buffer.pointer) + 2; /* Size of END_TAG */
182 /* Create a new buffer object for the result */
184 return_desc = acpi_ut_create_buffer_object(length1 + length2);
185 if (!return_desc) {
186 return_ACPI_STATUS(AE_NO_MEMORY);
189 /* Copy the templates to the new descriptor */
191 new_buf = return_desc->buffer.pointer;
192 ACPI_MEMCPY(new_buf, operand0->buffer.pointer, length1);
193 ACPI_MEMCPY(new_buf + length1, operand1->buffer.pointer, length2);
195 /* Compute the new checksum */
197 new_buf[return_desc->buffer.length - 1] =
198 acpi_ut_generate_checksum(return_desc->buffer.pointer,
199 (return_desc->buffer.length - 1));
201 /* Return the completed template descriptor */
203 *actual_return_desc = return_desc;
204 return_ACPI_STATUS(AE_OK);
207 /*******************************************************************************
209 * FUNCTION: acpi_ex_do_concatenate
211 * PARAMETERS: Operand0 - First source object
212 * Operand1 - Second source object
213 * actual_return_desc - Where to place the return object
214 * walk_state - Current walk state
216 * RETURN: Status
218 * DESCRIPTION: Concatenate two objects OF THE SAME TYPE.
220 ******************************************************************************/
222 acpi_status
223 acpi_ex_do_concatenate(union acpi_operand_object *operand0,
224 union acpi_operand_object *operand1,
225 union acpi_operand_object **actual_return_desc,
226 struct acpi_walk_state *walk_state)
228 union acpi_operand_object *local_operand1 = operand1;
229 union acpi_operand_object *return_desc;
230 char *new_buf;
231 acpi_status status;
232 acpi_size new_length;
234 ACPI_FUNCTION_TRACE("ex_do_concatenate");
237 * Convert the second operand if necessary. The first operand
238 * determines the type of the second operand, (See the Data Types
239 * section of the ACPI specification.) Both object types are
240 * guaranteed to be either Integer/String/Buffer by the operand
241 * resolution mechanism.
243 switch (ACPI_GET_OBJECT_TYPE(operand0)) {
244 case ACPI_TYPE_INTEGER:
245 status =
246 acpi_ex_convert_to_integer(operand1, &local_operand1, 16);
247 break;
249 case ACPI_TYPE_STRING:
250 status = acpi_ex_convert_to_string(operand1, &local_operand1,
251 ACPI_IMPLICIT_CONVERT_HEX);
252 break;
254 case ACPI_TYPE_BUFFER:
255 status = acpi_ex_convert_to_buffer(operand1, &local_operand1);
256 break;
258 default:
259 ACPI_REPORT_ERROR(("Concat - invalid obj type: %X\n",
260 ACPI_GET_OBJECT_TYPE(operand0)));
261 status = AE_AML_INTERNAL;
264 if (ACPI_FAILURE(status)) {
265 goto cleanup;
269 * Both operands are now known to be the same object type
270 * (Both are Integer, String, or Buffer), and we can now perform the
271 * concatenation.
275 * There are three cases to handle:
277 * 1) Two Integers concatenated to produce a new Buffer
278 * 2) Two Strings concatenated to produce a new String
279 * 3) Two Buffers concatenated to produce a new Buffer
281 switch (ACPI_GET_OBJECT_TYPE(operand0)) {
282 case ACPI_TYPE_INTEGER:
284 /* Result of two Integers is a Buffer */
285 /* Need enough buffer space for two integers */
287 return_desc = acpi_ut_create_buffer_object((acpi_size)
288 ACPI_MUL_2
289 (acpi_gbl_integer_byte_width));
290 if (!return_desc) {
291 status = AE_NO_MEMORY;
292 goto cleanup;
295 new_buf = (char *)return_desc->buffer.pointer;
297 /* Copy the first integer, LSB first */
299 ACPI_MEMCPY(new_buf,
300 &operand0->integer.value,
301 acpi_gbl_integer_byte_width);
303 /* Copy the second integer (LSB first) after the first */
305 ACPI_MEMCPY(new_buf + acpi_gbl_integer_byte_width,
306 &local_operand1->integer.value,
307 acpi_gbl_integer_byte_width);
308 break;
310 case ACPI_TYPE_STRING:
312 /* Result of two Strings is a String */
314 new_length = (acpi_size) operand0->string.length +
315 (acpi_size) local_operand1->string.length;
316 if (new_length > ACPI_MAX_STRING_CONVERSION) {
317 status = AE_AML_STRING_LIMIT;
318 goto cleanup;
321 return_desc = acpi_ut_create_string_object(new_length);
322 if (!return_desc) {
323 status = AE_NO_MEMORY;
324 goto cleanup;
327 new_buf = return_desc->string.pointer;
329 /* Concatenate the strings */
331 ACPI_STRCPY(new_buf, operand0->string.pointer);
332 ACPI_STRCPY(new_buf + operand0->string.length,
333 local_operand1->string.pointer);
334 break;
336 case ACPI_TYPE_BUFFER:
338 /* Result of two Buffers is a Buffer */
340 return_desc = acpi_ut_create_buffer_object((acpi_size)
341 operand0->buffer.
342 length +
343 (acpi_size)
344 local_operand1->
345 buffer.length);
346 if (!return_desc) {
347 status = AE_NO_MEMORY;
348 goto cleanup;
351 new_buf = (char *)return_desc->buffer.pointer;
353 /* Concatenate the buffers */
355 ACPI_MEMCPY(new_buf,
356 operand0->buffer.pointer, operand0->buffer.length);
357 ACPI_MEMCPY(new_buf + operand0->buffer.length,
358 local_operand1->buffer.pointer,
359 local_operand1->buffer.length);
360 break;
362 default:
364 /* Invalid object type, should not happen here */
366 ACPI_REPORT_ERROR(("Concatenate - Invalid object type: %X\n",
367 ACPI_GET_OBJECT_TYPE(operand0)));
368 status = AE_AML_INTERNAL;
369 goto cleanup;
372 *actual_return_desc = return_desc;
374 cleanup:
375 if (local_operand1 != operand1) {
376 acpi_ut_remove_reference(local_operand1);
378 return_ACPI_STATUS(status);
381 /*******************************************************************************
383 * FUNCTION: acpi_ex_do_math_op
385 * PARAMETERS: Opcode - AML opcode
386 * Integer0 - Integer operand #0
387 * Integer1 - Integer operand #1
389 * RETURN: Integer result of the operation
391 * DESCRIPTION: Execute a math AML opcode. The purpose of having all of the
392 * math functions here is to prevent a lot of pointer dereferencing
393 * to obtain the operands.
395 ******************************************************************************/
397 acpi_integer
398 acpi_ex_do_math_op(u16 opcode, acpi_integer integer0, acpi_integer integer1)
401 ACPI_FUNCTION_ENTRY();
403 switch (opcode) {
404 case AML_ADD_OP: /* Add (Integer0, Integer1, Result) */
406 return (integer0 + integer1);
408 case AML_BIT_AND_OP: /* And (Integer0, Integer1, Result) */
410 return (integer0 & integer1);
412 case AML_BIT_NAND_OP: /* NAnd (Integer0, Integer1, Result) */
414 return (~(integer0 & integer1));
416 case AML_BIT_OR_OP: /* Or (Integer0, Integer1, Result) */
418 return (integer0 | integer1);
420 case AML_BIT_NOR_OP: /* NOr (Integer0, Integer1, Result) */
422 return (~(integer0 | integer1));
424 case AML_BIT_XOR_OP: /* XOr (Integer0, Integer1, Result) */
426 return (integer0 ^ integer1);
428 case AML_MULTIPLY_OP: /* Multiply (Integer0, Integer1, Result) */
430 return (integer0 * integer1);
432 case AML_SHIFT_LEFT_OP: /* shift_left (Operand, shift_count, Result) */
434 return (integer0 << integer1);
436 case AML_SHIFT_RIGHT_OP: /* shift_right (Operand, shift_count, Result) */
438 return (integer0 >> integer1);
440 case AML_SUBTRACT_OP: /* Subtract (Integer0, Integer1, Result) */
442 return (integer0 - integer1);
444 default:
446 return (0);
450 /*******************************************************************************
452 * FUNCTION: acpi_ex_do_logical_numeric_op
454 * PARAMETERS: Opcode - AML opcode
455 * Integer0 - Integer operand #0
456 * Integer1 - Integer operand #1
457 * logical_result - TRUE/FALSE result of the operation
459 * RETURN: Status
461 * DESCRIPTION: Execute a logical "Numeric" AML opcode. For these Numeric
462 * operators (LAnd and LOr), both operands must be integers.
464 * Note: cleanest machine code seems to be produced by the code
465 * below, rather than using statements of the form:
466 * Result = (Integer0 && Integer1);
468 ******************************************************************************/
470 acpi_status
471 acpi_ex_do_logical_numeric_op(u16 opcode,
472 acpi_integer integer0,
473 acpi_integer integer1, u8 * logical_result)
475 acpi_status status = AE_OK;
476 u8 local_result = FALSE;
478 ACPI_FUNCTION_TRACE("ex_do_logical_numeric_op");
480 switch (opcode) {
481 case AML_LAND_OP: /* LAnd (Integer0, Integer1) */
483 if (integer0 && integer1) {
484 local_result = TRUE;
486 break;
488 case AML_LOR_OP: /* LOr (Integer0, Integer1) */
490 if (integer0 || integer1) {
491 local_result = TRUE;
493 break;
495 default:
496 status = AE_AML_INTERNAL;
497 break;
500 /* Return the logical result and status */
502 *logical_result = local_result;
503 return_ACPI_STATUS(status);
506 /*******************************************************************************
508 * FUNCTION: acpi_ex_do_logical_op
510 * PARAMETERS: Opcode - AML opcode
511 * Operand0 - operand #0
512 * Operand1 - operand #1
513 * logical_result - TRUE/FALSE result of the operation
515 * RETURN: Status
517 * DESCRIPTION: Execute a logical AML opcode. The purpose of having all of the
518 * functions here is to prevent a lot of pointer dereferencing
519 * to obtain the operands and to simplify the generation of the
520 * logical value. For the Numeric operators (LAnd and LOr), both
521 * operands must be integers. For the other logical operators,
522 * operands can be any combination of Integer/String/Buffer. The
523 * first operand determines the type to which the second operand
524 * will be converted.
526 * Note: cleanest machine code seems to be produced by the code
527 * below, rather than using statements of the form:
528 * Result = (Operand0 == Operand1);
530 ******************************************************************************/
532 acpi_status
533 acpi_ex_do_logical_op(u16 opcode,
534 union acpi_operand_object *operand0,
535 union acpi_operand_object *operand1, u8 * logical_result)
537 union acpi_operand_object *local_operand1 = operand1;
538 acpi_integer integer0;
539 acpi_integer integer1;
540 u32 length0;
541 u32 length1;
542 acpi_status status = AE_OK;
543 u8 local_result = FALSE;
544 int compare;
546 ACPI_FUNCTION_TRACE("ex_do_logical_op");
549 * Convert the second operand if necessary. The first operand
550 * determines the type of the second operand, (See the Data Types
551 * section of the ACPI 3.0+ specification.) Both object types are
552 * guaranteed to be either Integer/String/Buffer by the operand
553 * resolution mechanism.
555 switch (ACPI_GET_OBJECT_TYPE(operand0)) {
556 case ACPI_TYPE_INTEGER:
557 status =
558 acpi_ex_convert_to_integer(operand1, &local_operand1, 16);
559 break;
561 case ACPI_TYPE_STRING:
562 status = acpi_ex_convert_to_string(operand1, &local_operand1,
563 ACPI_IMPLICIT_CONVERT_HEX);
564 break;
566 case ACPI_TYPE_BUFFER:
567 status = acpi_ex_convert_to_buffer(operand1, &local_operand1);
568 break;
570 default:
571 status = AE_AML_INTERNAL;
572 break;
575 if (ACPI_FAILURE(status)) {
576 goto cleanup;
580 * Two cases: 1) Both Integers, 2) Both Strings or Buffers
582 if (ACPI_GET_OBJECT_TYPE(operand0) == ACPI_TYPE_INTEGER) {
584 * 1) Both operands are of type integer
585 * Note: local_operand1 may have changed above
587 integer0 = operand0->integer.value;
588 integer1 = local_operand1->integer.value;
590 switch (opcode) {
591 case AML_LEQUAL_OP: /* LEqual (Operand0, Operand1) */
593 if (integer0 == integer1) {
594 local_result = TRUE;
596 break;
598 case AML_LGREATER_OP: /* LGreater (Operand0, Operand1) */
600 if (integer0 > integer1) {
601 local_result = TRUE;
603 break;
605 case AML_LLESS_OP: /* LLess (Operand0, Operand1) */
607 if (integer0 < integer1) {
608 local_result = TRUE;
610 break;
612 default:
613 status = AE_AML_INTERNAL;
614 break;
616 } else {
618 * 2) Both operands are Strings or both are Buffers
619 * Note: Code below takes advantage of common Buffer/String
620 * object fields. local_operand1 may have changed above. Use
621 * memcmp to handle nulls in buffers.
623 length0 = operand0->buffer.length;
624 length1 = local_operand1->buffer.length;
626 /* Lexicographic compare: compare the data bytes */
628 compare = ACPI_MEMCMP(operand0->buffer.pointer,
629 local_operand1->buffer.pointer,
630 (length0 > length1) ? length1 : length0);
632 switch (opcode) {
633 case AML_LEQUAL_OP: /* LEqual (Operand0, Operand1) */
635 /* Length and all bytes must be equal */
637 if ((length0 == length1) && (compare == 0)) {
638 /* Length and all bytes match ==> TRUE */
640 local_result = TRUE;
642 break;
644 case AML_LGREATER_OP: /* LGreater (Operand0, Operand1) */
646 if (compare > 0) {
647 local_result = TRUE;
648 goto cleanup; /* TRUE */
650 if (compare < 0) {
651 goto cleanup; /* FALSE */
654 /* Bytes match (to shortest length), compare lengths */
656 if (length0 > length1) {
657 local_result = TRUE;
659 break;
661 case AML_LLESS_OP: /* LLess (Operand0, Operand1) */
663 if (compare > 0) {
664 goto cleanup; /* FALSE */
666 if (compare < 0) {
667 local_result = TRUE;
668 goto cleanup; /* TRUE */
671 /* Bytes match (to shortest length), compare lengths */
673 if (length0 < length1) {
674 local_result = TRUE;
676 break;
678 default:
679 status = AE_AML_INTERNAL;
680 break;
684 cleanup:
686 /* New object was created if implicit conversion performed - delete */
688 if (local_operand1 != operand1) {
689 acpi_ut_remove_reference(local_operand1);
692 /* Return the logical result and status */
694 *logical_result = local_result;
695 return_ACPI_STATUS(status);