1 /***************************************************************************
2 * Driver for USB-JTAG, Altera USB-Blaster and compatibles *
3 * Original code from Kolja Waschk's USB-JTAG project *
4 * (http://www.ixo.de/info/usb_jtag/). *
5 * Some updates by Anthony Liu (2006). *
6 * Minor updates and cleanup by Catalin Patulea (2009). *
7 * Speed updates by Ali Lown (2011). *
9 * Copyright (C) 2011 Ali Lown *
12 * Copyright (C) 2009 Catalin Patulea *
13 * cat@vv.carleton.ca *
15 * Copyright (C) 2006 Kolja Waschk *
18 * Based on ft2232.c and bitbang.c, *
19 * Copyright (C) 2004,2006 by Dominic Rath *
21 * This program is free software; you can redistribute it and/or modify *
22 * it under the terms of the GNU General Public License as published by *
23 * the Free Software Foundation; either version 2 of the License, or *
24 * (at your option) any later version. *
26 * This program is distributed in the hope that it will be useful, *
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
29 * GNU General Public License for more details. *
31 * You should have received a copy of the GNU General Public License *
32 * along with this program; if not, write to the *
33 * Free Software Foundation, Inc., *
34 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
35 ***************************************************************************/
38 * The following information is originally from Kolja Waschk's USB-JTAG,
39 * where it was obtained by reverse engineering an Altera USB-Blaster.
40 * See http://www.ixo.de/info/usb_jtag/ for USB-Blaster block diagram and
41 * usb_jtag-20080705-1200.zip#usb_jtag/host/openocd for protocol.
43 * The same information is also on the UrJTAG mediawiki, with some additional
44 * notes on bits marked as "unknown" by usb_jtag.
45 * (http://sourceforge.net/apps/mediawiki/urjtag/index.php?
46 * title=Cable_Altera_USB-Blaster)
48 * USB-JTAG, Altera USB-Blaster and compatibles are typically implemented as
49 * an FTDIChip FT245 followed by a CPLD which handles a two-mode protocol:
55 * __|__________ _________
57 * USB__| FTDI 245BM |__| EPM7064 |__JTAG (B_TDO,B_TDI,B_TMS,B_TCK)
58 * |_____________| |_________|
59 * __|__________ _|___________
61 * | 6 MHz XTAL | | 24 MHz Osc. |
62 * |_____________| |_____________|
64 * Protocol details are given in the code below.
66 * It is also possible to emulate this configuration using a single-chip USB
67 * controller like the Cypress FX2 (again, see usb_jtag for details).
78 /* project specific includes */
79 #include <jtag/interface.h>
80 #include <jtag/commands.h>
81 #include <helper/time_support.h>
90 #if (BUILD_USB_BLASTER_FTD2XX == 1 && BUILD_USB_BLASTER_LIBFTDI == 1)
91 #error "BUILD_USB_BLASTER_FTD2XX && BUILD_USB_BLASTER_LIBFTDI "
92 "are mutually exclusive"
93 #elif (BUILD_USB_BLASTER_FTD2XX != 1 && BUILD_USB_BLASTER_LIBFTDI != 1)
94 #error "BUILD_USB_BLASTER_FTD2XX || BUILD_USB_BLASTER_LIBFTDI must be chosen"
97 /* USB_BLASTER access library includes */
98 #if BUILD_USB_BLASTER_FTD2XX == 1
100 #include "ftd2xx_common.h"
101 #elif BUILD_USB_BLASTER_LIBFTDI == 1
105 #include <sys/time.h>
108 static char *usb_blaster_device_desc
;
109 static uint16_t usb_blaster_vid
= 0x09fb; /* Altera */
110 static uint16_t usb_blaster_pid
= 0x6001; /* USB-Blaster */
112 /* last output byte in simple bit banging (legacy) mode */
113 static uint8_t out_value
;
114 /* global output buffer for bit banging */
115 #define BUF_LEN 64 /* Size of EP1 */
116 static uint8_t out_buffer
[BUF_LEN
];
117 static uint16_t out_count
;
119 #if BUILD_USB_BLASTER_FTD2XX == 1
120 static FT_HANDLE ftdih
;
121 #elif BUILD_USB_BLASTER_LIBFTDI == 1
122 static struct ftdi_context ftdic
;
125 static int usb_blaster_buf_write(
126 uint8_t *buf
, int size
, uint32_t *bytes_written
)
128 #if BUILD_USB_BLASTER_FTD2XX == 1
130 DWORD dw_bytes_written
;
132 #ifdef _DEBUG_JTAG_IO_
133 LOG_DEBUG("usb_blaster_buf_write %02X (%d)", buf
[0], size
);
135 status
= FT_Write(ftdih
, buf
, size
, &dw_bytes_written
);
136 if (status
!= FT_OK
) {
137 *bytes_written
= dw_bytes_written
;
138 LOG_ERROR("FT_Write returned: %s", ftd2xx_status_string(status
));
139 return ERROR_JTAG_DEVICE_ERROR
;
141 *bytes_written
= dw_bytes_written
;
143 #elif BUILD_USB_BLASTER_LIBFTDI == 1
145 #ifdef _DEBUG_JTAG_IO_
146 LOG_DEBUG("usb_blaster_buf_write %02X (%d)", buf
[0], size
);
148 retval
= ftdi_write_data(&ftdic
, buf
, size
);
151 LOG_ERROR("ftdi_write_data: %s", ftdi_get_error_string(&ftdic
));
152 return ERROR_JTAG_DEVICE_ERROR
;
154 *bytes_written
= retval
;
159 static int usb_blaster_buf_read(uint8_t *buf
, unsigned size
, uint32_t *bytes_read
)
161 #if BUILD_USB_BLASTER_FTD2XX == 1
165 status
= FT_Read(ftdih
, buf
, size
, &dw_bytes_read
);
166 if (status
!= FT_OK
) {
167 *bytes_read
= dw_bytes_read
;
168 LOG_ERROR("FT_Read returned: %s", ftd2xx_status_string(status
));
169 return ERROR_JTAG_DEVICE_ERROR
;
171 #ifdef _DEBUG_JTAG_IO_
172 LOG_DEBUG("usb_blaster_buf_read %02X (%" PRIu32
")", buf
[0], dw_bytes_read
);
174 *bytes_read
= dw_bytes_read
;
177 #elif BUILD_USB_BLASTER_LIBFTDI == 1
182 while ((*bytes_read
< size
) && timeout
--) {
183 retval
= ftdi_read_data(&ftdic
, buf
+ *bytes_read
,
187 LOG_ERROR("ftdi_read_data: %s",
188 ftdi_get_error_string(&ftdic
));
189 return ERROR_JTAG_DEVICE_ERROR
;
191 *bytes_read
+= retval
;
193 #ifdef _DEBUG_JTAG_IO_
194 LOG_DEBUG("usb_blaster_buf_read %02X (%d)", buf
[0], *bytes_read
);
200 /* The following code doesn't fully utilize the possibilities of the
201 * USB-Blaster. It only buffers data up to the maximum packet size of 64 bytes.
203 * Actually, the USB-Blaster offers a byte-shift mode to transmit up to 504 data
204 * bits (bidirectional) in a single USB packet. A header byte has to be sent as
205 * the first byte in a packet with the following meaning:
207 * Bit 7 (0x80): Must be set to indicate byte-shift mode.
208 * Bit 6 (0x40): If set, the USB-Blaster will also read data, not just write.
209 * Bit 5..0: Define the number N of following bytes
211 * All N following bytes will then be clocked out serially on TDI. If Bit 6 was
212 * set, it will afterwards return N bytes with TDO data read while clocking out
213 * the TDI data. LSB of the first byte after the header byte will appear first
217 /* Simple bit banging mode:
219 * Bit 7 (0x80): Must be zero (see byte-shift mode above)
220 * Bit 6 (0x40): If set, you will receive a byte indicating the state of TDO
222 * Bit 5 (0x20): Output Enable/LED.
223 * Bit 4 (0x10): TDI Output.
224 * Bit 3 (0x08): nCS Output (not used in JTAG mode).
225 * Bit 2 (0x04): nCE Output (not used in JTAG mode).
226 * Bit 1 (0x02): TMS Output.
227 * Bit 0 (0x01): TCK Output.
229 * For transmitting a single data bit, you need to write two bytes. Up to 64
230 * bytes can be combined in a single USB packet.
231 * It isn't possible to read a data without transmitting data.
240 #define READ (1 << 6)
241 #define SHMODE (1 << 7)
242 #define OTHERS ((1 << 2) | (1 << 3) | (1 << 5))
244 #define READ_TDO (1 << 0)
246 static void usb_blaster_write_databuffer(uint8_t *buf
, uint16_t len
)
248 uint32_t bytes_written
;
249 usb_blaster_buf_write(buf
, len
, &bytes_written
);
251 #ifdef _DEBUG_JTAG_IO_
252 LOG_DEBUG("---- WROTE %d", bytes_written
);
256 static void usb_blaster_addtowritebuffer(uint8_t value
, bool forcewrite
)
258 out_buffer
[out_count
] = value
;
260 if (out_count
== BUF_LEN
|| forcewrite
)
261 usb_blaster_write_databuffer(out_buffer
, out_count
);
264 static int usb_blaster_read_data(void)
271 usb_blaster_write_databuffer(out_buffer
, out_count
);
274 usb_blaster_addtowritebuffer(out_value
, true);
277 status
= usb_blaster_buf_read(buf
, 1, &bytes_read
);
281 return !!(buf
[0] & READ_TDO
);
284 static void usb_blaster_write(int tck
, int tms
, int tdi
)
286 #ifdef _DEBUG_JTAG_IO_
287 LOG_DEBUG("---- usb_blaster_write(%d,%d,%d)", tck
, tms
, tdi
);
289 out_value
&= ~(TCK
| TMS
| TDI
);
297 usb_blaster_addtowritebuffer(out_value
, false);
300 static int usb_blaster_speed(int speed
)
302 #if BUILD_USB_BLASTER_FTD2XX == 1
303 LOG_DEBUG("TODO: usb_blaster_speed() isn't implemented for libftd2xx!");
304 #elif BUILD_USB_BLASTER_LIBFTDI == 1
305 LOG_DEBUG("TODO: usb_blaster_speed() isn't optimally implemented!");
307 /* TODO: libftdi's ftdi_set_baudrate chokes on high rates, use lowlevel
308 * usb function instead! And additionally allow user to throttle.
310 if (ftdi_set_baudrate(&ftdic
, 3000000 / 4) < 0) {
311 LOG_ERROR("Can't set baud rate to max: %s",
312 ftdi_get_error_string(&ftdic
));
313 return ERROR_JTAG_DEVICE_ERROR
;
321 static void usb_blaster_reset(int trst
, int srst
)
323 LOG_DEBUG("TODO: usb_blaster_reset(%d,%d) isn't implemented!",
327 static void usb_blaster_blink(int state
)
333 usb_blaster_addtowritebuffer(out_value
, true);
336 static struct bitbang_interface usb_blaster_bitbang
= {
337 .read
= usb_blaster_read_data
,
338 .write
= usb_blaster_write
,
339 .reset
= usb_blaster_reset
,
340 .blink
= usb_blaster_blink
,
343 static int usb_blaster_init(void)
345 uint8_t latency_timer
;
347 #if BUILD_USB_BLASTER_FTD2XX == 1
351 #if BUILD_USB_BLASTER_FTD2XX == 1
352 LOG_DEBUG("'usb_blaster' interface using FTD2XX");
353 #elif BUILD_USB_BLASTER_LIBFTDI == 1
354 LOG_DEBUG("'usb_blaster' interface using libftdi");
357 #if BUILD_USB_BLASTER_FTD2XX == 1
358 /* Open by device description */
359 if (usb_blaster_device_desc
== NULL
) {
360 LOG_WARNING("no usb_blaster device description specified, "
361 "using default 'USB-Blaster'");
362 usb_blaster_device_desc
= "USB-Blaster";
366 /* Add non-standard Vid/Pid to the linux driver */
367 status
= FT_SetVIDPID(usb_blaster_vid
, usb_blaster_pid
);
368 if (status
!= FT_OK
) {
369 LOG_WARNING("couldn't add %4.4x:%4.4x",
370 usb_blaster_vid
, usb_blaster_pid
);
374 status
= FT_OpenEx(usb_blaster_device_desc
, FT_OPEN_BY_DESCRIPTION
,
376 if (status
!= FT_OK
) {
379 LOG_ERROR("unable to open ftdi device: %s",
380 ftd2xx_status_string(status
));
381 status
= FT_ListDevices(&num_devices
, NULL
,
382 FT_LIST_NUMBER_ONLY
);
383 if (status
== FT_OK
) {
384 char **desc_array
= malloc(sizeof(char *)
385 * (num_devices
+ 1));
388 for (i
= 0; i
< num_devices
; i
++)
389 desc_array
[i
] = malloc(64);
390 desc_array
[num_devices
] = NULL
;
392 status
= FT_ListDevices(desc_array
, &num_devices
,
393 FT_LIST_ALL
| FT_OPEN_BY_DESCRIPTION
);
395 if (status
== FT_OK
) {
396 LOG_ERROR("ListDevices: %" PRIu32
, (uint32_t)num_devices
);
397 for (i
= 0; i
< num_devices
; i
++)
398 LOG_ERROR("%i: %s", i
, desc_array
[i
]);
401 for (i
= 0; i
< num_devices
; i
++)
405 printf("ListDevices: NONE\n");
406 return ERROR_JTAG_INIT_FAILED
;
409 status
= FT_SetLatencyTimer(ftdih
, 2);
410 if (status
!= FT_OK
) {
411 LOG_ERROR("unable to set latency timer: %s",
412 ftd2xx_status_string(status
));
413 return ERROR_JTAG_INIT_FAILED
;
416 status
= FT_GetLatencyTimer(ftdih
, &latency_timer
);
417 if (status
!= FT_OK
) {
418 LOG_ERROR("unable to get latency timer: %s",
419 ftd2xx_status_string(status
));
420 return ERROR_JTAG_INIT_FAILED
;
422 LOG_DEBUG("current latency timer: %i", latency_timer
);
424 status
= FT_SetBitMode(ftdih
, 0x00, 0);
425 if (status
!= FT_OK
) {
426 LOG_ERROR("unable to disable bit i/o mode: %s",
427 ftd2xx_status_string(status
));
428 return ERROR_JTAG_INIT_FAILED
;
430 #elif BUILD_USB_BLASTER_LIBFTDI == 1
431 if (ftdi_init(&ftdic
) < 0)
432 return ERROR_JTAG_INIT_FAILED
;
434 /* context, vendor id, product id */
435 if (ftdi_usb_open(&ftdic
, usb_blaster_vid
, usb_blaster_pid
) < 0) {
436 LOG_ERROR("unable to open ftdi device: %s", ftdic
.error_str
);
437 return ERROR_JTAG_INIT_FAILED
;
440 if (ftdi_usb_reset(&ftdic
) < 0) {
441 LOG_ERROR("unable to reset ftdi device");
442 return ERROR_JTAG_INIT_FAILED
;
445 if (ftdi_set_latency_timer(&ftdic
, 2) < 0) {
446 LOG_ERROR("unable to set latency timer");
447 return ERROR_JTAG_INIT_FAILED
;
450 if (ftdi_get_latency_timer(&ftdic
, &latency_timer
) < 0) {
451 LOG_ERROR("unable to get latency timer");
452 return ERROR_JTAG_INIT_FAILED
;
454 LOG_DEBUG("current latency timer: %u", latency_timer
);
456 ftdi_disable_bitbang(&ftdic
);
459 bitbang_interface
= &usb_blaster_bitbang
;
462 #if BUILD_USB_BLASTER_FTD2XX == 1
463 status
= FT_Purge(ftdih
, FT_PURGE_RX
| FT_PURGE_TX
);
464 if (status
!= FT_OK
) {
465 LOG_ERROR("error purging ftd2xx device: %i", status
);
466 return ERROR_JTAG_INIT_FAILED
;
468 #elif BUILD_USB_BLASTER_LIBFTDI == 1
469 if (ftdi_usb_purge_buffers(&ftdic
) < 0) {
470 LOG_ERROR("ftdi_purge_buffers: %s", ftdic
.error_str
);
471 return ERROR_JTAG_INIT_FAILED
;
479 static int usb_blaster_quit(void)
482 usb_blaster_write_databuffer(out_buffer
, out_count
);
484 #if BUILD_USB_BLASTER_FTD2XX == 1
487 status
= FT_Close(ftdih
);
488 #elif BUILD_USB_BLASTER_LIBFTDI == 1
489 ftdi_usb_close(&ftdic
);
496 COMMAND_HANDLER(usb_blaster_handle_device_desc_command
)
499 usb_blaster_device_desc
= strdup(CMD_ARGV
[0]);
501 LOG_ERROR("require exactly one argument to "
502 "usb_blaster_device_desc <description>");
507 COMMAND_HANDLER(usb_blaster_handle_vid_pid_command
)
510 LOG_WARNING("ignoring extra IDs in usb_blaster_vid_pid "
511 "(maximum is 1 pair)");
515 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], usb_blaster_vid
);
516 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[1], usb_blaster_pid
);
518 LOG_WARNING("incomplete usb_blaster_vid_pid configuration");
523 COMMAND_HANDLER(usb_blaster_handle_pin_command
)
526 const char *const pin_name
= CMD_ARGV
[0];
530 if (!strcmp(pin_name
, "pin6"))
532 else if (!strcmp(pin_name
, "pin8"))
535 LOG_ERROR("%s: pin name must be \"pin6\" or \"pin8\"",
537 return ERROR_COMMAND_SYNTAX_ERROR
;
540 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[1], state
);
543 usb_blaster_addtowritebuffer(out_value
, true);
544 } else if (state
== 1) {
546 usb_blaster_addtowritebuffer(out_value
, true);
548 LOG_ERROR("%s: pin state must be 0 or 1", CMD_NAME
);
549 return ERROR_COMMAND_SYNTAX_ERROR
;
554 LOG_ERROR("%s takes exactly two arguments", CMD_NAME
);
555 return ERROR_COMMAND_SYNTAX_ERROR
;
559 static const struct command_registration usb_blaster_command_handlers
[] = {
561 .name
= "usb_blaster_device_desc",
562 .handler
= usb_blaster_handle_device_desc_command
,
563 .mode
= COMMAND_CONFIG
,
564 .help
= "set the USB device description of the USB-Blaster",
565 .usage
= "description-string",
568 .name
= "usb_blaster_vid_pid",
569 .handler
= usb_blaster_handle_vid_pid_command
,
570 .mode
= COMMAND_CONFIG
,
571 .help
= "the vendor ID and product ID of the USB-Blaster",
575 .name
= "usb_blaster",
576 .handler
= usb_blaster_handle_pin_command
,
578 .help
= "set pin state for the unused GPIO pins",
579 .usage
= "(pin6|pin8) (0|1)",
581 COMMAND_REGISTRATION_DONE
584 struct jtag_interface usb_blaster_interface
= {
585 .name
= "usb_blaster",
586 .commands
= usb_blaster_command_handlers
,
587 .supported
= DEBUG_CAP_TMS_SEQ
,
589 .execute_queue
= bitbang_execute_queue
,
591 .speed
= usb_blaster_speed
,
592 .init
= usb_blaster_init
,
593 .quit
= usb_blaster_quit
,