summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoroharboe <oharboe@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2008-08-27 06:05:27 +0000
committeroharboe <oharboe@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2008-08-27 06:05:27 +0000
commita5cbe5bd85aad2341f62d7fcdb7691da290b0a38 (patch)
treed8612952c89df7c7509e2bc89286c09663cf0e2d
parent113436df6fa0f8638e03b9f63588ce8504290f63 (diff)
downloadopenocd+libswd-a5cbe5bd85aad2341f62d7fcdb7691da290b0a38.tar.gz
openocd+libswd-a5cbe5bd85aad2341f62d7fcdb7691da290b0a38.tar.bz2
openocd+libswd-a5cbe5bd85aad2341f62d7fcdb7691da290b0a38.tar.xz
openocd+libswd-a5cbe5bd85aad2341f62d7fcdb7691da290b0a38.zip
comment about slow RTCK
git-svn-id: svn://svn.berlios.de/openocd/trunk@972 b42882b7-edfa-0310-969c-e2dbd0fdcd60
-rw-r--r--src/jtag/jtag.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index 347777e4..7fdcd7bd 100644
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -199,7 +199,13 @@ typedef struct jtag_interface_s
int (*init)(void);
int (*quit)(void);
/* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
- a failure if it can't support the KHz/RTCK. */
+ a failure if it can't support the KHz/RTCK.
+
+ WARNING!!!! if RTCK is *slow* then think carefully about
+ whether you actually want to support this in the driver.
+ Many target scripts are written to handle the absence of RTCK
+ and use a fallback kHz TCK.
+ */
int (*khz)(int khz, int *jtag_speed);
/* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns
a failure if it can't support the KHz/RTCK. */