summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPaul Fertser <fercerpav@gmail.com>2015-01-23 11:38:31 +0300
committerAndreas Fritiofson <andreas.fritiofson@gmail.com>2015-02-11 22:19:37 +0000
commit30f802493d1237eeef21282d4224ed89d8a4d480 (patch)
treed7a98671bbd2581393a3766b67cc32966212f489 /doc
parenta35712a85c420e24a9c7e9a5eea4fc6d3aff6342 (diff)
downloadopenocd-30f802493d1237eeef21282d4224ed89d8a4d480.tar.gz
openocd-30f802493d1237eeef21282d4224ed89d8a4d480.tar.xz
flash/startup: extend "program" command to accept "exit"
This optional argument tells OpenOCD to exit after finishing (either succesfully, or with an error) the programming sequence. Without it OpenOCD stays running. Change-Id: I6ecaf33ff985eea9a9cd02ff644a74403ae3e1e5 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/2492 Tested-by: jenkins Reviewed-by: Uwe Bonnes <bon@elektron.ikp.physik.tu-darmstadt.de> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index ce681a38..e884be47 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -4922,7 +4922,7 @@ comamnd or the flash driver then it defaults to 0xff.
@end deffn
@anchor{program}
-@deffn Command {program} filename [verify] [reset] [offset]
+@deffn Command {program} filename [verify] [reset] [exit] [offset]
This is a helper script that simplifies using OpenOCD as a standalone
programmer. The only required parameter is @option{filename}, the others are optional.
@xref{Flash Programming}.
@@ -5928,7 +5928,7 @@ Programming can be acheived by either using GDB @ref{programmingusinggdb,,Progra
or using the cmds given in @ref{flashprogrammingcommands,,Flash Programming Commands}.
@*To simplify using the flash cmds directly a jimtcl script is available that handles the programming and verify stage.
-OpenOCD will program/verify/reset the target and shutdown.
+OpenOCD will program/verify/reset the target and optionally shutdown.
The script is executed as follows and by default the following actions will be peformed.
@enumerate
@@ -5937,7 +5937,7 @@ The script is executed as follows and by default the following actions will be p
@item @code{flash write_image} is called to erase and write any flash using the filename given.
@item @code{verify_image} is called if @option{verify} parameter is given.
@item @code{reset run} is called if @option{reset} parameter is given.
-@item OpenOCD is shutdown.
+@item OpenOCD is shutdown if @option{exit} parameter is given.
@end enumerate
An example of usage is given below. @xref{program}.
@@ -5946,11 +5946,11 @@ An example of usage is given below. @xref{program}.
# program and verify using elf/hex/s19. verify and reset
# are optional parameters
openocd -f board/stm32f3discovery.cfg \
- -c "program filename.elf verify reset"
+ -c "program filename.elf verify reset exit"
# binary files need the flash address passing
openocd -f board/stm32f3discovery.cfg \
- -c "program filename.bin 0x08000000"
+ -c "program filename.bin exit 0x08000000"
@end example
@node NAND Flash Commands