1/******************************************************************************
2 *
3 * Module Name: utuuid -- UUID support functions
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2023, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions, and the following disclaimer,
16 *    without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 *    substantially similar to the "NO WARRANTY" disclaimer below
19 *    ("Disclaimer") and any redistribution must be conditioned upon
20 *    including a substantially similar Disclaimer requirement for further
21 *    binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 *    of any contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include "acpi.h"
45#include "accommon.h"
46
47#define _COMPONENT          ACPI_COMPILER
48        ACPI_MODULE_NAME    ("utuuid")
49
50
51#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP || defined ACPI_DISASSEMBLER)
52/*
53 * UUID support functions.
54 *
55 * This table is used to convert an input UUID ascii string to a 16 byte
56 * buffer and the reverse. The table maps a UUID buffer index 0-15 to
57 * the index within the 36-byte UUID string where the associated 2-byte
58 * hex value can be found.
59 *
60 * 36-byte UUID strings are of the form:
61 *     aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
62 * Where aa-pp are one byte hex numbers, made up of two hex digits
63 *
64 * Note: This table is basically the inverse of the string-to-offset table
65 * found in the ACPI spec in the description of the ToUUID macro.
66 */
67const UINT8    AcpiGbl_MapToUuidOffset[UUID_BUFFER_LENGTH] =
68{
69    6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34
70};
71
72
73/*******************************************************************************
74 *
75 * FUNCTION:    AcpiUtConvertStringToUuid
76 *
77 * PARAMETERS:  InString            - 36-byte formatted UUID string
78 *              UuidBuffer          - Where the 16-byte UUID buffer is returned
79 *
80 * RETURN:      None. Output data is returned in the UuidBuffer
81 *
82 * DESCRIPTION: Convert a 36-byte formatted UUID string to 16-byte UUID buffer
83 *
84 ******************************************************************************/
85
86void
87AcpiUtConvertStringToUuid (
88    const char              *InString,
89    UINT8                   *UuidBuffer)
90{
91    UINT32                  i;
92
93
94    for (i = 0; i < UUID_BUFFER_LENGTH; i++)
95    {
96        UuidBuffer[i] = (AcpiUtAsciiCharToHex (
97            InString[AcpiGbl_MapToUuidOffset[i]]) << 4);
98
99        UuidBuffer[i] |= AcpiUtAsciiCharToHex (
100            InString[AcpiGbl_MapToUuidOffset[i] + 1]);
101    }
102}
103
104
105/*******************************************************************************
106 *
107 * FUNCTION:    AcpiUtConvertUuidToString
108 *
109 * PARAMETERS:  UuidBuffer          - 16-byte UUID buffer
110 *              OutString           - 36-byte formatted UUID string
111 *
112 * RETURN:      Status
113 *
114 * DESCRIPTION: Convert 16-byte UUID buffer to 36-byte formatted UUID string
115 *              OutString must be 37 bytes to include null terminator.
116 *
117 ******************************************************************************/
118
119ACPI_STATUS
120AcpiUtConvertUuidToString (
121    char                    *UuidBuffer,
122    char                    *OutString)
123{
124    UINT32                  i;
125
126
127    if (!UuidBuffer || !OutString)
128    {
129        return (AE_BAD_PARAMETER);
130    }
131
132    for (i = 0; i < UUID_BUFFER_LENGTH; i++)
133    {
134        OutString[AcpiGbl_MapToUuidOffset[i]] =
135            AcpiUtHexToAsciiChar (UuidBuffer[i], 4);
136
137        OutString[AcpiGbl_MapToUuidOffset[i] + 1] =
138            AcpiUtHexToAsciiChar (UuidBuffer[i], 0);
139    }
140
141    /* Insert required hyphens (dashes) */
142
143    OutString[UUID_HYPHEN1_OFFSET] =
144    OutString[UUID_HYPHEN2_OFFSET] =
145    OutString[UUID_HYPHEN3_OFFSET] =
146    OutString[UUID_HYPHEN4_OFFSET] = '-';
147
148    OutString[UUID_STRING_LENGTH] = 0; /* Null terminate */
149    return (AE_OK);
150}
151#endif
152