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 * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
15 * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
17 * See file CREDITS for list of people who contributed to this
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.
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.
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,
34 * 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.
48 #include <asm/errno.h>
49 #include <linux/mtd/mtd.h>
51 #include <jffs2/jffs2.h>
53 typedef struct erase_info erase_info_t;
54 typedef struct mtd_info mtd_info_t;
56 /* support only for native endian JFFS2 */
57 #define cpu_to_je16(x) (x)
58 #define cpu_to_je32(x) (x)
61 * nand_erase_opts: - erase NAND flash with support for various options
64 * @param meminfo NAND device to erase
65 * @param opts options, @see struct nand_erase_options
66 * @return 0 in case of success
68 * This code is ported from flash_eraseall.c from Linux mtd utils by
69 * Arcom Control System Ltd.
71 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
73 struct jffs2_unknown_node cleanmarker;
75 unsigned long erase_length, erased_length; /* in blocks */
78 int percent_complete = -1;
79 const char *mtd_device = meminfo->name;
80 struct mtd_oob_ops oob_opts;
81 struct nand_chip *chip = meminfo->priv;
83 if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
84 printf("Attempt to erase non block-aligned data\n");
88 memset(&erase, 0, sizeof(erase));
89 memset(&oob_opts, 0, sizeof(oob_opts));
92 erase.len = meminfo->erasesize;
93 erase.addr = opts->offset;
94 erase_length = lldiv(opts->length + meminfo->erasesize - 1,
97 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
98 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
99 cleanmarker.totlen = cpu_to_je32(8);
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.
106 erase.scrub = opts->scrub;
108 * We don't need the bad block table anymore...
109 * after scrub, there are no bad blocks left!
117 for (erased_length = 0;
118 erased_length < erase_length;
119 erase.addr += meminfo->erasesize) {
123 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
124 puts("Size of erase exceeds limit\n");
127 if (!opts->scrub && bbtest) {
128 int ret = mtd_block_isbad(meminfo, erase.addr);
131 printf("\rSkipping bad block at "
141 } else if (ret < 0) {
142 printf("\n%s: MTD get bad block failed: %d\n",
151 result = mtd_erase(meminfo, &erase);
153 printf("\n%s: MTD Erase failure: %d\n",
158 /* format for JFFS2 ? */
159 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
160 struct mtd_oob_ops ops;
163 ops.oobbuf = (uint8_t *)&cleanmarker;
165 ops.mode = MTD_OPS_AUTO_OOB;
167 result = mtd_write_oob(meminfo,
171 printf("\n%s: MTD writeoob failure: %d\n",
178 unsigned long long n = erased_length * 100ULL;
181 do_div(n, erase_length);
184 /* output progress message only at whole percent
185 * steps to reduce the number of messages printed
186 * on (slow) serial consoles
188 if (percent != percent_complete) {
189 percent_complete = percent;
191 printf("\rErasing at 0x%llx -- %3d%% complete.",
192 erase.addr, percent);
194 if (opts->jffs2 && result == 0)
195 printf(" Cleanmarker written at 0x%llx.",
204 chip->scan_bbt(meminfo);
209 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
211 /******************************************************************************
212 * Support for locking / unlocking operations of some NAND devices
213 *****************************************************************************/
216 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
219 * @param mtd nand mtd instance
220 * @param tight bring device in lock tight mode
222 * @return 0 on success, -1 in case of error
224 * The lock / lock-tight command only applies to the whole chip. To get some
225 * parts of the chip lock and others unlocked use the following sequence:
227 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
228 * - Call nand_unlock() once for each consecutive area to be unlocked
229 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
231 * If the device is in lock-tight state software can't change the
232 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
233 * calls will fail. It is only posible to leave lock-tight state by
234 * an hardware signal (low pulse on _WP pin) or by power down.
236 int nand_lock(struct mtd_info *mtd, int tight)
240 struct nand_chip *chip = mtd->priv;
242 /* select the NAND device */
243 chip->select_chip(mtd, 0);
245 /* check the Lock Tight Status */
246 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
247 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
248 printf("nand_lock: Device is locked tight!\n");
254 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
257 /* call wait ready function */
258 status = chip->waitfunc(mtd, chip);
260 /* see if device thinks it succeeded */
266 /* de-select the NAND device */
267 chip->select_chip(mtd, -1);
272 * nand_get_lock_status: - query current lock state from one page of NAND
275 * @param mtd nand mtd instance
276 * @param offset page address to query (must be page-aligned!)
278 * @return -1 in case of error
280 * bitfield with the following combinations:
281 * NAND_LOCK_STATUS_TIGHT: page in tight state
282 * NAND_LOCK_STATUS_UNLOCK: page unlocked
285 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
290 struct nand_chip *chip = mtd->priv;
292 /* select the NAND device */
293 chipnr = (int)(offset >> chip->chip_shift);
294 chip->select_chip(mtd, chipnr);
297 if ((offset & (mtd->writesize - 1)) != 0) {
298 printf("nand_get_lock_status: "
299 "Start address must be beginning of "
305 /* check the Lock Status */
306 page = (int)(offset >> chip->page_shift);
307 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
309 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
310 | NAND_LOCK_STATUS_UNLOCK);
313 /* de-select the NAND device */
314 chip->select_chip(mtd, -1);
319 * nand_unlock: - Unlock area of NAND pages
320 * only one consecutive area can be unlocked at one time!
322 * @param mtd nand mtd instance
323 * @param start start byte address
324 * @param length number of bytes to unlock (must be a multiple of
325 * page size nand->writesize)
326 * @param allexcept if set, unlock everything not selected
328 * @return 0 on success, -1 in case of error
330 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
337 struct nand_chip *chip = mtd->priv;
339 debug("nand_unlock%s: start: %08llx, length: %d!\n",
340 allexcept ? " (allexcept)" : "", start, length);
342 /* select the NAND device */
343 chipnr = (int)(start >> chip->chip_shift);
344 chip->select_chip(mtd, chipnr);
346 /* check the WP bit */
347 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
348 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
349 printf("nand_unlock: Device is write protected!\n");
354 /* check the Lock Tight Status */
355 page = (int)(start >> chip->page_shift);
356 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
357 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
358 printf("nand_unlock: Device is locked tight!\n");
363 if ((start & (mtd->erasesize - 1)) != 0) {
364 printf("nand_unlock: Start address must be beginning of "
370 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
371 printf("nand_unlock: Length must be a multiple of nand block "
372 "size %08x!\n", mtd->erasesize);
378 * Set length so that the last address is set to the
379 * starting address of the last block
381 length -= mtd->erasesize;
383 /* submit address of first page to unlock */
384 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
386 /* submit ADDRESS of LAST page to unlock */
387 page += (int)(length >> chip->page_shift);
390 * Page addresses for unlocking are supposed to be block-aligned.
391 * At least some NAND chips use the low bit to indicate that the
392 * page range should be inverted.
397 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
399 /* call wait ready function */
400 status = chip->waitfunc(mtd, chip);
401 /* see if device thinks it succeeded */
403 /* there was an error */
409 /* de-select the NAND device */
410 chip->select_chip(mtd, -1);
418 * Check if there are any bad blocks, and whether length including bad
419 * blocks fits into device
421 * @param nand NAND device
422 * @param offset offset in flash
423 * @param length image length
424 * @param used length of flash needed for the requested length
425 * @return 0 if the image fits and there are no bad blocks
426 * 1 if the image fits, but there are bad blocks
427 * -1 if the image does not fit
429 static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
432 size_t len_excl_bad = 0;
435 while (len_excl_bad < length) {
436 size_t block_len, block_off;
439 if (offset >= nand->size)
442 block_start = offset & ~(loff_t)(nand->erasesize - 1);
443 block_off = offset & (nand->erasesize - 1);
444 block_len = nand->erasesize - block_off;
446 if (!nand_block_isbad(nand, block_start))
447 len_excl_bad += block_len;
455 /* If the length is not a multiple of block_len, adjust. */
456 if (len_excl_bad > length)
457 *used -= (len_excl_bad - length);
462 #ifdef CONFIG_CMD_NAND_TRIMFFS
463 static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
469 for (i = l - 1; i >= 0; i--)
473 /* The resulting length must be aligned to the minimum flash I/O size */
475 l = (l + nand->writesize - 1) / nand->writesize;
476 l *= nand->writesize;
479 * since the input length may be unaligned, prevent access past the end
487 * nand_write_skip_bad:
489 * Write image to NAND flash.
490 * Blocks that are marked bad are skipped and the is written to the next
491 * block instead as long as the image is short enough to fit even after
492 * skipping the bad blocks. Due to bad blocks we may not be able to
493 * perform the requested write. In the case where the write would
494 * extend beyond the end of the NAND device, both length and actual (if
495 * not NULL) are set to 0. In the case where the write would extend
496 * beyond the limit we are passed, length is set to 0 and actual is set
497 * to the required length.
499 * @param nand NAND device
500 * @param offset offset in flash
501 * @param length buffer length
502 * @param actual set to size required to write length worth of
503 * buffer or 0 on error, if not NULL
504 * @param lim maximum size that actual may be in order to not
506 * @param buffer buffer to read from
507 * @param flags flags modifying the behaviour of the write to NAND
508 * @return 0 in case of success
510 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
511 size_t *actual, loff_t lim, u_char *buffer, int flags)
513 int rval = 0, blocksize;
514 size_t left_to_write = *length;
515 size_t used_for_write = 0;
516 u_char *p_buffer = buffer;
522 #ifdef CONFIG_CMD_NAND_YAFFS
523 if (flags & WITH_YAFFS_OOB) {
524 if (flags & ~WITH_YAFFS_OOB)
528 pages = nand->erasesize / nand->writesize;
529 blocksize = (pages * nand->oobsize) + nand->erasesize;
530 if (*length % (nand->writesize + nand->oobsize)) {
531 printf("Attempt to write incomplete page"
538 blocksize = nand->erasesize;
542 * nand_write() handles unaligned, partial page writes.
544 * We allow length to be unaligned, for convenience in
545 * using the $filesize variable.
547 * However, starting at an unaligned offset makes the
548 * semantics of bad block skipping ambiguous (really,
549 * you should only start a block skipping access at a
550 * partition boundary). So don't try to handle that.
552 if ((offset & (nand->writesize - 1)) != 0) {
553 printf("Attempt to write non page-aligned data\n");
558 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
561 *actual = used_for_write;
564 printf("Attempt to write outside the flash area\n");
569 if (used_for_write > lim) {
570 puts("Size of write exceeds partition or device limit\n");
575 if (!need_skip && !(flags & WITH_DROP_FFS)) {
576 rval = nand_write(nand, offset, length, buffer);
581 printf("NAND write to offset %llx failed %d\n",
586 while (left_to_write > 0) {
587 size_t block_offset = offset & (nand->erasesize - 1);
588 size_t write_size, truncated_write_size;
592 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
593 printf("Skip bad block 0x%08llx\n",
594 offset & ~(nand->erasesize - 1));
595 offset += nand->erasesize - block_offset;
599 if (left_to_write < (blocksize - block_offset))
600 write_size = left_to_write;
602 write_size = blocksize - block_offset;
604 #ifdef CONFIG_CMD_NAND_YAFFS
605 if (flags & WITH_YAFFS_OOB) {
607 size_t pagesize = nand->writesize;
608 size_t pagesize_oob = pagesize + nand->oobsize;
609 struct mtd_oob_ops ops;
612 ops.ooblen = nand->oobsize;
613 ops.mode = MTD_OPS_AUTO_OOB;
616 pages = write_size / pagesize_oob;
617 for (page = 0; page < pages; page++) {
620 ops.datbuf = p_buffer;
621 ops.oobbuf = ops.datbuf + pagesize;
623 rval = mtd_write_oob(nand, offset, &ops);
628 p_buffer += pagesize_oob;
634 truncated_write_size = write_size;
635 #ifdef CONFIG_CMD_NAND_TRIMFFS
636 if (flags & WITH_DROP_FFS)
637 truncated_write_size = drop_ffs(nand, p_buffer,
641 rval = nand_write(nand, offset, &truncated_write_size,
643 offset += write_size;
644 p_buffer += write_size;
648 printf("NAND write to offset %llx failed %d\n",
650 *length -= left_to_write;
654 left_to_write -= write_size;
661 * nand_read_skip_bad:
663 * Read image from NAND flash.
664 * Blocks that are marked bad are skipped and the next block is read
665 * instead as long as the image is short enough to fit even after
666 * skipping the bad blocks. Due to bad blocks we may not be able to
667 * perform the requested read. In the case where the read would extend
668 * beyond the end of the NAND device, both length and actual (if not
669 * NULL) are set to 0. In the case where the read would extend beyond
670 * the limit we are passed, length is set to 0 and actual is set to the
673 * @param nand NAND device
674 * @param offset offset in flash
675 * @param length buffer length, on return holds number of read bytes
676 * @param actual set to size required to read length worth of buffer or 0
677 * on error, if not NULL
678 * @param lim maximum size that actual may be in order to not exceed the
680 * @param buffer buffer to write to
681 * @return 0 in case of success
683 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
684 size_t *actual, loff_t lim, u_char *buffer)
687 size_t left_to_read = *length;
688 size_t used_for_read = 0;
689 u_char *p_buffer = buffer;
692 if ((offset & (nand->writesize - 1)) != 0) {
693 printf("Attempt to read non page-aligned data\n");
700 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
703 *actual = used_for_read;
706 printf("Attempt to read outside the flash area\n");
711 if (used_for_read > lim) {
712 puts("Size of read exceeds partition or device limit\n");
718 rval = nand_read(nand, offset, length, buffer);
719 if (!rval || rval == -EUCLEAN)
723 printf("NAND read from offset %llx failed %d\n",
728 while (left_to_read > 0) {
729 size_t block_offset = offset & (nand->erasesize - 1);
734 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
735 printf("Skipping bad block 0x%08llx\n",
736 offset & ~(nand->erasesize - 1));
737 offset += nand->erasesize - block_offset;
741 if (left_to_read < (nand->erasesize - block_offset))
742 read_length = left_to_read;
744 read_length = nand->erasesize - block_offset;
746 rval = nand_read(nand, offset, &read_length, p_buffer);
747 if (rval && rval != -EUCLEAN) {
748 printf("NAND read from offset %llx failed %d\n",
750 *length -= left_to_read;
754 left_to_read -= read_length;
755 offset += read_length;
756 p_buffer += read_length;
762 #ifdef CONFIG_CMD_NAND_TORTURE
767 * Check if buffer contains only a certain byte pattern.
769 * @param buf buffer to check
770 * @param patt the pattern to check
771 * @param size buffer size in bytes
772 * @return 1 if there are only patt bytes in buf
773 * 0 if something else was found
775 static int check_pattern(const u_char *buf, u_char patt, int size)
779 for (i = 0; i < size; i++)
788 * Torture a block of NAND flash.
789 * This is useful to determine if a block that caused a write error is still
790 * good or should be marked as bad.
792 * @param nand NAND device
793 * @param offset offset in flash
794 * @return 0 if the block is still good
796 int nand_torture(nand_info_t *nand, loff_t offset)
798 u_char patterns[] = {0xa5, 0x5a, 0x00};
799 struct erase_info instr = {
802 .len = nand->erasesize,
805 int err, ret = -1, i, patt_count;
808 if ((offset & (nand->erasesize - 1)) != 0) {
809 puts("Attempt to torture a block at a non block-aligned offset\n");
813 if (offset + nand->erasesize > nand->size) {
814 puts("Attempt to torture a block outside the flash area\n");
818 patt_count = ARRAY_SIZE(patterns);
820 buf = malloc(nand->erasesize);
822 puts("Out of memory for erase block buffer\n");
826 for (i = 0; i < patt_count; i++) {
827 err = nand->erase(nand, &instr);
829 printf("%s: erase() failed for block at 0x%llx: %d\n",
830 nand->name, instr.addr, err);
834 /* Make sure the block contains only 0xff bytes */
835 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
836 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
837 printf("%s: read() failed for block at 0x%llx: %d\n",
838 nand->name, instr.addr, err);
842 err = check_pattern(buf, 0xff, nand->erasesize);
844 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
850 /* Write a pattern and check it */
851 memset(buf, patterns[i], nand->erasesize);
852 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
853 if (err || retlen != nand->erasesize) {
854 printf("%s: write() failed for block at 0x%llx: %d\n",
855 nand->name, instr.addr, err);
859 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
860 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
861 printf("%s: read() failed for block at 0x%llx: %d\n",
862 nand->name, instr.addr, err);
866 err = check_pattern(buf, patterns[i], nand->erasesize);
868 printf("Pattern 0x%.2x checking failed for block at "
869 "0x%llx\n", patterns[i], offset);