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