xref: /freebsd-src/sys/contrib/dev/acpica/components/executer/exconvrt.c (revision 92f570c32e9b9b9b4db9b6921c4ab79be686a498)
1a159c266SJung-uk Kim /******************************************************************************
2a159c266SJung-uk Kim  *
3a159c266SJung-uk Kim  * Module Name: exconvrt - Object conversion routines
4a159c266SJung-uk Kim  *
5a159c266SJung-uk Kim  *****************************************************************************/
6a159c266SJung-uk Kim 
70d84335fSJung-uk Kim /******************************************************************************
80d84335fSJung-uk Kim  *
90d84335fSJung-uk Kim  * 1. Copyright Notice
100d84335fSJung-uk Kim  *
11804fe266SJung-uk Kim  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
12a159c266SJung-uk Kim  * All rights reserved.
13a159c266SJung-uk Kim  *
140d84335fSJung-uk Kim  * 2. License
150d84335fSJung-uk Kim  *
160d84335fSJung-uk Kim  * 2.1. This is your license from Intel Corp. under its intellectual property
170d84335fSJung-uk Kim  * rights. You may have additional license terms from the party that provided
180d84335fSJung-uk Kim  * you this software, covering your right to use that party's intellectual
190d84335fSJung-uk Kim  * property rights.
200d84335fSJung-uk Kim  *
210d84335fSJung-uk Kim  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
220d84335fSJung-uk Kim  * copy of the source code appearing in this file ("Covered Code") an
230d84335fSJung-uk Kim  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
240d84335fSJung-uk Kim  * base code distributed originally by Intel ("Original Intel Code") to copy,
250d84335fSJung-uk Kim  * make derivatives, distribute, use and display any portion of the Covered
260d84335fSJung-uk Kim  * Code in any form, with the right to sublicense such rights; and
270d84335fSJung-uk Kim  *
280d84335fSJung-uk Kim  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
290d84335fSJung-uk Kim  * license (with the right to sublicense), under only those claims of Intel
300d84335fSJung-uk Kim  * patents that are infringed by the Original Intel Code, to make, use, sell,
310d84335fSJung-uk Kim  * offer to sell, and import the Covered Code and derivative works thereof
320d84335fSJung-uk Kim  * solely to the minimum extent necessary to exercise the above copyright
330d84335fSJung-uk Kim  * license, and in no event shall the patent license extend to any additions
340d84335fSJung-uk Kim  * to or modifications of the Original Intel Code. No other license or right
350d84335fSJung-uk Kim  * is granted directly or by implication, estoppel or otherwise;
360d84335fSJung-uk Kim  *
370d84335fSJung-uk Kim  * The above copyright and patent license is granted only if the following
380d84335fSJung-uk Kim  * conditions are met:
390d84335fSJung-uk Kim  *
400d84335fSJung-uk Kim  * 3. Conditions
410d84335fSJung-uk Kim  *
420d84335fSJung-uk Kim  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
430d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
440d84335fSJung-uk Kim  * Code or modification with rights to further distribute source must include
450d84335fSJung-uk Kim  * the above Copyright Notice, the above License, this list of Conditions,
460d84335fSJung-uk Kim  * and the following Disclaimer and Export Compliance provision. In addition,
470d84335fSJung-uk Kim  * Licensee must cause all Covered Code to which Licensee contributes to
480d84335fSJung-uk Kim  * contain a file documenting the changes Licensee made to create that Covered
490d84335fSJung-uk Kim  * Code and the date of any change. Licensee must include in that file the
500d84335fSJung-uk Kim  * documentation of any changes made by any predecessor Licensee. Licensee
510d84335fSJung-uk Kim  * must include a prominent statement that the modification is derived,
520d84335fSJung-uk Kim  * directly or indirectly, from Original Intel Code.
530d84335fSJung-uk Kim  *
540d84335fSJung-uk Kim  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
550d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
560d84335fSJung-uk Kim  * Code or modification without rights to further distribute source must
570d84335fSJung-uk Kim  * include the following Disclaimer and Export Compliance provision in the
580d84335fSJung-uk Kim  * documentation and/or other materials provided with distribution. In
590d84335fSJung-uk Kim  * addition, Licensee may not authorize further sublicense of source of any
600d84335fSJung-uk Kim  * portion of the Covered Code, and must include terms to the effect that the
610d84335fSJung-uk Kim  * license from Licensee to its licensee is limited to the intellectual
620d84335fSJung-uk Kim  * property embodied in the software Licensee provides to its licensee, and
630d84335fSJung-uk Kim  * not to intellectual property embodied in modifications its licensee may
640d84335fSJung-uk Kim  * make.
650d84335fSJung-uk Kim  *
660d84335fSJung-uk Kim  * 3.3. Redistribution of Executable. Redistribution in executable form of any
670d84335fSJung-uk Kim  * substantial portion of the Covered Code or modification must reproduce the
680d84335fSJung-uk Kim  * above Copyright Notice, and the following Disclaimer and Export Compliance
690d84335fSJung-uk Kim  * provision in the documentation and/or other materials provided with the
700d84335fSJung-uk Kim  * distribution.
710d84335fSJung-uk Kim  *
720d84335fSJung-uk Kim  * 3.4. Intel retains all right, title, and interest in and to the Original
730d84335fSJung-uk Kim  * Intel Code.
740d84335fSJung-uk Kim  *
750d84335fSJung-uk Kim  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
760d84335fSJung-uk Kim  * Intel shall be used in advertising or otherwise to promote the sale, use or
770d84335fSJung-uk Kim  * other dealings in products derived from or relating to the Covered Code
780d84335fSJung-uk Kim  * without prior written authorization from Intel.
790d84335fSJung-uk Kim  *
800d84335fSJung-uk Kim  * 4. Disclaimer and Export Compliance
810d84335fSJung-uk Kim  *
820d84335fSJung-uk Kim  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
830d84335fSJung-uk Kim  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
840d84335fSJung-uk Kim  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
850d84335fSJung-uk Kim  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
860d84335fSJung-uk Kim  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
870d84335fSJung-uk Kim  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
880d84335fSJung-uk Kim  * PARTICULAR PURPOSE.
890d84335fSJung-uk Kim  *
900d84335fSJung-uk Kim  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
910d84335fSJung-uk Kim  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
920d84335fSJung-uk Kim  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
930d84335fSJung-uk Kim  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
940d84335fSJung-uk Kim  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
950d84335fSJung-uk Kim  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
960d84335fSJung-uk Kim  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
970d84335fSJung-uk Kim  * LIMITED REMEDY.
980d84335fSJung-uk Kim  *
990d84335fSJung-uk Kim  * 4.3. Licensee shall not export, either directly or indirectly, any of this
1000d84335fSJung-uk Kim  * software or system incorporating such software without first obtaining any
1010d84335fSJung-uk Kim  * required license or other approval from the U. S. Department of Commerce or
1020d84335fSJung-uk Kim  * any other agency or department of the United States Government. In the
1030d84335fSJung-uk Kim  * event Licensee exports any such software from the United States or
1040d84335fSJung-uk Kim  * re-exports any such software from a foreign destination, Licensee shall
1050d84335fSJung-uk Kim  * ensure that the distribution and export/re-export of the software is in
1060d84335fSJung-uk Kim  * compliance with all laws, regulations, orders, or other restrictions of the
1070d84335fSJung-uk Kim  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
1080d84335fSJung-uk Kim  * any of its subsidiaries will export/re-export any technical data, process,
1090d84335fSJung-uk Kim  * software, or service, directly or indirectly, to any country for which the
1100d84335fSJung-uk Kim  * United States government or any agency thereof requires an export license,
1110d84335fSJung-uk Kim  * other governmental approval, or letter of assurance, without first obtaining
1120d84335fSJung-uk Kim  * such license, approval or letter.
1130d84335fSJung-uk Kim  *
1140d84335fSJung-uk Kim  *****************************************************************************
1150d84335fSJung-uk Kim  *
1160d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
1170d84335fSJung-uk Kim  * following license:
1180d84335fSJung-uk Kim  *
119a159c266SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
120a159c266SJung-uk Kim  * modification, are permitted provided that the following conditions
121a159c266SJung-uk Kim  * are met:
122a159c266SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
123a159c266SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
124a159c266SJung-uk Kim  *    without modification.
125a159c266SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126a159c266SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
127a159c266SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
128a159c266SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
129a159c266SJung-uk Kim  *    binary redistribution.
130a159c266SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
131a159c266SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
132a159c266SJung-uk Kim  *    from this software without specific prior written permission.
133a159c266SJung-uk Kim  *
1340d84335fSJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1350d84335fSJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1360d84335fSJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1370d84335fSJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1380d84335fSJung-uk Kim  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1390d84335fSJung-uk Kim  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1400d84335fSJung-uk Kim  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1410d84335fSJung-uk Kim  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1420d84335fSJung-uk Kim  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1430d84335fSJung-uk Kim  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1440d84335fSJung-uk Kim  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1450d84335fSJung-uk Kim  *
1460d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
147a159c266SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
148a159c266SJung-uk Kim  * Software Foundation.
149a159c266SJung-uk Kim  *
1500d84335fSJung-uk Kim  *****************************************************************************/
151a159c266SJung-uk Kim 
152a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
153a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
154a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acinterp.h>
155a159c266SJung-uk Kim #include <contrib/dev/acpica/include/amlcode.h>
156a159c266SJung-uk Kim 
157a159c266SJung-uk Kim 
158a159c266SJung-uk Kim #define _COMPONENT          ACPI_EXECUTER
159a159c266SJung-uk Kim         ACPI_MODULE_NAME    ("exconvrt")
160a159c266SJung-uk Kim 
161a159c266SJung-uk Kim /* Local prototypes */
162a159c266SJung-uk Kim 
163a159c266SJung-uk Kim static UINT32
164a159c266SJung-uk Kim AcpiExConvertToAscii (
165a159c266SJung-uk Kim     UINT64                  Integer,
166a159c266SJung-uk Kim     UINT16                  Base,
167a159c266SJung-uk Kim     UINT8                   *String,
168*92f570c3SJung-uk Kim     UINT8                   MaxLength,
169*92f570c3SJung-uk Kim     BOOLEAN                 LeadingZeros);
170a159c266SJung-uk Kim 
171a159c266SJung-uk Kim 
172a159c266SJung-uk Kim /*******************************************************************************
173a159c266SJung-uk Kim  *
174a159c266SJung-uk Kim  * FUNCTION:    AcpiExConvertToInteger
175a159c266SJung-uk Kim  *
176a159c266SJung-uk Kim  * PARAMETERS:  ObjDesc             - Object to be converted. Must be an
177a159c266SJung-uk Kim  *                                    Integer, Buffer, or String
178a159c266SJung-uk Kim  *              ResultDesc          - Where the new Integer object is returned
1792f6a1a81SJung-uk Kim  *              ImplicitConversion  - Used for string conversion
180a159c266SJung-uk Kim  *
181a159c266SJung-uk Kim  * RETURN:      Status
182a159c266SJung-uk Kim  *
183a159c266SJung-uk Kim  * DESCRIPTION: Convert an ACPI Object to an integer.
184a159c266SJung-uk Kim  *
185a159c266SJung-uk Kim  ******************************************************************************/
186a159c266SJung-uk Kim 
187a159c266SJung-uk Kim ACPI_STATUS
188a159c266SJung-uk Kim AcpiExConvertToInteger (
189a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc,
190a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     **ResultDesc,
1912f6a1a81SJung-uk Kim     UINT32                  ImplicitConversion)
192a159c266SJung-uk Kim {
193a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ReturnDesc;
194a159c266SJung-uk Kim     UINT8                   *Pointer;
195a159c266SJung-uk Kim     UINT64                  Result;
196a159c266SJung-uk Kim     UINT32                  i;
197a159c266SJung-uk Kim     UINT32                  Count;
198a159c266SJung-uk Kim 
199a159c266SJung-uk Kim 
200a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (ExConvertToInteger, ObjDesc);
201a159c266SJung-uk Kim 
202a159c266SJung-uk Kim 
203a159c266SJung-uk Kim     switch (ObjDesc->Common.Type)
204a159c266SJung-uk Kim     {
205a159c266SJung-uk Kim     case ACPI_TYPE_INTEGER:
206a159c266SJung-uk Kim 
207a159c266SJung-uk Kim         /* No conversion necessary */
208a159c266SJung-uk Kim 
209a159c266SJung-uk Kim         *ResultDesc = ObjDesc;
210a159c266SJung-uk Kim         return_ACPI_STATUS (AE_OK);
211a159c266SJung-uk Kim 
212a159c266SJung-uk Kim     case ACPI_TYPE_BUFFER:
213a159c266SJung-uk Kim     case ACPI_TYPE_STRING:
214a159c266SJung-uk Kim 
215a159c266SJung-uk Kim         /* Note: Takes advantage of common buffer/string fields */
216a159c266SJung-uk Kim 
217a159c266SJung-uk Kim         Pointer = ObjDesc->Buffer.Pointer;
218a159c266SJung-uk Kim         Count   = ObjDesc->Buffer.Length;
219a159c266SJung-uk Kim         break;
220a159c266SJung-uk Kim 
221a159c266SJung-uk Kim     default:
222a9d8d09cSJung-uk Kim 
223a159c266SJung-uk Kim         return_ACPI_STATUS (AE_TYPE);
224a159c266SJung-uk Kim     }
225a159c266SJung-uk Kim 
226a159c266SJung-uk Kim     /*
227a159c266SJung-uk Kim      * Convert the buffer/string to an integer. Note that both buffers and
228a159c266SJung-uk Kim      * strings are treated as raw data - we don't convert ascii to hex for
229a159c266SJung-uk Kim      * strings.
230a159c266SJung-uk Kim      *
231a159c266SJung-uk Kim      * There are two terminating conditions for the loop:
232a159c266SJung-uk Kim      * 1) The size of an integer has been reached, or
233a159c266SJung-uk Kim      * 2) The end of the buffer or string has been reached
234a159c266SJung-uk Kim      */
235a159c266SJung-uk Kim     Result = 0;
236a159c266SJung-uk Kim 
237a159c266SJung-uk Kim     /* String conversion is different than Buffer conversion */
238a159c266SJung-uk Kim 
239a159c266SJung-uk Kim     switch (ObjDesc->Common.Type)
240a159c266SJung-uk Kim     {
241a159c266SJung-uk Kim     case ACPI_TYPE_STRING:
242a159c266SJung-uk Kim         /*
243a159c266SJung-uk Kim          * Convert string to an integer - for most cases, the string must be
244a159c266SJung-uk Kim          * hexadecimal as per the ACPI specification. The only exception (as
245a159c266SJung-uk Kim          * of ACPI 3.0) is that the ToInteger() operator allows both decimal
246a159c266SJung-uk Kim          * and hexadecimal strings (hex prefixed with "0x").
2472f6a1a81SJung-uk Kim          *
2482f6a1a81SJung-uk Kim          * Explicit conversion is used only by ToInteger.
2492f6a1a81SJung-uk Kim          * All other string-to-integer conversions are implicit conversions.
250a159c266SJung-uk Kim          */
2512f6a1a81SJung-uk Kim         if (ImplicitConversion)
252a159c266SJung-uk Kim         {
2532f6a1a81SJung-uk Kim             Result = AcpiUtImplicitStrtoul64 (ACPI_CAST_PTR (char, Pointer));
2542f6a1a81SJung-uk Kim         }
2552f6a1a81SJung-uk Kim         else
2562f6a1a81SJung-uk Kim         {
2572f6a1a81SJung-uk Kim             Result = AcpiUtExplicitStrtoul64 (ACPI_CAST_PTR (char, Pointer));
258a159c266SJung-uk Kim         }
259a159c266SJung-uk Kim         break;
260a159c266SJung-uk Kim 
261a159c266SJung-uk Kim     case ACPI_TYPE_BUFFER:
262a159c266SJung-uk Kim 
263a159c266SJung-uk Kim         /* Check for zero-length buffer */
264a159c266SJung-uk Kim 
265a159c266SJung-uk Kim         if (!Count)
266a159c266SJung-uk Kim         {
267a159c266SJung-uk Kim             return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
268a159c266SJung-uk Kim         }
269a159c266SJung-uk Kim 
270a159c266SJung-uk Kim         /* Transfer no more than an integer's worth of data */
271a159c266SJung-uk Kim 
272a159c266SJung-uk Kim         if (Count > AcpiGbl_IntegerByteWidth)
273a159c266SJung-uk Kim         {
274a159c266SJung-uk Kim             Count = AcpiGbl_IntegerByteWidth;
275a159c266SJung-uk Kim         }
276a159c266SJung-uk Kim 
277a159c266SJung-uk Kim         /*
278a159c266SJung-uk Kim          * Convert buffer to an integer - we simply grab enough raw data
279a159c266SJung-uk Kim          * from the buffer to fill an integer
280a159c266SJung-uk Kim          */
281a159c266SJung-uk Kim         for (i = 0; i < Count; i++)
282a159c266SJung-uk Kim         {
283a159c266SJung-uk Kim             /*
284a159c266SJung-uk Kim              * Get next byte and shift it into the Result.
285a159c266SJung-uk Kim              * Little endian is used, meaning that the first byte of the buffer
286a159c266SJung-uk Kim              * is the LSB of the integer
287a159c266SJung-uk Kim              */
288a159c266SJung-uk Kim             Result |= (((UINT64) Pointer[i]) << (i * 8));
289a159c266SJung-uk Kim         }
290a159c266SJung-uk Kim         break;
291a159c266SJung-uk Kim 
292a159c266SJung-uk Kim     default:
293a159c266SJung-uk Kim 
294a159c266SJung-uk Kim         /* No other types can get here */
295a9d8d09cSJung-uk Kim 
296a159c266SJung-uk Kim         break;
297a159c266SJung-uk Kim     }
298a159c266SJung-uk Kim 
299a159c266SJung-uk Kim     /* Create a new integer */
300a159c266SJung-uk Kim 
301a159c266SJung-uk Kim     ReturnDesc = AcpiUtCreateIntegerObject (Result);
302a159c266SJung-uk Kim     if (!ReturnDesc)
303a159c266SJung-uk Kim     {
304a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
305a159c266SJung-uk Kim     }
306a159c266SJung-uk Kim 
307a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
308a159c266SJung-uk Kim         ACPI_FORMAT_UINT64 (Result)));
309a159c266SJung-uk Kim 
310a159c266SJung-uk Kim     /* Save the Result */
311a159c266SJung-uk Kim 
312efcc2a30SJung-uk Kim     (void) AcpiExTruncateFor32bitTable (ReturnDesc);
313a159c266SJung-uk Kim     *ResultDesc = ReturnDesc;
314a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
315a159c266SJung-uk Kim }
316a159c266SJung-uk Kim 
317a159c266SJung-uk Kim 
318a159c266SJung-uk Kim /*******************************************************************************
319a159c266SJung-uk Kim  *
320a159c266SJung-uk Kim  * FUNCTION:    AcpiExConvertToBuffer
321a159c266SJung-uk Kim  *
322a159c266SJung-uk Kim  * PARAMETERS:  ObjDesc         - Object to be converted. Must be an
323a159c266SJung-uk Kim  *                                Integer, Buffer, or String
324a159c266SJung-uk Kim  *              ResultDesc      - Where the new buffer object is returned
325a159c266SJung-uk Kim  *
326a159c266SJung-uk Kim  * RETURN:      Status
327a159c266SJung-uk Kim  *
328a159c266SJung-uk Kim  * DESCRIPTION: Convert an ACPI Object to a Buffer
329a159c266SJung-uk Kim  *
330a159c266SJung-uk Kim  ******************************************************************************/
331a159c266SJung-uk Kim 
332a159c266SJung-uk Kim ACPI_STATUS
333a159c266SJung-uk Kim AcpiExConvertToBuffer (
334a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc,
335a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     **ResultDesc)
336a159c266SJung-uk Kim {
337a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ReturnDesc;
338a159c266SJung-uk Kim     UINT8                   *NewBuf;
339a159c266SJung-uk Kim 
340a159c266SJung-uk Kim 
341a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (ExConvertToBuffer, ObjDesc);
342a159c266SJung-uk Kim 
343a159c266SJung-uk Kim 
344a159c266SJung-uk Kim     switch (ObjDesc->Common.Type)
345a159c266SJung-uk Kim     {
346a159c266SJung-uk Kim     case ACPI_TYPE_BUFFER:
347a159c266SJung-uk Kim 
348a159c266SJung-uk Kim         /* No conversion necessary */
349a159c266SJung-uk Kim 
350a159c266SJung-uk Kim         *ResultDesc = ObjDesc;
351a159c266SJung-uk Kim         return_ACPI_STATUS (AE_OK);
352a159c266SJung-uk Kim 
353a159c266SJung-uk Kim 
354a159c266SJung-uk Kim     case ACPI_TYPE_INTEGER:
355a159c266SJung-uk Kim         /*
356a159c266SJung-uk Kim          * Create a new Buffer object.
357a159c266SJung-uk Kim          * Need enough space for one integer
358a159c266SJung-uk Kim          */
359a159c266SJung-uk Kim         ReturnDesc = AcpiUtCreateBufferObject (AcpiGbl_IntegerByteWidth);
360a159c266SJung-uk Kim         if (!ReturnDesc)
361a159c266SJung-uk Kim         {
362a159c266SJung-uk Kim             return_ACPI_STATUS (AE_NO_MEMORY);
363a159c266SJung-uk Kim         }
364a159c266SJung-uk Kim 
365a159c266SJung-uk Kim         /* Copy the integer to the buffer, LSB first */
366a159c266SJung-uk Kim 
367a159c266SJung-uk Kim         NewBuf = ReturnDesc->Buffer.Pointer;
368f8146b88SJung-uk Kim         memcpy (NewBuf, &ObjDesc->Integer.Value, AcpiGbl_IntegerByteWidth);
369a159c266SJung-uk Kim         break;
370a159c266SJung-uk Kim 
371a159c266SJung-uk Kim     case ACPI_TYPE_STRING:
372a159c266SJung-uk Kim         /*
373a159c266SJung-uk Kim          * Create a new Buffer object
374a159c266SJung-uk Kim          * Size will be the string length
375a159c266SJung-uk Kim          *
376a159c266SJung-uk Kim          * NOTE: Add one to the string length to include the null terminator.
377a159c266SJung-uk Kim          * The ACPI spec is unclear on this subject, but there is existing
378a159c266SJung-uk Kim          * ASL/AML code that depends on the null being transferred to the new
379a159c266SJung-uk Kim          * buffer.
380a159c266SJung-uk Kim          */
381f8146b88SJung-uk Kim         ReturnDesc = AcpiUtCreateBufferObject ((ACPI_SIZE)
382f8146b88SJung-uk Kim             ObjDesc->String.Length + 1);
383a159c266SJung-uk Kim         if (!ReturnDesc)
384a159c266SJung-uk Kim         {
385a159c266SJung-uk Kim             return_ACPI_STATUS (AE_NO_MEMORY);
386a159c266SJung-uk Kim         }
387a159c266SJung-uk Kim 
388a159c266SJung-uk Kim         /* Copy the string to the buffer */
389a159c266SJung-uk Kim 
390a159c266SJung-uk Kim         NewBuf = ReturnDesc->Buffer.Pointer;
3915ef50723SJung-uk Kim         strncpy ((char *) NewBuf, (char *) ObjDesc->String.Pointer,
392a159c266SJung-uk Kim             ObjDesc->String.Length);
393a159c266SJung-uk Kim         break;
394a159c266SJung-uk Kim 
395a159c266SJung-uk Kim     default:
396a9d8d09cSJung-uk Kim 
397a159c266SJung-uk Kim         return_ACPI_STATUS (AE_TYPE);
398a159c266SJung-uk Kim     }
399a159c266SJung-uk Kim 
400a159c266SJung-uk Kim     /* Mark buffer initialized */
401a159c266SJung-uk Kim 
402a159c266SJung-uk Kim     ReturnDesc->Common.Flags |= AOPOBJ_DATA_VALID;
403a159c266SJung-uk Kim     *ResultDesc = ReturnDesc;
404a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
405a159c266SJung-uk Kim }
406a159c266SJung-uk Kim 
407a159c266SJung-uk Kim 
408a159c266SJung-uk Kim /*******************************************************************************
409a159c266SJung-uk Kim  *
410a159c266SJung-uk Kim  * FUNCTION:    AcpiExConvertToAscii
411a159c266SJung-uk Kim  *
412a159c266SJung-uk Kim  * PARAMETERS:  Integer         - Value to be converted
413a159c266SJung-uk Kim  *              Base            - ACPI_STRING_DECIMAL or ACPI_STRING_HEX
414a159c266SJung-uk Kim  *              String          - Where the string is returned
415a159c266SJung-uk Kim  *              DataWidth       - Size of data item to be converted, in bytes
416*92f570c3SJung-uk Kim  *              LeadingZeros    - Allow leading zeros
417a159c266SJung-uk Kim  *
418a159c266SJung-uk Kim  * RETURN:      Actual string length
419a159c266SJung-uk Kim  *
420a159c266SJung-uk Kim  * DESCRIPTION: Convert an ACPI Integer to a hex or decimal string
421a159c266SJung-uk Kim  *
422a159c266SJung-uk Kim  ******************************************************************************/
423a159c266SJung-uk Kim 
424a159c266SJung-uk Kim static UINT32
425a159c266SJung-uk Kim AcpiExConvertToAscii (
426a159c266SJung-uk Kim     UINT64                  Integer,
427a159c266SJung-uk Kim     UINT16                  Base,
428a159c266SJung-uk Kim     UINT8                   *String,
429*92f570c3SJung-uk Kim     UINT8                   DataWidth,
430*92f570c3SJung-uk Kim     BOOLEAN                 LeadingZeros)
431a159c266SJung-uk Kim {
432a159c266SJung-uk Kim     UINT64                  Digit;
433a159c266SJung-uk Kim     UINT32                  i;
434a159c266SJung-uk Kim     UINT32                  j;
435a159c266SJung-uk Kim     UINT32                  k = 0;
436a159c266SJung-uk Kim     UINT32                  HexLength;
437a159c266SJung-uk Kim     UINT32                  DecimalLength;
438a159c266SJung-uk Kim     UINT32                  Remainder;
439*92f570c3SJung-uk Kim     BOOLEAN                 SupressZeros = !LeadingZeros;
440*92f570c3SJung-uk Kim     UINT8                   HexChar;
441a159c266SJung-uk Kim 
442a159c266SJung-uk Kim 
443a159c266SJung-uk Kim     ACPI_FUNCTION_ENTRY ();
444a159c266SJung-uk Kim 
445a159c266SJung-uk Kim 
446a159c266SJung-uk Kim     switch (Base)
447a159c266SJung-uk Kim     {
448a159c266SJung-uk Kim     case 10:
449a159c266SJung-uk Kim 
450a159c266SJung-uk Kim         /* Setup max length for the decimal number */
451a159c266SJung-uk Kim 
452a159c266SJung-uk Kim         switch (DataWidth)
453a159c266SJung-uk Kim         {
454a159c266SJung-uk Kim         case 1:
455a9d8d09cSJung-uk Kim 
456a159c266SJung-uk Kim             DecimalLength = ACPI_MAX8_DECIMAL_DIGITS;
457a159c266SJung-uk Kim             break;
458a159c266SJung-uk Kim 
459a159c266SJung-uk Kim         case 4:
460a9d8d09cSJung-uk Kim 
461a159c266SJung-uk Kim             DecimalLength = ACPI_MAX32_DECIMAL_DIGITS;
462a159c266SJung-uk Kim             break;
463a159c266SJung-uk Kim 
464a159c266SJung-uk Kim         case 8:
465a159c266SJung-uk Kim         default:
466a9d8d09cSJung-uk Kim 
467a159c266SJung-uk Kim             DecimalLength = ACPI_MAX64_DECIMAL_DIGITS;
468a159c266SJung-uk Kim             break;
469a159c266SJung-uk Kim         }
470a159c266SJung-uk Kim 
471a159c266SJung-uk Kim         Remainder = 0;
472a159c266SJung-uk Kim 
473a159c266SJung-uk Kim         for (i = DecimalLength; i > 0; i--)
474a159c266SJung-uk Kim         {
475a159c266SJung-uk Kim             /* Divide by nth factor of 10 */
476a159c266SJung-uk Kim 
477a159c266SJung-uk Kim             Digit = Integer;
478a159c266SJung-uk Kim             for (j = 0; j < i; j++)
479a159c266SJung-uk Kim             {
480a159c266SJung-uk Kim                 (void) AcpiUtShortDivide (Digit, 10, &Digit, &Remainder);
481a159c266SJung-uk Kim             }
482a159c266SJung-uk Kim 
483a159c266SJung-uk Kim             /* Handle leading zeros */
484a159c266SJung-uk Kim 
485a159c266SJung-uk Kim             if (Remainder != 0)
486a159c266SJung-uk Kim             {
487a159c266SJung-uk Kim                 SupressZeros = FALSE;
488a159c266SJung-uk Kim             }
489a159c266SJung-uk Kim 
490a159c266SJung-uk Kim             if (!SupressZeros)
491a159c266SJung-uk Kim             {
492a159c266SJung-uk Kim                 String[k] = (UINT8) (ACPI_ASCII_ZERO + Remainder);
493a159c266SJung-uk Kim                 k++;
494a159c266SJung-uk Kim             }
495a159c266SJung-uk Kim         }
496a159c266SJung-uk Kim         break;
497a159c266SJung-uk Kim 
498a159c266SJung-uk Kim     case 16:
499a159c266SJung-uk Kim 
500a159c266SJung-uk Kim         /* HexLength: 2 ascii hex chars per data byte */
501a159c266SJung-uk Kim 
50290b566fdSJung-uk Kim         HexLength = (DataWidth * 2);
503a159c266SJung-uk Kim         for (i = 0, j = (HexLength-1); i < HexLength; i++, j--)
504a159c266SJung-uk Kim         {
505a159c266SJung-uk Kim             /* Get one hex digit, most significant digits first */
506a159c266SJung-uk Kim 
507*92f570c3SJung-uk Kim             HexChar = (UINT8)
508f8146b88SJung-uk Kim                 AcpiUtHexToAsciiChar (Integer, ACPI_MUL_4 (j));
509*92f570c3SJung-uk Kim 
510*92f570c3SJung-uk Kim             /* Supress leading zeros until the first non-zero character */
511*92f570c3SJung-uk Kim 
512*92f570c3SJung-uk Kim             if (HexChar == ACPI_ASCII_ZERO && SupressZeros)
513*92f570c3SJung-uk Kim             {
514*92f570c3SJung-uk Kim                 continue;
515*92f570c3SJung-uk Kim             }
516*92f570c3SJung-uk Kim 
517*92f570c3SJung-uk Kim             SupressZeros = FALSE;
518*92f570c3SJung-uk Kim             String[k] = HexChar;
519a159c266SJung-uk Kim             k++;
520a159c266SJung-uk Kim         }
521a159c266SJung-uk Kim         break;
522a159c266SJung-uk Kim 
523a159c266SJung-uk Kim     default:
524a159c266SJung-uk Kim         return (0);
525a159c266SJung-uk Kim     }
526a159c266SJung-uk Kim 
527a159c266SJung-uk Kim     /*
528a159c266SJung-uk Kim      * Since leading zeros are suppressed, we must check for the case where
529a159c266SJung-uk Kim      * the integer equals 0
530a159c266SJung-uk Kim      *
531a159c266SJung-uk Kim      * Finally, null terminate the string and return the length
532a159c266SJung-uk Kim      */
533a159c266SJung-uk Kim     if (!k)
534a159c266SJung-uk Kim     {
535a159c266SJung-uk Kim         String [0] = ACPI_ASCII_ZERO;
536a159c266SJung-uk Kim         k = 1;
537a159c266SJung-uk Kim     }
538a159c266SJung-uk Kim 
539a159c266SJung-uk Kim     String [k] = 0;
540a159c266SJung-uk Kim     return ((UINT32) k);
541a159c266SJung-uk Kim }
542a159c266SJung-uk Kim 
543a159c266SJung-uk Kim 
544a159c266SJung-uk Kim /*******************************************************************************
545a159c266SJung-uk Kim  *
546a159c266SJung-uk Kim  * FUNCTION:    AcpiExConvertToString
547a159c266SJung-uk Kim  *
548a159c266SJung-uk Kim  * PARAMETERS:  ObjDesc         - Object to be converted. Must be an
549a159c266SJung-uk Kim  *                                Integer, Buffer, or String
550a159c266SJung-uk Kim  *              ResultDesc      - Where the string object is returned
551a159c266SJung-uk Kim  *              Type            - String flags (base and conversion type)
552a159c266SJung-uk Kim  *
553a159c266SJung-uk Kim  * RETURN:      Status
554a159c266SJung-uk Kim  *
55590b566fdSJung-uk Kim  * DESCRIPTION: Convert an ACPI Object to a string. Supports both implicit
55690b566fdSJung-uk Kim  *              and explicit conversions and related rules.
557a159c266SJung-uk Kim  *
558a159c266SJung-uk Kim  ******************************************************************************/
559a159c266SJung-uk Kim 
560a159c266SJung-uk Kim ACPI_STATUS
561a159c266SJung-uk Kim AcpiExConvertToString (
562a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc,
563a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     **ResultDesc,
564a159c266SJung-uk Kim     UINT32                  Type)
565a159c266SJung-uk Kim {
566a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ReturnDesc;
567a159c266SJung-uk Kim     UINT8                   *NewBuf;
568a159c266SJung-uk Kim     UINT32                  i;
569a159c266SJung-uk Kim     UINT32                  StringLength = 0;
570a159c266SJung-uk Kim     UINT16                  Base = 16;
571a159c266SJung-uk Kim     UINT8                   Separator = ',';
572*92f570c3SJung-uk Kim     BOOLEAN                 LeadingZeros;
573a159c266SJung-uk Kim 
574a159c266SJung-uk Kim 
575a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (ExConvertToString, ObjDesc);
576a159c266SJung-uk Kim 
577a159c266SJung-uk Kim 
578a159c266SJung-uk Kim     switch (ObjDesc->Common.Type)
579a159c266SJung-uk Kim     {
580a159c266SJung-uk Kim     case ACPI_TYPE_STRING:
581a159c266SJung-uk Kim 
582a159c266SJung-uk Kim         /* No conversion necessary */
583a159c266SJung-uk Kim 
584a159c266SJung-uk Kim         *ResultDesc = ObjDesc;
585a159c266SJung-uk Kim         return_ACPI_STATUS (AE_OK);
586a159c266SJung-uk Kim 
587a159c266SJung-uk Kim     case ACPI_TYPE_INTEGER:
588a159c266SJung-uk Kim 
589a159c266SJung-uk Kim         switch (Type)
590a159c266SJung-uk Kim         {
591a159c266SJung-uk Kim         case ACPI_EXPLICIT_CONVERT_DECIMAL:
59290b566fdSJung-uk Kim             /*
59390b566fdSJung-uk Kim              * From ToDecimalString, integer source.
59490b566fdSJung-uk Kim              *
59590b566fdSJung-uk Kim              * Make room for the maximum decimal number size
59690b566fdSJung-uk Kim              */
597a159c266SJung-uk Kim             StringLength = ACPI_MAX_DECIMAL_DIGITS;
598*92f570c3SJung-uk Kim             LeadingZeros = FALSE;
599a159c266SJung-uk Kim             Base = 10;
600a159c266SJung-uk Kim             break;
601a159c266SJung-uk Kim 
602*92f570c3SJung-uk Kim         case ACPI_EXPLICIT_CONVERT_HEX:
603*92f570c3SJung-uk Kim             /*
604*92f570c3SJung-uk Kim              * From ToHexString.
605*92f570c3SJung-uk Kim              *
606*92f570c3SJung-uk Kim              * Supress leading zeros and append "0x"
607*92f570c3SJung-uk Kim              */
608*92f570c3SJung-uk Kim             StringLength = ACPI_MUL_2 (AcpiGbl_IntegerByteWidth) + 2;
609*92f570c3SJung-uk Kim             LeadingZeros = FALSE;
610*92f570c3SJung-uk Kim             break;
611a159c266SJung-uk Kim         default:
612a159c266SJung-uk Kim 
613a159c266SJung-uk Kim             /* Two hex string characters for each integer byte */
614a159c266SJung-uk Kim 
615a159c266SJung-uk Kim             StringLength = ACPI_MUL_2 (AcpiGbl_IntegerByteWidth);
616*92f570c3SJung-uk Kim             LeadingZeros = TRUE;
617a159c266SJung-uk Kim             break;
618a159c266SJung-uk Kim         }
619a159c266SJung-uk Kim 
620a159c266SJung-uk Kim         /*
621a159c266SJung-uk Kim          * Create a new String
622a159c266SJung-uk Kim          * Need enough space for one ASCII integer (plus null terminator)
623a159c266SJung-uk Kim          */
624a159c266SJung-uk Kim         ReturnDesc = AcpiUtCreateStringObject ((ACPI_SIZE) StringLength);
625a159c266SJung-uk Kim         if (!ReturnDesc)
626a159c266SJung-uk Kim         {
627a159c266SJung-uk Kim             return_ACPI_STATUS (AE_NO_MEMORY);
628a159c266SJung-uk Kim         }
629a159c266SJung-uk Kim 
630a159c266SJung-uk Kim         NewBuf = ReturnDesc->Buffer.Pointer;
631*92f570c3SJung-uk Kim         if (Type == ACPI_EXPLICIT_CONVERT_HEX)
632*92f570c3SJung-uk Kim         {
633*92f570c3SJung-uk Kim             /* Append "0x" prefix for explicit hex conversion */
634*92f570c3SJung-uk Kim 
635*92f570c3SJung-uk Kim             *NewBuf++ = '0';
636*92f570c3SJung-uk Kim             *NewBuf++ = 'x';
637*92f570c3SJung-uk Kim         }
638a159c266SJung-uk Kim 
639a159c266SJung-uk Kim         /* Convert integer to string */
640a159c266SJung-uk Kim 
641f8146b88SJung-uk Kim         StringLength = AcpiExConvertToAscii (
642*92f570c3SJung-uk Kim             ObjDesc->Integer.Value, Base, NewBuf, AcpiGbl_IntegerByteWidth, LeadingZeros);
643a159c266SJung-uk Kim 
644a159c266SJung-uk Kim         /* Null terminate at the correct place */
645a159c266SJung-uk Kim 
646a159c266SJung-uk Kim         ReturnDesc->String.Length = StringLength;
647*92f570c3SJung-uk Kim         if (Type == ACPI_EXPLICIT_CONVERT_HEX)
648*92f570c3SJung-uk Kim         {
649*92f570c3SJung-uk Kim             /* Take "0x" prefix into account */
650*92f570c3SJung-uk Kim 
651*92f570c3SJung-uk Kim             ReturnDesc->String.Length += 2;
652*92f570c3SJung-uk Kim         }
653*92f570c3SJung-uk Kim 
654a159c266SJung-uk Kim         NewBuf [StringLength] = 0;
655a159c266SJung-uk Kim         break;
656a159c266SJung-uk Kim 
657a159c266SJung-uk Kim     case ACPI_TYPE_BUFFER:
658a159c266SJung-uk Kim 
659a159c266SJung-uk Kim         /* Setup string length, base, and separator */
660a159c266SJung-uk Kim 
661a159c266SJung-uk Kim         switch (Type)
662a159c266SJung-uk Kim         {
663a159c266SJung-uk Kim         case ACPI_EXPLICIT_CONVERT_DECIMAL: /* Used by ToDecimalString */
664a159c266SJung-uk Kim             /*
66590b566fdSJung-uk Kim              * Explicit conversion from the ToDecimalString ASL operator.
66690b566fdSJung-uk Kim              *
66790b566fdSJung-uk Kim              * From ACPI: "If the input is a buffer, it is converted to a
66890b566fdSJung-uk Kim              * a string of decimal values separated by commas."
669a159c266SJung-uk Kim              */
670*92f570c3SJung-uk Kim             LeadingZeros = FALSE;
671a159c266SJung-uk Kim             Base = 10;
672a159c266SJung-uk Kim 
673a159c266SJung-uk Kim             /*
674a159c266SJung-uk Kim              * Calculate the final string length. Individual string values
675a159c266SJung-uk Kim              * are variable length (include separator for each)
676a159c266SJung-uk Kim              */
677a159c266SJung-uk Kim             for (i = 0; i < ObjDesc->Buffer.Length; i++)
678a159c266SJung-uk Kim             {
679a159c266SJung-uk Kim                 if (ObjDesc->Buffer.Pointer[i] >= 100)
680a159c266SJung-uk Kim                 {
681a159c266SJung-uk Kim                     StringLength += 4;
682a159c266SJung-uk Kim                 }
683a159c266SJung-uk Kim                 else if (ObjDesc->Buffer.Pointer[i] >= 10)
684a159c266SJung-uk Kim                 {
685a159c266SJung-uk Kim                     StringLength += 3;
686a159c266SJung-uk Kim                 }
687a159c266SJung-uk Kim                 else
688a159c266SJung-uk Kim                 {
689a159c266SJung-uk Kim                     StringLength += 2;
690a159c266SJung-uk Kim                 }
691a159c266SJung-uk Kim             }
692a159c266SJung-uk Kim             break;
693a159c266SJung-uk Kim 
694a159c266SJung-uk Kim         case ACPI_IMPLICIT_CONVERT_HEX:
695a159c266SJung-uk Kim             /*
69690b566fdSJung-uk Kim              * Implicit buffer-to-string conversion
69790b566fdSJung-uk Kim              *
698a159c266SJung-uk Kim              * From the ACPI spec:
699a159c266SJung-uk Kim              * "The entire contents of the buffer are converted to a string of
700a159c266SJung-uk Kim              * two-character hexadecimal numbers, each separated by a space."
70190b566fdSJung-uk Kim              *
70290b566fdSJung-uk Kim              * Each hex number is prefixed with 0x (11/2018)
703a159c266SJung-uk Kim              */
704*92f570c3SJung-uk Kim             LeadingZeros = TRUE;
705a159c266SJung-uk Kim             Separator = ' ';
70690b566fdSJung-uk Kim             StringLength = (ObjDesc->Buffer.Length * 5);
707a159c266SJung-uk Kim             break;
708a159c266SJung-uk Kim 
70990b566fdSJung-uk Kim         case ACPI_EXPLICIT_CONVERT_HEX:
710a159c266SJung-uk Kim             /*
71190b566fdSJung-uk Kim              * Explicit conversion from the ToHexString ASL operator.
71290b566fdSJung-uk Kim              *
713a159c266SJung-uk Kim              * From ACPI: "If Data is a buffer, it is converted to a string of
714a159c266SJung-uk Kim              * hexadecimal values separated by commas."
71590b566fdSJung-uk Kim              *
71690b566fdSJung-uk Kim              * Each hex number is prefixed with 0x (11/2018)
717a159c266SJung-uk Kim              */
718*92f570c3SJung-uk Kim             LeadingZeros = TRUE;
71990b566fdSJung-uk Kim             Separator = ',';
72090b566fdSJung-uk Kim             StringLength = (ObjDesc->Buffer.Length * 5);
721a159c266SJung-uk Kim             break;
722a159c266SJung-uk Kim 
723a159c266SJung-uk Kim         default:
724a159c266SJung-uk Kim             return_ACPI_STATUS (AE_BAD_PARAMETER);
725a159c266SJung-uk Kim         }
726a159c266SJung-uk Kim 
727a159c266SJung-uk Kim         /*
728a159c266SJung-uk Kim          * Create a new string object and string buffer
729a159c266SJung-uk Kim          * (-1 because of extra separator included in StringLength from above)
730a159c266SJung-uk Kim          * Allow creation of zero-length strings from zero-length buffers.
731a159c266SJung-uk Kim          */
732a159c266SJung-uk Kim         if (StringLength)
733a159c266SJung-uk Kim         {
734a159c266SJung-uk Kim             StringLength--;
735a159c266SJung-uk Kim         }
736a159c266SJung-uk Kim 
737a159c266SJung-uk Kim         ReturnDesc = AcpiUtCreateStringObject ((ACPI_SIZE) StringLength);
738a159c266SJung-uk Kim         if (!ReturnDesc)
739a159c266SJung-uk Kim         {
740a159c266SJung-uk Kim             return_ACPI_STATUS (AE_NO_MEMORY);
741a159c266SJung-uk Kim         }
742a159c266SJung-uk Kim 
743a159c266SJung-uk Kim         NewBuf = ReturnDesc->Buffer.Pointer;
744a159c266SJung-uk Kim 
745a159c266SJung-uk Kim         /*
746a159c266SJung-uk Kim          * Convert buffer bytes to hex or decimal values
747a159c266SJung-uk Kim          * (separated by commas or spaces)
748a159c266SJung-uk Kim          */
749a159c266SJung-uk Kim         for (i = 0; i < ObjDesc->Buffer.Length; i++)
750a159c266SJung-uk Kim         {
75190b566fdSJung-uk Kim             if (Base == 16)
75290b566fdSJung-uk Kim             {
753cd6518c7SJung-uk Kim                 /* Emit 0x prefix for explicit/implicit hex conversion */
75490b566fdSJung-uk Kim 
75590b566fdSJung-uk Kim                 *NewBuf++ = '0';
75690b566fdSJung-uk Kim                 *NewBuf++ = 'x';
75790b566fdSJung-uk Kim             }
75890b566fdSJung-uk Kim 
759a159c266SJung-uk Kim             NewBuf += AcpiExConvertToAscii (
760*92f570c3SJung-uk Kim                 (UINT64) ObjDesc->Buffer.Pointer[i], Base, NewBuf, 1, LeadingZeros);
76190b566fdSJung-uk Kim 
76290b566fdSJung-uk Kim             /* Each digit is separated by either a comma or space */
76390b566fdSJung-uk Kim 
76490b566fdSJung-uk Kim             *NewBuf++ = Separator;
765a159c266SJung-uk Kim         }
766a159c266SJung-uk Kim 
767a159c266SJung-uk Kim         /*
768a159c266SJung-uk Kim          * Null terminate the string
769a159c266SJung-uk Kim          * (overwrites final comma/space from above)
770a159c266SJung-uk Kim          */
771a159c266SJung-uk Kim         if (ObjDesc->Buffer.Length)
772a159c266SJung-uk Kim         {
773a159c266SJung-uk Kim             NewBuf--;
774a159c266SJung-uk Kim         }
775a159c266SJung-uk Kim         *NewBuf = 0;
776a159c266SJung-uk Kim         break;
777a159c266SJung-uk Kim 
778a159c266SJung-uk Kim     default:
779a9d8d09cSJung-uk Kim 
780a159c266SJung-uk Kim         return_ACPI_STATUS (AE_TYPE);
781a159c266SJung-uk Kim     }
782a159c266SJung-uk Kim 
783a159c266SJung-uk Kim     *ResultDesc = ReturnDesc;
784a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
785a159c266SJung-uk Kim }
786a159c266SJung-uk Kim 
787a159c266SJung-uk Kim 
788a159c266SJung-uk Kim /*******************************************************************************
789a159c266SJung-uk Kim  *
790a159c266SJung-uk Kim  * FUNCTION:    AcpiExConvertToTargetType
791a159c266SJung-uk Kim  *
792a159c266SJung-uk Kim  * PARAMETERS:  DestinationType     - Current type of the destination
793a159c266SJung-uk Kim  *              SourceDesc          - Source object to be converted.
794a159c266SJung-uk Kim  *              ResultDesc          - Where the converted object is returned
795a159c266SJung-uk Kim  *              WalkState           - Current method state
796a159c266SJung-uk Kim  *
797a159c266SJung-uk Kim  * RETURN:      Status
798a159c266SJung-uk Kim  *
799a159c266SJung-uk Kim  * DESCRIPTION: Implements "implicit conversion" rules for storing an object.
800a159c266SJung-uk Kim  *
801a159c266SJung-uk Kim  ******************************************************************************/
802a159c266SJung-uk Kim 
803a159c266SJung-uk Kim ACPI_STATUS
804a159c266SJung-uk Kim AcpiExConvertToTargetType (
805a159c266SJung-uk Kim     ACPI_OBJECT_TYPE        DestinationType,
806a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *SourceDesc,
807a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     **ResultDesc,
808a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
809a159c266SJung-uk Kim {
810a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
811a159c266SJung-uk Kim 
812a159c266SJung-uk Kim 
813a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (ExConvertToTargetType);
814a159c266SJung-uk Kim 
815a159c266SJung-uk Kim 
816a159c266SJung-uk Kim     /* Default behavior */
817a159c266SJung-uk Kim 
818a159c266SJung-uk Kim     *ResultDesc = SourceDesc;
819a159c266SJung-uk Kim 
820a159c266SJung-uk Kim     /*
821a159c266SJung-uk Kim      * If required by the target,
822a159c266SJung-uk Kim      * perform implicit conversion on the source before we store it.
823a159c266SJung-uk Kim      */
824a159c266SJung-uk Kim     switch (GET_CURRENT_ARG_TYPE (WalkState->OpInfo->RuntimeArgs))
825a159c266SJung-uk Kim     {
826a159c266SJung-uk Kim     case ARGI_SIMPLE_TARGET:
827ff879b07SJung-uk Kim     case ARGI_FIXED_TARGET:
828a159c266SJung-uk Kim     case ARGI_INTEGER_REF:      /* Handles Increment, Decrement cases */
829a159c266SJung-uk Kim 
830a159c266SJung-uk Kim         switch (DestinationType)
831a159c266SJung-uk Kim         {
832a159c266SJung-uk Kim         case ACPI_TYPE_LOCAL_REGION_FIELD:
833a159c266SJung-uk Kim             /*
834a159c266SJung-uk Kim              * Named field can always handle conversions
835a159c266SJung-uk Kim              */
836a159c266SJung-uk Kim             break;
837a159c266SJung-uk Kim 
838a159c266SJung-uk Kim         default:
839a9d8d09cSJung-uk Kim 
840a159c266SJung-uk Kim             /* No conversion allowed for these types */
841a159c266SJung-uk Kim 
842a159c266SJung-uk Kim             if (DestinationType != SourceDesc->Common.Type)
843a159c266SJung-uk Kim             {
844a159c266SJung-uk Kim                 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
845a159c266SJung-uk Kim                     "Explicit operator, will store (%s) over existing type (%s)\n",
846a159c266SJung-uk Kim                     AcpiUtGetObjectTypeName (SourceDesc),
847a159c266SJung-uk Kim                     AcpiUtGetTypeName (DestinationType)));
848a159c266SJung-uk Kim                 Status = AE_TYPE;
849a159c266SJung-uk Kim             }
850a159c266SJung-uk Kim         }
851a159c266SJung-uk Kim         break;
852a159c266SJung-uk Kim 
853a159c266SJung-uk Kim     case ARGI_TARGETREF:
854f8146b88SJung-uk Kim     case ARGI_STORE_TARGET:
855a159c266SJung-uk Kim 
856a159c266SJung-uk Kim         switch (DestinationType)
857a159c266SJung-uk Kim         {
858a159c266SJung-uk Kim         case ACPI_TYPE_INTEGER:
859a159c266SJung-uk Kim         case ACPI_TYPE_BUFFER_FIELD:
860a159c266SJung-uk Kim         case ACPI_TYPE_LOCAL_BANK_FIELD:
861a159c266SJung-uk Kim         case ACPI_TYPE_LOCAL_INDEX_FIELD:
862a159c266SJung-uk Kim             /*
863a159c266SJung-uk Kim              * These types require an Integer operand. We can convert
864a159c266SJung-uk Kim              * a Buffer or a String to an Integer if necessary.
865a159c266SJung-uk Kim              */
866493deb39SJung-uk Kim             Status = AcpiExConvertToInteger (SourceDesc, ResultDesc,
8672f6a1a81SJung-uk Kim                 ACPI_IMPLICIT_CONVERSION);
868a159c266SJung-uk Kim             break;
869a159c266SJung-uk Kim 
870a159c266SJung-uk Kim         case ACPI_TYPE_STRING:
871a159c266SJung-uk Kim             /*
872a159c266SJung-uk Kim              * The operand must be a String. We can convert an
873a159c266SJung-uk Kim              * Integer or Buffer if necessary
874a159c266SJung-uk Kim              */
875a159c266SJung-uk Kim             Status = AcpiExConvertToString (SourceDesc, ResultDesc,
876a159c266SJung-uk Kim                 ACPI_IMPLICIT_CONVERT_HEX);
877a159c266SJung-uk Kim             break;
878a159c266SJung-uk Kim 
879a159c266SJung-uk Kim         case ACPI_TYPE_BUFFER:
880a159c266SJung-uk Kim             /*
881a159c266SJung-uk Kim              * The operand must be a Buffer. We can convert an
882a159c266SJung-uk Kim              * Integer or String if necessary
883a159c266SJung-uk Kim              */
884a159c266SJung-uk Kim             Status = AcpiExConvertToBuffer (SourceDesc, ResultDesc);
885a159c266SJung-uk Kim             break;
886a159c266SJung-uk Kim 
887a159c266SJung-uk Kim         default:
888a9d8d09cSJung-uk Kim 
889f8146b88SJung-uk Kim             ACPI_ERROR ((AE_INFO,
890f8146b88SJung-uk Kim                 "Bad destination type during conversion: 0x%X",
891a159c266SJung-uk Kim                 DestinationType));
892a159c266SJung-uk Kim             Status = AE_AML_INTERNAL;
893a159c266SJung-uk Kim             break;
894a159c266SJung-uk Kim         }
895a159c266SJung-uk Kim         break;
896a159c266SJung-uk Kim 
897a159c266SJung-uk Kim     case ARGI_REFERENCE:
898a159c266SJung-uk Kim         /*
899a159c266SJung-uk Kim          * CreateXxxxField cases - we are storing the field object into the name
900a159c266SJung-uk Kim          */
901a159c266SJung-uk Kim         break;
902a159c266SJung-uk Kim 
903a159c266SJung-uk Kim     default:
904a9d8d09cSJung-uk Kim 
905a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
906a159c266SJung-uk Kim             "Unknown Target type ID 0x%X AmlOpcode 0x%X DestType %s",
907a159c266SJung-uk Kim             GET_CURRENT_ARG_TYPE (WalkState->OpInfo->RuntimeArgs),
908a159c266SJung-uk Kim             WalkState->Opcode, AcpiUtGetTypeName (DestinationType)));
909a159c266SJung-uk Kim         Status = AE_AML_INTERNAL;
910a159c266SJung-uk Kim     }
911a159c266SJung-uk Kim 
912a159c266SJung-uk Kim     /*
913a159c266SJung-uk Kim      * Source-to-Target conversion semantics:
914a159c266SJung-uk Kim      *
915a159c266SJung-uk Kim      * If conversion to the target type cannot be performed, then simply
916a159c266SJung-uk Kim      * overwrite the target with the new object and type.
917a159c266SJung-uk Kim      */
918a159c266SJung-uk Kim     if (Status == AE_TYPE)
919a159c266SJung-uk Kim     {
920a159c266SJung-uk Kim         Status = AE_OK;
921a159c266SJung-uk Kim     }
922a159c266SJung-uk Kim 
923a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
924a159c266SJung-uk Kim }
925