Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:24:04

0001 /******************************************************************************
0002  *
0003  * Module Name: utuuid -- UUID support functions
0004  *
0005  *****************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151 
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 
0155 #define _COMPONENT          ACPI_COMPILER
0156         ACPI_MODULE_NAME    ("utuuid")
0157 
0158 
0159 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
0160 /*
0161  * UUID support functions.
0162  *
0163  * This table is used to convert an input UUID ascii string to a 16 byte
0164  * buffer and the reverse. The table maps a UUID buffer index 0-15 to
0165  * the index within the 36-byte UUID string where the associated 2-byte
0166  * hex value can be found.
0167  *
0168  * 36-byte UUID strings are of the form:
0169  *     aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
0170  * Where aa-pp are one byte hex numbers, made up of two hex digits
0171  *
0172  * Note: This table is basically the inverse of the string-to-offset table
0173  * found in the ACPI spec in the description of the ToUUID macro.
0174  */
0175 const UINT8    AcpiGbl_MapToUuidOffset[UUID_BUFFER_LENGTH] =
0176 {
0177     6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34
0178 };
0179 
0180 
0181 /*******************************************************************************
0182  *
0183  * FUNCTION:    AcpiUtConvertStringToUuid
0184  *
0185  * PARAMETERS:  InString            - 36-byte formatted UUID string
0186  *              UuidBuffer          - Where the 16-byte UUID buffer is returned
0187  *
0188  * RETURN:      None. Output data is returned in the UuidBuffer
0189  *
0190  * DESCRIPTION: Convert a 36-byte formatted UUID string to 16-byte UUID buffer
0191  *
0192  ******************************************************************************/
0193 
0194 void
0195 AcpiUtConvertStringToUuid (
0196     char                    *InString,
0197     UINT8                   *UuidBuffer)
0198 {
0199     UINT32                  i;
0200 
0201 
0202     for (i = 0; i < UUID_BUFFER_LENGTH; i++)
0203     {
0204         UuidBuffer[i] = (AcpiUtAsciiCharToHex (
0205             InString[AcpiGbl_MapToUuidOffset[i]]) << 4);
0206 
0207         UuidBuffer[i] |= AcpiUtAsciiCharToHex (
0208             InString[AcpiGbl_MapToUuidOffset[i] + 1]);
0209     }
0210 }
0211 
0212 
0213 /*******************************************************************************
0214  *
0215  * FUNCTION:    AcpiUtConvertUuidToString
0216  *
0217  * PARAMETERS:  UuidBuffer          - 16-byte UUID buffer
0218  *              OutString           - 36-byte formatted UUID string
0219  *
0220  * RETURN:      Status
0221  *
0222  * DESCRIPTION: Convert 16-byte UUID buffer to 36-byte formatted UUID string
0223  *              OutString must be 37 bytes to include null terminator.
0224  *
0225  ******************************************************************************/
0226 
0227 ACPI_STATUS
0228 AcpiUtConvertUuidToString (
0229     char                    *UuidBuffer,
0230     char                    *OutString)
0231 {
0232     UINT32                  i;
0233 
0234 
0235     if (!UuidBuffer || !OutString)
0236     {
0237         return (AE_BAD_PARAMETER);
0238     }
0239 
0240     for (i = 0; i < UUID_BUFFER_LENGTH; i++)
0241     {
0242         OutString[AcpiGbl_MapToUuidOffset[i]] =
0243             AcpiUtHexToAsciiChar (UuidBuffer[i], 4);
0244 
0245         OutString[AcpiGbl_MapToUuidOffset[i] + 1] =
0246             AcpiUtHexToAsciiChar (UuidBuffer[i], 0);
0247     }
0248 
0249     /* Insert required hyphens (dashes) */
0250 
0251     OutString[UUID_HYPHEN1_OFFSET] =
0252     OutString[UUID_HYPHEN2_OFFSET] =
0253     OutString[UUID_HYPHEN3_OFFSET] =
0254     OutString[UUID_HYPHEN4_OFFSET] = '-';
0255 
0256     OutString[UUID_STRING_LENGTH] = 0; /* Null terminate */
0257     return (AE_OK);
0258 }
0259 #endif