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 #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->priv;
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->priv;
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 nand->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->priv;
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 nand NAND device
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(nand_info_t *nand, 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 >= nand->size)
424 block_start = offset & ~(loff_t)(nand->erasesize - 1);
425 block_off = offset & (nand->erasesize - 1);
426 block_len = nand->erasesize - block_off;
428 if (!nand_block_isbad(nand, 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 nand_info_t *nand, 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 + nand->writesize - 1) / nand->writesize;
458 l *= nand->writesize;
461 * since the input length may be unaligned, prevent access past the end
469 * nand_write_skip_bad:
471 * Write image to NAND flash.
472 * Blocks that are marked bad are skipped and the is written to the next
473 * block instead as long as the image is short enough to fit even after
474 * skipping the bad blocks. Due to bad blocks we may not be able to
475 * perform the requested write. In the case where the write would
476 * extend beyond the end of the NAND device, both length and actual (if
477 * not NULL) are set to 0. In the case where the write would extend
478 * beyond the limit we are passed, length is set to 0 and actual is set
479 * to the required length.
481 * @param nand NAND device
482 * @param offset offset in flash
483 * @param length buffer length
484 * @param actual set to size required to write length worth of
485 * buffer or 0 on error, if not NULL
486 * @param lim maximum size that actual may be in order to not
488 * @param buffer buffer to read from
489 * @param flags flags modifying the behaviour of the write to NAND
490 * @return 0 in case of success
492 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
493 size_t *actual, loff_t lim, u_char *buffer, int flags)
495 int rval = 0, blocksize;
496 size_t left_to_write = *length;
497 size_t used_for_write = 0;
498 u_char *p_buffer = buffer;
504 #ifdef CONFIG_CMD_NAND_YAFFS
505 if (flags & WITH_YAFFS_OOB) {
506 if (flags & ~WITH_YAFFS_OOB)
510 pages = nand->erasesize / nand->writesize;
511 blocksize = (pages * nand->oobsize) + nand->erasesize;
512 if (*length % (nand->writesize + nand->oobsize)) {
513 printf("Attempt to write incomplete page"
520 blocksize = nand->erasesize;
524 * nand_write() handles unaligned, partial page writes.
526 * We allow length to be unaligned, for convenience in
527 * using the $filesize variable.
529 * However, starting at an unaligned offset makes the
530 * semantics of bad block skipping ambiguous (really,
531 * you should only start a block skipping access at a
532 * partition boundary). So don't try to handle that.
534 if ((offset & (nand->writesize - 1)) != 0) {
535 printf("Attempt to write non page-aligned data\n");
540 need_skip = check_skip_len(nand, offset, *length, &used_for_write);
543 *actual = used_for_write;
546 printf("Attempt to write outside the flash area\n");
551 if (used_for_write > lim) {
552 puts("Size of write exceeds partition or device limit\n");
557 if (!need_skip && !(flags & WITH_DROP_FFS)) {
558 rval = nand_write(nand, offset, length, buffer);
563 printf("NAND write to offset %llx failed %d\n",
568 while (left_to_write > 0) {
569 size_t block_offset = offset & (nand->erasesize - 1);
570 size_t write_size, truncated_write_size;
574 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
575 printf("Skip bad block 0x%08llx\n",
576 offset & ~(nand->erasesize - 1));
577 offset += nand->erasesize - block_offset;
581 if (left_to_write < (blocksize - block_offset))
582 write_size = left_to_write;
584 write_size = blocksize - block_offset;
586 #ifdef CONFIG_CMD_NAND_YAFFS
587 if (flags & WITH_YAFFS_OOB) {
589 size_t pagesize = nand->writesize;
590 size_t pagesize_oob = pagesize + nand->oobsize;
591 struct mtd_oob_ops ops;
594 ops.ooblen = nand->oobsize;
595 ops.mode = MTD_OPS_AUTO_OOB;
598 pages = write_size / pagesize_oob;
599 for (page = 0; page < pages; page++) {
602 ops.datbuf = p_buffer;
603 ops.oobbuf = ops.datbuf + pagesize;
605 rval = mtd_write_oob(nand, offset, &ops);
610 p_buffer += pagesize_oob;
616 truncated_write_size = write_size;
617 #ifdef CONFIG_CMD_NAND_TRIMFFS
618 if (flags & WITH_DROP_FFS)
619 truncated_write_size = drop_ffs(nand, p_buffer,
623 rval = nand_write(nand, offset, &truncated_write_size,
625 offset += write_size;
626 p_buffer += write_size;
630 printf("NAND write to offset %llx failed %d\n",
632 *length -= left_to_write;
636 left_to_write -= write_size;
643 * nand_read_skip_bad:
645 * Read image from NAND flash.
646 * Blocks that are marked bad are skipped and the next block is read
647 * instead as long as the image is short enough to fit even after
648 * skipping the bad blocks. Due to bad blocks we may not be able to
649 * perform the requested read. In the case where the read would extend
650 * beyond the end of the NAND device, both length and actual (if not
651 * NULL) are set to 0. In the case where the read would extend beyond
652 * the limit we are passed, length is set to 0 and actual is set to the
655 * @param nand NAND device
656 * @param offset offset in flash
657 * @param length buffer length, on return holds number of read bytes
658 * @param actual set to size required to read length worth of buffer or 0
659 * on error, if not NULL
660 * @param lim maximum size that actual may be in order to not exceed the
662 * @param buffer buffer to write to
663 * @return 0 in case of success
665 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
666 size_t *actual, loff_t lim, u_char *buffer)
669 size_t left_to_read = *length;
670 size_t used_for_read = 0;
671 u_char *p_buffer = buffer;
674 if ((offset & (nand->writesize - 1)) != 0) {
675 printf("Attempt to read non page-aligned data\n");
682 need_skip = check_skip_len(nand, offset, *length, &used_for_read);
685 *actual = used_for_read;
688 printf("Attempt to read outside the flash area\n");
693 if (used_for_read > lim) {
694 puts("Size of read exceeds partition or device limit\n");
700 rval = nand_read(nand, offset, length, buffer);
701 if (!rval || rval == -EUCLEAN)
705 printf("NAND read from offset %llx failed %d\n",
710 while (left_to_read > 0) {
711 size_t block_offset = offset & (nand->erasesize - 1);
716 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
717 printf("Skipping bad block 0x%08llx\n",
718 offset & ~(nand->erasesize - 1));
719 offset += nand->erasesize - block_offset;
723 if (left_to_read < (nand->erasesize - block_offset))
724 read_length = left_to_read;
726 read_length = nand->erasesize - block_offset;
728 rval = nand_read(nand, offset, &read_length, p_buffer);
729 if (rval && rval != -EUCLEAN) {
730 printf("NAND read from offset %llx failed %d\n",
732 *length -= left_to_read;
736 left_to_read -= read_length;
737 offset += read_length;
738 p_buffer += read_length;
744 #ifdef CONFIG_CMD_NAND_TORTURE
749 * Check if buffer contains only a certain byte pattern.
751 * @param buf buffer to check
752 * @param patt the pattern to check
753 * @param size buffer size in bytes
754 * @return 1 if there are only patt bytes in buf
755 * 0 if something else was found
757 static int check_pattern(const u_char *buf, u_char patt, int size)
761 for (i = 0; i < size; i++)
770 * Torture a block of NAND flash.
771 * This is useful to determine if a block that caused a write error is still
772 * good or should be marked as bad.
774 * @param nand NAND device
775 * @param offset offset in flash
776 * @return 0 if the block is still good
778 int nand_torture(nand_info_t *nand, loff_t offset)
780 u_char patterns[] = {0xa5, 0x5a, 0x00};
781 struct erase_info instr = {
784 .len = nand->erasesize,
787 int err, ret = -1, i, patt_count;
790 if ((offset & (nand->erasesize - 1)) != 0) {
791 puts("Attempt to torture a block at a non block-aligned offset\n");
795 if (offset + nand->erasesize > nand->size) {
796 puts("Attempt to torture a block outside the flash area\n");
800 patt_count = ARRAY_SIZE(patterns);
802 buf = malloc(nand->erasesize);
804 puts("Out of memory for erase block buffer\n");
808 for (i = 0; i < patt_count; i++) {
809 err = nand->erase(nand, &instr);
811 printf("%s: erase() failed for block at 0x%llx: %d\n",
812 nand->name, instr.addr, err);
816 /* Make sure the block contains only 0xff bytes */
817 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
818 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
819 printf("%s: read() failed for block at 0x%llx: %d\n",
820 nand->name, instr.addr, err);
824 err = check_pattern(buf, 0xff, nand->erasesize);
826 printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
832 /* Write a pattern and check it */
833 memset(buf, patterns[i], nand->erasesize);
834 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
835 if (err || retlen != nand->erasesize) {
836 printf("%s: write() failed for block at 0x%llx: %d\n",
837 nand->name, instr.addr, err);
841 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
842 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
843 printf("%s: read() failed for block at 0x%llx: %d\n",
844 nand->name, instr.addr, err);
848 err = check_pattern(buf, patterns[i], nand->erasesize);
850 printf("Pattern 0x%.2x checking failed for block at "
851 "0x%llx\n", patterns[i], offset);