disk/part_efi.c

   1 /*
   2  * Copyright (C) 2008 RuggedCom, Inc.
   3  * Richard Retanubun <RichardRetanubun@RuggedCom.com>
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 /*
  25  * Problems with CONFIG_SYS_64BIT_LBA:
  26  *
  27  * struct disk_partition.start in include/part.h is sized as ulong.
  28  * When CONFIG_SYS_64BIT_LBA is activated, lbaint_t changes from ulong to uint64_t.
  29  * For now, it is cast back to ulong at assignment.
  30  *
  31  * This limits the maximum size of addressable storage to < 2 Terra Bytes
  32  */
  33 #include <common.h>
  34 #include <command.h>
  35 #include <ide.h>
  36 #include <malloc.h>
  37 #include "part_efi.h"
  38 #include <linux/ctype.h>
  39
  40 #if defined(CONFIG_CMD_IDE) || \
  41     defined(CONFIG_CMD_SATA) || \
  42     defined(CONFIG_CMD_SCSI) || \
  43     defined(CONFIG_CMD_USB) || \
  44     defined(CONFIG_MMC) || \
  45     defined(CONFIG_SYSTEMACE)
  46
  47 /* Convert char[2] in little endian format to the host format integer
  48  */
  49 static inline unsigned short le16_to_int(unsigned char *le16)
  50 {
  51         return ((le16[1] << 8) + le16[0]);
  52 }
  53
  54 /* Convert char[4] in little endian format to the host format integer
  55  */
  56 static inline unsigned long le32_to_int(unsigned char *le32)
  57 {
  58         return ((le32[3] << 24) + (le32[2] << 16) + (le32[1] << 8) + le32[0]);
  59 }
  60
  61 /* Convert char[8] in little endian format to the host format integer
  62  */
  63 static inline unsigned long long le64_to_int(unsigned char *le64)
  64 {
  65         return (((unsigned long long)le64[7] << 56) +
  66                 ((unsigned long long)le64[6] << 48) +
  67                 ((unsigned long long)le64[5] << 40) +
  68                 ((unsigned long long)le64[4] << 32) +
  69                 ((unsigned long long)le64[3] << 24) +
  70                 ((unsigned long long)le64[2] << 16) +
  71                 ((unsigned long long)le64[1] << 8) +
  72                 (unsigned long long)le64[0]);
  73 }
  74
  75 /**
  76  * efi_crc32() - EFI version of crc32 function
  77  * @buf: buffer to calculate crc32 of
  78  * @len - length of buf
  79  *
  80  * Description: Returns EFI-style CRC32 value for @buf
  81  */
  82 static inline unsigned long efi_crc32(const void *buf, unsigned long len)
  83 {
  84         return crc32(0, buf, len);
  85 }
  86
  87 /*
  88  * Private function prototypes
  89  */
  90
  91 static int pmbr_part_valid(struct partition *part);
  92 static int is_pmbr_valid(legacy_mbr * mbr);
  93
  94 static int is_gpt_valid(block_dev_desc_t * dev_desc, unsigned long long lba,
  95                                 gpt_header * pgpt_head, gpt_entry ** pgpt_pte);
  96
  97 static gpt_entry *alloc_read_gpt_entries(block_dev_desc_t * dev_desc,
  98                                 gpt_header * pgpt_head);
  99
 100 static int is_pte_valid(gpt_entry * pte);
 101
 102 static char *print_efiname(gpt_entry *pte)
 103 {
 104         static char name[PARTNAME_SZ + 1];
 105         int i;
 106         for (i = 0; i < PARTNAME_SZ; i++) {
 107                 u8 c;
 108                 c = pte->partition_name[i] & 0xff;
 109                 c = (c && !isprint(c)) ? '.' : c;
 110                 name[i] = c;
 111         }
 112         name[PARTNAME_SZ] = 0;
 113         return name;
 114 }
 115
 116 /*
 117  * Public Functions (include/part.h)
 118  */
 119
 120 void print_part_efi(block_dev_desc_t * dev_desc)
 121 {
 122         ALLOC_CACHE_ALIGN_BUFFER(gpt_header, gpt_head, 1);
 123         gpt_entry *gpt_pte = NULL;
 124         int i = 0;
 125
 126         if (!dev_desc) {
 127                 printf("%s: Invalid Argument(s)\n", __func__);
 128                 return;
 129         }
 130         /* This function validates AND fills in the GPT header and PTE */
 131         if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
 132                          gpt_head, &gpt_pte) != 1) {
 133                 printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
 134                 return;
 135         }
 136
 137         debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
 138
 139         printf("Part\tName\t\t\tStart LBA\tEnd LBA\n");
 140         for (i = 0; i < le32_to_int(gpt_head->num_partition_entries); i++) {
 141
 142                 if (is_pte_valid(&gpt_pte[i])) {
 143                         printf("%3d\t%-18s\t0x%08llX\t0x%08llX\n", (i + 1),
 144                                 print_efiname(&gpt_pte[i]),
 145                                 le64_to_int(gpt_pte[i].starting_lba),
 146                                 le64_to_int(gpt_pte[i].ending_lba));
 147                 } else {
 148                         break;  /* Stop at the first non valid PTE */
 149                 }
 150         }
 151
 152         /* Remember to free pte */
 153         free(gpt_pte);
 154         return;
 155 }
 156
 157 #ifdef CONFIG_PARTITION_UUIDS
 158 static void uuid_string(unsigned char *uuid, char *str)
 159 {
 160         static const u8 le[16] = {3, 2, 1, 0, 5, 4, 7, 6, 8, 9, 10, 11,
 161                                   12, 13, 14, 15};
 162         int i;
 163
 164         for (i = 0; i < 16; i++) {
 165                 sprintf(str, "%02x", uuid[le[i]]);
 166                 str += 2;
 167                 switch (i) {
 168                 case 3:
 169                 case 5:
 170                 case 7:
 171                 case 9:
 172                         *str++ = '-';
 173                         break;
 174                 }
 175         }
 176 }
 177 #endif
 178
 179 int get_partition_info_efi(block_dev_desc_t * dev_desc, int part,
 180                                 disk_partition_t * info)
 181 {
 182         ALLOC_CACHE_ALIGN_BUFFER(gpt_header, gpt_head, 1);
 183         gpt_entry *gpt_pte = NULL;
 184
 185         /* "part" argument must be at least 1 */
 186         if (!dev_desc || !info || part < 1) {
 187                 printf("%s: Invalid Argument(s)\n", __func__);
 188                 return -1;
 189         }
 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                 return -1;
 196         }
 197
 198         if (part > le32_to_int(gpt_head->num_partition_entries) ||
 199             !is_pte_valid(&gpt_pte[part - 1])) {
 200                 printf("%s: *** ERROR: Invalid partition number %d ***\n",
 201                         __func__, part);
 202                 return -1;
 203         }
 204
 205         /* The ulong casting limits the maximum disk size to 2 TB */
 206         info->start = (ulong) le64_to_int(gpt_pte[part - 1].starting_lba);
 207         /* The ending LBA is inclusive, to calculate size, add 1 to it */
 208         info->size = ((ulong)le64_to_int(gpt_pte[part - 1].ending_lba) + 1)
 209                      - info->start;
 210         info->blksz = GPT_BLOCK_SIZE;
 211
 212         sprintf((char *)info->name, "%s",
 213                         print_efiname(&gpt_pte[part - 1]));
 214         sprintf((char *)info->type, "U-Boot");
 215 #ifdef CONFIG_PARTITION_UUIDS
 216         uuid_string(gpt_pte[part - 1].unique_partition_guid.b, info->uuid);
 217 #endif
 218
 219         debug("%s: start 0x%lX, size 0x%lX, name %s", __func__,
 220                 info->start, info->size, info->name);
 221
 222         /* Remember to free pte */
 223         free(gpt_pte);
 224         return 0;
 225 }
 226
 227 int test_part_efi(block_dev_desc_t * dev_desc)
 228 {
 229         ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, legacymbr, 1);
 230
 231         /* Read legacy MBR from block 0 and validate it */
 232         if ((dev_desc->block_read(dev_desc->dev, 0, 1, (ulong *)legacymbr) != 1)
 233                 || (is_pmbr_valid(legacymbr) != 1)) {
 234                 return -1;
 235         }
 236         return 0;
 237 }
 238
 239 /*
 240  * Private functions
 241  */
 242 /*
 243  * pmbr_part_valid(): Check for EFI partition signature
 244  *
 245  * Returns: 1 if EFI GPT partition type is found.
 246  */
 247 static int pmbr_part_valid(struct partition *part)
 248 {
 249         if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
 250                 le32_to_int(part->start_sect) == 1UL) {
 251                 return 1;
 252         }
 253
 254         return 0;
 255 }
 256
 257 /*
 258  * is_pmbr_valid(): test Protective MBR for validity
 259  *
 260  * Returns: 1 if PMBR is valid, 0 otherwise.
 261  * Validity depends on two things:
 262  *  1) MSDOS signature is in the last two bytes of the MBR
 263  *  2) One partition of type 0xEE is found, checked by pmbr_part_valid()
 264  */
 265 static int is_pmbr_valid(legacy_mbr * mbr)
 266 {
 267         int i = 0;
 268
 269         if (!mbr || le16_to_int(mbr->signature) != MSDOS_MBR_SIGNATURE) {
 270                 return 0;
 271         }
 272
 273         for (i = 0; i < 4; i++) {
 274                 if (pmbr_part_valid(&mbr->partition_record[i])) {
 275                         return 1;
 276                 }
 277         }
 278         return 0;
 279 }
 280
 281 /**
 282  * is_gpt_valid() - tests one GPT header and PTEs for validity
 283  *
 284  * lba is the logical block address of the GPT header to test
 285  * gpt is a GPT header ptr, filled on return.
 286  * ptes is a PTEs ptr, filled on return.
 287  *
 288  * Description: returns 1 if valid,  0 on error.
 289  * If valid, returns pointers to PTEs.
 290  */
 291 static int is_gpt_valid(block_dev_desc_t * dev_desc, unsigned long long lba,
 292                         gpt_header * pgpt_head, gpt_entry ** pgpt_pte)
 293 {
 294         unsigned char crc32_backup[4] = { 0 };
 295         unsigned long calc_crc32;
 296         unsigned long long lastlba;
 297
 298         if (!dev_desc || !pgpt_head) {
 299                 printf("%s: Invalid Argument(s)\n", __func__);
 300                 return 0;
 301         }
 302
 303         /* Read GPT Header from device */
 304         if (dev_desc->block_read(dev_desc->dev, lba, 1, pgpt_head) != 1) {
 305                 printf("*** ERROR: Can't read GPT header ***\n");
 306                 return 0;
 307         }
 308
 309         /* Check the GPT header signature */
 310         if (le64_to_int(pgpt_head->signature) != GPT_HEADER_SIGNATURE) {
 311                 printf("GUID Partition Table Header signature is wrong:"
 312                         "0x%llX != 0x%llX\n",
 313                         (unsigned long long)le64_to_int(pgpt_head->signature),
 314                         (unsigned long long)GPT_HEADER_SIGNATURE);
 315                 return 0;
 316         }
 317
 318         /* Check the GUID Partition Table CRC */
 319         memcpy(crc32_backup, pgpt_head->header_crc32, sizeof(crc32_backup));
 320         memset(pgpt_head->header_crc32, 0, sizeof(pgpt_head->header_crc32));
 321
 322         calc_crc32 = efi_crc32((const unsigned char *)pgpt_head,
 323                 le32_to_int(pgpt_head->header_size));
 324
 325         memcpy(pgpt_head->header_crc32, crc32_backup, sizeof(crc32_backup));
 326
 327         if (calc_crc32 != le32_to_int(crc32_backup)) {
 328                 printf("GUID Partition Table Header CRC is wrong:"
 329                         "0x%08lX != 0x%08lX\n",
 330                         le32_to_int(crc32_backup), calc_crc32);
 331                 return 0;
 332         }
 333
 334         /* Check that the my_lba entry points to the LBA that contains the GPT */
 335         if (le64_to_int(pgpt_head->my_lba) != lba) {
 336                 printf("GPT: my_lba incorrect: %llX != %llX\n",
 337                         (unsigned long long)le64_to_int(pgpt_head->my_lba),
 338                         (unsigned long long)lba);
 339                 return 0;
 340         }
 341
 342         /* Check the first_usable_lba and last_usable_lba are within the disk. */
 343         lastlba = (unsigned long long)dev_desc->lba;
 344         if (le64_to_int(pgpt_head->first_usable_lba) > lastlba) {
 345                 printf("GPT: first_usable_lba incorrect: %llX > %llX\n",
 346                         le64_to_int(pgpt_head->first_usable_lba), lastlba);
 347                 return 0;
 348         }
 349         if (le64_to_int(pgpt_head->last_usable_lba) > lastlba) {
 350                 printf("GPT: last_usable_lba incorrect: %llX > %llX\n",
 351                         le64_to_int(pgpt_head->last_usable_lba), lastlba);
 352                 return 0;
 353         }
 354
 355         debug("GPT: first_usable_lba: %llX last_usable_lba %llX last lba %llX\n",
 356                 le64_to_int(pgpt_head->first_usable_lba),
 357                 le64_to_int(pgpt_head->last_usable_lba), lastlba);
 358
 359         /* Read and allocate Partition Table Entries */
 360         *pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
 361         if (*pgpt_pte == NULL) {
 362                 printf("GPT: Failed to allocate memory for PTE\n");
 363                 return 0;
 364         }
 365
 366         /* Check the GUID Partition Table Entry Array CRC */
 367         calc_crc32 = efi_crc32((const unsigned char *)*pgpt_pte,
 368                 le32_to_int(pgpt_head->num_partition_entries) *
 369                 le32_to_int(pgpt_head->sizeof_partition_entry));
 370
 371         if (calc_crc32 != le32_to_int(pgpt_head->partition_entry_array_crc32)) {
 372                 printf("GUID Partition Table Entry Array CRC is wrong:"
 373                         "0x%08lX != 0x%08lX\n",
 374                         le32_to_int(pgpt_head->partition_entry_array_crc32),
 375                         calc_crc32);
 376
 377                 free(*pgpt_pte);
 378                 return 0;
 379         }
 380
 381         /* We're done, all's well */
 382         return 1;
 383 }
 384
 385 /**
 386  * alloc_read_gpt_entries(): reads partition entries from disk
 387  * @dev_desc
 388  * @gpt - GPT header
 389  *
 390  * Description: Returns ptes on success,  NULL on error.
 391  * Allocates space for PTEs based on information found in @gpt.
 392  * Notes: remember to free pte when you're done!
 393  */
 394 static gpt_entry *alloc_read_gpt_entries(block_dev_desc_t * dev_desc,
 395                                          gpt_header * pgpt_head)
 396 {
 397         size_t count = 0;
 398         gpt_entry *pte = NULL;
 399
 400         if (!dev_desc || !pgpt_head) {
 401                 printf("%s: Invalid Argument(s)\n", __func__);
 402                 return NULL;
 403         }
 404
 405         count = le32_to_int(pgpt_head->num_partition_entries) *
 406                 le32_to_int(pgpt_head->sizeof_partition_entry);
 407
 408         debug("%s: count = %lu * %lu = %u\n", __func__,
 409                 le32_to_int(pgpt_head->num_partition_entries),
 410                 le32_to_int(pgpt_head->sizeof_partition_entry), count);
 411
 412         /* Allocate memory for PTE, remember to FREE */
 413         if (count != 0) {
 414                 pte = memalign(ARCH_DMA_MINALIGN, count);
 415         }
 416
 417         if (count == 0 || pte == NULL) {
 418                 printf("%s: ERROR: Can't allocate 0x%X bytes for GPT Entries\n",
 419                         __func__, count);
 420                 return NULL;
 421         }
 422
 423         /* Read GPT Entries from device */
 424         if (dev_desc->block_read (dev_desc->dev,
 425                 (unsigned long)le64_to_int(pgpt_head->partition_entry_lba),
 426                 (lbaint_t) (count / GPT_BLOCK_SIZE), pte)
 427                 != (count / GPT_BLOCK_SIZE)) {
 428
 429                 printf("*** ERROR: Can't read GPT Entries ***\n");
 430                 free(pte);
 431                 return NULL;
 432         }
 433         return pte;
 434 }
 435
 436 /**
 437  * is_pte_valid(): validates a single Partition Table Entry
 438  * @gpt_entry - Pointer to a single Partition Table Entry
 439  *
 440  * Description: returns 1 if valid,  0 on error.
 441  */
 442 static int is_pte_valid(gpt_entry * pte)
 443 {
 444         efi_guid_t unused_guid;
 445
 446         if (!pte) {
 447                 printf("%s: Invalid Argument(s)\n", __func__);
 448                 return 0;
 449         }
 450
 451         /* Only one validation for now:
 452          * The GUID Partition Type != Unused Entry (ALL-ZERO)
 453          */
 454         memset(unused_guid.b, 0, sizeof(unused_guid.b));
 455
 456         if (memcmp(pte->partition_type_guid.b, unused_guid.b,
 457                 sizeof(unused_guid.b)) == 0) {
 458
 459                 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
 460                 (unsigned int)pte);
 461
 462                 return 0;
 463         } else {
 464                 return 1;
 465         }
 466 }
 467 #endif