From: Tim 'mithro' Ansell <mithro@mithis.com>
Date: Sun, 27 Sep 2015 10:33:59 +0000 (+1000)
Subject: tcl: Setting lowlevel driver for ixo-usb-jtag
X-Git-Tag: v0.10.0-rc1~434
X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=refs%2Fchanges%2F61%2F2961%2F7;hp=d52070c8552617b8631f80c117f43686f76e7c52

tcl: Setting lowlevel driver for ixo-usb-jtag

Also add further documentation about the project and how to use it.

Change-Id: Ia9878de566b3c8c1ea29f129287d5aea904d861d
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
Reviewed-on: http://openocd.zylin.com/2961
Tested-by: jenkins
Reviewed-by: Paul Fertser <fercerpav@gmail.com>
---

diff --git a/tcl/interface/usb-jtag.cfg b/tcl/interface/usb-jtag.cfg
index f0164cafd7..15274d529d 100644
--- a/tcl/interface/usb-jtag.cfg
+++ b/tcl/interface/usb-jtag.cfg
@@ -1,9 +1,37 @@
+# ixo-usb-jtag - Emulation of a Altera Bus Blaster I on a Cypress FX2 IC.
 #
-# Kolja Waschk's USB-JTAG
+# The ixo-usb-jtag firmware can be loaded onto a bunch of different hardware
+# including;
+#  * Xilinx USB Platform Cable
+#  * Many Digilent boards such as the Nexys, Nexys 2 and Atlys boards
+#  * Many fpga4fun.com boards from such as the Saxo and Xylo boards
+#  * The Numato Opsis
 #
-# http://www.ixo.de/info/usb_jtag/
+# Original version - http://www.ixo.de/info/usb_jtag/
+#  Updated version - http://ixo-jtag.sourceforge.net/
+#   Newest version - http://github.com/mithro/ixo-usb-jtag
 #
+# Procedure for using is;
+#  * Get the ixo-usb-jtag firmware for your hardware (or build it yourself).
+#  * Load the firmware using the fxload tool.
+#  * Use openocd.
+#
+# Unless you burn the firmware into the EEPROM on your device, power cycling
+# will require you to reload the firmware using the fxload tool. This can be
+# automated by using udev rules (which can be found in the firmware
+# repository).
+#
+# Ubuntu packages built from mithro's version (with prebuilt firmware and udev
+# rules) can be found at
+# https://launchpad.net/~timvideos/+archive/ubuntu/fpga-support
+#
+# TODO: Refactor the usb_blaster driver to allow loading firmware using any low
+# level driver. Loading firmware is currently only supported on the ublast2
+# driver but ixo-usb-jtag requires the ftdi or ftd2xx driver.
 
 interface usb_blaster
 usb_blaster_vid_pid 0x16C0 0x06AD
-usb_blaster_device_desc "USB-JTAG-IF"
+usb_blaster_device_desc "Van Ooijen Technische Informatica"
+# ixo-usb-jtag is only compatible with the ublast1 protocol implemented via the
+# ftdi or ftd2xx modes, using ublast2 will cause openocd to hang.
+usb_blaster_lowlevel_driver ftdi