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 <uuid.h>
  13 #include <asm/cache.h>
  14 #include <asm/unaligned.h>
  15 #include <common.h>
  16 #include <command.h>
  17 #include <fdtdec.h>
  18 #include <ide.h>
  19 #include <malloc.h>
  20 #include <memalign.h>
  21 #include <part_efi.h>
  22 #include <linux/compiler.h>
  23 #include <linux/ctype.h>
  24 #include <u-boot/crc.h>
  25
  26 DECLARE_GLOBAL_DATA_PTR;
  27
  28 /*
  29  * GUID for basic data partions.
  30  */
  31 static const efi_guid_t partition_basic_data_guid = PARTITION_BASIC_DATA_GUID;
  32
  33 #ifdef CONFIG_HAVE_BLOCK_DEVICE
  34 /**
  35  * efi_crc32() - EFI version of crc32 function
  36  * @buf: buffer to calculate crc32 of
  37  * @len - length of buf
  38  *
  39  * Description: Returns EFI-style CRC32 value for @buf
  40  */
  41 static inline u32 efi_crc32(const void *buf, u32 len)
  42 {
  43         return crc32(0, buf, len);
  44 }
  45
  46 /*
  47  * Private function prototypes
  48  */
  49
  50 static int pmbr_part_valid(struct partition *part);
  51 static int is_pmbr_valid(legacy_mbr * mbr);
  52 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
  53                                 gpt_header *pgpt_head, gpt_entry **pgpt_pte);
  54 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
  55                                          gpt_header *pgpt_head);
  56 static int is_pte_valid(gpt_entry * pte);
  57 static int find_valid_gpt(struct blk_desc *dev_desc, gpt_header *gpt_head,
  58                           gpt_entry **pgpt_pte);
  59
  60 static char *print_efiname(gpt_entry *pte)
  61 {
  62         static char name[PARTNAME_SZ + 1];
  63         int i;
  64         for (i = 0; i < PARTNAME_SZ; i++) {
  65                 u8 c;
  66                 c = pte->partition_name[i] & 0xff;
  67                 c = (c && !isprint(c)) ? '.' : c;
  68                 name[i] = c;
  69         }
  70         name[PARTNAME_SZ] = 0;
  71         return name;
  72 }
  73
  74 static const efi_guid_t system_guid = PARTITION_SYSTEM_GUID;
  75
  76 static int get_bootable(gpt_entry *p)
  77 {
  78         int ret = 0;
  79
  80         if (!memcmp(&p->partition_type_guid, &system_guid, sizeof(efi_guid_t)))
  81                 ret |=  PART_EFI_SYSTEM_PARTITION;
  82         if (p->attributes.fields.legacy_bios_bootable)
  83                 ret |=  PART_BOOTABLE;
  84         return ret;
  85 }
  86
  87 static int validate_gpt_header(gpt_header *gpt_h, lbaint_t lba,
  88                 lbaint_t lastlba)
  89 {
  90         uint32_t crc32_backup = 0;
  91         uint32_t calc_crc32;
  92
  93         /* Check the GPT header signature */
  94         if (le64_to_cpu(gpt_h->signature) != GPT_HEADER_SIGNATURE_UBOOT) {
  95                 printf("%s signature is wrong: 0x%llX != 0x%llX\n",
  96                        "GUID Partition Table Header",
  97                        le64_to_cpu(gpt_h->signature),
  98                        GPT_HEADER_SIGNATURE_UBOOT);
  99                 return -1;
 100         }
 101
 102         /* Check the GUID Partition Table CRC */
 103         memcpy(&crc32_backup, &gpt_h->header_crc32, sizeof(crc32_backup));
 104         memset(&gpt_h->header_crc32, 0, sizeof(gpt_h->header_crc32));
 105
 106         calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
 107                 le32_to_cpu(gpt_h->header_size));
 108
 109         memcpy(&gpt_h->header_crc32, &crc32_backup, sizeof(crc32_backup));
 110
 111         if (calc_crc32 != le32_to_cpu(crc32_backup)) {
 112                 printf("%s CRC is wrong: 0x%x != 0x%x\n",
 113                        "GUID Partition Table Header",
 114                        le32_to_cpu(crc32_backup), calc_crc32);
 115                 return -1;
 116         }
 117
 118         /*
 119          * Check that the my_lba entry points to the LBA that contains the GPT
 120          */
 121         if (le64_to_cpu(gpt_h->my_lba) != lba) {
 122                 printf("GPT: my_lba incorrect: %llX != " LBAF "\n",
 123                        le64_to_cpu(gpt_h->my_lba),
 124                        lba);
 125                 return -1;
 126         }
 127
 128         /*
 129          * Check that the first_usable_lba and that the last_usable_lba are
 130          * within the disk.
 131          */
 132         if (le64_to_cpu(gpt_h->first_usable_lba) > lastlba) {
 133                 printf("GPT: first_usable_lba incorrect: %llX > " LBAF "\n",
 134                        le64_to_cpu(gpt_h->first_usable_lba), lastlba);
 135                 return -1;
 136         }
 137         if (le64_to_cpu(gpt_h->last_usable_lba) > lastlba) {
 138                 printf("GPT: last_usable_lba incorrect: %llX > " LBAF "\n",
 139                        le64_to_cpu(gpt_h->last_usable_lba), lastlba);
 140                 return -1;
 141         }
 142
 143         debug("GPT: first_usable_lba: %llX last_usable_lba: %llX last lba: "
 144               LBAF "\n", le64_to_cpu(gpt_h->first_usable_lba),
 145               le64_to_cpu(gpt_h->last_usable_lba), lastlba);
 146
 147         return 0;
 148 }
 149
 150 static int validate_gpt_entries(gpt_header *gpt_h, gpt_entry *gpt_e)
 151 {
 152         uint32_t calc_crc32;
 153
 154         /* Check the GUID Partition Table Entry Array CRC */
 155         calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
 156                 le32_to_cpu(gpt_h->num_partition_entries) *
 157                 le32_to_cpu(gpt_h->sizeof_partition_entry));
 158
 159         if (calc_crc32 != le32_to_cpu(gpt_h->partition_entry_array_crc32)) {
 160                 printf("%s: 0x%x != 0x%x\n",
 161                        "GUID Partition Table Entry Array CRC is wrong",
 162                        le32_to_cpu(gpt_h->partition_entry_array_crc32),
 163                        calc_crc32);
 164                 return -1;
 165         }
 166
 167         return 0;
 168 }
 169
 170 static void prepare_backup_gpt_header(gpt_header *gpt_h)
 171 {
 172         uint32_t calc_crc32;
 173         uint64_t val;
 174
 175         /* recalculate the values for the Backup GPT Header */
 176         val = le64_to_cpu(gpt_h->my_lba);
 177         gpt_h->my_lba = gpt_h->alternate_lba;
 178         gpt_h->alternate_lba = cpu_to_le64(val);
 179         gpt_h->partition_entry_lba =
 180                         cpu_to_le64(le64_to_cpu(gpt_h->last_usable_lba) + 1);
 181         gpt_h->header_crc32 = 0;
 182
 183         calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
 184                                le32_to_cpu(gpt_h->header_size));
 185         gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
 186 }
 187
 188 #if CONFIG_IS_ENABLED(EFI_PARTITION)
 189 /*
 190  * Public Functions (include/part.h)
 191  */
 192
 193 /*
 194  * UUID is displayed as 32 hexadecimal digits, in 5 groups,
 195  * separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters
 196  */
 197 int get_disk_guid(struct blk_desc * dev_desc, char *guid)
 198 {
 199         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
 200         gpt_entry *gpt_pte = NULL;
 201         unsigned char *guid_bin;
 202
 203         /* This function validates AND fills in the GPT header and PTE */
 204         if (find_valid_gpt(dev_desc, gpt_head, &gpt_pte) != 1)
 205                 return -EINVAL;
 206
 207         guid_bin = gpt_head->disk_guid.b;
 208         uuid_bin_to_str(guid_bin, guid, UUID_STR_FORMAT_GUID);
 209
 210         /* Remember to free pte */
 211         free(gpt_pte);
 212         return 0;
 213 }
 214
 215 void part_print_efi(struct blk_desc *dev_desc)
 216 {
 217         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
 218         gpt_entry *gpt_pte = NULL;
 219         int i = 0;
 220         char uuid[UUID_STR_LEN + 1];
 221         unsigned char *uuid_bin;
 222
 223         /* This function validates AND fills in the GPT header and PTE */
 224         if (find_valid_gpt(dev_desc, gpt_head, &gpt_pte) != 1)
 225                 return;
 226
 227         debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
 228
 229         printf("Part\tStart LBA\tEnd LBA\t\tName\n");
 230         printf("\tAttributes\n");
 231         printf("\tType GUID\n");
 232         printf("\tPartition GUID\n");
 233
 234         for (i = 0; i < le32_to_cpu(gpt_head->num_partition_entries); i++) {
 235                 /* Stop at the first non valid PTE */
 236                 if (!is_pte_valid(&gpt_pte[i]))
 237                         break;
 238
 239                 printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i + 1),
 240                         le64_to_cpu(gpt_pte[i].starting_lba),
 241                         le64_to_cpu(gpt_pte[i].ending_lba),
 242                         print_efiname(&gpt_pte[i]));
 243                 printf("\tattrs:\t0x%016llx\n", gpt_pte[i].attributes.raw);
 244                 uuid_bin = (unsigned char *)gpt_pte[i].partition_type_guid.b;
 245                 uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
 246                 printf("\ttype:\t%s\n", uuid);
 247 #ifdef CONFIG_PARTITION_TYPE_GUID
 248                 if (!uuid_guid_get_str(uuid_bin, uuid))
 249                         printf("\ttype:\t%s\n", uuid);
 250 #endif
 251                 uuid_bin = (unsigned char *)gpt_pte[i].unique_partition_guid.b;
 252                 uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
 253                 printf("\tguid:\t%s\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 = fdtdec_get_config_int(gd->fdt_blob,
 561                                               "u-boot,efi-partition-entries-offset",
 562                                               -EINVAL);
 563         if (config_offset != -EINVAL) {
 564                 offset_bytes = PAD_TO_BLOCKSIZE(config_offset, dev_desc);
 565                 offset_blks = offset_bytes / dev_desc->blksz;
 566         }
 567 #endif
 568
 569         debug("efi: partition entries offset (in blocks): %d\n", offset_blks);
 570
 571         /*
 572          * The earliest LBA this can be at is LBA#2 (i.e. right behind
 573          * the (protective) MBR and the GPT header.
 574          */
 575         if (offset_blks < 2)
 576                 offset_blks = 2;
 577
 578         return offset_blks;
 579 }
 580
 581 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 582                 char *str_guid, int parts_count)
 583 {
 584         gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE_UBOOT);
 585         gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
 586         gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
 587         gpt_h->my_lba = cpu_to_le64(1);
 588         gpt_h->alternate_lba = cpu_to_le64(dev_desc->lba - 1);
 589         gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
 590         gpt_h->partition_entry_lba =
 591                 cpu_to_le64(partition_entries_offset(dev_desc));
 592         gpt_h->first_usable_lba =
 593                 cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 32);
 594         gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
 595         gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
 596         gpt_h->header_crc32 = 0;
 597         gpt_h->partition_entry_array_crc32 = 0;
 598
 599         if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
 600                 return -1;
 601
 602         return 0;
 603 }
 604
 605 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 606                 struct disk_partition *partitions, int parts_count)
 607 {
 608         gpt_header *gpt_h;
 609         gpt_entry *gpt_e;
 610         int ret, size;
 611
 612         size = PAD_TO_BLOCKSIZE(sizeof(gpt_header), dev_desc);
 613         gpt_h = malloc_cache_aligned(size);
 614         if (gpt_h == NULL) {
 615                 printf("%s: calloc failed!\n", __func__);
 616                 return -1;
 617         }
 618         memset(gpt_h, 0, size);
 619
 620         size = PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS * sizeof(gpt_entry),
 621                                 dev_desc);
 622         gpt_e = malloc_cache_aligned(size);
 623         if (gpt_e == NULL) {
 624                 printf("%s: calloc failed!\n", __func__);
 625                 free(gpt_h);
 626                 return -1;
 627         }
 628         memset(gpt_e, 0, size);
 629
 630         /* Generate Primary GPT header (LBA1) */
 631         ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
 632         if (ret)
 633                 goto err;
 634
 635         /* Generate partition entries */
 636         ret = gpt_fill_pte(dev_desc, gpt_h, gpt_e, partitions, parts_count);
 637         if (ret)
 638                 goto err;
 639
 640         /* Write GPT partition table */
 641         ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
 642
 643 err:
 644         free(gpt_e);
 645         free(gpt_h);
 646         return ret;
 647 }
 648
 649 /**
 650  * gpt_convert_efi_name_to_char() - convert u16 string to char string
 651  *
 652  * TODO: this conversion only supports ANSI characters
 653  *
 654  * @s:  target buffer
 655  * @es: u16 string to be converted
 656  * @n:  size of target buffer
 657  */
 658 static void gpt_convert_efi_name_to_char(char *s, void *es, int n)
 659 {
 660         char *ess = es;
 661         int i, j;
 662
 663         memset(s, '\0', n);
 664
 665         for (i = 0, j = 0; j < n; i += 2, j++) {
 666                 s[j] = ess[i];
 667                 if (!ess[i])
 668                         return;
 669         }
 670 }
 671
 672 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 673                        gpt_entry **gpt_pte)
 674 {
 675         /*
 676          * This function validates AND
 677          * fills in the GPT header and PTE
 678          */
 679         if (is_gpt_valid(dev_desc,
 680                          GPT_PRIMARY_PARTITION_TABLE_LBA,
 681                          gpt_head, gpt_pte) != 1) {
 682                 printf("%s: *** ERROR: Invalid GPT ***\n",
 683                        __func__);
 684                 return -1;
 685         }
 686
 687         /* Free pte before allocating again */
 688         free(*gpt_pte);
 689
 690         if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
 691                          gpt_head, gpt_pte) != 1) {
 692                 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
 693                        __func__);
 694                 return -1;
 695         }
 696
 697         return 0;
 698 }
 699
 700 int gpt_verify_partitions(struct blk_desc *dev_desc,
 701                           struct disk_partition *partitions, int parts,
 702                           gpt_header *gpt_head, gpt_entry **gpt_pte)
 703 {
 704         char efi_str[PARTNAME_SZ + 1];
 705         u64 gpt_part_size;
 706         gpt_entry *gpt_e;
 707         int ret, i;
 708
 709         ret = gpt_verify_headers(dev_desc, gpt_head, gpt_pte);
 710         if (ret)
 711                 return ret;
 712
 713         gpt_e = *gpt_pte;
 714
 715         for (i = 0; i < parts; i++) {
 716                 if (i == gpt_head->num_partition_entries) {
 717                         pr_err("More partitions than allowed!\n");
 718                         return -1;
 719                 }
 720
 721                 /* Check if GPT and ENV partition names match */
 722                 gpt_convert_efi_name_to_char(efi_str, gpt_e[i].partition_name,
 723                                              PARTNAME_SZ + 1);
 724
 725                 debug("%s: part: %2d name - GPT: %16s, ENV: %16s ",
 726                       __func__, i, efi_str, partitions[i].name);
 727
 728                 if (strncmp(efi_str, (char *)partitions[i].name,
 729                             sizeof(partitions->name))) {
 730                         pr_err("Partition name: %s does not match %s!\n",
 731                               efi_str, (char *)partitions[i].name);
 732                         return -1;
 733                 }
 734
 735                 /* Check if GPT and ENV sizes match */
 736                 gpt_part_size = le64_to_cpu(gpt_e[i].ending_lba) -
 737                         le64_to_cpu(gpt_e[i].starting_lba) + 1;
 738                 debug("size(LBA) - GPT: %8llu, ENV: %8llu ",
 739                       (unsigned long long)gpt_part_size,
 740                       (unsigned long long)partitions[i].size);
 741
 742                 if (le64_to_cpu(gpt_part_size) != partitions[i].size) {
 743                         /* We do not check the extend partition size */
 744                         if ((i == parts - 1) && (partitions[i].size == 0))
 745                                 continue;
 746
 747                         pr_err("Partition %s size: %llu does not match %llu!\n",
 748                               efi_str, (unsigned long long)gpt_part_size,
 749                               (unsigned long long)partitions[i].size);
 750                         return -1;
 751                 }
 752
 753                 /*
 754                  * Start address is optional - check only if provided
 755                  * in '$partition' variable
 756                  */
 757                 if (!partitions[i].start) {
 758                         debug("\n");
 759                         continue;
 760                 }
 761
 762                 /* Check if GPT and ENV start LBAs match */
 763                 debug("start LBA - GPT: %8llu, ENV: %8llu\n",
 764                       le64_to_cpu(gpt_e[i].starting_lba),
 765                       (unsigned long long)partitions[i].start);
 766
 767                 if (le64_to_cpu(gpt_e[i].starting_lba) != partitions[i].start) {
 768                         pr_err("Partition %s start: %llu does not match %llu!\n",
 769                               efi_str, le64_to_cpu(gpt_e[i].starting_lba),
 770                               (unsigned long long)partitions[i].start);
 771                         return -1;
 772                 }
 773         }
 774
 775         return 0;
 776 }
 777
 778 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf)
 779 {
 780         gpt_header *gpt_h;
 781         gpt_entry *gpt_e;
 782
 783         /* determine start of GPT Header in the buffer */
 784         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
 785                        dev_desc->blksz);
 786         if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
 787                                 dev_desc->lba))
 788                 return -1;
 789
 790         /* determine start of GPT Entries in the buffer */
 791         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
 792                        dev_desc->blksz);
 793         if (validate_gpt_entries(gpt_h, gpt_e))
 794                 return -1;
 795
 796         return 0;
 797 }
 798
 799 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf)
 800 {
 801         gpt_header *gpt_h;
 802         gpt_entry *gpt_e;
 803         int gpt_e_blk_cnt;
 804         lbaint_t lba;
 805         int cnt;
 806
 807         if (is_valid_gpt_buf(dev_desc, buf))
 808                 return -1;
 809
 810         /* determine start of GPT Header in the buffer */
 811         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
 812                        dev_desc->blksz);
 813
 814         /* determine start of GPT Entries in the buffer */
 815         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
 816                        dev_desc->blksz);
 817         gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
 818                                    le32_to_cpu(gpt_h->sizeof_partition_entry)),
 819                                   dev_desc);
 820
 821         /* write MBR */
 822         lba = 0;        /* MBR is always at 0 */
 823         cnt = 1;        /* MBR (1 block) */
 824         if (blk_dwrite(dev_desc, lba, cnt, buf) != cnt) {
 825                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 826                        __func__, "MBR", cnt, lba);
 827                 return 1;
 828         }
 829
 830         /* write Primary GPT */
 831         lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
 832         cnt = 1;        /* GPT Header (1 block) */
 833         if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
 834                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 835                        __func__, "Primary GPT Header", cnt, lba);
 836                 return 1;
 837         }
 838
 839         lba = le64_to_cpu(gpt_h->partition_entry_lba);
 840         cnt = gpt_e_blk_cnt;
 841         if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
 842                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 843                        __func__, "Primary GPT Entries", cnt, lba);
 844                 return 1;
 845         }
 846
 847         prepare_backup_gpt_header(gpt_h);
 848
 849         /* write Backup GPT */
 850         lba = le64_to_cpu(gpt_h->partition_entry_lba);
 851         cnt = gpt_e_blk_cnt;
 852         if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
 853                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 854                        __func__, "Backup GPT Entries", cnt, lba);
 855                 return 1;
 856         }
 857
 858         lba = le64_to_cpu(gpt_h->my_lba);
 859         cnt = 1;        /* GPT Header (1 block) */
 860         if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
 861                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 862                        __func__, "Backup GPT Header", cnt, lba);
 863                 return 1;
 864         }
 865
 866         return 0;
 867 }
 868 #endif
 869
 870 /*
 871  * Private functions
 872  */
 873 /*
 874  * pmbr_part_valid(): Check for EFI partition signature
 875  *
 876  * Returns: 1 if EFI GPT partition type is found.
 877  */
 878 static int pmbr_part_valid(struct partition *part)
 879 {
 880         if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
 881                 get_unaligned_le32(&part->start_sect) == 1UL) {
 882                 return 1;
 883         }
 884
 885         return 0;
 886 }
 887
 888 /*
 889  * is_pmbr_valid(): test Protective MBR for validity
 890  *
 891  * Returns: 1 if PMBR is valid, 0 otherwise.
 892  * Validity depends on two things:
 893  *  1) MSDOS signature is in the last two bytes of the MBR
 894  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
 895  */
 896 static int is_pmbr_valid(legacy_mbr * mbr)
 897 {
 898         int i = 0;
 899
 900         if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
 901                 return 0;
 902
 903         for (i = 0; i < 4; i++) {
 904                 if (pmbr_part_valid(&mbr->partition_record[i])) {
 905                         return 1;
 906                 }
 907         }
 908         return 0;
 909 }
 910
 911 /**
 912  * is_gpt_valid() - tests one GPT header and PTEs for validity
 913  *
 914  * lba is the logical block address of the GPT header to test
 915  * gpt is a GPT header ptr, filled on return.
 916  * ptes is a PTEs ptr, filled on return.
 917  *
 918  * Description: returns 1 if valid,  0 on error, 2 if ignored header
 919  * If valid, returns pointers to PTEs.
 920  */
 921 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
 922                         gpt_header *pgpt_head, gpt_entry **pgpt_pte)
 923 {
 924         /* Confirm valid arguments prior to allocation. */
 925         if (!dev_desc || !pgpt_head) {
 926                 printf("%s: Invalid Argument(s)\n", __func__);
 927                 return 0;
 928         }
 929
 930         ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, mbr, 1, dev_desc->blksz);
 931
 932         /* Read MBR Header from device */
 933         if (blk_dread(dev_desc, 0, 1, (ulong *)mbr) != 1) {
 934                 printf("*** ERROR: Can't read MBR header ***\n");
 935                 return 0;
 936         }
 937
 938         /* Read GPT Header from device */
 939         if (blk_dread(dev_desc, (lbaint_t)lba, 1, pgpt_head) != 1) {
 940                 printf("*** ERROR: Can't read GPT header ***\n");
 941                 return 0;
 942         }
 943
 944         /* Invalid but nothing to yell about. */
 945         if (le64_to_cpu(pgpt_head->signature) == GPT_HEADER_CHROMEOS_IGNORE) {
 946                 debug("ChromeOS 'IGNOREME' GPT header found and ignored\n");
 947                 return 2;
 948         }
 949
 950         if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->lba))
 951                 return 0;
 952
 953         if (dev_desc->sig_type == SIG_TYPE_NONE) {
 954                 efi_guid_t empty = {};
 955                 if (memcmp(&pgpt_head->disk_guid, &empty, sizeof(empty))) {
 956                         dev_desc->sig_type = SIG_TYPE_GUID;
 957                         memcpy(&dev_desc->guid_sig, &pgpt_head->disk_guid,
 958                               sizeof(empty));
 959                 } else if (mbr->unique_mbr_signature != 0) {
 960                         dev_desc->sig_type = SIG_TYPE_MBR;
 961                         dev_desc->mbr_sig = mbr->unique_mbr_signature;
 962                 }
 963         }
 964
 965         /* Read and allocate Partition Table Entries */
 966         *pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
 967         if (*pgpt_pte == NULL) {
 968                 printf("GPT: Failed to allocate memory for PTE\n");
 969                 return 0;
 970         }
 971
 972         if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
 973                 free(*pgpt_pte);
 974                 return 0;
 975         }
 976
 977         /* We're done, all's well */
 978         return 1;
 979 }
 980
 981 /**
 982  * find_valid_gpt() - finds a valid GPT header and PTEs
 983  *
 984  * gpt is a GPT header ptr, filled on return.
 985  * ptes is a PTEs ptr, filled on return.
 986  *
 987  * Description: returns 1 if found a valid gpt,  0 on error.
 988  * If valid, returns pointers to PTEs.
 989  */
 990 static int find_valid_gpt(struct blk_desc *dev_desc, gpt_header *gpt_head,
 991                           gpt_entry **pgpt_pte)
 992 {
 993         int r;
 994
 995         r = is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA, gpt_head,
 996                          pgpt_pte);
 997
 998         if (r != 1) {
 999                 if (r != 2)
1000                         printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
1001
1002                 if (is_gpt_valid(dev_desc, (dev_desc->lba - 1), gpt_head,
1003                                  pgpt_pte) != 1) {
1004                         printf("%s: *** ERROR: Invalid Backup GPT ***\n",
1005                                __func__);
1006                         return 0;
1007                 }
1008                 if (r != 2)
1009                         printf("%s: ***        Using Backup GPT ***\n",
1010                                __func__);
1011         }
1012         return 1;
1013 }
1014
1015 /**
1016  * alloc_read_gpt_entries(): reads partition entries from disk
1017  * @dev_desc
1018  * @gpt - GPT header
1019  *
1020  * Description: Returns ptes on success,  NULL on error.
1021  * Allocates space for PTEs based on information found in @gpt.
1022  * Notes: remember to free pte when you're done!
1023  */
1024 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
1025                                          gpt_header *pgpt_head)
1026 {
1027         size_t count = 0, blk_cnt;
1028         lbaint_t blk;
1029         gpt_entry *pte = NULL;
1030
1031         if (!dev_desc || !pgpt_head) {
1032                 printf("%s: Invalid Argument(s)\n", __func__);
1033                 return NULL;
1034         }
1035
1036         count = le32_to_cpu(pgpt_head->num_partition_entries) *
1037                 le32_to_cpu(pgpt_head->sizeof_partition_entry);
1038
1039         debug("%s: count = %u * %u = %lu\n", __func__,
1040               (u32) le32_to_cpu(pgpt_head->num_partition_entries),
1041               (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry),
1042               (ulong)count);
1043
1044         /* Allocate memory for PTE, remember to FREE */
1045         if (count != 0) {
1046                 pte = memalign(ARCH_DMA_MINALIGN,
1047                                PAD_TO_BLOCKSIZE(count, dev_desc));
1048         }
1049
1050         if (count == 0 || pte == NULL) {
1051                 printf("%s: ERROR: Can't allocate %#lX bytes for GPT Entries\n",
1052                        __func__, (ulong)count);
1053                 return NULL;
1054         }
1055
1056         /* Read GPT Entries from device */
1057         blk = le64_to_cpu(pgpt_head->partition_entry_lba);
1058         blk_cnt = BLOCK_CNT(count, dev_desc);
1059         if (blk_dread(dev_desc, blk, (lbaint_t)blk_cnt, pte) != blk_cnt) {
1060                 printf("*** ERROR: Can't read GPT Entries ***\n");
1061                 free(pte);
1062                 return NULL;
1063         }
1064         return pte;
1065 }
1066
1067 /**
1068  * is_pte_valid(): validates a single Partition Table Entry
1069  * @gpt_entry - Pointer to a single Partition Table Entry
1070  *
1071  * Description: returns 1 if valid,  0 on error.
1072  */
1073 static int is_pte_valid(gpt_entry * pte)
1074 {
1075         efi_guid_t unused_guid;
1076
1077         if (!pte) {
1078                 printf("%s: Invalid Argument(s)\n", __func__);
1079                 return 0;
1080         }
1081
1082         /* Only one validation for now:
1083          * The GUID Partition Type != Unused Entry (ALL-ZERO)
1084          */
1085         memset(unused_guid.b, 0, sizeof(unused_guid.b));
1086
1087         if (memcmp(pte->partition_type_guid.b, unused_guid.b,
1088                 sizeof(unused_guid.b)) == 0) {
1089
1090                 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
1091                       (unsigned int)(uintptr_t)pte);
1092
1093                 return 0;
1094         } else {
1095                 return 1;
1096         }
1097 }
1098
1099 /*
1100  * Add an 'a_' prefix so it comes before 'dos' in the linker list. We need to
1101  * check EFI first, since a DOS partition is often used as a 'protective MBR'
1102  * with EFI.
1103  */
1104 U_BOOT_PART_TYPE(a_efi) = {
1105         .name           = "EFI",
1106         .part_type      = PART_TYPE_EFI,
1107         .max_entries    = GPT_ENTRY_NUMBERS,
1108         .get_info       = part_get_info_ptr(part_get_info_efi),
1109         .print          = part_print_ptr(part_print_efi),
1110         .test           = part_test_efi,
1111 };
1112 #endif