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