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