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.
45 #include <acpi/acpi.h>
52 #define _COMPONENT ACPI_NAMESPACE
53 ACPI_MODULE_NAME("nsconvert")
55 /*******************************************************************************
57 * FUNCTION: acpi_ns_convert_to_integer
59 * PARAMETERS: original_object - Object to be converted
60 * return_object - Where the new converted object is returned
62 * RETURN: Status. AE_OK if conversion was successful.
64 * DESCRIPTION: Attempt to convert a String/Buffer object to an Integer.
66 ******************************************************************************/
68 acpi_ns_convert_to_integer(union acpi_operand_object *original_object,
69 union acpi_operand_object **return_object)
71 union acpi_operand_object *new_object;
76 switch (original_object->common.type) {
77 case ACPI_TYPE_STRING:
79 /* String-to-Integer conversion */
81 status = acpi_ut_strtoul64(original_object->string.pointer,
82 ACPI_ANY_BASE, &value);
83 if (ACPI_FAILURE(status)) {
88 case ACPI_TYPE_BUFFER:
90 /* Buffer-to-Integer conversion. Max buffer size is 64 bits. */
92 if (original_object->buffer.length > 8) {
93 return (AE_AML_OPERAND_TYPE);
96 /* Extract each buffer byte to create the integer */
98 for (i = 0; i < original_object->buffer.length; i++) {
100 ((u64)original_object->buffer.
101 pointer[i] << (i * 8));
107 return (AE_AML_OPERAND_TYPE);
110 new_object = acpi_ut_create_integer_object(value);
112 return (AE_NO_MEMORY);
115 *return_object = new_object;
119 /*******************************************************************************
121 * FUNCTION: acpi_ns_convert_to_string
123 * PARAMETERS: original_object - Object to be converted
124 * return_object - Where the new converted object is returned
126 * RETURN: Status. AE_OK if conversion was successful.
128 * DESCRIPTION: Attempt to convert a Integer/Buffer object to a String.
130 ******************************************************************************/
133 acpi_ns_convert_to_string(union acpi_operand_object *original_object,
134 union acpi_operand_object **return_object)
136 union acpi_operand_object *new_object;
140 switch (original_object->common.type) {
141 case ACPI_TYPE_INTEGER:
143 * Integer-to-String conversion. Commonly, convert
144 * an integer of value 0 to a NULL string. The last element of
145 * _BIF and _BIX packages occasionally need this fix.
147 if (original_object->integer.value == 0) {
149 /* Allocate a new NULL string object */
151 new_object = acpi_ut_create_string_object(0);
153 return (AE_NO_MEMORY);
157 acpi_ex_convert_to_string(original_object,
159 ACPI_IMPLICIT_CONVERT_HEX);
160 if (ACPI_FAILURE(status)) {
166 case ACPI_TYPE_BUFFER:
168 * Buffer-to-String conversion. Use a to_string
169 * conversion, no transform performed on the buffer data. The best
170 * example of this is the _BIF method, where the string data from
171 * the battery is often (incorrectly) returned as buffer object(s).
174 while ((length < original_object->buffer.length) &&
175 (original_object->buffer.pointer[length])) {
179 /* Allocate a new string object */
181 new_object = acpi_ut_create_string_object(length);
183 return (AE_NO_MEMORY);
187 * Copy the raw buffer data with no transform. String is already NULL
188 * terminated at Length+1.
190 memcpy(new_object->string.pointer,
191 original_object->buffer.pointer, length);
196 return (AE_AML_OPERAND_TYPE);
199 *return_object = new_object;
203 /*******************************************************************************
205 * FUNCTION: acpi_ns_convert_to_buffer
207 * PARAMETERS: original_object - Object to be converted
208 * return_object - Where the new converted object is returned
210 * RETURN: Status. AE_OK if conversion was successful.
212 * DESCRIPTION: Attempt to convert a Integer/String/Package object to a Buffer.
214 ******************************************************************************/
217 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object,
218 union acpi_operand_object **return_object)
220 union acpi_operand_object *new_object;
222 union acpi_operand_object **elements;
227 switch (original_object->common.type) {
228 case ACPI_TYPE_INTEGER:
230 * Integer-to-Buffer conversion.
231 * Convert the Integer to a packed-byte buffer. _MAT and other
232 * objects need this sometimes, if a read has been performed on a
233 * Field object that is less than or equal to the global integer
234 * size (32 or 64 bits).
237 acpi_ex_convert_to_buffer(original_object, &new_object);
238 if (ACPI_FAILURE(status)) {
243 case ACPI_TYPE_STRING:
245 /* String-to-Buffer conversion. Simple data copy */
248 acpi_ut_create_buffer_object(original_object->string.
251 return (AE_NO_MEMORY);
254 memcpy(new_object->buffer.pointer,
255 original_object->string.pointer,
256 original_object->string.length);
259 case ACPI_TYPE_PACKAGE:
261 * This case is often seen for predefined names that must return a
262 * Buffer object with multiple DWORD integers within. For example,
263 * _FDE and _GTM. The Package can be converted to a Buffer.
266 /* All elements of the Package must be integers */
268 elements = original_object->package.elements;
269 count = original_object->package.count;
271 for (i = 0; i < count; i++) {
273 ((*elements)->common.type != ACPI_TYPE_INTEGER)) {
274 return (AE_AML_OPERAND_TYPE);
279 /* Create the new buffer object to replace the Package */
281 new_object = acpi_ut_create_buffer_object(ACPI_MUL_4(count));
283 return (AE_NO_MEMORY);
286 /* Copy the package elements (integers) to the buffer as DWORDs */
288 elements = original_object->package.elements;
289 dword_buffer = ACPI_CAST_PTR(u32, new_object->buffer.pointer);
291 for (i = 0; i < count; i++) {
292 *dword_buffer = (u32)(*elements)->integer.value;
300 return (AE_AML_OPERAND_TYPE);
303 *return_object = new_object;
307 /*******************************************************************************
309 * FUNCTION: acpi_ns_convert_to_unicode
311 * PARAMETERS: original_object - ASCII String Object to be converted
312 * return_object - Where the new converted object is returned
314 * RETURN: Status. AE_OK if conversion was successful.
316 * DESCRIPTION: Attempt to convert a String object to a Unicode string Buffer.
318 ******************************************************************************/
321 acpi_ns_convert_to_unicode(union acpi_operand_object *original_object,
322 union acpi_operand_object **return_object)
324 union acpi_operand_object *new_object;
330 if (!original_object) {
334 /* If a Buffer was returned, it must be at least two bytes long */
336 if (original_object->common.type == ACPI_TYPE_BUFFER) {
337 if (original_object->buffer.length < 2) {
338 return (AE_AML_OPERAND_VALUE);
341 *return_object = NULL;
346 * The original object is an ASCII string. Convert this string to
349 ascii_string = original_object->string.pointer;
350 unicode_length = (original_object->string.length * 2) + 2;
352 /* Create a new buffer object for the Unicode data */
354 new_object = acpi_ut_create_buffer_object(unicode_length);
356 return (AE_NO_MEMORY);
359 unicode_buffer = ACPI_CAST_PTR(u16, new_object->buffer.pointer);
361 /* Convert ASCII to Unicode */
363 for (i = 0; i < original_object->string.length; i++) {
364 unicode_buffer[i] = (u16)ascii_string[i];
367 *return_object = new_object;
371 /*******************************************************************************
373 * FUNCTION: acpi_ns_convert_to_resource
375 * PARAMETERS: original_object - Object to be converted
376 * return_object - Where the new converted object is returned
378 * RETURN: Status. AE_OK if conversion was successful
380 * DESCRIPTION: Attempt to convert a Integer object to a resource_template
383 ******************************************************************************/
386 acpi_ns_convert_to_resource(union acpi_operand_object *original_object,
387 union acpi_operand_object **return_object)
389 union acpi_operand_object *new_object;
393 * We can fix the following cases for an expected resource template:
394 * 1. No return value (interpreter slack mode is disabled)
395 * 2. A "Return (Zero)" statement
396 * 3. A "Return empty buffer" statement
398 * We will return a buffer containing a single end_tag
399 * resource descriptor.
401 if (original_object) {
402 switch (original_object->common.type) {
403 case ACPI_TYPE_INTEGER:
405 /* We can only repair an Integer==0 */
407 if (original_object->integer.value) {
408 return (AE_AML_OPERAND_TYPE);
412 case ACPI_TYPE_BUFFER:
414 if (original_object->buffer.length) {
416 /* Additional checks can be added in the future */
418 *return_object = NULL;
423 case ACPI_TYPE_STRING:
426 return (AE_AML_OPERAND_TYPE);
430 /* Create the new buffer object for the resource descriptor */
432 new_object = acpi_ut_create_buffer_object(2);
434 return (AE_NO_MEMORY);
437 buffer = ACPI_CAST_PTR(u8, new_object->buffer.pointer);
439 /* Initialize the Buffer with a single end_tag descriptor */
441 buffer[0] = (ACPI_RESOURCE_NAME_END_TAG | ASL_RDESC_END_TAG_SIZE);
444 *return_object = new_object;