blob: b292826034f9f3964ae4278ed77314b953bcb761 [file] [log] [blame]
Stefan Roesed351b2b2006-10-10 12:36:02 +02001/*
Marcel Ziswileraea68562007-12-30 03:30:46 +01002 * drivers/mtd/nand/nand_util.c
Stefan Roesed351b2b2006-10-10 12:36:02 +02003 *
4 * Copyright (C) 2006 by Weiss-Electronic GmbH.
5 * All rights reserved.
6 *
7 * @author: Guido Classen <clagix@gmail.com>
8 * @descr: NAND Flash support
9 * @references: borrowed heavily from Linux mtd-utils code:
10 * flash_eraseall.c by Arcom Control System Ltd
11 * nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
12 * and Thomas Gleixner (tglx@linutronix.de)
13 *
Ben Gardiner34dd5672011-06-14 16:35:06 -040014 * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
15 * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
16 *
Tom Rinib7bef6a2013-10-31 09:24:00 -040017 * Copyright 2010 Freescale Semiconductor
18 *
19 * SPDX-License-Identifier: GPL-2.0
Stefan Roesed351b2b2006-10-10 12:36:02 +020020 */
21
22#include <common.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020023#include <command.h>
24#include <watchdog.h>
25#include <malloc.h>
Dirk Behme32d1f762007-08-02 17:42:08 +020026#include <div64.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020027
William Juul52c07962007-10-31 13:53:06 +010028#include <asm/errno.h>
29#include <linux/mtd/mtd.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020030#include <nand.h>
31#include <jffs2/jffs2.h>
32
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000033typedef struct erase_info erase_info_t;
34typedef struct mtd_info mtd_info_t;
Stefan Roesed351b2b2006-10-10 12:36:02 +020035
36/* support only for native endian JFFS2 */
37#define cpu_to_je16(x) (x)
38#define cpu_to_je32(x) (x)
39
Stefan Roesed351b2b2006-10-10 12:36:02 +020040/**
41 * nand_erase_opts: - erase NAND flash with support for various options
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000042 * (jffs2 formatting)
Stefan Roesed351b2b2006-10-10 12:36:02 +020043 *
44 * @param meminfo NAND device to erase
45 * @param opts options, @see struct nand_erase_options
46 * @return 0 in case of success
47 *
48 * This code is ported from flash_eraseall.c from Linux mtd utils by
49 * Arcom Control System Ltd.
50 */
51int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
52{
53 struct jffs2_unknown_node cleanmarker;
Stefan Roesed351b2b2006-10-10 12:36:02 +020054 erase_info_t erase;
Scott Wood1b5cd512010-08-25 14:43:29 -050055 unsigned long erase_length, erased_length; /* in blocks */
Stefan Roesed351b2b2006-10-10 12:36:02 +020056 int result;
57 int percent_complete = -1;
Stefan Roesed351b2b2006-10-10 12:36:02 +020058 const char *mtd_device = meminfo->name;
William Juul52c07962007-10-31 13:53:06 +010059 struct mtd_oob_ops oob_opts;
60 struct nand_chip *chip = meminfo->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +020061
Benoît Thébaudeauad5d6ee2012-11-05 10:16:15 +000062 if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
63 printf("Attempt to erase non block-aligned data\n");
Scott Wood1b5cd512010-08-25 14:43:29 -050064 return -1;
65 }
66
Stefan Roesed351b2b2006-10-10 12:36:02 +020067 memset(&erase, 0, sizeof(erase));
William Juul52c07962007-10-31 13:53:06 +010068 memset(&oob_opts, 0, sizeof(oob_opts));
Stefan Roesed351b2b2006-10-10 12:36:02 +020069
70 erase.mtd = meminfo;
71 erase.len = meminfo->erasesize;
Stefan Roese198b23e2006-10-28 15:55:52 +020072 erase.addr = opts->offset;
Scott Wood1b5cd512010-08-25 14:43:29 -050073 erase_length = lldiv(opts->length + meminfo->erasesize - 1,
74 meminfo->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +020075
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000076 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
77 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
William Juul52c07962007-10-31 13:53:06 +010078 cleanmarker.totlen = cpu_to_je32(8);
Stefan Roesed351b2b2006-10-10 12:36:02 +020079
80 /* scrub option allows to erase badblock. To prevent internal
81 * check from erase() method, set block check method to dummy
82 * and disable bad block table while erasing.
83 */
84 if (opts->scrub) {
Marek Vasut971d9a12011-09-12 06:04:06 +020085 erase.scrub = opts->scrub;
86 /*
87 * We don't need the bad block table anymore...
Stefan Roesed351b2b2006-10-10 12:36:02 +020088 * after scrub, there are no bad blocks left!
89 */
Marek Vasut971d9a12011-09-12 06:04:06 +020090 if (chip->bbt) {
91 kfree(chip->bbt);
Stefan Roesed351b2b2006-10-10 12:36:02 +020092 }
Marek Vasut971d9a12011-09-12 06:04:06 +020093 chip->bbt = NULL;
Stefan Roesed351b2b2006-10-10 12:36:02 +020094 }
95
Scott Wood1b5cd512010-08-25 14:43:29 -050096 for (erased_length = 0;
97 erased_length < erase_length;
Stefan Roesed351b2b2006-10-10 12:36:02 +020098 erase.addr += meminfo->erasesize) {
William Juulb76ec382007-11-08 10:39:53 +010099
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000100 WATCHDOG_RESET();
Stefan Roesed351b2b2006-10-10 12:36:02 +0200101
Heiko Schocher0ae98b42013-06-24 18:50:40 +0200102 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
103 puts("Size of erase exceeds limit\n");
104 return -EFBIG;
105 }
Masahiro Yamada7580d582013-07-12 10:53:37 +0900106 if (!opts->scrub) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000107 int ret = mtd_block_isbad(meminfo, erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200108 if (ret > 0) {
109 if (!opts->quiet)
110 printf("\rSkipping bad block at "
Stefan Roese586b3a62009-05-11 16:03:55 +0200111 "0x%08llx "
Wolfgang Denkd5cf1a42006-10-12 11:43:47 +0200112 " \n",
113 erase.addr);
Scott Wood1b5cd512010-08-25 14:43:29 -0500114
115 if (!opts->spread)
116 erased_length++;
117
Stefan Roesed351b2b2006-10-10 12:36:02 +0200118 continue;
119
120 } else if (ret < 0) {
121 printf("\n%s: MTD get bad block failed: %d\n",
122 mtd_device,
123 ret);
124 return -1;
125 }
126 }
127
Scott Wood1b5cd512010-08-25 14:43:29 -0500128 erased_length++;
129
Sergey Lapin3a38a552013-01-14 03:46:50 +0000130 result = mtd_erase(meminfo, &erase);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200131 if (result != 0) {
132 printf("\n%s: MTD Erase failure: %d\n",
133 mtd_device, result);
134 continue;
135 }
136
137 /* format for JFFS2 ? */
Scott Woodd50ad352008-10-29 14:20:26 -0500138 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000139 struct mtd_oob_ops ops;
140 ops.ooblen = 8;
141 ops.datbuf = NULL;
142 ops.oobbuf = (uint8_t *)&cleanmarker;
143 ops.ooboffs = 0;
144 ops.mode = MTD_OPS_AUTO_OOB;
William Juulb76ec382007-11-08 10:39:53 +0100145
Sergey Lapin3a38a552013-01-14 03:46:50 +0000146 result = mtd_write_oob(meminfo,
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200147 erase.addr,
148 &ops);
William Juul52c07962007-10-31 13:53:06 +0100149 if (result != 0) {
150 printf("\n%s: MTD writeoob failure: %d\n",
Scott Woodd50ad352008-10-29 14:20:26 -0500151 mtd_device, result);
William Juul52c07962007-10-31 13:53:06 +0100152 continue;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200153 }
154 }
155
156 if (!opts->quiet) {
Scott Wood1b5cd512010-08-25 14:43:29 -0500157 unsigned long long n = erased_length * 100ULL;
Matthias Fuchs82714b92007-09-11 17:04:00 +0200158 int percent;
159
160 do_div(n, erase_length);
161 percent = (int)n;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200162
163 /* output progress message only at whole percent
164 * steps to reduce the number of messages printed
165 * on (slow) serial consoles
166 */
167 if (percent != percent_complete) {
168 percent_complete = percent;
169
Stefan Roese586b3a62009-05-11 16:03:55 +0200170 printf("\rErasing at 0x%llx -- %3d%% complete.",
Scott Woodd50ad352008-10-29 14:20:26 -0500171 erase.addr, percent);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200172
173 if (opts->jffs2 && result == 0)
Stefan Roese586b3a62009-05-11 16:03:55 +0200174 printf(" Cleanmarker written at 0x%llx.",
Scott Woodd50ad352008-10-29 14:20:26 -0500175 erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200176 }
177 }
178 }
179 if (!opts->quiet)
180 printf("\n");
181
Marek Vasut971d9a12011-09-12 06:04:06 +0200182 if (opts->scrub)
183 chip->scan_bbt(meminfo);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200184
185 return 0;
186}
187
Nishanth Menonb20f8402008-12-13 09:43:06 -0600188#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
189
Stefan Roesed351b2b2006-10-10 12:36:02 +0200190/******************************************************************************
191 * Support for locking / unlocking operations of some NAND devices
192 *****************************************************************************/
193
Stefan Roesed351b2b2006-10-10 12:36:02 +0200194/**
195 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
196 * state
197 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600198 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200199 * @param tight bring device in lock tight mode
200 *
201 * @return 0 on success, -1 in case of error
202 *
203 * The lock / lock-tight command only applies to the whole chip. To get some
204 * parts of the chip lock and others unlocked use the following sequence:
205 *
206 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
207 * - Call nand_unlock() once for each consecutive area to be unlocked
208 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
209 *
210 * If the device is in lock-tight state software can't change the
211 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
212 * calls will fail. It is only posible to leave lock-tight state by
213 * an hardware signal (low pulse on _WP pin) or by power down.
214 */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600215int nand_lock(struct mtd_info *mtd, int tight)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200216{
217 int ret = 0;
218 int status;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600219 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200220
221 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600222 chip->select_chip(mtd, 0);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200223
Joe Hershberger8b177d42013-02-08 09:27:19 +0000224 /* check the Lock Tight Status */
225 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
226 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
227 printf("nand_lock: Device is locked tight!\n");
228 ret = -1;
229 goto out;
230 }
231
Nishanth Menonb20f8402008-12-13 09:43:06 -0600232 chip->cmdfunc(mtd,
Stefan Roesed351b2b2006-10-10 12:36:02 +0200233 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
234 -1, -1);
235
236 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600237 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200238
239 /* see if device thinks it succeeded */
240 if (status & 0x01) {
241 ret = -1;
242 }
243
Joe Hershberger8b177d42013-02-08 09:27:19 +0000244 out:
Stefan Roesed351b2b2006-10-10 12:36:02 +0200245 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600246 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200247 return ret;
248}
249
250/**
251 * nand_get_lock_status: - query current lock state from one page of NAND
252 * flash
253 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600254 * @param mtd nand mtd instance
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000255 * @param offset page address to query (must be page-aligned!)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200256 *
257 * @return -1 in case of error
258 * >0 lock status:
259 * bitfield with the following combinations:
260 * NAND_LOCK_STATUS_TIGHT: page in tight state
Stefan Roesed351b2b2006-10-10 12:36:02 +0200261 * NAND_LOCK_STATUS_UNLOCK: page unlocked
262 *
263 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200264int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200265{
266 int ret = 0;
267 int chipnr;
268 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600269 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200270
271 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600272 chipnr = (int)(offset >> chip->chip_shift);
273 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200274
275
Nishanth Menonb20f8402008-12-13 09:43:06 -0600276 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000277 printf("nand_get_lock_status: "
Stefan Roesed351b2b2006-10-10 12:36:02 +0200278 "Start address must be beginning of "
279 "nand page!\n");
280 ret = -1;
281 goto out;
282 }
283
284 /* check the Lock Status */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600285 page = (int)(offset >> chip->page_shift);
286 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200287
Nishanth Menonb20f8402008-12-13 09:43:06 -0600288 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
Stefan Roesed351b2b2006-10-10 12:36:02 +0200289 | NAND_LOCK_STATUS_UNLOCK);
290
291 out:
292 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600293 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200294 return ret;
295}
296
297/**
298 * nand_unlock: - Unlock area of NAND pages
299 * only one consecutive area can be unlocked at one time!
300 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600301 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200302 * @param start start byte address
303 * @param length number of bytes to unlock (must be a multiple of
William Juul52c07962007-10-31 13:53:06 +0100304 * page size nand->writesize)
Joe Hershbergercccf5952012-08-22 16:49:42 -0500305 * @param allexcept if set, unlock everything not selected
Stefan Roesed351b2b2006-10-10 12:36:02 +0200306 *
307 * @return 0 on success, -1 in case of error
308 */
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500309int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
310 int allexcept)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200311{
312 int ret = 0;
313 int chipnr;
314 int status;
315 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600316 struct nand_chip *chip = mtd->priv;
Joe Hershbergercccf5952012-08-22 16:49:42 -0500317
Tom Rini8e40bf62013-12-16 09:59:34 -0500318 debug("nand_unlock%s: start: %08llx, length: %zd!\n",
Joe Hershbergercccf5952012-08-22 16:49:42 -0500319 allexcept ? " (allexcept)" : "", start, length);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200320
321 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600322 chipnr = (int)(start >> chip->chip_shift);
323 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200324
325 /* check the WP bit */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600326 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
327 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000328 printf("nand_unlock: Device is write protected!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200329 ret = -1;
330 goto out;
331 }
332
Joe Hershberger8b177d42013-02-08 09:27:19 +0000333 /* check the Lock Tight Status */
334 page = (int)(start >> chip->page_shift);
335 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
336 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
337 printf("nand_unlock: Device is locked tight!\n");
338 ret = -1;
339 goto out;
340 }
341
Nishanth Menonb20f8402008-12-13 09:43:06 -0600342 if ((start & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000343 printf("nand_unlock: Start address must be beginning of "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600344 "nand block!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200345 ret = -1;
346 goto out;
347 }
348
Nishanth Menonb20f8402008-12-13 09:43:06 -0600349 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000350 printf("nand_unlock: Length must be a multiple of nand block "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600351 "size %08x!\n", mtd->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200352 ret = -1;
353 goto out;
354 }
355
Nishanth Menonb20f8402008-12-13 09:43:06 -0600356 /*
357 * Set length so that the last address is set to the
358 * starting address of the last block
359 */
360 length -= mtd->erasesize;
361
Stefan Roesed351b2b2006-10-10 12:36:02 +0200362 /* submit address of first page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600363 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200364
365 /* submit ADDRESS of LAST page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600366 page += (int)(length >> chip->page_shift);
Joe Hershbergercccf5952012-08-22 16:49:42 -0500367
368 /*
369 * Page addresses for unlocking are supposed to be block-aligned.
370 * At least some NAND chips use the low bit to indicate that the
371 * page range should be inverted.
372 */
373 if (allexcept)
374 page |= 1;
375
Nishanth Menonb20f8402008-12-13 09:43:06 -0600376 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200377
378 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600379 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200380 /* see if device thinks it succeeded */
381 if (status & 0x01) {
382 /* there was an error */
383 ret = -1;
384 goto out;
385 }
386
387 out:
388 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600389 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200390 return ret;
391}
William Juul52c07962007-10-31 13:53:06 +0100392#endif
Stefan Roesed351b2b2006-10-10 12:36:02 +0200393
Scott Woodcc5f3392008-06-12 13:20:16 -0500394/**
Scott Woodfe3b5e12010-07-30 16:11:41 -0500395 * check_skip_len
Scott Woodcc5f3392008-06-12 13:20:16 -0500396 *
Scott Woodfe3b5e12010-07-30 16:11:41 -0500397 * Check if there are any bad blocks, and whether length including bad
398 * blocks fits into device
Scott Woodcc5f3392008-06-12 13:20:16 -0500399 *
400 * @param nand NAND device
401 * @param offset offset in flash
402 * @param length image length
Tom Rini32d96182013-03-14 05:32:50 +0000403 * @param used length of flash needed for the requested length
Scott Woodfe3b5e12010-07-30 16:11:41 -0500404 * @return 0 if the image fits and there are no bad blocks
405 * 1 if the image fits, but there are bad blocks
406 * -1 if the image does not fit
Scott Woodcc5f3392008-06-12 13:20:16 -0500407 */
Tom Rini32d96182013-03-14 05:32:50 +0000408static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
409 size_t *used)
Scott Woodcc5f3392008-06-12 13:20:16 -0500410{
Scott Woodcc5f3392008-06-12 13:20:16 -0500411 size_t len_excl_bad = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500412 int ret = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500413
414 while (len_excl_bad < length) {
Scott Woodfe3b5e12010-07-30 16:11:41 -0500415 size_t block_len, block_off;
416 loff_t block_start;
Scott Woodcc5f3392008-06-12 13:20:16 -0500417
Scott Woodfe3b5e12010-07-30 16:11:41 -0500418 if (offset >= nand->size)
419 return -1;
Scott Woodcc5f3392008-06-12 13:20:16 -0500420
Scott Woodfe3b5e12010-07-30 16:11:41 -0500421 block_start = offset & ~(loff_t)(nand->erasesize - 1);
422 block_off = offset & (nand->erasesize - 1);
423 block_len = nand->erasesize - block_off;
Scott Woodcc5f3392008-06-12 13:20:16 -0500424
Scott Woodfe3b5e12010-07-30 16:11:41 -0500425 if (!nand_block_isbad(nand, block_start))
426 len_excl_bad += block_len;
427 else
428 ret = 1;
429
430 offset += block_len;
Tom Rini32d96182013-03-14 05:32:50 +0000431 *used += block_len;
Scott Woodcc5f3392008-06-12 13:20:16 -0500432 }
433
Tom Rini32d96182013-03-14 05:32:50 +0000434 /* If the length is not a multiple of block_len, adjust. */
435 if (len_excl_bad > length)
436 *used -= (len_excl_bad - length);
437
Scott Woodfe3b5e12010-07-30 16:11:41 -0500438 return ret;
Scott Woodcc5f3392008-06-12 13:20:16 -0500439}
Ben Gardiner34dd5672011-06-14 16:35:06 -0400440
441#ifdef CONFIG_CMD_NAND_TRIMFFS
442static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
443 const size_t *len)
444{
htbegin610e8552013-03-01 23:00:34 +0000445 size_t l = *len;
446 ssize_t i;
Ben Gardiner34dd5672011-06-14 16:35:06 -0400447
448 for (i = l - 1; i >= 0; i--)
449 if (buf[i] != 0xFF)
450 break;
451
452 /* The resulting length must be aligned to the minimum flash I/O size */
453 l = i + 1;
454 l = (l + nand->writesize - 1) / nand->writesize;
455 l *= nand->writesize;
456
457 /*
458 * since the input length may be unaligned, prevent access past the end
459 * of the buffer
460 */
461 return min(l, *len);
462}
463#endif
Scott Woodcc5f3392008-06-12 13:20:16 -0500464
465/**
466 * nand_write_skip_bad:
467 *
468 * Write image to NAND flash.
469 * Blocks that are marked bad are skipped and the is written to the next
470 * block instead as long as the image is short enough to fit even after
Tom Rini32d96182013-03-14 05:32:50 +0000471 * skipping the bad blocks. Due to bad blocks we may not be able to
472 * perform the requested write. In the case where the write would
473 * extend beyond the end of the NAND device, both length and actual (if
474 * not NULL) are set to 0. In the case where the write would extend
475 * beyond the limit we are passed, length is set to 0 and actual is set
476 * to the required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500477 *
478 * @param nand NAND device
479 * @param offset offset in flash
480 * @param length buffer length
Tom Rini32d96182013-03-14 05:32:50 +0000481 * @param actual set to size required to write length worth of
482 * buffer or 0 on error, if not NULL
483 * @param lim maximum size that actual may be in order to not
484 * exceed the buffer
Lei Wen4b5deaa2011-01-06 11:11:58 +0800485 * @param buffer buffer to read from
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400486 * @param flags flags modifying the behaviour of the write to NAND
Scott Woodcc5f3392008-06-12 13:20:16 -0500487 * @return 0 in case of success
488 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200489int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000490 size_t *actual, loff_t lim, u_char *buffer, int flags)
Scott Woodcc5f3392008-06-12 13:20:16 -0500491{
Lei Wen4b5deaa2011-01-06 11:11:58 +0800492 int rval = 0, blocksize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500493 size_t left_to_write = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000494 size_t used_for_write = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500495 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500496 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500497
Tom Rini32d96182013-03-14 05:32:50 +0000498 if (actual)
499 *actual = 0;
500
Lei Wen4b5deaa2011-01-06 11:11:58 +0800501#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400502 if (flags & WITH_YAFFS_OOB) {
Ben Gardiner871dea42011-06-14 16:35:05 -0400503 if (flags & ~WITH_YAFFS_OOB)
504 return -EINVAL;
505
Lei Wen4b5deaa2011-01-06 11:11:58 +0800506 int pages;
507 pages = nand->erasesize / nand->writesize;
508 blocksize = (pages * nand->oobsize) + nand->erasesize;
509 if (*length % (nand->writesize + nand->oobsize)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000510 printf("Attempt to write incomplete page"
Lei Wen4b5deaa2011-01-06 11:11:58 +0800511 " in yaffs mode\n");
512 return -EINVAL;
513 }
514 } else
515#endif
516 {
517 blocksize = nand->erasesize;
518 }
519
Scott Woodfe3b5e12010-07-30 16:11:41 -0500520 /*
521 * nand_write() handles unaligned, partial page writes.
522 *
523 * We allow length to be unaligned, for convenience in
524 * using the $filesize variable.
525 *
526 * However, starting at an unaligned offset makes the
527 * semantics of bad block skipping ambiguous (really,
528 * you should only start a block skipping access at a
529 * partition boundary). So don't try to handle that.
530 */
531 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000532 printf("Attempt to write non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500533 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500534 return -EINVAL;
535 }
536
Tom Rini32d96182013-03-14 05:32:50 +0000537 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
538
539 if (actual)
540 *actual = used_for_write;
541
Scott Woodfe3b5e12010-07-30 16:11:41 -0500542 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000543 printf("Attempt to write outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500544 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500545 return -EINVAL;
546 }
547
Tom Rini32d96182013-03-14 05:32:50 +0000548 if (used_for_write > lim) {
549 puts("Size of write exceeds partition or device limit\n");
550 *length = 0;
551 return -EFBIG;
552 }
553
Ben Gardiner34dd5672011-06-14 16:35:06 -0400554 if (!need_skip && !(flags & WITH_DROP_FFS)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000555 rval = nand_write(nand, offset, length, buffer);
Scott Woodfe3b5e12010-07-30 16:11:41 -0500556 if (rval == 0)
557 return 0;
Scott Wood90e0a6b2008-11-25 10:47:02 -0600558
Scott Woodfe3b5e12010-07-30 16:11:41 -0500559 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000560 printf("NAND write to offset %llx failed %d\n",
Scott Woodfe3b5e12010-07-30 16:11:41 -0500561 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600562 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500563 }
564
565 while (left_to_write > 0) {
566 size_t block_offset = offset & (nand->erasesize - 1);
Ben Gardiner34dd5672011-06-14 16:35:06 -0400567 size_t write_size, truncated_write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500568
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000569 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500570
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000571 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
572 printf("Skip bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500573 offset & ~(nand->erasesize - 1));
574 offset += nand->erasesize - block_offset;
575 continue;
576 }
577
Lei Wen4b5deaa2011-01-06 11:11:58 +0800578 if (left_to_write < (blocksize - block_offset))
Scott Woodcc5f3392008-06-12 13:20:16 -0500579 write_size = left_to_write;
580 else
Lei Wen4b5deaa2011-01-06 11:11:58 +0800581 write_size = blocksize - block_offset;
582
583#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400584 if (flags & WITH_YAFFS_OOB) {
Lei Wen4b5deaa2011-01-06 11:11:58 +0800585 int page, pages;
586 size_t pagesize = nand->writesize;
587 size_t pagesize_oob = pagesize + nand->oobsize;
588 struct mtd_oob_ops ops;
589
590 ops.len = pagesize;
591 ops.ooblen = nand->oobsize;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000592 ops.mode = MTD_OPS_AUTO_OOB;
Lei Wen4b5deaa2011-01-06 11:11:58 +0800593 ops.ooboffs = 0;
594
595 pages = write_size / pagesize_oob;
596 for (page = 0; page < pages; page++) {
Scott Woodea95b642011-02-02 18:15:57 -0600597 WATCHDOG_RESET();
598
Lei Wen4b5deaa2011-01-06 11:11:58 +0800599 ops.datbuf = p_buffer;
600 ops.oobbuf = ops.datbuf + pagesize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500601
Sergey Lapin3a38a552013-01-14 03:46:50 +0000602 rval = mtd_write_oob(nand, offset, &ops);
Liu, Wentaode95b322012-01-17 19:55:02 +0000603 if (rval != 0)
Lei Wen4b5deaa2011-01-06 11:11:58 +0800604 break;
605
606 offset += pagesize;
607 p_buffer += pagesize_oob;
608 }
609 }
610 else
611#endif
612 {
Ben Gardiner34dd5672011-06-14 16:35:06 -0400613 truncated_write_size = write_size;
614#ifdef CONFIG_CMD_NAND_TRIMFFS
615 if (flags & WITH_DROP_FFS)
616 truncated_write_size = drop_ffs(nand, p_buffer,
617 &write_size);
618#endif
619
620 rval = nand_write(nand, offset, &truncated_write_size,
621 p_buffer);
Lei Wen4b5deaa2011-01-06 11:11:58 +0800622 offset += write_size;
623 p_buffer += write_size;
624 }
625
Scott Woodcc5f3392008-06-12 13:20:16 -0500626 if (rval != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000627 printf("NAND write to offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200628 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500629 *length -= left_to_write;
630 return rval;
631 }
632
633 left_to_write -= write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500634 }
635
636 return 0;
637}
638
639/**
640 * nand_read_skip_bad:
641 *
642 * Read image from NAND flash.
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000643 * Blocks that are marked bad are skipped and the next block is read
Tom Rini32d96182013-03-14 05:32:50 +0000644 * instead as long as the image is short enough to fit even after
645 * skipping the bad blocks. Due to bad blocks we may not be able to
646 * perform the requested read. In the case where the read would extend
647 * beyond the end of the NAND device, both length and actual (if not
648 * NULL) are set to 0. In the case where the read would extend beyond
649 * the limit we are passed, length is set to 0 and actual is set to the
650 * required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500651 *
652 * @param nand NAND device
653 * @param offset offset in flash
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000654 * @param length buffer length, on return holds number of read bytes
Tom Rini32d96182013-03-14 05:32:50 +0000655 * @param actual set to size required to read length worth of buffer or 0
656 * on error, if not NULL
657 * @param lim maximum size that actual may be in order to not exceed the
658 * buffer
Scott Woodcc5f3392008-06-12 13:20:16 -0500659 * @param buffer buffer to write to
660 * @return 0 in case of success
661 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200662int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000663 size_t *actual, loff_t lim, u_char *buffer)
Scott Woodcc5f3392008-06-12 13:20:16 -0500664{
665 int rval;
666 size_t left_to_read = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000667 size_t used_for_read = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500668 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500669 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500670
Scott Woodfe3b5e12010-07-30 16:11:41 -0500671 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000672 printf("Attempt to read non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500673 *length = 0;
Tom Rini32d96182013-03-14 05:32:50 +0000674 if (actual)
675 *actual = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500676 return -EINVAL;
677 }
Scott Woodcc5f3392008-06-12 13:20:16 -0500678
Tom Rini32d96182013-03-14 05:32:50 +0000679 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
680
681 if (actual)
682 *actual = used_for_read;
683
Scott Woodfe3b5e12010-07-30 16:11:41 -0500684 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000685 printf("Attempt to read outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500686 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500687 return -EINVAL;
688 }
689
Tom Rini32d96182013-03-14 05:32:50 +0000690 if (used_for_read > lim) {
691 puts("Size of read exceeds partition or device limit\n");
692 *length = 0;
693 return -EFBIG;
694 }
695
Scott Woodfe3b5e12010-07-30 16:11:41 -0500696 if (!need_skip) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000697 rval = nand_read(nand, offset, length, buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300698 if (!rval || rval == -EUCLEAN)
699 return 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500700
701 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000702 printf("NAND read from offset %llx failed %d\n",
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300703 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600704 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500705 }
706
707 while (left_to_read > 0) {
708 size_t block_offset = offset & (nand->erasesize - 1);
709 size_t read_length;
710
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000711 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500712
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000713 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
714 printf("Skipping bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500715 offset & ~(nand->erasesize - 1));
716 offset += nand->erasesize - block_offset;
717 continue;
718 }
719
720 if (left_to_read < (nand->erasesize - block_offset))
721 read_length = left_to_read;
722 else
723 read_length = nand->erasesize - block_offset;
724
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000725 rval = nand_read(nand, offset, &read_length, p_buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300726 if (rval && rval != -EUCLEAN) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000727 printf("NAND read from offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200728 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500729 *length -= left_to_read;
730 return rval;
731 }
732
733 left_to_read -= read_length;
734 offset += read_length;
735 p_buffer += read_length;
736 }
737
738 return 0;
739}
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100740
741#ifdef CONFIG_CMD_NAND_TORTURE
742
743/**
744 * check_pattern:
745 *
746 * Check if buffer contains only a certain byte pattern.
747 *
748 * @param buf buffer to check
749 * @param patt the pattern to check
750 * @param size buffer size in bytes
751 * @return 1 if there are only patt bytes in buf
752 * 0 if something else was found
753 */
754static int check_pattern(const u_char *buf, u_char patt, int size)
755{
756 int i;
757
758 for (i = 0; i < size; i++)
759 if (buf[i] != patt)
760 return 0;
761 return 1;
762}
763
764/**
765 * nand_torture:
766 *
767 * Torture a block of NAND flash.
768 * This is useful to determine if a block that caused a write error is still
769 * good or should be marked as bad.
770 *
771 * @param nand NAND device
772 * @param offset offset in flash
773 * @return 0 if the block is still good
774 */
775int nand_torture(nand_info_t *nand, loff_t offset)
776{
777 u_char patterns[] = {0xa5, 0x5a, 0x00};
778 struct erase_info instr = {
779 .mtd = nand,
780 .addr = offset,
781 .len = nand->erasesize,
782 };
783 size_t retlen;
784 int err, ret = -1, i, patt_count;
785 u_char *buf;
786
787 if ((offset & (nand->erasesize - 1)) != 0) {
788 puts("Attempt to torture a block at a non block-aligned offset\n");
789 return -EINVAL;
790 }
791
792 if (offset + nand->erasesize > nand->size) {
793 puts("Attempt to torture a block outside the flash area\n");
794 return -EINVAL;
795 }
796
797 patt_count = ARRAY_SIZE(patterns);
798
799 buf = malloc(nand->erasesize);
800 if (buf == NULL) {
801 puts("Out of memory for erase block buffer\n");
802 return -ENOMEM;
803 }
804
805 for (i = 0; i < patt_count; i++) {
806 err = nand->erase(nand, &instr);
807 if (err) {
808 printf("%s: erase() failed for block at 0x%llx: %d\n",
809 nand->name, instr.addr, err);
810 goto out;
811 }
812
813 /* Make sure the block contains only 0xff bytes */
814 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
815 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
816 printf("%s: read() failed for block at 0x%llx: %d\n",
817 nand->name, instr.addr, err);
818 goto out;
819 }
820
821 err = check_pattern(buf, 0xff, nand->erasesize);
822 if (!err) {
823 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
824 offset);
825 ret = -EIO;
826 goto out;
827 }
828
829 /* Write a pattern and check it */
830 memset(buf, patterns[i], nand->erasesize);
831 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
832 if (err || retlen != nand->erasesize) {
833 printf("%s: write() failed for block at 0x%llx: %d\n",
834 nand->name, instr.addr, err);
835 goto out;
836 }
837
838 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
839 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
840 printf("%s: read() failed for block at 0x%llx: %d\n",
841 nand->name, instr.addr, err);
842 goto out;
843 }
844
845 err = check_pattern(buf, patterns[i], nand->erasesize);
846 if (!err) {
847 printf("Pattern 0x%.2x checking failed for block at "
848 "0x%llx\n", patterns[i], offset);
849 ret = -EIO;
850 goto out;
851 }
852 }
853
854 ret = 0;
855
856out:
857 free(buf);
858 return ret;
859}
860
861#endif