From b4a7ff291c3636eb5f6aa224476268775aceecad Mon Sep 17 00:00:00 2001 From: Tomas Vanek Date: Fri, 20 Sep 2019 13:49:17 +0200 Subject: [PATCH] doc: emphasize the role of 'reset init' before flash commands Change-Id: I4a4061ad0fa6e5dfb1e33f01d62145ca9bf12148 Signed-off-by: Tomas Vanek Reviewed-on: http://openocd.zylin.com/5304 Tested-by: jenkins Reviewed-by: Antonio Borneo --- doc/openocd.texi | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/openocd.texi b/doc/openocd.texi index c5a926ca86..bc77469c83 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -4949,6 +4949,20 @@ flash drivers can distinguish between probing and autoprobing, but most don't bother. @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 @cindex flash erasing @cindex flash reading @@ -7503,7 +7517,7 @@ change any behavior. @chapter Flash Programming 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}. @*To simplify using the flash commands directly a jimtcl script is available that handles the programming and verify stage. -- 2.30.2