]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - drivers/mtd/nand/nand_util.c
nand: Change ulong to loff_t and size_t
[karo-tx-uboot.git] / drivers / mtd / nand / nand_util.c
index 77da53e2618615b7b35460b8fc1c40a7a3027fdb..5ef7df74010bde3251416d2ca7b08c0fa1848efc 100644 (file)
@@ -11,6 +11,9 @@
  *             nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
  *                            and Thomas Gleixner (tglx@linutronix.de)
  *
+ * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
+ * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
+ *
  * See file CREDITS for list of people who contributed to this
  * project.
  *
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
  *
+ * Copyright 2010 Freescale Semiconductor
+ * The portions of this file whose copyright is held by Freescale and which
+ * are not considered a derived work of GPL v2-only code may be distributed
+ * and/or modified under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
  */
 
 #include <common.h>
@@ -36,7 +45,6 @@
 #include <malloc.h>
 #include <div64.h>
 
-
 #include <asm/errno.h>
 #include <linux/mtd/mtd.h>
 #include <nand.h>
@@ -49,12 +57,6 @@ typedef struct mtd_info        mtd_info_t;
 #define cpu_to_je16(x) (x)
 #define cpu_to_je32(x) (x)
 
-/*****************************************************************************/
-static int nand_block_bad_scrub(struct mtd_info *mtd, loff_t ofs, int getchip)
-{
-       return 0;
-}
-
 /**
  * nand_erase_opts: - erase NAND flash with support for various options
  *                   (jffs2 formating)
@@ -70,22 +72,27 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
 {
        struct jffs2_unknown_node cleanmarker;
        erase_info_t erase;
-       ulong erase_length;
+       unsigned long erase_length, erased_length; /* in blocks */
        int bbtest = 1;
        int result;
        int percent_complete = -1;
-       int (*nand_block_bad_old)(struct mtd_info *, loff_t, int) = NULL;
        const char *mtd_device = meminfo->name;
        struct mtd_oob_ops oob_opts;
        struct nand_chip *chip = meminfo->priv;
 
+       if ((opts->offset & (meminfo->writesize - 1)) != 0) {
+               printf("Attempt to erase non page aligned data\n");
+               return -1;
+       }
+
        memset(&erase, 0, sizeof(erase));
        memset(&oob_opts, 0, sizeof(oob_opts));
 
        erase.mtd = meminfo;
        erase.len  = meminfo->erasesize;
        erase.addr = opts->offset;
-       erase_length = opts->length;
+       erase_length = lldiv(opts->length + meminfo->erasesize - 1,
+                            meminfo->erasesize);
 
        cleanmarker.magic = cpu_to_je16 (JFFS2_MAGIC_BITMASK);
        cleanmarker.nodetype = cpu_to_je16 (JFFS2_NODETYPE_CLEANMARKER);
