xref: /rk3399_rockchip-uboot/disk/part_efi.c (revision 6a8f377ca2e7df7257118262bdf7e8e1412915ef)
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 #define FACTORY_UNKNOWN_LBA (0xffffffff - 34)
76 static int validate_gpt_header(gpt_header *gpt_h, lbaint_t lba,
77 		lbaint_t lastlba)
78 {
79 	uint32_t crc32_backup = 0;
80 	uint32_t calc_crc32;
81 
82 	/* Check the GPT header signature */
83 	if (le64_to_cpu(gpt_h->signature) != GPT_HEADER_SIGNATURE) {
84 		if (le64_to_cpu(gpt_h->signature) != 0)
85 			printf("%s signature is wrong: 0x%llX != 0x%llX\n",
86 			       "GUID Partition Table Header",
87 			       le64_to_cpu(gpt_h->signature),
88 			       GPT_HEADER_SIGNATURE);
89 		return -1;
90 	}
91 
92 	/* Check the GUID Partition Table CRC */
93 	memcpy(&crc32_backup, &gpt_h->header_crc32, sizeof(crc32_backup));
94 	memset(&gpt_h->header_crc32, 0, sizeof(gpt_h->header_crc32));
95 
96 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
97 		le32_to_cpu(gpt_h->header_size));
98 
99 	memcpy(&gpt_h->header_crc32, &crc32_backup, sizeof(crc32_backup));
100 
101 	if (calc_crc32 != le32_to_cpu(crc32_backup)) {
102 		printf("%s CRC is wrong: 0x%x != 0x%x\n",
103 		       "GUID Partition Table Header",
104 		       le32_to_cpu(crc32_backup), calc_crc32);
105 		return -1;
106 	}
107 
108 	/*
109 	 * Check that the my_lba entry points to the LBA that contains the GPT
110 	 */
111 	if (le64_to_cpu(gpt_h->my_lba) != lba) {
112 		printf("GPT: my_lba incorrect: %llX != " LBAF "\n",
113 		       le64_to_cpu(gpt_h->my_lba),
114 		       lba);
115 		return -1;
116 	}
117 
118 	/*
119 	 * Check that the first_usable_lba and that the last_usable_lba are
120 	 * within the disk.
121 	 */
122 	if (le64_to_cpu(gpt_h->first_usable_lba) > lastlba) {
123 		printf("GPT: first_usable_lba incorrect: %llX > " LBAF "\n",
124 		       le64_to_cpu(gpt_h->first_usable_lba), lastlba);
125 		return -1;
126 	}
127 	if (le64_to_cpu(gpt_h->last_usable_lba) > lastlba) {
128 		if (le64_to_cpu(gpt_h->last_usable_lba) == FACTORY_UNKNOWN_LBA) {
129 #ifdef CONFIG_SPL_BUILD
130 			printf("GPT: SPL workaround factory last_usable_lba\n");
131 			gpt_h->last_usable_lba = lastlba - 34;
132 			return 0;
133 #else
134 			printf("GPT: last_usable_lba need repair\n");
135 			return 0;
136 #endif
137 		}
138 		printf("GPT: last_usable_lba incorrect: %llX > " LBAF "\n",
139 		       le64_to_cpu(gpt_h->last_usable_lba), lastlba);
140 		return -1;
141 	}
142 
143 	debug("GPT: first_usable_lba: %llX last_usable_lba: %llX last lba: "
144 	      LBAF "\n", le64_to_cpu(gpt_h->first_usable_lba),
145 	      le64_to_cpu(gpt_h->last_usable_lba), lastlba);
146 
147 	return 0;
148 }
149 
150 static int validate_gpt_entries(gpt_header *gpt_h, gpt_entry *gpt_e)
151 {
152 	uint32_t calc_crc32;
153 
154 	/* Check the GUID Partition Table Entry Array CRC */
155 	calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
156 		le32_to_cpu(gpt_h->num_partition_entries) *
157 		le32_to_cpu(gpt_h->sizeof_partition_entry));
158 
159 	if (calc_crc32 != le32_to_cpu(gpt_h->partition_entry_array_crc32)) {
160 		printf("%s: 0x%x != 0x%x\n",
161 		       "GUID Partition Table Entry Array CRC is wrong",
162 		       le32_to_cpu(gpt_h->partition_entry_array_crc32),
163 		       calc_crc32);
164 		return -1;
165 	}
166 
167 	return 0;
168 }
169 
170 static void prepare_backup_gpt_header(gpt_header *gpt_h)
171 {
172 	uint32_t calc_crc32;
173 	uint64_t val;
174 
175 	/* recalculate the values for the Backup GPT Header */
176 	val = le64_to_cpu(gpt_h->my_lba);
177 	gpt_h->my_lba = gpt_h->alternate_lba;
178 	gpt_h->alternate_lba = cpu_to_le64(val);
179 	gpt_h->partition_entry_lba =
180 			cpu_to_le64(le64_to_cpu(gpt_h->last_usable_lba) + 1);
181 	gpt_h->header_crc32 = 0;
182 
183 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
184 			       le32_to_cpu(gpt_h->header_size));
185 	gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
186 }
187 
188 #if CONFIG_IS_ENABLED(EFI_PARTITION)
189 /*
190  * Public Functions (include/part.h)
191  */
192 
193 /*
194  * UUID is displayed as 32 hexadecimal digits, in 5 groups,
195  * separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters
196  */
197 int get_disk_guid(struct blk_desc * dev_desc, char *guid)
198 {
199 	ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->rawblksz);
200 	gpt_entry *gpt_pte = NULL;
201 	unsigned char *guid_bin;
202 
203 	/* This function validates AND fills in the GPT header and PTE */
204 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
205 			 gpt_head, &gpt_pte) != 1) {
206 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
207 		if (is_gpt_valid(dev_desc, dev_desc->rawlba - 1,
208 				 gpt_head, &gpt_pte) != 1) {
209 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
210 			       __func__);
211 			return -EINVAL;
212 		} else {
213 			printf("%s: ***        Using Backup GPT ***\n",
214 			       __func__);
215 		}
216 	}
217 
218 	guid_bin = gpt_head->disk_guid.b;
219 	uuid_bin_to_str(guid_bin, guid, UUID_STR_FORMAT_GUID);
220 
221 	return 0;
222 }
223 
224 void part_print_efi(struct blk_desc *dev_desc)
225 {
226 	ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->rawblksz);
227 	gpt_entry *gpt_pte = NULL;
228 	int i = 0;
229 	char uuid[UUID_STR_LEN + 1];
230 	unsigned char *uuid_bin;
231 	int sector;
232 
233 	/* This function validates AND fills in the GPT header and PTE */
234 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
235 			 gpt_head, &gpt_pte) != 1) {
236 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
237 		if (is_gpt_valid(dev_desc, (dev_desc->rawlba - 1),
238 				 gpt_head, &gpt_pte) != 1) {
239 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
240 			       __func__);
241 			return;
242 		} else {
243 			printf("%s: ***        Using Backup GPT ***\n",
244 			       __func__);
245 		}
246 	}
247 
248 	debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
249 
250 	printf("Part\tStart LBA\tEnd LBA\t\tName\n");
251 	printf("\tAttributes\n");
252 	printf("\tType GUID\n");
253 	printf("\tPartition GUID\n");
254 
255 	sector = dev_desc->rawblksz / dev_desc->blksz;
256 	for (i = 0; i < le32_to_cpu(gpt_head->num_partition_entries); i++) {
257 		/* Stop at the first non valid PTE */
258 		if (!is_pte_valid(&gpt_pte[i]))
259 			break;
260 
261 		printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i + 1),
262 			le64_to_cpu(gpt_pte[i].starting_lba * sector),
263 			le64_to_cpu(gpt_pte[i].ending_lba * sector + sector - 1),
264 			print_efiname(&gpt_pte[i]));
265 		printf("\tattrs:\t0x%016llx\n", gpt_pte[i].attributes.raw);
266 		uuid_bin = (unsigned char *)gpt_pte[i].partition_type_guid.b;
267 		uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
268 		printf("\ttype:\t%s\n", uuid);
269 #ifdef CONFIG_PARTITION_TYPE_GUID
270 		if (!uuid_guid_get_str(uuid_bin, uuid))
271 			printf("\ttype:\t%s\n", uuid);
272 #endif
273 		uuid_bin = (unsigned char *)gpt_pte[i].unique_partition_guid.b;
274 		uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
275 		printf("\tguid:\t%s\n", uuid);
276 	}
277 
278 	/* Remember to free pte */
279 	free(gpt_pte);
280 	return;
281 }
282 
283 int part_get_info_efi(struct blk_desc *dev_desc, int part,
284 		      disk_partition_t *info)
285 {
286 	static gpt_entry *gpt_pte = NULL;
287 	static gpt_header *gpt_head = NULL;
288 	int sector, b_gpt_nsec = 0x22;
289 
290 	if (!dev_desc->rawblksz || !dev_desc->rawlba) {
291 		dev_desc->rawblksz = dev_desc->blksz;
292 		dev_desc->rawlba = dev_desc->lba;
293 	}
294 
295 	if (dev_desc->rawblksz == 4096)
296 		b_gpt_nsec = 6;
297 
298 	if (!gpt_head)
299 		gpt_head = memalign(ARCH_DMA_MINALIGN, dev_desc->rawblksz);
300 
301 	/*
302 	 * We suppose different dev have different size, eg. emmc vs sd
303 	 * free the pte first if exist and then will malloc and init a new one.
304 	 */
305 	if (gpt_head && (gpt_head->last_usable_lba + b_gpt_nsec) != dev_desc->rawlba) {
306 		if (dev_desc->rawblksz == 4096) {
307 			/* realloc gpt header buffer */
308 			free(gpt_head);
309 			gpt_head = memalign(ARCH_DMA_MINALIGN, dev_desc->rawblksz);
310 		}
311 		if (gpt_pte)
312 			free(gpt_pte);
313 		gpt_pte = NULL;
314 	}
315 
316 	/* "part" argument must be at least 1 */
317 	if (part < 1) {
318 		printf("%s: Invalid Argument(s)\n", __func__);
319 		return -1;
320 	}
321 
322 	/* This function validates AND fills in the GPT header and PTE */
323 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
324 			gpt_head, &gpt_pte) != 1) {
325 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
326 		if (is_gpt_valid(dev_desc, (dev_desc->rawlba - 1),
327 				 gpt_head, &gpt_pte) != 1) {
328 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
329 			       __func__);
330 			return -1;
331 		} else {
332 			printf("%s: ***        Using Backup GPT ***\n",
333 			       __func__);
334 		}
335 	}
336 
337 	if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
338 	    !is_pte_valid(&gpt_pte[part - 1])) {
339 		debug("%s: *** ERROR: Invalid partition number %d ***\n",
340 			__func__, part);
341 		return -1;
342 	}
343 
344 	sector = dev_desc->rawblksz / dev_desc->blksz;
345 	/* The 'lbaint_t' casting may limit the maximum disk size to 2 TB */
346 	info->start = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].starting_lba);
347 	/* The ending LBA is inclusive, to calculate size, add 1 to it */
348 	info->size = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1
349 		     - info->start;
350 	info->start *= sector;
351 	info->size *= sector;
352 
353 	info->blksz = dev_desc->blksz;
354 
355 	sprintf((char *)info->name, "%s",
356 			print_efiname(&gpt_pte[part - 1]));
357 	strcpy((char *)info->type, "U-Boot");
358 	info->bootable = is_bootable(&gpt_pte[part - 1]);
359 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
360 	uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b, info->uuid,
361 			UUID_STR_FORMAT_GUID);
362 #endif
363 #ifdef CONFIG_PARTITION_TYPE_GUID
364 	uuid_bin_to_str(gpt_pte[part - 1].partition_type_guid.b,
365 			info->type_guid, UUID_STR_FORMAT_GUID);
366 #endif
367 
368 	debug("%s: start 0x" LBAF ", size 0x" LBAF ", name %s\n", __func__,
369 	      info->start, info->size, info->name);
370 
371 	return 0;
372 }
373 
374 #ifdef CONFIG_RKIMG_BOOTLOADER
375 #if defined(CONFIG_SPL_KERNEL_BOOT) || !defined(CONFIG_SPL_BUILD)
376 static void gpt_entry_modify(struct blk_desc *dev_desc,
377 			     gpt_entry *gpt_pte,
378 			     gpt_header *gpt_head)
379 {
380 	int i;
381 	uint32_t calc_crc32;
382 
383 	for (i = 0; i < gpt_head->num_partition_entries; i++) {
384 		if (!is_pte_valid(&gpt_pte[i]))
385 			break;
386 	}
387 	if (dev_desc->rawblksz == 4096) {
388 		if (gpt_pte[i - 1].ending_lba <= (dev_desc->rawlba - 6))
389 			return;
390 		gpt_pte[i - 1].ending_lba = dev_desc->rawlba - 6;
391 	} else {
392 		if (gpt_pte[i - 1].ending_lba <= (dev_desc->rawlba - 0x22))
393 			return;
394 		/* The last partition size need align to 4KB, here align to 32KB. */
395 		gpt_pte[i - 1].ending_lba = dev_desc->rawlba - 0x41;
396 	}
397 	calc_crc32 = efi_crc32((const unsigned char *)gpt_pte,
398 			       le32_to_cpu(gpt_head->num_partition_entries) *
399 			       le32_to_cpu(gpt_head->sizeof_partition_entry));
400 	gpt_head->partition_entry_array_crc32 = calc_crc32;
401 }
402 
403 static int part_efi_repair(struct blk_desc *dev_desc, gpt_entry *gpt_pte,
404 			   gpt_header *gpt_head, int head_gpt_valid,
405 			   int backup_gpt_valid)
406 {
407 	uint32_t calc_crc32;
408 	size_t count = 0, blk_cnt;
409 	lbaint_t blk;
410 	int sector = dev_desc->rawblksz / dev_desc->blksz;
411 
412 	if (head_gpt_valid == 1 && backup_gpt_valid == 1) {
413 		return 0;
414 	} else if (head_gpt_valid == 0 && backup_gpt_valid == 0) {
415 		return -1;
416 	} else if (head_gpt_valid == 1 && backup_gpt_valid == 0) {
417 		gpt_head->header_crc32 = 0;
418 		gpt_head->my_lba = dev_desc->rawlba - 1;
419 		gpt_head->alternate_lba = 1;
420 		if (sector == 8) {
421 			gpt_head->partition_entry_lba = dev_desc->rawlba - 5;
422 			gpt_head->last_usable_lba = cpu_to_le64(dev_desc->rawlba - 6);
423 		} else {
424 			gpt_head->partition_entry_lba = dev_desc->rawlba - 0x21;
425 			gpt_head->last_usable_lba = cpu_to_le64(dev_desc->rawlba - 34);
426 		}
427 		gpt_entry_modify(dev_desc, gpt_pte, gpt_head);
428 		calc_crc32 = efi_crc32((const unsigned char *)gpt_head,
429 				       le32_to_cpu(gpt_head->header_size));
430 		gpt_head->header_crc32 = calc_crc32;
431 		blk = le64_to_cpu(dev_desc->rawlba - 1);
432 		if (blk_dwrite(dev_desc, blk * sector, sector, gpt_head) != sector) {
433 			printf("*** ERROR: Can't write GPT header ***\n");
434 			return -1;
435 		}
436 		count = le32_to_cpu(gpt_head->num_partition_entries) *
437 			le32_to_cpu(gpt_head->sizeof_partition_entry);
438 		blk = le64_to_cpu(gpt_head->partition_entry_lba);
439 		blk_cnt = BLOCK_CNT(count, dev_desc);
440 		if (blk_dwrite(dev_desc, blk * sector, (lbaint_t)blk_cnt, gpt_pte) !=
441 		    blk_cnt) {
442 			printf("*** ERROR: Can't write entry partitions ***\n");
443 			return -1;
444 		}
445 		printf("Repair the backup gpt table OK!\n");
446 	} else if (head_gpt_valid == 0 && backup_gpt_valid == 1) {
447 		gpt_head->header_crc32 = 0;
448 		gpt_head->my_lba = 1;
449 		gpt_head->alternate_lba = dev_desc->rawlba - 1;
450 		gpt_head->partition_entry_lba = 0x2;
451 		if (sector == 8) {
452 			gpt_head->last_usable_lba = cpu_to_le64(dev_desc->rawlba - 6);
453 		} else {
454 			gpt_head->last_usable_lba = cpu_to_le64(dev_desc->rawlba - 34);
455 		}
456 		gpt_entry_modify(dev_desc, gpt_pte, gpt_head);
457 		calc_crc32 = efi_crc32((const unsigned char *)gpt_head,
458 				       le32_to_cpu(gpt_head->header_size));
459 		gpt_head->header_crc32 = calc_crc32;
460 		if (blk_dwrite(dev_desc, 1 * sector, sector, gpt_head) != sector) {
461 			printf("*** ERROR: Can't write GPT header ***\n");
462 			return -1;
463 		}
464 		count = le32_to_cpu(gpt_head->num_partition_entries) *
465 			le32_to_cpu(gpt_head->sizeof_partition_entry);
466 		blk = le64_to_cpu(gpt_head->partition_entry_lba);
467 		blk_cnt = BLOCK_CNT(count, dev_desc);
468 		if (blk_dwrite(dev_desc, blk * sector, (lbaint_t)blk_cnt, gpt_pte) !=
469 		    blk_cnt) {
470 			printf("*** ERROR: Can't write entry partitions ***\n");
471 			return -1;
472 		}
473 		printf("Repair the Primary gpt table OK!\n");
474 	}
475 
476 	return 0;
477 }
478 #endif
479 #endif
480 
481 static int part_test_efi(struct blk_desc *dev_desc)
482 {
483 	int ret = 0;
484 
485 	if (!dev_desc->rawblksz || !dev_desc->rawlba) {
486 		dev_desc->rawblksz = dev_desc->blksz;
487 		dev_desc->rawlba = dev_desc->lba;
488 	}
489 
490 	ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, dev_desc->rawblksz);
491 
492 	/* Read legacy MBR from block 0 and validate it */
493 	if ((blk_dread(dev_desc, 0, 1, (ulong *)legacymbr) != 1)
494 		|| (is_pmbr_valid(legacymbr) != 1)) {
495 		return -1;
496 	}
497 #ifdef CONFIG_RKIMG_BOOTLOADER
498 #if defined(CONFIG_SPL_KERNEL_BOOT) || !defined(CONFIG_SPL_BUILD)
499 	gpt_entry *h_gpt_pte = NULL;
500 	gpt_header *h_gpt_head = NULL;
501 	gpt_entry *b_gpt_pte = NULL;
502 	gpt_header *b_gpt_head = NULL;
503 	int head_gpt_valid = 0;
504 	int backup_gpt_valid = 0;
505 
506 	if (!h_gpt_head)
507 		h_gpt_head = memalign(ARCH_DMA_MINALIGN, dev_desc->rawblksz);
508 	if (!b_gpt_head)
509 		b_gpt_head = memalign(ARCH_DMA_MINALIGN, dev_desc->rawblksz);
510 
511 	head_gpt_valid = is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
512 				      h_gpt_head, &h_gpt_pte);
513 	backup_gpt_valid = is_gpt_valid(dev_desc, (dev_desc->rawlba - 1),
514 					b_gpt_head, &b_gpt_pte);
515 
516 	if ((head_gpt_valid == 1) &&
517 	    (le64_to_cpu(h_gpt_head->last_usable_lba)
518 	     == FACTORY_UNKNOWN_LBA)) {
519 		if (part_efi_repair(dev_desc, h_gpt_pte, h_gpt_head,
520 				    0, 1))
521 			printf("Primary GPT repair fail!\n");
522 		/* Force repair backup GPT for factory or ota upgrade. */
523 		backup_gpt_valid = 0;
524 	}
525 
526 	if (head_gpt_valid == 1 && backup_gpt_valid == 0) {
527 		if (part_efi_repair(dev_desc, h_gpt_pte, h_gpt_head,
528 				    head_gpt_valid, backup_gpt_valid))
529 			printf("Backup GPT repair fail!\n");
530 	} else if (head_gpt_valid == 0 && backup_gpt_valid == 1) {
531 		if (part_efi_repair(dev_desc, b_gpt_pte, b_gpt_head,
532 				    head_gpt_valid, backup_gpt_valid))
533 			printf("Primary GPT repair fail!\n");
534 	} else if (head_gpt_valid == 0 && backup_gpt_valid == 0) {
535 		ret = -1;
536 	}
537 
538 	free(h_gpt_pte);
539 	h_gpt_pte = NULL;
540 	free(h_gpt_head);
541 	h_gpt_head = NULL;
542 	free(b_gpt_pte);
543 	b_gpt_pte = NULL;
544 	free(b_gpt_head);
545 	b_gpt_head = NULL;
546 #endif
547 #endif
548 	return ret;
549 }
550 
551 /**
552  * set_protective_mbr(): Set the EFI protective MBR
553  * @param dev_desc - block device descriptor
554  *
555  * @return - zero on success, otherwise error
556  */
557 static int set_protective_mbr(struct blk_desc *dev_desc)
558 {
559 	/* Setup the Protective MBR */
560 	ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, p_mbr, 1, dev_desc->rawblksz);
561 	memset(p_mbr, 0, dev_desc->rawblksz);
562 
563 	if (p_mbr == NULL) {
564 		printf("%s: calloc failed!\n", __func__);
565 		return -1;
566 	}
567 
568 	/* Read MBR to backup boot code if it exists */
569 	if (blk_dread(dev_desc, 0, 1, p_mbr) != 1) {
570 		pr_err("** Can't read from device %d **\n", dev_desc->devnum);
571 		return -1;
572 	}
573 
574 	/* Append signature */
575 	p_mbr->signature = MSDOS_MBR_SIGNATURE;
576 	p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
577 	p_mbr->partition_record[0].start_sect = 1;
578 	p_mbr->partition_record[0].nr_sects = (u32) dev_desc->rawlba - 1;
579 
580 	/* Write MBR sector to the MMC device */
581 	if (blk_dwrite(dev_desc, 0, 1, p_mbr) != 1) {
582 		printf("** Can't write to device %d **\n",
583 			dev_desc->devnum);
584 		return -1;
585 	}
586 
587 	return 0;
588 }
589 
590 int write_gpt_table(struct blk_desc *dev_desc,
591 		gpt_header *gpt_h, gpt_entry *gpt_e)
592 {
593 	const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
594 					   * sizeof(gpt_entry)), dev_desc);
595 	u32 calc_crc32, sector;
596 
597 	sector = dev_desc->rawblksz / dev_desc->blksz;
598 
599 	debug("max lba: %x\n", (u32) dev_desc->rawlba);
600 	/* Setup the Protective MBR */
601 	if (set_protective_mbr(dev_desc) < 0)
602 		goto err;
603 
604 	/* Generate CRC for the Primary GPT Header */
605 	calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
606 			      le32_to_cpu(gpt_h->num_partition_entries) *
607 			      le32_to_cpu(gpt_h->sizeof_partition_entry));
608 	gpt_h->partition_entry_array_crc32 = cpu_to_le32(calc_crc32);
609 
610 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
611 			      le32_to_cpu(gpt_h->header_size));
612 	gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
613 
614 	/* Write the First GPT to the block right after the Legacy MBR */
615 	if (blk_dwrite(dev_desc, 1 * sector, sector, gpt_h) != sector)
616 		goto err;
617 
618 	if (blk_dwrite(dev_desc, le64_to_cpu(gpt_h->partition_entry_lba * sector),
619 		       pte_blk_cnt, gpt_e) != pte_blk_cnt)
620 		goto err;
621 
622 	prepare_backup_gpt_header(gpt_h);
623 
624 	if (blk_dwrite(dev_desc, (lbaint_t)(le64_to_cpu(gpt_h->last_usable_lba)
625 		       + 1) * sector, pte_blk_cnt, gpt_e) != pte_blk_cnt)
626 		goto err;
627 
628 	if (blk_dwrite(dev_desc, (lbaint_t)le64_to_cpu(gpt_h->my_lba) * sector, 1,
629 		       gpt_h) != 1)
630 		goto err;
631 
632 	debug("GPT successfully written to block device!\n");
633 	return 0;
634 
635  err:
636 	printf("** Can't write to device %d **\n", dev_desc->devnum);
637 	return -1;
638 }
639 
640 int gpt_fill_pte(struct blk_desc *dev_desc,
641 		 gpt_header *gpt_h, gpt_entry *gpt_e,
642 		 disk_partition_t *partitions, int parts)
643 {
644 	lbaint_t offset = (lbaint_t)le64_to_cpu(gpt_h->first_usable_lba);
645 	lbaint_t last_usable_lba = (lbaint_t)
646 			le64_to_cpu(gpt_h->last_usable_lba);
647 	int i, k;
648 	size_t efiname_len, dosname_len;
649 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
650 	char *str_uuid;
651 	unsigned char *bin_uuid;
652 #endif
653 #ifdef CONFIG_PARTITION_TYPE_GUID
654 	char *str_type_guid;
655 	unsigned char *bin_type_guid;
656 #endif
657 	size_t hdr_start = gpt_h->my_lba;
658 	size_t hdr_end = hdr_start + 1;
659 
660 	size_t pte_start = gpt_h->partition_entry_lba;
661 	size_t pte_end = pte_start +
662 		gpt_h->num_partition_entries * gpt_h->sizeof_partition_entry /
663 		dev_desc->rawblksz;
664 
665 	for (i = 0; i < parts; i++) {
666 		/* partition starting lba */
667 		lbaint_t start = partitions[i].start;
668 		lbaint_t size = partitions[i].size;
669 
670 		if (start) {
671 			offset = start + size;
672 		} else {
673 			start = offset;
674 			offset += size;
675 		}
676 
677 		/*
678 		 * If our partition overlaps with either the GPT
679 		 * header, or the partition entry, reject it.
680 		 */
681 		if (((start < hdr_end && hdr_start < (start + size)) ||
682 		     (start < pte_end && pte_start < (start + size)))) {
683 			printf("Partition overlap\n");
684 			return -1;
685 		}
686 
687 		gpt_e[i].starting_lba = cpu_to_le64(start);
688 
689 		if (offset > (last_usable_lba + 1)) {
690 			printf("Partitions layout exceds disk size\n");
691 			return -1;
692 		}
693 		/* partition ending lba */
694 		if ((i == parts - 1) && (size == 0))
695 			/* extend the last partition to maximuim */
696 			gpt_e[i].ending_lba = gpt_h->last_usable_lba;
697 		else
698 			gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
699 
700 #ifdef CONFIG_PARTITION_TYPE_GUID
701 		str_type_guid = partitions[i].type_guid;
702 		bin_type_guid = gpt_e[i].partition_type_guid.b;
703 		if (strlen(str_type_guid)) {
704 			if (uuid_str_to_bin(str_type_guid, bin_type_guid,
705 					    UUID_STR_FORMAT_GUID)) {
706 				printf("Partition no. %d: invalid type guid: %s\n",
707 				       i, str_type_guid);
708 				return -1;
709 			}
710 		} else {
711 			/* default partition type GUID */
712 			memcpy(bin_type_guid,
713 			       &PARTITION_BASIC_DATA_GUID, 16);
714 		}
715 #else
716 		/* partition type GUID */
717 		memcpy(gpt_e[i].partition_type_guid.b,
718 			&PARTITION_BASIC_DATA_GUID, 16);
719 #endif
720 
721 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
722 		str_uuid = partitions[i].uuid;
723 		bin_uuid = gpt_e[i].unique_partition_guid.b;
724 
725 		if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_GUID)) {
726 			printf("Partition no. %d: invalid guid: %s\n",
727 				i, str_uuid);
728 			return -1;
729 		}
730 #endif
731 
732 		/* partition attributes */
733 		memset(&gpt_e[i].attributes, 0,
734 		       sizeof(gpt_entry_attributes));
735 
736 		if (partitions[i].bootable)
737 			gpt_e[i].attributes.fields.legacy_bios_bootable = 1;
738 
739 		/* partition name */
740 		efiname_len = sizeof(gpt_e[i].partition_name)
741 			/ sizeof(efi_char16_t);
742 		dosname_len = sizeof(partitions[i].name);
743 
744 		memset(gpt_e[i].partition_name, 0,
745 		       sizeof(gpt_e[i].partition_name));
746 
747 		for (k = 0; k < min(dosname_len, efiname_len); k++)
748 			gpt_e[i].partition_name[k] =
749 				(efi_char16_t)(partitions[i].name[k]);
750 
751 		debug("%s: name: %s offset[%d]: 0x" LBAF
752 		      " size[%d]: 0x" LBAF "\n",
753 		      __func__, partitions[i].name, i,
754 		      offset, i, size);
755 	}
756 
757 	return 0;
758 }
759 
760 static uint32_t partition_entries_offset(struct blk_desc *dev_desc)
761 {
762 	uint32_t offset_blks = 2;
763 	uint32_t __maybe_unused offset_bytes;
764 	int __maybe_unused config_offset;
765 
766 #if defined(CONFIG_EFI_PARTITION_ENTRIES_OFF)
767 	/*
768 	 * Some architectures require their SPL loader at a fixed
769 	 * address within the first 16KB of the disk.  To avoid an
770 	 * overlap with the partition entries of the EFI partition
771 	 * table, the first safe offset (in bytes, from the start of
772 	 * the disk) for the entries can be set in
773 	 * CONFIG_EFI_PARTITION_ENTRIES_OFF.
774 	 */
775 	offset_bytes = PAD_SIZE(CONFIG_EFI_PARTITION_ENTRIES_OFF, dev_desc->rawblksz);
776 	offset_blks = offset_bytes / dev_desc->rawblksz;
777 #endif
778 
779 #if defined(CONFIG_OF_CONTROL)
780 	/*
781 	 * Allow the offset of the first partition entires (in bytes
782 	 * from the start of the device) to be specified as a property
783 	 * of the device tree '/config' node.
784 	 */
785 	config_offset = fdtdec_get_config_int(gd->fdt_blob,
786 					      "u-boot,efi-partition-entries-offset",
787 					      -EINVAL);
788 	if (config_offset != -EINVAL) {
789 		offset_bytes = PAD_SIZE(config_offset, dev_desc->rawblksz);
790 		offset_blks = offset_bytes / dev_desc->rawblksz;
791 	}
792 #endif
793 
794 	debug("efi: partition entries offset (in blocks): %d\n", offset_blks);
795 
796 	/*
797 	 * The earliest LBA this can be at is LBA#2 (i.e. right behind
798 	 * the (protective) MBR and the GPT header.
799 	 */
800 	if (offset_blks < 2)
801 		offset_blks = 2;
802 
803 	return offset_blks;
804 }
805 
806 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
807 		char *str_guid, int parts_count)
808 {
809 	gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE);
810 	gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
811 	gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
812 	gpt_h->my_lba = cpu_to_le64(1);
813 	gpt_h->alternate_lba = cpu_to_le64(dev_desc->rawlba - 1);
814 	gpt_h->partition_entry_lba =
815 		cpu_to_le64(partition_entries_offset(dev_desc));
816 	if (dev_desc->rawblksz == 4096) {
817 		gpt_h->last_usable_lba = cpu_to_le64(dev_desc->rawlba - 6);
818 		gpt_h->first_usable_lba =
819 			cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 4);
820 	} else {
821 		gpt_h->last_usable_lba = cpu_to_le64(dev_desc->rawlba - 34);
822 		gpt_h->first_usable_lba =
823 			cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 32);
824 	}
825 	gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
826 	gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
827 	gpt_h->header_crc32 = 0;
828 	gpt_h->partition_entry_array_crc32 = 0;
829 
830 	if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
831 		return -1;
832 
833 	return 0;
834 }
835 
836 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
837 		disk_partition_t *partitions, int parts_count)
838 {
839 	gpt_header *gpt_h;
840 	gpt_entry *gpt_e;
841 	int ret, size;
842 
843 	size = PAD_SIZE(sizeof(gpt_header), dev_desc->rawblksz);
844 	gpt_h = malloc_cache_aligned(size);
845 	if (gpt_h == NULL) {
846 		printf("%s: calloc failed!\n", __func__);
847 		return -1;
848 	}
849 	memset(gpt_h, 0, size);
850 
851 	size = PAD_SIZE(GPT_ENTRY_NUMBERS * sizeof(gpt_entry), dev_desc->rawblksz);
852 	gpt_e = malloc_cache_aligned(size);
853 	if (gpt_e == NULL) {
854 		printf("%s: calloc failed!\n", __func__);
855 		free(gpt_h);
856 		return -1;
857 	}
858 	memset(gpt_e, 0, size);
859 
860 	/* Generate Primary GPT header (LBA1) */
861 	ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
862 	if (ret)
863 		goto err;
864 
865 	/* Generate partition entries */
866 	ret = gpt_fill_pte(dev_desc, gpt_h, gpt_e, partitions, parts_count);
867 	if (ret)
868 		goto err;
869 
870 	/* Write GPT partition table */
871 	ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
872 
873 err:
874 	free(gpt_e);
875 	free(gpt_h);
876 	return ret;
877 }
878 
879 /**
880  * gpt_convert_efi_name_to_char() - convert u16 string to char string
881  *
882  * TODO: this conversion only supports ANSI characters
883  *
884  * @s:	target buffer
885  * @es:	u16 string to be converted
886  * @n:	size of target buffer
887  */
888 static void gpt_convert_efi_name_to_char(char *s, void *es, int n)
889 {
890 	char *ess = es;
891 	int i, j;
892 
893 	memset(s, '\0', n);
894 
895 	for (i = 0, j = 0; j < n; i += 2, j++) {
896 		s[j] = ess[i];
897 		if (!ess[i])
898 			return;
899 	}
900 }
901 
902 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
903 		       gpt_entry **gpt_pte)
904 {
905 	/*
906 	 * This function validates AND
907 	 * fills in the GPT header and PTE
908 	 */
909 	if (is_gpt_valid(dev_desc,
910 			 GPT_PRIMARY_PARTITION_TABLE_LBA,
911 			 gpt_head, gpt_pte) != 1) {
912 		printf("%s: *** ERROR: Invalid GPT ***\n",
913 		       __func__);
914 		return -1;
915 	}
916 	if (is_gpt_valid(dev_desc, (dev_desc->rawlba - 1),
917 			 gpt_head, gpt_pte) != 1) {
918 		printf("%s: *** ERROR: Invalid Backup GPT ***\n",
919 		       __func__);
920 		return -1;
921 	}
922 
923 	return 0;
924 }
925 
926 int gpt_verify_partitions(struct blk_desc *dev_desc,
927 			  disk_partition_t *partitions, int parts,
928 			  gpt_header *gpt_head, gpt_entry **gpt_pte)
929 {
930 	char efi_str[PARTNAME_SZ + 1];
931 	u64 gpt_part_size;
932 	gpt_entry *gpt_e;
933 	int ret, i;
934 
935 	ret = gpt_verify_headers(dev_desc, gpt_head, gpt_pte);
936 	if (ret)
937 		return ret;
938 
939 	gpt_e = *gpt_pte;
940 
941 	for (i = 0; i < parts; i++) {
942 		if (i == gpt_head->num_partition_entries) {
943 			pr_err("More partitions than allowed!\n");
944 			return -1;
945 		}
946 
947 		/* Check if GPT and ENV partition names match */
948 		gpt_convert_efi_name_to_char(efi_str, gpt_e[i].partition_name,
949 					     PARTNAME_SZ + 1);
950 
951 		debug("%s: part: %2d name - GPT: %16s, ENV: %16s ",
952 		      __func__, i, efi_str, partitions[i].name);
953 
954 		if (strncmp(efi_str, (char *)partitions[i].name,
955 			    sizeof(partitions->name))) {
956 			pr_err("Partition name: %s does not match %s!\n",
957 			      efi_str, (char *)partitions[i].name);
958 			return -1;
959 		}
960 
961 		/* Check if GPT and ENV sizes match */
962 		gpt_part_size = le64_to_cpu(gpt_e[i].ending_lba) -
963 			le64_to_cpu(gpt_e[i].starting_lba) + 1;
964 		debug("size(LBA) - GPT: %8llu, ENV: %8llu ",
965 		      (unsigned long long)gpt_part_size,
966 		      (unsigned long long)partitions[i].size);
967 
968 		if (le64_to_cpu(gpt_part_size) != partitions[i].size) {
969 			/* We do not check the extend partition size */
970 			if ((i == parts - 1) && (partitions[i].size == 0))
971 				continue;
972 
973 			pr_err("Partition %s size: %llu does not match %llu!\n",
974 			      efi_str, (unsigned long long)gpt_part_size,
975 			      (unsigned long long)partitions[i].size);
976 			return -1;
977 		}
978 
979 		/*
980 		 * Start address is optional - check only if provided
981 		 * in '$partition' variable
982 		 */
983 		if (!partitions[i].start) {
984 			debug("\n");
985 			continue;
986 		}
987 
988 		/* Check if GPT and ENV start LBAs match */
989 		debug("start LBA - GPT: %8llu, ENV: %8llu\n",
990 		      le64_to_cpu(gpt_e[i].starting_lba),
991 		      (unsigned long long)partitions[i].start);
992 
993 		if (le64_to_cpu(gpt_e[i].starting_lba) != partitions[i].start) {
994 			pr_err("Partition %s start: %llu does not match %llu!\n",
995 			      efi_str, le64_to_cpu(gpt_e[i].starting_lba),
996 			      (unsigned long long)partitions[i].start);
997 			return -1;
998 		}
999 	}
1000 
1001 	return 0;
1002 }
1003 
1004 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf)
1005 {
1006 	gpt_header *gpt_h;
1007 	gpt_entry *gpt_e;
1008 
1009 	/* determine start of GPT Header in the buffer */
1010 	gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
1011 		       dev_desc->rawblksz);
1012 
1013 	if ((le64_to_cpu(gpt_h->alternate_lba) + 1)
1014 			!= cpu_to_le64(dev_desc->rawlba) &&
1015 			le64_to_cpu(gpt_h->last_usable_lba) != FACTORY_UNKNOWN_LBA) {
1016 		printf("%s: failed checking '%s'\n", __func__,
1017 		       "invalid GPT Disk Size");
1018 		return -1;
1019 	}
1020 
1021 	if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
1022 				dev_desc->rawlba))
1023 		return -1;
1024 
1025 	/* determine start of GPT Entries in the buffer */
1026 	gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
1027 		       dev_desc->rawblksz);
1028 	if (validate_gpt_entries(gpt_h, gpt_e))
1029 		return -1;
1030 
1031 	return 0;
1032 }
1033 
1034 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf)
1035 {
1036 	gpt_header *gpt_h;
1037 	gpt_entry *gpt_e;
1038 	int gpt_e_blk_cnt;
1039 	lbaint_t lba;
1040 	int cnt;
1041 
1042 	if (!dev_desc->rawblksz || !dev_desc->rawlba) {
1043 		dev_desc->rawblksz = dev_desc->blksz;
1044 		dev_desc->rawlba = dev_desc->lba;
1045 	}
1046 
1047 	if (is_valid_gpt_buf(dev_desc, buf))
1048 		return -1;
1049 
1050 	/* determine start of GPT Header in the buffer */
1051 	gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
1052 		       dev_desc->rawblksz);
1053 
1054 	/* determine start of GPT Entries in the buffer */
1055 	gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
1056 		       dev_desc->rawblksz);
1057 	gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
1058 				   le32_to_cpu(gpt_h->sizeof_partition_entry)),
1059 				  dev_desc);
1060 
1061 	/* write MBR */
1062 	lba = 0;	/* MBR is always at 0 */
1063 	cnt = 1;	/* MBR (1 block) */
1064 	if (blk_dwrite(dev_desc, lba, cnt, buf) != cnt) {
1065 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
1066 		       __func__, "MBR", cnt, lba);
1067 		return 1;
1068 	}
1069 
1070 	/* write Primary GPT */
1071 	lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
1072 	cnt = 1;	/* GPT Header (1 block) */
1073 	if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
1074 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
1075 		       __func__, "Primary GPT Header", cnt, lba);
1076 		return 1;
1077 	}
1078 
1079 	lba = le64_to_cpu(gpt_h->partition_entry_lba);
1080 	cnt = gpt_e_blk_cnt;
1081 	if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
1082 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
1083 		       __func__, "Primary GPT Entries", cnt, lba);
1084 		return 1;
1085 	}
1086 
1087 	prepare_backup_gpt_header(gpt_h);
1088 
1089 	/* write Backup GPT */
1090 	lba = le64_to_cpu(gpt_h->partition_entry_lba);
1091 	cnt = gpt_e_blk_cnt;
1092 	if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
1093 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
1094 		       __func__, "Backup GPT Entries", cnt, lba);
1095 		return 1;
1096 	}
1097 
1098 	lba = le64_to_cpu(gpt_h->my_lba);
1099 	cnt = 1;	/* GPT Header (1 block) */
1100 	if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
1101 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
1102 		       __func__, "Backup GPT Header", cnt, lba);
1103 		return 1;
1104 	}
1105 
1106 	return 0;
1107 }
1108 #endif
1109 
1110 /*
1111  * Private functions
1112  */
1113 /*
1114  * pmbr_part_valid(): Check for EFI partition signature
1115  *
1116  * Returns: 1 if EFI GPT partition type is found.
1117  */
1118 static int pmbr_part_valid(struct partition *part)
1119 {
1120 	if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
1121 		get_unaligned_le32(&part->start_sect) == 1UL) {
1122 		return 1;
1123 	}
1124 
1125 	return 0;
1126 }
1127 
1128 /*
1129  * is_pmbr_valid(): test Protective MBR for validity
1130  *
1131  * Returns: 1 if PMBR is valid, 0 otherwise.
1132  * Validity depends on two things:
1133  *  1) MSDOS signature is in the last two bytes of the MBR
1134  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
1135  */
1136 static int is_pmbr_valid(legacy_mbr * mbr)
1137 {
1138 	int i = 0;
1139 
1140 #ifdef CONFIG_ARCH_ROCKCHIP
1141 	/*
1142 	 * In sd-update card, we use RKPARM partition in bootloader to load
1143 	 * firmware, and use MS-DOS partition in recovery to update system.
1144 	 * Now, we want to use gpt in bootloader and abandon the RKPARM
1145 	 * partition. So in new sd-update card, we write the MS-DOS partition
1146 	 * table and gpt to sd card. Then we must return 1 directly when test
1147 	 * the mbr sector otherwise the gpt is unavailable.
1148 	 */
1149 	return 1;
1150 #endif
1151 
1152 	if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
1153 		return 0;
1154 
1155 	for (i = 0; i < 4; i++) {
1156 		if (pmbr_part_valid(&mbr->partition_record[i])) {
1157 			return 1;
1158 		}
1159 	}
1160 	return 0;
1161 }
1162 
1163 /**
1164  * is_gpt_valid() - tests one GPT header and PTEs for validity
1165  *
1166  * lba is the logical block address of the GPT header to test
1167  * gpt is a GPT header ptr, filled on return.
1168  * ptes is a PTEs ptr, filled on return.
1169  *
1170  * Description: returns 1 if valid,  0 on error.
1171  * If valid, returns pointers to PTEs.
1172  */
1173 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
1174 			gpt_header *pgpt_head, gpt_entry **pgpt_pte)
1175 {
1176 	int sector;
1177 	/* Confirm valid arguments prior to allocation. */
1178 	if (!dev_desc || !pgpt_head) {
1179 		printf("%s: Invalid Argument(s)\n", __func__);
1180 		return 0;
1181 	}
1182 
1183 	/* Re-use pte if it's not NULL */
1184 	if (*pgpt_pte)
1185 		return 1;
1186 
1187 	ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, mbr, 1, dev_desc->rawblksz);
1188 
1189 	sector = dev_desc->rawblksz / dev_desc->blksz;
1190 	/* Read MBR Header from device */
1191 	if (blk_dread(dev_desc, 0, sector, (ulong *)mbr) != sector) {
1192 		printf("*** ERROR: Can't read MBR header ***\n");
1193 		return 0;
1194 	}
1195 
1196 	/* Read GPT Header from device */
1197 	if (blk_dread(dev_desc, (lbaint_t)lba * sector, sector, pgpt_head) != sector) {
1198 		printf("*** ERROR: Can't read GPT header ***\n");
1199 		return 0;
1200 	}
1201 
1202 	if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->rawlba))
1203 		return 0;
1204 
1205 	if (dev_desc->sig_type == SIG_TYPE_NONE) {
1206 		efi_guid_t empty = {};
1207 		if (memcmp(&pgpt_head->disk_guid, &empty, sizeof(empty))) {
1208 			dev_desc->sig_type = SIG_TYPE_GUID;
1209 			memcpy(&dev_desc->guid_sig, &pgpt_head->disk_guid,
1210 			      sizeof(empty));
1211 		} else if (mbr->unique_mbr_signature != 0) {
1212 			dev_desc->sig_type = SIG_TYPE_MBR;
1213 			dev_desc->mbr_sig = mbr->unique_mbr_signature;
1214 		}
1215 	}
1216 
1217 	/* Read and allocate Partition Table Entries */
1218 	*pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
1219 	if (*pgpt_pte == NULL) {
1220 		printf("GPT: Failed to allocate memory for PTE\n");
1221 		return 0;
1222 	}
1223 
1224 	if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
1225 		free(*pgpt_pte);
1226 		*pgpt_pte = NULL;
1227 		return 0;
1228 	}
1229 
1230 	/* We're done, all's well */
1231 	return 1;
1232 }
1233 
1234 /**
1235  * alloc_read_gpt_entries(): reads partition entries from disk
1236  * @dev_desc
1237  * @gpt - GPT header
1238  *
1239  * Description: Returns ptes on success,  NULL on error.
1240  * Allocates space for PTEs based on information found in @gpt.
1241  * Notes: remember to free pte when you're done!
1242  */
1243 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
1244 					 gpt_header *pgpt_head)
1245 {
1246 	size_t count = 0, blk_cnt;
1247 	lbaint_t blk;
1248 	gpt_entry *pte = NULL;
1249 
1250 	if (!dev_desc || !pgpt_head) {
1251 		printf("%s: Invalid Argument(s)\n", __func__);
1252 		return NULL;
1253 	}
1254 
1255 	count = le32_to_cpu(pgpt_head->num_partition_entries) *
1256 		le32_to_cpu(pgpt_head->sizeof_partition_entry);
1257 
1258 	debug("%s: count = %u * %u = %lu\n", __func__,
1259 	      (u32) le32_to_cpu(pgpt_head->num_partition_entries),
1260 	      (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry),
1261 	      (ulong)count);
1262 
1263 	/* Allocate memory for PTE, remember to FREE */
1264 	if (count != 0) {
1265 		pte = memalign(ARCH_DMA_MINALIGN,
1266 			       PAD_SIZE(count, dev_desc->rawblksz));
1267 	}
1268 
1269 	if (count == 0 || pte == NULL) {
1270 		printf("%s: ERROR: Can't allocate %#lX bytes for GPT Entries\n",
1271 		       __func__, (ulong)count);
1272 		return NULL;
1273 	}
1274 
1275 	/* Read GPT Entries from device */
1276 	blk = le64_to_cpu(pgpt_head->partition_entry_lba);
1277 	blk_cnt = BLOCK_CNT(count, dev_desc);
1278 	if (blk_dread(dev_desc, blk * dev_desc->rawblksz / dev_desc->blksz, (lbaint_t)blk_cnt, pte) != blk_cnt) {
1279 		printf("*** ERROR: Can't read GPT Entries ***\n");
1280 		free(pte);
1281 		return NULL;
1282 	}
1283 	return pte;
1284 }
1285 
1286 /**
1287  * is_pte_valid(): validates a single Partition Table Entry
1288  * @gpt_entry - Pointer to a single Partition Table Entry
1289  *
1290  * Description: returns 1 if valid,  0 on error.
1291  */
1292 static int is_pte_valid(gpt_entry * pte)
1293 {
1294 	efi_guid_t unused_guid;
1295 
1296 	if (!pte) {
1297 		printf("%s: Invalid Argument(s)\n", __func__);
1298 		return 0;
1299 	}
1300 
1301 	/* Only one validation for now:
1302 	 * The GUID Partition Type != Unused Entry (ALL-ZERO)
1303 	 */
1304 	memset(unused_guid.b, 0, sizeof(unused_guid.b));
1305 
1306 	if (memcmp(pte->partition_type_guid.b, unused_guid.b,
1307 		sizeof(unused_guid.b)) == 0) {
1308 
1309 		debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
1310 		      (unsigned int)(uintptr_t)pte);
1311 
1312 		return 0;
1313 	} else {
1314 		return 1;
1315 	}
1316 }
1317 
1318 /*
1319  * Add an 'a_' prefix so it comes before 'dos' in the linker list. We need to
1320  * check EFI first, since a DOS partition is often used as a 'protective MBR'
1321  * with EFI.
1322  */
1323 U_BOOT_PART_TYPE(a_efi) = {
1324 	.name		= "EFI",
1325 	.part_type	= PART_TYPE_EFI,
1326 	.max_entries	= GPT_ENTRY_NUMBERS,
1327 	.get_info	= part_get_info_ptr(part_get_info_efi),
1328 	.print		= part_print_ptr(part_print_efi),
1329 	.test		= part_test_efi,
1330 };
1331 #endif
1332