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 * Added 16-bit nand support
8 * (C) 2004 Texas Instruments
12 #include <linux/mtd/mtd.h>
14 #if defined(CONFIG_CMD_NAND)
19 #include <asm/byteorder.h>
20 #include <jffs2/jffs2.h>
23 #if defined(CONFIG_CMD_MTDPARTS)
25 /* parition handling routines */
26 int mtdparts_init(void);
27 int id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
28 int find_dev_and_part(const char *id, struct mtd_device **dev,
29 u8 *part_num, struct part_info **part);
32 static int nand_dump(nand_info_t *nand, ulong off, int only_oob)
35 u_char *datbuf, *oobbuf, *p;
37 datbuf = malloc(nand->writesize + nand->oobsize);
38 oobbuf = malloc(nand->oobsize);
39 if (!datbuf || !oobbuf) {
40 puts("No memory for page buffer\n");
43 off &= ~(nand->writesize - 1);
44 loff_t addr = (loff_t) off;
45 struct mtd_oob_ops ops;
46 memset(&ops, 0, sizeof(ops));
48 ops.oobbuf = oobbuf; /* must exist, but oob data will be appended to ops.datbuf */
49 ops.len = nand->writesize;
50 ops.ooblen = nand->oobsize;
51 ops.mode = MTD_OOB_RAW;
52 i = nand->read_oob(nand, addr, &ops);
54 printf("Error (%d) reading page %08lx\n", i, off);
59 printf("Page %08lx dump:\n", off);
60 i = nand->writesize >> 4;
65 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
66 " %02x %02x %02x %02x %02x %02x %02x %02x\n",
67 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
68 p[8], p[9], p[10], p[11], p[12], p[13], p[14],
73 i = nand->oobsize >> 3;
75 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
76 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
85 /* ------------------------------------------------------------------------- */
87 static inline int str2long(char *p, ulong *num)
91 *num = simple_strtoul(p, &endptr, 16);
92 return (*p != '\0' && *endptr == '\0') ? 1 : 0;
96 arg_off_size(int argc, char *argv[], nand_info_t *nand, ulong *off, size_t *size)
98 int idx = nand_curr_device;
99 #if defined(CONFIG_CMD_MTDPARTS)
100 struct mtd_device *dev;
101 struct part_info *part;
104 if (argc >= 1 && !(str2long(argv[0], off))) {
105 if ((mtdparts_init() == 0) &&
106 (find_dev_and_part(argv[0], &dev, &pnum, &part) == 0)) {
107 if (dev->id->type != MTD_DEV_TYPE_NAND) {
108 puts("not a NAND device\n");
113 if (!(str2long(argv[1], (ulong *)size))) {
114 printf("'%s' is not a number\n", argv[1]);
117 if (*size > part->size)
123 *nand = nand_info[idx];
130 if (!(str2long(argv[0], off))) {
131 printf("'%s' is not a number\n", argv[0]);
139 if (!(str2long(argv[1], (ulong *)size))) {
140 printf("'%s' is not a number\n", argv[1]);
144 *size = nand->size - *off;
147 #if defined(CONFIG_CMD_MTDPARTS)
150 printf("device %d ", idx);
151 if (*size == nand->size)
152 puts("whole chip\n");
154 printf("offset 0x%lx, size 0x%zx\n", *off, *size);
158 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
159 static void print_status(ulong start, ulong end, ulong erasesize, int status)
161 printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
164 (end - start) / erasesize,
165 ((status & NAND_LOCK_STATUS_TIGHT) ? "TIGHT " : ""),
166 ((status & NAND_LOCK_STATUS_LOCK) ? "LOCK " : ""),
167 ((status & NAND_LOCK_STATUS_UNLOCK) ? "UNLOCK " : ""));
170 static void do_nand_status(nand_info_t *nand)
172 ulong block_start = 0;
174 int last_status = -1;
176 struct nand_chip *nand_chip = nand->priv;
177 /* check the WP bit */
178 nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
179 printf("device is %swrite protected\n",
180 (nand_chip->read_byte(nand) & 0x80 ?
183 for (off = 0; off < nand->size; off += nand->erasesize) {
184 int s = nand_get_lock_status(nand, off);
186 /* print message only if status has changed */
187 if (s != last_status && off != 0) {
188 print_status(block_start, off, nand->erasesize,
194 /* Print the last block info */
195 print_status(block_start, off, nand->erasesize, last_status);
199 static void nand_print_info(int idx)
201 nand_info_t *nand = &nand_info[idx];
202 struct nand_chip *chip = nand->priv;
203 printf("Device %d: ", idx);
204 if (chip->numchips > 1)
205 printf("%dx ", chip->numchips);
206 printf("%s, sector size %u KiB\n",
207 nand->name, nand->erasesize >> 10);
210 int do_nand(cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
217 #ifdef CONFIG_SYS_NAND_QUIET
218 int quiet = CONFIG_SYS_NAND_QUIET;
222 const char *quiet_str = getenv("quiet");
224 /* at least two arguments please */
229 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
233 if (strcmp(cmd, "info") == 0) {
236 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
237 if (nand_info[i].name)
243 if (strcmp(cmd, "device") == 0) {
247 if ((nand_curr_device < 0) ||
248 (nand_curr_device >= CONFIG_SYS_MAX_NAND_DEVICE))
249 puts("no devices available\n");
251 nand_print_info(nand_curr_device);
254 dev = (int)simple_strtoul(argv[2], NULL, 10);
255 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[dev].name) {
256 puts("No such device\n");
259 printf("Device %d: %s", dev, nand_info[dev].name);
260 puts("... is now current device\n");
261 nand_curr_device = dev;
263 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
265 * Select the chip in the board/cpu specific driver
267 board_nand_select_device(nand_info[dev].priv, dev);
273 if (strcmp(cmd, "bad") != 0 && strcmp(cmd, "erase") != 0 &&
274 strncmp(cmd, "dump", 4) != 0 &&
275 strncmp(cmd, "read", 4) != 0 && strncmp(cmd, "write", 5) != 0 &&
276 strcmp(cmd, "scrub") != 0 && strcmp(cmd, "markbad") != 0 &&
277 strcmp(cmd, "biterr") != 0 &&
278 strcmp(cmd, "lock") != 0 && strcmp(cmd, "unlock") != 0 )
281 /* the following commands operate on the current device */
282 if (nand_curr_device < 0 || nand_curr_device >= CONFIG_SYS_MAX_NAND_DEVICE ||
283 !nand_info[nand_curr_device].name) {
284 puts("\nno devices available\n");
287 nand = &nand_info[nand_curr_device];
289 if (strcmp(cmd, "bad") == 0) {
290 printf("\nDevice %d bad blocks:\n", nand_curr_device);
291 for (off = 0; off < nand->size; off += nand->erasesize)
292 if (nand_block_isbad(nand, off))
293 printf(" %08lx\n", off);
300 * nand erase [clean] [off size]
302 if (strcmp(cmd, "erase") == 0 || strcmp(cmd, "scrub") == 0) {
303 nand_erase_options_t opts;
304 /* "clean" at index 2 means request to write cleanmarker */
305 int clean = argc > 2 && !strcmp("clean", argv[2]);
306 int o = clean ? 3 : 2;
307 int scrub = !strcmp(cmd, "scrub");
309 printf("\nNAND %s: ", scrub ? "scrub" : "erase");
310 /* skip first two or three arguments, look for offset and size */
311 if (arg_off_size(argc - o, argv + o, nand, &off, &size) != 0)
314 memset(&opts, 0, sizeof(opts));
322 "scrub option will erase all factory set "
325 "There is no reliable way to recover them.\n"
327 "Use this command only for testing purposes "
330 "are sure of what you are doing!\n"
331 "\nReally scrub this NAND flash? <y/N>\n");
333 if (getc() == 'y' && getc() == '\r') {
336 puts("scrub aborted\n");
340 ret = nand_erase_opts(nand, &opts);
341 printf("%s\n", ret ? "ERROR" : "OK");
343 return ret == 0 ? 0 : 1;
346 if (strncmp(cmd, "dump", 4) == 0) {
350 s = strchr(cmd, '.');
351 off = (int)simple_strtoul(argv[2], NULL, 16);
353 if (s != NULL && strcmp(s, ".oob") == 0)
354 ret = nand_dump(nand, off, 1);
356 ret = nand_dump(nand, off, 0);
358 return ret == 0 ? 1 : 0;
362 if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
368 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
370 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
371 printf("\nNAND %s: ", read ? "read" : "write");
372 if (arg_off_size(argc - 3, argv + 3, nand, &off, &size) != 0)
375 s = strchr(cmd, '.');
376 if (!s || !strcmp(s, ".jffs2") ||
377 !strcmp(s, ".e") || !strcmp(s, ".i")) {
379 ret = nand_read_skip_bad(nand, off, &size,
382 ret = nand_write_skip_bad(nand, off, &size,
384 } else if (!strcmp(s, ".oob")) {
385 /* out-of-band data */
386 mtd_oob_ops_t ops = {
387 .oobbuf = (u8 *)addr,
393 ret = nand->read_oob(nand, off, &ops);
395 ret = nand->write_oob(nand, off, &ops);
397 printf("Unknown nand command suffix '%s'.\n", s);
401 printf(" %zu bytes %s: %s\n", size,
402 read ? "read" : "written", ret ? "ERROR" : "OK");
404 return ret == 0 ? 0 : 1;
407 if (strcmp(cmd, "markbad") == 0) {
415 addr = simple_strtoul(*argv, NULL, 16);
417 if (nand->block_markbad(nand, addr)) {
418 printf("block 0x%08lx NOT marked "
419 "as bad! ERROR %d\n",
423 printf("block 0x%08lx successfully "
433 if (strcmp(cmd, "biterr") == 0) {
438 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
439 if (strcmp(cmd, "lock") == 0) {
443 if (!strcmp("tight", argv[2]))
445 if (!strcmp("status", argv[2]))
449 do_nand_status(nand);
451 if (!nand_lock(nand, tight)) {
452 puts("NAND flash successfully locked\n");
454 puts("Error locking NAND flash\n");
461 if (strcmp(cmd, "unlock") == 0) {
462 if (arg_off_size(argc - 2, argv + 2, nand, &off, &size) < 0)
465 if (!nand_unlock(nand, off, size)) {
466 puts("NAND flash successfully unlocked\n");
468 puts("Error unlocking NAND flash, "
469 "write and erase will probably fail\n");
481 U_BOOT_CMD(nand, CONFIG_SYS_MAXARGS, 1, do_nand,
483 "info - show available NAND devices\n"
484 "nand device [dev] - show or set current device\n"
485 "nand read - addr off|partition size\n"
486 "nand write - addr off|partition size\n"
487 " read/write 'size' bytes starting at offset 'off'\n"
488 " to/from memory address 'addr', skipping bad blocks.\n"
489 "nand erase [clean] [off size] - erase 'size' bytes from\n"
490 " offset 'off' (entire device if not specified)\n"
491 "nand bad - show bad blocks\n"
492 "nand dump[.oob] off - dump page\n"
493 "nand scrub - really clean NAND erasing bad blocks (UNSAFE)\n"
494 "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
495 "nand biterr off - make a bit error at offset (UNSAFE)"
496 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
498 "nand lock [tight] [status]\n"
499 " bring nand to lock state or display locked pages\n"
500 "nand unlock [offset] [size] - unlock section"
504 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
505 ulong offset, ulong addr, char *cmd)
511 #if defined(CONFIG_FIT)
512 const void *fit_hdr = NULL;
515 s = strchr(cmd, '.');
517 (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
518 printf("Unknown nand load suffix '%s'\n", s);
519 show_boot_progress(-53);
523 printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
525 cnt = nand->writesize;
526 r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
528 puts("** Read error\n");
529 show_boot_progress (-56);
532 show_boot_progress (56);
534 switch (genimg_get_format ((void *)addr)) {
535 case IMAGE_FORMAT_LEGACY:
536 hdr = (image_header_t *)addr;
538 show_boot_progress (57);
539 image_print_contents (hdr);
541 cnt = image_get_image_size (hdr);
543 #if defined(CONFIG_FIT)
544 case IMAGE_FORMAT_FIT:
545 fit_hdr = (const void *)addr;
546 puts ("Fit image detected...\n");
548 cnt = fit_get_size (fit_hdr);
552 show_boot_progress (-57);
553 puts ("** Unknown image type\n");
556 show_boot_progress (57);
558 r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
560 puts("** Read error\n");
561 show_boot_progress (-58);
564 show_boot_progress (58);
566 #if defined(CONFIG_FIT)
567 /* This cannot be done earlier, we need complete FIT image in RAM first */
568 if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
569 if (!fit_check_format (fit_hdr)) {
570 show_boot_progress (-150);
571 puts ("** Bad FIT image format\n");
574 show_boot_progress (151);
575 fit_print_contents (fit_hdr);
579 /* Loading ok, update default load address */
583 /* Check if we should attempt an auto-start */
584 if (((ep = getenv("autostart")) != NULL) && (strcmp(ep, "yes") == 0)) {
586 extern int do_bootm(cmd_tbl_t *, int, int, char *[]);
589 local_args[1] = NULL;
591 printf("Automatic boot of image at addr 0x%08lx ...\n", addr);
593 do_bootm(cmdtp, 0, 1, local_args);
599 int do_nandboot(cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
601 char *boot_device = NULL;
603 ulong addr, offset = 0;
604 #if defined(CONFIG_CMD_MTDPARTS)
605 struct mtd_device *dev;
606 struct part_info *part;
610 char *p = (argc == 2) ? argv[1] : argv[2];
611 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
612 (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
613 if (dev->id->type != MTD_DEV_TYPE_NAND) {
614 puts("Not a NAND device\n");
620 addr = simple_strtoul(argv[1], NULL, 16);
622 addr = CONFIG_SYS_LOAD_ADDR;
623 return nand_load_image(cmdtp, &nand_info[dev->id->num],
624 part->offset, addr, argv[0]);
629 show_boot_progress(52);
632 addr = CONFIG_SYS_LOAD_ADDR;
633 boot_device = getenv("bootdevice");
636 addr = simple_strtoul(argv[1], NULL, 16);
637 boot_device = getenv("bootdevice");
640 addr = simple_strtoul(argv[1], NULL, 16);
641 boot_device = argv[2];
644 addr = simple_strtoul(argv[1], NULL, 16);
645 boot_device = argv[2];
646 offset = simple_strtoul(argv[3], NULL, 16);
649 #if defined(CONFIG_CMD_MTDPARTS)
653 show_boot_progress(-53);
657 show_boot_progress(53);
659 puts("\n** No boot device **\n");
660 show_boot_progress(-54);
663 show_boot_progress(54);
665 idx = simple_strtoul(boot_device, NULL, 16);
667 if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
668 printf("\n** Device %d not available\n", idx);
669 show_boot_progress(-55);
672 show_boot_progress(55);
674 return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
677 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
678 "boot from NAND device",
679 "[partition] | [[[loadAddr] dev] offset]"