blob: 71b8f9644296dd2b9887c3c9d5df1000b7c9670f [file] [log] [blame]
wdenkdc7c9a12003-03-26 06:55:25 +00001/*
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>
wdenk384cc682005-04-03 22:35:21 +00006 *
Ben Gardinerc9f73512010-07-05 13:27:07 -04007 * 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.
wdenk384cc682005-04-03 22:35:21 +000011 * Added 16-bit nand support
12 * (C) 2004 Texas Instruments
Scott Woodea533c22010-08-02 13:04:24 -050013 *
Scott Wood418396e2012-03-02 14:01:57 -060014 * Copyright 2010, 2012 Freescale Semiconductor
Scott Woodea533c22010-08-02 13:04:24 -050015 * 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.
Balamanikandan Gunasundar4ea84c52021-06-29 12:46:11 +053020 *
21 * The function nand_biterror() in this file is inspired from
22 * mtd-utils/nand-utils/nandflipbits.c which was released under GPLv2
23 * only
wdenkdc7c9a12003-03-26 06:55:25 +000024 */
25
26#include <common.h>
Simon Glass52f24232020-05-10 11:40:00 -060027#include <bootstage.h>
Simon Glass8e8ccfe2019-12-28 10:45:03 -070028#include <image.h>
Simon Glass90526e92020-05-10 11:39:56 -060029#include <asm/cache.h>
William Juulcfa460a2007-10-31 13:53:06 +010030#include <linux/mtd/mtd.h>
Tom Rini1cefed12021-09-22 14:50:35 -040031#include <linux/mtd/rawnand.h>
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010032#include <command.h>
Simon Glass24b852a2015-11-08 23:47:45 -070033#include <console.h>
Simon Glassc7694dd2019-08-01 09:46:46 -060034#include <env.h>
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010035#include <watchdog.h>
36#include <malloc.h>
37#include <asm/byteorder.h>
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010038#include <jffs2/jffs2.h>
39#include <nand.h>
40
Miquel Raynaleb446ef2019-10-25 19:39:29 +020041#include "legacy-mtd-utils.h"
42
Ladislav Michl0c8a8492009-04-21 02:26:31 +020043#if defined(CONFIG_CMD_MTDPARTS)
Stefan Roese856f0542006-10-28 15:55:52 +020044
Wolfgang Denk445093d2009-11-17 21:27:39 +010045/* partition handling routines */
Stefan Roese856f0542006-10-28 15:55:52 +020046int mtdparts_init(void);
Stefan Roese856f0542006-10-28 15:55:52 +020047int find_dev_and_part(const char *id, struct mtd_device **dev,
Wolfgang Denk4b070802008-08-14 14:41:06 +020048 u8 *part_num, struct part_info **part);
Stefan Roese856f0542006-10-28 15:55:52 +020049#endif
50
Balamanikandan Gunasundar4ea84c52021-06-29 12:46:11 +053051#define MAX_NUM_PAGES 64
52
53static int nand_biterror(struct mtd_info *mtd, ulong off, int bit)
54{
55 int ret = 0;
56 int page = 0;
57 ulong block_off;
58 u_char *datbuf[MAX_NUM_PAGES]; /* Data and OOB */
59 u_char data;
60 int pages_per_blk = mtd->erasesize / mtd->writesize;
61 struct erase_info einfo;
62
63 if (pages_per_blk > MAX_NUM_PAGES) {
64 printf("Too many pages in one erase block\n");
65 return 1;
66 }
67
68 if (bit < 0 || bit > 7) {
69 printf("bit position 0 to 7 is allowed\n");
70 return 1;
71 }
72
73 /* Allocate memory */
74 memset(datbuf, 0, sizeof(datbuf));
75 for (page = 0; page < pages_per_blk ; page++) {
76 datbuf[page] = malloc(mtd->writesize + mtd->oobsize);
77 if (!datbuf[page]) {
78 printf("No memory for page buffer\n");
79 ret = -ENOMEM;
80 goto free_memory;
81 }
82 }
83
84 /* Align to erase block boundary */
85 block_off = off & (~(mtd->erasesize - 1));
86
87 /* Read out memory as first step */
88 for (page = 0; page < pages_per_blk ; page++) {
89 struct mtd_oob_ops ops;
90 loff_t addr = (loff_t)block_off;
91
92 memset(&ops, 0, sizeof(ops));
93 ops.datbuf = datbuf[page];
94 ops.oobbuf = datbuf[page] + mtd->writesize;
95 ops.len = mtd->writesize;
96 ops.ooblen = mtd->oobsize;
97 ops.mode = MTD_OPS_RAW;
98 ret = mtd_read_oob(mtd, addr, &ops);
99 if (ret < 0) {
100 printf("Error (%d) reading page %08lx\n",
101 ret, block_off);
102 ret = 1;
103 goto free_memory;
104 }
105 block_off += mtd->writesize;
106 }
107
108 /* Erase the block */
109 memset(&einfo, 0, sizeof(einfo));
110 einfo.mtd = mtd;
111 /* Align to erase block boundary */
112 einfo.addr = (loff_t)(off & (~(mtd->erasesize - 1)));
113 einfo.len = mtd->erasesize;
114 ret = mtd_erase(mtd, &einfo);
115 if (ret < 0) {
116 printf("Error (%d) nand_erase_nand page %08llx\n",
117 ret, einfo.addr);
118 ret = 1;
119 goto free_memory;
120 }
121
122 /* Twist a bit in data part */
123 block_off = off & (mtd->erasesize - 1);
124 data = datbuf[block_off / mtd->writesize][block_off % mtd->writesize];
125 data ^= (1 << bit);
126 datbuf[block_off / mtd->writesize][block_off % mtd->writesize] = data;
127
128 printf("Flip data at 0x%lx with xor 0x%02x (bit=%d) to value=0x%02x\n",
129 off, (1 << bit), bit, data);
130
131 /* Write back twisted data and unmodified OOB */
132 /* Align to erase block boundary */
133 block_off = off & (~(mtd->erasesize - 1));
134 for (page = 0; page < pages_per_blk; page++) {
135 struct mtd_oob_ops ops;
136 loff_t addr = (loff_t)block_off;
137
138 memset(&ops, 0, sizeof(ops));
139 ops.datbuf = datbuf[page];
140 ops.oobbuf = datbuf[page] + mtd->writesize;
141 ops.len = mtd->writesize;
142 ops.ooblen = mtd->oobsize;
143 ops.mode = MTD_OPS_RAW;
144 ret = mtd_write_oob(mtd, addr, &ops);
145 if (ret < 0) {
146 printf("Error (%d) write page %08lx\n", ret, block_off);
147 ret = 1;
148 goto free_memory;
149 }
150 block_off += mtd->writesize;
151 }
152
153free_memory:
154 for (page = 0; page < pages_per_blk ; page++) {
155 if (datbuf[page])
156 free(datbuf[page]);
157 }
158 return ret;
159}
160
Scott Wood151c06e2016-05-30 13:57:54 -0500161static int nand_dump(struct mtd_info *mtd, ulong off, int only_oob,
162 int repeat)
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100163{
164 int i;
William Juul9ad754f2007-12-14 16:33:45 +0100165 u_char *datbuf, *oobbuf, *p;
Scott Wood8c5659a2010-08-25 15:24:01 -0500166 static loff_t last;
Masahiro Yamadae40520b2013-07-11 17:27:12 +0900167 int ret = 0;
Scott Wood8c5659a2010-08-25 15:24:01 -0500168
169 if (repeat)
Scott Wood151c06e2016-05-30 13:57:54 -0500170 off = last + mtd->writesize;
Scott Wood8c5659a2010-08-25 15:24:01 -0500171
172 last = off;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100173
Scott Wood151c06e2016-05-30 13:57:54 -0500174 datbuf = memalign(ARCH_DMA_MINALIGN, mtd->writesize);
Masahiro Yamadae40520b2013-07-11 17:27:12 +0900175 if (!datbuf) {
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100176 puts("No memory for page buffer\n");
177 return 1;
178 }
Masahiro Yamadae40520b2013-07-11 17:27:12 +0900179
Scott Wood151c06e2016-05-30 13:57:54 -0500180 oobbuf = memalign(ARCH_DMA_MINALIGN, mtd->oobsize);
Masahiro Yamadae40520b2013-07-11 17:27:12 +0900181 if (!oobbuf) {
182 puts("No memory for page buffer\n");
183 ret = 1;
184 goto free_dat;
185 }
Scott Wood151c06e2016-05-30 13:57:54 -0500186 off &= ~(mtd->writesize - 1);
William Juulcfa460a2007-10-31 13:53:06 +0100187 loff_t addr = (loff_t) off;
William Juul9ad754f2007-12-14 16:33:45 +0100188 struct mtd_oob_ops ops;
189 memset(&ops, 0, sizeof(ops));
190 ops.datbuf = datbuf;
Tom Rinicfdae122012-02-23 15:47:46 -0700191 ops.oobbuf = oobbuf;
Scott Wood151c06e2016-05-30 13:57:54 -0500192 ops.len = mtd->writesize;
193 ops.ooblen = mtd->oobsize;
Sergey Lapindfe64e22013-01-14 03:46:50 +0000194 ops.mode = MTD_OPS_RAW;
Scott Wood151c06e2016-05-30 13:57:54 -0500195 i = mtd_read_oob(mtd, addr, &ops);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100196 if (i < 0) {
Stefan Roesee8706902008-07-10 10:10:54 +0200197 printf("Error (%d) reading page %08lx\n", i, off);
Masahiro Yamadae40520b2013-07-11 17:27:12 +0900198 ret = 1;
199 goto free_all;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100200 }
Stefan Roesee8706902008-07-10 10:10:54 +0200201 printf("Page %08lx dump:\n", off);
Wolfgang Denk4b070802008-08-14 14:41:06 +0200202
Masahiro Yamada7d25cd32013-07-11 17:27:13 +0900203 if (!only_oob) {
Scott Wood151c06e2016-05-30 13:57:54 -0500204 i = mtd->writesize >> 4;
Masahiro Yamada7d25cd32013-07-11 17:27:13 +0900205 p = datbuf;
206
207 while (i--) {
William Juul9ad754f2007-12-14 16:33:45 +0100208 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
209 " %02x %02x %02x %02x %02x %02x %02x %02x\n",
210 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
Scott Wooddfbf6172008-06-12 13:20:16 -0500211 p[8], p[9], p[10], p[11], p[12], p[13], p[14],
212 p[15]);
Masahiro Yamada7d25cd32013-07-11 17:27:13 +0900213 p += 16;
214 }
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100215 }
Masahiro Yamada7d25cd32013-07-11 17:27:13 +0900216
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100217 puts("OOB:\n");
Scott Wood151c06e2016-05-30 13:57:54 -0500218 i = mtd->oobsize >> 3;
Tom Rinicfdae122012-02-23 15:47:46 -0700219 p = oobbuf;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100220 while (i--) {
William Juulcfa460a2007-10-31 13:53:06 +0100221 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
222 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100223 p += 8;
224 }
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100225
Masahiro Yamadae40520b2013-07-11 17:27:12 +0900226free_all:
227 free(oobbuf);
228free_dat:
229 free(datbuf);
230
231 return ret;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100232}
233
234/* ------------------------------------------------------------------------- */
235
Scott Woodea533c22010-08-02 13:04:24 -0500236static int set_dev(int dev)
237{
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500238 struct mtd_info *mtd = get_nand_dev_by_index(dev);
239
240 if (!mtd)
241 return -ENODEV;
Scott Woodea533c22010-08-02 13:04:24 -0500242
243 if (nand_curr_device == dev)
244 return 0;
245
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500246 printf("Device %d: %s", dev, mtd->name);
Scott Woodea533c22010-08-02 13:04:24 -0500247 puts("... is now current device\n");
248 nand_curr_device = dev;
249
250#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Grygorii Strashko6308e712017-06-26 19:12:58 -0500251 board_nand_select_device(mtd_to_nand(mtd), dev);
Scott Woodea533c22010-08-02 13:04:24 -0500252#endif
253
254 return 0;
255}
256
Nishanth Menon50657c22008-12-13 09:43:06 -0600257#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
258static void print_status(ulong start, ulong end, ulong erasesize, int status)
259{
Joe Hershbergere70bfa22012-08-22 16:49:45 -0500260 /*
261 * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
262 * not the same as others. Instead of bit 1 being lock, it is
263 * #lock_tight. To make the driver support either format, ignore bit 1
264 * and use only bit 0 and bit 2.
265 */
Nishanth Menon50657c22008-12-13 09:43:06 -0600266 printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
267 start,
268 end - 1,
269 (end - start) / erasesize,
270 ((status & NAND_LOCK_STATUS_TIGHT) ? "TIGHT " : ""),
Joe Hershbergere70bfa22012-08-22 16:49:45 -0500271 (!(status & NAND_LOCK_STATUS_UNLOCK) ? "LOCK " : ""),
Nishanth Menon50657c22008-12-13 09:43:06 -0600272 ((status & NAND_LOCK_STATUS_UNLOCK) ? "UNLOCK " : ""));
273}
274
Scott Wood151c06e2016-05-30 13:57:54 -0500275static void do_nand_status(struct mtd_info *mtd)
Nishanth Menon50657c22008-12-13 09:43:06 -0600276{
277 ulong block_start = 0;
278 ulong off;
279 int last_status = -1;
280
Scott Wood17cb4b82016-05-30 13:57:56 -0500281 struct nand_chip *nand_chip = mtd_to_nand(mtd);
Nishanth Menon50657c22008-12-13 09:43:06 -0600282 /* check the WP bit */
Scott Wood151c06e2016-05-30 13:57:54 -0500283 nand_chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Nishanth Menon50657c22008-12-13 09:43:06 -0600284 printf("device is %swrite protected\n",
Scott Wood151c06e2016-05-30 13:57:54 -0500285 (nand_chip->read_byte(mtd) & 0x80 ?
286 "NOT " : ""));
Nishanth Menon50657c22008-12-13 09:43:06 -0600287
Scott Wood151c06e2016-05-30 13:57:54 -0500288 for (off = 0; off < mtd->size; off += mtd->erasesize) {
289 int s = nand_get_lock_status(mtd, off);
Nishanth Menon50657c22008-12-13 09:43:06 -0600290
291 /* print message only if status has changed */
292 if (s != last_status && off != 0) {
Scott Wood151c06e2016-05-30 13:57:54 -0500293 print_status(block_start, off, mtd->erasesize,
Nishanth Menon50657c22008-12-13 09:43:06 -0600294 last_status);
295 block_start = off;
296 }
297 last_status = s;
298 }
299 /* Print the last block info */
Scott Wood151c06e2016-05-30 13:57:54 -0500300 print_status(block_start, off, mtd->erasesize, last_status);
Nishanth Menon50657c22008-12-13 09:43:06 -0600301}
302#endif
303
Ben Gardinerc9f73512010-07-05 13:27:07 -0400304#ifdef CONFIG_ENV_OFFSET_OOB
305unsigned long nand_env_oob_offset;
306
Simon Glass09140112020-05-10 11:40:03 -0600307int do_nand_env_oob(struct cmd_tbl *cmdtp, int argc, char *const argv[])
Ben Gardinerc9f73512010-07-05 13:27:07 -0400308{
309 int ret;
310 uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500311 struct mtd_info *mtd = get_nand_dev_by_index(0);
Ben Gardinerc9f73512010-07-05 13:27:07 -0400312 char *cmd = argv[1];
313
Scott Wood8b7d5122016-09-01 17:31:31 -0500314 if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !mtd) {
Scott Woodea533c22010-08-02 13:04:24 -0500315 puts("no devices available\n");
316 return 1;
317 }
318
319 set_dev(0);
320
Ben Gardinerc9f73512010-07-05 13:27:07 -0400321 if (!strcmp(cmd, "get")) {
Scott Wood151c06e2016-05-30 13:57:54 -0500322 ret = get_nand_env_oob(mtd, &nand_env_oob_offset);
Scott Wood53504a22010-07-12 18:17:40 -0500323 if (ret)
Ben Gardinerc9f73512010-07-05 13:27:07 -0400324 return 1;
Scott Wood53504a22010-07-12 18:17:40 -0500325
326 printf("0x%08lx\n", nand_env_oob_offset);
Ben Gardinerc9f73512010-07-05 13:27:07 -0400327 } else if (!strcmp(cmd, "set")) {
Scott Woodea533c22010-08-02 13:04:24 -0500328 loff_t addr;
329 loff_t maxsize;
Ben Gardinerc9f73512010-07-05 13:27:07 -0400330 struct mtd_oob_ops ops;
Scott Woodea533c22010-08-02 13:04:24 -0500331 int idx = 0;
Ben Gardinerc9f73512010-07-05 13:27:07 -0400332
333 if (argc < 3)
334 goto usage;
335
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500336 mtd = get_nand_dev_by_index(idx);
Tom Rinic39d6a02013-03-14 05:32:50 +0000337 /* We don't care about size, or maxsize. */
Heiko Schocher09c32802015-04-27 07:42:05 +0200338 if (mtd_arg_off(argv[2], &idx, &addr, &maxsize, &maxsize,
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500339 MTD_DEV_TYPE_NAND, mtd->size)) {
Heiko Schocher09c32802015-04-27 07:42:05 +0200340 puts("Offset or partition name expected\n");
341 return 1;
342 }
343 if (set_dev(idx)) {
Scott Woodea533c22010-08-02 13:04:24 -0500344 puts("Offset or partition name expected\n");
345 return 1;
346 }
347
348 if (idx != 0) {
349 puts("Partition not on first NAND device\n");
Ben Gardinerc9f73512010-07-05 13:27:07 -0400350 return 1;
351 }
352
Scott Wood151c06e2016-05-30 13:57:54 -0500353 if (mtd->oobavail < ENV_OFFSET_SIZE) {
Scott Wood53504a22010-07-12 18:17:40 -0500354 printf("Insufficient available OOB bytes:\n"
355 "%d OOB bytes available but %d required for "
356 "env.oob support\n",
Scott Wood151c06e2016-05-30 13:57:54 -0500357 mtd->oobavail, ENV_OFFSET_SIZE);
Ben Gardinerc9f73512010-07-05 13:27:07 -0400358 return 1;
359 }
360
Scott Wood151c06e2016-05-30 13:57:54 -0500361 if ((addr & (mtd->erasesize - 1)) != 0) {
Ben Gardinerc9f73512010-07-05 13:27:07 -0400362 printf("Environment offset must be block-aligned\n");
363 return 1;
364 }
365
366 ops.datbuf = NULL;
367 ops.mode = MTD_OOB_AUTO;
368 ops.ooboffs = 0;
369 ops.ooblen = ENV_OFFSET_SIZE;
370 ops.oobbuf = (void *) oob_buf;
371
372 oob_buf[0] = ENV_OOB_MARKER;
Scott Wood151c06e2016-05-30 13:57:54 -0500373 oob_buf[1] = addr / mtd->erasesize;
Ben Gardinerc9f73512010-07-05 13:27:07 -0400374
Scott Wood151c06e2016-05-30 13:57:54 -0500375 ret = mtd->write_oob(mtd, ENV_OFFSET_SIZE, &ops);
Scott Wood53504a22010-07-12 18:17:40 -0500376 if (ret) {
Ben Gardinerc9f73512010-07-05 13:27:07 -0400377 printf("Error writing OOB block 0\n");
378 return ret;
379 }
Scott Wood53504a22010-07-12 18:17:40 -0500380
Scott Wood151c06e2016-05-30 13:57:54 -0500381 ret = get_nand_env_oob(mtd, &nand_env_oob_offset);
Scott Wood53504a22010-07-12 18:17:40 -0500382 if (ret) {
383 printf("Error reading env offset in OOB\n");
384 return ret;
385 }
386
387 if (addr != nand_env_oob_offset) {
388 printf("Verification of env offset in OOB failed: "
Scott Woodea533c22010-08-02 13:04:24 -0500389 "0x%08llx expected but got 0x%08lx\n",
390 (unsigned long long)addr, nand_env_oob_offset);
Scott Wood53504a22010-07-12 18:17:40 -0500391 return 1;
392 }
Ben Gardinerc9f73512010-07-05 13:27:07 -0400393 } else {
394 goto usage;
395 }
396
397 return ret;
398
399usage:
Simon Glass4c12eeb2011-12-10 08:44:01 +0000400 return CMD_RET_USAGE;
Ben Gardinerc9f73512010-07-05 13:27:07 -0400401}
402
403#endif
404
Marek Vasutce80ddc2011-09-22 03:57:26 +0200405static void nand_print_and_set_info(int idx)
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +0100406{
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500407 struct mtd_info *mtd;
408 struct nand_chip *chip;
Marek Vasutce80ddc2011-09-22 03:57:26 +0200409
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500410 mtd = get_nand_dev_by_index(idx);
411 if (!mtd)
412 return;
413
414 chip = mtd_to_nand(mtd);
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +0100415 printf("Device %d: ", idx);
416 if (chip->numchips > 1)
417 printf("%dx ", chip->numchips);
418 printf("%s, sector size %u KiB\n",
Scott Wood151c06e2016-05-30 13:57:54 -0500419 mtd->name, mtd->erasesize >> 10);
Michael Trimarchi308bd742022-09-22 15:39:37 +0200420 printf(" Page size %8d b\n", mtd->writesize);
421 printf(" OOB size %8d b\n", mtd->oobsize);
422 printf(" Erase size %8d b\n", mtd->erasesize);
423 printf(" ecc strength %8d bits\n", mtd->ecc_strength);
424 printf(" ecc step size %8d b\n", mtd->ecc_step_size);
425 printf(" subpagesize %8d b\n", chip->subpagesize);
426 printf(" options 0x%08x\n", chip->options);
427 printf(" bbt options 0x%08x\n", chip->bbt_options);
Marek Vasutce80ddc2011-09-22 03:57:26 +0200428
429 /* Set geometry info */
Simon Glass018f5302017-08-03 12:22:10 -0600430 env_set_hex("nand_writesize", mtd->writesize);
431 env_set_hex("nand_oobsize", mtd->oobsize);
432 env_set_hex("nand_erasesize", mtd->erasesize);
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +0100433}
434
Scott Wood151c06e2016-05-30 13:57:54 -0500435static int raw_access(struct mtd_info *mtd, ulong addr, loff_t off,
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200436 ulong count, int read, int no_verify)
Scott Wood418396e2012-03-02 14:01:57 -0600437{
438 int ret = 0;
Scott Wood418396e2012-03-02 14:01:57 -0600439
440 while (count--) {
441 /* Raw access */
442 mtd_oob_ops_t ops = {
443 .datbuf = (u8 *)addr,
Scott Wood151c06e2016-05-30 13:57:54 -0500444 .oobbuf = ((u8 *)addr) + mtd->writesize,
445 .len = mtd->writesize,
446 .ooblen = mtd->oobsize,
Sergey Lapindfe64e22013-01-14 03:46:50 +0000447 .mode = MTD_OPS_RAW
Scott Wood418396e2012-03-02 14:01:57 -0600448 };
449
Peter Tyser6b94f112015-02-03 11:58:13 -0600450 if (read) {
Scott Wood151c06e2016-05-30 13:57:54 -0500451 ret = mtd_read_oob(mtd, off, &ops);
Peter Tyser6b94f112015-02-03 11:58:13 -0600452 } else {
Scott Wood151c06e2016-05-30 13:57:54 -0500453 ret = mtd_write_oob(mtd, off, &ops);
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200454 if (!ret && !no_verify)
Scott Wood151c06e2016-05-30 13:57:54 -0500455 ret = nand_verify_page_oob(mtd, &ops, off);
Peter Tyser6b94f112015-02-03 11:58:13 -0600456 }
Scott Wood418396e2012-03-02 14:01:57 -0600457
458 if (ret) {
459 printf("%s: error at offset %llx, ret %d\n",
460 __func__, (long long)off, ret);
461 break;
462 }
463
Scott Wood151c06e2016-05-30 13:57:54 -0500464 addr += mtd->writesize + mtd->oobsize;
465 off += mtd->writesize;
Scott Wood418396e2012-03-02 14:01:57 -0600466 }
467
468 return ret;
469}
470
Harvey Chapmane8344022013-02-26 17:57:14 +0000471/* Adjust a chip/partition size down for bad blocks so we don't
Scott Wood9b80aa82013-06-20 12:45:31 -0500472 * read/write past the end of a chip/partition by accident.
Harvey Chapmane8344022013-02-26 17:57:14 +0000473 */
474static void adjust_size_for_badblocks(loff_t *size, loff_t offset, int dev)
475{
476 /* We grab the nand info object here fresh because this is usually
477 * called after arg_off_size() which can change the value of dev.
478 */
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500479 struct mtd_info *mtd = get_nand_dev_by_index(dev);
Harvey Chapmane8344022013-02-26 17:57:14 +0000480 loff_t maxoffset = offset + *size;
481 int badblocks = 0;
482
483 /* count badblocks in NAND from offset to offset + size */
Scott Wood151c06e2016-05-30 13:57:54 -0500484 for (; offset < maxoffset; offset += mtd->erasesize) {
485 if (nand_block_isbad(mtd, offset))
Harvey Chapmane8344022013-02-26 17:57:14 +0000486 badblocks++;
487 }
488 /* adjust size if any bad blocks found */
489 if (badblocks) {
Scott Wood151c06e2016-05-30 13:57:54 -0500490 *size -= badblocks * mtd->erasesize;
Harvey Chapmane8344022013-02-26 17:57:14 +0000491 printf("size adjusted to 0x%llx (%d bad blocks)\n",
492 (unsigned long long)*size, badblocks);
493 }
494}
495
Simon Glass09140112020-05-10 11:40:03 -0600496static int do_nand(struct cmd_tbl *cmdtp, int flag, int argc,
497 char *const argv[])
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100498{
Scott Woodea533c22010-08-02 13:04:24 -0500499 int i, ret = 0;
500 ulong addr;
Tom Rinic39d6a02013-03-14 05:32:50 +0000501 loff_t off, size, maxsize;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100502 char *cmd, *s;
Scott Wood151c06e2016-05-30 13:57:54 -0500503 struct mtd_info *mtd;
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200504#ifdef CONFIG_SYS_NAND_QUIET
505 int quiet = CONFIG_SYS_NAND_QUIET;
Matthias Fuchsc750d2e2007-09-12 12:36:53 +0200506#else
Stefan Roese2255b2d2006-10-10 12:36:02 +0200507 int quiet = 0;
Matthias Fuchsc750d2e2007-09-12 12:36:53 +0200508#endif
Simon Glass00caae62017-08-03 12:22:12 -0600509 const char *quiet_str = env_get("quiet");
Scott Woodea533c22010-08-02 13:04:24 -0500510 int dev = nand_curr_device;
Scott Wood8c5659a2010-08-25 15:24:01 -0500511 int repeat = flag & CMD_FLAG_REPEAT;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100512
513 /* at least two arguments please */
514 if (argc < 2)
515 goto usage;
516
Stefan Roese2255b2d2006-10-10 12:36:02 +0200517 if (quiet_str)
518 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
519
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100520 cmd = argv[1];
521
Scott Wood8c5659a2010-08-25 15:24:01 -0500522 /* Only "dump" is repeatable. */
523 if (repeat && strcmp(cmd, "dump"))
524 return 0;
525
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100526 if (strcmp(cmd, "info") == 0) {
527
528 putc('\n');
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500529 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++)
530 nand_print_and_set_info(i);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100531 return 0;
532 }
533
534 if (strcmp(cmd, "device") == 0) {
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100535 if (argc < 3) {
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +0100536 putc('\n');
Scott Woodea533c22010-08-02 13:04:24 -0500537 if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +0100538 puts("no devices available\n");
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100539 else
Marek Vasutce80ddc2011-09-22 03:57:26 +0200540 nand_print_and_set_info(dev);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100541 return 0;
542 }
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200543
Simon Glass0b1284e2021-07-24 09:03:30 -0600544 dev = (int)dectoul(argv[2], NULL);
Scott Woodea533c22010-08-02 13:04:24 -0500545 set_dev(dev);
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200546
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100547 return 0;
548 }
549
Ben Gardinerc9f73512010-07-05 13:27:07 -0400550#ifdef CONFIG_ENV_OFFSET_OOB
551 /* this command operates only on the first nand device */
Scott Woodea533c22010-08-02 13:04:24 -0500552 if (strcmp(cmd, "env.oob") == 0)
553 return do_nand_env_oob(cmdtp, argc - 1, argv + 1);
Ben Gardinerc9f73512010-07-05 13:27:07 -0400554#endif
555
Scott Woodea533c22010-08-02 13:04:24 -0500556 /* The following commands operate on the current device, unless
557 * overridden by a partition specifier. Note that if somehow the
558 * current device is invalid, it will have to be changed to a valid
559 * one before these commands can run, even if a partition specifier
560 * for another device is to be used.
561 */
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500562 mtd = get_nand_dev_by_index(dev);
563 if (!mtd) {
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100564 puts("\nno devices available\n");
565 return 1;
566 }
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100567
568 if (strcmp(cmd, "bad") == 0) {
Scott Woodea533c22010-08-02 13:04:24 -0500569 printf("\nDevice %d bad blocks:\n", dev);
Ashok Reddy Somacfb82f72023-01-05 02:46:20 -0700570 for (off = 0; off < mtd->size; off += mtd->erasesize) {
571 ret = nand_block_isbad(mtd, off);
572 if (ret)
573 printf(" 0x%08llx%s\n", (unsigned long long)off,
574 ret == 2 ? "\t (bbt reserved)" : "");
575 }
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100576 return 0;
577 }
578
Stefan Roese856f0542006-10-28 15:55:52 +0200579 /*
580 * Syntax is:
581 * 0 1 2 3 4
582 * nand erase [clean] [off size]
583 */
Scott Wood30486322010-08-25 14:43:29 -0500584 if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
Stefan Roese2255b2d2006-10-10 12:36:02 +0200585 nand_erase_options_t opts;
Stefan Roese856f0542006-10-28 15:55:52 +0200586 /* "clean" at index 2 means request to write cleanmarker */
William Juul3043c042007-11-14 14:28:11 +0100587 int clean = argc > 2 && !strcmp("clean", argv[2]);
Marek Vasut60899812011-09-14 00:20:35 +0200588 int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
589 int o = (clean || scrub_yes) ? 3 : 2;
Scott Wood30486322010-08-25 14:43:29 -0500590 int scrub = !strncmp(cmd, "scrub", 5);
Scott Wood30486322010-08-25 14:43:29 -0500591 int spread = 0;
592 int args = 2;
Marek Vasut60899812011-09-14 00:20:35 +0200593 const char *scrub_warn =
594 "Warning: "
595 "scrub option will erase all factory set bad blocks!\n"
596 " "
597 "There is no reliable way to recover them.\n"
598 " "
599 "Use this command only for testing purposes if you\n"
600 " "
601 "are sure of what you are doing!\n"
602 "\nReally scrub this NAND flash? <y/N>\n";
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100603
Scott Wood30486322010-08-25 14:43:29 -0500604 if (cmd[5] != 0) {
605 if (!strcmp(&cmd[5], ".spread")) {
606 spread = 1;
607 } else if (!strcmp(&cmd[5], ".part")) {
Scott Wood30486322010-08-25 14:43:29 -0500608 args = 1;
609 } else if (!strcmp(&cmd[5], ".chip")) {
Scott Wood30486322010-08-25 14:43:29 -0500610 args = 0;
611 } else {
612 goto usage;
613 }
614 }
615
616 /*
617 * Don't allow missing arguments to cause full chip/partition
618 * erases -- easy to do accidentally, e.g. with a misspelled
619 * variable name.
620 */
621 if (argc != o + args)
622 goto usage;
623
624 printf("\nNAND %s: ", cmd);
Stefan Roese856f0542006-10-28 15:55:52 +0200625 /* skip first two or three arguments, look for offset and size */
Heiko Schocher09c32802015-04-27 07:42:05 +0200626 if (mtd_arg_off_size(argc - o, argv + o, &dev, &off, &size,
627 &maxsize, MTD_DEV_TYPE_NAND,
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500628 mtd->size) != 0)
Heiko Schocher09c32802015-04-27 07:42:05 +0200629 return 1;
630
631 if (set_dev(dev))
Stefan Roese856f0542006-10-28 15:55:52 +0200632 return 1;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200633
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500634 mtd = get_nand_dev_by_index(dev);
Scott Woodea533c22010-08-02 13:04:24 -0500635
Stefan Roese2255b2d2006-10-10 12:36:02 +0200636 memset(&opts, 0, sizeof(opts));
637 opts.offset = off;
638 opts.length = size;
639 opts.jffs2 = clean;
640 opts.quiet = quiet;
Scott Wood30486322010-08-25 14:43:29 -0500641 opts.spread = spread;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200642
643 if (scrub) {
Pierre Auberta5dffa42014-04-24 10:30:07 +0200644 if (scrub_yes) {
Marek Vasut60899812011-09-14 00:20:35 +0200645 opts.scrub = 1;
Pierre Auberta5dffa42014-04-24 10:30:07 +0200646 } else {
647 puts(scrub_warn);
648 if (confirm_yesno()) {
Florian Fainelli6b94b492010-03-20 19:02:58 +0100649 opts.scrub = 1;
Pierre Auberta5dffa42014-04-24 10:30:07 +0200650 } else {
Florian Fainelli6b94b492010-03-20 19:02:58 +0100651 puts("scrub aborted\n");
Masahiro Yamada46aabcc2013-07-11 17:29:57 +0900652 return 1;
Florian Fainelli6b94b492010-03-20 19:02:58 +0100653 }
Stefan Roese2255b2d2006-10-10 12:36:02 +0200654 }
655 }
Scott Wood151c06e2016-05-30 13:57:54 -0500656 ret = nand_erase_opts(mtd, &opts);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100657 printf("%s\n", ret ? "ERROR" : "OK");
658
659 return ret == 0 ? 0 : 1;
660 }
661
662 if (strncmp(cmd, "dump", 4) == 0) {
663 if (argc < 3)
664 goto usage;
665
Simon Glass7e5f4602021-07-24 09:03:29 -0600666 off = (int)hextoul(argv[2], NULL);
Scott Wood151c06e2016-05-30 13:57:54 -0500667 ret = nand_dump(mtd, off, !strcmp(&cmd[4], ".oob"), repeat);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100668
669 return ret == 0 ? 1 : 0;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100670 }
671
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100672 if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
Scott Woodea533c22010-08-02 13:04:24 -0500673 size_t rwsize;
Scott Wood418396e2012-03-02 14:01:57 -0600674 ulong pagecount = 1;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200675 int read;
Harvey Chapmanced199d2013-02-07 11:34:44 +0000676 int raw = 0;
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200677 int no_verify = 0;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200678
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100679 if (argc < 4)
680 goto usage;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200681
Simon Glass7e5f4602021-07-24 09:03:29 -0600682 addr = (ulong)hextoul(argv[2], NULL);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100683
Stefan Roese2255b2d2006-10-10 12:36:02 +0200684 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
Stefan Roese856f0542006-10-28 15:55:52 +0200685 printf("\nNAND %s: ", read ? "read" : "write");
William Juul4cbb6512007-11-08 10:39:53 +0100686
Stefan Roese2255b2d2006-10-10 12:36:02 +0200687 s = strchr(cmd, '.');
Scott Wood418396e2012-03-02 14:01:57 -0600688
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200689 if (s && !strncmp(s, ".raw", 4)) {
Scott Wood418396e2012-03-02 14:01:57 -0600690 raw = 1;
691
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200692 if (!strcmp(s, ".raw.noverify"))
693 no_verify = 1;
694
Heiko Schocher09c32802015-04-27 07:42:05 +0200695 if (mtd_arg_off(argv[3], &dev, &off, &size, &maxsize,
696 MTD_DEV_TYPE_NAND,
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500697 mtd->size))
Heiko Schocher09c32802015-04-27 07:42:05 +0200698 return 1;
699
700 if (set_dev(dev))
Scott Wood418396e2012-03-02 14:01:57 -0600701 return 1;
702
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500703 mtd = get_nand_dev_by_index(dev);
Rostislav Lisovy93d32322014-09-16 14:38:52 +0200704
Scott Wood418396e2012-03-02 14:01:57 -0600705 if (argc > 4 && !str2long(argv[4], &pagecount)) {
706 printf("'%s' is not a number\n", argv[4]);
707 return 1;
708 }
709
Scott Wood151c06e2016-05-30 13:57:54 -0500710 if (pagecount * mtd->writesize > size) {
Scott Wood418396e2012-03-02 14:01:57 -0600711 puts("Size exceeds partition or device limit\n");
712 return -1;
713 }
714
Scott Wood151c06e2016-05-30 13:57:54 -0500715 rwsize = pagecount * (mtd->writesize + mtd->oobsize);
Scott Wood418396e2012-03-02 14:01:57 -0600716 } else {
Heiko Schocher09c32802015-04-27 07:42:05 +0200717 if (mtd_arg_off_size(argc - 3, argv + 3, &dev, &off,
718 &size, &maxsize,
719 MTD_DEV_TYPE_NAND,
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500720 mtd->size) != 0)
Heiko Schocher09c32802015-04-27 07:42:05 +0200721 return 1;
722
723 if (set_dev(dev))
Scott Wood418396e2012-03-02 14:01:57 -0600724 return 1;
725
Harvey Chapmane8344022013-02-26 17:57:14 +0000726 /* size is unspecified */
727 if (argc < 5)
728 adjust_size_for_badblocks(&size, off, dev);
Scott Wood418396e2012-03-02 14:01:57 -0600729 rwsize = size;
730 }
731
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500732 mtd = get_nand_dev_by_index(dev);
Rostislav Lisovy93d32322014-09-16 14:38:52 +0200733
Scott Wood984e03c2008-06-12 13:13:23 -0500734 if (!s || !strcmp(s, ".jffs2") ||
735 !strcmp(s, ".e") || !strcmp(s, ".i")) {
Scott Wooddfbf6172008-06-12 13:20:16 -0500736 if (read)
Scott Wood151c06e2016-05-30 13:57:54 -0500737 ret = nand_read_skip_bad(mtd, off, &rwsize,
Tom Rinic39d6a02013-03-14 05:32:50 +0000738 NULL, maxsize,
Wolfgang Denk4b070802008-08-14 14:41:06 +0200739 (u_char *)addr);
Scott Wooddfbf6172008-06-12 13:20:16 -0500740 else
Scott Wood151c06e2016-05-30 13:57:54 -0500741 ret = nand_write_skip_bad(mtd, off, &rwsize,
Tom Rinic39d6a02013-03-14 05:32:50 +0000742 NULL, maxsize,
Peter Tyser6b94f112015-02-03 11:58:13 -0600743 (u_char *)addr,
744 WITH_WR_VERIFY);
Ben Gardinerc9494862011-06-14 16:35:07 -0400745#ifdef CONFIG_CMD_NAND_TRIMFFS
746 } else if (!strcmp(s, ".trimffs")) {
747 if (read) {
748 printf("Unknown nand command suffix '%s'\n", s);
749 return 1;
750 }
Scott Wood151c06e2016-05-30 13:57:54 -0500751 ret = nand_write_skip_bad(mtd, off, &rwsize, NULL,
Tom Rinic39d6a02013-03-14 05:32:50 +0000752 maxsize, (u_char *)addr,
Peter Tyser6b94f112015-02-03 11:58:13 -0600753 WITH_DROP_FFS | WITH_WR_VERIFY);
Ben Gardinerc9494862011-06-14 16:35:07 -0400754#endif
Mike Frysingerdfc99e12009-04-12 22:29:20 -0400755 } else if (!strcmp(s, ".oob")) {
William Juulcfa460a2007-10-31 13:53:06 +0100756 /* out-of-band data */
757 mtd_oob_ops_t ops = {
758 .oobbuf = (u8 *)addr,
Scott Woodea533c22010-08-02 13:04:24 -0500759 .ooblen = rwsize,
Sergey Lapindfe64e22013-01-14 03:46:50 +0000760 .mode = MTD_OPS_RAW
William Juulcfa460a2007-10-31 13:53:06 +0100761 };
762
Harald Welte62d4f432007-12-19 14:12:53 +0100763 if (read)
Scott Wood151c06e2016-05-30 13:57:54 -0500764 ret = mtd_read_oob(mtd, off, &ops);
Harald Welte62d4f432007-12-19 14:12:53 +0100765 else
Scott Wood151c06e2016-05-30 13:57:54 -0500766 ret = mtd_write_oob(mtd, off, &ops);
Scott Wood418396e2012-03-02 14:01:57 -0600767 } else if (raw) {
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200768 ret = raw_access(mtd, addr, off, pagecount, read,
769 no_verify);
Stefan Roese856f0542006-10-28 15:55:52 +0200770 } else {
Scott Wood984e03c2008-06-12 13:13:23 -0500771 printf("Unknown nand command suffix '%s'.\n", s);
772 return 1;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200773 }
774
Scott Woodea533c22010-08-02 13:04:24 -0500775 printf(" %zu bytes %s: %s\n", rwsize,
Stefan Roese2255b2d2006-10-10 12:36:02 +0200776 read ? "read" : "written", ret ? "ERROR" : "OK");
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100777
778 return ret == 0 ? 0 : 1;
779 }
Stefan Roese2255b2d2006-10-10 12:36:02 +0200780
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100781#ifdef CONFIG_CMD_NAND_TORTURE
782 if (strcmp(cmd, "torture") == 0) {
Max Krummenacher1866be72016-06-13 10:15:48 +0200783 loff_t endoff;
784 unsigned int failed = 0, passed = 0;
785
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100786 if (argc < 3)
787 goto usage;
788
789 if (!str2off(argv[2], &off)) {
790 puts("Offset is not a valid number\n");
791 return 1;
792 }
793
Max Krummenacher1866be72016-06-13 10:15:48 +0200794 size = mtd->erasesize;
795 if (argc > 3) {
796 if (!str2off(argv[3], &size)) {
797 puts("Size is not a valid number\n");
798 return 1;
799 }
800 }
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100801
Max Krummenacher1866be72016-06-13 10:15:48 +0200802 endoff = off + size;
803 if (endoff > mtd->size) {
804 puts("Arguments beyond end of NAND\n");
805 return 1;
806 }
807
808 off = round_down(off, mtd->erasesize);
809 endoff = round_up(endoff, mtd->erasesize);
810 size = endoff - off;
811 printf("\nNAND torture: device %d offset 0x%llx size 0x%llx (block size 0x%x)\n",
812 dev, off, size, mtd->erasesize);
813 while (off < endoff) {
814 ret = nand_torture(mtd, off);
815 if (ret) {
816 failed++;
817 printf(" block at 0x%llx failed\n", off);
818 } else {
819 passed++;
820 }
821 off += mtd->erasesize;
822 }
823 printf(" Passed: %u, failed: %u\n", passed, failed);
824 return failed != 0;
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100825 }
826#endif
827
Stefan Roese2255b2d2006-10-10 12:36:02 +0200828 if (strcmp(cmd, "markbad") == 0) {
Wolfgang Denk8360b662009-05-24 17:34:33 +0200829 argc -= 2;
830 argv += 2;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200831
Wolfgang Denk8360b662009-05-24 17:34:33 +0200832 if (argc <= 0)
833 goto usage;
834
835 while (argc > 0) {
Simon Glass7e5f4602021-07-24 09:03:29 -0600836 addr = hextoul(*argv, NULL);
Wolfgang Denk8360b662009-05-24 17:34:33 +0200837
Scott Wood151c06e2016-05-30 13:57:54 -0500838 if (mtd_block_markbad(mtd, addr)) {
Wolfgang Denk8360b662009-05-24 17:34:33 +0200839 printf("block 0x%08lx NOT marked "
840 "as bad! ERROR %d\n",
841 addr, ret);
842 ret = 1;
843 } else {
844 printf("block 0x%08lx successfully "
845 "marked as bad\n",
846 addr);
847 }
848 --argc;
849 ++argv;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200850 }
Wolfgang Denk8360b662009-05-24 17:34:33 +0200851 return ret;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200852 }
Scott Wooddfbf6172008-06-12 13:20:16 -0500853
Stefan Roese2255b2d2006-10-10 12:36:02 +0200854 if (strcmp(cmd, "biterr") == 0) {
Balamanikandan Gunasundar4ea84c52021-06-29 12:46:11 +0530855 int bit;
856
857 if (argc != 4)
858 goto usage;
859
860 off = (int)simple_strtoul(argv[2], NULL, 16);
861 bit = (int)simple_strtoul(argv[3], NULL, 10);
862 ret = nand_biterror(mtd, off, bit);
863 return ret;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200864 }
865
Nishanth Menon50657c22008-12-13 09:43:06 -0600866#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
Stefan Roese2255b2d2006-10-10 12:36:02 +0200867 if (strcmp(cmd, "lock") == 0) {
Nishanth Menon50657c22008-12-13 09:43:06 -0600868 int tight = 0;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200869 int status = 0;
870 if (argc == 3) {
871 if (!strcmp("tight", argv[2]))
872 tight = 1;
873 if (!strcmp("status", argv[2]))
874 status = 1;
875 }
Stefan Roese2255b2d2006-10-10 12:36:02 +0200876 if (status) {
Scott Wood151c06e2016-05-30 13:57:54 -0500877 do_nand_status(mtd);
William Juulcfa460a2007-10-31 13:53:06 +0100878 } else {
Scott Wood151c06e2016-05-30 13:57:54 -0500879 if (!nand_lock(mtd, tight)) {
William Juul5e1dae52007-11-09 13:32:30 +0100880 puts("NAND flash successfully locked\n");
881 } else {
882 puts("Error locking NAND flash\n");
883 return 1;
884 }
Stefan Roese2255b2d2006-10-10 12:36:02 +0200885 }
886 return 0;
887 }
888
Joe Hershbergereee623a2012-08-22 16:49:42 -0500889 if (strncmp(cmd, "unlock", 5) == 0) {
890 int allexcept = 0;
891
892 s = strchr(cmd, '.');
893
894 if (s && !strcmp(s, ".allexcept"))
895 allexcept = 1;
896
Heiko Schocher09c32802015-04-27 07:42:05 +0200897 if (mtd_arg_off_size(argc - 2, argv + 2, &dev, &off, &size,
898 &maxsize, MTD_DEV_TYPE_NAND,
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500899 mtd->size) < 0)
Heiko Schocher09c32802015-04-27 07:42:05 +0200900 return 1;
901
902 if (set_dev(dev))
Stefan Roese856f0542006-10-28 15:55:52 +0200903 return 1;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200904
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500905 mtd = get_nand_dev_by_index(dev);
906
907 if (!nand_unlock(mtd, off, size, allexcept)) {
William Juul5e1dae52007-11-09 13:32:30 +0100908 puts("NAND flash successfully unlocked\n");
909 } else {
910 puts("Error unlocking NAND flash, "
William Juul3043c042007-11-14 14:28:11 +0100911 "write and erase will probably fail\n");
William Juul5e1dae52007-11-09 13:32:30 +0100912 return 1;
913 }
Stefan Roese2255b2d2006-10-10 12:36:02 +0200914 return 0;
915 }
Nishanth Menon50657c22008-12-13 09:43:06 -0600916#endif
Stefan Roese2255b2d2006-10-10 12:36:02 +0200917
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100918usage:
Simon Glass4c12eeb2011-12-10 08:44:01 +0000919 return CMD_RET_USAGE;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100920}
921
Tom Rini36162182023-10-07 15:13:08 -0400922U_BOOT_LONGHELP(nand,
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200923 "info - show available NAND devices\n"
924 "nand device [dev] - show or set current device\n"
925 "nand read - addr off|partition size\n"
926 "nand write - addr off|partition size\n"
927 " read/write 'size' bytes starting at offset 'off'\n"
928 " to/from memory address 'addr', skipping bad blocks.\n"
Scott Wood418396e2012-03-02 14:01:57 -0600929 "nand read.raw - addr off|partition [count]\n"
Boris Brezillon2dc3c4832016-06-15 10:42:18 +0200930 "nand write.raw[.noverify] - addr off|partition [count]\n"
Scott Wood418396e2012-03-02 14:01:57 -0600931 " Use read.raw/write.raw to avoid ECC and access the flash as-is.\n"
Ben Gardinerc9494862011-06-14 16:35:07 -0400932#ifdef CONFIG_CMD_NAND_TRIMFFS
933 "nand write.trimffs - addr off|partition size\n"
934 " write 'size' bytes starting at offset 'off' from memory address\n"
935 " 'addr', skipping bad blocks and dropping any pages at the end\n"
936 " of eraseblocks that contain only 0xFF\n"
937#endif
Daniel Hobieb3abce2011-05-19 19:28:54 +0200938 "nand erase[.spread] [clean] off size - erase 'size' bytes "
Scott Wood30486322010-08-25 14:43:29 -0500939 "from offset 'off'\n"
940 " With '.spread', erase enough for given file size, otherwise,\n"
941 " 'size' includes skipped bad blocks.\n"
942 "nand erase.part [clean] partition - erase entire mtd partition'\n"
943 "nand erase.chip [clean] - erase entire chip'\n"
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200944 "nand bad - show bad blocks\n"
945 "nand dump[.oob] off - dump page\n"
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100946#ifdef CONFIG_CMD_NAND_TORTURE
Max Krummenacher1866be72016-06-13 10:15:48 +0200947 "nand torture off - torture one block at offset\n"
948 "nand torture off [size] - torture blocks from off to off+size\n"
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100949#endif
Marek Vasut60899812011-09-14 00:20:35 +0200950 "nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
Scott Wood30486322010-08-25 14:43:29 -0500951 " really clean NAND erasing bad blocks (UNSAFE)\n"
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200952 "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
Balamanikandan Gunasundar4ea84c52021-06-29 12:46:11 +0530953 "nand biterr off bit - make a bit error at offset and bit position (UNSAFE)"
Nishanth Menon50657c22008-12-13 09:43:06 -0600954#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200955 "\n"
956 "nand lock [tight] [status]\n"
957 " bring nand to lock state or display locked pages\n"
Joe Hershbergereee623a2012-08-22 16:49:42 -0500958 "nand unlock[.allexcept] [offset] [size] - unlock section"
Nishanth Menon50657c22008-12-13 09:43:06 -0600959#endif
Ben Gardinerc9f73512010-07-05 13:27:07 -0400960#ifdef CONFIG_ENV_OFFSET_OOB
961 "\n"
962 "nand env.oob - environment offset in OOB of block 0 of"
963 " first device.\n"
964 "nand env.oob set off|partition - set enviromnent offset\n"
965 "nand env.oob get - get environment offset"
966#endif
Tom Rini36162182023-10-07 15:13:08 -0400967 );
Kim Phillips088f1b12012-10-29 13:34:31 +0000968
969U_BOOT_CMD(
970 nand, CONFIG_SYS_MAXARGS, 1, do_nand,
971 "NAND sub-system", nand_help_text
Nishanth Menon50657c22008-12-13 09:43:06 -0600972);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100973
Simon Glass09140112020-05-10 11:40:03 -0600974static int nand_load_image(struct cmd_tbl *cmdtp, struct mtd_info *mtd,
Wolfgang Denk4b070802008-08-14 14:41:06 +0200975 ulong offset, ulong addr, char *cmd)
Stefan Roese856f0542006-10-28 15:55:52 +0200976{
977 int r;
Mike Frysinger67d668b2011-06-05 13:43:02 +0000978 char *s;
Wolfgang Denk4ca79f42008-04-28 12:08:18 +0200979 size_t cnt;
Tom Rinic76c93a2019-05-23 07:14:07 -0400980#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Simon Glassf3543e62022-09-06 20:26:52 -0600981 struct legacy_img_hdr *hdr;
Heiko Schocher21d29f72014-05-28 11:33:33 +0200982#endif
Marian Balakowicz09475f72008-03-12 10:33:01 +0100983#if defined(CONFIG_FIT)
Marian Balakowicz3bab76a2008-06-06 23:07:40 +0200984 const void *fit_hdr = NULL;
Marian Balakowicz09475f72008-03-12 10:33:01 +0100985#endif
Thomas Knobloch10e03892007-07-06 14:58:39 +0200986
987 s = strchr(cmd, '.');
988 if (s != NULL &&
Scott Wood65d8bc92009-03-17 12:06:04 -0500989 (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
Scott Wood984e03c2008-06-12 13:13:23 -0500990 printf("Unknown nand load suffix '%s'\n", s);
Simon Glass770605e2012-02-13 13:51:18 +0000991 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
Scott Wood984e03c2008-06-12 13:13:23 -0500992 return 1;
993 }
Stefan Roese856f0542006-10-28 15:55:52 +0200994
Scott Wood151c06e2016-05-30 13:57:54 -0500995 printf("\nLoading from %s, offset 0x%lx\n", mtd->name, offset);
Stefan Roese856f0542006-10-28 15:55:52 +0200996
Scott Wood151c06e2016-05-30 13:57:54 -0500997 cnt = mtd->writesize;
998 r = nand_read_skip_bad(mtd, offset, &cnt, NULL, mtd->size,
999 (u_char *)addr);
Stefan Roese856f0542006-10-28 15:55:52 +02001000 if (r) {
1001 puts("** Read error\n");
Simon Glass770605e2012-02-13 13:51:18 +00001002 bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
Stefan Roese856f0542006-10-28 15:55:52 +02001003 return 1;
1004 }
Simon Glass770605e2012-02-13 13:51:18 +00001005 bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
Stefan Roese856f0542006-10-28 15:55:52 +02001006
Marian Balakowicz9a4daad2008-02-29 14:58:34 +01001007 switch (genimg_get_format ((void *)addr)) {
Tom Rinic76c93a2019-05-23 07:14:07 -04001008#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001009 case IMAGE_FORMAT_LEGACY:
Simon Glassf3543e62022-09-06 20:26:52 -06001010 hdr = (struct legacy_img_hdr *)addr;
Stefan Roese856f0542006-10-28 15:55:52 +02001011
Simon Glass770605e2012-02-13 13:51:18 +00001012 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001013 image_print_contents (hdr);
1014
1015 cnt = image_get_image_size (hdr);
1016 break;
Heiko Schocher21d29f72014-05-28 11:33:33 +02001017#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001018#if defined(CONFIG_FIT)
1019 case IMAGE_FORMAT_FIT:
Marian Balakowicz09475f72008-03-12 10:33:01 +01001020 fit_hdr = (const void *)addr;
Marian Balakowicz09475f72008-03-12 10:33:01 +01001021 puts ("Fit image detected...\n");
1022
1023 cnt = fit_get_size (fit_hdr);
1024 break;
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001025#endif
1026 default:
Simon Glass770605e2012-02-13 13:51:18 +00001027 bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +01001028 puts ("** Unknown image type\n");
Stefan Roese856f0542006-10-28 15:55:52 +02001029 return 1;
1030 }
Simon Glass770605e2012-02-13 13:51:18 +00001031 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
Stefan Roese856f0542006-10-28 15:55:52 +02001032
Scott Wood151c06e2016-05-30 13:57:54 -05001033 r = nand_read_skip_bad(mtd, offset, &cnt, NULL, mtd->size,
1034 (u_char *)addr);
Stefan Roese856f0542006-10-28 15:55:52 +02001035 if (r) {
1036 puts("** Read error\n");
Simon Glass770605e2012-02-13 13:51:18 +00001037 bootstage_error(BOOTSTAGE_ID_NAND_READ);
Stefan Roese856f0542006-10-28 15:55:52 +02001038 return 1;
1039 }
Simon Glass770605e2012-02-13 13:51:18 +00001040 bootstage_mark(BOOTSTAGE_ID_NAND_READ);
Stefan Roese856f0542006-10-28 15:55:52 +02001041
Marian Balakowicz09475f72008-03-12 10:33:01 +01001042#if defined(CONFIG_FIT)
1043 /* This cannot be done earlier, we need complete FIT image in RAM first */
Marian Balakowicz3bab76a2008-06-06 23:07:40 +02001044 if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
Simon Glassc5819702021-02-15 17:08:09 -07001045 if (fit_check_format(fit_hdr, IMAGE_SIZE_INVAL)) {
Simon Glass770605e2012-02-13 13:51:18 +00001046 bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
Marian Balakowicz3bab76a2008-06-06 23:07:40 +02001047 puts ("** Bad FIT image format\n");
1048 return 1;
1049 }
Simon Glass770605e2012-02-13 13:51:18 +00001050 bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
Marian Balakowicz3bab76a2008-06-06 23:07:40 +02001051 fit_print_contents (fit_hdr);
1052 }
Marian Balakowicz09475f72008-03-12 10:33:01 +01001053#endif
1054
Stefan Roese856f0542006-10-28 15:55:52 +02001055 /* Loading ok, update default load address */
1056
Simon Glassbb872dd2019-12-28 10:45:02 -07001057 image_load_addr = addr;
Stefan Roese856f0542006-10-28 15:55:52 +02001058
Mike Frysinger67d668b2011-06-05 13:43:02 +00001059 return bootm_maybe_autostart(cmdtp, cmd);
Stefan Roese856f0542006-10-28 15:55:52 +02001060}
1061
Simon Glass09140112020-05-10 11:40:03 -06001062static int do_nandboot(struct cmd_tbl *cmdtp, int flag, int argc,
1063 char *const argv[])
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001064{
1065 char *boot_device = NULL;
Stefan Roese856f0542006-10-28 15:55:52 +02001066 int idx;
1067 ulong addr, offset = 0;
Mugunthan V Nad92dff2017-06-26 19:12:51 -05001068 struct mtd_info *mtd;
Ladislav Michl0c8a8492009-04-21 02:26:31 +02001069#if defined(CONFIG_CMD_MTDPARTS)
Stefan Roese856f0542006-10-28 15:55:52 +02001070 struct mtd_device *dev;
1071 struct part_info *part;
1072 u8 pnum;
1073
1074 if (argc >= 2) {
1075 char *p = (argc == 2) ? argv[1] : argv[2];
1076 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
1077 (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
1078 if (dev->id->type != MTD_DEV_TYPE_NAND) {
1079 puts("Not a NAND device\n");
1080 return 1;
1081 }
1082 if (argc > 3)
1083 goto usage;
1084 if (argc == 3)
Simon Glass7e5f4602021-07-24 09:03:29 -06001085 addr = hextoul(argv[1], NULL);
Stefan Roese856f0542006-10-28 15:55:52 +02001086 else
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001087 addr = CONFIG_SYS_LOAD_ADDR;
Mugunthan V Nad92dff2017-06-26 19:12:51 -05001088
1089 mtd = get_nand_dev_by_index(dev->id->num);
1090 return nand_load_image(cmdtp, mtd, part->offset,
1091 addr, argv[0]);
Stefan Roese856f0542006-10-28 15:55:52 +02001092 }
1093 }
1094#endif
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001095
Simon Glass770605e2012-02-13 13:51:18 +00001096 bootstage_mark(BOOTSTAGE_ID_NAND_PART);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001097 switch (argc) {
1098 case 1:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001099 addr = CONFIG_SYS_LOAD_ADDR;
Simon Glass00caae62017-08-03 12:22:12 -06001100 boot_device = env_get("bootdevice");
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001101 break;
1102 case 2:
Simon Glass7e5f4602021-07-24 09:03:29 -06001103 addr = hextoul(argv[1], NULL);
Simon Glass00caae62017-08-03 12:22:12 -06001104 boot_device = env_get("bootdevice");
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001105 break;
1106 case 3:
Simon Glass7e5f4602021-07-24 09:03:29 -06001107 addr = hextoul(argv[1], NULL);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001108 boot_device = argv[2];
1109 break;
1110 case 4:
Simon Glass7e5f4602021-07-24 09:03:29 -06001111 addr = hextoul(argv[1], NULL);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001112 boot_device = argv[2];
Simon Glass7e5f4602021-07-24 09:03:29 -06001113 offset = hextoul(argv[3], NULL);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001114 break;
1115 default:
Ladislav Michl0c8a8492009-04-21 02:26:31 +02001116#if defined(CONFIG_CMD_MTDPARTS)
Stefan Roese856f0542006-10-28 15:55:52 +02001117usage:
1118#endif
Simon Glass770605e2012-02-13 13:51:18 +00001119 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
Simon Glass4c12eeb2011-12-10 08:44:01 +00001120 return CMD_RET_USAGE;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001121 }
Simon Glass770605e2012-02-13 13:51:18 +00001122 bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001123
1124 if (!boot_device) {
1125 puts("\n** No boot device **\n");
Simon Glass770605e2012-02-13 13:51:18 +00001126 bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001127 return 1;
1128 }
Simon Glass770605e2012-02-13 13:51:18 +00001129 bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001130
Simon Glass7e5f4602021-07-24 09:03:29 -06001131 idx = hextoul(boot_device, NULL);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001132
Mugunthan V Nad92dff2017-06-26 19:12:51 -05001133 mtd = get_nand_dev_by_index(idx);
1134 if (!mtd) {
Stefan Roese856f0542006-10-28 15:55:52 +02001135 printf("\n** Device %d not available\n", idx);
Simon Glass770605e2012-02-13 13:51:18 +00001136 bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001137 return 1;
1138 }
Simon Glass770605e2012-02-13 13:51:18 +00001139 bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001140
Mugunthan V Nad92dff2017-06-26 19:12:51 -05001141 return nand_load_image(cmdtp, mtd, offset, addr, argv[0]);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01001142}
1143
1144U_BOOT_CMD(nboot, 4, 1, do_nandboot,
Peter Tyser2fb26042009-01-27 18:03:12 -06001145 "boot from NAND device",
Wolfgang Denka89c33d2009-05-24 17:06:54 +02001146 "[partition] | [[[loadAddr] dev] offset]"
1147);