i2c-eg20t: change timeout value 50msec to 1000msec
[zen-stable.git] / drivers / acpi / acpica / exconvrt.c
blobe385436bd42422ef81ad64ca2decfa9a14eaeae7
1 /******************************************************************************
3 * Module Name: exconvrt - Object conversion routines
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2012, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acinterp.h"
47 #include "amlcode.h"
49 #define _COMPONENT ACPI_EXECUTER
50 ACPI_MODULE_NAME("exconvrt")
52 /* Local prototypes */
53 static u32
54 acpi_ex_convert_to_ascii(u64 integer, u16 base, u8 *string, u8 max_length);
56 /*******************************************************************************
58 * FUNCTION: acpi_ex_convert_to_integer
60 * PARAMETERS: obj_desc - Object to be converted. Must be an
61 * Integer, Buffer, or String
62 * result_desc - Where the new Integer object is returned
63 * Flags - Used for string conversion
65 * RETURN: Status
67 * DESCRIPTION: Convert an ACPI Object to an integer.
69 ******************************************************************************/
71 acpi_status
72 acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
73 union acpi_operand_object **result_desc, u32 flags)
75 union acpi_operand_object *return_desc;
76 u8 *pointer;
77 u64 result;
78 u32 i;
79 u32 count;
80 acpi_status status;
82 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_integer, obj_desc);
84 switch (obj_desc->common.type) {
85 case ACPI_TYPE_INTEGER:
87 /* No conversion necessary */
89 *result_desc = obj_desc;
90 return_ACPI_STATUS(AE_OK);
92 case ACPI_TYPE_BUFFER:
93 case ACPI_TYPE_STRING:
95 /* Note: Takes advantage of common buffer/string fields */
97 pointer = obj_desc->buffer.pointer;
98 count = obj_desc->buffer.length;
99 break;
101 default:
102 return_ACPI_STATUS(AE_TYPE);
106 * Convert the buffer/string to an integer. Note that both buffers and
107 * strings are treated as raw data - we don't convert ascii to hex for
108 * strings.
110 * There are two terminating conditions for the loop:
111 * 1) The size of an integer has been reached, or
112 * 2) The end of the buffer or string has been reached
114 result = 0;
116 /* String conversion is different than Buffer conversion */
118 switch (obj_desc->common.type) {
119 case ACPI_TYPE_STRING:
122 * Convert string to an integer - for most cases, the string must be
123 * hexadecimal as per the ACPI specification. The only exception (as
124 * of ACPI 3.0) is that the to_integer() operator allows both decimal
125 * and hexadecimal strings (hex prefixed with "0x").
127 status = acpi_ut_strtoul64((char *)pointer, flags, &result);
128 if (ACPI_FAILURE(status)) {
129 return_ACPI_STATUS(status);
131 break;
133 case ACPI_TYPE_BUFFER:
135 /* Check for zero-length buffer */
137 if (!count) {
138 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
141 /* Transfer no more than an integer's worth of data */
143 if (count > acpi_gbl_integer_byte_width) {
144 count = acpi_gbl_integer_byte_width;
148 * Convert buffer to an integer - we simply grab enough raw data
149 * from the buffer to fill an integer
151 for (i = 0; i < count; i++) {
153 * Get next byte and shift it into the Result.
154 * Little endian is used, meaning that the first byte of the buffer
155 * is the LSB of the integer
157 result |= (((u64) pointer[i]) << (i * 8));
159 break;
161 default:
163 /* No other types can get here */
164 break;
167 /* Create a new integer */
169 return_desc = acpi_ut_create_integer_object(result);
170 if (!return_desc) {
171 return_ACPI_STATUS(AE_NO_MEMORY);
174 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
175 ACPI_FORMAT_UINT64(result)));
177 /* Save the Result */
179 acpi_ex_truncate_for32bit_table(return_desc);
180 *result_desc = return_desc;
181 return_ACPI_STATUS(AE_OK);
184 /*******************************************************************************
186 * FUNCTION: acpi_ex_convert_to_buffer
188 * PARAMETERS: obj_desc - Object to be converted. Must be an
189 * Integer, Buffer, or String
190 * result_desc - Where the new buffer object is returned
192 * RETURN: Status
194 * DESCRIPTION: Convert an ACPI Object to a Buffer
196 ******************************************************************************/
198 acpi_status
199 acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
200 union acpi_operand_object **result_desc)
202 union acpi_operand_object *return_desc;
203 u8 *new_buf;
205 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_buffer, obj_desc);
207 switch (obj_desc->common.type) {
208 case ACPI_TYPE_BUFFER:
210 /* No conversion necessary */
212 *result_desc = obj_desc;
213 return_ACPI_STATUS(AE_OK);
215 case ACPI_TYPE_INTEGER:
218 * Create a new Buffer object.
219 * Need enough space for one integer
221 return_desc =
222 acpi_ut_create_buffer_object(acpi_gbl_integer_byte_width);
223 if (!return_desc) {
224 return_ACPI_STATUS(AE_NO_MEMORY);
227 /* Copy the integer to the buffer, LSB first */
229 new_buf = return_desc->buffer.pointer;
230 ACPI_MEMCPY(new_buf,
231 &obj_desc->integer.value,
232 acpi_gbl_integer_byte_width);
233 break;
235 case ACPI_TYPE_STRING:
238 * Create a new Buffer object
239 * Size will be the string length
241 * NOTE: Add one to the string length to include the null terminator.
242 * The ACPI spec is unclear on this subject, but there is existing
243 * ASL/AML code that depends on the null being transferred to the new
244 * buffer.
246 return_desc = acpi_ut_create_buffer_object((acpi_size)
247 obj_desc->string.
248 length + 1);
249 if (!return_desc) {
250 return_ACPI_STATUS(AE_NO_MEMORY);
253 /* Copy the string to the buffer */
255 new_buf = return_desc->buffer.pointer;
256 ACPI_STRNCPY((char *)new_buf, (char *)obj_desc->string.pointer,
257 obj_desc->string.length);
258 break;
260 default:
261 return_ACPI_STATUS(AE_TYPE);
264 /* Mark buffer initialized */
266 return_desc->common.flags |= AOPOBJ_DATA_VALID;
267 *result_desc = return_desc;
268 return_ACPI_STATUS(AE_OK);
271 /*******************************************************************************
273 * FUNCTION: acpi_ex_convert_to_ascii
275 * PARAMETERS: Integer - Value to be converted
276 * Base - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
277 * String - Where the string is returned
278 * data_width - Size of data item to be converted, in bytes
280 * RETURN: Actual string length
282 * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
284 ******************************************************************************/
286 static u32
287 acpi_ex_convert_to_ascii(u64 integer, u16 base, u8 *string, u8 data_width)
289 u64 digit;
290 u32 i;
291 u32 j;
292 u32 k = 0;
293 u32 hex_length;
294 u32 decimal_length;
295 u32 remainder;
296 u8 supress_zeros;
298 ACPI_FUNCTION_ENTRY();
300 switch (base) {
301 case 10:
303 /* Setup max length for the decimal number */
305 switch (data_width) {
306 case 1:
307 decimal_length = ACPI_MAX8_DECIMAL_DIGITS;
308 break;
310 case 4:
311 decimal_length = ACPI_MAX32_DECIMAL_DIGITS;
312 break;
314 case 8:
315 default:
316 decimal_length = ACPI_MAX64_DECIMAL_DIGITS;
317 break;
320 supress_zeros = TRUE; /* No leading zeros */
321 remainder = 0;
323 for (i = decimal_length; i > 0; i--) {
325 /* Divide by nth factor of 10 */
327 digit = integer;
328 for (j = 0; j < i; j++) {
329 (void)acpi_ut_short_divide(digit, 10, &digit,
330 &remainder);
333 /* Handle leading zeros */
335 if (remainder != 0) {
336 supress_zeros = FALSE;
339 if (!supress_zeros) {
340 string[k] = (u8) (ACPI_ASCII_ZERO + remainder);
341 k++;
344 break;
346 case 16:
348 /* hex_length: 2 ascii hex chars per data byte */
350 hex_length = ACPI_MUL_2(data_width);
351 for (i = 0, j = (hex_length - 1); i < hex_length; i++, j--) {
353 /* Get one hex digit, most significant digits first */
355 string[k] =
356 (u8) acpi_ut_hex_to_ascii_char(integer,
357 ACPI_MUL_4(j));
358 k++;
360 break;
362 default:
363 return (0);
367 * Since leading zeros are suppressed, we must check for the case where
368 * the integer equals 0
370 * Finally, null terminate the string and return the length
372 if (!k) {
373 string[0] = ACPI_ASCII_ZERO;
374 k = 1;
377 string[k] = 0;
378 return ((u32) k);
381 /*******************************************************************************
383 * FUNCTION: acpi_ex_convert_to_string
385 * PARAMETERS: obj_desc - Object to be converted. Must be an
386 * Integer, Buffer, or String
387 * result_desc - Where the string object is returned
388 * Type - String flags (base and conversion type)
390 * RETURN: Status
392 * DESCRIPTION: Convert an ACPI Object to a string
394 ******************************************************************************/
396 acpi_status
397 acpi_ex_convert_to_string(union acpi_operand_object * obj_desc,
398 union acpi_operand_object ** result_desc, u32 type)
400 union acpi_operand_object *return_desc;
401 u8 *new_buf;
402 u32 i;
403 u32 string_length = 0;
404 u16 base = 16;
405 u8 separator = ',';
407 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_string, obj_desc);
409 switch (obj_desc->common.type) {
410 case ACPI_TYPE_STRING:
412 /* No conversion necessary */
414 *result_desc = obj_desc;
415 return_ACPI_STATUS(AE_OK);
417 case ACPI_TYPE_INTEGER:
419 switch (type) {
420 case ACPI_EXPLICIT_CONVERT_DECIMAL:
422 /* Make room for maximum decimal number */
424 string_length = ACPI_MAX_DECIMAL_DIGITS;
425 base = 10;
426 break;
428 default:
430 /* Two hex string characters for each integer byte */
432 string_length = ACPI_MUL_2(acpi_gbl_integer_byte_width);
433 break;
437 * Create a new String
438 * Need enough space for one ASCII integer (plus null terminator)
440 return_desc =
441 acpi_ut_create_string_object((acpi_size) string_length);
442 if (!return_desc) {
443 return_ACPI_STATUS(AE_NO_MEMORY);
446 new_buf = return_desc->buffer.pointer;
448 /* Convert integer to string */
450 string_length =
451 acpi_ex_convert_to_ascii(obj_desc->integer.value, base,
452 new_buf,
453 acpi_gbl_integer_byte_width);
455 /* Null terminate at the correct place */
457 return_desc->string.length = string_length;
458 new_buf[string_length] = 0;
459 break;
461 case ACPI_TYPE_BUFFER:
463 /* Setup string length, base, and separator */
465 switch (type) {
466 case ACPI_EXPLICIT_CONVERT_DECIMAL: /* Used by to_decimal_string */
468 * From ACPI: "If Data is a buffer, it is converted to a string of
469 * decimal values separated by commas."
471 base = 10;
474 * Calculate the final string length. Individual string values
475 * are variable length (include separator for each)
477 for (i = 0; i < obj_desc->buffer.length; i++) {
478 if (obj_desc->buffer.pointer[i] >= 100) {
479 string_length += 4;
480 } else if (obj_desc->buffer.pointer[i] >= 10) {
481 string_length += 3;
482 } else {
483 string_length += 2;
486 break;
488 case ACPI_IMPLICIT_CONVERT_HEX:
490 * From the ACPI spec:
491 *"The entire contents of the buffer are converted to a string of
492 * two-character hexadecimal numbers, each separated by a space."
494 separator = ' ';
495 string_length = (obj_desc->buffer.length * 3);
496 break;
498 case ACPI_EXPLICIT_CONVERT_HEX: /* Used by to_hex_string */
500 * From ACPI: "If Data is a buffer, it is converted to a string of
501 * hexadecimal values separated by commas."
503 string_length = (obj_desc->buffer.length * 3);
504 break;
506 default:
507 return_ACPI_STATUS(AE_BAD_PARAMETER);
511 * Create a new string object and string buffer
512 * (-1 because of extra separator included in string_length from above)
513 * Allow creation of zero-length strings from zero-length buffers.
515 if (string_length) {
516 string_length--;
519 return_desc = acpi_ut_create_string_object((acpi_size)
520 string_length);
521 if (!return_desc) {
522 return_ACPI_STATUS(AE_NO_MEMORY);
525 new_buf = return_desc->buffer.pointer;
528 * Convert buffer bytes to hex or decimal values
529 * (separated by commas or spaces)
531 for (i = 0; i < obj_desc->buffer.length; i++) {
532 new_buf += acpi_ex_convert_to_ascii((u64) obj_desc->
533 buffer.pointer[i],
534 base, new_buf, 1);
535 *new_buf++ = separator; /* each separated by a comma or space */
539 * Null terminate the string
540 * (overwrites final comma/space from above)
542 if (obj_desc->buffer.length) {
543 new_buf--;
545 *new_buf = 0;
546 break;
548 default:
549 return_ACPI_STATUS(AE_TYPE);
552 *result_desc = return_desc;
553 return_ACPI_STATUS(AE_OK);
556 /*******************************************************************************
558 * FUNCTION: acpi_ex_convert_to_target_type
560 * PARAMETERS: destination_type - Current type of the destination
561 * source_desc - Source object to be converted.
562 * result_desc - Where the converted object is returned
563 * walk_state - Current method state
565 * RETURN: Status
567 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
569 ******************************************************************************/
571 acpi_status
572 acpi_ex_convert_to_target_type(acpi_object_type destination_type,
573 union acpi_operand_object *source_desc,
574 union acpi_operand_object **result_desc,
575 struct acpi_walk_state *walk_state)
577 acpi_status status = AE_OK;
579 ACPI_FUNCTION_TRACE(ex_convert_to_target_type);
581 /* Default behavior */
583 *result_desc = source_desc;
586 * If required by the target,
587 * perform implicit conversion on the source before we store it.
589 switch (GET_CURRENT_ARG_TYPE(walk_state->op_info->runtime_args)) {
590 case ARGI_SIMPLE_TARGET:
591 case ARGI_FIXED_TARGET:
592 case ARGI_INTEGER_REF: /* Handles Increment, Decrement cases */
594 switch (destination_type) {
595 case ACPI_TYPE_LOCAL_REGION_FIELD:
597 * Named field can always handle conversions
599 break;
601 default:
602 /* No conversion allowed for these types */
604 if (destination_type != source_desc->common.type) {
605 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
606 "Explicit operator, will store (%s) over existing type (%s)\n",
607 acpi_ut_get_object_type_name
608 (source_desc),
609 acpi_ut_get_type_name
610 (destination_type)));
611 status = AE_TYPE;
614 break;
616 case ARGI_TARGETREF:
618 switch (destination_type) {
619 case ACPI_TYPE_INTEGER:
620 case ACPI_TYPE_BUFFER_FIELD:
621 case ACPI_TYPE_LOCAL_BANK_FIELD:
622 case ACPI_TYPE_LOCAL_INDEX_FIELD:
624 * These types require an Integer operand. We can convert
625 * a Buffer or a String to an Integer if necessary.
627 status =
628 acpi_ex_convert_to_integer(source_desc, result_desc,
629 16);
630 break;
632 case ACPI_TYPE_STRING:
634 * The operand must be a String. We can convert an
635 * Integer or Buffer if necessary
637 status =
638 acpi_ex_convert_to_string(source_desc, result_desc,
639 ACPI_IMPLICIT_CONVERT_HEX);
640 break;
642 case ACPI_TYPE_BUFFER:
644 * The operand must be a Buffer. We can convert an
645 * Integer or String if necessary
647 status =
648 acpi_ex_convert_to_buffer(source_desc, result_desc);
649 break;
651 default:
652 ACPI_ERROR((AE_INFO,
653 "Bad destination type during conversion: 0x%X",
654 destination_type));
655 status = AE_AML_INTERNAL;
656 break;
658 break;
660 case ARGI_REFERENCE:
662 * create_xxxx_field cases - we are storing the field object into the name
664 break;
666 default:
667 ACPI_ERROR((AE_INFO,
668 "Unknown Target type ID 0x%X AmlOpcode 0x%X DestType %s",
669 GET_CURRENT_ARG_TYPE(walk_state->op_info->
670 runtime_args),
671 walk_state->opcode,
672 acpi_ut_get_type_name(destination_type)));
673 status = AE_AML_INTERNAL;
677 * Source-to-Target conversion semantics:
679 * If conversion to the target type cannot be performed, then simply
680 * overwrite the target with the new object and type.
682 if (status == AE_TYPE) {
683 status = AE_OK;
686 return_ACPI_STATUS(status);