blob: d81972ca27baa9f851af9aa872da262386f31d2c [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) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000124 int ret = mtd_block_isbad(meminfo, erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200125 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
Sergey Lapin3a38a552013-01-14 03:46:50 +0000147 result = mtd_erase(meminfo, &erase);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200148 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) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000156 struct mtd_oob_ops ops;
157 ops.ooblen = 8;
158 ops.datbuf = NULL;
159 ops.oobbuf = (uint8_t *)&cleanmarker;
160 ops.ooboffs = 0;
161 ops.mode = MTD_OPS_AUTO_OOB;
William Juulb76ec382007-11-08 10:39:53 +0100162
Sergey Lapin3a38a552013-01-14 03:46:50 +0000163 result = mtd_write_oob(meminfo,
Scott Woodd50ad352008-10-29 14:20:26 -0500164 erase.addr,
Sergey Lapin3a38a552013-01-14 03:46:50 +0000165 &ops);
William Juul52c07962007-10-31 13:53:06 +0100166 if (result != 0) {
167 printf("\n%s: MTD writeoob failure: %d\n",
Scott Woodd50ad352008-10-29 14:20:26 -0500168 mtd_device, result);
William Juul52c07962007-10-31 13:53:06 +0100169 continue;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200170 }
171 }
172
173 if (!opts->quiet) {
Scott Wood1b5cd512010-08-25 14:43:29 -0500174 unsigned long long n = erased_length * 100ULL;
Matthias Fuchs82714b92007-09-11 17:04:00 +0200175 int percent;
176
177 do_div(n, erase_length);
178 percent = (int)n;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200179
180 /* output progress message only at whole percent
181 * steps to reduce the number of messages printed
182 * on (slow) serial consoles
183 */
184 if (percent != percent_complete) {
185 percent_complete = percent;
186
Stefan Roese586b3a62009-05-11 16:03:55 +0200187 printf("\rErasing at 0x%llx -- %3d%% complete.",
Scott Woodd50ad352008-10-29 14:20:26 -0500188 erase.addr, percent);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200189
190 if (opts->jffs2 && result == 0)
Stefan Roese586b3a62009-05-11 16:03:55 +0200191 printf(" Cleanmarker written at 0x%llx.",
Scott Woodd50ad352008-10-29 14:20:26 -0500192 erase.addr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200193 }
194 }
195 }
196 if (!opts->quiet)
197 printf("\n");
198
Marek Vasut971d9a12011-09-12 06:04:06 +0200199 if (opts->scrub)
200 chip->scan_bbt(meminfo);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200201
202 return 0;
203}
204
Nishanth Menonb20f8402008-12-13 09:43:06 -0600205#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
206
Stefan Roesed351b2b2006-10-10 12:36:02 +0200207/******************************************************************************
208 * Support for locking / unlocking operations of some NAND devices
209 *****************************************************************************/
210
Stefan Roesed351b2b2006-10-10 12:36:02 +0200211/**
212 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
213 * state
214 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600215 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200216 * @param tight bring device in lock tight mode
217 *
218 * @return 0 on success, -1 in case of error
219 *
220 * The lock / lock-tight command only applies to the whole chip. To get some
221 * parts of the chip lock and others unlocked use the following sequence:
222 *
223 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
224 * - Call nand_unlock() once for each consecutive area to be unlocked
225 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
226 *
227 * If the device is in lock-tight state software can't change the
228 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
229 * calls will fail. It is only posible to leave lock-tight state by
230 * an hardware signal (low pulse on _WP pin) or by power down.
231 */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600232int nand_lock(struct mtd_info *mtd, int tight)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200233{
234 int ret = 0;
235 int status;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600236 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200237
238 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600239 chip->select_chip(mtd, 0);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200240
Joe Hershberger8b177d42013-02-08 09:27:19 +0000241 /* check the Lock Tight Status */
242 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
243 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
244 printf("nand_lock: Device is locked tight!\n");
245 ret = -1;
246 goto out;
247 }
248
Nishanth Menonb20f8402008-12-13 09:43:06 -0600249 chip->cmdfunc(mtd,
Stefan Roesed351b2b2006-10-10 12:36:02 +0200250 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
251 -1, -1);
252
253 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600254 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200255
256 /* see if device thinks it succeeded */
257 if (status & 0x01) {
258 ret = -1;
259 }
260
Joe Hershberger8b177d42013-02-08 09:27:19 +0000261 out:
Stefan Roesed351b2b2006-10-10 12:36:02 +0200262 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600263 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200264 return ret;
265}
266
267/**
268 * nand_get_lock_status: - query current lock state from one page of NAND
269 * flash
270 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600271 * @param mtd nand mtd instance
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000272 * @param offset page address to query (must be page-aligned!)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200273 *
274 * @return -1 in case of error
275 * >0 lock status:
276 * bitfield with the following combinations:
277 * NAND_LOCK_STATUS_TIGHT: page in tight state
Stefan Roesed351b2b2006-10-10 12:36:02 +0200278 * NAND_LOCK_STATUS_UNLOCK: page unlocked
279 *
280 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200281int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200282{
283 int ret = 0;
284 int chipnr;
285 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600286 struct nand_chip *chip = mtd->priv;
Stefan Roesed351b2b2006-10-10 12:36:02 +0200287
288 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600289 chipnr = (int)(offset >> chip->chip_shift);
290 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200291
292
Nishanth Menonb20f8402008-12-13 09:43:06 -0600293 if ((offset & (mtd->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000294 printf("nand_get_lock_status: "
Stefan Roesed351b2b2006-10-10 12:36:02 +0200295 "Start address must be beginning of "
296 "nand page!\n");
297 ret = -1;
298 goto out;
299 }
300
301 /* check the Lock Status */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600302 page = (int)(offset >> chip->page_shift);
303 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200304
Nishanth Menonb20f8402008-12-13 09:43:06 -0600305 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
Stefan Roesed351b2b2006-10-10 12:36:02 +0200306 | NAND_LOCK_STATUS_UNLOCK);
307
308 out:
309 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600310 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200311 return ret;
312}
313
314/**
315 * nand_unlock: - Unlock area of NAND pages
316 * only one consecutive area can be unlocked at one time!
317 *
Nishanth Menonb20f8402008-12-13 09:43:06 -0600318 * @param mtd nand mtd instance
Stefan Roesed351b2b2006-10-10 12:36:02 +0200319 * @param start start byte address
320 * @param length number of bytes to unlock (must be a multiple of
William Juul52c07962007-10-31 13:53:06 +0100321 * page size nand->writesize)
Joe Hershbergercccf5952012-08-22 16:49:42 -0500322 * @param allexcept if set, unlock everything not selected
Stefan Roesed351b2b2006-10-10 12:36:02 +0200323 *
324 * @return 0 on success, -1 in case of error
325 */
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500326int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
327 int allexcept)
Stefan Roesed351b2b2006-10-10 12:36:02 +0200328{
329 int ret = 0;
330 int chipnr;
331 int status;
332 int page;
Nishanth Menonb20f8402008-12-13 09:43:06 -0600333 struct nand_chip *chip = mtd->priv;
Joe Hershbergercccf5952012-08-22 16:49:42 -0500334
Joe Hershbergerdfa8ba42012-08-22 16:49:43 -0500335 debug("nand_unlock%s: start: %08llx, length: %d!\n",
Joe Hershbergercccf5952012-08-22 16:49:42 -0500336 allexcept ? " (allexcept)" : "", start, length);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200337
338 /* select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600339 chipnr = (int)(start >> chip->chip_shift);
340 chip->select_chip(mtd, chipnr);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200341
342 /* check the WP bit */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600343 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
344 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000345 printf("nand_unlock: Device is write protected!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200346 ret = -1;
347 goto out;
348 }
349
Joe Hershberger8b177d42013-02-08 09:27:19 +0000350 /* check the Lock Tight Status */
351 page = (int)(start >> chip->page_shift);
352 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
353 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
354 printf("nand_unlock: Device is locked tight!\n");
355 ret = -1;
356 goto out;
357 }
358
Nishanth Menonb20f8402008-12-13 09:43:06 -0600359 if ((start & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000360 printf("nand_unlock: Start address must be beginning of "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600361 "nand block!\n");
Stefan Roesed351b2b2006-10-10 12:36:02 +0200362 ret = -1;
363 goto out;
364 }
365
Nishanth Menonb20f8402008-12-13 09:43:06 -0600366 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000367 printf("nand_unlock: Length must be a multiple of nand block "
Nishanth Menonb20f8402008-12-13 09:43:06 -0600368 "size %08x!\n", mtd->erasesize);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200369 ret = -1;
370 goto out;
371 }
372
Nishanth Menonb20f8402008-12-13 09:43:06 -0600373 /*
374 * Set length so that the last address is set to the
375 * starting address of the last block
376 */
377 length -= mtd->erasesize;
378
Stefan Roesed351b2b2006-10-10 12:36:02 +0200379 /* submit address of first page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600380 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200381
382 /* submit ADDRESS of LAST page to unlock */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600383 page += (int)(length >> chip->page_shift);
Joe Hershbergercccf5952012-08-22 16:49:42 -0500384
385 /*
386 * Page addresses for unlocking are supposed to be block-aligned.
387 * At least some NAND chips use the low bit to indicate that the
388 * page range should be inverted.
389 */
390 if (allexcept)
391 page |= 1;
392
Nishanth Menonb20f8402008-12-13 09:43:06 -0600393 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200394
395 /* call wait ready function */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600396 status = chip->waitfunc(mtd, chip);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200397 /* see if device thinks it succeeded */
398 if (status & 0x01) {
399 /* there was an error */
400 ret = -1;
401 goto out;
402 }
403
404 out:
405 /* de-select the NAND device */
Nishanth Menonb20f8402008-12-13 09:43:06 -0600406 chip->select_chip(mtd, -1);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200407 return ret;
408}
William Juul52c07962007-10-31 13:53:06 +0100409#endif
Stefan Roesed351b2b2006-10-10 12:36:02 +0200410
Scott Woodcc5f3392008-06-12 13:20:16 -0500411/**
Scott Woodfe3b5e12010-07-30 16:11:41 -0500412 * check_skip_len
Scott Woodcc5f3392008-06-12 13:20:16 -0500413 *
Scott Woodfe3b5e12010-07-30 16:11:41 -0500414 * Check if there are any bad blocks, and whether length including bad
415 * blocks fits into device
Scott Woodcc5f3392008-06-12 13:20:16 -0500416 *
417 * @param nand NAND device
418 * @param offset offset in flash
419 * @param length image length
Tom Rini32d96182013-03-14 05:32:50 +0000420 * @param used length of flash needed for the requested length
Scott Woodfe3b5e12010-07-30 16:11:41 -0500421 * @return 0 if the image fits and there are no bad blocks
422 * 1 if the image fits, but there are bad blocks
423 * -1 if the image does not fit
Scott Woodcc5f3392008-06-12 13:20:16 -0500424 */
Tom Rini32d96182013-03-14 05:32:50 +0000425static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
426 size_t *used)
Scott Woodcc5f3392008-06-12 13:20:16 -0500427{
Scott Woodcc5f3392008-06-12 13:20:16 -0500428 size_t len_excl_bad = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500429 int ret = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500430
431 while (len_excl_bad < length) {
Scott Woodfe3b5e12010-07-30 16:11:41 -0500432 size_t block_len, block_off;
433 loff_t block_start;
Scott Woodcc5f3392008-06-12 13:20:16 -0500434
Scott Woodfe3b5e12010-07-30 16:11:41 -0500435 if (offset >= nand->size)
436 return -1;
Scott Woodcc5f3392008-06-12 13:20:16 -0500437
Scott Woodfe3b5e12010-07-30 16:11:41 -0500438 block_start = offset & ~(loff_t)(nand->erasesize - 1);
439 block_off = offset & (nand->erasesize - 1);
440 block_len = nand->erasesize - block_off;
Scott Woodcc5f3392008-06-12 13:20:16 -0500441
Scott Woodfe3b5e12010-07-30 16:11:41 -0500442 if (!nand_block_isbad(nand, block_start))
443 len_excl_bad += block_len;
444 else
445 ret = 1;
446
447 offset += block_len;
Tom Rini32d96182013-03-14 05:32:50 +0000448 *used += block_len;
Scott Woodcc5f3392008-06-12 13:20:16 -0500449 }
450
Tom Rini32d96182013-03-14 05:32:50 +0000451 /* If the length is not a multiple of block_len, adjust. */
452 if (len_excl_bad > length)
453 *used -= (len_excl_bad - length);
454
Scott Woodfe3b5e12010-07-30 16:11:41 -0500455 return ret;
Scott Woodcc5f3392008-06-12 13:20:16 -0500456}
Ben Gardiner34dd5672011-06-14 16:35:06 -0400457
458#ifdef CONFIG_CMD_NAND_TRIMFFS
459static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
460 const size_t *len)
461{
htbegin610e8552013-03-01 23:00:34 +0000462 size_t l = *len;
463 ssize_t i;
Ben Gardiner34dd5672011-06-14 16:35:06 -0400464
465 for (i = l - 1; i >= 0; i--)
466 if (buf[i] != 0xFF)
467 break;
468
469 /* The resulting length must be aligned to the minimum flash I/O size */
470 l = i + 1;
471 l = (l + nand->writesize - 1) / nand->writesize;
472 l *= nand->writesize;
473
474 /*
475 * since the input length may be unaligned, prevent access past the end
476 * of the buffer
477 */
478 return min(l, *len);
479}
480#endif
Scott Woodcc5f3392008-06-12 13:20:16 -0500481
482/**
483 * nand_write_skip_bad:
484 *
485 * Write image to NAND flash.
486 * Blocks that are marked bad are skipped and the is written to the next
487 * block instead as long as the image is short enough to fit even after
Tom Rini32d96182013-03-14 05:32:50 +0000488 * skipping the bad blocks. Due to bad blocks we may not be able to
489 * perform the requested write. In the case where the write would
490 * extend beyond the end of the NAND device, both length and actual (if
491 * not NULL) are set to 0. In the case where the write would extend
492 * beyond the limit we are passed, length is set to 0 and actual is set
493 * to the required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500494 *
495 * @param nand NAND device
496 * @param offset offset in flash
497 * @param length buffer length
Tom Rini32d96182013-03-14 05:32:50 +0000498 * @param actual set to size required to write length worth of
499 * buffer or 0 on error, if not NULL
500 * @param lim maximum size that actual may be in order to not
501 * exceed the buffer
Lei Wen4b5deaa2011-01-06 11:11:58 +0800502 * @param buffer buffer to read from
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400503 * @param flags flags modifying the behaviour of the write to NAND
Scott Woodcc5f3392008-06-12 13:20:16 -0500504 * @return 0 in case of success
505 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200506int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000507 size_t *actual, loff_t lim, u_char *buffer, int flags)
Scott Woodcc5f3392008-06-12 13:20:16 -0500508{
Lei Wen4b5deaa2011-01-06 11:11:58 +0800509 int rval = 0, blocksize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500510 size_t left_to_write = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000511 size_t used_for_write = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500512 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500513 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500514
Tom Rini32d96182013-03-14 05:32:50 +0000515 if (actual)
516 *actual = 0;
517
Lei Wen4b5deaa2011-01-06 11:11:58 +0800518#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400519 if (flags & WITH_YAFFS_OOB) {
Ben Gardiner871dea42011-06-14 16:35:05 -0400520 if (flags & ~WITH_YAFFS_OOB)
521 return -EINVAL;
522
Lei Wen4b5deaa2011-01-06 11:11:58 +0800523 int pages;
524 pages = nand->erasesize / nand->writesize;
525 blocksize = (pages * nand->oobsize) + nand->erasesize;
526 if (*length % (nand->writesize + nand->oobsize)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000527 printf("Attempt to write incomplete page"
Lei Wen4b5deaa2011-01-06 11:11:58 +0800528 " in yaffs mode\n");
529 return -EINVAL;
530 }
531 } else
532#endif
533 {
534 blocksize = nand->erasesize;
535 }
536
Scott Woodfe3b5e12010-07-30 16:11:41 -0500537 /*
538 * nand_write() handles unaligned, partial page writes.
539 *
540 * We allow length to be unaligned, for convenience in
541 * using the $filesize variable.
542 *
543 * However, starting at an unaligned offset makes the
544 * semantics of bad block skipping ambiguous (really,
545 * you should only start a block skipping access at a
546 * partition boundary). So don't try to handle that.
547 */
548 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000549 printf("Attempt to write non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500550 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500551 return -EINVAL;
552 }
553
Tom Rini32d96182013-03-14 05:32:50 +0000554 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
555
556 if (actual)
557 *actual = used_for_write;
558
Scott Woodfe3b5e12010-07-30 16:11:41 -0500559 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000560 printf("Attempt to write outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500561 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500562 return -EINVAL;
563 }
564
Tom Rini32d96182013-03-14 05:32:50 +0000565 if (used_for_write > lim) {
566 puts("Size of write exceeds partition or device limit\n");
567 *length = 0;
568 return -EFBIG;
569 }
570
Ben Gardiner34dd5672011-06-14 16:35:06 -0400571 if (!need_skip && !(flags & WITH_DROP_FFS)) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000572 rval = nand_write(nand, offset, length, buffer);
Scott Woodfe3b5e12010-07-30 16:11:41 -0500573 if (rval == 0)
574 return 0;
Scott Wood90e0a6b2008-11-25 10:47:02 -0600575
Scott Woodfe3b5e12010-07-30 16:11:41 -0500576 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000577 printf("NAND write to offset %llx failed %d\n",
Scott Woodfe3b5e12010-07-30 16:11:41 -0500578 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600579 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500580 }
581
582 while (left_to_write > 0) {
583 size_t block_offset = offset & (nand->erasesize - 1);
Ben Gardiner34dd5672011-06-14 16:35:06 -0400584 size_t write_size, truncated_write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500585
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000586 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500587
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000588 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
589 printf("Skip bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500590 offset & ~(nand->erasesize - 1));
591 offset += nand->erasesize - block_offset;
592 continue;
593 }
594
Lei Wen4b5deaa2011-01-06 11:11:58 +0800595 if (left_to_write < (blocksize - block_offset))
Scott Woodcc5f3392008-06-12 13:20:16 -0500596 write_size = left_to_write;
597 else
Lei Wen4b5deaa2011-01-06 11:11:58 +0800598 write_size = blocksize - block_offset;
599
600#ifdef CONFIG_CMD_NAND_YAFFS
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400601 if (flags & WITH_YAFFS_OOB) {
Lei Wen4b5deaa2011-01-06 11:11:58 +0800602 int page, pages;
603 size_t pagesize = nand->writesize;
604 size_t pagesize_oob = pagesize + nand->oobsize;
605 struct mtd_oob_ops ops;
606
607 ops.len = pagesize;
608 ops.ooblen = nand->oobsize;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000609 ops.mode = MTD_OPS_AUTO_OOB;
Lei Wen4b5deaa2011-01-06 11:11:58 +0800610 ops.ooboffs = 0;
611
612 pages = write_size / pagesize_oob;
613 for (page = 0; page < pages; page++) {
Scott Woodea95b642011-02-02 18:15:57 -0600614 WATCHDOG_RESET();
615
Lei Wen4b5deaa2011-01-06 11:11:58 +0800616 ops.datbuf = p_buffer;
617 ops.oobbuf = ops.datbuf + pagesize;
Scott Woodcc5f3392008-06-12 13:20:16 -0500618
Sergey Lapin3a38a552013-01-14 03:46:50 +0000619 rval = mtd_write_oob(nand, offset, &ops);
Liu, Wentaode95b322012-01-17 19:55:02 +0000620 if (rval != 0)
Lei Wen4b5deaa2011-01-06 11:11:58 +0800621 break;
622
623 offset += pagesize;
624 p_buffer += pagesize_oob;
625 }
626 }
627 else
628#endif
629 {
Ben Gardiner34dd5672011-06-14 16:35:06 -0400630 truncated_write_size = write_size;
631#ifdef CONFIG_CMD_NAND_TRIMFFS
632 if (flags & WITH_DROP_FFS)
633 truncated_write_size = drop_ffs(nand, p_buffer,
634 &write_size);
635#endif
636
637 rval = nand_write(nand, offset, &truncated_write_size,
638 p_buffer);
Lei Wen4b5deaa2011-01-06 11:11:58 +0800639 offset += write_size;
640 p_buffer += write_size;
641 }
642
Scott Woodcc5f3392008-06-12 13:20:16 -0500643 if (rval != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000644 printf("NAND write to offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200645 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500646 *length -= left_to_write;
647 return rval;
648 }
649
650 left_to_write -= write_size;
Scott Woodcc5f3392008-06-12 13:20:16 -0500651 }
652
653 return 0;
654}
655
656/**
657 * nand_read_skip_bad:
658 *
659 * Read image from NAND flash.
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000660 * Blocks that are marked bad are skipped and the next block is read
Tom Rini32d96182013-03-14 05:32:50 +0000661 * instead as long as the image is short enough to fit even after
662 * skipping the bad blocks. Due to bad blocks we may not be able to
663 * perform the requested read. In the case where the read would extend
664 * beyond the end of the NAND device, both length and actual (if not
665 * NULL) are set to 0. In the case where the read would extend beyond
666 * the limit we are passed, length is set to 0 and actual is set to the
667 * required length.
Scott Woodcc5f3392008-06-12 13:20:16 -0500668 *
669 * @param nand NAND device
670 * @param offset offset in flash
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000671 * @param length buffer length, on return holds number of read bytes
Tom Rini32d96182013-03-14 05:32:50 +0000672 * @param actual set to size required to read length worth of buffer or 0
673 * on error, if not NULL
674 * @param lim maximum size that actual may be in order to not exceed the
675 * buffer
Scott Woodcc5f3392008-06-12 13:20:16 -0500676 * @param buffer buffer to write to
677 * @return 0 in case of success
678 */
Jean-Christophe PLAGNIOL-VILLARD2511ba02009-05-16 14:27:40 +0200679int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000680 size_t *actual, loff_t lim, u_char *buffer)
Scott Woodcc5f3392008-06-12 13:20:16 -0500681{
682 int rval;
683 size_t left_to_read = *length;
Tom Rini32d96182013-03-14 05:32:50 +0000684 size_t used_for_read = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500685 u_char *p_buffer = buffer;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500686 int need_skip;
Scott Woodcc5f3392008-06-12 13:20:16 -0500687
Scott Woodfe3b5e12010-07-30 16:11:41 -0500688 if ((offset & (nand->writesize - 1)) != 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000689 printf("Attempt to read non page-aligned data\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500690 *length = 0;
Tom Rini32d96182013-03-14 05:32:50 +0000691 if (actual)
692 *actual = 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500693 return -EINVAL;
694 }
Scott Woodcc5f3392008-06-12 13:20:16 -0500695
Tom Rini32d96182013-03-14 05:32:50 +0000696 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
697
698 if (actual)
699 *actual = used_for_read;
700
Scott Woodfe3b5e12010-07-30 16:11:41 -0500701 if (need_skip < 0) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000702 printf("Attempt to read outside the flash area\n");
Scott Woodfe3b5e12010-07-30 16:11:41 -0500703 *length = 0;
Scott Woodcc5f3392008-06-12 13:20:16 -0500704 return -EINVAL;
705 }
706
Tom Rini32d96182013-03-14 05:32:50 +0000707 if (used_for_read > lim) {
708 puts("Size of read exceeds partition or device limit\n");
709 *length = 0;
710 return -EFBIG;
711 }
712
Scott Woodfe3b5e12010-07-30 16:11:41 -0500713 if (!need_skip) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000714 rval = nand_read(nand, offset, length, buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300715 if (!rval || rval == -EUCLEAN)
716 return 0;
Scott Woodfe3b5e12010-07-30 16:11:41 -0500717
718 *length = 0;
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000719 printf("NAND read from offset %llx failed %d\n",
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300720 offset, rval);
Scott Wood90e0a6b2008-11-25 10:47:02 -0600721 return rval;
Scott Woodcc5f3392008-06-12 13:20:16 -0500722 }
723
724 while (left_to_read > 0) {
725 size_t block_offset = offset & (nand->erasesize - 1);
726 size_t read_length;
727
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000728 WATCHDOG_RESET();
Giulio Benetti749bd662009-07-31 17:30:34 -0500729
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000730 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
731 printf("Skipping bad block 0x%08llx\n",
Scott Woodcc5f3392008-06-12 13:20:16 -0500732 offset & ~(nand->erasesize - 1));
733 offset += nand->erasesize - block_offset;
734 continue;
735 }
736
737 if (left_to_read < (nand->erasesize - block_offset))
738 read_length = left_to_read;
739 else
740 read_length = nand->erasesize - block_offset;
741
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000742 rval = nand_read(nand, offset, &read_length, p_buffer);
Valeriy Glushkovf2aead82009-07-14 13:51:10 +0300743 if (rval && rval != -EUCLEAN) {
Benoît Thébaudeaue26708e2012-11-05 10:15:46 +0000744 printf("NAND read from offset %llx failed %d\n",
Wolfgang Denk74e0dde2008-08-14 14:41:06 +0200745 offset, rval);
Scott Woodcc5f3392008-06-12 13:20:16 -0500746 *length -= left_to_read;
747 return rval;
748 }
749
750 left_to_read -= read_length;
751 offset += read_length;
752 p_buffer += read_length;
753 }
754
755 return 0;
756}
Benoît Thébaudeau5661f702012-11-16 20:20:54 +0100757
758#ifdef CONFIG_CMD_NAND_TORTURE
759
760/**
761 * check_pattern:
762 *
763 * Check if buffer contains only a certain byte pattern.
764 *
765 * @param buf buffer to check
766 * @param patt the pattern to check
767 * @param size buffer size in bytes
768 * @return 1 if there are only patt bytes in buf
769 * 0 if something else was found
770 */
771static int check_pattern(const u_char *buf, u_char patt, int size)
772{
773 int i;
774
775 for (i = 0; i < size; i++)
776 if (buf[i] != patt)
777 return 0;
778 return 1;
779}
780
781/**
782 * nand_torture:
783 *
784 * Torture a block of NAND flash.
785 * This is useful to determine if a block that caused a write error is still
786 * good or should be marked as bad.
787 *
788 * @param nand NAND device
789 * @param offset offset in flash
790 * @return 0 if the block is still good
791 */
792int nand_torture(nand_info_t *nand, loff_t offset)
793{
794 u_char patterns[] = {0xa5, 0x5a, 0x00};
795 struct erase_info instr = {
796 .mtd = nand,
797 .addr = offset,
798 .len = nand->erasesize,
799 };
800 size_t retlen;
801 int err, ret = -1, i, patt_count;
802 u_char *buf;
803
804 if ((offset & (nand->erasesize - 1)) != 0) {
805 puts("Attempt to torture a block at a non block-aligned offset\n");
806 return -EINVAL;
807 }
808
809 if (offset + nand->erasesize > nand->size) {
810 puts("Attempt to torture a block outside the flash area\n");
811 return -EINVAL;
812 }
813
814 patt_count = ARRAY_SIZE(patterns);
815
816 buf = malloc(nand->erasesize);
817 if (buf == NULL) {
818 puts("Out of memory for erase block buffer\n");
819 return -ENOMEM;
820 }
821
822 for (i = 0; i < patt_count; i++) {
823 err = nand->erase(nand, &instr);
824 if (err) {
825 printf("%s: erase() failed for block at 0x%llx: %d\n",
826 nand->name, instr.addr, err);
827 goto out;
828 }
829
830 /* Make sure the block contains only 0xff bytes */
831 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
832 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
833 printf("%s: read() failed for block at 0x%llx: %d\n",
834 nand->name, instr.addr, err);
835 goto out;
836 }
837
838 err = check_pattern(buf, 0xff, nand->erasesize);
839 if (!err) {
840 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
841 offset);
842 ret = -EIO;
843 goto out;
844 }
845
846 /* Write a pattern and check it */
847 memset(buf, patterns[i], nand->erasesize);
848 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
849 if (err || retlen != nand->erasesize) {
850 printf("%s: write() failed for block at 0x%llx: %d\n",
851 nand->name, instr.addr, err);
852 goto out;
853 }
854
855 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
856 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
857 printf("%s: read() failed for block at 0x%llx: %d\n",
858 nand->name, instr.addr, err);
859 goto out;
860 }
861
862 err = check_pattern(buf, patterns[i], nand->erasesize);
863 if (!err) {
864 printf("Pattern 0x%.2x checking failed for block at "
865 "0x%llx\n", patterns[i], offset);
866 ret = -EIO;
867 goto out;
868 }
869 }
870
871 ret = 0;
872
873out:
874 free(buf);
875 return ret;
876}
877
878#endif