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
29 #include <asm/errno.h>
30 #include <linux/mtd/mtd.h>
32 #include <jffs2/jffs2.h>
34 typedef struct erase_info erase_info_t;
35 typedef struct mtd_info mtd_info_t;
37 /* support only for native endian JFFS2 */
38 #define cpu_to_je16(x) (x)
39 #define cpu_to_je32(x) (x)
42 * nand_erase_opts: - erase NAND flash with support for various options
45 * @param meminfo NAND device to erase
46 * @param opts options, @see struct nand_erase_options
47 * @return 0 in case of success
49 * This code is ported from flash_eraseall.c from Linux mtd utils by
50 * Arcom Control System Ltd.
52 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
54 struct jffs2_unknown_node cleanmarker;
56 unsigned long erase_length, erased_length; /* in blocks */
58 int percent_complete = -1;
59 const char *mtd_device = meminfo->name;
60 struct mtd_oob_ops oob_opts;
61 struct nand_chip *chip = meminfo->priv;
63 if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
64 printf("Attempt to erase non block-aligned data\n");
68 memset(&erase, 0, sizeof(erase));
69 memset(&oob_opts, 0, sizeof(oob_opts));
72 erase.len = meminfo->erasesize;
73 erase.addr = opts->offset;
74 erase_length = lldiv(opts->length + meminfo->erasesize - 1,
77 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
78 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
79 cleanmarker.totlen = cpu_to_je32(8);
81 /* scrub option allows to erase badblock. To prevent internal
82 * check from erase() method, set block check method to dummy
83 * and disable bad block table while erasing.
86 erase.scrub = opts->scrub;
88 * We don't need the bad block table anymore...
89 * after scrub, there are no bad blocks left!
95 chip->options &= ~NAND_BBT_SCANNED;
98 for (erased_length = 0;
99 erased_length < erase_length;
100 erase.addr += meminfo->erasesize) {
104 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
105 puts("Size of erase exceeds limit\n");
109 int ret = mtd_block_isbad(meminfo, erase.addr);
112 printf("\rSkipping bad block at "
122 } else if (ret < 0) {
123 printf("\n%s: MTD get bad block failed: %d\n",
132 result = mtd_erase(meminfo, &erase);
134 printf("\n%s: MTD Erase failure: %d\n",
139 /* format for JFFS2 ? */
140 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
141 struct mtd_oob_ops ops;
144 ops.oobbuf = (uint8_t *)&cleanmarker;
146 ops.mode = MTD_OPS_AUTO_OOB;
148 result = mtd_write_oob(meminfo,
152 printf("\n%s: MTD writeoob failure: %d\n",
159 unsigned long long n = erased_length * 100ULL;
162 do_div(n, erase_length);
165 /* output progress message only at whole percent
166 * steps to reduce the number of messages printed
167 * on (slow) serial consoles
169 if (percent != percent_complete) {
170 percent_complete = percent;
172 printf("\rErasing at 0x%llx -- %3d%% complete.",
173 erase.addr, percent);
175 if (opts->jffs2 && result == 0)
176 printf(" Cleanmarker written at 0x%llx.",
187 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
189 #define NAND_CMD_LOCK_TIGHT 0x2c
190 #define NAND_CMD_LOCK_STATUS 0x7a
192 /******************************************************************************
193 * Support for locking / unlocking operations of some NAND devices
194 *****************************************************************************/
197 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
200 * @param mtd nand mtd instance
201 * @param tight bring device in lock tight mode
203 * @return 0 on success, -1 in case of error
205 * The lock / lock-tight command only applies to the whole chip. To get some
206 * parts of the chip lock and others unlocked use the following sequence:
208 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
209 * - Call nand_unlock() once for each consecutive area to be unlocked
210 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
212 * If the device is in lock-tight state software can't change the
213 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
214 * calls will fail. It is only posible to leave lock-tight state by
215 * an hardware signal (low pulse on _WP pin) or by power down.
217 int nand_lock(struct mtd_info *mtd, int tight)
221 struct nand_chip *chip = mtd->priv;
223 /* select the NAND device */
224 chip->select_chip(mtd, 0);
226 /* check the Lock Tight Status */
227 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
228 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
229 printf("nand_lock: Device is locked tight!\n");
235 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
238 /* call wait ready function */
239 status = chip->waitfunc(mtd, chip);
241 /* see if device thinks it succeeded */
247 /* de-select the NAND device */
248 chip->select_chip(mtd, -1);
253 * nand_get_lock_status: - query current lock state from one page of NAND
256 * @param mtd nand mtd instance
257 * @param offset page address to query (must be page-aligned!)
259 * @return -1 in case of error
261 * bitfield with the following combinations:
262 * NAND_LOCK_STATUS_TIGHT: page in tight state
263 * NAND_LOCK_STATUS_UNLOCK: page unlocked
266 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
271 struct nand_chip *chip = mtd->priv;
273 /* select the NAND device */
274 chipnr = (int)(offset >> chip->chip_shift);
275 chip->select_chip(mtd, chipnr);
278 if ((offset & (mtd->writesize - 1)) != 0) {
279 printf("nand_get_lock_status: "
280 "Start address must be beginning of "
286 /* check the Lock Status */
287 page = (int)(offset >> chip->page_shift);
288 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
290 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
291 | NAND_LOCK_STATUS_UNLOCK);
294 /* de-select the NAND device */
295 chip->select_chip(mtd, -1);
300 * nand_unlock: - Unlock area of NAND pages
301 * only one consecutive area can be unlocked at one time!
303 * @param mtd nand mtd instance
304 * @param start start byte address
305 * @param length number of bytes to unlock (must be a multiple of
306 * page size nand->writesize)
307 * @param allexcept if set, unlock everything not selected
309 * @return 0 on success, -1 in case of error
311 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
318 struct nand_chip *chip = mtd->priv;
320 debug("nand_unlock%s: start: %08llx, length: %zd!\n",
321 allexcept ? " (allexcept)" : "", start, length);
323 /* select the NAND device */
324 chipnr = (int)(start >> chip->chip_shift);
325 chip->select_chip(mtd, chipnr);
327 /* check the WP bit */
328 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
329 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
330 printf("nand_unlock: Device is write protected!\n");
335 /* check the Lock Tight Status */
336 page = (int)(start >> chip->page_shift);
337 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
338 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
339 printf("nand_unlock: Device is locked tight!\n");
344 if ((start & (mtd->erasesize - 1)) != 0) {
345 printf("nand_unlock: Start address must be beginning of "
351 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
352 printf("nand_unlock: Length must be a multiple of nand block "
353 "size %08x!\n", mtd->erasesize);
359 * Set length so that the last address is set to the
360 * starting address of the last block
362 length -= mtd->erasesize;
364 /* submit address of first page to unlock */
365 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
367 /* submit ADDRESS of LAST page to unlock */
368 page += (int)(length >> chip->page_shift);
371 * Page addresses for unlocking are supposed to be block-aligned.
372 * At least some NAND chips use the low bit to indicate that the
373 * page range should be inverted.
378 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
380 /* call wait ready function */
381 status = chip->waitfunc(mtd, chip);
382 /* see if device thinks it succeeded */
384 /* there was an error */
390 /* de-select the NAND device */
391 chip->select_chip(mtd, -1);
399 * Check if there are any bad blocks, and whether length including bad
400 * blocks fits into device
402 * @param nand NAND device
403 * @param offset offset in flash
404 * @param length image length
405 * @param used length of flash needed for the requested length
406 * @return 0 if the image fits and there are no bad blocks
407 * 1 if the image fits, but there are bad blocks
408 * -1 if the image does not fit
410 static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
413 size_t len_excl_bad = 0;
416 while (len_excl_bad < length) {
417 size_t block_len, block_off;
420 if (offset >= nand->size)
423 block_start = offset & ~(loff_t)(nand->erasesize - 1);
424 block_off = offset & (nand->erasesize - 1);
425 block_len = nand->erasesize - block_off;
427 if (!nand_block_isbad(nand, block_start))
428 len_excl_bad += block_len;
436 /* If the length is not a multiple of block_len, adjust. */
437 if (len_excl_bad > length)
438 *used -= (len_excl_bad - length);
443 #ifdef CONFIG_CMD_NAND_TRIMFFS
444 static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
450 for (i = l - 1; i >= 0; i--)
454 /* The resulting length must be aligned to the minimum flash I/O size */
456 l = (l + nand->writesize - 1) / nand->writesize;
457 l *= nand->writesize;
460 * since the input length may be unaligned, prevent access past the end
468 * nand_verify_page_oob:
470 * Verify a page of NAND flash, including the OOB.
471 * Reads page of NAND and verifies the contents and OOB against the
474 * @param nand NAND device
475 * @param ops MTD operations, including data to verify
476 * @param ofs offset in flash
477 * @return 0 in case of success
479 int nand_verify_page_oob(nand_info_t *nand, struct mtd_oob_ops *ops, loff_t ofs)
482 struct mtd_oob_ops vops;
483 size_t verlen = nand->writesize + nand->oobsize;
485 memcpy(&vops, ops, sizeof(vops));
487 vops.datbuf = memalign(ARCH_DMA_MINALIGN, verlen);
492 vops.oobbuf = vops.datbuf + nand->writesize;
494 rval = mtd_read_oob(nand, ofs, &vops);
496 rval = memcmp(ops->datbuf, vops.datbuf, vops.len);
498 rval = memcmp(ops->oobbuf, vops.oobbuf, vops.ooblen);
502 return rval ? -EIO : 0;
508 * Verify a region of NAND flash.
509 * Reads NAND in page-sized chunks and verifies the contents against
510 * the contents of a buffer. The offset into the NAND must be
511 * page-aligned, and the function doesn't handle skipping bad blocks.
513 * @param nand NAND device
514 * @param ofs offset in flash
515 * @param len buffer length
516 * @param buf buffer to read from
517 * @return 0 in case of success
519 int nand_verify(nand_info_t *nand, loff_t ofs, size_t len, u_char *buf)
523 size_t verlen = nand->writesize;
524 uint8_t *verbuf = memalign(ARCH_DMA_MINALIGN, verlen);
529 /* Read the NAND back in page-size groups to limit malloc size */
530 for (verofs = ofs; verofs < ofs + len;
531 verofs += verlen, buf += verlen) {
532 verlen = min(nand->writesize, (uint32_t)(ofs + len - verofs));
533 rval = nand_read(nand, verofs, &verlen, verbuf);
534 if (!rval || (rval == -EUCLEAN))
535 rval = memcmp(buf, verbuf, verlen);
543 return rval ? -EIO : 0;
549 * nand_write_skip_bad:
551 * Write image to NAND flash.
552 * Blocks that are marked bad are skipped and the is written to the next
553 * block instead as long as the image is short enough to fit even after
554 * skipping the bad blocks. Due to bad blocks we may not be able to
555 * perform the requested write. In the case where the write would
556 * extend beyond the end of the NAND device, both length and actual (if
557 * not NULL) are set to 0. In the case where the write would extend
558 * beyond the limit we are passed, length is set to 0 and actual is set
559 * to the required length.
561 * @param nand NAND device
562 * @param offset offset in flash
563 * @param length buffer length
564 * @param actual set to size required to write length worth of
565 * buffer or 0 on error, if not NULL
566 * @param lim maximum size that actual may be in order to not
568 * @param buffer buffer to read from
569 * @param flags flags modifying the behaviour of the write to NAND
570 * @return 0 in case of success
572 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
573 size_t *actual, loff_t lim, u_char *buffer, int flags)
575 int rval = 0, blocksize;
576 size_t left_to_write = *length;
577 size_t used_for_write = 0;
578 u_char *p_buffer = buffer;
584 blocksize = nand->erasesize;
587 * nand_write() handles unaligned, partial page writes.
589 * We allow length to be unaligned, for convenience in
590 * using the $filesize variable.
592 * However, starting at an unaligned offset makes the
593 * semantics of bad block skipping ambiguous (really,
594 * you should only start a block skipping access at a
595 * partition boundary). So don't try to handle that.
597 if ((offset & (nand->writesize - 1)) != 0) {
598 printf("Attempt to write non page-aligned data\n");
603 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
606 *actual = used_for_write;
609 printf("Attempt to write outside the flash area\n");
614 if (used_for_write > lim) {
615 puts("Size of write exceeds partition or device limit\n");
620 if (!need_skip && !(flags & WITH_DROP_FFS)) {
621 rval = nand_write(nand, offset, length, buffer);
623 if ((flags & WITH_WR_VERIFY) && !rval)
624 rval = nand_verify(nand, offset, *length, buffer);
630 printf("NAND write to offset %llx failed %d\n",
635 while (left_to_write > 0) {
636 size_t block_offset = offset & (nand->erasesize - 1);
637 size_t write_size, truncated_write_size;
641 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
642 printf("Skip bad block 0x%08llx\n",
643 offset & ~(nand->erasesize - 1));
644 offset += nand->erasesize - block_offset;
648 if (left_to_write < (blocksize - block_offset))
649 write_size = left_to_write;
651 write_size = blocksize - block_offset;
653 truncated_write_size = write_size;
654 #ifdef CONFIG_CMD_NAND_TRIMFFS
655 if (flags & WITH_DROP_FFS)
656 truncated_write_size = drop_ffs(nand, p_buffer,
660 rval = nand_write(nand, offset, &truncated_write_size,
663 if ((flags & WITH_WR_VERIFY) && !rval)
664 rval = nand_verify(nand, offset,
665 truncated_write_size, p_buffer);
667 offset += write_size;
668 p_buffer += write_size;
671 printf("NAND write to offset %llx failed %d\n",
673 *length -= left_to_write;
677 left_to_write -= write_size;
684 * nand_read_skip_bad:
686 * Read image from NAND flash.
687 * Blocks that are marked bad are skipped and the next block is read
688 * instead as long as the image is short enough to fit even after
689 * skipping the bad blocks. Due to bad blocks we may not be able to
690 * perform the requested read. In the case where the read would extend
691 * beyond the end of the NAND device, both length and actual (if not
692 * NULL) are set to 0. In the case where the read would extend beyond
693 * the limit we are passed, length is set to 0 and actual is set to the
696 * @param nand NAND device
697 * @param offset offset in flash
698 * @param length buffer length, on return holds number of read bytes
699 * @param actual set to size required to read length worth of buffer or 0
700 * on error, if not NULL
701 * @param lim maximum size that actual may be in order to not exceed the
703 * @param buffer buffer to write to
704 * @return 0 in case of success
706 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
707 size_t *actual, loff_t lim, u_char *buffer)
710 size_t left_to_read = *length;
711 size_t used_for_read = 0;
712 u_char *p_buffer = buffer;
715 if ((offset & (nand->writesize - 1)) != 0) {
716 printf("Attempt to read non page-aligned data\n");
723 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
726 *actual = used_for_read;
729 printf("Attempt to read outside the flash area\n");
734 if (used_for_read > lim) {
735 puts("Size of read exceeds partition or device limit\n");
741 rval = nand_read(nand, offset, length, buffer);
742 if (!rval || rval == -EUCLEAN)
746 printf("NAND read from offset %llx failed %d\n",
751 while (left_to_read > 0) {
752 size_t block_offset = offset & (nand->erasesize - 1);
757 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
758 printf("Skipping bad block 0x%08llx\n",
759 offset & ~(nand->erasesize - 1));
760 offset += nand->erasesize - block_offset;
764 if (left_to_read < (nand->erasesize - block_offset))
765 read_length = left_to_read;
767 read_length = nand->erasesize - block_offset;
769 rval = nand_read(nand, offset, &read_length, p_buffer);
770 if (rval && rval != -EUCLEAN) {
771 printf("NAND read from offset %llx failed %d\n",
773 *length -= left_to_read;
777 left_to_read -= read_length;
778 offset += read_length;
779 p_buffer += read_length;
785 #ifdef CONFIG_CMD_NAND_TORTURE
790 * Check if buffer contains only a certain byte pattern.
792 * @param buf buffer to check
793 * @param patt the pattern to check
794 * @param size buffer size in bytes
795 * @return 1 if there are only patt bytes in buf
796 * 0 if something else was found
798 static int check_pattern(const u_char *buf, u_char patt, int size)
802 for (i = 0; i < size; i++)
811 * Torture a block of NAND flash.
812 * This is useful to determine if a block that caused a write error is still
813 * good or should be marked as bad.
815 * @param nand NAND device
816 * @param offset offset in flash
817 * @return 0 if the block is still good
819 int nand_torture(nand_info_t *nand, loff_t offset)
821 u_char patterns[] = {0xa5, 0x5a, 0x00};
822 struct erase_info instr = {
825 .len = nand->erasesize,
828 int err, ret = -1, i, patt_count;
831 if ((offset & (nand->erasesize - 1)) != 0) {
832 puts("Attempt to torture a block at a non block-aligned offset\n");
836 if (offset + nand->erasesize > nand->size) {
837 puts("Attempt to torture a block outside the flash area\n");
841 patt_count = ARRAY_SIZE(patterns);
843 buf = malloc_cache_aligned(nand->erasesize);
845 puts("Out of memory for erase block buffer\n");
849 for (i = 0; i < patt_count; i++) {
850 err = nand->erase(nand, &instr);
852 printf("%s: erase() failed for block at 0x%llx: %d\n",
853 nand->name, instr.addr, err);
857 /* Make sure the block contains only 0xff bytes */
858 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
859 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
860 printf("%s: read() failed for block at 0x%llx: %d\n",
861 nand->name, instr.addr, err);
865 err = check_pattern(buf, 0xff, nand->erasesize);
867 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
873 /* Write a pattern and check it */
874 memset(buf, patterns[i], nand->erasesize);
875 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
876 if (err || retlen != nand->erasesize) {
877 printf("%s: write() failed for block at 0x%llx: %d\n",
878 nand->name, instr.addr, err);
882 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
883 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
884 printf("%s: read() failed for block at 0x%llx: %d\n",
885 nand->name, instr.addr, err);
889 err = check_pattern(buf, patterns[i], nand->erasesize);
891 printf("Pattern 0x%.2x checking failed for block at "
892 "0x%llx\n", patterns[i], offset);