disk/part_efi.c

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