interesting
/
riscv-openocd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: emphasize the role of 'reset init' before flash commands 

Change-Id: I4a4061ad0fa6e5dfb1e33f01d62145ca9bf12148
Signed-off-by: Tomas Vanek <vanekt@fbl.cz>
Reviewed-on: http://openocd.zylin.com/5304
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
This commit is contained in:
Tomas Vanek 2019-09-20 13:49:17 +02:00 committed by Spencer Oliver
parent 462c012066
commit b4a7ff291c
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/openocd.texi
View File

@ -4949,6 +4949,20 @@ flash drivers can distinguish between probing and autoprobing,
but most don't bother. but most don't bother.
@end deffn @end deffn
@section Preparing a Target before Flash Programming
The target device should be in well defined state before the flash programming
begins.
@emph{Always issue} @command{reset init} before @ref{flashprogrammingcommands,,Flash Programming Commands}.
Do not issue another @command{reset} or @command{reset halt} or @command{resume}
until the programming session is finished.
If you use @ref{programmingusinggdb,,Programming using GDB},
the target is prepared automatically in the event gdb-flash-erase-start
The jimtcl script @command{program} calls @command{reset init} explicitly.
@section Erasing, Reading, Writing to Flash @section Erasing, Reading, Writing to Flash
@cindex flash erasing @cindex flash erasing
@cindex flash reading @cindex flash reading
@ -7503,7 +7517,7 @@ change any behavior.
@chapter Flash Programming @chapter Flash Programming
OpenOCD implements numerous ways to program the target flash, whether internal or external. OpenOCD implements numerous ways to program the target flash, whether internal or external.
Programming can be achieved by either using GDB @ref{programmingusinggdb,,Programming using GDB}, Programming can be achieved by either using @ref{programmingusinggdb,,Programming using GDB},
or using the commands given in @ref{flashprogrammingcommands,,Flash Programming Commands}. or using the commands given in @ref{flashprogrammingcommands,,Flash Programming Commands}.
@*To simplify using the flash commands directly a jimtcl script is available that handles the programming and verify stage. @*To simplify using the flash commands directly a jimtcl script is available that handles the programming and verify stage.