xref: /rk3399_rockchip-uboot/disk/part_efi.c (revision 9a7ebf31057d48c90fe59d4679dbf2cfdb0f005b)
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 	/* We suppose different dev have different size, eg. emmc vs sd */
279 	if (gpt_head && (gpt_head->last_usable_lba + 0x22) != dev_desc->lba)
280 		gpt_pte = NULL;
281 
282 	/* "part" argument must be at least 1 */
283 	if (part < 1) {
284 		printf("%s: Invalid Argument(s)\n", __func__);
285 		return -1;
286 	}
287 
288 	/* This function validates AND fills in the GPT header and PTE */
289 	if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
290 			gpt_head, &gpt_pte) != 1) {
291 		printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
292 		if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
293 				 gpt_head, &gpt_pte) != 1) {
294 			printf("%s: *** ERROR: Invalid Backup GPT ***\n",
295 			       __func__);
296 			return -1;
297 		} else {
298 			printf("%s: ***        Using Backup GPT ***\n",
299 			       __func__);
300 		}
301 	}
302 
303 	if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
304 	    !is_pte_valid(&gpt_pte[part - 1])) {
305 		debug("%s: *** ERROR: Invalid partition number %d ***\n",
306 			__func__, part);
307 		return -1;
308 	}
309 
310 	/* The 'lbaint_t' casting may limit the maximum disk size to 2 TB */
311 	info->start = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].starting_lba);
312 	/* The ending LBA is inclusive, to calculate size, add 1 to it */
313 	info->size = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1
314 		     - info->start;
315 	info->blksz = dev_desc->blksz;
316 
317 	sprintf((char *)info->name, "%s",
318 			print_efiname(&gpt_pte[part - 1]));
319 	strcpy((char *)info->type, "U-Boot");
320 	info->bootable = is_bootable(&gpt_pte[part - 1]);
321 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
322 	uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b, info->uuid,
323 			UUID_STR_FORMAT_GUID);
324 #endif
325 #ifdef CONFIG_PARTITION_TYPE_GUID
326 	uuid_bin_to_str(gpt_pte[part - 1].partition_type_guid.b,
327 			info->type_guid, UUID_STR_FORMAT_GUID);
328 #endif
329 
330 	debug("%s: start 0x" LBAF ", size 0x" LBAF ", name %s\n", __func__,
331 	      info->start, info->size, info->name);
332 
333 	return 0;
334 }
335 
336 static int part_test_efi(struct blk_desc *dev_desc)
337 {
338 	ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, dev_desc->blksz);
339 
340 	/* Read legacy MBR from block 0 and validate it */
341 	if ((blk_dread(dev_desc, 0, 1, (ulong *)legacymbr) != 1)
342 		|| (is_pmbr_valid(legacymbr) != 1)) {
343 		return -1;
344 	}
345 	return 0;
346 }
347 
348 /**
349  * set_protective_mbr(): Set the EFI protective MBR
350  * @param dev_desc - block device descriptor
351  *
352  * @return - zero on success, otherwise error
353  */
354 static int set_protective_mbr(struct blk_desc *dev_desc)
355 {
356 	/* Setup the Protective MBR */
357 	ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, p_mbr, 1);
358 	memset(p_mbr, 0, sizeof(*p_mbr));
359 
360 	if (p_mbr == NULL) {
361 		printf("%s: calloc failed!\n", __func__);
362 		return -1;
363 	}
364 
365 	/* Read MBR to backup boot code if it exists */
366 	if (blk_dread(dev_desc, 0, 1, p_mbr) != 1) {
367 		pr_err("** Can't read from device %d **\n", dev_desc->devnum);
368 		return -1;
369 	}
370 
371 	/* Append signature */
372 	p_mbr->signature = MSDOS_MBR_SIGNATURE;
373 	p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
374 	p_mbr->partition_record[0].start_sect = 1;
375 	p_mbr->partition_record[0].nr_sects = (u32) dev_desc->lba - 1;
376 
377 	/* Write MBR sector to the MMC device */
378 	if (blk_dwrite(dev_desc, 0, 1, p_mbr) != 1) {
379 		printf("** Can't write to device %d **\n",
380 			dev_desc->devnum);
381 		return -1;
382 	}
383 
384 	return 0;
385 }
386 
387 int write_gpt_table(struct blk_desc *dev_desc,
388 		gpt_header *gpt_h, gpt_entry *gpt_e)
389 {
390 	const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
391 					   * sizeof(gpt_entry)), dev_desc);
392 	u32 calc_crc32;
393 
394 	debug("max lba: %x\n", (u32) dev_desc->lba);
395 	/* Setup the Protective MBR */
396 	if (set_protective_mbr(dev_desc) < 0)
397 		goto err;
398 
399 	/* Generate CRC for the Primary GPT Header */
400 	calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
401 			      le32_to_cpu(gpt_h->num_partition_entries) *
402 			      le32_to_cpu(gpt_h->sizeof_partition_entry));
403 	gpt_h->partition_entry_array_crc32 = cpu_to_le32(calc_crc32);
404 
405 	calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
406 			      le32_to_cpu(gpt_h->header_size));
407 	gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
408 
409 	/* Write the First GPT to the block right after the Legacy MBR */
410 	if (blk_dwrite(dev_desc, 1, 1, gpt_h) != 1)
411 		goto err;
412 
413 	if (blk_dwrite(dev_desc, le64_to_cpu(gpt_h->partition_entry_lba),
414 		       pte_blk_cnt, gpt_e) != pte_blk_cnt)
415 		goto err;
416 
417 	prepare_backup_gpt_header(gpt_h);
418 
419 	if (blk_dwrite(dev_desc, (lbaint_t)le64_to_cpu(gpt_h->last_usable_lba)
420 		       + 1, pte_blk_cnt, gpt_e) != pte_blk_cnt)
421 		goto err;
422 
423 	if (blk_dwrite(dev_desc, (lbaint_t)le64_to_cpu(gpt_h->my_lba), 1,
424 		       gpt_h) != 1)
425 		goto err;
426 
427 	debug("GPT successfully written to block device!\n");
428 	return 0;
429 
430  err:
431 	printf("** Can't write to device %d **\n", dev_desc->devnum);
432 	return -1;
433 }
434 
435 int gpt_fill_pte(struct blk_desc *dev_desc,
436 		 gpt_header *gpt_h, gpt_entry *gpt_e,
437 		 disk_partition_t *partitions, int parts)
438 {
439 	lbaint_t offset = (lbaint_t)le64_to_cpu(gpt_h->first_usable_lba);
440 	lbaint_t last_usable_lba = (lbaint_t)
441 			le64_to_cpu(gpt_h->last_usable_lba);
442 	int i, k;
443 	size_t efiname_len, dosname_len;
444 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
445 	char *str_uuid;
446 	unsigned char *bin_uuid;
447 #endif
448 #ifdef CONFIG_PARTITION_TYPE_GUID
449 	char *str_type_guid;
450 	unsigned char *bin_type_guid;
451 #endif
452 	size_t hdr_start = gpt_h->my_lba;
453 	size_t hdr_end = hdr_start + 1;
454 
455 	size_t pte_start = gpt_h->partition_entry_lba;
456 	size_t pte_end = pte_start +
457 		gpt_h->num_partition_entries * gpt_h->sizeof_partition_entry /
458 		dev_desc->blksz;
459 
460 	for (i = 0; i < parts; i++) {
461 		/* partition starting lba */
462 		lbaint_t start = partitions[i].start;
463 		lbaint_t size = partitions[i].size;
464 
465 		if (start) {
466 			offset = start + size;
467 		} else {
468 			start = offset;
469 			offset += size;
470 		}
471 
472 		/*
473 		 * If our partition overlaps with either the GPT
474 		 * header, or the partition entry, reject it.
475 		 */
476 		if (((start < hdr_end && hdr_start < (start + size)) ||
477 		     (start < pte_end && pte_start < (start + size)))) {
478 			printf("Partition overlap\n");
479 			return -1;
480 		}
481 
482 		gpt_e[i].starting_lba = cpu_to_le64(start);
483 
484 		if (offset > (last_usable_lba + 1)) {
485 			printf("Partitions layout exceds disk size\n");
486 			return -1;
487 		}
488 		/* partition ending lba */
489 		if ((i == parts - 1) && (size == 0))
490 			/* extend the last partition to maximuim */
491 			gpt_e[i].ending_lba = gpt_h->last_usable_lba;
492 		else
493 			gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
494 
495 #ifdef CONFIG_PARTITION_TYPE_GUID
496 		str_type_guid = partitions[i].type_guid;
497 		bin_type_guid = gpt_e[i].partition_type_guid.b;
498 		if (strlen(str_type_guid)) {
499 			if (uuid_str_to_bin(str_type_guid, bin_type_guid,
500 					    UUID_STR_FORMAT_GUID)) {
501 				printf("Partition no. %d: invalid type guid: %s\n",
502 				       i, str_type_guid);
503 				return -1;
504 			}
505 		} else {
506 			/* default partition type GUID */
507 			memcpy(bin_type_guid,
508 			       &PARTITION_BASIC_DATA_GUID, 16);
509 		}
510 #else
511 		/* partition type GUID */
512 		memcpy(gpt_e[i].partition_type_guid.b,
513 			&PARTITION_BASIC_DATA_GUID, 16);
514 #endif
515 
516 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
517 		str_uuid = partitions[i].uuid;
518 		bin_uuid = gpt_e[i].unique_partition_guid.b;
519 
520 		if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_GUID)) {
521 			printf("Partition no. %d: invalid guid: %s\n",
522 				i, str_uuid);
523 			return -1;
524 		}
525 #endif
526 
527 		/* partition attributes */
528 		memset(&gpt_e[i].attributes, 0,
529 		       sizeof(gpt_entry_attributes));
530 
531 		if (partitions[i].bootable)
532 			gpt_e[i].attributes.fields.legacy_bios_bootable = 1;
533 
534 		/* partition name */
535 		efiname_len = sizeof(gpt_e[i].partition_name)
536 			/ sizeof(efi_char16_t);
537 		dosname_len = sizeof(partitions[i].name);
538 
539 		memset(gpt_e[i].partition_name, 0,
540 		       sizeof(gpt_e[i].partition_name));
541 
542 		for (k = 0; k < min(dosname_len, efiname_len); k++)
543 			gpt_e[i].partition_name[k] =
544 				(efi_char16_t)(partitions[i].name[k]);
545 
546 		debug("%s: name: %s offset[%d]: 0x" LBAF
547 		      " size[%d]: 0x" LBAF "\n",
548 		      __func__, partitions[i].name, i,
549 		      offset, i, size);
550 	}
551 
552 	return 0;
553 }
554 
555 static uint32_t partition_entries_offset(struct blk_desc *dev_desc)
556 {
557 	uint32_t offset_blks = 2;
558 	uint32_t __maybe_unused offset_bytes;
559 	int __maybe_unused config_offset;
560 
561 #if defined(CONFIG_EFI_PARTITION_ENTRIES_OFF)
562 	/*
563 	 * Some architectures require their SPL loader at a fixed
564 	 * address within the first 16KB of the disk.  To avoid an
565 	 * overlap with the partition entries of the EFI partition
566 	 * table, the first safe offset (in bytes, from the start of
567 	 * the disk) for the entries can be set in
568 	 * CONFIG_EFI_PARTITION_ENTRIES_OFF.
569 	 */
570 	offset_bytes =
571 		PAD_TO_BLOCKSIZE(CONFIG_EFI_PARTITION_ENTRIES_OFF, dev_desc);
572 	offset_blks = offset_bytes / dev_desc->blksz;
573 #endif
574 
575 #if defined(CONFIG_OF_CONTROL)
576 	/*
577 	 * Allow the offset of the first partition entires (in bytes
578 	 * from the start of the device) to be specified as a property
579 	 * of the device tree '/config' node.
580 	 */
581 	config_offset = fdtdec_get_config_int(gd->fdt_blob,
582 					      "u-boot,efi-partition-entries-offset",
583 					      -EINVAL);
584 	if (config_offset != -EINVAL) {
585 		offset_bytes = PAD_TO_BLOCKSIZE(config_offset, dev_desc);
586 		offset_blks = offset_bytes / dev_desc->blksz;
587 	}
588 #endif
589 
590 	debug("efi: partition entries offset (in blocks): %d\n", offset_blks);
591 
592 	/*
593 	 * The earliest LBA this can be at is LBA#2 (i.e. right behind
594 	 * the (protective) MBR and the GPT header.
595 	 */
596 	if (offset_blks < 2)
597 		offset_blks = 2;
598 
599 	return offset_blks;
600 }
601 
602 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
603 		char *str_guid, int parts_count)
604 {
605 	gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE);
606 	gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
607 	gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
608 	gpt_h->my_lba = cpu_to_le64(1);
609 	gpt_h->alternate_lba = cpu_to_le64(dev_desc->lba - 1);
610 	gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
611 	gpt_h->partition_entry_lba =
612 		cpu_to_le64(partition_entries_offset(dev_desc));
613 	gpt_h->first_usable_lba =
614 		cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 32);
615 	gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
616 	gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
617 	gpt_h->header_crc32 = 0;
618 	gpt_h->partition_entry_array_crc32 = 0;
619 
620 	if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
621 		return -1;
622 
623 	return 0;
624 }
625 
626 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
627 		disk_partition_t *partitions, int parts_count)
628 {
629 	gpt_header *gpt_h;
630 	gpt_entry *gpt_e;
631 	int ret, size;
632 
633 	size = PAD_TO_BLOCKSIZE(sizeof(gpt_header), dev_desc);
634 	gpt_h = malloc_cache_aligned(size);
635 	if (gpt_h == NULL) {
636 		printf("%s: calloc failed!\n", __func__);
637 		return -1;
638 	}
639 	memset(gpt_h, 0, size);
640 
641 	size = PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS * sizeof(gpt_entry),
642 				dev_desc);
643 	gpt_e = malloc_cache_aligned(size);
644 	if (gpt_e == NULL) {
645 		printf("%s: calloc failed!\n", __func__);
646 		free(gpt_h);
647 		return -1;
648 	}
649 	memset(gpt_e, 0, size);
650 
651 	/* Generate Primary GPT header (LBA1) */
652 	ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
653 	if (ret)
654 		goto err;
655 
656 	/* Generate partition entries */
657 	ret = gpt_fill_pte(dev_desc, gpt_h, gpt_e, partitions, parts_count);
658 	if (ret)
659 		goto err;
660 
661 	/* Write GPT partition table */
662 	ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
663 
664 err:
665 	free(gpt_e);
666 	free(gpt_h);
667 	return ret;
668 }
669 
670 static void gpt_convert_efi_name_to_char(char *s, efi_char16_t *es, int n)
671 {
672 	char *ess = (char *)es;
673 	int i, j;
674 
675 	memset(s, '\0', n);
676 
677 	for (i = 0, j = 0; j < n; i += 2, j++) {
678 		s[j] = ess[i];
679 		if (!ess[i])
680 			return;
681 	}
682 }
683 
684 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
685 		       gpt_entry **gpt_pte)
686 {
687 	/*
688 	 * This function validates AND
689 	 * fills in the GPT header and PTE
690 	 */
691 	if (is_gpt_valid(dev_desc,
692 			 GPT_PRIMARY_PARTITION_TABLE_LBA,
693 			 gpt_head, gpt_pte) != 1) {
694 		printf("%s: *** ERROR: Invalid GPT ***\n",
695 		       __func__);
696 		return -1;
697 	}
698 	if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
699 			 gpt_head, gpt_pte) != 1) {
700 		printf("%s: *** ERROR: Invalid Backup GPT ***\n",
701 		       __func__);
702 		return -1;
703 	}
704 
705 	return 0;
706 }
707 
708 int gpt_verify_partitions(struct blk_desc *dev_desc,
709 			  disk_partition_t *partitions, int parts,
710 			  gpt_header *gpt_head, gpt_entry **gpt_pte)
711 {
712 	char efi_str[PARTNAME_SZ + 1];
713 	u64 gpt_part_size;
714 	gpt_entry *gpt_e;
715 	int ret, i;
716 
717 	ret = gpt_verify_headers(dev_desc, gpt_head, gpt_pte);
718 	if (ret)
719 		return ret;
720 
721 	gpt_e = *gpt_pte;
722 
723 	for (i = 0; i < parts; i++) {
724 		if (i == gpt_head->num_partition_entries) {
725 			pr_err("More partitions than allowed!\n");
726 			return -1;
727 		}
728 
729 		/* Check if GPT and ENV partition names match */
730 		gpt_convert_efi_name_to_char(efi_str, gpt_e[i].partition_name,
731 					     PARTNAME_SZ + 1);
732 
733 		debug("%s: part: %2d name - GPT: %16s, ENV: %16s ",
734 		      __func__, i, efi_str, partitions[i].name);
735 
736 		if (strncmp(efi_str, (char *)partitions[i].name,
737 			    sizeof(partitions->name))) {
738 			pr_err("Partition name: %s does not match %s!\n",
739 			      efi_str, (char *)partitions[i].name);
740 			return -1;
741 		}
742 
743 		/* Check if GPT and ENV sizes match */
744 		gpt_part_size = le64_to_cpu(gpt_e[i].ending_lba) -
745 			le64_to_cpu(gpt_e[i].starting_lba) + 1;
746 		debug("size(LBA) - GPT: %8llu, ENV: %8llu ",
747 		      (unsigned long long)gpt_part_size,
748 		      (unsigned long long)partitions[i].size);
749 
750 		if (le64_to_cpu(gpt_part_size) != partitions[i].size) {
751 			/* We do not check the extend partition size */
752 			if ((i == parts - 1) && (partitions[i].size == 0))
753 				continue;
754 
755 			pr_err("Partition %s size: %llu does not match %llu!\n",
756 			      efi_str, (unsigned long long)gpt_part_size,
757 			      (unsigned long long)partitions[i].size);
758 			return -1;
759 		}
760 
761 		/*
762 		 * Start address is optional - check only if provided
763 		 * in '$partition' variable
764 		 */
765 		if (!partitions[i].start) {
766 			debug("\n");
767 			continue;
768 		}
769 
770 		/* Check if GPT and ENV start LBAs match */
771 		debug("start LBA - GPT: %8llu, ENV: %8llu\n",
772 		      le64_to_cpu(gpt_e[i].starting_lba),
773 		      (unsigned long long)partitions[i].start);
774 
775 		if (le64_to_cpu(gpt_e[i].starting_lba) != partitions[i].start) {
776 			pr_err("Partition %s start: %llu does not match %llu!\n",
777 			      efi_str, le64_to_cpu(gpt_e[i].starting_lba),
778 			      (unsigned long long)partitions[i].start);
779 			return -1;
780 		}
781 	}
782 
783 	return 0;
784 }
785 
786 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf)
787 {
788 	gpt_header *gpt_h;
789 	gpt_entry *gpt_e;
790 
791 	/* determine start of GPT Header in the buffer */
792 	gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
793 		       dev_desc->blksz);
794 
795 	if ((le64_to_cpu(gpt_h->alternate_lba) + 1)
796 			!= cpu_to_le64(dev_desc->lba)) {
797 		printf("%s: failed checking '%s'\n", __func__,
798 		       "invalid GPT Disk Size");
799 		return -1;
800 	}
801 
802 	if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
803 				dev_desc->lba))
804 		return -1;
805 
806 	/* determine start of GPT Entries in the buffer */
807 	gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
808 		       dev_desc->blksz);
809 	if (validate_gpt_entries(gpt_h, gpt_e))
810 		return -1;
811 
812 	return 0;
813 }
814 
815 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf)
816 {
817 	gpt_header *gpt_h;
818 	gpt_entry *gpt_e;
819 	int gpt_e_blk_cnt;
820 	lbaint_t lba;
821 	int cnt;
822 
823 	if (is_valid_gpt_buf(dev_desc, buf))
824 		return -1;
825 
826 	/* determine start of GPT Header in the buffer */
827 	gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
828 		       dev_desc->blksz);
829 
830 	/* determine start of GPT Entries in the buffer */
831 	gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
832 		       dev_desc->blksz);
833 	gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
834 				   le32_to_cpu(gpt_h->sizeof_partition_entry)),
835 				  dev_desc);
836 
837 	/* write MBR */
838 	lba = 0;	/* MBR is always at 0 */
839 	cnt = 1;	/* MBR (1 block) */
840 	if (blk_dwrite(dev_desc, lba, cnt, buf) != cnt) {
841 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
842 		       __func__, "MBR", cnt, lba);
843 		return 1;
844 	}
845 
846 	/* write Primary GPT */
847 	lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
848 	cnt = 1;	/* GPT Header (1 block) */
849 	if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
850 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
851 		       __func__, "Primary GPT Header", cnt, lba);
852 		return 1;
853 	}
854 
855 	lba = le64_to_cpu(gpt_h->partition_entry_lba);
856 	cnt = gpt_e_blk_cnt;
857 	if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
858 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
859 		       __func__, "Primary GPT Entries", cnt, lba);
860 		return 1;
861 	}
862 
863 	prepare_backup_gpt_header(gpt_h);
864 
865 	/* write Backup GPT */
866 	lba = le64_to_cpu(gpt_h->partition_entry_lba);
867 	cnt = gpt_e_blk_cnt;
868 	if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
869 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
870 		       __func__, "Backup GPT Entries", cnt, lba);
871 		return 1;
872 	}
873 
874 	lba = le64_to_cpu(gpt_h->my_lba);
875 	cnt = 1;	/* GPT Header (1 block) */
876 	if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
877 		printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
878 		       __func__, "Backup GPT Header", cnt, lba);
879 		return 1;
880 	}
881 
882 	return 0;
883 }
884 #endif
885 
886 /*
887  * Private functions
888  */
889 /*
890  * pmbr_part_valid(): Check for EFI partition signature
891  *
892  * Returns: 1 if EFI GPT partition type is found.
893  */
894 static int pmbr_part_valid(struct partition *part)
895 {
896 	if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
897 		get_unaligned_le32(&part->start_sect) == 1UL) {
898 		return 1;
899 	}
900 
901 	return 0;
902 }
903 
904 /*
905  * is_pmbr_valid(): test Protective MBR for validity
906  *
907  * Returns: 1 if PMBR is valid, 0 otherwise.
908  * Validity depends on two things:
909  *  1) MSDOS signature is in the last two bytes of the MBR
910  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
911  */
912 static int is_pmbr_valid(legacy_mbr * mbr)
913 {
914 	int i = 0;
915 
916 	if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
917 		return 0;
918 
919 	for (i = 0; i < 4; i++) {
920 		if (pmbr_part_valid(&mbr->partition_record[i])) {
921 			return 1;
922 		}
923 	}
924 	return 0;
925 }
926 
927 /**
928  * is_gpt_valid() - tests one GPT header and PTEs for validity
929  *
930  * lba is the logical block address of the GPT header to test
931  * gpt is a GPT header ptr, filled on return.
932  * ptes is a PTEs ptr, filled on return.
933  *
934  * Description: returns 1 if valid,  0 on error.
935  * If valid, returns pointers to PTEs.
936  */
937 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
938 			gpt_header *pgpt_head, gpt_entry **pgpt_pte)
939 {
940 	/* Confirm valid arguments prior to allocation. */
941 	if (!dev_desc || !pgpt_head) {
942 		printf("%s: Invalid Argument(s)\n", __func__);
943 		return 0;
944 	}
945 
946 	/* Re-use pte if it's not NULL */
947 	if (*pgpt_pte)
948 		return 1;
949 
950 	ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, mbr, dev_desc->blksz);
951 
952 	/* Read MBR Header from device */
953 	if (blk_dread(dev_desc, 0, 1, (ulong *)mbr) != 1) {
954 		printf("*** ERROR: Can't read MBR header ***\n");
955 		return 0;
956 	}
957 
958 	/* Read GPT Header from device */
959 	if (blk_dread(dev_desc, (lbaint_t)lba, 1, pgpt_head) != 1) {
960 		printf("*** ERROR: Can't read GPT header ***\n");
961 		return 0;
962 	}
963 
964 	if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->lba))
965 		return 0;
966 
967 	if (dev_desc->sig_type == SIG_TYPE_NONE) {
968 		efi_guid_t empty = {};
969 		if (memcmp(&pgpt_head->disk_guid, &empty, sizeof(empty))) {
970 			dev_desc->sig_type = SIG_TYPE_GUID;
971 			memcpy(&dev_desc->guid_sig, &pgpt_head->disk_guid,
972 			      sizeof(empty));
973 		} else if (mbr->unique_mbr_signature != 0) {
974 			dev_desc->sig_type = SIG_TYPE_MBR;
975 			dev_desc->mbr_sig = mbr->unique_mbr_signature;
976 		}
977 	}
978 
979 	/* Read and allocate Partition Table Entries */
980 	*pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
981 	if (*pgpt_pte == NULL) {
982 		printf("GPT: Failed to allocate memory for PTE\n");
983 		return 0;
984 	}
985 
986 	if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
987 		free(*pgpt_pte);
988 		*pgpt_pte = NULL;
989 		return 0;
990 	}
991 
992 	/* We're done, all's well */
993 	return 1;
994 }
995 
996 /**
997  * alloc_read_gpt_entries(): reads partition entries from disk
998  * @dev_desc
999  * @gpt - GPT header
1000  *
1001  * Description: Returns ptes on success,  NULL on error.
1002  * Allocates space for PTEs based on information found in @gpt.
1003  * Notes: remember to free pte when you're done!
1004  */
1005 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
1006 					 gpt_header *pgpt_head)
1007 {
1008 	size_t count = 0, blk_cnt;
1009 	lbaint_t blk;
1010 	gpt_entry *pte = NULL;
1011 
1012 	if (!dev_desc || !pgpt_head) {
1013 		printf("%s: Invalid Argument(s)\n", __func__);
1014 		return NULL;
1015 	}
1016 
1017 	count = le32_to_cpu(pgpt_head->num_partition_entries) *
1018 		le32_to_cpu(pgpt_head->sizeof_partition_entry);
1019 
1020 	debug("%s: count = %u * %u = %lu\n", __func__,
1021 	      (u32) le32_to_cpu(pgpt_head->num_partition_entries),
1022 	      (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry),
1023 	      (ulong)count);
1024 
1025 	/* Allocate memory for PTE, remember to FREE */
1026 	if (count != 0) {
1027 		pte = memalign(ARCH_DMA_MINALIGN,
1028 			       PAD_TO_BLOCKSIZE(count, dev_desc));
1029 	}
1030 
1031 	if (count == 0 || pte == NULL) {
1032 		printf("%s: ERROR: Can't allocate %#lX bytes for GPT Entries\n",
1033 		       __func__, (ulong)count);
1034 		return NULL;
1035 	}
1036 
1037 	/* Read GPT Entries from device */
1038 	blk = le64_to_cpu(pgpt_head->partition_entry_lba);
1039 	blk_cnt = BLOCK_CNT(count, dev_desc);
1040 	if (blk_dread(dev_desc, blk, (lbaint_t)blk_cnt, pte) != blk_cnt) {
1041 		printf("*** ERROR: Can't read GPT Entries ***\n");
1042 		free(pte);
1043 		return NULL;
1044 	}
1045 	return pte;
1046 }
1047 
1048 /**
1049  * is_pte_valid(): validates a single Partition Table Entry
1050  * @gpt_entry - Pointer to a single Partition Table Entry
1051  *
1052  * Description: returns 1 if valid,  0 on error.
1053  */
1054 static int is_pte_valid(gpt_entry * pte)
1055 {
1056 	efi_guid_t unused_guid;
1057 
1058 	if (!pte) {
1059 		printf("%s: Invalid Argument(s)\n", __func__);
1060 		return 0;
1061 	}
1062 
1063 	/* Only one validation for now:
1064 	 * The GUID Partition Type != Unused Entry (ALL-ZERO)
1065 	 */
1066 	memset(unused_guid.b, 0, sizeof(unused_guid.b));
1067 
1068 	if (memcmp(pte->partition_type_guid.b, unused_guid.b,
1069 		sizeof(unused_guid.b)) == 0) {
1070 
1071 		debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
1072 		      (unsigned int)(uintptr_t)pte);
1073 
1074 		return 0;
1075 	} else {
1076 		return 1;
1077 	}
1078 }
1079 
1080 /*
1081  * Add an 'a_' prefix so it comes before 'dos' in the linker list. We need to
1082  * check EFI first, since a DOS partition is often used as a 'protective MBR'
1083  * with EFI.
1084  */
1085 U_BOOT_PART_TYPE(a_efi) = {
1086 	.name		= "EFI",
1087 	.part_type	= PART_TYPE_EFI,
1088 	.max_entries	= GPT_ENTRY_NUMBERS,
1089 	.get_info	= part_get_info_ptr(part_get_info_efi),
1090 	.print		= part_print_ptr(part_print_efi),
1091 	.test		= part_test_efi,
1092 };
1093 #endif
1094