blob: 1d22b5240d46701468ce911046dede4bf125ad43 [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 *
Stefan Roesed351b2b2006-10-10 12:36:02 +020017 * See file CREDITS for list of people who contributed to this
18 * project.
19 *
20 * This program is free software; you can redistribute it and/or
21 * modify it under the terms of the GNU General Public License version
22 * 2 as published by the Free Software Foundation.
23 *
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
32 * MA 02111-1307 USA
33 *
Scott Woodfe3b5e12010-07-30 16:11:41 -050034 * Copyright 2010 Freescale Semiconductor
35 * The portions of this file whose copyright is held by Freescale and which
36 * are not considered a derived work of GPL v2-only code may be distributed
37 * and/or modified under the terms of the GNU General Public License as
38 * published by the Free Software Foundation; either version 2 of the
39 * License, or (at your option) any later version.
Stefan Roesed351b2b2006-10-10 12:36:02 +020040 */
41
42#include <common.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020043#include <command.h>
44#include <watchdog.h>
45#include <malloc.h>
Dirk Behme32d1f762007-08-02 17:42:08 +020046#include <div64.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020047
William Juul52c07962007-10-31 13:53:06 +010048#include <asm/errno.h>
49#include <linux/mtd/mtd.h>
Stefan Roesed351b2b2006-10-10 12:36:02 +020050#include <nand.h>
51#include <jffs2/jffs2.h>
52
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000053typedef struct erase_info erase_info_t;
54typedef struct mtd_info mtd_info_t;
Stefan Roesed351b2b2006-10-10 12:36:02 +020055
56/* support only for native endian JFFS2 */
57#define cpu_to_je16(x) (x)
58#define cpu_to_je32(x) (x)
59
Stefan Roesed351b2b2006-10-10 12:36:02 +020060/**
61 * nand_erase_opts: - erase NAND flash with support for various options
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000062 * (jffs2 formatting)
Stefan Roesed351b2b2006-10-10 12:36:02 +020063 *
64 * @param meminfo NAND device to erase
65 * @param opts options, @see struct nand_erase_options
66 * @return 0 in case of success
67 *
68 * This code is ported from flash_eraseall.c from Linux mtd utils by
69 * Arcom Control System Ltd.
70 */
71int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
72{
73 struct jffs2_unknown_node cleanmarker;
Stefan Roesed351b2b2006-10-10 12:36:02 +020074 erase_info_t erase;
Scott Wood1b5cd512010-08-25 14:43:29 -050075 unsigned long erase_length, erased_length; /* in blocks */
Stefan Roesed351b2b2006-10-10 12:36:02 +020076 int bbtest = 1;
77 int result;
78 int percent_complete = -1;
Stefan Roesed351b2b2006-10-10 12:36:02 +020079 const char *mtd_device = meminfo->name;
William Juul52c07962007-10-31 13:53:06 +010080 struct mtd_oob_ops oob_opts;
81 struct nand_chip *chip = meminfo->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +020082
Benoît Thébaudeauad5d6ee2012-11-05 10:16:15 +000083 if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
84 printf("Attempt to erase non block-aligned data\n");
Scott Wood1b5cd512010-08-25 14:43:29 -050085 return -1;
86 }
87
Stefan Roesed351b2b2006-10-10 12:36:02 +020088 memset(&erase, 0, sizeof(erase));
William Juul52c07962007-10-31 13:53:06 +010089 memset(&oob_opts, 0, sizeof(oob_opts));
Stefan Roesed351b2b2006-10-10 12:36:02 +020090
91 erase.mtd = meminfo;
92 erase.len = meminfo->erasesize;
Stefan Roese198b23e2006-10-28 15:55:52 +020093 erase.addr = opts->offset;
Scott Wood1b5cd512010-08-25 14:43:29 -050094 erase_length = lldiv(opts->length + meminfo->erasesize - 1,
95 meminfo->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +020096
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +000097 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
98 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
William Juul52c07962007-10-31 13:53:06 +010099 cleanmarker.totlen = cpu_to_je32(8);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200100
101 /* scrub option allows to erase badblock. To prevent internal
102 * check from erase() method, set block check method to dummy
103 * and disable bad block table while erasing.
104 */
105 if (opts->scrub) {
Marek Vasut971d9a12011-09-12 06:04:06 +0200106 erase.scrub = opts->scrub;
107 /*
108 * We don't need the bad block table anymore...
Stefan Roesed351b2b2006-10-10 12:36:02 +0200109 * after scrub, there are no bad blocks left!
110 */
Marek Vasut971d9a12011-09-12 06:04:06 +0200111 if (chip->bbt) {
112 kfree(chip->bbt);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200113 }
Marek Vasut971d9a12011-09-12 06:04:06 +0200114 chip->bbt = NULL;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200115 }
116
Scott Wood1b5cd512010-08-25 14:43:29 -0500117 for (erased_length = 0;
118 erased_length < erase_length;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200119 erase.addr += meminfo->erasesize) {
William Juulb76ec382007-11-08 10:39:53 +0100120
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000121 WATCHDOG_RESET();
Stefan Roesed351b2b2006-10-10 12:36:02 +0200122
Heiko Schocher0ae98b42013-06-24 18:50:40 +0200123 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
124 puts("Size of erase exceeds limit\n");
125 return -EFBIG;
126 }
Stefan Roesed351b2b2006-10-10 12:36:02 +0200127 if (!opts->scrub && bbtest) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000128 int ret = mtd_block_isbad(meminfo, erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200129 if (ret > 0) {
130 if (!opts->quiet)
131 printf("\rSkipping bad block at "
Stefan Roese586b3a62009-05-11 16:03:55 +0200132 "0x%08llx "
Wolfgang Denkd5cf1a42006-10-12 11:43:47 +0200133 " \n",
134 erase.addr);
Scott Wood1b5cd512010-08-25 14:43:29 -0500135
136 if (!opts->spread)
137 erased_length++;
138
Stefan Roesed351b2b2006-10-10 12:36:02 +0200139 continue;
140
141 } else if (ret < 0) {
142 printf("\n%s: MTD get bad block failed: %d\n",
143 mtd_device,
144 ret);
145 return -1;
146 }
147 }
148
Scott Wood1b5cd512010-08-25 14:43:29 -0500149 erased_length++;
150
Sergey Lapin3a38a552013-01-14 03:46:50 +0000151 result = mtd_erase(meminfo, &erase);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200152 if (result != 0) {
153 printf("\n%s: MTD Erase failure: %d\n",
154 mtd_device, result);
155 continue;
156 }
157
158 /* format for JFFS2 ? */
Scott Woodd50ad352008-10-29 14:20:26 -0500159 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000160 struct mtd_oob_ops ops;
161 ops.ooblen = 8;
162 ops.datbuf = NULL;
163 ops.oobbuf = (uint8_t *)&cleanmarker;
164 ops.ooboffs = 0;
165 ops.mode = MTD_OPS_AUTO_OOB;
William Juulb76ec382007-11-08 10:39:53 +0100166
Sergey Lapin3a38a552013-01-14 03:46:50 +0000167 result = mtd_write_oob(meminfo,
Scott Woodd50ad352008-10-29 14:20:26 -0500168 erase.addr,
Sergey Lapin3a38a552013-01-14 03:46:50 +0000169 &ops);
William Juul52c07962007-10-31 13:53:06 +0100170 if (result != 0) {
171 printf("\n%s: MTD writeoob failure: %d\n",
Scott Woodd50ad352008-10-29 14:20:26 -0500172 mtd_device, result);
William Juul52c07962007-10-31 13:53:06 +0100173 continue;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200174 }
175 }
176
177 if (!opts->quiet) {
Scott Wood1b5cd512010-08-25 14:43:29 -0500178 unsigned long long n = erased_length * 100ULL;
Matthias Fuchs82714b92007-09-11 17:04:00 +0200179 int percent;
180
181 do_div(n, erase_length);
182 percent = (int)n;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200183
184 /* output progress message only at whole percent
185 * steps to reduce the number of messages printed
186 * on (slow) serial consoles
187 */
188 if (percent != percent_complete) {
189 percent_complete = percent;
190
Stefan Roese586b3a62009-05-11 16:03:55 +0200191 printf("\rErasing at 0x%llx -- %3d%% complete.",
Scott Woodd50ad352008-10-29 14:20:26 -0500192 erase.addr, percent);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200193
194 if (opts->jffs2 && result == 0)
Stefan Roese586b3a62009-05-11 16:03:55 +0200195 printf(" Cleanmarker written at 0x%llx.",
Scott Woodd50ad352008-10-29 14:20:26 -0500196 erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200197 }
198 }
199 }
200 if (!opts->quiet)
201 printf("\n");
202
Marek Vasut971d9a12011-09-12 06:04:06 +0200203 if (opts->scrub)
204 chip->scan_bbt(meminfo);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200205
206 return 0;
207}
208
Nishanth Menonb20f8402008-12-13 09:43:06 -0600209#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
210
Stefan Roesed351b2b2006-10-10 12:36:02 +0200211/******************************************************************************
212 * Support for locking / unlocking operations of some NAND devices
213 *****************************************************************************/
214
Stefan Roesed351b2b2006-10-10 12:36:02 +0200215/**
216 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
217 * state
218 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600219 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200220 * @param tight bring device in lock tight mode
221 *
222 * @return 0 on success, -1 in case of error
223 *
224 * The lock / lock-tight command only applies to the whole chip. To get some
225 * parts of the chip lock and others unlocked use the following sequence:
226 *
227 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
228 * - Call nand_unlock() once for each consecutive area to be unlocked
229 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
230 *
231 * If the device is in lock-tight state software can't change the
232 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
233 * calls will fail. It is only posible to leave lock-tight state by
234 * an hardware signal (low pulse on _WP pin) or by power down.
235 */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600236int nand_lock(struct mtd_info *mtd, int tight)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200237{
238 int ret = 0;
239 int status;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600240 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200241
242 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600243 chip->select_chip(mtd, 0);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200244
Joe Hershberger8b177d42013-02-08 09:27:19 +0000245 /* check the Lock Tight Status */
246 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
247 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
248 printf("nand_lock: Device is locked tight!\n");
249 ret = -1;
250 goto out;
251 }
252
Nishanth Menonb20f8402008-12-13 09:43:06 -0600253 chip->cmdfunc(mtd,
Stefan Roesed351b2b2006-10-10 12:36:02 +0200254 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
255 -1, -1);
256
257 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600258 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200259
260 /* see if device thinks it succeeded */
261 if (status & 0x01) {
262 ret = -1;
263 }
264
Joe Hershberger8b177d42013-02-08 09:27:19 +0000265 out:
Stefan Roesed351b2b2006-10-10 12:36:02 +0200266 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600267 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200268 return ret;
269}
270
271/**
272 * nand_get_lock_status: - query current lock state from one page of NAND
273 * flash
274 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600275 * @param mtd nand mtd instance
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000276 * @param offset page address to query (must be page-aligned!)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200277 *
278 * @return -1 in case of error
279 * >0 lock status:
280 * bitfield with the following combinations:
281 * NAND_LOCK_STATUS_TIGHT: page in tight state
Stefan Roesed351b2b2006-10-10 12:36:02 +0200282 * NAND_LOCK_STATUS_UNLOCK: page unlocked
283 *
284 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200285int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200286{
287 int ret = 0;
288 int chipnr;
289 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600290 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200291
292 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600293 chipnr = (int)(offset >> chip->chip_shift);
294 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200295
296
Nishanth Menonb20f8402008-12-13 09:43:06 -0600297 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000298 printf("nand_get_lock_status: "
Stefan Roesed351b2b2006-10-10 12:36:02 +0200299 "Start address must be beginning of "
300 "nand page!\n");
301 ret = -1;
302 goto out;
303 }
304
305 /* check the Lock Status */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600306 page = (int)(offset >> chip->page_shift);
307 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200308
Nishanth Menonb20f8402008-12-13 09:43:06 -0600309 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
Stefan Roesed351b2b2006-10-10 12:36:02 +0200310 | NAND_LOCK_STATUS_UNLOCK);
311
312 out:
313 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600314 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200315 return ret;
316}
317
318/**
319 * nand_unlock: - Unlock area of NAND pages
320 * only one consecutive area can be unlocked at one time!
321 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600322 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200323 * @param start start byte address
324 * @param length number of bytes to unlock (must be a multiple of
William Juul52c07962007-10-31 13:53:06 +0100325 * page size nand->writesize)
Joe Hershbergercccf5952012-08-22 16:49:42 -0500326 * @param allexcept if set, unlock everything not selected
Stefan Roesed351b2b2006-10-10 12:36:02 +0200327 *
328 * @return 0 on success, -1 in case of error
329 */
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500330int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
331 int allexcept)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200332{
333 int ret = 0;
334 int chipnr;
335 int status;
336 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600337 struct nand_chip *chip = mtd->priv;
Joe Hershbergercccf5952012-08-22 16:49:42 -0500338
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500339 debug("nand_unlock%s: start: %08llx, length: %d!\n",
Joe Hershbergercccf5952012-08-22 16:49:42 -0500340 allexcept ? " (allexcept)" : "", start, length);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200341
342 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600343 chipnr = (int)(start >> chip->chip_shift);
344 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200345
346 /* check the WP bit */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600347 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
348 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000349 printf("nand_unlock: Device is write protected!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200350 ret = -1;
351 goto out;
352 }
353
Joe Hershberger8b177d42013-02-08 09:27:19 +0000354 /* check the Lock Tight Status */
355 page = (int)(start >> chip->page_shift);
356 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
357 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
358 printf("nand_unlock: Device is locked tight!\n");
359 ret = -1;
360 goto out;
361 }
362
Nishanth Menonb20f8402008-12-13 09:43:06 -0600363 if ((start & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000364 printf("nand_unlock: Start address must be beginning of "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600365 "nand block!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200366 ret = -1;
367 goto out;
368 }
369
Nishanth Menonb20f8402008-12-13 09:43:06 -0600370 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000371 printf("nand_unlock: Length must be a multiple of nand block "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600372 "size %08x!\n", mtd->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200373 ret = -1;
374 goto out;
375 }
376
Nishanth Menonb20f8402008-12-13 09:43:06 -0600377 /*
378 * Set length so that the last address is set to the
379 * starting address of the last block
380 */
381 length -= mtd->erasesize;
382
Stefan Roesed351b2b2006-10-10 12:36:02 +0200383 /* submit address of first page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600384 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200385
386 /* submit ADDRESS of LAST page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600387 page += (int)(length >> chip->page_shift);
Joe Hershbergercccf5952012-08-22 16:49:42 -0500388
389 /*
390 * Page addresses for unlocking are supposed to be block-aligned.
391 * At least some NAND chips use the low bit to indicate that the
392 * page range should be inverted.
393 */
394 if (allexcept)
395 page |= 1;
396
Nishanth Menonb20f8402008-12-13 09:43:06 -0600397 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200398
399 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600400 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200401 /* see if device thinks it succeeded */
402 if (status & 0x01) {
403 /* there was an error */
404 ret = -1;
405 goto out;
406 }
407
408 out:
409 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600410 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200411 return ret;
412}
William Juul52c07962007-10-31 13:53:06 +0100413#endif
Stefan Roesed351b2b2006-10-10 12:36:02 +0200414
Scott Woodcc5f3392008-06-12 13:20:16 -0500415/**
Scott Woodfe3b5e12010-07-30 16:11:41 -0500416 * check_skip_len
Scott Woodcc5f3392008-06-12 13:20:16 -0500417 *
Scott Woodfe3b5e12010-07-30 16:11:41 -0500418 * Check if there are any bad blocks, and whether length including bad
419 * blocks fits into device
Scott Woodcc5f3392008-06-12 13:20:16 -0500420 *
421 * @param nand NAND device
422 * @param offset offset in flash
423 * @param length image length
Tom Rini32d96182013-03-14 05:32:50 +0000424 * @param used length of flash needed for the requested length
Scott Woodfe3b5e12010-07-30 16:11:41 -0500425 * @return 0 if the image fits and there are no bad blocks
426 * 1 if the image fits, but there are bad blocks
427 * -1 if the image does not fit
Scott Woodcc5f3392008-06-12 13:20:16 -0500428 */
Tom Rini32d96182013-03-14 05:32:50 +0000429static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
430 size_t *used)
Scott Woodcc5f3392008-06-12 13:20:16 -0500431{
Scott Woodcc5f3392008-06-12 13:20:16 -0500432 size_t len_excl_bad = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500433 int ret = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500434
435 while (len_excl_bad < length) {
Scott Woodfe3b5e12010-07-30 16:11:41 -0500436 size_t block_len, block_off;
437 loff_t block_start;
Scott Woodcc5f3392008-06-12 13:20:16 -0500438
Scott Woodfe3b5e12010-07-30 16:11:41 -0500439 if (offset >= nand->size)
440 return -1;
Scott Woodcc5f3392008-06-12 13:20:16 -0500441
Scott Woodfe3b5e12010-07-30 16:11:41 -0500442 block_start = offset & ~(loff_t)(nand->erasesize - 1);
443 block_off = offset & (nand->erasesize - 1);
444 block_len = nand->erasesize - block_off;
Scott Woodcc5f3392008-06-12 13:20:16 -0500445
Scott Woodfe3b5e12010-07-30 16:11:41 -0500446 if (!nand_block_isbad(nand, block_start))
447 len_excl_bad += block_len;
448 else
449 ret = 1;
450
451 offset += block_len;
Tom Rini32d96182013-03-14 05:32:50 +0000452 *used += block_len;
Scott Woodcc5f3392008-06-12 13:20:16 -0500453 }
454
Tom Rini32d96182013-03-14 05:32:50 +0000455 /* If the length is not a multiple of block_len, adjust. */
456 if (len_excl_bad > length)
457 *used -= (len_excl_bad - length);
458
Scott Woodfe3b5e12010-07-30 16:11:41 -0500459 return ret;
Scott Woodcc5f3392008-06-12 13:20:16 -0500460}
Ben Gardiner34dd5672011-06-14 16:35:06 -0400461
462#ifdef CONFIG_CMD_NAND_TRIMFFS
463static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
464 const size_t *len)
465{
htbegin610e8552013-03-01 23:00:34 +0000466 size_t l = *len;
467 ssize_t i;
Ben Gardiner34dd5672011-06-14 16:35:06 -0400468
469 for (i = l - 1; i >= 0; i--)
470 if (buf[i] != 0xFF)
471 break;
472
473 /* The resulting length must be aligned to the minimum flash I/O size */
474 l = i + 1;
475 l = (l + nand->writesize - 1) / nand->writesize;
476 l *= nand->writesize;
477
478 /*
479 * since the input length may be unaligned, prevent access past the end
480 * of the buffer
481 */
482 return min(l, *len);
483}
484#endif
Scott Woodcc5f3392008-06-12 13:20:16 -0500485
486/**
487 * nand_write_skip_bad:
488 *
489 * Write image to NAND flash.
490 * Blocks that are marked bad are skipped and the is written to the next
491 * block instead as long as the image is short enough to fit even after
Tom Rini32d96182013-03-14 05:32:50 +0000492 * skipping the bad blocks. Due to bad blocks we may not be able to
493 * perform the requested write. In the case where the write would
494 * extend beyond the end of the NAND device, both length and actual (if
495 * not NULL) are set to 0. In the case where the write would extend
496 * beyond the limit we are passed, length is set to 0 and actual is set
497 * to the required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500498 *
499 * @param nand NAND device
500 * @param offset offset in flash
501 * @param length buffer length
Tom Rini32d96182013-03-14 05:32:50 +0000502 * @param actual set to size required to write length worth of
503 * buffer or 0 on error, if not NULL
504 * @param lim maximum size that actual may be in order to not
505 * exceed the buffer
Lei Wen4b5deaa2011-01-06 11:11:58 +0800506 * @param buffer buffer to read from
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400507 * @param flags flags modifying the behaviour of the write to NAND
Scott Woodcc5f3392008-06-12 13:20:16 -0500508 * @return 0 in case of success
509 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200510int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000511 size_t *actual, loff_t lim, u_char *buffer, int flags)
Scott Woodcc5f3392008-06-12 13:20:16 -0500512{
Lei Wen4b5deaa2011-01-06 11:11:58 +0800513 int rval = 0, blocksize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500514 size_t left_to_write = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000515 size_t used_for_write = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500516 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500517 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500518
Tom Rini32d96182013-03-14 05:32:50 +0000519 if (actual)
520 *actual = 0;
521
Lei Wen4b5deaa2011-01-06 11:11:58 +0800522#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400523 if (flags & WITH_YAFFS_OOB) {
Ben Gardiner871dea42011-06-14 16:35:05 -0400524 if (flags & ~WITH_YAFFS_OOB)
525 return -EINVAL;
526
Lei Wen4b5deaa2011-01-06 11:11:58 +0800527 int pages;
528 pages = nand->erasesize / nand->writesize;
529 blocksize = (pages * nand->oobsize) + nand->erasesize;
530 if (*length % (nand->writesize + nand->oobsize)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000531 printf("Attempt to write incomplete page"
Lei Wen4b5deaa2011-01-06 11:11:58 +0800532 " in yaffs mode\n");
533 return -EINVAL;
534 }
535 } else
536#endif
537 {
538 blocksize = nand->erasesize;
539 }
540
Scott Woodfe3b5e12010-07-30 16:11:41 -0500541 /*
542 * nand_write() handles unaligned, partial page writes.
543 *
544 * We allow length to be unaligned, for convenience in
545 * using the $filesize variable.
546 *
547 * However, starting at an unaligned offset makes the
548 * semantics of bad block skipping ambiguous (really,
549 * you should only start a block skipping access at a
550 * partition boundary). So don't try to handle that.
551 */
552 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000553 printf("Attempt to write non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500554 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500555 return -EINVAL;
556 }
557
Tom Rini32d96182013-03-14 05:32:50 +0000558 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
559
560 if (actual)
561 *actual = used_for_write;
562
Scott Woodfe3b5e12010-07-30 16:11:41 -0500563 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000564 printf("Attempt to write outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500565 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500566 return -EINVAL;
567 }
568
Tom Rini32d96182013-03-14 05:32:50 +0000569 if (used_for_write > lim) {
570 puts("Size of write exceeds partition or device limit\n");
571 *length = 0;
572 return -EFBIG;
573 }
574
Ben Gardiner34dd5672011-06-14 16:35:06 -0400575 if (!need_skip && !(flags & WITH_DROP_FFS)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000576 rval = nand_write(nand, offset, length, buffer);
Scott Woodfe3b5e12010-07-30 16:11:41 -0500577 if (rval == 0)
578 return 0;
Scott Wood90e0a6b2008-11-25 10:47:02 -0600579
Scott Woodfe3b5e12010-07-30 16:11:41 -0500580 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000581 printf("NAND write to offset %llx failed %d\n",
Scott Woodfe3b5e12010-07-30 16:11:41 -0500582 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600583 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500584 }
585
586 while (left_to_write > 0) {
587 size_t block_offset = offset & (nand->erasesize - 1);
Ben Gardiner34dd5672011-06-14 16:35:06 -0400588 size_t write_size, truncated_write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500589
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000590 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500591
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000592 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
593 printf("Skip bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500594 offset & ~(nand->erasesize - 1));
595 offset += nand->erasesize - block_offset;
596 continue;
597 }
598
Lei Wen4b5deaa2011-01-06 11:11:58 +0800599 if (left_to_write < (blocksize - block_offset))
Scott Woodcc5f3392008-06-12 13:20:16 -0500600 write_size = left_to_write;
601 else
Lei Wen4b5deaa2011-01-06 11:11:58 +0800602 write_size = blocksize - block_offset;
603
604#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400605 if (flags & WITH_YAFFS_OOB) {
Lei Wen4b5deaa2011-01-06 11:11:58 +0800606 int page, pages;
607 size_t pagesize = nand->writesize;
608 size_t pagesize_oob = pagesize + nand->oobsize;
609 struct mtd_oob_ops ops;
610
611 ops.len = pagesize;
612 ops.ooblen = nand->oobsize;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000613 ops.mode = MTD_OPS_AUTO_OOB;
Lei Wen4b5deaa2011-01-06 11:11:58 +0800614 ops.ooboffs = 0;
615
616 pages = write_size / pagesize_oob;
617 for (page = 0; page < pages; page++) {
Scott Woodea95b642011-02-02 18:15:57 -0600618 WATCHDOG_RESET();
619
Lei Wen4b5deaa2011-01-06 11:11:58 +0800620 ops.datbuf = p_buffer;
621 ops.oobbuf = ops.datbuf + pagesize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500622
Sergey Lapin3a38a552013-01-14 03:46:50 +0000623 rval = mtd_write_oob(nand, offset, &ops);
Liu, Wentaode95b322012-01-17 19:55:02 +0000624 if (rval != 0)
Lei Wen4b5deaa2011-01-06 11:11:58 +0800625 break;
626
627 offset += pagesize;
628 p_buffer += pagesize_oob;
629 }
630 }
631 else
632#endif
633 {
Ben Gardiner34dd5672011-06-14 16:35:06 -0400634 truncated_write_size = write_size;
635#ifdef CONFIG_CMD_NAND_TRIMFFS
636 if (flags & WITH_DROP_FFS)
637 truncated_write_size = drop_ffs(nand, p_buffer,
638 &write_size);
639#endif
640
641 rval = nand_write(nand, offset, &truncated_write_size,
642 p_buffer);
Lei Wen4b5deaa2011-01-06 11:11:58 +0800643 offset += write_size;
644 p_buffer += write_size;
645 }
646
Scott Woodcc5f3392008-06-12 13:20:16 -0500647 if (rval != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000648 printf("NAND write to offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200649 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500650 *length -= left_to_write;
651 return rval;
652 }
653
654 left_to_write -= write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500655 }
656
657 return 0;
658}
659
660/**
661 * nand_read_skip_bad:
662 *
663 * Read image from NAND flash.
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000664 * Blocks that are marked bad are skipped and the next block is read
Tom Rini32d96182013-03-14 05:32:50 +0000665 * instead as long as the image is short enough to fit even after
666 * skipping the bad blocks. Due to bad blocks we may not be able to
667 * perform the requested read. In the case where the read would extend
668 * beyond the end of the NAND device, both length and actual (if not
669 * NULL) are set to 0. In the case where the read would extend beyond
670 * the limit we are passed, length is set to 0 and actual is set to the
671 * required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500672 *
673 * @param nand NAND device
674 * @param offset offset in flash
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000675 * @param length buffer length, on return holds number of read bytes
Tom Rini32d96182013-03-14 05:32:50 +0000676 * @param actual set to size required to read length worth of buffer or 0
677 * on error, if not NULL
678 * @param lim maximum size that actual may be in order to not exceed the
679 * buffer
Scott Woodcc5f3392008-06-12 13:20:16 -0500680 * @param buffer buffer to write to
681 * @return 0 in case of success
682 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200683int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000684 size_t *actual, loff_t lim, u_char *buffer)
Scott Woodcc5f3392008-06-12 13:20:16 -0500685{
686 int rval;
687 size_t left_to_read = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000688 size_t used_for_read = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500689 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500690 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500691
Scott Woodfe3b5e12010-07-30 16:11:41 -0500692 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000693 printf("Attempt to read non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500694 *length = 0;
Tom Rini32d96182013-03-14 05:32:50 +0000695 if (actual)
696 *actual = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500697 return -EINVAL;
698 }
Scott Woodcc5f3392008-06-12 13:20:16 -0500699
Tom Rini32d96182013-03-14 05:32:50 +0000700 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
701
702 if (actual)
703 *actual = used_for_read;
704
Scott Woodfe3b5e12010-07-30 16:11:41 -0500705 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000706 printf("Attempt to read outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500707 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500708 return -EINVAL;
709 }
710
Tom Rini32d96182013-03-14 05:32:50 +0000711 if (used_for_read > lim) {
712 puts("Size of read exceeds partition or device limit\n");
713 *length = 0;
714 return -EFBIG;
715 }
716
Scott Woodfe3b5e12010-07-30 16:11:41 -0500717 if (!need_skip) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000718 rval = nand_read(nand, offset, length, buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300719 if (!rval || rval == -EUCLEAN)
720 return 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500721
722 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000723 printf("NAND read from offset %llx failed %d\n",
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300724 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600725 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500726 }
727
728 while (left_to_read > 0) {
729 size_t block_offset = offset & (nand->erasesize - 1);
730 size_t read_length;
731
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000732 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500733
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000734 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
735 printf("Skipping bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500736 offset & ~(nand->erasesize - 1));
737 offset += nand->erasesize - block_offset;
738 continue;
739 }
740
741 if (left_to_read < (nand->erasesize - block_offset))
742 read_length = left_to_read;
743 else
744 read_length = nand->erasesize - block_offset;
745
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000746 rval = nand_read(nand, offset, &read_length, p_buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300747 if (rval && rval != -EUCLEAN) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000748 printf("NAND read from offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200749 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500750 *length -= left_to_read;
751 return rval;
752 }
753
754 left_to_read -= read_length;
755 offset += read_length;
756 p_buffer += read_length;
757 }
758
759 return 0;
760}
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100761
762#ifdef CONFIG_CMD_NAND_TORTURE
763
764/**
765 * check_pattern:
766 *
767 * Check if buffer contains only a certain byte pattern.
768 *
769 * @param buf buffer to check
770 * @param patt the pattern to check
771 * @param size buffer size in bytes
772 * @return 1 if there are only patt bytes in buf
773 * 0 if something else was found
774 */
775static int check_pattern(const u_char *buf, u_char patt, int size)
776{
777 int i;
778
779 for (i = 0; i < size; i++)
780 if (buf[i] != patt)
781 return 0;
782 return 1;
783}
784
785/**
786 * nand_torture:
787 *
788 * Torture a block of NAND flash.
789 * This is useful to determine if a block that caused a write error is still
790 * good or should be marked as bad.
791 *
792 * @param nand NAND device
793 * @param offset offset in flash
794 * @return 0 if the block is still good
795 */
796int nand_torture(nand_info_t *nand, loff_t offset)
797{
798 u_char patterns[] = {0xa5, 0x5a, 0x00};
799 struct erase_info instr = {
800 .mtd = nand,
801 .addr = offset,
802 .len = nand->erasesize,
803 };
804 size_t retlen;
805 int err, ret = -1, i, patt_count;
806 u_char *buf;
807
808 if ((offset & (nand->erasesize - 1)) != 0) {
809 puts("Attempt to torture a block at a non block-aligned offset\n");
810 return -EINVAL;
811 }
812
813 if (offset + nand->erasesize > nand->size) {
814 puts("Attempt to torture a block outside the flash area\n");
815 return -EINVAL;
816 }
817
818 patt_count = ARRAY_SIZE(patterns);
819
820 buf = malloc(nand->erasesize);
821 if (buf == NULL) {
822 puts("Out of memory for erase block buffer\n");
823 return -ENOMEM;
824 }
825
826 for (i = 0; i < patt_count; i++) {
827 err = nand->erase(nand, &instr);
828 if (err) {
829 printf("%s: erase() failed for block at 0x%llx: %d\n",
830 nand->name, instr.addr, err);
831 goto out;
832 }
833
834 /* Make sure the block contains only 0xff bytes */
835 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
836 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
837 printf("%s: read() failed for block at 0x%llx: %d\n",
838 nand->name, instr.addr, err);
839 goto out;
840 }
841
842 err = check_pattern(buf, 0xff, nand->erasesize);
843 if (!err) {
844 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
845 offset);
846 ret = -EIO;
847 goto out;
848 }
849
850 /* Write a pattern and check it */
851 memset(buf, patterns[i], nand->erasesize);
852 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
853 if (err || retlen != nand->erasesize) {
854 printf("%s: write() failed for block at 0x%llx: %d\n",
855 nand->name, instr.addr, err);
856 goto out;
857 }
858
859 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
860 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
861 printf("%s: read() failed for block at 0x%llx: %d\n",
862 nand->name, instr.addr, err);
863 goto out;
864 }
865
866 err = check_pattern(buf, patterns[i], nand->erasesize);
867 if (!err) {
868 printf("Pattern 0x%.2x checking failed for block at "
869 "0x%llx\n", patterns[i], offset);
870 ret = -EIO;
871 goto out;
872 }
873 }
874
875 ret = 0;
876
877out:
878 free(buf);
879 return ret;
880}
881
882#endif