blob: 4727f9c9892517df97b5951e88f11b384177ba01 [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
123 if (!opts->scrub && bbtest) {
124 int ret = meminfo->block_isbad(meminfo, erase.addr);
125 if (ret > 0) {
126 if (!opts->quiet)
127 printf("\rSkipping bad block at "
Stefan Roese586b3a62009-05-11 16:03:55 +0200128 "0x%08llx "
Wolfgang Denkd5cf1a42006-10-12 11:43:47 +0200129 " \n",
130 erase.addr);
Scott Wood1b5cd512010-08-25 14:43:29 -0500131
132 if (!opts->spread)
133 erased_length++;
134
Stefan Roesed351b2b2006-10-10 12:36:02 +0200135 continue;
136
137 } else if (ret < 0) {
138 printf("\n%s: MTD get bad block failed: %d\n",
139 mtd_device,
140 ret);
141 return -1;
142 }
143 }
144
Scott Wood1b5cd512010-08-25 14:43:29 -0500145 erased_length++;
146
Stefan Roesed351b2b2006-10-10 12:36:02 +0200147 result = meminfo->erase(meminfo, &erase);
148 if (result != 0) {
149 printf("\n%s: MTD Erase failure: %d\n",
150 mtd_device, result);
151 continue;
152 }
153
154 /* format for JFFS2 ? */
Scott Woodd50ad352008-10-29 14:20:26 -0500155 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
156 chip->ops.ooblen = 8;
William Juul52c07962007-10-31 13:53:06 +0100157 chip->ops.datbuf = NULL;
Scott Woodd50ad352008-10-29 14:20:26 -0500158 chip->ops.oobbuf = (uint8_t *)&cleanmarker;
159 chip->ops.ooboffs = 0;
160 chip->ops.mode = MTD_OOB_AUTO;
William Juulb76ec382007-11-08 10:39:53 +0100161
William Juul52c07962007-10-31 13:53:06 +0100162 result = meminfo->write_oob(meminfo,
Scott Woodd50ad352008-10-29 14:20:26 -0500163 erase.addr,
164 &chip->ops);
William Juul52c07962007-10-31 13:53:06 +0100165 if (result != 0) {
166 printf("\n%s: MTD writeoob failure: %d\n",
Scott Woodd50ad352008-10-29 14:20:26 -0500167 mtd_device, result);
William Juul52c07962007-10-31 13:53:06 +0100168 continue;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200169 }
170 }
171
172 if (!opts->quiet) {
Scott Wood1b5cd512010-08-25 14:43:29 -0500173 unsigned long long n = erased_length * 100ULL;
Matthias Fuchs82714b92007-09-11 17:04:00 +0200174 int percent;
175
176 do_div(n, erase_length);
177 percent = (int)n;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200178
179 /* output progress message only at whole percent
180 * steps to reduce the number of messages printed
181 * on (slow) serial consoles
182 */
183 if (percent != percent_complete) {
184 percent_complete = percent;
185
Stefan Roese586b3a62009-05-11 16:03:55 +0200186 printf("\rErasing at 0x%llx -- %3d%% complete.",
Scott Woodd50ad352008-10-29 14:20:26 -0500187 erase.addr, percent);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200188
189 if (opts->jffs2 && result == 0)
Stefan Roese586b3a62009-05-11 16:03:55 +0200190 printf(" Cleanmarker written at 0x%llx.",
Scott Woodd50ad352008-10-29 14:20:26 -0500191 erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200192 }
193 }
194 }
195 if (!opts->quiet)
196 printf("\n");
197
Marek Vasut971d9a12011-09-12 06:04:06 +0200198 if (opts->scrub)
199 chip->scan_bbt(meminfo);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200200
201 return 0;
202}
203
Nishanth Menonb20f8402008-12-13 09:43:06 -0600204#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
205
Stefan Roesed351b2b2006-10-10 12:36:02 +0200206/******************************************************************************
207 * Support for locking / unlocking operations of some NAND devices
208 *****************************************************************************/
209
Stefan Roesed351b2b2006-10-10 12:36:02 +0200210/**
211 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
212 * state
213 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600214 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200215 * @param tight bring device in lock tight mode
216 *
217 * @return 0 on success, -1 in case of error
218 *
219 * The lock / lock-tight command only applies to the whole chip. To get some
220 * parts of the chip lock and others unlocked use the following sequence:
221 *
222 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
223 * - Call nand_unlock() once for each consecutive area to be unlocked
224 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
225 *
226 * If the device is in lock-tight state software can't change the
227 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
228 * calls will fail. It is only posible to leave lock-tight state by
229 * an hardware signal (low pulse on _WP pin) or by power down.
230 */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600231int nand_lock(struct mtd_info *mtd, int tight)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200232{
233 int ret = 0;
234 int status;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600235 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200236
237 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600238 chip->select_chip(mtd, 0);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200239
Joe Hershberger8b177d42013-02-08 09:27:19 +0000240 /* check the Lock Tight Status */
241 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
242 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
243 printf("nand_lock: Device is locked tight!\n");
244 ret = -1;
245 goto out;
246 }
247
Nishanth Menonb20f8402008-12-13 09:43:06 -0600248 chip->cmdfunc(mtd,
Stefan Roesed351b2b2006-10-10 12:36:02 +0200249 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
250 -1, -1);
251
252 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600253 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200254
255 /* see if device thinks it succeeded */
256 if (status & 0x01) {
257 ret = -1;
258 }
259
Joe Hershberger8b177d42013-02-08 09:27:19 +0000260 out:
Stefan Roesed351b2b2006-10-10 12:36:02 +0200261 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600262 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200263 return ret;
264}
265
266/**
267 * nand_get_lock_status: - query current lock state from one page of NAND
268 * flash
269 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600270 * @param mtd nand mtd instance
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000271 * @param offset page address to query (must be page-aligned!)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200272 *
273 * @return -1 in case of error
274 * >0 lock status:
275 * bitfield with the following combinations:
276 * NAND_LOCK_STATUS_TIGHT: page in tight state
Stefan Roesed351b2b2006-10-10 12:36:02 +0200277 * NAND_LOCK_STATUS_UNLOCK: page unlocked
278 *
279 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200280int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200281{
282 int ret = 0;
283 int chipnr;
284 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600285 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200286
287 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600288 chipnr = (int)(offset >> chip->chip_shift);
289 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200290
291
Nishanth Menonb20f8402008-12-13 09:43:06 -0600292 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000293 printf("nand_get_lock_status: "
Stefan Roesed351b2b2006-10-10 12:36:02 +0200294 "Start address must be beginning of "
295 "nand page!\n");
296 ret = -1;
297 goto out;
298 }
299
300 /* check the Lock Status */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600301 page = (int)(offset >> chip->page_shift);
302 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200303
Nishanth Menonb20f8402008-12-13 09:43:06 -0600304 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
Stefan Roesed351b2b2006-10-10 12:36:02 +0200305 | NAND_LOCK_STATUS_UNLOCK);
306
307 out:
308 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600309 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200310 return ret;
311}
312
313/**
314 * nand_unlock: - Unlock area of NAND pages
315 * only one consecutive area can be unlocked at one time!
316 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600317 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200318 * @param start start byte address
319 * @param length number of bytes to unlock (must be a multiple of
William Juul52c07962007-10-31 13:53:06 +0100320 * page size nand->writesize)
Joe Hershbergercccf5952012-08-22 16:49:42 -0500321 * @param allexcept if set, unlock everything not selected
Stefan Roesed351b2b2006-10-10 12:36:02 +0200322 *
323 * @return 0 on success, -1 in case of error
324 */
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500325int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
326 int allexcept)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200327{
328 int ret = 0;
329 int chipnr;
330 int status;
331 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600332 struct nand_chip *chip = mtd->priv;
Joe Hershbergercccf5952012-08-22 16:49:42 -0500333
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500334 debug("nand_unlock%s: start: %08llx, length: %d!\n",
Joe Hershbergercccf5952012-08-22 16:49:42 -0500335 allexcept ? " (allexcept)" : "", start, length);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200336
337 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600338 chipnr = (int)(start >> chip->chip_shift);
339 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200340
341 /* check the WP bit */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600342 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
343 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000344 printf("nand_unlock: Device is write protected!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200345 ret = -1;
346 goto out;
347 }
348
Joe Hershberger8b177d42013-02-08 09:27:19 +0000349 /* check the Lock Tight Status */
350 page = (int)(start >> chip->page_shift);
351 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
352 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
353 printf("nand_unlock: Device is locked tight!\n");
354 ret = -1;
355 goto out;
356 }
357
Nishanth Menonb20f8402008-12-13 09:43:06 -0600358 if ((start & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000359 printf("nand_unlock: Start address must be beginning of "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600360 "nand block!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200361 ret = -1;
362 goto out;
363 }
364
Nishanth Menonb20f8402008-12-13 09:43:06 -0600365 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000366 printf("nand_unlock: Length must be a multiple of nand block "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600367 "size %08x!\n", mtd->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200368 ret = -1;
369 goto out;
370 }
371
Nishanth Menonb20f8402008-12-13 09:43:06 -0600372 /*
373 * Set length so that the last address is set to the
374 * starting address of the last block
375 */
376 length -= mtd->erasesize;
377
Stefan Roesed351b2b2006-10-10 12:36:02 +0200378 /* submit address of first page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600379 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200380
381 /* submit ADDRESS of LAST page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600382 page += (int)(length >> chip->page_shift);
Joe Hershbergercccf5952012-08-22 16:49:42 -0500383
384 /*
385 * Page addresses for unlocking are supposed to be block-aligned.
386 * At least some NAND chips use the low bit to indicate that the
387 * page range should be inverted.
388 */
389 if (allexcept)
390 page |= 1;
391
Nishanth Menonb20f8402008-12-13 09:43:06 -0600392 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200393
394 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600395 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200396 /* see if device thinks it succeeded */
397 if (status & 0x01) {
398 /* there was an error */
399 ret = -1;
400 goto out;
401 }
402
403 out:
404 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600405 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200406 return ret;
407}
William Juul52c07962007-10-31 13:53:06 +0100408#endif
Stefan Roesed351b2b2006-10-10 12:36:02 +0200409
Scott Woodcc5f3392008-06-12 13:20:16 -0500410/**
Scott Woodfe3b5e12010-07-30 16:11:41 -0500411 * check_skip_len
Scott Woodcc5f3392008-06-12 13:20:16 -0500412 *
Scott Woodfe3b5e12010-07-30 16:11:41 -0500413 * Check if there are any bad blocks, and whether length including bad
414 * blocks fits into device
Scott Woodcc5f3392008-06-12 13:20:16 -0500415 *
416 * @param nand NAND device
417 * @param offset offset in flash
418 * @param length image length
Tom Rini32d96182013-03-14 05:32:50 +0000419 * @param used length of flash needed for the requested length
Scott Woodfe3b5e12010-07-30 16:11:41 -0500420 * @return 0 if the image fits and there are no bad blocks
421 * 1 if the image fits, but there are bad blocks
422 * -1 if the image does not fit
Scott Woodcc5f3392008-06-12 13:20:16 -0500423 */
Tom Rini32d96182013-03-14 05:32:50 +0000424static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
425 size_t *used)
Scott Woodcc5f3392008-06-12 13:20:16 -0500426{
Scott Woodcc5f3392008-06-12 13:20:16 -0500427 size_t len_excl_bad = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500428 int ret = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500429
430 while (len_excl_bad < length) {
Scott Woodfe3b5e12010-07-30 16:11:41 -0500431 size_t block_len, block_off;
432 loff_t block_start;
Scott Woodcc5f3392008-06-12 13:20:16 -0500433
Scott Woodfe3b5e12010-07-30 16:11:41 -0500434 if (offset >= nand->size)
435 return -1;
Scott Woodcc5f3392008-06-12 13:20:16 -0500436
Scott Woodfe3b5e12010-07-30 16:11:41 -0500437 block_start = offset & ~(loff_t)(nand->erasesize - 1);
438 block_off = offset & (nand->erasesize - 1);
439 block_len = nand->erasesize - block_off;
Scott Woodcc5f3392008-06-12 13:20:16 -0500440
Scott Woodfe3b5e12010-07-30 16:11:41 -0500441 if (!nand_block_isbad(nand, block_start))
442 len_excl_bad += block_len;
443 else
444 ret = 1;
445
446 offset += block_len;
Tom Rini32d96182013-03-14 05:32:50 +0000447 *used += block_len;
Scott Woodcc5f3392008-06-12 13:20:16 -0500448 }
449
Tom Rini32d96182013-03-14 05:32:50 +0000450 /* If the length is not a multiple of block_len, adjust. */
451 if (len_excl_bad > length)
452 *used -= (len_excl_bad - length);
453
Scott Woodfe3b5e12010-07-30 16:11:41 -0500454 return ret;
Scott Woodcc5f3392008-06-12 13:20:16 -0500455}
Ben Gardiner34dd5672011-06-14 16:35:06 -0400456
457#ifdef CONFIG_CMD_NAND_TRIMFFS
458static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
459 const size_t *len)
460{
461 size_t i, l = *len;
462
463 for (i = l - 1; i >= 0; i--)
464 if (buf[i] != 0xFF)
465 break;
466
467 /* The resulting length must be aligned to the minimum flash I/O size */
468 l = i + 1;
469 l = (l + nand->writesize - 1) / nand->writesize;
470 l *= nand->writesize;
471
472 /*
473 * since the input length may be unaligned, prevent access past the end
474 * of the buffer
475 */
476 return min(l, *len);
477}
478#endif
Scott Woodcc5f3392008-06-12 13:20:16 -0500479
480/**
481 * nand_write_skip_bad:
482 *
483 * Write image to NAND flash.
484 * Blocks that are marked bad are skipped and the is written to the next
485 * block instead as long as the image is short enough to fit even after
Tom Rini32d96182013-03-14 05:32:50 +0000486 * skipping the bad blocks. Due to bad blocks we may not be able to
487 * perform the requested write. In the case where the write would
488 * extend beyond the end of the NAND device, both length and actual (if
489 * not NULL) are set to 0. In the case where the write would extend
490 * beyond the limit we are passed, length is set to 0 and actual is set
491 * to the required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500492 *
493 * @param nand NAND device
494 * @param offset offset in flash
495 * @param length buffer length
Tom Rini32d96182013-03-14 05:32:50 +0000496 * @param actual set to size required to write length worth of
497 * buffer or 0 on error, if not NULL
498 * @param lim maximum size that actual may be in order to not
499 * exceed the buffer
Lei Wen4b5deaa2011-01-06 11:11:58 +0800500 * @param buffer buffer to read from
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400501 * @param flags flags modifying the behaviour of the write to NAND
Scott Woodcc5f3392008-06-12 13:20:16 -0500502 * @return 0 in case of success
503 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200504int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000505 size_t *actual, loff_t lim, u_char *buffer, int flags)
Scott Woodcc5f3392008-06-12 13:20:16 -0500506{
Lei Wen4b5deaa2011-01-06 11:11:58 +0800507 int rval = 0, blocksize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500508 size_t left_to_write = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000509 size_t used_for_write = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500510 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500511 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500512
Tom Rini32d96182013-03-14 05:32:50 +0000513 if (actual)
514 *actual = 0;
515
Lei Wen4b5deaa2011-01-06 11:11:58 +0800516#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400517 if (flags & WITH_YAFFS_OOB) {
Ben Gardiner871dea42011-06-14 16:35:05 -0400518 if (flags & ~WITH_YAFFS_OOB)
519 return -EINVAL;
520
Lei Wen4b5deaa2011-01-06 11:11:58 +0800521 int pages;
522 pages = nand->erasesize / nand->writesize;
523 blocksize = (pages * nand->oobsize) + nand->erasesize;
524 if (*length % (nand->writesize + nand->oobsize)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000525 printf("Attempt to write incomplete page"
Lei Wen4b5deaa2011-01-06 11:11:58 +0800526 " in yaffs mode\n");
527 return -EINVAL;
528 }
529 } else
530#endif
531 {
532 blocksize = nand->erasesize;
533 }
534
Scott Woodfe3b5e12010-07-30 16:11:41 -0500535 /*
536 * nand_write() handles unaligned, partial page writes.
537 *
538 * We allow length to be unaligned, for convenience in
539 * using the $filesize variable.
540 *
541 * However, starting at an unaligned offset makes the
542 * semantics of bad block skipping ambiguous (really,
543 * you should only start a block skipping access at a
544 * partition boundary). So don't try to handle that.
545 */
546 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000547 printf("Attempt to write non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500548 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500549 return -EINVAL;
550 }
551
Tom Rini32d96182013-03-14 05:32:50 +0000552 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
553
554 if (actual)
555 *actual = used_for_write;
556
Scott Woodfe3b5e12010-07-30 16:11:41 -0500557 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000558 printf("Attempt to write outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500559 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500560 return -EINVAL;
561 }
562
Tom Rini32d96182013-03-14 05:32:50 +0000563 if (used_for_write > lim) {
564 puts("Size of write exceeds partition or device limit\n");
565 *length = 0;
566 return -EFBIG;
567 }
568
Ben Gardiner34dd5672011-06-14 16:35:06 -0400569 if (!need_skip && !(flags & WITH_DROP_FFS)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000570 rval = nand_write(nand, offset, length, buffer);
Scott Woodfe3b5e12010-07-30 16:11:41 -0500571 if (rval == 0)
572 return 0;
Scott Wood90e0a6b2008-11-25 10:47:02 -0600573
Scott Woodfe3b5e12010-07-30 16:11:41 -0500574 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000575 printf("NAND write to offset %llx failed %d\n",
Scott Woodfe3b5e12010-07-30 16:11:41 -0500576 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600577 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500578 }
579
580 while (left_to_write > 0) {
581 size_t block_offset = offset & (nand->erasesize - 1);
Ben Gardiner34dd5672011-06-14 16:35:06 -0400582 size_t write_size, truncated_write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500583
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000584 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500585
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000586 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
587 printf("Skip bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500588 offset & ~(nand->erasesize - 1));
589 offset += nand->erasesize - block_offset;
590 continue;
591 }
592
Lei Wen4b5deaa2011-01-06 11:11:58 +0800593 if (left_to_write < (blocksize - block_offset))
Scott Woodcc5f3392008-06-12 13:20:16 -0500594 write_size = left_to_write;
595 else
Lei Wen4b5deaa2011-01-06 11:11:58 +0800596 write_size = blocksize - block_offset;
597
598#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400599 if (flags & WITH_YAFFS_OOB) {
Lei Wen4b5deaa2011-01-06 11:11:58 +0800600 int page, pages;
601 size_t pagesize = nand->writesize;
602 size_t pagesize_oob = pagesize + nand->oobsize;
603 struct mtd_oob_ops ops;
604
605 ops.len = pagesize;
606 ops.ooblen = nand->oobsize;
607 ops.mode = MTD_OOB_AUTO;
608 ops.ooboffs = 0;
609
610 pages = write_size / pagesize_oob;
611 for (page = 0; page < pages; page++) {
Scott Woodea95b642011-02-02 18:15:57 -0600612 WATCHDOG_RESET();
613
Lei Wen4b5deaa2011-01-06 11:11:58 +0800614 ops.datbuf = p_buffer;
615 ops.oobbuf = ops.datbuf + pagesize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500616
Lei Wen4b5deaa2011-01-06 11:11:58 +0800617 rval = nand->write_oob(nand, offset, &ops);
Liu, Wentaode95b322012-01-17 19:55:02 +0000618 if (rval != 0)
Lei Wen4b5deaa2011-01-06 11:11:58 +0800619 break;
620
621 offset += pagesize;
622 p_buffer += pagesize_oob;
623 }
624 }
625 else
626#endif
627 {
Ben Gardiner34dd5672011-06-14 16:35:06 -0400628 truncated_write_size = write_size;
629#ifdef CONFIG_CMD_NAND_TRIMFFS
630 if (flags & WITH_DROP_FFS)
631 truncated_write_size = drop_ffs(nand, p_buffer,
632 &write_size);
633#endif
634
635 rval = nand_write(nand, offset, &truncated_write_size,
636 p_buffer);
Lei Wen4b5deaa2011-01-06 11:11:58 +0800637 offset += write_size;
638 p_buffer += write_size;
639 }
640
Scott Woodcc5f3392008-06-12 13:20:16 -0500641 if (rval != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000642 printf("NAND write to offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200643 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500644 *length -= left_to_write;
645 return rval;
646 }
647
648 left_to_write -= write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500649 }
650
651 return 0;
652}
653
654/**
655 * nand_read_skip_bad:
656 *
657 * Read image from NAND flash.
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000658 * Blocks that are marked bad are skipped and the next block is read
Tom Rini32d96182013-03-14 05:32:50 +0000659 * instead as long as the image is short enough to fit even after
660 * skipping the bad blocks. Due to bad blocks we may not be able to
661 * perform the requested read. In the case where the read would extend
662 * beyond the end of the NAND device, both length and actual (if not
663 * NULL) are set to 0. In the case where the read would extend beyond
664 * the limit we are passed, length is set to 0 and actual is set to the
665 * required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500666 *
667 * @param nand NAND device
668 * @param offset offset in flash
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000669 * @param length buffer length, on return holds number of read bytes
Tom Rini32d96182013-03-14 05:32:50 +0000670 * @param actual set to size required to read length worth of buffer or 0
671 * on error, if not NULL
672 * @param lim maximum size that actual may be in order to not exceed the
673 * buffer
Scott Woodcc5f3392008-06-12 13:20:16 -0500674 * @param buffer buffer to write to
675 * @return 0 in case of success
676 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200677int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000678 size_t *actual, loff_t lim, u_char *buffer)
Scott Woodcc5f3392008-06-12 13:20:16 -0500679{
680 int rval;
681 size_t left_to_read = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000682 size_t used_for_read = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500683 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500684 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500685
Scott Woodfe3b5e12010-07-30 16:11:41 -0500686 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000687 printf("Attempt to read non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500688 *length = 0;
Tom Rini32d96182013-03-14 05:32:50 +0000689 if (actual)
690 *actual = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500691 return -EINVAL;
692 }
Scott Woodcc5f3392008-06-12 13:20:16 -0500693
Tom Rini32d96182013-03-14 05:32:50 +0000694 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
695
696 if (actual)
697 *actual = used_for_read;
698
Scott Woodfe3b5e12010-07-30 16:11:41 -0500699 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000700 printf("Attempt to read outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500701 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500702 return -EINVAL;
703 }
704
Tom Rini32d96182013-03-14 05:32:50 +0000705 if (used_for_read > lim) {
706 puts("Size of read exceeds partition or device limit\n");
707 *length = 0;
708 return -EFBIG;
709 }
710
Scott Woodfe3b5e12010-07-30 16:11:41 -0500711 if (!need_skip) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000712 rval = nand_read(nand, offset, length, buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300713 if (!rval || rval == -EUCLEAN)
714 return 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500715
716 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000717 printf("NAND read from offset %llx failed %d\n",
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300718 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600719 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500720 }
721
722 while (left_to_read > 0) {
723 size_t block_offset = offset & (nand->erasesize - 1);
724 size_t read_length;
725
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000726 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500727
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000728 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
729 printf("Skipping bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500730 offset & ~(nand->erasesize - 1));
731 offset += nand->erasesize - block_offset;
732 continue;
733 }
734
735 if (left_to_read < (nand->erasesize - block_offset))
736 read_length = left_to_read;
737 else
738 read_length = nand->erasesize - block_offset;
739
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000740 rval = nand_read(nand, offset, &read_length, p_buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300741 if (rval && rval != -EUCLEAN) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000742 printf("NAND read from offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200743 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500744 *length -= left_to_read;
745 return rval;
746 }
747
748 left_to_read -= read_length;
749 offset += read_length;
750 p_buffer += read_length;
751 }
752
753 return 0;
754}
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100755
756#ifdef CONFIG_CMD_NAND_TORTURE
757
758/**
759 * check_pattern:
760 *
761 * Check if buffer contains only a certain byte pattern.
762 *
763 * @param buf buffer to check
764 * @param patt the pattern to check
765 * @param size buffer size in bytes
766 * @return 1 if there are only patt bytes in buf
767 * 0 if something else was found
768 */
769static int check_pattern(const u_char *buf, u_char patt, int size)
770{
771 int i;
772
773 for (i = 0; i < size; i++)
774 if (buf[i] != patt)
775 return 0;
776 return 1;
777}
778
779/**
780 * nand_torture:
781 *
782 * Torture a block of NAND flash.
783 * This is useful to determine if a block that caused a write error is still
784 * good or should be marked as bad.
785 *
786 * @param nand NAND device
787 * @param offset offset in flash
788 * @return 0 if the block is still good
789 */
790int nand_torture(nand_info_t *nand, loff_t offset)
791{
792 u_char patterns[] = {0xa5, 0x5a, 0x00};
793 struct erase_info instr = {
794 .mtd = nand,
795 .addr = offset,
796 .len = nand->erasesize,
797 };
798 size_t retlen;
799 int err, ret = -1, i, patt_count;
800 u_char *buf;
801
802 if ((offset & (nand->erasesize - 1)) != 0) {
803 puts("Attempt to torture a block at a non block-aligned offset\n");
804 return -EINVAL;
805 }
806
807 if (offset + nand->erasesize > nand->size) {
808 puts("Attempt to torture a block outside the flash area\n");
809 return -EINVAL;
810 }
811
812 patt_count = ARRAY_SIZE(patterns);
813
814 buf = malloc(nand->erasesize);
815 if (buf == NULL) {
816 puts("Out of memory for erase block buffer\n");
817 return -ENOMEM;
818 }
819
820 for (i = 0; i < patt_count; i++) {
821 err = nand->erase(nand, &instr);
822 if (err) {
823 printf("%s: erase() failed for block at 0x%llx: %d\n",
824 nand->name, instr.addr, err);
825 goto out;
826 }
827
828 /* Make sure the block contains only 0xff bytes */
829 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
830 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
831 printf("%s: read() failed for block at 0x%llx: %d\n",
832 nand->name, instr.addr, err);
833 goto out;
834 }
835
836 err = check_pattern(buf, 0xff, nand->erasesize);
837 if (!err) {
838 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
839 offset);
840 ret = -EIO;
841 goto out;
842 }
843
844 /* Write a pattern and check it */
845 memset(buf, patterns[i], nand->erasesize);
846 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
847 if (err || retlen != nand->erasesize) {
848 printf("%s: write() failed for block at 0x%llx: %d\n",
849 nand->name, instr.addr, err);
850 goto out;
851 }
852
853 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
854 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
855 printf("%s: read() failed for block at 0x%llx: %d\n",
856 nand->name, instr.addr, err);
857 goto out;
858 }
859
860 err = check_pattern(buf, patterns[i], nand->erasesize);
861 if (!err) {
862 printf("Pattern 0x%.2x checking failed for block at "
863 "0x%llx\n", patterns[i], offset);
864 ret = -EIO;
865 goto out;
866 }
867 }
868
869 ret = 0;
870
871out:
872 free(buf);
873 return ret;
874}
875
876#endif