2 * Copyright (C) 2008 RuggedCom, Inc.
3 * Richard Retanubun <RichardRetanubun@RuggedCom.com>
5 * SPDX-License-Identifier: GPL-2.0+
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
13 #include <asm/unaligned.h>
20 #include <linux/ctype.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 #ifdef HAVE_BLOCK_DEVICE
26 * efi_crc32() - EFI version of crc32 function
27 * @buf: buffer to calculate crc32 of
28 * @len - length of buf
30 * Description: Returns EFI-style CRC32 value for @buf
32 static inline u32 efi_crc32(const void *buf, u32 len)
34 return crc32(0, buf, len);
38 * Private function prototypes
41 static int pmbr_part_valid(struct partition *part);
42 static int is_pmbr_valid(legacy_mbr * mbr);
43 static int is_gpt_valid(block_dev_desc_t *dev_desc, u64 lba,
44 gpt_header *pgpt_head, gpt_entry **pgpt_pte);
45 static gpt_entry *alloc_read_gpt_entries(block_dev_desc_t * dev_desc,
46 gpt_header * pgpt_head);
47 static int is_pte_valid(gpt_entry * pte);
49 static char *print_efiname(gpt_entry *pte)
51 static char name[PARTNAME_SZ + 1];
53 for (i = 0; i < PARTNAME_SZ; i++) {
55 c = pte->partition_name[i] & 0xff;
56 c = (c && !isprint(c)) ? '.' : c;
59 name[PARTNAME_SZ] = 0;
63 static efi_guid_t system_guid = PARTITION_SYSTEM_GUID;
65 static inline int is_bootable(gpt_entry *p)
67 return p->attributes.fields.legacy_bios_bootable ||
68 !memcmp(&(p->partition_type_guid), &system_guid,
72 static int validate_gpt_header(gpt_header *gpt_h, lbaint_t lba,
75 uint32_t crc32_backup = 0;
78 /* Check the GPT header signature */
79 if (le64_to_cpu(gpt_h->signature) != GPT_HEADER_SIGNATURE) {
80 printf("%s signature is wrong: 0x%llX != 0x%llX\n",
81 "GUID Partition Table Header",
82 le64_to_cpu(gpt_h->signature),
83 GPT_HEADER_SIGNATURE);
87 /* Check the GUID Partition Table CRC */
88 memcpy(&crc32_backup, &gpt_h->header_crc32, sizeof(crc32_backup));
89 memset(&gpt_h->header_crc32, 0, sizeof(gpt_h->header_crc32));
91 calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
92 le32_to_cpu(gpt_h->header_size));
94 memcpy(&gpt_h->header_crc32, &crc32_backup, sizeof(crc32_backup));
96 if (calc_crc32 != le32_to_cpu(crc32_backup)) {
97 printf("%s CRC is wrong: 0x%x != 0x%x\n",
98 "GUID Partition Table Header",
99 le32_to_cpu(crc32_backup), calc_crc32);
104 * Check that the my_lba entry points to the LBA that contains the GPT
106 if (le64_to_cpu(gpt_h->my_lba) != lba) {
107 printf("GPT: my_lba incorrect: %llX != " LBAF "\n",
108 le64_to_cpu(gpt_h->my_lba),
114 * Check that the first_usable_lba and that the last_usable_lba are
117 if (le64_to_cpu(gpt_h->first_usable_lba) > lastlba) {
118 printf("GPT: first_usable_lba incorrect: %llX > " LBAF "\n",
119 le64_to_cpu(gpt_h->first_usable_lba), lastlba);
122 if (le64_to_cpu(gpt_h->last_usable_lba) > lastlba) {
123 printf("GPT: last_usable_lba incorrect: %llX > " LBAF "\n",
124 le64_to_cpu(gpt_h->last_usable_lba), lastlba);
128 debug("GPT: first_usable_lba: %llX last_usable_lba: %llX last lba: "
129 LBAF "\n", le64_to_cpu(gpt_h->first_usable_lba),
130 le64_to_cpu(gpt_h->last_usable_lba), lastlba);
135 static int validate_gpt_entries(gpt_header *gpt_h, gpt_entry *gpt_e)
139 /* Check the GUID Partition Table Entry Array CRC */
140 calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
141 le32_to_cpu(gpt_h->num_partition_entries) *
142 le32_to_cpu(gpt_h->sizeof_partition_entry));
144 if (calc_crc32 != le32_to_cpu(gpt_h->partition_entry_array_crc32)) {
145 printf("%s: 0x%x != 0x%x\n",
146 "GUID Partition Table Entry Array CRC is wrong",
147 le32_to_cpu(gpt_h->partition_entry_array_crc32),
155 static void prepare_backup_gpt_header(gpt_header *gpt_h)
160 /* recalculate the values for the Backup GPT Header */
161 val = le64_to_cpu(gpt_h->my_lba);
162 gpt_h->my_lba = gpt_h->alternate_lba;
163 gpt_h->alternate_lba = cpu_to_le64(val);
164 gpt_h->header_crc32 = 0;
166 calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
167 le32_to_cpu(gpt_h->header_size));
168 gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
171 #ifdef CONFIG_EFI_PARTITION
173 * Public Functions (include/part.h)
176 void print_part_efi(block_dev_desc_t * dev_desc)
178 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
179 gpt_entry *gpt_pte = NULL;
182 unsigned char *uuid_bin;
185 printf("%s: Invalid Argument(s)\n", __func__);
188 /* This function validates AND fills in the GPT header and PTE */
189 if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
190 gpt_head, &gpt_pte) != 1) {
191 printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
192 if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
193 gpt_head, &gpt_pte) != 1) {
194 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
198 printf("%s: *** Using Backup GPT ***\n",
203 debug("%s: gpt-entry at %p\n", __func__, gpt_pte);
205 printf("Part\tStart LBA\tEnd LBA\t\tName\n");
206 printf("\tAttributes\n");
207 printf("\tType GUID\n");
208 printf("\tPartition GUID\n");
210 for (i = 0; i < le32_to_cpu(gpt_head->num_partition_entries); i++) {
211 /* Stop at the first non valid PTE */
212 if (!is_pte_valid(&gpt_pte[i]))
215 printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i + 1),
216 le64_to_cpu(gpt_pte[i].starting_lba),
217 le64_to_cpu(gpt_pte[i].ending_lba),
218 print_efiname(&gpt_pte[i]));
219 printf("\tattrs:\t0x%016llx\n", gpt_pte[i].attributes.raw);
220 uuid_bin = (unsigned char *)gpt_pte[i].partition_type_guid.b;
221 uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
222 printf("\ttype:\t%s\n", uuid);
223 uuid_bin = (unsigned char *)gpt_pte[i].unique_partition_guid.b;
224 uuid_bin_to_str(uuid_bin, uuid, UUID_STR_FORMAT_GUID);
225 printf("\tguid:\t%s\n", uuid);
228 /* Remember to free pte */
233 int get_partition_info_efi(block_dev_desc_t * dev_desc, int part,
234 disk_partition_t * info)
236 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1, dev_desc->blksz);
237 gpt_entry *gpt_pte = NULL;
239 /* "part" argument must be at least 1 */
240 if (!dev_desc || !info || part < 1) {
241 printf("%s: Invalid Argument(s)\n", __func__);
245 /* This function validates AND fills in the GPT header and PTE */
246 if (is_gpt_valid(dev_desc, GPT_PRIMARY_PARTITION_TABLE_LBA,
247 gpt_head, &gpt_pte) != 1) {
248 printf("%s: *** ERROR: Invalid GPT ***\n", __func__);
249 if (is_gpt_valid(dev_desc, (dev_desc->lba - 1),
250 gpt_head, &gpt_pte) != 1) {
251 printf("%s: *** ERROR: Invalid Backup GPT ***\n",
255 printf("%s: *** Using Backup GPT ***\n",
260 if (part > le32_to_cpu(gpt_head->num_partition_entries) ||
261 !is_pte_valid(&gpt_pte[part - 1])) {
262 debug("%s: *** ERROR: Invalid partition number %d ***\n",
268 /* The 'lbaint_t' casting may limit the maximum disk size to 2 TB */
269 info->start = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].starting_lba);
270 /* The ending LBA is inclusive, to calculate size, add 1 to it */
271 info->size = (lbaint_t)le64_to_cpu(gpt_pte[part - 1].ending_lba) + 1
273 info->blksz = dev_desc->blksz;
275 sprintf((char *)info->name, "%s",
276 print_efiname(&gpt_pte[part - 1]));
277 sprintf((char *)info->type, "U-Boot");
278 info->bootable = is_bootable(&gpt_pte[part - 1]);
279 #ifdef CONFIG_PARTITION_UUIDS
280 uuid_bin_to_str(gpt_pte[part - 1].unique_partition_guid.b, info->uuid,
281 UUID_STR_FORMAT_GUID);
284 debug("%s: start 0x" LBAF ", size 0x" LBAF ", name %s\n", __func__,
285 info->start, info->size, info->name);
287 /* Remember to free pte */
292 int get_partition_info_efi_by_name(block_dev_desc_t *dev_desc,
293 const char *name, disk_partition_t *info)
297 for (i = 1; i < GPT_ENTRY_NUMBERS; i++) {
298 ret = get_partition_info_efi(dev_desc, i, info);
300 /* no more entries in table */
303 if (strcmp(name, (const char *)info->name) == 0) {
311 int test_part_efi(block_dev_desc_t * dev_desc)
313 ALLOC_CACHE_ALIGN_BUFFER_PAD(legacy_mbr, legacymbr, 1, dev_desc->blksz);
315 /* Read legacy MBR from block 0 and validate it */
316 if ((dev_desc->block_read(dev_desc->dev, 0, 1, (ulong *)legacymbr) != 1)
317 || (is_pmbr_valid(legacymbr) != 1)) {
324 * set_protective_mbr(): Set the EFI protective MBR
325 * @param dev_desc - block device descriptor
327 * @return - zero on success, otherwise error
329 static int set_protective_mbr(block_dev_desc_t *dev_desc)
331 /* Setup the Protective MBR */
332 ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr, p_mbr, 1);
333 memset(p_mbr, 0, sizeof(*p_mbr));
336 printf("%s: calloc failed!\n", __func__);
339 /* Append signature */
340 p_mbr->signature = MSDOS_MBR_SIGNATURE;
341 p_mbr->partition_record[0].sys_ind = EFI_PMBR_OSTYPE_EFI_GPT;
342 p_mbr->partition_record[0].start_sect = 1;
343 p_mbr->partition_record[0].nr_sects = (u32) dev_desc->lba;
345 /* Write MBR sector to the MMC device */
346 if (dev_desc->block_write(dev_desc->dev, 0, 1, p_mbr) != 1) {
347 printf("** Can't write to device %d **\n",
355 int write_gpt_table(block_dev_desc_t *dev_desc,
356 gpt_header *gpt_h, gpt_entry *gpt_e)
358 const int pte_blk_cnt = BLOCK_CNT((gpt_h->num_partition_entries
359 * sizeof(gpt_entry)), dev_desc);
362 debug("max lba: %x\n", (u32) dev_desc->lba);
363 /* Setup the Protective MBR */
364 if (set_protective_mbr(dev_desc) < 0)
367 /* Generate CRC for the Primary GPT Header */
368 calc_crc32 = efi_crc32((const unsigned char *)gpt_e,
369 le32_to_cpu(gpt_h->num_partition_entries) *
370 le32_to_cpu(gpt_h->sizeof_partition_entry));
371 gpt_h->partition_entry_array_crc32 = cpu_to_le32(calc_crc32);
373 calc_crc32 = efi_crc32((const unsigned char *)gpt_h,
374 le32_to_cpu(gpt_h->header_size));
375 gpt_h->header_crc32 = cpu_to_le32(calc_crc32);
377 /* Write the First GPT to the block right after the Legacy MBR */
378 if (dev_desc->block_write(dev_desc->dev, 1, 1, gpt_h) != 1)
381 if (dev_desc->block_write(dev_desc->dev, 2, pte_blk_cnt, gpt_e)
385 prepare_backup_gpt_header(gpt_h);
387 if (dev_desc->block_write(dev_desc->dev,
388 (lbaint_t)le64_to_cpu(gpt_h->last_usable_lba)
390 pte_blk_cnt, gpt_e) != pte_blk_cnt)
393 if (dev_desc->block_write(dev_desc->dev,
394 (lbaint_t)le64_to_cpu(gpt_h->my_lba), 1,
398 debug("GPT successfully written to block device!\n");
402 printf("** Can't write to device %d **\n", dev_desc->dev);
406 int gpt_fill_pte(gpt_header *gpt_h, gpt_entry *gpt_e,
407 disk_partition_t *partitions, int parts)
409 lbaint_t offset = (lbaint_t)le64_to_cpu(gpt_h->first_usable_lba);
411 lbaint_t last_usable_lba = (lbaint_t)
412 le64_to_cpu(gpt_h->last_usable_lba);
414 size_t efiname_len, dosname_len;
415 #ifdef CONFIG_PARTITION_UUIDS
417 unsigned char *bin_uuid;
420 for (i = 0; i < parts; i++) {
421 /* partition starting lba */
422 start = partitions[i].start;
423 if (start && (start < offset)) {
424 printf("Partition overlap\n");
428 gpt_e[i].starting_lba = cpu_to_le64(start);
429 offset = start + partitions[i].size;
431 gpt_e[i].starting_lba = cpu_to_le64(offset);
432 offset += partitions[i].size;
434 if (offset >= last_usable_lba) {
435 printf("Partitions layout exceds disk size\n");
438 /* partition ending lba */
439 if ((i == parts - 1) && (partitions[i].size == 0))
440 /* extend the last partition to maximuim */
441 gpt_e[i].ending_lba = gpt_h->last_usable_lba;
443 gpt_e[i].ending_lba = cpu_to_le64(offset - 1);
445 /* partition type GUID */
446 memcpy(gpt_e[i].partition_type_guid.b,
447 &PARTITION_BASIC_DATA_GUID, 16);
449 #ifdef CONFIG_PARTITION_UUIDS
450 str_uuid = partitions[i].uuid;
451 bin_uuid = gpt_e[i].unique_partition_guid.b;
453 if (uuid_str_to_bin(str_uuid, bin_uuid, UUID_STR_FORMAT_STD)) {
454 printf("Partition no. %d: invalid guid: %s\n",
460 /* partition attributes */
461 memset(&gpt_e[i].attributes, 0,
462 sizeof(gpt_entry_attributes));
465 efiname_len = sizeof(gpt_e[i].partition_name)
466 / sizeof(efi_char16_t);
467 dosname_len = sizeof(partitions[i].name);
469 memset(gpt_e[i].partition_name, 0,
470 sizeof(gpt_e[i].partition_name));
472 for (k = 0; k < min(dosname_len, efiname_len); k++)
473 gpt_e[i].partition_name[k] =
474 (efi_char16_t)(partitions[i].name[k]);
476 debug("%s: name: %s offset[%d]: 0x" LBAF
477 " size[%d]: 0x" LBAF "\n",
478 __func__, partitions[i].name, i,
479 offset, i, partitions[i].size);
485 int gpt_fill_header(block_dev_desc_t *dev_desc, gpt_header *gpt_h,
486 char *str_guid, int parts_count)
488 gpt_h->signature = cpu_to_le64(GPT_HEADER_SIGNATURE);
489 gpt_h->revision = cpu_to_le32(GPT_HEADER_REVISION_V1);
490 gpt_h->header_size = cpu_to_le32(sizeof(gpt_header));
491 gpt_h->my_lba = cpu_to_le64(1);
492 gpt_h->alternate_lba = cpu_to_le64(dev_desc->lba - 1);
493 gpt_h->first_usable_lba = cpu_to_le64(34);
494 gpt_h->last_usable_lba = cpu_to_le64(dev_desc->lba - 34);
495 gpt_h->partition_entry_lba = cpu_to_le64(2);
496 gpt_h->num_partition_entries = cpu_to_le32(GPT_ENTRY_NUMBERS);
497 gpt_h->sizeof_partition_entry = cpu_to_le32(sizeof(gpt_entry));
498 gpt_h->header_crc32 = 0;
499 gpt_h->partition_entry_array_crc32 = 0;
501 if (uuid_str_to_bin(str_guid, gpt_h->disk_guid.b, UUID_STR_FORMAT_GUID))
507 int gpt_restore(block_dev_desc_t *dev_desc, char *str_disk_guid,
508 disk_partition_t *partitions, int parts_count)
512 gpt_header *gpt_h = calloc(1, PAD_TO_BLOCKSIZE(sizeof(gpt_header),
517 printf("%s: calloc failed!\n", __func__);
521 gpt_e = calloc(1, PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS
525 printf("%s: calloc failed!\n", __func__);
530 /* Generate Primary GPT header (LBA1) */
531 ret = gpt_fill_header(dev_desc, gpt_h, str_disk_guid, parts_count);
535 /* Generate partition entries */
536 ret = gpt_fill_pte(gpt_h, gpt_e, partitions, parts_count);
540 /* Write GPT partition table */
541 ret = write_gpt_table(dev_desc, gpt_h, gpt_e);
554 * pmbr_part_valid(): Check for EFI partition signature
556 * Returns: 1 if EFI GPT partition type is found.
558 static int pmbr_part_valid(struct partition *part)
560 if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
561 get_unaligned_le32(&part->start_sect) == 1UL) {
569 * is_pmbr_valid(): test Protective MBR for validity
571 * Returns: 1 if PMBR is valid, 0 otherwise.
572 * Validity depends on two things:
573 * 1) MSDOS signature is in the last two bytes of the MBR
574 * 2) One partition of type 0xEE is found, checked by pmbr_part_valid()
576 static int is_pmbr_valid(legacy_mbr * mbr)
580 if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
583 for (i = 0; i < 4; i++) {
584 if (pmbr_part_valid(&mbr->partition_record[i])) {
592 * is_gpt_valid() - tests one GPT header and PTEs for validity
594 * lba is the logical block address of the GPT header to test
595 * gpt is a GPT header ptr, filled on return.
596 * ptes is a PTEs ptr, filled on return.
598 * Description: returns 1 if valid, 0 on error.
599 * If valid, returns pointers to PTEs.
601 static int is_gpt_valid(block_dev_desc_t *dev_desc, u64 lba,
602 gpt_header *pgpt_head, gpt_entry **pgpt_pte)
604 if (!dev_desc || !pgpt_head) {
605 printf("%s: Invalid Argument(s)\n", __func__);
609 /* Read GPT Header from device */
610 if (dev_desc->block_read(dev_desc->dev, (lbaint_t)lba, 1, pgpt_head)
612 printf("*** ERROR: Can't read GPT header ***\n");
616 if (validate_gpt_header(pgpt_head, (lbaint_t)lba, dev_desc->lba))
619 /* Read and allocate Partition Table Entries */
620 *pgpt_pte = alloc_read_gpt_entries(dev_desc, pgpt_head);
621 if (*pgpt_pte == NULL) {
622 printf("GPT: Failed to allocate memory for PTE\n");
626 if (validate_gpt_entries(pgpt_head, *pgpt_pte)) {
631 /* We're done, all's well */
636 * alloc_read_gpt_entries(): reads partition entries from disk
640 * Description: Returns ptes on success, NULL on error.
641 * Allocates space for PTEs based on information found in @gpt.
642 * Notes: remember to free pte when you're done!
644 static gpt_entry *alloc_read_gpt_entries(block_dev_desc_t * dev_desc,
645 gpt_header * pgpt_head)
647 size_t count = 0, blk_cnt;
648 gpt_entry *pte = NULL;
650 if (!dev_desc || !pgpt_head) {
651 printf("%s: Invalid Argument(s)\n", __func__);
655 count = le32_to_cpu(pgpt_head->num_partition_entries) *
656 le32_to_cpu(pgpt_head->sizeof_partition_entry);
658 debug("%s: count = %u * %u = %zu\n", __func__,
659 (u32) le32_to_cpu(pgpt_head->num_partition_entries),
660 (u32) le32_to_cpu(pgpt_head->sizeof_partition_entry), count);
662 /* Allocate memory for PTE, remember to FREE */
664 pte = memalign(ARCH_DMA_MINALIGN,
665 PAD_TO_BLOCKSIZE(count, dev_desc));
668 if (count == 0 || pte == NULL) {
669 printf("%s: ERROR: Can't allocate 0x%zX "
670 "bytes for GPT Entries\n",
675 /* Read GPT Entries from device */
676 blk_cnt = BLOCK_CNT(count, dev_desc);
677 if (dev_desc->block_read (dev_desc->dev,
678 (lbaint_t)le64_to_cpu(pgpt_head->partition_entry_lba),
679 (lbaint_t) (blk_cnt), pte)
682 printf("*** ERROR: Can't read GPT Entries ***\n");
690 * is_pte_valid(): validates a single Partition Table Entry
691 * @gpt_entry - Pointer to a single Partition Table Entry
693 * Description: returns 1 if valid, 0 on error.
695 static int is_pte_valid(gpt_entry * pte)
697 efi_guid_t unused_guid;
700 printf("%s: Invalid Argument(s)\n", __func__);
704 /* Only one validation for now:
705 * The GUID Partition Type != Unused Entry (ALL-ZERO)
707 memset(unused_guid.b, 0, sizeof(unused_guid.b));
709 if (memcmp(pte->partition_type_guid.b, unused_guid.b,
710 sizeof(unused_guid.b)) == 0) {
712 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__,
713 (unsigned int)(uintptr_t)pte);