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 * Copyright 2010 Freescale Semiconductor
19 * SPDX-License-Identifier: GPL-2.0
28 #include <asm/errno.h>
29 #include <linux/mtd/mtd.h>
31 #include <jffs2/jffs2.h>
33 typedef struct erase_info erase_info_t;
34 typedef struct mtd_info mtd_info_t;
36 /* support only for native endian JFFS2 */
37 #define cpu_to_je16(x) (x)
38 #define cpu_to_je32(x) (x)
41 * nand_erase_opts: - erase NAND flash with support for various options
44 * @param meminfo NAND device to erase
45 * @param opts options, @see struct nand_erase_options
46 * @return 0 in case of success
48 * This code is ported from flash_eraseall.c from Linux mtd utils by
49 * Arcom Control System Ltd.
51 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
53 struct jffs2_unknown_node cleanmarker;
55 unsigned long erase_length, erased_length; /* in blocks */
57 int percent_complete = -1;
58 const char *mtd_device = meminfo->name;
59 struct mtd_oob_ops oob_opts;
60 struct nand_chip *chip = meminfo->priv;
62 if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
63 printf("Attempt to erase non block-aligned data\n");
67 memset(&erase, 0, sizeof(erase));
68 memset(&oob_opts, 0, sizeof(oob_opts));
71 erase.len = meminfo->erasesize;
72 erase.addr = opts->offset;
73 erase_length = lldiv(opts->length + meminfo->erasesize - 1,
76 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
77 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
78 cleanmarker.totlen = cpu_to_je32(8);
80 /* scrub option allows to erase badblock. To prevent internal
81 * check from erase() method, set block check method to dummy
82 * and disable bad block table while erasing.
85 erase.scrub = opts->scrub;
87 * We don't need the bad block table anymore...
88 * after scrub, there are no bad blocks left!
96 for (erased_length = 0;
97 erased_length < erase_length;
98 erase.addr += meminfo->erasesize) {
102 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
103 puts("Size of erase exceeds limit\n");
107 int ret = mtd_block_isbad(meminfo, erase.addr);
110 printf("\rSkipping bad block at "
120 } else if (ret < 0) {
121 printf("\n%s: MTD get bad block failed: %d\n",
130 result = mtd_erase(meminfo, &erase);
132 printf("\n%s: MTD Erase failure: %d\n",
137 /* format for JFFS2 ? */
138 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
139 struct mtd_oob_ops ops;
142 ops.oobbuf = (uint8_t *)&cleanmarker;
144 ops.mode = MTD_OPS_AUTO_OOB;
146 result = mtd_write_oob(meminfo,
150 printf("\n%s: MTD writeoob failure: %d\n",
157 unsigned long long n = erased_length * 100ULL;
160 do_div(n, erase_length);
163 /* output progress message only at whole percent
164 * steps to reduce the number of messages printed
165 * on (slow) serial consoles
167 if (percent != percent_complete) {
168 percent_complete = percent;
170 printf("\rErasing at 0x%llx -- %3d%% complete.",
171 erase.addr, percent);
173 if (opts->jffs2 && result == 0)
174 printf(" Cleanmarker written at 0x%llx.",
183 chip->scan_bbt(meminfo);
188 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
190 /******************************************************************************
191 * Support for locking / unlocking operations of some NAND devices
192 *****************************************************************************/
195 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
198 * @param mtd nand mtd instance
199 * @param tight bring device in lock tight mode
201 * @return 0 on success, -1 in case of error
203 * The lock / lock-tight command only applies to the whole chip. To get some
204 * parts of the chip lock and others unlocked use the following sequence:
206 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
207 * - Call nand_unlock() once for each consecutive area to be unlocked
208 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
210 * If the device is in lock-tight state software can't change the
211 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
212 * calls will fail. It is only posible to leave lock-tight state by
213 * an hardware signal (low pulse on _WP pin) or by power down.
215 int nand_lock(struct mtd_info *mtd, int tight)
219 struct nand_chip *chip = mtd->priv;
221 /* select the NAND device */
222 chip->select_chip(mtd, 0);
224 /* check the Lock Tight Status */
225 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
226 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
227 printf("nand_lock: Device is locked tight!\n");
233 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
236 /* call wait ready function */
237 status = chip->waitfunc(mtd, chip);
239 /* see if device thinks it succeeded */
245 /* de-select the NAND device */
246 chip->select_chip(mtd, -1);
251 * nand_get_lock_status: - query current lock state from one page of NAND
254 * @param mtd nand mtd instance
255 * @param offset page address to query (must be page-aligned!)
257 * @return -1 in case of error
259 * bitfield with the following combinations:
260 * NAND_LOCK_STATUS_TIGHT: page in tight state
261 * NAND_LOCK_STATUS_UNLOCK: page unlocked
264 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
269 struct nand_chip *chip = mtd->priv;
271 /* select the NAND device */
272 chipnr = (int)(offset >> chip->chip_shift);
273 chip->select_chip(mtd, chipnr);
276 if ((offset & (mtd->writesize - 1)) != 0) {
277 printf("nand_get_lock_status: "
278 "Start address must be beginning of "
284 /* check the Lock Status */
285 page = (int)(offset >> chip->page_shift);
286 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
288 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
289 | NAND_LOCK_STATUS_UNLOCK);
292 /* de-select the NAND device */
293 chip->select_chip(mtd, -1);
298 * nand_unlock: - Unlock area of NAND pages
299 * only one consecutive area can be unlocked at one time!
301 * @param mtd nand mtd instance
302 * @param start start byte address
303 * @param length number of bytes to unlock (must be a multiple of
304 * page size nand->writesize)
305 * @param allexcept if set, unlock everything not selected
307 * @return 0 on success, -1 in case of error
309 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
316 struct nand_chip *chip = mtd->priv;
318 debug("nand_unlock%s: start: %08llx, length: %zd!\n",
319 allexcept ? " (allexcept)" : "", start, length);
321 /* select the NAND device */
322 chipnr = (int)(start >> chip->chip_shift);
323 chip->select_chip(mtd, chipnr);
325 /* check the WP bit */
326 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
327 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
328 printf("nand_unlock: Device is write protected!\n");
333 /* check the Lock Tight Status */
334 page = (int)(start >> chip->page_shift);
335 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
336 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
337 printf("nand_unlock: Device is locked tight!\n");
342 if ((start & (mtd->erasesize - 1)) != 0) {
343 printf("nand_unlock: Start address must be beginning of "
349 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
350 printf("nand_unlock: Length must be a multiple of nand block "
351 "size %08x!\n", mtd->erasesize);
357 * Set length so that the last address is set to the
358 * starting address of the last block
360 length -= mtd->erasesize;
362 /* submit address of first page to unlock */
363 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
365 /* submit ADDRESS of LAST page to unlock */
366 page += (int)(length >> chip->page_shift);
369 * Page addresses for unlocking are supposed to be block-aligned.
370 * At least some NAND chips use the low bit to indicate that the
371 * page range should be inverted.
376 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
378 /* call wait ready function */
379 status = chip->waitfunc(mtd, chip);
380 /* see if device thinks it succeeded */
382 /* there was an error */
388 /* de-select the NAND device */
389 chip->select_chip(mtd, -1);
397 * Check if there are any bad blocks, and whether length including bad
398 * blocks fits into device
400 * @param nand NAND device
401 * @param offset offset in flash
402 * @param length image length
403 * @param used length of flash needed for the requested length
404 * @return 0 if the image fits and there are no bad blocks
405 * 1 if the image fits, but there are bad blocks
406 * -1 if the image does not fit
408 static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
411 size_t len_excl_bad = 0;
414 while (len_excl_bad < length) {
415 size_t block_len, block_off;
418 if (offset >= nand->size)
421 block_start = offset & ~(loff_t)(nand->erasesize - 1);
422 block_off = offset & (nand->erasesize - 1);
423 block_len = nand->erasesize - block_off;
425 if (!nand_block_isbad(nand, block_start))
426 len_excl_bad += block_len;
434 /* If the length is not a multiple of block_len, adjust. */
435 if (len_excl_bad > length)
436 *used -= (len_excl_bad - length);
441 #ifdef CONFIG_CMD_NAND_TRIMFFS
442 static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
448 for (i = l - 1; i >= 0; i--)
452 /* The resulting length must be aligned to the minimum flash I/O size */
454 l = (l + nand->writesize - 1) / nand->writesize;
455 l *= nand->writesize;
458 * since the input length may be unaligned, prevent access past the end
466 * nand_write_skip_bad:
468 * Write image to NAND flash.
469 * Blocks that are marked bad are skipped and the is written to the next
470 * block instead as long as the image is short enough to fit even after
471 * skipping the bad blocks. Due to bad blocks we may not be able to
472 * perform the requested write. In the case where the write would
473 * extend beyond the end of the NAND device, both length and actual (if
474 * not NULL) are set to 0. In the case where the write would extend
475 * beyond the limit we are passed, length is set to 0 and actual is set
476 * to the required length.
478 * @param nand NAND device
479 * @param offset offset in flash
480 * @param length buffer length
481 * @param actual set to size required to write length worth of
482 * buffer or 0 on error, if not NULL
483 * @param lim maximum size that actual may be in order to not
485 * @param buffer buffer to read from
486 * @param flags flags modifying the behaviour of the write to NAND
487 * @return 0 in case of success
489 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
490 size_t *actual, loff_t lim, u_char *buffer, int flags)
492 int rval = 0, blocksize;
493 size_t left_to_write = *length;
494 size_t used_for_write = 0;
495 u_char *p_buffer = buffer;
501 #ifdef CONFIG_CMD_NAND_YAFFS
502 if (flags & WITH_YAFFS_OOB) {
503 if (flags & ~WITH_YAFFS_OOB)
507 pages = nand->erasesize / nand->writesize;
508 blocksize = (pages * nand->oobsize) + nand->erasesize;
509 if (*length % (nand->writesize + nand->oobsize)) {
510 printf("Attempt to write incomplete page"
517 blocksize = nand->erasesize;
521 * nand_write() handles unaligned, partial page writes.
523 * We allow length to be unaligned, for convenience in
524 * using the $filesize variable.
526 * However, starting at an unaligned offset makes the
527 * semantics of bad block skipping ambiguous (really,
528 * you should only start a block skipping access at a
529 * partition boundary). So don't try to handle that.
531 if ((offset & (nand->writesize - 1)) != 0) {
532 printf("Attempt to write non page-aligned data\n");
537 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
540 *actual = used_for_write;
543 printf("Attempt to write outside the flash area\n");
548 if (used_for_write > lim) {
549 puts("Size of write exceeds partition or device limit\n");
554 if (!need_skip && !(flags & WITH_DROP_FFS)) {
555 rval = nand_write(nand, offset, length, buffer);
560 printf("NAND write to offset %llx failed %d\n",
565 while (left_to_write > 0) {
566 size_t block_offset = offset & (nand->erasesize - 1);
567 size_t write_size, truncated_write_size;
571 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
572 printf("Skip bad block 0x%08llx\n",
573 offset & ~(nand->erasesize - 1));
574 offset += nand->erasesize - block_offset;
578 if (left_to_write < (blocksize - block_offset))
579 write_size = left_to_write;
581 write_size = blocksize - block_offset;
583 #ifdef CONFIG_CMD_NAND_YAFFS
584 if (flags & WITH_YAFFS_OOB) {
586 size_t pagesize = nand->writesize;
587 size_t pagesize_oob = pagesize + nand->oobsize;
588 struct mtd_oob_ops ops;
591 ops.ooblen = nand->oobsize;
592 ops.mode = MTD_OPS_AUTO_OOB;
595 pages = write_size / pagesize_oob;
596 for (page = 0; page < pages; page++) {
599 ops.datbuf = p_buffer;
600 ops.oobbuf = ops.datbuf + pagesize;
602 rval = mtd_write_oob(nand, offset, &ops);
607 p_buffer += pagesize_oob;
613 truncated_write_size = write_size;
614 #ifdef CONFIG_CMD_NAND_TRIMFFS
615 if (flags & WITH_DROP_FFS)
616 truncated_write_size = drop_ffs(nand, p_buffer,
620 rval = nand_write(nand, offset, &truncated_write_size,
622 offset += write_size;
623 p_buffer += write_size;
627 printf("NAND write to offset %llx failed %d\n",
629 *length -= left_to_write;
633 left_to_write -= write_size;
640 * nand_read_skip_bad:
642 * Read image from NAND flash.
643 * Blocks that are marked bad are skipped and the next block is read
644 * instead as long as the image is short enough to fit even after
645 * skipping the bad blocks. Due to bad blocks we may not be able to
646 * perform the requested read. In the case where the read would extend
647 * beyond the end of the NAND device, both length and actual (if not
648 * NULL) are set to 0. In the case where the read would extend beyond
649 * the limit we are passed, length is set to 0 and actual is set to the
652 * @param nand NAND device
653 * @param offset offset in flash
654 * @param length buffer length, on return holds number of read bytes
655 * @param actual set to size required to read length worth of buffer or 0
656 * on error, if not NULL
657 * @param lim maximum size that actual may be in order to not exceed the
659 * @param buffer buffer to write to
660 * @return 0 in case of success
662 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
663 size_t *actual, loff_t lim, u_char *buffer)
666 size_t left_to_read = *length;
667 size_t used_for_read = 0;
668 u_char *p_buffer = buffer;
671 if ((offset & (nand->writesize - 1)) != 0) {
672 printf("Attempt to read non page-aligned data\n");
679 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
682 *actual = used_for_read;
685 printf("Attempt to read outside the flash area\n");
690 if (used_for_read > lim) {
691 puts("Size of read exceeds partition or device limit\n");
697 rval = nand_read(nand, offset, length, buffer);
698 if (!rval || rval == -EUCLEAN)
702 printf("NAND read from offset %llx failed %d\n",
707 while (left_to_read > 0) {
708 size_t block_offset = offset & (nand->erasesize - 1);
713 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
714 printf("Skipping bad block 0x%08llx\n",
715 offset & ~(nand->erasesize - 1));
716 offset += nand->erasesize - block_offset;
720 if (left_to_read < (nand->erasesize - block_offset))
721 read_length = left_to_read;
723 read_length = nand->erasesize - block_offset;
725 rval = nand_read(nand, offset, &read_length, p_buffer);
726 if (rval && rval != -EUCLEAN) {
727 printf("NAND read from offset %llx failed %d\n",
729 *length -= left_to_read;
733 left_to_read -= read_length;
734 offset += read_length;
735 p_buffer += read_length;
741 #ifdef CONFIG_CMD_NAND_TORTURE
746 * Check if buffer contains only a certain byte pattern.
748 * @param buf buffer to check
749 * @param patt the pattern to check
750 * @param size buffer size in bytes
751 * @return 1 if there are only patt bytes in buf
752 * 0 if something else was found
754 static int check_pattern(const u_char *buf, u_char patt, int size)
758 for (i = 0; i < size; i++)
767 * Torture a block of NAND flash.
768 * This is useful to determine if a block that caused a write error is still
769 * good or should be marked as bad.
771 * @param nand NAND device
772 * @param offset offset in flash
773 * @return 0 if the block is still good
775 int nand_torture(nand_info_t *nand, loff_t offset)
777 u_char patterns[] = {0xa5, 0x5a, 0x00};
778 struct erase_info instr = {
781 .len = nand->erasesize,
784 int err, ret = -1, i, patt_count;
787 if ((offset & (nand->erasesize - 1)) != 0) {
788 puts("Attempt to torture a block at a non block-aligned offset\n");
792 if (offset + nand->erasesize > nand->size) {
793 puts("Attempt to torture a block outside the flash area\n");
797 patt_count = ARRAY_SIZE(patterns);
799 buf = malloc(nand->erasesize);
801 puts("Out of memory for erase block buffer\n");
805 for (i = 0; i < patt_count; i++) {
806 err = nand->erase(nand, &instr);
808 printf("%s: erase() failed for block at 0x%llx: %d\n",
809 nand->name, instr.addr, err);
813 /* Make sure the block contains only 0xff bytes */
814 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
815 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
816 printf("%s: read() failed for block at 0x%llx: %d\n",
817 nand->name, instr.addr, err);
821 err = check_pattern(buf, 0xff, nand->erasesize);
823 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
829 /* Write a pattern and check it */
830 memset(buf, patterns[i], nand->erasesize);
831 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
832 if (err || retlen != nand->erasesize) {
833 printf("%s: write() failed for block at 0x%llx: %d\n",
834 nand->name, instr.addr, err);
838 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
839 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
840 printf("%s: read() failed for block at 0x%llx: %d\n",
841 nand->name, instr.addr, err);
845 err = check_pattern(buf, patterns[i], nand->erasesize);
847 printf("Pattern 0x%.2x checking failed for block at "
848 "0x%llx\n", patterns[i], offset);