Blame view

lib/uuid.c 8.22 KB
e11938eab   Jason Hobbs   lib: add uuid_str...
1
2
3
  /*
   * Copyright 2011 Calxeda, Inc.
   *
1a4596601   Wolfgang Denk   Add GPL-2.0+ SPDX...
4
   * SPDX-License-Identifier:	GPL-2.0+
e11938eab   Jason Hobbs   lib: add uuid_str...
5
   */
89c8230de   Przemyslaw Marczak   new commands: uui...
6
  #include <common.h>
e11938eab   Jason Hobbs   lib: add uuid_str...
7
  #include <linux/ctype.h>
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
8
9
  #include <errno.h>
  #include <common.h>
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
10
11
12
  #include <asm/io.h>
  #include <part_efi.h>
  #include <malloc.h>
e11938eab   Jason Hobbs   lib: add uuid_str...
13
14
  
  /*
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
15
16
   * 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...
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
   *        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...
33
34
35
36
37
38
39
40
41
42
43
44
45
46
   *
   * 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...
47
   *
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
48
49
   * 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...
50
   *
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
51
   * GUID:
e11938eab   Jason Hobbs   lib: add uuid_str...
52
53
54
   * 0        9    14   19   24
   * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
   *    le     le   le   be       be
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
55
56
   *
   * GUID is used e.g. in GPT (GUID Partition Table) as a partiions unique id.
e11938eab   Jason Hobbs   lib: add uuid_str...
57
   */
e11938eab   Jason Hobbs   lib: add uuid_str...
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  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...
75
  	if (i != UUID_STR_LEN || !valid)
e11938eab   Jason Hobbs   lib: add uuid_str...
76
77
78
79
  		return 0;
  
  	return 1;
  }
bcb41dcae   Patrick Delaunay   uuid: add selecti...
80
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
  #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...
134
135
136
  /*
   * uuid_str_to_bin() - convert string UUID or GUID to big endian binary data.
   *
bcb41dcae   Patrick Delaunay   uuid: add selecti...
137
   * @param uuid_str - pointer to UUID or GUID string [37B] or GUID shorcut
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
138
139
140
141
   * @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...
142
143
144
145
  {
  	uint16_t tmp16;
  	uint32_t tmp32;
  	uint64_t tmp64;
bcb41dcae   Patrick Delaunay   uuid: add selecti...
146
147
148
149
150
  	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...
151
  		return -EINVAL;
bcb41dcae   Patrick Delaunay   uuid: add selecti...
152
  	}
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
153

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
154
155
156
  	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...
157

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

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
161
162
163
164
165
  		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...
166

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

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
170
171
172
173
174
175
  		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...
176

d718ded05   Przemyslaw Marczak   lib: uuid: code r...
177
178
  	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...
179
180
181
  
  	return 0;
  }
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
182
183
184
185
186
187
188
189
  /*
   * uuid_bin_to_str() - convert big endian binary data to string UUID or GUID.
   *
   * @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     - UUID string format: 0 - UUID; 1 - GUID
   */
  void uuid_bin_to_str(unsigned char *uuid_bin, char *uuid_str, int str_format)
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
190
  {
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
191
192
193
194
195
  	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;
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
196
  	int i;
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
197
198
199
200
201
202
203
204
205
  	/*
  	 * UUID and GUID bin data - always in big endian:
  	 * 4B-2B-2B-2B-6B
  	 * be be be be be
  	 */
  	if (str_format == UUID_STR_FORMAT_STD)
  		char_order = uuid_char_order;
  	else
  		char_order = guid_char_order;
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
206
  	for (i = 0; i < 16; i++) {
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
207
208
  		sprintf(uuid_str, "%02x", uuid_bin[char_order[i]]);
  		uuid_str += 2;
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
209
210
211
212
213
  		switch (i) {
  		case 3:
  		case 5:
  		case 7:
  		case 9:
d718ded05   Przemyslaw Marczak   lib: uuid: code r...
214
  			*uuid_str++ = '-';
a96a0e615   Przemyslaw Marczak   part_efi: move uu...
215
216
217
  			break;
  		}
  	}
e11938eab   Jason Hobbs   lib: add uuid_str...
218
  }
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
219
220
221
222
223
224
225
226
  
  /*
   * 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...
227
  #if defined(CONFIG_RANDOM_UUID) || defined(CONFIG_CMD_UUID)
4e4815fea   Przemyslaw Marczak   lib: uuid: add fu...
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
  void gen_rand_uuid(unsigned char *uuid_bin)
  {
  	struct uuid uuid;
  	unsigned int *ptr = (unsigned int *)&uuid;
  	int i;
  
  	/* Set all fields randomly */
  	for (i = 0; i < sizeof(struct uuid) / sizeof(*ptr); i++)
  		*(ptr + i) = cpu_to_be32(rand());
  
  	clrsetbits_be16(&uuid.time_hi_and_version,
  			UUID_VERSION_MASK,
  			UUID_VERSION << UUID_VERSION_SHIFT);
  
  	clrsetbits_8(&uuid.clock_seq_hi_and_reserved,
  		     UUID_VARIANT_MASK,
  		     UUID_VARIANT << UUID_VARIANT_SHIFT);
  
  	memcpy(uuid_bin, &uuid, sizeof(struct uuid));
  }
  
  /*
   * 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...
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
  
  #ifdef CONFIG_CMD_UUID
  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...
287
  		env_set(argv[1], uuid);
89c8230de   Przemyslaw Marczak   new commands: uui...
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  
  	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...
313
314
  #endif /* CONFIG_CMD_UUID */
  #endif /* CONFIG_RANDOM_UUID || CONFIG_CMD_UUID */