[Openocd-svn] r1558 - trunk/src/jtag

[<oh...@ma...>]

Author: oharboe
Date: 2009-04-28 22:59:52 +0200 (Tue, 28 Apr 2009)
New Revision: 1558

Modified:
   trunk/src/jtag/jtag.h
Log:
more docs on jtag_add_pathmove()

Modified: trunk/src/jtag/jtag.h
===================================================================
--- trunk/src/jtag/jtag.h	2009-04-28 19:02:29 UTC (rev 1557)
+++ trunk/src/jtag/jtag.h	2009-04-28 20:59:52 UTC (rev 1558)
@@ -575,7 +575,18 @@
 extern void jtag_add_tlr(void);
 extern int  interface_jtag_add_tlr(void);
 
-/* Do not use jtag_add_pathmove() unless you need to, but do use it
+/* Application code *must* assume that interfaces will
+ * implement transitions between states with different
+ * paths and path lengths through the state diagram. The
+ * path will vary across interface and also across versions
+ * of the same interface over time. Even if the OpenOCD code
+ * is unchanged, the actual path taken may vary over time
+ * and versions of interface firmware or PCB revisions.
+ * 
+ * Use jtag_add_pathmove() when specific transition sequences
+ * are required.
+ * 
+ * Do not use jtag_add_pathmove() unless you need to, but do use it
  * if you have to.
  *
  * DANGER! If the target is dependent upon a particular sequence