1 /******************************************************************************
3 * Module Name: exconvrt - Object conversion routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 #define __EXCONVRT_C__
119 #include <contrib/dev/acpica/include/acpi.h>
120 #include <contrib/dev/acpica/include/accommon.h>
121 #include <contrib/dev/acpica/include/acinterp.h>
122 #include <contrib/dev/acpica/include/amlcode.h>
125 #define _COMPONENT ACPI_EXECUTER
126 ACPI_MODULE_NAME ("exconvrt")
128 /* Local prototypes */
131 AcpiExConvertToAscii (
132 ACPI_INTEGER Integer,
138 /*******************************************************************************
140 * FUNCTION: AcpiExConvertToInteger
142 * PARAMETERS: ObjDesc - Object to be converted. Must be an
143 * Integer, Buffer, or String
144 * ResultDesc - Where the new Integer object is returned
145 * Flags - Used for string conversion
149 * DESCRIPTION: Convert an ACPI Object to an integer.
151 ******************************************************************************/
154 AcpiExConvertToInteger (
155 ACPI_OPERAND_OBJECT *ObjDesc,
156 ACPI_OPERAND_OBJECT **ResultDesc,
159 ACPI_OPERAND_OBJECT *ReturnDesc;
167 ACPI_FUNCTION_TRACE_PTR (ExConvertToInteger, ObjDesc);
170 switch (ObjDesc->Common.Type)
172 case ACPI_TYPE_INTEGER:
174 /* No conversion necessary */
176 *ResultDesc = ObjDesc;
177 return_ACPI_STATUS (AE_OK);
179 case ACPI_TYPE_BUFFER:
180 case ACPI_TYPE_STRING:
182 /* Note: Takes advantage of common buffer/string fields */
184 Pointer = ObjDesc->Buffer.Pointer;
185 Count = ObjDesc->Buffer.Length;
189 return_ACPI_STATUS (AE_TYPE);
193 * Convert the buffer/string to an integer. Note that both buffers and
194 * strings are treated as raw data - we don't convert ascii to hex for
197 * There are two terminating conditions for the loop:
198 * 1) The size of an integer has been reached, or
199 * 2) The end of the buffer or string has been reached
203 /* String conversion is different than Buffer conversion */
205 switch (ObjDesc->Common.Type)
207 case ACPI_TYPE_STRING:
210 * Convert string to an integer - for most cases, the string must be
211 * hexadecimal as per the ACPI specification. The only exception (as
212 * of ACPI 3.0) is that the ToInteger() operator allows both decimal
213 * and hexadecimal strings (hex prefixed with "0x").
215 Status = AcpiUtStrtoul64 ((char *) Pointer, Flags, &Result);
216 if (ACPI_FAILURE (Status))
218 return_ACPI_STATUS (Status);
223 case ACPI_TYPE_BUFFER:
225 /* Check for zero-length buffer */
229 return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
232 /* Transfer no more than an integer's worth of data */
234 if (Count > AcpiGbl_IntegerByteWidth)
236 Count = AcpiGbl_IntegerByteWidth;
240 * Convert buffer to an integer - we simply grab enough raw data
241 * from the buffer to fill an integer
243 for (i = 0; i < Count; i++)
246 * Get next byte and shift it into the Result.
247 * Little endian is used, meaning that the first byte of the buffer
248 * is the LSB of the integer
250 Result |= (((ACPI_INTEGER) Pointer[i]) << (i * 8));
257 /* No other types can get here */
261 /* Create a new integer */
263 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
266 return_ACPI_STATUS (AE_NO_MEMORY);
269 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
270 ACPI_FORMAT_UINT64 (Result)));
272 /* Save the Result */
274 ReturnDesc->Integer.Value = Result;
275 AcpiExTruncateFor32bitTable (ReturnDesc);
276 *ResultDesc = ReturnDesc;
277 return_ACPI_STATUS (AE_OK);
281 /*******************************************************************************
283 * FUNCTION: AcpiExConvertToBuffer
285 * PARAMETERS: ObjDesc - Object to be converted. Must be an
286 * Integer, Buffer, or String
287 * ResultDesc - Where the new buffer object is returned
291 * DESCRIPTION: Convert an ACPI Object to a Buffer
293 ******************************************************************************/
296 AcpiExConvertToBuffer (
297 ACPI_OPERAND_OBJECT *ObjDesc,
298 ACPI_OPERAND_OBJECT **ResultDesc)
300 ACPI_OPERAND_OBJECT *ReturnDesc;
304 ACPI_FUNCTION_TRACE_PTR (ExConvertToBuffer, ObjDesc);
307 switch (ObjDesc->Common.Type)
309 case ACPI_TYPE_BUFFER:
311 /* No conversion necessary */
313 *ResultDesc = ObjDesc;
314 return_ACPI_STATUS (AE_OK);
317 case ACPI_TYPE_INTEGER:
320 * Create a new Buffer object.
321 * Need enough space for one integer
323 ReturnDesc = AcpiUtCreateBufferObject (AcpiGbl_IntegerByteWidth);
326 return_ACPI_STATUS (AE_NO_MEMORY);
329 /* Copy the integer to the buffer, LSB first */
331 NewBuf = ReturnDesc->Buffer.Pointer;
333 &ObjDesc->Integer.Value,
334 AcpiGbl_IntegerByteWidth);
338 case ACPI_TYPE_STRING:
341 * Create a new Buffer object
342 * Size will be the string length
344 * NOTE: Add one to the string length to include the null terminator.
345 * The ACPI spec is unclear on this subject, but there is existing
346 * ASL/AML code that depends on the null being transferred to the new
349 ReturnDesc = AcpiUtCreateBufferObject (
350 (ACPI_SIZE) ObjDesc->String.Length + 1);
353 return_ACPI_STATUS (AE_NO_MEMORY);
356 /* Copy the string to the buffer */
358 NewBuf = ReturnDesc->Buffer.Pointer;
359 ACPI_STRNCPY ((char *) NewBuf, (char *) ObjDesc->String.Pointer,
360 ObjDesc->String.Length);
365 return_ACPI_STATUS (AE_TYPE);
368 /* Mark buffer initialized */
370 ReturnDesc->Common.Flags |= AOPOBJ_DATA_VALID;
371 *ResultDesc = ReturnDesc;
372 return_ACPI_STATUS (AE_OK);
376 /*******************************************************************************
378 * FUNCTION: AcpiExConvertToAscii
380 * PARAMETERS: Integer - Value to be converted
381 * Base - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
382 * String - Where the string is returned
383 * DataWidth - Size of data item to be converted, in bytes
385 * RETURN: Actual string length
387 * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
389 ******************************************************************************/
392 AcpiExConvertToAscii (
393 ACPI_INTEGER Integer,
403 UINT32 DecimalLength;
405 BOOLEAN SupressZeros;
408 ACPI_FUNCTION_ENTRY ();
415 /* Setup max length for the decimal number */
420 DecimalLength = ACPI_MAX8_DECIMAL_DIGITS;
424 DecimalLength = ACPI_MAX32_DECIMAL_DIGITS;
429 DecimalLength = ACPI_MAX64_DECIMAL_DIGITS;
433 SupressZeros = TRUE; /* No leading zeros */
436 for (i = DecimalLength; i > 0; i--)
438 /* Divide by nth factor of 10 */
441 for (j = 0; j < i; j++)
443 (void) AcpiUtShortDivide (Digit, 10, &Digit, &Remainder);
446 /* Handle leading zeros */
450 SupressZeros = FALSE;
455 String[k] = (UINT8) (ACPI_ASCII_ZERO + Remainder);
463 /* HexLength: 2 ascii hex chars per data byte */
465 HexLength = ACPI_MUL_2 (DataWidth);
466 for (i = 0, j = (HexLength-1); i < HexLength; i++, j--)
468 /* Get one hex digit, most significant digits first */
470 String[k] = (UINT8) AcpiUtHexToAsciiChar (Integer, ACPI_MUL_4 (j));
480 * Since leading zeros are suppressed, we must check for the case where
481 * the integer equals 0
483 * Finally, null terminate the string and return the length
487 String [0] = ACPI_ASCII_ZERO;
496 /*******************************************************************************
498 * FUNCTION: AcpiExConvertToString
500 * PARAMETERS: ObjDesc - Object to be converted. Must be an
501 * Integer, Buffer, or String
502 * ResultDesc - Where the string object is returned
503 * Type - String flags (base and conversion type)
507 * DESCRIPTION: Convert an ACPI Object to a string
509 ******************************************************************************/
512 AcpiExConvertToString (
513 ACPI_OPERAND_OBJECT *ObjDesc,
514 ACPI_OPERAND_OBJECT **ResultDesc,
517 ACPI_OPERAND_OBJECT *ReturnDesc;
520 UINT32 StringLength = 0;
522 UINT8 Separator = ',';
525 ACPI_FUNCTION_TRACE_PTR (ExConvertToString, ObjDesc);
528 switch (ObjDesc->Common.Type)
530 case ACPI_TYPE_STRING:
532 /* No conversion necessary */
534 *ResultDesc = ObjDesc;
535 return_ACPI_STATUS (AE_OK);
538 case ACPI_TYPE_INTEGER:
542 case ACPI_EXPLICIT_CONVERT_DECIMAL:
544 /* Make room for maximum decimal number */
546 StringLength = ACPI_MAX_DECIMAL_DIGITS;
552 /* Two hex string characters for each integer byte */
554 StringLength = ACPI_MUL_2 (AcpiGbl_IntegerByteWidth);
559 * Create a new String
560 * Need enough space for one ASCII integer (plus null terminator)
562 ReturnDesc = AcpiUtCreateStringObject ((ACPI_SIZE) StringLength);
565 return_ACPI_STATUS (AE_NO_MEMORY);
568 NewBuf = ReturnDesc->Buffer.Pointer;
570 /* Convert integer to string */
572 StringLength = AcpiExConvertToAscii (ObjDesc->Integer.Value, Base,
573 NewBuf, AcpiGbl_IntegerByteWidth);
575 /* Null terminate at the correct place */
577 ReturnDesc->String.Length = StringLength;
578 NewBuf [StringLength] = 0;
582 case ACPI_TYPE_BUFFER:
584 /* Setup string length, base, and separator */
588 case ACPI_EXPLICIT_CONVERT_DECIMAL: /* Used by ToDecimalString */
590 * From ACPI: "If Data is a buffer, it is converted to a string of
591 * decimal values separated by commas."
596 * Calculate the final string length. Individual string values
597 * are variable length (include separator for each)
599 for (i = 0; i < ObjDesc->Buffer.Length; i++)
601 if (ObjDesc->Buffer.Pointer[i] >= 100)
605 else if (ObjDesc->Buffer.Pointer[i] >= 10)
616 case ACPI_IMPLICIT_CONVERT_HEX:
618 * From the ACPI spec:
619 *"The entire contents of the buffer are converted to a string of
620 * two-character hexadecimal numbers, each separated by a space."
623 StringLength = (ObjDesc->Buffer.Length * 3);
626 case ACPI_EXPLICIT_CONVERT_HEX: /* Used by ToHexString */
628 * From ACPI: "If Data is a buffer, it is converted to a string of
629 * hexadecimal values separated by commas."
631 StringLength = (ObjDesc->Buffer.Length * 3);
635 return_ACPI_STATUS (AE_BAD_PARAMETER);
639 * Create a new string object and string buffer
640 * (-1 because of extra separator included in StringLength from above)
641 * Allow creation of zero-length strings from zero-length buffers.
648 ReturnDesc = AcpiUtCreateStringObject ((ACPI_SIZE) StringLength);
651 return_ACPI_STATUS (AE_NO_MEMORY);
654 NewBuf = ReturnDesc->Buffer.Pointer;
657 * Convert buffer bytes to hex or decimal values
658 * (separated by commas or spaces)
660 for (i = 0; i < ObjDesc->Buffer.Length; i++)
662 NewBuf += AcpiExConvertToAscii (
663 (ACPI_INTEGER) ObjDesc->Buffer.Pointer[i], Base,
665 *NewBuf++ = Separator; /* each separated by a comma or space */
669 * Null terminate the string
670 * (overwrites final comma/space from above)
672 if (ObjDesc->Buffer.Length)
680 return_ACPI_STATUS (AE_TYPE);
683 *ResultDesc = ReturnDesc;
684 return_ACPI_STATUS (AE_OK);
688 /*******************************************************************************
690 * FUNCTION: AcpiExConvertToTargetType
692 * PARAMETERS: DestinationType - Current type of the destination
693 * SourceDesc - Source object to be converted.
694 * ResultDesc - Where the converted object is returned
695 * WalkState - Current method state
699 * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
701 ******************************************************************************/
704 AcpiExConvertToTargetType (
705 ACPI_OBJECT_TYPE DestinationType,
706 ACPI_OPERAND_OBJECT *SourceDesc,
707 ACPI_OPERAND_OBJECT **ResultDesc,
708 ACPI_WALK_STATE *WalkState)
710 ACPI_STATUS Status = AE_OK;
713 ACPI_FUNCTION_TRACE (ExConvertToTargetType);
716 /* Default behavior */
718 *ResultDesc = SourceDesc;
721 * If required by the target,
722 * perform implicit conversion on the source before we store it.
724 switch (GET_CURRENT_ARG_TYPE (WalkState->OpInfo->RuntimeArgs))
726 case ARGI_SIMPLE_TARGET:
727 case ARGI_FIXED_TARGET:
728 case ARGI_INTEGER_REF: /* Handles Increment, Decrement cases */
730 switch (DestinationType)
732 case ACPI_TYPE_LOCAL_REGION_FIELD:
734 * Named field can always handle conversions
739 /* No conversion allowed for these types */
741 if (DestinationType != SourceDesc->Common.Type)
743 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
744 "Explicit operator, will store (%s) over existing type (%s)\n",
745 AcpiUtGetObjectTypeName (SourceDesc),
746 AcpiUtGetTypeName (DestinationType)));
755 switch (DestinationType)
757 case ACPI_TYPE_INTEGER:
758 case ACPI_TYPE_BUFFER_FIELD:
759 case ACPI_TYPE_LOCAL_BANK_FIELD:
760 case ACPI_TYPE_LOCAL_INDEX_FIELD:
762 * These types require an Integer operand. We can convert
763 * a Buffer or a String to an Integer if necessary.
765 Status = AcpiExConvertToInteger (SourceDesc, ResultDesc,
770 case ACPI_TYPE_STRING:
772 * The operand must be a String. We can convert an
773 * Integer or Buffer if necessary
775 Status = AcpiExConvertToString (SourceDesc, ResultDesc,
776 ACPI_IMPLICIT_CONVERT_HEX);
780 case ACPI_TYPE_BUFFER:
782 * The operand must be a Buffer. We can convert an
783 * Integer or String if necessary
785 Status = AcpiExConvertToBuffer (SourceDesc, ResultDesc);
790 ACPI_ERROR ((AE_INFO, "Bad destination type during conversion: %X",
792 Status = AE_AML_INTERNAL;
800 * CreateXxxxField cases - we are storing the field object into the name
806 ACPI_ERROR ((AE_INFO,
807 "Unknown Target type ID 0x%X AmlOpcode %X DestType %s",
808 GET_CURRENT_ARG_TYPE (WalkState->OpInfo->RuntimeArgs),
809 WalkState->Opcode, AcpiUtGetTypeName (DestinationType)));
810 Status = AE_AML_INTERNAL;
814 * Source-to-Target conversion semantics:
816 * If conversion to the target type cannot be performed, then simply
817 * overwrite the target with the new object and type.
819 if (Status == AE_TYPE)
824 return_ACPI_STATUS (Status);