@@ -96,28 +103,19 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
         * and disable bad block table while erasing.
         */
        if (opts->scrub) {
-               struct nand_chip *priv_nand = meminfo->priv;
-
-               nand_block_bad_old = priv_nand->block_bad;
-               priv_nand->block_bad = nand_block_bad_scrub;
-               /* we don't need the bad block table anymore...
+               erase.scrub = opts->scrub;
+               /*
+                * We don't need the bad block table anymore...
                 * after scrub, there are no bad blocks left!
                 */
-               if (priv_nand->bbt) {
-                       kfree(priv_nand->bbt);
+               if (chip->bbt) {
+                       kfree(chip->bbt);
                }
-               priv_nand->bbt = NULL;
+               chip->bbt = NULL;
        }
 
-       if (erase_length < meminfo->erasesize) {
-               printf("Warning: Erase size 0x%08lx smaller than one "  \
-                      "erase block 0x%08x\n",erase_length, meminfo->erasesize);
-               printf("         Erasing 0x%08x instead\n", meminfo->erasesize);
-               erase_length = meminfo->erasesize;
-       }
-
-       for (;
-            erase.addr < opts->offset + erase_length;
+       for (erased_length = 0;
+            erased_length < erase_length;
             erase.addr += meminfo->erasesize) {
 
                WATCHDOG_RESET ();
@@ -127,9 +125,13 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
                        if (ret > 0) {
                                if (!opts->quiet)
                                        printf("\rSkipping bad block at  "
-                                              "0x%08x                   "
+                                              "0x%08llx                 "
                                               "                         \n",
                                               erase.addr);
+
+                               if (!opts->spread)
+                                       erased_length++;
+
                                continue;
 
                        } else if (ret < 0) {
@@ -140,6 +142,8 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
                        }
                }
 
+               erased_length++;
+
                result = meminfo->erase(meminfo, &erase);
                if (result != 0) {
                        printf("\n%s: MTD Erase failure: %d\n",
@@ -166,9 +170,7 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
                }
 
                if (!opts->quiet) {
-                       unsigned long long n =(unsigned long long)
-                               (erase.addr + meminfo->erasesize - opts->offset)
-                               * 100;
+                       unsigned long long n = erased_length * 100ULL;
                        int percent;
 
                        do_div(n, erase_length);
@@ -181,11 +183,11 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
                        if (percent != percent_complete) {
                                percent_complete = percent;
 
-                               printf("\rErasing at 0x%x -- %3d%% complete.",
+                               printf("\rErasing at 0x%llx -- %3d%% complete.",
                                       erase.addr, percent);
 
                                if (opts->jffs2 && result == 0)
-                                       printf(" Cleanmarker written at 0x%x.",
+                                       printf(" Cleanmarker written at 0x%llx.",
                                               erase.addr);
                        }
                }
@@ -193,51 +195,12 @@ int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
        if (!opts->quiet)
                printf("\n");
 
-       if (nand_block_bad_old) {
-               struct nand_chip *priv_nand = meminfo->priv;
-
-               priv_nand->block_bad = nand_block_bad_old;
-               priv_nand->scan_bbt(meminfo);
-       }
+       if (opts->scrub)
+               chip->scan_bbt(meminfo);
 
        return 0;
 }
 
-/* XXX U-BOOT XXX */
-#if 0
-
-#define MAX_PAGE_SIZE  2048
-#define MAX_OOB_SIZE   64
-
-/*
- * buffer array used for writing data
- */
-static unsigned char data_buf[MAX_PAGE_SIZE];
-static unsigned char oob_buf[MAX_OOB_SIZE];
-
-/* OOB layouts to pass into the kernel as default */
-static struct nand_ecclayout none_ecclayout = {
-       .useecc = MTD_NANDECC_OFF,
-};
-
-static struct nand_ecclayout jffs2_ecclayout = {
-       .useecc = MTD_NANDECC_PLACE,
-       .eccbytes = 6,
-       .eccpos = { 0, 1, 2, 3, 6, 7 }
-};
-
-static struct nand_ecclayout yaffs_ecclayout = {
-       .useecc = MTD_NANDECC_PLACE,
-       .eccbytes = 6,
-       .eccpos = { 8, 9, 10, 13, 14, 15}
-};
-
-static struct nand_ecclayout autoplace_ecclayout = {
-       .useecc = MTD_NANDECC_AUTOPLACE
-};
-#endif
-
-/* XXX U-BOOT XXX */
 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 
 /******************************************************************************
@@ -312,7 +275,7 @@ int nand_lock(struct mtd_info *mtd, int tight)
  *                       NAND_LOCK_STATUS_UNLOCK: page unlocked
  *
  */
-int nand_get_lock_status(struct mtd_info *mtd, ulong offset)
+int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
 {
        int ret = 0;
        int chipnr;
@@ -354,18 +317,21 @@ int nand_get_lock_status(struct mtd_info *mtd, ulong offset)
  * @param start                start byte address
  * @param length       number of bytes to unlock (must be a multiple of
  *                     page size nand->writesize)
+ * @param allexcept    if set, unlock everything not selected
  *
  * @return             0 on success, -1 in case of error
  */
-int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
+int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
+       int allexcept)
 {
        int ret = 0;
        int chipnr;
        int status;
        int page;
        struct nand_chip *chip = mtd->priv;
-       printf ("nand_unlock: start: %08x, length: %d!\n",
-               (int)start, (int)length);
+
+       debug("nand_unlock%s: start: %08llx, length: %d!\n",
+               allexcept ? " (allexcept)" : "", start, length);
 
        /* select the NAND device */
        chipnr = (int)(start >> chip->chip_shift);
@@ -405,6 +371,15 @@ int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
 
        /* submit ADDRESS of LAST page to unlock */
        page += (int)(length >> chip->page_shift);
+
+       /*
+        * Page addresses for unlocking are supposed to be block-aligned.
+        * At least some NAND chips use the low bit to indicate that the
+        * page range should be inverted.
+        */
+       if (allexcept)
+               page |= 1;
+
        chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
 
        /* call wait ready function */
@@ -424,37 +399,67 @@ int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
 #endif
 
 /**
- * get_len_incl_bad
+ * check_skip_len
  *
- * Check if length including bad blocks fits into device.
+ * Check if there are any bad blocks, and whether length including bad
+ * blocks fits into device
  *
  * @param nand NAND device
  * @param offset offset in flash
  * @param length image length
- * @return image length including bad blocks
+ * @return 0 if the image fits and there are no bad blocks
+ *         1 if the image fits, but there are bad blocks
+ *        -1 if the image does not fit
  */
-static size_t get_len_incl_bad (nand_info_t *nand, size_t offset,
-                               const size_t length)
+static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length)
 {
-       size_t len_incl_bad = 0;
        size_t len_excl_bad = 0;
-       size_t block_len;
+       int ret = 0;
 
        while (len_excl_bad < length) {
-               block_len = nand->erasesize - (offset & (nand->erasesize - 1));
+               size_t block_len, block_off;
+               loff_t block_start;
+
+               if (offset >= nand->size)
+                       return -1;
+
+               block_start = offset & ~(loff_t)(nand->erasesize - 1);
+               block_off = offset & (nand->erasesize - 1);
+               block_len = nand->erasesize - block_off;
 
-               if (!nand_block_isbad (nand, offset & ~(nand->erasesize - 1)))
+               if (!nand_block_isbad(nand, block_start))
                        len_excl_bad += block_len;
+               else
+                       ret = 1;
 
-               len_incl_bad += block_len;
-               offset       += block_len;
+               offset += block_len;
+       }
 
-               if ((offset + len_incl_bad) >= nand->size)
+       return ret;
+}
+
+#ifdef CONFIG_CMD_NAND_TRIMFFS
+static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
+                       const size_t *len)
+{
+       size_t i, l = *len;
+
+       for (i = l - 1; i >= 0; i--)
+               if (buf[i] != 0xFF)
                        break;
-       }
 
-       return len_incl_bad;
+       /* The resulting length must be aligned to the minimum flash I/O size */
+       l = i + 1;
+       l = (l + nand->writesize - 1) / nand->writesize;
+       l *=  nand->writesize;
+
+       /*
+        * since the input length may be unaligned, prevent access past the end
+        * of the buffer
+        */
+       return min(l, *len);
 }
+#endif
 
 /**
  * nand_write_skip_bad:
@@ -467,67 +472,141 @@ static size_t get_len_incl_bad (nand_info_t *nand, size_t offset,
  * @param nand         NAND device
  * @param offset       offset in flash
  * @param length       buffer length
- * @param buf           buffer to read from
+ * @param buffer        buffer to read from
+ * @param flags                flags modifying the behaviour of the write to NAND
  * @return             0 in case of success
  */
-int nand_write_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
-                       u_char *buffer)
+int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
+                       u_char *buffer, int flags)
 {
-       int rval;
+       int rval = 0, blocksize;
        size_t left_to_write = *length;
-       size_t len_incl_bad;
        u_char *p_buffer = buffer;
+       int need_skip;
+
+#ifdef CONFIG_CMD_NAND_YAFFS
+       if (flags & WITH_YAFFS_OOB) {
+               if (flags & ~WITH_YAFFS_OOB)
+                       return -EINVAL;
+
+               int pages;
+               pages = nand->erasesize / nand->writesize;
+               blocksize = (pages * nand->oobsize) + nand->erasesize;
+               if (*length % (nand->writesize + nand->oobsize)) {
+                       printf ("Attempt to write incomplete page"
+                               " in yaffs mode\n");
+                       return -EINVAL;
+               }
+       } else
+#endif
+       {
+               blocksize = nand->erasesize;
+       }
 
-       /* Reject writes, which are not page aligned */
-       if ((offset & (nand->writesize - 1)) != 0 ||
-           (*length & (nand->writesize - 1)) != 0) {
+       /*
+        * nand_write() handles unaligned, partial page writes.
+        *
+        * We allow length to be unaligned, for convenience in
+        * using the $filesize variable.
+        *
+        * However, starting at an unaligned offset makes the
+        * semantics of bad block skipping ambiguous (really,
+        * you should only start a block skipping access at a
+        * partition boundary).  So don't try to handle that.
+        */
+       if ((offset & (nand->writesize - 1)) != 0) {
                printf ("Attempt to write non page aligned data\n");
+               *length = 0;
                return -EINVAL;
        }
 
-       len_incl_bad = get_len_incl_bad (nand, offset, *length);
-
-       if ((offset + len_incl_bad) >= nand->size) {
+       need_skip = check_skip_len(nand, offset, *length);
+       if (need_skip < 0) {
                printf ("Attempt to write outside the flash area\n");
+               *length = 0;
                return -EINVAL;
        }
 
-       if (len_incl_bad == *length) {
+       if (!need_skip && !(flags & WITH_DROP_FFS)) {
                rval = nand_write (nand, offset, length, buffer);
-               if (rval != 0)
-                       printf ("NAND write to offset %x failed %d\n",
-                               offset, rval);
+               if (rval == 0)
+                       return 0;
 
+               *length = 0;
+               printf ("NAND write to offset %llx failed %d\n",
+                       offset, rval);
                return rval;
        }
 
        while (left_to_write > 0) {
                size_t block_offset = offset & (nand->erasesize - 1);
-               size_t write_size;
+               size_t write_size, truncated_write_size;
+
+               WATCHDOG_RESET ();
 
                if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
-                       printf ("Skip bad block 0x%08x\n",
+                       printf ("Skip bad block 0x%08llx\n",
                                offset & ~(nand->erasesize - 1));
                        offset += nand->erasesize - block_offset;
                        continue;
                }
 
-               if (left_to_write < (nand->erasesize - block_offset))
+               if (left_to_write < (blocksize - block_offset))
                        write_size = left_to_write;
                else
-                       write_size = nand->erasesize - block_offset;
+                       write_size = blocksize - block_offset;
+
+#ifdef CONFIG_CMD_NAND_YAFFS
+               if (flags & WITH_YAFFS_OOB) {
+                       int page, pages;
+                       size_t pagesize = nand->writesize;
+                       size_t pagesize_oob = pagesize + nand->oobsize;
+                       struct mtd_oob_ops ops;
+
+                       ops.len = pagesize;
+                       ops.ooblen = nand->oobsize;
+                       ops.mode = MTD_OOB_AUTO;
+                       ops.ooboffs = 0;
+
+                       pages = write_size / pagesize_oob;
+                       for (page = 0; page < pages; page++) {
+                               WATCHDOG_RESET();
+
+                               ops.datbuf = p_buffer;
+                               ops.oobbuf = ops.datbuf + pagesize;
+
+                               rval = nand->write_oob(nand, offset, &ops);
+                               if (rval != 0)
+                                       break;
+
+                               offset += pagesize;
+                               p_buffer += pagesize_oob;
+                       }
+               }
+               else
+#endif
+               {
+                       truncated_write_size = write_size;
+#ifdef CONFIG_CMD_NAND_TRIMFFS
+                       if (flags & WITH_DROP_FFS)
+                               truncated_write_size = drop_ffs(nand, p_buffer,
+                                               &write_size);
+#endif
+
+                       rval = nand_write(nand, offset, &truncated_write_size,
+                                       p_buffer);
+                       offset += write_size;
+                       p_buffer += write_size;
+               }
 
-               rval = nand_write (nand, offset, &write_size, p_buffer);
                if (rval != 0) {
-                       printf ("NAND write to offset %x failed %d\n",
+                       printf ("NAND write to offset %llx failed %d\n",
                                offset, rval);
                        *length -= left_to_write;
                        return rval;
                }
 
                left_to_write -= write_size;
-               offset        += write_size;
-               p_buffer      += write_size;
        }
 
        return 0;
@@ -547,27 +626,35 @@ int nand_write_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
  * @param buffer buffer to write to
  * @return 0 in case of success
  */
-int nand_read_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
+int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
                       u_char *buffer)
 {
        int rval;
        size_t left_to_read = *length;
-       size_t len_incl_bad;
        u_char *p_buffer = buffer;
+       int need_skip;
 
-       len_incl_bad = get_len_incl_bad (nand, offset, *length);
+       if ((offset & (nand->writesize - 1)) != 0) {
+               printf ("Attempt to read non page aligned data\n");
+               *length = 0;
+               return -EINVAL;
+       }
 
-       if ((offset + len_incl_bad) >= nand->size) {
+       need_skip = check_skip_len(nand, offset, *length);
+       if (need_skip < 0) {
                printf ("Attempt to read outside the flash area\n");
+               *length = 0;
                return -EINVAL;
        }
 
-       if (len_incl_bad == *length) {
+       if (!need_skip) {
                rval = nand_read (nand, offset, length, buffer);
-               if (rval != 0)
-                       printf ("NAND read from offset %x failed %d\n",
-                               offset, rval);
+               if (!rval || rval == -EUCLEAN)
+                       return 0;
 
+               *length = 0;
+               printf ("NAND read from offset %llx failed %d\n",
+                       offset, rval);
                return rval;
        }
 
@@ -575,8 +662,10 @@ int nand_read_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
                size_t block_offset = offset & (nand->erasesize - 1);
                size_t read_length;
 
+               WATCHDOG_RESET ();
+
                if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
-                       printf ("Skipping bad block 0x%08x\n",
+                       printf ("Skipping bad block 0x%08llx\n",
                                offset & ~(nand->erasesize - 1));
                        offset += nand->erasesize - block_offset;
                        continue;
@@ -588,8 +677,8 @@ int nand_read_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
                        read_length = nand->erasesize - block_offset;
 
                rval = nand_read (nand, offset, &read_length, p_buffer);
-               if (rval != 0) {
-                       printf ("NAND read from offset %x failed %d\n",
+               if (rval && rval != -EUCLEAN) {
+                       printf ("NAND read from offset %llx failed %d\n",
                                offset, rval);
                        *length -= left_to_read;
                        return rval;