summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Brownell <dbrownell@users.sourceforge.net>2009-10-20 20:04:36 -0700
committerDavid Brownell <dbrownell@users.sourceforge.net>2009-10-20 20:04:36 -0700
commit7556a93aed97c3fad2c0a904a115168cd3dd61a8 (patch)
tree9ec8b3587676945e34181671fdbb4b8eb0c70344 /doc
parenta1609e5ad1b8df67f216d2f7c43db82c420db373 (diff)
downloadopenocd+libswd-7556a93aed97c3fad2c0a904a115168cd3dd61a8.tar.gz
openocd+libswd-7556a93aed97c3fad2c0a904a115168cd3dd61a8.tar.bz2
openocd+libswd-7556a93aed97c3fad2c0a904a115168cd3dd61a8.tar.xz
openocd+libswd-7556a93aed97c3fad2c0a904a115168cd3dd61a8.zip
XSVF: use svf_add_statemove()
XSVF improvements: - Layer parts of XSVF directly over SVF, calling svf_add_statemove() instead of expecting jtag_add_statemove() to conform to the SVF/XSVF requirements (which it doesn't). This should improve XSTATE handling a lot; it removes most users of jtag_add_statemove(), and the comments about how it should really do what svf_add_statemove() does. - Update XSTATE logic to be a closer match to the XSVF spec. The main open issue here is (still) that this implementation doesn't know how to build and submit paths from single-state transitions ... but now it will report that error case. - Update the User's Guide to mention the two utility scripts for working with XSVF, and to mention the five extension opcodes. Handling of state transition paths is, overall, still a mess. I think they should all be specified as paths not unlike SVF uses, and compiled to the bitstrings later ... so that we can actually make sense of the paths. (And see the extra clocks, detours through RUN, etc.) Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi27
1 files changed, 25 insertions, 2 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 107441d2..500faf9a 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -6096,6 +6096,8 @@ with handlers for that event.
@deffn Command {pathmove} start_state [next_state ...]
Start by moving to @var{start_state}, which
must be one of the @emph{stable} states.
+Unless it is the only state given, this will often be the
+current state, so that no TCK transitions are needed.
Then, in a series of single state transitions
(conforming to the JTAG state machine) shift to
each @var{next_state} in sequence, one per TCK cycle.
@@ -6130,8 +6132,8 @@ Default is enabled.
The @var{tap_state} names used by OpenOCD in the @command{drscan},
@command{irscan}, and @command{pathmove} commands are the same
-as those used in SVF boundary scan documents, except that some
-versions of SVF use @sc{idle} instead of @sc{run/idle}.
+as those used in SVF boundary scan documents, except that
+SVF uses @sc{idle} instead of @sc{run/idle}.
@itemize @bullet
@item @b{RESET} ... @emph{stable} (with TMS high);
@@ -6222,6 +6224,27 @@ Unless the @option{quiet} option is specified,
messages are logged for comments and some retries.
@end deffn
+The OpenOCD sources also include two utility scripts
+for working with XSVF; they are not currently installed
+after building the software.
+You may find them useful:
+
+@itemize
+@item @emph{svf2xsvf} ... converts SVF files into the extended XSVF
+syntax understood by the @command{xsvf} command; see notes below.
+@item @emph{xsvfdump} ... converts XSVF files into a text output format;
+understands the OpenOCD extensions.
+@end itemize
+
+The input format accepts a handful of non-standard extensions.
+These include three opcodes corresponding to SVF extensions
+from Lattice Semiconductor (LCOUNT, LDELAY, LDSR), and
+two opcodes supporting a more accurate translation of SVF
+(XTRST, XWAITSTATE).
+If @emph{xsvfdump} shows a file is using those opcodes, it
+probably will not be usable with other XSVF tools.
+
+
@node TFTP
@chapter TFTP
@cindex TFTP