xref: /freebsd/sys/contrib/dev/acpica/components/utilities/utuuid.c (revision 0d84335f991f528c6f038e79dd5cc0a7770532da)
1313a0c13SJung-uk Kim /******************************************************************************
2313a0c13SJung-uk Kim  *
3313a0c13SJung-uk Kim  * Module Name: utuuid -- UUID support functions
4313a0c13SJung-uk Kim  *
5313a0c13SJung-uk Kim  *****************************************************************************/
6313a0c13SJung-uk Kim 
7*0d84335fSJung-uk Kim /******************************************************************************
8*0d84335fSJung-uk Kim  *
9*0d84335fSJung-uk Kim  * 1. Copyright Notice
10*0d84335fSJung-uk Kim  *
11*0d84335fSJung-uk Kim  * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12313a0c13SJung-uk Kim  * All rights reserved.
13313a0c13SJung-uk Kim  *
14*0d84335fSJung-uk Kim  * 2. License
15*0d84335fSJung-uk Kim  *
16*0d84335fSJung-uk Kim  * 2.1. This is your license from Intel Corp. under its intellectual property
17*0d84335fSJung-uk Kim  * rights. You may have additional license terms from the party that provided
18*0d84335fSJung-uk Kim  * you this software, covering your right to use that party's intellectual
19*0d84335fSJung-uk Kim  * property rights.
20*0d84335fSJung-uk Kim  *
21*0d84335fSJung-uk Kim  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*0d84335fSJung-uk Kim  * copy of the source code appearing in this file ("Covered Code") an
23*0d84335fSJung-uk Kim  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*0d84335fSJung-uk Kim  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*0d84335fSJung-uk Kim  * make derivatives, distribute, use and display any portion of the Covered
26*0d84335fSJung-uk Kim  * Code in any form, with the right to sublicense such rights; and
27*0d84335fSJung-uk Kim  *
28*0d84335fSJung-uk Kim  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*0d84335fSJung-uk Kim  * license (with the right to sublicense), under only those claims of Intel
30*0d84335fSJung-uk Kim  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*0d84335fSJung-uk Kim  * offer to sell, and import the Covered Code and derivative works thereof
32*0d84335fSJung-uk Kim  * solely to the minimum extent necessary to exercise the above copyright
33*0d84335fSJung-uk Kim  * license, and in no event shall the patent license extend to any additions
34*0d84335fSJung-uk Kim  * to or modifications of the Original Intel Code. No other license or right
35*0d84335fSJung-uk Kim  * is granted directly or by implication, estoppel or otherwise;
36*0d84335fSJung-uk Kim  *
37*0d84335fSJung-uk Kim  * The above copyright and patent license is granted only if the following
38*0d84335fSJung-uk Kim  * conditions are met:
39*0d84335fSJung-uk Kim  *
40*0d84335fSJung-uk Kim  * 3. Conditions
41*0d84335fSJung-uk Kim  *
42*0d84335fSJung-uk Kim  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*0d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
44*0d84335fSJung-uk Kim  * Code or modification with rights to further distribute source must include
45*0d84335fSJung-uk Kim  * the above Copyright Notice, the above License, this list of Conditions,
46*0d84335fSJung-uk Kim  * and the following Disclaimer and Export Compliance provision. In addition,
47*0d84335fSJung-uk Kim  * Licensee must cause all Covered Code to which Licensee contributes to
48*0d84335fSJung-uk Kim  * contain a file documenting the changes Licensee made to create that Covered
49*0d84335fSJung-uk Kim  * Code and the date of any change. Licensee must include in that file the
50*0d84335fSJung-uk Kim  * documentation of any changes made by any predecessor Licensee. Licensee
51*0d84335fSJung-uk Kim  * must include a prominent statement that the modification is derived,
52*0d84335fSJung-uk Kim  * directly or indirectly, from Original Intel Code.
53*0d84335fSJung-uk Kim  *
54*0d84335fSJung-uk Kim  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*0d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
56*0d84335fSJung-uk Kim  * Code or modification without rights to further distribute source must
57*0d84335fSJung-uk Kim  * include the following Disclaimer and Export Compliance provision in the
58*0d84335fSJung-uk Kim  * documentation and/or other materials provided with distribution. In
59*0d84335fSJung-uk Kim  * addition, Licensee may not authorize further sublicense of source of any
60*0d84335fSJung-uk Kim  * portion of the Covered Code, and must include terms to the effect that the
61*0d84335fSJung-uk Kim  * license from Licensee to its licensee is limited to the intellectual
62*0d84335fSJung-uk Kim  * property embodied in the software Licensee provides to its licensee, and
63*0d84335fSJung-uk Kim  * not to intellectual property embodied in modifications its licensee may
64*0d84335fSJung-uk Kim  * make.
65*0d84335fSJung-uk Kim  *
66*0d84335fSJung-uk Kim  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*0d84335fSJung-uk Kim  * substantial portion of the Covered Code or modification must reproduce the
68*0d84335fSJung-uk Kim  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*0d84335fSJung-uk Kim  * provision in the documentation and/or other materials provided with the
70*0d84335fSJung-uk Kim  * distribution.
71*0d84335fSJung-uk Kim  *
72*0d84335fSJung-uk Kim  * 3.4. Intel retains all right, title, and interest in and to the Original
73*0d84335fSJung-uk Kim  * Intel Code.
74*0d84335fSJung-uk Kim  *
75*0d84335fSJung-uk Kim  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*0d84335fSJung-uk Kim  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*0d84335fSJung-uk Kim  * other dealings in products derived from or relating to the Covered Code
78*0d84335fSJung-uk Kim  * without prior written authorization from Intel.
79*0d84335fSJung-uk Kim  *
80*0d84335fSJung-uk Kim  * 4. Disclaimer and Export Compliance
81*0d84335fSJung-uk Kim  *
82*0d84335fSJung-uk Kim  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*0d84335fSJung-uk Kim  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*0d84335fSJung-uk Kim  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*0d84335fSJung-uk Kim  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*0d84335fSJung-uk Kim  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*0d84335fSJung-uk Kim  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*0d84335fSJung-uk Kim  * PARTICULAR PURPOSE.
89*0d84335fSJung-uk Kim  *
90*0d84335fSJung-uk Kim  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*0d84335fSJung-uk Kim  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*0d84335fSJung-uk Kim  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*0d84335fSJung-uk Kim  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*0d84335fSJung-uk Kim  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*0d84335fSJung-uk Kim  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*0d84335fSJung-uk Kim  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*0d84335fSJung-uk Kim  * LIMITED REMEDY.
98*0d84335fSJung-uk Kim  *
99*0d84335fSJung-uk Kim  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*0d84335fSJung-uk Kim  * software or system incorporating such software without first obtaining any
101*0d84335fSJung-uk Kim  * required license or other approval from the U. S. Department of Commerce or
102*0d84335fSJung-uk Kim  * any other agency or department of the United States Government. In the
103*0d84335fSJung-uk Kim  * event Licensee exports any such software from the United States or
104*0d84335fSJung-uk Kim  * re-exports any such software from a foreign destination, Licensee shall
105*0d84335fSJung-uk Kim  * ensure that the distribution and export/re-export of the software is in
106*0d84335fSJung-uk Kim  * compliance with all laws, regulations, orders, or other restrictions of the
107*0d84335fSJung-uk Kim  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*0d84335fSJung-uk Kim  * any of its subsidiaries will export/re-export any technical data, process,
109*0d84335fSJung-uk Kim  * software, or service, directly or indirectly, to any country for which the
110*0d84335fSJung-uk Kim  * United States government or any agency thereof requires an export license,
111*0d84335fSJung-uk Kim  * other governmental approval, or letter of assurance, without first obtaining
112*0d84335fSJung-uk Kim  * such license, approval or letter.
113*0d84335fSJung-uk Kim  *
114*0d84335fSJung-uk Kim  *****************************************************************************
115*0d84335fSJung-uk Kim  *
116*0d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
117*0d84335fSJung-uk Kim  * following license:
118*0d84335fSJung-uk Kim  *
119313a0c13SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
120313a0c13SJung-uk Kim  * modification, are permitted provided that the following conditions
121313a0c13SJung-uk Kim  * are met:
122313a0c13SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
123313a0c13SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
124313a0c13SJung-uk Kim  *    without modification.
125313a0c13SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126313a0c13SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
127313a0c13SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
128313a0c13SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
129313a0c13SJung-uk Kim  *    binary redistribution.
130313a0c13SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
131313a0c13SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
132313a0c13SJung-uk Kim  *    from this software without specific prior written permission.
133313a0c13SJung-uk Kim  *
134*0d84335fSJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135*0d84335fSJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*0d84335fSJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137*0d84335fSJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*0d84335fSJung-uk Kim  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*0d84335fSJung-uk Kim  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*0d84335fSJung-uk Kim  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*0d84335fSJung-uk Kim  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*0d84335fSJung-uk Kim  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*0d84335fSJung-uk Kim  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*0d84335fSJung-uk Kim  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*0d84335fSJung-uk Kim  *
146*0d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
147313a0c13SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
148313a0c13SJung-uk Kim  * Software Foundation.
149313a0c13SJung-uk Kim  *
150*0d84335fSJung-uk Kim  *****************************************************************************/
151313a0c13SJung-uk Kim 
152313a0c13SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
153313a0c13SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
154313a0c13SJung-uk Kim 
155313a0c13SJung-uk Kim #define _COMPONENT          ACPI_COMPILER
156313a0c13SJung-uk Kim         ACPI_MODULE_NAME    ("utuuid")
157313a0c13SJung-uk Kim 
158313a0c13SJung-uk Kim 
1597cf3e94aSJung-uk Kim #if (defined ACPI_ASL_COMPILER || defined ACPI_DISASSEMBLER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
160313a0c13SJung-uk Kim /*
161313a0c13SJung-uk Kim  * UUID support functions.
162313a0c13SJung-uk Kim  *
163313a0c13SJung-uk Kim  * This table is used to convert an input UUID ascii string to a 16 byte
164313a0c13SJung-uk Kim  * buffer and the reverse. The table maps a UUID buffer index 0-15 to
165313a0c13SJung-uk Kim  * the index within the 36-byte UUID string where the associated 2-byte
166313a0c13SJung-uk Kim  * hex value can be found.
167313a0c13SJung-uk Kim  *
168313a0c13SJung-uk Kim  * 36-byte UUID strings are of the form:
169313a0c13SJung-uk Kim  *     aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
170313a0c13SJung-uk Kim  * Where aa-pp are one byte hex numbers, made up of two hex digits
171313a0c13SJung-uk Kim  *
172313a0c13SJung-uk Kim  * Note: This table is basically the inverse of the string-to-offset table
173313a0c13SJung-uk Kim  * found in the ACPI spec in the description of the ToUUID macro.
174313a0c13SJung-uk Kim  */
175313a0c13SJung-uk Kim const UINT8    AcpiGbl_MapToUuidOffset[UUID_BUFFER_LENGTH] =
176313a0c13SJung-uk Kim {
177313a0c13SJung-uk Kim     6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34
178313a0c13SJung-uk Kim };
179313a0c13SJung-uk Kim 
180313a0c13SJung-uk Kim 
181313a0c13SJung-uk Kim /*******************************************************************************
182313a0c13SJung-uk Kim  *
183313a0c13SJung-uk Kim  * FUNCTION:    AcpiUtConvertStringToUuid
184313a0c13SJung-uk Kim  *
185313a0c13SJung-uk Kim  * PARAMETERS:  InString            - 36-byte formatted UUID string
186313a0c13SJung-uk Kim  *              UuidBuffer          - Where the 16-byte UUID buffer is returned
187313a0c13SJung-uk Kim  *
188313a0c13SJung-uk Kim  * RETURN:      None. Output data is returned in the UuidBuffer
189313a0c13SJung-uk Kim  *
190313a0c13SJung-uk Kim  * DESCRIPTION: Convert a 36-byte formatted UUID string to 16-byte UUID buffer
191313a0c13SJung-uk Kim  *
192313a0c13SJung-uk Kim  ******************************************************************************/
193313a0c13SJung-uk Kim 
194313a0c13SJung-uk Kim void
195313a0c13SJung-uk Kim AcpiUtConvertStringToUuid (
196313a0c13SJung-uk Kim     char                    *InString,
197313a0c13SJung-uk Kim     UINT8                   *UuidBuffer)
198313a0c13SJung-uk Kim {
199313a0c13SJung-uk Kim     UINT32                  i;
200313a0c13SJung-uk Kim 
201313a0c13SJung-uk Kim 
202313a0c13SJung-uk Kim     for (i = 0; i < UUID_BUFFER_LENGTH; i++)
203313a0c13SJung-uk Kim     {
204f8146b88SJung-uk Kim         UuidBuffer[i] = (AcpiUtAsciiCharToHex (
205f8146b88SJung-uk Kim             InString[AcpiGbl_MapToUuidOffset[i]]) << 4);
206313a0c13SJung-uk Kim 
207f8146b88SJung-uk Kim         UuidBuffer[i] |= AcpiUtAsciiCharToHex (
208f8146b88SJung-uk Kim             InString[AcpiGbl_MapToUuidOffset[i] + 1]);
209313a0c13SJung-uk Kim     }
210313a0c13SJung-uk Kim }
2117cf3e94aSJung-uk Kim #endif
212