comment about slow RTCK

git-svn-id: svn://svn.berlios.de/openocd/trunk@972 b42882b7-edfa-0310-969c-e2dbd0fdcd60

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index 347777e496829aaf50a7a039377ae1420161f8f0..7fdcd7bdaf59590ca9addb958eb48a6dc0480720 100644 (file)
--- 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. */