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 void uuid_string(unsigned char *uuid
, char *str
)
68 static const u8 le
[16] = {3, 2, 1, 0, 5, 4, 7, 6, 8, 9, 10, 11,
72 for (i
= 0; i
< 16; i
++) {
73 sprintf(str
, "%02x", uuid
[le
[i
]]);
86 static efi_guid_t system_guid
= PARTITION_SYSTEM_GUID
;
88 static inline int is_bootable(gpt_entry
*p
)
90 return p
->attributes
.fields
.legacy_bios_bootable
||
91 !memcmp(&(p
->partition_type_guid
), &system_guid
,
95 #ifdef CONFIG_EFI_PARTITION
97 * Public Functions (include/part.h)
100 void print_part_efi(block_dev_desc_t
* dev_desc
)
102 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header
, gpt_head
, 1, dev_desc
->blksz
);
103 gpt_entry
*gpt_pte
= NULL
;
108 printf("%s: Invalid Argument(s)\n", __func__
);
111 /* This function validates AND fills in the GPT header and PTE */
112 if (is_gpt_valid(dev_desc
, GPT_PRIMARY_PARTITION_TABLE_LBA
,
113 gpt_head
, &gpt_pte
) != 1) {
114 printf("%s: *** ERROR: Invalid GPT ***\n", __func__
);
118 debug("%s: gpt-entry at %p\n", __func__
, gpt_pte
);
120 printf("Part\tStart LBA\tEnd LBA\t\tName\n");
121 printf("\tAttributes\n");
122 printf("\tType UUID\n");
123 printf("\tPartition UUID\n");
125 for (i
= 0; i
< le32_to_cpu(gpt_head
->num_partition_entries
); i
++) {
126 /* Stop at the first non valid PTE */
127 if (!is_pte_valid(&gpt_pte
[i
]))
130 printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i
+ 1),
131 le64_to_cpu(gpt_pte
[i
].starting_lba
),
132 le64_to_cpu(gpt_pte
[i
].ending_lba
),
133 print_efiname(&gpt_pte
[i
]));
134 printf("\tattrs:\t0x%016llx\n", gpt_pte
[i
].attributes
.raw
);
135 uuid_string(gpt_pte
[i
].partition_type_guid
.b
, uuid
);
136 printf("\ttype:\t%s\n", uuid
);
137 uuid_string(gpt_pte
[i
].unique_partition_guid
.b
, uuid
);
138 printf("\tuuid:\t%s\n", uuid
);
141 /* Remember to free pte */
146 int get_partition_info_efi(block_dev_desc_t
* dev_desc
, int part
,
147 disk_partition_t
* info
)
149 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header
, gpt_head
, 1, dev_desc
->blksz
);
150 gpt_entry
*gpt_pte
= NULL
;
152 /* "part" argument must be at least 1 */
153 if (!dev_desc
|| !info
|| part
< 1) {
154 printf("%s: Invalid Argument(s)\n", __func__
);
158 /* This function validates AND fills in the GPT header and PTE */
159 if (is_gpt_valid(dev_desc
, GPT_PRIMARY_PARTITION_TABLE_LBA
,
160 gpt_head
, &gpt_pte
) != 1) {
161 printf("%s: *** ERROR: Invalid GPT ***\n", __func__
);
165 if (part
> le32_to_cpu(gpt_head
->num_partition_entries
) ||
166 !is_pte_valid(&gpt_pte
[part
- 1])) {
167 debug("%s: *** ERROR: Invalid partition number %d ***\n",
173 /* The ulong casting limits the maximum disk size to 2 TB */
174 info
->start
= (u64
)le64_to_cpu(gpt_pte
[part
- 1].starting_lba
);
175 /* The ending LBA is inclusive, to calculate size, add 1 to it */
176 info
->size
= ((u64
)le64_to_cpu(gpt_pte
[part
- 1].ending_lba
) + 1)
178 info
->blksz
= dev_desc
->blksz
;
180 sprintf((char *)info
->name
, "%s",
181 print_efiname(&gpt_pte
[part
- 1]));
182 sprintf((char *)info
->type
, "U-Boot");
183 info
->bootable
= is_bootable(&gpt_pte
[part
- 1]);
184 #ifdef CONFIG_PARTITION_UUIDS
185 uuid_string(gpt_pte
[part
- 1].unique_partition_guid
.b
, info
->uuid
);
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
)
218 /* Setup the Protective MBR */
219 p_mbr
= calloc(1, 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",
243 * string_uuid(); Convert UUID stored as string to bytes
245 * @param uuid - UUID represented as string
246 * @param dst - GUID buffer
248 * @return return 0 on successful conversion
250 static int string_uuid(char *uuid
, u8
*dst
)
259 const u8 uuid_str_len
= 36;
261 /* The UUID is written in text: */
263 /* xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */
265 debug("%s: uuid: %s\n", __func__
, uuid
);
267 if (strlen(uuid
) != uuid_str_len
)
270 for (i
= 0; i
< uuid_str_len
; i
++) {
271 if ((i
== 8) || (i
== 13) || (i
== 18) || (i
== 23)) {
275 if (!isxdigit(uuid
[i
]))
280 a
= (u32
)simple_strtoul(uuid
, NULL
, 16);
281 b
= (u16
)simple_strtoul(uuid
+ 9, NULL
, 16);
282 c
= (u16
)simple_strtoul(uuid
+ 14, NULL
, 16);
283 d
= (u16
)simple_strtoul(uuid
+ 19, NULL
, 16);
284 e
= (u64
)simple_strtoull(uuid
+ 24, NULL
, 16);
287 guid
= EFI_GUID(a
, b
, c
, d
>> 8, d
& 0xFF,
288 *(p
+ 5), *(p
+ 4), *(p
+ 3),
289 *(p
+ 2), *(p
+ 1) , *p
);
291 memcpy(dst
, guid
.b
, sizeof(efi_guid_t
));
296 int write_gpt_table(block_dev_desc_t
*dev_desc
,
297 gpt_header
*gpt_h
, gpt_entry
*gpt_e
)
299 const int pte_blk_cnt
= BLOCK_CNT((gpt_h
->num_partition_entries
300 * sizeof(gpt_entry
)), dev_desc
);
304 debug("max lba: %x\n", (u32
) dev_desc
->lba
);
305 /* Setup the Protective MBR */
306 if (set_protective_mbr(dev_desc
) < 0)
309 /* Generate CRC for the Primary GPT Header */
310 calc_crc32
= efi_crc32((const unsigned char *)gpt_e
,
311 le32_to_cpu(gpt_h
->num_partition_entries
) *
312 le32_to_cpu(gpt_h
->sizeof_partition_entry
));
313 gpt_h
->partition_entry_array_crc32
= cpu_to_le32(calc_crc32
);
315 calc_crc32
= efi_crc32((const unsigned char *)gpt_h
,
316 le32_to_cpu(gpt_h
->header_size
));
317 gpt_h
->header_crc32
= cpu_to_le32(calc_crc32
);
319 /* Write the First GPT to the block right after the Legacy MBR */
320 if (dev_desc
->block_write(dev_desc
->dev
, 1, 1, gpt_h
) != 1)
323 if (dev_desc
->block_write(dev_desc
->dev
, 2, pte_blk_cnt
, gpt_e
)
327 /* recalculate the values for the Second GPT Header */
328 val
= le64_to_cpu(gpt_h
->my_lba
);
329 gpt_h
->my_lba
= gpt_h
->alternate_lba
;
330 gpt_h
->alternate_lba
= cpu_to_le64(val
);
331 gpt_h
->header_crc32
= 0;
333 calc_crc32
= efi_crc32((const unsigned char *)gpt_h
,
334 le32_to_cpu(gpt_h
->header_size
));
335 gpt_h
->header_crc32
= cpu_to_le32(calc_crc32
);
337 if (dev_desc
->block_write(dev_desc
->dev
,
338 le32_to_cpu(gpt_h
->last_usable_lba
+ 1),
339 pte_blk_cnt
, gpt_e
) != pte_blk_cnt
)
342 if (dev_desc
->block_write(dev_desc
->dev
,
343 le32_to_cpu(gpt_h
->my_lba
), 1, gpt_h
) != 1)
346 debug("GPT successfully written to block device!\n");
350 printf("** Can't write to device %d **\n", dev_desc
->dev
);
354 int gpt_fill_pte(gpt_header
*gpt_h
, gpt_entry
*gpt_e
,
355 disk_partition_t
*partitions
, int parts
)
357 u32 offset
= (u32
)le32_to_cpu(gpt_h
->first_usable_lba
);
360 size_t efiname_len
, dosname_len
;
361 #ifdef CONFIG_PARTITION_UUIDS
365 for (i
= 0; i
< parts
; i
++) {
366 /* partition starting lba */
367 start
= partitions
[i
].start
;
368 if (start
&& (start
< offset
)) {
369 printf("Partition overlap\n");
373 gpt_e
[i
].starting_lba
= cpu_to_le64(start
);
374 offset
= start
+ partitions
[i
].size
;
376 gpt_e
[i
].starting_lba
= cpu_to_le64(offset
);
377 offset
+= partitions
[i
].size
;
379 if (offset
>= gpt_h
->last_usable_lba
) {
380 printf("Partitions layout exceds disk size\n");
383 /* partition ending lba */
384 if ((i
== parts
- 1) && (partitions
[i
].size
== 0))
385 /* extend the last partition to maximuim */
386 gpt_e
[i
].ending_lba
= gpt_h
->last_usable_lba
;
388 gpt_e
[i
].ending_lba
= cpu_to_le64(offset
- 1);
390 /* partition type GUID */
391 memcpy(gpt_e
[i
].partition_type_guid
.b
,
392 &PARTITION_BASIC_DATA_GUID
, 16);
394 #ifdef CONFIG_PARTITION_UUIDS
395 str_uuid
= partitions
[i
].uuid
;
396 if (string_uuid(str_uuid
, gpt_e
[i
].unique_partition_guid
.b
)) {
397 printf("Partition no. %d: invalid guid: %s\n",
403 /* partition attributes */
404 memset(&gpt_e
[i
].attributes
, 0,
405 sizeof(gpt_entry_attributes
));
408 efiname_len
= sizeof(gpt_e
[i
].partition_name
)
409 / sizeof(efi_char16_t
);
410 dosname_len
= sizeof(partitions
[i
].name
);
412 memset(gpt_e
[i
].partition_name
, 0,
413 sizeof(gpt_e
[i
].partition_name
));
415 for (k
= 0; k
< min(dosname_len
, efiname_len
); k
++)
416 gpt_e
[i
].partition_name
[k
] =
417 (efi_char16_t
)(partitions
[i
].name
[k
]);
419 debug("%s: name: %s offset[%d]: 0x%x size[%d]: 0x" LBAF
"\n",
420 __func__
, partitions
[i
].name
, i
,
421 offset
, i
, partitions
[i
].size
);
427 int gpt_fill_header(block_dev_desc_t
*dev_desc
, gpt_header
*gpt_h
,
428 char *str_guid
, int parts_count
)
430 gpt_h
->signature
= cpu_to_le64(GPT_HEADER_SIGNATURE
);
431 gpt_h
->revision
= cpu_to_le32(GPT_HEADER_REVISION_V1
);
432 gpt_h
->header_size
= cpu_to_le32(sizeof(gpt_header
));
433 gpt_h
->my_lba
= cpu_to_le64(1);
434 gpt_h
->alternate_lba
= cpu_to_le64(dev_desc
->lba
- 1);
435 gpt_h
->first_usable_lba
= cpu_to_le64(34);
436 gpt_h
->last_usable_lba
= cpu_to_le64(dev_desc
->lba
- 34);
437 gpt_h
->partition_entry_lba
= cpu_to_le64(2);
438 gpt_h
->num_partition_entries
= cpu_to_le32(GPT_ENTRY_NUMBERS
);
439 gpt_h
->sizeof_partition_entry
= cpu_to_le32(sizeof(gpt_entry
));
440 gpt_h
->header_crc32
= 0;
441 gpt_h
->partition_entry_array_crc32
= 0;
443 if (string_uuid(str_guid
, gpt_h
->disk_guid
.b
))
449 int gpt_restore(block_dev_desc_t
*dev_desc
, char *str_disk_guid
,
450 disk_partition_t
*partitions
, int parts_count
)
454 gpt_header
*gpt_h
= calloc(1, PAD_TO_BLOCKSIZE(sizeof(gpt_header
),
459 printf("%s: calloc failed!\n", __func__
);
463 gpt_e
= calloc(1, PAD_TO_BLOCKSIZE(GPT_ENTRY_NUMBERS
467 printf("%s: calloc failed!\n", __func__
);
472 /* Generate Primary GPT header (LBA1) */
473 ret
= gpt_fill_header(dev_desc
, gpt_h
, str_disk_guid
, parts_count
);
477 /* Generate partition entries */
478 ret
= gpt_fill_pte(gpt_h
, gpt_e
, partitions
, parts_count
);
482 /* Write GPT partition table */
483 ret
= write_gpt_table(dev_desc
, gpt_h
, gpt_e
);
496 * pmbr_part_valid(): Check for EFI partition signature
498 * Returns: 1 if EFI GPT partition type is found.
500 static int pmbr_part_valid(struct partition
*part
)
502 if (part
->sys_ind
== EFI_PMBR_OSTYPE_EFI_GPT
&&
503 get_unaligned_le32(&part
->start_sect
) == 1UL) {
511 * is_pmbr_valid(): test Protective MBR for validity
513 * Returns: 1 if PMBR is valid, 0 otherwise.
514 * Validity depends on two things:
515 * 1) MSDOS signature is in the last two bytes of the MBR
516 * 2) One partition of type 0xEE is found, checked by pmbr_part_valid()
518 static int is_pmbr_valid(legacy_mbr
* mbr
)
522 if (!mbr
|| le16_to_cpu(mbr
->signature
) != MSDOS_MBR_SIGNATURE
)
525 for (i
= 0; i
< 4; i
++) {
526 if (pmbr_part_valid(&mbr
->partition_record
[i
])) {
534 * is_gpt_valid() - tests one GPT header and PTEs for validity
536 * lba is the logical block address of the GPT header to test
537 * gpt is a GPT header ptr, filled on return.
538 * ptes is a PTEs ptr, filled on return.
540 * Description: returns 1 if valid, 0 on error.
541 * If valid, returns pointers to PTEs.
543 static int is_gpt_valid(block_dev_desc_t
* dev_desc
, unsigned long long lba
,
544 gpt_header
* pgpt_head
, gpt_entry
** pgpt_pte
)
546 u32 crc32_backup
= 0;
548 unsigned long long lastlba
;
550 if (!dev_desc
|| !pgpt_head
) {
551 printf("%s: Invalid Argument(s)\n", __func__
);
555 /* Read GPT Header from device */
556 if (dev_desc
->block_read(dev_desc
->dev
, lba
, 1, pgpt_head
) != 1) {
557 printf("*** ERROR: Can't read GPT header ***\n");
561 /* Check the GPT header signature */
562 if (le64_to_cpu(pgpt_head
->signature
) != GPT_HEADER_SIGNATURE
) {
563 printf("GUID Partition Table Header signature is wrong:"
564 "0x%llX != 0x%llX\n",
565 le64_to_cpu(pgpt_head
->signature
),
566 GPT_HEADER_SIGNATURE
);
570 /* Check the GUID Partition Table CRC */
571 memcpy(&crc32_backup
, &pgpt_head
->header_crc32
, sizeof(crc32_backup
));
572 memset(&pgpt_head
->header_crc32
, 0, sizeof(pgpt_head
->header_crc32
));
574 calc_crc32
= efi_crc32((const unsigned char *)pgpt_head
,
575 le32_to_cpu(pgpt_head
->header_size
));
577 memcpy(&pgpt_head
->header_crc32
, &crc32_backup
, sizeof(crc32_backup
));
579 if (calc_crc32
!= le32_to_cpu(crc32_backup
)) {
580 printf("GUID Partition Table Header CRC is wrong:"
582 le32_to_cpu(crc32_backup
), calc_crc32
);
586 /* Check that the my_lba entry points to the LBA that contains the GPT */
587 if (le64_to_cpu(pgpt_head
->my_lba
) != lba
) {
588 printf("GPT: my_lba incorrect: %llX != %llX\n",
589 le64_to_cpu(pgpt_head
->my_lba
),
594 /* Check the first_usable_lba and last_usable_lba are within the disk. */
595 lastlba
= (unsigned long long)dev_desc
->lba
;
596 if (le64_to_cpu(pgpt_head
->first_usable_lba
) > lastlba
) {
597 printf("GPT: first_usable_lba incorrect: %llX > %llX\n",
598 le64_to_cpu(pgpt_head
->first_usable_lba
), lastlba
);
601 if (le64_to_cpu(pgpt_head
->last_usable_lba
) > lastlba
) {
602 printf("GPT: last_usable_lba incorrect: %llX > %llX\n",
603 (u64
) le64_to_cpu(pgpt_head
->last_usable_lba
), lastlba
);
607 debug("GPT: first_usable_lba: %llX last_usable_lba %llX last lba %llX\n",
608 le64_to_cpu(pgpt_head
->first_usable_lba
),
609 le64_to_cpu(pgpt_head
->last_usable_lba
), lastlba
);
611 /* Read and allocate Partition Table Entries */
612 *pgpt_pte
= alloc_read_gpt_entries(dev_desc
, pgpt_head
);
613 if (*pgpt_pte
== NULL
) {
614 printf("GPT: Failed to allocate memory for PTE\n");
618 /* Check the GUID Partition Table Entry Array CRC */
619 calc_crc32
= efi_crc32((const unsigned char *)*pgpt_pte
,
620 le32_to_cpu(pgpt_head
->num_partition_entries
) *
621 le32_to_cpu(pgpt_head
->sizeof_partition_entry
));
623 if (calc_crc32
!= le32_to_cpu(pgpt_head
->partition_entry_array_crc32
)) {
624 printf("GUID Partition Table Entry Array CRC is wrong:"
626 le32_to_cpu(pgpt_head
->partition_entry_array_crc32
),
633 /* We're done, all's well */
638 * alloc_read_gpt_entries(): reads partition entries from disk
642 * Description: Returns ptes on success, NULL on error.
643 * Allocates space for PTEs based on information found in @gpt.
644 * Notes: remember to free pte when you're done!
646 static gpt_entry
*alloc_read_gpt_entries(block_dev_desc_t
* dev_desc
,
647 gpt_header
* pgpt_head
)
649 size_t count
= 0, blk_cnt
;
650 gpt_entry
*pte
= NULL
;
652 if (!dev_desc
|| !pgpt_head
) {
653 printf("%s: Invalid Argument(s)\n", __func__
);
657 count
= le32_to_cpu(pgpt_head
->num_partition_entries
) *
658 le32_to_cpu(pgpt_head
->sizeof_partition_entry
);
660 debug("%s: count = %u * %u = %zu\n", __func__
,
661 (u32
) le32_to_cpu(pgpt_head
->num_partition_entries
),
662 (u32
) le32_to_cpu(pgpt_head
->sizeof_partition_entry
), count
);
664 /* Allocate memory for PTE, remember to FREE */
666 pte
= memalign(ARCH_DMA_MINALIGN
,
667 PAD_TO_BLOCKSIZE(count
, dev_desc
));
670 if (count
== 0 || pte
== NULL
) {
671 printf("%s: ERROR: Can't allocate 0x%zX "
672 "bytes for GPT Entries\n",
677 /* Read GPT Entries from device */
678 blk_cnt
= BLOCK_CNT(count
, dev_desc
);
679 if (dev_desc
->block_read (dev_desc
->dev
,
680 le64_to_cpu(pgpt_head
->partition_entry_lba
),
681 (lbaint_t
) (blk_cnt
), pte
)
684 printf("*** ERROR: Can't read GPT Entries ***\n");
692 * is_pte_valid(): validates a single Partition Table Entry
693 * @gpt_entry - Pointer to a single Partition Table Entry
695 * Description: returns 1 if valid, 0 on error.
697 static int is_pte_valid(gpt_entry
* pte
)
699 efi_guid_t unused_guid
;
702 printf("%s: Invalid Argument(s)\n", __func__
);
706 /* Only one validation for now:
707 * The GUID Partition Type != Unused Entry (ALL-ZERO)
709 memset(unused_guid
.b
, 0, sizeof(unused_guid
.b
));
711 if (memcmp(pte
->partition_type_guid
.b
, unused_guid
.b
,
712 sizeof(unused_guid
.b
)) == 0) {
714 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__
,
715 (unsigned int)(uintptr_t)pte
);