From 18b5a88a8a6ea6cf93864d27a65b4d229a6f6fb6 Mon Sep 17 00:00:00 2001 From: oharboe Date: Tue, 28 Apr 2009 20:59:52 +0000 Subject: [PATCH] more docs on jtag_add_pathmove() git-svn-id: svn://svn.berlios.de/openocd/trunk@1558 b42882b7-edfa-0310-969c-e2dbd0fdcd60 --- src/jtag/jtag.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h index e07614639..8f0f477c2 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