1 // SPDX-License-Identifier: GPL-2.0
3 * drivers/mtd/nand/raw/nand_util.c
5 * Copyright (C) 2006 by Weiss-Electronic GmbH.
8 * @author: Guido Classen <clagix@gmail.com>
9 * @descr: NAND Flash support
10 * @references: borrowed heavily from Linux mtd-utils code:
11 * flash_eraseall.c by Arcom Control System Ltd
12 * nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
13 * and Thomas Gleixner (tglx@linutronix.de)
15 * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
16 * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
18 * Copyright 2010 Freescale Semiconductor
28 #include <asm/cache.h>
29 #include <dm/devres.h>
31 #include <linux/errno.h>
32 #include <linux/mtd/mtd.h>
34 #include <jffs2/jffs2.h>
36 typedef struct erase_info erase_info_t;
37 typedef struct mtd_info mtd_info_t;
39 /* support only for native endian JFFS2 */
40 #define cpu_to_je16(x) (x)
41 #define cpu_to_je32(x) (x)
44 * nand_erase_opts: - erase NAND flash with support for various options
47 * @param mtd nand mtd instance to erase
48 * @param opts options, @see struct nand_erase_options
49 * @return 0 in case of success
51 * This code is ported from flash_eraseall.c from Linux mtd utils by
52 * Arcom Control System Ltd.
54 int nand_erase_opts(struct mtd_info *mtd,
55 const nand_erase_options_t *opts)
57 struct jffs2_unknown_node cleanmarker;
59 unsigned long erase_length, erased_length; /* in blocks */
61 int percent_complete = -1;
62 const char *mtd_device = mtd->name;
63 struct mtd_oob_ops oob_opts;
64 struct nand_chip *chip = mtd_to_nand(mtd);
66 if ((opts->offset & (mtd->erasesize - 1)) != 0) {
67 printf("Attempt to erase non block-aligned data\n");
71 memset(&erase, 0, sizeof(erase));
72 memset(&oob_opts, 0, sizeof(oob_opts));
75 erase.len = mtd->erasesize;
76 erase.addr = opts->offset;
77 erase_length = lldiv(opts->length + mtd->erasesize - 1,
80 cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
81 cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
82 cleanmarker.totlen = cpu_to_je32(8);
84 /* scrub option allows to erase badblock. To prevent internal
85 * check from erase() method, set block check method to dummy
86 * and disable bad block table while erasing.
89 erase.scrub = opts->scrub;
91 * We don't need the bad block table anymore...
92 * after scrub, there are no bad blocks left!
98 chip->options &= ~NAND_BBT_SCANNED;
101 for (erased_length = 0;
102 erased_length < erase_length;
103 erase.addr += mtd->erasesize) {
107 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
108 puts("Size of erase exceeds limit\n");
112 int ret = mtd_block_isbad(mtd, erase.addr);
115 printf("\rSkipping bad block at "
125 } else if (ret < 0) {
126 printf("\n%s: MTD get bad block failed: %d\n",
135 result = mtd_erase(mtd, &erase);
137 printf("\n%s: MTD Erase failure: %d\n",
142 /* format for JFFS2 ? */
143 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
144 struct mtd_oob_ops ops;
147 ops.oobbuf = (uint8_t *)&cleanmarker;
149 ops.mode = MTD_OPS_AUTO_OOB;
151 result = mtd_write_oob(mtd, erase.addr, &ops);
153 printf("\n%s: MTD writeoob failure: %d\n",
160 unsigned long long n = erased_length * 100ULL;
163 do_div(n, erase_length);
166 /* output progress message only at whole percent
167 * steps to reduce the number of messages printed
168 * on (slow) serial consoles
170 if (percent != percent_complete) {
171 percent_complete = percent;
173 printf("\rErasing at 0x%llx -- %3d%% complete.",
174 erase.addr, percent);
176 if (opts->jffs2 && result == 0)
177 printf(" Cleanmarker written at 0x%llx.",
188 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
190 #define NAND_CMD_LOCK_TIGHT 0x2c
191 #define NAND_CMD_LOCK_STATUS 0x7a
193 /******************************************************************************
194 * Support for locking / unlocking operations of some NAND devices
195 *****************************************************************************/
198 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
201 * @param mtd nand mtd instance
202 * @param tight bring device in lock tight mode
204 * @return 0 on success, -1 in case of error
206 * The lock / lock-tight command only applies to the whole chip. To get some
207 * parts of the chip lock and others unlocked use the following sequence:
209 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
210 * - Call nand_unlock() once for each consecutive area to be unlocked
211 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
213 * If the device is in lock-tight state software can't change the
214 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
215 * calls will fail. It is only posible to leave lock-tight state by
216 * an hardware signal (low pulse on _WP pin) or by power down.
218 int nand_lock(struct mtd_info *mtd, int tight)
222 struct nand_chip *chip = mtd_to_nand(mtd);
224 /* select the NAND device */
225 chip->select_chip(mtd, 0);
227 /* check the Lock Tight Status */
228 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
229 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
230 printf("nand_lock: Device is locked tight!\n");
236 (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
239 /* call wait ready function */
240 status = chip->waitfunc(mtd, chip);
242 /* see if device thinks it succeeded */
248 /* de-select the NAND device */
249 chip->select_chip(mtd, -1);
254 * nand_get_lock_status: - query current lock state from one page of NAND
257 * @param mtd nand mtd instance
258 * @param offset page address to query (must be page-aligned!)
260 * @return -1 in case of error
262 * bitfield with the following combinations:
263 * NAND_LOCK_STATUS_TIGHT: page in tight state
264 * NAND_LOCK_STATUS_UNLOCK: page unlocked
267 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
272 struct nand_chip *chip = mtd_to_nand(mtd);
274 /* select the NAND device */
275 chipnr = (int)(offset >> chip->chip_shift);
276 chip->select_chip(mtd, chipnr);
279 if ((offset & (mtd->writesize - 1)) != 0) {
280 printf("nand_get_lock_status: "
281 "Start address must be beginning of "
287 /* check the Lock Status */
288 page = (int)(offset >> chip->page_shift);
289 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
291 ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
292 | NAND_LOCK_STATUS_UNLOCK);
295 /* de-select the NAND device */
296 chip->select_chip(mtd, -1);
301 * nand_unlock: - Unlock area of NAND pages
302 * only one consecutive area can be unlocked at one time!
304 * @param mtd nand mtd instance
305 * @param start start byte address
306 * @param length number of bytes to unlock (must be a multiple of
307 * page size mtd->writesize)
308 * @param allexcept if set, unlock everything not selected
310 * @return 0 on success, -1 in case of error
312 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
319 struct nand_chip *chip = mtd_to_nand(mtd);
321 debug("nand_unlock%s: start: %08llx, length: %zd!\n",
322 allexcept ? " (allexcept)" : "", start, length);
324 /* select the NAND device */
325 chipnr = (int)(start >> chip->chip_shift);
326 chip->select_chip(mtd, chipnr);
328 /* check the WP bit */
329 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
330 if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
331 printf("nand_unlock: Device is write protected!\n");
336 /* check the Lock Tight Status */
337 page = (int)(start >> chip->page_shift);
338 chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
339 if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
340 printf("nand_unlock: Device is locked tight!\n");
345 if ((start & (mtd->erasesize - 1)) != 0) {
346 printf("nand_unlock: Start address must be beginning of "
352 if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
353 printf("nand_unlock: Length must be a multiple of nand block "
354 "size %08x!\n", mtd->erasesize);
360 * Set length so that the last address is set to the
361 * starting address of the last block
363 length -= mtd->erasesize;
365 /* submit address of first page to unlock */
366 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
368 /* submit ADDRESS of LAST page to unlock */
369 page += (int)(length >> chip->page_shift);
372 * Page addresses for unlocking are supposed to be block-aligned.
373 * At least some NAND chips use the low bit to indicate that the
374 * page range should be inverted.
379 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
381 /* call wait ready function */
382 status = chip->waitfunc(mtd, chip);
383 /* see if device thinks it succeeded */
385 /* there was an error */
391 /* de-select the NAND device */
392 chip->select_chip(mtd, -1);
400 * Check if there are any bad blocks, and whether length including bad
401 * blocks fits into device
403 * @param mtd nand mtd instance
404 * @param offset offset in flash
405 * @param length image length
406 * @param used length of flash needed for the requested length
407 * @return 0 if the image fits and there are no bad blocks
408 * 1 if the image fits, but there are bad blocks
409 * -1 if the image does not fit
411 static int check_skip_len(struct mtd_info *mtd, loff_t offset, size_t length,
414 size_t len_excl_bad = 0;
417 while (len_excl_bad < length) {
418 size_t block_len, block_off;
421 if (offset >= mtd->size)
424 block_start = offset & ~(loff_t)(mtd->erasesize - 1);
425 block_off = offset & (mtd->erasesize - 1);
426 block_len = mtd->erasesize - block_off;
428 if (!nand_block_isbad(mtd, block_start))
429 len_excl_bad += block_len;
437 /* If the length is not a multiple of block_len, adjust. */
438 if (len_excl_bad > length)
439 *used -= (len_excl_bad - length);
444 #ifdef CONFIG_CMD_NAND_TRIMFFS
445 static size_t drop_ffs(const struct mtd_info *mtd, const u_char *buf,
451 for (i = l - 1; i >= 0; i--)
455 /* The resulting length must be aligned to the minimum flash I/O size */
457 l = (l + mtd->writesize - 1) / mtd->writesize;
461 * since the input length may be unaligned, prevent access past the end
469 * nand_verify_page_oob:
471 * Verify a page of NAND flash, including the OOB.
472 * Reads page of NAND and verifies the contents and OOB against the
475 * @param mtd nand mtd instance
476 * @param ops MTD operations, including data to verify
477 * @param ofs offset in flash
478 * @return 0 in case of success
480 int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
484 struct mtd_oob_ops vops;
485 size_t verlen = mtd->writesize + mtd->oobsize;
487 memcpy(&vops, ops, sizeof(vops));
489 vops.datbuf = memalign(ARCH_DMA_MINALIGN, verlen);
494 vops.oobbuf = vops.datbuf + mtd->writesize;
496 rval = mtd_read_oob(mtd, ofs, &vops);
498 rval = memcmp(ops->datbuf, vops.datbuf, vops.len);
500 rval = memcmp(ops->oobbuf, vops.oobbuf, vops.ooblen);
504 return rval ? -EIO : 0;
510 * Verify a region of NAND flash.
511 * Reads NAND in page-sized chunks and verifies the contents against
512 * the contents of a buffer. The offset into the NAND must be
513 * page-aligned, and the function doesn't handle skipping bad blocks.
515 * @param mtd nand mtd instance
516 * @param ofs offset in flash
517 * @param len buffer length
518 * @param buf buffer to read from
519 * @return 0 in case of success
521 int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
525 size_t verlen = mtd->writesize;
526 uint8_t *verbuf = memalign(ARCH_DMA_MINALIGN, verlen);
531 /* Read the NAND back in page-size groups to limit malloc size */
532 for (verofs = ofs; verofs < ofs + len;
533 verofs += verlen, buf += verlen) {
534 verlen = min(mtd->writesize, (uint32_t)(ofs + len - verofs));
535 rval = nand_read(mtd, verofs, &verlen, verbuf);
536 if (!rval || (rval == -EUCLEAN))
537 rval = memcmp(buf, verbuf, verlen);
545 return rval ? -EIO : 0;
551 * nand_write_skip_bad:
553 * Write image to NAND flash.
554 * Blocks that are marked bad are skipped and the is written to the next
555 * block instead as long as the image is short enough to fit even after
556 * skipping the bad blocks. Due to bad blocks we may not be able to
557 * perform the requested write. In the case where the write would
558 * extend beyond the end of the NAND device, both length and actual (if
559 * not NULL) are set to 0. In the case where the write would extend
560 * beyond the limit we are passed, length is set to 0 and actual is set
561 * to the required length.
563 * @param mtd nand mtd instance
564 * @param offset offset in flash
565 * @param length buffer length
566 * @param actual set to size required to write length worth of
567 * buffer or 0 on error, if not NULL
568 * @param lim maximum size that actual may be in order to not
570 * @param buffer buffer to read from
571 * @param flags flags modifying the behaviour of the write to NAND
572 * @return 0 in case of success
574 int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
575 size_t *actual, loff_t lim, u_char *buffer, int flags)
577 int rval = 0, blocksize;
578 size_t left_to_write = *length;
579 size_t used_for_write = 0;
580 u_char *p_buffer = buffer;
586 blocksize = mtd->erasesize;
589 * nand_write() handles unaligned, partial page writes.
591 * We allow length to be unaligned, for convenience in
592 * using the $filesize variable.
594 * However, starting at an unaligned offset makes the
595 * semantics of bad block skipping ambiguous (really,
596 * you should only start a block skipping access at a
597 * partition boundary). So don't try to handle that.
599 if ((offset & (mtd->writesize - 1)) != 0) {
600 printf("Attempt to write non page-aligned data\n");
605 need_skip = check_skip_len(mtd, offset, *length, &used_for_write);
608 *actual = used_for_write;
611 printf("Attempt to write outside the flash area\n");
616 if (used_for_write > lim) {
617 puts("Size of write exceeds partition or device limit\n");
622 if (!need_skip && !(flags & WITH_DROP_FFS)) {
623 rval = nand_write(mtd, offset, length, buffer);
625 if ((flags & WITH_WR_VERIFY) && !rval)
626 rval = nand_verify(mtd, offset, *length, buffer);
632 printf("NAND write to offset %llx failed %d\n",
637 while (left_to_write > 0) {
638 size_t block_offset = offset & (mtd->erasesize - 1);
639 size_t write_size, truncated_write_size;
643 if (nand_block_isbad(mtd, offset & ~(mtd->erasesize - 1))) {
644 printf("Skip bad block 0x%08llx\n",
645 offset & ~(mtd->erasesize - 1));
646 offset += mtd->erasesize - block_offset;
650 if (left_to_write < (blocksize - block_offset))
651 write_size = left_to_write;
653 write_size = blocksize - block_offset;
655 truncated_write_size = write_size;
656 #ifdef CONFIG_CMD_NAND_TRIMFFS
657 if (flags & WITH_DROP_FFS)
658 truncated_write_size = drop_ffs(mtd, p_buffer,
662 rval = nand_write(mtd, offset, &truncated_write_size,
665 if ((flags & WITH_WR_VERIFY) && !rval)
666 rval = nand_verify(mtd, offset,
667 truncated_write_size, p_buffer);
669 offset += write_size;
670 p_buffer += write_size;
673 printf("NAND write to offset %llx failed %d\n",
675 *length -= left_to_write;
679 left_to_write -= write_size;
686 * nand_read_skip_bad:
688 * Read image from NAND flash.
689 * Blocks that are marked bad are skipped and the next block is read
690 * instead as long as the image is short enough to fit even after
691 * skipping the bad blocks. Due to bad blocks we may not be able to
692 * perform the requested read. In the case where the read would extend
693 * beyond the end of the NAND device, both length and actual (if not
694 * NULL) are set to 0. In the case where the read would extend beyond
695 * the limit we are passed, length is set to 0 and actual is set to the
698 * @param mtd nand mtd instance
699 * @param offset offset in flash
700 * @param length buffer length, on return holds number of read bytes
701 * @param actual set to size required to read length worth of buffer or 0
702 * on error, if not NULL
703 * @param lim maximum size that actual may be in order to not exceed the
705 * @param buffer buffer to write to
706 * @return 0 in case of success
708 int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
709 size_t *actual, loff_t lim, u_char *buffer)
712 size_t left_to_read = *length;
713 size_t used_for_read = 0;
714 u_char *p_buffer = buffer;
717 if ((offset & (mtd->writesize - 1)) != 0) {
718 printf("Attempt to read non page-aligned data\n");
725 need_skip = check_skip_len(mtd, offset, *length, &used_for_read);
728 *actual = used_for_read;
731 printf("Attempt to read outside the flash area\n");
736 if (used_for_read > lim) {
737 puts("Size of read exceeds partition or device limit\n");
743 rval = nand_read(mtd, offset, length, buffer);
744 if (!rval || rval == -EUCLEAN)
748 printf("NAND read from offset %llx failed %d\n",
753 while (left_to_read > 0) {
754 size_t block_offset = offset & (mtd->erasesize - 1);
759 if (nand_block_isbad(mtd, offset & ~(mtd->erasesize - 1))) {
760 printf("Skipping bad block 0x%08llx\n",
761 offset & ~(mtd->erasesize - 1));
762 offset += mtd->erasesize - block_offset;
766 if (left_to_read < (mtd->erasesize - block_offset))
767 read_length = left_to_read;
769 read_length = mtd->erasesize - block_offset;
771 rval = nand_read(mtd, offset, &read_length, p_buffer);
772 if (rval && rval != -EUCLEAN) {
773 printf("NAND read from offset %llx failed %d\n",
775 *length -= left_to_read;
779 left_to_read -= read_length;
780 offset += read_length;
781 p_buffer += read_length;
787 #ifdef CONFIG_CMD_NAND_TORTURE
792 * Check if buffer contains only a certain byte pattern.
794 * @param buf buffer to check
795 * @param patt the pattern to check
796 * @param size buffer size in bytes
797 * @return 1 if there are only patt bytes in buf
798 * 0 if something else was found
800 static int check_pattern(const u_char *buf, u_char patt, int size)
804 for (i = 0; i < size; i++)
813 * Torture a block of NAND flash.
814 * This is useful to determine if a block that caused a write error is still
815 * good or should be marked as bad.
817 * @param mtd nand mtd instance
818 * @param offset offset in flash
819 * @return 0 if the block is still good
821 int nand_torture(struct mtd_info *mtd, loff_t offset)
823 u_char patterns[] = {0xa5, 0x5a, 0x00};
824 struct erase_info instr = {
827 .len = mtd->erasesize,
830 int err, ret = -1, i, patt_count;
833 if ((offset & (mtd->erasesize - 1)) != 0) {
834 puts("Attempt to torture a block at a non block-aligned offset\n");
838 if (offset + mtd->erasesize > mtd->size) {
839 puts("Attempt to torture a block outside the flash area\n");
843 patt_count = ARRAY_SIZE(patterns);
845 buf = malloc_cache_aligned(mtd->erasesize);
847 puts("Out of memory for erase block buffer\n");
851 for (i = 0; i < patt_count; i++) {
852 err = mtd_erase(mtd, &instr);
854 printf("%s: erase() failed for block at 0x%llx: %d\n",
855 mtd->name, instr.addr, err);
859 /* Make sure the block contains only 0xff bytes */
860 err = mtd_read(mtd, offset, mtd->erasesize, &retlen, buf);
861 if ((err && err != -EUCLEAN) || retlen != mtd->erasesize) {
862 printf("%s: read() failed for block at 0x%llx: %d\n",
863 mtd->name, instr.addr, err);
867 err = check_pattern(buf, 0xff, mtd->erasesize);
869 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
875 /* Write a pattern and check it */
876 memset(buf, patterns[i], mtd->erasesize);
877 err = mtd_write(mtd, offset, mtd->erasesize, &retlen, buf);
878 if (err || retlen != mtd->erasesize) {
879 printf("%s: write() failed for block at 0x%llx: %d\n",
880 mtd->name, instr.addr, err);
884 err = mtd_read(mtd, offset, mtd->erasesize, &retlen, buf);
885 if ((err && err != -EUCLEAN) || retlen != mtd->erasesize) {
886 printf("%s: read() failed for block at 0x%llx: %d\n",
887 mtd->name, instr.addr, err);
891 err = check_pattern(buf, patterns[i], mtd->erasesize);
893 printf("Pattern 0x%.2x checking failed for block at "
894 "0x%llx\n", patterns[i], offset);