sys/contrib/dev/acpica-unix/compiler/asluuid.c

   1 /******************************************************************************
   2  *
   3  * Module Name: asluuid-- compiler UUID support
   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
 117 #include "aslcompiler.h"
 118
 119 #define _COMPONENT          ACPI_COMPILER
 120         ACPI_MODULE_NAME    ("asluuid")
 121
 122
 123 /*
 124  * UUID support functions.
 125  *
 126  * This table is used to convert an input UUID ascii string to a 16 byte
 127  * buffer and the reverse. The table maps a UUID buffer index 0-15 to
 128  * the index within the 36-byte UUID string where the associated 2-byte
 129  * hex value can be found.
 130  *
 131  * 36-byte UUID strings are of the form:
 132  *     aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
 133  * Where aa-pp are one byte hex numbers, made up of two hex digits
 134  *
 135  * Note: This table is basically the inverse of the string-to-offset table
 136  * found in the ACPI spec in the description of the ToUUID macro.
 137  */
 138 static UINT8    Gbl_MapToUuidOffset[16] =
 139 {
 140     6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34
 141 };
 142
 143 #define UUID_BUFFER_LENGTH          16
 144 #define UUID_STRING_LENGTH          36
 145
 146 /* Positions for required hyphens (dashes) in UUID strings */
 147
 148 #define UUID_HYPHEN1_OFFSET         8
 149 #define UUID_HYPHEN2_OFFSET         13
 150 #define UUID_HYPHEN3_OFFSET         18
 151 #define UUID_HYPHEN4_OFFSET         23
 152
 153
 154 /*******************************************************************************
 155  *
 156  * FUNCTION:    AuValiduateUuid
 157  *
 158  * PARAMETERS:  InString            - 36-byte formatted UUID string
 159  *
 160  * RETURN:      Status
 161  *
 162  * DESCRIPTION: Check all 36 characters for correct format
 163  *
 164  ******************************************************************************/
 165
 166 ACPI_STATUS
 167 AuValidateUuid (
 168     char                    *InString)
 169 {
 170     UINT32                  i;
 171
 172
 173     if (!InString || (ACPI_STRLEN (InString) != UUID_STRING_LENGTH))
 174     {
 175         return (AE_BAD_PARAMETER);
 176     }
 177
 178     /* Check all 36 characters for correct format */
 179
 180     for (i = 0; i < UUID_STRING_LENGTH; i++)
 181     {
 182         /* Must have 4 hyphens (dashes) in these positions: */
 183
 184         if ((i == UUID_HYPHEN1_OFFSET) ||
 185             (i == UUID_HYPHEN2_OFFSET) ||
 186             (i == UUID_HYPHEN3_OFFSET) ||
 187             (i == UUID_HYPHEN4_OFFSET))
 188         {
 189             if (InString[i] != '-')
 190             {
 191                 return (AE_BAD_PARAMETER);
 192             }
 193         }
 194
 195         /* All other positions must contain hex digits */
 196
 197         else
 198         {
 199             if (!isxdigit ((int) InString[i]))
 200             {
 201                 return (AE_BAD_PARAMETER);
 202             }
 203         }
 204     }
 205
 206     return (AE_OK);
 207 }
 208
 209
 210 /*******************************************************************************
 211  *
 212  * FUNCTION:    AuConvertStringToUuid
 213  *
 214  * PARAMETERS:  InString            - 36-byte formatted UUID string
 215  *              UuidBuffer          - 16-byte UUID buffer
 216  *
 217  * RETURN:      Status
 218  *
 219  * DESCRIPTION: Convert 36-byte formatted UUID string to 16-byte UUID buffer
 220  *
 221  ******************************************************************************/
 222
 223 ACPI_STATUS
 224 AuConvertStringToUuid (
 225     char                    *InString,
 226     char                    *UuidBuffer)
 227 {
 228     UINT32                  i;
 229
 230
 231     if (!InString || !UuidBuffer)
 232     {
 233         return (AE_BAD_PARAMETER);
 234     }
 235
 236     for (i = 0; i < UUID_BUFFER_LENGTH; i++)
 237     {
 238         UuidBuffer[i]  = (char) (UtHexCharToValue (InString[Gbl_MapToUuidOffset[i]]) << 4);
 239         UuidBuffer[i] |= (char)  UtHexCharToValue (InString[Gbl_MapToUuidOffset[i] + 1]);
 240     }
 241
 242     return (AE_OK);
 243 }
 244
 245
 246 /*******************************************************************************
 247  *
 248  * FUNCTION:    AuConvertUuidToString
 249  *
 250  * PARAMETERS:  UuidBuffer          - 16-byte UUID buffer
 251  *              OutString           - 36-byte formatted UUID string
 252  *
 253  * RETURN:      Status
 254  *
 255  * DESCRIPTION: Convert 16-byte UUID buffer to 36-byte formatted UUID string
 256  *              OutString must be 37 bytes to include null terminator.
 257  *
 258  ******************************************************************************/
 259
 260 ACPI_STATUS
 261 AuConvertUuidToString (
 262     char                    *UuidBuffer,
 263     char                    *OutString)
 264 {
 265     UINT32                  i;
 266
 267
 268     if (!UuidBuffer || !OutString)
 269     {
 270         return (AE_BAD_PARAMETER);
 271     }
 272
 273     for (i = 0; i < UUID_BUFFER_LENGTH; i++)
 274     {
 275         OutString[Gbl_MapToUuidOffset[i]] =     (UINT8) AslHexLookup[(UuidBuffer[i] >> 4) & 0xF];
 276         OutString[Gbl_MapToUuidOffset[i] + 1] = (UINT8) AslHexLookup[UuidBuffer[i] & 0xF];
 277     }
 278
 279     /* Insert required hyphens (dashes) */
 280
 281     OutString[UUID_HYPHEN1_OFFSET] =
 282     OutString[UUID_HYPHEN2_OFFSET] =
 283     OutString[UUID_HYPHEN3_OFFSET] =
 284     OutString[UUID_HYPHEN4_OFFSET] = '-';
 285
 286     OutString[UUID_STRING_LENGTH] = 0; /* Null terminate */
 287     return (AE_OK);
 288 }