Subversion Repositories Kolibri OS

Rev

Rev 1498 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  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 - 2011, 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. #define __UTIDS_C__
  117.  
  118. #include "acpi.h"
  119. #include "accommon.h"
  120. #include "acinterp.h"
  121.  
  122.  
  123. #define _COMPONENT          ACPI_UTILITIES
  124.         ACPI_MODULE_NAME    ("utids")
  125.  
  126.  
  127. /*******************************************************************************
  128.  *
  129.  * FUNCTION:    AcpiUtExecute_HID
  130.  *
  131.  * PARAMETERS:  DeviceNode          - Node for the device
  132.  *              ReturnId            - Where the string HID is returned
  133.  *
  134.  * RETURN:      Status
  135.  *
  136.  * DESCRIPTION: Executes the _HID control method that returns the hardware
  137.  *              ID of the device. The HID is either an 32-bit encoded EISAID
  138.  *              Integer or a String. A string is always returned. An EISAID
  139.  *              is converted to a string.
  140.  *
  141.  *              NOTE: Internal function, no parameter validation
  142.  *
  143.  ******************************************************************************/
  144.  
  145. ACPI_STATUS
  146. AcpiUtExecute_HID (
  147.     ACPI_NAMESPACE_NODE     *DeviceNode,
  148.     ACPI_DEVICE_ID          **ReturnId)
  149. {
  150.     ACPI_OPERAND_OBJECT     *ObjDesc;
  151.     ACPI_DEVICE_ID          *Hid;
  152.     UINT32                  Length;
  153.     ACPI_STATUS             Status;
  154.  
  155.  
  156.     ACPI_FUNCTION_TRACE (UtExecute_HID);
  157.  
  158.  
  159.     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__HID,
  160.                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
  161.     if (ACPI_FAILURE (Status))
  162.     {
  163.         return_ACPI_STATUS (Status);
  164.     }
  165.  
  166.     /* Get the size of the String to be returned, includes null terminator */
  167.  
  168.     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
  169.     {
  170.         Length = ACPI_EISAID_STRING_SIZE;
  171.     }
  172.     else
  173.     {
  174.         Length = ObjDesc->String.Length + 1;
  175.     }
  176.  
  177.     /* Allocate a buffer for the HID */
  178.  
  179.     Hid = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_ID) + (ACPI_SIZE) Length);
  180.     if (!Hid)
  181.     {
  182.         Status = AE_NO_MEMORY;
  183.         goto Cleanup;
  184.     }
  185.  
  186.     /* Area for the string starts after DEVICE_ID struct */
  187.  
  188.     Hid->String = ACPI_ADD_PTR (char, Hid, sizeof (ACPI_DEVICE_ID));
  189.  
  190.     /* Convert EISAID to a string or simply copy existing string */
  191.  
  192.     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
  193.     {
  194.         AcpiExEisaIdToString (Hid->String, ObjDesc->Integer.Value);
  195.     }
  196.     else
  197.     {
  198.         ACPI_STRCPY (Hid->String, ObjDesc->String.Pointer);
  199.     }
  200.  
  201.     Hid->Length = Length;
  202.     *ReturnId = Hid;
  203.  
  204.  
  205. Cleanup:
  206.  
  207.     /* On exit, we must delete the return object */
  208.  
  209.     AcpiUtRemoveReference (ObjDesc);
  210.     return_ACPI_STATUS (Status);
  211. }
  212.  
  213.  
  214. /*******************************************************************************
  215.  *
  216.  * FUNCTION:    AcpiUtExecute_UID
  217.  *
  218.  * PARAMETERS:  DeviceNode          - Node for the device
  219.  *              ReturnId            - Where the string UID is returned
  220.  *
  221.  * RETURN:      Status
  222.  *
  223.  * DESCRIPTION: Executes the _UID control method that returns the unique
  224.  *              ID of the device. The UID is either a 64-bit Integer (NOT an
  225.  *              EISAID) or a string. Always returns a string. A 64-bit integer
  226.  *              is converted to a decimal string.
  227.  *
  228.  *              NOTE: Internal function, no parameter validation
  229.  *
  230.  ******************************************************************************/
  231.  
  232. ACPI_STATUS
  233. AcpiUtExecute_UID (
  234.     ACPI_NAMESPACE_NODE     *DeviceNode,
  235.     ACPI_DEVICE_ID          **ReturnId)
  236. {
  237.     ACPI_OPERAND_OBJECT     *ObjDesc;
  238.     ACPI_DEVICE_ID          *Uid;
  239.     UINT32                  Length;
  240.     ACPI_STATUS             Status;
  241.  
  242.  
  243.     ACPI_FUNCTION_TRACE (UtExecute_UID);
  244.  
  245.  
  246.     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__UID,
  247.                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
  248.     if (ACPI_FAILURE (Status))
  249.     {
  250.         return_ACPI_STATUS (Status);
  251.     }
  252.  
  253.     /* Get the size of the String to be returned, includes null terminator */
  254.  
  255.     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
  256.     {
  257.         Length = ACPI_MAX64_DECIMAL_DIGITS + 1;
  258.     }
  259.     else
  260.     {
  261.         Length = ObjDesc->String.Length + 1;
  262.     }
  263.  
  264.     /* Allocate a buffer for the UID */
  265.  
  266.     Uid = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_ID) + (ACPI_SIZE) Length);
  267.     if (!Uid)
  268.     {
  269.         Status = AE_NO_MEMORY;
  270.         goto Cleanup;
  271.     }
  272.  
  273.     /* Area for the string starts after DEVICE_ID struct */
  274.  
  275.     Uid->String = ACPI_ADD_PTR (char, Uid, sizeof (ACPI_DEVICE_ID));
  276.  
  277.     /* Convert an Integer to string, or just copy an existing string */
  278.  
  279.     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
  280.     {
  281.         AcpiExIntegerToString (Uid->String, ObjDesc->Integer.Value);
  282.     }
  283.     else
  284.     {
  285.         ACPI_STRCPY (Uid->String, ObjDesc->String.Pointer);
  286.     }
  287.  
  288.     Uid->Length = Length;
  289.     *ReturnId = Uid;
  290.  
  291.  
  292. Cleanup:
  293.  
  294.     /* On exit, we must delete the return object */
  295.  
  296.     AcpiUtRemoveReference (ObjDesc);
  297.     return_ACPI_STATUS (Status);
  298. }
  299.  
  300.  
  301. /*******************************************************************************
  302.  *
  303.  * FUNCTION:    AcpiUtExecute_CID
  304.  *
  305.  * PARAMETERS:  DeviceNode          - Node for the device
  306.  *              ReturnCidList       - Where the CID list is returned
  307.  *
  308.  * RETURN:      Status, list of CID strings
  309.  *
  310.  * DESCRIPTION: Executes the _CID control method that returns one or more
  311.  *              compatible hardware IDs for the device.
  312.  *
  313.  *              NOTE: Internal function, no parameter validation
  314.  *
  315.  * A _CID method can return either a single compatible ID or a package of
  316.  * compatible IDs. Each compatible ID can be one of the following:
  317.  * 1) Integer (32 bit compressed EISA ID) or
  318.  * 2) String (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss")
  319.  *
  320.  * The Integer CIDs are converted to string format by this function.
  321.  *
  322.  ******************************************************************************/
  323.  
  324. ACPI_STATUS
  325. AcpiUtExecute_CID (
  326.     ACPI_NAMESPACE_NODE     *DeviceNode,
  327.     ACPI_DEVICE_ID_LIST     **ReturnCidList)
  328. {
  329.     ACPI_OPERAND_OBJECT     **CidObjects;
  330.     ACPI_OPERAND_OBJECT     *ObjDesc;
  331.     ACPI_DEVICE_ID_LIST     *CidList;
  332.     char                    *NextIdString;
  333.     UINT32                  StringAreaSize;
  334.     UINT32                  Length;
  335.     UINT32                  CidListSize;
  336.     ACPI_STATUS             Status;
  337.     UINT32                  Count;
  338.     UINT32                  i;
  339.  
  340.  
  341.     ACPI_FUNCTION_TRACE (UtExecute_CID);
  342.  
  343.  
  344.     /* Evaluate the _CID method for this device */
  345.  
  346.     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__CID,
  347.                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_PACKAGE,
  348.                 &ObjDesc);
  349.     if (ACPI_FAILURE (Status))
  350.     {
  351.         return_ACPI_STATUS (Status);
  352.     }
  353.  
  354.     /*
  355.      * Get the count and size of the returned _CIDs. _CID can return either
  356.      * a Package of Integers/Strings or a single Integer or String.
  357.      * Note: This section also validates that all CID elements are of the
  358.      * correct type (Integer or String).
  359.      */
  360.     if (ObjDesc->Common.Type == ACPI_TYPE_PACKAGE)
  361.     {
  362.         Count = ObjDesc->Package.Count;
  363.         CidObjects = ObjDesc->Package.Elements;
  364.     }
  365.     else /* Single Integer or String CID */
  366.     {
  367.         Count = 1;
  368.         CidObjects = &ObjDesc;
  369.     }
  370.  
  371.     StringAreaSize = 0;
  372.     for (i = 0; i < Count; i++)
  373.     {
  374.         /* String lengths include null terminator */
  375.  
  376.         switch (CidObjects[i]->Common.Type)
  377.         {
  378.         case ACPI_TYPE_INTEGER:
  379.             StringAreaSize += ACPI_EISAID_STRING_SIZE;
  380.             break;
  381.  
  382.         case ACPI_TYPE_STRING:
  383.             StringAreaSize += CidObjects[i]->String.Length + 1;
  384.             break;
  385.  
  386.         default:
  387.             Status = AE_TYPE;
  388.             goto Cleanup;
  389.         }
  390.     }
  391.  
  392.     /*
  393.      * Now that we know the length of the CIDs, allocate return buffer:
  394.      * 1) Size of the base structure +
  395.      * 2) Size of the CID DEVICE_ID array +
  396.      * 3) Size of the actual CID strings
  397.      */
  398.     CidListSize = sizeof (ACPI_DEVICE_ID_LIST) +
  399.         ((Count - 1) * sizeof (ACPI_DEVICE_ID)) +
  400.         StringAreaSize;
  401.  
  402.     CidList = ACPI_ALLOCATE_ZEROED (CidListSize);
  403.     if (!CidList)
  404.     {
  405.         Status = AE_NO_MEMORY;
  406.         goto Cleanup;
  407.     }
  408.  
  409.     /* Area for CID strings starts after the CID DEVICE_ID array */
  410.  
  411.     NextIdString = ACPI_CAST_PTR (char, CidList->Ids) +
  412.         ((ACPI_SIZE) Count * sizeof (ACPI_DEVICE_ID));
  413.  
  414.     /* Copy/convert the CIDs to the return buffer */
  415.  
  416.     for (i = 0; i < Count; i++)
  417.     {
  418.         if (CidObjects[i]->Common.Type == ACPI_TYPE_INTEGER)
  419.         {
  420.             /* Convert the Integer (EISAID) CID to a string */
  421.  
  422.             AcpiExEisaIdToString (NextIdString, CidObjects[i]->Integer.Value);
  423.             Length = ACPI_EISAID_STRING_SIZE;
  424.         }
  425.         else /* ACPI_TYPE_STRING */
  426.         {
  427.             /* Copy the String CID from the returned object */
  428.  
  429.             ACPI_STRCPY (NextIdString, CidObjects[i]->String.Pointer);
  430.             Length = CidObjects[i]->String.Length + 1;
  431.         }
  432.  
  433.         CidList->Ids[i].String = NextIdString;
  434.         CidList->Ids[i].Length = Length;
  435.         NextIdString += Length;
  436.     }
  437.  
  438.     /* Finish the CID list */
  439.  
  440.     CidList->Count = Count;
  441.     CidList->ListSize = CidListSize;
  442.     *ReturnCidList = CidList;
  443.  
  444.  
  445. Cleanup:
  446.  
  447.     /* On exit, we must delete the _CID return object */
  448.  
  449.     AcpiUtRemoveReference (ObjDesc);
  450.     return_ACPI_STATUS (Status);
  451. }
  452.  
  453.