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