Skip to contentSkip to conversation

Add 'sf update' command to do smart SPI flash update

PATCH Superseded Simon Glass 2 participants 3 messages Aug 19, 2011

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Add 'sf update' command to do smart SPI flash update

This adds a new SPI flash command which only rewrites blocks if the contents need to change. This can speed up SPI flash programming when much of the data is unchanged from what is already there.

---
Changes in v2:
-Moved loop into a function
-Moved malloc outside loop
-Other minor changes from review comments

 common/cmd_sf.c |   82 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 80 insertions(+), 2 deletions(-)
common/cmd_sf.c +80 -2
index 11a491d..e69dc1e 100644
@@ -6,6 +6,7 @@
  */
 
 #include <common.h>
+#include <malloc.h>
 #include <spi_flash.h>
 
 #include <asm/io.h>
@@ -109,6 +110,78 @@ static int do_spi_flash_probe(int argc, char * const argv[])
 	return 0;
 }
 
+/**
+ * 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 *write_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=%#x\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 %x: 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;		/* statistics */
+
+	cmp_buf = malloc(flash->sector_size);
+	if (cmp_buf) {
+		for (skipped = 0; buf < end; buf += todo, offset += todo) {
+			todo = min(end - buf, flash->sector_size);
+			err_oper = write_block(flash, offset, todo, buf,
+					cmp_buf, &skipped);
+		}
+	} else {
+		err_oper = "malloc";
+	}
+	free(cmp_buf);
+	if (err_oper) {
+		printf("SPI flash %s failed\n", err_oper);
+		return 1;
+	}
+	printf("%d bytes written, %d bytes skipped\n", len - skipped, skipped);
+	return 0;
+}
+
 static int do_spi_flash_read_write(int argc, char * const argv[])
 {
 	unsigned long addr;
@@ -137,7 +210,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);
@@ -203,7 +278,8 @@ 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)
+	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);
@@ -229,4 +305,6 @@ U_BOOT_CMD(
 	"				  at `addr' to flash at `offset'\n"
 	"sf erase offset [+]len		- erase `len' bytes from `offset'\n"
 	"				  `+len' round up `len' to block size"
+	"sf update addr offset len	- erase and write `len' bytes from memory\n"
+	"				  at `addr' to flash at `offset'\n"
 );
Signature · 1 line
1.7.3.1
#1 lore raw

PATCH v2 1/1 Add 'sf update' command to do smart SPI flash update

common/cmd_sf.c static int do_spi_flash_probe(int argc, char * const argv[]) · line 128

Quoted 2 lines · On Friday, August 19, 2011 14:19:42 Simon Glass wrote:
common/cmd_sf.c +2 -0
+static const char *write_block(struct spi_flash *flash, u32 offset,
+		size_t len, const char *buf, char *cmp_buf, size_t *skipped)

"spi_flash_update_block" is probably a better name. after all, you're doing more (and sometimes less) than "writing a block".

common/cmd_sf.c static int do_spi_flash_probe(int argc, char * const argv[]) · line 133

Quoted 1 line
common/cmd_sf.c +1 -0
+		return"read";

need a space in the middle there

common/cmd_sf.c static int do_spi_flash_probe(int argc, char * const argv[]) · line 178

Quoted 1 line
common/cmd_sf.c +1 -0
+		printf("SPI flash %s failed\n", err_oper);

how about:
SPI flash update failed in %s step
running 'sf update' on the command line would be obvious where the problem is coming from, but if you have a bunch of sf commands in a script and only see one error, it's probably confusing to quickly pick out where the error occurred.

Review

Quoted 12 lines
(quoted diff) +5 -2
-	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);
...
-	if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0)
+	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);

these duplicate strcmp's make me wonder if a follow up patch should turn these into a tokenize step first and then later code works off that

rest looks fine
-mike
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: This is a digitally signed message part.
Url : http://lists.denx.de/pipermail/u-boot/attachments/20110819/d9738178/attachment.pgp

#2 lore raw

PATCH v2 1/1 Add 'sf update' command to do smart SPI flash update

Hi Mike,

Quoted 10 lines · Mike Frysinger
Quoted 2 lines · On Friday, August 19, 2011 14:19:42 Simon Glass wrote:

+static const char *write_block(struct spi_flash *flash, u32 offset,
+ ? ? ? ? ? ? size_t len, const char *buf, char *cmp_buf, size_t *skipped)

"spi_flash_update_block" is probably a better name. ?after all, you're doing more (and sometimes less) than "writing a block".

Quoted 1 line

+ ? ? ? ? ? ? return"read";

need a space in the middle there

Done

Quoted 9 lines
Quoted 2 lines

+ ? ? ? ? ? ? printf("SPI flash %s failed\n", err_oper);

how about:
? ? ? ?SPI flash update failed in %s step
running 'sf update' on the command line would be obvious where the problem is coming from, but if you have a bunch of sf commands in a script and only see one error, it's probably confusing to quickly pick out where the error occurred.

Done

Quoted 14 lines
Quoted 7 lines

- ? ? 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);
...

Quoted 6 lines
- ? ? if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0)
+ ? ? 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);

Quoted 2 lines

these duplicate strcmp's make me wonder if a follow up patch should turn these into a tokenize step first and then later code works off that

Yes I agree. Still the sf code is quite a bit cleaner than March.

Quoted 4 lines

rest looks fine
-mike

Thanks,
Simon