2 * Driver for NAND support, Rick Bronson
3 * borrowed heavily from:
4 * (c) 1999 Machine Vision Holdings, Inc.
5 * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org>
7 * Ported 'dynenv' to 'nand env.oob' command
8 * (C) 2010 Nanometrics, Inc.
9 * 'dynenv' -- Dynamic environment offset in NAND OOB
10 * (C) Copyright 2006-2007 OpenMoko, Inc.
11 * Added 16-bit nand support
12 * (C) 2004 Texas Instruments
14 * Copyright 2010 Freescale Semiconductor
15 * The portions of this file whose copyright is held by Freescale and which
16 * are not considered a derived work of GPL v2-only code may be distributed
17 * and/or modified under the terms of the GNU General Public License as
18 * published by the Free Software Foundation; either version 2 of the
19 * License, or (at your option) any later version.
23 #include <linux/mtd/mtd.h>
27 #include <asm/byteorder.h>
28 #include <jffs2/jffs2.h>
31 #if defined(CONFIG_CMD_MTDPARTS)
33 /* partition handling routines */
34 int mtdparts_init(void);
35 int id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
36 int find_dev_and_part(const char *id, struct mtd_device **dev,
37 u8 *part_num, struct part_info **part);
40 static int nand_dump(nand_info_t *nand, ulong off, int only_oob, int repeat)
43 u_char *datbuf, *oobbuf, *p;
47 off = last + nand->writesize;
51 datbuf = malloc(nand->writesize + nand->oobsize);
52 oobbuf = malloc(nand->oobsize);
53 if (!datbuf || !oobbuf) {
54 puts("No memory for page buffer\n");
61 off &= ~(nand->writesize - 1);
62 loff_t addr = (loff_t) off;
63 struct mtd_oob_ops ops;
64 memset(&ops, 0, sizeof(ops));
66 ops.oobbuf = oobbuf; /* must exist, but oob data will be appended to ops.datbuf */
67 ops.len = nand->writesize;
68 ops.ooblen = nand->oobsize;
69 ops.mode = MTD_OOB_RAW;
70 i = nand->read_oob(nand, addr, &ops);
72 printf("Error (%d) reading page %08lx\n", i, off);
77 printf("Page %08lx dump:\n", off);
78 i = nand->writesize >> 4;
83 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
84 " %02x %02x %02x %02x %02x %02x %02x %02x\n",
85 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
86 p[8], p[9], p[10], p[11], p[12], p[13], p[14],
91 i = nand->oobsize >> 3;
93 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
94 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
103 /* ------------------------------------------------------------------------- */
105 static int set_dev(int dev)
107 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
108 !nand_info[dev].name) {
109 puts("No such device\n");
113 if (nand_curr_device == dev)
116 printf("Device %d: %s", dev, nand_info[dev].name);
117 puts("... is now current device\n");
118 nand_curr_device = dev;
120 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
121 board_nand_select_device(nand_info[dev].priv, dev);
127 static inline int str2off(const char *p, loff_t *num)
131 *num = simple_strtoull(p, &endptr, 16);
132 return *p != '\0' && *endptr == '\0';
135 static inline int str2long(const char *p, ulong *num)
139 *num = simple_strtoul(p, &endptr, 16);
140 return *p != '\0' && *endptr == '\0';
143 static int get_part(const char *partname, int *idx, loff_t *off, loff_t *size)
145 #ifdef CONFIG_CMD_MTDPARTS
146 struct mtd_device *dev;
147 struct part_info *part;
151 ret = mtdparts_init();
155 ret = find_dev_and_part(partname, &dev, &pnum, &part);
159 if (dev->id->type != MTD_DEV_TYPE_NAND) {
160 puts("not a NAND device\n");
174 puts("offset is not a number\n");
179 static int arg_off(const char *arg, int *idx, loff_t *off, loff_t *maxsize)
181 if (!str2off(arg, off))
182 return get_part(arg, idx, off, maxsize);
184 if (*off >= nand_info[*idx].size) {
185 puts("Offset exceeds device limit\n");
189 *maxsize = nand_info[*idx].size - *off;
193 static int arg_off_size(int argc, char *const argv[], int *idx,
194 loff_t *off, loff_t *size)
201 *size = nand_info[*idx].size;
205 ret = arg_off(argv[0], idx, off, &maxsize);
214 if (!str2off(argv[1], size)) {
215 printf("'%s' is not a number\n", argv[1]);
219 if (*size > maxsize) {
220 puts("Size exceeds partition or device limit\n");
225 printf("device %d ", *idx);
226 if (*size == nand_info[*idx].size)
227 puts("whole chip\n");
229 printf("offset 0x%llx, size 0x%llx\n",
230 (unsigned long long)*off, (unsigned long long)*size);
234 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
235 static void print_status(ulong start, ulong end, ulong erasesize, int status)
237 printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
240 (end - start) / erasesize,
241 ((status & NAND_LOCK_STATUS_TIGHT) ? "TIGHT " : ""),
242 ((status & NAND_LOCK_STATUS_LOCK) ? "LOCK " : ""),
243 ((status & NAND_LOCK_STATUS_UNLOCK) ? "UNLOCK " : ""));
246 static void do_nand_status(nand_info_t *nand)
248 ulong block_start = 0;
250 int last_status = -1;
252 struct nand_chip *nand_chip = nand->priv;
253 /* check the WP bit */
254 nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
255 printf("device is %swrite protected\n",
256 (nand_chip->read_byte(nand) & 0x80 ?
259 for (off = 0; off < nand->size; off += nand->erasesize) {
260 int s = nand_get_lock_status(nand, off);
262 /* print message only if status has changed */
263 if (s != last_status && off != 0) {
264 print_status(block_start, off, nand->erasesize,
270 /* Print the last block info */
271 print_status(block_start, off, nand->erasesize, last_status);
275 #ifdef CONFIG_ENV_OFFSET_OOB
276 unsigned long nand_env_oob_offset;
278 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
281 uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
282 nand_info_t *nand = &nand_info[0];
285 if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !nand->name) {
286 puts("no devices available\n");
292 if (!strcmp(cmd, "get")) {
293 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
297 printf("0x%08lx\n", nand_env_oob_offset);
298 } else if (!strcmp(cmd, "set")) {
301 struct mtd_oob_ops ops;
307 if (arg_off(argv[2], &idx, &addr, &maxsize)) {
308 puts("Offset or partition name expected\n");
313 puts("Partition not on first NAND device\n");
317 if (nand->oobavail < ENV_OFFSET_SIZE) {
318 printf("Insufficient available OOB bytes:\n"
319 "%d OOB bytes available but %d required for "
321 nand->oobavail, ENV_OFFSET_SIZE);
325 if ((addr & (nand->erasesize - 1)) != 0) {
326 printf("Environment offset must be block-aligned\n");
331 ops.mode = MTD_OOB_AUTO;
333 ops.ooblen = ENV_OFFSET_SIZE;
334 ops.oobbuf = (void *) oob_buf;
336 oob_buf[0] = ENV_OOB_MARKER;
337 oob_buf[1] = addr / nand->erasesize;
339 ret = nand->write_oob(nand, ENV_OFFSET_SIZE, &ops);
341 printf("Error writing OOB block 0\n");
345 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
347 printf("Error reading env offset in OOB\n");
351 if (addr != nand_env_oob_offset) {
352 printf("Verification of env offset in OOB failed: "
353 "0x%08llx expected but got 0x%08lx\n",
354 (unsigned long long)addr, nand_env_oob_offset);
364 return cmd_usage(cmdtp);
369 static void nand_print_info(int idx)
371 nand_info_t *nand = &nand_info[idx];
372 struct nand_chip *chip = nand->priv;
373 printf("Device %d: ", idx);
374 if (chip->numchips > 1)
375 printf("%dx ", chip->numchips);
376 printf("%s, sector size %u KiB\n",
377 nand->name, nand->erasesize >> 10);
380 int do_nand(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
387 #ifdef CONFIG_SYS_NAND_QUIET
388 int quiet = CONFIG_SYS_NAND_QUIET;
392 const char *quiet_str = getenv("quiet");
393 int dev = nand_curr_device;
394 int repeat = flag & CMD_FLAG_REPEAT;
396 /* at least two arguments please */
401 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
405 /* Only "dump" is repeatable. */
406 if (repeat && strcmp(cmd, "dump"))
409 if (strcmp(cmd, "info") == 0) {
412 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
413 if (nand_info[i].name)
419 if (strcmp(cmd, "device") == 0) {
422 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
423 puts("no devices available\n");
425 nand_print_info(dev);
429 dev = (int)simple_strtoul(argv[2], NULL, 10);
435 #ifdef CONFIG_ENV_OFFSET_OOB
436 /* this command operates only on the first nand device */
437 if (strcmp(cmd, "env.oob") == 0)
438 return do_nand_env_oob(cmdtp, argc - 1, argv + 1);
441 /* The following commands operate on the current device, unless
442 * overridden by a partition specifier. Note that if somehow the
443 * current device is invalid, it will have to be changed to a valid
444 * one before these commands can run, even if a partition specifier
445 * for another device is to be used.
447 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
448 !nand_info[dev].name) {
449 puts("\nno devices available\n");
452 nand = &nand_info[dev];
454 if (strcmp(cmd, "bad") == 0) {
455 printf("\nDevice %d bad blocks:\n", dev);
456 for (off = 0; off < nand->size; off += nand->erasesize)
457 if (nand_block_isbad(nand, off))
458 printf(" %08llx\n", (unsigned long long)off);
465 * nand erase [clean] [off size]
467 if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
468 nand_erase_options_t opts;
469 /* "clean" at index 2 means request to write cleanmarker */
470 int clean = argc > 2 && !strcmp("clean", argv[2]);
471 int o = clean ? 3 : 2;
472 int scrub = !strncmp(cmd, "scrub", 5);
479 if (!strcmp(&cmd[5], ".spread")) {
481 } else if (!strcmp(&cmd[5], ".part")) {
484 } else if (!strcmp(&cmd[5], ".chip")) {
493 * Don't allow missing arguments to cause full chip/partition
494 * erases -- easy to do accidentally, e.g. with a misspelled
497 if (argc != o + args)
500 printf("\nNAND %s: ", cmd);
501 /* skip first two or three arguments, look for offset and size */
502 if (arg_off_size(argc - o, argv + o, &dev, &off, &size) != 0)
505 nand = &nand_info[dev];
507 memset(&opts, 0, sizeof(opts));
512 opts.spread = spread;
516 "scrub option will erase all factory set "
519 "There is no reliable way to recover them.\n"
521 "Use this command only for testing purposes "
524 "are sure of what you are doing!\n"
525 "\nReally scrub this NAND flash? <y/N>\n");
532 puts("scrub aborted\n");
536 puts("scrub aborted\n");
540 ret = nand_erase_opts(nand, &opts);
541 printf("%s\n", ret ? "ERROR" : "OK");
543 return ret == 0 ? 0 : 1;
546 if (strncmp(cmd, "dump", 4) == 0) {
550 off = (int)simple_strtoul(argv[2], NULL, 16);
551 ret = nand_dump(nand, off, !strcmp(&cmd[4], ".oob"), repeat);
553 return ret == 0 ? 1 : 0;
556 if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
563 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
565 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
566 printf("\nNAND %s: ", read ? "read" : "write");
567 if (arg_off_size(argc - 3, argv + 3, &dev, &off, &size) != 0)
570 nand = &nand_info[dev];
573 s = strchr(cmd, '.');
574 if (!s || !strcmp(s, ".jffs2") ||
575 !strcmp(s, ".e") || !strcmp(s, ".i")) {
577 #ifdef SPRD_EVM_TAG_ON
580 ret = nand_read_skip_bad(nand, off, &rwsize,
582 #ifdef SPRD_EVM_TAG_ON
587 ret = nand_write_skip_bad(nand, off, &rwsize,
589 } else if (!strcmp(s, ".oob")) {
590 /* out-of-band data */
591 mtd_oob_ops_t ops = {
592 .oobbuf = (u8 *)addr,
598 ret = nand->read_oob(nand, off, &ops);
600 ret = nand->write_oob(nand, off, &ops);
602 printf("Unknown nand command suffix '%s'.\n", s);
606 printf(" %zu bytes %s: %s\n", rwsize,
607 read ? "read" : "written", ret ? "ERROR" : "OK");
609 return ret == 0 ? 0 : 1;
612 if (strcmp(cmd, "markbad") == 0) {
620 addr = simple_strtoul(*argv, NULL, 16);
622 if (nand->block_markbad(nand, addr)) {
623 printf("block 0x%08lx NOT marked "
624 "as bad! ERROR %d\n",
628 printf("block 0x%08lx successfully "
638 if (strcmp(cmd, "biterr") == 0) {
643 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
644 if (strcmp(cmd, "lock") == 0) {
648 if (!strcmp("tight", argv[2]))
650 if (!strcmp("status", argv[2]))
654 do_nand_status(nand);
656 if (!nand_lock(nand, tight)) {
657 puts("NAND flash successfully locked\n");
659 puts("Error locking NAND flash\n");
666 if (strcmp(cmd, "unlock") == 0) {
667 if (arg_off_size(argc - 2, argv + 2, &dev, &off, &size) < 0)
670 if (!nand_unlock(&nand_info[dev], off, size)) {
671 puts("NAND flash successfully unlocked\n");
673 puts("Error unlocking NAND flash, "
674 "write and erase will probably fail\n");
682 return cmd_usage(cmdtp);
686 nand, CONFIG_SYS_MAXARGS, 1, do_nand,
688 "info - show available NAND devices\n"
689 "nand device [dev] - show or set current device\n"
690 "nand read - addr off|partition size\n"
691 "nand write - addr off|partition size\n"
692 " read/write 'size' bytes starting at offset 'off'\n"
693 " to/from memory address 'addr', skipping bad blocks.\n"
694 "nand erase[.spread] [clean] [off [size]] - erase 'size' bytes "
695 "from offset 'off'\n"
696 " With '.spread', erase enough for given file size, otherwise,\n"
697 " 'size' includes skipped bad blocks.\n"
698 "nand erase.part [clean] partition - erase entire mtd partition'\n"
699 "nand erase.chip [clean] - erase entire chip'\n"
700 "nand bad - show bad blocks\n"
701 "nand dump[.oob] off - dump page\n"
702 "nand scrub off size | scrub.part partition | scrub.chip\n"
703 " really clean NAND erasing bad blocks (UNSAFE)\n"
704 "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
705 "nand biterr off - make a bit error at offset (UNSAFE)"
706 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
708 "nand lock [tight] [status]\n"
709 " bring nand to lock state or display locked pages\n"
710 "nand unlock [offset] [size] - unlock section"
712 #ifdef CONFIG_ENV_OFFSET_OOB
714 "nand env.oob - environment offset in OOB of block 0 of"
716 "nand env.oob set off|partition - set enviromnent offset\n"
717 "nand env.oob get - get environment offset"
721 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
722 ulong offset, ulong addr, char *cmd)
728 #if defined(CONFIG_FIT)
729 const void *fit_hdr = NULL;
732 s = strchr(cmd, '.');
734 (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
735 printf("Unknown nand load suffix '%s'\n", s);
736 show_boot_progress(-53);
740 printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
742 cnt = nand->writesize;
743 r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
745 puts("** Read error\n");
746 show_boot_progress (-56);
749 show_boot_progress (56);
751 switch (genimg_get_format ((void *)addr)) {
752 case IMAGE_FORMAT_LEGACY:
753 hdr = (image_header_t *)addr;
755 show_boot_progress (57);
756 image_print_contents (hdr);
758 cnt = image_get_image_size (hdr);
760 #if defined(CONFIG_FIT)
761 case IMAGE_FORMAT_FIT:
762 fit_hdr = (const void *)addr;
763 puts ("Fit image detected...\n");
765 cnt = fit_get_size (fit_hdr);
769 show_boot_progress (-57);
770 puts ("** Unknown image type\n");
773 show_boot_progress (57);
775 r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
777 puts("** Read error\n");
778 show_boot_progress (-58);
781 show_boot_progress (58);
783 #if defined(CONFIG_FIT)
784 /* This cannot be done earlier, we need complete FIT image in RAM first */
785 if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
786 if (!fit_check_format (fit_hdr)) {
787 show_boot_progress (-150);
788 puts ("** Bad FIT image format\n");
791 show_boot_progress (151);
792 fit_print_contents (fit_hdr);
796 /* Loading ok, update default load address */
800 /* Check if we should attempt an auto-start */
801 if (((ep = getenv("autostart")) != NULL) && (strcmp(ep, "yes") == 0)) {
803 extern int do_bootm(cmd_tbl_t *, int, int, char *[]);
806 local_args[1] = NULL;
808 printf("Automatic boot of image at addr 0x%08lx ...\n", addr);
810 do_bootm(cmdtp, 0, 1, local_args);
816 int do_nandboot(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
818 char *boot_device = NULL;
820 ulong addr, offset = 0;
821 #if defined(CONFIG_CMD_MTDPARTS)
822 struct mtd_device *dev;
823 struct part_info *part;
827 char *p = (argc == 2) ? argv[1] : argv[2];
828 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
829 (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
830 if (dev->id->type != MTD_DEV_TYPE_NAND) {
831 puts("Not a NAND device\n");
837 addr = simple_strtoul(argv[1], NULL, 16);
839 addr = CONFIG_SYS_LOAD_ADDR;
840 return nand_load_image(cmdtp, &nand_info[dev->id->num],
841 part->offset, addr, argv[0]);
846 show_boot_progress(52);
849 addr = CONFIG_SYS_LOAD_ADDR;
850 boot_device = getenv("bootdevice");
853 addr = simple_strtoul(argv[1], NULL, 16);
854 boot_device = getenv("bootdevice");
857 addr = simple_strtoul(argv[1], NULL, 16);
858 boot_device = argv[2];
861 addr = simple_strtoul(argv[1], NULL, 16);
862 boot_device = argv[2];
863 offset = simple_strtoul(argv[3], NULL, 16);
866 #if defined(CONFIG_CMD_MTDPARTS)
869 show_boot_progress(-53);
870 return cmd_usage(cmdtp);
873 show_boot_progress(53);
875 puts("\n** No boot device **\n");
876 show_boot_progress(-54);
879 show_boot_progress(54);
881 idx = simple_strtoul(boot_device, NULL, 16);
883 if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
884 printf("\n** Device %d not available\n", idx);
885 show_boot_progress(-55);
888 show_boot_progress(55);
890 return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
893 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
894 "boot from NAND device",
895 "[partition] | [[[loadAddr] dev] offset]"