Blame view

lib/uuid.c 8.37 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  // SPDX-License-Identifier: GPL-2.0+
e11938eab   Jason Hobbs   lib: add uuid_str...
2
3
  /*
   * Copyright 2011 Calxeda, Inc.
e11938eab   Jason Hobbs   lib: add uuid_str...
4
   */
89c8230de   Przemyslaw Marczak   new commands: uui...
5
  #include <common.h>
9fb625ce0   Simon Glass   env: Move env_set...
6
  #include <env.h>
1045315df   Simon Glass   common: Move get_...
7
  #include <time.h>
e11938eab   Jason Hobbs   lib: add uuid_str...
8
  #include <linux/ctype.h>
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
9
10
  #include <errno.h>
  #include <common.h>
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
11
12
13
  #include <asm/io.h>
  #include <part_efi.h>
  #include <malloc.h>
e11938eab   Jason Hobbs   lib: add uuid_str...
14
15
  
  /*
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
16
17
   * UUID - Universally Unique IDentifier - 128 bits unique number.
   *        There are 5 versions and one variant of UUID defined by RFC4122
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
   *        specification. A UUID contains a set of fields. The set varies
   *        depending on the version of the UUID, as shown below:
   *        - time, MAC address(v1),
   *        - user ID(v2),
   *        - MD5 of name or URL(v3),
   *        - random data(v4),
   *        - SHA-1 of name or URL(v5),
   *
   * Layout of UUID:
   * timestamp - 60-bit: time_low, time_mid, time_hi_and_version
   * version   - 4 bit (bit 4 through 7 of the time_hi_and_version)
   * clock seq - 14 bit: clock_seq_hi_and_reserved, clock_seq_low
   * variant:  - bit 6 and 7 of clock_seq_hi_and_reserved
   * node      - 48 bit
   *
   * source: https://www.ietf.org/rfc/rfc4122.txt
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
34
35
36
37
38
39
40
41
42
43
44
45
46
47
   *
   * UUID binary format (16 bytes):
   *
   * 4B-2B-2B-2B-6B (big endian - network byte order)
   *
   * UUID string is 36 length of characters (36 bytes):
   *
   * 0        9    14   19   24
   * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
   *    be     be   be   be       be
   *
   * where x is a hexadecimal character. Fields are separated by '-'s.
   * When converting to a binary UUID, le means the field should be converted
   * to little endian and be means it should be converted to big endian.
e11938eab   Jason Hobbs   lib: add uuid_str...
48
   *
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
49
50
   * UUID is also used as GUID (Globally Unique Identifier) with the same binary
   * format but it differs in string format like below.
e11938eab   Jason Hobbs   lib: add uuid_str...
51
   *
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
52
   * GUID:
e11938eab   Jason Hobbs   lib: add uuid_str...
53
54
55
   * 0        9    14   19   24
   * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
   *    le     le   le   be       be
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
56
57
   *
   * GUID is used e.g. in GPT (GUID Partition Table) as a partiions unique id.
e11938eab   Jason Hobbs   lib: add uuid_str...
58
   */
e11938eab   Jason Hobbs   lib: add uuid_str...
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
  int uuid_str_valid(const char *uuid)
  {
  	int i, valid;
  
  	if (uuid == NULL)
  		return 0;
  
  	for (i = 0, valid = 1; uuid[i] && valid; i++) {
  		switch (i) {
  		case 8: case 13: case 18: case 23:
  			valid = (uuid[i] == '-');
  			break;
  		default:
  			valid = isxdigit(uuid[i]);
  			break;
  		}
  	}
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
76
  	if (i != UUID_STR_LEN || !valid)
e11938eab   Jason Hobbs   lib: add uuid_str...
77
78
79
80
  		return 0;
  
  	return 1;
  }
