cmd_nand: show nand scrub confirmation character
[people/ms/u-boot.git] / common / cmd_nand.c
1 /*
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>
6 *
7 * Added 16-bit nand support
8 * (C) 2004 Texas Instruments
9 */
10
11 #include <common.h>
12 #include <linux/mtd/mtd.h>
13 #include <command.h>
14 #include <watchdog.h>
15 #include <malloc.h>
16 #include <asm/byteorder.h>
17 #include <jffs2/jffs2.h>
18 #include <nand.h>
19
20 #if defined(CONFIG_CMD_MTDPARTS)
21
22 /* parition handling routines */
23 int mtdparts_init(void);
24 int id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
25 int find_dev_and_part(const char *id, struct mtd_device **dev,
26 u8 *part_num, struct part_info **part);
27 #endif
28
29 static int nand_dump(nand_info_t *nand, ulong off, int only_oob)
30 {
31 int i;
32 u_char *datbuf, *oobbuf, *p;
33
34 datbuf = malloc(nand->writesize + nand->oobsize);
35 oobbuf = malloc(nand->oobsize);
36 if (!datbuf || !oobbuf) {
37 puts("No memory for page buffer\n");
38 return 1;
39 }
40 off &= ~(nand->writesize - 1);
41 loff_t addr = (loff_t) off;
42 struct mtd_oob_ops ops;
43 memset(&ops, 0, sizeof(ops));
44 ops.datbuf = datbuf;
45 ops.oobbuf = oobbuf; /* must exist, but oob data will be appended to ops.datbuf */
46 ops.len = nand->writesize;
47 ops.ooblen = nand->oobsize;
48 ops.mode = MTD_OOB_RAW;
49 i = nand->read_oob(nand, addr, &ops);
50 if (i < 0) {
51 printf("Error (%d) reading page %08lx\n", i, off);
52 free(datbuf);
53 free(oobbuf);
54 return 1;
55 }
56 printf("Page %08lx dump:\n", off);
57 i = nand->writesize >> 4;
58 p = datbuf;
59
60 while (i--) {
61 if (!only_oob)
62 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
63 " %02x %02x %02x %02x %02x %02x %02x %02x\n",
64 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
65 p[8], p[9], p[10], p[11], p[12], p[13], p[14],
66 p[15]);
67 p += 16;
68 }
69 puts("OOB:\n");
70 i = nand->oobsize >> 3;
71 while (i--) {
72 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
73 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
74 p += 8;
75 }
76 free(datbuf);
77 free(oobbuf);
78
79 return 0;
80 }
81
82 /* ------------------------------------------------------------------------- */
83
84 static inline int str2long(char *p, ulong *num)
85 {
86 char *endptr;
87
88 *num = simple_strtoul(p, &endptr, 16);
89 return (*p != '\0' && *endptr == '\0') ? 1 : 0;
90 }
91
92 static int
93 arg_off_size(int argc, char *argv[], nand_info_t *nand, ulong *off, size_t *size)
94 {
95 int idx = nand_curr_device;
96 #if defined(CONFIG_CMD_MTDPARTS)
97 struct mtd_device *dev;
98 struct part_info *part;
99 u8 pnum;
100
101 if (argc >= 1 && !(str2long(argv[0], off))) {
102 if ((mtdparts_init() == 0) &&
103 (find_dev_and_part(argv[0], &dev, &pnum, &part) == 0)) {
104 if (dev->id->type != MTD_DEV_TYPE_NAND) {
105 puts("not a NAND device\n");
106 return -1;
107 }
108 *off = part->offset;
109 if (argc >= 2) {
110 if (!(str2long(argv[1], (ulong *)size))) {
111 printf("'%s' is not a number\n", argv[1]);
112 return -1;
113 }
114 if (*size > part->size)
115 *size = part->size;
116 } else {
117 *size = part->size;
118 }
119 idx = dev->id->num;
120 *nand = nand_info[idx];
121 goto out;
122 }
123 }
124 #endif
125
126 if (argc >= 1) {
127 if (!(str2long(argv[0], off))) {
128 printf("'%s' is not a number\n", argv[0]);
129 return -1;
130 }
131 } else {
132 *off = 0;
133 }
134
135 if (argc >= 2) {
136 if (!(str2long(argv[1], (ulong *)size))) {
137 printf("'%s' is not a number\n", argv[1]);
138 return -1;
139 }
140 } else {
141 *size = nand->size - *off;
142 }
143
144 #if defined(CONFIG_CMD_MTDPARTS)
145 out:
146 #endif
147 printf("device %d ", idx);
148 if (*size == nand->size)
149 puts("whole chip\n");
150 else
151 printf("offset 0x%lx, size 0x%zx\n", *off, *size);
152 return 0;
153 }
154
155 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
156 static void print_status(ulong start, ulong end, ulong erasesize, int status)
157 {
158 printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
159 start,
160 end - 1,
161 (end - start) / erasesize,
162 ((status & NAND_LOCK_STATUS_TIGHT) ? "TIGHT " : ""),
163 ((status & NAND_LOCK_STATUS_LOCK) ? "LOCK " : ""),
164 ((status & NAND_LOCK_STATUS_UNLOCK) ? "UNLOCK " : ""));
165 }
166
167 static void do_nand_status(nand_info_t *nand)
168 {
169 ulong block_start = 0;
170 ulong off;
171 int last_status = -1;
172
173 struct nand_chip *nand_chip = nand->priv;
174 /* check the WP bit */
175 nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
176 printf("device is %swrite protected\n",
177 (nand_chip->read_byte(nand) & 0x80 ?
178 "NOT " : ""));
179
180 for (off = 0; off < nand->size; off += nand->erasesize) {
181 int s = nand_get_lock_status(nand, off);
182
183 /* print message only if status has changed */
184 if (s != last_status && off != 0) {
185 print_status(block_start, off, nand->erasesize,
186 last_status);
187 block_start = off;
188 }
189 last_status = s;
190 }
191 /* Print the last block info */
192 print_status(block_start, off, nand->erasesize, last_status);
193 }
194 #endif
195
196 static void nand_print_info(int idx)
197 {
198 nand_info_t *nand = &nand_info[idx];
199 struct nand_chip *chip = nand->priv;
200 printf("Device %d: ", idx);
201 if (chip->numchips > 1)
202 printf("%dx ", chip->numchips);
203 printf("%s, sector size %u KiB\n",
204 nand->name, nand->erasesize >> 10);
205 }
206
207 int do_nand(cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
208 {
209 int i, dev, ret = 0;
210 ulong addr, off;
211 size_t size;
212 char *cmd, *s;
213 nand_info_t *nand;
214 #ifdef CONFIG_SYS_NAND_QUIET
215 int quiet = CONFIG_SYS_NAND_QUIET;
216 #else
217 int quiet = 0;
218 #endif
219 const char *quiet_str = getenv("quiet");
220
221 /* at least two arguments please */
222 if (argc < 2)
223 goto usage;
224
225 if (quiet_str)
226 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
227
228 cmd = argv[1];
229
230 if (strcmp(cmd, "info") == 0) {
231
232 putc('\n');
233 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
234 if (nand_info[i].name)
235 nand_print_info(i);
236 }
237 return 0;
238 }
239
240 if (strcmp(cmd, "device") == 0) {
241
242 if (argc < 3) {
243 putc('\n');
244 if ((nand_curr_device < 0) ||
245 (nand_curr_device >= CONFIG_SYS_MAX_NAND_DEVICE))
246 puts("no devices available\n");
247 else
248 nand_print_info(nand_curr_device);
249 return 0;
250 }
251 dev = (int)simple_strtoul(argv[2], NULL, 10);
252 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[dev].name) {
253 puts("No such device\n");
254 return 1;
255 }
256 printf("Device %d: %s", dev, nand_info[dev].name);
257 puts("... is now current device\n");
258 nand_curr_device = dev;
259
260 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
261 /*
262 * Select the chip in the board/cpu specific driver
263 */
264 board_nand_select_device(nand_info[dev].priv, dev);
265 #endif
266
267 return 0;
268 }
269
270 if (strcmp(cmd, "bad") != 0 && strcmp(cmd, "erase") != 0 &&
271 strncmp(cmd, "dump", 4) != 0 &&
272 strncmp(cmd, "read", 4) != 0 && strncmp(cmd, "write", 5) != 0 &&
273 strcmp(cmd, "scrub") != 0 && strcmp(cmd, "markbad") != 0 &&
274 strcmp(cmd, "biterr") != 0 &&
275 strcmp(cmd, "lock") != 0 && strcmp(cmd, "unlock") != 0 )
276 goto usage;
277
278 /* the following commands operate on the current device */
279 if (nand_curr_device < 0 || nand_curr_device >= CONFIG_SYS_MAX_NAND_DEVICE ||
280 !nand_info[nand_curr_device].name) {
281 puts("\nno devices available\n");
282 return 1;
283 }
284 nand = &nand_info[nand_curr_device];
285
286 if (strcmp(cmd, "bad") == 0) {
287 printf("\nDevice %d bad blocks:\n", nand_curr_device);
288 for (off = 0; off < nand->size; off += nand->erasesize)
289 if (nand_block_isbad(nand, off))
290 printf(" %08lx\n", off);
291 return 0;
292 }
293
294 /*
295 * Syntax is:
296 * 0 1 2 3 4
297 * nand erase [clean] [off size]
298 */
299 if (strcmp(cmd, "erase") == 0 || strcmp(cmd, "scrub") == 0) {
300 nand_erase_options_t opts;
301 /* "clean" at index 2 means request to write cleanmarker */
302 int clean = argc > 2 && !strcmp("clean", argv[2]);
303 int o = clean ? 3 : 2;
304 int scrub = !strcmp(cmd, "scrub");
305
306 printf("\nNAND %s: ", scrub ? "scrub" : "erase");
307 /* skip first two or three arguments, look for offset and size */
308 if (arg_off_size(argc - o, argv + o, nand, &off, &size) != 0)
309 return 1;
310
311 memset(&opts, 0, sizeof(opts));
312 opts.offset = off;
313 opts.length = size;
314 opts.jffs2 = clean;
315 opts.quiet = quiet;
316
317 if (scrub) {
318 puts("Warning: "
319 "scrub option will erase all factory set "
320 "bad blocks!\n"
321 " "
322 "There is no reliable way to recover them.\n"
323 " "
324 "Use this command only for testing purposes "
325 "if you\n"
326 " "
327 "are sure of what you are doing!\n"
328 "\nReally scrub this NAND flash? <y/N>\n");
329
330 if (getc() == 'y') {
331 puts("y");
332 if (getc() == '\r')
333 opts.scrub = 1;
334 else {
335 puts("scrub aborted\n");
336 return -1;
337 }
338 } else {
339 puts("scrub aborted\n");
340 return -1;
341 }
342 }
343 ret = nand_erase_opts(nand, &opts);
344 printf("%s\n", ret ? "ERROR" : "OK");
345
346 return ret == 0 ? 0 : 1;
347 }
348
349 if (strncmp(cmd, "dump", 4) == 0) {
350 if (argc < 3)
351 goto usage;
352
353 s = strchr(cmd, '.');
354 off = (int)simple_strtoul(argv[2], NULL, 16);
355
356 if (s != NULL && strcmp(s, ".oob") == 0)
357 ret = nand_dump(nand, off, 1);
358 else
359 ret = nand_dump(nand, off, 0);
360
361 return ret == 0 ? 1 : 0;
362
363 }
364
365 if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
366 int read;
367
368 if (argc < 4)
369 goto usage;
370
371 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
372
373 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
374 printf("\nNAND %s: ", read ? "read" : "write");
375 if (arg_off_size(argc - 3, argv + 3, nand, &off, &size) != 0)
376 return 1;
377
378 s = strchr(cmd, '.');
379 if (!s || !strcmp(s, ".jffs2") ||
380 !strcmp(s, ".e") || !strcmp(s, ".i")) {
381 if (read)
382 ret = nand_read_skip_bad(nand, off, &size,
383 (u_char *)addr);
384 else
385 ret = nand_write_skip_bad(nand, off, &size,
386 (u_char *)addr);
387 } else if (!strcmp(s, ".oob")) {
388 /* out-of-band data */
389 mtd_oob_ops_t ops = {
390 .oobbuf = (u8 *)addr,
391 .ooblen = size,
392 .mode = MTD_OOB_RAW
393 };
394
395 if (read)
396 ret = nand->read_oob(nand, off, &ops);
397 else
398 ret = nand->write_oob(nand, off, &ops);
399 } else {
400 printf("Unknown nand command suffix '%s'.\n", s);
401 return 1;
402 }
403
404 printf(" %zu bytes %s: %s\n", size,
405 read ? "read" : "written", ret ? "ERROR" : "OK");
406
407 return ret == 0 ? 0 : 1;
408 }
409
410 if (strcmp(cmd, "markbad") == 0) {
411 argc -= 2;
412 argv += 2;
413
414 if (argc <= 0)
415 goto usage;
416
417 while (argc > 0) {
418 addr = simple_strtoul(*argv, NULL, 16);
419
420 if (nand->block_markbad(nand, addr)) {
421 printf("block 0x%08lx NOT marked "
422 "as bad! ERROR %d\n",
423 addr, ret);
424 ret = 1;
425 } else {
426 printf("block 0x%08lx successfully "
427 "marked as bad\n",
428 addr);
429 }
430 --argc;
431 ++argv;
432 }
433 return ret;
434 }
435
436 if (strcmp(cmd, "biterr") == 0) {
437 /* todo */
438 return 1;
439 }
440
441 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
442 if (strcmp(cmd, "lock") == 0) {
443 int tight = 0;
444 int status = 0;
445 if (argc == 3) {
446 if (!strcmp("tight", argv[2]))
447 tight = 1;
448 if (!strcmp("status", argv[2]))
449 status = 1;
450 }
451 if (status) {
452 do_nand_status(nand);
453 } else {
454 if (!nand_lock(nand, tight)) {
455 puts("NAND flash successfully locked\n");
456 } else {
457 puts("Error locking NAND flash\n");
458 return 1;
459 }
460 }
461 return 0;
462 }
463
464 if (strcmp(cmd, "unlock") == 0) {
465 if (arg_off_size(argc - 2, argv + 2, nand, &off, &size) < 0)
466 return 1;
467
468 if (!nand_unlock(nand, off, size)) {
469 puts("NAND flash successfully unlocked\n");
470 } else {
471 puts("Error unlocking NAND flash, "
472 "write and erase will probably fail\n");
473 return 1;
474 }
475 return 0;
476 }
477 #endif
478
479 usage:
480 cmd_usage(cmdtp);
481 return 1;
482 }
483
484 U_BOOT_CMD(nand, CONFIG_SYS_MAXARGS, 1, do_nand,
485 "NAND sub-system",
486 "info - show available NAND devices\n"
487 "nand device [dev] - show or set current device\n"
488 "nand read - addr off|partition size\n"
489 "nand write - addr off|partition size\n"
490 " read/write 'size' bytes starting at offset 'off'\n"
491 " to/from memory address 'addr', skipping bad blocks.\n"
492 "nand erase [clean] [off size] - erase 'size' bytes from\n"
493 " offset 'off' (entire device if not specified)\n"
494 "nand bad - show bad blocks\n"
495 "nand dump[.oob] off - dump page\n"
496 "nand scrub - really clean NAND erasing bad blocks (UNSAFE)\n"
497 "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
498 "nand biterr off - make a bit error at offset (UNSAFE)"
499 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
500 "\n"
501 "nand lock [tight] [status]\n"
502 " bring nand to lock state or display locked pages\n"
503 "nand unlock [offset] [size] - unlock section"
504 #endif
505 );
506
507 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
508 ulong offset, ulong addr, char *cmd)
509 {
510 int r;
511 char *ep, *s;
512 size_t cnt;
513 image_header_t *hdr;
514 #if defined(CONFIG_FIT)
515 const void *fit_hdr = NULL;
516 #endif
517
518 s = strchr(cmd, '.');
519 if (s != NULL &&
520 (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
521 printf("Unknown nand load suffix '%s'\n", s);
522 show_boot_progress(-53);
523 return 1;
524 }
525
526 printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
527
528 cnt = nand->writesize;
529 r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
530 if (r) {
531 puts("** Read error\n");
532 show_boot_progress (-56);
533 return 1;
534 }
535 show_boot_progress (56);
536
537 switch (genimg_get_format ((void *)addr)) {
538 case IMAGE_FORMAT_LEGACY:
539 hdr = (image_header_t *)addr;
540
541 show_boot_progress (57);
542 image_print_contents (hdr);
543
544 cnt = image_get_image_size (hdr);
545 break;
546 #if defined(CONFIG_FIT)
547 case IMAGE_FORMAT_FIT:
548 fit_hdr = (const void *)addr;
549 puts ("Fit image detected...\n");
550
551 cnt = fit_get_size (fit_hdr);
552 break;
553 #endif
554 default:
555 show_boot_progress (-57);
556 puts ("** Unknown image type\n");
557 return 1;
558 }
559 show_boot_progress (57);
560
561 r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
562 if (r) {
563 puts("** Read error\n");
564 show_boot_progress (-58);
565 return 1;
566 }
567 show_boot_progress (58);
568
569 #if defined(CONFIG_FIT)
570 /* This cannot be done earlier, we need complete FIT image in RAM first */
571 if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
572 if (!fit_check_format (fit_hdr)) {
573 show_boot_progress (-150);
574 puts ("** Bad FIT image format\n");
575 return 1;
576 }
577 show_boot_progress (151);
578 fit_print_contents (fit_hdr);
579 }
580 #endif
581
582 /* Loading ok, update default load address */
583
584 load_addr = addr;
585
586 /* Check if we should attempt an auto-start */
587 if (((ep = getenv("autostart")) != NULL) && (strcmp(ep, "yes") == 0)) {
588 char *local_args[2];
589 extern int do_bootm(cmd_tbl_t *, int, int, char *[]);
590
591 local_args[0] = cmd;
592 local_args[1] = NULL;
593
594 printf("Automatic boot of image at addr 0x%08lx ...\n", addr);
595
596 do_bootm(cmdtp, 0, 1, local_args);
597 return 1;
598 }
599 return 0;
600 }
601
602 int do_nandboot(cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
603 {
604 char *boot_device = NULL;
605 int idx;
606 ulong addr, offset = 0;
607 #if defined(CONFIG_CMD_MTDPARTS)
608 struct mtd_device *dev;
609 struct part_info *part;
610 u8 pnum;
611
612 if (argc >= 2) {
613 char *p = (argc == 2) ? argv[1] : argv[2];
614 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
615 (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
616 if (dev->id->type != MTD_DEV_TYPE_NAND) {
617 puts("Not a NAND device\n");
618 return 1;
619 }
620 if (argc > 3)
621 goto usage;
622 if (argc == 3)
623 addr = simple_strtoul(argv[1], NULL, 16);
624 else
625 addr = CONFIG_SYS_LOAD_ADDR;
626 return nand_load_image(cmdtp, &nand_info[dev->id->num],
627 part->offset, addr, argv[0]);
628 }
629 }
630 #endif
631
632 show_boot_progress(52);
633 switch (argc) {
634 case 1:
635 addr = CONFIG_SYS_LOAD_ADDR;
636 boot_device = getenv("bootdevice");
637 break;
638 case 2:
639 addr = simple_strtoul(argv[1], NULL, 16);
640 boot_device = getenv("bootdevice");
641 break;
642 case 3:
643 addr = simple_strtoul(argv[1], NULL, 16);
644 boot_device = argv[2];
645 break;
646 case 4:
647 addr = simple_strtoul(argv[1], NULL, 16);
648 boot_device = argv[2];
649 offset = simple_strtoul(argv[3], NULL, 16);
650 break;
651 default:
652 #if defined(CONFIG_CMD_MTDPARTS)
653 usage:
654 #endif
655 cmd_usage(cmdtp);
656 show_boot_progress(-53);
657 return 1;
658 }
659
660 show_boot_progress(53);
661 if (!boot_device) {
662 puts("\n** No boot device **\n");
663 show_boot_progress(-54);
664 return 1;
665 }
666 show_boot_progress(54);
667
668 idx = simple_strtoul(boot_device, NULL, 16);
669
670 if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
671 printf("\n** Device %d not available\n", idx);
672 show_boot_progress(-55);
673 return 1;
674 }
675 show_boot_progress(55);
676
677 return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
678 }
679
680 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
681 "boot from NAND device",
682 "[partition] | [[[loadAddr] dev] offset]"
683 );