blob: fda4239fa792dfc677367fcac632a2b239a282a4 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0
Stefan Roesed351b2b2006-10-10 12:36:02 +02002/*
Miquel Raynal1f1ae152018-08-16 17:30:07 +02003 * drivers/mtd/nand/raw/nand_util.c
Stefan Roesed351b2b2006-10-10 12:36:02 +02004 *
5 * Copyright (C) 2006 by Weiss-Electronic GmbH.
6 * All rights reserved.
7 *
8 * @author: Guido Classen <clagix@gmail.com>
9 * @descr: NAND Flash support
10 * @references: borrowed heavily from Linux mtd-utils code:
11 * flash_eraseall.c by Arcom Control System Ltd
12 * nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
13 * and Thomas Gleixner (tglx@linutronix.de)
14 *
Ben Gardiner34dd5672011-06-14 16:35:06 -040015 * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
16 * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
17 *
Tom Rinib7bef6a2013-10-31 09:24:00 -040018 * Copyright 2010 Freescale Semiconductor
Stefan Roesed351b2b2006-10-10 12:36:02 +020019 */
20
Stefan Roesed351b2b2006-10-10 12:36:02 +020021#include <command.h>
Simon Glass0f2af882020-05-10 11:40:05 -060022#include <log.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020023#include <watchdog.h>
24#include <malloc.h>
Simon Glassa87fc0a2015-09-02 17:24:57 -060025#include <memalign.h>
Dirk Behme32d1f762007-08-02 17:42:08 +020026#include <div64.h>
Simon Glass274e0b02020-05-10 11:39:56 -060027#include <asm/cache.h>
Simon Glassd66c5f72020-02-03 07:36:15 -070028#include <dm/devres.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020029
Masahiro Yamada56a931c2016-09-21 11:28:55 +090030#include <linux/errno.h>
William Juul52c07962007-10-31 13:53:06 +010031#include <linux/mtd/mtd.h>
Tom Rini3bde7e22021-09-22 14:50:35 -040032#include <linux/mtd/rawnand.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020033#include <nand.h>
34#include <jffs2/jffs2.h>
35
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000036typedef struct erase_info erase_info_t;
37typedef struct mtd_info mtd_info_t;
Stefan Roesed351b2b2006-10-10 12:36:02 +020038
39/* support only for native endian JFFS2 */
40#define cpu_to_je16(x) (x)
41#define cpu_to_je32(x) (x)
42
Stefan Roesed351b2b2006-10-10 12:36:02 +020043/**
44 * nand_erase_opts: - erase NAND flash with support for various options
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000045 * (jffs2 formatting)
Stefan Roesed351b2b2006-10-10 12:36:02 +020046 *
Scott Wood08364d92016-05-30 13:57:54 -050047 * @param mtd nand mtd instance to erase
Stefan Roesed351b2b2006-10-10 12:36:02 +020048 * @param opts options, @see struct nand_erase_options
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +010049 * Return: 0 in case of success
Stefan Roesed351b2b2006-10-10 12:36:02 +020050 *
51 * This code is ported from flash_eraseall.c from Linux mtd utils by
52 * Arcom Control System Ltd.
53 */
Scott Wood08364d92016-05-30 13:57:54 -050054int nand_erase_opts(struct mtd_info *mtd,
55 const nand_erase_options_t *opts)
Stefan Roesed351b2b2006-10-10 12:36:02 +020056{
57 struct jffs2_unknown_node cleanmarker;
Stefan Roesed351b2b2006-10-10 12:36:02 +020058 erase_info_t erase;
Scott Wood1b5cd512010-08-25 14:43:29 -050059 unsigned long erase_length, erased_length; /* in blocks */
Stefan Roesed351b2b2006-10-10 12:36:02 +020060 int result;
61 int percent_complete = -1;
Scott Wood08364d92016-05-30 13:57:54 -050062 const char *mtd_device = mtd->name;
William Juul52c07962007-10-31 13:53:06 +010063 struct mtd_oob_ops oob_opts;
Scott Wood17fed142016-05-30 13:57:56 -050064 struct nand_chip *chip = mtd_to_nand(mtd);
Stefan Roesed351b2b2006-10-10 12:36:02 +020065
Scott Wood08364d92016-05-30 13:57:54 -050066 if ((opts->offset & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeauad5d6ee2012-11-05 10:16:15 +000067 printf("Attempt to erase non block-aligned data\n");
Scott Wood1b5cd512010-08-25 14:43:29 -050068 return -1;
69 }
70
Stefan Roesed351b2b2006-10-10 12:36:02 +020071 memset(&erase, 0, sizeof(erase));
William Juul52c07962007-10-31 13:53:06 +010072 memset(&oob_opts, 0, sizeof(oob_opts));
Stefan Roesed351b2b2006-10-10 12:36:02 +020073
Scott Wood08364d92016-05-30 13:57:54 -050074 erase.mtd = mtd;
75 erase.len = mtd->erasesize;
Stefan Roese198b23e2006-10-28 15:55:52 +020076 erase.addr = opts->offset;
Scott Wood08364d92016-05-30 13:57:54 -050077 erase_length = lldiv(opts->length + mtd->erasesize - 1,
78 mtd->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +020079
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000080 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
81 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
William Juul52c07962007-10-31 13:53:06 +010082 cleanmarker.totlen = cpu_to_je32(8);
Stefan Roesed351b2b2006-10-10 12:36:02 +020083
84 /* scrub option allows to erase badblock. To prevent internal
85 * check from erase() method, set block check method to dummy
86 * and disable bad block table while erasing.
87 */
88 if (opts->scrub) {
Marek Vasut971d9a12011-09-12 06:04:06 +020089 erase.scrub = opts->scrub;
90 /*
91 * We don't need the bad block table anymore...
Stefan Roesed351b2b2006-10-10 12:36:02 +020092 * after scrub, there are no bad blocks left!
93 */
Marek Vasut971d9a12011-09-12 06:04:06 +020094 if (chip->bbt) {
95 kfree(chip->bbt);
Stefan Roesed351b2b2006-10-10 12:36:02 +020096 }
Marek Vasut971d9a12011-09-12 06:04:06 +020097 chip->bbt = NULL;
Masahiro Yamada8d100542014-12-26 22:20:58 +090098 chip->options &= ~NAND_BBT_SCANNED;
Stefan Roesed351b2b2006-10-10 12:36:02 +020099 }
100
Scott Wood1b5cd512010-08-25 14:43:29 -0500101 for (erased_length = 0;
102 erased_length < erase_length;
Scott Wood08364d92016-05-30 13:57:54 -0500103 erase.addr += mtd->erasesize) {
William Juulb76ec382007-11-08 10:39:53 +0100104
Stefan Roese80877fa2022-09-02 14:10:46 +0200105 schedule();
Stefan Roesed351b2b2006-10-10 12:36:02 +0200106
Heiko Schocher0ae98b42013-06-24 18:50:40 +0200107 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
108 puts("Size of erase exceeds limit\n");
109 return -EFBIG;
110 }
Masahiro Yamada7580d582013-07-12 10:53:37 +0900111 if (!opts->scrub) {
Scott Wood08364d92016-05-30 13:57:54 -0500112 int ret = mtd_block_isbad(mtd, erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200113 if (ret > 0) {
114 if (!opts->quiet)
Michael Trimarchia9675582023-02-27 16:01:43 +0100115 printf("\rSkipping %s at "
Stefan Roese586b3a62009-05-11 16:03:55 +0200116 "0x%08llx "
Wolfgang Denkd5cf1a42006-10-12 11:43:47 +0200117 " \n",
Michael Trimarchia9675582023-02-27 16:01:43 +0100118 ret == 1 ? "bad block" : "bbt reserved",
Wolfgang Denkd5cf1a42006-10-12 11:43:47 +0200119 erase.addr);
Scott Wood1b5cd512010-08-25 14:43:29 -0500120
121 if (!opts->spread)
122 erased_length++;
123
Stefan Roesed351b2b2006-10-10 12:36:02 +0200124 continue;
125
126 } else if (ret < 0) {
127 printf("\n%s: MTD get bad block failed: %d\n",
128 mtd_device,
129 ret);
130 return -1;
131 }
132 }
133
Scott Wood1b5cd512010-08-25 14:43:29 -0500134 erased_length++;
135
Scott Wood08364d92016-05-30 13:57:54 -0500136 result = mtd_erase(mtd, &erase);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200137 if (result != 0) {
138 printf("\n%s: MTD Erase failure: %d\n",
139 mtd_device, result);
140 continue;
141 }
142
143 /* format for JFFS2 ? */
Scott Woodd50ad352008-10-29 14:20:26 -0500144 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000145 struct mtd_oob_ops ops;
146 ops.ooblen = 8;
147 ops.datbuf = NULL;
148 ops.oobbuf = (uint8_t *)&cleanmarker;
149 ops.ooboffs = 0;
150 ops.mode = MTD_OPS_AUTO_OOB;
William Juulb76ec382007-11-08 10:39:53 +0100151
Scott Wood08364d92016-05-30 13:57:54 -0500152 result = mtd_write_oob(mtd, erase.addr, &ops);
William Juul52c07962007-10-31 13:53:06 +0100153 if (result != 0) {
154 printf("\n%s: MTD writeoob failure: %d\n",
Scott Woodd50ad352008-10-29 14:20:26 -0500155 mtd_device, result);
William Juul52c07962007-10-31 13:53:06 +0100156 continue;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200157 }
158 }
159
160 if (!opts->quiet) {
Scott Wood1b5cd512010-08-25 14:43:29 -0500161 unsigned long long n = erased_length * 100ULL;
Matthias Fuchs82714b92007-09-11 17:04:00 +0200162 int percent;
163
164 do_div(n, erase_length);
165 percent = (int)n;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200166
167 /* output progress message only at whole percent
168 * steps to reduce the number of messages printed
169 * on (slow) serial consoles
170 */
171 if (percent != percent_complete) {
172 percent_complete = percent;
173
Stefan Roese586b3a62009-05-11 16:03:55 +0200174 printf("\rErasing at 0x%llx -- %3d%% complete.",
Scott Woodd50ad352008-10-29 14:20:26 -0500175 erase.addr, percent);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200176
177 if (opts->jffs2 && result == 0)
Stefan Roese586b3a62009-05-11 16:03:55 +0200178 printf(" Cleanmarker written at 0x%llx.",
Scott Woodd50ad352008-10-29 14:20:26 -0500179 erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200180 }
181 }
182 }
183 if (!opts->quiet)
184 printf("\n");
185
Stefan Roesed351b2b2006-10-10 12:36:02 +0200186 return 0;
187}
188
Nishanth Menonb20f8402008-12-13 09:43:06 -0600189#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
190
Heiko Schocherf5895d12014-06-24 10:10:04 +0200191#define NAND_CMD_LOCK_TIGHT 0x2c
192#define NAND_CMD_LOCK_STATUS 0x7a
Wolfgang Denk9d328a62021-09-27 17:42:38 +0200193
Stefan Roesed351b2b2006-10-10 12:36:02 +0200194/******************************************************************************
195 * Support for locking / unlocking operations of some NAND devices
196 *****************************************************************************/
197
Stefan Roesed351b2b2006-10-10 12:36:02 +0200198/**
199 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
200 * state
201 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600202 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200203 * @param tight bring device in lock tight mode
204 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100205 * Return: 0 on success, -1 in case of error
Stefan Roesed351b2b2006-10-10 12:36:02 +0200206 *
207 * The lock / lock-tight command only applies to the whole chip. To get some
208 * parts of the chip lock and others unlocked use the following sequence:
209 *
210 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
211 * - Call nand_unlock() once for each consecutive area to be unlocked
212 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
213 *
214 * If the device is in lock-tight state software can't change the
215 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
216 * calls will fail. It is only posible to leave lock-tight state by
217 * an hardware signal (low pulse on _WP pin) or by power down.
218 */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600219int nand_lock(struct mtd_info *mtd, int tight)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200220{
221 int ret = 0;
222 int status;
Scott Wood17fed142016-05-30 13:57:56 -0500223 struct nand_chip *chip = mtd_to_nand(mtd);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200224
225 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600226 chip->select_chip(mtd, 0);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200227
Joe Hershberger8b177d42013-02-08 09:27:19 +0000228 /* check the Lock Tight Status */
229 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
230 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
231 printf("nand_lock: Device is locked tight!\n");
232 ret = -1;
233 goto out;
234 }
235
Nishanth Menonb20f8402008-12-13 09:43:06 -0600236 chip->cmdfunc(mtd,
Stefan Roesed351b2b2006-10-10 12:36:02 +0200237 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
238 -1, -1);
239
240 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600241 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200242
243 /* see if device thinks it succeeded */
244 if (status & 0x01) {
245 ret = -1;
246 }
247
Joe Hershberger8b177d42013-02-08 09:27:19 +0000248 out:
Stefan Roesed351b2b2006-10-10 12:36:02 +0200249 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600250 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200251 return ret;
252}
253
254/**
255 * nand_get_lock_status: - query current lock state from one page of NAND
256 * flash
257 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600258 * @param mtd nand mtd instance
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000259 * @param offset page address to query (must be page-aligned!)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200260 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100261 * Return: -1 in case of error
Stefan Roesed351b2b2006-10-10 12:36:02 +0200262 * >0 lock status:
263 * bitfield with the following combinations:
264 * NAND_LOCK_STATUS_TIGHT: page in tight state
Stefan Roesed351b2b2006-10-10 12:36:02 +0200265 * NAND_LOCK_STATUS_UNLOCK: page unlocked
266 *
267 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200268int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200269{
270 int ret = 0;
271 int chipnr;
272 int page;
Scott Wood17fed142016-05-30 13:57:56 -0500273 struct nand_chip *chip = mtd_to_nand(mtd);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200274
275 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600276 chipnr = (int)(offset >> chip->chip_shift);
277 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200278
279
Nishanth Menonb20f8402008-12-13 09:43:06 -0600280 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000281 printf("nand_get_lock_status: "
Stefan Roesed351b2b2006-10-10 12:36:02 +0200282 "Start address must be beginning of "
283 "nand page!\n");
284 ret = -1;
285 goto out;
286 }
287
288 /* check the Lock Status */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600289 page = (int)(offset >> chip->page_shift);
290 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200291
Nishanth Menonb20f8402008-12-13 09:43:06 -0600292 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
Stefan Roesed351b2b2006-10-10 12:36:02 +0200293 | NAND_LOCK_STATUS_UNLOCK);
294
295 out:
296 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600297 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200298 return ret;
299}
300
301/**
302 * nand_unlock: - Unlock area of NAND pages
303 * only one consecutive area can be unlocked at one time!
304 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600305 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200306 * @param start start byte address
307 * @param length number of bytes to unlock (must be a multiple of
Scott Wood08364d92016-05-30 13:57:54 -0500308 * page size mtd->writesize)
Joe Hershbergercccf5952012-08-22 16:49:42 -0500309 * @param allexcept if set, unlock everything not selected
Stefan Roesed351b2b2006-10-10 12:36:02 +0200310 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100311 * Return: 0 on success, -1 in case of error
Stefan Roesed351b2b2006-10-10 12:36:02 +0200312 */
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500313int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
314 int allexcept)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200315{
316 int ret = 0;
317 int chipnr;
318 int status;
319 int page;
Scott Wood17fed142016-05-30 13:57:56 -0500320 struct nand_chip *chip = mtd_to_nand(mtd);
Joe Hershbergercccf5952012-08-22 16:49:42 -0500321
Tom Rini8e40bf62013-12-16 09:59:34 -0500322 debug("nand_unlock%s: start: %08llx, length: %zd!\n",
Joe Hershbergercccf5952012-08-22 16:49:42 -0500323 allexcept ? " (allexcept)" : "", start, length);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200324
325 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600326 chipnr = (int)(start >> chip->chip_shift);
327 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200328
329 /* check the WP bit */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600330 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
331 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000332 printf("nand_unlock: Device is write protected!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200333 ret = -1;
334 goto out;
335 }
336
Joe Hershberger8b177d42013-02-08 09:27:19 +0000337 /* check the Lock Tight Status */
338 page = (int)(start >> chip->page_shift);
339 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
340 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
341 printf("nand_unlock: Device is locked tight!\n");
342 ret = -1;
343 goto out;
344 }
345
Nishanth Menonb20f8402008-12-13 09:43:06 -0600346 if ((start & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000347 printf("nand_unlock: Start address must be beginning of "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600348 "nand block!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200349 ret = -1;
350 goto out;
351 }
352
Nishanth Menonb20f8402008-12-13 09:43:06 -0600353 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000354 printf("nand_unlock: Length must be a multiple of nand block "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600355 "size %08x!\n", mtd->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200356 ret = -1;
357 goto out;
358 }
359
Nishanth Menonb20f8402008-12-13 09:43:06 -0600360 /*
361 * Set length so that the last address is set to the
362 * starting address of the last block
363 */
364 length -= mtd->erasesize;
365
Stefan Roesed351b2b2006-10-10 12:36:02 +0200366 /* submit address of first page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600367 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200368
369 /* submit ADDRESS of LAST page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600370 page += (int)(length >> chip->page_shift);
Joe Hershbergercccf5952012-08-22 16:49:42 -0500371
372 /*
373 * Page addresses for unlocking are supposed to be block-aligned.
374 * At least some NAND chips use the low bit to indicate that the
375 * page range should be inverted.
376 */
377 if (allexcept)
378 page |= 1;
379
Nishanth Menonb20f8402008-12-13 09:43:06 -0600380 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200381
382 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600383 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200384 /* see if device thinks it succeeded */
385 if (status & 0x01) {
386 /* there was an error */
387 ret = -1;
388 goto out;
389 }
390
391 out:
392 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600393 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200394 return ret;
395}
William Juul52c07962007-10-31 13:53:06 +0100396#endif
Stefan Roesed351b2b2006-10-10 12:36:02 +0200397
Scott Woodcc5f3392008-06-12 13:20:16 -0500398/**
Scott Woodfe3b5e12010-07-30 16:11:41 -0500399 * check_skip_len
Scott Woodcc5f3392008-06-12 13:20:16 -0500400 *
Scott Woodfe3b5e12010-07-30 16:11:41 -0500401 * Check if there are any bad blocks, and whether length including bad
402 * blocks fits into device
Scott Woodcc5f3392008-06-12 13:20:16 -0500403 *
Scott Wood08364d92016-05-30 13:57:54 -0500404 * @param mtd nand mtd instance
Scott Woodcc5f3392008-06-12 13:20:16 -0500405 * @param offset offset in flash
406 * @param length image length
Tom Rini32d96182013-03-14 05:32:50 +0000407 * @param used length of flash needed for the requested length
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100408 * Return: 0 if the image fits and there are no bad blocks
Scott Woodfe3b5e12010-07-30 16:11:41 -0500409 * 1 if the image fits, but there are bad blocks
410 * -1 if the image does not fit
Scott Woodcc5f3392008-06-12 13:20:16 -0500411 */
Scott Wood08364d92016-05-30 13:57:54 -0500412static int check_skip_len(struct mtd_info *mtd, loff_t offset, size_t length,
413 size_t *used)
Scott Woodcc5f3392008-06-12 13:20:16 -0500414{
Scott Woodcc5f3392008-06-12 13:20:16 -0500415 size_t len_excl_bad = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500416 int ret = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500417
418 while (len_excl_bad < length) {
Scott Woodfe3b5e12010-07-30 16:11:41 -0500419 size_t block_len, block_off;
420 loff_t block_start;
Scott Woodcc5f3392008-06-12 13:20:16 -0500421
Scott Wood08364d92016-05-30 13:57:54 -0500422 if (offset >= mtd->size)
Scott Woodfe3b5e12010-07-30 16:11:41 -0500423 return -1;
Scott Woodcc5f3392008-06-12 13:20:16 -0500424
Scott Wood08364d92016-05-30 13:57:54 -0500425 block_start = offset & ~(loff_t)(mtd->erasesize - 1);
426 block_off = offset & (mtd->erasesize - 1);
427 block_len = mtd->erasesize - block_off;
Scott Woodcc5f3392008-06-12 13:20:16 -0500428
Scott Wood08364d92016-05-30 13:57:54 -0500429 if (!nand_block_isbad(mtd, block_start))
Scott Woodfe3b5e12010-07-30 16:11:41 -0500430 len_excl_bad += block_len;
431 else
432 ret = 1;
433
434 offset += block_len;
Tom Rini32d96182013-03-14 05:32:50 +0000435 *used += block_len;
Scott Woodcc5f3392008-06-12 13:20:16 -0500436 }
437
Tom Rini32d96182013-03-14 05:32:50 +0000438 /* If the length is not a multiple of block_len, adjust. */
439 if (len_excl_bad > length)
440 *used -= (len_excl_bad - length);
441
Scott Woodfe3b5e12010-07-30 16:11:41 -0500442 return ret;
Scott Woodcc5f3392008-06-12 13:20:16 -0500443}
Ben Gardiner34dd5672011-06-14 16:35:06 -0400444
445#ifdef CONFIG_CMD_NAND_TRIMFFS
Scott Wood08364d92016-05-30 13:57:54 -0500446static size_t drop_ffs(const struct mtd_info *mtd, const u_char *buf,
Ben Gardiner34dd5672011-06-14 16:35:06 -0400447 const size_t *len)
448{
htbegin610e8552013-03-01 23:00:34 +0000449 size_t l = *len;
450 ssize_t i;
Ben Gardiner34dd5672011-06-14 16:35:06 -0400451
452 for (i = l - 1; i >= 0; i--)
453 if (buf[i] != 0xFF)
454 break;
455
456 /* The resulting length must be aligned to the minimum flash I/O size */
457 l = i + 1;
Scott Wood08364d92016-05-30 13:57:54 -0500458 l = (l + mtd->writesize - 1) / mtd->writesize;
459 l *= mtd->writesize;
Ben Gardiner34dd5672011-06-14 16:35:06 -0400460
461 /*
462 * since the input length may be unaligned, prevent access past the end
463 * of the buffer
464 */
465 return min(l, *len);
466}
467#endif
Scott Woodcc5f3392008-06-12 13:20:16 -0500468
469/**
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600470 * nand_verify_page_oob:
471 *
472 * Verify a page of NAND flash, including the OOB.
473 * Reads page of NAND and verifies the contents and OOB against the
474 * values in ops.
475 *
Scott Wood08364d92016-05-30 13:57:54 -0500476 * @param mtd nand mtd instance
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600477 * @param ops MTD operations, including data to verify
478 * @param ofs offset in flash
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100479 * Return: 0 in case of success
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600480 */
Scott Wood08364d92016-05-30 13:57:54 -0500481int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
482 loff_t ofs)
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600483{
484 int rval;
485 struct mtd_oob_ops vops;
Scott Wood08364d92016-05-30 13:57:54 -0500486 size_t verlen = mtd->writesize + mtd->oobsize;
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600487
488 memcpy(&vops, ops, sizeof(vops));
489
Stephen Warren12db8182015-04-14 08:59:00 -0600490 vops.datbuf = memalign(ARCH_DMA_MINALIGN, verlen);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600491
492 if (!vops.datbuf)
493 return -ENOMEM;
494
Scott Wood08364d92016-05-30 13:57:54 -0500495 vops.oobbuf = vops.datbuf + mtd->writesize;
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600496
Scott Wood08364d92016-05-30 13:57:54 -0500497 rval = mtd_read_oob(mtd, ofs, &vops);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600498 if (!rval)
499 rval = memcmp(ops->datbuf, vops.datbuf, vops.len);
500 if (!rval)
501 rval = memcmp(ops->oobbuf, vops.oobbuf, vops.ooblen);
502
503 free(vops.datbuf);
504
505 return rval ? -EIO : 0;
506}
507
508/**
509 * nand_verify:
510 *
511 * Verify a region of NAND flash.
512 * Reads NAND in page-sized chunks and verifies the contents against
513 * the contents of a buffer. The offset into the NAND must be
514 * page-aligned, and the function doesn't handle skipping bad blocks.
515 *
Scott Wood08364d92016-05-30 13:57:54 -0500516 * @param mtd nand mtd instance
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600517 * @param ofs offset in flash
518 * @param len buffer length
519 * @param buf buffer to read from
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100520 * Return: 0 in case of success
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600521 */
Scott Wood08364d92016-05-30 13:57:54 -0500522int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600523{
524 int rval = 0;
525 size_t verofs;
Scott Wood08364d92016-05-30 13:57:54 -0500526 size_t verlen = mtd->writesize;
Stephen Warren12db8182015-04-14 08:59:00 -0600527 uint8_t *verbuf = memalign(ARCH_DMA_MINALIGN, verlen);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600528
529 if (!verbuf)
530 return -ENOMEM;
531
532 /* Read the NAND back in page-size groups to limit malloc size */
533 for (verofs = ofs; verofs < ofs + len;
534 verofs += verlen, buf += verlen) {
Scott Wood08364d92016-05-30 13:57:54 -0500535 verlen = min(mtd->writesize, (uint32_t)(ofs + len - verofs));
536 rval = nand_read(mtd, verofs, &verlen, verbuf);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600537 if (!rval || (rval == -EUCLEAN))
538 rval = memcmp(buf, verbuf, verlen);
539
540 if (rval)
541 break;
542 }
543
544 free(verbuf);
545
546 return rval ? -EIO : 0;
547}
548
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600549/**
Scott Woodcc5f3392008-06-12 13:20:16 -0500550 * nand_write_skip_bad:
551 *
552 * Write image to NAND flash.
553 * Blocks that are marked bad are skipped and the is written to the next
554 * block instead as long as the image is short enough to fit even after
Tom Rini32d96182013-03-14 05:32:50 +0000555 * skipping the bad blocks. Due to bad blocks we may not be able to
556 * perform the requested write. In the case where the write would
557 * extend beyond the end of the NAND device, both length and actual (if
558 * not NULL) are set to 0. In the case where the write would extend
559 * beyond the limit we are passed, length is set to 0 and actual is set
560 * to the required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500561 *
Scott Wood08364d92016-05-30 13:57:54 -0500562 * @param mtd nand mtd instance
Scott Woodcc5f3392008-06-12 13:20:16 -0500563 * @param offset offset in flash
564 * @param length buffer length
Tom Rini32d96182013-03-14 05:32:50 +0000565 * @param actual set to size required to write length worth of
566 * buffer or 0 on error, if not NULL
567 * @param lim maximum size that actual may be in order to not
568 * exceed the buffer
Lei Wen4b5deaa2011-01-06 11:11:58 +0800569 * @param buffer buffer to read from
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400570 * @param flags flags modifying the behaviour of the write to NAND
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100571 * Return: 0 in case of success
Scott Woodcc5f3392008-06-12 13:20:16 -0500572 */
Scott Wood08364d92016-05-30 13:57:54 -0500573int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
574 size_t *actual, loff_t lim, u_char *buffer, int flags)
Scott Woodcc5f3392008-06-12 13:20:16 -0500575{
Lei Wen4b5deaa2011-01-06 11:11:58 +0800576 int rval = 0, blocksize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500577 size_t left_to_write = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000578 size_t used_for_write = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500579 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500580 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500581
Tom Rini32d96182013-03-14 05:32:50 +0000582 if (actual)
583 *actual = 0;
584
Scott Wood08364d92016-05-30 13:57:54 -0500585 blocksize = mtd->erasesize;
Lei Wen4b5deaa2011-01-06 11:11:58 +0800586
Scott Woodfe3b5e12010-07-30 16:11:41 -0500587 /*
588 * nand_write() handles unaligned, partial page writes.
589 *
590 * We allow length to be unaligned, for convenience in
591 * using the $filesize variable.
592 *
593 * However, starting at an unaligned offset makes the
594 * semantics of bad block skipping ambiguous (really,
595 * you should only start a block skipping access at a
596 * partition boundary). So don't try to handle that.
597 */
Scott Wood08364d92016-05-30 13:57:54 -0500598 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000599 printf("Attempt to write non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500600 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500601 return -EINVAL;
602 }
603
Scott Wood08364d92016-05-30 13:57:54 -0500604 need_skip = check_skip_len(mtd, offset, *length, &used_for_write);
Tom Rini32d96182013-03-14 05:32:50 +0000605
606 if (actual)
607 *actual = used_for_write;
608
Scott Woodfe3b5e12010-07-30 16:11:41 -0500609 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000610 printf("Attempt to write outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500611 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500612 return -EINVAL;
613 }
614
Tom Rini32d96182013-03-14 05:32:50 +0000615 if (used_for_write > lim) {
616 puts("Size of write exceeds partition or device limit\n");
617 *length = 0;
618 return -EFBIG;
619 }
620
Ben Gardiner34dd5672011-06-14 16:35:06 -0400621 if (!need_skip && !(flags & WITH_DROP_FFS)) {
Scott Wood08364d92016-05-30 13:57:54 -0500622 rval = nand_write(mtd, offset, length, buffer);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600623
624 if ((flags & WITH_WR_VERIFY) && !rval)
Scott Wood08364d92016-05-30 13:57:54 -0500625 rval = nand_verify(mtd, offset, *length, buffer);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600626
Scott Woodfe3b5e12010-07-30 16:11:41 -0500627 if (rval == 0)
628 return 0;
Scott Wood90e0a6b2008-11-25 10:47:02 -0600629
Scott Woodfe3b5e12010-07-30 16:11:41 -0500630 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000631 printf("NAND write to offset %llx failed %d\n",
Scott Woodfe3b5e12010-07-30 16:11:41 -0500632 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600633 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500634 }
635
636 while (left_to_write > 0) {
T Karthik Reddy63a95ab2020-08-31 14:27:37 +0200637 loff_t block_start = offset & ~(loff_t)(mtd->erasesize - 1);
Scott Wood08364d92016-05-30 13:57:54 -0500638 size_t block_offset = offset & (mtd->erasesize - 1);
Ben Gardiner34dd5672011-06-14 16:35:06 -0400639 size_t write_size, truncated_write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500640
Stefan Roese80877fa2022-09-02 14:10:46 +0200641 schedule();
Giulio Benetti749bd662009-07-31 17:30:34 -0500642
T Karthik Reddy63a95ab2020-08-31 14:27:37 +0200643 if (nand_block_isbad(mtd, block_start)) {
644 printf("Skip bad block 0x%08llx\n", block_start);
Scott Wood08364d92016-05-30 13:57:54 -0500645 offset += mtd->erasesize - block_offset;
Scott Woodcc5f3392008-06-12 13:20:16 -0500646 continue;
647 }
648
Lei Wen4b5deaa2011-01-06 11:11:58 +0800649 if (left_to_write < (blocksize - block_offset))
Scott Woodcc5f3392008-06-12 13:20:16 -0500650 write_size = left_to_write;
651 else
Lei Wen4b5deaa2011-01-06 11:11:58 +0800652 write_size = blocksize - block_offset;
653
Peter Tyserae6ad782015-02-03 11:58:16 -0600654 truncated_write_size = write_size;
Ben Gardiner34dd5672011-06-14 16:35:06 -0400655#ifdef CONFIG_CMD_NAND_TRIMFFS
Peter Tyserae6ad782015-02-03 11:58:16 -0600656 if (flags & WITH_DROP_FFS)
Scott Wood08364d92016-05-30 13:57:54 -0500657 truncated_write_size = drop_ffs(mtd, p_buffer,
Peter Tyserae6ad782015-02-03 11:58:16 -0600658 &write_size);
Ben Gardiner34dd5672011-06-14 16:35:06 -0400659#endif
660
Scott Wood08364d92016-05-30 13:57:54 -0500661 rval = nand_write(mtd, offset, &truncated_write_size,
Peter Tyserae6ad782015-02-03 11:58:16 -0600662 p_buffer);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600663
Peter Tyserae6ad782015-02-03 11:58:16 -0600664 if ((flags & WITH_WR_VERIFY) && !rval)
Scott Wood08364d92016-05-30 13:57:54 -0500665 rval = nand_verify(mtd, offset,
Peter Tyserae6ad782015-02-03 11:58:16 -0600666 truncated_write_size, p_buffer);
Peter Tyserc9d92cf2015-02-03 11:58:12 -0600667
Peter Tyserae6ad782015-02-03 11:58:16 -0600668 offset += write_size;
669 p_buffer += write_size;
Lei Wen4b5deaa2011-01-06 11:11:58 +0800670
Scott Woodcc5f3392008-06-12 13:20:16 -0500671 if (rval != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000672 printf("NAND write to offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200673 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500674 *length -= left_to_write;
675 return rval;
676 }
677
678 left_to_write -= write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500679 }
680
681 return 0;
682}
683
684/**
685 * nand_read_skip_bad:
686 *
687 * Read image from NAND flash.
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000688 * Blocks that are marked bad are skipped and the next block is read
Tom Rini32d96182013-03-14 05:32:50 +0000689 * instead as long as the image is short enough to fit even after
690 * skipping the bad blocks. Due to bad blocks we may not be able to
691 * perform the requested read. In the case where the read would extend
692 * beyond the end of the NAND device, both length and actual (if not
693 * NULL) are set to 0. In the case where the read would extend beyond
694 * the limit we are passed, length is set to 0 and actual is set to the
695 * required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500696 *
Scott Wood08364d92016-05-30 13:57:54 -0500697 * @param mtd nand mtd instance
Scott Woodcc5f3392008-06-12 13:20:16 -0500698 * @param offset offset in flash
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000699 * @param length buffer length, on return holds number of read bytes
Tom Rini32d96182013-03-14 05:32:50 +0000700 * @param actual set to size required to read length worth of buffer or 0
701 * on error, if not NULL
702 * @param lim maximum size that actual may be in order to not exceed the
703 * buffer
Scott Woodcc5f3392008-06-12 13:20:16 -0500704 * @param buffer buffer to write to
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100705 * Return: 0 in case of success
Scott Woodcc5f3392008-06-12 13:20:16 -0500706 */
Scott Wood08364d92016-05-30 13:57:54 -0500707int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
708 size_t *actual, loff_t lim, u_char *buffer)
Scott Woodcc5f3392008-06-12 13:20:16 -0500709{
710 int rval;
711 size_t left_to_read = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000712 size_t used_for_read = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500713 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500714 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500715
Scott Wood08364d92016-05-30 13:57:54 -0500716 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000717 printf("Attempt to read non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500718 *length = 0;
Tom Rini32d96182013-03-14 05:32:50 +0000719 if (actual)
720 *actual = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500721 return -EINVAL;
722 }
Scott Woodcc5f3392008-06-12 13:20:16 -0500723
Scott Wood08364d92016-05-30 13:57:54 -0500724 need_skip = check_skip_len(mtd, offset, *length, &used_for_read);
Tom Rini32d96182013-03-14 05:32:50 +0000725
726 if (actual)
727 *actual = used_for_read;
728
Scott Woodfe3b5e12010-07-30 16:11:41 -0500729 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000730 printf("Attempt to read outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500731 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500732 return -EINVAL;
733 }
734
Tom Rini32d96182013-03-14 05:32:50 +0000735 if (used_for_read > lim) {
736 puts("Size of read exceeds partition or device limit\n");
737 *length = 0;
738 return -EFBIG;
739 }
740
Scott Woodfe3b5e12010-07-30 16:11:41 -0500741 if (!need_skip) {
Scott Wood08364d92016-05-30 13:57:54 -0500742 rval = nand_read(mtd, offset, length, buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300743 if (!rval || rval == -EUCLEAN)
744 return 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500745
746 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000747 printf("NAND read from offset %llx failed %d\n",
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300748 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600749 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500750 }
751
752 while (left_to_read > 0) {
Scott Wood08364d92016-05-30 13:57:54 -0500753 size_t block_offset = offset & (mtd->erasesize - 1);
Scott Woodcc5f3392008-06-12 13:20:16 -0500754 size_t read_length;
755
Stefan Roese80877fa2022-09-02 14:10:46 +0200756 schedule();
Giulio Benetti749bd662009-07-31 17:30:34 -0500757
Scott Wood08364d92016-05-30 13:57:54 -0500758 if (nand_block_isbad(mtd, offset & ~(mtd->erasesize - 1))) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000759 printf("Skipping bad block 0x%08llx\n",
Scott Wood08364d92016-05-30 13:57:54 -0500760 offset & ~(mtd->erasesize - 1));
761 offset += mtd->erasesize - block_offset;
Scott Woodcc5f3392008-06-12 13:20:16 -0500762 continue;
763 }
764
Scott Wood08364d92016-05-30 13:57:54 -0500765 if (left_to_read < (mtd->erasesize - block_offset))
Scott Woodcc5f3392008-06-12 13:20:16 -0500766 read_length = left_to_read;
767 else
Scott Wood08364d92016-05-30 13:57:54 -0500768 read_length = mtd->erasesize - block_offset;
Scott Woodcc5f3392008-06-12 13:20:16 -0500769
Scott Wood08364d92016-05-30 13:57:54 -0500770 rval = nand_read(mtd, offset, &read_length, p_buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300771 if (rval && rval != -EUCLEAN) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000772 printf("NAND read from offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200773 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500774 *length -= left_to_read;
775 return rval;
776 }
777
778 left_to_read -= read_length;
779 offset += read_length;
780 p_buffer += read_length;
781 }
782
783 return 0;
784}
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100785
786#ifdef CONFIG_CMD_NAND_TORTURE
787
788/**
789 * check_pattern:
790 *
791 * Check if buffer contains only a certain byte pattern.
792 *
793 * @param buf buffer to check
794 * @param patt the pattern to check
795 * @param size buffer size in bytes
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100796 * Return: 1 if there are only patt bytes in buf
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100797 * 0 if something else was found
798 */
799static int check_pattern(const u_char *buf, u_char patt, int size)
800{
801 int i;
802
803 for (i = 0; i < size; i++)
804 if (buf[i] != patt)
805 return 0;
806 return 1;
807}
808
809/**
810 * nand_torture:
811 *
812 * Torture a block of NAND flash.
813 * This is useful to determine if a block that caused a write error is still
814 * good or should be marked as bad.
815 *
Scott Wood08364d92016-05-30 13:57:54 -0500816 * @param mtd nand mtd instance
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100817 * @param offset offset in flash
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100818 * Return: 0 if the block is still good
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100819 */
Scott Wood08364d92016-05-30 13:57:54 -0500820int nand_torture(struct mtd_info *mtd, loff_t offset)
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100821{
822 u_char patterns[] = {0xa5, 0x5a, 0x00};
823 struct erase_info instr = {
Max Krummenacherf3178d72016-06-13 10:15:47 +0200824 .mtd = mtd,
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100825 .addr = offset,
Scott Wood08364d92016-05-30 13:57:54 -0500826 .len = mtd->erasesize,
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100827 };
828 size_t retlen;
829 int err, ret = -1, i, patt_count;
830 u_char *buf;
831
Scott Wood08364d92016-05-30 13:57:54 -0500832 if ((offset & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100833 puts("Attempt to torture a block at a non block-aligned offset\n");
834 return -EINVAL;
835 }
836
Scott Wood08364d92016-05-30 13:57:54 -0500837 if (offset + mtd->erasesize > mtd->size) {
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100838 puts("Attempt to torture a block outside the flash area\n");
839 return -EINVAL;
840 }
841
842 patt_count = ARRAY_SIZE(patterns);
843
Scott Wood08364d92016-05-30 13:57:54 -0500844 buf = malloc_cache_aligned(mtd->erasesize);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100845 if (buf == NULL) {
846 puts("Out of memory for erase block buffer\n");
847 return -ENOMEM;
848 }
849
850 for (i = 0; i < patt_count; i++) {
Max Krummenachera21c4482016-05-30 16:28:28 +0200851 err = mtd_erase(mtd, &instr);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100852 if (err) {
853 printf("%s: erase() failed for block at 0x%llx: %d\n",
Scott Wood08364d92016-05-30 13:57:54 -0500854 mtd->name, instr.addr, err);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100855 goto out;
856 }
857
858 /* Make sure the block contains only 0xff bytes */
Max Krummenachera21c4482016-05-30 16:28:28 +0200859 err = mtd_read(mtd, offset, mtd->erasesize, &retlen, buf);
Scott Wood08364d92016-05-30 13:57:54 -0500860 if ((err && err != -EUCLEAN) || retlen != mtd->erasesize) {
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100861 printf("%s: read() failed for block at 0x%llx: %d\n",
Scott Wood08364d92016-05-30 13:57:54 -0500862 mtd->name, instr.addr, err);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100863 goto out;
864 }
865
Scott Wood08364d92016-05-30 13:57:54 -0500866 err = check_pattern(buf, 0xff, mtd->erasesize);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100867 if (!err) {
868 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
869 offset);
870 ret = -EIO;
871 goto out;
872 }
873
874 /* Write a pattern and check it */
Scott Wood08364d92016-05-30 13:57:54 -0500875 memset(buf, patterns[i], mtd->erasesize);
Max Krummenachera21c4482016-05-30 16:28:28 +0200876 err = mtd_write(mtd, offset, mtd->erasesize, &retlen, buf);
Scott Wood08364d92016-05-30 13:57:54 -0500877 if (err || retlen != mtd->erasesize) {
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100878 printf("%s: write() failed for block at 0x%llx: %d\n",
Scott Wood08364d92016-05-30 13:57:54 -0500879 mtd->name, instr.addr, err);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100880 goto out;
881 }
882
Max Krummenachera21c4482016-05-30 16:28:28 +0200883 err = mtd_read(mtd, offset, mtd->erasesize, &retlen, buf);
Scott Wood08364d92016-05-30 13:57:54 -0500884 if ((err && err != -EUCLEAN) || retlen != mtd->erasesize) {
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100885 printf("%s: read() failed for block at 0x%llx: %d\n",
Scott Wood08364d92016-05-30 13:57:54 -0500886 mtd->name, instr.addr, err);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100887 goto out;
888 }
889
Scott Wood08364d92016-05-30 13:57:54 -0500890 err = check_pattern(buf, patterns[i], mtd->erasesize);
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100891 if (!err) {
892 printf("Pattern 0x%.2x checking failed for block at "
893 "0x%llx\n", patterns[i], offset);
894 ret = -EIO;
895 goto out;
896 }
897 }
898
899 ret = 0;
900
901out:
902 free(buf);
903 return ret;
904}
905
906#endif