1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2016 Marvell International Ltd.
4 * https://spdx.org/licenses
16 #include <spi_flash.h>
25 #include <u-boot/sha1.h>
26 #include <u-boot/sha256.h>
28 #ifndef CONFIG_SYS_MMC_ENV_DEV
29 #define CONFIG_SYS_MMC_ENV_DEV 0
32 #if defined(CONFIG_ARMADA_8K)
33 #define MAIN_HDR_MAGIC 0xB105B002
35 struct mvebu_image_header {
37 u32 prolog_size; /* 4-7 */
38 u32 prolog_checksum; /* 8-11 */
39 u32 boot_image_size; /* 12-15 */
40 u32 boot_image_checksum; /* 16-19 */
41 u32 rsrvd0; /* 20-23 */
42 u32 load_addr; /* 24-27 */
43 u32 exec_addr; /* 28-31 */
46 u8 ext_count; /* 34 */
47 u8 aux_flags; /* 35 */
48 u32 io_arg_0; /* 36-39 */
49 u32 io_arg_1; /* 40-43 */
50 u32 io_arg_2; /* 43-47 */
51 u32 io_arg_3; /* 48-51 */
52 u32 rsrvd1; /* 52-55 */
53 u32 rsrvd2; /* 56-59 */
54 u32 rsrvd3; /* 60-63 */
56 #elif defined(CONFIG_ARMADA_3700) /* A3700 */
57 #define HASH_SUM_LEN 16
58 #define IMAGE_VERSION_3_6_0 0x030600
59 #define IMAGE_VERSION_3_5_0 0x030500
61 struct common_tim_data {
67 u32 reserved[5]; /* Reserve 20 bytes */
74 struct mvebu_image_info {
80 u32 image_size_to_hash;
81 u32 hash_algorithm_id;
82 u32 hash[HASH_SUM_LEN]; /* Reserve 512 bits for the hash */
85 u32 encrypt_start_offset;
90 /* Structure of the main header, version 1 (Armada 370/38x/XP) */
91 struct a38x_main_hdr_v1 {
94 u16 reserved2; /* 0x2-0x3 */
95 u32 blocksize; /* 0x4-0x7 */
97 u8 headersz_msb; /* 0x9 */
98 u16 headersz_lsb; /* 0xA-0xB */
99 u32 srcaddr; /* 0xC-0xF */
100 u32 destaddr; /* 0x10-0x13 */
101 u32 execaddr; /* 0x14-0x17 */
102 u8 options; /* 0x18 */
103 u8 nandblocksize; /* 0x19 */
104 u8 nandbadblklocation; /* 0x1A */
105 u8 reserved4; /* 0x1B */
106 u16 reserved5; /* 0x1C-0x1D */
108 u8 checksum; /* 0x1F */
111 struct a38x_boot_mode {
116 /* The blockid header field values used to indicate boot device of image */
117 struct a38x_boot_mode a38x_boot_modes[] = {
130 size_t (*read)(const char *file_name);
131 int (*write)(size_t image_size);
135 static ulong get_load_addr(void)
137 const char *addr_str;
140 addr_str = env_get("loadaddr");
142 addr = simple_strtoul(addr_str, NULL, 16);
144 addr = CONFIG_SYS_LOAD_ADDR;
149 /********************************************************************
151 ********************************************************************/
152 #if CONFIG_IS_ENABLED(DM_MMC) && CONFIG_IS_ENABLED(MMC_WRITE)
153 static int mmc_burn_image(size_t image_size)
160 const u8 mmc_dev_num = CONFIG_SYS_MMC_ENV_DEV;
162 struct blk_desc *blk_desc;
164 mmc = find_mmc_device(mmc_dev_num);
166 printf("No SD/MMC/eMMC card found\n");
172 printf("%s(%d) init failed\n", IS_SD(mmc) ? "SD" : "MMC",
177 #ifdef CONFIG_SYS_MMC_ENV_PART
178 if (mmc->part_num != CONFIG_SYS_MMC_ENV_PART) {
179 err = mmc_switch_part(mmc_dev_num, CONFIG_SYS_MMC_ENV_PART);
181 printf("MMC partition switch failed\n");
187 /* SD reserves LBA-0 for MBR and boots from LBA-1,
188 * MMC/eMMC boots from LBA-0
190 start_lba = IS_SD(mmc) ? 1 : 0;
192 blk_count = image_size / mmc->write_bl_len;
193 if (image_size % mmc->write_bl_len)
196 blk_desc = mmc_get_blk_desc(mmc);
198 printf("Error - failed to obtain block descriptor\n");
201 blk_written = blk_dwrite(blk_desc, start_lba, blk_count,
202 (void *)get_load_addr());
204 blk_count = image_size / mmc->block_dev.blksz;
205 if (image_size % mmc->block_dev.blksz)
208 blk_written = mmc->block_dev.block_write(mmc_dev_num,
209 start_lba, blk_count,
210 (void *)get_load_addr());
211 #endif /* CONFIG_BLK */
212 if (blk_written != blk_count) {
213 printf("Error - written %#lx blocks\n", blk_written);
218 #ifdef CONFIG_SYS_MMC_ENV_PART
219 if (mmc->part_num != CONFIG_SYS_MMC_ENV_PART)
220 mmc_switch_part(mmc_dev_num, mmc->part_num);
226 static size_t mmc_read_file(const char *file_name)
231 const u8 mmc_dev_num = CONFIG_SYS_MMC_ENV_DEV;
233 mmc = find_mmc_device(mmc_dev_num);
235 printf("No SD/MMC/eMMC card found\n");
240 printf("%s(%d) init failed\n", IS_SD(mmc) ? "SD" : "MMC",
245 /* Load from data partition (0) */
246 if (fs_set_blk_dev("mmc", "0", FS_TYPE_ANY)) {
247 printf("Error: MMC 0 not found\n");
251 /* Perfrom file read */
252 rc = fs_read(file_name, get_load_addr(), 0, 0, &act_read);
259 static int is_mmc_active(void)
263 #else /* CONFIG_DM_MMC */
264 static int mmc_burn_image(size_t image_size)
269 static size_t mmc_read_file(const char *file_name)
274 static int is_mmc_active(void)
278 #endif /* CONFIG_DM_MMC */
280 /********************************************************************
282 ********************************************************************/
283 #ifdef CONFIG_SPI_FLASH
284 static int spi_burn_image(size_t image_size)
287 struct spi_flash *flash;
290 /* Probe the SPI bus to get the flash device */
291 flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
293 CONFIG_SF_DEFAULT_SPEED,
294 CONFIG_SF_DEFAULT_MODE);
296 printf("Failed to probe SPI Flash\n");
300 #ifdef CONFIG_SPI_FLASH_PROTECTION
301 spi_flash_protect(flash, 0);
303 erase_bytes = image_size +
304 (flash->erase_size - image_size % flash->erase_size);
305 printf("Erasing %d bytes (%d blocks) at offset 0 ...",
306 erase_bytes, erase_bytes / flash->erase_size);
307 ret = spi_flash_erase(flash, 0, erase_bytes);
313 printf("Writing %d bytes from 0x%lx to offset 0 ...",
314 (int)image_size, get_load_addr());
315 ret = spi_flash_write(flash, 0, image_size, (void *)get_load_addr());
321 #ifdef CONFIG_SPI_FLASH_PROTECTION
322 spi_flash_protect(flash, 1);
328 static int is_spi_active(void)
333 #else /* CONFIG_SPI_FLASH */
334 static int spi_burn_image(size_t image_size)
339 static int is_spi_active(void)
343 #endif /* CONFIG_SPI_FLASH */
345 /********************************************************************
347 ********************************************************************/
348 #ifdef CONFIG_CMD_NAND
349 static int nand_burn_image(size_t image_size)
353 struct mtd_info *mtd;
355 mtd = get_nand_dev_by_index(nand_curr_device);
357 puts("\nno devices available\n");
360 block_size = mtd->erasesize;
362 /* Align U-Boot size to currently used blocksize */
363 image_size = ((image_size + (block_size - 1)) & (~(block_size - 1)));
365 /* Erase the U-Boot image space */
366 printf("Erasing 0x%x - 0x%x:...", 0, (int)image_size);
367 ret = nand_erase(mtd, 0, image_size);
374 /* Write the image to flash */
375 printf("Writing %d bytes from 0x%lx to offset 0 ... ",
376 (int)image_size, get_load_addr());
377 ret = nand_write(mtd, 0, &image_size, (void *)get_load_addr());
387 static int is_nand_active(void)
392 #else /* CONFIG_CMD_NAND */
393 static int nand_burn_image(size_t image_size)
398 static int is_nand_active(void)
402 #endif /* CONFIG_CMD_NAND */
404 /********************************************************************
406 ********************************************************************/
407 #if defined(CONFIG_USB_STORAGE) && defined(CONFIG_BLK)
408 static size_t usb_read_file(const char *file_name)
416 if (usb_init() < 0) {
417 printf("Error: usb_init failed\n");
421 /* Try to recognize storage devices immediately */
422 blk_first_device(IF_TYPE_USB, &dev);
424 printf("Error: USB storage device not found\n");
428 /* Always load from usb 0 */
429 if (fs_set_blk_dev("usb", "0", FS_TYPE_ANY)) {
430 printf("Error: USB 0 not found\n");
434 /* Perfrom file read */
435 rc = fs_read(file_name, get_load_addr(), 0, 0, &act_read);
442 static int is_usb_active(void)
447 #else /* defined(CONFIG_USB_STORAGE) && defined (CONFIG_BLK) */
448 static size_t usb_read_file(const char *file_name)
453 static int is_usb_active(void)
457 #endif /* defined(CONFIG_USB_STORAGE) && defined (CONFIG_BLK) */
459 /********************************************************************
461 ********************************************************************/
462 #ifdef CONFIG_CMD_NET
463 static size_t tftp_read_file(const char *file_name)
466 * update global variable image_load_addr before tftp file from network
468 image_load_addr = get_load_addr();
469 return net_loop(TFTPGET);
472 static int is_tftp_active(void)
478 static size_t tftp_read_file(const char *file_name)
483 static int is_tftp_active(void)
487 #endif /* CONFIG_CMD_NET */
499 struct bubt_dev bubt_devs[BUBT_MAX_DEV] = {
500 {"tftp", tftp_read_file, NULL, is_tftp_active},
501 {"usb", usb_read_file, NULL, is_usb_active},
502 {"mmc", mmc_read_file, mmc_burn_image, is_mmc_active},
503 {"spi", NULL, spi_burn_image, is_spi_active},
504 {"nand", NULL, nand_burn_image, is_nand_active},
507 static int bubt_write_file(struct bubt_dev *dst, size_t image_size)
510 printf("Error: Write not supported on device %s\n", dst->name);
514 return dst->write(image_size);
517 #if defined(CONFIG_ARMADA_8K)
518 u32 do_checksum32(u32 *start, int32_t len)
532 static int check_image_header(void)
534 struct mvebu_image_header *hdr =
535 (struct mvebu_image_header *)get_load_addr();
536 u32 header_len = hdr->prolog_size;
538 u32 checksum_ref = hdr->prolog_checksum;
541 * For now compare checksum, and magic. Later we can
542 * verify more stuff on the header like interface type, etc
544 if (hdr->magic != MAIN_HDR_MAGIC) {
545 printf("ERROR: Bad MAGIC 0x%08x != 0x%08x\n",
546 hdr->magic, MAIN_HDR_MAGIC);
550 /* The checksum value is discarded from checksum calculation */
551 hdr->prolog_checksum = 0;
553 checksum = do_checksum32((u32 *)hdr, header_len);
554 if (checksum != checksum_ref) {
555 printf("Error: Bad Image checksum. 0x%x != 0x%x\n",
556 checksum, checksum_ref);
560 /* Restore the checksum before writing */
561 hdr->prolog_checksum = checksum_ref;
562 printf("Image checksum...OK!\n");
566 #elif defined(CONFIG_ARMADA_3700) /* Armada 3700 */
567 static int check_image_header(void)
569 struct common_tim_data *hdr = (struct common_tim_data *)get_load_addr();
571 u8 hash_160_output[SHA1_SUM_LEN];
572 u8 hash_256_output[SHA256_SUM_LEN];
573 sha1_context hash1_text;
574 sha256_context hash256_text;
576 u32 hash_algorithm_id;
577 u32 image_size_to_hash;
578 u32 flash_entry_addr;
580 u32 internal_hash[HASH_SUM_LEN];
582 u32 num_of_image = hdr->num_images;
583 u32 version = hdr->version;
584 u32 trusted = hdr->trusted;
586 /* bubt checksum validation only supports nontrusted images */
588 printf("bypass image validation, ");
589 printf("only untrusted image is supported now\n");
592 /* only supports image version 3.5 and 3.6 */
593 if (version != IMAGE_VERSION_3_5_0 && version != IMAGE_VERSION_3_6_0) {
594 printf("Error: Unsupported Image version = 0x%08x\n", version);
597 /* validate images hash value */
598 for (image_num = 0; image_num < num_of_image; image_num++) {
599 struct mvebu_image_info *info =
600 (struct mvebu_image_info *)(get_load_addr() +
601 sizeof(struct common_tim_data) +
602 image_num * sizeof(struct mvebu_image_info));
603 hash_algorithm_id = info->hash_algorithm_id;
604 image_size_to_hash = info->image_size_to_hash;
605 flash_entry_addr = info->flash_entry_addr;
606 hash_value = info->hash;
607 buff = (const u8 *)(get_load_addr() + flash_entry_addr);
609 if (image_num == 0) {
611 * The first image includes hash values in its content.
612 * For hash calculation, we need to save the original
613 * hash values to a local variable that will be
614 * copied back for comparsion and set all zeros to
615 * the orignal hash values for calculating new value.
616 * First image original format :
617 * x...x (datum1) x...x(orig. hash values) x...x(datum2)
618 * Replaced first image format :
619 * x...x (datum1) 0...0(hash values) x...x(datum2)
621 memcpy(internal_hash, hash_value,
622 sizeof(internal_hash));
623 memset(hash_value, 0, sizeof(internal_hash));
625 if (image_size_to_hash == 0) {
626 printf("Warning: Image_%d hash checksum is disabled, ",
628 printf("skip the image validation.\n");
631 switch (hash_algorithm_id) {
633 sha1_starts(&hash1_text);
634 sha1_update(&hash1_text, buff, image_size_to_hash);
635 sha1_finish(&hash1_text, hash_160_output);
636 hash_output = hash_160_output;
639 sha256_starts(&hash256_text);
640 sha256_update(&hash256_text, buff, image_size_to_hash);
641 sha256_finish(&hash256_text, hash_256_output);
642 hash_output = hash_256_output;
645 printf("Error: Unsupported hash_algorithm_id = %d\n",
650 memcpy(hash_value, internal_hash,
651 sizeof(internal_hash));
652 if (memcmp(hash_value, hash_output, hash_algorithm_id) != 0) {
653 printf("Error: Image_%d checksum is not correct\n",
658 printf("Image checksum...OK!\n");
662 #elif defined(CONFIG_ARMADA_38X)
663 static size_t a38x_header_size(const struct a38x_main_hdr_v1 *h)
666 return (h->headersz_msb << 16) | le16_to_cpu(h->headersz_lsb);
668 printf("Error: Invalid A38x image (header version 0x%x unknown)!\n",
673 static uint8_t image_checksum8(const void *start, size_t len)
687 static int check_image_header(void)
690 const struct a38x_main_hdr_v1 *hdr =
691 (struct a38x_main_hdr_v1 *)get_load_addr();
692 const size_t image_size = a38x_header_size(hdr);
697 checksum = image_checksum8(hdr, image_size);
698 checksum -= hdr->checksum;
699 if (checksum != hdr->checksum) {
700 printf("Error: Bad A38x image checksum. 0x%x != 0x%x\n",
701 checksum, hdr->checksum);
705 printf("Image checksum...OK!\n");
708 #else /* Not ARMADA? */
709 static int check_image_header(void)
711 printf("bubt cmd does not support this SoC device or family!\n");
716 static int bubt_check_boot_mode(const struct bubt_dev *dst)
718 if (IS_ENABLED(CONFIG_ARMADA_38X)) {
720 const struct a38x_main_hdr_v1 *hdr =
721 (struct a38x_main_hdr_v1 *)get_load_addr();
723 for (mode = 0; mode < ARRAY_SIZE(a38x_boot_modes); mode++) {
724 if (strcmp(a38x_boot_modes[mode].name, dst->name) == 0)
728 if (a38x_boot_modes[mode].id == hdr->blockid)
731 for (int i = 0; i < ARRAY_SIZE(a38x_boot_modes); i++) {
732 if (a38x_boot_modes[i].id == hdr->blockid) {
733 printf("Error: A38x image meant to be booted from "
734 "\"%s\", not \"%s\"!\n",
735 a38x_boot_modes[i].name, dst->name);
740 printf("Error: unknown boot device in A38x image header: "
741 "0x%x\n", hdr->blockid);
748 static int bubt_verify(const struct bubt_dev *dst)
752 /* Check a correct image header exists */
753 err = check_image_header();
755 printf("Error: Image header verification failed\n");
759 err = bubt_check_boot_mode(dst);
761 printf("Error: Image boot mode verification failed\n");
768 static int bubt_read_file(struct bubt_dev *src)
773 printf("Error: Read not supported on device \"%s\"\n",
778 image_size = src->read(net_boot_file_name);
779 if (image_size <= 0) {
780 printf("Error: Failed to read file %s from %s\n",
781 net_boot_file_name, src->name);
788 static int bubt_is_dev_active(struct bubt_dev *dev)
791 printf("Device \"%s\" not supported by U-Boot image\n",
796 if (!dev->active()) {
797 printf("Device \"%s\" is inactive\n", dev->name);
804 struct bubt_dev *find_bubt_dev(char *dev_name)
808 for (dev = 0; dev < BUBT_MAX_DEV; dev++) {
809 if (strcmp(bubt_devs[dev].name, dev_name) == 0)
810 return &bubt_devs[dev];
816 #define DEFAULT_BUBT_SRC "tftp"
818 #ifndef DEFAULT_BUBT_DST
819 #ifdef CONFIG_MVEBU_SPI_BOOT
820 #define DEFAULT_BUBT_DST "spi"
821 #elif defined(CONFIG_MVEBU_NAND_BOOT)
822 #define DEFAULT_BUBT_DST "nand"
823 #elif defined(CONFIG_MVEBU_MMC_BOOT)
824 #define DEFAULT_BUBT_DST "mmc"
826 #define DEFAULT_BUBT_DST "error"
828 #endif /* DEFAULT_BUBT_DST */
830 int do_bubt_cmd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
832 struct bubt_dev *src, *dst;
834 char src_dev_name[8];
835 char dst_dev_name[8];
840 copy_filename(net_boot_file_name,
841 CONFIG_MVEBU_UBOOT_DFLT_NAME,
842 sizeof(net_boot_file_name));
844 copy_filename(net_boot_file_name, argv[1],
845 sizeof(net_boot_file_name));
848 strncpy(dst_dev_name, argv[2], 8);
850 name = DEFAULT_BUBT_DST;
851 strncpy(dst_dev_name, name, 8);
855 strncpy(src_dev_name, argv[3], 8);
857 strncpy(src_dev_name, DEFAULT_BUBT_SRC, 8);
859 /* Figure out the destination device */
860 dst = find_bubt_dev(dst_dev_name);
862 printf("Error: Unknown destination \"%s\"\n", dst_dev_name);
866 if (!bubt_is_dev_active(dst))
869 /* Figure out the source device */
870 src = find_bubt_dev(src_dev_name);
872 printf("Error: Unknown source \"%s\"\n", src_dev_name);
876 if (!bubt_is_dev_active(src))
879 printf("Burning U-Boot image \"%s\" from \"%s\" to \"%s\"\n",
880 net_boot_file_name, src->name, dst->name);
882 image_size = bubt_read_file(src);
886 err = bubt_verify(dst);
890 err = bubt_write_file(dst, image_size);
898 bubt, 4, 0, do_bubt_cmd,
899 "Burn a u-boot image to flash",
900 "[file-name] [destination [source]]\n"
901 "\t-file-name The image file name to burn. Default = flash-image.bin\n"
902 "\t-destination Flash to burn to [spi, nand, mmc]. Default = active boot device\n"
903 "\t-source The source to load image from [tftp, usb, mmc]. Default = tftp\n"
905 "\tbubt - Burn flash-image.bin from tftp to active boot device\n"
906 "\tbubt flash-image-new.bin nand - Burn flash-image-new.bin from tftp to NAND flash\n"
907 "\tbubt backup-flash-image.bin mmc usb - Burn backup-flash-image.bin from usb to MMC\n"