]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - common/cmd_sf.c
cosmetic: suvd3: align #defines
[karo-tx-uboot.git] / common / cmd_sf.c
index 6e7be818ebe8cae981d2cfe2f68991dfac20603c..5ac1d0c4c1ef4ef9cc34b30b3e056b2a76744beb 100644 (file)
@@ -6,6 +6,7 @@
  */
 
 #include <common.h>
+#include <malloc.h>
 #include <spi_flash.h>
 
 #include <asm/io.h>
 #ifndef CONFIG_SF_DEFAULT_MODE
 # define CONFIG_SF_DEFAULT_MODE                SPI_MODE_3
 #endif
+#ifndef CONFIG_SF_DEFAULT_CS
+# define CONFIG_SF_DEFAULT_CS          0
+#endif
+#ifndef CONFIG_SF_DEFAULT_BUS
+# define CONFIG_SF_DEFAULT_BUS         0
+#endif
 
 static struct spi_flash *flash;
 
+
+/*
+ * This function computes the length argument for the erase command.
+ * The length on which the command is to operate can be given in two forms:
+ * 1. <cmd> offset len  - operate on <'offset',  'len')
+ * 2. <cmd> offset +len - operate on <'offset',  'round_up(len)')
+ * If the second form is used and the length doesn't fall on the
+ * sector boundary, than it will be adjusted to the next sector boundary.
+ * If it isn't in the flash, the function will fail (return -1).
+ * Input:
+ *    arg: length specification (i.e. both command arguments)
+ * Output:
+ *    len: computed length for operation
+ * Return:
+ *    1: success
+ *   -1: failure (bad format, bad address).
+ */
+static int sf_parse_len_arg(char *arg, ulong *len)
+{
+       char *ep;
+       char round_up_len; /* indicates if the "+length" form used */
+       ulong len_arg;
+
+       round_up_len = 0;
+       if (*arg == '+') {
+               round_up_len = 1;
+               ++arg;
+       }
+
+       len_arg = simple_strtoul(arg, &ep, 16);
+       if (ep == arg || *ep != '\0')
+               return -1;
+
+       if (round_up_len && flash->sector_size > 0)
+               *len = ROUND(len_arg, flash->sector_size);
+       else
+               *len = len_arg;
+
+       return 1;
+}
+
 static int do_spi_flash_probe(int argc, char * const argv[])
 {
-       unsigned int bus = 0;
-       unsigned int cs;
+       unsigned int bus = CONFIG_SF_DEFAULT_BUS;
+       unsigned int cs = CONFIG_SF_DEFAULT_CS;
        unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
        unsigned int mode = CONFIG_SF_DEFAULT_MODE;
        char *endp;
        struct spi_flash *new;
 
-       if (argc < 2)
-               goto usage;
-
-       cs = simple_strtoul(argv[1], &endp, 0);
-       if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
-               goto usage;
-       if (*endp == ':') {
-               if (endp[1] == 0)
-                       goto usage;
-
-               bus = cs;
-               cs = simple_strtoul(endp + 1, &endp, 0);
-               if (*endp != 0)
-                       goto usage;
+       if (argc >= 2) {
+               cs = simple_strtoul(argv[1], &endp, 0);
+               if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
+                       return -1;
+               if (*endp == ':') {
+                       if (endp[1] == 0)
+                               return -1;
+
+                       bus = cs;
+                       cs = simple_strtoul(endp + 1, &endp, 0);
+                       if (*endp != 0)
+                               return -1;
+               }
        }
 
        if (argc >= 3) {
                speed = simple_strtoul(argv[2], &endp, 0);
                if (*argv[2] == 0 || *endp != 0)
-                       goto usage;
+                       return -1;
        }
        if (argc >= 4) {
                mode = simple_strtoul(argv[3], &endp, 16);
                if (*argv[3] == 0 || *endp != 0)
-                       goto usage;
+                       return -1;
        }
 
        new = spi_flash_probe(bus, cs, speed, mode);
@@ -65,14 +112,81 @@ static int do_spi_flash_probe(int argc, char * const argv[])
                spi_flash_free(flash);
        flash = new;
 
-       printf("%u KiB %s at %u:%u is now current device\n",
-                       flash->size >> 10, flash->name, bus, cs);
-
        return 0;
+}
 
-usage:
-       puts("Usage: sf probe [bus:]cs [hz] [mode]\n");
-       return 1;
+/**
+ * Write a block of data to SPI flash, first checking if it is different from
+ * what is already there.
+ *
+ * If the data being written is the same, then *skipped is incremented by len.
+ *
+ * @param flash                flash context pointer
+ * @param offset       flash offset to write
+ * @param len          number of bytes to write
+ * @param buf          buffer to write from
+ * @param cmp_buf      read buffer to use to compare data
+ * @param skipped      Count of skipped data (incremented by this function)
+ * @return NULL if OK, else a string containing the stage which failed
+ */
+static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
+               size_t len, const char *buf, char *cmp_buf, size_t *skipped)
+{
+       debug("offset=%#x, sector_size=%#x, len=%#zx\n",
+               offset, flash->sector_size, len);
+       if (spi_flash_read(flash, offset, len, cmp_buf))
+               return "read";
+       if (memcmp(cmp_buf, buf, len) == 0) {
+               debug("Skip region %x size %zx: no change\n",
+                       offset, len);
+               *skipped += len;
+               return NULL;
+       }
+       if (spi_flash_erase(flash, offset, len))
+               return "erase";
+       if (spi_flash_write(flash, offset, len, buf))
+               return "write";
+       return NULL;
+}
+
+/**
+ * Update an area of SPI flash by erasing and writing any blocks which need
+ * to change. Existing blocks with the correct data are left unchanged.
+ *
+ * @param flash                flash context pointer
+ * @param offset       flash offset to write
+ * @param len          number of bytes to write
+ * @param buf          buffer to write from
+ * @return 0 if ok, 1 on error
+ */
+static int spi_flash_update(struct spi_flash *flash, u32 offset,
+               size_t len, const char *buf)
+{
+       const char *err_oper = NULL;
+       char *cmp_buf;
+       const char *end = buf + len;
+       size_t todo;            /* number of bytes to do in this pass */
+       size_t skipped = 0;     /* statistics */
+
+       cmp_buf = malloc(flash->sector_size);
+       if (cmp_buf) {
+               for (; buf < end && !err_oper; buf += todo, offset += todo) {
+                       todo = min(end - buf, flash->sector_size);
+                       err_oper = spi_flash_update_block(flash, offset, todo,
+                                       buf, cmp_buf, &skipped);
+               }
+       } else {
+               err_oper = "malloc";
+       }
+       free(cmp_buf);
+       if (err_oper) {
+               printf("SPI flash failed in %s step\n", err_oper);
+               return 1;
+       }
+       printf("%zu bytes written, %zu bytes skipped\n", len - skipped,
+              skipped);
+
+       return 0;
 }
 
 static int do_spi_flash_read_write(int argc, char * const argv[])
