2 * Copyright (C) 2008 RuggedCom, Inc.
3 * Richard Retanubun <RichardRetanubun@RuggedCom.com>
5 * See file CREDITS for list of people who contributed to this
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.
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.
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,
25 * Problems with CONFIG_SYS_64BIT_LBA:
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.
31 * This limits the maximum size of addressable storage to < 2 Terra Bytes
38 #include <linux/ctype.h>
40 DECLARE_GLOBAL_DATA_PTR
;
42 #ifdef HAVE_BLOCK_DEVICE
44 * efi_crc32() - EFI version of crc32 function
45 * @buf: buffer to calculate crc32 of
46 * @len - length of buf
48 * Description: Returns EFI-style CRC32 value for @buf
50 static inline u32
efi_crc32(const void *buf
, u32 len
)
52 return crc32(0, buf
, len
);
56 * Private function prototypes
59 static int pmbr_part_valid(struct partition
*part
);
60 static int is_pmbr_valid(legacy_mbr
* mbr
);
61 static int is_gpt_valid(block_dev_desc_t
* dev_desc
, unsigned long long lba
,
62 gpt_header
* pgpt_head
, gpt_entry
** pgpt_pte
);
63 static gpt_entry
*alloc_read_gpt_entries(block_dev_desc_t
* dev_desc
,
64 gpt_header
* pgpt_head
);
65 static int is_pte_valid(gpt_entry
* pte
);
67 static char *print_efiname(gpt_entry
*pte
)
69 static char name
[PARTNAME_SZ
+ 1];
71 for (i
= 0; i
< PARTNAME_SZ
; i
++) {
73 c
= pte
->partition_name
[i
] & 0xff;
74 c
= (c
&& !isprint(c
)) ? '.' : c
;
77 name
[PARTNAME_SZ
] = 0;
81 static void uuid_string(unsigned char *uuid
, char *str
)
83 static const u8 le
[16] = {3, 2, 1, 0, 5, 4, 7, 6, 8, 9, 10, 11,
87 for (i
= 0; i
< 16; i
++) {
88 sprintf(str
, "%02x", uuid
[le
[i
]]);
101 static efi_guid_t system_guid
= PARTITION_SYSTEM_GUID
;
103 static inline int is_bootable(gpt_entry
*p
)
105 return p
->attributes
.fields
.legacy_bios_bootable
||
106 !memcmp(&(p
->partition_type_guid
), &system_guid
,
110 #ifdef CONFIG_EFI_PARTITION
112 * Public Functions (include/part.h)
115 void print_part_efi(block_dev_desc_t
* dev_desc
)
117 ALLOC_CACHE_ALIGN_BUFFER(gpt_header
, gpt_head
, 1);
118 gpt_entry
*gpt_pte
= NULL
;
123 printf("%s: Invalid Argument(s)\n", __func__
);
126 /* This function validates AND fills in the GPT header and PTE */
127 if (is_gpt_valid(dev_desc
, GPT_PRIMARY_PARTITION_TABLE_LBA
,
128 gpt_head
, &gpt_pte
) != 1) {
129 printf("%s: *** ERROR: Invalid GPT ***\n", __func__
);
133 debug("%s: gpt-entry at %p\n", __func__
, gpt_pte
);
135 printf("Part\tStart LBA\tEnd LBA\t\tName\n");
136 printf("\tAttributes\n");
137 printf("\tType UUID\n");
138 printf("\tPartition UUID\n");
140 for (i
= 0; i
< le32_to_cpu(gpt_head
->num_partition_entries
); i
++) {
141 /* Stop at the first non valid PTE */
142 if (!is_pte_valid(&gpt_pte
[i
]))
145 printf("%3d\t0x%08llx\t0x%08llx\t\"%s\"\n", (i
+ 1),
146 le64_to_cpu(gpt_pte
[i
].starting_lba
),
147 le64_to_cpu(gpt_pte
[i
].ending_lba
),
148 print_efiname(&gpt_pte
[i
]));
149 printf("\tattrs:\t0x%016llx\n", gpt_pte
[i
].attributes
.raw
);
150 uuid_string(gpt_pte
[i
].partition_type_guid
.b
, uuid
);
151 printf("\ttype:\t%s\n", uuid
);
152 uuid_string(gpt_pte
[i
].unique_partition_guid
.b
, uuid
);
153 printf("\tuuid:\t%s\n", uuid
);
156 /* Remember to free pte */
161 int get_partition_info_efi(block_dev_desc_t
* dev_desc
, int part
,
162 disk_partition_t
* info
)
164 ALLOC_CACHE_ALIGN_BUFFER(gpt_header
, gpt_head
, 1);
165 gpt_entry
*gpt_pte
= NULL
;
167 /* "part" argument must be at least 1 */
168 if (!dev_desc
|| !info
|| part
< 1) {
169 printf("%s: Invalid Argument(s)\n", __func__
);
173 /* This function validates AND fills in the GPT header and PTE */
174 if (is_gpt_valid(dev_desc
, GPT_PRIMARY_PARTITION_TABLE_LBA
,
175 gpt_head
, &gpt_pte
) != 1) {
176 printf("%s: *** ERROR: Invalid GPT ***\n", __func__
);
180 if (part
> le32_to_cpu(gpt_head
->num_partition_entries
) ||
181 !is_pte_valid(&gpt_pte
[part
- 1])) {
182 printf("%s: *** ERROR: Invalid partition number %d ***\n",
187 /* The ulong casting limits the maximum disk size to 2 TB */
188 info
->start
= (u64
)le64_to_cpu(gpt_pte
[part
- 1].starting_lba
);
189 /* The ending LBA is inclusive, to calculate size, add 1 to it */
190 info
->size
= ((u64
)le64_to_cpu(gpt_pte
[part
- 1].ending_lba
) + 1)
192 info
->blksz
= GPT_BLOCK_SIZE
;
194 sprintf((char *)info
->name
, "%s",
195 print_efiname(&gpt_pte
[part
- 1]));
196 sprintf((char *)info
->type
, "U-Boot");
197 info
->bootable
= is_bootable(&gpt_pte
[part
- 1]);
198 #ifdef CONFIG_PARTITION_UUIDS
199 uuid_string(gpt_pte
[part
- 1].unique_partition_guid
.b
, info
->uuid
);
202 debug("%s: start 0x%lX, size 0x%lX, name %s", __func__
,
203 info
->start
, info
->size
, info
->name
);
205 /* Remember to free pte */
210 int test_part_efi(block_dev_desc_t
* dev_desc
)
212 ALLOC_CACHE_ALIGN_BUFFER(legacy_mbr
, legacymbr
, 1);
214 /* Read legacy MBR from block 0 and validate it */
215 if ((dev_desc
->block_read(dev_desc
->dev
, 0, 1, (ulong
*)legacymbr
) != 1)
216 || (is_pmbr_valid(legacymbr
) != 1)) {
223 * set_protective_mbr(): Set the EFI protective MBR
224 * @param dev_desc - block device descriptor
226 * @return - zero on success, otherwise error
228 static int set_protective_mbr(block_dev_desc_t
*dev_desc
)
232 /* Setup the Protective MBR */
233 p_mbr
= calloc(1, sizeof(p_mbr
));
235 printf("%s: calloc failed!\n", __func__
);
238 /* Append signature */
239 p_mbr
->signature
= MSDOS_MBR_SIGNATURE
;
240 p_mbr
->partition_record
[0].sys_ind
= EFI_PMBR_OSTYPE_EFI_GPT
;
241 p_mbr
->partition_record
[0].start_sect
= 1;
242 p_mbr
->partition_record
[0].nr_sects
= (u32
) dev_desc
->lba
;
244 /* Write MBR sector to the MMC device */
245 if (dev_desc
->block_write(dev_desc
->dev
, 0, 1, p_mbr
) != 1) {
246 printf("** Can't write to device %d **\n",
257 * string_uuid(); Convert UUID stored as string to bytes
259 * @param uuid - UUID represented as string
260 * @param dst - GUID buffer
262 * @return return 0 on successful conversion
264 static int string_uuid(char *uuid
, u8
*dst
)
273 const u8 uuid_str_len
= 36;
275 /* The UUID is written in text: */
277 /* xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */
279 debug("%s: uuid: %s\n", __func__
, uuid
);
281 if (strlen(uuid
) != uuid_str_len
)
284 for (i
= 0; i
< uuid_str_len
; i
++) {
285 if ((i
== 8) || (i
== 13) || (i
== 18) || (i
== 23)) {
289 if (!isxdigit(uuid
[i
]))
294 a
= (u32
)simple_strtoul(uuid
, NULL
, 16);
295 b
= (u16
)simple_strtoul(uuid
+ 9, NULL
, 16);
296 c
= (u16
)simple_strtoul(uuid
+ 14, NULL
, 16);
297 d
= (u16
)simple_strtoul(uuid
+ 19, NULL
, 16);
298 e
= (u64
)simple_strtoull(uuid
+ 24, NULL
, 16);
301 guid
= EFI_GUID(a
, b
, c
, d
>> 8, d
& 0xFF,
302 *(p
+ 5), *(p
+ 4), *(p
+ 3),
303 *(p
+ 2), *(p
+ 1) , *p
);
305 memcpy(dst
, guid
.b
, sizeof(efi_guid_t
));
310 int write_gpt_table(block_dev_desc_t
*dev_desc
,
311 gpt_header
*gpt_h
, gpt_entry
*gpt_e
)
313 const int pte_blk_num
= (gpt_h
->num_partition_entries
314 * sizeof(gpt_entry
)) / dev_desc
->blksz
;
319 debug("max lba: %x\n", (u32
) dev_desc
->lba
);
320 /* Setup the Protective MBR */
321 if (set_protective_mbr(dev_desc
) < 0)
324 /* Generate CRC for the Primary GPT Header */
325 calc_crc32
= efi_crc32((const unsigned char *)gpt_e
,
326 le32_to_cpu(gpt_h
->num_partition_entries
) *
327 le32_to_cpu(gpt_h
->sizeof_partition_entry
));
328 gpt_h
->partition_entry_array_crc32
= cpu_to_le32(calc_crc32
);
330 calc_crc32
= efi_crc32((const unsigned char *)gpt_h
,
331 le32_to_cpu(gpt_h
->header_size
));
332 gpt_h
->header_crc32
= cpu_to_le32(calc_crc32
);
334 /* Write the First GPT to the block right after the Legacy MBR */
335 if (dev_desc
->block_write(dev_desc
->dev
, 1, 1, gpt_h
) != 1)
338 if (dev_desc
->block_write(dev_desc
->dev
, 2, pte_blk_num
, gpt_e
)
342 /* recalculate the values for the Second GPT Header */
343 val
= le64_to_cpu(gpt_h
->my_lba
);
344 gpt_h
->my_lba
= gpt_h
->alternate_lba
;
345 gpt_h
->alternate_lba
= cpu_to_le64(val
);
346 gpt_h
->header_crc32
= 0;
348 calc_crc32
= efi_crc32((const unsigned char *)gpt_h
,
349 le32_to_cpu(gpt_h
->header_size
));
350 gpt_h
->header_crc32
= cpu_to_le32(calc_crc32
);
352 if (dev_desc
->block_write(dev_desc
->dev
,
353 le32_to_cpu(gpt_h
->last_usable_lba
+ 1),
354 pte_blk_num
, gpt_e
) != pte_blk_num
)
357 if (dev_desc
->block_write(dev_desc
->dev
,
358 le32_to_cpu(gpt_h
->my_lba
), 1, gpt_h
) != 1)
361 debug("GPT successfully written to block device!\n");
365 printf("** Can't write to device %d **\n", dev_desc
->dev
);
369 int gpt_fill_pte(gpt_header
*gpt_h
, gpt_entry
*gpt_e
,
370 disk_partition_t
*partitions
, int parts
)
372 u32 offset
= (u32
)le32_to_cpu(gpt_h
->first_usable_lba
);
376 #ifdef CONFIG_PARTITION_UUIDS
380 for (i
= 0; i
< parts
; i
++) {
381 /* partition starting lba */
382 start
= partitions
[i
].start
;
383 if (start
&& (start
< offset
)) {
384 printf("Partition overlap\n");
388 gpt_e
[i
].starting_lba
= cpu_to_le64(start
);
389 offset
= start
+ partitions
[i
].size
;
391 gpt_e
[i
].starting_lba
= cpu_to_le64(offset
);
392 offset
+= partitions
[i
].size
;
394 if (offset
>= gpt_h
->last_usable_lba
) {
395 printf("Partitions layout exceds disk size\n");
398 /* partition ending lba */
399 if ((i
== parts
- 1) && (partitions
[i
].size
== 0))
400 /* extend the last partition to maximuim */
401 gpt_e
[i
].ending_lba
= gpt_h
->last_usable_lba
;
403 gpt_e
[i
].ending_lba
= cpu_to_le64(offset
- 1);
405 /* partition type GUID */
406 memcpy(gpt_e
[i
].partition_type_guid
.b
,
407 &PARTITION_BASIC_DATA_GUID
, 16);
409 #ifdef CONFIG_PARTITION_UUIDS
410 str_uuid
= partitions
[i
].uuid
;
411 if (string_uuid(str_uuid
, gpt_e
[i
].unique_partition_guid
.b
)) {
412 printf("Partition no. %d: invalid guid: %s\n",
418 /* partition attributes */
419 memset(&gpt_e
[i
].attributes
, 0,
420 sizeof(gpt_entry_attributes
));
423 name_len
= sizeof(gpt_e
[i
].partition_name
)
424 / sizeof(efi_char16_t
);
425 for (k
= 0; k
< name_len
; k
++)
426 gpt_e
[i
].partition_name
[k
] =
427 (efi_char16_t
)(partitions
[i
].name
[k
]);
429 debug("%s: name: %s offset[%d]: 0x%x size[%d]: 0x%lx\n",
430 __func__
, partitions
[i
].name
, i
,
431 offset
, i
, partitions
[i
].size
);
437 int gpt_fill_header(block_dev_desc_t
*dev_desc
, gpt_header
*gpt_h
,
438 char *str_guid
, int parts_count
)
440 gpt_h
->signature
= cpu_to_le64(GPT_HEADER_SIGNATURE
);
441 gpt_h
->revision
= cpu_to_le32(GPT_HEADER_REVISION_V1
);
442 gpt_h
->header_size
= cpu_to_le32(sizeof(gpt_header
));
443 gpt_h
->my_lba
= cpu_to_le64(1);
444 gpt_h
->alternate_lba
= cpu_to_le64(dev_desc
->lba
- 1);
445 gpt_h
->first_usable_lba
= cpu_to_le64(34);
446 gpt_h
->last_usable_lba
= cpu_to_le64(dev_desc
->lba
- 34);
447 gpt_h
->partition_entry_lba
= cpu_to_le64(2);
448 gpt_h
->num_partition_entries
= cpu_to_le32(GPT_ENTRY_NUMBERS
);
449 gpt_h
->sizeof_partition_entry
= cpu_to_le32(sizeof(gpt_entry
));
450 gpt_h
->header_crc32
= 0;
451 gpt_h
->partition_entry_array_crc32
= 0;
453 if (string_uuid(str_guid
, gpt_h
->disk_guid
.b
))
459 int gpt_restore(block_dev_desc_t
*dev_desc
, char *str_disk_guid
,
460 disk_partition_t
*partitions
, int parts_count
)
464 gpt_header
*gpt_h
= calloc(1, sizeof(gpt_header
));
466 printf("%s: calloc failed!\n", __func__
);
470 gpt_entry
*gpt_e
= calloc(GPT_ENTRY_NUMBERS
, sizeof(gpt_entry
));
472 printf("%s: calloc failed!\n", __func__
);
477 /* Generate Primary GPT header (LBA1) */
478 ret
= gpt_fill_header(dev_desc
, gpt_h
, str_disk_guid
, parts_count
);
482 /* Generate partition entries */
483 ret
= gpt_fill_pte(gpt_h
, gpt_e
, partitions
, parts_count
);
487 /* Write GPT partition table */
488 ret
= write_gpt_table(dev_desc
, gpt_h
, gpt_e
);
501 * pmbr_part_valid(): Check for EFI partition signature
503 * Returns: 1 if EFI GPT partition type is found.
505 static int pmbr_part_valid(struct partition
*part
)
507 if (part
->sys_ind
== EFI_PMBR_OSTYPE_EFI_GPT
&&
508 le32_to_cpu(part
->start_sect
) == 1UL) {
516 * is_pmbr_valid(): test Protective MBR for validity
518 * Returns: 1 if PMBR is valid, 0 otherwise.
519 * Validity depends on two things:
520 * 1) MSDOS signature is in the last two bytes of the MBR
521 * 2) One partition of type 0xEE is found, checked by pmbr_part_valid()
523 static int is_pmbr_valid(legacy_mbr
* mbr
)
527 if (!mbr
|| le16_to_cpu(mbr
->signature
) != MSDOS_MBR_SIGNATURE
)
530 for (i
= 0; i
< 4; i
++) {
531 if (pmbr_part_valid(&mbr
->partition_record
[i
])) {
539 * is_gpt_valid() - tests one GPT header and PTEs for validity
541 * lba is the logical block address of the GPT header to test
542 * gpt is a GPT header ptr, filled on return.
543 * ptes is a PTEs ptr, filled on return.
545 * Description: returns 1 if valid, 0 on error.
546 * If valid, returns pointers to PTEs.
548 static int is_gpt_valid(block_dev_desc_t
* dev_desc
, unsigned long long lba
,
549 gpt_header
* pgpt_head
, gpt_entry
** pgpt_pte
)
551 u32 crc32_backup
= 0;
553 unsigned long long lastlba
;
555 if (!dev_desc
|| !pgpt_head
) {
556 printf("%s: Invalid Argument(s)\n", __func__
);
560 /* Read GPT Header from device */
561 if (dev_desc
->block_read(dev_desc
->dev
, lba
, 1, pgpt_head
) != 1) {
562 printf("*** ERROR: Can't read GPT header ***\n");
566 /* Check the GPT header signature */
567 if (le64_to_cpu(pgpt_head
->signature
) != GPT_HEADER_SIGNATURE
) {
568 printf("GUID Partition Table Header signature is wrong:"
569 "0x%llX != 0x%llX\n",
570 le64_to_cpu(pgpt_head
->signature
),
571 GPT_HEADER_SIGNATURE
);
575 /* Check the GUID Partition Table CRC */
576 memcpy(&crc32_backup
, &pgpt_head
->header_crc32
, sizeof(crc32_backup
));
577 memset(&pgpt_head
->header_crc32
, 0, sizeof(pgpt_head
->header_crc32
));
579 calc_crc32
= efi_crc32((const unsigned char *)pgpt_head
,
580 le32_to_cpu(pgpt_head
->header_size
));
582 memcpy(&pgpt_head
->header_crc32
, &crc32_backup
, sizeof(crc32_backup
));
584 if (calc_crc32
!= le32_to_cpu(crc32_backup
)) {
585 printf("GUID Partition Table Header CRC is wrong:"
587 le32_to_cpu(crc32_backup
), calc_crc32
);
591 /* Check that the my_lba entry points to the LBA that contains the GPT */
592 if (le64_to_cpu(pgpt_head
->my_lba
) != lba
) {
593 printf("GPT: my_lba incorrect: %llX != %llX\n",
594 le64_to_cpu(pgpt_head
->my_lba
),
599 /* Check the first_usable_lba and last_usable_lba are within the disk. */
600 lastlba
= (unsigned long long)dev_desc
->lba
;
601 if (le64_to_cpu(pgpt_head
->first_usable_lba
) > lastlba
) {
602 printf("GPT: first_usable_lba incorrect: %llX > %llX\n",
603 le64_to_cpu(pgpt_head
->first_usable_lba
), lastlba
);
606 if (le64_to_cpu(pgpt_head
->last_usable_lba
) > lastlba
) {
607 printf("GPT: last_usable_lba incorrect: %llX > %llX\n",
608 (u64
) le64_to_cpu(pgpt_head
->last_usable_lba
), lastlba
);
612 debug("GPT: first_usable_lba: %llX last_usable_lba %llX last lba %llX\n",
613 le64_to_cpu(pgpt_head
->first_usable_lba
),
614 le64_to_cpu(pgpt_head
->last_usable_lba
), lastlba
);
616 /* Read and allocate Partition Table Entries */
617 *pgpt_pte
= alloc_read_gpt_entries(dev_desc
, pgpt_head
);
618 if (*pgpt_pte
== NULL
) {
619 printf("GPT: Failed to allocate memory for PTE\n");
623 /* Check the GUID Partition Table Entry Array CRC */
624 calc_crc32
= efi_crc32((const unsigned char *)*pgpt_pte
,
625 le32_to_cpu(pgpt_head
->num_partition_entries
) *
626 le32_to_cpu(pgpt_head
->sizeof_partition_entry
));
628 if (calc_crc32
!= le32_to_cpu(pgpt_head
->partition_entry_array_crc32
)) {
629 printf("GUID Partition Table Entry Array CRC is wrong:"
631 le32_to_cpu(pgpt_head
->partition_entry_array_crc32
),
638 /* We're done, all's well */
643 * alloc_read_gpt_entries(): reads partition entries from disk
647 * Description: Returns ptes on success, NULL on error.
648 * Allocates space for PTEs based on information found in @gpt.
649 * Notes: remember to free pte when you're done!
651 static gpt_entry
*alloc_read_gpt_entries(block_dev_desc_t
* dev_desc
,
652 gpt_header
* pgpt_head
)
655 gpt_entry
*pte
= NULL
;
657 if (!dev_desc
|| !pgpt_head
) {
658 printf("%s: Invalid Argument(s)\n", __func__
);
662 count
= le32_to_cpu(pgpt_head
->num_partition_entries
) *
663 le32_to_cpu(pgpt_head
->sizeof_partition_entry
);
665 debug("%s: count = %u * %u = %zu\n", __func__
,
666 (u32
) le32_to_cpu(pgpt_head
->num_partition_entries
),
667 (u32
) le32_to_cpu(pgpt_head
->sizeof_partition_entry
), count
);
669 /* Allocate memory for PTE, remember to FREE */
671 pte
= memalign(ARCH_DMA_MINALIGN
, count
);
674 if (count
== 0 || pte
== NULL
) {
675 printf("%s: ERROR: Can't allocate 0x%zX "
676 "bytes for GPT Entries\n",
681 /* Read GPT Entries from device */
682 if (dev_desc
->block_read (dev_desc
->dev
,
683 le64_to_cpu(pgpt_head
->partition_entry_lba
),
684 (lbaint_t
) (count
/ GPT_BLOCK_SIZE
), pte
)
685 != (count
/ GPT_BLOCK_SIZE
)) {
687 printf("*** ERROR: Can't read GPT Entries ***\n");
695 * is_pte_valid(): validates a single Partition Table Entry
696 * @gpt_entry - Pointer to a single Partition Table Entry
698 * Description: returns 1 if valid, 0 on error.
700 static int is_pte_valid(gpt_entry
* pte
)
702 efi_guid_t unused_guid
;
705 printf("%s: Invalid Argument(s)\n", __func__
);
709 /* Only one validation for now:
710 * The GUID Partition Type != Unused Entry (ALL-ZERO)
712 memset(unused_guid
.b
, 0, sizeof(unused_guid
.b
));
714 if (memcmp(pte
->partition_type_guid
.b
, unused_guid
.b
,
715 sizeof(unused_guid
.b
)) == 0) {
717 debug("%s: Found an unused PTE GUID at 0x%08X\n", __func__
,
718 (unsigned int)(uintptr_t)pte
);