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 #elif BUILD_USB_BLASTER_LIBFTDI == 1
104 #include <sys/time.h>
107 static char *usb_blaster_device_desc
;
108 static uint16_t usb_blaster_vid
= 0x09fb; /* Altera */
109 static uint16_t usb_blaster_pid
= 0x6001; /* USB-Blaster */
111 /* last output byte in simple bit banging (legacy) mode */
112 static uint8_t out_value
;
113 /* global output buffer for bit banging */
114 #define BUF_LEN 64 //Size of EP1
115 static uint8_t out_buffer
[BUF_LEN
];
116 static uint16_t out_count
= 0;
118 #if BUILD_USB_BLASTER_FTD2XX == 1
119 static FT_HANDLE ftdih
;
120 #elif BUILD_USB_BLASTER_LIBFTDI == 1
121 static struct ftdi_context ftdic
;
124 static int usb_blaster_buf_write(
125 uint8_t *buf
, int size
, uint32_t *bytes_written
)
127 #if BUILD_USB_BLASTER_FTD2XX == 1
129 DWORD dw_bytes_written
;
131 #ifdef _DEBUG_JTAG_IO_
132 LOG_DEBUG("usb_blaster_buf_write %02X (%d)", buf
[0], size
);
134 status
= FT_Write(ftdih
, buf
, size
, &dw_bytes_written
);
137 *bytes_written
= dw_bytes_written
;
138 LOG_ERROR("FT_Write returned: %lu", 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
);
152 LOG_ERROR("ftdi_write_data: %s", ftdi_get_error_string(&ftdic
));
153 return ERROR_JTAG_DEVICE_ERROR
;
155 *bytes_written
= retval
;
161 usb_blaster_buf_read(uint8_t *buf
, unsigned size
, uint32_t *bytes_read
)
163 #if BUILD_USB_BLASTER_FTD2XX == 1
167 status
= FT_Read(ftdih
, buf
, size
, &dw_bytes_read
);
170 *bytes_read
= dw_bytes_read
;
171 LOG_ERROR("FT_Read returned: %lu", status
);
172 return ERROR_JTAG_DEVICE_ERROR
;
174 #ifdef _DEBUG_JTAG_IO_
175 LOG_DEBUG("usb_blaster_buf_read %02X (%lu)", buf
[0], dw_bytes_read
);
177 *bytes_read
= dw_bytes_read
;
180 #elif BUILD_USB_BLASTER_LIBFTDI == 1
185 while ((*bytes_read
< size
) && timeout
--)
187 retval
= ftdi_read_data(&ftdic
, buf
+ *bytes_read
,
192 LOG_ERROR("ftdi_read_data: %s",
193 ftdi_get_error_string(&ftdic
));
194 return ERROR_JTAG_DEVICE_ERROR
;
196 *bytes_read
+= retval
;
198 #ifdef _DEBUG_JTAG_IO_
199 LOG_DEBUG("usb_blaster_buf_read %02X (%d)", buf
[0], *bytes_read
);
205 /* The following code doesn't fully utilize the possibilities of the
206 * USB-Blaster. It only buffers data up to the maximum packet size of 64 bytes.
208 * Actually, the USB-Blaster offers a byte-shift mode to transmit up to 504 data
209 * bits (bidirectional) in a single USB packet. A header byte has to be sent as
210 * the first byte in a packet with the following meaning:
212 * Bit 7 (0x80): Must be set to indicate byte-shift mode.
213 * Bit 6 (0x40): If set, the USB-Blaster will also read data, not just write.
214 * Bit 5..0: Define the number N of following bytes
216 * All N following bytes will then be clocked out serially on TDI. If Bit 6 was
217 * set, it will afterwards return N bytes with TDO data read while clocking out
218 * the TDI data. LSB of the first byte after the header byte will appear first
222 /* Simple bit banging mode:
224 * Bit 7 (0x80): Must be zero (see byte-shift mode above)
225 * Bit 6 (0x40): If set, you will receive a byte indicating the state of TDO
227 * Bit 5 (0x20): Output Enable/LED.
228 * Bit 4 (0x10): TDI Output.
229 * Bit 3 (0x08): nCS Output (not used in JTAG mode).
230 * Bit 2 (0x04): nCE Output (not used in JTAG mode).
231 * Bit 1 (0x02): TMS Output.
232 * Bit 0 (0x01): TCK Output.
234 * For transmitting a single data bit, you need to write two bytes. Up to 64
235 * bytes can be combined in a single USB packet.
236 * It isn't possible to read a data without transmitting data.
245 #define READ (1 << 6)
246 #define SHMODE (1 << 7)
247 #define OTHERS ((1 << 2) | (1 << 3) | (1 << 5))
249 #define READ_TDO (1 << 0)
251 static void usb_blaster_write_databuffer(uint8_t* buf
, uint16_t len
)
253 uint32_t bytes_written
;
254 usb_blaster_buf_write(buf
, len
, &bytes_written
);
256 #ifdef _DEBUG_JTAG_IO_
257 LOG_DEBUG("---- WROTE %d",bytes_written
);
261 static void usb_blaster_addtowritebuffer(uint8_t value
, bool forcewrite
)
263 out_buffer
[out_count
] = value
;
265 if(out_count
== BUF_LEN
|| forcewrite
)
266 usb_blaster_write_databuffer(out_buffer
, out_count
);
269 static int usb_blaster_read_data(void)
276 usb_blaster_write_databuffer(out_buffer
, out_count
);
279 usb_blaster_addtowritebuffer(out_value
, true);
282 status
= usb_blaster_buf_read(buf
, 1, &bytes_read
);
286 return !!(buf
[0] & READ_TDO
);
289 static void usb_blaster_write(int tck
, int tms
, int tdi
)
291 #ifdef _DEBUG_JTAG_IO_
292 LOG_DEBUG("---- usb_blaster_write(%d,%d,%d)", tck
, tms
, tdi
);
294 out_value
&= ~(TCK
| TMS
| TDI
);
302 usb_blaster_addtowritebuffer(out_value
, false);
305 static int usb_blaster_speed(int speed
)
307 #if BUILD_USB_BLASTER_FTD2XX == 1
308 LOG_DEBUG("TODO: usb_blaster_speed() isn't implemented for libftd2xx!");
309 #elif BUILD_USB_BLASTER_LIBFTDI == 1
310 LOG_DEBUG("TODO: usb_blaster_speed() isn't optimally implemented!");
312 /* TODO: libftdi's ftdi_set_baudrate chokes on high rates, use lowlevel
313 * usb function instead! And additionally allow user to throttle.
315 if (ftdi_set_baudrate(&ftdic
, 3000000 / 4) < 0)
317 LOG_ERROR("Can't set baud rate to max: %s",
318 ftdi_get_error_string(&ftdic
));
319 return ERROR_JTAG_DEVICE_ERROR
;
326 static void usb_blaster_reset(int trst
, int srst
)
328 LOG_DEBUG("TODO: usb_blaster_reset(%d,%d) isn't implemented!",
332 static void usb_blaster_blink(int state
)
338 usb_blaster_addtowritebuffer(out_value
, true);
341 static struct bitbang_interface usb_blaster_bitbang
= {
342 .read
= usb_blaster_read_data
,
343 .write
= usb_blaster_write
,
344 .reset
= usb_blaster_reset
,
345 .blink
= usb_blaster_blink
,
348 static int usb_blaster_init(void)
350 uint8_t latency_timer
;
352 #if BUILD_USB_BLASTER_FTD2XX == 1
356 #if BUILD_USB_BLASTER_FTD2XX == 1
357 LOG_DEBUG("'usb_blaster' interface using FTD2XX");
358 #elif BUILD_USB_BLASTER_LIBFTDI == 1
359 LOG_DEBUG("'usb_blaster' interface using libftdi");
362 #if BUILD_USB_BLASTER_FTD2XX == 1
363 /* Open by device description */
364 if (usb_blaster_device_desc
== NULL
)
366 LOG_WARNING("no usb_blaster device description specified, "
367 "using default 'USB-Blaster'");
368 usb_blaster_device_desc
= "USB-Blaster";
372 /* Add non-standard Vid/Pid to the linux driver */
373 status
= FT_SetVIDPID(usb_blaster_vid
, usb_blaster_pid
);
376 LOG_WARNING("couldn't add %4.4x:%4.4x",
377 usb_blaster_vid
, usb_blaster_pid
);
381 status
= FT_OpenEx(usb_blaster_device_desc
, FT_OPEN_BY_DESCRIPTION
,
387 LOG_ERROR("unable to open ftdi device: %lu", status
);
388 status
= FT_ListDevices(&num_devices
, NULL
,
389 FT_LIST_NUMBER_ONLY
);
392 char **desc_array
= malloc(sizeof(char *)
393 * (num_devices
+ 1));
396 for (i
= 0; i
< num_devices
; i
++)
397 desc_array
[i
] = malloc(64);
398 desc_array
[num_devices
] = NULL
;
400 status
= FT_ListDevices(desc_array
, &num_devices
,
401 FT_LIST_ALL
| FT_OPEN_BY_DESCRIPTION
);
405 LOG_ERROR("ListDevices: %lu", num_devices
);
406 for (i
= 0; i
< num_devices
; i
++)
407 LOG_ERROR("%i: %s", i
, desc_array
[i
]);
410 for (i
= 0; i
< num_devices
; i
++)
416 printf("ListDevices: NONE\n");
418 return ERROR_JTAG_INIT_FAILED
;
421 status
= FT_SetLatencyTimer(ftdih
, 2);
424 LOG_ERROR("unable to set latency timer: %lu", status
);
425 return ERROR_JTAG_INIT_FAILED
;
428 status
= FT_GetLatencyTimer(ftdih
, &latency_timer
);
431 LOG_ERROR("unable to get latency timer: %lu", status
);
432 return ERROR_JTAG_INIT_FAILED
;
434 LOG_DEBUG("current latency timer: %i", latency_timer
);
436 status
= FT_SetBitMode(ftdih
, 0x00, 0);
439 LOG_ERROR("unable to disable bit i/o mode: %lu", status
);
440 return ERROR_JTAG_INIT_FAILED
;
442 #elif BUILD_USB_BLASTER_LIBFTDI == 1
443 if (ftdi_init(&ftdic
) < 0)
444 return ERROR_JTAG_INIT_FAILED
;
446 /* context, vendor id, product id */
447 if (ftdi_usb_open(&ftdic
, usb_blaster_vid
, usb_blaster_pid
) < 0)
449 LOG_ERROR("unable to open ftdi device: %s", ftdic
.error_str
);
450 return ERROR_JTAG_INIT_FAILED
;
453 if (ftdi_usb_reset(&ftdic
) < 0)
455 LOG_ERROR("unable to reset ftdi device");
456 return ERROR_JTAG_INIT_FAILED
;
459 if (ftdi_set_latency_timer(&ftdic
, 2) < 0)
461 LOG_ERROR("unable to set latency timer");
462 return ERROR_JTAG_INIT_FAILED
;
465 if (ftdi_get_latency_timer(&ftdic
, &latency_timer
) < 0)
467 LOG_ERROR("unable to get latency timer");
468 return ERROR_JTAG_INIT_FAILED
;
470 LOG_DEBUG("current latency timer: %u", latency_timer
);
472 ftdi_disable_bitbang(&ftdic
);
475 bitbang_interface
= &usb_blaster_bitbang
;
478 #if BUILD_USB_BLASTER_FTD2XX == 1
479 if ((status
= FT_Purge(ftdih
, FT_PURGE_RX
| FT_PURGE_TX
)) != FT_OK
)
481 LOG_ERROR("error purging ftd2xx device: %i", status
);
482 return ERROR_JTAG_INIT_FAILED
;
484 #elif BUILD_USB_BLASTER_LIBFTDI == 1
485 if (ftdi_usb_purge_buffers(&ftdic
) < 0)
487 LOG_ERROR("ftdi_purge_buffers: %s", ftdic
.error_str
);
488 return ERROR_JTAG_INIT_FAILED
;
496 static int usb_blaster_quit(void)
499 usb_blaster_write_databuffer(out_buffer
, out_count
);
501 #if BUILD_USB_BLASTER_FTD2XX == 1
504 status
= FT_Close(ftdih
);
505 #elif BUILD_USB_BLASTER_LIBFTDI == 1
506 ftdi_usb_close(&ftdic
);
513 COMMAND_HANDLER(usb_blaster_handle_device_desc_command
)
516 usb_blaster_device_desc
= strdup(CMD_ARGV
[0]);
518 LOG_ERROR("require exactly one argument to "
519 "usb_blaster_device_desc <description>");
524 COMMAND_HANDLER(usb_blaster_handle_vid_pid_command
)
528 LOG_WARNING("ignoring extra IDs in usb_blaster_vid_pid "
529 "(maximum is 1 pair)");
534 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], usb_blaster_vid
);
535 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[1], usb_blaster_pid
);
538 LOG_WARNING("incomplete usb_blaster_vid_pid configuration");
543 COMMAND_HANDLER(usb_blaster_handle_pin_command
)
547 const char * const pin_name
= CMD_ARGV
[0];
551 if (!strcmp(pin_name
, "pin6"))
553 else if (!strcmp(pin_name
, "pin8"))
557 LOG_ERROR("%s: pin name must be \"pin6\" or \"pin8\"",
559 return ERROR_COMMAND_SYNTAX_ERROR
;
562 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[1], state
);
566 usb_blaster_addtowritebuffer(out_value
, true);
571 usb_blaster_addtowritebuffer(out_value
, true);
575 LOG_ERROR("%s: pin state must be 0 or 1", CMD_NAME
);
576 return ERROR_COMMAND_SYNTAX_ERROR
;
583 LOG_ERROR("%s takes exactly two arguments", CMD_NAME
);
584 return ERROR_COMMAND_SYNTAX_ERROR
;
588 static const struct command_registration usb_blaster_command_handlers
[] = {
590 .name
= "usb_blaster_device_desc",
591 .handler
= usb_blaster_handle_device_desc_command
,
592 .mode
= COMMAND_CONFIG
,
593 .help
= "set the USB device description of the USB-Blaster",
594 .usage
= "description-string",
597 .name
= "usb_blaster_vid_pid",
598 .handler
= usb_blaster_handle_vid_pid_command
,
599 .mode
= COMMAND_CONFIG
,
600 .help
= "the vendor ID and product ID of the USB-Blaster",
604 .name
= "usb_blaster",
605 .handler
= usb_blaster_handle_pin_command
,
607 .help
= "set pin state for the unused GPIO pins",
608 .usage
= "(pin6|pin8) (0|1)",
610 COMMAND_REGISTRATION_DONE
613 struct jtag_interface usb_blaster_interface
= {
614 .name
= "usb_blaster",
615 .commands
= usb_blaster_command_handlers
,
616 .supported
= DEBUG_CAP_TMS_SEQ
,
618 .execute_queue
= bitbang_execute_queue
,
620 .speed
= usb_blaster_speed
,
621 .init
= usb_blaster_init
,
622 .quit
= usb_blaster_quit
,
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)