@@ -85,17 +199,24 @@ static int do_spi_flash_read_write(int argc, char * const argv[])
        int ret;
 
        if (argc < 4)
-               goto usage;
+               return -1;
 
        addr = simple_strtoul(argv[1], &endp, 16);
        if (*argv[1] == 0 || *endp != 0)
-               goto usage;
+               return -1;
        offset = simple_strtoul(argv[2], &endp, 16);
        if (*argv[2] == 0 || *endp != 0)
-               goto usage;
+               return -1;
        len = simple_strtoul(argv[3], &endp, 16);
        if (*argv[3] == 0 || *endp != 0)
-               goto usage;
+               return -1;
+
+       /* Consistency checking */
+       if (offset + len > flash->size) {
+               printf("ERROR: attempting %s past flash size (%#x)\n",
+                       argv[0], flash->size);
+               return 1;
+       }
 
        buf = map_physmem(addr, len, MAP_WRBACK);
        if (!buf) {
@@ -103,7 +224,9 @@ static int do_spi_flash_read_write(int argc, char * const argv[])
                return 1;
        }
 
-       if (strcmp(argv[0], "read") == 0)
+       if (strcmp(argv[0], "update") == 0)
+               ret = spi_flash_update(flash, offset, len, buf);
+       else if (strcmp(argv[0], "read") == 0)
                ret = spi_flash_read(flash, offset, len, buf);
        else
                ret = spi_flash_write(flash, offset, len, buf);
