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 #ifdef CONFIG_HAVE_BLOCK_DEVICE
  32
  33 /* GUID for basic data partitons */
  34 #if CONFIG_IS_ENABLED(EFI_PARTITION)
  35 static const efi_guid_t partition_basic_data_guid = PARTITION_BASIC_DATA_GUID;
  36 #endif
  37
  38 /**
  39  * efi_crc32() - EFI version of crc32 function
  40  * @buf: buffer to calculate crc32 of
  41  * @len - length of buf
  42  *
  43  * Description: Returns EFI-style CRC32 value for @buf
  44  */
  45 static inline u32 efi_crc32(const void *buf, u32 len)
  46 {
  47         return crc32(0, buf, len);
  48 }
  49
  50 /*
  51  * Private function prototypes
  52  */
  53
  54 static int pmbr_part_valid(struct partition *part);
  55 static int is_pmbr_valid(legacy_mbr * mbr);
  56 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
  57                                 gpt_header *pgpt_head, gpt_entry **pgpt_pte);
  58 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
  59                                          gpt_header *pgpt_head);
  60 static int is_pte_valid(gpt_entry * pte);
  61 static int find_valid_gpt(struct blk_desc *dev_desc, gpt_header *gpt_head,
  62                           gpt_entry **pgpt_pte);
  63
  64 static char *print_efiname(gpt_entry *pte)
  65 {
  66         static char name[PARTNAME_SZ + 1];
  67         int i;
  68         for (i = 0; i < PARTNAME_SZ; i++) {
  69                 u8 c;
  70                 c = pte->partition_name[i] & 0xff;
  71                 c = (c && !isprint(c)) ? '.' : c;
  72                 name[i] = c;
  73         }
  74         name[PARTNAME_SZ] = 0;
  75         return name;
  76 }
  77
  78 static const efi_guid_t system_guid = PARTITION_SYSTEM_GUID;
  79
  80 static int get_bootable(gpt_entry *p)
  81 {
  82         int ret = 0;
  83
  84         if (!memcmp(&p->partition_type_guid, &system_guid, sizeof(efi_guid_t)))
  85                 ret |=  PART_EFI_SYSTEM_PARTITION;
  86         if (p->attributes.fields.legacy_bios_bootable)
  87                 ret |=  PART_BOOTABLE;
  88         return ret;
  89 }
  90
  91 static int validate_gpt_header(gpt_header *gpt_h, lbaint_t lba,
  92                 lbaint_t lastlba)
  93 {
  94         uint32_t crc32_backup = 0;
  95         uint32_t calc_crc32;
  96
  97         /* Check the GPT header signature */
  98         if (le64_to_cpu(gpt_h->signature) != GPT_HEADER_SIGNATURE_UBOOT) {
  99                 printf("%s signature is wrong: 0x%llX != 0x%llX\n",
 100                        "GUID Partition Table Header",
 101                        le64_to_cpu(gpt_h->signature),
 102                        GPT_HEADER_SIGNATURE_UBOOT);
 103                 return -1;
 104         }
 105
 106         /* Check the GUID Partition Table CRC */
 107         memcpy(&crc32_backup, &gpt_h->header_crc32, sizeof(crc32_backup));
 108         memset(&gpt_h->header_crc32, 0, sizeof(gpt_h->header_crc32));
 109
 110         calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
 111                 le32_to_cpu(gpt_h->header_size));
 112
 113         memcpy(&gpt_h->header_crc32, &crc32_backup, sizeof(crc32_backup));
 114
 115         if (calc_crc32 != le32_to_cpu(crc32_backup)) {
 116                 printf("%s CRC is wrong: 0x%x != 0x%x\n",
 117                        "GUID Partition Table Header",
 118                        le32_to_cpu(crc32_backup), calc_crc32);
 119                 return -1;
 120         }
 121
 122         /*
 123          * Check that the my_lba entry points to the LBA that contains the GPT
 124          */
 125         if (le64_to_cpu(gpt_h->my_lba) != lba) {
 126                 printf("GPT: my_lba incorrect: %llX != " LBAF "\n",
 127                        le64_to_cpu(gpt_h->my_lba),
 128                        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                 printf("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                 printf("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                 printf("%s: 0x%x != 0x%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 * dev_desc, char *guid)
 202 {
 203         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_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(dev_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 *dev_desc)
 220 {
 221         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_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(dev_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 (CONFIG_IS_ENABLED(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 *dev_desc, int part,
 262                       struct disk_partition *info)
 263 {
 264         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
 265         gpt_entry *gpt_pte = NULL;
 266
 267         /* "part" argument must be at least 1 */
 268         if (part < 1) {
 269                 printf("%s: Invalid Argument(s)\n", __func__);
 270                 return -1;
 271         }
 272
 273         /* This function validates AND fills in the GPT header and PTE */
 274         if (find_valid_gpt(dev_desc, gpt_head, &gpt_pte) != 1)
 275                 return -1;
 276
 277         if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
 278             !is_pte_valid(&gpt_pte[part - 1])) {
 279                 debug("%s: *** ERROR: Invalid partition number %d ***\n",
 280                         __func__, part);
 281                 free(gpt_pte);
 282                 return -1;
 283         }
 284
 285         /* The 'lbaint_t' casting may limit the maximum disk size to 2 TB */
 286         info->start = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].starting_lba);
 287         /* The ending LBA is inclusive, to calculate size, add 1 to it */
 288         info->size = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1
 289                      - info->start;
 290         info->blksz = dev_desc->blksz;
 291
 292         snprintf((char *)info->name, sizeof(info->name), "%s",
 293                  print_efiname(&gpt_pte[part - 1]));
 294         strcpy((char *)info->type, "U-Boot");
 295         info->bootable = get_bootable(&gpt_pte[part - 1]);
 296 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 297         uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b, info->uuid,
 298                         UUID_STR_FORMAT_GUID);
 299 #endif
 300 #ifdef CONFIG_PARTITION_TYPE_GUID
 301         uuid_bin_to_str(gpt_pte[part - 1].partition_type_guid.b,
 302                         info->type_guid, UUID_STR_FORMAT_GUID);
 303 #endif
 304
 305         debug("%s: start 0x" LBAF ", size 0x" LBAF ", name %s\n", __func__,
 306               info->start, info->size, info->name);
 307
 308         /* Remember to free pte */
 309         free(gpt_pte);
 310         return 0;
 311 }
 312
 313 static int part_test_efi(struct blk_desc *dev_desc)
 314 {
 315         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, dev_desc->blksz);
 316
 317         /* Read legacy MBR from block 0 and validate it */
 318         if ((blk_dread(dev_desc, 0, 1, (ulong *)legacymbr) != 1)
 319                 || (is_pmbr_valid(legacymbr) != 1)) {
 320                 return -1;
 321         }
 322         return 0;
 323 }
 324
 325 /**
 326  * set_protective_mbr(): Set the EFI protective MBR
 327  * @param dev_desc - block device descriptor
 328  *
 329  * Return: - zero on success, otherwise error
 330  */
 331 static int set_protective_mbr(struct blk_desc *dev_desc)
 332 {
 333         /* Setup the Protective MBR */
 334         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, p_mbr, 1, dev_desc->blksz);
 335         if (p_mbr == NULL) {
 336                 printf("%s: calloc failed!\n", __func__);
 337                 return -1;
 338         }
 339
 340         /* Read MBR to backup boot code if it exists */
 341         if (blk_dread(dev_desc, 0, 1, p_mbr) != 1) {
 342                 pr_err("** Can't read from device %d **\n", dev_desc->devnum);
 343                 return -1;
 344         }
 345
 346         /* Clear all data in MBR except of backed up boot code */
 347         memset((char *)p_mbr + MSDOS_MBR_BOOT_CODE_SIZE, 0, sizeof(*p_mbr) -
 348                         MSDOS_MBR_BOOT_CODE_SIZE);
 349
 350         /* Append signature */
 351         p_mbr->signature = MSDOS_MBR_SIGNATURE;
 352         p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
 353         p_mbr->partition_record[0].start_sect = 1;
 354         p_mbr->partition_record[0].nr_sects = (u32) dev_desc->lba - 1;
 355
 356         /* Write MBR sector to the MMC device */
 357         if (blk_dwrite(dev_desc, 0, 1, p_mbr) != 1) {
 358                 printf("** Can't write to device %d **\n",
 359                         dev_desc->devnum);
 360                 return -1;
 361         }
 362
 363         return 0;
 364 }
 365
 366 int write_gpt_table(struct blk_desc *dev_desc,
 367                 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)), dev_desc);
 371         u32 calc_crc32;
 372
 373         debug("max lba: %x\n", (u32) dev_desc->lba);
 374         /* Setup the Protective MBR */
 375         if (set_protective_mbr(dev_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(dev_desc, 1, 1, gpt_h) != 1)
 390                 goto err;
 391
 392         if (blk_dwrite(dev_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(dev_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(dev_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         printf("** Can't write to device %d **\n", dev_desc->devnum);
 411         return -1;
 412 }
 413
 414 int gpt_fill_pte(struct blk_desc *dev_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 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 424         char *str_uuid;
 425         unsigned char *bin_uuid;
 426 #endif
 427 #ifdef CONFIG_PARTITION_TYPE_GUID
 428         char *str_type_guid;
 429         unsigned char *bin_type_guid;
 430 #endif
 431         size_t hdr_start = gpt_h->my_lba;
 432         size_t hdr_end = hdr_start + 1;
 433
 434         size_t pte_start = gpt_h->partition_entry_lba;
 435         size_t pte_end = pte_start +
 436                 gpt_h->num_partition_entries * gpt_h->sizeof_partition_entry /
 437                 dev_desc->blksz;
 438
 439         for (i = 0; i < parts; i++) {
 440                 /* partition starting lba */
 441                 lbaint_t start = partitions[i].start;
 442                 lbaint_t size = partitions[i].size;
 443
 444                 if (start) {
 445                         offset = start + size;
 446                 } else {
 447                         start = offset;
 448                         offset += size;
 449                 }
 450
 451                 /*
 452                  * If our partition overlaps with either the GPT
 453                  * header, or the partition entry, reject it.
 454                  */
 455                 if (((start < hdr_end && hdr_start < (start + size)) ||
 456                      (start < pte_end && pte_start < (start + size)))) {
 457                         printf("Partition overlap\n");
 458                         return -1;
 459                 }
 460
 461                 gpt_e[i].starting_lba = cpu_to_le64(start);
 462
 463                 if (offset > (last_usable_lba + 1)) {
 464                         printf("Partitions layout exceds disk size\n");
 465                         return -1;
 466                 }
 467                 /* partition ending lba */
 468                 if ((i == parts - 1) && (size == 0))
 469                         /* extend the last partition to maximuim */
 470                         gpt_e[i].ending_lba = gpt_h->last_usable_lba;
 471                 else
 472                         gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
 473
 474 #ifdef CONFIG_PARTITION_TYPE_GUID
 475                 str_type_guid = partitions[i].type_guid;
 476                 bin_type_guid = gpt_e[i].partition_type_guid.b;
 477                 if (strlen(str_type_guid)) {
 478                         if (uuid_str_to_bin(str_type_guid, bin_type_guid,
 479                                             UUID_STR_FORMAT_GUID)) {
 480                                 printf("Partition no. %d: invalid type guid: %s\n",
 481                                        i, str_type_guid);
 482                                 return -1;
 483                         }
 484                 } else {
 485                         /* default partition type GUID */
 486                         memcpy(bin_type_guid,
 487                                &partition_basic_data_guid, 16);
 488                 }
 489 #else
 490                 /* partition type GUID */
 491                 memcpy(gpt_e[i].partition_type_guid.b,
 492                         &partition_basic_data_guid, 16);
 493 #endif
 494
 495 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 496                 str_uuid = partitions[i].uuid;
 497                 bin_uuid = gpt_e[i].unique_partition_guid.b;
 498
 499                 if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_GUID)) {
 500                         printf("Partition no. %d: invalid guid: %s\n",
 501                                 i, str_uuid);
 502                         return -1;
 503                 }
 504 #endif
 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 *dev_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, dev_desc);
 551         offset_blks = offset_bytes / dev_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, dev_desc);
 564                 offset_blks = offset_bytes / dev_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 *dev_desc, gpt_header *gpt_h,
 581                 char *str_guid, 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(dev_desc->lba - 1);
 588         gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
 589         gpt_h->partition_entry_lba =
 590                 cpu_to_le64(partition_entries_offset(dev_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 *dev_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), dev_desc);
 612         gpt_h = malloc_cache_aligned(size);
 613         if (gpt_h == NULL) {
 614                 printf("%s: calloc failed!\n", __func__);
 615                 return -1;
 616         }
 617         memset(gpt_h, 0, size);
 618
 619         size = PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS * sizeof(gpt_entry),
 620                                 dev_desc);
 621         gpt_e = malloc_cache_aligned(size);
 622         if (gpt_e == NULL) {
 623                 printf("%s: calloc failed!\n", __func__);
 624                 free(gpt_h);
 625                 return -1;
 626         }
 627         memset(gpt_e, 0, size);
 628
 629         /* Generate Primary GPT header (LBA1) */
 630         ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
 631         if (ret)
 632                 goto err;
 633
 634         /* Generate partition entries */
 635         ret = gpt_fill_pte(dev_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(dev_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 *dev_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(dev_desc,
 679                          GPT_PRIMARY_PARTITION_TABLE_LBA,
 680                          gpt_head, gpt_pte) != 1) {
 681                 printf("%s: *** ERROR: Invalid GPT ***\n",
 682                        __func__);
 683                 return -1;
 684         }
 685
 686         /* Free pte before allocating again */
 687         free(*gpt_pte);
 688
 689         /*
 690          * Check that the alternate_lba entry points to the last LBA
 691          */
 692         if (le64_to_cpu(gpt_head->alternate_lba) != (dev_desc->lba - 1)) {
 693                 printf("%s: *** ERROR: Misplaced Backup GPT ***\n",
 694                        __func__);
 695                 return -1;
 696         }
 697
 698         if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
 699                          gpt_head, gpt_pte) != 1) {
 700                 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
 701                        __func__);
 702                 return -1;
 703         }
 704
 705         return 0;
 706 }
 707
 708 int gpt_verify_partitions(struct blk_desc *dev_desc,
 709                           struct disk_partition *partitions, int parts,
 710                           gpt_header *gpt_head, gpt_entry **gpt_pte)
 711 {
 712         char efi_str[PARTNAME_SZ + 1];
 713         u64 gpt_part_size;
 714         gpt_entry *gpt_e;
 715         int ret, i;
 716
 717         ret = gpt_verify_headers(dev_desc, gpt_head, gpt_pte);
 718         if (ret)
 719                 return ret;
 720
 721         gpt_e = *gpt_pte;
 722
 723         for (i = 0; i < parts; i++) {
 724                 if (i == gpt_head->num_partition_entries) {
 725                         pr_err("More partitions than allowed!\n");
 726                         return -1;
 727                 }
 728
 729                 /* Check if GPT and ENV partition names match */
 730                 gpt_convert_efi_name_to_char(efi_str, gpt_e[i].partition_name,
 731                                              PARTNAME_SZ + 1);
 732
 733                 debug("%s: part: %2d name - GPT: %16s, ENV: %16s ",
 734                       __func__, i, efi_str, partitions[i].name);
 735
 736                 if (strncmp(efi_str, (char *)partitions[i].name,
 737                             sizeof(partitions->name))) {
 738                         pr_err("Partition name: %s does not match %s!\n",
 739                               efi_str, (char *)partitions[i].name);
 740                         return -1;
 741                 }
 742
 743                 /* Check if GPT and ENV sizes match */
 744                 gpt_part_size = le64_to_cpu(gpt_e[i].ending_lba) -
 745                         le64_to_cpu(gpt_e[i].starting_lba) + 1;
 746                 debug("size(LBA) - GPT: %8llu, ENV: %8llu ",
 747                       (unsigned long long)gpt_part_size,
 748                       (unsigned long long)partitions[i].size);
 749
 750                 if (le64_to_cpu(gpt_part_size) != partitions[i].size) {
 751                         /* We do not check the extend partition size */
 752                         if ((i == parts - 1) && (partitions[i].size == 0))
 753                                 continue;
 754
 755                         pr_err("Partition %s size: %llu does not match %llu!\n",
 756                               efi_str, (unsigned long long)gpt_part_size,
 757                               (unsigned long long)partitions[i].size);
 758                         return -1;
 759                 }
 760
 761                 /*
 762                  * Start address is optional - check only if provided
 763                  * in '$partition' variable
 764                  */
 765                 if (!partitions[i].start) {
 766                         debug("\n");
 767                         continue;
 768                 }
 769
 770                 /* Check if GPT and ENV start LBAs match */
 771                 debug("start LBA - GPT: %8llu, ENV: %8llu\n",
 772                       le64_to_cpu(gpt_e[i].starting_lba),
 773                       (unsigned long long)partitions[i].start);
 774
 775                 if (le64_to_cpu(gpt_e[i].starting_lba) != partitions[i].start) {
 776                         pr_err("Partition %s start: %llu does not match %llu!\n",
 777                               efi_str, le64_to_cpu(gpt_e[i].starting_lba),
 778                               (unsigned long long)partitions[i].start);
 779                         return -1;
 780                 }
 781         }
 782
 783         return 0;
 784 }
 785
 786 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf)
 787 {
 788         gpt_header *gpt_h;
 789         gpt_entry *gpt_e;
 790
 791         /* determine start of GPT Header in the buffer */
 792         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
 793                        dev_desc->blksz);
 794         if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
 795                                 dev_desc->lba))
 796                 return -1;
 797
 798         /* determine start of GPT Entries in the buffer */
 799         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
 800                        dev_desc->blksz);
 801         if (validate_gpt_entries(gpt_h, gpt_e))
 802                 return -1;
 803
 804         return 0;
 805 }
 806
 807 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf)
 808 {
 809         gpt_header *gpt_h;
 810         gpt_entry *gpt_e;
 811         int gpt_e_blk_cnt;
 812         lbaint_t lba;
 813         int cnt;
 814
 815         if (is_valid_gpt_buf(dev_desc, buf))
 816                 return -1;
 817
 818         /* determine start of GPT Header in the buffer */
 819         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
 820                        dev_desc->blksz);
 821
 822         /* determine start of GPT Entries in the buffer */
 823         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
 824                        dev_desc->blksz);
 825         gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
 826                                    le32_to_cpu(gpt_h->sizeof_partition_entry)),
 827                                   dev_desc);
 828
 829         /* write MBR */
 830         lba = 0;        /* MBR is always at 0 */
 831         cnt = 1;        /* MBR (1 block) */
 832         if (blk_dwrite(dev_desc, lba, cnt, buf) != cnt) {
 833                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 834                        __func__, "MBR", cnt, lba);
 835                 return 1;
 836         }
 837
 838         /* write Primary GPT */
 839         lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
 840         cnt = 1;        /* GPT Header (1 block) */
 841         if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
 842                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 843                        __func__, "Primary GPT Header", cnt, lba);
 844                 return 1;
 845         }
 846
 847         lba = le64_to_cpu(gpt_h->partition_entry_lba);
 848         cnt = gpt_e_blk_cnt;
 849         if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
 850                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 851                        __func__, "Primary GPT Entries", cnt, lba);
 852                 return 1;
 853         }
 854
 855         prepare_backup_gpt_header(gpt_h);
 856
 857         /* write Backup GPT */
 858         lba = le64_to_cpu(gpt_h->partition_entry_lba);
 859         cnt = gpt_e_blk_cnt;
 860         if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
 861                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 862                        __func__, "Backup GPT Entries", cnt, lba);
 863                 return 1;
 864         }
 865
 866         lba = le64_to_cpu(gpt_h->my_lba);
 867         cnt = 1;        /* GPT Header (1 block) */
 868         if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
 869                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 870                        __func__, "Backup GPT Header", cnt, lba);
 871                 return 1;
 872         }
 873
 874         /* Update the partition table entries*/
 875         part_init(dev_desc);
 876
 877         return 0;
 878 }
 879 #endif
 880
 881 /*
 882  * Private functions
 883  */
 884 /*
 885  * pmbr_part_valid(): Check for EFI partition signature
 886  *
 887  * Returns: 1 if EFI GPT partition type is found.
 888  */
 889 static int pmbr_part_valid(struct partition *part)
 890 {
 891         if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
 892                 get_unaligned_le32(&part->start_sect) == 1UL) {
 893                 return 1;
 894         }
 895
 896         return 0;
 897 }
 898
 899 /*
 900  * is_pmbr_valid(): test Protective MBR for validity
 901  *
 902  * Returns: 1 if PMBR is valid, 0 otherwise.
 903  * Validity depends on two things:
 904  *  1) MSDOS signature is in the last two bytes of the MBR
 905  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
 906  */
 907 static int is_pmbr_valid(legacy_mbr * mbr)
 908 {
 909         int i = 0;
 910
 911         if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
 912                 return 0;
 913
 914         for (i = 0; i < 4; i++) {
 915                 if (pmbr_part_valid(&mbr->partition_record[i])) {
 916                         return 1;
 917                 }
 918         }
 919         return 0;
 920 }
 921
 922 /**
 923  * is_gpt_valid() - tests one GPT header and PTEs for validity
 924  *
 925  * lba is the logical block address of the GPT header to test
 926  * gpt is a GPT header ptr, filled on return.
 927  * ptes is a PTEs ptr, filled on return.
 928  *
 929  * Description: returns 1 if valid,  0 on error, 2 if ignored header
 930  * If valid, returns pointers to PTEs.
 931  */
 932 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
 933                         gpt_header *pgpt_head, gpt_entry **pgpt_pte)
 934 {
 935         /* Confirm valid arguments prior to allocation. */
 936         if (!dev_desc || !pgpt_head) {
 937                 printf("%s: Invalid Argument(s)\n", __func__);
 938                 return 0;
 939         }
 940
 941         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, mbr, 1, dev_desc->blksz);
 942
 943         /* Read MBR Header from device */
 944         if (blk_dread(dev_desc, 0, 1, (ulong *)mbr) != 1) {
 945                 printf("*** ERROR: Can't read MBR header ***\n");
 946                 return 0;
 947         }
 948
 949         /* Read GPT Header from device */
 950         if (blk_dread(dev_desc, (lbaint_t)lba, 1, pgpt_head) != 1) {
 951                 printf("*** ERROR: Can't read GPT header ***\n");
 952                 return 0;
 953         }
 954
 955         /* Invalid but nothing to yell about. */
 956         if (le64_to_cpu(pgpt_head->signature) == GPT_HEADER_CHROMEOS_IGNORE) {
 957                 debug("ChromeOS 'IGNOREME' GPT header found and ignored\n");
 958                 return 2;
 959         }
 960
 961         if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->lba))
 962                 return 0;
 963
 964         if (dev_desc->sig_type == SIG_TYPE_NONE) {
 965                 efi_guid_t empty = {};
 966                 if (memcmp(&pgpt_head->disk_guid, &empty, sizeof(empty))) {
 967                         dev_desc->sig_type = SIG_TYPE_GUID;
 968                         memcpy(&dev_desc->guid_sig, &pgpt_head->disk_guid,
 969                               sizeof(empty));
 970                 } else if (mbr->unique_mbr_signature != 0) {
 971                         dev_desc->sig_type = SIG_TYPE_MBR;
 972                         dev_desc->mbr_sig = mbr->unique_mbr_signature;
 973                 }
 974         }
 975
 976         /* Read and allocate Partition Table Entries */
 977         *pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
 978         if (*pgpt_pte == NULL) {
 979                 printf("GPT: Failed to allocate memory for PTE\n");
 980                 return 0;
 981         }
 982
 983         if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
 984                 free(*pgpt_pte);
 985                 return 0;
 986         }
 987
 988         /* We're done, all's well */
 989         return 1;
 990 }
 991
 992 /**
 993  * find_valid_gpt() - finds a valid GPT header and PTEs
 994  *
 995  * gpt is a GPT header ptr, filled on return.
 996  * ptes is a PTEs ptr, filled on return.
 997  *
 998  * Description: returns 1 if found a valid gpt,  0 on error.
 999  * If valid, returns pointers to PTEs.
1000  */
1001 static int find_valid_gpt(struct blk_desc *dev_desc, gpt_header *gpt_head,
1002                           gpt_entry **pgpt_pte)
1003 {
1004         int r;
1005
1006         r = is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA, gpt_head,
1007                          pgpt_pte);
1008
1009         if (r != 1) {
1010                 if (r != 2)
1011                         printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
1012
1013                 if (is_gpt_valid(dev_desc, (dev_desc->lba - 1), gpt_head,
1014                                  pgpt_pte) != 1) {
1015                         printf("%s: *** ERROR: Invalid Backup GPT ***\n",
1016                                __func__);
1017                         return 0;
1018                 }
1019                 if (r != 2)
1020                         printf("%s: ***        Using Backup GPT ***\n",
1021                                __func__);
1022         }
1023         return 1;
1024 }
1025
1026 /**
1027  * alloc_read_gpt_entries(): reads partition entries from disk
1028  * @dev_desc
1029  * @gpt - GPT header
1030  *
1031  * Description: Returns ptes on success,  NULL on error.
1032  * Allocates space for PTEs based on information found in @gpt.
1033  * Notes: remember to free pte when you're done!
1034  */
1035 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
1036                                          gpt_header *pgpt_head)
1037 {
1038         size_t count = 0, blk_cnt;
1039         lbaint_t blk;
1040         gpt_entry *pte = NULL;
1041
1042         if (!dev_desc || !pgpt_head) {
1043                 printf("%s: Invalid Argument(s)\n", __func__);
1044                 return NULL;
1045         }
1046
1047         count = le32_to_cpu(pgpt_head->num_partition_entries) *
1048                 le32_to_cpu(pgpt_head->sizeof_partition_entry);
1049
1050         debug("%s: count = %u * %u = %lu\n", __func__,
1051               (u32) le32_to_cpu(pgpt_head->num_partition_entries),
1052               (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry),
1053               (ulong)count);
1054
1055         /* Allocate memory for PTE, remember to FREE */
1056         if (count != 0) {
1057                 pte = memalign(ARCH_DMA_MINALIGN,
1058                                PAD_TO_BLOCKSIZE(count, dev_desc));
1059         }
1060
1061         if (count == 0 || pte == NULL) {
1062                 printf("%s: ERROR: Can't allocate %#lX bytes for GPT Entries\n",
1063                        __func__, (ulong)count);
1064                 return NULL;
1065         }
1066
1067         /* Read GPT Entries from device */
1068         blk = le64_to_cpu(pgpt_head->partition_entry_lba);
1069         blk_cnt = BLOCK_CNT(count, dev_desc);
1070         if (blk_dread(dev_desc, blk, (lbaint_t)blk_cnt, pte) != blk_cnt) {
1071                 printf("*** ERROR: Can't read GPT Entries ***\n");
1072                 free(pte);
1073                 return NULL;
1074         }
1075         return pte;
1076 }
1077
1078 /**
1079  * is_pte_valid(): validates a single Partition Table Entry
1080  * @gpt_entry - Pointer to a single Partition Table Entry
1081  *
1082  * Description: returns 1 if valid,  0 on error.
1083  */
1084 static int is_pte_valid(gpt_entry * pte)
1085 {
1086         efi_guid_t unused_guid;
1087
1088         if (!pte) {
1089                 printf("%s: Invalid Argument(s)\n", __func__);
1090                 return 0;
1091         }
1092
1093         /* Only one validation for now:
1094          * The GUID Partition Type != Unused Entry (ALL-ZERO)
1095          */
1096         memset(unused_guid.b, 0, sizeof(unused_guid.b));
1097
1098         if (memcmp(pte->partition_type_guid.b, unused_guid.b,
1099                 sizeof(unused_guid.b)) == 0) {
1100
1101                 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
1102                       (unsigned int)(uintptr_t)pte);
1103
1104                 return 0;
1105         } else {
1106                 return 1;
1107         }
1108 }
1109
1110 /*
1111  * Add an 'a_' prefix so it comes before 'dos' in the linker list. We need to
1112  * check EFI first, since a DOS partition is often used as a 'protective MBR'
1113  * with EFI.
1114  */
1115 U_BOOT_PART_TYPE(a_efi) = {
1116         .name           = "EFI",
1117         .part_type      = PART_TYPE_EFI,
1118         .max_entries    = GPT_ENTRY_NUMBERS,
1119         .get_info       = part_get_info_ptr(part_get_info_efi),
1120         .print          = part_print_ptr(part_print_efi),
1121         .test           = part_test_efi,
1122 };
1123 #endif /* CONFIG_HAVE_BLOCK_DEVICE */