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