@@ -116,10 +239,6 @@ static int do_spi_flash_read_write(int argc, char * const argv[])
        }
 
        return 0;
-
-usage:
-       printf("Usage: sf %s addr offset len\n", argv[0]);
-       return 1;
 }
 
 static int do_spi_flash_erase(int argc, char * const argv[])
@@ -130,14 +249,22 @@ static int do_spi_flash_erase(int argc, char * const argv[])
        int ret;
 
        if (argc < 3)
-               goto usage;
+               return -1;
 
        offset = simple_strtoul(argv[1], &endp, 16);
        if (*argv[1] == 0 || *endp != 0)
-               goto usage;
-       len = simple_strtoul(argv[2], &endp, 16);
-       if (*argv[2] == 0 || *endp != 0)
-               goto usage;
+               return -1;
+
+       ret = sf_parse_len_arg(argv[2], &len);
+       if (ret != 1)
+               return -1;
+
+       /* Consistency checking */
+       if (offset + len > flash->size) {
+               printf("ERROR: attempting %s past flash size (%#x)\n",
+                       argv[0], flash->size);
+               return 1;
+       }
 
        ret = spi_flash_erase(flash, offset, len);
        if (ret) {
@@ -146,24 +273,25 @@ static int do_spi_flash_erase(int argc, char * const argv[])
        }
 
        return 0;
-
-usage:
-       puts("Usage: sf erase offset len\n");
-       return 1;
 }
 
 static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 {
        const char *cmd;
+       int ret;
 
        /* need at least two arguments */
        if (argc < 2)
                goto usage;
 
        cmd = argv[1];
+       --argc;
+       ++argv;
 
-       if (strcmp(cmd, "probe") == 0)
-               return do_spi_flash_probe(argc - 1, argv + 1);
+       if (strcmp(cmd, "probe") == 0) {
+               ret = do_spi_flash_probe(argc, argv);
+               goto done;
+       }
 
        /* The remaining commands require a selected device */
        if (!flash) {
@@ -171,23 +299,33 @@ static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[
                return 1;
        }
 
-       if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0)
-               return do_spi_flash_read_write(argc - 1, argv + 1);
-       if (strcmp(cmd, "erase") == 0)
-               return do_spi_flash_erase(argc - 1, argv + 1);
+       if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
+           strcmp(cmd, "update") == 0)
+               ret = do_spi_flash_read_write(argc, argv);
+       else if (strcmp(cmd, "erase") == 0)
+               ret = do_spi_flash_erase(argc, argv);
+       else
+               ret = -1;
+
+done:
+       if (ret != -1)
+               return ret;
 
 usage:
-       return cmd_usage(cmdtp);
+       return CMD_RET_USAGE;
 }
 
 U_BOOT_CMD(
        sf,     5,      1,      do_spi_flash,
        "SPI flash sub-system",
-       "probe [bus:]cs [hz] [mode]     - init flash device on given SPI bus\n"
+       "probe [[bus:]cs] [hz] [mode]   - init flash device on given SPI bus\n"
        "                                 and chip select\n"
        "sf read addr offset len        - read `len' bytes starting at\n"
        "                                 `offset' to memory at `addr'\n"
        "sf write addr offset len       - write `len' bytes from memory\n"
        "                                 at `addr' to flash at `offset'\n"
-       "sf erase offset len            - erase `len' bytes from `offset'"
+       "sf erase offset [+]len         - erase `len' bytes from `offset'\n"
+       "                                 `+len' round up `len' to block size\n"
+       "sf update addr offset len      - erase and write `len' bytes from memory\n"
+       "                                 at `addr' to flash at `offset'"
 );