summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Brownell <dbrownell@users.sourceforge.net>2010-03-11 09:47:47 -0800
committerDavid Brownell <dbrownell@users.sourceforge.net>2010-03-11 09:47:47 -0800
commit591e0bbab957e86c8b2c6e19420a8cd9f89993cd (patch)
tree42ad314762daeaa26afaf93636357f19a778bb59 /doc
parentedf52a6cc5314a1db34c110050090a539c8ab3ed (diff)
downloadopenocd+libswd-591e0bbab957e86c8b2c6e19420a8cd9f89993cd.tar.gz
openocd+libswd-591e0bbab957e86c8b2c6e19420a8cd9f89993cd.tar.bz2
openocd+libswd-591e0bbab957e86c8b2c6e19420a8cd9f89993cd.tar.xz
openocd+libswd-591e0bbab957e86c8b2c6e19420a8cd9f89993cd.zip
split "interface" commands from "jtag" ones
We'll need to be able to work with debug adapter interfaces (drivers) even when they're not used for JTAG ... for example, while there are multi-transport drivers which support JTAG *and* several other transports (or just one more, like SWD) there are also adapters with more limited goals (and no JTAG support at all). Start decoupling the two concepts ("debug adapter driver", "jtag") by having two command groups, which initialize separately. This will help us support OpenOCD sessions using only non-JTAG transports, in which JTAG commands should not be registered. Update docs to mention that the JTAG, SVF, and XSVF commands won't work without a JTAG transport. Note that at least commands working with SRST are still inappropriately coupled to JTAG ... inappropriate because (a) SRST is not part of the JTAG standard, for all that many platforms (like ARM) expect it; and also (b) because they're used with non-JTAG debug and programming interfaces, too. They should perhaps become generic "interface" operations at some point. (Similarly with the clock rate to be used by a given adapter.) Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index f9f9b68e..33c442f6 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -6641,6 +6641,8 @@ the order of TAP state transitions.
If you're not debugging OpenOCD internals, or bringing up a
new JTAG adapter or a new type of TAP device (like a CPU or
JTAG router), you probably won't need to use these commands.
+In a debug session that doesn't use JTAG for its transport protocol,
+these commands are not available.
@deffn Command {drscan} tap [numbits value]+ [@option{-endstate} tap_state]
Loads the data register of @var{tap} with a series of bit fields
@@ -6831,6 +6833,7 @@ OpenOCD also includes some boundary scan commands.
The Serial Vector Format, better known as @dfn{SVF}, is a
way to represent JTAG test patterns in text files.
+In a debug session using JTAG for its transport protocol,
OpenOCD supports running such test files.
@deffn Command {svf} filename [@option{quiet}]
@@ -6847,6 +6850,7 @@ each command is logged before it is executed.
The Xilinx Serial Vector Format, better known as @dfn{XSVF}, is a
binary representation of SVF which is optimized for use with
Xilinx devices.
+In a debug session using JTAG for its transport protocol,
OpenOCD supports running such test files.
@quotation Important