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 start;
 436         lbaint_t last_usable_lba = (lbaint_t)
 437                         le64_to_cpu(gpt_h->last_usable_lba);
 438         int i, k;
 439         size_t efiname_len, dosname_len;
 440 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 441         char *str_uuid;
 442         unsigned char *bin_uuid;
 443 #endif
 444 #ifdef CONFIG_PARTITION_TYPE_GUID
 445         char *str_type_guid;
 446         unsigned char *bin_type_guid;
 447 #endif
 448
 449         for (i = 0; i < parts; i++) {
 450                 /* partition starting lba */
 451                 start = partitions[i].start;
 452                 if (start && (start < offset)) {
 453                         printf("Partition overlap\n");
 454                         return -1;
 455                 }
 456                 if (start) {
 457                         gpt_e[i].starting_lba = cpu_to_le64(start);
 458                         offset = start + partitions[i].size;
 459                 } else {
 460                         gpt_e[i].starting_lba = cpu_to_le64(offset);
 461                         offset += partitions[i].size;
 462                 }
 463                 if (offset > (last_usable_lba + 1)) {
 464                         printf("Partitions layout exceds disk size\n");
 465                         return -1;
 466                 }
 467                 /* partition ending lba */
 468                 if ((i == parts - 1) && (partitions[i].size == 0))
 469                         /* extend the last partition to maximuim */
 470                         gpt_e[i].ending_lba = gpt_h->last_usable_lba;
 471                 else
 472                         gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
 473
 474 #ifdef CONFIG_PARTITION_TYPE_GUID
 475                 str_type_guid = partitions[i].type_guid;
 476                 bin_type_guid = gpt_e[i].partition_type_guid.b;
 477                 if (strlen(str_type_guid)) {
 478                         if (uuid_str_to_bin(str_type_guid, bin_type_guid,
 479                                             UUID_STR_FORMAT_GUID)) {
 480                                 printf("Partition no. %d: invalid type guid: %s\n",
 481                                        i, str_type_guid);
 482                                 return -1;
 483                         }
 484                 } else {
 485                         /* default partition type GUID */
 486                         memcpy(bin_type_guid,
 487                                &PARTITION_BASIC_DATA_GUID, 16);
 488                 }
 489 #else
 490                 /* partition type GUID */
 491                 memcpy(gpt_e[i].partition_type_guid.b,
 492                         &PARTITION_BASIC_DATA_GUID, 16);
 493 #endif
 494
 495 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 496                 str_uuid = partitions[i].uuid;
 497                 bin_uuid = gpt_e[i].unique_partition_guid.b;
 498
 499                 if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_GUID)) {
 500                         printf("Partition no. %d: invalid guid: %s\n",
 501                                 i, str_uuid);
 502                         return -1;
 503                 }
 504 #endif
 505
 506                 /* partition attributes */
 507                 memset(&gpt_e[i].attributes, 0,
 508                        sizeof(gpt_entry_attributes));
 509
 510                 if (partitions[i].bootable)
 511                         gpt_e[i].attributes.fields.legacy_bios_bootable = 1;
 512
 513                 /* partition name */
 514                 efiname_len = sizeof(gpt_e[i].partition_name)
 515                         / sizeof(efi_char16_t);
 516                 dosname_len = sizeof(partitions[i].name);
 517
 518                 memset(gpt_e[i].partition_name, 0,
 519                        sizeof(gpt_e[i].partition_name));
 520
 521                 for (k = 0; k < min(dosname_len, efiname_len); k++)
 522                         gpt_e[i].partition_name[k] =
 523                                 (efi_char16_t)(partitions[i].name[k]);
 524
 525                 debug("%s: name: %s offset[%d]: 0x" LBAF
 526                       " size[%d]: 0x" LBAF "\n",
 527                       __func__, partitions[i].name, i,
 528                       offset, i, partitions[i].size);
 529         }
 530
 531         return 0;
 532 }
 533
 534 static uint32_t partition_entries_offset(struct blk_desc *dev_desc)
 535 {
 536         uint32_t offset_blks = 2;
 537         uint32_t __maybe_unused offset_bytes;
 538         int __maybe_unused config_offset;
 539
 540 #if defined(CONFIG_EFI_PARTITION_ENTRIES_OFF)
 541         /*
 542          * Some architectures require their SPL loader at a fixed
 543          * address within the first 16KB of the disk.  To avoid an
 544          * overlap with the partition entries of the EFI partition
 545          * table, the first safe offset (in bytes, from the start of
 546          * the disk) for the entries can be set in
 547          * CONFIG_EFI_PARTITION_ENTRIES_OFF.
 548          */
 549         offset_bytes =
 550                 PAD_TO_BLOCKSIZE(CONFIG_EFI_PARTITION_ENTRIES_OFF, dev_desc);
 551         offset_blks = offset_bytes / dev_desc->blksz;
 552 #endif
 553
 554 #if defined(CONFIG_OF_CONTROL)
 555         /*
 556          * Allow the offset of the first partition entires (in bytes
 557          * from the start of the device) to be specified as a property
 558          * of the device tree '/config' node.
 559          */
 560         config_offset = fdtdec_get_config_int(gd->fdt_blob,
 561                                               "u-boot,efi-partition-entries-offset",
 562                                               -EINVAL);
 563         if (config_offset != -EINVAL) {
 564                 offset_bytes = PAD_TO_BLOCKSIZE(config_offset, dev_desc);
 565                 offset_blks = offset_bytes / dev_desc->blksz;
 566         }
 567 #endif
 568
 569         debug("efi: partition entries offset (in blocks): %d\n", offset_blks);
 570
 571         /*
 572          * The earliest LBA this can be at is LBA#2 (i.e. right behind
 573          * the (protective) MBR and the GPT header.
 574          */
 575         if (offset_blks < 2)
 576                 offset_blks = 2;
 577
 578         return offset_blks;
 579 }
 580
 581 int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
 582                 char *str_guid, int parts_count)
 583 {
 584         gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE);
 585         gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
 586         gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
 587         gpt_h->my_lba = cpu_to_le64(1);
 588         gpt_h->alternate_lba = cpu_to_le64(dev_desc->lba - 1);
 589         gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
 590         gpt_h->partition_entry_lba =
 591                 cpu_to_le64(partition_entries_offset(dev_desc));
 592         gpt_h->first_usable_lba =
 593                 cpu_to_le64(le64_to_cpu(gpt_h->partition_entry_lba) + 32);
 594         gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
 595         gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
 596         gpt_h->header_crc32 = 0;
 597         gpt_h->partition_entry_array_crc32 = 0;
 598
 599         if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
 600                 return -1;
 601
 602         return 0;
 603 }
 604
 605 int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
 606                 disk_partition_t *partitions, int parts_count)
 607 {
 608         int ret;
 609
 610         gpt_header *gpt_h = calloc(1, PAD_TO_BLOCKSIZE(sizeof(gpt_header),
 611                                                        dev_desc));
 612         gpt_entry *gpt_e;
 613
 614         if (gpt_h == NULL) {
 615                 printf("%s: calloc failed!\n", __func__);
 616                 return -1;
 617         }
 618
 619         gpt_e = calloc(1, PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS
 620                                                * sizeof(gpt_entry),
 621                                                dev_desc));
 622         if (gpt_e == NULL) {
 623                 printf("%s: calloc failed!\n", __func__);
 624                 free(gpt_h);
 625                 return -1;
 626         }
 627
 628         /* Generate Primary GPT header (LBA1) */
 629         ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
 630         if (ret)
 631                 goto err;
 632
 633         /* Generate partition entries */
 634         ret = gpt_fill_pte(gpt_h, gpt_e, partitions, parts_count);
 635         if (ret)
 636                 goto err;
 637
 638         /* Write GPT partition table */
 639         ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
 640
 641 err:
 642         free(gpt_e);
 643         free(gpt_h);
 644         return ret;
 645 }
 646
 647 static void gpt_convert_efi_name_to_char(char *s, efi_char16_t *es, int n)
 648 {
 649         char *ess = (char *)es;
 650         int i, j;
 651
 652         memset(s, '\0', n);
 653
 654         for (i = 0, j = 0; j < n; i += 2, j++) {
 655                 s[j] = ess[i];
 656                 if (!ess[i])
 657                         return;
 658         }
 659 }
 660
 661 int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
 662                        gpt_entry **gpt_pte)
 663 {
 664         /*
 665          * This function validates AND
 666          * fills in the GPT header and PTE
 667          */
 668         if (is_gpt_valid(dev_desc,
 669                          GPT_PRIMARY_PARTITION_TABLE_LBA,
 670                          gpt_head, gpt_pte) != 1) {
 671                 printf("%s: *** ERROR: Invalid GPT ***\n",
 672                        __func__);
 673                 return -1;
 674         }
 675         if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
 676                          gpt_head, gpt_pte) != 1) {
 677                 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
 678                        __func__);
 679                 return -1;
 680         }
 681
 682         return 0;
 683 }
 684
 685 int gpt_verify_partitions(struct blk_desc *dev_desc,
 686                           disk_partition_t *partitions, int parts,
 687                           gpt_header *gpt_head, gpt_entry **gpt_pte)
 688 {
 689         char efi_str[PARTNAME_SZ + 1];
 690         u64 gpt_part_size;
 691         gpt_entry *gpt_e;
 692         int ret, i;
 693
 694         ret = gpt_verify_headers(dev_desc, gpt_head, gpt_pte);
 695         if (ret)
 696                 return ret;
 697
 698         gpt_e = *gpt_pte;
 699
 700         for (i = 0; i < parts; i++) {
 701                 if (i == gpt_head->num_partition_entries) {
 702                         error("More partitions than allowed!\n");
 703                         return -1;
 704                 }
 705
 706                 /* Check if GPT and ENV partition names match */
 707                 gpt_convert_efi_name_to_char(efi_str, gpt_e[i].partition_name,
 708                                              PARTNAME_SZ + 1);
 709
 710                 debug("%s: part: %2d name - GPT: %16s, ENV: %16s ",
 711                       __func__, i, efi_str, partitions[i].name);
 712
 713                 if (strncmp(efi_str, (char *)partitions[i].name,
 714                             sizeof(partitions->name))) {
 715                         error("Partition name: %s does not match %s!\n",
 716                               efi_str, (char *)partitions[i].name);
 717                         return -1;
 718                 }
 719
 720                 /* Check if GPT and ENV sizes match */
 721                 gpt_part_size = le64_to_cpu(gpt_e[i].ending_lba) -
 722                         le64_to_cpu(gpt_e[i].starting_lba) + 1;
 723                 debug("size(LBA) - GPT: %8llu, ENV: %8llu ",
 724                       (unsigned long long)gpt_part_size,
 725                       (unsigned long long)partitions[i].size);
 726
 727                 if (le64_to_cpu(gpt_part_size) != partitions[i].size) {
 728                         /* We do not check the extend partition size */
 729                         if ((i == parts - 1) && (partitions[i].size == 0))
 730                                 continue;
 731
 732                         error("Partition %s size: %llu does not match %llu!\n",
 733                               efi_str, (unsigned long long)gpt_part_size,
 734                               (unsigned long long)partitions[i].size);
 735                         return -1;
 736                 }
 737
 738                 /*
 739                  * Start address is optional - check only if provided
 740                  * in '$partition' variable
 741                  */
 742                 if (!partitions[i].start) {
 743                         debug("\n");
 744                         continue;
 745                 }
 746
 747                 /* Check if GPT and ENV start LBAs match */
 748                 debug("start LBA - GPT: %8llu, ENV: %8llu\n",
 749                       le64_to_cpu(gpt_e[i].starting_lba),
 750                       (unsigned long long)partitions[i].start);
 751
 752                 if (le64_to_cpu(gpt_e[i].starting_lba) != partitions[i].start) {
 753                         error("Partition %s start: %llu does not match %llu!\n",
 754                               efi_str, le64_to_cpu(gpt_e[i].starting_lba),
 755                               (unsigned long long)partitions[i].start);
 756                         return -1;
 757                 }
 758         }
 759
 760         return 0;
 761 }
 762
 763 int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf)
 764 {
 765         gpt_header *gpt_h;
 766         gpt_entry *gpt_e;
 767
 768         /* determine start of GPT Header in the buffer */
 769         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
 770                        dev_desc->blksz);
 771         if (validate_gpt_header(gpt_h, GPT_PRIMARY_PARTITION_TABLE_LBA,
 772                                 dev_desc->lba))
 773                 return -1;
 774
 775         /* determine start of GPT Entries in the buffer */
 776         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
 777                        dev_desc->blksz);
 778         if (validate_gpt_entries(gpt_h, gpt_e))
 779                 return -1;
 780
 781         return 0;
 782 }
 783
 784 int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf)
 785 {
 786         gpt_header *gpt_h;
 787         gpt_entry *gpt_e;
 788         int gpt_e_blk_cnt;
 789         lbaint_t lba;
 790         int cnt;
 791
 792         if (is_valid_gpt_buf(dev_desc, buf))
 793                 return -1;
 794
 795         /* determine start of GPT Header in the buffer */
 796         gpt_h = buf + (GPT_PRIMARY_PARTITION_TABLE_LBA *
 797                        dev_desc->blksz);
 798
 799         /* determine start of GPT Entries in the buffer */
 800         gpt_e = buf + (le64_to_cpu(gpt_h->partition_entry_lba) *
 801                        dev_desc->blksz);
 802         gpt_e_blk_cnt = BLOCK_CNT((le32_to_cpu(gpt_h->num_partition_entries) *
 803                                    le32_to_cpu(gpt_h->sizeof_partition_entry)),
 804                                   dev_desc);
 805
 806         /* write MBR */
 807         lba = 0;        /* MBR is always at 0 */
 808         cnt = 1;        /* MBR (1 block) */
 809         if (blk_dwrite(dev_desc, lba, cnt, buf) != cnt) {
 810                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 811                        __func__, "MBR", cnt, lba);
 812                 return 1;
 813         }
 814
 815         /* write Primary GPT */
 816         lba = GPT_PRIMARY_PARTITION_TABLE_LBA;
 817         cnt = 1;        /* GPT Header (1 block) */
 818         if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
 819                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 820                        __func__, "Primary GPT Header", cnt, lba);
 821                 return 1;
 822         }
 823
 824         lba = le64_to_cpu(gpt_h->partition_entry_lba);
 825         cnt = gpt_e_blk_cnt;
 826         if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
 827                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 828                        __func__, "Primary GPT Entries", cnt, lba);
 829                 return 1;
 830         }
 831
 832         prepare_backup_gpt_header(gpt_h);
 833
 834         /* write Backup GPT */
 835         lba = le64_to_cpu(gpt_h->partition_entry_lba);
 836         cnt = gpt_e_blk_cnt;
 837         if (blk_dwrite(dev_desc, lba, cnt, gpt_e) != cnt) {
 838                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 839                        __func__, "Backup GPT Entries", cnt, lba);
 840                 return 1;
 841         }
 842
 843         lba = le64_to_cpu(gpt_h->my_lba);
 844         cnt = 1;        /* GPT Header (1 block) */
 845         if (blk_dwrite(dev_desc, lba, cnt, gpt_h) != cnt) {
 846                 printf("%s: failed writing '%s' (%d blks at 0x" LBAF ")\n",
 847                        __func__, "Backup GPT Header", cnt, lba);
 848                 return 1;
 849         }
 850
 851         return 0;
 852 }
 853 #endif
 854
 855 /*
 856  * Private functions
 857  */
 858 /*
 859  * pmbr_part_valid(): Check for EFI partition signature
 860  *
 861  * Returns: 1 if EFI GPT partition type is found.
 862  */
 863 static int pmbr_part_valid(struct partition *part)
 864 {
 865         if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
 866                 get_unaligned_le32(&part->start_sect) == 1UL) {
 867                 return 1;
 868         }
 869
 870         return 0;
 871 }
 872
 873 /*
 874  * is_pmbr_valid(): test Protective MBR for validity
 875  *
 876  * Returns: 1 if PMBR is valid, 0 otherwise.
 877  * Validity depends on two things:
 878  *  1) MSDOS signature is in the last two bytes of the MBR
 879  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
 880  */
 881 static int is_pmbr_valid(legacy_mbr * mbr)
 882 {
 883         int i = 0;
 884
 885         if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
 886                 return 0;
 887
 888         for (i = 0; i < 4; i++) {
 889                 if (pmbr_part_valid(&mbr->partition_record[i])) {
 890                         return 1;
 891                 }
 892         }
 893         return 0;
 894 }
 895
 896 /**
 897  * is_gpt_valid() - tests one GPT header and PTEs for validity
 898  *
 899  * lba is the logical block address of the GPT header to test
 900  * gpt is a GPT header ptr, filled on return.
 901  * ptes is a PTEs ptr, filled on return.
 902  *
 903  * Description: returns 1 if valid,  0 on error.
 904  * If valid, returns pointers to PTEs.
 905  */
 906 static int is_gpt_valid(struct blk_desc *dev_desc, u64 lba,
 907                         gpt_header *pgpt_head, gpt_entry **pgpt_pte)
 908 {
 909         if (!dev_desc || !pgpt_head) {
 910                 printf("%s: Invalid Argument(s)\n", __func__);
 911                 return 0;
 912         }
 913
 914         /* Read GPT Header from device */
 915         if (blk_dread(dev_desc, (lbaint_t)lba, 1, pgpt_head) != 1) {
 916                 printf("*** ERROR: Can't read GPT header ***\n");
 917                 return 0;
 918         }
 919
 920         if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->lba))
 921                 return 0;
 922
 923         /* Read and allocate Partition Table Entries */
 924         *pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
 925         if (*pgpt_pte == NULL) {
 926                 printf("GPT: Failed to allocate memory for PTE\n");
 927                 return 0;
 928         }
 929
 930         if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
 931                 free(*pgpt_pte);
 932                 return 0;
 933         }
 934
 935         /* We're done, all's well */
 936         return 1;
 937 }
 938
 939 /**
 940  * alloc_read_gpt_entries(): reads partition entries from disk
 941  * @dev_desc
 942  * @gpt - GPT header
 943  *
 944  * Description: Returns ptes on success,  NULL on error.
 945  * Allocates space for PTEs based on information found in @gpt.
 946  * Notes: remember to free pte when you're done!
 947  */
 948 static gpt_entry *alloc_read_gpt_entries(struct blk_desc *dev_desc,
 949                                          gpt_header *pgpt_head)
 950 {
 951         size_t count = 0, blk_cnt;
 952         lbaint_t blk;
 953         gpt_entry *pte = NULL;
 954
 955         if (!dev_desc || !pgpt_head) {
 956                 printf("%s: Invalid Argument(s)\n", __func__);
 957                 return NULL;
 958         }
 959
 960         count = le32_to_cpu(pgpt_head->num_partition_entries) *
 961                 le32_to_cpu(pgpt_head->sizeof_partition_entry);
 962
 963         debug("%s: count = %u * %u = %lu\n", __func__,
 964               (u32) le32_to_cpu(pgpt_head->num_partition_entries),
 965               (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry),
 966               (ulong)count);
 967
 968         /* Allocate memory for PTE, remember to FREE */
 969         if (count != 0) {
 970                 pte = memalign(ARCH_DMA_MINALIGN,
 971                                PAD_TO_BLOCKSIZE(count, dev_desc));
 972         }
 973
 974         if (count == 0 || pte == NULL) {
 975                 printf("%s: ERROR: Can't allocate %#lX bytes for GPT Entries\n",
 976                        __func__, (ulong)count);
 977                 return NULL;
 978         }
 979
 980         /* Read GPT Entries from device */
 981         blk = le64_to_cpu(pgpt_head->partition_entry_lba);
 982         blk_cnt = BLOCK_CNT(count, dev_desc);
 983         if (blk_dread(dev_desc, blk, (lbaint_t)blk_cnt, pte) != blk_cnt) {
 984                 printf("*** ERROR: Can't read GPT Entries ***\n");
 985                 free(pte);
 986                 return NULL;
 987         }
 988         return pte;
 989 }
 990
 991 /**
 992  * is_pte_valid(): validates a single Partition Table Entry
 993  * @gpt_entry - Pointer to a single Partition Table Entry
 994  *
 995  * Description: returns 1 if valid,  0 on error.
 996  */
 997 static int is_pte_valid(gpt_entry * pte)
 998 {
 999         efi_guid_t unused_guid;
1000
1001         if (!pte) {
1002                 printf("%s: Invalid Argument(s)\n", __func__);
1003                 return 0;
1004         }
1005
1006         /* Only one validation for now:
1007          * The GUID Partition Type != Unused Entry (ALL-ZERO)
1008          */
1009         memset(unused_guid.b, 0, sizeof(unused_guid.b));
1010
1011         if (memcmp(pte->partition_type_guid.b, unused_guid.b,
1012                 sizeof(unused_guid.b)) == 0) {
1013
1014                 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
1015                       (unsigned int)(uintptr_t)pte);
1016
1017                 return 0;
1018         } else {
1019                 return 1;
1020         }
1021 }
1022
1023 /*
1024  * Add an 'a_' prefix so it comes before 'dos' in the linker list. We need to
1025  * check EFI first, since a DOS partition is often used as a 'protective MBR'
1026  * with EFI.
1027  */
1028 U_BOOT_PART_TYPE(a_efi) = {
1029         .name           = "EFI",
1030         .part_type      = PART_TYPE_EFI,
1031         .max_entries    = GPT_ENTRY_NUMBERS,
1032         .get_info       = part_get_info_ptr(part_get_info_efi),
1033         .print          = part_print_ptr(part_print_efi),
1034         .test           = part_test_efi,
1035 };
1036 #endif