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 original_object
->buffer
.pointer
[i
] << (i
*
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
);
156 status
= acpi_ex_convert_to_string(original_object
,
158 ACPI_IMPLICIT_CONVERT_HEX
);
159 if (ACPI_FAILURE(status
)) {
165 case ACPI_TYPE_BUFFER
:
167 * Buffer-to-String conversion. Use a to_string
168 * conversion, no transform performed on the buffer data. The best
169 * example of this is the _BIF method, where the string data from
170 * the battery is often (incorrectly) returned as buffer object(s).
173 while ((length
< original_object
->buffer
.length
) &&
174 (original_object
->buffer
.pointer
[length
])) {
178 /* Allocate a new string object */
180 new_object
= acpi_ut_create_string_object(length
);
182 return (AE_NO_MEMORY
);
186 * Copy the raw buffer data with no transform. String is already NULL
187 * terminated at Length+1.
189 memcpy(new_object
->string
.pointer
,
190 original_object
->buffer
.pointer
, length
);
195 return (AE_AML_OPERAND_TYPE
);
198 *return_object
= new_object
;
202 /*******************************************************************************
204 * FUNCTION: acpi_ns_convert_to_buffer
206 * PARAMETERS: original_object - Object to be converted
207 * return_object - Where the new converted object is returned
209 * RETURN: Status. AE_OK if conversion was successful.
211 * DESCRIPTION: Attempt to convert a Integer/String/Package object to a Buffer.
213 ******************************************************************************/
216 acpi_ns_convert_to_buffer(union acpi_operand_object
*original_object
,
217 union acpi_operand_object
**return_object
)
219 union acpi_operand_object
*new_object
;
221 union acpi_operand_object
**elements
;
226 switch (original_object
->common
.type
) {
227 case ACPI_TYPE_INTEGER
:
229 * Integer-to-Buffer conversion.
230 * Convert the Integer to a packed-byte buffer. _MAT and other
231 * objects need this sometimes, if a read has been performed on a
232 * Field object that is less than or equal to the global integer
233 * size (32 or 64 bits).
236 acpi_ex_convert_to_buffer(original_object
, &new_object
);
237 if (ACPI_FAILURE(status
)) {
242 case ACPI_TYPE_STRING
:
244 /* String-to-Buffer conversion. Simple data copy */
246 new_object
= acpi_ut_create_buffer_object
247 (original_object
->string
.length
);
249 return (AE_NO_MEMORY
);
252 memcpy(new_object
->buffer
.pointer
,
253 original_object
->string
.pointer
,
254 original_object
->string
.length
);
257 case ACPI_TYPE_PACKAGE
:
259 * This case is often seen for predefined names that must return a
260 * Buffer object with multiple DWORD integers within. For example,
261 * _FDE and _GTM. The Package can be converted to a Buffer.
264 /* All elements of the Package must be integers */
266 elements
= original_object
->package
.elements
;
267 count
= original_object
->package
.count
;
269 for (i
= 0; i
< count
; i
++) {
271 ((*elements
)->common
.type
!= ACPI_TYPE_INTEGER
)) {
272 return (AE_AML_OPERAND_TYPE
);
277 /* Create the new buffer object to replace the Package */
279 new_object
= acpi_ut_create_buffer_object(ACPI_MUL_4(count
));
281 return (AE_NO_MEMORY
);
284 /* Copy the package elements (integers) to the buffer as DWORDs */
286 elements
= original_object
->package
.elements
;
287 dword_buffer
= ACPI_CAST_PTR(u32
, new_object
->buffer
.pointer
);
289 for (i
= 0; i
< count
; i
++) {
290 *dword_buffer
= (u32
)(*elements
)->integer
.value
;
298 return (AE_AML_OPERAND_TYPE
);
301 *return_object
= new_object
;
305 /*******************************************************************************
307 * FUNCTION: acpi_ns_convert_to_unicode
309 * PARAMETERS: original_object - ASCII String Object to be converted
310 * return_object - Where the new converted object is returned
312 * RETURN: Status. AE_OK if conversion was successful.
314 * DESCRIPTION: Attempt to convert a String object to a Unicode string Buffer.
316 ******************************************************************************/
319 acpi_ns_convert_to_unicode(union acpi_operand_object
*original_object
,
320 union acpi_operand_object
**return_object
)
322 union acpi_operand_object
*new_object
;
328 if (!original_object
) {
332 /* If a Buffer was returned, it must be at least two bytes long */
334 if (original_object
->common
.type
== ACPI_TYPE_BUFFER
) {
335 if (original_object
->buffer
.length
< 2) {
336 return (AE_AML_OPERAND_VALUE
);
339 *return_object
= NULL
;
344 * The original object is an ASCII string. Convert this string to
347 ascii_string
= original_object
->string
.pointer
;
348 unicode_length
= (original_object
->string
.length
* 2) + 2;
350 /* Create a new buffer object for the Unicode data */
352 new_object
= acpi_ut_create_buffer_object(unicode_length
);
354 return (AE_NO_MEMORY
);
357 unicode_buffer
= ACPI_CAST_PTR(u16
, new_object
->buffer
.pointer
);
359 /* Convert ASCII to Unicode */
361 for (i
= 0; i
< original_object
->string
.length
; i
++) {
362 unicode_buffer
[i
] = (u16
)ascii_string
[i
];
365 *return_object
= new_object
;
369 /*******************************************************************************
371 * FUNCTION: acpi_ns_convert_to_resource
373 * PARAMETERS: original_object - Object to be converted
374 * return_object - Where the new converted object is returned
376 * RETURN: Status. AE_OK if conversion was successful
378 * DESCRIPTION: Attempt to convert a Integer object to a resource_template
381 ******************************************************************************/
384 acpi_ns_convert_to_resource(union acpi_operand_object
*original_object
,
385 union acpi_operand_object
**return_object
)
387 union acpi_operand_object
*new_object
;
391 * We can fix the following cases for an expected resource template:
392 * 1. No return value (interpreter slack mode is disabled)
393 * 2. A "Return (Zero)" statement
394 * 3. A "Return empty buffer" statement
396 * We will return a buffer containing a single end_tag
397 * resource descriptor.
399 if (original_object
) {
400 switch (original_object
->common
.type
) {
401 case ACPI_TYPE_INTEGER
:
403 /* We can only repair an Integer==0 */
405 if (original_object
->integer
.value
) {
406 return (AE_AML_OPERAND_TYPE
);
410 case ACPI_TYPE_BUFFER
:
412 if (original_object
->buffer
.length
) {
414 /* Additional checks can be added in the future */
416 *return_object
= NULL
;
421 case ACPI_TYPE_STRING
:
424 return (AE_AML_OPERAND_TYPE
);
428 /* Create the new buffer object for the resource descriptor */
430 new_object
= acpi_ut_create_buffer_object(2);
432 return (AE_NO_MEMORY
);
435 buffer
= ACPI_CAST_PTR(u8
, new_object
->buffer
.pointer
);
437 /* Initialize the Buffer with a single end_tag descriptor */
439 buffer
[0] = (ACPI_RESOURCE_NAME_END_TAG
| ASL_RDESC_END_TAG_SIZE
);
442 *return_object
= new_object
;