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 - 2016, 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, AcpiGbl_IntegerByteWidth, &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) 180 OriginalObject->Buffer.Pointer[i] << (i * 8)); 181 } 182 break; 183 184 default: 185 186 return (AE_AML_OPERAND_TYPE); 187 } 188 189 NewObject = AcpiUtCreateIntegerObject (Value); 190 if (!NewObject) 191 { 192 return (AE_NO_MEMORY); 193 } 194 195 *ReturnObject = NewObject; 196 return (AE_OK); 197 } 198 199 200 /******************************************************************************* 201 * 202 * FUNCTION: AcpiNsConvertToString 203 * 204 * PARAMETERS: OriginalObject - Object to be converted 205 * ReturnObject - Where the new converted object is returned 206 * 207 * RETURN: Status. AE_OK if conversion was successful. 208 * 209 * DESCRIPTION: Attempt to convert a Integer/Buffer object to a String. 210 * 211 ******************************************************************************/ 212 213 ACPI_STATUS 214 AcpiNsConvertToString ( 215 ACPI_OPERAND_OBJECT *OriginalObject, 216 ACPI_OPERAND_OBJECT **ReturnObject) 217 { 218 ACPI_OPERAND_OBJECT *NewObject; 219 ACPI_SIZE Length; 220 ACPI_STATUS Status; 221 222 223 switch (OriginalObject->Common.Type) 224 { 225 case ACPI_TYPE_INTEGER: 226 /* 227 * Integer-to-String conversion. Commonly, convert 228 * an integer of value 0 to a NULL string. The last element of 229 * _BIF and _BIX packages occasionally need this fix. 230 */ 231 if (OriginalObject->Integer.Value == 0) 232 { 233 /* Allocate a new NULL string object */ 234 235 NewObject = AcpiUtCreateStringObject (0); 236 if (!NewObject) 237 { 238 return (AE_NO_MEMORY); 239 } 240 } 241 else 242 { 243 Status = AcpiExConvertToString (OriginalObject, 244 &NewObject, ACPI_IMPLICIT_CONVERT_HEX); 245 if (ACPI_FAILURE (Status)) 246 { 247 return (Status); 248 } 249 } 250 break; 251 252 case ACPI_TYPE_BUFFER: 253 /* 254 * Buffer-to-String conversion. Use a ToString 255 * conversion, no transform performed on the buffer data. The best 256 * example of this is the _BIF method, where the string data from 257 * the battery is often (incorrectly) returned as buffer object(s). 258 */ 259 Length = 0; 260 while ((Length < OriginalObject->Buffer.Length) && 261 (OriginalObject->Buffer.Pointer[Length])) 262 { 263 Length++; 264 } 265 266 /* Allocate a new string object */ 267 268 NewObject = AcpiUtCreateStringObject (Length); 269 if (!NewObject) 270 { 271 return (AE_NO_MEMORY); 272 } 273 274 /* 275 * Copy the raw buffer data with no transform. String is already NULL 276 * terminated at Length+1. 277 */ 278 memcpy (NewObject->String.Pointer, 279 OriginalObject->Buffer.Pointer, Length); 280 break; 281 282 default: 283 284 return (AE_AML_OPERAND_TYPE); 285 } 286 287 *ReturnObject = NewObject; 288 return (AE_OK); 289 } 290 291 292 /******************************************************************************* 293 * 294 * FUNCTION: AcpiNsConvertToBuffer 295 * 296 * PARAMETERS: OriginalObject - Object to be converted 297 * ReturnObject - Where the new converted object is returned 298 * 299 * RETURN: Status. AE_OK if conversion was successful. 300 * 301 * DESCRIPTION: Attempt to convert a Integer/String/Package object to a Buffer. 302 * 303 ******************************************************************************/ 304 305 ACPI_STATUS 306 AcpiNsConvertToBuffer ( 307 ACPI_OPERAND_OBJECT *OriginalObject, 308 ACPI_OPERAND_OBJECT **ReturnObject) 309 { 310 ACPI_OPERAND_OBJECT *NewObject; 311 ACPI_STATUS Status; 312 ACPI_OPERAND_OBJECT **Elements; 313 UINT32 *DwordBuffer; 314 UINT32 Count; 315 UINT32 i; 316 317 318 switch (OriginalObject->Common.Type) 319 { 320 case ACPI_TYPE_INTEGER: 321 /* 322 * Integer-to-Buffer conversion. 323 * Convert the Integer to a packed-byte buffer. _MAT and other 324 * objects need this sometimes, if a read has been performed on a 325 * Field object that is less than or equal to the global integer 326 * size (32 or 64 bits). 327 */ 328 Status = AcpiExConvertToBuffer (OriginalObject, &NewObject); 329 if (ACPI_FAILURE (Status)) 330 { 331 return (Status); 332 } 333 break; 334 335 case ACPI_TYPE_STRING: 336 337 /* String-to-Buffer conversion. Simple data copy */ 338 339 NewObject = AcpiUtCreateBufferObject 340 (OriginalObject->String.Length); 341 if (!NewObject) 342 { 343 return (AE_NO_MEMORY); 344 } 345 346 memcpy (NewObject->Buffer.Pointer, 347 OriginalObject->String.Pointer, OriginalObject->String.Length); 348 break; 349 350 case ACPI_TYPE_PACKAGE: 351 /* 352 * This case is often seen for predefined names that must return a 353 * Buffer object with multiple DWORD integers within. For example, 354 * _FDE and _GTM. The Package can be converted to a Buffer. 355 */ 356 357 /* All elements of the Package must be integers */ 358 359 Elements = OriginalObject->Package.Elements; 360 Count = OriginalObject->Package.Count; 361 362 for (i = 0; i < Count; i++) 363 { 364 if ((!*Elements) || 365 ((*Elements)->Common.Type != ACPI_TYPE_INTEGER)) 366 { 367 return (AE_AML_OPERAND_TYPE); 368 } 369 Elements++; 370 } 371 372 /* Create the new buffer object to replace the Package */ 373 374 NewObject = AcpiUtCreateBufferObject (ACPI_MUL_4 (Count)); 375 if (!NewObject) 376 { 377 return (AE_NO_MEMORY); 378 } 379 380 /* Copy the package elements (integers) to the buffer as DWORDs */ 381 382 Elements = OriginalObject->Package.Elements; 383 DwordBuffer = ACPI_CAST_PTR (UINT32, NewObject->Buffer.Pointer); 384 385 for (i = 0; i < Count; i++) 386 { 387 *DwordBuffer = (UINT32) (*Elements)->Integer.Value; 388 DwordBuffer++; 389 Elements++; 390 } 391 break; 392 393 default: 394 395 return (AE_AML_OPERAND_TYPE); 396 } 397 398 *ReturnObject = NewObject; 399 return (AE_OK); 400 } 401 402 403 /******************************************************************************* 404 * 405 * FUNCTION: AcpiNsConvertToUnicode 406 * 407 * PARAMETERS: Scope - Namespace node for the method/object 408 * OriginalObject - ASCII String Object to be converted 409 * ReturnObject - Where the new converted object is returned 410 * 411 * RETURN: Status. AE_OK if conversion was successful. 412 * 413 * DESCRIPTION: Attempt to convert a String object to a Unicode string Buffer. 414 * 415 ******************************************************************************/ 416 417 ACPI_STATUS 418 AcpiNsConvertToUnicode ( 419 ACPI_NAMESPACE_NODE *Scope, 420 ACPI_OPERAND_OBJECT *OriginalObject, 421 ACPI_OPERAND_OBJECT **ReturnObject) 422 { 423 ACPI_OPERAND_OBJECT *NewObject; 424 char *AsciiString; 425 UINT16 *UnicodeBuffer; 426 UINT32 UnicodeLength; 427 UINT32 i; 428 429 430 if (!OriginalObject) 431 { 432 return (AE_OK); 433 } 434 435 /* If a Buffer was returned, it must be at least two bytes long */ 436 437 if (OriginalObject->Common.Type == ACPI_TYPE_BUFFER) 438 { 439 if (OriginalObject->Buffer.Length < 2) 440 { 441 return (AE_AML_OPERAND_VALUE); 442 } 443 444 *ReturnObject = NULL; 445 return (AE_OK); 446 } 447 448 /* 449 * The original object is an ASCII string. Convert this string to 450 * a unicode buffer. 451 */ 452 AsciiString = OriginalObject->String.Pointer; 453 UnicodeLength = (OriginalObject->String.Length * 2) + 2; 454 455 /* Create a new buffer object for the Unicode data */ 456 457 NewObject = AcpiUtCreateBufferObject (UnicodeLength); 458 if (!NewObject) 459 { 460 return (AE_NO_MEMORY); 461 } 462 463 UnicodeBuffer = ACPI_CAST_PTR (UINT16, NewObject->Buffer.Pointer); 464 465 /* Convert ASCII to Unicode */ 466 467 for (i = 0; i < OriginalObject->String.Length; i++) 468 { 469 UnicodeBuffer[i] = (UINT16) AsciiString[i]; 470 } 471 472 *ReturnObject = NewObject; 473 return (AE_OK); 474 } 475 476 477 /******************************************************************************* 478 * 479 * FUNCTION: AcpiNsConvertToResource 480 * 481 * PARAMETERS: Scope - Namespace node for the method/object 482 * OriginalObject - Object to be converted 483 * ReturnObject - Where the new converted object is returned 484 * 485 * RETURN: Status. AE_OK if conversion was successful 486 * 487 * DESCRIPTION: Attempt to convert a Integer object to a ResourceTemplate 488 * Buffer. 489 * 490 ******************************************************************************/ 491 492 ACPI_STATUS 493 AcpiNsConvertToResource ( 494 ACPI_NAMESPACE_NODE *Scope, 495 ACPI_OPERAND_OBJECT *OriginalObject, 496 ACPI_OPERAND_OBJECT **ReturnObject) 497 { 498 ACPI_OPERAND_OBJECT *NewObject; 499 UINT8 *Buffer; 500 501 502 /* 503 * We can fix the following cases for an expected resource template: 504 * 1. No return value (interpreter slack mode is disabled) 505 * 2. A "Return (Zero)" statement 506 * 3. A "Return empty buffer" statement 507 * 508 * We will return a buffer containing a single EndTag 509 * resource descriptor. 510 */ 511 if (OriginalObject) 512 { 513 switch (OriginalObject->Common.Type) 514 { 515 case ACPI_TYPE_INTEGER: 516 517 /* We can only repair an Integer==0 */ 518 519 if (OriginalObject->Integer.Value) 520 { 521 return (AE_AML_OPERAND_TYPE); 522 } 523 break; 524 525 case ACPI_TYPE_BUFFER: 526 527 if (OriginalObject->Buffer.Length) 528 { 529 /* Additional checks can be added in the future */ 530 531 *ReturnObject = NULL; 532 return (AE_OK); 533 } 534 break; 535 536 case ACPI_TYPE_STRING: 537 default: 538 539 return (AE_AML_OPERAND_TYPE); 540 } 541 } 542 543 /* Create the new buffer object for the resource descriptor */ 544 545 NewObject = AcpiUtCreateBufferObject (2); 546 if (!NewObject) 547 { 548 return (AE_NO_MEMORY); 549 } 550 551 Buffer = ACPI_CAST_PTR (UINT8, NewObject->Buffer.Pointer); 552 553 /* Initialize the Buffer with a single EndTag descriptor */ 554 555 Buffer[0] = (ACPI_RESOURCE_NAME_END_TAG | ASL_RDESC_END_TAG_SIZE); 556 Buffer[1] = 0x00; 557 558 *ReturnObject = NewObject; 559 return (AE_OK); 560 } 561 562 563 /******************************************************************************* 564 * 565 * FUNCTION: AcpiNsConvertToReference 566 * 567 * PARAMETERS: Scope - Namespace node for the method/object 568 * OriginalObject - Object to be converted 569 * ReturnObject - Where the new converted object is returned 570 * 571 * RETURN: Status. AE_OK if conversion was successful 572 * 573 * DESCRIPTION: Attempt to convert a Integer object to a ObjectReference. 574 * Buffer. 575 * 576 ******************************************************************************/ 577 578 ACPI_STATUS 579 AcpiNsConvertToReference ( 580 ACPI_NAMESPACE_NODE *Scope, 581 ACPI_OPERAND_OBJECT *OriginalObject, 582 ACPI_OPERAND_OBJECT **ReturnObject) 583 { 584 ACPI_OPERAND_OBJECT *NewObject = NULL; 585 ACPI_STATUS Status; 586 ACPI_NAMESPACE_NODE *Node; 587 ACPI_GENERIC_STATE ScopeInfo; 588 char *Name; 589 590 591 ACPI_FUNCTION_NAME (NsConvertToReference); 592 593 594 /* Convert path into internal presentation */ 595 596 Status = AcpiNsInternalizeName (OriginalObject->String.Pointer, &Name); 597 if (ACPI_FAILURE (Status)) 598 { 599 return_ACPI_STATUS (Status); 600 } 601 602 /* Find the namespace node */ 603 604 ScopeInfo.Scope.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Scope); 605 Status = AcpiNsLookup (&ScopeInfo, Name, 606 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE, 607 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE, NULL, &Node); 608 if (ACPI_FAILURE (Status)) 609 { 610 /* Check if we are resolving a named reference within a package */ 611 612 ACPI_ERROR_NAMESPACE (OriginalObject->String.Pointer, Status); 613 goto ErrorExit; 614 } 615 616 /* Create and init a new internal ACPI object */ 617 618 NewObject = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE); 619 if (!NewObject) 620 { 621 Status = AE_NO_MEMORY; 622 goto ErrorExit; 623 } 624 NewObject->Reference.Node = Node; 625 NewObject->Reference.Object = Node->Object; 626 NewObject->Reference.Class = ACPI_REFCLASS_NAME; 627 628 /* 629 * Increase reference of the object if needed (the object is likely a 630 * null for device nodes). 631 */ 632 AcpiUtAddReference (Node->Object); 633 634 ErrorExit: 635 ACPI_FREE (Name); 636 *ReturnObject = NewObject; 637 return (AE_OK); 638 } 639