JTAG_TRST_ASSERTED event cleanup. More clear where and when it is invoked and some duplicate(harmless) invocations avoided.

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

1 files changed, 11 insertions, 0 deletions

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index 04eefaad..5fbe7dc1 100644
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -218,6 +218,17 @@ enum reset_line_mode {
 	LINE_PUSH_PULL  = 0x1,
 };
 
+/* 
+ * There are three cases when JTAG_TRST_ASSERTED callback is invoked. The
+ * event is invoked *after* TRST is asserted(or queued rather). It is illegal 
+ * to communicate with the JTAG interface during the callback(as there is 
+ * currently a queue being built).
+ * 
+ * - TMS reset
+ * - SRST pulls TRST
+ * - TRST asserted
+ * 
+ **/
 enum jtag_event {
 	JTAG_TRST_ASSERTED
 };