drivers/bus/acpi/acpica/namespace/nsconvert.c

   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 - 2014, 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 #define __NSCONVERT_C__
 118
 119 #include "acpi.h"
 120 #include "accommon.h"
 121 #include "acnamesp.h"
 122 #include "acinterp.h"
 123 #include "acpredef.h"
 124 #include "amlresrc.h"
 125
 126 #define _COMPONENT          ACPI_NAMESPACE
 127         ACPI_MODULE_NAME    ("nsconvert")
 128
 129
 130 /*******************************************************************************
 131  *
 132  * FUNCTION:    AcpiNsConvertToInteger
 133  *
 134  * PARAMETERS:  OriginalObject      - Object to be converted
 135  *              ReturnObject        - Where the new converted object is returned
 136  *
 137  * RETURN:      Status. AE_OK if conversion was successful.
 138  *
 139  * DESCRIPTION: Attempt to convert a String/Buffer object to an Integer.
 140  *
 141  ******************************************************************************/
 142
 143 ACPI_STATUS
 144 AcpiNsConvertToInteger (
 145     ACPI_OPERAND_OBJECT     *OriginalObject,
 146     ACPI_OPERAND_OBJECT     **ReturnObject)
 147 {
 148     ACPI_OPERAND_OBJECT     *NewObject;
 149     ACPI_STATUS             Status;
 150     UINT64                  Value = 0;
 151     UINT32                  i;
 152
 153
 154     switch (OriginalObject->Common.Type)
 155     {
 156     case ACPI_TYPE_STRING:
 157
 158         /* String-to-Integer conversion */
 159
 160         Status = AcpiUtStrtoul64 (OriginalObject->String.Pointer,
 161                     ACPI_ANY_BASE, &Value);
 162         if (ACPI_FAILURE (Status))
 163         {
 164             return (Status);
 165         }
 166         break;
 167
 168     case ACPI_TYPE_BUFFER:
 169
 170         /* Buffer-to-Integer conversion. Max buffer size is 64 bits. */
 171
 172         if (OriginalObject->Buffer.Length > 8)
 173         {
 174             return (AE_AML_OPERAND_TYPE);
 175         }
 176
 177         /* Extract each buffer byte to create the integer */
 178
 179         for (i = 0; i < OriginalObject->Buffer.Length; i++)
 180         {
 181             Value |= ((UINT64) OriginalObject->Buffer.Pointer[i] << (i * 8));
 182         }
 183         break;
 184
 185     default:
 186
 187         return (AE_AML_OPERAND_TYPE);
 188     }
 189
 190     NewObject = AcpiUtCreateIntegerObject (Value);
 191     if (!NewObject)
 192     {
 193         return (AE_NO_MEMORY);
 194     }
 195
 196     *ReturnObject = NewObject;
 197     return (AE_OK);
 198 }
 199
 200
 201 /*******************************************************************************
 202  *
 203  * FUNCTION:    AcpiNsConvertToString
 204  *
 205  * PARAMETERS:  OriginalObject      - Object to be converted
 206  *              ReturnObject        - Where the new converted object is returned
 207  *
 208  * RETURN:      Status. AE_OK if conversion was successful.
 209  *
 210  * DESCRIPTION: Attempt to convert a Integer/Buffer object to a String.
 211  *
 212  ******************************************************************************/
 213
 214 ACPI_STATUS
 215 AcpiNsConvertToString (
 216     ACPI_OPERAND_OBJECT     *OriginalObject,
 217     ACPI_OPERAND_OBJECT     **ReturnObject)
 218 {
 219     ACPI_OPERAND_OBJECT     *NewObject;
 220     ACPI_SIZE               Length;
 221     ACPI_STATUS             Status;
 222
 223
 224     switch (OriginalObject->Common.Type)
 225     {
 226     case ACPI_TYPE_INTEGER:
 227         /*
 228          * Integer-to-String conversion. Commonly, convert
 229          * an integer of value 0 to a NULL string. The last element of
 230          * _BIF and _BIX packages occasionally need this fix.
 231          */
 232         if (OriginalObject->Integer.Value == 0)
 233         {
 234             /* Allocate a new NULL string object */
 235
 236             NewObject = AcpiUtCreateStringObject (0);
 237             if (!NewObject)
 238             {
 239                 return (AE_NO_MEMORY);
 240             }
 241         }
 242         else
 243         {
 244             Status = AcpiExConvertToString (OriginalObject, &NewObject,
 245                         ACPI_IMPLICIT_CONVERT_HEX);
 246             if (ACPI_FAILURE (Status))
 247             {
 248                 return (Status);
 249             }
 250         }
 251         break;
 252
 253     case ACPI_TYPE_BUFFER:
 254         /*
 255          * Buffer-to-String conversion. Use a ToString
 256          * conversion, no transform performed on the buffer data. The best
 257          * example of this is the _BIF method, where the string data from
 258          * the battery is often (incorrectly) returned as buffer object(s).
 259          */
 260         Length = 0;
 261         while ((Length < OriginalObject->Buffer.Length) &&
 262                 (OriginalObject->Buffer.Pointer[Length]))
 263         {
 264             Length++;
 265         }
 266
 267         /* Allocate a new string object */
 268
 269         NewObject = AcpiUtCreateStringObject (Length);
 270         if (!NewObject)
 271         {
 272             return (AE_NO_MEMORY);
 273         }
 274
 275         /*
 276          * Copy the raw buffer data with no transform. String is already NULL
 277          * terminated at Length+1.
 278          */
 279         ACPI_MEMCPY (NewObject->String.Pointer,
 280             OriginalObject->Buffer.Pointer, Length);
 281         break;
 282
 283     default:
 284
 285         return (AE_AML_OPERAND_TYPE);
 286     }
 287
 288     *ReturnObject = NewObject;
 289     return (AE_OK);
 290 }
 291
 292
 293 /*******************************************************************************
 294  *
 295  * FUNCTION:    AcpiNsConvertToBuffer
 296  *
 297  * PARAMETERS:  OriginalObject      - Object to be converted
 298  *              ReturnObject        - Where the new converted object is returned
 299  *
 300  * RETURN:      Status. AE_OK if conversion was successful.
 301  *
 302  * DESCRIPTION: Attempt to convert a Integer/String/Package object to a Buffer.
 303  *
 304  ******************************************************************************/
 305
 306 ACPI_STATUS
 307 AcpiNsConvertToBuffer (
 308     ACPI_OPERAND_OBJECT     *OriginalObject,
 309     ACPI_OPERAND_OBJECT     **ReturnObject)
 310 {
 311     ACPI_OPERAND_OBJECT     *NewObject;
 312     ACPI_STATUS             Status;
 313     ACPI_OPERAND_OBJECT     **Elements;
 314     UINT32                  *DwordBuffer;
 315     UINT32                  Count;
 316     UINT32                  i;
 317
 318
 319     switch (OriginalObject->Common.Type)
 320     {
 321     case ACPI_TYPE_INTEGER:
 322         /*
 323          * Integer-to-Buffer conversion.
 324          * Convert the Integer to a packed-byte buffer. _MAT and other
 325          * objects need this sometimes, if a read has been performed on a
 326          * Field object that is less than or equal to the global integer
 327          * size (32 or 64 bits).
 328          */
 329         Status = AcpiExConvertToBuffer (OriginalObject, &NewObject);
 330         if (ACPI_FAILURE (Status))
 331         {
 332             return (Status);
 333         }
 334         break;
 335
 336     case ACPI_TYPE_STRING:
 337
 338         /* String-to-Buffer conversion. Simple data copy */
 339
 340         NewObject = AcpiUtCreateBufferObject (OriginalObject->String.Length);
 341         if (!NewObject)
 342         {
 343             return (AE_NO_MEMORY);
 344         }
 345
 346         ACPI_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:  OriginalObject      - ASCII String Object to be converted
 408  *              ReturnObject        - Where the new converted object is returned
 409  *
 410  * RETURN:      Status. AE_OK if conversion was successful.
 411  *
 412  * DESCRIPTION: Attempt to convert a String object to a Unicode string Buffer.
 413  *
 414  ******************************************************************************/
 415
 416 ACPI_STATUS
 417 AcpiNsConvertToUnicode (
 418     ACPI_OPERAND_OBJECT     *OriginalObject,
 419     ACPI_OPERAND_OBJECT     **ReturnObject)
 420 {
 421     ACPI_OPERAND_OBJECT     *NewObject;
 422     char                    *AsciiString;
 423     UINT16                  *UnicodeBuffer;
 424     UINT32                  UnicodeLength;
 425     UINT32                  i;
 426
 427
 428     if (!OriginalObject)
 429     {
 430         return (AE_OK);
 431     }
 432
 433     /* If a Buffer was returned, it must be at least two bytes long */
 434
 435     if (OriginalObject->Common.Type == ACPI_TYPE_BUFFER)
 436     {
 437         if (OriginalObject->Buffer.Length < 2)
 438         {
 439             return (AE_AML_OPERAND_VALUE);
 440         }
 441
 442         *ReturnObject = NULL;
 443         return (AE_OK);
 444     }
 445
 446     /*
 447      * The original object is an ASCII string. Convert this string to
 448      * a unicode buffer.
 449      */
 450     AsciiString = OriginalObject->String.Pointer;
 451     UnicodeLength = (OriginalObject->String.Length * 2) + 2;
 452
 453     /* Create a new buffer object for the Unicode data */
 454
 455     NewObject = AcpiUtCreateBufferObject (UnicodeLength);
 456     if (!NewObject)
 457     {
 458         return (AE_NO_MEMORY);
 459     }
 460
 461     UnicodeBuffer = ACPI_CAST_PTR (UINT16, NewObject->Buffer.Pointer);
 462
 463     /* Convert ASCII to Unicode */
 464
 465     for (i = 0; i < OriginalObject->String.Length; i++)
 466     {
 467         UnicodeBuffer[i] = (UINT16) AsciiString[i];
 468     }
 469
 470     *ReturnObject = NewObject;
 471     return (AE_OK);
 472 }
 473
 474
 475 /*******************************************************************************
 476  *
 477  * FUNCTION:    AcpiNsConvertToResource
 478  *
 479  * PARAMETERS:  OriginalObject      - Object to be converted
 480  *              ReturnObject        - Where the new converted object is returned
 481  *
 482  * RETURN:      Status. AE_OK if conversion was successful
 483  *
 484  * DESCRIPTION: Attempt to convert a Integer object to a ResourceTemplate
 485  *              Buffer.
 486  *
 487  ******************************************************************************/
 488
 489 ACPI_STATUS
 490 AcpiNsConvertToResource (
 491     ACPI_OPERAND_OBJECT     *OriginalObject,
 492     ACPI_OPERAND_OBJECT     **ReturnObject)
 493 {
 494     ACPI_OPERAND_OBJECT     *NewObject;
 495     UINT8                   *Buffer;
 496
 497
 498     /*
 499      * We can fix the following cases for an expected resource template:
 500      * 1. No return value (interpreter slack mode is disabled)
 501      * 2. A "Return (Zero)" statement
 502      * 3. A "Return empty buffer" statement
 503      *
 504      * We will return a buffer containing a single EndTag
 505      * resource descriptor.
 506      */
 507     if (OriginalObject)
 508     {
 509         switch (OriginalObject->Common.Type)
 510         {
 511         case ACPI_TYPE_INTEGER:
 512
 513             /* We can only repair an Integer==0 */
 514
 515             if (OriginalObject->Integer.Value)
 516             {
 517                 return (AE_AML_OPERAND_TYPE);
 518             }
 519             break;
 520
 521         case ACPI_TYPE_BUFFER:
 522
 523             if (OriginalObject->Buffer.Length)
 524             {
 525                 /* Additional checks can be added in the future */
 526
 527                 *ReturnObject = NULL;
 528                 return (AE_OK);
 529             }
 530             break;
 531
 532         case ACPI_TYPE_STRING:
 533         default:
 534
 535             return (AE_AML_OPERAND_TYPE);
 536         }
 537     }
 538
 539     /* Create the new buffer object for the resource descriptor */
 540
 541     NewObject = AcpiUtCreateBufferObject (2);
 542     if (!NewObject)
 543     {
 544         return (AE_NO_MEMORY);
 545     }
 546
 547     Buffer = ACPI_CAST_PTR (UINT8, NewObject->Buffer.Pointer);
 548
 549     /* Initialize the Buffer with a single EndTag descriptor */
 550
 551     Buffer[0] = (ACPI_RESOURCE_NAME_END_TAG | ASL_RDESC_END_TAG_SIZE);
 552     Buffer[1] = 0x00;
 553
 554     *ReturnObject = NewObject;
 555     return (AE_OK);
 556 }