1 /******************************************************************************
3 * Module Name: exconvrt - Object conversion routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, 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(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
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 (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
;
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
:
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
|= (((u64
) pointer
[i
]) << (i
* 8));
163 /* No other types can get here */
168 /* Create a new integer */
170 return_desc
= acpi_ut_create_integer_object(result
);
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 (void)acpi_ex_truncate_for32bit_table(return_desc
);
181 *result_desc
= return_desc
;
182 return_ACPI_STATUS(AE_OK
);
185 /*******************************************************************************
187 * FUNCTION: acpi_ex_convert_to_buffer
189 * PARAMETERS: obj_desc - Object to be converted. Must be an
190 * Integer, Buffer, or String
191 * result_desc - Where the new buffer object is returned
195 * DESCRIPTION: Convert an ACPI Object to a Buffer
197 ******************************************************************************/
200 acpi_ex_convert_to_buffer(union acpi_operand_object
*obj_desc
,
201 union acpi_operand_object
**result_desc
)
203 union acpi_operand_object
*return_desc
;
206 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_buffer
, obj_desc
);
208 switch (obj_desc
->common
.type
) {
209 case ACPI_TYPE_BUFFER
:
211 /* No conversion necessary */
213 *result_desc
= obj_desc
;
214 return_ACPI_STATUS(AE_OK
);
216 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
, acpi_gbl_integer_byte_width
);
234 case ACPI_TYPE_STRING
:
236 * Create a new Buffer object
237 * Size will be the string length
239 * NOTE: Add one to the string length to include the null terminator.
240 * The ACPI spec is unclear on this subject, but there is existing
241 * ASL/AML code that depends on the null being transferred to the new
244 return_desc
= acpi_ut_create_buffer_object((acpi_size
)
248 return_ACPI_STATUS(AE_NO_MEMORY
);
251 /* Copy the string to the buffer */
253 new_buf
= return_desc
->buffer
.pointer
;
254 strncpy((char *)new_buf
, (char *)obj_desc
->string
.pointer
,
255 obj_desc
->string
.length
);
260 return_ACPI_STATUS(AE_TYPE
);
263 /* Mark buffer initialized */
265 return_desc
->common
.flags
|= AOPOBJ_DATA_VALID
;
266 *result_desc
= return_desc
;
267 return_ACPI_STATUS(AE_OK
);
270 /*******************************************************************************
272 * FUNCTION: acpi_ex_convert_to_ascii
274 * PARAMETERS: integer - Value to be converted
275 * base - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
276 * string - Where the string is returned
277 * data_width - Size of data item to be converted, in bytes
279 * RETURN: Actual string length
281 * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
283 ******************************************************************************/
286 acpi_ex_convert_to_ascii(u64 integer
, u16 base
, u8
*string
, u8 data_width
)
297 ACPI_FUNCTION_ENTRY();
302 /* Setup max length for the decimal number */
304 switch (data_width
) {
307 decimal_length
= ACPI_MAX8_DECIMAL_DIGITS
;
312 decimal_length
= ACPI_MAX32_DECIMAL_DIGITS
;
318 decimal_length
= ACPI_MAX64_DECIMAL_DIGITS
;
322 supress_zeros
= TRUE
; /* No leading zeros */
325 for (i
= decimal_length
; i
> 0; i
--) {
327 /* Divide by nth factor of 10 */
330 for (j
= 0; j
< i
; j
++) {
331 (void)acpi_ut_short_divide(digit
, 10, &digit
,
335 /* Handle leading zeros */
337 if (remainder
!= 0) {
338 supress_zeros
= FALSE
;
341 if (!supress_zeros
) {
342 string
[k
] = (u8
) (ACPI_ASCII_ZERO
+ remainder
);
350 /* hex_length: 2 ascii hex chars per data byte */
352 hex_length
= ACPI_MUL_2(data_width
);
353 for (i
= 0, j
= (hex_length
- 1); i
< hex_length
; i
++, j
--) {
355 /* Get one hex digit, most significant digits first */
358 (u8
) acpi_ut_hex_to_ascii_char(integer
,
369 * Since leading zeros are suppressed, we must check for the case where
370 * the integer equals 0
372 * Finally, null terminate the string and return the length
375 string
[0] = ACPI_ASCII_ZERO
;
383 /*******************************************************************************
385 * FUNCTION: acpi_ex_convert_to_string
387 * PARAMETERS: obj_desc - Object to be converted. Must be an
388 * Integer, Buffer, or String
389 * result_desc - Where the string object is returned
390 * type - String flags (base and conversion type)
394 * DESCRIPTION: Convert an ACPI Object to a string
396 ******************************************************************************/
399 acpi_ex_convert_to_string(union acpi_operand_object
* obj_desc
,
400 union acpi_operand_object
** result_desc
, u32 type
)
402 union acpi_operand_object
*return_desc
;
405 u32 string_length
= 0;
409 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_string
, obj_desc
);
411 switch (obj_desc
->common
.type
) {
412 case ACPI_TYPE_STRING
:
414 /* No conversion necessary */
416 *result_desc
= obj_desc
;
417 return_ACPI_STATUS(AE_OK
);
419 case ACPI_TYPE_INTEGER
:
422 case ACPI_EXPLICIT_CONVERT_DECIMAL
:
424 /* Make room for maximum decimal number */
426 string_length
= ACPI_MAX_DECIMAL_DIGITS
;
432 /* Two hex string characters for each integer byte */
434 string_length
= ACPI_MUL_2(acpi_gbl_integer_byte_width
);
439 * Create a new String
440 * Need enough space for one ASCII integer (plus null terminator)
443 acpi_ut_create_string_object((acpi_size
) string_length
);
445 return_ACPI_STATUS(AE_NO_MEMORY
);
448 new_buf
= return_desc
->buffer
.pointer
;
450 /* Convert integer to string */
453 acpi_ex_convert_to_ascii(obj_desc
->integer
.value
, base
,
455 acpi_gbl_integer_byte_width
);
457 /* Null terminate at the correct place */
459 return_desc
->string
.length
= string_length
;
460 new_buf
[string_length
] = 0;
463 case ACPI_TYPE_BUFFER
:
465 /* Setup string length, base, and separator */
468 case ACPI_EXPLICIT_CONVERT_DECIMAL
: /* Used by to_decimal_string */
470 * From ACPI: "If Data is a buffer, it is converted to a string of
471 * decimal values separated by commas."
476 * Calculate the final string length. Individual string values
477 * are variable length (include separator for each)
479 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
480 if (obj_desc
->buffer
.pointer
[i
] >= 100) {
482 } else if (obj_desc
->buffer
.pointer
[i
] >= 10) {
490 case ACPI_IMPLICIT_CONVERT_HEX
:
492 * From the ACPI spec:
493 *"The entire contents of the buffer are converted to a string of
494 * two-character hexadecimal numbers, each separated by a space."
497 string_length
= (obj_desc
->buffer
.length
* 3);
500 case ACPI_EXPLICIT_CONVERT_HEX
: /* Used by to_hex_string */
502 * From ACPI: "If Data is a buffer, it is converted to a string of
503 * hexadecimal values separated by commas."
505 string_length
= (obj_desc
->buffer
.length
* 3);
509 return_ACPI_STATUS(AE_BAD_PARAMETER
);
513 * Create a new string object and string buffer
514 * (-1 because of extra separator included in string_length from above)
515 * Allow creation of zero-length strings from zero-length buffers.
522 acpi_ut_create_string_object((acpi_size
) string_length
);
524 return_ACPI_STATUS(AE_NO_MEMORY
);
527 new_buf
= return_desc
->buffer
.pointer
;
530 * Convert buffer bytes to hex or decimal values
531 * (separated by commas or spaces)
533 for (i
= 0; i
< obj_desc
->buffer
.length
; i
++) {
534 new_buf
+= acpi_ex_convert_to_ascii((u64
) obj_desc
->
537 *new_buf
++ = separator
; /* each separated by a comma or space */
541 * Null terminate the string
542 * (overwrites final comma/space from above)
544 if (obj_desc
->buffer
.length
) {
552 return_ACPI_STATUS(AE_TYPE
);
555 *result_desc
= return_desc
;
556 return_ACPI_STATUS(AE_OK
);
559 /*******************************************************************************
561 * FUNCTION: acpi_ex_convert_to_target_type
563 * PARAMETERS: destination_type - Current type of the destination
564 * source_desc - Source object to be converted.
565 * result_desc - Where the converted object is returned
566 * walk_state - Current method state
570 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
572 ******************************************************************************/
575 acpi_ex_convert_to_target_type(acpi_object_type destination_type
,
576 union acpi_operand_object
*source_desc
,
577 union acpi_operand_object
**result_desc
,
578 struct acpi_walk_state
*walk_state
)
580 acpi_status status
= AE_OK
;
582 ACPI_FUNCTION_TRACE(ex_convert_to_target_type
);
584 /* Default behavior */
586 *result_desc
= source_desc
;
589 * If required by the target,
590 * perform implicit conversion on the source before we store it.
592 switch (GET_CURRENT_ARG_TYPE(walk_state
->op_info
->runtime_args
)) {
593 case ARGI_SIMPLE_TARGET
:
594 case ARGI_FIXED_TARGET
:
595 case ARGI_INTEGER_REF
: /* Handles Increment, Decrement cases */
597 switch (destination_type
) {
598 case ACPI_TYPE_LOCAL_REGION_FIELD
:
600 * 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
)));
621 case ARGI_STORE_TARGET
:
623 switch (destination_type
) {
624 case ACPI_TYPE_INTEGER
:
625 case ACPI_TYPE_BUFFER_FIELD
:
626 case ACPI_TYPE_LOCAL_BANK_FIELD
:
627 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
629 * These types require an Integer operand. We can convert
630 * a Buffer or a String to an Integer if necessary.
633 acpi_ex_convert_to_integer(source_desc
, result_desc
,
637 case ACPI_TYPE_STRING
:
639 * The operand must be a String. We can convert an
640 * Integer or Buffer if necessary
643 acpi_ex_convert_to_string(source_desc
, result_desc
,
644 ACPI_IMPLICIT_CONVERT_HEX
);
647 case ACPI_TYPE_BUFFER
:
649 * The operand must be a Buffer. We can convert an
650 * Integer or String if necessary
653 acpi_ex_convert_to_buffer(source_desc
, result_desc
);
659 "Bad destination type during conversion: 0x%X",
661 status
= AE_AML_INTERNAL
;
668 * create_xxxx_field cases - we are storing the field object into the name
675 "Unknown Target type ID 0x%X AmlOpcode 0x%X DestType %s",
676 GET_CURRENT_ARG_TYPE(walk_state
->op_info
->
679 acpi_ut_get_type_name(destination_type
)));
680 status
= AE_AML_INTERNAL
;
684 * Source-to-Target conversion semantics:
686 * If conversion to the target type cannot be performed, then simply
687 * overwrite the target with the new object and type.
689 if (status
== AE_TYPE
) {
693 return_ACPI_STATUS(status
);