1 /****************************************************************************** 2 * 3 * Module Name: nsconvert - Object conversions for objects returned by 4 * predefined methods 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 #include "acpi.h" 118 #include "accommon.h" 119 #include "acnamesp.h" 120 #include "acinterp.h" 121 #include "acpredef.h" 122 #include "amlresrc.h" 123 124 #define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nsconvert") 126 127 128 /******************************************************************************* 129 * 130 * FUNCTION: AcpiNsConvertToInteger 131 * 132 * PARAMETERS: OriginalObject - Object to be converted 133 * ReturnObject - Where the new converted object is returned 134 * 135 * RETURN: Status. AE_OK if conversion was successful. 136 * 137 * DESCRIPTION: Attempt to convert a String/Buffer object to an Integer. 138 * 139 ******************************************************************************/ 140 141 ACPI_STATUS 142 AcpiNsConvertToInteger ( 143 ACPI_OPERAND_OBJECT *OriginalObject, 144 ACPI_OPERAND_OBJECT **ReturnObject) 145 { 146 ACPI_OPERAND_OBJECT *NewObject; 147 ACPI_STATUS Status; 148 UINT64 Value = 0; 149 UINT32 i; 150 151 152 switch (OriginalObject->Common.Type) 153 { 154 case ACPI_TYPE_STRING: 155 156 /* String-to-Integer conversion */ 157 158 Status = AcpiUtStrtoul64 (OriginalObject->String.Pointer, 159 ACPI_ANY_BASE, &Value); 160 if (ACPI_FAILURE (Status)) 161 { 162 return (Status); 163 } 164 break; 165 166 case ACPI_TYPE_BUFFER: 167 168 /* Buffer-to-Integer conversion. Max buffer size is 64 bits. */ 169 170 if (OriginalObject->Buffer.Length > 8) 171 { 172 return (AE_AML_OPERAND_TYPE); 173 } 174 175 /* Extract each buffer byte to create the integer */ 176 177 for (i = 0; i < OriginalObject->Buffer.Length; i++) 178 { 179 Value |= ((UINT64) OriginalObject->Buffer.Pointer[i] << (i * 8)); 180 } 181 break; 182 183 default: 184 185 return (AE_AML_OPERAND_TYPE); 186 } 187 188 NewObject = AcpiUtCreateIntegerObject (Value); 189 if (!NewObject) 190 { 191 return (AE_NO_MEMORY); 192 } 193 194 *ReturnObject = NewObject; 195 return (AE_OK); 196 } 197 198 199 /******************************************************************************* 200 * 201 * FUNCTION: AcpiNsConvertToString 202 * 203 * PARAMETERS: OriginalObject - Object to be converted 204 * ReturnObject - Where the new converted object is returned 205 * 206 * RETURN: Status. AE_OK if conversion was successful. 207 * 208 * DESCRIPTION: Attempt to convert a Integer/Buffer object to a String. 209 * 210 ******************************************************************************/ 211 212 ACPI_STATUS 213 AcpiNsConvertToString ( 214 ACPI_OPERAND_OBJECT *OriginalObject, 215 ACPI_OPERAND_OBJECT **ReturnObject) 216 { 217 ACPI_OPERAND_OBJECT *NewObject; 218 ACPI_SIZE Length; 219 ACPI_STATUS Status; 220 221 222 switch (OriginalObject->Common.Type) 223 { 224 case ACPI_TYPE_INTEGER: 225 /* 226 * Integer-to-String conversion. Commonly, convert 227 * an integer of value 0 to a NULL string. The last element of 228 * _BIF and _BIX packages occasionally need this fix. 229 */ 230 if (OriginalObject->Integer.Value == 0) 231 { 232 /* Allocate a new NULL string object */ 233 234 NewObject = AcpiUtCreateStringObject (0); 235 if (!NewObject) 236 { 237 return (AE_NO_MEMORY); 238 } 239 } 240 else 241 { 242 Status = AcpiExConvertToString (OriginalObject, &NewObject, 243 ACPI_IMPLICIT_CONVERT_HEX); 244 if (ACPI_FAILURE (Status)) 245 { 246 return (Status); 247 } 248 } 249 break; 250 251 case ACPI_TYPE_BUFFER: 252 /* 253 * Buffer-to-String conversion. Use a ToString 254 * conversion, no transform performed on the buffer data. The best 255 * example of this is the _BIF method, where the string data from 256 * the battery is often (incorrectly) returned as buffer object(s). 257 */ 258 Length = 0; 259 while ((Length < OriginalObject->Buffer.Length) && 260 (OriginalObject->Buffer.Pointer[Length])) 261 { 262 Length++; 263 } 264 265 /* Allocate a new string object */ 266 267 NewObject = AcpiUtCreateStringObject (Length); 268 if (!NewObject) 269 { 270 return (AE_NO_MEMORY); 271 } 272 273 /* 274 * Copy the raw buffer data with no transform. String is already NULL 275 * terminated at Length+1. 276 */ 277 memcpy (NewObject->String.Pointer, 278 OriginalObject->Buffer.Pointer, Length); 279 break; 280 281 default: 282 283 return (AE_AML_OPERAND_TYPE); 284 } 285 286 *ReturnObject = NewObject; 287 return (AE_OK); 288 } 289 290 291 /******************************************************************************* 292 * 293 * FUNCTION: AcpiNsConvertToBuffer 294 * 295 * PARAMETERS: OriginalObject - Object to be converted 296 * ReturnObject - Where the new converted object is returned 297 * 298 * RETURN: Status. AE_OK if conversion was successful. 299 * 300 * DESCRIPTION: Attempt to convert a Integer/String/Package object to a Buffer. 301 * 302 ******************************************************************************/ 303 304 ACPI_STATUS 305 AcpiNsConvertToBuffer ( 306 ACPI_OPERAND_OBJECT *OriginalObject, 307 ACPI_OPERAND_OBJECT **ReturnObject) 308 { 309 ACPI_OPERAND_OBJECT *NewObject; 310 ACPI_STATUS Status; 311 ACPI_OPERAND_OBJECT **Elements; 312 UINT32 *DwordBuffer; 313 UINT32 Count; 314 UINT32 i; 315 316 317 switch (OriginalObject->Common.Type) 318 { 319 case ACPI_TYPE_INTEGER: 320 /* 321 * Integer-to-Buffer conversion. 322 * Convert the Integer to a packed-byte buffer. _MAT and other 323 * objects need this sometimes, if a read has been performed on a 324 * Field object that is less than or equal to the global integer 325 * size (32 or 64 bits). 326 */ 327 Status = AcpiExConvertToBuffer (OriginalObject, &NewObject); 328 if (ACPI_FAILURE (Status)) 329 { 330 return (Status); 331 } 332 break; 333 334 case ACPI_TYPE_STRING: 335 336 /* String-to-Buffer conversion. Simple data copy */ 337 338 NewObject = AcpiUtCreateBufferObject (OriginalObject->String.Length); 339 if (!NewObject) 340 { 341 return (AE_NO_MEMORY); 342 } 343 344 memcpy (NewObject->Buffer.Pointer, 345 OriginalObject->String.Pointer, OriginalObject->String.Length); 346 break; 347 348 case ACPI_TYPE_PACKAGE: 349 /* 350 * This case is often seen for predefined names that must return a 351 * Buffer object with multiple DWORD integers within. For example, 352 * _FDE and _GTM. The Package can be converted to a Buffer. 353 */ 354 355 /* All elements of the Package must be integers */ 356 357 Elements = OriginalObject->Package.Elements; 358 Count = OriginalObject->Package.Count; 359 360 for (i = 0; i < Count; i++) 361 { 362 if ((!*Elements) || 363 ((*Elements)->Common.Type != ACPI_TYPE_INTEGER)) 364 { 365 return (AE_AML_OPERAND_TYPE); 366 } 367 Elements++; 368 } 369 370 /* Create the new buffer object to replace the Package */ 371 372 NewObject = AcpiUtCreateBufferObject (ACPI_MUL_4 (Count)); 373 if (!NewObject) 374 { 375 return (AE_NO_MEMORY); 376 } 377 378 /* Copy the package elements (integers) to the buffer as DWORDs */ 379 380 Elements = OriginalObject->Package.Elements; 381 DwordBuffer = ACPI_CAST_PTR (UINT32, NewObject->Buffer.Pointer); 382 383 for (i = 0; i < Count; i++) 384 { 385 *DwordBuffer = (UINT32) (*Elements)->Integer.Value; 386 DwordBuffer++; 387 Elements++; 388 } 389 break; 390 391 default: 392 393 return (AE_AML_OPERAND_TYPE); 394 } 395 396 *ReturnObject = NewObject; 397 return (AE_OK); 398 } 399 400 401 /******************************************************************************* 402 * 403 * FUNCTION: AcpiNsConvertToUnicode 404 * 405 * PARAMETERS: OriginalObject - ASCII String Object to be converted 406 * ReturnObject - Where the new converted object is returned 407 * 408 * RETURN: Status. AE_OK if conversion was successful. 409 * 410 * DESCRIPTION: Attempt to convert a String object to a Unicode string Buffer. 411 * 412 ******************************************************************************/ 413 414 ACPI_STATUS 415 AcpiNsConvertToUnicode ( 416 ACPI_OPERAND_OBJECT *OriginalObject, 417 ACPI_OPERAND_OBJECT **ReturnObject) 418 { 419 ACPI_OPERAND_OBJECT *NewObject; 420 char *AsciiString; 421 UINT16 *UnicodeBuffer; 422 UINT32 UnicodeLength; 423 UINT32 i; 424 425 426 if (!OriginalObject) 427 { 428 return (AE_OK); 429 } 430 431 /* If a Buffer was returned, it must be at least two bytes long */ 432 433 if (OriginalObject->Common.Type == ACPI_TYPE_BUFFER) 434 { 435 if (OriginalObject->Buffer.Length < 2) 436 { 437 return (AE_AML_OPERAND_VALUE); 438 } 439 440 *ReturnObject = NULL; 441 return (AE_OK); 442 } 443 444 /* 445 * The original object is an ASCII string. Convert this string to 446 * a unicode buffer. 447 */ 448 AsciiString = OriginalObject->String.Pointer; 449 UnicodeLength = (OriginalObject->String.Length * 2) + 2; 450 451 /* Create a new buffer object for the Unicode data */ 452 453 NewObject = AcpiUtCreateBufferObject (UnicodeLength); 454 if (!NewObject) 455 { 456 return (AE_NO_MEMORY); 457 } 458 459 UnicodeBuffer = ACPI_CAST_PTR (UINT16, NewObject->Buffer.Pointer); 460 461 /* Convert ASCII to Unicode */ 462 463 for (i = 0; i < OriginalObject->String.Length; i++) 464 { 465 UnicodeBuffer[i] = (UINT16) AsciiString[i]; 466 } 467 468 *ReturnObject = NewObject; 469 return (AE_OK); 470 } 471 472 473 /******************************************************************************* 474 * 475 * FUNCTION: AcpiNsConvertToResource 476 * 477 * PARAMETERS: OriginalObject - Object to be converted 478 * ReturnObject - Where the new converted object is returned 479 * 480 * RETURN: Status. AE_OK if conversion was successful 481 * 482 * DESCRIPTION: Attempt to convert a Integer object to a ResourceTemplate 483 * Buffer. 484 * 485 ******************************************************************************/ 486 487 ACPI_STATUS 488 AcpiNsConvertToResource ( 489 ACPI_OPERAND_OBJECT *OriginalObject, 490 ACPI_OPERAND_OBJECT **ReturnObject) 491 { 492 ACPI_OPERAND_OBJECT *NewObject; 493 UINT8 *Buffer; 494 495 496 /* 497 * We can fix the following cases for an expected resource template: 498 * 1. No return value (interpreter slack mode is disabled) 499 * 2. A "Return (Zero)" statement 500 * 3. A "Return empty buffer" statement 501 * 502 * We will return a buffer containing a single EndTag 503 * resource descriptor. 504 */ 505 if (OriginalObject) 506 { 507 switch (OriginalObject->Common.Type) 508 { 509 case ACPI_TYPE_INTEGER: 510 511 /* We can only repair an Integer==0 */ 512 513 if (OriginalObject->Integer.Value) 514 { 515 return (AE_AML_OPERAND_TYPE); 516 } 517 break; 518 519 case ACPI_TYPE_BUFFER: 520 521 if (OriginalObject->Buffer.Length) 522 { 523 /* Additional checks can be added in the future */ 524 525 *ReturnObject = NULL; 526 return (AE_OK); 527 } 528 break; 529 530 case ACPI_TYPE_STRING: 531 default: 532 533 return (AE_AML_OPERAND_TYPE); 534 } 535 } 536 537 /* Create the new buffer object for the resource descriptor */ 538 539 NewObject = AcpiUtCreateBufferObject (2); 540 if (!NewObject) 541 { 542 return (AE_NO_MEMORY); 543 } 544 545 Buffer = ACPI_CAST_PTR (UINT8, NewObject->Buffer.Pointer); 546 547 /* Initialize the Buffer with a single EndTag descriptor */ 548 549 Buffer[0] = (ACPI_RESOURCE_NAME_END_TAG | ASL_RDESC_END_TAG_SIZE); 550 Buffer[1] = 0x00; 551 552 *ReturnObject = NewObject; 553 return (AE_OK); 554 } 555