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