bcb41dcae   Patrick Delaunay   uuid: add selecti...
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
  #ifdef CONFIG_PARTITION_TYPE_GUID
  static const struct {
  	const char *string;
  	efi_guid_t guid;
  } list_guid[] = {
  	{"system",	PARTITION_SYSTEM_GUID},
  	{"mbr",		LEGACY_MBR_PARTITION_GUID},
  	{"msft",	PARTITION_MSFT_RESERVED_GUID},
  	{"data",	PARTITION_BASIC_DATA_GUID},
  	{"linux",	PARTITION_LINUX_FILE_SYSTEM_DATA_GUID},
  	{"raid",	PARTITION_LINUX_RAID_GUID},
  	{"swap",	PARTITION_LINUX_SWAP_GUID},
  	{"lvm",		PARTITION_LINUX_LVM_GUID}
  };
  
  /*
   * uuid_guid_get_bin() - this function get GUID bin for string
   *
   * @param guid_str - pointer to partition type string
   * @param guid_bin - pointer to allocated array for big endian output [16B]
   */
  int uuid_guid_get_bin(const char *guid_str, unsigned char *guid_bin)
  {
  	int i;
  
  	for (i = 0; i < ARRAY_SIZE(list_guid); i++) {
  		if (!strcmp(list_guid[i].string, guid_str)) {
  			memcpy(guid_bin, &list_guid[i].guid, 16);
  			return 0;
  		}
  	}
  	return -ENODEV;
  }
  
  /*
   * uuid_guid_get_str() - this function get string for GUID.
   *
   * @param guid_bin - pointer to string with partition type guid [16B]
   * @param guid_str - pointer to allocated partition type string [7B]
   */
  int uuid_guid_get_str(unsigned char *guid_bin, char *guid_str)
  {
  	int i;
  
  	*guid_str = 0;
  	for (i = 0; i < ARRAY_SIZE(list_guid); i++) {
  		if (!memcmp(list_guid[i].guid.b, guid_bin, 16)) {
  			strcpy(guid_str, list_guid[i].string);
  			return 0;
  		}
  	}
  	return -ENODEV;
  }
  #endif
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
135
136
137
  /*
   * uuid_str_to_bin() - convert string UUID or GUID to big endian binary data.
   *
bcb41dcae   Patrick Delaunay   uuid: add selecti...
138
   * @param uuid_str - pointer to UUID or GUID string [37B] or GUID shorcut
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
139
140
141
142
   * @param uuid_bin - pointer to allocated array for big endian output [16B]
   * @str_format     - UUID string format: 0 - UUID; 1 - GUID
   */
  int uuid_str_to_bin(char *uuid_str, unsigned char *uuid_bin, int str_format)
