xref: /rk3399_rockchip-uboot/disk/part_efi.c (revision bc04a3dd9a41813372820ba50655022a6a28bfbf)
1 /*
2  * Copyright (C) 2008 RuggedCom, Inc.
3  * Richard Retanubun <RichardRetanubun@RuggedCom.com>
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 /*
9  * NOTE:
10  *   when CONFIG_SYS_64BIT_LBA is not defined, lbaint_t is 32 bits; this
11  *   limits the maximum size of addressable storage to < 2 Terra Bytes
12  */
13 #include <asm/unaligned.h>
14 #include <common.h>
15 #include <command.h>
16 #include <fdtdec.h>
17 #include <ide.h>
18 #include <inttypes.h>
19 #include <malloc.h>
20 #include <memalign.h>
21 #include <part_efi.h>
22 #include <linux/compiler.h>
23 #include <linux/ctype.h>
24 
25 DECLARE_GLOBAL_DATA_PTR;
26 
27 #ifdef HAVE_BLOCK_DEVICE
28 /**
29  * efi_crc32() - EFI version of crc32 function
30  * @buf: buffer to calculate crc32 of
31  * @len - length of buf
32  *
33  * Description: Returns EFI-style CRC32 value for @buf
34  */
35 static inline u32 efi_crc32(const void *buf, u32 len)
36 {
37 	return crc32(0, buf, len);
38 }
39 
40 /*
41  * Private function prototypes
42  */
43 
44 static int pmbr_part_valid(struct partition *part);
45 static int is_pmbr_valid(legacy_mbr * mbr);
46 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
47 				gpt_header *pgpt_head, gpt_entry **pgpt_pte);
48 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
49 					 gpt_header *pgpt_head);
50 static int is_pte_valid(gpt_entry * pte);
51 
52 static char *print_efiname(gpt_entry *pte)
53 {
54 	static char name[PARTNAME_SZ + 1];
55 	int i;
56 	for (i = 0; i < PARTNAME_SZ; i++) {
57 		u8 c;
58 		c = pte->partition_name[i] & 0xff;
59 		c = (c && !isprint(c)) ? '.' : c;
60 		name[i] = c;
61 	}
62 	name[PARTNAME_SZ] = 0;
63 	return name;
64 }
65 
66 static efi_guid_t system_guid = PARTITION_SYSTEM_GUID;
67 
68 static inline int is_bootable(gpt_entry *p)
69 {
70 	return p->attributes.fields.legacy_bios_bootable ||
71 		!memcmp(&(p->partition_type_guid), &system_guid,
72 			sizeof(efi_guid_t));
73 }
74 
75 static int validate_gpt_header(gpt_header *gpt_h, lbaint_t lba,
76 		lbaint_t lastlba)
77 {
78 	uint32_t crc32_backup = 0;
79 	uint32_t calc_crc32;
80 
81 	/* Check the GPT header signature */
82 	if (le64_to_cpu(gpt_h->signature) != GPT_HEADER_SIGNATURE) {
83 		printf("%s signature is wrong: 0x%llX != 0x%llX\n",
84 		       "GUID Partition Table Header",
85 		       le64_to_cpu(gpt_h->signature),
86 		       GPT_HEADER_SIGNATURE);
87 		return -1;
88 	}
89 
90 	/* Check the GUID Partition Table CRC */
91 	memcpy(&crc32_backup, &gpt_h->header_crc32, sizeof(crc32_backup));
92 	memset(&gpt_h->header_crc32, 0, sizeof(gpt_h->header_crc32));
93 
94 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
95 		le32_to_cpu(gpt_h->header_size));
96 
97 	memcpy(&gpt_h->header_crc32, &crc32_backup, sizeof(crc32_backup));
98 
99 	if (calc_crc32 != le32_to_cpu(crc32_backup)) {
100 		printf("%s CRC is wrong: 0x%x != 0x%x\n",
101 		       "GUID Partition Table Header",
102 		       le32_to_cpu(crc32_backup), calc_crc32);
103 		return -1;
104 	}
105 
106 	/*
107 	 * Check that the my_lba entry points to the LBA that contains the GPT
108 	 */
109 	if (le64_to_cpu(gpt_h->my_lba) != lba) {
110 		printf("GPT: my_lba incorrect: %llX != " LBAF "\n",
111 		       le64_to_cpu(gpt_h->my_lba),
112 		       lba);
113 		return -1;
114 	}
115 
116 	/*
117 	 * Check that the first_usable_lba and that the last_usable_lba are
118 	 * within the disk.
119 	 */
120 	if (le64_to_cpu(gpt_h->first_usable_lba) > lastlba) {
121 		printf("GPT: first_usable_lba incorrect: %llX > " LBAF "\n",
122 		       le64_to_cpu(gpt_h->first_usable_lba), lastlba);
123 		return -1;
124 	}
125 	if (le64_to_cpu(gpt_h->last_usable_lba) > lastlba) {
126 		printf("GPT: last_usable_lba incorrect: %llX > " LBAF "\n",
127 		       le64_to_cpu(gpt_h->last_usable_lba), lastlba);
128 		return -1;
129 	}
130 
131 	debug("GPT: first_usable_lba: %llX last_usable_lba: %llX last lba: "
132 	      LBAF "\n", le64_to_cpu(gpt_h->first_usable_lba),
133 	      le64_to_cpu(gpt_h->last_usable_lba), lastlba);
134 
135 	return 0;
136 }
137 
138 static int validate_gpt_entries(gpt_header *gpt_h, gpt_entry *gpt_e)
139 {
140 	uint32_t calc_crc32;
141 
142 	/* Check the GUID Partition Table Entry Array CRC */
143 	calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
144 		le32_to_cpu(gpt_h->num_partition_entries) *
145 		le32_to_cpu(gpt_h->sizeof_partition_entry));
146 
147 	if (calc_crc32 != le32_to_cpu(gpt_h->partition_entry_array_crc32)) {
148 		printf("%s: 0x%x != 0x%x\n",
149 		       "GUID Partition Table Entry Array CRC is wrong",
150 		       le32_to_cpu(gpt_h->partition_entry_array_crc32),
151 		       calc_crc32);
152 		return -1;
153 	}
154 
155 	return 0;
156 }
157 
158 static void prepare_backup_gpt_header(gpt_header *gpt_h)
159 {
160 	uint32_t calc_crc32;
161 	uint64_t val;
162 
163 	/* recalculate the values for the Backup GPT Header */
164 	val = le64_to_cpu(gpt_h->my_lba);
165 	gpt_h->my_lba = gpt_h->alternate_lba;
166 	gpt_h->alternate_lba = cpu_to_le64(val);
167 	gpt_h->partition_entry_lba =
168 			cpu_to_le64(le64_to_cpu(gpt_h->last_usable_lba) + 1);
169 	gpt_h->header_crc32 = 0;
170 
171 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
172 			       le32_to_cpu(gpt_h->header_size));
173 	gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
174 }
175 
176 #if CONFIG_IS_ENABLED(EFI_PARTITION)
177 /*
178  * Public Functions (include/part.h)
179  */
180 
181 /*
182  * UUID is displayed as 32 hexadecimal digits, in 5 groups,
183  * separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters
184  */
185 int get_disk_guid(struct blk_desc * dev_desc, char *guid)
186 {
187 	ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
188 	gpt_entry *gpt_pte = NULL;
189 	unsigned char *guid_bin;
190 
191 	/* This function validates AND fills in the GPT header and PTE */
192 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
193 			 gpt_head, &gpt_pte) != 1) {
194 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
195 		if (is_gpt_valid(dev_desc, dev_desc->lba - 1,
196 				 gpt_head, &gpt_pte) != 1) {
197 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
198 			       __func__);
199 			return -EINVAL;
200 		} else {
201 			printf("%s: ***        Using Backup GPT ***\n",
202 			       __func__);
203 		}
204 	}
205 
206 	guid_bin = gpt_head->disk_guid.b;
207 	uuid_bin_to_str(guid_bin, guid, UUID_STR_FORMAT_GUID);
208 
209 	return 0;
210 }
211 
212 void part_print_efi(struct blk_desc *dev_desc)
213 {
214 	ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
215 	gpt_entry *gpt_pte = NULL;
216 	int i = 0;
217 	char uuid[UUID_STR_LEN + 1];
218 	unsigned char *uuid_bin;
219 
220 	/* This function validates AND fills in the GPT header and PTE */
221 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
222 			 gpt_head, &gpt_pte) != 1) {
223 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
224 		if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
225 				 gpt_head, &gpt_pte) != 1) {
226 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
227 			       __func__);
228 			return;
229 		} else {
230 			printf("%s: ***        Using Backup GPT ***\n",
231 			       __func__);
232 		}
233 	}
234 
235 	debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
236 
237 	printf("Part\tStart LBA\tEnd LBA\t\tName\n");
238 	printf("\tAttributes\n");
239 	printf("\tType GUID\n");
240 	printf("\tPartition GUID\n");
241 
242 	for (i = 0; i < le32_to_cpu(gpt_head->num_partition_entries); i++) {
243 		/* Stop at the first non valid PTE */
244 		if (!is_pte_valid(&gpt_pte[i]))
245 			break;
246 
247 		printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i + 1),
248 			le64_to_cpu(gpt_pte[i].starting_lba),
249 			le64_to_cpu(gpt_pte[i].ending_lba),
250 			print_efiname(&gpt_pte[i]));
251 		printf("\tattrs:\t0x%016llx\n", gpt_pte[i].attributes.raw);
252 		uuid_bin = (unsigned char *)gpt_pte[i].partition_type_guid.b;
253 		uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
254 		printf("\ttype:\t%s\n", uuid);
255 #ifdef CONFIG_PARTITION_TYPE_GUID
256 		if (!uuid_guid_get_str(uuid_bin, uuid))
257 			printf("\ttype:\t%s\n", uuid);
258 #endif
259 		uuid_bin = (unsigned char *)gpt_pte[i].unique_partition_guid.b;
260 		uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
261 		printf("\tguid:\t%s\n", uuid);
262 	}
263 
264 	/* Remember to free pte */
265 	free(gpt_pte);
266 	return;
267 }
268 
269 int part_get_info_efi(struct blk_desc *dev_desc, int part,
270 		      disk_partition_t *info)
271 {
272 	static gpt_entry *gpt_pte = NULL;
273 	static gpt_header *gpt_head = NULL;
274 
275 	if (!gpt_head)
276 		gpt_head = memalign(ARCH_DMA_MINALIGN, dev_desc->blksz);
277 
278 	/*
279 	 * We suppose different dev have different size, eg. emmc vs sd
280 	 * free the pte first if exist and then will malloc and init a new one.
281 	 */
282 	if (gpt_head && (gpt_head->last_usable_lba + 0x22) != dev_desc->lba) {
283 		if (gpt_pte)
284 			free(gpt_pte);
285 		gpt_pte = NULL;
286 	}
287 
288 	/* "part" argument must be at least 1 */
289 	if (part < 1) {
290 		printf("%s: Invalid Argument(s)\n", __func__);
291 		return -1;
292 	}
293 
294 	/* This function validates AND fills in the GPT header and PTE */
295 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
296 			gpt_head, &gpt_pte) != 1) {
297 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
298 		if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
299 				 gpt_head, &gpt_pte) != 1) {
300 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
301 			       __func__);
302 			return -1;
303 		} else {
304 			printf("%s: ***        Using Backup GPT ***\n",
305 			       __func__);
306 		}
307 	}
308 
309 	if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
310 	    !is_pte_valid(&gpt_pte[part - 1])) {
311 		debug("%s: *** ERROR: Invalid partition number %d ***\n",
312 			__func__, part);
313 		return -1;
314 	}
315 
316 	/* The 'lbaint_t' casting may limit the maximum disk size to 2 TB */
317 	info->start = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].starting_lba);
318 	/* The ending LBA is inclusive, to calculate size, add 1 to it */
319 	info->size = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1
320 		     - info->start;
321 	info->blksz = dev_desc->blksz;
322 
323 	sprintf((char *)info->name, "%s",
324 			print_efiname(&gpt_pte[part - 1]));
325 	strcpy((char *)info->type, "U-Boot");
326 	info->bootable = is_bootable(&gpt_pte[part - 1]);
327 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
328 	uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b, info->uuid,
329 			UUID_STR_FORMAT_GUID);
330 #endif
331 #ifdef CONFIG_PARTITION_TYPE_GUID
332 	uuid_bin_to_str(gpt_pte[part - 1].partition_type_guid.b,
333 			info->type_guid, UUID_STR_FORMAT_GUID);
334 #endif
335 
336 	debug("%s: start 0x" LBAF ", size 0x" LBAF ", name %s\n", __func__,
337 	      info->start, info->size, info->name);
338 
339 	return 0;
340 }
341 
342 static int part_test_efi(struct blk_desc *dev_desc)
343 {
344 	ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, dev_desc->blksz);
345 
346 	/* Read legacy MBR from block 0 and validate it */
347 	if ((blk_dread(dev_desc, 0, 1, (ulong *)legacymbr) != 1)
348 		|| (is_pmbr_valid(legacymbr) != 1)) {
349 		return -1;
350 	}
351 	return 0;
352 }
353 
354 /**
355  * set_protective_mbr(): Set the EFI protective MBR
356  * @param dev_desc - block device descriptor
357  *
358  * @return - zero on success, otherwise error
359  */
360 static int set_protective_mbr(struct blk_desc *dev_desc)
361 {
362 	/* Setup the Protective MBR */
363 	ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, p_mbr, 1);
364 	memset(p_mbr, 0, sizeof(*p_mbr));
365 
366 	if (p_mbr == NULL) {
367 		printf("%s: calloc failed!\n", __func__);
368 		return -1;
369 	}
370 
371 	/* Read MBR to backup boot code if it exists */
372 	if (blk_dread(dev_desc, 0, 1, p_mbr) != 1) {
373 		pr_err("** Can't read from device %d **\n", dev_desc->devnum);
374 		return -1;
375 	}
376 
377 	/* Append signature */
378 	p_mbr->signature = MSDOS_MBR_SIGNATURE;
379 	p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
380 	p_mbr->partition_record[0].start_sect = 1;
381 	p_mbr->partition_record[0].nr_sects = (u32) dev_desc->lba - 1;
382 
383 	/* Write MBR sector to the MMC device */
384 	if (blk_dwrite(dev_desc, 0, 1, p_mbr) != 1) {
385 		printf("** Can't write to device %d **\n",
386 			dev_desc->devnum);
387 		return -1;
388 	}
389 
390 	return 0;
391 }
392 
393 int write_gpt_table(struct blk_desc *dev_desc,
394 		gpt_header *gpt_h, gpt_entry *gpt_e)
395 {
396 	const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
397 					   * sizeof(gpt_entry)), dev_desc);
398 	u32 calc_crc32;
399 
400 	debug("max lba: %x\n", (u32) dev_desc->lba);
401 	/* Setup the Protective MBR */
402 	if (set_protective_mbr(dev_desc) < 0)
403 		goto err;
404 
405 	/* Generate CRC for the Primary GPT Header */
406 	calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
407 			      le32_to_cpu(gpt_h->num_partition_entries) *
408 			      le32_to_cpu(gpt_h->sizeof_partition_entry));
409 	gpt_h->partition_entry_array_crc32 = cpu_to_le32(calc_crc32);
410 
411 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
412 			      le32_to_cpu(gpt_h->header_size));
413 	gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
414 
415 	/* Write the First GPT to the block right after the Legacy MBR */
416 	if (blk_dwrite(dev_desc, 1, 1, gpt_h) != 1)
417 		goto err;
418 
419 	if (blk_dwrite(dev_desc, le64_to_cpu(gpt_h->partition_entry_lba),
420 		       pte_blk_cnt, gpt_e) != pte_blk_cnt)
421 		goto err;
422 
423 	prepare_backup_gpt_header(gpt_h);
424 
425 	if (blk_dwrite(dev_desc, (lbaint_t)le64_to_cpu(gpt_h->last_usable_lba)
426 		       + 1, pte_blk_cnt, gpt_e) != pte_blk_cnt)
427 		goto err;
428 
429 	if (blk_dwrite(dev_desc, (lbaint_t)le64_to_cpu(gpt_h->my_lba), 1,
430 		       gpt_h) != 1)
431 		goto err;
432 
433 	debug("GPT successfully written to block device!\n");
434 	return 0;
435 
436  err:
437 	printf("** Can't write to device %d **\n", dev_desc->devnum);
438 	return -1;
439 }
440 
441 int gpt_fill_pte(struct blk_desc *dev_desc,
442 		 gpt_header *gpt_h, gpt_entry *gpt_e,
443 		 disk_partition_t *partitions, int parts)
444 {
445 	lbaint_t offset = (lbaint_t)le64_to_cpu(gpt_h->first_usable_lba);
446 	lbaint_t last_usable_lba = (lbaint_t)
447 			le64_to_cpu(gpt_h->last_usable_lba);
448 	int i, k;
449 	size_t efiname_len, dosname_len;
450 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
451 	char *str_uuid;
452 	unsigned char *bin_uuid;
453 #endif
454 #ifdef CONFIG_PARTITION_TYPE_GUID
455 	char *str_type_guid;
456 	unsigned char *bin_type_guid;
457 #endif
458 	size_t hdr_start = gpt_h->my_lba;
459 	size_t hdr_end = hdr_start + 1;
460 
461 	size_t pte_start = gpt_h->partition_entry_lba;
462 	size_t pte_end = pte_start +
463 		gpt_h->num_partition_entries * gpt_h->sizeof_partition_entry /
464 		dev_desc->blksz;
465 
466 	for (i = 0; i < parts; i++) {
467 		/* partition starting lba */
468 		lbaint_t start = partitions[i].start;
469 		lbaint_t size = partitions[i].size;
470 
471 		if (start) {
472 			offset = start + size;
473 		} else {
474 			start = offset;
475 			offset += size;
476 		}
477 
478 		/*
479 		 * If our partition overlaps with either the GPT
480 		 * header, or the partition entry, reject it.
481 		 */
482 		if (((start < hdr_end && hdr_start < (start + size)) ||
483 		     (start < pte_end && pte_start < (start + size)))) {
484 			printf("Partition overlap\n");
485 			return -1;
486 		}
487 
488 		gpt_e[i].starting_lba = cpu_to_le64(start);
489 
490 		if (offset > (last_usable_lba + 1)) {
491 			printf("Partitions layout exceds disk size\n");
492 			return -1;
493 		}
494 		/* partition ending lba */
495 		if ((i == parts - 1) && (size == 0))
496 			/* extend the last partition to maximuim */
497 			gpt_e[i].ending_lba = gpt_h->last_usable_lba;
498 		else
499 			gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
500 
501 #ifdef CONFIG_PARTITION_TYPE_GUID
502 		str_type_guid = partitions[i].type_guid;
503 		bin_type_guid = gpt_e[i].partition_type_guid.b;
504 		if (strlen(str_type_guid)) {
505 			if (uuid_str_to_bin(str_type_guid, bin_type_guid,
506 					    UUID_STR_FORMAT_GUID)) {
507 				printf("Partition no. %d: invalid type guid: %s\n",
508 				       i, str_type_guid);
509 				return -1;
510 			}
511 		} else {
512 			/* default partition type GUID */
513 			memcpy(bin_type_guid,
514 			       &PARTITION_BASIC_DATA_GUID, 16);
515 		}
516 #else
517 		/* partition type GUID */
518 		memcpy(gpt_e[i].partition_type_guid.b,
519 			&PARTITION_BASIC_DATA_GUID, 16);
520 #endif
521 
522 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
523 		str_uuid = partitions[i].uuid;
524 		bin_uuid = gpt_e[i].unique_partition_guid.b;
525 
526 		if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_GUID)) {
527 			printf("Partition no. %d: invalid guid: %s\n",
528 				i, str_uuid);
529 			return -1;
530 		}
531 #endif
532 
533 		/* partition attributes */
534 		memset(&gpt_e[i].attributes, 0,
535 		       sizeof(gpt_entry_attributes));
536 
537 		if (partitions[i].bootable)
538 			gpt_e[i].attributes.fields.legacy_bios_bootable = 1;
539 
540 		/* partition name */
541 		efiname_len = sizeof(gpt_e[i].partition_name)
542 			/ sizeof(efi_char16_t);
543 		dosname_len = sizeof(partitions[i].name);
544 
545 		memset(gpt_e[i].partition_name, 0,
546 		       sizeof(gpt_e[i].partition_name));
547 
548 		for (k = 0; k < min(dosname_len, efiname_len); k++)
549 			gpt_e[i].partition_name[k] =
550 				(efi_char16_t)(partitions[i].name[k]);
551 
552 		debug("%s: name: %s offset[%d]: 0x" LBAF
553 		      " size[%d]: 0x" LBAF "\n",
554 		      __func__, partitions[i].name, i,
555 		      offset, i, size);
556 	}
557 
558 	return 0;
559 }
560 
561 static uint32_t partition_entries_offset(struct blk_desc *dev_desc)
562 {
563 	uint32_t offset_blks = 2;
564 	uint32_t __maybe_unused offset_bytes;
565 	int __maybe_unused config_offset;
566 
567 #if defined(CONFIG_EFI_PARTITION_ENTRIES_OFF)
568 	/*
569 	 * Some architectures require their SPL loader at a fixed
570 	 * address within the first 16KB of the disk.  To avoid an
571 	 * overlap with the partition entries of the EFI partition
572 	 * table, the first safe offset (in bytes, from the start of
573 	 * the disk) for the entries can be set in
574 	 * CONFIG_EFI_PARTITION_ENTRIES_OFF.
575 	 */
576 	offset_bytes =
577 		PAD_TO_BLOCKSIZE(CONFIG_EFI_PARTITION_ENTRIES_OFF, dev_desc);
578 	offset_blks = offset_bytes / dev_desc->blksz;
579 #endif
580 
581 #if defined(CONFIG_OF_CONTROL)
582 	/*
583 	 * Allow the offset of the first partition entires (in bytes
584 	 * from the start of the device) to be specified as a property
585 	 * of the device tree '/config' node.
586 	 */
587 	config_offset = fdtdec_get_config_int(gd->fdt_blob,
588 					      "u-boot,efi-partition-entries-offset",
589 					      -EINVAL);
590 	if (config_offset != -EINVAL) {
591 		offset_bytes = PAD_TO_BLOCKSIZE(config_offset, dev_desc);
592 		offset_blks = offset_bytes / dev_desc->blksz;
593 	}
594 #endif
595 
596 	debug("efi: partition entries offset (in blocks): %d\n", offset_blks);
597 
598 	/*
599 	 * The earliest LBA this can be at is LBA#2 (i.e. right behind
600 	 * the (protective) MBR and the GPT header.
601 	 */
602 	if (offset_blks < 2)
603 		offset_blks = 2;
604 
605 	return offset_blks;
606 }
607 
608 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
609 		char *str_guid, int parts_count)
610 {
611 	gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE);
612 	gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
613 	gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
614 	gpt_h->my_lba = cpu_to_le64(1);
615 	gpt_h->alternate_lba = cpu_to_le64(dev_desc->lba - 1);
616 	gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
617 	gpt_h->partition_entry_lba =
618 		cpu_to_le64(partition_entries_offset(dev_desc));
619 	gpt_h->first_usable_lba =
620 		cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 32);
621 	gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
622 	gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
623 	gpt_h->header_crc32 = 0;
624 	gpt_h->partition_entry_array_crc32 = 0;
625 
626 	if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
627 		return -1;
628 
629 	return 0;
630 }
631 
632 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
633 		disk_partition_t *partitions, int parts_count)
634 {
635 	gpt_header *gpt_h;
636 	gpt_entry *gpt_e;
637 	int ret, size;
638 
639 	size = PAD_TO_BLOCKSIZE(sizeof(gpt_header), dev_desc);
640 	gpt_h = malloc_cache_aligned(size);
641 	if (gpt_h == NULL) {
642 		printf("%s: calloc failed!\n", __func__);
643 		return -1;
644 	}
645 	memset(gpt_h, 0, size);
646 
647 	size = PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS * sizeof(gpt_entry),
648 				dev_desc);
649 	gpt_e = malloc_cache_aligned(size);
650 	if (gpt_e == NULL) {
651 		printf("%s: calloc failed!\n", __func__);
652 		free(gpt_h);
653 		return -1;
654 	}
655 	memset(gpt_e, 0, size);
656 
657 	/* Generate Primary GPT header (LBA1) */
658 	ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
659 	if (ret)
660 		goto err;
661 
662 	/* Generate partition entries */
663 	ret = gpt_fill_pte(dev_desc, gpt_h, gpt_e, partitions, parts_count);
664 	if (ret)
665 		goto err;
666 
667 	/* Write GPT partition table */
668 	ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
669 
670 err:
671 	free(gpt_e);
672 	free(gpt_h);
673 	return ret;
674 }
675 
676 static void gpt_convert_efi_name_to_char(char *s, efi_char16_t *es, int n)
677 {
678 	char *ess = (char *)es;
679 	int i, j;
680 
681 	memset(s, '\0', n);
682 
683 	for (i = 0, j = 0; j < n; i += 2, j++) {
684 		s[j] = ess[i];
685 		if (!ess[i])
686 			return;
687 	}
688 }
689 
690 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
691 		       gpt_entry **gpt_pte)
692 {
693 	/*
694 	 * This function validates AND
695 	 * fills in the GPT header and PTE
696 	 */
697 	if (is_gpt_valid(dev_desc,
698 			 GPT_PRIMARY_PARTITION_TABLE_LBA,
699 			 gpt_head, gpt_pte) != 1) {
700 		printf("%s: *** ERROR: Invalid GPT ***\n",
701 		       __func__);
702 		return -1;
703 	}
704 	if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
705 			 gpt_head, gpt_pte) != 1) {
706 		printf("%s: *** ERROR: Invalid Backup GPT ***\n",
707 		       __func__);
708 		return -1;
709 	}
710 
711 	return 0;
712 }
713 
714 int gpt_verify_partitions(struct blk_desc *dev_desc,
715 			  disk_partition_t *partitions, int parts,
716 			  gpt_header *gpt_head, gpt_entry **gpt_pte)
717 {
718 	char efi_str[PARTNAME_SZ + 1];
719 	u64 gpt_part_size;
720 	gpt_entry *gpt_e;
721 	int ret, i;
722 
723 	ret = gpt_verify_headers(dev_desc, gpt_head, gpt_pte);
724 	if (ret)
725 		return ret;
726 
727 	gpt_e = *gpt_pte;
728 
729 	for (i = 0; i < parts; i++) {
730 		if (i == gpt_head->num_partition_entries) {
731 			pr_err("More partitions than allowed!\n");
732 			return -1;
733 		}
734 
735 		/* Check if GPT and ENV partition names match */
736 		gpt_convert_efi_name_to_char(efi_str, gpt_e[i].partition_name,
737 					     PARTNAME_SZ + 1);
738 
739 		debug("%s: part: %2d name - GPT: %16s, ENV: %16s ",
740 		      __func__, i, efi_str, partitions[i].name);
741 
742 		if (strncmp(efi_str, (char *)partitions[i].name,
743 			    sizeof(partitions->name))) {
744 			pr_err("Partition name: %s does not match %s!\n",
745 			      efi_str, (char *)partitions[i].name);
746 			return -1;
747 		}
748 
749 		/* Check if GPT and ENV sizes match */
750 		gpt_part_size = le64_to_cpu(gpt_e[i].ending_lba) -
751 			le64_to_cpu(gpt_e[i].starting_lba) + 1;
752 		debug("size(LBA) - GPT: %8llu, ENV: %8llu ",
753 		      (unsigned long long)gpt_part_size,
754 		      (unsigned long long)partitions[i].size);
755 
756 		if (le64_to_cpu(gpt_part_size) != partitions[i].size) {
757 			/* We do not check the extend partition size */
758 			if ((i == parts - 1) && (partitions[i].size == 0))
759 				continue;
760 
761 			pr_err("Partition %s size: %llu does not match %llu!\n",
762 			      efi_str, (unsigned long long)gpt_part_size,
763 			      (unsigned long long)partitions[i].size);
764 			return -1;
765 		}
766 
767 		/*
768 		 * Start address is optional - check only if provided
769 		 * in '$partition' variable
770 		 */
771 		if (!partitions[i].start) {
772 			debug("\n");
773 			continue;
774 		}
775 
776 		/* Check if GPT and ENV start LBAs match */
777 		debug("start LBA - GPT: %8llu, ENV: %8llu\n",
778 		      le64_to_cpu(gpt_e[i].starting_lba),
779 		      (unsigned long long)partitions[i].start);
780 
781 		if (le64_to_cpu(gpt_e[i].starting_lba) != partitions[i].start) {
782 			pr_err("Partition %s start: %llu does not match %llu!\n",
783 			      efi_str, le64_to_cpu(gpt_e[i].starting_lba),
784 			      (unsigned long long)partitions[i].start);
785 			return -1;
786 		}
787 	}
788 
789 	return 0;
790 }
791 
792 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf)
793 {
794 	gpt_header *gpt_h;
795 	gpt_entry *gpt_e;
796 
797 	/* determine start of GPT Header in the buffer */
798 	gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
799 		       dev_desc->blksz);
800 
801 	if ((le64_to_cpu(gpt_h->alternate_lba) + 1)
802 			!= cpu_to_le64(dev_desc->lba)) {
803 		printf("%s: failed checking '%s'\n", __func__,
804 		       "invalid GPT Disk Size");
805 		return -1;
806 	}
807 
808 	if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
809 				dev_desc->lba))
810 		return -1;
811 
812 	/* determine start of GPT Entries in the buffer */
813 	gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
814 		       dev_desc->blksz);
815 	if (validate_gpt_entries(gpt_h, gpt_e))
816 		return -1;
817 
818 	return 0;
819 }
820 
821 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf)
822 {
823 	gpt_header *gpt_h;
824 	gpt_entry *gpt_e;
825 	int gpt_e_blk_cnt;
826 	lbaint_t lba;
827 	int cnt;
828 
829 	if (is_valid_gpt_buf(dev_desc, buf))
830 		return -1;
831 
832 	/* determine start of GPT Header in the buffer */
833 	gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
834 		       dev_desc->blksz);
835 
836 	/* determine start of GPT Entries in the buffer */
837 	gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
838 		       dev_desc->blksz);
839 	gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
840 				   le32_to_cpu(gpt_h->sizeof_partition_entry)),
841 				  dev_desc);
842 
843 	/* write MBR */
844 	lba = 0;	/* MBR is always at 0 */
845 	cnt = 1;	/* MBR (1 block) */
846 	if (blk_dwrite(dev_desc, lba, cnt, buf) != cnt) {
847 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
848 		       __func__, "MBR", cnt, lba);
849 		return 1;
850 	}
851 
852 	/* write Primary GPT */
853 	lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
854 	cnt = 1;	/* GPT Header (1 block) */
855 	if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
856 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
857 		       __func__, "Primary GPT Header", cnt, lba);
858 		return 1;
859 	}
860 
861 	lba = le64_to_cpu(gpt_h->partition_entry_lba);
862 	cnt = gpt_e_blk_cnt;
863 	if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
864 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
865 		       __func__, "Primary GPT Entries", cnt, lba);
866 		return 1;
867 	}
868 
869 	prepare_backup_gpt_header(gpt_h);
870 
871 	/* write Backup GPT */
872 	lba = le64_to_cpu(gpt_h->partition_entry_lba);
873 	cnt = gpt_e_blk_cnt;
874 	if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
875 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
876 		       __func__, "Backup GPT Entries", cnt, lba);
877 		return 1;
878 	}
879 
880 	lba = le64_to_cpu(gpt_h->my_lba);
881 	cnt = 1;	/* GPT Header (1 block) */
882 	if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
883 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
884 		       __func__, "Backup GPT Header", cnt, lba);
885 		return 1;
886 	}
887 
888 	return 0;
889 }
890 #endif
891 
892 /*
893  * Private functions
894  */
895 /*
896  * pmbr_part_valid(): Check for EFI partition signature
897  *
898  * Returns: 1 if EFI GPT partition type is found.
899  */
900 static int pmbr_part_valid(struct partition *part)
901 {
902 	if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
903 		get_unaligned_le32(&part->start_sect) == 1UL) {
904 		return 1;
905 	}
906 
907 	return 0;
908 }
909 
910 /*
911  * is_pmbr_valid(): test Protective MBR for validity
912  *
913  * Returns: 1 if PMBR is valid, 0 otherwise.
914  * Validity depends on two things:
915  *  1) MSDOS signature is in the last two bytes of the MBR
916  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
917  */
918 static int is_pmbr_valid(legacy_mbr * mbr)
919 {
920 	int i = 0;
921 
922 	if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
923 		return 0;
924 
925 	for (i = 0; i < 4; i++) {
926 		if (pmbr_part_valid(&mbr->partition_record[i])) {
927 			return 1;
928 		}
929 	}
930 	return 0;
931 }
932 
933 /**
934  * is_gpt_valid() - tests one GPT header and PTEs for validity
935  *
936  * lba is the logical block address of the GPT header to test
937  * gpt is a GPT header ptr, filled on return.
938  * ptes is a PTEs ptr, filled on return.
939  *
940  * Description: returns 1 if valid,  0 on error.
941  * If valid, returns pointers to PTEs.
942  */
943 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
944 			gpt_header *pgpt_head, gpt_entry **pgpt_pte)
945 {
946 	/* Confirm valid arguments prior to allocation. */
947 	if (!dev_desc || !pgpt_head) {
948 		printf("%s: Invalid Argument(s)\n", __func__);
949 		return 0;
950 	}
951 
952 	/* Re-use pte if it's not NULL */
953 	if (*pgpt_pte)
954 		return 1;
955 
956 	ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, mbr, dev_desc->blksz);
957 
958 	/* Read MBR Header from device */
959 	if (blk_dread(dev_desc, 0, 1, (ulong *)mbr) != 1) {
960 		printf("*** ERROR: Can't read MBR header ***\n");
961 		return 0;
962 	}
963 
964 	/* Read GPT Header from device */
965 	if (blk_dread(dev_desc, (lbaint_t)lba, 1, pgpt_head) != 1) {
966 		printf("*** ERROR: Can't read GPT header ***\n");
967 		return 0;
968 	}
969 
970 	if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->lba))
971 		return 0;
972 
973 	if (dev_desc->sig_type == SIG_TYPE_NONE) {
974 		efi_guid_t empty = {};
975 		if (memcmp(&pgpt_head->disk_guid, &empty, sizeof(empty))) {
976 			dev_desc->sig_type = SIG_TYPE_GUID;
977 			memcpy(&dev_desc->guid_sig, &pgpt_head->disk_guid,
978 			      sizeof(empty));
979 		} else if (mbr->unique_mbr_signature != 0) {
980 			dev_desc->sig_type = SIG_TYPE_MBR;
981 			dev_desc->mbr_sig = mbr->unique_mbr_signature;
982 		}
983 	}
984 
985 	/* Read and allocate Partition Table Entries */
986 	*pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
987 	if (*pgpt_pte == NULL) {
988 		printf("GPT: Failed to allocate memory for PTE\n");
989 		return 0;
990 	}
991 
992 	if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
993 		free(*pgpt_pte);
994 		*pgpt_pte = NULL;
995 		return 0;
996 	}
997 
998 	/* We're done, all's well */
999 	return 1;
1000 }
1001 
1002 /**
1003  * alloc_read_gpt_entries(): reads partition entries from disk
1004  * @dev_desc
1005  * @gpt - GPT header
1006  *
1007  * Description: Returns ptes on success,  NULL on error.
1008  * Allocates space for PTEs based on information found in @gpt.
1009  * Notes: remember to free pte when you're done!
1010  */
1011 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
1012 					 gpt_header *pgpt_head)
1013 {
1014 	size_t count = 0, blk_cnt;
1015 	lbaint_t blk;
1016 	gpt_entry *pte = NULL;
1017 
1018 	if (!dev_desc || !pgpt_head) {
1019 		printf("%s: Invalid Argument(s)\n", __func__);
1020 		return NULL;
1021 	}
1022 
1023 	count = le32_to_cpu(pgpt_head->num_partition_entries) *
1024 		le32_to_cpu(pgpt_head->sizeof_partition_entry);
1025 
1026 	debug("%s: count = %u * %u = %lu\n", __func__,
1027 	      (u32) le32_to_cpu(pgpt_head->num_partition_entries),
1028 	      (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry),
1029 	      (ulong)count);
1030 
1031 	/* Allocate memory for PTE, remember to FREE */
1032 	if (count != 0) {
1033 		pte = memalign(ARCH_DMA_MINALIGN,
1034 			       PAD_TO_BLOCKSIZE(count, dev_desc));
1035 	}
1036 
1037 	if (count == 0 || pte == NULL) {
1038 		printf("%s: ERROR: Can't allocate %#lX bytes for GPT Entries\n",
1039 		       __func__, (ulong)count);
1040 		return NULL;
1041 	}
1042 
1043 	/* Read GPT Entries from device */
1044 	blk = le64_to_cpu(pgpt_head->partition_entry_lba);
1045 	blk_cnt = BLOCK_CNT(count, dev_desc);
1046 	if (blk_dread(dev_desc, blk, (lbaint_t)blk_cnt, pte) != blk_cnt) {
1047 		printf("*** ERROR: Can't read GPT Entries ***\n");
1048 		free(pte);
1049 		return NULL;
1050 	}
1051 	return pte;
1052 }
1053 
1054 /**
1055  * is_pte_valid(): validates a single Partition Table Entry
1056  * @gpt_entry - Pointer to a single Partition Table Entry
1057  *
1058  * Description: returns 1 if valid,  0 on error.
1059  */
1060 static int is_pte_valid(gpt_entry * pte)
1061 {
1062 	efi_guid_t unused_guid;
1063 
1064 	if (!pte) {
1065 		printf("%s: Invalid Argument(s)\n", __func__);
1066 		return 0;
1067 	}
1068 
1069 	/* Only one validation for now:
1070 	 * The GUID Partition Type != Unused Entry (ALL-ZERO)
1071 	 */
1072 	memset(unused_guid.b, 0, sizeof(unused_guid.b));
1073 
1074 	if (memcmp(pte->partition_type_guid.b, unused_guid.b,
1075 		sizeof(unused_guid.b)) == 0) {
1076 
1077 		debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
1078 		      (unsigned int)(uintptr_t)pte);
1079 
1080 		return 0;
1081 	} else {
1082 		return 1;
1083 	}
1084 }
1085 
1086 /*
1087  * Add an 'a_' prefix so it comes before 'dos' in the linker list. We need to
1088  * check EFI first, since a DOS partition is often used as a 'protective MBR'
1089  * with EFI.
1090  */
1091 U_BOOT_PART_TYPE(a_efi) = {
1092 	.name		= "EFI",
1093 	.part_type	= PART_TYPE_EFI,
1094 	.max_entries	= GPT_ENTRY_NUMBERS,
1095 	.get_info	= part_get_info_ptr(part_get_info_efi),
1096 	.print		= part_print_ptr(part_print_efi),
1097 	.test		= part_test_efi,
1098 };
1099 #endif
1100