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