e11938eab   Jason Hobbs   lib: add uuid_str...
143
144
145
146
  {
  	uint16_t tmp16;
  	uint32_t tmp32;
  	uint64_t tmp64;
bcb41dcae   Patrick Delaunay   uuid: add selecti...
147
148
149
150
151
  	if (!uuid_str_valid(uuid_str)) {
  #ifdef CONFIG_PARTITION_TYPE_GUID
  		if (!uuid_guid_get_bin(uuid_str, uuid_bin))
  			return 0;
  #endif
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
152
  		return -EINVAL;
bcb41dcae   Patrick Delaunay   uuid: add selecti...
153
  	}
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
154

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
155
156
157
  	if (str_format == UUID_STR_FORMAT_STD) {
  		tmp32 = cpu_to_be32(simple_strtoul(uuid_str, NULL, 16));
  		memcpy(uuid_bin, &tmp32, 4);
e11938eab   Jason Hobbs   lib: add uuid_str...
158

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
159
160
  		tmp16 = cpu_to_be16(simple_strtoul(uuid_str + 9, NULL, 16));
  		memcpy(uuid_bin + 4, &tmp16, 2);
e11938eab   Jason Hobbs   lib: add uuid_str...
161

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
162
163
164
165
166
  		tmp16 = cpu_to_be16(simple_strtoul(uuid_str + 14, NULL, 16));
  		memcpy(uuid_bin + 6, &tmp16, 2);
  	} else {
  		tmp32 = cpu_to_le32(simple_strtoul(uuid_str, NULL, 16));
  		memcpy(uuid_bin, &tmp32, 4);
e11938eab   Jason Hobbs   lib: add uuid_str...
167

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
168
169
  		tmp16 = cpu_to_le16(simple_strtoul(uuid_str + 9, NULL, 16));
  		memcpy(uuid_bin + 4, &tmp16, 2);
e11938eab   Jason Hobbs   lib: add uuid_str...
170

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
171
172
173
174
175
176
  		tmp16 = cpu_to_le16(simple_strtoul(uuid_str + 14, NULL, 16));
  		memcpy(uuid_bin + 6, &tmp16, 2);
  	}
  
  	tmp16 = cpu_to_be16(simple_strtoul(uuid_str + 19, NULL, 16));
  	memcpy(uuid_bin + 8, &tmp16, 2);
e11938eab   Jason Hobbs   lib: add uuid_str...
177

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
178
179
  	tmp64 = cpu_to_be64(simple_strtoull(uuid_str + 24, NULL, 16));
  	memcpy(uuid_bin + 10, (char *)&tmp64 + 2, 6);
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
180
181
182
  
  	return 0;
  }
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
183
184
185
  /*
   * uuid_bin_to_str() - convert big endian binary data to string UUID or GUID.
   *
3bad256f5   Heinrich Schuchardt   lib/vsprintf: all...
186
187
188
189
   * @param uuid_bin:	pointer to binary data of UUID (big endian) [16B]
   * @param uuid_str:	pointer to allocated array for output string [37B]
   * @str_format:		bit 0: 0 - UUID; 1 - GUID
   *			bit 1: 0 - lower case; 2 - upper case
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
190
191
   */
  void uuid_bin_to_str(unsigned char *uuid_bin, char *uuid_str, int str_format)
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
192
  {
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
193
194
195
196
197
  	const u8 uuid_char_order[UUID_BIN_LEN] = {0, 1, 2, 3, 4, 5, 6, 7, 8,
  						  9, 10, 11, 12, 13, 14, 15};
  	const u8 guid_char_order[UUID_BIN_LEN] = {3, 2, 1, 0, 5, 4, 7, 6, 8,
  						  9, 10, 11, 12, 13, 14, 15};
  	const u8 *char_order;
3bad256f5   Heinrich Schuchardt   lib/vsprintf: all...
198
  	const char *format;
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
199
  	int i;
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
200
201
202
203
204
  	/*
  	 * UUID and GUID bin data - always in big endian:
  	 * 4B-2B-2B-2B-6B
  	 * be be be be be
  	 */
3bad256f5   Heinrich Schuchardt   lib/vsprintf: all...
205
206
207
  	if (str_format & UUID_STR_FORMAT_GUID)
  		char_order = guid_char_order;
  	else
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
208
  		char_order = uuid_char_order;
3bad256f5   Heinrich Schuchardt   lib/vsprintf: all...
209
210
  	if (str_format & UUID_STR_UPPER_CASE)
  		format = "%02X";
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
211
  	else
3bad256f5   Heinrich Schuchardt   lib/vsprintf: all...
212
  		format = "%02x";
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
213

a96a0e615   Przemyslaw Marczak   part_efi: move uu...
214
  	for (i = 0; i < 16; i++) {
3bad256f5   Heinrich Schuchardt   lib/vsprintf: all...
215
  		sprintf(uuid_str, format, uuid_bin[char_order[i]]);
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
216
  		uuid_str += 2;
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
217
218
219
220
221
  		switch (i) {
  		case 3:
  		case 5:
  		case 7:
  		case 9:
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
222
  			*uuid_str++ = '-';
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
223
224
225
  			break;
  		}
  	}
e11938eab   Jason Hobbs   lib: add uuid_str...
226
  }
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
227
228
229
230
231
232
233
234
  
  /*
   * gen_rand_uuid() - this function generates a random binary UUID version 4.
   *                   In this version all fields beside 4 bits of version and
   *                   2 bits of variant are randomly generated.
   *
   * @param uuid_bin - pointer to allocated array [16B]. Output is in big endian.
  */
