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