1 /***************************************************************************
2 * Copyright (C) 2007 by Pavel Chromy *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
29 #include "replacements.h"
31 /* project specific includes */
35 #include "configuration.h"
36 #include "time_support.h"
47 /* PRESTO access library includes */
48 #if BUILD_PRESTO_FTD2XX == 1
50 #elif BUILD_PRESTO_LIBFTDI == 1
53 #error "BUG: either FTD2XX and LIBFTDI has to be used"
57 int presto_jtag_speed(int speed);
58 int presto_jtag_register_commands(struct command_context_s *cmd_ctx);
59 int presto_jtag_init(void);
60 int presto_jtag_quit(void);
62 jtag_interface_t presto_interface =
65 .execute_queue = bitq_execute_queue,
66 .speed = presto_jtag_speed,
67 .register_commands = presto_jtag_register_commands,
68 .init = presto_jtag_init,
69 .quit = presto_jtag_quit,
73 int presto_bitq_out(int tms, int tdi, int tdo_req);
74 int presto_bitq_flush(void);
75 int presto_bitq_sleep(unsigned long us);
76 int presto_bitq_reset(int trst, int srst);
77 int presto_bitq_in_rdy(void);
78 int presto_bitq_in(void);
80 bitq_interface_t presto_bitq =
82 .out = presto_bitq_out,
83 .flush = presto_bitq_flush,
84 .sleep = presto_bitq_sleep,
85 .reset = presto_bitq_reset,
86 .in_rdy = presto_bitq_in_rdy,
91 /* -------------------------------------------------------------------------- */
94 #define FT_DEVICE_NAME_LEN 64
95 #define FT_DEVICE_SERNUM_LEN 64
97 #define PRESTO_VID_PID 0x0403f1a0
98 #define PRESTO_VID (0x0403)
99 #define PRESTO_PID (0xf1a0)
101 #define BUFFER_SIZE (64*62)
103 typedef struct presto_s
105 #if BUILD_PRESTO_FTD2XX == 1
108 #elif BUILD_PRESTO_LIBFTDI == 1
109 struct ftdi_context ftdic;
113 char serial[FT_DEVICE_SERNUM_LEN];
115 u8 buff_out[BUFFER_SIZE];
118 u8 buff_in[BUFFER_SIZE];
119 int buff_in_exp; /* expected in buffer length */
120 int buff_in_len; /* length of data received */
123 unsigned long total_out;
124 unsigned long total_in;
126 int jtag_tms; /* last tms state */
127 int jtag_tck; /* last tck state */
134 presto_t presto_state;
135 presto_t *presto = &presto_state;
137 u8 presto_init_seq[] =
139 0x80, 0xA0, 0xA8, 0xB0, 0xC0, 0xE0
142 int presto_write(u8 *buf, int size, u32* bytes_written)
144 #if BUILD_PRESTO_FTD2XX == 1
145 DWORD dw_bytes_written;
146 if ((presto->status = FT_Write(presto->handle, buf, size, &dw_bytes_written)) != FT_OK)
148 *bytes_written = dw_bytes_written;
149 ERROR("FT_Write returned: %lu", presto->status);
150 return ERROR_JTAG_DEVICE_ERROR;
154 *bytes_written = dw_bytes_written;
157 #elif BUILD_PRESTO_LIBFTDI == 1
158 if ((presto->retval = ftdi_write_data(&presto->ftdic, buf, size)) < 0)
161 ERROR("ftdi_write_data: %s", ftdi_get_error_string(&presto->ftdic));
162 return ERROR_JTAG_DEVICE_ERROR;
166 *bytes_written = presto->retval; /* FIXME: Correct? */
172 int presto_read(u8* buf, int size, u32* bytes_read)
174 #if BUILD_PRESTO_FTD2XX == 1
179 while ((*bytes_read < size) && timeout--)
181 if ((presto->status = FT_Read(presto->handle, buf + *bytes_read, size -
182 *bytes_read, &dw_bytes_read)) != FT_OK)
185 ERROR("FT_Read returned: %lu", presto->status);
186 return ERROR_JTAG_DEVICE_ERROR;
188 *bytes_read += dw_bytes_read;
190 #elif BUILD_PRESTO_LIBFTDI == 1
194 while ((*bytes_read < size) && timeout--)
196 if ((presto->retval = ftdi_read_data(&presto->ftdic, buf + *bytes_read, size - *bytes_read)) < 0)
199 ERROR("ftdi_read_data: %s", ftdi_get_error_string(&presto->ftdic));
200 return ERROR_JTAG_DEVICE_ERROR;
202 *bytes_read += presto->retval; /* FIXME: Correct? */
206 if (*bytes_read < size)
208 ERROR("couldn't read the requested number of bytes from PRESTO (%i < %i)", *bytes_read, size);
209 return ERROR_JTAG_DEVICE_ERROR;
215 #if BUILD_PRESTO_FTD2XX == 1
216 int presto_open_ftd2xx(char *req_serial)
221 char devname[FT_DEVICE_NAME_LEN];
225 unsigned long ftbytes;
227 presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
230 /* Add non-standard Vid/Pid to the linux driver */
231 if ((presto->status = FT_SetVIDPID(PRESTO_VID, PRESTO_PID)) != FT_OK)
233 ERROR("couldn't add PRESTO VID/PID");
238 if ((presto->status = FT_ListDevices(&numdevs, NULL, FT_LIST_NUMBER_ONLY)) != FT_OK)
240 ERROR("FT_ListDevices failed: %i", (int)presto->status);
241 return ERROR_JTAG_DEVICE_ERROR;
244 DEBUG("FTDI devices available: %i", numdevs);
245 for (i = 0; i < numdevs; i++)
247 if ((presto->status = FT_Open(i, &(presto->handle))) != FT_OK)
249 /* this is not fatal, the device may be legitimately open by other process, hence debug message only */
250 DEBUG("FT_Open failed: %i", (int)presto->status);
253 DEBUG("FTDI device %i open", i);
255 if ((presto->status = FT_GetDeviceInfo(presto->handle, &device, &vidpid,
256 presto->serial, devname, NULL)) == FT_OK)
258 if (vidpid == PRESTO_VID_PID
259 && (req_serial == NULL || !strcmp(presto->serial, req_serial)))
263 DEBUG("FT_GetDeviceInfo failed: %i", presto->status);
265 DEBUG("FTDI device %i does not match, closing", i);
266 FT_Close(presto->handle);
267 presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
270 if (presto->handle == (FT_HANDLE)INVALID_HANDLE_VALUE)
271 return ERROR_JTAG_DEVICE_ERROR; /* presto not open, return */
273 if ((presto->status = FT_SetLatencyTimer(presto->handle, 1)) != FT_OK)
274 return ERROR_JTAG_DEVICE_ERROR;
277 if ((presto->status = FT_SetTimeouts(presto->handle, 100, 0)) != FT_OK)
278 return ERROR_JTAG_DEVICE_ERROR;
280 if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
281 return ERROR_JTAG_DEVICE_ERROR;
284 if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
285 return ERROR_JTAG_DEVICE_ERROR;
287 /* delay between first write/read turnaround (after purge?) necessary under Linux for unknown reason,
288 probably a bug in library threading */
290 if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
291 return ERROR_JTAG_DEVICE_ERROR;
295 DEBUG("PRESTO reset");
297 if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
298 return ERROR_JTAG_DEVICE_ERROR;
299 if ((presto->status = FT_SetBitMode(presto->handle, 0x80, 1)) != FT_OK)
300 return ERROR_JTAG_DEVICE_ERROR;
301 if ((presto->status = FT_SetBaudRate(presto->handle, 9600)) != FT_OK)
302 return ERROR_JTAG_DEVICE_ERROR;
305 for (i = 0; i < 4 * 62; i++)
306 if ((presto->status=FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
307 return ERROR_JTAG_DEVICE_ERROR;
311 if ((presto->status = FT_SetBitMode(presto->handle, 0x00, 0)) != FT_OK)
312 return ERROR_JTAG_DEVICE_ERROR;
314 if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
315 return ERROR_JTAG_DEVICE_ERROR;
318 if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
319 return ERROR_JTAG_DEVICE_ERROR;
321 /* delay between first write/read turnaround (after purge?) necessary under Linux for unknown reason,
322 probably a bug in library threading */
324 if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
325 return ERROR_JTAG_DEVICE_ERROR;
329 DEBUG("PRESTO not responding");
330 return ERROR_JTAG_DEVICE_ERROR;
334 if ((presto->status = FT_SetTimeouts(presto->handle, 0, 0)) != FT_OK)
335 return ERROR_JTAG_DEVICE_ERROR;
338 presto->status = FT_Write(presto->handle, &presto_init_seq, sizeof(presto_init_seq), &ftbytes);
339 if (presto->status != FT_OK || ftbytes != sizeof(presto_init_seq))
340 return ERROR_JTAG_DEVICE_ERROR;
345 #elif BUILD_PRESTO_LIBFTDI == 1
346 int presto_open_libftdi(char *req_serial)
351 DEBUG("searching for presto JTAG interface using libftdi");
353 /* context, vendor id, product id */
354 if (ftdi_usb_open_desc(&presto->ftdic, PRESTO_VID, PRESTO_PID, NULL, req_serial) < 0)
356 ERROR("unable to open presto: %s", presto->ftdic.error_str);
357 return ERROR_JTAG_DEVICE_ERROR;
360 if (ftdi_usb_reset(&presto->ftdic) < 0)
362 ERROR("unable to reset presto device");
363 return ERROR_JTAG_DEVICE_ERROR;
366 if (ftdi_set_latency_timer(&presto->ftdic, 1) < 0)
368 ERROR("unable to set latency timer");
369 return ERROR_JTAG_DEVICE_ERROR;
372 if (ftdi_usb_purge_buffers(&presto->ftdic) < 0)
374 ERROR("unable to purge presto buffer");
375 return ERROR_JTAG_DEVICE_ERROR;
379 if ((presto->retval = presto_write(&presto_data, 1, &ftbytes)) != ERROR_OK)
380 return ERROR_JTAG_DEVICE_ERROR;
381 if ((presto->retval = presto_read(&presto_data, 1, &ftbytes)) != ERROR_OK)
382 return ERROR_JTAG_DEVICE_ERROR;
386 #endif /* BUILD_PRESTO_LIBFTDI == 1 */
388 int presto_open(char *req_serial)
390 presto->buff_out_pos=0;
391 presto->buff_in_pos=0;
392 presto->buff_in_len=0;
393 presto->buff_in_exp=0;
400 presto->jtag_tdi_data=0;
401 presto->jtag_tdi_count=0;
403 #if BUILD_PRESTO_FTD2XX == 1
404 return presto_open_ftd2xx(req_serial);
405 #elif BUILD_PRESTO_LIBFTDI == 1
406 return presto_open_libftdi(req_serial);
410 int presto_close(void)
413 int result = ERROR_OK;
415 #if BUILD_PRESTO_FTD2XX == 1
416 unsigned long ftbytes;
418 if (presto->handle == (FT_HANDLE)INVALID_HANDLE_VALUE)
421 presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX);
422 if (presto->status != FT_OK)
423 result = ERROR_JTAG_DEVICE_ERROR;
425 presto->status = FT_Write(presto->handle, &presto_init_seq, sizeof(presto_init_seq), &ftbytes);
426 if (presto->status != FT_OK || ftbytes != sizeof(presto_init_seq))
427 result = ERROR_JTAG_DEVICE_ERROR;
429 if ((presto->status = FT_SetLatencyTimer(presto->handle, 16)) != FT_OK)
430 result = ERROR_JTAG_DEVICE_ERROR;
432 if ((presto->status = FT_Close(presto->handle)) != FT_OK)
433 result = ERROR_JTAG_DEVICE_ERROR;
435 presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
437 #elif BUILD_PRESTO_LIBFTDI == 1
439 if ((presto->retval = ftdi_write_data(&presto->ftdic, presto_init_seq, sizeof(presto_init_seq))) < 0)
441 result = ERROR_JTAG_DEVICE_ERROR;
444 if ((presto->retval = ftdi_set_latency_timer(&presto->ftdic, 16)) < 0)
446 result = ERROR_JTAG_DEVICE_ERROR;
449 ftdi_deinit(&presto->ftdic);
457 int presto_flush(void)
461 if (presto->buff_out_pos == 0)
464 #if BUILD_PRESTO_FTD2XX == 1
465 if (presto->status != FT_OK)
466 #elif BUILD_PRESTO_LIBFTDI == 1
467 if (presto->retval != ERROR_OK)
469 return ERROR_JTAG_DEVICE_ERROR;
472 if (presto_write(presto->buff_out, presto->buff_out_pos, &ftbytes) != ERROR_OK)
474 presto->buff_out_pos = 0;
475 return ERROR_JTAG_DEVICE_ERROR;
478 presto->total_out += ftbytes;
480 if (presto->buff_out_pos != ftbytes)
482 presto->buff_out_pos = 0;
483 return ERROR_JTAG_DEVICE_ERROR;
486 presto->buff_out_pos = 0;
488 if (presto->buff_in_exp == 0)
491 presto->buff_in_pos = 0;
492 presto->buff_in_len = 0;
494 if (presto_read(presto->buff_in, presto->buff_in_exp, &ftbytes) != ERROR_OK)
496 presto->buff_in_exp = 0;
497 return ERROR_JTAG_DEVICE_ERROR;
500 presto->total_in += ftbytes;
502 if (ftbytes != presto->buff_in_exp)
504 presto->buff_in_exp = 0;
505 return ERROR_JTAG_DEVICE_ERROR;
508 presto->buff_in_len = presto->buff_in_exp;
509 presto->buff_in_exp = 0;
515 int presto_sendbyte(int data)
517 if (data == EOF) return presto_flush();
519 if (presto->buff_out_pos < BUFFER_SIZE)
521 presto->buff_out[presto->buff_out_pos++] = (u8)data;
522 if (((data & 0xC0) == 0x40) || ((data & 0xD0)== 0xD0))
523 presto->buff_in_exp++;
526 return ERROR_JTAG_DEVICE_ERROR;
528 if (presto->buff_out_pos >= BUFFER_SIZE)
529 return presto_flush();
535 int presto_getbyte(void)
537 if (presto->buff_in_pos < presto->buff_in_len)
538 return presto->buff_in[presto->buff_in_pos++];
540 if (presto->buff_in_exp == 0)
543 if (presto_flush() != ERROR_OK)
546 if (presto->buff_in_pos<presto->buff_in_len)
547 return presto->buff_in[presto->buff_in_pos++];
553 /* -------------------------------------------------------------------------- */
556 int presto_bitq_out(int tms, int tdi, int tdo_req)
558 unsigned char cmdparam;
560 if (presto->jtag_tck == 0)
562 presto_sendbyte(0xA4);
563 presto->jtag_tck = 1;
566 else if (!tdo_req && tms == presto->jtag_tms)
568 if (presto->jtag_tdi_count == 0)
569 presto->jtag_tdi_data = (tdi != 0);
571 presto->jtag_tdi_data |= (tdi != 0) << presto->jtag_tdi_count;
573 if (++presto->jtag_tdi_count == 4)
575 presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
576 presto_sendbyte(presto->jtag_tdi_data);
577 presto->jtag_tdi_count = 0;
582 if (presto->jtag_tdi_count)
584 presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
585 presto_sendbyte(presto->jtag_tdi_data);
586 presto->jtag_tdi_count = 0;
594 presto_sendbyte( 0xC0 | cmdparam);
596 if (tms != presto->jtag_tms)
599 presto_sendbyte(0xEC);
601 presto_sendbyte(0xE8);
602 presto->jtag_tms = tms;
606 presto_sendbyte(0xD4 | cmdparam);
608 presto_sendbyte(0xC4|cmdparam);
614 int presto_bitq_flush(void)
616 if (presto->jtag_tdi_count)
618 presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
619 presto_sendbyte(presto->jtag_tdi_data);
620 presto->jtag_tdi_count = 0;
623 presto_sendbyte(0xCA);
624 presto->jtag_tck = 0;
626 presto_sendbyte(0xA0);
628 return presto_flush();
632 int presto_bitq_in_rdy(void)
634 if (presto->buff_in_pos>=presto->buff_in_len)
636 return presto->buff_in_len-presto->buff_in_pos;
640 int presto_bitq_in(void)
642 if (presto->buff_in_pos>=presto->buff_in_len)
644 if (presto->buff_in[presto->buff_in_pos++]&0x08) return 1;
649 int presto_bitq_sleep(unsigned long us)
660 waits = us / 170 + 2;
662 presto_sendbyte(0x80);
668 int presto_bitq_reset(int trst, int srst)
673 if (presto->jtag_tms)
679 presto_sendbyte(cmd);
684 /* -------------------------------------------------------------------------- */
686 char *presto_speed_text[4] =
694 int presto_jtag_speed(int speed)
697 if ((speed < 0) || (speed > 3))
699 INFO("valid speed values: 0 (3 MHz), 1 (1.5 MHz), 2 (750 kHz) and 3 (93.75 kHz)");
700 return ERROR_INVALID_ARGUMENTS;
704 INFO("setting speed to %d, max. TCK freq. is %s", speed, presto_speed_text[speed]);
705 return presto_sendbyte(0xA8 | speed);
711 int presto_handle_serial_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
717 presto_serial = strdup(args[0]);
721 ERROR("expected exactly one argument to presto_serial <serial-number>");
728 int presto_jtag_register_commands(struct command_context_s *cmd_ctx)
730 register_command(cmd_ctx, NULL, "presto_serial", presto_handle_serial_command,
731 COMMAND_CONFIG, NULL);
736 int presto_jtag_init(void)
738 if (presto_open(presto_serial) != ERROR_OK)
741 if (presto_serial != NULL)
742 ERROR("Cannot open PRESTO, serial number '%s'", presto_serial);
744 ERROR("Cannot open PRESTO");
745 return ERROR_JTAG_INIT_FAILED;
747 INFO("PRESTO open, serial number '%s'", presto->serial);
749 /* use JTAG speed setting from configuration file */
750 presto_jtag_speed(jtag_speed);
752 bitq_interface = &presto_bitq;
757 int presto_jtag_quit(void)
761 INFO("PRESTO closed");
766 presto_serial = NULL;