flash/nor/tcl: Make verify_bank parameter optional

Make the 'offset' parameter optional, if omitted simply start at the
beginning of the flash bank.

Additionally, check if the argument is out of bounds of the flash bank.

Change-Id: Id1959eee5c395666c35f26342c3c50134dd564e5
Signed-off-by: Marc Schink <openocd-dev@marcschink.de>
Reviewed-on: http://openocd.zylin.com/3858
Tested-by: jenkins
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>

diff --git a/doc/openocd.texi b/doc/openocd.texi
index c3053b76754847afcb6ca4fdbd4dde4218c62eb9..a60474ba1bdadab54c6dcd18ae65e18976d41dd8 100644 (file)
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -4656,9 +4656,10 @@ and write the contents to the binary @file{filename}.
 The @var{num} parameter is a value shown by @command{flash banks}.
 @end deffn
 
-@deffn Command {flash verify_bank} num filename offset
+@deffn Command {flash verify_bank} num filename [offset]
 Compare the contents of the binary file @var{filename} with the contents of the
-flash @var{num} starting at @var{offset}. Fails if the contents do not match.
+flash bank @var{num} starting at @var{offset}. If @var{offset} is omitted,
+start at the beginning of the flash bank. Fail if the contents do not match.
 The @var{num} parameter is a value shown by @command{flash banks}.
 @end deffn
 

diff --git a/src/flash/nor/tcl.c b/src/flash/nor/tcl.c
index 3619e2fb085702863c09933bf3267c3523856184..b93d12694b0edc4d4e6a95c92877f5f8b77da376 100644 (file)
--- a/src/flash/nor/tcl.c
+++ b/src/flash/nor/tcl.c
@@ -707,7 +707,7 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
        size_t filesize;
        int differ;
 
-       if (CMD_ARGC != 3)
+       if (CMD_ARGC < 2 || CMD_ARGC > 3)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        struct duration bench;
@@ -718,7 +718,16 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
        if (ERROR_OK != retval)
                return retval;
 
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+       offset = 0;
+
+       if (CMD_ARGC > 2)
+               COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+
+       if (offset > p->size) {
+               LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
+                       offset);
+               return ERROR_COMMAND_ARGUMENT_INVALID;
+       }
 
        retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
        if (retval != ERROR_OK) {
@@ -926,10 +935,10 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .name = "verify_bank",
                .handler = handle_flash_verify_bank_command,
                .mode = COMMAND_EXEC,
-               .usage = "bank_id filename offset",
-               .help = "Read binary data from flash bank and file, "
-                       "starting at specified byte offset from the "
-                       "beginning of the bank. Compare the contents.",
+               .usage = "bank_id filename [offset]",
+               .help = "Compare the contents of a file with the contents of the "
+                       "flash bank. Allow optional offset from beginning of the bank "
+                       "(defaults to zero).",
        },
        {
                .name = "protect",