Spelling fixes in comments, documentation, tests and examples
[oweals/busybox.git] / miscutils / nandwrite.c
index c5e2fb841face3dc6d219ae7040f44d7e7603b8d..dbe9043f4be34a19f9686a77125ae6bf75cbe9d2 100644 (file)
@@ -8,44 +8,48 @@
  * TODO: add support for large (>4GB) MTD devices
  */
 
-//applet:IF_NANDWRITE(APPLET(nandwrite, BB_DIR_USR_SBIN, BB_SUID_DROP))
-//applet:IF_NANDWRITE(APPLET_ODDNAME(nanddump, nandwrite, BB_DIR_USR_SBIN, BB_SUID_DROP, nanddump))
-
-//kbuild:lib-$(CONFIG_NANDWRITE) += nandwrite.o
-//kbuild:lib-$(CONFIG_NANDDUMP) += nandwrite.o
-
 //config:config NANDWRITE
 //config:      bool "nandwrite"
-//config:      default n
-//config:      depends on PLATFORM_LINUX
+//config:      default y
+//config:      select PLATFORM_LINUX
 //config:      help
 //config:        Write to the specified MTD device, with bad blocks awareness
 //config:
 //config:config NANDDUMP
 //config:      bool "nanddump"
-//config:      default n
-//config:      depends on PLATFORM_LINUX
+//config:      default y
+//config:      select PLATFORM_LINUX
 //config:      help
 //config:        Dump the content of raw NAND chip
 
+//applet:IF_NANDWRITE(APPLET(nandwrite, BB_DIR_USR_SBIN, BB_SUID_DROP))
+//applet:IF_NANDDUMP(APPLET_ODDNAME(nanddump, nandwrite, BB_DIR_USR_SBIN, BB_SUID_DROP, nanddump))
+
+//kbuild:lib-$(CONFIG_NANDWRITE) += nandwrite.o
+//kbuild:lib-$(CONFIG_NANDDUMP) += nandwrite.o
+
 //usage:#define nandwrite_trivial_usage
-//usage:       "[-p] [-s ADDR] MTD_DEVICE [FILE]"
+//usage:       "[-np] [-s ADDR] MTD_DEVICE [FILE]"
 //usage:#define nandwrite_full_usage "\n\n"
-//usage:       "Write to the specified MTD device\n"
-//usage:     "\nOptions:"
+//usage:       "Write to MTD_DEVICE\n"
+//usage:     "\n       -n      Write without ecc"
 //usage:     "\n       -p      Pad to page size"
 //usage:     "\n       -s ADDR Start address"
 
 //usage:#define nanddump_trivial_usage
-//usage:       "[-o] [-b] [-s ADDR] [-f FILE] MTD_DEVICE"
+//usage:       "[-no]" IF_LONG_OPTS(" [--bb padbad|skipbad]") " [-s ADDR] [-l LEN] [-f FILE] MTD_DEVICE"
 //usage:#define nanddump_full_usage "\n\n"
-//usage:       "Dump the sepcified MTD device\n"
-//usage:     "\nOptions:"
-//usage:     "\n       -o      Omit oob data"
-//usage:     "\n       -b      Omit bad block from the dump"
+//usage:       "Dump MTD_DEVICE\n"
+//usage:     "\n       -n      Read without ecc"
+//usage:     "\n       -o      Dump oob data"
 //usage:     "\n       -s ADDR Start address"
 //usage:     "\n       -l LEN  Length"
 //usage:     "\n       -f FILE Dump to file ('-' for stdout)"
+//usage:     IF_LONG_OPTS(
+//usage:     "\n       --bb METHOD"
+//usage:     "\n               skipbad: skip bad blocks"
+//usage:     "\n               padbad: substitute bad blocks by 0xff (default)"
+//usage:     )
 
 #include "libbb.h"
 #include <mtd/mtd-user.h>
 
 #define OPT_p  (1 << 0) /* nandwrite only */
 #define OPT_o  (1 << 0) /* nanddump only */
-#define OPT_s  (1 << 1)
-#define OPT_b  (1 << 2)
+#define OPT_n  (1 << 1)
+#define OPT_s  (1 << 2)
 #define OPT_f  (1 << 3)
 #define OPT_l  (1 << 4)
+#define OPT_bb (1 << 5) /* must be the last one in the list */
+
+#define BB_PADBAD (1 << 0)
+#define BB_SKIPBAD (1 << 1)
 
 /* helper for writing out 0xff for bad blocks pad */
 static void dump_bad(struct mtd_info_user *meminfo, unsigned len, int oob)
@@ -66,8 +74,8 @@ static void dump_bad(struct mtd_info_user *meminfo, unsigned len, int oob)
        unsigned char buf[meminfo->writesize];
        unsigned count;
 
