1 /******************************************************************************
3 * Module Name: nsconvert - Object conversions for objects returned by
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2015, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
52 #define _COMPONENT ACPI_NAMESPACE
53 ACPI_MODULE_NAME ("nsconvert")
56 /*******************************************************************************
58 * FUNCTION: AcpiNsConvertToInteger
60 * PARAMETERS: OriginalObject - Object to be converted
61 * ReturnObject - Where the new converted object is returned
63 * RETURN: Status. AE_OK if conversion was successful.
65 * DESCRIPTION: Attempt to convert a String/Buffer object to an Integer.
67 ******************************************************************************/
70 AcpiNsConvertToInteger (
71 ACPI_OPERAND_OBJECT *OriginalObject,
72 ACPI_OPERAND_OBJECT **ReturnObject)
74 ACPI_OPERAND_OBJECT *NewObject;
80 switch (OriginalObject->Common.Type)
82 case ACPI_TYPE_STRING:
84 /* String-to-Integer conversion */
86 Status = AcpiUtStrtoul64 (OriginalObject->String.Pointer,
87 ACPI_ANY_BASE, &Value);
88 if (ACPI_FAILURE (Status))
94 case ACPI_TYPE_BUFFER:
96 /* Buffer-to-Integer conversion. Max buffer size is 64 bits. */
98 if (OriginalObject->Buffer.Length > 8)
100 return (AE_AML_OPERAND_TYPE);
103 /* Extract each buffer byte to create the integer */
105 for (i = 0; i < OriginalObject->Buffer.Length; i++)
107 Value |= ((UINT64) OriginalObject->Buffer.Pointer[i] << (i * 8));
113 return (AE_AML_OPERAND_TYPE);
116 NewObject = AcpiUtCreateIntegerObject (Value);
119 return (AE_NO_MEMORY);
122 *ReturnObject = NewObject;
127 /*******************************************************************************
129 * FUNCTION: AcpiNsConvertToString
131 * PARAMETERS: OriginalObject - Object to be converted
132 * ReturnObject - Where the new converted object is returned
134 * RETURN: Status. AE_OK if conversion was successful.
136 * DESCRIPTION: Attempt to convert a Integer/Buffer object to a String.
138 ******************************************************************************/
141 AcpiNsConvertToString (
142 ACPI_OPERAND_OBJECT *OriginalObject,
143 ACPI_OPERAND_OBJECT **ReturnObject)
145 ACPI_OPERAND_OBJECT *NewObject;
150 switch (OriginalObject->Common.Type)
152 case ACPI_TYPE_INTEGER:
154 * Integer-to-String conversion. Commonly, convert
155 * an integer of value 0 to a NULL string. The last element of
156 * _BIF and _BIX packages occasionally need this fix.
158 if (OriginalObject->Integer.Value == 0)
160 /* Allocate a new NULL string object */
162 NewObject = AcpiUtCreateStringObject (0);
165 return (AE_NO_MEMORY);
170 Status = AcpiExConvertToString (OriginalObject, &NewObject,
171 ACPI_IMPLICIT_CONVERT_HEX);
172 if (ACPI_FAILURE (Status))
179 case ACPI_TYPE_BUFFER:
181 * Buffer-to-String conversion. Use a ToString
182 * conversion, no transform performed on the buffer data. The best
183 * example of this is the _BIF method, where the string data from
184 * the battery is often (incorrectly) returned as buffer object(s).
187 while ((Length < OriginalObject->Buffer.Length) &&
188 (OriginalObject->Buffer.Pointer[Length]))
193 /* Allocate a new string object */
195 NewObject = AcpiUtCreateStringObject (Length);
198 return (AE_NO_MEMORY);
202 * Copy the raw buffer data with no transform. String is already NULL
203 * terminated at Length+1.
205 memcpy (NewObject->String.Pointer,
206 OriginalObject->Buffer.Pointer, Length);
211 return (AE_AML_OPERAND_TYPE);
214 *ReturnObject = NewObject;
219 /*******************************************************************************
221 * FUNCTION: AcpiNsConvertToBuffer
223 * PARAMETERS: OriginalObject - Object to be converted
224 * ReturnObject - Where the new converted object is returned
226 * RETURN: Status. AE_OK if conversion was successful.
228 * DESCRIPTION: Attempt to convert a Integer/String/Package object to a Buffer.
230 ******************************************************************************/
233 AcpiNsConvertToBuffer (
234 ACPI_OPERAND_OBJECT *OriginalObject,
235 ACPI_OPERAND_OBJECT **ReturnObject)
237 ACPI_OPERAND_OBJECT *NewObject;
239 ACPI_OPERAND_OBJECT **Elements;
245 switch (OriginalObject->Common.Type)
247 case ACPI_TYPE_INTEGER:
249 * Integer-to-Buffer conversion.
250 * Convert the Integer to a packed-byte buffer. _MAT and other
251 * objects need this sometimes, if a read has been performed on a
252 * Field object that is less than or equal to the global integer
253 * size (32 or 64 bits).
255 Status = AcpiExConvertToBuffer (OriginalObject, &NewObject);
256 if (ACPI_FAILURE (Status))
262 case ACPI_TYPE_STRING:
264 /* String-to-Buffer conversion. Simple data copy */
266 NewObject = AcpiUtCreateBufferObject (OriginalObject->String.Length);
269 return (AE_NO_MEMORY);
272 memcpy (NewObject->Buffer.Pointer,
273 OriginalObject->String.Pointer, OriginalObject->String.Length);
276 case ACPI_TYPE_PACKAGE:
278 * This case is often seen for predefined names that must return a
279 * Buffer object with multiple DWORD integers within. For example,
280 * _FDE and _GTM. The Package can be converted to a Buffer.
283 /* All elements of the Package must be integers */
285 Elements = OriginalObject->Package.Elements;
286 Count = OriginalObject->Package.Count;
288 for (i = 0; i < Count; i++)
291 ((*Elements)->Common.Type != ACPI_TYPE_INTEGER))
293 return (AE_AML_OPERAND_TYPE);
298 /* Create the new buffer object to replace the Package */
300 NewObject = AcpiUtCreateBufferObject (ACPI_MUL_4 (Count));
303 return (AE_NO_MEMORY);
306 /* Copy the package elements (integers) to the buffer as DWORDs */
308 Elements = OriginalObject->Package.Elements;
309 DwordBuffer = ACPI_CAST_PTR (UINT32, NewObject->Buffer.Pointer);
311 for (i = 0; i < Count; i++)
313 *DwordBuffer = (UINT32) (*Elements)->Integer.Value;
321 return (AE_AML_OPERAND_TYPE);
324 *ReturnObject = NewObject;
329 /*******************************************************************************
331 * FUNCTION: AcpiNsConvertToUnicode
333 * PARAMETERS: OriginalObject - ASCII String Object to be converted
334 * ReturnObject - Where the new converted object is returned
336 * RETURN: Status. AE_OK if conversion was successful.
338 * DESCRIPTION: Attempt to convert a String object to a Unicode string Buffer.
340 ******************************************************************************/
343 AcpiNsConvertToUnicode (
344 ACPI_OPERAND_OBJECT *OriginalObject,
345 ACPI_OPERAND_OBJECT **ReturnObject)
347 ACPI_OPERAND_OBJECT *NewObject;
349 UINT16 *UnicodeBuffer;
350 UINT32 UnicodeLength;
359 /* If a Buffer was returned, it must be at least two bytes long */
361 if (OriginalObject->Common.Type == ACPI_TYPE_BUFFER)
363 if (OriginalObject->Buffer.Length < 2)
365 return (AE_AML_OPERAND_VALUE);
368 *ReturnObject = NULL;
373 * The original object is an ASCII string. Convert this string to
376 AsciiString = OriginalObject->String.Pointer;
377 UnicodeLength = (OriginalObject->String.Length * 2) + 2;
379 /* Create a new buffer object for the Unicode data */
381 NewObject = AcpiUtCreateBufferObject (UnicodeLength);
384 return (AE_NO_MEMORY);
387 UnicodeBuffer = ACPI_CAST_PTR (UINT16, NewObject->Buffer.Pointer);
389 /* Convert ASCII to Unicode */
391 for (i = 0; i < OriginalObject->String.Length; i++)
393 UnicodeBuffer[i] = (UINT16) AsciiString[i];
396 *ReturnObject = NewObject;
401 /*******************************************************************************
403 * FUNCTION: AcpiNsConvertToResource
405 * PARAMETERS: OriginalObject - Object to be converted
406 * ReturnObject - Where the new converted object is returned
408 * RETURN: Status. AE_OK if conversion was successful
410 * DESCRIPTION: Attempt to convert a Integer object to a ResourceTemplate
413 ******************************************************************************/
416 AcpiNsConvertToResource (
417 ACPI_OPERAND_OBJECT *OriginalObject,
418 ACPI_OPERAND_OBJECT **ReturnObject)
420 ACPI_OPERAND_OBJECT *NewObject;
425 * We can fix the following cases for an expected resource template:
426 * 1. No return value (interpreter slack mode is disabled)
427 * 2. A "Return (Zero)" statement
428 * 3. A "Return empty buffer" statement
430 * We will return a buffer containing a single EndTag
431 * resource descriptor.
435 switch (OriginalObject->Common.Type)
437 case ACPI_TYPE_INTEGER:
439 /* We can only repair an Integer==0 */
441 if (OriginalObject->Integer.Value)
443 return (AE_AML_OPERAND_TYPE);
447 case ACPI_TYPE_BUFFER:
449 if (OriginalObject->Buffer.Length)
451 /* Additional checks can be added in the future */
453 *ReturnObject = NULL;
458 case ACPI_TYPE_STRING:
461 return (AE_AML_OPERAND_TYPE);
465 /* Create the new buffer object for the resource descriptor */
467 NewObject = AcpiUtCreateBufferObject (2);
470 return (AE_NO_MEMORY);
473 Buffer = ACPI_CAST_PTR (UINT8, NewObject->Buffer.Pointer);
475 /* Initialize the Buffer with a single EndTag descriptor */
477 Buffer[0] = (ACPI_RESOURCE_NAME_END_TAG | ASL_RDESC_END_TAG_SIZE);
480 *ReturnObject = NewObject;