disk/part_efi.c

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