1 /***************************************************************************
2 * Copyright (C) 2009 by Øyvind Harboe *
3 * Øyvind Harboe <oyvind.harboe@zylin.com> *
5 * Copyright (C) 2009 by SoftPLC Corporation. http://softplc.com *
6 * Dick Hollenbeck <dick@softplc.com> *
8 * Copyright (C) 2004, 2006 by Dominic Rath *
9 * Dominic.Rath@gmx.de *
11 * Copyright (C) 2008 by Spencer Oliver *
12 * spen@spen-soft.co.uk *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program; if not, write to the *
26 * Free Software Foundation, Inc., *
27 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
28 ***************************************************************************/
32 * JTAG adapters based on the FT2232 full and high speed USB parts are
33 * popular low cost JTAG debug solutions. Many FT2232 based JTAG adapters
34 * are discrete, but development boards may integrate them as alternatives
35 * to more capable (and expensive) third party JTAG pods.
37 * JTAG uses only one of the two communications channels ("MPSSE engines")
38 * on these devices. Adapters based on FT4232 parts have four ports/channels
39 * (A/B/C/D), instead of just two (A/B).
41 * Especially on development boards integrating one of these chips (as
42 * opposed to discrete pods/dongles), the additional channels can be used
43 * for a variety of purposes, but OpenOCD only uses one channel at a time.
45 * - As a USB-to-serial adapter for the target's console UART ...
46 * which may be able to support ROM boot loaders that load initial
47 * firmware images to flash (or SRAM).
49 * - On systems which support ARM's SWD in addition to JTAG, or instead
50 * of it, that second port can be used for reading SWV/SWO trace data.
52 * - Additional JTAG links, e.g. to a CPLD or * FPGA.
54 * FT2232 based JTAG adapters are "dumb" not "smart", because most JTAG
55 * request/response interactions involve round trips over the USB link.
56 * A "smart" JTAG adapter has intelligence close to the scan chain, so it
57 * can for example poll quickly for a status change (usually taking on the
58 * order of microseconds not milliseconds) before beginning a queued
59 * transaction which require the previous one to have completed.
61 * There are dozens of adapters of this type, differing in details which
62 * this driver needs to understand. Those "layout" details are required
63 * as part of FT2232 driver configuration.
65 * This code uses information contained in the MPSSE specification which was
67 * http://www.ftdichip.com/Documents/AppNotes/AN2232C-01_MPSSE_Cmnd.pdf
68 * Hereafter this is called the "MPSSE Spec".
70 * The datasheet for the ftdichip.com's FT2232D part is here:
71 * http://www.ftdichip.com/Documents/DataSheets/DS_FT2232D.pdf
73 * Also note the issue with code 0x4b (clock data to TMS) noted in
74 * http://developer.intra2net.com/mailarchive/html/libftdi/2009/msg00292.html
75 * which can affect longer JTAG state paths.
82 /* project specific includes */
83 #include <jtag/interface.h>
84 #include <transport/transport.h>
85 #include <helper/time_support.h>
93 #if (BUILD_FT2232_FTD2XX == 1 && BUILD_FT2232_LIBFTDI == 1)
94 #error "BUILD_FT2232_FTD2XX && BUILD_FT2232_LIBFTDI are mutually exclusive"
95 #elif (BUILD_FT2232_FTD2XX != 1 && BUILD_FT2232_LIBFTDI != 1)
96 #error "BUILD_FT2232_FTD2XX || BUILD_FT2232_LIBFTDI must be chosen"
99 /* FT2232 access library includes */
100 #if BUILD_FT2232_FTD2XX == 1
102 #include "ftd2xx_common.h"
113 #elif BUILD_FT2232_LIBFTDI == 1
117 /* max TCK for the high speed devices 30000 kHz */
118 #define FTDI_2232H_4232H_MAX_TCK 30000
119 /* max TCK for the full speed devices 6000 kHz */
120 #define FTDI_2232C_MAX_TCK 6000
121 /* this speed value tells that RTCK is requested */
122 #define RTCK_SPEED -1
125 * On my Athlon XP 1900+ EHCI host with FT2232H JTAG dongle I get read timeout
126 * errors with a retry count of 100. Increasing it solves the problem for me.
129 * FIXME There's likely an issue with the usb_read_timeout from libftdi.
130 * Fix that (libusb? kernel? libftdi? here?) and restore the retry count
133 #define LIBFTDI_READ_RETRY_COUNT 2000
135 #ifndef BUILD_FT2232_HIGHSPEED
136 #if BUILD_FT2232_FTD2XX == 1
137 enum { FT_DEVICE_2232H = 6, FT_DEVICE_4232H };
138 #elif BUILD_FT2232_LIBFTDI == 1
139 enum { TYPE_2232H = 4, TYPE_4232H = 5 };
144 * Send out \a num_cycles on the TCK line while the TAP(s) are in a
145 * stable state. Calling code must ensure that current state is stable,
146 * that verification is not done in here.
148 * @param num_cycles The number of clocks cycles to send.
149 * @param cmd The command to send.
151 * @returns ERROR_OK on success, or ERROR_JTAG_QUEUE_FAILED on failure.
153 static int ft2232_stableclocks(int num_cycles, struct jtag_command* cmd);
155 static char * ft2232_device_desc_A = NULL;
156 static char* ft2232_device_desc = NULL;
157 static char* ft2232_serial = NULL;
158 static uint8_t ft2232_latency = 2;
159 static unsigned ft2232_max_tck = FTDI_2232C_MAX_TCK;
161 #define MAX_USB_IDS 8
162 /* vid = pid = 0 marks the end of the list */
163 static uint16_t ft2232_vid[MAX_USB_IDS + 1] = { 0x0403, 0 };
164 static uint16_t ft2232_pid[MAX_USB_IDS + 1] = { 0x6010, 0 };
166 struct ft2232_layout {
169 void (*reset)(int trst, int srst);
174 /* init procedures for supported layouts */
175 static int usbjtag_init(void);
176 static int jtagkey_init(void);
177 static int lm3s811_jtag_init(void);
178 static int icdi_jtag_init(void);
179 static int olimex_jtag_init(void);
180 static int flyswatter_init(void);
181 static int minimodule_init(void);
182 static int turtle_init(void);
183 static int comstick_init(void);
184 static int stm32stick_init(void);
185 static int axm0432_jtag_init(void);
186 static int sheevaplug_init(void);
187 static int icebear_jtag_init(void);
188 static int cortino_jtag_init(void);
189 static int signalyzer_init(void);
190 static int signalyzer_h_init(void);
191 static int ktlink_init(void);
192 static int redbee_init(void);
193 static int lisa_l_init(void);
194 static int flossjtag_init(void);
195 static int xds100v2_init(void);
197 /* reset procedures for supported layouts */
198 static void ftx23_reset(int trst, int srst);
199 static void jtagkey_reset(int trst, int srst);
200 static void olimex_jtag_reset(int trst, int srst);
201 static void flyswatter_reset(int trst, int srst);
202 static void minimodule_reset(int trst, int srst);
203 static void turtle_reset(int trst, int srst);
204 static void comstick_reset(int trst, int srst);
205 static void stm32stick_reset(int trst, int srst);
206 static void axm0432_jtag_reset(int trst, int srst);
207 static void sheevaplug_reset(int trst, int srst);
208 static void icebear_jtag_reset(int trst, int srst);
209 static void signalyzer_h_reset(int trst, int srst);
210 static void ktlink_reset(int trst, int srst);
211 static void redbee_reset(int trst, int srst);
212 static void xds100v2_reset(int trst, int srst);
214 /* blink procedures for layouts that support a blinking led */
215 static void olimex_jtag_blink(void);
216 static void flyswatter_jtag_blink(void);
217 static void turtle_jtag_blink(void);
218 static void signalyzer_h_blink(void);
219 static void ktlink_blink(void);
220 static void lisa_l_blink(void);
221 static void flossjtag_blink(void);
223 /* common transport support options */
225 //static const char *jtag_and_swd[] = { "jtag", "swd", NULL };
227 static const struct ft2232_layout ft2232_layouts[] =
230 .init = usbjtag_init,
231 .reset = ftx23_reset,
234 .init = jtagkey_init,
235 .reset = jtagkey_reset,
237 { .name = "jtagkey_prototype_v1",
238 .init = jtagkey_init,
239 .reset = jtagkey_reset,
241 { .name = "oocdlink",
242 .init = jtagkey_init,
243 .reset = jtagkey_reset,
245 { .name = "signalyzer",
246 .init = signalyzer_init,
247 .reset = ftx23_reset,
249 { .name = "evb_lm3s811",
250 .init = lm3s811_jtag_init,
251 .reset = ftx23_reset,
253 { .name = "luminary_icdi",
254 .init = icdi_jtag_init,
255 .reset = ftx23_reset,
257 { .name = "olimex-jtag",
258 .init = olimex_jtag_init,
259 .reset = olimex_jtag_reset,
260 .blink = olimex_jtag_blink
262 { .name = "flyswatter",
263 .init = flyswatter_init,
264 .reset = flyswatter_reset,
265 .blink = flyswatter_jtag_blink
267 { .name = "minimodule",
268 .init = minimodule_init,
269 .reset = minimodule_reset,
271 { .name = "turtelizer2",
273 .reset = turtle_reset,
274 .blink = turtle_jtag_blink
276 { .name = "comstick",
277 .init = comstick_init,
278 .reset = comstick_reset,
280 { .name = "stm32stick",
281 .init = stm32stick_init,
282 .reset = stm32stick_reset,
284 { .name = "axm0432_jtag",
285 .init = axm0432_jtag_init,
286 .reset = axm0432_jtag_reset,
288 { .name = "sheevaplug",
289 .init = sheevaplug_init,
290 .reset = sheevaplug_reset,
293 .init = icebear_jtag_init,
294 .reset = icebear_jtag_reset,
297 .init = cortino_jtag_init,
298 .reset = comstick_reset,
300 { .name = "signalyzer-h",
301 .init = signalyzer_h_init,
302 .reset = signalyzer_h_reset,
303 .blink = signalyzer_h_blink
307 .reset = ktlink_reset,
308 .blink = ktlink_blink
310 { .name = "redbee-econotag",
312 .reset = redbee_reset,
314 { .name = "redbee-usb",
316 .reset = redbee_reset,
317 .channel = INTERFACE_B,
321 .reset = ftx23_reset,
322 .blink = lisa_l_blink,
323 .channel = INTERFACE_B,
325 { .name = "flossjtag",
326 .init = flossjtag_init,
327 .reset = ftx23_reset,
328 .blink = flossjtag_blink,
330 { .name = "xds100v2",
331 .init = xds100v2_init,
332 .reset = xds100v2_reset,
334 { .name = NULL, /* END OF TABLE */ },
337 /* bitmask used to drive nTRST; usually a GPIOLx signal */
338 static uint8_t nTRST;
339 static uint8_t nTRSTnOE;
340 /* bitmask used to drive nSRST; usually a GPIOLx signal */
341 static uint8_t nSRST;
342 static uint8_t nSRSTnOE;
344 /** the layout being used with this debug session */
345 static const struct ft2232_layout *layout;
347 /** default bitmask values driven on DBUS: TCK/TDI/TDO/TMS and GPIOL(0..4) */
348 static uint8_t low_output = 0x0;
350 /* note that direction bit == 1 means that signal is an output */
352 /** default direction bitmask for DBUS: TCK/TDI/TDO/TMS and GPIOL(0..4) */
353 static uint8_t low_direction = 0x0;
354 /** default value bitmask for CBUS GPIOH(0..4) */
355 static uint8_t high_output = 0x0;
356 /** default direction bitmask for CBUS GPIOH(0..4) */
357 static uint8_t high_direction = 0x0;
359 #if BUILD_FT2232_FTD2XX == 1
360 static FT_HANDLE ftdih = NULL;
361 static FT_DEVICE ftdi_device = 0;
362 #elif BUILD_FT2232_LIBFTDI == 1
363 static struct ftdi_context ftdic;
364 static enum ftdi_chip_type ftdi_device;
367 static struct jtag_command* first_unsent; /* next command that has to be sent */
368 static int require_send;
370 /* http://urjtag.wiki.sourceforge.net/Cable + FT2232 says:
372 "There is a significant difference between libftdi and libftd2xx. The latter
373 one allows to schedule up to 64*64 bytes of result data while libftdi fails
374 with more than 4*64. As a consequence, the FT2232 driver is forced to
375 perform around 16x more USB transactions for long command streams with TDO
376 capture when running with libftdi."
379 #define FT2232_BUFFER_SIZE 131072
380 a comment would have been nice.
383 #if BUILD_FT2232_FTD2XX == 1
384 #define FT2232_BUFFER_READ_QUEUE_SIZE (64*64)
386 #define FT2232_BUFFER_READ_QUEUE_SIZE (64*4)
389 #define FT2232_BUFFER_SIZE 131072
391 static uint8_t* ft2232_buffer = NULL;
392 static int ft2232_buffer_size = 0;
393 static int ft2232_read_pointer = 0;
394 static int ft2232_expect_read = 0;
397 * Function buffer_write
398 * writes a byte into the byte buffer, "ft2232_buffer", which must be sent later.
399 * @param val is the byte to send.
401 static inline void buffer_write(uint8_t val)
403 assert(ft2232_buffer);
404 assert((unsigned) ft2232_buffer_size < (unsigned) FT2232_BUFFER_SIZE);
405 ft2232_buffer[ft2232_buffer_size++] = val;
409 * Function buffer_read
410 * returns a byte from the byte buffer.
412 static inline uint8_t buffer_read(void)
414 assert(ft2232_buffer);
415 assert(ft2232_read_pointer < ft2232_buffer_size);
416 return ft2232_buffer[ft2232_read_pointer++];
420 * Clocks out \a bit_count bits on the TMS line, starting with the least
421 * significant bit of tms_bits and progressing to more significant bits.
422 * Rigorous state transition logging is done here via tap_set_state().
424 * @param mpsse_cmd One of the MPSSE TMS oriented commands such as
425 * 0x4b or 0x6b. See the MPSSE spec referenced above for their
426 * functionality. The MPSSE command "Clock Data to TMS/CS Pin (no Read)"
427 * is often used for this, 0x4b.
429 * @param tms_bits Holds the sequence of bits to send.
430 * @param tms_count Tells how many bits in the sequence.
431 * @param tdi_bit A single bit to pass on to TDI before the first TCK
432 * cycle and held static for the duration of TMS clocking.
434 * See the MPSSE spec referenced above.
436 static void clock_tms(uint8_t mpsse_cmd, int tms_bits, int tms_count, bool tdi_bit)
440 int tms_ndx; /* bit index into tms_byte */
442 assert(tms_count > 0);
444 DEBUG_JTAG_IO("mpsse cmd=%02x, tms_bits = 0x%08x, bit_count=%d",
445 mpsse_cmd, tms_bits, tms_count);
447 for (tms_byte = tms_ndx = i = 0; i < tms_count; ++i, tms_bits>>=1)
449 bool bit = tms_bits & 1;
452 tms_byte |= (1 << tms_ndx);
454 /* always do state transitions in public view */
455 tap_set_state(tap_state_transition(tap_get_state(), bit));
457 /* we wrote a bit to tms_byte just above, increment bit index. if bit was zero
462 if (tms_ndx == 7 || i == tms_count-1)
464 buffer_write(mpsse_cmd);
465 buffer_write(tms_ndx - 1);
467 /* Bit 7 of the byte is passed on to TDI/DO before the first TCK/SK of
468 TMS/CS and is held static for the duration of TMS/CS clocking.
470 buffer_write(tms_byte | (tdi_bit << 7));
476 * Function get_tms_buffer_requirements
477 * returns what clock_tms() will consume if called with
480 static inline int get_tms_buffer_requirements(int bit_count)
482 return ((bit_count + 6)/7) * 3;
486 * Function move_to_state
487 * moves the TAP controller from the current state to a
488 * \a goal_state through a path given by tap_get_tms_path(). State transition
489 * logging is performed by delegation to clock_tms().
491 * @param goal_state is the destination state for the move.
493 static void move_to_state(tap_state_t goal_state)
495 tap_state_t start_state = tap_get_state();
497 /* goal_state is 1/2 of a tuple/pair of states which allow convenient
498 lookup of the required TMS pattern to move to this state from the
502 /* do the 2 lookups */
503 int tms_bits = tap_get_tms_path(start_state, goal_state);
504 int tms_count = tap_get_tms_path_len(start_state, goal_state);
506 DEBUG_JTAG_IO("start=%s goal=%s", tap_state_name(start_state), tap_state_name(goal_state));
508 clock_tms(0x4b, tms_bits, tms_count, 0);
511 static int ft2232_write(uint8_t* buf, int size, uint32_t* bytes_written)
513 #if BUILD_FT2232_FTD2XX == 1
515 DWORD dw_bytes_written = 0;
516 if ((status = FT_Write(ftdih, buf, size, &dw_bytes_written)) != FT_OK)
518 *bytes_written = dw_bytes_written;
519 LOG_ERROR("FT_Write returned: %s", ftd2xx_status_string(status));
520 return ERROR_JTAG_DEVICE_ERROR;
524 *bytes_written = dw_bytes_written;
526 #elif BUILD_FT2232_LIBFTDI == 1
528 if ((retval = ftdi_write_data(&ftdic, buf, size)) < 0)
531 LOG_ERROR("ftdi_write_data: %s", ftdi_get_error_string(&ftdic));
532 return ERROR_JTAG_DEVICE_ERROR;
536 *bytes_written = retval;
540 if (*bytes_written != (uint32_t)size)
542 return ERROR_JTAG_DEVICE_ERROR;
548 static int ft2232_read(uint8_t* buf, uint32_t size, uint32_t* bytes_read)
550 #if BUILD_FT2232_FTD2XX == 1
556 while ((*bytes_read < size) && timeout--)
558 if ((status = FT_Read(ftdih, buf + *bytes_read, size -
559 *bytes_read, &dw_bytes_read)) != FT_OK)
562 LOG_ERROR("FT_Read returned: %s", ftd2xx_status_string(status));
563 return ERROR_JTAG_DEVICE_ERROR;
565 *bytes_read += dw_bytes_read;
568 #elif BUILD_FT2232_LIBFTDI == 1
570 int timeout = LIBFTDI_READ_RETRY_COUNT;
573 while ((*bytes_read < size) && timeout--)
575 if ((retval = ftdi_read_data(&ftdic, buf + *bytes_read, size - *bytes_read)) < 0)
578 LOG_ERROR("ftdi_read_data: %s", ftdi_get_error_string(&ftdic));
579 return ERROR_JTAG_DEVICE_ERROR;
581 *bytes_read += retval;
586 if (*bytes_read < size)
588 LOG_ERROR("couldn't read enough bytes from "
589 "FT2232 device (%i < %i)",
590 (unsigned)*bytes_read,
592 return ERROR_JTAG_DEVICE_ERROR;
598 static bool ft2232_device_is_highspeed(void)
600 #if BUILD_FT2232_FTD2XX == 1
601 return (ftdi_device == FT_DEVICE_2232H) || (ftdi_device == FT_DEVICE_4232H);
602 #elif BUILD_FT2232_LIBFTDI == 1
603 return (ftdi_device == TYPE_2232H || ftdi_device == TYPE_4232H);
608 * Commands that only apply to the FT2232H and FT4232H devices.
609 * See chapter 6 in http://www.ftdichip.com/Documents/AppNotes/
610 * AN_108_Command_Processor_for_MPSSE_and_MCU_Host_Bus_Emulation_Modes.pdf
613 static int ft2232h_ft4232h_adaptive_clocking(bool enable)
615 uint8_t buf = enable ? 0x96 : 0x97;
616 LOG_DEBUG("%2.2x", buf);
618 uint32_t bytes_written;
621 if ((retval = ft2232_write(&buf, sizeof(buf), &bytes_written)) != ERROR_OK)
623 LOG_ERROR("couldn't write command to %s adaptive clocking"
624 , enable ? "enable" : "disable");
632 * Enable/disable the clk divide by 5 of the 60MHz master clock.
633 * This result in a JTAG clock speed range of 91.553Hz-6MHz
634 * respective 457.763Hz-30MHz.
636 static int ft2232h_ft4232h_clk_divide_by_5(bool enable)
638 uint32_t bytes_written;
639 uint8_t buf = enable ? 0x8b : 0x8a;
641 if (ft2232_write(&buf, sizeof(buf), &bytes_written) != ERROR_OK)
643 LOG_ERROR("couldn't write command to %s clk divide by 5"
644 , enable ? "enable" : "disable");
645 return ERROR_JTAG_INIT_FAILED;
647 ft2232_max_tck = enable ? FTDI_2232C_MAX_TCK : FTDI_2232H_4232H_MAX_TCK;
648 LOG_INFO("max TCK change to: %u kHz", ft2232_max_tck);
653 static int ft2232_speed(int speed)
657 uint32_t bytes_written;
660 bool enable_adaptive_clocking = (RTCK_SPEED == speed);
661 if (ft2232_device_is_highspeed())
662 retval = ft2232h_ft4232h_adaptive_clocking(enable_adaptive_clocking);
663 else if (enable_adaptive_clocking)
665 LOG_ERROR("ft2232 device %lu does not support RTCK"
666 , (long unsigned int)ftdi_device);
670 if ((enable_adaptive_clocking) || (ERROR_OK != retval))
673 buf[0] = 0x86; /* command "set divisor" */
674 buf[1] = speed & 0xff; /* valueL (0 = 6MHz, 1 = 3MHz, 2 = 2.0MHz, ...*/
675 buf[2] = (speed >> 8) & 0xff; /* valueH */
677 LOG_DEBUG("%2.2x %2.2x %2.2x", buf[0], buf[1], buf[2]);
678 if ((retval = ft2232_write(buf, sizeof(buf), &bytes_written)) != ERROR_OK)
680 LOG_ERROR("couldn't set FT2232 TCK speed");
687 static int ft2232_speed_div(int speed, int* khz)
689 /* Take a look in the FT2232 manual,
690 * AN2232C-01 Command Processor for
691 * MPSSE and MCU Host Bus. Chapter 3.8 */
693 *khz = (RTCK_SPEED == speed) ? 0 : ft2232_max_tck / (1 + speed);
698 static int ft2232_khz(int khz, int* jtag_speed)
702 if (ft2232_device_is_highspeed())
704 *jtag_speed = RTCK_SPEED;
709 LOG_DEBUG("RCLK not supported");
714 /* Take a look in the FT2232 manual,
715 * AN2232C-01 Command Processor for
716 * MPSSE and MCU Host Bus. Chapter 3.8
718 * We will calc here with a multiplier
719 * of 10 for better rounding later. */
721 /* Calc speed, (ft2232_max_tck / khz) - 1 */
722 /* Use 65000 for better rounding */
723 *jtag_speed = ((ft2232_max_tck*10) / khz) - 10;
725 /* Add 0.9 for rounding */
728 /* Calc real speed */
729 *jtag_speed = *jtag_speed / 10;
731 /* Check if speed is greater than 0 */
737 /* Check max value */
738 if (*jtag_speed > 0xFFFF)
740 *jtag_speed = 0xFFFF;
746 static void ft2232_end_state(tap_state_t state)
748 if (tap_is_state_stable(state))
749 tap_set_end_state(state);
752 LOG_ERROR("BUG: %s is not a stable end state", tap_state_name(state));
757 static void ft2232_read_scan(enum scan_type type, uint8_t* buffer, int scan_size)
759 int num_bytes = (scan_size + 7) / 8;
760 int bits_left = scan_size;
763 while (num_bytes-- > 1)
765 buffer[cur_byte++] = buffer_read();
769 buffer[cur_byte] = 0x0;
771 /* There is one more partial byte left from the clock data in/out instructions */
774 buffer[cur_byte] = buffer_read() >> 1;
776 /* This shift depends on the length of the clock data to tms instruction, insterted at end of the scan, now fixed to a two step transition in ft2232_add_scan */
777 buffer[cur_byte] = (buffer[cur_byte] | (((buffer_read()) << 1) & 0x80)) >> (8 - bits_left);
780 static void ft2232_debug_dump_buffer(void)
786 for (i = 0; i < ft2232_buffer_size; i++)
788 line_p += snprintf(line_p, sizeof(line) - (line_p - line), "%2.2x ", ft2232_buffer[i]);
791 LOG_DEBUG("%s", line);
797 LOG_DEBUG("%s", line);
800 static int ft2232_send_and_recv(struct jtag_command* first, struct jtag_command* last)
802 struct jtag_command* cmd;
807 uint32_t bytes_written = 0;
808 uint32_t bytes_read = 0;
810 #ifdef _DEBUG_USB_IO_
811 struct timeval start, inter, inter2, end;
812 struct timeval d_inter, d_inter2, d_end;
815 #ifdef _DEBUG_USB_COMMS_
816 LOG_DEBUG("write buffer (size %i):", ft2232_buffer_size);
817 ft2232_debug_dump_buffer();
820 #ifdef _DEBUG_USB_IO_
821 gettimeofday(&start, NULL);
824 if ((retval = ft2232_write(ft2232_buffer, ft2232_buffer_size, &bytes_written)) != ERROR_OK)
826 LOG_ERROR("couldn't write MPSSE commands to FT2232");
830 #ifdef _DEBUG_USB_IO_
831 gettimeofday(&inter, NULL);
834 if (ft2232_expect_read)
836 /* FIXME this "timeout" is never changed ... */
837 int timeout = LIBFTDI_READ_RETRY_COUNT;
838 ft2232_buffer_size = 0;
840 #ifdef _DEBUG_USB_IO_
841 gettimeofday(&inter2, NULL);
844 if ((retval = ft2232_read(ft2232_buffer, ft2232_expect_read, &bytes_read)) != ERROR_OK)
846 LOG_ERROR("couldn't read from FT2232");
850 #ifdef _DEBUG_USB_IO_
851 gettimeofday(&end, NULL);
853 timeval_subtract(&d_inter, &inter, &start);
854 timeval_subtract(&d_inter2, &inter2, &start);
855 timeval_subtract(&d_end, &end, &start);
857 LOG_INFO("inter: %u.%06u, inter2: %u.%06u end: %u.%06u",
858 (unsigned)d_inter.tv_sec, (unsigned)d_inter.tv_usec,
859 (unsigned)d_inter2.tv_sec, (unsigned)d_inter2.tv_usec,
860 (unsigned)d_end.tv_sec, (unsigned)d_end.tv_usec);
863 ft2232_buffer_size = bytes_read;
865 if (ft2232_expect_read != ft2232_buffer_size)
867 LOG_ERROR("ft2232_expect_read (%i) != "
868 "ft2232_buffer_size (%i) "
872 LIBFTDI_READ_RETRY_COUNT - timeout);
873 ft2232_debug_dump_buffer();
878 #ifdef _DEBUG_USB_COMMS_
879 LOG_DEBUG("read buffer (%i retries): %i bytes",
880 LIBFTDI_READ_RETRY_COUNT - timeout,
882 ft2232_debug_dump_buffer();
886 ft2232_expect_read = 0;
887 ft2232_read_pointer = 0;
889 /* return ERROR_OK, unless a jtag_read_buffer returns a failed check
890 * that wasn't handled by a caller-provided error handler
900 type = jtag_scan_type(cmd->cmd.scan);
901 if (type != SCAN_OUT)
903 scan_size = jtag_scan_size(cmd->cmd.scan);
904 buffer = calloc(DIV_ROUND_UP(scan_size, 8), 1);
905 ft2232_read_scan(type, buffer, scan_size);
906 if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
907 retval = ERROR_JTAG_QUEUE_FAILED;
919 ft2232_buffer_size = 0;
925 * Function ft2232_add_pathmove
926 * moves the TAP controller from the current state to a new state through the
927 * given path, where path is an array of tap_state_t's.
929 * @param path is an array of tap_stat_t which gives the states to traverse through
930 * ending with the last state at path[num_states-1]
931 * @param num_states is the count of state steps to move through
933 static void ft2232_add_pathmove(tap_state_t* path, int num_states)
937 assert((unsigned) num_states <= 32u); /* tms_bits only holds 32 bits */
941 /* this loop verifies that the path is legal and logs each state in the path */
944 unsigned char tms_byte = 0; /* zero this on each MPSSE batch */
946 int num_states_batch = num_states > 7 ? 7 : num_states;
948 /* command "Clock Data to TMS/CS Pin (no Read)" */
951 /* number of states remaining */
952 buffer_write(num_states_batch - 1);
954 while (num_states_batch--) {
955 /* either TMS=0 or TMS=1 must work ... */
956 if (tap_state_transition(tap_get_state(), false)
957 == path[state_count])
958 buf_set_u32(&tms_byte, bit_count++, 1, 0x0);
959 else if (tap_state_transition(tap_get_state(), true)
960 == path[state_count])
961 buf_set_u32(&tms_byte, bit_count++, 1, 0x1);
963 /* ... or else the caller goofed BADLY */
965 LOG_ERROR("BUG: %s -> %s isn't a valid "
966 "TAP state transition",
967 tap_state_name(tap_get_state()),
968 tap_state_name(path[state_count]));
972 tap_set_state(path[state_count]);
977 buffer_write(tms_byte);
979 tap_set_end_state(tap_get_state());
982 static void ft2232_add_scan(bool ir_scan, enum scan_type type, uint8_t* buffer, int scan_size)
984 int num_bytes = (scan_size + 7) / 8;
985 int bits_left = scan_size;
991 if (tap_get_state() != TAP_DRSHIFT)
993 move_to_state(TAP_DRSHIFT);
998 if (tap_get_state() != TAP_IRSHIFT)
1000 move_to_state(TAP_IRSHIFT);
1004 /* add command for complete bytes */
1005 while (num_bytes > 1)
1008 if (type == SCAN_IO)
1010 /* Clock Data Bytes In and Out LSB First */
1012 /* LOG_DEBUG("added TDI bytes (io %i)", num_bytes); */
1014 else if (type == SCAN_OUT)
1016 /* Clock Data Bytes Out on -ve Clock Edge LSB First (no Read) */
1018 /* LOG_DEBUG("added TDI bytes (o)"); */
1020 else if (type == SCAN_IN)
1022 /* Clock Data Bytes In on +ve Clock Edge LSB First (no Write) */
1024 /* LOG_DEBUG("added TDI bytes (i %i)", num_bytes); */
1027 thisrun_bytes = (num_bytes > 65537) ? 65536 : (num_bytes - 1);
1028 num_bytes -= thisrun_bytes;
1030 buffer_write((uint8_t) (thisrun_bytes - 1));
1031 buffer_write((uint8_t) ((thisrun_bytes - 1) >> 8));
1033 if (type != SCAN_IN)
1035 /* add complete bytes */
1036 while (thisrun_bytes-- > 0)
1038 buffer_write(buffer[cur_byte++]);
1042 else /* (type == SCAN_IN) */
1044 bits_left -= 8 * (thisrun_bytes);
1048 /* the most signifcant bit is scanned during TAP movement */
1049 if (type != SCAN_IN)
1050 last_bit = (buffer[cur_byte] >> (bits_left - 1)) & 0x1;
1054 /* process remaining bits but the last one */
1057 if (type == SCAN_IO)
1059 /* Clock Data Bits In and Out LSB First */
1061 /* LOG_DEBUG("added TDI bits (io) %i", bits_left - 1); */
1063 else if (type == SCAN_OUT)
1065 /* Clock Data Bits Out on -ve Clock Edge LSB First (no Read) */
1067 /* LOG_DEBUG("added TDI bits (o)"); */
1069 else if (type == SCAN_IN)
1071 /* Clock Data Bits In on +ve Clock Edge LSB First (no Write) */
1073 /* LOG_DEBUG("added TDI bits (i %i)", bits_left - 1); */
1076 buffer_write(bits_left - 2);
1077 if (type != SCAN_IN)
1078 buffer_write(buffer[cur_byte]);
1081 if ((ir_scan && (tap_get_end_state() == TAP_IRSHIFT))
1082 || (!ir_scan && (tap_get_end_state() == TAP_DRSHIFT)))
1084 if (type == SCAN_IO)
1086 /* Clock Data Bits In and Out LSB First */
1088 /* LOG_DEBUG("added TDI bits (io) %i", bits_left - 1); */
1090 else if (type == SCAN_OUT)
1092 /* Clock Data Bits Out on -ve Clock Edge LSB First (no Read) */
1094 /* LOG_DEBUG("added TDI bits (o)"); */
1096 else if (type == SCAN_IN)
1098 /* Clock Data Bits In on +ve Clock Edge LSB First (no Write) */
1100 /* LOG_DEBUG("added TDI bits (i %i)", bits_left - 1); */
1103 buffer_write(last_bit);
1111 /* move from Shift-IR/DR to end state */
1112 if (type != SCAN_OUT)
1114 /* We always go to the PAUSE state in two step at the end of an IN or IO scan */
1115 /* This must be coordinated with the bit shifts in ft2232_read_scan */
1118 /* Clock Data to TMS/CS Pin with Read */
1123 tms_bits = tap_get_tms_path(tap_get_state(), tap_get_end_state());
1124 tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1125 /* Clock Data to TMS/CS Pin (no Read) */
1129 DEBUG_JTAG_IO("finish %s", (type == SCAN_OUT) ? "without read" : "via PAUSE");
1130 clock_tms(mpsse_cmd, tms_bits, tms_count, last_bit);
1133 if (tap_get_state() != tap_get_end_state())
1135 move_to_state(tap_get_end_state());
1139 static int ft2232_large_scan(struct scan_command* cmd, enum scan_type type, uint8_t* buffer, int scan_size)
1141 int num_bytes = (scan_size + 7) / 8;
1142 int bits_left = scan_size;
1145 uint8_t* receive_buffer = malloc(DIV_ROUND_UP(scan_size, 8));
1146 uint8_t* receive_pointer = receive_buffer;
1147 uint32_t bytes_written;
1148 uint32_t bytes_read;
1150 int thisrun_read = 0;
1154 LOG_ERROR("BUG: large IR scans are not supported");
1158 if (tap_get_state() != TAP_DRSHIFT)
1160 move_to_state(TAP_DRSHIFT);
1163 if ((retval = ft2232_write(ft2232_buffer, ft2232_buffer_size, &bytes_written)) != ERROR_OK)
1165 LOG_ERROR("couldn't write MPSSE commands to FT2232");
1168 LOG_DEBUG("ft2232_buffer_size: %i, bytes_written: %i",
1169 ft2232_buffer_size, (int)bytes_written);
1170 ft2232_buffer_size = 0;
1172 /* add command for complete bytes */
1173 while (num_bytes > 1)
1177 if (type == SCAN_IO)
1179 /* Clock Data Bytes In and Out LSB First */
1181 /* LOG_DEBUG("added TDI bytes (io %i)", num_bytes); */
1183 else if (type == SCAN_OUT)
1185 /* Clock Data Bytes Out on -ve Clock Edge LSB First (no Read) */
1187 /* LOG_DEBUG("added TDI bytes (o)"); */
1189 else if (type == SCAN_IN)
1191 /* Clock Data Bytes In on +ve Clock Edge LSB First (no Write) */
1193 /* LOG_DEBUG("added TDI bytes (i %i)", num_bytes); */
1196 thisrun_bytes = (num_bytes > 65537) ? 65536 : (num_bytes - 1);
1197 thisrun_read = thisrun_bytes;
1198 num_bytes -= thisrun_bytes;
1199 buffer_write((uint8_t) (thisrun_bytes - 1));
1200 buffer_write((uint8_t) ((thisrun_bytes - 1) >> 8));
1202 if (type != SCAN_IN)
1204 /* add complete bytes */
1205 while (thisrun_bytes-- > 0)
1207 buffer_write(buffer[cur_byte]);
1212 else /* (type == SCAN_IN) */
1214 bits_left -= 8 * (thisrun_bytes);
1217 if ((retval = ft2232_write(ft2232_buffer, ft2232_buffer_size, &bytes_written)) != ERROR_OK)
1219 LOG_ERROR("couldn't write MPSSE commands to FT2232");
1222 LOG_DEBUG("ft2232_buffer_size: %i, bytes_written: %i",
1224 (int)bytes_written);
1225 ft2232_buffer_size = 0;
1227 if (type != SCAN_OUT)
1229 if ((retval = ft2232_read(receive_pointer, thisrun_read, &bytes_read)) != ERROR_OK)
1231 LOG_ERROR("couldn't read from FT2232");
1234 LOG_DEBUG("thisrun_read: %i, bytes_read: %i",
1237 receive_pointer += bytes_read;
1243 /* the most signifcant bit is scanned during TAP movement */
1244 if (type != SCAN_IN)
1245 last_bit = (buffer[cur_byte] >> (bits_left - 1)) & 0x1;
1249 /* process remaining bits but the last one */
1252 if (type == SCAN_IO)
1254 /* Clock Data Bits In and Out LSB First */
1256 /* LOG_DEBUG("added TDI bits (io) %i", bits_left - 1); */
1258 else if (type == SCAN_OUT)
1260 /* Clock Data Bits Out on -ve Clock Edge LSB First (no Read) */
1262 /* LOG_DEBUG("added TDI bits (o)"); */
1264 else if (type == SCAN_IN)
1266 /* Clock Data Bits In on +ve Clock Edge LSB First (no Write) */
1268 /* LOG_DEBUG("added TDI bits (i %i)", bits_left - 1); */
1270 buffer_write(bits_left - 2);
1271 if (type != SCAN_IN)
1272 buffer_write(buffer[cur_byte]);
1274 if (type != SCAN_OUT)
1278 if (tap_get_end_state() == TAP_DRSHIFT)
1280 if (type == SCAN_IO)
1282 /* Clock Data Bits In and Out LSB First */
1284 /* LOG_DEBUG("added TDI bits (io) %i", bits_left - 1); */
1286 else if (type == SCAN_OUT)
1288 /* Clock Data Bits Out on -ve Clock Edge LSB First (no Read) */
1290 /* LOG_DEBUG("added TDI bits (o)"); */
1292 else if (type == SCAN_IN)
1294 /* Clock Data Bits In on +ve Clock Edge LSB First (no Write) */
1296 /* LOG_DEBUG("added TDI bits (i %i)", bits_left - 1); */
1299 buffer_write(last_bit);
1303 int tms_bits = tap_get_tms_path(tap_get_state(), tap_get_end_state());
1304 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1307 /* move from Shift-IR/DR to end state */
1308 if (type != SCAN_OUT)
1310 /* Clock Data to TMS/CS Pin with Read */
1312 /* LOG_DEBUG("added TMS scan (read)"); */
1316 /* Clock Data to TMS/CS Pin (no Read) */
1318 /* LOG_DEBUG("added TMS scan (no read)"); */
1321 DEBUG_JTAG_IO("finish, %s", (type == SCAN_OUT) ? "no read" : "read");
1322 clock_tms(mpsse_cmd, tms_bits, tms_count, last_bit);
1325 if (type != SCAN_OUT)
1328 if ((retval = ft2232_write(ft2232_buffer, ft2232_buffer_size, &bytes_written)) != ERROR_OK)
1330 LOG_ERROR("couldn't write MPSSE commands to FT2232");
1333 LOG_DEBUG("ft2232_buffer_size: %i, bytes_written: %i",
1335 (int)bytes_written);
1336 ft2232_buffer_size = 0;
1338 if (type != SCAN_OUT)
1340 if ((retval = ft2232_read(receive_pointer, thisrun_read, &bytes_read)) != ERROR_OK)
1342 LOG_ERROR("couldn't read from FT2232");
1345 LOG_DEBUG("thisrun_read: %i, bytes_read: %i",
1348 receive_pointer += bytes_read;
1354 static int ft2232_predict_scan_out(int scan_size, enum scan_type type)
1356 int predicted_size = 3;
1357 int num_bytes = (scan_size - 1) / 8;
1359 if (tap_get_state() != TAP_DRSHIFT)
1360 predicted_size += get_tms_buffer_requirements(tap_get_tms_path_len(tap_get_state(), TAP_DRSHIFT));
1362 if (type == SCAN_IN) /* only from device to host */
1364 /* complete bytes */
1365 predicted_size += DIV_ROUND_UP(num_bytes, 65536) * 3;
1367 /* remaining bits - 1 (up to 7) */
1368 predicted_size += ((scan_size - 1) % 8) ? 2 : 0;
1370 else /* host to device, or bidirectional */
1372 /* complete bytes */
1373 predicted_size += num_bytes + DIV_ROUND_UP(num_bytes, 65536) * 3;
1375 /* remaining bits -1 (up to 7) */
1376 predicted_size += ((scan_size - 1) % 8) ? 3 : 0;
1379 return predicted_size;
1382 static int ft2232_predict_scan_in(int scan_size, enum scan_type type)
1384 int predicted_size = 0;
1386 if (type != SCAN_OUT)
1388 /* complete bytes */
1389 predicted_size += (DIV_ROUND_UP(scan_size, 8) > 1) ? (DIV_ROUND_UP(scan_size, 8) - 1) : 0;
1391 /* remaining bits - 1 */
1392 predicted_size += ((scan_size - 1) % 8) ? 1 : 0;
1394 /* last bit (from TMS scan) */
1395 predicted_size += 1;
1398 /* LOG_DEBUG("scan_size: %i, predicted_size: %i", scan_size, predicted_size); */
1400 return predicted_size;
1403 /* semi-generic FT2232/FT4232 reset code */
1404 static void ftx23_reset(int trst, int srst)
1406 enum reset_types jtag_reset_config = jtag_get_reset_config();
1409 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
1410 low_direction |= nTRSTnOE; /* switch to output pin (output is low) */
1412 low_output &= ~nTRST; /* switch output low */
1416 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
1417 low_direction &= ~nTRSTnOE; /* switch to input pin (high-Z + internal and external pullup) */
1419 low_output |= nTRST; /* switch output high */
1424 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
1425 low_output &= ~nSRST; /* switch output low */
1427 low_direction |= nSRSTnOE; /* switch to output pin (output is low) */
1431 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
1432 low_output |= nSRST; /* switch output high */
1434 low_direction &= ~nSRSTnOE; /* switch to input pin (high-Z) */
1437 /* command "set data bits low byte" */
1439 buffer_write(low_output);
1440 buffer_write(low_direction);
1443 static void jtagkey_reset(int trst, int srst)
1445 enum reset_types jtag_reset_config = jtag_get_reset_config();
1448 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
1449 high_output &= ~nTRSTnOE;
1451 high_output &= ~nTRST;
1455 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
1456 high_output |= nTRSTnOE;
1458 high_output |= nTRST;
1463 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
1464 high_output &= ~nSRST;
1466 high_output &= ~nSRSTnOE;
1470 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
1471 high_output |= nSRST;
1473 high_output |= nSRSTnOE;
1476 /* command "set data bits high byte" */
1478 buffer_write(high_output);
1479 buffer_write(high_direction);
1480 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output,
1484 static void olimex_jtag_reset(int trst, int srst)
1486 enum reset_types jtag_reset_config = jtag_get_reset_config();
1489 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
1490 high_output &= ~nTRSTnOE;
1492 high_output &= ~nTRST;
1496 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
1497 high_output |= nTRSTnOE;
1499 high_output |= nTRST;
1504 high_output |= nSRST;
1508 high_output &= ~nSRST;
1511 /* command "set data bits high byte" */
1513 buffer_write(high_output);
1514 buffer_write(high_direction);
1515 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output,
1519 static void axm0432_jtag_reset(int trst, int srst)
1523 tap_set_state(TAP_RESET);
1524 high_output &= ~nTRST;
1528 high_output |= nTRST;
1533 high_output &= ~nSRST;
1537 high_output |= nSRST;
1540 /* command "set data bits low byte" */
1542 buffer_write(high_output);
1543 buffer_write(high_direction);
1544 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output,
1548 static void flyswatter_reset(int trst, int srst)
1552 low_output &= ~nTRST;
1556 low_output |= nTRST;
1561 low_output |= nSRST;
1565 low_output &= ~nSRST;
1568 /* command "set data bits low byte" */
1570 buffer_write(low_output);
1571 buffer_write(low_direction);
1572 LOG_DEBUG("trst: %i, srst: %i, low_output: 0x%2.2x, low_direction: 0x%2.2x", trst, srst, low_output, low_direction);
1575 static void minimodule_reset(int trst, int srst)
1579 low_output &= ~nSRST;
1583 low_output |= nSRST;
1586 /* command "set data bits low byte" */
1588 buffer_write(low_output);
1589 buffer_write(low_direction);
1590 LOG_DEBUG("trst: %i, srst: %i, low_output: 0x%2.2x, low_direction: 0x%2.2x", trst, srst, low_output, low_direction);
1593 static void turtle_reset(int trst, int srst)
1599 low_output |= nSRST;
1603 low_output &= ~nSRST;
1606 /* command "set data bits low byte" */
1608 buffer_write(low_output);
1609 buffer_write(low_direction);
1610 LOG_DEBUG("srst: %i, low_output: 0x%2.2x, low_direction: 0x%2.2x", srst, low_output, low_direction);
1613 static void comstick_reset(int trst, int srst)
1617 high_output &= ~nTRST;
1621 high_output |= nTRST;
1626 high_output &= ~nSRST;
1630 high_output |= nSRST;
1633 /* command "set data bits high byte" */
1635 buffer_write(high_output);
1636 buffer_write(high_direction);
1637 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output,
1641 static void stm32stick_reset(int trst, int srst)
1645 high_output &= ~nTRST;
1649 high_output |= nTRST;
1654 low_output &= ~nSRST;
1658 low_output |= nSRST;
1661 /* command "set data bits low byte" */
1663 buffer_write(low_output);
1664 buffer_write(low_direction);
1666 /* command "set data bits high byte" */
1668 buffer_write(high_output);
1669 buffer_write(high_direction);
1670 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output,
1674 static void sheevaplug_reset(int trst, int srst)
1677 high_output &= ~nTRST;
1679 high_output |= nTRST;
1682 high_output &= ~nSRSTnOE;
1684 high_output |= nSRSTnOE;
1686 /* command "set data bits high byte" */
1688 buffer_write(high_output);
1689 buffer_write(high_direction);
1690 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output, high_direction);
1693 static void redbee_reset(int trst, int srst)
1697 tap_set_state(TAP_RESET);
1698 high_output &= ~nTRST;
1702 high_output |= nTRST;
1707 high_output &= ~nSRST;
1711 high_output |= nSRST;
1714 /* command "set data bits low byte" */
1716 buffer_write(high_output);
1717 buffer_write(high_direction);
1718 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, "
1719 "high_direction: 0x%2.2x", trst, srst, high_output,
1723 static void xds100v2_reset(int trst, int srst)
1727 tap_set_state(TAP_RESET);
1728 high_output &= ~nTRST;
1732 high_output |= nTRST;
1737 high_output |= nSRST;
1741 high_output &= ~nSRST;
1744 /* command "set data bits low byte" */
1746 buffer_write(high_output);
1747 buffer_write(high_direction);
1748 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, "
1749 "high_direction: 0x%2.2x", trst, srst, high_output,
1753 static int ft2232_execute_runtest(struct jtag_command *cmd)
1757 int predicted_size = 0;
1760 DEBUG_JTAG_IO("runtest %i cycles, end in %s",
1761 cmd->cmd.runtest->num_cycles,
1762 tap_state_name(cmd->cmd.runtest->end_state));
1764 /* only send the maximum buffer size that FT2232C can handle */
1766 if (tap_get_state() != TAP_IDLE)
1767 predicted_size += 3;
1768 predicted_size += 3 * DIV_ROUND_UP(cmd->cmd.runtest->num_cycles, 7);
1769 if (cmd->cmd.runtest->end_state != TAP_IDLE)
1770 predicted_size += 3;
1771 if (tap_get_end_state() != TAP_IDLE)
1772 predicted_size += 3;
1773 if (ft2232_buffer_size + predicted_size + 1 > FT2232_BUFFER_SIZE)
1775 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
1776 retval = ERROR_JTAG_QUEUE_FAILED;
1780 if (tap_get_state() != TAP_IDLE)
1782 move_to_state(TAP_IDLE);
1785 i = cmd->cmd.runtest->num_cycles;
1788 /* there are no state transitions in this code, so omit state tracking */
1790 /* command "Clock Data to TMS/CS Pin (no Read)" */
1794 buffer_write((i > 7) ? 6 : (i - 1));
1799 i -= (i > 7) ? 7 : i;
1800 /* LOG_DEBUG("added TMS scan (no read)"); */
1803 ft2232_end_state(cmd->cmd.runtest->end_state);
1805 if (tap_get_state() != tap_get_end_state())
1807 move_to_state(tap_get_end_state());
1811 DEBUG_JTAG_IO("runtest: %i, end in %s",
1812 cmd->cmd.runtest->num_cycles,
1813 tap_state_name(tap_get_end_state()));
1817 static int ft2232_execute_statemove(struct jtag_command *cmd)
1819 int predicted_size = 0;
1820 int retval = ERROR_OK;
1822 DEBUG_JTAG_IO("statemove end in %s",
1823 tap_state_name(cmd->cmd.statemove->end_state));
1825 /* only send the maximum buffer size that FT2232C can handle */
1827 if (ft2232_buffer_size + predicted_size + 1 > FT2232_BUFFER_SIZE)
1829 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
1830 retval = ERROR_JTAG_QUEUE_FAILED;
1834 ft2232_end_state(cmd->cmd.statemove->end_state);
1836 /* For TAP_RESET, ignore the current recorded state. It's often
1837 * wrong at server startup, and this transation is critical whenever
1840 if (tap_get_end_state() == TAP_RESET) {
1841 clock_tms(0x4b, 0xff, 5, 0);
1844 /* shortest-path move to desired end state */
1845 } else if (tap_get_state() != tap_get_end_state())
1847 move_to_state(tap_get_end_state());
1855 * Clock a bunch of TMS (or SWDIO) transitions, to change the JTAG
1856 * (or SWD) state machine.
1858 static int ft2232_execute_tms(struct jtag_command *cmd)
1860 int retval = ERROR_OK;
1861 unsigned num_bits = cmd->cmd.tms->num_bits;
1862 const uint8_t *bits = cmd->cmd.tms->bits;
1865 DEBUG_JTAG_IO("TMS: %d bits", num_bits);
1867 /* only send the maximum buffer size that FT2232C can handle */
1868 count = 3 * DIV_ROUND_UP(num_bits, 4);
1869 if (ft2232_buffer_size + 3*count + 1 > FT2232_BUFFER_SIZE) {
1870 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
1871 retval = ERROR_JTAG_QUEUE_FAILED;
1877 /* Shift out in batches of at most 6 bits; there's a report of an
1878 * FT2232 bug in this area, where shifting exactly 7 bits can make
1879 * problems with TMS signaling for the last clock cycle:
1881 * http://developer.intra2net.com/mailarchive/html/
1882 * libftdi/2009/msg00292.html
1884 * Command 0x4b is: "Clock Data to TMS/CS Pin (no Read)"
1886 * Note that pathmoves in JTAG are not often seven bits, so that
1887 * isn't a particularly likely situation outside of "special"
1888 * signaling such as switching between JTAG and SWD modes.
1891 if (num_bits <= 6) {
1893 buffer_write(num_bits - 1);
1894 buffer_write(*bits & 0x3f);
1898 /* Yes, this is lazy ... we COULD shift out more data
1899 * bits per operation, but doing it in nybbles is easy
1903 buffer_write(*bits & 0xf);
1906 count = (num_bits > 4) ? 4 : num_bits;
1909 buffer_write(count - 1);
1910 buffer_write((*bits >> 4) & 0xf);
1920 static int ft2232_execute_pathmove(struct jtag_command *cmd)
1922 int predicted_size = 0;
1923 int retval = ERROR_OK;
1925 tap_state_t* path = cmd->cmd.pathmove->path;
1926 int num_states = cmd->cmd.pathmove->num_states;
1928 DEBUG_JTAG_IO("pathmove: %i states, current: %s end: %s", num_states,
1929 tap_state_name(tap_get_state()),
1930 tap_state_name(path[num_states-1]));
1932 /* only send the maximum buffer size that FT2232C can handle */
1933 predicted_size = 3 * DIV_ROUND_UP(num_states, 7);
1934 if (ft2232_buffer_size + predicted_size + 1 > FT2232_BUFFER_SIZE)
1936 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
1937 retval = ERROR_JTAG_QUEUE_FAILED;
1943 ft2232_add_pathmove(path, num_states);
1949 static int ft2232_execute_scan(struct jtag_command *cmd)
1952 int scan_size; /* size of IR or DR scan */
1953 int predicted_size = 0;
1954 int retval = ERROR_OK;
1956 enum scan_type type = jtag_scan_type(cmd->cmd.scan);
1958 DEBUG_JTAG_IO("%s type:%d", cmd->cmd.scan->ir_scan ? "IRSCAN" : "DRSCAN", type);
1960 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
1962 predicted_size = ft2232_predict_scan_out(scan_size, type);
1963 if ((predicted_size + 1) > FT2232_BUFFER_SIZE)
1965 LOG_DEBUG("oversized ft2232 scan (predicted_size > FT2232_BUFFER_SIZE)");
1966 /* unsent commands before this */
1967 if (first_unsent != cmd)
1968 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
1969 retval = ERROR_JTAG_QUEUE_FAILED;
1971 /* current command */
1972 ft2232_end_state(cmd->cmd.scan->end_state);
1973 ft2232_large_scan(cmd->cmd.scan, type, buffer, scan_size);
1975 first_unsent = cmd->next;
1980 else if (ft2232_buffer_size + predicted_size + 1 > FT2232_BUFFER_SIZE)
1982 LOG_DEBUG("ft2232 buffer size reached, sending queued commands (first_unsent: %p, cmd: %p)",
1985 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
1986 retval = ERROR_JTAG_QUEUE_FAILED;
1990 ft2232_expect_read += ft2232_predict_scan_in(scan_size, type);
1991 /* LOG_DEBUG("new read size: %i", ft2232_expect_read); */
1992 ft2232_end_state(cmd->cmd.scan->end_state);
1993 ft2232_add_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
1997 DEBUG_JTAG_IO("%s scan, %i bits, end in %s",
1998 (cmd->cmd.scan->ir_scan) ? "IR" : "DR", scan_size,
1999 tap_state_name(tap_get_end_state()));
2004 static int ft2232_execute_reset(struct jtag_command *cmd)
2007 int predicted_size = 0;
2010 DEBUG_JTAG_IO("reset trst: %i srst %i",
2011 cmd->cmd.reset->trst, cmd->cmd.reset->srst);
2013 /* only send the maximum buffer size that FT2232C can handle */
2015 if (ft2232_buffer_size + predicted_size + 1 > FT2232_BUFFER_SIZE)
2017 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
2018 retval = ERROR_JTAG_QUEUE_FAILED;
2023 if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
2025 tap_set_state(TAP_RESET);
2028 layout->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
2031 DEBUG_JTAG_IO("trst: %i, srst: %i",
2032 cmd->cmd.reset->trst, cmd->cmd.reset->srst);
2036 static int ft2232_execute_sleep(struct jtag_command *cmd)
2041 DEBUG_JTAG_IO("sleep %" PRIi32, cmd->cmd.sleep->us);
2043 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
2044 retval = ERROR_JTAG_QUEUE_FAILED;
2045 first_unsent = cmd->next;
2046 jtag_sleep(cmd->cmd.sleep->us);
2047 DEBUG_JTAG_IO("sleep %" PRIi32 " usec while in %s",
2049 tap_state_name(tap_get_state()));
2053 static int ft2232_execute_stableclocks(struct jtag_command *cmd)
2058 /* this is only allowed while in a stable state. A check for a stable
2059 * state was done in jtag_add_clocks()
2061 if (ft2232_stableclocks(cmd->cmd.stableclocks->num_cycles, cmd) != ERROR_OK)
2062 retval = ERROR_JTAG_QUEUE_FAILED;
2063 DEBUG_JTAG_IO("clocks %i while in %s",
2064 cmd->cmd.stableclocks->num_cycles,
2065 tap_state_name(tap_get_state()));
2069 static int ft2232_execute_command(struct jtag_command *cmd)
2075 case JTAG_RESET: retval = ft2232_execute_reset(cmd); break;
2076 case JTAG_RUNTEST: retval = ft2232_execute_runtest(cmd); break;
2077 case JTAG_TLR_RESET: retval = ft2232_execute_statemove(cmd); break;
2078 case JTAG_PATHMOVE: retval = ft2232_execute_pathmove(cmd); break;
2079 case JTAG_SCAN: retval = ft2232_execute_scan(cmd); break;
2080 case JTAG_SLEEP: retval = ft2232_execute_sleep(cmd); break;
2081 case JTAG_STABLECLOCKS: retval = ft2232_execute_stableclocks(cmd); break;
2083 retval = ft2232_execute_tms(cmd);
2086 LOG_ERROR("BUG: unknown JTAG command type encountered");
2087 retval = ERROR_JTAG_QUEUE_FAILED;
2093 static int ft2232_execute_queue(void)
2095 struct jtag_command* cmd = jtag_command_queue; /* currently processed command */
2098 first_unsent = cmd; /* next command that has to be sent */
2101 /* return ERROR_OK, unless ft2232_send_and_recv reports a failed check
2102 * that wasn't handled by a caller-provided error handler
2106 ft2232_buffer_size = 0;
2107 ft2232_expect_read = 0;
2109 /* blink, if the current layout has that feature */
2115 /* fill the write buffer with the desired command */
2116 if (ft2232_execute_command(cmd) != ERROR_OK)
2117 retval = ERROR_JTAG_QUEUE_FAILED;
2118 /* Start reading input before FT2232 TX buffer fills up.
2119 * Sometimes this happens because we don't know the
2120 * length of the last command before we execute it. So
2121 * we simple inform the user.
2125 if (ft2232_expect_read >= FT2232_BUFFER_READ_QUEUE_SIZE )
2127 if (ft2232_expect_read > (FT2232_BUFFER_READ_QUEUE_SIZE+1) )
2128 LOG_DEBUG("read buffer size looks too high %d/%d",ft2232_expect_read,(FT2232_BUFFER_READ_QUEUE_SIZE+1));
2129 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
2130 retval = ERROR_JTAG_QUEUE_FAILED;
2135 if (require_send > 0)
2136 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
2137 retval = ERROR_JTAG_QUEUE_FAILED;
2142 #if BUILD_FT2232_FTD2XX == 1
2143 static int ft2232_init_ftd2xx(uint16_t vid, uint16_t pid, int more, int* try_more)
2147 char SerialNumber[16];
2148 char Description[64];
2149 DWORD openex_flags = 0;
2150 char* openex_string = NULL;
2151 uint8_t latency_timer;
2153 if (layout == NULL) {
2154 LOG_WARNING("No ft2232 layout specified'");
2155 return ERROR_JTAG_INIT_FAILED;
2158 LOG_DEBUG("'ft2232' interface using FTD2XX with '%s' layout (%4.4x:%4.4x)", layout->name, vid, pid);
2161 /* Add non-standard Vid/Pid to the linux driver */
2162 if ((status = FT_SetVIDPID(vid, pid)) != FT_OK)
2164 LOG_WARNING("couldn't add %4.4x:%4.4x", vid, pid);
2168 if (ft2232_device_desc && ft2232_serial)
2170 LOG_WARNING("can't open by device description and serial number, giving precedence to serial");
2171 ft2232_device_desc = NULL;
2174 if (ft2232_device_desc)
2176 openex_string = ft2232_device_desc;
2177 openex_flags = FT_OPEN_BY_DESCRIPTION;
2179 else if (ft2232_serial)
2181 openex_string = ft2232_serial;
2182 openex_flags = FT_OPEN_BY_SERIAL_NUMBER;
2186 LOG_ERROR("neither device description nor serial number specified");
2187 LOG_ERROR("please add \"ft2232_device_desc <string>\" or \"ft2232_serial <string>\" to your .cfg file");
2189 return ERROR_JTAG_INIT_FAILED;
2192 status = FT_OpenEx(openex_string, openex_flags, &ftdih);
2193 if (status != FT_OK) {
2194 /* under Win32, the FTD2XX driver appends an "A" to the end
2195 * of the description, if we tried by the desc, then
2196 * try by the alternate "A" description. */
2197 if (openex_string == ft2232_device_desc) {
2198 /* Try the alternate method. */
2199 openex_string = ft2232_device_desc_A;
2200 status = FT_OpenEx(openex_string, openex_flags, &ftdih);
2201 if (status == FT_OK) {
2202 /* yea, the "alternate" method worked! */
2204 /* drat, give the user a meaningfull message.
2205 * telling the use we tried *BOTH* methods. */
2206 LOG_WARNING("Unable to open FTDI Device tried: '%s' and '%s'",
2208 ft2232_device_desc_A);
2213 if (status != FT_OK)
2219 LOG_WARNING("unable to open ftdi device (trying more): %s",
2220 ftd2xx_status_string(status));
2222 return ERROR_JTAG_INIT_FAILED;
2224 LOG_ERROR("unable to open ftdi device: %s",
2225 ftd2xx_status_string(status));
2226 status = FT_ListDevices(&num_devices, NULL, FT_LIST_NUMBER_ONLY);
2227 if (status == FT_OK)
2229 char** desc_array = malloc(sizeof(char*) * (num_devices + 1));
2232 for (i = 0; i < num_devices; i++)
2233 desc_array[i] = malloc(64);
2235 desc_array[num_devices] = NULL;
2237 status = FT_ListDevices(desc_array, &num_devices, FT_LIST_ALL | openex_flags);
2239 if (status == FT_OK)
2241 LOG_ERROR("ListDevices: %" PRIu32, (uint32_t)num_devices);
2242 for (i = 0; i < num_devices; i++)
2243 LOG_ERROR("%" PRIu32 ": \"%s\"", i, desc_array[i]);
2246 for (i = 0; i < num_devices; i++)
2247 free(desc_array[i]);
2253 LOG_ERROR("ListDevices: NONE");
2255 return ERROR_JTAG_INIT_FAILED;
2258 if ((status = FT_SetLatencyTimer(ftdih, ft2232_latency)) != FT_OK)
2260 LOG_ERROR("unable to set latency timer: %s",
2261 ftd2xx_status_string(status));
2262 return ERROR_JTAG_INIT_FAILED;
2265 if ((status = FT_GetLatencyTimer(ftdih, &latency_timer)) != FT_OK)
2267 /* ftd2xx 1.04 (linux) has a bug when calling FT_GetLatencyTimer
2268 * so ignore errors if using this driver version */
2271 status = FT_GetDriverVersion(ftdih, &dw_version);
2272 LOG_ERROR("unable to get latency timer: %s",
2273 ftd2xx_status_string(status));
2275 if ((status == FT_OK) && (dw_version == 0x10004)) {
2276 LOG_ERROR("ftd2xx 1.04 detected - this has known issues " \
2277 "with FT_GetLatencyTimer, upgrade to a newer version");
2280 return ERROR_JTAG_INIT_FAILED;
2285 LOG_DEBUG("current latency timer: %i", latency_timer);
2288 if ((status = FT_SetTimeouts(ftdih, 5000, 5000)) != FT_OK)
2290 LOG_ERROR("unable to set timeouts: %s",
2291 ftd2xx_status_string(status));
2292 return ERROR_JTAG_INIT_FAILED;
2295 if ((status = FT_SetBitMode(ftdih, 0x0b, 2)) != FT_OK)
2297 LOG_ERROR("unable to enable bit i/o mode: %s",
2298 ftd2xx_status_string(status));
2299 return ERROR_JTAG_INIT_FAILED;
2302 if ((status = FT_GetDeviceInfo(ftdih, &ftdi_device, &deviceID, SerialNumber, Description, NULL)) != FT_OK)
2304 LOG_ERROR("unable to get FT_GetDeviceInfo: %s",
2305 ftd2xx_status_string(status));
2306 return ERROR_JTAG_INIT_FAILED;
2310 static const char* type_str[] =
2311 {"BM", "AM", "100AX", "UNKNOWN", "2232C", "232R", "2232H", "4232H"};
2312 unsigned no_of_known_types = ARRAY_SIZE(type_str) - 1;
2313 unsigned type_index = ((unsigned)ftdi_device <= no_of_known_types)
2314 ? ftdi_device : FT_DEVICE_UNKNOWN;
2315 LOG_INFO("device: %" PRIu32 " \"%s\"", (uint32_t)ftdi_device, type_str[type_index]);
2316 LOG_INFO("deviceID: %" PRIu32, (uint32_t)deviceID);
2317 LOG_INFO("SerialNumber: %s", SerialNumber);
2318 LOG_INFO("Description: %s", Description);
2324 static int ft2232_purge_ftd2xx(void)
2328 if ((status = FT_Purge(ftdih, FT_PURGE_RX | FT_PURGE_TX)) != FT_OK)
2330 LOG_ERROR("error purging ftd2xx device: %s",
2331 ftd2xx_status_string(status));
2332 return ERROR_JTAG_INIT_FAILED;
2338 #endif /* BUILD_FT2232_FTD2XX == 1 */
2340 #if BUILD_FT2232_LIBFTDI == 1
2341 static int ft2232_init_libftdi(uint16_t vid, uint16_t pid, int more, int* try_more, int channel)
2343 uint8_t latency_timer;
2345 if (layout == NULL) {
2346 LOG_WARNING("No ft2232 layout specified'");
2347 return ERROR_JTAG_INIT_FAILED;
2350 LOG_DEBUG("'ft2232' interface using libftdi with '%s' layout (%4.4x:%4.4x)",
2351 layout->name, vid, pid);
2353 if (ftdi_init(&ftdic) < 0)
2354 return ERROR_JTAG_INIT_FAILED;
2356 /* default to INTERFACE_A */
2357 if(channel == INTERFACE_ANY) { channel = INTERFACE_A; }
2359 if (ftdi_set_interface(&ftdic, channel) < 0)
2361 LOG_ERROR("unable to select FT2232 channel A: %s", ftdic.error_str);
2362 return ERROR_JTAG_INIT_FAILED;
2365 /* context, vendor id, product id */
2366 if (ftdi_usb_open_desc(&ftdic, vid, pid, ft2232_device_desc,
2370 LOG_WARNING("unable to open ftdi device (trying more): %s",
2373 LOG_ERROR("unable to open ftdi device: %s", ftdic.error_str);
2375 return ERROR_JTAG_INIT_FAILED;
2378 /* There is already a reset in ftdi_usb_open_desc, this should be redundant */
2379 if (ftdi_usb_reset(&ftdic) < 0)
2381 LOG_ERROR("unable to reset ftdi device");
2382 return ERROR_JTAG_INIT_FAILED;
2385 if (ftdi_set_latency_timer(&ftdic, ft2232_latency) < 0)
2387 LOG_ERROR("unable to set latency timer");
2388 return ERROR_JTAG_INIT_FAILED;
2391 if (ftdi_get_latency_timer(&ftdic, &latency_timer) < 0)
2393 LOG_ERROR("unable to get latency timer");
2394 return ERROR_JTAG_INIT_FAILED;
2398 LOG_DEBUG("current latency timer: %i", latency_timer);
2401 ftdi_set_bitmode(&ftdic, 0x0b, 2); /* ctx, JTAG I/O mask */
2403 ftdi_device = ftdic.type;
2404 static const char* type_str[] =
2405 {"AM", "BM", "2232C", "R", "2232H", "4232H", "Unknown"};
2406 unsigned no_of_known_types = ARRAY_SIZE(type_str) - 1;
2407 unsigned type_index = ((unsigned)ftdi_device < no_of_known_types)
2408 ? ftdi_device : no_of_known_types;
2409 LOG_DEBUG("FTDI chip type: %i \"%s\"", (int)ftdi_device, type_str[type_index]);
2413 static int ft2232_purge_libftdi(void)
2415 if (ftdi_usb_purge_buffers(&ftdic) < 0)
2417 LOG_ERROR("ftdi_purge_buffers: %s", ftdic.error_str);
2418 return ERROR_JTAG_INIT_FAILED;
2424 #endif /* BUILD_FT2232_LIBFTDI == 1 */
2426 static int ft2232_set_data_bits_low_byte( uint8_t value, uint8_t direction )
2429 uint32_t bytes_written;
2431 buf[0] = 0x80; /* command "set data bits low byte" */
2432 buf[1] = value; /* value */
2433 buf[2] = direction; /* direction */
2435 LOG_DEBUG("%2.2x %2.2x %2.2x", buf[0], buf[1], buf[2]);
2437 if (ft2232_write(buf, sizeof(buf), &bytes_written) != ERROR_OK)
2439 LOG_ERROR("couldn't initialize data bits low byte");
2440 return ERROR_JTAG_INIT_FAILED;
2446 static int ft2232_set_data_bits_high_byte( uint8_t value, uint8_t direction )
2449 uint32_t bytes_written;
2451 buf[0] = 0x82; /* command "set data bits high byte" */
2452 buf[1] = value; /* value */
2453 buf[2] = direction; /* direction */
2455 LOG_DEBUG("%2.2x %2.2x %2.2x", buf[0], buf[1], buf[2]);
2457 if (ft2232_write(buf, sizeof(buf), &bytes_written) != ERROR_OK)
2459 LOG_ERROR("couldn't initialize data bits high byte");
2460 return ERROR_JTAG_INIT_FAILED;
2466 static int ft2232_init(void)
2470 uint32_t bytes_written;
2472 if (tap_get_tms_path_len(TAP_IRPAUSE,TAP_IRPAUSE) == 7)
2474 LOG_DEBUG("ft2232 interface using 7 step jtag state transitions");
2478 LOG_DEBUG("ft2232 interface using shortest path jtag state transitions");
2481 if (layout == NULL) {
2482 LOG_WARNING("No ft2232 layout specified'");
2483 return ERROR_JTAG_INIT_FAILED;
2486 for (int i = 0; 1; i++)
2489 * "more indicates that there are more IDs to try, so we should
2490 * not print an error for an ID mismatch (but for anything
2493 * try_more indicates that the error code returned indicates an
2494 * ID mismatch (and nothing else) and that we should proceeed
2495 * with the next ID pair.
2497 int more = ft2232_vid[i + 1] || ft2232_pid[i + 1];
2500 #if BUILD_FT2232_FTD2XX == 1
2501 retval = ft2232_init_ftd2xx(ft2232_vid[i], ft2232_pid[i],
2503 #elif BUILD_FT2232_LIBFTDI == 1
2504 retval = ft2232_init_libftdi(ft2232_vid[i], ft2232_pid[i],
2505 more, &try_more, layout->channel);
2509 if (!more || !try_more)
2513 ft2232_buffer_size = 0;
2514 ft2232_buffer = malloc(FT2232_BUFFER_SIZE);
2516 if (layout->init() != ERROR_OK)
2517 return ERROR_JTAG_INIT_FAILED;
2519 if (ft2232_device_is_highspeed())
2521 #ifndef BUILD_FT2232_HIGHSPEED
2522 #if BUILD_FT2232_FTD2XX == 1
2523 LOG_WARNING("High Speed device found - You need a newer FTD2XX driver (version 2.04.16 or later)");
2524 #elif BUILD_FT2232_LIBFTDI == 1
2525 LOG_WARNING("High Speed device found - You need a newer libftdi version (0.16 or later)");
2528 /* make sure the legacy mode is disabled */
2529 if (ft2232h_ft4232h_clk_divide_by_5(false) != ERROR_OK)
2530 return ERROR_JTAG_INIT_FAILED;
2533 buf[0] = 0x85; /* Disconnect TDI/DO to TDO/DI for Loopback */
2534 if ((retval = ft2232_write(buf, 1, &bytes_written)) != ERROR_OK)
2536 LOG_ERROR("couldn't write to FT2232 to disable loopback");
2537 return ERROR_JTAG_INIT_FAILED;
2540 #if BUILD_FT2232_FTD2XX == 1
2541 return ft2232_purge_ftd2xx();
2542 #elif BUILD_FT2232_LIBFTDI == 1
2543 return ft2232_purge_libftdi();
2549 /** Updates defaults for DBUS signals: the four JTAG signals
2550 * (TCK, TDI, TDO, TMS) and * the four GPIOL signals.
2552 static inline void ftx232_dbus_init(void)
2555 low_direction = 0x0b;
2558 /** Initializes DBUS signals: the four JTAG signals (TCK, TDI, TDO, TMS),
2559 * the four GPIOL signals. Initialization covers value and direction,
2560 * as customized for each layout.
2562 static int ftx232_dbus_write(void)
2564 enum reset_types jtag_reset_config = jtag_get_reset_config();
2565 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
2567 low_direction &= ~nTRSTnOE; /* nTRST input */
2568 low_output &= ~nTRST; /* nTRST = 0 */
2572 low_direction |= nTRSTnOE; /* nTRST output */
2573 low_output |= nTRST; /* nTRST = 1 */
2576 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
2578 low_direction |= nSRSTnOE; /* nSRST output */
2579 low_output |= nSRST; /* nSRST = 1 */
2583 low_direction &= ~nSRSTnOE; /* nSRST input */
2584 low_output &= ~nSRST; /* nSRST = 0 */
2587 /* initialize low byte for jtag */
2588 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2590 LOG_ERROR("couldn't initialize FT2232 DBUS");
2591 return ERROR_JTAG_INIT_FAILED;
2597 static int usbjtag_init(void)
2600 * NOTE: This is now _specific_ to the "usbjtag" layout.
2601 * Don't try cram any more layouts into this.
2610 return ftx232_dbus_write();
2613 static int lm3s811_jtag_init(void)
2617 /* There are multiple revisions of LM3S811 eval boards:
2618 * - Rev B (and older?) boards have no SWO trace support.
2619 * - Rev C boards add ADBUS_6 DBG_ENn and BDBUS_4 SWO_EN;
2620 * they should use the "luminary_icdi" layout instead.
2627 low_direction = 0x8b;
2629 return ftx232_dbus_write();
2632 static int icdi_jtag_init(void)
2636 /* Most Luminary eval boards support SWO trace output,
2637 * and should use this "luminary_icdi" layout.
2639 * ADBUS 0..3 are used for JTAG as usual. GPIOs are used
2640 * to switch between JTAG and SWD, or switch the ft2232 UART
2641 * on the second MPSSE channel/interface (BDBUS)
2642 * between (i) the stellaris UART (on Luminary boards)
2643 * or (ii) SWO trace data (generic).
2645 * We come up in JTAG mode and may switch to SWD later (with
2646 * SWO/trace option if SWD is active).
2653 #define ICDI_JTAG_EN (1 << 7) /* ADBUS 7 (a.k.a. DBGMOD) */
2654 #define ICDI_DBG_ENn (1 << 6) /* ADBUS 6 */
2655 #define ICDI_SRST (1 << 5) /* ADBUS 5 */
2658 /* GPIOs on second channel/interface (UART) ... */
2659 #define ICDI_SWO_EN (1 << 4) /* BDBUS 4 */
2660 #define ICDI_TX_SWO (1 << 1) /* BDBUS 1 */
2661 #define ICDI_VCP_RX (1 << 0) /* BDBUS 0 (to stellaris UART) */
2666 nSRSTnOE = ICDI_SRST;
2668 low_direction |= ICDI_JTAG_EN | ICDI_DBG_ENn;
2669 low_output |= ICDI_JTAG_EN;
2670 low_output &= ~ICDI_DBG_ENn;
2672 return ftx232_dbus_write();
2675 static int signalyzer_init(void)
2683 return ftx232_dbus_write();
2686 static int axm0432_jtag_init(void)
2689 low_direction = 0x2b;
2691 /* initialize low byte for jtag */
2692 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2694 LOG_ERROR("couldn't initialize FT2232 with 'JTAGkey' layout");
2695 return ERROR_JTAG_INIT_FAILED;
2698 if (strcmp(layout->name, "axm0432_jtag") == 0)
2701 nTRSTnOE = 0x0; /* No output enable for TRST*/
2703 nSRSTnOE = 0x0; /* No output enable for SRST*/
2707 LOG_ERROR("BUG: axm0432_jtag_init called for non axm0432 layout");
2712 high_direction = 0x0c;
2714 enum reset_types jtag_reset_config = jtag_get_reset_config();
2715 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
2717 LOG_ERROR("can't set nTRSTOE to push-pull on the Dicarlo jtag");
2721 high_output |= nTRST;
2724 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
2726 LOG_ERROR("can't set nSRST to push-pull on the Dicarlo jtag");
2730 high_output |= nSRST;
2733 /* initialize high byte for jtag */
2734 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2736 LOG_ERROR("couldn't initialize FT2232 with 'Dicarlo' layout");
2737 return ERROR_JTAG_INIT_FAILED;
2743 static int redbee_init(void)
2746 low_direction = 0x2b;
2748 /* initialize low byte for jtag */
2749 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2751 LOG_ERROR("couldn't initialize FT2232 with 'redbee' layout");
2752 return ERROR_JTAG_INIT_FAILED;
2756 nTRSTnOE = 0x0; /* No output enable for TRST*/
2758 nSRSTnOE = 0x0; /* No output enable for SRST*/
2761 high_direction = 0x0c;
2763 enum reset_types jtag_reset_config = jtag_get_reset_config();
2764 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
2766 LOG_ERROR("can't set nTRSTOE to push-pull on redbee");
2770 high_output |= nTRST;
2773 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
2775 LOG_ERROR("can't set nSRST to push-pull on redbee");
2779 high_output |= nSRST;
2782 /* initialize high byte for jtag */
2783 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2785 LOG_ERROR("couldn't initialize FT2232 with 'redbee' layout");
2786 return ERROR_JTAG_INIT_FAILED;
2792 static int jtagkey_init(void)
2795 low_direction = 0x1b;
2797 /* initialize low byte for jtag */
2798 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2800 LOG_ERROR("couldn't initialize FT2232 with 'JTAGkey' layout");
2801 return ERROR_JTAG_INIT_FAILED;
2804 if (strcmp(layout->name, "jtagkey") == 0)
2811 else if ((strcmp(layout->name, "jtagkey_prototype_v1") == 0)
2812 || (strcmp(layout->name, "oocdlink") == 0))
2821 LOG_ERROR("BUG: jtagkey_init called for non jtagkey layout");
2826 high_direction = 0x0f;
2828 enum reset_types jtag_reset_config = jtag_get_reset_config();
2829 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
2831 high_output |= nTRSTnOE;
2832 high_output &= ~nTRST;
2836 high_output &= ~nTRSTnOE;
2837 high_output |= nTRST;
2840 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
2842 high_output &= ~nSRSTnOE;
2843 high_output |= nSRST;
2847 high_output |= nSRSTnOE;
2848 high_output &= ~nSRST;
2851 /* initialize high byte for jtag */
2852 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2854 LOG_ERROR("couldn't initialize FT2232 with 'JTAGkey' layout");
2855 return ERROR_JTAG_INIT_FAILED;
2861 static int olimex_jtag_init(void)
2864 low_direction = 0x1b;
2866 /* initialize low byte for jtag */
2867 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2869 LOG_ERROR("couldn't initialize FT2232 with 'Olimex' layout");
2870 return ERROR_JTAG_INIT_FAILED;
2876 nSRSTnOE = 0x00; /* no output enable for nSRST */
2879 high_direction = 0x0f;
2881 enum reset_types jtag_reset_config = jtag_get_reset_config();
2882 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
2884 high_output |= nTRSTnOE;
2885 high_output &= ~nTRST;
2889 high_output &= ~nTRSTnOE;
2890 high_output |= nTRST;
2893 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
2895 LOG_ERROR("can't set nSRST to push-pull on the Olimex ARM-USB-OCD");
2899 high_output &= ~nSRST;
2902 /* turn red LED on */
2903 high_output |= 0x08;
2905 /* initialize high byte for jtag */
2906 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2908 LOG_ERROR("couldn't initialize FT2232 with 'Olimex' layout");
2909 return ERROR_JTAG_INIT_FAILED;
2915 static int flyswatter_init(void)
2918 low_direction = 0xfb;
2920 /* initialize low byte for jtag */
2921 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2923 LOG_ERROR("couldn't initialize FT2232 with 'flyswatter' layout");
2924 return ERROR_JTAG_INIT_FAILED;
2928 nTRSTnOE = 0x0; /* not output enable for nTRST */
2930 nSRSTnOE = 0x00; /* no output enable for nSRST */
2933 high_direction = 0x0c;
2935 /* turn red LED3 on, LED2 off */
2936 high_output |= 0x08;
2938 /* initialize high byte for jtag */
2939 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2941 LOG_ERROR("couldn't initialize FT2232 with 'flyswatter' layout");
2942 return ERROR_JTAG_INIT_FAILED;
2948 static int minimodule_init(void)
2950 low_output = 0x18;//check if srst should be 1 or 0 initially. (0x08) (flyswatter was 0x18)
2951 low_direction = 0xfb;//0xfb;
2953 /* initialize low byte for jtag */
2954 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2956 LOG_ERROR("couldn't initialize FT2232 with 'minimodule' layout");
2957 return ERROR_JTAG_INIT_FAILED;
2964 high_direction = 0x05;
2966 /* turn red LED3 on, LED2 off */
2967 //high_output |= 0x08;
2969 /* initialize high byte for jtag */
2970 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2972 LOG_ERROR("couldn't initialize FT2232 with 'minimodule' layout");
2973 return ERROR_JTAG_INIT_FAILED;
2979 static int turtle_init(void)
2982 low_direction = 0x5b;
2984 /* initialize low byte for jtag */
2985 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
2987 LOG_ERROR("couldn't initialize FT2232 with 'turtelizer2' layout");
2988 return ERROR_JTAG_INIT_FAILED;
2994 high_direction = 0x0C;
2996 /* initialize high byte for jtag */
2997 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
2999 LOG_ERROR("couldn't initialize FT2232 with 'turtelizer2' layout");
3000 return ERROR_JTAG_INIT_FAILED;
3006 static int comstick_init(void)
3009 low_direction = 0x0b;
3011 /* initialize low byte for jtag */
3012 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
3014 LOG_ERROR("couldn't initialize FT2232 with 'comstick' layout");
3015 return ERROR_JTAG_INIT_FAILED;
3019 nTRSTnOE = 0x00; /* no output enable for nTRST */
3021 nSRSTnOE = 0x00; /* no output enable for nSRST */
3024 high_direction = 0x03;
3026 /* initialize high byte for jtag */
3027 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3029 LOG_ERROR("couldn't initialize FT2232 with 'comstick' layout");
3030 return ERROR_JTAG_INIT_FAILED;
3036 static int stm32stick_init(void)
3039 low_direction = 0x8b;
3041 /* initialize low byte for jtag */
3042 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
3044 LOG_ERROR("couldn't initialize FT2232 with 'stm32stick' layout");
3045 return ERROR_JTAG_INIT_FAILED;
3049 nTRSTnOE = 0x00; /* no output enable for nTRST */
3051 nSRSTnOE = 0x00; /* no output enable for nSRST */
3054 high_direction = 0x03;
3056 /* initialize high byte for jtag */
3057 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3059 LOG_ERROR("couldn't initialize FT2232 with 'stm32stick' layout");
3060 return ERROR_JTAG_INIT_FAILED;
3066 static int sheevaplug_init(void)
3069 low_direction = 0x1b;
3071 /* initialize low byte for jtag */
3072 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
3074 LOG_ERROR("couldn't initialize FT2232 with 'sheevaplug' layout");
3075 return ERROR_JTAG_INIT_FAILED;
3084 high_direction = 0x0f;
3086 /* nTRST is always push-pull */
3087 high_output &= ~nTRSTnOE;
3088 high_output |= nTRST;
3090 /* nSRST is always open-drain */
3091 high_output |= nSRSTnOE;
3092 high_output &= ~nSRST;
3094 /* initialize high byte for jtag */
3095 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3097 LOG_ERROR("couldn't initialize FT2232 with 'sheevaplug' layout");
3098 return ERROR_JTAG_INIT_FAILED;
3104 static int cortino_jtag_init(void)
3107 low_direction = 0x1b;
3109 /* initialize low byte for jtag */
3110 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
3112 LOG_ERROR("couldn't initialize FT2232 with 'cortino' layout");
3113 return ERROR_JTAG_INIT_FAILED;
3117 nTRSTnOE = 0x00; /* no output enable for nTRST */
3119 nSRSTnOE = 0x00; /* no output enable for nSRST */
3122 high_direction = 0x03;
3124 /* initialize high byte for jtag */
3125 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3127 LOG_ERROR("couldn't initialize FT2232 with 'cortino' layout");
3128 return ERROR_JTAG_INIT_FAILED;
3134 static int lisa_l_init(void)
3144 high_direction = 0x18;
3146 /* initialize high byte for jtag */
3147 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3149 LOG_ERROR("couldn't initialize FT2232 with 'lisa_l' layout");
3150 return ERROR_JTAG_INIT_FAILED;
3153 return ftx232_dbus_write();
3156 static int flossjtag_init(void)
3166 high_direction = 0x18;
3168 /* initialize high byte for jtag */
3169 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3171 LOG_ERROR("couldn't initialize FT2232 with 'Floss-JTAG' layout");
3172 return ERROR_JTAG_INIT_FAILED;
3175 return ftx232_dbus_write();
3178 static int xds100v2_init(void)
3181 low_direction = 0x7B;
3183 /* initialize low byte for jtag */
3184 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
3186 LOG_ERROR("couldn't initialize FT2232 with 'xds100v2' layout");
3187 return ERROR_JTAG_INIT_FAILED;
3191 nTRSTnOE = 0x0; /* not output enable for nTRST */
3192 nSRST = 0x00; /* TODO: SRST is not supported yet */
3193 nSRSTnOE = 0x00; /* no output enable for nSRST */
3196 high_direction = 0x59;
3198 /* initialize high byte for jtag */
3199 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3201 LOG_ERROR("couldn't initialize FT2232 with 'xds100v2' layout");
3202 return ERROR_JTAG_INIT_FAILED;
3206 high_direction = 0x59;
3208 /* initialize high byte for jtag */
3209 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
3211 LOG_ERROR("couldn't initialize FT2232 with 'xds100v2' layout");
3212 return ERROR_JTAG_INIT_FAILED;
3218 static void olimex_jtag_blink(void)
3220 /* Olimex ARM-USB-OCD has a LED connected to ACBUS3
3221 * ACBUS3 is bit 3 of the GPIOH port
3223 high_output ^= 0x08;
3226 buffer_write(high_output);
3227 buffer_write(high_direction);
3230 static void flyswatter_jtag_blink(void)
3233 * Flyswatter has two LEDs connected to ACBUS2 and ACBUS3
3235 high_output ^= 0x0c;
3238 buffer_write(high_output);
3239 buffer_write(high_direction);
3242 static void turtle_jtag_blink(void)
3245 * Turtelizer2 has two LEDs connected to ACBUS2 and ACBUS3
3247 if (high_output & 0x08)
3257 buffer_write(high_output);
3258 buffer_write(high_direction);
3261 static void lisa_l_blink(void)
3264 * Lisa/L has two LEDs connected to BCBUS3 and BCBUS4
3266 if (high_output & 0x10)
3276 buffer_write(high_output);
3277 buffer_write(high_direction);
3280 static void flossjtag_blink(void)
3283 * Floss-JTAG has two LEDs connected to ACBUS3 and ACBUS4
3285 if (high_output & 0x10)
3295 buffer_write(high_output);
3296 buffer_write(high_direction);
3299 static int ft2232_quit(void)
3301 #if BUILD_FT2232_FTD2XX == 1
3304 status = FT_Close(ftdih);
3305 #elif BUILD_FT2232_LIBFTDI == 1
3306 ftdi_usb_close(&ftdic);
3308 ftdi_deinit(&ftdic);
3311 free(ft2232_buffer);
3312 ft2232_buffer = NULL;
3317 COMMAND_HANDLER(ft2232_handle_device_desc_command)
3323 ft2232_device_desc = strdup(CMD_ARGV[0]);
3324 cp = strchr(ft2232_device_desc, 0);
3325 /* under Win32, the FTD2XX driver appends an "A" to the end
3326 * of the description, this examines the given desc
3327 * and creates the 'missing' _A or non_A variable. */
3328 if ((cp[-1] == 'A') && (cp[-2]==' ')) {
3329 /* it was, so make this the "A" version. */
3330 ft2232_device_desc_A = ft2232_device_desc;
3331 /* and *CREATE* the non-A version. */
3332 strcpy(buf, ft2232_device_desc);
3333 cp = strchr(buf, 0);
3335 ft2232_device_desc = strdup(buf);
3337 /* <space > A not defined
3339 sprintf(buf, "%s A", ft2232_device_desc);
3340 ft2232_device_desc_A = strdup(buf);
3345 LOG_ERROR("expected exactly one argument to ft2232_device_desc <description>");
3351 COMMAND_HANDLER(ft2232_handle_serial_command)
3355 ft2232_serial = strdup(CMD_ARGV[0]);
3359 LOG_ERROR("expected exactly one argument to ft2232_serial <serial-number>");
3365 COMMAND_HANDLER(ft2232_handle_layout_command)
3367 if (CMD_ARGC != 1) {
3368 LOG_ERROR("Need exactly one argument to ft2232_layout");
3373 LOG_ERROR("already specified ft2232_layout %s",
3375 return (strcmp(layout->name, CMD_ARGV[0]) != 0)
3380 for (const struct ft2232_layout *l = ft2232_layouts; l->name; l++) {
3381 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
3387 LOG_ERROR("No FT2232 layout '%s' found", CMD_ARGV[0]);
3391 COMMAND_HANDLER(ft2232_handle_vid_pid_command)
3393 if (CMD_ARGC > MAX_USB_IDS * 2)
3395 LOG_WARNING("ignoring extra IDs in ft2232_vid_pid "
3396 "(maximum is %d pairs)", MAX_USB_IDS);
3397 CMD_ARGC = MAX_USB_IDS * 2;
3399 if (CMD_ARGC < 2 || (CMD_ARGC & 1))
3401 LOG_WARNING("incomplete ft2232_vid_pid configuration directive");
3403 return ERROR_COMMAND_SYNTAX_ERROR;
3404 /* remove the incomplete trailing id */
3409 for (i = 0; i < CMD_ARGC; i += 2)
3411 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i], ft2232_vid[i >> 1]);
3412 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], ft2232_pid[i >> 1]);
3416 * Explicitly terminate, in case there are multiples instances of
3419 ft2232_vid[i >> 1] = ft2232_pid[i >> 1] = 0;
3424 COMMAND_HANDLER(ft2232_handle_latency_command)
3428 ft2232_latency = atoi(CMD_ARGV[0]);
3432 LOG_ERROR("expected exactly one argument to ft2232_latency <ms>");
3438 static int ft2232_stableclocks(int num_cycles, struct jtag_command* cmd)
3442 /* 7 bits of either ones or zeros. */
3443 uint8_t tms = (tap_get_state() == TAP_RESET ? 0x7F : 0x00);
3445 while (num_cycles > 0)
3447 /* the command 0x4b, "Clock Data to TMS/CS Pin (no Read)" handles
3448 * at most 7 bits per invocation. Here we invoke it potentially
3451 int bitcount_per_command = (num_cycles > 7) ? 7 : num_cycles;
3453 if (ft2232_buffer_size + 3 >= FT2232_BUFFER_SIZE)
3455 if (ft2232_send_and_recv(first_unsent, cmd) != ERROR_OK)
3456 retval = ERROR_JTAG_QUEUE_FAILED;
3461 /* there are no state transitions in this code, so omit state tracking */
3463 /* command "Clock Data to TMS/CS Pin (no Read)" */
3467 buffer_write(bitcount_per_command - 1);
3469 /* TMS data bits are either all zeros or ones to stay in the current stable state */
3474 num_cycles -= bitcount_per_command;
3480 /* ---------------------------------------------------------------------
3481 * Support for IceBear JTAG adapter from Section5:
3482 * http://section5.ch/icebear
3484 * Author: Sten, debian@sansys-electronic.com
3487 /* Icebear pin layout
3489 * ADBUS5 (nEMU) nSRST | 2 1| GND (10k->VCC)
3490 * GND GND | 4 3| n.c.
3491 * ADBUS3 TMS | 6 5| ADBUS6 VCC
3492 * ADBUS0 TCK | 8 7| ADBUS7 (GND)
3493 * ADBUS4 nTRST |10 9| ACBUS0 (GND)
3494 * ADBUS1 TDI |12 11| ACBUS1 (GND)
3495 * ADBUS2 TDO |14 13| GND GND
3497 * ADBUS0 O L TCK ACBUS0 GND
3498 * ADBUS1 O L TDI ACBUS1 GND
3499 * ADBUS2 I TDO ACBUS2 n.c.
3500 * ADBUS3 O H TMS ACBUS3 n.c.
3506 static int icebear_jtag_init(void) {
3507 low_direction = 0x0b; /* output: TCK TDI TMS; input: TDO */
3508 low_output = 0x08; /* high: TMS; low: TCK TDI */
3512 enum reset_types jtag_reset_config = jtag_get_reset_config();
3513 if ((jtag_reset_config & RESET_TRST_OPEN_DRAIN) != 0) {
3514 low_direction &= ~nTRST; /* nTRST high impedance */
3517 low_direction |= nTRST;
3518 low_output |= nTRST;
3521 low_direction |= nSRST;
3522 low_output |= nSRST;
3524 /* initialize low byte for jtag */
3525 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK) {
3526 LOG_ERROR("couldn't initialize FT2232 with 'IceBear' layout (low)");
3527 return ERROR_JTAG_INIT_FAILED;
3531 high_direction = 0x00;
3533 /* initialize high byte for jtag */
3534 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK) {
3535 LOG_ERROR("couldn't initialize FT2232 with 'IceBear' layout (high)");
3536 return ERROR_JTAG_INIT_FAILED;
3542 static void icebear_jtag_reset(int trst, int srst) {
3545 low_direction |= nTRST;
3546 low_output &= ~nTRST;
3548 else if (trst == 0) {
3549 enum reset_types jtag_reset_config = jtag_get_reset_config();
3550 if ((jtag_reset_config & RESET_TRST_OPEN_DRAIN) != 0)
3551 low_direction &= ~nTRST;
3553 low_output |= nTRST;
3557 low_output &= ~nSRST;
3559 else if (srst == 0) {
3560 low_output |= nSRST;
3563 /* command "set data bits low byte" */
3565 buffer_write(low_output);
3566 buffer_write(low_direction);
3568 LOG_DEBUG("trst: %i, srst: %i, low_output: 0x%2.2x, low_direction: 0x%2.2x", trst, srst, low_output, low_direction);
3571 /* ---------------------------------------------------------------------
3572 * Support for Signalyzer H2 and Signalyzer H4
3573 * JTAG adapter from Xverve Technologies Inc.
3574 * http://www.signalyzer.com or http://www.xverve.com
3576 * Author: Oleg Seiljus, oleg@signalyzer.com
3578 static unsigned char signalyzer_h_side;
3579 static unsigned int signalyzer_h_adapter_type;
3581 static int signalyzer_h_ctrl_write(int address, unsigned short value);
3583 #if BUILD_FT2232_FTD2XX == 1
3584 static int signalyzer_h_ctrl_read(int address, unsigned short *value);
3587 #define SIGNALYZER_COMMAND_ADDR 128
3588 #define SIGNALYZER_DATA_BUFFER_ADDR 129
3590 #define SIGNALYZER_COMMAND_VERSION 0x41
3591 #define SIGNALYZER_COMMAND_RESET 0x42
3592 #define SIGNALYZER_COMMAND_POWERCONTROL_GET 0x50
3593 #define SIGNALYZER_COMMAND_POWERCONTROL_SET 0x51
3594 #define SIGNALYZER_COMMAND_PWM_SET 0x52
3595 #define SIGNALYZER_COMMAND_LED_SET 0x53
3596 #define SIGNALYZER_COMMAND_ADC 0x54
3597 #define SIGNALYZER_COMMAND_GPIO_STATE 0x55
3598 #define SIGNALYZER_COMMAND_GPIO_MODE 0x56
3599 #define SIGNALYZER_COMMAND_GPIO_PORT 0x57
3600 #define SIGNALYZER_COMMAND_I2C 0x58
3602 #define SIGNALYZER_CHAN_A 1
3603 #define SIGNALYZER_CHAN_B 2
3604 /* LEDS use channel C */
3605 #define SIGNALYZER_CHAN_C 4
3607 #define SIGNALYZER_LED_GREEN 1
3608 #define SIGNALYZER_LED_RED 2
3610 #define SIGNALYZER_MODULE_TYPE_EM_LT16_A 0x0301
3611 #define SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG 0x0302
3612 #define SIGNALYZER_MODULE_TYPE_EM_JTAG 0x0303
3613 #define SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG_P 0x0304
3614 #define SIGNALYZER_MODULE_TYPE_EM_JTAG_P 0x0305
3617 static int signalyzer_h_ctrl_write(int address, unsigned short value)
3619 #if BUILD_FT2232_FTD2XX == 1
3620 return FT_WriteEE(ftdih, address, value);
3621 #elif BUILD_FT2232_LIBFTDI == 1
3626 #if BUILD_FT2232_FTD2XX == 1
3627 static int signalyzer_h_ctrl_read(int address, unsigned short *value)
3629 return FT_ReadEE(ftdih, address, value);
3633 static int signalyzer_h_led_set(unsigned char channel, unsigned char led,
3634 int on_time_ms, int off_time_ms, unsigned char cycles)
3636 unsigned char on_time;
3637 unsigned char off_time;
3639 if (on_time_ms < 0xFFFF)
3640 on_time = (unsigned char)(on_time_ms / 62);
3644 off_time = (unsigned char)(off_time_ms / 62);
3646 #if BUILD_FT2232_FTD2XX == 1
3649 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_DATA_BUFFER_ADDR,
3650 ((uint32_t)(channel << 8) | led))) != FT_OK)
3652 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3653 ftd2xx_status_string(status));
3654 return ERROR_JTAG_DEVICE_ERROR;
3657 if ((status = signalyzer_h_ctrl_write(
3658 (SIGNALYZER_DATA_BUFFER_ADDR + 1),
3659 ((uint32_t)(on_time << 8) | off_time))) != FT_OK)
3661 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3662 ftd2xx_status_string(status));
3663 return ERROR_JTAG_DEVICE_ERROR;
3666 if ((status = signalyzer_h_ctrl_write(
3667 (SIGNALYZER_DATA_BUFFER_ADDR + 2),
3668 ((uint32_t)cycles))) != FT_OK)
3670 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3671 ftd2xx_status_string(status));
3672 return ERROR_JTAG_DEVICE_ERROR;
3675 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3676 SIGNALYZER_COMMAND_LED_SET)) != FT_OK)
3678 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3679 ftd2xx_status_string(status));
3680 return ERROR_JTAG_DEVICE_ERROR;
3684 #elif BUILD_FT2232_LIBFTDI == 1
3687 if ((retval = signalyzer_h_ctrl_write(SIGNALYZER_DATA_BUFFER_ADDR,
3688 ((uint32_t)(channel << 8) | led))) < 0)
3690 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3691 ftdi_get_error_string(&ftdic));
3692 return ERROR_JTAG_DEVICE_ERROR;
3695 if ((retval = signalyzer_h_ctrl_write(
3696 (SIGNALYZER_DATA_BUFFER_ADDR + 1),
3697 ((uint32_t)(on_time << 8) | off_time))) < 0)
3699 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3700 ftdi_get_error_string(&ftdic));
3701 return ERROR_JTAG_DEVICE_ERROR;
3704 if ((retval = signalyzer_h_ctrl_write(
3705 (SIGNALYZER_DATA_BUFFER_ADDR + 2),
3706 (uint32_t)cycles)) < 0)
3708 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3709 ftdi_get_error_string(&ftdic));
3710 return ERROR_JTAG_DEVICE_ERROR;
3713 if ((retval = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3714 SIGNALYZER_COMMAND_LED_SET)) < 0)
3716 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3717 ftdi_get_error_string(&ftdic));
3718 return ERROR_JTAG_DEVICE_ERROR;
3725 static int signalyzer_h_init(void)
3727 #if BUILD_FT2232_FTD2XX == 1
3734 uint16_t read_buf[12] = { 0 };
3736 /* turn on center green led */
3737 signalyzer_h_led_set(SIGNALYZER_CHAN_C, SIGNALYZER_LED_GREEN,
3738 0xFFFF, 0x00, 0x00);
3740 /* determine what channel config wants to open
3741 * TODO: change me... current implementation is made to work
3742 * with openocd description parsing.
3744 end_of_desc = strrchr(ft2232_device_desc, 0x00);
3748 signalyzer_h_side = *(end_of_desc - 1);
3749 if (signalyzer_h_side == 'B')
3750 signalyzer_h_side = SIGNALYZER_CHAN_B;
3752 signalyzer_h_side = SIGNALYZER_CHAN_A;
3756 LOG_ERROR("No Channel was specified");
3760 signalyzer_h_led_set(signalyzer_h_side, SIGNALYZER_LED_GREEN,
3763 #if BUILD_FT2232_FTD2XX == 1
3764 /* read signalyzer versionining information */
3765 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3766 SIGNALYZER_COMMAND_VERSION)) != FT_OK)
3768 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3769 ftd2xx_status_string(status));
3770 return ERROR_JTAG_DEVICE_ERROR;
3773 for (i = 0; i < 10; i++)
3775 if ((status = signalyzer_h_ctrl_read(
3776 (SIGNALYZER_DATA_BUFFER_ADDR + i),
3777 &read_buf[i])) != FT_OK)
3779 LOG_ERROR("signalyzer_h_ctrl_read returned: %s",
3780 ftd2xx_status_string(status));
3781 return ERROR_JTAG_DEVICE_ERROR;
3785 LOG_INFO("Signalyzer: ID info: { %.4x %.4x %.4x %.4x %.4x %.4x %.4x }",
3786 read_buf[0], read_buf[1], read_buf[2], read_buf[3],
3787 read_buf[4], read_buf[5], read_buf[6]);
3789 /* set gpio register */
3790 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_DATA_BUFFER_ADDR,
3791 (uint32_t)(signalyzer_h_side << 8))) != FT_OK)
3793 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3794 ftd2xx_status_string(status));
3795 return ERROR_JTAG_DEVICE_ERROR;
3798 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_DATA_BUFFER_ADDR + 1,
3801 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3802 ftd2xx_status_string(status));
3803 return ERROR_JTAG_DEVICE_ERROR;
3806 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3807 SIGNALYZER_COMMAND_GPIO_STATE)) != FT_OK)
3809 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3810 ftd2xx_status_string(status));
3811 return ERROR_JTAG_DEVICE_ERROR;
3814 /* read adapter type information */
3815 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_DATA_BUFFER_ADDR,
3816 ((uint32_t)(signalyzer_h_side << 8) | 0x01))) != FT_OK)
3818 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3819 ftd2xx_status_string(status));
3820 return ERROR_JTAG_DEVICE_ERROR;
3823 if ((status = signalyzer_h_ctrl_write(
3824 (SIGNALYZER_DATA_BUFFER_ADDR + 1), 0xA000)) != FT_OK)
3826 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3827 ftd2xx_status_string(status));
3828 return ERROR_JTAG_DEVICE_ERROR;
3831 if ((status = signalyzer_h_ctrl_write(
3832 (SIGNALYZER_DATA_BUFFER_ADDR + 2), 0x0008)) != FT_OK)
3834 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3835 ftd2xx_status_string(status));
3836 return ERROR_JTAG_DEVICE_ERROR;
3839 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3840 SIGNALYZER_COMMAND_I2C)) != FT_OK)
3842 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3843 ftd2xx_status_string(status));
3844 return ERROR_JTAG_DEVICE_ERROR;
3849 if ((status = signalyzer_h_ctrl_read(SIGNALYZER_COMMAND_ADDR,
3850 &read_buf[0])) != FT_OK)
3852 LOG_ERROR("signalyzer_h_ctrl_read returned: %s",
3853 ftd2xx_status_string(status));
3854 return ERROR_JTAG_DEVICE_ERROR;
3857 if (read_buf[0] != 0x0498)
3858 signalyzer_h_adapter_type = 0x0000;
3861 for (i = 0; i < 4; i++)
3863 if ((status = signalyzer_h_ctrl_read(
3864 (SIGNALYZER_DATA_BUFFER_ADDR + i),
3865 &read_buf[i])) != FT_OK)
3867 LOG_ERROR("signalyzer_h_ctrl_read returned: %s",
3868 ftd2xx_status_string(status));
3869 return ERROR_JTAG_DEVICE_ERROR;
3873 signalyzer_h_adapter_type = read_buf[0];
3876 #elif BUILD_FT2232_LIBFTDI == 1
3877 /* currently libftdi does not allow reading individual eeprom
3878 * locations, therefore adapter type cannot be detected.
3879 * override with most common type
3881 signalyzer_h_adapter_type = SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG;
3884 enum reset_types jtag_reset_config = jtag_get_reset_config();
3886 /* ADAPTOR: EM_LT16_A */
3887 if (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_LT16_A)
3889 LOG_INFO("Signalyzer: EM-LT (16-channel level translator) "
3890 "detected. (HW: %2x).", (read_buf[1] >> 8));
3898 low_direction = 0x1b;
3901 high_direction = 0x0;
3903 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
3905 low_direction &= ~nTRSTnOE; /* nTRST input */
3906 low_output &= ~nTRST; /* nTRST = 0 */
3910 low_direction |= nTRSTnOE; /* nTRST output */
3911 low_output |= nTRST; /* nTRST = 1 */
3914 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
3916 low_direction |= nSRSTnOE; /* nSRST output */
3917 low_output |= nSRST; /* nSRST = 1 */
3921 low_direction &= ~nSRSTnOE; /* nSRST input */
3922 low_output &= ~nSRST; /* nSRST = 0 */
3925 #if BUILD_FT2232_FTD2XX == 1
3926 /* enable power to the module */
3927 if ((status = signalyzer_h_ctrl_write(
3928 SIGNALYZER_DATA_BUFFER_ADDR,
3929 ((uint32_t)(signalyzer_h_side << 8) | 0x01)))
3932 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3933 ftd2xx_status_string(status));
3934 return ERROR_JTAG_DEVICE_ERROR;
3937 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3938 SIGNALYZER_COMMAND_POWERCONTROL_SET)) != FT_OK)
3940 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3941 ftd2xx_status_string(status));
3942 return ERROR_JTAG_DEVICE_ERROR;
3945 /* set gpio mode register */
3946 if ((status = signalyzer_h_ctrl_write(
3947 SIGNALYZER_DATA_BUFFER_ADDR,
3948 (uint32_t)(signalyzer_h_side << 8))) != FT_OK)
3950 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3951 ftd2xx_status_string(status));
3952 return ERROR_JTAG_DEVICE_ERROR;
3955 if ((status = signalyzer_h_ctrl_write(
3956 SIGNALYZER_DATA_BUFFER_ADDR + 1, 0x0000))
3959 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3960 ftd2xx_status_string(status));
3961 return ERROR_JTAG_DEVICE_ERROR;
3964 if ((status = signalyzer_h_ctrl_write(SIGNALYZER_COMMAND_ADDR,
3965 SIGNALYZER_COMMAND_GPIO_MODE)) != FT_OK)
3967 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3968 ftd2xx_status_string(status));
3969 return ERROR_JTAG_DEVICE_ERROR;
3972 /* set gpio register */
3973 if ((status = signalyzer_h_ctrl_write(
3974 SIGNALYZER_DATA_BUFFER_ADDR,
3975 (uint32_t)(signalyzer_h_side << 8))) != FT_OK)
3977 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3978 ftd2xx_status_string(status));
3979 return ERROR_JTAG_DEVICE_ERROR;
3982 if ((status = signalyzer_h_ctrl_write(
3983 SIGNALYZER_DATA_BUFFER_ADDR + 1, 0x4040))
3986 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3987 ftd2xx_status_string(status));
3988 return ERROR_JTAG_DEVICE_ERROR;
3991 if ((status = signalyzer_h_ctrl_write(
3992 SIGNALYZER_COMMAND_ADDR,
3993 SIGNALYZER_COMMAND_GPIO_STATE)) != FT_OK)
3995 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
3996 ftd2xx_status_string(status));
3997 return ERROR_JTAG_DEVICE_ERROR;
4002 /* ADAPTOR: EM_ARM_JTAG, EM_ARM_JTAG_P, EM_JTAG, EM_JTAG_P */
4003 else if ((signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG) ||
4004 (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG_P) ||
4005 (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_JTAG) ||
4006 (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_JTAG_P))
4008 if (signalyzer_h_adapter_type
4009 == SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG)
4010 LOG_INFO("Signalyzer: EM-ARM-JTAG (ARM JTAG) "
4011 "detected. (HW: %2x).", (read_buf[1] >> 8));
4012 else if (signalyzer_h_adapter_type
4013 == SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG_P)
4014 LOG_INFO("Signalyzer: EM-ARM-JTAG_P "
4015 "(ARM JTAG with PSU) detected. (HW: %2x).",
4016 (read_buf[1] >> 8));
4017 else if (signalyzer_h_adapter_type
4018 == SIGNALYZER_MODULE_TYPE_EM_JTAG)
4019 LOG_INFO("Signalyzer: EM-JTAG (Generic JTAG) "
4020 "detected. (HW: %2x).", (read_buf[1] >> 8));
4021 else if (signalyzer_h_adapter_type
4022 == SIGNALYZER_MODULE_TYPE_EM_JTAG_P)
4023 LOG_INFO("Signalyzer: EM-JTAG-P "
4024 "(Generic JTAG with PSU) detected. (HW: %2x).",
4025 (read_buf[1] >> 8));
4033 low_direction = 0x1b;
4036 high_direction = 0x1f;
4038 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4040 high_output |= nTRSTnOE;
4041 high_output &= ~nTRST;
4045 high_output &= ~nTRSTnOE;
4046 high_output |= nTRST;
4049 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4051 high_output &= ~nSRSTnOE;
4052 high_output |= nSRST;
4056 high_output |= nSRSTnOE;
4057 high_output &= ~nSRST;
4060 #if BUILD_FT2232_FTD2XX == 1
4061 /* enable power to the module */
4062 if ((status = signalyzer_h_ctrl_write(
4063 SIGNALYZER_DATA_BUFFER_ADDR,
4064 ((uint32_t)(signalyzer_h_side << 8) | 0x01)))
4067 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4068 ftd2xx_status_string(status));
4069 return ERROR_JTAG_DEVICE_ERROR;
4072 if ((status = signalyzer_h_ctrl_write(
4073 SIGNALYZER_COMMAND_ADDR,
4074 SIGNALYZER_COMMAND_POWERCONTROL_SET)) != FT_OK)
4076 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4077 ftd2xx_status_string(status));
4078 return ERROR_JTAG_DEVICE_ERROR;
4081 /* set gpio mode register (IO_16 and IO_17 set as analog
4082 * inputs, other is gpio)
4084 if ((status = signalyzer_h_ctrl_write(
4085 SIGNALYZER_DATA_BUFFER_ADDR,
4086 (uint32_t)(signalyzer_h_side << 8))) != FT_OK)
4088 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4089 ftd2xx_status_string(status));
4090 return ERROR_JTAG_DEVICE_ERROR;
4093 if ((status = signalyzer_h_ctrl_write(
4094 SIGNALYZER_DATA_BUFFER_ADDR + 1, 0x0060))
4097 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4098 ftd2xx_status_string(status));
4099 return ERROR_JTAG_DEVICE_ERROR;
4102 if ((status = signalyzer_h_ctrl_write(
4103 SIGNALYZER_COMMAND_ADDR,
4104 SIGNALYZER_COMMAND_GPIO_MODE)) != FT_OK)
4106 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4107 ftd2xx_status_string(status));
4108 return ERROR_JTAG_DEVICE_ERROR;
4111 /* set gpio register (all inputs, for -P modules,
4112 * PSU will be turned off)
4114 if ((status = signalyzer_h_ctrl_write(
4115 SIGNALYZER_DATA_BUFFER_ADDR,
4116 (uint32_t)(signalyzer_h_side << 8))) != FT_OK)
4118 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4119 ftd2xx_status_string(status));
4120 return ERROR_JTAG_DEVICE_ERROR;
4123 if ((status = signalyzer_h_ctrl_write(
4124 SIGNALYZER_DATA_BUFFER_ADDR + 1, 0x0000))
4127 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4128 ftd2xx_status_string(status));
4129 return ERROR_JTAG_DEVICE_ERROR;
4132 if ((status = signalyzer_h_ctrl_write(
4133 SIGNALYZER_COMMAND_ADDR,
4134 SIGNALYZER_COMMAND_GPIO_STATE)) != FT_OK)
4136 LOG_ERROR("signalyzer_h_ctrl_write returned: %s",
4137 ftd2xx_status_string(status));
4138 return ERROR_JTAG_DEVICE_ERROR;
4143 else if (signalyzer_h_adapter_type == 0x0000)
4145 LOG_INFO("Signalyzer: No external modules were detected.");
4153 low_direction = 0x1b;
4156 high_direction = 0x0;
4158 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4160 low_direction &= ~nTRSTnOE; /* nTRST input */
4161 low_output &= ~nTRST; /* nTRST = 0 */
4165 low_direction |= nTRSTnOE; /* nTRST output */
4166 low_output |= nTRST; /* nTRST = 1 */
4169 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4171 low_direction |= nSRSTnOE; /* nSRST output */
4172 low_output |= nSRST; /* nSRST = 1 */
4176 low_direction &= ~nSRSTnOE; /* nSRST input */
4177 low_output &= ~nSRST; /* nSRST = 0 */
4182 LOG_ERROR("Unknown module type is detected: %.4x",
4183 signalyzer_h_adapter_type);
4184 return ERROR_JTAG_DEVICE_ERROR;
4187 /* initialize low byte of controller for jtag operation */
4188 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
4190 LOG_ERROR("couldn't initialize Signalyzer-H layout");
4191 return ERROR_JTAG_INIT_FAILED;
4194 #if BUILD_FT2232_FTD2XX == 1
4195 if (ftdi_device == FT_DEVICE_2232H)
4197 /* initialize high byte of controller for jtag operation */
4198 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
4200 LOG_ERROR("couldn't initialize Signalyzer-H layout");
4201 return ERROR_JTAG_INIT_FAILED;
4204 #elif BUILD_FT2232_LIBFTDI == 1
4205 if (ftdi_device == TYPE_2232H)
4207 /* initialize high byte of controller for jtag operation */
4208 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
4210 LOG_ERROR("couldn't initialize Signalyzer-H layout");
4211 return ERROR_JTAG_INIT_FAILED;
4218 static void signalyzer_h_reset(int trst, int srst)
4220 enum reset_types jtag_reset_config = jtag_get_reset_config();
4222 /* ADAPTOR: EM_LT16_A */
4223 if (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_LT16_A)
4227 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4228 /* switch to output pin (output is low) */
4229 low_direction |= nTRSTnOE;
4231 /* switch output low */
4232 low_output &= ~nTRST;
4236 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4237 /* switch to input pin (high-Z + internal
4238 * and external pullup) */
4239 low_direction &= ~nTRSTnOE;
4241 /* switch output high */
4242 low_output |= nTRST;
4247 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4248 /* switch output low */
4249 low_output &= ~nSRST;
4251 /* switch to output pin (output is low) */
4252 low_direction |= nSRSTnOE;
4256 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4257 /* switch output high */
4258 low_output |= nSRST;
4260 /* switch to input pin (high-Z) */
4261 low_direction &= ~nSRSTnOE;
4264 /* command "set data bits low byte" */
4266 buffer_write(low_output);
4267 buffer_write(low_direction);
4268 LOG_DEBUG("trst: %i, srst: %i, low_output: 0x%2.2x, "
4269 "low_direction: 0x%2.2x",
4270 trst, srst, low_output, low_direction);
4272 /* ADAPTOR: EM_ARM_JTAG, EM_ARM_JTAG_P, EM_JTAG, EM_JTAG_P */
4273 else if ((signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG) ||
4274 (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_ARM_JTAG_P) ||
4275 (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_JTAG) ||
4276 (signalyzer_h_adapter_type == SIGNALYZER_MODULE_TYPE_EM_JTAG_P))
4280 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4281 high_output &= ~nTRSTnOE;
4283 high_output &= ~nTRST;
4287 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4288 high_output |= nTRSTnOE;
4290 high_output |= nTRST;
4295 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4296 high_output &= ~nSRST;
4298 high_output &= ~nSRSTnOE;
4302 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4303 high_output |= nSRST;
4305 high_output |= nSRSTnOE;
4308 /* command "set data bits high byte" */
4310 buffer_write(high_output);
4311 buffer_write(high_direction);
4312 LOG_INFO("trst: %i, srst: %i, high_output: 0x%2.2x, "
4313 "high_direction: 0x%2.2x",
4314 trst, srst, high_output, high_direction);
4316 else if (signalyzer_h_adapter_type == 0x0000)
4320 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4321 /* switch to output pin (output is low) */
4322 low_direction |= nTRSTnOE;
4324 /* switch output low */
4325 low_output &= ~nTRST;
4329 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4330 /* switch to input pin (high-Z + internal
4331 * and external pullup) */
4332 low_direction &= ~nTRSTnOE;
4334 /* switch output high */
4335 low_output |= nTRST;
4340 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4341 /* switch output low */
4342 low_output &= ~nSRST;
4344 /* switch to output pin (output is low) */
4345 low_direction |= nSRSTnOE;
4349 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4350 /* switch output high */
4351 low_output |= nSRST;
4353 /* switch to input pin (high-Z) */
4354 low_direction &= ~nSRSTnOE;
4357 /* command "set data bits low byte" */
4359 buffer_write(low_output);
4360 buffer_write(low_direction);
4361 LOG_DEBUG("trst: %i, srst: %i, low_output: 0x%2.2x, "
4362 "low_direction: 0x%2.2x",
4363 trst, srst, low_output, low_direction);
4367 static void signalyzer_h_blink(void)
4369 signalyzer_h_led_set(signalyzer_h_side, SIGNALYZER_LED_RED, 100, 0, 1);
4372 /********************************************************************
4373 * Support for KT-LINK
4374 * JTAG adapter from KRISTECH
4375 * http://www.kristech.eu
4376 *******************************************************************/
4377 static int ktlink_init(void)
4379 uint8_t swd_en = 0x20; //0x20 SWD disable, 0x00 SWD enable (ADBUS5)
4381 low_output = 0x08 | swd_en; // value; TMS=1,TCK=0,TDI=0,SWD=swd_en
4382 low_direction = 0x3B; // out=1; TCK/TDI/TMS=out,TDO=in,SWD=out,RTCK=in,SRSTIN=in
4384 /* initialize low byte for jtag */
4385 if (ft2232_set_data_bits_low_byte(low_output,low_direction) != ERROR_OK)
4387 LOG_ERROR("couldn't initialize FT2232 with 'ktlink' layout");
4388 return ERROR_JTAG_INIT_FAILED;
4396 high_output = 0x80; // turn LED on
4397 high_direction = 0xFF; // all outputs
4399 enum reset_types jtag_reset_config = jtag_get_reset_config();
4401 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN) {
4402 high_output |= nTRSTnOE;
4403 high_output &= ~nTRST;
4405 high_output &= ~nTRSTnOE;
4406 high_output |= nTRST;
4409 if (jtag_reset_config & RESET_SRST_PUSH_PULL) {
4410 high_output &= ~nSRSTnOE;
4411 high_output |= nSRST;
4413 high_output |= nSRSTnOE;
4414 high_output &= ~nSRST;
4417 /* initialize high byte for jtag */
4418 if (ft2232_set_data_bits_high_byte(high_output,high_direction) != ERROR_OK)
4420 LOG_ERROR("couldn't initialize FT2232 with 'ktlink' layout");
4421 return ERROR_JTAG_INIT_FAILED;
4427 static void ktlink_reset(int trst, int srst)
4429 enum reset_types jtag_reset_config = jtag_get_reset_config();
4432 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4433 high_output &= ~nTRSTnOE;
4435 high_output &= ~nTRST;
4436 } else if (trst == 0) {
4437 if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
4438 high_output |= nTRSTnOE;
4440 high_output |= nTRST;
4444 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4445 high_output &= ~nSRST;
4447 high_output &= ~nSRSTnOE;
4448 } else if (srst == 0) {
4449 if (jtag_reset_config & RESET_SRST_PUSH_PULL)
4450 high_output |= nSRST;
4452 high_output |= nSRSTnOE;
4455 buffer_write(0x82); // command "set data bits high byte"
4456 buffer_write(high_output);
4457 buffer_write(high_direction);
4458 LOG_DEBUG("trst: %i, srst: %i, high_output: 0x%2.2x, high_direction: 0x%2.2x", trst, srst, high_output,high_direction);
4461 static void ktlink_blink(void)
4463 /* LED connected to ACBUS7 */
4464 high_output ^= 0x80;
4466 buffer_write(0x82); // command "set data bits high byte"
4467 buffer_write(high_output);
4468 buffer_write(high_direction);
4471 static const struct command_registration ft2232_command_handlers[] = {
4473 .name = "ft2232_device_desc",
4474 .handler = &ft2232_handle_device_desc_command,
4475 .mode = COMMAND_CONFIG,
4476 .help = "set the USB device description of the FTDI FT2232 device",
4477 .usage = "description_string",
4480 .name = "ft2232_serial",
4481 .handler = &ft2232_handle_serial_command,
4482 .mode = COMMAND_CONFIG,
4483 .help = "set the serial number of the FTDI FT2232 device",
4484 .usage = "serial_string",
4487 .name = "ft2232_layout",
4488 .handler = &ft2232_handle_layout_command,
4489 .mode = COMMAND_CONFIG,
4490 .help = "set the layout of the FT2232 GPIO signals used "
4491 "to control output-enables and reset signals",
4492 .usage = "layout_name",
4495 .name = "ft2232_vid_pid",
4496 .handler = &ft2232_handle_vid_pid_command,
4497 .mode = COMMAND_CONFIG,
4498 .help = "the vendor ID and product ID of the FTDI FT2232 device",
4499 .usage = "(vid pid)* ",
4502 .name = "ft2232_latency",
4503 .handler = &ft2232_handle_latency_command,
4504 .mode = COMMAND_CONFIG,
4505 .help = "set the FT2232 latency timer to a new value",
4508 COMMAND_REGISTRATION_DONE
4511 struct jtag_interface ft2232_interface = {
4513 .supported = DEBUG_CAP_TMS_SEQ,
4514 .commands = ft2232_command_handlers,
4515 .transports = jtag_only,
4517 .init = ft2232_init,
4518 .quit = ft2232_quit,
4519 .speed = ft2232_speed,
4520 .speed_div = ft2232_speed_div,
4522 .execute_queue = ft2232_execute_queue,