drivers/acpi/components/utilities/utids.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utids - support for device IDs - HID, UID, CID
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acinterp.h"
 119
 120
 121 #define _COMPONENT          ACPI_UTILITIES
 122         ACPI_MODULE_NAME    ("utids")
 123
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiUtExecute_HID
 128  *
 129  * PARAMETERS:  DeviceNode          - Node for the device
 130  *              ReturnId            - Where the string HID is returned
 131  *
 132  * RETURN:      Status
 133  *
 134  * DESCRIPTION: Executes the _HID control method that returns the hardware
 135  *              ID of the device. The HID is either an 32-bit encoded EISAID
 136  *              Integer or a String. A string is always returned. An EISAID
 137  *              is converted to a string.
 138  *
 139  *              NOTE: Internal function, no parameter validation
 140  *
 141  ******************************************************************************/
 142
 143 ACPI_STATUS
 144 AcpiUtExecute_HID (
 145     ACPI_NAMESPACE_NODE     *DeviceNode,
 146     ACPI_PNP_DEVICE_ID      **ReturnId)
 147 {
 148     ACPI_OPERAND_OBJECT     *ObjDesc;
 149     ACPI_PNP_DEVICE_ID      *Hid;
 150     UINT32                  Length;
 151     ACPI_STATUS             Status;
 152
 153
 154     ACPI_FUNCTION_TRACE (UtExecute_HID);
 155
 156
 157     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__HID,
 158                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
 159     if (ACPI_FAILURE (Status))
 160     {
 161         return_ACPI_STATUS (Status);
 162     }
 163
 164     /* Get the size of the String to be returned, includes null terminator */
 165
 166     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
 167     {
 168         Length = ACPI_EISAID_STRING_SIZE;
 169     }
 170     else
 171     {
 172         Length = ObjDesc->String.Length + 1;
 173     }
 174
 175     /* Allocate a buffer for the HID */
 176
 177     Hid = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PNP_DEVICE_ID) + (ACPI_SIZE) Length);
 178     if (!Hid)
 179     {
 180         Status = AE_NO_MEMORY;
 181         goto Cleanup;
 182     }
 183
 184     /* Area for the string starts after PNP_DEVICE_ID struct */
 185
 186     Hid->String = ACPI_ADD_PTR (char, Hid, sizeof (ACPI_PNP_DEVICE_ID));
 187
 188     /* Convert EISAID to a string or simply copy existing string */
 189
 190     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
 191     {
 192         AcpiExEisaIdToString (Hid->String, ObjDesc->Integer.Value);
 193     }
 194     else
 195     {
 196         ACPI_STRCPY (Hid->String, ObjDesc->String.Pointer);
 197     }
 198
 199     Hid->Length = Length;
 200     *ReturnId = Hid;
 201
 202
 203 Cleanup:
 204
 205     /* On exit, we must delete the return object */
 206
 207     AcpiUtRemoveReference (ObjDesc);
 208     return_ACPI_STATUS (Status);
 209 }
 210
 211
 212 /*******************************************************************************
 213  *
 214  * FUNCTION:    AcpiUtExecute_SUB
 215  *
 216  * PARAMETERS:  DeviceNode          - Node for the device
 217  *              ReturnId            - Where the _SUB is returned
 218  *
 219  * RETURN:      Status
 220  *
 221  * DESCRIPTION: Executes the _SUB control method that returns the subsystem
 222  *              ID of the device. The _SUB value is always a string containing
 223  *              either a valid PNP or ACPI ID.
 224  *
 225  *              NOTE: Internal function, no parameter validation
 226  *
 227  ******************************************************************************/
 228
 229 ACPI_STATUS
 230 AcpiUtExecute_SUB (
 231     ACPI_NAMESPACE_NODE     *DeviceNode,
 232     ACPI_PNP_DEVICE_ID      **ReturnId)
 233 {
 234     ACPI_OPERAND_OBJECT     *ObjDesc;
 235     ACPI_PNP_DEVICE_ID      *Sub;
 236     UINT32                  Length;
 237     ACPI_STATUS             Status;
 238
 239
 240     ACPI_FUNCTION_TRACE (UtExecute_SUB);
 241
 242
 243     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__SUB,
 244                 ACPI_BTYPE_STRING, &ObjDesc);
 245     if (ACPI_FAILURE (Status))
 246     {
 247         return_ACPI_STATUS (Status);
 248     }
 249
 250     /* Get the size of the String to be returned, includes null terminator */
 251
 252     Length = ObjDesc->String.Length + 1;
 253
 254     /* Allocate a buffer for the SUB */
 255
 256     Sub = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PNP_DEVICE_ID) + (ACPI_SIZE) Length);
 257     if (!Sub)
 258     {
 259         Status = AE_NO_MEMORY;
 260         goto Cleanup;
 261     }
 262
 263     /* Area for the string starts after PNP_DEVICE_ID struct */
 264
 265     Sub->String = ACPI_ADD_PTR (char, Sub, sizeof (ACPI_PNP_DEVICE_ID));
 266
 267     /* Simply copy existing string */
 268
 269     ACPI_STRCPY (Sub->String, ObjDesc->String.Pointer);
 270     Sub->Length = Length;
 271     *ReturnId = Sub;
 272
 273
 274 Cleanup:
 275
 276     /* On exit, we must delete the return object */
 277
 278     AcpiUtRemoveReference (ObjDesc);
 279     return_ACPI_STATUS (Status);
 280 }
 281
 282
 283 /*******************************************************************************
 284  *
 285  * FUNCTION:    AcpiUtExecute_UID
 286  *
 287  * PARAMETERS:  DeviceNode          - Node for the device
 288  *              ReturnId            - Where the string UID is returned
 289  *
 290  * RETURN:      Status
 291  *
 292  * DESCRIPTION: Executes the _UID control method that returns the unique
 293  *              ID of the device. The UID is either a 64-bit Integer (NOT an
 294  *              EISAID) or a string. Always returns a string. A 64-bit integer
 295  *              is converted to a decimal string.
 296  *
 297  *              NOTE: Internal function, no parameter validation
 298  *
 299  ******************************************************************************/
 300
 301 ACPI_STATUS
 302 AcpiUtExecute_UID (
 303     ACPI_NAMESPACE_NODE     *DeviceNode,
 304     ACPI_PNP_DEVICE_ID      **ReturnId)
 305 {
 306     ACPI_OPERAND_OBJECT     *ObjDesc;
 307     ACPI_PNP_DEVICE_ID      *Uid;
 308     UINT32                  Length;
 309     ACPI_STATUS             Status;
 310
 311
 312     ACPI_FUNCTION_TRACE (UtExecute_UID);
 313
 314
 315     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__UID,
 316                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
 317     if (ACPI_FAILURE (Status))
 318     {
 319         return_ACPI_STATUS (Status);
 320     }
 321
 322     /* Get the size of the String to be returned, includes null terminator */
 323
 324     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
 325     {
 326         Length = ACPI_MAX64_DECIMAL_DIGITS + 1;
 327     }
 328     else
 329     {
 330         Length = ObjDesc->String.Length + 1;
 331     }
 332
 333     /* Allocate a buffer for the UID */
 334
 335     Uid = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PNP_DEVICE_ID) + (ACPI_SIZE) Length);
 336     if (!Uid)
 337     {
 338         Status = AE_NO_MEMORY;
 339         goto Cleanup;
 340     }
 341
 342     /* Area for the string starts after PNP_DEVICE_ID struct */
 343
 344     Uid->String = ACPI_ADD_PTR (char, Uid, sizeof (ACPI_PNP_DEVICE_ID));
 345
 346     /* Convert an Integer to string, or just copy an existing string */
 347
 348     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
 349     {
 350         AcpiExIntegerToString (Uid->String, ObjDesc->Integer.Value);
 351     }
 352     else
 353     {
 354         ACPI_STRCPY (Uid->String, ObjDesc->String.Pointer);
 355     }
 356
 357     Uid->Length = Length;
 358     *ReturnId = Uid;
 359
 360
 361 Cleanup:
 362
 363     /* On exit, we must delete the return object */
 364
 365     AcpiUtRemoveReference (ObjDesc);
 366     return_ACPI_STATUS (Status);
 367 }
 368
 369
 370 /*******************************************************************************
 371  *
 372  * FUNCTION:    AcpiUtExecute_CID
 373  *
 374  * PARAMETERS:  DeviceNode          - Node for the device
 375  *              ReturnCidList       - Where the CID list is returned
 376  *
 377  * RETURN:      Status, list of CID strings
 378  *
 379  * DESCRIPTION: Executes the _CID control method that returns one or more
 380  *              compatible hardware IDs for the device.
 381  *
 382  *              NOTE: Internal function, no parameter validation
 383  *
 384  * A _CID method can return either a single compatible ID or a package of
 385  * compatible IDs. Each compatible ID can be one of the following:
 386  * 1) Integer (32 bit compressed EISA ID) or
 387  * 2) String (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss")
 388  *
 389  * The Integer CIDs are converted to string format by this function.
 390  *
 391  ******************************************************************************/
 392
 393 ACPI_STATUS
 394 AcpiUtExecute_CID (
 395     ACPI_NAMESPACE_NODE     *DeviceNode,
 396     ACPI_PNP_DEVICE_ID_LIST **ReturnCidList)
 397 {
 398     ACPI_OPERAND_OBJECT     **CidObjects;
 399     ACPI_OPERAND_OBJECT     *ObjDesc;
 400     ACPI_PNP_DEVICE_ID_LIST *CidList;
 401     char                    *NextIdString;
 402     UINT32                  StringAreaSize;
 403     UINT32                  Length;
 404     UINT32                  CidListSize;
 405     ACPI_STATUS             Status;
 406     UINT32                  Count;
 407     UINT32                  i;
 408
 409
 410     ACPI_FUNCTION_TRACE (UtExecute_CID);
 411
 412
 413     /* Evaluate the _CID method for this device */
 414
 415     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__CID,
 416                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_PACKAGE,
 417                 &ObjDesc);
 418     if (ACPI_FAILURE (Status))
 419     {
 420         return_ACPI_STATUS (Status);
 421     }
 422
 423     /*
 424      * Get the count and size of the returned _CIDs. _CID can return either
 425      * a Package of Integers/Strings or a single Integer or String.
 426      * Note: This section also validates that all CID elements are of the
 427      * correct type (Integer or String).
 428      */
 429     if (ObjDesc->Common.Type == ACPI_TYPE_PACKAGE)
 430     {
 431         Count = ObjDesc->Package.Count;
 432         CidObjects = ObjDesc->Package.Elements;
 433     }
 434     else /* Single Integer or String CID */
 435     {
 436         Count = 1;
 437         CidObjects = &ObjDesc;
 438     }
 439
 440     StringAreaSize = 0;
 441     for (i = 0; i < Count; i++)
 442     {
 443         /* String lengths include null terminator */
 444
 445         switch (CidObjects[i]->Common.Type)
 446         {
 447         case ACPI_TYPE_INTEGER:
 448
 449             StringAreaSize += ACPI_EISAID_STRING_SIZE;
 450             break;
 451
 452         case ACPI_TYPE_STRING:
 453
 454             StringAreaSize += CidObjects[i]->String.Length + 1;
 455             break;
 456
 457         default:
 458
 459             Status = AE_TYPE;
 460             goto Cleanup;
 461         }
 462     }
 463
 464     /*
 465      * Now that we know the length of the CIDs, allocate return buffer:
 466      * 1) Size of the base structure +
 467      * 2) Size of the CID PNP_DEVICE_ID array +
 468      * 3) Size of the actual CID strings
 469      */
 470     CidListSize = sizeof (ACPI_PNP_DEVICE_ID_LIST) +
 471         ((Count - 1) * sizeof (ACPI_PNP_DEVICE_ID)) +
 472         StringAreaSize;
 473
 474     CidList = ACPI_ALLOCATE_ZEROED (CidListSize);
 475     if (!CidList)
 476     {
 477         Status = AE_NO_MEMORY;
 478         goto Cleanup;
 479     }
 480
 481     /* Area for CID strings starts after the CID PNP_DEVICE_ID array */
 482
 483     NextIdString = ACPI_CAST_PTR (char, CidList->Ids) +
 484         ((ACPI_SIZE) Count * sizeof (ACPI_PNP_DEVICE_ID));
 485
 486     /* Copy/convert the CIDs to the return buffer */
 487
 488     for (i = 0; i < Count; i++)
 489     {
 490         if (CidObjects[i]->Common.Type == ACPI_TYPE_INTEGER)
 491         {
 492             /* Convert the Integer (EISAID) CID to a string */
 493
 494             AcpiExEisaIdToString (NextIdString, CidObjects[i]->Integer.Value);
 495             Length = ACPI_EISAID_STRING_SIZE;
 496         }
 497         else /* ACPI_TYPE_STRING */
 498         {
 499             /* Copy the String CID from the returned object */
 500
 501             ACPI_STRCPY (NextIdString, CidObjects[i]->String.Pointer);
 502             Length = CidObjects[i]->String.Length + 1;
 503         }
 504
 505         CidList->Ids[i].String = NextIdString;
 506         CidList->Ids[i].Length = Length;
 507         NextIdString += Length;
 508     }
 509
 510     /* Finish the CID list */
 511
 512     CidList->Count = Count;
 513     CidList->ListSize = CidListSize;
 514     *ReturnCidList = CidList;
 515
 516
 517 Cleanup:
 518
 519     /* On exit, we must delete the _CID return object */
 520
 521     AcpiUtRemoveReference (ObjDesc);
 522     return_ACPI_STATUS (Status);
 523 }