-       /* round len to the next page */
-       len = (len | ~(meminfo->writesize - 1)) + 1;
+       /* round len to the next page only if len is not already on a page */
+       len = ((len - 1) | (meminfo->writesize - 1)) + 1;
 
        memset(buf, 0xff, sizeof(buf));
        for (count = 0; count < len; count += meminfo->writesize) {
@@ -104,6 +112,7 @@ int nandwrite_main(int argc UNUSED_PARAM, char **argv)
        /* Buffer for OOB data */
        unsigned char *oobbuf;
        unsigned opts;
+       unsigned bb_method = BB_SKIPBAD;
        int fd;
        ssize_t cnt;
        unsigned mtdoffset, meminfo_writesize, blockstart, limit;
@@ -111,14 +120,18 @@ int nandwrite_main(int argc UNUSED_PARAM, char **argv)
        struct mtd_info_user meminfo;
        struct mtd_oob_buf oob;
        unsigned char *filebuf;
-       const char *opt_s = "0", *opt_f = "-", *opt_l;
+       const char *opt_s = "0", *opt_f = "-", *opt_l, *opt_bb;
 
        if (IS_NANDDUMP) {
                opt_complementary = "=1";
-               opts = getopt32(argv, "os:bf:l:", &opt_s, &opt_f, &opt_l);
+#if ENABLE_LONG_OPTS
+               applet_long_options =
+                       "bb\0" Required_argument "\xff"; /* no short equivalent */
+#endif
+               opts = getopt32(argv, "ons:f:l:", &opt_s, &opt_f, &opt_l, &opt_bb);
        } else { /* nandwrite */
                opt_complementary = "-1:?2";
-               opts = getopt32(argv, "ps:", &opt_s);
+               opts = getopt32(argv, "pns:", &opt_s);
        }
        argv += optind;
 
@@ -131,15 +144,26 @@ int nandwrite_main(int argc UNUSED_PARAM, char **argv)
                xmove_fd(tmp_fd, IS_NANDDUMP ? STDOUT_FILENO : STDIN_FILENO);
        }
 
-       fd = xopen(argv[0], O_RDWR);
+       fd = xopen(argv[0], IS_NANDWRITE ? O_RDWR : O_RDONLY);
        xioctl(fd, MEMGETINFO, &meminfo);
 
+       if (opts & OPT_n)
+               xioctl(fd, MTDFILEMODE, (void *)MTD_FILE_MODE_RAW);
+
        mtdoffset = xstrtou(opt_s, 0);
        if (IS_NANDDUMP && (opts & OPT_l)) {
                unsigned length = xstrtou(opt_l, 0);
                if (length < meminfo.size - mtdoffset)
                        end_addr = mtdoffset + length;
        }
+       if (IS_NANDDUMP && (opts & OPT_bb)) {
+               if (strcmp("skipbad", opt_bb) == 0)
+                       bb_method = BB_SKIPBAD;
+               else if (strcmp("padbad", opt_bb) == 0)
+                       bb_method = BB_PADBAD;
+               else
+                       bb_show_usage();
+       }
 
        /* Pull it into a CPU register (hopefully) - smaller code that way */
        meminfo_writesize = meminfo.writesize;
@@ -164,9 +188,15 @@ int nandwrite_main(int argc UNUSED_PARAM, char **argv)
                tmp = next_good_eraseblock(fd, &meminfo, blockstart);
                if (tmp != blockstart) {
                        /* bad block(s), advance mtdoffset */
-                       if (IS_NANDDUMP & !(opts & OPT_b)) {
-                               int bad_len = MIN(tmp, end_addr) - mtdoffset;
-                               dump_bad(&meminfo, bad_len, !(opts & OPT_o));
+                       if (IS_NANDDUMP) {
+                               if (bb_method == BB_PADBAD) {
+                                       int bad_len = MIN(tmp, end_addr) - mtdoffset;
+                                       dump_bad(&meminfo, bad_len, opts & OPT_o);
+                               }
+                               /* with option skipbad, increase the total length */
+                               if (bb_method == BB_SKIPBAD) {
+                                       end_addr += (tmp - blockstart);
+                               }
                        }
                        mtdoffset = tmp;
                }
@@ -185,8 +215,18 @@ int nandwrite_main(int argc UNUSED_PARAM, char **argv)
                        if (IS_NANDWRITE)
                                printf("Writing at 0x%08x\n", mtdoffset);
                        else if (mtdoffset > blockstart) {
-                               int bad_len = MIN(mtdoffset, limit) - blockstart;
-                               dump_bad(&meminfo, bad_len, !(opts & OPT_o));
+                               if (bb_method == BB_PADBAD) {
+                                       /* dump FF padded bad block */
+                                       int bad_len = MIN(mtdoffset, limit) - blockstart;
+                                       dump_bad(&meminfo, bad_len, opts & OPT_o);
+                               } else if (bb_method == BB_SKIPBAD) {
+                                       /* for skipbad, increase the length */
+                                       if ((end_addr + mtdoffset - blockstart) > end_addr)
+                                               end_addr += (mtdoffset - blockstart);
+                                       else
+                                               end_addr = ~0;
+                                       limit = MIN(meminfo.size, end_addr);
+                               }
                        }
                        if (mtdoffset >= limit)
                                break;
@@ -212,7 +252,7 @@ int nandwrite_main(int argc UNUSED_PARAM, char **argv)
                }
                xwrite(output_fd, filebuf, meminfo_writesize);
 
-               if (IS_NANDDUMP && !(opts & OPT_o)) {
+               if (IS_NANDDUMP && (opts & OPT_o)) {
                        /* Dump OOB data */
                        oob.start = mtdoffset;
                        xioctl(fd, MEMREADOOB, &oob);