summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoroharboe <oharboe@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-04-28 20:59:52 +0000
committeroharboe <oharboe@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-04-28 20:59:52 +0000
commit18b5a88a8a6ea6cf93864d27a65b4d229a6f6fb6 (patch)
tree34f03bdcf830ec5ccf25be0768e7be45d17bae1c
parentabeee8b4c237914a87921f2e3aa733b9fc699908 (diff)
downloadopenocd+libswd-18b5a88a8a6ea6cf93864d27a65b4d229a6f6fb6.tar.gz
openocd+libswd-18b5a88a8a6ea6cf93864d27a65b4d229a6f6fb6.tar.bz2
openocd+libswd-18b5a88a8a6ea6cf93864d27a65b4d229a6f6fb6.tar.xz
openocd+libswd-18b5a88a8a6ea6cf93864d27a65b4d229a6f6fb6.zip
more docs on jtag_add_pathmove()
git-svn-id: svn://svn.berlios.de/openocd/trunk@1558 b42882b7-edfa-0310-969c-e2dbd0fdcd60
-rw-r--r--src/jtag/jtag.h13
1 files changed, 12 insertions, 1 deletions
diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index e0761463..8f0f477c 100644
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -575,7 +575,18 @@ extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t* field
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