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,
39 #include <asm/errno.h>
40 #include <linux/mtd/mtd.h>
42 #include <jffs2/jffs2.h>
44 typedef struct erase_info erase_info_t;
45 typedef struct mtd_info mtd_info_t;
47 /* support only for native endian JFFS2 */
48 #define cpu_to_je16(x) (x)
49 #define cpu_to_je32(x) (x)
51 /*****************************************************************************/
52 static int nand_block_bad_scrub(struct mtd_info *mtd, loff_t ofs, int getchip)
58 * nand_erase_opts: - erase NAND flash with support for various options
61 * @param meminfo NAND device to erase
62 * @param opts options, @see struct nand_erase_options
63 * @return 0 in case of success
65 * This code is ported from flash_eraseall.c from Linux mtd utils by
66 * Arcom Control System Ltd.
68 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
70 struct jffs2_unknown_node cleanmarker;
75 int percent_complete = -1;
76 int (*nand_block_bad_old)(struct mtd_info *, loff_t, int) = NULL;
77 const char *mtd_device = meminfo->name;
78 struct mtd_oob_ops oob_opts;
79 struct nand_chip *chip = meminfo->priv;
81 memset(&erase, 0, sizeof(erase));
82 memset(&oob_opts, 0, sizeof(oob_opts));
85 erase.len = meminfo->erasesize;
86 erase.addr = opts->offset;
87 erase_length = opts->length;
89 cleanmarker.magic = cpu_to_je16 (JFFS2_MAGIC_BITMASK);
90 cleanmarker.nodetype = cpu_to_je16 (JFFS2_NODETYPE_CLEANMARKER);
91 cleanmarker.totlen = cpu_to_je32(8);
93 /* scrub option allows to erase badblock. To prevent internal
94 * check from erase() method, set block check method to dummy
95 * and disable bad block table while erasing.
98 struct nand_chip *priv_nand = meminfo->priv;
100 nand_block_bad_old = priv_nand->block_bad;
101 priv_nand->block_bad = nand_block_bad_scrub;
102 /* we don't need the bad block table anymore...
103 * after scrub, there are no bad blocks left!
105 if (priv_nand->bbt) {
106 kfree(priv_nand->bbt);
108 priv_nand->bbt = NULL;
111 if (erase_length < meminfo->erasesize) {
112 printf("Warning: Erase size 0x%08lx smaller than one " \
113 "erase block 0x%08x\n",erase_length, meminfo->erasesize);
114 printf(" Erasing 0x%08x instead\n", meminfo->erasesize);
115 erase_length = meminfo->erasesize;
119 erase.addr < opts->offset + erase_length;
120 erase.addr += meminfo->erasesize) {
124 if (!opts->scrub && bbtest) {
125 int ret = meminfo->block_isbad(meminfo, erase.addr);
128 printf("\rSkipping bad block at "
134 } else if (ret < 0) {
135 printf("\n%s: MTD get bad block failed: %d\n",
142 result = meminfo->erase(meminfo, &erase);
144 printf("\n%s: MTD Erase failure: %d\n",
149 /* format for JFFS2 ? */
150 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
151 chip->ops.ooblen = 8;
152 chip->ops.datbuf = NULL;
153 chip->ops.oobbuf = (uint8_t *)&cleanmarker;
154 chip->ops.ooboffs = 0;
155 chip->ops.mode = MTD_OOB_AUTO;
157 result = meminfo->write_oob(meminfo,
161 printf("\n%s: MTD writeoob failure: %d\n",
168 unsigned long long n =(unsigned long long)
169 (erase.addr + meminfo->erasesize - opts->offset)
173 do_div(n, erase_length);
176 /* output progress message only at whole percent
177 * steps to reduce the number of messages printed
178 * on (slow) serial consoles
180 if (percent != percent_complete) {
181 percent_complete = percent;
183 printf("\rErasing at 0x%llx -- %3d%% complete.",
184 erase.addr, percent);
186 if (opts->jffs2 && result == 0)
187 printf(" Cleanmarker written at 0x%llx.",
195 if (nand_block_bad_old) {
196 struct nand_chip *priv_nand = meminfo->priv;
198 priv_nand->block_bad = nand_block_bad_old;
199 priv_nand->scan_bbt(meminfo);
208 #define MAX_PAGE_SIZE 2048
209 #define MAX_OOB_SIZE 64
212 * buffer array used for writing data
214 static unsigned char data_buf[MAX_PAGE_SIZE];
215 static unsigned char oob_buf[MAX_OOB_SIZE];
217 /* OOB layouts to pass into the kernel as default */
218 static struct nand_ecclayout none_ecclayout = {
219 .useecc = MTD_NANDECC_OFF,
222 static struct nand_ecclayout jffs2_ecclayout = {
223 .useecc = MTD_NANDECC_PLACE,
225 .eccpos = { 0, 1, 2, 3, 6, 7 }
228 static struct nand_ecclayout yaffs_ecclayout = {
229 .useecc = MTD_NANDECC_PLACE,
231 .eccpos = { 8, 9, 10, 13, 14, 15}
234 static struct nand_ecclayout autoplace_ecclayout = {
235 .useecc = MTD_NANDECC_AUTOPLACE
240 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
242 /******************************************************************************
243 * Support for locking / unlocking operations of some NAND devices
244 *****************************************************************************/
246 #define NAND_CMD_LOCK 0x2a
247 #define NAND_CMD_LOCK_TIGHT 0x2c
248 #define NAND_CMD_UNLOCK1 0x23
249 #define NAND_CMD_UNLOCK2 0x24
250 #define NAND_CMD_LOCK_STATUS 0x7a
253 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
256 * @param mtd nand mtd instance
257 * @param tight bring device in lock tight mode
259 * @return 0 on success, -1 in case of error
261 * The lock / lock-tight command only applies to the whole chip. To get some
262 * parts of the chip lock and others unlocked use the following sequence:
264 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
265 * - Call nand_unlock() once for each consecutive area to be unlocked
266 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
268 * If the device is in lock-tight state software can't change the
269 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
270 * calls will fail. It is only posible to leave lock-tight state by
271 * an hardware signal (low pulse on _WP pin) or by power down.
273 int nand_lock(struct mtd_info *mtd, int tight)
277 struct nand_chip *chip = mtd->priv;
279 /* select the NAND device */
280 chip->select_chip(mtd, 0);
283 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
286 /* call wait ready function */
287 status = chip->waitfunc(mtd, chip);
289 /* see if device thinks it succeeded */
294 /* de-select the NAND device */
295 chip->select_chip(mtd, -1);
300 * nand_get_lock_status: - query current lock state from one page of NAND
303 * @param mtd nand mtd instance
304 * @param offset page address to query (muss be page aligned!)
306 * @return -1 in case of error
308 * bitfield with the following combinations:
309 * NAND_LOCK_STATUS_TIGHT: page in tight state
310 * NAND_LOCK_STATUS_LOCK: page locked
311 * NAND_LOCK_STATUS_UNLOCK: page unlocked
314 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
319 struct nand_chip *chip = mtd->priv;
321 /* select the NAND device */
322 chipnr = (int)(offset >> chip->chip_shift);
323 chip->select_chip(mtd, chipnr);
326 if ((offset & (mtd->writesize - 1)) != 0) {
327 printf ("nand_get_lock_status: "
328 "Start address must be beginning of "
334 /* check the Lock Status */
335 page = (int)(offset >> chip->page_shift);
336 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
338 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
339 | NAND_LOCK_STATUS_LOCK
340 | NAND_LOCK_STATUS_UNLOCK);
343 /* de-select the NAND device */
344 chip->select_chip(mtd, -1);
349 * nand_unlock: - Unlock area of NAND pages
350 * only one consecutive area can be unlocked at one time!
352 * @param mtd nand mtd instance
353 * @param start start byte address
354 * @param length number of bytes to unlock (must be a multiple of
355 * page size nand->writesize)
357 * @return 0 on success, -1 in case of error
359 int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
365 struct nand_chip *chip = mtd->priv;
366 printf ("nand_unlock: start: %08x, length: %d!\n",
367 (int)start, (int)length);
369 /* select the NAND device */
370 chipnr = (int)(start >> chip->chip_shift);
371 chip->select_chip(mtd, chipnr);
373 /* check the WP bit */
374 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
375 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
376 printf ("nand_unlock: Device is write protected!\n");
381 if ((start & (mtd->erasesize - 1)) != 0) {
382 printf ("nand_unlock: Start address must be beginning of "
388 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
389 printf ("nand_unlock: Length must be a multiple of nand block "
390 "size %08x!\n", mtd->erasesize);
396 * Set length so that the last address is set to the
397 * starting address of the last block
399 length -= mtd->erasesize;
401 /* submit address of first page to unlock */
402 page = (int)(start >> chip->page_shift);
403 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
405 /* submit ADDRESS of LAST page to unlock */
406 page += (int)(length >> chip->page_shift);
407 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
409 /* call wait ready function */
410 status = chip->waitfunc(mtd, chip);
411 /* see if device thinks it succeeded */
413 /* there was an error */
419 /* de-select the NAND device */
420 chip->select_chip(mtd, -1);
428 * Check if length including bad blocks fits into device.
430 * @param nand NAND device
431 * @param offset offset in flash
432 * @param length image length
433 * @return image length including bad blocks
435 static size_t get_len_incl_bad (nand_info_t *nand, loff_t offset,
438 size_t len_incl_bad = 0;
439 size_t len_excl_bad = 0;
442 while (len_excl_bad < length) {
443 block_len = nand->erasesize - (offset & (nand->erasesize - 1));
445 if (!nand_block_isbad (nand, offset & ~(nand->erasesize - 1)))
446 len_excl_bad += block_len;
448 len_incl_bad += block_len;
451 if (offset >= nand->size)
459 * nand_write_skip_bad:
461 * Write image to NAND flash.
462 * Blocks that are marked bad are skipped and the is written to the next
463 * block instead as long as the image is short enough to fit even after
464 * skipping the bad blocks.
466 * @param nand NAND device
467 * @param offset offset in flash
468 * @param length buffer length
469 * @param buf buffer to read from
470 * @return 0 in case of success
472 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
476 size_t left_to_write = *length;
478 u_char *p_buffer = buffer;
480 /* Reject writes, which are not page aligned */
481 if ((offset & (nand->writesize - 1)) != 0 ||
482 (*length & (nand->writesize - 1)) != 0) {
483 printf ("Attempt to write non page aligned data\n");
487 len_incl_bad = get_len_incl_bad (nand, offset, *length);
489 if ((offset + len_incl_bad) > nand->size) {
490 printf ("Attempt to write outside the flash area\n");
494 if (len_incl_bad == *length) {
495 rval = nand_write (nand, offset, length, buffer);
497 printf ("NAND write to offset %llx failed %d\n",
503 while (left_to_write > 0) {
504 size_t block_offset = offset & (nand->erasesize - 1);
509 if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
510 printf ("Skip bad block 0x%08llx\n",
511 offset & ~(nand->erasesize - 1));
512 offset += nand->erasesize - block_offset;
516 if (left_to_write < (nand->erasesize - block_offset))
517 write_size = left_to_write;
519 write_size = nand->erasesize - block_offset;
521 rval = nand_write (nand, offset, &write_size, p_buffer);
523 printf ("NAND write to offset %llx failed %d\n",
525 *length -= left_to_write;
529 left_to_write -= write_size;
530 offset += write_size;
531 p_buffer += write_size;
538 * nand_read_skip_bad:
540 * Read image from NAND flash.
541 * Blocks that are marked bad are skipped and the next block is readen
542 * instead as long as the image is short enough to fit even after skipping the
545 * @param nand NAND device
546 * @param offset offset in flash
547 * @param length buffer length, on return holds remaining bytes to read
548 * @param buffer buffer to write to
549 * @return 0 in case of success
551 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
555 size_t left_to_read = *length;
557 u_char *p_buffer = buffer;
559 len_incl_bad = get_len_incl_bad (nand, offset, *length);
561 if ((offset + len_incl_bad) > nand->size) {
562 printf ("Attempt to read outside the flash area\n");
566 if (len_incl_bad == *length) {
567 rval = nand_read (nand, offset, length, buffer);
568 if (!rval || rval == -EUCLEAN)
570 printf ("NAND read from offset %llx failed %d\n",
575 while (left_to_read > 0) {
576 size_t block_offset = offset & (nand->erasesize - 1);
581 if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
582 printf ("Skipping bad block 0x%08llx\n",
583 offset & ~(nand->erasesize - 1));
584 offset += nand->erasesize - block_offset;
588 if (left_to_read < (nand->erasesize - block_offset))
589 read_length = left_to_read;
591 read_length = nand->erasesize - block_offset;
593 rval = nand_read (nand, offset, &read_length, p_buffer);
594 if (rval && rval != -EUCLEAN) {
595 printf ("NAND read from offset %llx failed %d\n",
597 *length -= left_to_read;
601 left_to_read -= read_length;
602 offset += read_length;
603 p_buffer += read_length;