1 /******************************************************************************
3 * Module Name: exconvrt - Object conversion routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, 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.
44 #include <acpi/acpi.h>
45 #include <acpi/acinterp.h>
46 #include <acpi/amlcode.h>
48 #define _COMPONENT ACPI_EXECUTER
49 ACPI_MODULE_NAME("exconvrt")
51 /* Local prototypes */
53 acpi_ex_convert_to_ascii(acpi_integer integer
,
54 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
67 * DESCRIPTION: Convert an ACPI Object to an integer.
69 ******************************************************************************/
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
;
82 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_integer
, obj_desc
);
84 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
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
;
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
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
116 /* String conversion is different than Buffer conversion */
118 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
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
);
133 case ACPI_TYPE_BUFFER
:
135 /* Check for zero-length buffer */
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
|= (((acpi_integer
) pointer
[i
]) << (i
* 8));
162 /* No other types can get here */
166 /* Create a new integer */
168 return_desc
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
170 return_ACPI_STATUS(AE_NO_MEMORY
);
173 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Converted value: %8.8X%8.8X\n",
174 ACPI_FORMAT_UINT64(result
)));
176 /* Save the Result */
178 return_desc
->integer
.value
= 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
194 * DESCRIPTION: Convert an ACPI Object to a Buffer
196 ******************************************************************************/
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
;
205 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_buffer
, obj_desc
);
207 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
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
222 acpi_ut_create_buffer_object(acpi_gbl_integer_byte_width
);
224 return_ACPI_STATUS(AE_NO_MEMORY
);
227 /* Copy the integer to the buffer, LSB first */
229 new_buf
= return_desc
->buffer
.pointer
;
231 &obj_desc
->integer
.value
,
232 acpi_gbl_integer_byte_width
);
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
246 return_desc
= acpi_ut_create_buffer_object((acpi_size
)
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
);
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 ******************************************************************************/
287 acpi_ex_convert_to_ascii(acpi_integer integer
,
288 u16 base
, u8
* string
, u8 data_width
)
293 acpi_native_uint k
= 0;
294 acpi_native_uint hex_length
;
295 acpi_native_uint decimal_length
;
299 ACPI_FUNCTION_ENTRY();
304 /* Setup max length for the decimal number */
306 switch (data_width
) {
308 decimal_length
= ACPI_MAX8_DECIMAL_DIGITS
;
312 decimal_length
= ACPI_MAX32_DECIMAL_DIGITS
;
317 decimal_length
= ACPI_MAX64_DECIMAL_DIGITS
;
321 supress_zeros
= TRUE
; /* No leading zeros */
324 for (i
= decimal_length
; i
> 0; i
--) {
326 /* Divide by nth factor of 10 */
329 for (j
= 0; j
< i
; j
++) {
330 (void)acpi_ut_short_divide(digit
, 10, &digit
,
334 /* Handle leading zeros */
336 if (remainder
!= 0) {
337 supress_zeros
= FALSE
;
340 if (!supress_zeros
) {
341 string
[k
] = (u8
) (ACPI_ASCII_ZERO
+ remainder
);
349 /* hex_length: 2 ascii hex chars per data byte */
351 hex_length
= (acpi_native_uint
) ACPI_MUL_2(data_width
);
352 for (i
= 0, j
= (hex_length
- 1); i
< hex_length
; i
++, j
--) {
354 /* Get one hex digit, most significant digits first */
357 (u8
) acpi_ut_hex_to_ascii_char(integer
,
368 * Since leading zeros are supressed, we must check for the case where
369 * the integer equals 0
371 * Finally, null terminate the string and return the length
374 string
[0] = ACPI_ASCII_ZERO
;
382 /*******************************************************************************
384 * FUNCTION: acpi_ex_convert_to_string
386 * PARAMETERS: obj_desc - Object to be converted. Must be an
387 * Integer, Buffer, or String
388 * result_desc - Where the string object is returned
389 * Type - String flags (base and conversion type)
393 * DESCRIPTION: Convert an ACPI Object to a string
395 ******************************************************************************/
398 acpi_ex_convert_to_string(union acpi_operand_object
* obj_desc
,
399 union acpi_operand_object
** result_desc
, u32 type
)
401 union acpi_operand_object
*return_desc
;
404 u32 string_length
= 0;
408 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_string
, obj_desc
);
410 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
411 case ACPI_TYPE_STRING
:
413 /* No conversion necessary */
415 *result_desc
= obj_desc
;
416 return_ACPI_STATUS(AE_OK
);
418 case ACPI_TYPE_INTEGER
:
421 case ACPI_EXPLICIT_CONVERT_DECIMAL
:
423 /* Make room for maximum decimal number */
425 string_length
= ACPI_MAX_DECIMAL_DIGITS
;
431 /* Two hex string characters for each integer byte */
433 string_length
= ACPI_MUL_2(acpi_gbl_integer_byte_width
);
438 * Create a new String
439 * Need enough space for one ASCII integer (plus null terminator)
442 acpi_ut_create_string_object((acpi_size
) string_length
);
444 return_ACPI_STATUS(AE_NO_MEMORY
);
447 new_buf
= return_desc
->buffer
.pointer
;
449 /* Convert integer to string */
452 acpi_ex_convert_to_ascii(obj_desc
->integer
.value
, base
,
454 acpi_gbl_integer_byte_width
);
456 /* Null terminate at the correct place */
458 return_desc
->string
.length
= string_length
;
459 new_buf
[string_length
] = 0;
462 case ACPI_TYPE_BUFFER
:
464 /* Setup string length, base, and separator */
467 case ACPI_EXPLICIT_CONVERT_DECIMAL
: /* Used by to_decimal_string */
469 * From ACPI: "If Data is a buffer, it is converted to a string of
470 * decimal values separated by commas."
475 * Calculate the final string length. Individual string values
476 * are variable length (include separator for each)
478 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
479 if (obj_desc
->buffer
.pointer
[i
] >= 100) {
481 } else if (obj_desc
->buffer
.pointer
[i
] >= 10) {
489 case ACPI_IMPLICIT_CONVERT_HEX
:
491 * From the ACPI spec:
492 *"The entire contents of the buffer are converted to a string of
493 * two-character hexadecimal numbers, each separated by a space."
496 string_length
= (obj_desc
->buffer
.length
* 3);
499 case ACPI_EXPLICIT_CONVERT_HEX
: /* Used by to_hex_string */
501 * From ACPI: "If Data is a buffer, it is converted to a string of
502 * hexadecimal values separated by commas."
504 string_length
= (obj_desc
->buffer
.length
* 3);
508 return_ACPI_STATUS(AE_BAD_PARAMETER
);
512 * Create a new string object and string buffer
513 * (-1 because of extra separator included in string_length from above)
515 return_desc
= acpi_ut_create_string_object((acpi_size
)
516 (string_length
- 1));
518 return_ACPI_STATUS(AE_NO_MEMORY
);
521 new_buf
= return_desc
->buffer
.pointer
;
524 * Convert buffer bytes to hex or decimal values
525 * (separated by commas or spaces)
527 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
528 new_buf
+= acpi_ex_convert_to_ascii((acpi_integer
)
532 *new_buf
++ = separator
; /* each separated by a comma or space */
536 * Null terminate the string
537 * (overwrites final comma/space from above)
544 return_ACPI_STATUS(AE_TYPE
);
547 *result_desc
= return_desc
;
548 return_ACPI_STATUS(AE_OK
);
551 /*******************************************************************************
553 * FUNCTION: acpi_ex_convert_to_target_type
555 * PARAMETERS: destination_type - Current type of the destination
556 * source_desc - Source object to be converted.
557 * result_desc - Where the converted object is returned
558 * walk_state - Current method state
562 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
564 ******************************************************************************/
567 acpi_ex_convert_to_target_type(acpi_object_type destination_type
,
568 union acpi_operand_object
*source_desc
,
569 union acpi_operand_object
**result_desc
,
570 struct acpi_walk_state
*walk_state
)
572 acpi_status status
= AE_OK
;
574 ACPI_FUNCTION_TRACE(ex_convert_to_target_type
);
576 /* Default behavior */
578 *result_desc
= source_desc
;
581 * If required by the target,
582 * perform implicit conversion on the source before we store it.
584 switch (GET_CURRENT_ARG_TYPE(walk_state
->op_info
->runtime_args
)) {
585 case ARGI_SIMPLE_TARGET
:
586 case ARGI_FIXED_TARGET
:
587 case ARGI_INTEGER_REF
: /* Handles Increment, Decrement cases */
589 switch (destination_type
) {
590 case ACPI_TYPE_LOCAL_REGION_FIELD
:
592 * Named field can always handle conversions
597 /* No conversion allowed for these types */
599 if (destination_type
!=
600 ACPI_GET_OBJECT_TYPE(source_desc
)) {
601 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
602 "Explicit operator, will store (%s) over existing type (%s)\n",
603 acpi_ut_get_object_type_name
605 acpi_ut_get_type_name
606 (destination_type
)));
614 switch (destination_type
) {
615 case ACPI_TYPE_INTEGER
:
616 case ACPI_TYPE_BUFFER_FIELD
:
617 case ACPI_TYPE_LOCAL_BANK_FIELD
:
618 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
620 * These types require an Integer operand. We can convert
621 * a Buffer or a String to an Integer if necessary.
624 acpi_ex_convert_to_integer(source_desc
, result_desc
,
628 case ACPI_TYPE_STRING
:
630 * The operand must be a String. We can convert an
631 * Integer or Buffer if necessary
634 acpi_ex_convert_to_string(source_desc
, result_desc
,
635 ACPI_IMPLICIT_CONVERT_HEX
);
638 case ACPI_TYPE_BUFFER
:
640 * The operand must be a Buffer. We can convert an
641 * Integer or String if necessary
644 acpi_ex_convert_to_buffer(source_desc
, result_desc
);
649 "Bad destination type during conversion: %X",
651 status
= AE_AML_INTERNAL
;
658 * create_xxxx_field cases - we are storing the field object into the name
664 "Unknown Target type ID 0x%X AmlOpcode %X DestType %s",
665 GET_CURRENT_ARG_TYPE(walk_state
->op_info
->
668 acpi_ut_get_type_name(destination_type
)));
669 status
= AE_AML_INTERNAL
;
673 * Source-to-Target conversion semantics:
675 * If conversion to the target type cannot be performed, then simply
676 * overwrite the target with the new object and type.
678 if (status
== AE_TYPE
) {
682 return_ACPI_STATUS(status
);