1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2011 Calxeda, Inc.
13 #include <linux/ctype.h>
19 #include <dm/uclass.h>
23 * UUID - Universally Unique IDentifier - 128 bits unique number.
24 * There are 5 versions and one variant of UUID defined by RFC4122
25 * specification. A UUID contains a set of fields. The set varies
26 * depending on the version of the UUID, as shown below:
27 * - time, MAC address(v1),
29 * - MD5 of name or URL(v3),
31 * - SHA-1 of name or URL(v5),
34 * timestamp - 60-bit: time_low, time_mid, time_hi_and_version
35 * version - 4 bit (bit 4 through 7 of the time_hi_and_version)
36 * clock seq - 14 bit: clock_seq_hi_and_reserved, clock_seq_low
37 * variant: - bit 6 and 7 of clock_seq_hi_and_reserved
40 * source: https://www.ietf.org/rfc/rfc4122.txt
42 * UUID binary format (16 bytes):
44 * 4B-2B-2B-2B-6B (big endian - network byte order)
46 * UUID string is 36 length of characters (36 bytes):
49 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
52 * where x is a hexadecimal character. Fields are separated by '-'s.
53 * When converting to a binary UUID, le means the field should be converted
54 * to little endian and be means it should be converted to big endian.
56 * UUID is also used as GUID (Globally Unique Identifier) with the same binary
57 * format but it differs in string format like below.
61 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
64 * GUID is used e.g. in GPT (GUID Partition Table) as a partiions unique id.
66 int uuid_str_valid(const char *uuid
)
73 for (i
= 0, valid
= 1; uuid
[i
] && valid
; i
++) {
75 case 8: case 13: case 18: case 23:
76 valid
= (uuid
[i
] == '-');
79 valid
= isxdigit(uuid
[i
]);
84 if (i
!= UUID_STR_LEN
|| !valid
)
94 #ifdef CONFIG_PARTITION_TYPE_GUID
95 {"system", PARTITION_SYSTEM_GUID
},
96 {"mbr", LEGACY_MBR_PARTITION_GUID
},
97 {"msft", PARTITION_MSFT_RESERVED_GUID
},
98 {"data", PARTITION_BASIC_DATA_GUID
},
99 {"linux", PARTITION_LINUX_FILE_SYSTEM_DATA_GUID
},
100 {"raid", PARTITION_LINUX_RAID_GUID
},
101 {"swap", PARTITION_LINUX_SWAP_GUID
},
102 {"lvm", PARTITION_LINUX_LVM_GUID
},
103 {"u-boot-env", PARTITION_U_BOOT_ENVIRONMENT
},
105 #if defined(CONFIG_CMD_EFIDEBUG) || defined(CONFIG_EFI)
108 EFI_DEVICE_PATH_PROTOCOL_GUID
,
111 "Device Path To Text",
112 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID
,
115 "Device Path Utilities",
116 EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID
,
119 "Unicode Collation 2",
120 EFI_UNICODE_COLLATION_PROTOCOL2_GUID
,
124 EFI_DRIVER_BINDING_PROTOCOL_GUID
,
128 EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
,
131 "Simple Text Input Ex",
132 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID
,
135 "Simple Text Output",
136 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID
,
140 EFI_BLOCK_IO_PROTOCOL_GUID
,
143 "Simple File System",
144 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID
,
148 EFI_LOADED_IMAGE_PROTOCOL_GUID
,
152 EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
,
156 EFI_HII_STRING_PROTOCOL_GUID
,
160 EFI_HII_DATABASE_PROTOCOL_GUID
,
163 "HII Config Routing",
164 EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID
,
168 EFI_LOAD_FILE2_PROTOCOL_GUID
,
171 "Random Number Generator",
172 EFI_RNG_PROTOCOL_GUID
,
176 EFI_SIMPLE_NETWORK_PROTOCOL_GUID
,
180 EFI_PXE_BASE_CODE_PROTOCOL_GUID
,
184 EFI_DT_FIXUP_PROTOCOL_GUID
,
188 EFI_TCG2_PROTOCOL_GUID
,
192 PARTITION_SYSTEM_GUID
195 "Firmware Management",
196 EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID
198 /* Configuration table GUIDs */
204 "EFI System Resource Table",
205 EFI_SYSTEM_RESOURCE_TABLE_GUID
,
216 "Runtime properties",
217 EFI_RT_PROPERTIES_TABLE_GUID
,
220 "TCG2 Final Events Table",
221 EFI_TCG2_FINAL_EVENTS_TABLE_GUID
,
224 "EFI Conformance Profiles Table",
225 EFI_CONFORMANCE_PROFILES_TABLE_GUID
,
227 #ifdef CONFIG_EFI_RISCV_BOOT_PROTOCOL
230 RISCV_EFI_BOOT_PROTOCOL_GUID
,
233 #endif /* CONFIG_CMD_EFIDEBUG */
234 #ifdef CONFIG_CMD_NVEDIT_EFI
235 /* signature database */
237 "EFI_GLOBAL_VARIABLE_GUID",
238 EFI_GLOBAL_VARIABLE_GUID
,
241 "EFI_IMAGE_SECURITY_DATABASE_GUID",
242 EFI_IMAGE_SECURITY_DATABASE_GUID
,
244 /* certificate types */
246 "EFI_CERT_SHA256_GUID",
247 EFI_CERT_SHA256_GUID
,
250 "EFI_CERT_X509_GUID",
254 "EFI_CERT_TYPE_PKCS7_GUID",
255 EFI_CERT_TYPE_PKCS7_GUID
,
259 { "EFI_LZMA_COMPRESSED", EFI_LZMA_COMPRESSED
},
260 { "EFI_DXE_SERVICES", EFI_DXE_SERVICES
},
261 { "EFI_HOB_LIST", EFI_HOB_LIST
},
262 { "EFI_MEMORY_TYPE", EFI_MEMORY_TYPE
},
263 { "EFI_MEM_STATUS_CODE_REC", EFI_MEM_STATUS_CODE_REC
},
264 { "EFI_GUID_EFI_ACPI1", EFI_GUID_EFI_ACPI1
},
269 * uuid_guid_get_bin() - this function get GUID bin for string
271 * @param guid_str - pointer to partition type string
272 * @param guid_bin - pointer to allocated array for big endian output [16B]
274 int uuid_guid_get_bin(const char *guid_str
, unsigned char *guid_bin
)
278 for (i
= 0; i
< ARRAY_SIZE(list_guid
); i
++) {
279 if (!strcmp(list_guid
[i
].string
, guid_str
)) {
280 memcpy(guid_bin
, &list_guid
[i
].guid
, 16);
288 * uuid_guid_get_str() - this function get string for GUID.
290 * @param guid_bin - pointer to string with partition type guid [16B]
292 * Returns NULL if the type GUID is not known.
294 const char *uuid_guid_get_str(const unsigned char *guid_bin
)
298 for (i
= 0; i
< ARRAY_SIZE(list_guid
); i
++) {
299 if (!memcmp(list_guid
[i
].guid
.b
, guid_bin
, 16)) {
300 return list_guid
[i
].string
;
307 * uuid_str_to_bin() - convert string UUID or GUID to big endian binary data.
309 * @param uuid_str - pointer to UUID or GUID string [37B] or GUID shorcut
310 * @param uuid_bin - pointer to allocated array for big endian output [16B]
311 * @str_format - UUID string format: 0 - UUID; 1 - GUID
313 int uuid_str_to_bin(const char *uuid_str
, unsigned char *uuid_bin
,
320 if (!uuid_str_valid(uuid_str
)) {
321 #ifdef CONFIG_PARTITION_TYPE_GUID
322 if (!uuid_guid_get_bin(uuid_str
, uuid_bin
))
328 if (str_format
== UUID_STR_FORMAT_STD
) {
329 tmp32
= cpu_to_be32(hextoul(uuid_str
, NULL
));
330 memcpy(uuid_bin
, &tmp32
, 4);
332 tmp16
= cpu_to_be16(hextoul(uuid_str
+ 9, NULL
));
333 memcpy(uuid_bin
+ 4, &tmp16
, 2);
335 tmp16
= cpu_to_be16(hextoul(uuid_str
+ 14, NULL
));
336 memcpy(uuid_bin
+ 6, &tmp16
, 2);
338 tmp32
= cpu_to_le32(hextoul(uuid_str
, NULL
));
339 memcpy(uuid_bin
, &tmp32
, 4);
341 tmp16
= cpu_to_le16(hextoul(uuid_str
+ 9, NULL
));
342 memcpy(uuid_bin
+ 4, &tmp16
, 2);
344 tmp16
= cpu_to_le16(hextoul(uuid_str
+ 14, NULL
));
345 memcpy(uuid_bin
+ 6, &tmp16
, 2);
348 tmp16
= cpu_to_be16(hextoul(uuid_str
+ 19, NULL
));
349 memcpy(uuid_bin
+ 8, &tmp16
, 2);
351 tmp64
= cpu_to_be64(simple_strtoull(uuid_str
+ 24, NULL
, 16));
352 memcpy(uuid_bin
+ 10, (char *)&tmp64
+ 2, 6);
358 * uuid_bin_to_str() - convert big endian binary data to string UUID or GUID.
360 * @param uuid_bin: pointer to binary data of UUID (big endian) [16B]
361 * @param uuid_str: pointer to allocated array for output string [37B]
362 * @str_format: bit 0: 0 - UUID; 1 - GUID
363 * bit 1: 0 - lower case; 2 - upper case
365 void uuid_bin_to_str(const unsigned char *uuid_bin
, char *uuid_str
,
368 const u8 uuid_char_order
[UUID_BIN_LEN
] = {0, 1, 2, 3, 4, 5, 6, 7, 8,
369 9, 10, 11, 12, 13, 14, 15};
370 const u8 guid_char_order
[UUID_BIN_LEN
] = {3, 2, 1, 0, 5, 4, 7, 6, 8,
371 9, 10, 11, 12, 13, 14, 15};
372 const u8
*char_order
;
377 * UUID and GUID bin data - always in big endian:
381 if (str_format
& UUID_STR_FORMAT_GUID
)
382 char_order
= guid_char_order
;
384 char_order
= uuid_char_order
;
385 if (str_format
& UUID_STR_UPPER_CASE
)
390 for (i
= 0; i
< 16; i
++) {
391 sprintf(uuid_str
, format
, uuid_bin
[char_order
[i
]]);
405 * gen_rand_uuid() - this function generates a random binary UUID version 4.
406 * In this version all fields beside 4 bits of version and
407 * 2 bits of variant are randomly generated.
409 * @param uuid_bin - pointer to allocated array [16B]. Output is in big endian.
411 #if defined(CONFIG_RANDOM_UUID) || defined(CONFIG_CMD_UUID)
412 void gen_rand_uuid(unsigned char *uuid_bin
)
415 struct uuid
*uuid
= (struct uuid
*)ptr
;
417 struct udevice
*devp
;
420 if (IS_ENABLED(CONFIG_DM_RNG
)) {
421 ret
= uclass_get_device(UCLASS_RNG
, 0, &devp
);
423 ret
= dm_rng_read(devp
, &randv
, sizeof(randv
));
431 srand(get_ticks() + rand());
433 /* Set all fields randomly */
434 for (i
= 0; i
< 4; i
++)
437 clrsetbits_be16(&uuid
->time_hi_and_version
,
439 UUID_VERSION
<< UUID_VERSION_SHIFT
);
441 clrsetbits_8(&uuid
->clock_seq_hi_and_reserved
,
443 UUID_VARIANT
<< UUID_VARIANT_SHIFT
);
445 memcpy(uuid_bin
, uuid
, 16);
449 * gen_rand_uuid_str() - this function generates UUID v4 (random) in two string
450 * formats UUID or GUID.
452 * @param uuid_str - pointer to allocated array [37B].
453 * @param - uuid output type: UUID - 0, GUID - 1
455 void gen_rand_uuid_str(char *uuid_str
, int str_format
)
457 unsigned char uuid_bin
[UUID_BIN_LEN
];
459 /* Generate UUID (big endian) */
460 gen_rand_uuid(uuid_bin
);
462 /* Convert UUID bin to UUID or GUID formated STRING */
463 uuid_bin_to_str(uuid_bin
, uuid_str
, str_format
);
466 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_CMD_UUID)
467 int do_uuid(struct cmd_tbl
*cmdtp
, int flag
, int argc
, char *const argv
[])
469 char uuid
[UUID_STR_LEN
+ 1];
472 if (!strcmp(argv
[0], "uuid"))
473 str_format
= UUID_STR_FORMAT_STD
;
475 str_format
= UUID_STR_FORMAT_GUID
;
478 return CMD_RET_USAGE
;
480 gen_rand_uuid_str(uuid
, str_format
);
483 printf("%s\n", uuid
);
485 env_set(argv
[1], uuid
);
487 return CMD_RET_SUCCESS
;
490 U_BOOT_CMD(uuid
, CONFIG_SYS_MAXARGS
, 1, do_uuid
,
491 "UUID - generate random Universally Unique Identifier",
494 "varname: for set result in a environment variable\n"
498 U_BOOT_CMD(guid
, CONFIG_SYS_MAXARGS
, 1, do_uuid
,
499 "GUID - generate Globally Unique Identifier based on random UUID",
502 "varname: for set result in a environment variable\n"
505 #endif /* CONFIG_CMD_UUID */
506 #endif /* CONFIG_RANDOM_UUID || CONFIG_CMD_UUID */