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