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