2 * Copyright (C) 2012-2014 Lothar Waßmann <LW@KARO-electronics.de>
4 * See file CREDITS for list of people who contributed to this
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
23 #include <linux/err.h>
24 #include <jffs2/load_kernel.h>
27 #include <asm/sizes.h>
28 #include <asm/arch/imx-regs.h>
29 #include <asm/imx-common/regs-gpmi.h>
30 #include <asm/imx-common/regs-bch.h>
32 struct mx6_nand_timing {
47 struct mx6_nand_timing timing;
50 u32 sectors_per_block;
51 u32 number_of_nands; /* not used by ROM code */
52 u32 total_internal_die; /* not used by ROM code */
53 u32 cell_type; /* not used by ROM code */
59 u32 ecc_blocks_per_page;
60 u32 rsrvd1[6]; /* not used by ROM code */
61 u32 bch_mode; /* erase_threshold */
70 u32 bb_mark_phys_offset;
72 u32 rsrvd3[8]; /* Toggle NAND timing parameters */
74 u32 bb_mark_spare_offset;
75 u32 rsrvd4[9]; /* ONFI NAND parameters */
79 struct mx6_dbbt_header {
94 #define BF_VAL(v, bf) (((v) & bf##_MASK) >> bf##_OFFSET)
96 static nand_info_t *mtd = &nand_info[0];
100 #define BIT(v,n) (((v) >> (n)) & 0x1)
102 static u8 calculate_parity_13_8(u8 d)
106 p |= (BIT(d, 6) ^ BIT(d, 5) ^ BIT(d, 3) ^ BIT(d, 2)) << 0;
107 p |= (BIT(d, 7) ^ BIT(d, 5) ^ BIT(d, 4) ^ BIT(d, 2) ^ BIT(d, 1)) << 1;
108 p |= (BIT(d, 7) ^ BIT(d, 6) ^ BIT(d, 5) ^ BIT(d, 1) ^ BIT(d, 0)) << 2;
109 p |= (BIT(d, 7) ^ BIT(d, 4) ^ BIT(d, 3) ^ BIT(d, 0)) << 3;
110 p |= (BIT(d, 6) ^ BIT(d, 4) ^ BIT(d, 3) ^ BIT(d, 2) ^ BIT(d, 1) ^ BIT(d, 0)) << 4;
114 static void encode_hamming_13_8(void *_src, void *_ecc, size_t size)
120 for (i = 0; i < size; i++)
121 ecc[i] = calculate_parity_13_8(src[i]);
124 static u32 calc_chksum(void *buf, size_t size)
130 for (i = 0; i < size; i++) {
137 Physical organisation of data in NAND flash:
139 payload chunk 0 (may be empty)
140 ecc for metadata + payload chunk 0
142 ecc for payload chunk 1
145 ecc for payload chunk n
148 static inline int calc_bb_offset(nand_info_t *mtd, struct mx6_fcb *fcb)
151 int chunk_data_size = fcb->ecc_blockn_size * 8;
152 int chunk_ecc_size = (fcb->ecc_blockn_type << 1) * 13;
153 int chunk_total_size = chunk_data_size + chunk_ecc_size;
154 int bb_mark_chunk, bb_mark_chunk_offs;
156 bb_mark_offset = (mtd->writesize - fcb->metadata_size) * 8;
157 if (fcb->ecc_block0_size == 0)
158 bb_mark_offset -= (fcb->ecc_block0_type << 1) * 13;
160 bb_mark_chunk = bb_mark_offset / chunk_total_size;
161 bb_mark_chunk_offs = bb_mark_offset - (bb_mark_chunk * chunk_total_size);
162 if (bb_mark_chunk_offs > chunk_data_size) {
163 printf("Unsupported ECC layout; BB mark resides in ECC data: %u\n",
167 bb_mark_offset -= bb_mark_chunk * chunk_ecc_size;
168 return bb_mark_offset;
172 * return number of blocks to skip for a contiguous partition
175 static int find_contig_space(int block, int num_blocks, int max_blocks)
179 int last = block + max_blocks;
181 debug("Searching %u contiguous blocks from %d..%d\n",
182 num_blocks, block, block + max_blocks - 1);
183 for (; block < last; block++) {
184 if (nand_block_isbad(mtd, block * mtd->erasesize)) {
187 debug("Skipping %u blocks to %u\n",
191 if (found >= num_blocks) {
192 debug("Found %u good blocks from %d..%d\n",
193 found, block - found + 1, block);
201 #define pr_fcb_val(p, n) debug("%s=%08x(%d)\n", #n, (p)->n, (p)->n)
203 static struct mx6_fcb *create_fcb(void *buf, int fw1_start_block,
204 int fw2_start_block, int fw_num_blocks)
206 struct gpmi_regs *gpmi_base = (void *)GPMI_BASE_ADDRESS;
207 struct bch_regs *bch_base = (void *)BCH_BASE_ADDRESS;
211 int bb_mark_bit_offs;
215 if (gpmi_base == NULL || bch_base == NULL) {
216 return ERR_PTR(-ENOMEM);
219 fl0 = readl(&bch_base->hw_bch_flash0layout0);
220 fl1 = readl(&bch_base->hw_bch_flash0layout1);
221 t0 = readl(&gpmi_base->hw_gpmi_timing0);
223 metadata_size = BF_VAL(fl0, BCH_FLASHLAYOUT0_META_SIZE);
225 fcb = buf + ALIGN(metadata_size, 4);
226 fcb_offs = (void *)fcb - buf;
228 memset(buf, 0xff, fcb_offs);
229 memset(fcb, 0x00, sizeof(*fcb));
230 memset(fcb + 1, 0xff, mtd->erasesize - fcb_offs - sizeof(*fcb));
232 strncpy((char *)&fcb->fingerprint, "FCB ", 4);
233 fcb->version = cpu_to_be32(1);
235 fcb->disbb_search = 0;
238 /* ROM code assumes GPMI clock of 25 MHz */
239 fcb->timing.data_setup = BF_VAL(t0, GPMI_TIMING0_DATA_SETUP) * 40;
240 fcb->timing.data_hold = BF_VAL(t0, GPMI_TIMING0_DATA_HOLD) * 40;
241 fcb->timing.address_setup = BF_VAL(t0, GPMI_TIMING0_ADDRESS_SETUP) * 40;
243 fcb->page_data_size = mtd->writesize;
244 fcb->total_page_size = mtd->writesize + mtd->oobsize;
245 fcb->sectors_per_block = mtd->erasesize / mtd->writesize;
247 fcb->ecc_block0_type = BF_VAL(fl0, BCH_FLASHLAYOUT0_ECC0);
248 fcb->ecc_block0_size = BF_VAL(fl0, BCH_FLASHLAYOUT0_DATA0_SIZE) * 4;
249 fcb->ecc_blockn_type = BF_VAL(fl1, BCH_FLASHLAYOUT1_ECCN);
250 fcb->ecc_blockn_size = BF_VAL(fl1, BCH_FLASHLAYOUT1_DATAN_SIZE) * 4;
252 pr_fcb_val(fcb, ecc_block0_type);
253 pr_fcb_val(fcb, ecc_blockn_type);
254 pr_fcb_val(fcb, ecc_block0_size);
255 pr_fcb_val(fcb, ecc_blockn_size);
257 fcb->metadata_size = BF_VAL(fl0, BCH_FLASHLAYOUT0_META_SIZE);
258 fcb->ecc_blocks_per_page = BF_VAL(fl0, BCH_FLASHLAYOUT0_NBLOCKS);
259 fcb->bch_mode = readl(&bch_base->hw_bch_mode);
260 fcb->bch_type = 0; /* BCH20 */
262 fcb->fw1_start_page = fw1_start_block * fcb->sectors_per_block;
263 fcb->fw1_sectors = fw_num_blocks * fcb->sectors_per_block;
264 pr_fcb_val(fcb, fw1_start_page);
265 pr_fcb_val(fcb, fw1_sectors);
267 if (fw2_start_block != 0 && fw2_start_block < mtd->size / mtd->erasesize) {
268 fcb->fw2_start_page = fw2_start_block * fcb->sectors_per_block;
269 fcb->fw2_sectors = fcb->fw1_sectors;
270 pr_fcb_val(fcb, fw2_start_page);
271 pr_fcb_val(fcb, fw2_sectors);
274 fcb->dbbt_search_area = 0;
276 bb_mark_bit_offs = calc_bb_offset(mtd, fcb);
277 if (bb_mark_bit_offs < 0)
278 return ERR_PTR(bb_mark_bit_offs);
279 fcb->bb_mark_byte = bb_mark_bit_offs / 8;
280 fcb->bb_mark_startbit = bb_mark_bit_offs % 8;
281 fcb->bb_mark_phys_offset = mtd->writesize;
283 pr_fcb_val(fcb, bb_mark_byte);
284 pr_fcb_val(fcb, bb_mark_startbit);
285 pr_fcb_val(fcb, bb_mark_phys_offset);
287 fcb->checksum = calc_chksum(&fcb->fingerprint, 512 - 4);
291 static int find_fcb(void *ref, int page)
294 struct nand_chip *chip = mtd->priv;
295 void *buf = malloc(mtd->erasesize);
300 chip->select_chip(mtd, 0);
301 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
302 ret = chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
304 printf("Failed to read FCB from page %u: %d\n", page, ret);
307 if (memcmp(buf, ref, mtd->writesize) == 0) {
308 debug("Found FCB in page %u (%08x)\n",
309 page, page * mtd->writesize);
313 chip->select_chip(mtd, -1);
318 static int write_fcb(void *buf, int block)
321 struct nand_chip *chip = mtd->priv;
322 int page = block * mtd->erasesize / mtd->writesize;
324 ret = find_fcb(buf, page);
326 printf("FCB at block %d is up to date\n", block);
330 ret = nand_erase(mtd, block * mtd->erasesize, mtd->erasesize);
332 printf("Failed to erase FCB block %u\n", block);
336 printf("Writing FCB to block %d @ %08llx\n", block,
337 (u64)block * mtd->erasesize);
338 chip->select_chip(mtd, 0);
339 ret = chip->write_page(mtd, chip, buf, 1, page, 0, 1);
341 printf("Failed to write FCB to block %u: %d\n", block, ret);
343 chip->select_chip(mtd, -1);
358 struct mx6_boot_data {
364 static int find_ivt(void *buf)
366 struct mx6_ivt *ivt_hdr = buf + 0x400;
368 if ((ivt_hdr->magic & 0xff0000ff) != 0x400000d1)
374 static inline void *reloc(void *dst, void *base, void *ptr)
376 return dst + (ptr - base);
379 static int patch_ivt(void *buf, size_t fsize)
381 struct mx6_ivt *ivt_hdr = buf + 0x400;
382 struct mx6_boot_data *boot_data;
384 if (!find_ivt(buf)) {
385 printf("No IVT found in image at %p\n", buf);
388 boot_data = reloc(ivt_hdr, ivt_hdr->self, ivt_hdr->boot_data);
389 boot_data->length = fsize;
394 #define chk_overlap(a,b) \
395 ((a##_start_block <= b##_end_block && \
396 a##_end_block >= b##_start_block) || \
397 (b##_start_block <= a##_end_block && \
398 b##_end_block >= a##_start_block))
400 #define fail_if_overlap(a,b,m1,m2) do { \
401 if (chk_overlap(a, b)) { \
402 printf("%s blocks %lu..%lu overlap %s in blocks %lu..%lu!\n", \
403 m1, a##_start_block, a##_end_block, \
404 m2, b##_start_block, b##_end_block); \
409 static int tx6_prog_uboot(void *addr, int start_block, int skip,
410 size_t size, size_t max_len)
413 nand_erase_options_t erase_opts = { 0, };
415 size_t prg_length = max_len - skip * mtd->erasesize;
416 int prg_start = (start_block + skip) * mtd->erasesize;
418 erase_opts.offset = start_block * mtd->erasesize;
419 erase_opts.length = max_len;
420 erase_opts.quiet = 1;
422 printf("Erasing flash @ %08llx..%08llx\n", erase_opts.offset,
423 erase_opts.offset + erase_opts.length - 1);
424 ret = nand_erase_opts(mtd, &erase_opts);
426 printf("Failed to erase flash: %d\n", ret);
430 printf("Programming flash @ %08llx..%08llx from %p\n",
431 (u64)start_block * mtd->erasesize,
432 (u64)start_block * mtd->erasesize + size - 1, addr);
434 ret = nand_write_skip_bad(mtd, prg_start, &actual, NULL,
435 prg_length, addr, WITH_DROP_FFS);
437 printf("Failed to program flash: %d\n", ret);
441 printf("Could only write %u of %u bytes\n", actual, size);
447 #ifdef CONFIG_ENV_IS_IN_NAND
448 #ifndef CONFIG_ENV_OFFSET_REDUND
449 #define TOTAL_ENV_SIZE CONFIG_ENV_RANGE
451 #define TOTAL_ENV_SIZE (CONFIG_ENV_RANGE * 2)
455 int do_update(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
458 const unsigned long fcb_start_block = 0, fcb_end_block = 0;
459 int erase_size = mtd->erasesize;
460 int page_size = mtd->writesize;
467 unsigned long mtd_num_blocks = mtd->size / mtd->erasesize;
468 #ifdef CONFIG_ENV_IS_IN_NAND
469 unsigned long env_start_block = CONFIG_ENV_OFFSET / mtd->erasesize;
470 unsigned long env_end_block = env_start_block +
471 DIV_ROUND_UP(TOTAL_ENV_SIZE, mtd->erasesize) - 1;
475 unsigned long fw1_start_block = 0, fw1_end_block;
476 unsigned long fw2_start_block = 0, fw2_end_block;
477 unsigned long fw_num_blocks;
478 int fw1_skip, fw2_skip;
479 unsigned long extra_blocks = 0;
480 size_t max_len1, max_len2;
481 struct mtd_device *dev;
482 struct part_info *part_info;
483 struct part_info *redund_part_info;
484 const char *uboot_part = "u-boot";
485 const char *redund_part = NULL;
489 ret = mtdparts_init();
493 for (optind = 1; optind < argc; optind++) {
496 if (strcmp(argv[optind], "-f") == 0) {
497 if (optind >= argc - 1) {
498 printf("Option %s requires an argument\n",
503 fw1_start_block = simple_strtoul(argv[optind], &endp, 0);
505 uboot_part = argv[optind];
509 if (fw1_start_block >= mtd_num_blocks) {
510 printf("Block number %lu is out of range: 0..%lu\n",
511 fw1_start_block, mtd_num_blocks - 1);
514 } else if (strcmp(argv[optind], "-r") == 0) {
516 if (optind < argc - 1 && argv[optind + 1][0] != '-') {
518 fw2_start_block = simple_strtoul(argv[optind],
521 redund_part = argv[optind];
524 if (fw2_start_block >= mtd_num_blocks) {
525 printf("Block number %lu is out of range: 0..%lu\n",
531 } else if (strcmp(argv[optind], "-e") == 0) {
532 if (optind >= argc - 1) {
533 printf("Option %s requires an argument\n",
538 extra_blocks = simple_strtoul(argv[optind], NULL, 0);
539 if (extra_blocks >= mtd_num_blocks) {
540 printf("Extra block count %lu is out of range: 0..%lu\n",
545 } else if (argv[optind][0] == '-') {
546 printf("Unrecognized option %s\n", argv[optind]);
553 load_addr = getenv("fileaddr");
554 file_size = getenv("filesize");
556 if (argc - optind < 1 && load_addr == NULL) {
557 printf("Load address not specified\n");
560 if (argc - optind < 2 && file_size == NULL) {
561 printf("WARNING: Image size not specified; overwriting whole uboot partition\n");
565 addr = (void *)simple_strtoul(argv[optind], NULL, 16);
570 size = simple_strtoul(argv[optind], NULL, 16);
573 if (load_addr != NULL) {
574 addr = (void *)simple_strtoul(load_addr, NULL, 16);
575 printf("Using default load address %p\n", addr);
577 if (file_size != NULL) {
578 size = simple_strtoul(file_size, NULL, 16);
579 printf("Using default file size %08x\n", size);
582 fw_num_blocks = DIV_ROUND_UP(size, mtd->erasesize);
584 fw_num_blocks = part_info->size / mtd->erasesize -
586 size = fw_num_blocks * mtd->erasesize;
590 ret = find_dev_and_part(uboot_part, &dev, &part_num,
593 printf("Failed to find '%s' partition: %d\n",
597 fw1_start_block = part_info->offset / mtd->erasesize;
598 max_len1 = part_info->size;
600 max_len1 = (fw_num_blocks + extra_blocks) * mtd->erasesize;
604 ret = find_dev_and_part(redund_part, &dev, &redund_part_num,
607 printf("Failed to find '%s' partition: %d\n",
611 fw2_start_block = redund_part_info->offset / mtd->erasesize;
612 max_len2 = redund_part_info->size;
613 } else if (fw2_set) {
614 max_len2 = (fw_num_blocks + extra_blocks) * mtd->erasesize;
619 fw1_skip = find_contig_space(fw1_start_block, fw_num_blocks,
620 max_len1 / mtd->erasesize);
622 printf("Could not find %lu contiguous good blocks for fw image\n",
625 #ifdef CONFIG_ENV_IS_IN_NAND
626 if (part_info->offset <= CONFIG_ENV_OFFSET + TOTAL_ENV_SIZE) {
627 printf("Use a different partition\n");
629 printf("Increase the size of the '%s' partition\n",
633 printf("Increase the size of the '%s' partition\n",
637 printf("Increase the number of spare blocks to use with the '-e' option\n");
641 fw1_end_block = fw1_start_block + fw1_skip + fw_num_blocks - 1;
643 if (fw2_set && fw2_start_block == 0)
644 fw2_start_block = fw1_end_block + 1;
645 if (fw2_start_block > 0) {
646 fw2_skip = find_contig_space(fw2_start_block, fw_num_blocks,
647 max_len2 / mtd->erasesize);
649 printf("Could not find %lu contiguous good blocks for redundant fw image\n",
652 printf("Increase the size of the '%s' partition or use a different partition\n",
655 printf("Increase the number of spare blocks to use with the '-e' option\n");
662 fw2_end_block = fw2_start_block + fw2_skip + fw_num_blocks - 1;
664 #ifdef CONFIG_ENV_IS_IN_NAND
665 fail_if_overlap(fcb, env, "FCB", "Environment");
666 fail_if_overlap(fw1, env, "FW1", "Environment");
668 fail_if_overlap(fcb, fw1, "FCB", "FW1");
670 fail_if_overlap(fcb, fw2, "FCB", "FW2");
671 #ifdef CONFIG_ENV_IS_IN_NAND
672 fail_if_overlap(fw2, env, "FW2", "Environment");
674 fail_if_overlap(fw1, fw2, "FW1", "FW2");
677 buf = malloc(erase_size);
679 printf("Failed to allocate buffer\n");
683 fcb = create_fcb(buf, fw1_start_block + fw1_skip,
684 fw2_start_block + fw2_skip, fw_num_blocks);
686 printf("Failed to initialize FCB: %ld\n", PTR_ERR(fcb));
690 encode_hamming_13_8(fcb, (void *)fcb + 512, 512);
692 ret = write_fcb(buf, fcb_start_block);
695 printf("Failed to write FCB to block %lu\n", fcb_start_block);
698 ret = patch_ivt(addr, size);
703 if (size & (page_size - 1)) {
704 memset(addr + size, 0xff, size & (page_size - 1));
705 size = ALIGN(size, page_size);
708 printf("Programming U-Boot image from %p to block %lu @ %08llx\n",
709 addr, fw1_start_block + fw1_skip,
710 (u64)(fw1_start_block + fw1_skip) * mtd->erasesize);
711 ret = tx6_prog_uboot(addr, fw1_start_block, fw1_skip, size,
714 if (fw2_start_block == 0) {
718 printf("Programming redundant U-Boot image to block %lu @ %08llx\n",
719 fw2_start_block + fw2_skip,
720 (u64)(fw2_start_block + fw2_skip) * mtd->erasesize);
721 ret = tx6_prog_uboot(addr, fw2_start_block, fw2_skip, fw_num_blocks,
726 U_BOOT_CMD(romupdate, 11, 0, do_update,
727 "Creates an FCB data structure and writes an U-Boot image to flash",
728 "[-f {<part>|block#}] [-r [{<part>|block#}]] [-e #] [<address>] [<length>]\n"
729 "\t-f <part>\twrite bootloader image to partition <part>\n"
730 "\t-f #\twrite bootloader image at block # (decimal)\n"
731 "\t-r\twrite redundant bootloader image at next free block after first image\n"
732 "\t-r <part>\twrite redundant bootloader image to partition <part>\n"
733 "\t-r #\twrite redundant bootloader image at block # (decimal)\n"
734 "\t-e #\tspecify number of redundant blocks per boot loader image\n"
735 "\t\tonly valid if -f or -r specify a flash address rather than a partition name\n"
736 "\t<address>\tRAM address of bootloader image (default: ${fileaddr}\n"
737 "\t<length>\tlength of bootloader image in RAM (default: ${filesize}"