From: David Brownell <dbrownell@users.sourceforge.net>
Date: Mon, 19 Oct 2009 21:45:43 +0000 (-0700)
Subject: Doc: jtag_init must validate scan chain too
X-Git-Tag: v0.3.0-rc0~67
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=6ec1026bbb83f626484e4fd4b61aa1f7d864dbc7;p=openocd

Doc: jtag_init must validate scan chain too

Same requirement as like init_reset, and for the same reason:
we need to start with a known and working state.
---

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 6d33d56a..7ebe4578 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -1573,6 +1573,11 @@ which uses only a lightweight JTAG reset before examining the
 scan chain.
 If that fails, it tries again, using a harder reset
 from the overridable procedure @command{init_reset}.
+
+Implementations must have verified the JTAG scan chain before
+they return.
+This is done by calling @command{jtag arp_init}
+(or @command{jtag arp_init-reset}).
 @end deffn
 
 @anchor{TCP/IP Ports}