2 * drivers/mtd/nand/nand_util.c
4 * Copyright (C) 2006 by Weiss-Electronic GmbH.
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)
14 * See file CREDITS for list of people who contributed to this
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License version
19 * 2 as published by the Free Software Foundation.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
40 #include <asm/errno.h>
41 #include <linux/mtd/mtd.h>
43 #include <jffs2/jffs2.h>
45 typedef struct erase_info erase_info_t;
46 typedef struct mtd_info mtd_info_t;
48 /* support only for native endian JFFS2 */
49 #define cpu_to_je16(x) (x)
50 #define cpu_to_je32(x) (x)
52 /*****************************************************************************/
53 static int nand_block_bad_scrub(struct mtd_info *mtd, loff_t ofs, int getchip)
59 * nand_erase_opts: - erase NAND flash with support for various options
62 * @param meminfo NAND device to erase
63 * @param opts options, @see struct nand_erase_options
64 * @return 0 in case of success
66 * This code is ported from flash_eraseall.c from Linux mtd utils by
67 * Arcom Control System Ltd.
69 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
71 struct jffs2_unknown_node cleanmarker;
76 int percent_complete = -1;
77 int (*nand_block_bad_old)(struct mtd_info *, loff_t, int) = NULL;
78 const char *mtd_device = meminfo->name;
79 struct mtd_oob_ops oob_opts;
80 struct nand_chip *chip = meminfo->priv;
82 memset(&erase, 0, sizeof(erase));
83 memset(&oob_opts, 0, sizeof(oob_opts));
86 erase.len = meminfo->erasesize;
87 erase.addr = opts->offset;
88 erase_length = opts->length;
90 cleanmarker.magic = cpu_to_je16 (JFFS2_MAGIC_BITMASK);
91 cleanmarker.nodetype = cpu_to_je16 (JFFS2_NODETYPE_CLEANMARKER);
92 cleanmarker.totlen = cpu_to_je32(8);
94 /* scrub option allows to erase badblock. To prevent internal
95 * check from erase() method, set block check method to dummy
96 * and disable bad block table while erasing.
99 struct nand_chip *priv_nand = meminfo->priv;
101 nand_block_bad_old = priv_nand->block_bad;
102 priv_nand->block_bad = nand_block_bad_scrub;
103 /* we don't need the bad block table anymore...
104 * after scrub, there are no bad blocks left!
106 if (priv_nand->bbt) {
107 kfree(priv_nand->bbt);
109 priv_nand->bbt = NULL;
112 if (erase_length < meminfo->erasesize) {
113 printf("Warning: Erase size 0x%08lx smaller than one " \
114 "erase block 0x%08x\n",erase_length, meminfo->erasesize);
115 printf(" Erasing 0x%08x instead\n", meminfo->erasesize);
116 erase_length = meminfo->erasesize;
120 erase.addr < opts->offset + erase_length;
121 erase.addr += meminfo->erasesize) {
125 if (!opts->scrub && bbtest) {
126 int ret = meminfo->block_isbad(meminfo, erase.addr);
129 printf("\rSkipping bad block at "
135 } else if (ret < 0) {
136 printf("\n%s: MTD get bad block failed: %d\n",
143 result = meminfo->erase(meminfo, &erase);
145 printf("\n%s: MTD Erase failure: %d\n",
150 /* format for JFFS2 ? */
151 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
152 chip->ops.ooblen = 8;
153 chip->ops.datbuf = NULL;
154 chip->ops.oobbuf = (uint8_t *)&cleanmarker;
155 chip->ops.ooboffs = 0;
156 chip->ops.mode = MTD_OOB_AUTO;
158 result = meminfo->write_oob(meminfo,
162 printf("\n%s: MTD writeoob failure: %d\n",
169 unsigned long long n =(unsigned long long)
170 (erase.addr + meminfo->erasesize - opts->offset)
174 do_div(n, erase_length);
177 /* output progress message only at whole percent
178 * steps to reduce the number of messages printed
179 * on (slow) serial consoles
181 if (percent != percent_complete) {
182 percent_complete = percent;
184 printf("\rErasing at 0x%x -- %3d%% complete.",
185 erase.addr, percent);
187 if (opts->jffs2 && result == 0)
188 printf(" Cleanmarker written at 0x%x.",
196 if (nand_block_bad_old) {
197 struct nand_chip *priv_nand = meminfo->priv;
199 priv_nand->block_bad = nand_block_bad_old;
200 priv_nand->scan_bbt(meminfo);
209 #define MAX_PAGE_SIZE 2048
210 #define MAX_OOB_SIZE 64
213 * buffer array used for writing data
215 static unsigned char data_buf[MAX_PAGE_SIZE];
216 static unsigned char oob_buf[MAX_OOB_SIZE];
218 /* OOB layouts to pass into the kernel as default */
219 static struct nand_ecclayout none_ecclayout = {
220 .useecc = MTD_NANDECC_OFF,
223 static struct nand_ecclayout jffs2_ecclayout = {
224 .useecc = MTD_NANDECC_PLACE,
226 .eccpos = { 0, 1, 2, 3, 6, 7 }
229 static struct nand_ecclayout yaffs_ecclayout = {
230 .useecc = MTD_NANDECC_PLACE,
232 .eccpos = { 8, 9, 10, 13, 14, 15}
235 static struct nand_ecclayout autoplace_ecclayout = {
236 .useecc = MTD_NANDECC_AUTOPLACE
241 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
243 /******************************************************************************
244 * Support for locking / unlocking operations of some NAND devices
245 *****************************************************************************/
247 #define NAND_CMD_LOCK 0x2a
248 #define NAND_CMD_LOCK_TIGHT 0x2c
249 #define NAND_CMD_UNLOCK1 0x23
250 #define NAND_CMD_UNLOCK2 0x24
251 #define NAND_CMD_LOCK_STATUS 0x7a
254 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
257 * @param mtd nand mtd instance
258 * @param tight bring device in lock tight mode
260 * @return 0 on success, -1 in case of error
262 * The lock / lock-tight command only applies to the whole chip. To get some
263 * parts of the chip lock and others unlocked use the following sequence:
265 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
266 * - Call nand_unlock() once for each consecutive area to be unlocked
267 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
269 * If the device is in lock-tight state software can't change the
270 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
271 * calls will fail. It is only posible to leave lock-tight state by
272 * an hardware signal (low pulse on _WP pin) or by power down.
274 int nand_lock(struct mtd_info *mtd, int tight)
278 struct nand_chip *chip = mtd->priv;
280 /* select the NAND device */
281 chip->select_chip(mtd, 0);
284 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
287 /* call wait ready function */
288 status = chip->waitfunc(mtd, chip);
290 /* see if device thinks it succeeded */
295 /* de-select the NAND device */
296 chip->select_chip(mtd, -1);
301 * nand_get_lock_status: - query current lock state from one page of NAND
304 * @param mtd nand mtd instance
305 * @param offset page address to query (muss be page aligned!)
307 * @return -1 in case of error
309 * bitfield with the following combinations:
310 * NAND_LOCK_STATUS_TIGHT: page in tight state
311 * NAND_LOCK_STATUS_LOCK: page locked
312 * NAND_LOCK_STATUS_UNLOCK: page unlocked
315 int nand_get_lock_status(struct mtd_info *mtd, ulong offset)
320 struct nand_chip *chip = mtd->priv;
322 /* select the NAND device */
323 chipnr = (int)(offset >> chip->chip_shift);
324 chip->select_chip(mtd, chipnr);
327 if ((offset & (mtd->writesize - 1)) != 0) {
328 printf ("nand_get_lock_status: "
329 "Start address must be beginning of "
335 /* check the Lock Status */
336 page = (int)(offset >> chip->page_shift);
337 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
339 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
340 | NAND_LOCK_STATUS_LOCK
341 | NAND_LOCK_STATUS_UNLOCK);
344 /* de-select the NAND device */
345 chip->select_chip(mtd, -1);
350 * nand_unlock: - Unlock area of NAND pages
351 * only one consecutive area can be unlocked at one time!
353 * @param mtd nand mtd instance
354 * @param start start byte address
355 * @param length number of bytes to unlock (must be a multiple of
356 * page size nand->writesize)
358 * @return 0 on success, -1 in case of error
360 int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
366 struct nand_chip *chip = mtd->priv;
367 printf ("nand_unlock: start: %08x, length: %d!\n",
368 (int)start, (int)length);
370 /* select the NAND device */
371 chipnr = (int)(start >> chip->chip_shift);
372 chip->select_chip(mtd, chipnr);
374 /* check the WP bit */
375 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
376 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
377 printf ("nand_unlock: Device is write protected!\n");
382 if ((start & (mtd->erasesize - 1)) != 0) {
383 printf ("nand_unlock: Start address must be beginning of "
389 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
390 printf ("nand_unlock: Length must be a multiple of nand block "
391 "size %08x!\n", mtd->erasesize);
397 * Set length so that the last address is set to the
398 * starting address of the last block
400 length -= mtd->erasesize;
402 /* submit address of first page to unlock */
403 page = (int)(start >> chip->page_shift);
404 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
406 /* submit ADDRESS of LAST page to unlock */
407 page += (int)(length >> chip->page_shift);
408 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
410 /* call wait ready function */
411 status = chip->waitfunc(mtd, chip);
412 /* see if device thinks it succeeded */
414 /* there was an error */
420 /* de-select the NAND device */
421 chip->select_chip(mtd, -1);
429 * Check if length including bad blocks fits into device.
431 * @param nand NAND device
432 * @param offset offset in flash
433 * @param length image length
434 * @return image length including bad blocks
436 static size_t get_len_incl_bad (nand_info_t *nand, size_t offset,
439 size_t len_incl_bad = 0;
440 size_t len_excl_bad = 0;
443 while (len_excl_bad < length) {
444 block_len = nand->erasesize - (offset & (nand->erasesize - 1));
446 if (!nand_block_isbad (nand, offset & ~(nand->erasesize - 1)))
447 len_excl_bad += block_len;
449 len_incl_bad += block_len;
452 if ((offset + len_incl_bad) >= nand->size)
460 * nand_write_skip_bad:
462 * Write image to NAND flash.
463 * Blocks that are marked bad are skipped and the is written to the next
464 * block instead as long as the image is short enough to fit even after
465 * skipping the bad blocks.
467 * @param nand NAND device
468 * @param offset offset in flash
469 * @param length buffer length
470 * @param buf buffer to read from
471 * @return 0 in case of success
473 int nand_write_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
477 size_t left_to_write = *length;
479 u_char *p_buffer = buffer;
481 /* Reject writes, which are not page aligned */
482 if ((offset & (nand->writesize - 1)) != 0 ||
483 (*length & (nand->writesize - 1)) != 0) {
484 printf ("Attempt to write non page aligned data\n");
488 len_incl_bad = get_len_incl_bad (nand, offset, *length);
490 if ((offset + len_incl_bad) >= nand->size) {
491 printf ("Attempt to write outside the flash area\n");
495 if (len_incl_bad == *length) {
496 rval = nand_write (nand, offset, length, buffer);
498 printf ("NAND write to offset %zx failed %d\n",
504 while (left_to_write > 0) {
505 size_t block_offset = offset & (nand->erasesize - 1);
508 if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
509 printf ("Skip bad block 0x%08zx\n",
510 offset & ~(nand->erasesize - 1));
511 offset += nand->erasesize - block_offset;
515 if (left_to_write < (nand->erasesize - block_offset))
516 write_size = left_to_write;
518 write_size = nand->erasesize - block_offset;
520 rval = nand_write (nand, offset, &write_size, p_buffer);
522 printf ("NAND write to offset %zx failed %d\n",
524 *length -= left_to_write;
528 left_to_write -= write_size;
529 offset += write_size;
530 p_buffer += write_size;
537 * nand_read_skip_bad:
539 * Read image from NAND flash.
540 * Blocks that are marked bad are skipped and the next block is readen
541 * instead as long as the image is short enough to fit even after skipping the
544 * @param nand NAND device
545 * @param offset offset in flash
546 * @param length buffer length, on return holds remaining bytes to read
547 * @param buffer buffer to write to
548 * @return 0 in case of success
550 int nand_read_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
554 size_t left_to_read = *length;
556 u_char *p_buffer = buffer;
558 len_incl_bad = get_len_incl_bad (nand, offset, *length);
560 if ((offset + len_incl_bad) >= nand->size) {
561 printf ("Attempt to read outside the flash area\n");
565 if (len_incl_bad == *length) {
566 rval = nand_read (nand, offset, length, buffer);
568 printf ("NAND read from offset %zx failed %d\n",
574 while (left_to_read > 0) {
575 size_t block_offset = offset & (nand->erasesize - 1);
578 if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
579 printf ("Skipping bad block 0x%08zx\n",
580 offset & ~(nand->erasesize - 1));
581 offset += nand->erasesize - block_offset;
585 if (left_to_read < (nand->erasesize - block_offset))
586 read_length = left_to_read;
588 read_length = nand->erasesize - block_offset;
590 rval = nand_read (nand, offset, &read_length, p_buffer);
592 printf ("NAND read from offset %zx failed %d\n",
594 *length -= left_to_read;
598 left_to_read -= read_length;
599 offset += read_length;
600 p_buffer += read_length;