aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarc Schink <openocd-dev@marcschink.de>2016-11-04 09:19:21 +0100
committerFreddie Chopin <freddie.chopin@gmail.com>2017-06-17 12:45:56 +0100
commit1725abc3c0b69660cfe3e43ee3f3dbb479821b31 (patch)
treec0122676aaf88d54d94cc873745e6b6a33ffcb31 /doc
parent7112e5f57afffb3b387283f2f6048bf45f25c840 (diff)
downloadriscv-openocd-1725abc3c0b69660cfe3e43ee3f3dbb479821b31.zip
riscv-openocd-1725abc3c0b69660cfe3e43ee3f3dbb479821b31.tar.gz
riscv-openocd-1725abc3c0b69660cfe3e43ee3f3dbb479821b31.tar.bz2
flash/nor/tcl: Make read_bank parameters optional
Make 'offset' and 'length' parameters optional, if both are omitted simply read the whole flash bank. Additionally, check if the 'offset' and 'length' arguments are out of bounds of the flash bank. Change-Id: Ib9c1b0538a2c78ebcf702e2da11468dff407f8ff Signed-off-by: Marc Schink <openocd-dev@marcschink.de> Reviewed-on: http://openocd.zylin.com/3862 Tested-by: jenkins Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 329b705..30d8aae 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -4722,9 +4722,11 @@ is omitted, start at the beginning of the flash bank.
The @var{num} parameter is a value shown by @command{flash banks}.
@end deffn
-@deffn Command {flash read_bank} num filename offset length
+@deffn Command {flash read_bank} num filename [offset [length]]
Read @var{length} bytes from the flash bank @var{num} starting at @var{offset}
-and write the contents to the binary @file{filename}.
+and write the contents to the binary @file{filename}. If @var{offset} is
+omitted, start at the beginning of the flash bank. If @var{length} is omitted,
+read the remaining bytes from the flash bank.
The @var{num} parameter is a value shown by @command{flash banks}.
@end deffn