1 /******************************************************************************
3 * Module Name: exconvrt - Object conversion routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, 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 /* Save the Result */
175 return_desc
->integer
.value
= result
;
176 acpi_ex_truncate_for32bit_table(return_desc
);
177 *result_desc
= return_desc
;
178 return_ACPI_STATUS(AE_OK
);
181 /*******************************************************************************
183 * FUNCTION: acpi_ex_convert_to_buffer
185 * PARAMETERS: obj_desc - Object to be converted. Must be an
186 * Integer, Buffer, or String
187 * result_desc - Where the new buffer object is returned
191 * DESCRIPTION: Convert an ACPI Object to a Buffer
193 ******************************************************************************/
196 acpi_ex_convert_to_buffer(union acpi_operand_object
*obj_desc
,
197 union acpi_operand_object
**result_desc
)
199 union acpi_operand_object
*return_desc
;
202 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_buffer
, obj_desc
);
204 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
205 case ACPI_TYPE_BUFFER
:
207 /* No conversion necessary */
209 *result_desc
= obj_desc
;
210 return_ACPI_STATUS(AE_OK
);
212 case ACPI_TYPE_INTEGER
:
215 * Create a new Buffer object.
216 * Need enough space for one integer
219 acpi_ut_create_buffer_object(acpi_gbl_integer_byte_width
);
221 return_ACPI_STATUS(AE_NO_MEMORY
);
224 /* Copy the integer to the buffer, LSB first */
226 new_buf
= return_desc
->buffer
.pointer
;
228 &obj_desc
->integer
.value
,
229 acpi_gbl_integer_byte_width
);
232 case ACPI_TYPE_STRING
:
235 * Create a new Buffer object
236 * Size will be the string length
238 * NOTE: Add one to the string length to include the null terminator.
239 * The ACPI spec is unclear on this subject, but there is existing
240 * ASL/AML code that depends on the null being transferred to the new
243 return_desc
= acpi_ut_create_buffer_object((acpi_size
)
247 return_ACPI_STATUS(AE_NO_MEMORY
);
250 /* Copy the string to the buffer */
252 new_buf
= return_desc
->buffer
.pointer
;
253 ACPI_STRNCPY((char *)new_buf
, (char *)obj_desc
->string
.pointer
,
254 obj_desc
->string
.length
);
258 return_ACPI_STATUS(AE_TYPE
);
261 /* Mark buffer initialized */
263 return_desc
->common
.flags
|= AOPOBJ_DATA_VALID
;
264 *result_desc
= return_desc
;
265 return_ACPI_STATUS(AE_OK
);
268 /*******************************************************************************
270 * FUNCTION: acpi_ex_convert_to_ascii
272 * PARAMETERS: Integer - Value to be converted
273 * Base - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
274 * String - Where the string is returned
275 * data_width - Size of data item to be converted, in bytes
277 * RETURN: Actual string length
279 * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
281 ******************************************************************************/
284 acpi_ex_convert_to_ascii(acpi_integer integer
,
285 u16 base
, u8
* string
, u8 data_width
)
290 acpi_native_uint k
= 0;
291 acpi_native_uint hex_length
;
292 acpi_native_uint decimal_length
;
296 ACPI_FUNCTION_ENTRY();
301 /* Setup max length for the decimal number */
303 switch (data_width
) {
305 decimal_length
= ACPI_MAX8_DECIMAL_DIGITS
;
309 decimal_length
= ACPI_MAX32_DECIMAL_DIGITS
;
314 decimal_length
= ACPI_MAX64_DECIMAL_DIGITS
;
318 supress_zeros
= TRUE
; /* No leading zeros */
321 for (i
= decimal_length
; i
> 0; i
--) {
323 /* Divide by nth factor of 10 */
326 for (j
= 0; j
< i
; j
++) {
327 (void)acpi_ut_short_divide(digit
, 10, &digit
,
331 /* Handle leading zeros */
333 if (remainder
!= 0) {
334 supress_zeros
= FALSE
;
337 if (!supress_zeros
) {
338 string
[k
] = (u8
) (ACPI_ASCII_ZERO
+ remainder
);
346 /* hex_length: 2 ascii hex chars per data byte */
348 hex_length
= (acpi_native_uint
) ACPI_MUL_2(data_width
);
349 for (i
= 0, j
= (hex_length
- 1); i
< hex_length
; i
++, j
--) {
351 /* Get one hex digit, most significant digits first */
354 (u8
) acpi_ut_hex_to_ascii_char(integer
,
365 * Since leading zeros are supressed, we must check for the case where
366 * the integer equals 0
368 * Finally, null terminate the string and return the length
371 string
[0] = ACPI_ASCII_ZERO
;
379 /*******************************************************************************
381 * FUNCTION: acpi_ex_convert_to_string
383 * PARAMETERS: obj_desc - Object to be converted. Must be an
384 * Integer, Buffer, or String
385 * result_desc - Where the string object is returned
386 * Type - String flags (base and conversion type)
390 * DESCRIPTION: Convert an ACPI Object to a string
392 ******************************************************************************/
395 acpi_ex_convert_to_string(union acpi_operand_object
* obj_desc
,
396 union acpi_operand_object
** result_desc
, u32 type
)
398 union acpi_operand_object
*return_desc
;
401 u32 string_length
= 0;
405 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_string
, obj_desc
);
407 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
408 case ACPI_TYPE_STRING
:
410 /* No conversion necessary */
412 *result_desc
= obj_desc
;
413 return_ACPI_STATUS(AE_OK
);
415 case ACPI_TYPE_INTEGER
:
418 case ACPI_EXPLICIT_CONVERT_DECIMAL
:
420 /* Make room for maximum decimal number */
422 string_length
= ACPI_MAX_DECIMAL_DIGITS
;
428 /* Two hex string characters for each integer byte */
430 string_length
= ACPI_MUL_2(acpi_gbl_integer_byte_width
);
435 * Create a new String
436 * Need enough space for one ASCII integer (plus null terminator)
439 acpi_ut_create_string_object((acpi_size
) string_length
);
441 return_ACPI_STATUS(AE_NO_MEMORY
);
444 new_buf
= return_desc
->buffer
.pointer
;
446 /* Convert integer to string */
449 acpi_ex_convert_to_ascii(obj_desc
->integer
.value
, base
,
451 acpi_gbl_integer_byte_width
);
453 /* Null terminate at the correct place */
455 return_desc
->string
.length
= string_length
;
456 new_buf
[string_length
] = 0;
459 case ACPI_TYPE_BUFFER
:
461 /* Setup string length, base, and separator */
464 case ACPI_EXPLICIT_CONVERT_DECIMAL
: /* Used by to_decimal_string */
466 * From ACPI: "If Data is a buffer, it is converted to a string of
467 * decimal values separated by commas."
472 * Calculate the final string length. Individual string values
473 * are variable length (include separator for each)
475 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
476 if (obj_desc
->buffer
.pointer
[i
] >= 100) {
478 } else if (obj_desc
->buffer
.pointer
[i
] >= 10) {
486 case ACPI_IMPLICIT_CONVERT_HEX
:
488 * From the ACPI spec:
489 *"The entire contents of the buffer are converted to a string of
490 * two-character hexadecimal numbers, each separated by a space."
493 string_length
= (obj_desc
->buffer
.length
* 3);
496 case ACPI_EXPLICIT_CONVERT_HEX
: /* Used by to_hex_string */
498 * From ACPI: "If Data is a buffer, it is converted to a string of
499 * hexadecimal values separated by commas."
501 string_length
= (obj_desc
->buffer
.length
* 3);
505 return_ACPI_STATUS(AE_BAD_PARAMETER
);
509 * Create a new string object and string buffer
510 * (-1 because of extra separator included in string_length from above)
513 acpi_ut_create_string_object((acpi_size
)
514 (string_length
- 1));
516 return_ACPI_STATUS(AE_NO_MEMORY
);
519 new_buf
= return_desc
->buffer
.pointer
;
522 * Convert buffer bytes to hex or decimal values
523 * (separated by commas or spaces)
525 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
526 new_buf
+= acpi_ex_convert_to_ascii((acpi_integer
)
530 *new_buf
++ = separator
; /* each separated by a comma or space */
534 * Null terminate the string
535 * (overwrites final comma/space from above)
542 return_ACPI_STATUS(AE_TYPE
);
545 *result_desc
= return_desc
;
546 return_ACPI_STATUS(AE_OK
);
549 /*******************************************************************************
551 * FUNCTION: acpi_ex_convert_to_target_type
553 * PARAMETERS: destination_type - Current type of the destination
554 * source_desc - Source object to be converted.
555 * result_desc - Where the converted object is returned
556 * walk_state - Current method state
560 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
562 ******************************************************************************/
565 acpi_ex_convert_to_target_type(acpi_object_type destination_type
,
566 union acpi_operand_object
*source_desc
,
567 union acpi_operand_object
**result_desc
,
568 struct acpi_walk_state
*walk_state
)
570 acpi_status status
= AE_OK
;
572 ACPI_FUNCTION_TRACE(ex_convert_to_target_type
);
574 /* Default behavior */
576 *result_desc
= source_desc
;
579 * If required by the target,
580 * perform implicit conversion on the source before we store it.
582 switch (GET_CURRENT_ARG_TYPE(walk_state
->op_info
->runtime_args
)) {
583 case ARGI_SIMPLE_TARGET
:
584 case ARGI_FIXED_TARGET
:
585 case ARGI_INTEGER_REF
: /* Handles Increment, Decrement cases */
587 switch (destination_type
) {
588 case ACPI_TYPE_LOCAL_REGION_FIELD
:
590 * Named field can always handle conversions
595 /* No conversion allowed for these types */
597 if (destination_type
!=
598 ACPI_GET_OBJECT_TYPE(source_desc
)) {
599 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
600 "Explicit operator, will store (%s) over existing type (%s)\n",
601 acpi_ut_get_object_type_name
603 acpi_ut_get_type_name
604 (destination_type
)));
612 switch (destination_type
) {
613 case ACPI_TYPE_INTEGER
:
614 case ACPI_TYPE_BUFFER_FIELD
:
615 case ACPI_TYPE_LOCAL_BANK_FIELD
:
616 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
618 * These types require an Integer operand. We can convert
619 * a Buffer or a String to an Integer if necessary.
622 acpi_ex_convert_to_integer(source_desc
, result_desc
,
626 case ACPI_TYPE_STRING
:
628 * The operand must be a String. We can convert an
629 * Integer or Buffer if necessary
632 acpi_ex_convert_to_string(source_desc
, result_desc
,
633 ACPI_IMPLICIT_CONVERT_HEX
);
636 case ACPI_TYPE_BUFFER
:
638 * The operand must be a Buffer. We can convert an
639 * Integer or String if necessary
642 acpi_ex_convert_to_buffer(source_desc
, result_desc
);
647 "Bad destination type during conversion: %X",
649 status
= AE_AML_INTERNAL
;
656 * create_xxxx_field cases - we are storing the field object into the name
662 "Unknown Target type ID 0x%X AmlOpcode %X DestType %s",
663 GET_CURRENT_ARG_TYPE(walk_state
->op_info
->
666 acpi_ut_get_type_name(destination_type
)));
667 status
= AE_AML_INTERNAL
;
671 * Source-to-Target conversion semantics:
673 * If conversion to the target type cannot be performed, then simply
674 * overwrite the target with the new object and type.
676 if (status
== AE_TYPE
) {
680 return_ACPI_STATUS(status
);