]> Git Repo - J-u-boot.git/blob - disk/part_efi.c
Merge tag 'v2023.10-rc4' into next
[J-u-boot.git] / disk / part_efi.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) 2008 RuggedCom, Inc.
4  * Richard Retanubun <[email protected]>
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
13 #define LOG_CATEGORY LOGC_FS
14
15 #include <common.h>
16 #include <blk.h>
17 #include <log.h>
18 #include <part.h>
19 #include <uuid.h>
20 #include <asm/cache.h>
21 #include <asm/global_data.h>
22 #include <asm/unaligned.h>
23 #include <command.h>
24 #include <fdtdec.h>
25 #include <ide.h>
26 #include <malloc.h>
27 #include <memalign.h>
28 #include <part_efi.h>
29 #include <dm/ofnode.h>
30 #include <linux/compiler.h>
31 #include <linux/ctype.h>
32 #include <u-boot/crc.h>
33
34 /* GUID for basic data partitons */
35 #if CONFIG_IS_ENABLED(EFI_PARTITION)
36 static const efi_guid_t partition_basic_data_guid = PARTITION_BASIC_DATA_GUID;
37 #endif
38
39 /**
40  * efi_crc32() - EFI version of crc32 function
41  * @buf: buffer to calculate crc32 of
42  * @len - length of buf
43  *
44  * Description: Returns EFI-style CRC32 value for @buf
45  */
46 static inline u32 efi_crc32(const void *buf, u32 len)
47 {
48         return crc32(0, buf, len);
49 }
50
51 /*
52  * Private function prototypes
53  */
54
55 static int pmbr_part_valid(struct partition *part);
56 static int is_pmbr_valid(legacy_mbr * mbr);
57 static int is_gpt_valid(struct blk_desc *desc, u64 lba, gpt_header *pgpt_head,
58                         gpt_entry **pgpt_pte);
59 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *desc,
60                                          gpt_header *pgpt_head);
61 static int is_pte_valid(gpt_entry * pte);
62 static int find_valid_gpt(struct blk_desc *desc, gpt_header *gpt_head,
63                           gpt_entry **pgpt_pte);
64
65 static char *print_efiname(gpt_entry *pte)
66 {
67         static char name[PARTNAME_SZ + 1];
68         int i;
69         for (i = 0; i < PARTNAME_SZ; i++) {
70                 u8 c;
71                 c = pte->partition_name[i] & 0xff;
72                 c = (c && !isprint(c)) ? '.' : c;
73                 name[i] = c;
74         }
75         name[PARTNAME_SZ] = 0;
76         return name;
77 }
78
79 static const efi_guid_t system_guid = PARTITION_SYSTEM_GUID;
80
81 static int get_bootable(gpt_entry *p)
82 {
83         int ret = 0;
84
85         if (!memcmp(&p->partition_type_guid, &system_guid, sizeof(efi_guid_t)))
86                 ret |=  PART_EFI_SYSTEM_PARTITION;
87         if (p->attributes.fields.legacy_bios_bootable)
88                 ret |=  PART_BOOTABLE;
89         return ret;
90 }
91
92 static int validate_gpt_header(gpt_header *gpt_h, lbaint_t lba,
93                 lbaint_t lastlba)
94 {
95         uint32_t crc32_backup = 0;
96         uint32_t calc_crc32;
97
98         /* Check the GPT header signature */
99         if (le64_to_cpu(gpt_h->signature) != GPT_HEADER_SIGNATURE_UBOOT) {
100                 log_debug("%s signature is wrong: %#llX != %#llX\n",
101                           "GUID Partition Table Header",
102                           le64_to_cpu(gpt_h->signature),
103                           GPT_HEADER_SIGNATURE_UBOOT);
104                 return -1;
105         }
106
107         /* Check the GUID Partition Table CRC */
108         memcpy(&crc32_backup, &gpt_h->header_crc32, sizeof(crc32_backup));
109         memset(&gpt_h->header_crc32, 0, sizeof(gpt_h->header_crc32));
110
111         calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
112                 le32_to_cpu(gpt_h->header_size));
113
114         memcpy(&gpt_h->header_crc32, &crc32_backup, sizeof(crc32_backup));
115
116         if (calc_crc32 != le32_to_cpu(crc32_backup)) {
117                 log_debug("%s: CRC is wrong: %#x != %#x\n",
118                           "GUID Partition Table Header",
119                           le32_to_cpu(crc32_backup), calc_crc32);
120                 return -1;
121         }
122
123         /*
124          * Check that the my_lba entry points to the LBA that contains the GPT
125          */
126         if (le64_to_cpu(gpt_h->my_lba) != lba) {
127                 log_debug("GPT: my_lba incorrect: %llX != " LBAF "\n",
128                           le64_to_cpu(gpt_h->my_lba), lba);
129                 return -1;
130         }
131
132         /*
133          * Check that the first_usable_lba and that the last_usable_lba are
134          * within the disk.
135          */
136         if (le64_to_cpu(gpt_h->first_usable_lba) > lastlba) {
137                 log_debug("GPT: first_usable_lba incorrect: %llX > " LBAF "\n",
138                           le64_to_cpu(gpt_h->first_usable_lba), lastlba);
139                 return -1;
140         }
141         if (le64_to_cpu(gpt_h->last_usable_lba) > lastlba) {
142                 log_debug("GPT: last_usable_lba incorrect: %llX > " LBAF "\n",
143                           le64_to_cpu(gpt_h->last_usable_lba), lastlba);
144                 return -1;
145         }
146
147         debug("GPT: first_usable_lba: %llX last_usable_lba: %llX last lba: "
148               LBAF "\n", le64_to_cpu(gpt_h->first_usable_lba),
149               le64_to_cpu(gpt_h->last_usable_lba), lastlba);
150
151         return 0;
152 }
153
154 static int validate_gpt_entries(gpt_header *gpt_h, gpt_entry *gpt_e)
155 {
156         uint32_t calc_crc32;
157
158         /* Check the GUID Partition Table Entry Array CRC */
159         calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
160                 le32_to_cpu(gpt_h->num_partition_entries) *
161                 le32_to_cpu(gpt_h->sizeof_partition_entry));
162
163         if (calc_crc32 != le32_to_cpu(gpt_h->partition_entry_array_crc32)) {
164                 log_debug("%s: %#x != %#x\n",
165                           "GUID Partition Table Entry Array CRC is wrong",
166                           le32_to_cpu(gpt_h->partition_entry_array_crc32),
167                           calc_crc32);
168                 return -1;
169         }
170
171         return 0;
172 }
173
174 static void prepare_backup_gpt_header(gpt_header *gpt_h)
175 {
176         uint32_t calc_crc32;
177         uint64_t val;
178
179         /* recalculate the values for the Backup GPT Header */
180         val = le64_to_cpu(gpt_h->my_lba);
181         gpt_h->my_lba = gpt_h->alternate_lba;
182         gpt_h->alternate_lba = cpu_to_le64(val);
183         gpt_h->partition_entry_lba =
184                         cpu_to_le64(le64_to_cpu(gpt_h->last_usable_lba) + 1);
185         gpt_h->header_crc32 = 0;
186
187         calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
188                                le32_to_cpu(gpt_h->header_size));
189         gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
190 }
191
192 #if CONFIG_IS_ENABLED(EFI_PARTITION)
193 /*
194  * Public Functions (include/part.h)
195  */
196
197 /*
198  * UUID is displayed as 32 hexadecimal digits, in 5 groups,
199  * separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters
200  */
201 int get_disk_guid(struct blk_desc *desc, char *guid)
202 {
203         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, desc->blksz);
204         gpt_entry *gpt_pte = NULL;
205         unsigned char *guid_bin;
206
207         /* This function validates AND fills in the GPT header and PTE */
208         if (find_valid_gpt(desc, gpt_head, &gpt_pte) != 1)
209                 return -EINVAL;
210
211         guid_bin = gpt_head->disk_guid.b;
212         uuid_bin_to_str(guid_bin, guid, UUID_STR_FORMAT_GUID);
213
214         /* Remember to free pte */
215         free(gpt_pte);
216         return 0;
217 }
218
219 void part_print_efi(struct blk_desc *desc)
220 {
221         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, desc->blksz);
222         gpt_entry *gpt_pte = NULL;
223         int i = 0;
224         unsigned char *uuid;
225
226         /* This function validates AND fills in the GPT header and PTE */
227         if (find_valid_gpt(desc, gpt_head, &gpt_pte) != 1)
228                 return;
229
230         debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
231
232         printf("Part\tStart LBA\tEnd LBA\t\tName\n");
233         printf("\tAttributes\n");
234         printf("\tType GUID\n");
235         printf("\tPartition GUID\n");
236
237         for (i = 0; i < le32_to_cpu(gpt_head->num_partition_entries); i++) {
238                 /* Skip invalid PTE */
239                 if (!is_pte_valid(&gpt_pte[i]))
240                         continue;
241
242                 printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i + 1),
243                         le64_to_cpu(gpt_pte[i].starting_lba),
244                         le64_to_cpu(gpt_pte[i].ending_lba),
245                         print_efiname(&gpt_pte[i]));
246                 printf("\tattrs:\t0x%016llx\n", gpt_pte[i].attributes.raw);
247                 uuid = (unsigned char *)gpt_pte[i].partition_type_guid.b;
248                 if (IS_ENABLED(CONFIG_PARTITION_TYPE_GUID))
249                         printf("\ttype:\t%pUl\n\t\t(%pUs)\n", uuid, uuid);
250                 else
251                         printf("\ttype:\t%pUl\n", uuid);
252                 uuid = (unsigned char *)gpt_pte[i].unique_partition_guid.b;
253                 printf("\tguid:\t%pUl\n", uuid);
254         }
255
256         /* Remember to free pte */
257         free(gpt_pte);
258         return;
259 }
260
261 int part_get_info_efi(struct blk_desc *desc, int part,
262                       struct disk_partition *info)
263 {
264         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, desc->blksz);
265         gpt_entry *gpt_pte = NULL;
266
267         /* "part" argument must be at least 1 */
268         if (part < 1) {
269                 log_debug("Invalid Argument(s)\n");
270                 return -EINVAL;
271         }
272
273         /* This function validates AND fills in the GPT header and PTE */
274         if (find_valid_gpt(desc, gpt_head, &gpt_pte) != 1)
275                 return -EINVAL;
276
277         if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
278             !is_pte_valid(&gpt_pte[part - 1])) {
279                 log_debug("Invalid partition number %d\n", part);
280                 free(gpt_pte);
281                 return -EPERM;
282         }
283
284         /* The 'lbaint_t' casting may limit the maximum disk size to 2 TB */
285         info->start = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].starting_lba);
286         /* The ending LBA is inclusive, to calculate size, add 1 to it */
287         info->size = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1
288                      - info->start;
289         info->blksz = desc->blksz;
290
291         snprintf((char *)info->name, sizeof(info->name), "%s",
292                  print_efiname(&gpt_pte[part - 1]));
293         strcpy((char *)info->type, "U-Boot");
294         info->bootable = get_bootable(&gpt_pte[part - 1]);
295         if (CONFIG_IS_ENABLED(PARTITION_UUIDS)) {
296                 uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b,
297                                 (char *)disk_partition_uuid(info),
298                                 UUID_STR_FORMAT_GUID);
299         }
300         if (IS_ENABLED(CONFIG_PARTITION_TYPE_GUID)) {
301                 uuid_bin_to_str(gpt_pte[part - 1].partition_type_guid.b,
302                                 (char *)disk_partition_type_uuid(info),
303                                 UUID_STR_FORMAT_GUID);
304         }
305
306         log_debug("start 0x" LBAF ", size 0x" LBAF ", name %s\n", info->start,
307                   info->size, info->name);
308
309         /* Remember to free pte */
310         free(gpt_pte);
311         return 0;
312 }
313
314 static int part_test_efi(struct blk_desc *desc)
315 {
316         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, desc->blksz);
317
318         /* Read legacy MBR from block 0 and validate it */
319         if ((blk_dread(desc, 0, 1, (ulong *)legacymbr) != 1)
320                 || (is_pmbr_valid(legacymbr) != 1)) {
321                 return -1;
322         }
323         return 0;
324 }
325
326 /**
327  * set_protective_mbr(): Set the EFI protective MBR
328  * @param desc - block device descriptor
329  *
330  * Return: - zero on success, otherwise error
331  */
332 static int set_protective_mbr(struct blk_desc *desc)
333 {
334         /* Setup the Protective MBR */
335         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, p_mbr, 1, desc->blksz);
336         if (p_mbr == NULL) {
337                 log_debug("calloc failed!\n");
338                 return -ENOMEM;
339         }
340
341         /* Read MBR to backup boot code if it exists */
342         if (blk_dread(desc, 0, 1, p_mbr) != 1) {
343                 log_debug("** Can't read from device %d **\n",
344                           desc->devnum);
345                 return -EIO;
346         }
347
348         /* Clear all data in MBR except of backed up boot code */
349         memset((char *)p_mbr + MSDOS_MBR_BOOT_CODE_SIZE, 0, sizeof(*p_mbr) -
350                         MSDOS_MBR_BOOT_CODE_SIZE);
351
352         /* Append signature */
353         p_mbr->signature = MSDOS_MBR_SIGNATURE;
354         p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
355         p_mbr->partition_record[0].start_sect = 1;
356         p_mbr->partition_record[0].nr_sects = (u32)desc->lba - 1;
357
358         /* Write MBR sector to the MMC device */
359         if (blk_dwrite(desc, 0, 1, p_mbr) != 1) {
360                 log_debug("** Can't write to device %d **\n", desc->devnum);
361                 return -EIO;
362         }
363
364         return 0;
365 }
366
367 int write_gpt_table(struct blk_desc *desc, gpt_header *gpt_h, gpt_entry *gpt_e)
368 {
369         const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
370                                            * sizeof(gpt_entry)), desc);
371         u32 calc_crc32;
372
373         debug("max lba: %x\n", (u32)desc->lba);
374         /* Setup the Protective MBR */
375         if (set_protective_mbr(desc) < 0)
376                 goto err;
377
378         /* Generate CRC for the Primary GPT Header */
379         calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
380                               le32_to_cpu(gpt_h->num_partition_entries) *
381                               le32_to_cpu(gpt_h->sizeof_partition_entry));
382         gpt_h->partition_entry_array_crc32 = cpu_to_le32(calc_crc32);
383
384         calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
385                               le32_to_cpu(gpt_h->header_size));
386         gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
387
388         /* Write the First GPT to the block right after the Legacy MBR */
389         if (blk_dwrite(desc, 1, 1, gpt_h) != 1)
390                 goto err;
391
392         if (blk_dwrite(desc, le64_to_cpu(gpt_h->partition_entry_lba),
393                        pte_blk_cnt, gpt_e) != pte_blk_cnt)
394                 goto err;
395
396         prepare_backup_gpt_header(gpt_h);
397
398         if (blk_dwrite(desc, (lbaint_t)le64_to_cpu(gpt_h->last_usable_lba)
399                        + 1, pte_blk_cnt, gpt_e) != pte_blk_cnt)
400                 goto err;
401
402         if (blk_dwrite(desc, (lbaint_t)le64_to_cpu(gpt_h->my_lba), 1,
403                        gpt_h) != 1)
404                 goto err;
405
406         debug("GPT successfully written to block device!\n");
407         return 0;
408
409  err:
410         log_debug("** Can't write to device %d **\n", desc->devnum);
411         return -EIO;
412 }
413
414 int gpt_fill_pte(struct blk_desc *desc,
415                  gpt_header *gpt_h, gpt_entry *gpt_e,
416                  struct disk_partition *partitions, int parts)
417 {
418         lbaint_t offset = (lbaint_t)le64_to_cpu(gpt_h->first_usable_lba);
419         lbaint_t last_usable_lba = (lbaint_t)
420                         le64_to_cpu(gpt_h->last_usable_lba);
421         int i, k;
422         size_t efiname_len, dosname_len;
423         unsigned char *bin_uuid;
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                 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                         log_debug("Partition overlap\n");
455                         return -ENOSPC;
456                 }
457
458                 gpt_e[i].starting_lba = cpu_to_le64(start);
459
460                 if (offset > (last_usable_lba + 1)) {
461                         log_debug("Partitions layout exceeds disk size\n");
462                         return -E2BIG;
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                                 log_debug("Partition no. %d: invalid type guid: %s\n",
478                                           i, str_type_guid);
479                                 return -EINVAL;
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                         const char *str_uuid;
494
495                         str_uuid = disk_partition_uuid(&partitions[i]);
496                         bin_uuid = gpt_e[i].unique_partition_guid.b;
497
498                         if (uuid_str_to_bin(str_uuid, bin_uuid,
499                                             UUID_STR_FORMAT_GUID)) {
500                                 log_debug("Partition no. %d: invalid guid: %s\n",
501                                           i, str_uuid);
502                                 return -EINVAL;
503                         }
504                 }
505
506                 /* partition attributes */
507                 memset(&gpt_e[i].attributes, 0,
508                        sizeof(gpt_entry_attributes));
509
510                 if (partitions[i].bootable & PART_BOOTABLE)
511                         gpt_e[i].attributes.fields.legacy_bios_bootable = 1;
512
513                 /* partition name */
514                 efiname_len = sizeof(gpt_e[i].partition_name)
515                         / sizeof(efi_char16_t);
516                 dosname_len = sizeof(partitions[i].name);
517
518                 memset(gpt_e[i].partition_name, 0,
519                        sizeof(gpt_e[i].partition_name));
520
521                 for (k = 0; k < min(dosname_len, efiname_len); k++)
522                         gpt_e[i].partition_name[k] =
523                                 (efi_char16_t)(partitions[i].name[k]);
524
525                 debug("%s: name: %s offset[%d]: 0x" LBAF
526                       " size[%d]: 0x" LBAF "\n",
527                       __func__, partitions[i].name, i,
528                       offset, i, size);
529         }
530
531         return 0;
532 }
533
534 static uint32_t partition_entries_offset(struct blk_desc *desc)
535 {
536         uint32_t offset_blks = 2;
537         uint32_t __maybe_unused offset_bytes;
538         int __maybe_unused config_offset;
539
540 #if defined(CONFIG_EFI_PARTITION_ENTRIES_OFF)
541         /*
542          * Some architectures require their SPL loader at a fixed
543          * address within the first 16KB of the disk.  To avoid an
544          * overlap with the partition entries of the EFI partition
545          * table, the first safe offset (in bytes, from the start of
546          * the disk) for the entries can be set in
547          * CONFIG_EFI_PARTITION_ENTRIES_OFF.
548          */
549         offset_bytes =
550                 PAD_TO_BLOCKSIZE(CONFIG_EFI_PARTITION_ENTRIES_OFF, desc);
551         offset_blks = offset_bytes / desc->blksz;
552 #endif
553
554 #if defined(CONFIG_OF_CONTROL)
555         /*
556          * Allow the offset of the first partition entires (in bytes
557          * from the start of the device) to be specified as a property
558          * of the device tree '/config' node.
559          */
560         config_offset = ofnode_conf_read_int(
561                 "u-boot,efi-partition-entries-offset", -EINVAL);
562         if (config_offset != -EINVAL) {
563                 offset_bytes = PAD_TO_BLOCKSIZE(config_offset, desc);
564                 offset_blks = offset_bytes / desc->blksz;
565         }
566 #endif
567
568         debug("efi: partition entries offset (in blocks): %d\n", offset_blks);
569
570         /*
571          * The earliest LBA this can be at is LBA#2 (i.e. right behind
572          * the (protective) MBR and the GPT header.
573          */
574         if (offset_blks < 2)
575                 offset_blks = 2;
576
577         return offset_blks;
578 }
579
580 int gpt_fill_header(struct blk_desc *desc, gpt_header *gpt_h, char *str_guid,
581                     int parts_count)
582 {
583         gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE_UBOOT);
584         gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
585         gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
586         gpt_h->my_lba = cpu_to_le64(1);
587         gpt_h->alternate_lba = cpu_to_le64(desc->lba - 1);
588         gpt_h->last_usable_lba = cpu_to_le64(desc->lba - 34);
589         gpt_h->partition_entry_lba =
590                 cpu_to_le64(partition_entries_offset(desc));
591         gpt_h->first_usable_lba =
592                 cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 32);
593         gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
594         gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
595         gpt_h->header_crc32 = 0;
596         gpt_h->partition_entry_array_crc32 = 0;
597
598         if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
599                 return -1;
600
601         return 0;
602 }
603
604 int gpt_restore(struct blk_desc *desc, char *str_disk_guid,
605                 struct disk_partition *partitions, int parts_count)
606 {
607         gpt_header *gpt_h;
608         gpt_entry *gpt_e;
609         int ret, size;
610
611         size = PAD_TO_BLOCKSIZE(sizeof(gpt_header), desc);
612         gpt_h = malloc_cache_aligned(size);
613         if (gpt_h == NULL) {
614                 log_debug("calloc failed!\n");
615                 return -ENOMEM;
616         }
617         memset(gpt_h, 0, size);
618
619         size = PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS * sizeof(gpt_entry),
620                                 desc);
621         gpt_e = malloc_cache_aligned(size);
622         if (gpt_e == NULL) {
623                 log_debug("calloc failed!\n");
624                 free(gpt_h);
625                 return -ENOMEM;
626         }
627         memset(gpt_e, 0, size);
628
629         /* Generate Primary GPT header (LBA1) */
630         ret = gpt_fill_header(desc, gpt_h, str_disk_guid, parts_count);
631         if (ret)
632                 goto err;
633
634         /* Generate partition entries */
635         ret = gpt_fill_pte(desc, gpt_h, gpt_e, partitions, parts_count);
636         if (ret)
637                 goto err;
638
639         /* Write GPT partition table */
640         ret = write_gpt_table(desc, gpt_h, gpt_e);
641
642 err:
643         free(gpt_e);
644         free(gpt_h);
645         return ret;
646 }
647
648 /**
649  * gpt_convert_efi_name_to_char() - convert u16 string to char string
650  *
651  * TODO: this conversion only supports ANSI characters
652  *
653  * @s:  target buffer
654  * @es: u16 string to be converted
655  * @n:  size of target buffer
656  */
657 static void gpt_convert_efi_name_to_char(char *s, void *es, int n)
658 {
659         char *ess = es;
660         int i, j;
661
662         memset(s, '\0', n);
663
664         for (i = 0, j = 0; j < n; i += 2, j++) {
665                 s[j] = ess[i];
666                 if (!ess[i])
667                         return;
668         }
669 }
670
671 int gpt_verify_headers(struct blk_desc *desc, gpt_header *gpt_head,
672                        gpt_entry **gpt_pte)
673 {
674         /*
675          * This function validates AND
676          * fills in the GPT header and PTE
677          */
678         if (is_gpt_valid(desc,
679                          GPT_PRIMARY_PARTITION_TABLE_LBA,
680                          gpt_head, gpt_pte) != 1) {
681                 log_debug("Invalid GPT\n");
682                 return -1;
683         }
684
685         /* Free pte before allocating again */
686         free(*gpt_pte);
687
688         /*
689          * Check that the alternate_lba entry points to the last LBA
690          */
691         if (le64_to_cpu(gpt_head->alternate_lba) != (desc->lba - 1)) {
692                 log_debug("Misplaced Backup GPT\n");
693                 return -1;
694         }
695
696         if (is_gpt_valid(desc, (desc->lba - 1),
697                          gpt_head, gpt_pte) != 1) {
698                 log_debug("Invalid Backup GPT\n");
699                 return -1;
700         }
701
702         return 0;
703 }
704
705 static void restore_primary_gpt_header(gpt_header *gpt_h, struct blk_desc *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(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 *desc, gpt_header *gpt_h,
724                                gpt_entry *gpt_e)
725 {
726         const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
727                                            * sizeof(gpt_entry)), desc);
728         lbaint_t start;
729         int ret = 0;
730
731         start = le64_to_cpu(gpt_h->my_lba);
732         if (blk_dwrite(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(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 *desc)
748 {
749         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_h1, 1, desc->blksz);
750         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_h2, 1, 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(desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
756                                      gpt_h1, &gpt_e1);
757         is_gpt2_valid = is_gpt_valid(desc, 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(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, desc);
773                 ret = write_one_gpt_table(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 *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(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 *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 * desc->blksz);
876         if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
877                                 desc->lba))
878                 return -1;
879
880         /* determine start of GPT Entries in the buffer */
881         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
882                        desc->blksz);
883         if (validate_gpt_entries(gpt_h, gpt_e))
884                 return -1;
885
886         return 0;
887 }
888
889 int write_mbr_and_gpt_partitions(struct blk_desc *desc, void *buf)
890 {
891         gpt_header *gpt_h;
892         gpt_entry *gpt_e;
893         int gpt_e_blk_cnt;
894         lbaint_t lba;
895         int cnt;
896
897         if (is_valid_gpt_buf(desc, buf))
898                 return -1;
899
900         /* determine start of GPT Header in the buffer */
901         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA * desc->blksz);
902
903         /* determine start of GPT Entries in the buffer */
904         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) * desc->blksz);
905         gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
906                                    le32_to_cpu(gpt_h->sizeof_partition_entry)),
907                                   desc);
908
909         /* write MBR */
910         lba = 0;        /* MBR is always at 0 */
911         cnt = 1;        /* MBR (1 block) */
912         if (blk_dwrite(desc, lba, cnt, buf) != cnt) {
913                 log_debug("failed writing '%s' (%d blks at 0x" LBAF ")\n",
914                           "MBR", cnt, lba);
915                 return 1;
916         }
917
918         /* write Primary GPT */
919         lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
920         cnt = 1;        /* GPT Header (1 block) */
921         if (blk_dwrite(desc, lba, cnt, gpt_h) != cnt) {
922                 log_debug("failed writing '%s' (%d blks at 0x" LBAF ")\n",
923                           "Primary GPT Header", cnt, lba);
924                 return 1;
925         }
926
927         lba = le64_to_cpu(gpt_h->partition_entry_lba);
928         cnt = gpt_e_blk_cnt;
929         if (blk_dwrite(desc, lba, cnt, gpt_e) != cnt) {
930                 log_debug("failed writing '%s' (%d blks at 0x" LBAF ")\n",
931                           "Primary GPT Entries", cnt, lba);
932                 return 1;
933         }
934
935         prepare_backup_gpt_header(gpt_h);
936
937         /* write Backup GPT */
938         lba = le64_to_cpu(gpt_h->partition_entry_lba);
939         cnt = gpt_e_blk_cnt;
940         if (blk_dwrite(desc, lba, cnt, gpt_e) != cnt) {
941                 log_debug("failed writing '%s' (%d blks at 0x" LBAF ")\n",
942                           "Backup GPT Entries", cnt, lba);
943                 return 1;
944         }
945
946         lba = le64_to_cpu(gpt_h->my_lba);
947         cnt = 1;        /* GPT Header (1 block) */
948         if (blk_dwrite(desc, lba, cnt, gpt_h) != cnt) {
949                 log_debug("failed writing '%s' (%d blks at 0x" LBAF ")\n",
950                           "Backup GPT Header", cnt, lba);
951                 return 1;
952         }
953
954         /* Update the partition table entries*/
955         part_init(desc);
956
957         return 0;
958 }
959 #endif
960
961 /*
962  * Private functions
963  */
964 /*
965  * pmbr_part_valid(): Check for EFI partition signature
966  *
967  * Returns: 1 if EFI GPT partition type is found.
968  */
969 static int pmbr_part_valid(struct partition *part)
970 {
971         if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
972                 get_unaligned_le32(&part->start_sect) == 1UL) {
973                 return 1;
974         }
975
976         return 0;
977 }
978
979 /*
980  * is_pmbr_valid(): test Protective MBR for validity
981  *
982  * @mbr: Pointer to Master Boot-Record data
983  *
984  * Returns: 1 if PMBR is valid, 0 otherwise.
985  * Validity depends on two things:
986  *  1) MSDOS signature is in the last two bytes of the MBR
987  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
988  */
989 static int is_pmbr_valid(legacy_mbr *mbr)
990 {
991         uint sig = le16_to_cpu(mbr->signature);
992         int i = 0;
993
994         if (sig != MSDOS_MBR_SIGNATURE) {
995                 log_debug("Invalid signature %x\n", sig);
996                 return 0;
997         }
998         log_debug("Signature %x valid\n", sig);
999
1000         for (i = 0; i < 4; i++) {
1001                 if (pmbr_part_valid(&mbr->partition_record[i])) {
1002                         return 1;
1003                 }
1004         }
1005         return 0;
1006 }
1007
1008 /**
1009  * is_gpt_valid() - tests one GPT header and PTEs for validity
1010  *
1011  * lba is the logical block address of the GPT header to test
1012  * gpt is a GPT header ptr, filled on return.
1013  * ptes is a PTEs ptr, filled on return.
1014  *
1015  * Description: returns 1 if valid,  0 on error, 2 if ignored header
1016  * If valid, returns pointers to PTEs.
1017  */
1018 static int is_gpt_valid(struct blk_desc *desc, u64 lba, gpt_header *pgpt_head,
1019                         gpt_entry **pgpt_pte)
1020 {
1021         /* Confirm valid arguments prior to allocation. */
1022         if (!desc || !pgpt_head) {
1023                 log_debug("Invalid Argument(s)\n");
1024                 return 0;
1025         }
1026
1027         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, mbr, 1, desc->blksz);
1028
1029         /* Read MBR Header from device */
1030         if (blk_dread(desc, 0, 1, (ulong *)mbr) != 1) {
1031                 log_debug("Can't read MBR header\n");
1032                 return 0;
1033         }
1034
1035         /* Read GPT Header from device */
1036         if (blk_dread(desc, (lbaint_t)lba, 1, pgpt_head) != 1) {
1037                 log_debug("Can't read GPT header\n");
1038                 return 0;
1039         }
1040
1041         /* Invalid but nothing to yell about. */
1042         if (le64_to_cpu(pgpt_head->signature) == GPT_HEADER_CHROMEOS_IGNORE) {
1043                 log_debug("ChromeOS 'IGNOREME' GPT header found and ignored\n");
1044                 return 2;
1045         }
1046
1047         if (validate_gpt_header(pgpt_head, (lbaint_t)lba, desc->lba))
1048                 return 0;
1049
1050         if (desc->sig_type == SIG_TYPE_NONE) {
1051                 efi_guid_t empty = {};
1052                 if (memcmp(&pgpt_head->disk_guid, &empty, sizeof(empty))) {
1053                         desc->sig_type = SIG_TYPE_GUID;
1054                         memcpy(&desc->guid_sig, &pgpt_head->disk_guid,
1055                                sizeof(empty));
1056                 } else if (mbr->unique_mbr_signature != 0) {
1057                         desc->sig_type = SIG_TYPE_MBR;
1058                         desc->mbr_sig = mbr->unique_mbr_signature;
1059                 }
1060         }
1061
1062         /* Read and allocate Partition Table Entries */
1063         *pgpt_pte = alloc_read_gpt_entries(desc, pgpt_head);
1064         if (!*pgpt_pte)
1065                 return 0;
1066
1067         if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
1068                 free(*pgpt_pte);
1069                 return 0;
1070         }
1071
1072         /* We're done, all's well */
1073         return 1;
1074 }
1075
1076 /**
1077  * find_valid_gpt() - finds a valid GPT header and PTEs
1078  *
1079  * gpt is a GPT header ptr, filled on return.
1080  * ptes is a PTEs ptr, filled on return.
1081  *
1082  * Description: returns 1 if found a valid gpt,  0 on error.
1083  * If valid, returns pointers to PTEs.
1084  */
1085 static int find_valid_gpt(struct blk_desc *desc, gpt_header *gpt_head,
1086                           gpt_entry **pgpt_pte)
1087 {
1088         int r;
1089
1090         r = is_gpt_valid(desc, GPT_PRIMARY_PARTITION_TABLE_LBA, gpt_head,
1091                          pgpt_pte);
1092
1093         if (r != 1) {
1094                 if (r != 2)
1095                         log_debug("Invalid GPT\n");
1096
1097                 if (is_gpt_valid(desc, desc->lba - 1, gpt_head, pgpt_pte)
1098                     != 1) {
1099                         log_debug("Invalid Backup GPT\n");
1100                         return 0;
1101                 }
1102                 if (r != 2)
1103                         log_debug("        Using Backup GPT\n");
1104         }
1105         return 1;
1106 }
1107
1108 /**
1109  * alloc_read_gpt_entries(): reads partition entries from disk
1110  * @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 *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 (!desc || !pgpt_head) {
1125                 log_debug("Invalid Argument(s)\n");
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         log_debug("count = %u * %u = %lu\n",
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, desc));
1141         }
1142
1143         if (count == 0 || pte == NULL) {
1144                 log_debug("ERROR: Can't allocate %#lX bytes for GPT Entries\n",
1145                           (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, desc);
1152         if (blk_dread(desc, blk, (lbaint_t)blk_cnt, pte) != blk_cnt) {
1153                 log_debug("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                 log_debug("Invalid Argument(s)\n");
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                 log_debug("Found an unused PTE GUID at 0x%08X\n",
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 };
This page took 0.097482 seconds and 4 git commands to generate.