summaryrefslogtreecommitdiff
path: root/src/jtag/jtag.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/jtag/jtag.h')
-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. */