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 mtd nand mtd instance 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(struct mtd_info
*mtd
,
53 const nand_erase_options_t
*opts
)
55 struct jffs2_unknown_node cleanmarker
;
57 unsigned long erase_length
, erased_length
; /* in blocks */
59 int percent_complete
= -1;
60 const char *mtd_device
= mtd
->name
;
61 struct mtd_oob_ops oob_opts
;
62 struct nand_chip
*chip
= mtd
->priv
;
64 if ((opts
->offset
& (mtd
->erasesize
- 1)) != 0) {
65 printf("Attempt to erase non block-aligned data\n");
69 memset(&erase
, 0, sizeof(erase
));
70 memset(&oob_opts
, 0, sizeof(oob_opts
));
73 erase
.len
= mtd
->erasesize
;
74 erase
.addr
= opts
->offset
;
75 erase_length
= lldiv(opts
->length
+ mtd
->erasesize
- 1,
78 cleanmarker
.magic
= cpu_to_je16(JFFS2_MAGIC_BITMASK
);
79 cleanmarker
.nodetype
= cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER
);
80 cleanmarker
.totlen
= cpu_to_je32(8);
82 /* scrub option allows to erase badblock. To prevent internal
83 * check from erase() method, set block check method to dummy
84 * and disable bad block table while erasing.
87 erase
.scrub
= opts
->scrub
;
89 * We don't need the bad block table anymore...
90 * after scrub, there are no bad blocks left!
96 chip
->options
&= ~NAND_BBT_SCANNED
;
99 for (erased_length
= 0;
100 erased_length
< erase_length
;
101 erase
.addr
+= mtd
->erasesize
) {
105 if (opts
->lim
&& (erase
.addr
>= (opts
->offset
+ opts
->lim
))) {
106 puts("Size of erase exceeds limit\n");
110 int ret
= mtd_block_isbad(mtd
, erase
.addr
);
113 printf("\rSkipping bad block at "
123 } else if (ret
< 0) {
124 printf("\n%s: MTD get bad block failed: %d\n",
133 result
= mtd_erase(mtd
, &erase
);
135 printf("\n%s: MTD Erase failure: %d\n",
140 /* format for JFFS2 ? */
141 if (opts
->jffs2
&& chip
->ecc
.layout
->oobavail
>= 8) {
142 struct mtd_oob_ops ops
;
145 ops
.oobbuf
= (uint8_t *)&cleanmarker
;
147 ops
.mode
= MTD_OPS_AUTO_OOB
;
149 result
= mtd_write_oob(mtd
, erase
.addr
, &ops
);
151 printf("\n%s: MTD writeoob failure: %d\n",
158 unsigned long long n
= erased_length
* 100ULL;
161 do_div(n
, erase_length
);
164 /* output progress message only at whole percent
165 * steps to reduce the number of messages printed
166 * on (slow) serial consoles
168 if (percent
!= percent_complete
) {
169 percent_complete
= percent
;
171 printf("\rErasing at 0x%llx -- %3d%% complete.",
172 erase
.addr
, percent
);
174 if (opts
->jffs2
&& result
== 0)
175 printf(" Cleanmarker written at 0x%llx.",
186 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
188 #define NAND_CMD_LOCK_TIGHT 0x2c
189 #define NAND_CMD_LOCK_STATUS 0x7a
191 /******************************************************************************
192 * Support for locking / unlocking operations of some NAND devices
193 *****************************************************************************/
196 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
199 * @param mtd nand mtd instance
200 * @param tight bring device in lock tight mode
202 * @return 0 on success, -1 in case of error
204 * The lock / lock-tight command only applies to the whole chip. To get some
205 * parts of the chip lock and others unlocked use the following sequence:
207 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
208 * - Call nand_unlock() once for each consecutive area to be unlocked
209 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
211 * If the device is in lock-tight state software can't change the
212 * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
213 * calls will fail. It is only posible to leave lock-tight state by
214 * an hardware signal (low pulse on _WP pin) or by power down.
216 int nand_lock(struct mtd_info
*mtd
, int tight
)
220 struct nand_chip
*chip
= mtd
->priv
;
222 /* select the NAND device */
223 chip
->select_chip(mtd
, 0);
225 /* check the Lock Tight Status */
226 chip
->cmdfunc(mtd
, NAND_CMD_LOCK_STATUS
, -1, 0);
227 if (chip
->read_byte(mtd
) & NAND_LOCK_STATUS_TIGHT
) {
228 printf("nand_lock: Device is locked tight!\n");
234 (tight
? NAND_CMD_LOCK_TIGHT
: NAND_CMD_LOCK
),
237 /* call wait ready function */
238 status
= chip
->waitfunc(mtd
, chip
);
240 /* see if device thinks it succeeded */
246 /* de-select the NAND device */
247 chip
->select_chip(mtd
, -1);
252 * nand_get_lock_status: - query current lock state from one page of NAND
255 * @param mtd nand mtd instance
256 * @param offset page address to query (must be page-aligned!)
258 * @return -1 in case of error
260 * bitfield with the following combinations:
261 * NAND_LOCK_STATUS_TIGHT: page in tight state
262 * NAND_LOCK_STATUS_UNLOCK: page unlocked
265 int nand_get_lock_status(struct mtd_info
*mtd
, loff_t offset
)
270 struct nand_chip
*chip
= mtd
->priv
;
272 /* select the NAND device */
273 chipnr
= (int)(offset
>> chip
->chip_shift
);
274 chip
->select_chip(mtd
, chipnr
);
277 if ((offset
& (mtd
->writesize
- 1)) != 0) {
278 printf("nand_get_lock_status: "
279 "Start address must be beginning of "
285 /* check the Lock Status */
286 page
= (int)(offset
>> chip
->page_shift
);
287 chip
->cmdfunc(mtd
, NAND_CMD_LOCK_STATUS
, -1, page
& chip
->pagemask
);
289 ret
= chip
->read_byte(mtd
) & (NAND_LOCK_STATUS_TIGHT
290 | NAND_LOCK_STATUS_UNLOCK
);
293 /* de-select the NAND device */
294 chip
->select_chip(mtd
, -1);
299 * nand_unlock: - Unlock area of NAND pages
300 * only one consecutive area can be unlocked at one time!
302 * @param mtd nand mtd instance
303 * @param start start byte address
304 * @param length number of bytes to unlock (must be a multiple of
305 * page size mtd->writesize)
306 * @param allexcept if set, unlock everything not selected
308 * @return 0 on success, -1 in case of error
310 int nand_unlock(struct mtd_info
*mtd
, loff_t start
, size_t length
,
317 struct nand_chip
*chip
= mtd
->priv
;
319 debug("nand_unlock%s: start: %08llx, length: %zd!\n",
320 allexcept
? " (allexcept)" : "", start
, length
);
322 /* select the NAND device */
323 chipnr
= (int)(start
>> chip
->chip_shift
);
324 chip
->select_chip(mtd
, chipnr
);
326 /* check the WP bit */
327 chip
->cmdfunc(mtd
, NAND_CMD_STATUS
, -1, -1);
328 if (!(chip
->read_byte(mtd
) & NAND_STATUS_WP
)) {
329 printf("nand_unlock: Device is write protected!\n");
334 /* check the Lock Tight Status */
335 page
= (int)(start
>> chip
->page_shift
);
336 chip
->cmdfunc(mtd
, NAND_CMD_LOCK_STATUS
, -1, page
& chip
->pagemask
);
337 if (chip
->read_byte(mtd
) & NAND_LOCK_STATUS_TIGHT
) {
338 printf("nand_unlock: Device is locked tight!\n");
343 if ((start
& (mtd
->erasesize
- 1)) != 0) {
344 printf("nand_unlock: Start address must be beginning of "
350 if (length
== 0 || (length
& (mtd
->erasesize
- 1)) != 0) {
351 printf("nand_unlock: Length must be a multiple of nand block "
352 "size %08x!\n", mtd
->erasesize
);
358 * Set length so that the last address is set to the
359 * starting address of the last block
361 length
-= mtd
->erasesize
;
363 /* submit address of first page to unlock */
364 chip
->cmdfunc(mtd
, NAND_CMD_UNLOCK1
, -1, page
& chip
->pagemask
);
366 /* submit ADDRESS of LAST page to unlock */
367 page
+= (int)(length
>> chip
->page_shift
);
370 * Page addresses for unlocking are supposed to be block-aligned.
371 * At least some NAND chips use the low bit to indicate that the
372 * page range should be inverted.
377 chip
->cmdfunc(mtd
, NAND_CMD_UNLOCK2
, -1, page
& chip
->pagemask
);
379 /* call wait ready function */
380 status
= chip
->waitfunc(mtd
, chip
);
381 /* see if device thinks it succeeded */
383 /* there was an error */
389 /* de-select the NAND device */
390 chip
->select_chip(mtd
, -1);
398 * Check if there are any bad blocks, and whether length including bad
399 * blocks fits into device
401 * @param mtd nand mtd instance
402 * @param offset offset in flash
403 * @param length image length
404 * @param used length of flash needed for the requested length
405 * @return 0 if the image fits and there are no bad blocks
406 * 1 if the image fits, but there are bad blocks
407 * -1 if the image does not fit
409 static int check_skip_len(struct mtd_info
*mtd
, loff_t offset
, size_t length
,
412 size_t len_excl_bad
= 0;
415 while (len_excl_bad
< length
) {
416 size_t block_len
, block_off
;
419 if (offset
>= mtd
->size
)
422 block_start
= offset
& ~(loff_t
)(mtd
->erasesize
- 1);
423 block_off
= offset
& (mtd
->erasesize
- 1);
424 block_len
= mtd
->erasesize
- block_off
;
426 if (!nand_block_isbad(mtd
, block_start
))
427 len_excl_bad
+= block_len
;
435 /* If the length is not a multiple of block_len, adjust. */
436 if (len_excl_bad
> length
)
437 *used
-= (len_excl_bad
- length
);
442 #ifdef CONFIG_CMD_NAND_TRIMFFS
443 static size_t drop_ffs(const struct mtd_info
*mtd
, const u_char
*buf
,
449 for (i
= l
- 1; i
>= 0; i
--)
453 /* The resulting length must be aligned to the minimum flash I/O size */
455 l
= (l
+ mtd
->writesize
- 1) / mtd
->writesize
;
459 * since the input length may be unaligned, prevent access past the end
467 * nand_verify_page_oob:
469 * Verify a page of NAND flash, including the OOB.
470 * Reads page of NAND and verifies the contents and OOB against the
473 * @param mtd nand mtd instance
474 * @param ops MTD operations, including data to verify
475 * @param ofs offset in flash
476 * @return 0 in case of success
478 int nand_verify_page_oob(struct mtd_info
*mtd
, struct mtd_oob_ops
*ops
,
482 struct mtd_oob_ops vops
;
483 size_t verlen
= mtd
->writesize
+ mtd
->oobsize
;
485 memcpy(&vops
, ops
, sizeof(vops
));
487 vops
.datbuf
= memalign(ARCH_DMA_MINALIGN
, verlen
);
492 vops
.oobbuf
= vops
.datbuf
+ mtd
->writesize
;
494 rval
= mtd_read_oob(mtd
, 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 mtd nand mtd instance
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(struct mtd_info
*mtd
, loff_t ofs
, size_t len
, u_char
*buf
)
523 size_t verlen
= mtd
->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(mtd
->writesize
, (uint32_t)(ofs
+ len
- verofs
));
533 rval
= nand_read(mtd
, 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 mtd nand mtd instance
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(struct mtd_info
*mtd
, 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
= mtd
->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
& (mtd
->writesize
- 1)) != 0) {
598 printf("Attempt to write non page-aligned data\n");
603 need_skip
= check_skip_len(mtd
, 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(mtd
, offset
, length
, buffer
);
623 if ((flags
& WITH_WR_VERIFY
) && !rval
)
624 rval
= nand_verify(mtd
, 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
& (mtd
->erasesize
- 1);
637 size_t write_size
, truncated_write_size
;
641 if (nand_block_isbad(mtd
, offset
& ~(mtd
->erasesize
- 1))) {
642 printf("Skip bad block 0x%08llx\n",
643 offset
& ~(mtd
->erasesize
- 1));
644 offset
+= mtd
->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(mtd
, p_buffer
,
660 rval
= nand_write(mtd
, offset
, &truncated_write_size
,
663 if ((flags
& WITH_WR_VERIFY
) && !rval
)
664 rval
= nand_verify(mtd
, 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 mtd nand mtd instance
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(struct mtd_info
*mtd
, 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
& (mtd
->writesize
- 1)) != 0) {
716 printf("Attempt to read non page-aligned data\n");
723 need_skip
= check_skip_len(mtd
, 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(mtd
, 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
& (mtd
->erasesize
- 1);
757 if (nand_block_isbad(mtd
, offset
& ~(mtd
->erasesize
- 1))) {
758 printf("Skipping bad block 0x%08llx\n",
759 offset
& ~(mtd
->erasesize
- 1));
760 offset
+= mtd
->erasesize
- block_offset
;
764 if (left_to_read
< (mtd
->erasesize
- block_offset
))
765 read_length
= left_to_read
;
767 read_length
= mtd
->erasesize
- block_offset
;
769 rval
= nand_read(mtd
, 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 mtd nand mtd instance
816 * @param offset offset in flash
817 * @return 0 if the block is still good
819 int nand_torture(struct mtd_info
*mtd
, loff_t offset
)
821 u_char patterns
[] = {0xa5, 0x5a, 0x00};
822 struct erase_info instr
= {
825 .len
= mtd
->erasesize
,
828 int err
, ret
= -1, i
, patt_count
;
831 if ((offset
& (mtd
->erasesize
- 1)) != 0) {
832 puts("Attempt to torture a block at a non block-aligned offset\n");
836 if (offset
+ mtd
->erasesize
> mtd
->size
) {
837 puts("Attempt to torture a block outside the flash area\n");
841 patt_count
= ARRAY_SIZE(patterns
);
843 buf
= malloc_cache_aligned(mtd
->erasesize
);
845 puts("Out of memory for erase block buffer\n");
849 for (i
= 0; i
< patt_count
; i
++) {
850 err
= mtd
->erase(mtd
, &instr
);
852 printf("%s: erase() failed for block at 0x%llx: %d\n",
853 mtd
->name
, instr
.addr
, err
);
857 /* Make sure the block contains only 0xff bytes */
858 err
= mtd
->read(mtd
, offset
, mtd
->erasesize
, &retlen
, buf
);
859 if ((err
&& err
!= -EUCLEAN
) || retlen
!= mtd
->erasesize
) {
860 printf("%s: read() failed for block at 0x%llx: %d\n",
861 mtd
->name
, instr
.addr
, err
);
865 err
= check_pattern(buf
, 0xff, mtd
->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
], mtd
->erasesize
);
875 err
= mtd
->write(mtd
, offset
, mtd
->erasesize
, &retlen
, buf
);
876 if (err
|| retlen
!= mtd
->erasesize
) {
877 printf("%s: write() failed for block at 0x%llx: %d\n",
878 mtd
->name
, instr
.addr
, err
);
882 err
= mtd
->read(mtd
, offset
, mtd
->erasesize
, &retlen
, buf
);
883 if ((err
&& err
!= -EUCLEAN
) || retlen
!= mtd
->erasesize
) {
884 printf("%s: read() failed for block at 0x%llx: %d\n",
885 mtd
->name
, instr
.addr
, err
);
889 err
= check_pattern(buf
, patterns
[i
], mtd
->erasesize
);
891 printf("Pattern 0x%.2x checking failed for block at "
892 "0x%llx\n", patterns
[i
], offset
);