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