]> git.ipfire.org Git - people/ms/u-boot.git/blob - common/cmd_nand.c
mtd, nand: Move common functions from cmd_nand.c to common place
[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 * 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
13 *
14 * Copyright 2010, 2012 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.
20 */
21
22 #include <common.h>
23 #include <linux/mtd/mtd.h>
24 #include <command.h>
25 #include <watchdog.h>
26 #include <malloc.h>
27 #include <asm/byteorder.h>
28 #include <jffs2/jffs2.h>
29 #include <nand.h>
30
31 #if defined(CONFIG_CMD_MTDPARTS)
32
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);
38 #endif
39
40 static int nand_dump(nand_info_t *nand, ulong off, int only_oob, int repeat)
41 {
42 int i;
43 u_char *datbuf, *oobbuf, *p;
44 static loff_t last;
45 int ret = 0;
46
47 if (repeat)
48 off = last + nand->writesize;
49
50 last = off;
51
52 datbuf = memalign(ARCH_DMA_MINALIGN, nand->writesize);
53 if (!datbuf) {
54 puts("No memory for page buffer\n");
55 return 1;
56 }
57
58 oobbuf = memalign(ARCH_DMA_MINALIGN, nand->oobsize);
59 if (!oobbuf) {
60 puts("No memory for page buffer\n");
61 ret = 1;
62 goto free_dat;
63 }
64 off &= ~(nand->writesize - 1);
65 loff_t addr = (loff_t) off;
66 struct mtd_oob_ops ops;
67 memset(&ops, 0, sizeof(ops));
68 ops.datbuf = datbuf;
69 ops.oobbuf = oobbuf;
70 ops.len = nand->writesize;
71 ops.ooblen = nand->oobsize;
72 ops.mode = MTD_OPS_RAW;
73 i = mtd_read_oob(nand, addr, &ops);
74 if (i < 0) {
75 printf("Error (%d) reading page %08lx\n", i, off);
76 ret = 1;
77 goto free_all;
78 }
79 printf("Page %08lx dump:\n", off);
80
81 if (!only_oob) {
82 i = nand->writesize >> 4;
83 p = datbuf;
84
85 while (i--) {
86 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
87 " %02x %02x %02x %02x %02x %02x %02x %02x\n",
88 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
89 p[8], p[9], p[10], p[11], p[12], p[13], p[14],
90 p[15]);
91 p += 16;
92 }
93 }
94
95 puts("OOB:\n");
96 i = nand->oobsize >> 3;
97 p = oobbuf;
98 while (i--) {
99 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
100 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
101 p += 8;
102 }
103
104 free_all:
105 free(oobbuf);
106 free_dat:
107 free(datbuf);
108
109 return ret;
110 }
111
112 /* ------------------------------------------------------------------------- */
113
114 static int set_dev(int dev)
115 {
116 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
117 !nand_info[dev].name) {
118 puts("No such device\n");
119 return -1;
120 }
121
122 if (nand_curr_device == dev)
123 return 0;
124
125 printf("Device %d: %s", dev, nand_info[dev].name);
126 puts("... is now current device\n");
127 nand_curr_device = dev;
128
129 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
130 board_nand_select_device(nand_info[dev].priv, dev);
131 #endif
132
133 return 0;
134 }
135
136 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
137 static void print_status(ulong start, ulong end, ulong erasesize, int status)
138 {
139 /*
140 * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
141 * not the same as others. Instead of bit 1 being lock, it is
142 * #lock_tight. To make the driver support either format, ignore bit 1
143 * and use only bit 0 and bit 2.
144 */
145 printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
146 start,
147 end - 1,
148 (end - start) / erasesize,
149 ((status & NAND_LOCK_STATUS_TIGHT) ? "TIGHT " : ""),
150 (!(status & NAND_LOCK_STATUS_UNLOCK) ? "LOCK " : ""),
151 ((status & NAND_LOCK_STATUS_UNLOCK) ? "UNLOCK " : ""));
152 }
153
154 static void do_nand_status(nand_info_t *nand)
155 {
156 ulong block_start = 0;
157 ulong off;
158 int last_status = -1;
159
160 struct nand_chip *nand_chip = nand->priv;
161 /* check the WP bit */
162 nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
163 printf("device is %swrite protected\n",
164 (nand_chip->read_byte(nand) & 0x80 ?
165 "NOT " : ""));
166
167 for (off = 0; off < nand->size; off += nand->erasesize) {
168 int s = nand_get_lock_status(nand, off);
169
170 /* print message only if status has changed */
171 if (s != last_status && off != 0) {
172 print_status(block_start, off, nand->erasesize,
173 last_status);
174 block_start = off;
175 }
176 last_status = s;
177 }
178 /* Print the last block info */
179 print_status(block_start, off, nand->erasesize, last_status);
180 }
181 #endif
182
183 #ifdef CONFIG_ENV_OFFSET_OOB
184 unsigned long nand_env_oob_offset;
185
186 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
187 {
188 int ret;
189 uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
190 nand_info_t *nand = &nand_info[0];
191 char *cmd = argv[1];
192
193 if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !nand->name) {
194 puts("no devices available\n");
195 return 1;
196 }
197
198 set_dev(0);
199
200 if (!strcmp(cmd, "get")) {
201 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
202 if (ret)
203 return 1;
204
205 printf("0x%08lx\n", nand_env_oob_offset);
206 } else if (!strcmp(cmd, "set")) {
207 loff_t addr;
208 loff_t maxsize;
209 struct mtd_oob_ops ops;
210 int idx = 0;
211
212 if (argc < 3)
213 goto usage;
214
215 /* We don't care about size, or maxsize. */
216 if (mtd_arg_off(argv[2], &idx, &addr, &maxsize, &maxsize,
217 MTD_DEV_TYPE_NAND, nand_info[idx].size)) {
218 puts("Offset or partition name expected\n");
219 return 1;
220 }
221 if (set_dev(idx)) {
222 puts("Offset or partition name expected\n");
223 return 1;
224 }
225
226 if (idx != 0) {
227 puts("Partition not on first NAND device\n");
228 return 1;
229 }
230
231 if (nand->oobavail < ENV_OFFSET_SIZE) {
232 printf("Insufficient available OOB bytes:\n"
233 "%d OOB bytes available but %d required for "
234 "env.oob support\n",
235 nand->oobavail, ENV_OFFSET_SIZE);
236 return 1;
237 }
238
239 if ((addr & (nand->erasesize - 1)) != 0) {
240 printf("Environment offset must be block-aligned\n");
241 return 1;
242 }
243
244 ops.datbuf = NULL;
245 ops.mode = MTD_OOB_AUTO;
246 ops.ooboffs = 0;
247 ops.ooblen = ENV_OFFSET_SIZE;
248 ops.oobbuf = (void *) oob_buf;
249
250 oob_buf[0] = ENV_OOB_MARKER;
251 oob_buf[1] = addr / nand->erasesize;
252
253 ret = nand->write_oob(nand, ENV_OFFSET_SIZE, &ops);
254 if (ret) {
255 printf("Error writing OOB block 0\n");
256 return ret;
257 }
258
259 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
260 if (ret) {
261 printf("Error reading env offset in OOB\n");
262 return ret;
263 }
264
265 if (addr != nand_env_oob_offset) {
266 printf("Verification of env offset in OOB failed: "
267 "0x%08llx expected but got 0x%08lx\n",
268 (unsigned long long)addr, nand_env_oob_offset);
269 return 1;
270 }
271 } else {
272 goto usage;
273 }
274
275 return ret;
276
277 usage:
278 return CMD_RET_USAGE;
279 }
280
281 #endif
282
283 static void nand_print_and_set_info(int idx)
284 {
285 nand_info_t *nand = &nand_info[idx];
286 struct nand_chip *chip = nand->priv;
287
288 printf("Device %d: ", idx);
289 if (chip->numchips > 1)
290 printf("%dx ", chip->numchips);
291 printf("%s, sector size %u KiB\n",
292 nand->name, nand->erasesize >> 10);
293 printf(" Page size %8d b\n", nand->writesize);
294 printf(" OOB size %8d b\n", nand->oobsize);
295 printf(" Erase size %8d b\n", nand->erasesize);
296 printf(" subpagesize %8d b\n", chip->subpagesize);
297 printf(" options 0x%8x\n", chip->options);
298 printf(" bbt options 0x%8x\n", chip->bbt_options);
299
300 /* Set geometry info */
301 setenv_hex("nand_writesize", nand->writesize);
302 setenv_hex("nand_oobsize", nand->oobsize);
303 setenv_hex("nand_erasesize", nand->erasesize);
304 }
305
306 static int raw_access(nand_info_t *nand, ulong addr, loff_t off, ulong count,
307 int read)
308 {
309 int ret = 0;
310
311 while (count--) {
312 /* Raw access */
313 mtd_oob_ops_t ops = {
314 .datbuf = (u8 *)addr,
315 .oobbuf = ((u8 *)addr) + nand->writesize,
316 .len = nand->writesize,
317 .ooblen = nand->oobsize,
318 .mode = MTD_OPS_RAW
319 };
320
321 if (read) {
322 ret = mtd_read_oob(nand, off, &ops);
323 } else {
324 ret = mtd_write_oob(nand, off, &ops);
325 if (!ret)
326 ret = nand_verify_page_oob(nand, &ops, off);
327 }
328
329 if (ret) {
330 printf("%s: error at offset %llx, ret %d\n",
331 __func__, (long long)off, ret);
332 break;
333 }
334
335 addr += nand->writesize + nand->oobsize;
336 off += nand->writesize;
337 }
338
339 return ret;
340 }
341
342 /* Adjust a chip/partition size down for bad blocks so we don't
343 * read/write past the end of a chip/partition by accident.
344 */
345 static void adjust_size_for_badblocks(loff_t *size, loff_t offset, int dev)
346 {
347 /* We grab the nand info object here fresh because this is usually
348 * called after arg_off_size() which can change the value of dev.
349 */
350 nand_info_t *nand = &nand_info[dev];
351 loff_t maxoffset = offset + *size;
352 int badblocks = 0;
353
354 /* count badblocks in NAND from offset to offset + size */
355 for (; offset < maxoffset; offset += nand->erasesize) {
356 if (nand_block_isbad(nand, offset))
357 badblocks++;
358 }
359 /* adjust size if any bad blocks found */
360 if (badblocks) {
361 *size -= badblocks * nand->erasesize;
362 printf("size adjusted to 0x%llx (%d bad blocks)\n",
363 (unsigned long long)*size, badblocks);
364 }
365 }
366
367 static int do_nand(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
368 {
369 int i, ret = 0;
370 ulong addr;
371 loff_t off, size, maxsize;
372 char *cmd, *s;
373 nand_info_t *nand;
374 #ifdef CONFIG_SYS_NAND_QUIET
375 int quiet = CONFIG_SYS_NAND_QUIET;
376 #else
377 int quiet = 0;
378 #endif
379 const char *quiet_str = getenv("quiet");
380 int dev = nand_curr_device;
381 int repeat = flag & CMD_FLAG_REPEAT;
382
383 /* at least two arguments please */
384 if (argc < 2)
385 goto usage;
386
387 if (quiet_str)
388 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
389
390 cmd = argv[1];
391
392 /* Only "dump" is repeatable. */
393 if (repeat && strcmp(cmd, "dump"))
394 return 0;
395
396 if (strcmp(cmd, "info") == 0) {
397
398 putc('\n');
399 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
400 if (nand_info[i].name)
401 nand_print_and_set_info(i);
402 }
403 return 0;
404 }
405
406 if (strcmp(cmd, "device") == 0) {
407 if (argc < 3) {
408 putc('\n');
409 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
410 puts("no devices available\n");
411 else
412 nand_print_and_set_info(dev);
413 return 0;
414 }
415
416 dev = (int)simple_strtoul(argv[2], NULL, 10);
417 set_dev(dev);
418
419 return 0;
420 }
421
422 #ifdef CONFIG_ENV_OFFSET_OOB
423 /* this command operates only on the first nand device */
424 if (strcmp(cmd, "env.oob") == 0)
425 return do_nand_env_oob(cmdtp, argc - 1, argv + 1);
426 #endif
427
428 /* The following commands operate on the current device, unless
429 * overridden by a partition specifier. Note that if somehow the
430 * current device is invalid, it will have to be changed to a valid
431 * one before these commands can run, even if a partition specifier
432 * for another device is to be used.
433 */
434 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
435 !nand_info[dev].name) {
436 puts("\nno devices available\n");
437 return 1;
438 }
439 nand = &nand_info[dev];
440
441 if (strcmp(cmd, "bad") == 0) {
442 printf("\nDevice %d bad blocks:\n", dev);
443 for (off = 0; off < nand->size; off += nand->erasesize)
444 if (nand_block_isbad(nand, off))
445 printf(" %08llx\n", (unsigned long long)off);
446 return 0;
447 }
448
449 /*
450 * Syntax is:
451 * 0 1 2 3 4
452 * nand erase [clean] [off size]
453 */
454 if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
455 nand_erase_options_t opts;
456 /* "clean" at index 2 means request to write cleanmarker */
457 int clean = argc > 2 && !strcmp("clean", argv[2]);
458 int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
459 int o = (clean || scrub_yes) ? 3 : 2;
460 int scrub = !strncmp(cmd, "scrub", 5);
461 int spread = 0;
462 int args = 2;
463 const char *scrub_warn =
464 "Warning: "
465 "scrub option will erase all factory set bad blocks!\n"
466 " "
467 "There is no reliable way to recover them.\n"
468 " "
469 "Use this command only for testing purposes if you\n"
470 " "
471 "are sure of what you are doing!\n"
472 "\nReally scrub this NAND flash? <y/N>\n";
473
474 if (cmd[5] != 0) {
475 if (!strcmp(&cmd[5], ".spread")) {
476 spread = 1;
477 } else if (!strcmp(&cmd[5], ".part")) {
478 args = 1;
479 } else if (!strcmp(&cmd[5], ".chip")) {
480 args = 0;
481 } else {
482 goto usage;
483 }
484 }
485
486 /*
487 * Don't allow missing arguments to cause full chip/partition
488 * erases -- easy to do accidentally, e.g. with a misspelled
489 * variable name.
490 */
491 if (argc != o + args)
492 goto usage;
493
494 printf("\nNAND %s: ", cmd);
495 /* skip first two or three arguments, look for offset and size */
496 if (mtd_arg_off_size(argc - o, argv + o, &dev, &off, &size,
497 &maxsize, MTD_DEV_TYPE_NAND,
498 nand_info[dev].size) != 0)
499 return 1;
500
501 if (set_dev(dev))
502 return 1;
503
504 nand = &nand_info[dev];
505
506 memset(&opts, 0, sizeof(opts));
507 opts.offset = off;
508 opts.length = size;
509 opts.jffs2 = clean;
510 opts.quiet = quiet;
511 opts.spread = spread;
512
513 if (scrub) {
514 if (scrub_yes) {
515 opts.scrub = 1;
516 } else {
517 puts(scrub_warn);
518 if (confirm_yesno()) {
519 opts.scrub = 1;
520 } else {
521 puts("scrub aborted\n");
522 return 1;
523 }
524 }
525 }
526 ret = nand_erase_opts(nand, &opts);
527 printf("%s\n", ret ? "ERROR" : "OK");
528
529 return ret == 0 ? 0 : 1;
530 }
531
532 if (strncmp(cmd, "dump", 4) == 0) {
533 if (argc < 3)
534 goto usage;
535
536 off = (int)simple_strtoul(argv[2], NULL, 16);
537 ret = nand_dump(nand, off, !strcmp(&cmd[4], ".oob"), repeat);
538
539 return ret == 0 ? 1 : 0;
540 }
541
542 if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
543 size_t rwsize;
544 ulong pagecount = 1;
545 int read;
546 int raw = 0;
547
548 if (argc < 4)
549 goto usage;
550
551 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
552
553 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
554 printf("\nNAND %s: ", read ? "read" : "write");
555
556 s = strchr(cmd, '.');
557
558 if (s && !strcmp(s, ".raw")) {
559 raw = 1;
560
561 if (mtd_arg_off(argv[3], &dev, &off, &size, &maxsize,
562 MTD_DEV_TYPE_NAND,
563 nand_info[dev].size))
564 return 1;
565
566 if (set_dev(dev))
567 return 1;
568
569 nand = &nand_info[dev];
570
571 if (argc > 4 && !str2long(argv[4], &pagecount)) {
572 printf("'%s' is not a number\n", argv[4]);
573 return 1;
574 }
575
576 if (pagecount * nand->writesize > size) {
577 puts("Size exceeds partition or device limit\n");
578 return -1;
579 }
580
581 rwsize = pagecount * (nand->writesize + nand->oobsize);
582 } else {
583 if (mtd_arg_off_size(argc - 3, argv + 3, &dev, &off,
584 &size, &maxsize,
585 MTD_DEV_TYPE_NAND,
586 nand_info[dev].size) != 0)
587 return 1;
588
589 if (set_dev(dev))
590 return 1;
591
592 /* size is unspecified */
593 if (argc < 5)
594 adjust_size_for_badblocks(&size, off, dev);
595 rwsize = size;
596 }
597
598 nand = &nand_info[dev];
599
600 if (!s || !strcmp(s, ".jffs2") ||
601 !strcmp(s, ".e") || !strcmp(s, ".i")) {
602 if (read)
603 ret = nand_read_skip_bad(nand, off, &rwsize,
604 NULL, maxsize,
605 (u_char *)addr);
606 else
607 ret = nand_write_skip_bad(nand, off, &rwsize,
608 NULL, maxsize,
609 (u_char *)addr,
610 WITH_WR_VERIFY);
611 #ifdef CONFIG_CMD_NAND_TRIMFFS
612 } else if (!strcmp(s, ".trimffs")) {
613 if (read) {
614 printf("Unknown nand command suffix '%s'\n", s);
615 return 1;
616 }
617 ret = nand_write_skip_bad(nand, off, &rwsize, NULL,
618 maxsize, (u_char *)addr,
619 WITH_DROP_FFS | WITH_WR_VERIFY);
620 #endif
621 } else if (!strcmp(s, ".oob")) {
622 /* out-of-band data */
623 mtd_oob_ops_t ops = {
624 .oobbuf = (u8 *)addr,
625 .ooblen = rwsize,
626 .mode = MTD_OPS_RAW
627 };
628
629 if (read)
630 ret = mtd_read_oob(nand, off, &ops);
631 else
632 ret = mtd_write_oob(nand, off, &ops);
633 } else if (raw) {
634 ret = raw_access(nand, addr, off, pagecount, read);
635 } else {
636 printf("Unknown nand command suffix '%s'.\n", s);
637 return 1;
638 }
639
640 printf(" %zu bytes %s: %s\n", rwsize,
641 read ? "read" : "written", ret ? "ERROR" : "OK");
642
643 return ret == 0 ? 0 : 1;
644 }
645
646 #ifdef CONFIG_CMD_NAND_TORTURE
647 if (strcmp(cmd, "torture") == 0) {
648 if (argc < 3)
649 goto usage;
650
651 if (!str2off(argv[2], &off)) {
652 puts("Offset is not a valid number\n");
653 return 1;
654 }
655
656 printf("\nNAND torture: device %d offset 0x%llx size 0x%x\n",
657 dev, off, nand->erasesize);
658 ret = nand_torture(nand, off);
659 printf(" %s\n", ret ? "Failed" : "Passed");
660
661 return ret == 0 ? 0 : 1;
662 }
663 #endif
664
665 if (strcmp(cmd, "markbad") == 0) {
666 argc -= 2;
667 argv += 2;
668
669 if (argc <= 0)
670 goto usage;
671
672 while (argc > 0) {
673 addr = simple_strtoul(*argv, NULL, 16);
674
675 if (mtd_block_markbad(nand, addr)) {
676 printf("block 0x%08lx NOT marked "
677 "as bad! ERROR %d\n",
678 addr, ret);
679 ret = 1;
680 } else {
681 printf("block 0x%08lx successfully "
682 "marked as bad\n",
683 addr);
684 }
685 --argc;
686 ++argv;
687 }
688 return ret;
689 }
690
691 if (strcmp(cmd, "biterr") == 0) {
692 /* todo */
693 return 1;
694 }
695
696 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
697 if (strcmp(cmd, "lock") == 0) {
698 int tight = 0;
699 int status = 0;
700 if (argc == 3) {
701 if (!strcmp("tight", argv[2]))
702 tight = 1;
703 if (!strcmp("status", argv[2]))
704 status = 1;
705 }
706 if (status) {
707 do_nand_status(nand);
708 } else {
709 if (!nand_lock(nand, tight)) {
710 puts("NAND flash successfully locked\n");
711 } else {
712 puts("Error locking NAND flash\n");
713 return 1;
714 }
715 }
716 return 0;
717 }
718
719 if (strncmp(cmd, "unlock", 5) == 0) {
720 int allexcept = 0;
721
722 s = strchr(cmd, '.');
723
724 if (s && !strcmp(s, ".allexcept"))
725 allexcept = 1;
726
727 if (mtd_arg_off_size(argc - 2, argv + 2, &dev, &off, &size,
728 &maxsize, MTD_DEV_TYPE_NAND,
729 nand_info[dev].size) < 0)
730 return 1;
731
732 if (set_dev(dev))
733 return 1;
734
735 if (!nand_unlock(&nand_info[dev], off, size, allexcept)) {
736 puts("NAND flash successfully unlocked\n");
737 } else {
738 puts("Error unlocking NAND flash, "
739 "write and erase will probably fail\n");
740 return 1;
741 }
742 return 0;
743 }
744 #endif
745
746 usage:
747 return CMD_RET_USAGE;
748 }
749
750 #ifdef CONFIG_SYS_LONGHELP
751 static char nand_help_text[] =
752 "info - show available NAND devices\n"
753 "nand device [dev] - show or set current device\n"
754 "nand read - addr off|partition size\n"
755 "nand write - addr off|partition size\n"
756 " read/write 'size' bytes starting at offset 'off'\n"
757 " to/from memory address 'addr', skipping bad blocks.\n"
758 "nand read.raw - addr off|partition [count]\n"
759 "nand write.raw - addr off|partition [count]\n"
760 " Use read.raw/write.raw to avoid ECC and access the flash as-is.\n"
761 #ifdef CONFIG_CMD_NAND_TRIMFFS
762 "nand write.trimffs - addr off|partition size\n"
763 " write 'size' bytes starting at offset 'off' from memory address\n"
764 " 'addr', skipping bad blocks and dropping any pages at the end\n"
765 " of eraseblocks that contain only 0xFF\n"
766 #endif
767 "nand erase[.spread] [clean] off size - erase 'size' bytes "
768 "from offset 'off'\n"
769 " With '.spread', erase enough for given file size, otherwise,\n"
770 " 'size' includes skipped bad blocks.\n"
771 "nand erase.part [clean] partition - erase entire mtd partition'\n"
772 "nand erase.chip [clean] - erase entire chip'\n"
773 "nand bad - show bad blocks\n"
774 "nand dump[.oob] off - dump page\n"
775 #ifdef CONFIG_CMD_NAND_TORTURE
776 "nand torture off - torture block at offset\n"
777 #endif
778 "nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
779 " really clean NAND erasing bad blocks (UNSAFE)\n"
780 "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
781 "nand biterr off - make a bit error at offset (UNSAFE)"
782 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
783 "\n"
784 "nand lock [tight] [status]\n"
785 " bring nand to lock state or display locked pages\n"
786 "nand unlock[.allexcept] [offset] [size] - unlock section"
787 #endif
788 #ifdef CONFIG_ENV_OFFSET_OOB
789 "\n"
790 "nand env.oob - environment offset in OOB of block 0 of"
791 " first device.\n"
792 "nand env.oob set off|partition - set enviromnent offset\n"
793 "nand env.oob get - get environment offset"
794 #endif
795 "";
796 #endif
797
798 U_BOOT_CMD(
799 nand, CONFIG_SYS_MAXARGS, 1, do_nand,
800 "NAND sub-system", nand_help_text
801 );
802
803 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
804 ulong offset, ulong addr, char *cmd)
805 {
806 int r;
807 char *s;
808 size_t cnt;
809 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
810 image_header_t *hdr;
811 #endif
812 #if defined(CONFIG_FIT)
813 const void *fit_hdr = NULL;
814 #endif
815
816 s = strchr(cmd, '.');
817 if (s != NULL &&
818 (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
819 printf("Unknown nand load suffix '%s'\n", s);
820 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
821 return 1;
822 }
823
824 printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
825
826 cnt = nand->writesize;
827 r = nand_read_skip_bad(nand, offset, &cnt, NULL, nand->size,
828 (u_char *)addr);
829 if (r) {
830 puts("** Read error\n");
831 bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
832 return 1;
833 }
834 bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
835
836 switch (genimg_get_format ((void *)addr)) {
837 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
838 case IMAGE_FORMAT_LEGACY:
839 hdr = (image_header_t *)addr;
840
841 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
842 image_print_contents (hdr);
843
844 cnt = image_get_image_size (hdr);
845 break;
846 #endif
847 #if defined(CONFIG_FIT)
848 case IMAGE_FORMAT_FIT:
849 fit_hdr = (const void *)addr;
850 puts ("Fit image detected...\n");
851
852 cnt = fit_get_size (fit_hdr);
853 break;
854 #endif
855 default:
856 bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
857 puts ("** Unknown image type\n");
858 return 1;
859 }
860 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
861
862 r = nand_read_skip_bad(nand, offset, &cnt, NULL, nand->size,
863 (u_char *)addr);
864 if (r) {
865 puts("** Read error\n");
866 bootstage_error(BOOTSTAGE_ID_NAND_READ);
867 return 1;
868 }
869 bootstage_mark(BOOTSTAGE_ID_NAND_READ);
870
871 #if defined(CONFIG_FIT)
872 /* This cannot be done earlier, we need complete FIT image in RAM first */
873 if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
874 if (!fit_check_format (fit_hdr)) {
875 bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
876 puts ("** Bad FIT image format\n");
877 return 1;
878 }
879 bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
880 fit_print_contents (fit_hdr);
881 }
882 #endif
883
884 /* Loading ok, update default load address */
885
886 load_addr = addr;
887
888 return bootm_maybe_autostart(cmdtp, cmd);
889 }
890
891 static int do_nandboot(cmd_tbl_t *cmdtp, int flag, int argc,
892 char * const argv[])
893 {
894 char *boot_device = NULL;
895 int idx;
896 ulong addr, offset = 0;
897 #if defined(CONFIG_CMD_MTDPARTS)
898 struct mtd_device *dev;
899 struct part_info *part;
900 u8 pnum;
901
902 if (argc >= 2) {
903 char *p = (argc == 2) ? argv[1] : argv[2];
904 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
905 (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
906 if (dev->id->type != MTD_DEV_TYPE_NAND) {
907 puts("Not a NAND device\n");
908 return 1;
909 }
910 if (argc > 3)
911 goto usage;
912 if (argc == 3)
913 addr = simple_strtoul(argv[1], NULL, 16);
914 else
915 addr = CONFIG_SYS_LOAD_ADDR;
916 return nand_load_image(cmdtp, &nand_info[dev->id->num],
917 part->offset, addr, argv[0]);
918 }
919 }
920 #endif
921
922 bootstage_mark(BOOTSTAGE_ID_NAND_PART);
923 switch (argc) {
924 case 1:
925 addr = CONFIG_SYS_LOAD_ADDR;
926 boot_device = getenv("bootdevice");
927 break;
928 case 2:
929 addr = simple_strtoul(argv[1], NULL, 16);
930 boot_device = getenv("bootdevice");
931 break;
932 case 3:
933 addr = simple_strtoul(argv[1], NULL, 16);
934 boot_device = argv[2];
935 break;
936 case 4:
937 addr = simple_strtoul(argv[1], NULL, 16);
938 boot_device = argv[2];
939 offset = simple_strtoul(argv[3], NULL, 16);
940 break;
941 default:
942 #if defined(CONFIG_CMD_MTDPARTS)
943 usage:
944 #endif
945 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
946 return CMD_RET_USAGE;
947 }
948 bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
949
950 if (!boot_device) {
951 puts("\n** No boot device **\n");
952 bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
953 return 1;
954 }
955 bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
956
957 idx = simple_strtoul(boot_device, NULL, 16);
958
959 if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
960 printf("\n** Device %d not available\n", idx);
961 bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
962 return 1;
963 }
964 bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
965
966 return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
967 }
968
969 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
970 "boot from NAND device",
971 "[partition] | [[[loadAddr] dev] offset]"
972 );