1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: exconvrt - Object conversion routines
6 * Copyright (C) 2000 - 2022, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
15 #define _COMPONENT ACPI_EXECUTER
16 ACPI_MODULE_NAME("exconvrt")
18 /* Local prototypes */
20 acpi_ex_convert_to_ascii(u64 integer, u16 base, u8 *string, u8 max_length);
22 /*******************************************************************************
24 * FUNCTION: acpi_ex_convert_to_integer
26 * PARAMETERS: obj_desc - Object to be converted. Must be an
27 * Integer, Buffer, or String
28 * result_desc - Where the new Integer object is returned
29 * implicit_conversion - Used for string conversion
33 * DESCRIPTION: Convert an ACPI Object to an integer.
35 ******************************************************************************/
38 acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
39 union acpi_operand_object **result_desc,
40 u32 implicit_conversion)
42 union acpi_operand_object *return_desc;
48 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_integer, obj_desc);
50 switch (obj_desc->common.type) {
51 case ACPI_TYPE_INTEGER:
53 /* No conversion necessary */
55 *result_desc = obj_desc;
56 return_ACPI_STATUS(AE_OK);
58 case ACPI_TYPE_BUFFER:
59 case ACPI_TYPE_STRING:
61 /* Note: Takes advantage of common buffer/string fields */
63 pointer = obj_desc->buffer.pointer;
64 count = obj_desc->buffer.length;
69 return_ACPI_STATUS(AE_TYPE);
73 * Convert the buffer/string to an integer. Note that both buffers and
74 * strings are treated as raw data - we don't convert ascii to hex for
77 * There are two terminating conditions for the loop:
78 * 1) The size of an integer has been reached, or
79 * 2) The end of the buffer or string has been reached
83 /* String conversion is different than Buffer conversion */
85 switch (obj_desc->common.type) {
86 case ACPI_TYPE_STRING:
88 * Convert string to an integer - for most cases, the string must be
89 * hexadecimal as per the ACPI specification. The only exception (as
90 * of ACPI 3.0) is that the to_integer() operator allows both decimal
91 * and hexadecimal strings (hex prefixed with "0x").
93 * Explicit conversion is used only by to_integer.
94 * All other string-to-integer conversions are implicit conversions.
96 if (implicit_conversion) {
98 acpi_ut_implicit_strtoul64(ACPI_CAST_PTR
102 acpi_ut_explicit_strtoul64(ACPI_CAST_PTR
107 case ACPI_TYPE_BUFFER:
109 /* Check for zero-length buffer */
112 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
115 /* Transfer no more than an integer's worth of data */
117 if (count > acpi_gbl_integer_byte_width) {
118 count = acpi_gbl_integer_byte_width;
122 * Convert buffer to an integer - we simply grab enough raw data
123 * from the buffer to fill an integer
125 for (i = 0; i < count; i++) {
127 * Get next byte and shift it into the Result.
128 * Little endian is used, meaning that the first byte of the buffer
129 * is the LSB of the integer
131 result |= (((u64) pointer[i]) << (i * 8));
137 /* No other types can get here */
142 /* Create a new integer */
144 return_desc = acpi_ut_create_integer_object(result);
146 return_ACPI_STATUS(AE_NO_MEMORY);
149 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
150 ACPI_FORMAT_UINT64(result)));
152 /* Save the Result */
154 (void)acpi_ex_truncate_for32bit_table(return_desc);
155 *result_desc = return_desc;
156 return_ACPI_STATUS(AE_OK);
159 /*******************************************************************************
161 * FUNCTION: acpi_ex_convert_to_buffer
163 * PARAMETERS: obj_desc - Object to be converted. Must be an
164 * Integer, Buffer, or String
165 * result_desc - Where the new buffer object is returned
169 * DESCRIPTION: Convert an ACPI Object to a Buffer
171 ******************************************************************************/
174 acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
175 union acpi_operand_object **result_desc)
177 union acpi_operand_object *return_desc;
180 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_buffer, obj_desc);
182 switch (obj_desc->common.type) {
183 case ACPI_TYPE_BUFFER:
185 /* No conversion necessary */
187 *result_desc = obj_desc;
188 return_ACPI_STATUS(AE_OK);
190 case ACPI_TYPE_INTEGER:
192 * Create a new Buffer object.
193 * Need enough space for one integer
196 acpi_ut_create_buffer_object(acpi_gbl_integer_byte_width);
198 return_ACPI_STATUS(AE_NO_MEMORY);
201 /* Copy the integer to the buffer, LSB first */
203 new_buf = return_desc->buffer.pointer;
204 memcpy(new_buf, &obj_desc->integer.value,
205 acpi_gbl_integer_byte_width);
208 case ACPI_TYPE_STRING:
210 * Create a new Buffer object
211 * Size will be the string length
213 * NOTE: Add one to the string length to include the null terminator.
214 * The ACPI spec is unclear on this subject, but there is existing
215 * ASL/AML code that depends on the null being transferred to the new
218 return_desc = acpi_ut_create_buffer_object((acpi_size)
222 return_ACPI_STATUS(AE_NO_MEMORY);
225 /* Copy the string to the buffer */
227 new_buf = return_desc->buffer.pointer;
228 strncpy((char *)new_buf, (char *)obj_desc->string.pointer,
229 obj_desc->string.length);
234 return_ACPI_STATUS(AE_TYPE);
237 /* Mark buffer initialized */
239 return_desc->common.flags |= AOPOBJ_DATA_VALID;
240 *result_desc = return_desc;
241 return_ACPI_STATUS(AE_OK);
244 /*******************************************************************************
246 * FUNCTION: acpi_ex_convert_to_ascii
248 * PARAMETERS: integer - Value to be converted
249 * base - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
250 * string - Where the string is returned
251 * data_width - Size of data item to be converted, in bytes
253 * RETURN: Actual string length
255 * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
257 ******************************************************************************/
260 acpi_ex_convert_to_ascii(u64 integer, u16 base, u8 *string, u8 data_width)
271 ACPI_FUNCTION_ENTRY();
276 /* Setup max length for the decimal number */
278 switch (data_width) {
281 decimal_length = ACPI_MAX8_DECIMAL_DIGITS;
286 decimal_length = ACPI_MAX32_DECIMAL_DIGITS;
292 decimal_length = ACPI_MAX64_DECIMAL_DIGITS;
296 supress_zeros = TRUE; /* No leading zeros */
299 for (i = decimal_length; i > 0; i--) {
301 /* Divide by nth factor of 10 */
304 for (j = 0; j < i; j++) {
305 (void)acpi_ut_short_divide(digit, 10, &digit,
309 /* Handle leading zeros */
311 if (remainder != 0) {
312 supress_zeros = FALSE;
315 if (!supress_zeros) {
316 string[k] = (u8) (ACPI_ASCII_ZERO + remainder);
324 /* hex_length: 2 ascii hex chars per data byte */
326 hex_length = (data_width * 2);
327 for (i = 0, j = (hex_length - 1); i < hex_length; i++, j--) {
329 /* Get one hex digit, most significant digits first */
332 acpi_ut_hex_to_ascii_char(integer, ACPI_MUL_4(j));
342 * Since leading zeros are suppressed, we must check for the case where
343 * the integer equals 0
345 * Finally, null terminate the string and return the length
348 string[0] = ACPI_ASCII_ZERO;
356 /*******************************************************************************
358 * FUNCTION: acpi_ex_convert_to_string
360 * PARAMETERS: obj_desc - Object to be converted. Must be an
361 * Integer, Buffer, or String
362 * result_desc - Where the string object is returned
363 * type - String flags (base and conversion type)
367 * DESCRIPTION: Convert an ACPI Object to a string. Supports both implicit
368 * and explicit conversions and related rules.
370 ******************************************************************************/
373 acpi_ex_convert_to_string(union acpi_operand_object * obj_desc,
374 union acpi_operand_object ** result_desc, u32 type)
376 union acpi_operand_object *return_desc;
379 u32 string_length = 0;
383 ACPI_FUNCTION_TRACE_PTR(ex_convert_to_string, obj_desc);
385 switch (obj_desc->common.type) {
386 case ACPI_TYPE_STRING:
388 /* No conversion necessary */
390 *result_desc = obj_desc;
391 return_ACPI_STATUS(AE_OK);
393 case ACPI_TYPE_INTEGER:
396 case ACPI_EXPLICIT_CONVERT_DECIMAL:
398 * From to_decimal_string, integer source.
400 * Make room for the maximum decimal number size
402 string_length = ACPI_MAX_DECIMAL_DIGITS;
408 /* Two hex string characters for each integer byte */
410 string_length = ACPI_MUL_2(acpi_gbl_integer_byte_width);
415 * Create a new String
416 * Need enough space for one ASCII integer (plus null terminator)
419 acpi_ut_create_string_object((acpi_size)string_length);
421 return_ACPI_STATUS(AE_NO_MEMORY);
424 new_buf = return_desc->buffer.pointer;
426 /* Convert integer to string */
429 acpi_ex_convert_to_ascii(obj_desc->integer.value, base,
431 acpi_gbl_integer_byte_width);
433 /* Null terminate at the correct place */
435 return_desc->string.length = string_length;
436 new_buf[string_length] = 0;
439 case ACPI_TYPE_BUFFER:
441 /* Setup string length, base, and separator */
444 case ACPI_EXPLICIT_CONVERT_DECIMAL: /* Used by to_decimal_string */
446 * Explicit conversion from the to_decimal_string ASL operator.
448 * From ACPI: "If the input is a buffer, it is converted to a
449 * a string of decimal values separated by commas."
454 * Calculate the final string length. Individual string values
455 * are variable length (include separator for each)
457 for (i = 0; i < obj_desc->buffer.length; i++) {
458 if (obj_desc->buffer.pointer[i] >= 100) {
460 } else if (obj_desc->buffer.pointer[i] >= 10) {
468 case ACPI_IMPLICIT_CONVERT_HEX:
470 * Implicit buffer-to-string conversion
472 * From the ACPI spec:
473 * "The entire contents of the buffer are converted to a string of
474 * two-character hexadecimal numbers, each separated by a space."
476 * Each hex number is prefixed with 0x (11/2018)
479 string_length = (obj_desc->buffer.length * 5);
482 case ACPI_EXPLICIT_CONVERT_HEX:
484 * Explicit conversion from the to_hex_string ASL operator.
486 * From ACPI: "If Data is a buffer, it is converted to a string of
487 * hexadecimal values separated by commas."
489 * Each hex number is prefixed with 0x (11/2018)
492 string_length = (obj_desc->buffer.length * 5);
496 return_ACPI_STATUS(AE_BAD_PARAMETER);
500 * Create a new string object and string buffer
501 * (-1 because of extra separator included in string_length from above)
502 * Allow creation of zero-length strings from zero-length buffers.
509 acpi_ut_create_string_object((acpi_size)string_length);
511 return_ACPI_STATUS(AE_NO_MEMORY);
514 new_buf = return_desc->buffer.pointer;
517 * Convert buffer bytes to hex or decimal values
518 * (separated by commas or spaces)
520 for (i = 0; i < obj_desc->buffer.length; i++) {
523 /* Emit 0x prefix for explicit/implicit hex conversion */
529 new_buf += acpi_ex_convert_to_ascii((u64) obj_desc->
533 /* Each digit is separated by either a comma or space */
535 *new_buf++ = separator;
539 * Null terminate the string
540 * (overwrites final comma/space from above)
542 if (obj_desc->buffer.length) {
550 return_ACPI_STATUS(AE_TYPE);
553 *result_desc = return_desc;
554 return_ACPI_STATUS(AE_OK);
557 /*******************************************************************************
559 * FUNCTION: acpi_ex_convert_to_target_type
561 * PARAMETERS: destination_type - Current type of the destination
562 * source_desc - Source object to be converted.
563 * result_desc - Where the converted object is returned
564 * walk_state - Current method state
568 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
570 ******************************************************************************/
573 acpi_ex_convert_to_target_type(acpi_object_type destination_type,
574 union acpi_operand_object *source_desc,
575 union acpi_operand_object **result_desc,
576 struct acpi_walk_state *walk_state)
578 acpi_status status = AE_OK;
580 ACPI_FUNCTION_TRACE(ex_convert_to_target_type);
582 /* Default behavior */
584 *result_desc = source_desc;
587 * If required by the target,
588 * perform implicit conversion on the source before we store it.
590 switch (GET_CURRENT_ARG_TYPE(walk_state->op_info->runtime_args)) {
591 case ARGI_SIMPLE_TARGET:
592 case ARGI_FIXED_TARGET:
593 case ARGI_INTEGER_REF: /* Handles Increment, Decrement cases */
595 switch (destination_type) {
596 case ACPI_TYPE_LOCAL_REGION_FIELD:
598 * Named field can always handle conversions
604 /* No conversion allowed for these types */
606 if (destination_type != source_desc->common.type) {
607 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
608 "Explicit operator, will store (%s) over existing type (%s)\n",
609 acpi_ut_get_object_type_name
611 acpi_ut_get_type_name
612 (destination_type)));
619 case ARGI_STORE_TARGET:
621 switch (destination_type) {
622 case ACPI_TYPE_INTEGER:
623 case ACPI_TYPE_BUFFER_FIELD:
624 case ACPI_TYPE_LOCAL_BANK_FIELD:
625 case ACPI_TYPE_LOCAL_INDEX_FIELD:
627 * These types require an Integer operand. We can convert
628 * a Buffer or a String to an Integer if necessary.
631 acpi_ex_convert_to_integer(source_desc, result_desc,
632 ACPI_IMPLICIT_CONVERSION);
635 case ACPI_TYPE_STRING:
637 * The operand must be a String. We can convert an
638 * Integer or Buffer if necessary
641 acpi_ex_convert_to_string(source_desc, result_desc,
642 ACPI_IMPLICIT_CONVERT_HEX);
645 case ACPI_TYPE_BUFFER:
647 * The operand must be a Buffer. We can convert an
648 * Integer or String if necessary
651 acpi_ex_convert_to_buffer(source_desc, result_desc);
657 "Bad destination type during conversion: 0x%X",
659 status = AE_AML_INTERNAL;
666 * create_xxxx_field cases - we are storing the field object into the name
673 "Unknown Target type ID 0x%X AmlOpcode 0x%X DestType %s",
674 GET_CURRENT_ARG_TYPE(walk_state->op_info->
677 acpi_ut_get_type_name(destination_type)));
678 status = AE_AML_INTERNAL;
682 * Source-to-Target conversion semantics:
684 * If conversion to the target type cannot be performed, then simply
685 * overwrite the target with the new object and type.
687 if (status == AE_TYPE) {
691 return_ACPI_STATUS(status);