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)
144 #if BUILD_PRESTO_FTD2XX == 1
146 if ((presto->status = FT_Write(presto->handle, buf, size, &ftbytes)) != FT_OK)
148 ERROR("FT_Write returned: %lu", presto->status);
149 return ERROR_JTAG_DEVICE_ERROR;
152 #elif BUILD_PRESTO_LIBFTDI == 1
154 if ((presto->retval = ftdi_write_data(&presto->ftdic, buf, size)) < 0)
156 ERROR("ftdi_write_data: %s", ftdi_get_error_string(&presto->ftdic));
157 return ERROR_JTAG_DEVICE_ERROR;
159 ftbytes = presto->retval;
164 ERROR("couldn't write the requested number of bytes to PRESTO (%i < %i)", ftbytes, size);
165 return ERROR_JTAG_DEVICE_ERROR;
171 int presto_read(u8* buf, int size)
173 #if BUILD_PRESTO_FTD2XX == 1
175 if ((presto->status = FT_Read(presto->handle, buf, size, &ftbytes)) != FT_OK)
177 ERROR("FT_Read returned: %lu", presto->status);
178 return ERROR_JTAG_DEVICE_ERROR;
181 #elif BUILD_PRESTO_LIBFTDI == 1
184 struct timeval timeout, now;
185 gettimeofday(&timeout, NULL);
186 timeval_add_time(&timeout, 1, 0); /* one second timeout */
188 while (ftbytes < size)
190 if ((presto->retval = ftdi_read_data(&presto->ftdic, buf + ftbytes, size - ftbytes)) < 0)
192 ERROR("ftdi_read_data: %s", ftdi_get_error_string(&presto->ftdic));
193 return ERROR_JTAG_DEVICE_ERROR;
195 ftbytes += presto->retval;
197 gettimeofday(&now, NULL);
198 if ((now.tv_sec > timeout.tv_sec) || ((now.tv_sec == timeout.tv_sec) && (now.tv_usec > timeout.tv_usec)))
205 /* this is just a warning, there might have been timeout when detecting PRESTO, which is not fatal */
206 WARNING("couldn't read the requested number of bytes from PRESTO (%i < %i)", ftbytes, size);
207 return ERROR_JTAG_DEVICE_ERROR;
213 #if BUILD_PRESTO_FTD2XX == 1
214 int presto_open_ftd2xx(char *req_serial)
219 char devname[FT_DEVICE_NAME_LEN];
225 presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
228 /* Add non-standard Vid/Pid to the linux driver */
229 if ((presto->status = FT_SetVIDPID(PRESTO_VID, PRESTO_PID)) != FT_OK)
231 ERROR("couldn't add PRESTO VID/PID");
236 if ((presto->status = FT_ListDevices(&numdevs, NULL, FT_LIST_NUMBER_ONLY)) != FT_OK)
238 ERROR("FT_ListDevices failed: %i", (int)presto->status);
239 return ERROR_JTAG_DEVICE_ERROR;
242 DEBUG("FTDI devices available: %i", numdevs);
243 for (i = 0; i < numdevs; i++)
245 if ((presto->status = FT_Open(i, &(presto->handle))) != FT_OK)
247 /* this is not fatal, the device may be legitimately open by other process, hence debug message only */
248 DEBUG("FT_Open failed: %i", (int)presto->status);
251 DEBUG("FTDI device %i open", i);
253 if ((presto->status = FT_GetDeviceInfo(presto->handle, &device, &vidpid,
254 presto->serial, devname, NULL)) == FT_OK)
256 if (vidpid == PRESTO_VID_PID
257 && (req_serial == NULL || !strcmp(presto->serial, req_serial)))
261 DEBUG("FT_GetDeviceInfo failed: %i", presto->status);
263 DEBUG("FTDI device %i does not match, closing", i);
264 FT_Close(presto->handle);
265 presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
268 if (presto->handle == (FT_HANDLE)INVALID_HANDLE_VALUE)
269 return ERROR_JTAG_DEVICE_ERROR; /* presto not open, return */
271 if ((presto->status = FT_SetLatencyTimer(presto->handle, 1)) != FT_OK)
272 return ERROR_JTAG_DEVICE_ERROR;
275 if ((presto->status = FT_SetTimeouts(presto->handle, 100, 0)) != FT_OK)
276 return ERROR_JTAG_DEVICE_ERROR;
278 if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
279 return ERROR_JTAG_DEVICE_ERROR;
282 if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
283 return ERROR_JTAG_DEVICE_ERROR;
285 /* delay between first write/read turnaround (after purge?) necessary under Linux for unknown reason,
286 probably a bug in library threading */
288 if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
289 return ERROR_JTAG_DEVICE_ERROR;
293 DEBUG("PRESTO reset");
295 if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
296 return ERROR_JTAG_DEVICE_ERROR;
297 if ((presto->status = FT_SetBitMode(presto->handle, 0x80, 1)) != FT_OK)
298 return ERROR_JTAG_DEVICE_ERROR;
299 if ((presto->status = FT_SetBaudRate(presto->handle, 9600)) != FT_OK)
300 return ERROR_JTAG_DEVICE_ERROR;
303 for (i = 0; i < 4 * 62; i++)
304 if ((presto->status=FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
305 return ERROR_JTAG_DEVICE_ERROR;
309 if ((presto->status = FT_SetBitMode(presto->handle, 0x00, 0)) != FT_OK)
310 return ERROR_JTAG_DEVICE_ERROR;
312 if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
313 return ERROR_JTAG_DEVICE_ERROR;
316 if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
317 return ERROR_JTAG_DEVICE_ERROR;
319 /* delay between first write/read turnaround (after purge?) necessary under Linux for unknown reason,
320 probably a bug in library threading */
322 if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
323 return ERROR_JTAG_DEVICE_ERROR;
327 DEBUG("PRESTO not responding");
328 return ERROR_JTAG_DEVICE_ERROR;
332 if ((presto->status = FT_SetTimeouts(presto->handle, 0, 0)) != FT_OK)
333 return ERROR_JTAG_DEVICE_ERROR;
336 presto->status = FT_Write(presto->handle, &presto_init_seq, sizeof(presto_init_seq), &ftbytes);
337 if (presto->status != FT_OK || ftbytes != sizeof(presto_init_seq))
338 return ERROR_JTAG_DEVICE_ERROR;
343 #elif BUILD_PRESTO_LIBFTDI == 1
344 int presto_open_libftdi(char *req_serial)
348 DEBUG("searching for PRESTO using libftdi");
350 /* initialize FTDI context structure */
351 if (ftdi_init(&presto->ftdic) < 0)
353 ERROR("unable to init libftdi: %s", presto->ftdic.error_str);
354 return ERROR_JTAG_DEVICE_ERROR;
357 /* context, vendor id, product id */
358 if (ftdi_usb_open_desc(&presto->ftdic, PRESTO_VID, PRESTO_PID, NULL, req_serial) < 0)
360 ERROR("unable to open PRESTO: %s", presto->ftdic.error_str);
361 return ERROR_JTAG_DEVICE_ERROR;
364 if (ftdi_usb_reset(&presto->ftdic) < 0)
366 ERROR("unable to reset PRESTO device");
367 return ERROR_JTAG_DEVICE_ERROR;
370 if (ftdi_set_latency_timer(&presto->ftdic, 1) < 0)
372 ERROR("unable to set latency timer");
373 return ERROR_JTAG_DEVICE_ERROR;
376 if (ftdi_usb_purge_buffers(&presto->ftdic) < 0)
378 ERROR("unable to purge PRESTO buffers");
379 return ERROR_JTAG_DEVICE_ERROR;
383 if (presto_write(&presto_data, 1) != ERROR_OK)
385 ERROR("error writing to PRESTO");
386 return ERROR_JTAG_DEVICE_ERROR;
389 if (presto_read(&presto_data, 1) != ERROR_OK)
391 DEBUG("no response from PRESTO, retrying");
393 if (ftdi_usb_purge_buffers(&presto->ftdic) < 0)
394 return ERROR_JTAG_DEVICE_ERROR;
397 if (presto_write(&presto_data, 1) != ERROR_OK)
398 return ERROR_JTAG_DEVICE_ERROR;
400 if (presto_read(&presto_data, 1) != ERROR_OK)
402 ERROR("no response from PRESTO, giving up");
403 return ERROR_JTAG_DEVICE_ERROR;
407 if (presto_write(presto_init_seq, sizeof(presto_init_seq)) != ERROR_OK)
409 ERROR("error writing PRESTO init sequence");
410 return ERROR_JTAG_DEVICE_ERROR;
415 #endif /* BUILD_PRESTO_LIBFTDI == 1 */
417 int presto_open(char *req_serial)
419 presto->buff_out_pos=0;
420 presto->buff_in_pos=0;
421 presto->buff_in_len=0;
422 presto->buff_in_exp=0;
429 presto->jtag_tdi_data=0;
430 presto->jtag_tdi_count=0;
432 #if BUILD_PRESTO_FTD2XX == 1
433 return presto_open_ftd2xx(req_serial);
434 #elif BUILD_PRESTO_LIBFTDI == 1
435 return presto_open_libftdi(req_serial);
439 int presto_close(void)
442 int result = ERROR_OK;
444 #if BUILD_PRESTO_FTD2XX == 1
445 unsigned long ftbytes;
447 if (presto->handle == (FT_HANDLE)INVALID_HANDLE_VALUE)
450 presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX);
451 if (presto->status != FT_OK)
452 result = ERROR_JTAG_DEVICE_ERROR;
454 presto->status = FT_Write(presto->handle, &presto_init_seq, sizeof(presto_init_seq), &ftbytes);
455 if (presto->status != FT_OK || ftbytes != sizeof(presto_init_seq))
456 result = ERROR_JTAG_DEVICE_ERROR;
458 if ((presto->status = FT_SetLatencyTimer(presto->handle, 16)) != FT_OK)
459 result = ERROR_JTAG_DEVICE_ERROR;
461 if ((presto->status = FT_Close(presto->handle)) != FT_OK)
462 result = ERROR_JTAG_DEVICE_ERROR;
464 presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
466 #elif BUILD_PRESTO_LIBFTDI == 1
468 if ((presto->retval = ftdi_write_data(&presto->ftdic, presto_init_seq, sizeof(presto_init_seq))) != sizeof(presto_init_seq))
469 result = ERROR_JTAG_DEVICE_ERROR;
471 if ((presto->retval = ftdi_set_latency_timer(&presto->ftdic, 16)) < 0)
472 result = ERROR_JTAG_DEVICE_ERROR;
474 if ((presto->retval = ftdi_usb_close(&presto->ftdic)) < 0)
475 result = ERROR_JTAG_DEVICE_ERROR;
477 ftdi_deinit(&presto->ftdic);
484 int presto_flush(void)
486 if (presto->buff_out_pos == 0)
489 #if BUILD_PRESTO_FTD2XX == 1
490 if (presto->status != FT_OK)
491 #elif BUILD_PRESTO_LIBFTDI == 1
492 if (presto->retval < 0)
495 DEBUG("error in previous communication, canceling I/O operation");
496 return ERROR_JTAG_DEVICE_ERROR;
499 if (presto_write(presto->buff_out, presto->buff_out_pos) != ERROR_OK)
501 presto->buff_out_pos = 0;
502 return ERROR_JTAG_DEVICE_ERROR;
505 presto->total_out += presto->buff_out_pos;
506 presto->buff_out_pos = 0;
508 if (presto->buff_in_exp == 0)
511 presto->buff_in_pos = 0;
512 presto->buff_in_len = 0;
514 if (presto_read(presto->buff_in, presto->buff_in_exp) != ERROR_OK)
516 presto->buff_in_exp = 0;
517 return ERROR_JTAG_DEVICE_ERROR;
520 presto->total_in += presto->buff_in_exp;
521 presto->buff_in_len = presto->buff_in_exp;
522 presto->buff_in_exp = 0;
528 int presto_sendbyte(int data)
530 if (data == EOF) return presto_flush();
532 if (presto->buff_out_pos < BUFFER_SIZE)
534 presto->buff_out[presto->buff_out_pos++] = (u8)data;
535 if (((data & 0xC0) == 0x40) || ((data & 0xD0)== 0xD0))
536 presto->buff_in_exp++;
539 return ERROR_JTAG_DEVICE_ERROR;
541 #if BUILD_PRESTO_FTD2XX == 1
542 if (presto->buff_out_pos >= BUFFER_SIZE)
543 #elif BUILD_PRESTO_LIBFTDI == 1
544 /* libftdi does not do background read, be sure that USB IN buffer does not overflow (128 bytes only!) */
545 if (presto->buff_out_pos >= BUFFER_SIZE || presto->buff_in_exp==128)
547 return presto_flush();
553 int presto_getbyte(void)
555 if (presto->buff_in_pos < presto->buff_in_len)
556 return presto->buff_in[presto->buff_in_pos++];
558 if (presto->buff_in_exp == 0)
561 if (presto_flush() != ERROR_OK)
564 if (presto->buff_in_pos<presto->buff_in_len)
565 return presto->buff_in[presto->buff_in_pos++];
571 /* -------------------------------------------------------------------------- */
574 int presto_bitq_out(int tms, int tdi, int tdo_req)
576 unsigned char cmdparam;
578 if (presto->jtag_tck == 0)
580 presto_sendbyte(0xA4);
581 presto->jtag_tck = 1;
584 else if (!tdo_req && tms == presto->jtag_tms)
586 if (presto->jtag_tdi_count == 0)
587 presto->jtag_tdi_data = (tdi != 0);
589 presto->jtag_tdi_data |= (tdi != 0) << presto->jtag_tdi_count;
591 if (++presto->jtag_tdi_count == 4)
593 presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
594 presto_sendbyte(presto->jtag_tdi_data);
595 presto->jtag_tdi_count = 0;
600 if (presto->jtag_tdi_count)
602 presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
603 presto_sendbyte(presto->jtag_tdi_data);
604 presto->jtag_tdi_count = 0;
612 presto_sendbyte( 0xC0 | cmdparam);
614 if (tms != presto->jtag_tms)
617 presto_sendbyte(0xEC);
619 presto_sendbyte(0xE8);
620 presto->jtag_tms = tms;
624 presto_sendbyte(0xD4 | cmdparam);
626 presto_sendbyte(0xC4|cmdparam);
632 int presto_bitq_flush(void)
634 if (presto->jtag_tdi_count)
636 presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
637 presto_sendbyte(presto->jtag_tdi_data);
638 presto->jtag_tdi_count = 0;
641 presto_sendbyte(0xCA);
642 presto->jtag_tck = 0;
644 presto_sendbyte(0xA0);
646 return presto_flush();
650 int presto_bitq_in_rdy(void)
652 if (presto->buff_in_pos>=presto->buff_in_len)
654 return presto->buff_in_len-presto->buff_in_pos;
658 int presto_bitq_in(void)
660 if (presto->buff_in_pos>=presto->buff_in_len)
662 if (presto->buff_in[presto->buff_in_pos++]&0x08) return 1;
667 int presto_bitq_sleep(unsigned long us)
678 waits = us / 170 + 2;
680 presto_sendbyte(0x80);
686 int presto_bitq_reset(int trst, int srst)
691 if (presto->jtag_tms)
697 presto_sendbyte(cmd);
702 /* -------------------------------------------------------------------------- */
704 char *presto_speed_text[4] =
712 int presto_jtag_speed(int speed)
715 if ((speed < 0) || (speed > 3))
717 INFO("valid speed values: 0 (3 MHz), 1 (1.5 MHz), 2 (750 kHz) and 3 (93.75 kHz)");
718 return ERROR_INVALID_ARGUMENTS;
722 INFO("setting speed to %d, max. TCK freq. is %s", speed, presto_speed_text[speed]);
723 return presto_sendbyte(0xA8 | speed);
729 int presto_handle_serial_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
735 presto_serial = strdup(args[0]);
739 ERROR("expected exactly one argument to presto_serial <serial-number>");
746 int presto_jtag_register_commands(struct command_context_s *cmd_ctx)
748 register_command(cmd_ctx, NULL, "presto_serial", presto_handle_serial_command,
749 COMMAND_CONFIG, NULL);
754 int presto_jtag_init(void)
756 if (presto_open(presto_serial) != ERROR_OK)
759 if (presto_serial != NULL)
760 ERROR("Cannot open PRESTO, serial number '%s'", presto_serial);
762 ERROR("Cannot open PRESTO");
763 return ERROR_JTAG_INIT_FAILED;
765 INFO("PRESTO open, serial number '%s'", presto->serial);
767 /* use JTAG speed setting from configuration file */
768 presto_jtag_speed(jtag_speed);
770 bitq_interface = &presto_bitq;
775 int presto_jtag_quit(void)
779 INFO("PRESTO closed");
784 presto_serial = NULL;