89c8230de   Przemyslaw Marczak   new commands: uui...
235
  #if defined(CONFIG_RANDOM_UUID) || defined(CONFIG_CMD_UUID)
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
236
237
  void gen_rand_uuid(unsigned char *uuid_bin)
  {
a1b633df5   Heinrich Schuchardt   lib: uuid: alignm...
238
239
  	u32 ptr[4];
  	struct uuid *uuid = (struct uuid *)ptr;
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
240
  	int i;
4ccf678f3   Eugeniu Rosca   lib: uuid: Fix un...
241
  	srand(get_ticks() + rand());
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
242
  	/* Set all fields randomly */
a1b633df5   Heinrich Schuchardt   lib: uuid: alignm...
243
244
  	for (i = 0; i < 4; i++)
  		ptr[i] = rand();
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
245

a1b633df5   Heinrich Schuchardt   lib: uuid: alignm...
246
  	clrsetbits_be16(&uuid->time_hi_and_version,
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
247
248
  			UUID_VERSION_MASK,
  			UUID_VERSION << UUID_VERSION_SHIFT);
a1b633df5   Heinrich Schuchardt   lib: uuid: alignm...
249
  	clrsetbits_8(&uuid->clock_seq_hi_and_reserved,
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
250
251
  		     UUID_VARIANT_MASK,
  		     UUID_VARIANT << UUID_VARIANT_SHIFT);
a1b633df5   Heinrich Schuchardt   lib: uuid: alignm...
252
  	memcpy(uuid_bin, uuid, 16);
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
  }
  
  /*
   * gen_rand_uuid_str() - this function generates UUID v4 (random) in two string
   *                       formats UUID or GUID.
   *
   * @param uuid_str - pointer to allocated array [37B].
   * @param          - uuid output type: UUID - 0, GUID - 1
   */
  void gen_rand_uuid_str(char *uuid_str, int str_format)
  {
  	unsigned char uuid_bin[UUID_BIN_LEN];
  
  	/* Generate UUID (big endian) */
  	gen_rand_uuid(uuid_bin);
  
  	/* Convert UUID bin to UUID or GUID formated STRING  */
  	uuid_bin_to_str(uuid_bin, uuid_str, str_format);
  }
89c8230de   Przemyslaw Marczak   new commands: uui...
272

05f6da3fa   Marek Vasut   lib: uuid: Do not...
273
  #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_CMD_UUID)
89c8230de   Przemyslaw Marczak   new commands: uui...
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
  int do_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  {
  	char uuid[UUID_STR_LEN + 1];
  	int str_format;
  
  	if (!strcmp(argv[0], "uuid"))
  		str_format = UUID_STR_FORMAT_STD;
  	else
  		str_format = UUID_STR_FORMAT_GUID;
  
  	if (argc > 2)
  		return CMD_RET_USAGE;
  
  	gen_rand_uuid_str(uuid, str_format);
  
  	if (argc == 1)
  		printf("%s
  ", uuid);
  	else
382bee57f   Simon Glass   env: Rename seten...
293
  		env_set(argv[1], uuid);
89c8230de   Przemyslaw Marczak   new commands: uui...
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
  
  	return CMD_RET_SUCCESS;
  }
  
  U_BOOT_CMD(uuid, CONFIG_SYS_MAXARGS, 1, do_uuid,
  	   "UUID - generate random Universally Unique Identifier",
  	   "[<varname>]
  "
  	   "Argument:
  "
  	   "varname: for set result in a environment variable
  "
  	   "e.g. uuid uuid_env"
  );
  
  U_BOOT_CMD(guid, CONFIG_SYS_MAXARGS, 1, do_uuid,
  	   "GUID - generate Globally Unique Identifier based on random UUID",
  	   "[<varname>]
  "
  	   "Argument:
  "
  	   "varname: for set result in a environment variable
  "
  	   "e.g. guid guid_env"
  );
39206382d   Przemyslaw Marczak   cmd:gpt: randomly...
319
320
  #endif /* CONFIG_CMD_UUID */
  #endif /* CONFIG_RANDOM_UUID || CONFIG_CMD_UUID */