2 * Copyright (C) 2008 RuggedCom, Inc.
3 * Richard Retanubun <RichardRetanubun@RuggedCom.com>
5 * SPDX-License-Identifier: GPL-2.0+
9 * Problems with CONFIG_SYS_64BIT_LBA:
11 * struct disk_partition.start in include/part.h is sized as ulong.
12 * When CONFIG_SYS_64BIT_LBA is activated, lbaint_t changes from ulong to uint64_t.
13 * For now, it is cast back to ulong at assignment.
15 * This limits the maximum size of addressable storage to < 2 Terra Bytes
17 #include <asm/unaligned.h>
23 #include <linux/ctype.h>
25 DECLARE_GLOBAL_DATA_PTR;
27 #ifdef HAVE_BLOCK_DEVICE
29 * efi_crc32() - EFI version of crc32 function
30 * @buf: buffer to calculate crc32 of
31 * @len - length of buf
33 * Description: Returns EFI-style CRC32 value for @buf
35 static inline u32 efi_crc32(const void *buf, u32 len)
37 return crc32(0, buf, len);
41 * Private function prototypes
44 static int pmbr_part_valid(struct partition *part);
45 static int is_pmbr_valid(legacy_mbr * mbr);
46 static int is_gpt_valid(block_dev_desc_t * dev_desc, unsigned long long lba,
47 gpt_header * pgpt_head, gpt_entry ** pgpt_pte);
48 static gpt_entry *alloc_read_gpt_entries(block_dev_desc_t * dev_desc,
49 gpt_header * pgpt_head);
50 static int is_pte_valid(gpt_entry * pte);
52 static char *print_efiname(gpt_entry *pte)
54 static char name[PARTNAME_SZ + 1];
56 for (i = 0; i < PARTNAME_SZ; i++) {
58 c = pte->partition_name[i] & 0xff;
59 c = (c && !isprint(c)) ? '.' : c;
62 name[PARTNAME_SZ] = 0;
66 static efi_guid_t system_guid = PARTITION_SYSTEM_GUID;
68 static inline int is_bootable(gpt_entry *p)
70 return p->attributes.fields.legacy_bios_bootable ||
71 !memcmp(&(p->partition_type_guid), &system_guid,
75 #ifdef CONFIG_EFI_PARTITION
77 * Public Functions (include/part.h)
80 void print_part_efi(block_dev_desc_t * dev_desc)
82 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
83 gpt_entry *gpt_pte = NULL;
86 unsigned char *uuid_bin;
89 printf("%s: Invalid Argument(s)\n", __func__);
92 /* This function validates AND fills in the GPT header and PTE */
93 if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
94 gpt_head, &gpt_pte) != 1) {
95 printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
96 if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
97 gpt_head, &gpt_pte) != 1) {
98 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
102 printf("%s: *** Using Backup GPT ***\n",
107 debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
109 printf("Part\tStart LBA\tEnd LBA\t\tName\n");
110 printf("\tAttributes\n");
111 printf("\tType GUID\n");
112 printf("\tPartition GUID\n");
114 for (i = 0; i < le32_to_cpu(gpt_head->num_partition_entries); i++) {
115 /* Stop at the first non valid PTE */
116 if (!is_pte_valid(&gpt_pte[i]))
119 printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i + 1),
120 le64_to_cpu(gpt_pte[i].starting_lba),
121 le64_to_cpu(gpt_pte[i].ending_lba),
122 print_efiname(&gpt_pte[i]));
123 printf("\tattrs:\t0x%016llx\n", gpt_pte[i].attributes.raw);
124 uuid_bin = (unsigned char *)gpt_pte[i].partition_type_guid.b;
125 uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
126 printf("\ttype:\t%s\n", uuid);
127 uuid_bin = (unsigned char *)gpt_pte[i].unique_partition_guid.b;
128 uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
129 printf("\tguid:\t%s\n", uuid);
132 /* Remember to free pte */
137 int get_partition_info_efi(block_dev_desc_t * dev_desc, int part,
138 disk_partition_t * info)
140 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
141 gpt_entry *gpt_pte = NULL;
143 /* "part" argument must be at least 1 */
144 if (!dev_desc || !info || part < 1) {
145 printf("%s: Invalid Argument(s)\n", __func__);
149 /* This function validates AND fills in the GPT header and PTE */
150 if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
151 gpt_head, &gpt_pte) != 1) {
152 printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
153 if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
154 gpt_head, &gpt_pte) != 1) {
155 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
159 printf("%s: *** Using Backup GPT ***\n",
164 if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
165 !is_pte_valid(&gpt_pte[part - 1])) {
166 debug("%s: *** ERROR: Invalid partition number %d ***\n",
172 /* The ulong casting limits the maximum disk size to 2 TB */
173 info->start = (u64)le64_to_cpu(gpt_pte[part - 1].starting_lba);
174 /* The ending LBA is inclusive, to calculate size, add 1 to it */
175 info->size = ((u64)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1)
177 info->blksz = dev_desc->blksz;
179 sprintf((char *)info->name, "%s",
180 print_efiname(&gpt_pte[part - 1]));
181 sprintf((char *)info->type, "U-Boot");
182 info->bootable = is_bootable(&gpt_pte[part - 1]);
183 #ifdef CONFIG_PARTITION_UUIDS
184 uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b, info->uuid,
185 UUID_STR_FORMAT_GUID);
188 debug("%s: start 0x" LBAF ", size 0x" LBAF ", name %s", __func__,
189 info->start, info->size, info->name);
191 /* Remember to free pte */
196 int test_part_efi(block_dev_desc_t * dev_desc)
198 ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, dev_desc->blksz);
200 /* Read legacy MBR from block 0 and validate it */
201 if ((dev_desc->block_read(dev_desc->dev, 0, 1, (ulong *)legacymbr) != 1)
202 || (is_pmbr_valid(legacymbr) != 1)) {
209 * set_protective_mbr(): Set the EFI protective MBR
210 * @param dev_desc - block device descriptor
212 * @return - zero on success, otherwise error
214 static int set_protective_mbr(block_dev_desc_t *dev_desc)
216 /* Setup the Protective MBR */
217 ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, p_mbr, 1);
218 memset(p_mbr, 0, sizeof(*p_mbr));
221 printf("%s: calloc failed!\n", __func__);
224 /* Append signature */
225 p_mbr->signature = MSDOS_MBR_SIGNATURE;
226 p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
227 p_mbr->partition_record[0].start_sect = 1;
228 p_mbr->partition_record[0].nr_sects = (u32) dev_desc->lba;
230 /* Write MBR sector to the MMC device */
231 if (dev_desc->block_write(dev_desc->dev, 0, 1, p_mbr) != 1) {
232 printf("** Can't write to device %d **\n",
240 int write_gpt_table(block_dev_desc_t *dev_desc,
241 gpt_header *gpt_h, gpt_entry *gpt_e)
243 const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
244 * sizeof(gpt_entry)), dev_desc);
248 debug("max lba: %x\n", (u32) dev_desc->lba);
249 /* Setup the Protective MBR */
250 if (set_protective_mbr(dev_desc) < 0)
253 /* Generate CRC for the Primary GPT Header */
254 calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
255 le32_to_cpu(gpt_h->num_partition_entries) *
256 le32_to_cpu(gpt_h->sizeof_partition_entry));
257 gpt_h->partition_entry_array_crc32 = cpu_to_le32(calc_crc32);
259 calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
260 le32_to_cpu(gpt_h->header_size));
261 gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
263 /* Write the First GPT to the block right after the Legacy MBR */
264 if (dev_desc->block_write(dev_desc->dev, 1, 1, gpt_h) != 1)
267 if (dev_desc->block_write(dev_desc->dev, 2, pte_blk_cnt, gpt_e)
271 /* recalculate the values for the Backup GPT Header */
272 val = le64_to_cpu(gpt_h->my_lba);
273 gpt_h->my_lba = gpt_h->alternate_lba;
274 gpt_h->alternate_lba = cpu_to_le64(val);
275 gpt_h->header_crc32 = 0;
277 calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
278 le32_to_cpu(gpt_h->header_size));
279 gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
281 if (dev_desc->block_write(dev_desc->dev,
282 le32_to_cpu(gpt_h->last_usable_lba + 1),
283 pte_blk_cnt, gpt_e) != pte_blk_cnt)
286 if (dev_desc->block_write(dev_desc->dev,
287 le32_to_cpu(gpt_h->my_lba), 1, gpt_h) != 1)
290 debug("GPT successfully written to block device!\n");
294 printf("** Can't write to device %d **\n", dev_desc->dev);
298 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
299 disk_partition_t *partitions, int parts)
301 u32 offset = (u32)le32_to_cpu(gpt_h->first_usable_lba);
304 size_t efiname_len, dosname_len;
305 #ifdef CONFIG_PARTITION_UUIDS
307 unsigned char *bin_uuid;
310 for (i = 0; i < parts; i++) {
311 /* partition starting lba */
312 start = partitions[i].start;
313 if (start && (start < offset)) {
314 printf("Partition overlap\n");
318 gpt_e[i].starting_lba = cpu_to_le64(start);
319 offset = start + partitions[i].size;
321 gpt_e[i].starting_lba = cpu_to_le64(offset);
322 offset += partitions[i].size;
324 if (offset >= gpt_h->last_usable_lba) {
325 printf("Partitions layout exceds disk size\n");
328 /* partition ending lba */
329 if ((i == parts - 1) && (partitions[i].size == 0))
330 /* extend the last partition to maximuim */
331 gpt_e[i].ending_lba = gpt_h->last_usable_lba;
333 gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
335 /* partition type GUID */
336 memcpy(gpt_e[i].partition_type_guid.b,
337 &PARTITION_BASIC_DATA_GUID, 16);
339 #ifdef CONFIG_PARTITION_UUIDS
340 str_uuid = partitions[i].uuid;
341 bin_uuid = gpt_e[i].unique_partition_guid.b;
343 if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_STD)) {
344 printf("Partition no. %d: invalid guid: %s\n",
350 /* partition attributes */
351 memset(&gpt_e[i].attributes, 0,
352 sizeof(gpt_entry_attributes));
355 efiname_len = sizeof(gpt_e[i].partition_name)
356 / sizeof(efi_char16_t);
357 dosname_len = sizeof(partitions[i].name);
359 memset(gpt_e[i].partition_name, 0,
360 sizeof(gpt_e[i].partition_name));
362 for (k = 0; k < min(dosname_len, efiname_len); k++)
363 gpt_e[i].partition_name[k] =
364 (efi_char16_t)(partitions[i].name[k]);
366 debug("%s: name: %s offset[%d]: 0x%x size[%d]: 0x" LBAF "\n",
367 __func__, partitions[i].name, i,
368 offset, i, partitions[i].size);
374 int gpt_fill_header(block_dev_desc_t *dev_desc, gpt_header *gpt_h,
375 char *str_guid, int parts_count)
377 gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE);
378 gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
379 gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
380 gpt_h->my_lba = cpu_to_le64(1);
381 gpt_h->alternate_lba = cpu_to_le64(dev_desc->lba - 1);
382 gpt_h->first_usable_lba = cpu_to_le64(34);
383 gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
384 gpt_h->partition_entry_lba = cpu_to_le64(2);
385 gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
386 gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
387 gpt_h->header_crc32 = 0;
388 gpt_h->partition_entry_array_crc32 = 0;
390 if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
396 int gpt_restore(block_dev_desc_t *dev_desc, char *str_disk_guid,
397 disk_partition_t *partitions, int parts_count)
401 gpt_header *gpt_h = calloc(1, PAD_TO_BLOCKSIZE(sizeof(gpt_header),
406 printf("%s: calloc failed!\n", __func__);
410 gpt_e = calloc(1, PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS
414 printf("%s: calloc failed!\n", __func__);
419 /* Generate Primary GPT header (LBA1) */
420 ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
424 /* Generate partition entries */
425 ret = gpt_fill_pte(gpt_h, gpt_e, partitions, parts_count);
429 /* Write GPT partition table */
430 ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
443 * pmbr_part_valid(): Check for EFI partition signature
445 * Returns: 1 if EFI GPT partition type is found.
447 static int pmbr_part_valid(struct partition *part)
449 if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
450 get_unaligned_le32(&part->start_sect) == 1UL) {
458 * is_pmbr_valid(): test Protective MBR for validity
460 * Returns: 1 if PMBR is valid, 0 otherwise.
461 * Validity depends on two things:
462 * 1) MSDOS signature is in the last two bytes of the MBR
463 * 2) One partition of type 0xEE is found, checked by pmbr_part_valid()
465 static int is_pmbr_valid(legacy_mbr * mbr)
469 if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
472 for (i = 0; i < 4; i++) {
473 if (pmbr_part_valid(&mbr->partition_record[i])) {
481 * is_gpt_valid() - tests one GPT header and PTEs for validity
483 * lba is the logical block address of the GPT header to test
484 * gpt is a GPT header ptr, filled on return.
485 * ptes is a PTEs ptr, filled on return.
487 * Description: returns 1 if valid, 0 on error.
488 * If valid, returns pointers to PTEs.
490 static int is_gpt_valid(block_dev_desc_t * dev_desc, unsigned long long lba,
491 gpt_header * pgpt_head, gpt_entry ** pgpt_pte)
493 u32 crc32_backup = 0;
495 unsigned long long lastlba;
497 if (!dev_desc || !pgpt_head) {
498 printf("%s: Invalid Argument(s)\n", __func__);
502 /* Read GPT Header from device */
503 if (dev_desc->block_read(dev_desc->dev, lba, 1, pgpt_head) != 1) {
504 printf("*** ERROR: Can't read GPT header ***\n");
508 /* Check the GPT header signature */
509 if (le64_to_cpu(pgpt_head->signature) != GPT_HEADER_SIGNATURE) {
510 printf("GUID Partition Table Header signature is wrong:"
511 "0x%llX != 0x%llX\n",
512 le64_to_cpu(pgpt_head->signature),
513 GPT_HEADER_SIGNATURE);
517 /* Check the GUID Partition Table CRC */
518 memcpy(&crc32_backup, &pgpt_head->header_crc32, sizeof(crc32_backup));
519 memset(&pgpt_head->header_crc32, 0, sizeof(pgpt_head->header_crc32));
521 calc_crc32 = efi_crc32((const unsigned char *)pgpt_head,
522 le32_to_cpu(pgpt_head->header_size));
524 memcpy(&pgpt_head->header_crc32, &crc32_backup, sizeof(crc32_backup));
526 if (calc_crc32 != le32_to_cpu(crc32_backup)) {
527 printf("GUID Partition Table Header CRC is wrong:"
529 le32_to_cpu(crc32_backup), calc_crc32);
533 /* Check that the my_lba entry points to the LBA that contains the GPT */
534 if (le64_to_cpu(pgpt_head->my_lba) != lba) {
535 printf("GPT: my_lba incorrect: %llX != %llX\n",
536 le64_to_cpu(pgpt_head->my_lba),
541 /* Check the first_usable_lba and last_usable_lba are within the disk. */
542 lastlba = (unsigned long long)dev_desc->lba;
543 if (le64_to_cpu(pgpt_head->first_usable_lba) > lastlba) {
544 printf("GPT: first_usable_lba incorrect: %llX > %llX\n",
545 le64_to_cpu(pgpt_head->first_usable_lba), lastlba);
548 if (le64_to_cpu(pgpt_head->last_usable_lba) > lastlba) {
549 printf("GPT: last_usable_lba incorrect: %llX > %llX\n",
550 (u64) le64_to_cpu(pgpt_head->last_usable_lba), lastlba);
554 debug("GPT: first_usable_lba: %llX last_usable_lba %llX last lba %llX\n",
555 le64_to_cpu(pgpt_head->first_usable_lba),
556 le64_to_cpu(pgpt_head->last_usable_lba), lastlba);
558 /* Read and allocate Partition Table Entries */
559 *pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
560 if (*pgpt_pte == NULL) {
561 printf("GPT: Failed to allocate memory for PTE\n");
565 /* Check the GUID Partition Table Entry Array CRC */
566 calc_crc32 = efi_crc32((const unsigned char *)*pgpt_pte,
567 le32_to_cpu(pgpt_head->num_partition_entries) *
568 le32_to_cpu(pgpt_head->sizeof_partition_entry));
570 if (calc_crc32 != le32_to_cpu(pgpt_head->partition_entry_array_crc32)) {
571 printf("GUID Partition Table Entry Array CRC is wrong:"
573 le32_to_cpu(pgpt_head->partition_entry_array_crc32),
580 /* We're done, all's well */
585 * alloc_read_gpt_entries(): reads partition entries from disk
589 * Description: Returns ptes on success, NULL on error.
590 * Allocates space for PTEs based on information found in @gpt.
591 * Notes: remember to free pte when you're done!
593 static gpt_entry *alloc_read_gpt_entries(block_dev_desc_t * dev_desc,
594 gpt_header * pgpt_head)
596 size_t count = 0, blk_cnt;
597 gpt_entry *pte = NULL;
599 if (!dev_desc || !pgpt_head) {
600 printf("%s: Invalid Argument(s)\n", __func__);
604 count = le32_to_cpu(pgpt_head->num_partition_entries) *
605 le32_to_cpu(pgpt_head->sizeof_partition_entry);
607 debug("%s: count = %u * %u = %zu\n", __func__,
608 (u32) le32_to_cpu(pgpt_head->num_partition_entries),
609 (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry), count);
611 /* Allocate memory for PTE, remember to FREE */
613 pte = memalign(ARCH_DMA_MINALIGN,
614 PAD_TO_BLOCKSIZE(count, dev_desc));
617 if (count == 0 || pte == NULL) {
618 printf("%s: ERROR: Can't allocate 0x%zX "
619 "bytes for GPT Entries\n",
624 /* Read GPT Entries from device */
625 blk_cnt = BLOCK_CNT(count, dev_desc);
626 if (dev_desc->block_read (dev_desc->dev,
627 le64_to_cpu(pgpt_head->partition_entry_lba),
628 (lbaint_t) (blk_cnt), pte)
631 printf("*** ERROR: Can't read GPT Entries ***\n");
639 * is_pte_valid(): validates a single Partition Table Entry
640 * @gpt_entry - Pointer to a single Partition Table Entry
642 * Description: returns 1 if valid, 0 on error.
644 static int is_pte_valid(gpt_entry * pte)
646 efi_guid_t unused_guid;
649 printf("%s: Invalid Argument(s)\n", __func__);
653 /* Only one validation for now:
654 * The GUID Partition Type != Unused Entry (ALL-ZERO)
656 memset(unused_guid.b, 0, sizeof(unused_guid.b));
658 if (memcmp(pte->partition_type_guid.b, unused_guid.b,
659 sizeof(unused_guid.b)) == 0) {
661 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
662 (unsigned int)(uintptr_t)pte);