1 /******************************************************************************
3 * Module Name: exconvrt - Object conversion routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
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>
49 #define _COMPONENT ACPI_EXECUTER
50 ACPI_MODULE_NAME("exconvrt")
52 /* Local prototypes */
54 acpi_ex_convert_to_ascii(acpi_integer integer
,
55 u16 base
, u8
* string
, u8 max_length
);
57 /*******************************************************************************
59 * FUNCTION: acpi_ex_convert_to_integer
61 * PARAMETERS: obj_desc - Object to be converted. Must be an
62 * Integer, Buffer, or String
63 * result_desc - Where the new Integer object is returned
64 * Flags - Used for string conversion
68 * DESCRIPTION: Convert an ACPI Object to an integer.
70 ******************************************************************************/
73 acpi_ex_convert_to_integer(union acpi_operand_object
*obj_desc
,
74 union acpi_operand_object
**result_desc
, u32 flags
)
76 union acpi_operand_object
*return_desc
;
83 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_integer
, obj_desc
);
85 switch (obj_desc
->common
.type
) {
86 case ACPI_TYPE_INTEGER
:
88 /* No conversion necessary */
90 *result_desc
= obj_desc
;
91 return_ACPI_STATUS(AE_OK
);
93 case ACPI_TYPE_BUFFER
:
94 case ACPI_TYPE_STRING
:
96 /* Note: Takes advantage of common buffer/string fields */
98 pointer
= obj_desc
->buffer
.pointer
;
99 count
= obj_desc
->buffer
.length
;
103 return_ACPI_STATUS(AE_TYPE
);
107 * Convert the buffer/string to an integer. Note that both buffers and
108 * strings are treated as raw data - we don't convert ascii to hex for
111 * There are two terminating conditions for the loop:
112 * 1) The size of an integer has been reached, or
113 * 2) The end of the buffer or string has been reached
117 /* String conversion is different than Buffer conversion */
119 switch (obj_desc
->common
.type
) {
120 case ACPI_TYPE_STRING
:
123 * Convert string to an integer - for most cases, the string must be
124 * hexadecimal as per the ACPI specification. The only exception (as
125 * of ACPI 3.0) is that the to_integer() operator allows both decimal
126 * and hexadecimal strings (hex prefixed with "0x").
128 status
= acpi_ut_strtoul64((char *)pointer
, flags
, &result
);
129 if (ACPI_FAILURE(status
)) {
130 return_ACPI_STATUS(status
);
134 case ACPI_TYPE_BUFFER
:
136 /* Check for zero-length buffer */
139 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT
);
142 /* Transfer no more than an integer's worth of data */
144 if (count
> acpi_gbl_integer_byte_width
) {
145 count
= acpi_gbl_integer_byte_width
;
149 * Convert buffer to an integer - we simply grab enough raw data
150 * from the buffer to fill an integer
152 for (i
= 0; i
< count
; i
++) {
154 * Get next byte and shift it into the Result.
155 * Little endian is used, meaning that the first byte of the buffer
156 * is the LSB of the integer
158 result
|= (((acpi_integer
) pointer
[i
]) << (i
* 8));
164 /* No other types can get here */
168 /* Create a new integer */
170 return_desc
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
172 return_ACPI_STATUS(AE_NO_MEMORY
);
175 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Converted value: %8.8X%8.8X\n",
176 ACPI_FORMAT_UINT64(result
)));
178 /* Save the Result */
180 return_desc
->integer
.value
= result
;
181 acpi_ex_truncate_for32bit_table(return_desc
);
182 *result_desc
= return_desc
;
183 return_ACPI_STATUS(AE_OK
);
186 /*******************************************************************************
188 * FUNCTION: acpi_ex_convert_to_buffer
190 * PARAMETERS: obj_desc - Object to be converted. Must be an
191 * Integer, Buffer, or String
192 * result_desc - Where the new buffer object is returned
196 * DESCRIPTION: Convert an ACPI Object to a Buffer
198 ******************************************************************************/
201 acpi_ex_convert_to_buffer(union acpi_operand_object
*obj_desc
,
202 union acpi_operand_object
**result_desc
)
204 union acpi_operand_object
*return_desc
;
207 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_buffer
, obj_desc
);
209 switch (obj_desc
->common
.type
) {
210 case ACPI_TYPE_BUFFER
:
212 /* No conversion necessary */
214 *result_desc
= obj_desc
;
215 return_ACPI_STATUS(AE_OK
);
217 case ACPI_TYPE_INTEGER
:
220 * Create a new Buffer object.
221 * Need enough space for one integer
224 acpi_ut_create_buffer_object(acpi_gbl_integer_byte_width
);
226 return_ACPI_STATUS(AE_NO_MEMORY
);
229 /* Copy the integer to the buffer, LSB first */
231 new_buf
= return_desc
->buffer
.pointer
;
233 &obj_desc
->integer
.value
,
234 acpi_gbl_integer_byte_width
);
237 case ACPI_TYPE_STRING
:
240 * Create a new Buffer object
241 * Size will be the string length
243 * NOTE: Add one to the string length to include the null terminator.
244 * The ACPI spec is unclear on this subject, but there is existing
245 * ASL/AML code that depends on the null being transferred to the new
248 return_desc
= acpi_ut_create_buffer_object((acpi_size
)
252 return_ACPI_STATUS(AE_NO_MEMORY
);
255 /* Copy the string to the buffer */
257 new_buf
= return_desc
->buffer
.pointer
;
258 ACPI_STRNCPY((char *)new_buf
, (char *)obj_desc
->string
.pointer
,
259 obj_desc
->string
.length
);
263 return_ACPI_STATUS(AE_TYPE
);
266 /* Mark buffer initialized */
268 return_desc
->common
.flags
|= AOPOBJ_DATA_VALID
;
269 *result_desc
= return_desc
;
270 return_ACPI_STATUS(AE_OK
);
273 /*******************************************************************************
275 * FUNCTION: acpi_ex_convert_to_ascii
277 * PARAMETERS: Integer - Value to be converted
278 * Base - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
279 * String - Where the string is returned
280 * data_width - Size of data item to be converted, in bytes
282 * RETURN: Actual string length
284 * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
286 ******************************************************************************/
289 acpi_ex_convert_to_ascii(acpi_integer integer
,
290 u16 base
, u8
* string
, u8 data_width
)
301 ACPI_FUNCTION_ENTRY();
306 /* Setup max length for the decimal number */
308 switch (data_width
) {
310 decimal_length
= ACPI_MAX8_DECIMAL_DIGITS
;
314 decimal_length
= ACPI_MAX32_DECIMAL_DIGITS
;
319 decimal_length
= ACPI_MAX64_DECIMAL_DIGITS
;
323 supress_zeros
= TRUE
; /* No leading zeros */
326 for (i
= decimal_length
; i
> 0; i
--) {
328 /* Divide by nth factor of 10 */
331 for (j
= 0; j
< i
; j
++) {
332 (void)acpi_ut_short_divide(digit
, 10, &digit
,
336 /* Handle leading zeros */
338 if (remainder
!= 0) {
339 supress_zeros
= FALSE
;
342 if (!supress_zeros
) {
343 string
[k
] = (u8
) (ACPI_ASCII_ZERO
+ remainder
);
351 /* hex_length: 2 ascii hex chars per data byte */
353 hex_length
= ACPI_MUL_2(data_width
);
354 for (i
= 0, j
= (hex_length
- 1); i
< hex_length
; i
++, j
--) {
356 /* Get one hex digit, most significant digits first */
359 (u8
) acpi_ut_hex_to_ascii_char(integer
,
370 * Since leading zeros are suppressed, we must check for the case where
371 * the integer equals 0
373 * Finally, null terminate the string and return the length
376 string
[0] = ACPI_ASCII_ZERO
;
384 /*******************************************************************************
386 * FUNCTION: acpi_ex_convert_to_string
388 * PARAMETERS: obj_desc - Object to be converted. Must be an
389 * Integer, Buffer, or String
390 * result_desc - Where the string object is returned
391 * Type - String flags (base and conversion type)
395 * DESCRIPTION: Convert an ACPI Object to a string
397 ******************************************************************************/
400 acpi_ex_convert_to_string(union acpi_operand_object
* obj_desc
,
401 union acpi_operand_object
** result_desc
, u32 type
)
403 union acpi_operand_object
*return_desc
;
406 u32 string_length
= 0;
410 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_string
, obj_desc
);
412 switch (obj_desc
->common
.type
) {
413 case ACPI_TYPE_STRING
:
415 /* No conversion necessary */
417 *result_desc
= obj_desc
;
418 return_ACPI_STATUS(AE_OK
);
420 case ACPI_TYPE_INTEGER
:
423 case ACPI_EXPLICIT_CONVERT_DECIMAL
:
425 /* Make room for maximum decimal number */
427 string_length
= ACPI_MAX_DECIMAL_DIGITS
;
433 /* Two hex string characters for each integer byte */
435 string_length
= ACPI_MUL_2(acpi_gbl_integer_byte_width
);
440 * Create a new String
441 * Need enough space for one ASCII integer (plus null terminator)
444 acpi_ut_create_string_object((acpi_size
) string_length
);
446 return_ACPI_STATUS(AE_NO_MEMORY
);
449 new_buf
= return_desc
->buffer
.pointer
;
451 /* Convert integer to string */
454 acpi_ex_convert_to_ascii(obj_desc
->integer
.value
, base
,
456 acpi_gbl_integer_byte_width
);
458 /* Null terminate at the correct place */
460 return_desc
->string
.length
= string_length
;
461 new_buf
[string_length
] = 0;
464 case ACPI_TYPE_BUFFER
:
466 /* Setup string length, base, and separator */
469 case ACPI_EXPLICIT_CONVERT_DECIMAL
: /* Used by to_decimal_string */
471 * From ACPI: "If Data is a buffer, it is converted to a string of
472 * decimal values separated by commas."
477 * Calculate the final string length. Individual string values
478 * are variable length (include separator for each)
480 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
481 if (obj_desc
->buffer
.pointer
[i
] >= 100) {
483 } else if (obj_desc
->buffer
.pointer
[i
] >= 10) {
491 case ACPI_IMPLICIT_CONVERT_HEX
:
493 * From the ACPI spec:
494 *"The entire contents of the buffer are converted to a string of
495 * two-character hexadecimal numbers, each separated by a space."
498 string_length
= (obj_desc
->buffer
.length
* 3);
501 case ACPI_EXPLICIT_CONVERT_HEX
: /* Used by to_hex_string */
503 * From ACPI: "If Data is a buffer, it is converted to a string of
504 * hexadecimal values separated by commas."
506 string_length
= (obj_desc
->buffer
.length
* 3);
510 return_ACPI_STATUS(AE_BAD_PARAMETER
);
514 * Create a new string object and string buffer
515 * (-1 because of extra separator included in string_length from above)
516 * Allow creation of zero-length strings from zero-length buffers.
522 return_desc
= acpi_ut_create_string_object((acpi_size
)
525 return_ACPI_STATUS(AE_NO_MEMORY
);
528 new_buf
= return_desc
->buffer
.pointer
;
531 * Convert buffer bytes to hex or decimal values
532 * (separated by commas or spaces)
534 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
535 new_buf
+= acpi_ex_convert_to_ascii((acpi_integer
)
539 *new_buf
++ = separator
; /* each separated by a comma or space */
543 * Null terminate the string
544 * (overwrites final comma/space from above)
546 if (obj_desc
->buffer
.length
) {
553 return_ACPI_STATUS(AE_TYPE
);
556 *result_desc
= return_desc
;
557 return_ACPI_STATUS(AE_OK
);
560 /*******************************************************************************
562 * FUNCTION: acpi_ex_convert_to_target_type
564 * PARAMETERS: destination_type - Current type of the destination
565 * source_desc - Source object to be converted.
566 * result_desc - Where the converted object is returned
567 * walk_state - Current method state
571 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
573 ******************************************************************************/
576 acpi_ex_convert_to_target_type(acpi_object_type destination_type
,
577 union acpi_operand_object
*source_desc
,
578 union acpi_operand_object
**result_desc
,
579 struct acpi_walk_state
*walk_state
)
581 acpi_status status
= AE_OK
;
583 ACPI_FUNCTION_TRACE(ex_convert_to_target_type
);
585 /* Default behavior */
587 *result_desc
= source_desc
;
590 * If required by the target,
591 * perform implicit conversion on the source before we store it.
593 switch (GET_CURRENT_ARG_TYPE(walk_state
->op_info
->runtime_args
)) {
594 case ARGI_SIMPLE_TARGET
:
595 case ARGI_FIXED_TARGET
:
596 case ARGI_INTEGER_REF
: /* Handles Increment, Decrement cases */
598 switch (destination_type
) {
599 case ACPI_TYPE_LOCAL_REGION_FIELD
:
601 * Named field can always handle conversions
606 /* No conversion allowed for these types */
608 if (destination_type
!= source_desc
->common
.type
) {
609 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
610 "Explicit operator, will store (%s) over existing type (%s)\n",
611 acpi_ut_get_object_type_name
613 acpi_ut_get_type_name
614 (destination_type
)));
622 switch (destination_type
) {
623 case ACPI_TYPE_INTEGER
:
624 case ACPI_TYPE_BUFFER_FIELD
:
625 case ACPI_TYPE_LOCAL_BANK_FIELD
:
626 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
628 * These types require an Integer operand. We can convert
629 * a Buffer or a String to an Integer if necessary.
632 acpi_ex_convert_to_integer(source_desc
, result_desc
,
636 case ACPI_TYPE_STRING
:
638 * The operand must be a String. We can convert an
639 * Integer or Buffer if necessary
642 acpi_ex_convert_to_string(source_desc
, result_desc
,
643 ACPI_IMPLICIT_CONVERT_HEX
);
646 case ACPI_TYPE_BUFFER
:
648 * The operand must be a Buffer. We can convert an
649 * Integer or String if necessary
652 acpi_ex_convert_to_buffer(source_desc
, result_desc
);
657 "Bad destination type during conversion: %X",
659 status
= AE_AML_INTERNAL
;
666 * create_xxxx_field cases - we are storing the field object into the name
672 "Unknown Target type ID 0x%X AmlOpcode %X DestType %s",
673 GET_CURRENT_ARG_TYPE(walk_state
->op_info
->
676 acpi_ut_get_type_name(destination_type
)));
677 status
= AE_AML_INTERNAL
;
681 * Source-to-Target conversion semantics:
683 * If conversion to the target type cannot be performed, then simply
684 * overwrite the target with the new object and type.
686 if (status
== AE_TYPE
) {
690 return_ACPI_STATUS(status
);