1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 Rob Brown, Lou Deluxe *
9 * rob@cobbleware.com, lou.openocd012@fixit.nospammail.net *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
30 /* project specific includes */
31 #include "interface.h"
37 #include "usb_common.h"
40 /* This feature is made useless by running the DTC all the time. When automatic, the LED is on whenever the DTC is running. Otherwise, USB messages are sent to turn it on and off. */
41 #undef AUTOMATIC_BUSY_LED
43 /* This feature may require derating the speed due to reduced hold time. */
44 #undef USE_HARDWARE_SHIFTER_FOR_TMS
47 #define INTERFACE_NAME "RLink"
49 #define USB_IDVENDOR (0x138e)
50 #define USB_IDPRODUCT (0x9000)
52 #define USB_EP1OUT_ADDR (0x01)
53 #define USB_EP1OUT_SIZE (16)
54 #define USB_EP1IN_ADDR (USB_EP1OUT_ADDR | 0x80)
55 #define USB_EP1IN_SIZE (USB_EP1OUT_SIZE)
57 #define USB_EP2OUT_ADDR (0x02)
58 #define USB_EP2OUT_SIZE (64)
59 #define USB_EP2IN_ADDR (USB_EP2OUT_ADDR | 0x80)
60 #define USB_EP2IN_SIZE (USB_EP2OUT_SIZE)
61 #define USB_EP2BANK_SIZE (512)
63 #define USB_TIMEOUT_MS (3 * 1000)
65 #define DTC_STATUS_POLL_BYTE (ST7_USB_BUF_EP0OUT + 0xff)
68 #define ST7_PD_NBUSY_LED ST7_PD0
69 #define ST7_PD_NRUN_LED ST7_PD1
70 /* low enables VPP at adapter header, high connects it to GND instead */
71 #define ST7_PD_VPP_SEL ST7_PD6
72 /* low: VPP = 12v, high: VPP <= 5v */
73 #define ST7_PD_VPP_SHDN ST7_PD7
75 /* These pins are connected together */
76 #define ST7_PE_ADAPTER_SENSE_IN ST7_PE3
77 #define ST7_PE_ADAPTER_SENSE_OUT ST7_PE4
79 /* Symbolic mapping between port pins and numbered IO lines */
80 #define ST7_PA_IO1 ST7_PA1
81 #define ST7_PA_IO2 ST7_PA2
82 #define ST7_PA_IO4 ST7_PA4
83 #define ST7_PA_IO8 ST7_PA6
84 #define ST7_PA_IO10 ST7_PA7
85 #define ST7_PB_IO5 ST7_PB5
86 #define ST7_PC_IO9 ST7_PC1
87 #define ST7_PC_IO3 ST7_PC2
88 #define ST7_PC_IO7 ST7_PC3
89 #define ST7_PE_IO6 ST7_PE5
91 /* Symbolic mapping between numbered IO lines and adapter signals */
92 #define ST7_PA_RTCK ST7_PA_IO0
93 #define ST7_PA_NTRST ST7_PA_IO1
94 #define ST7_PC_TDI ST7_PC_IO3
95 #define ST7_PA_DBGRQ ST7_PA_IO4
96 #define ST7_PB_NSRST ST7_PB_IO5
97 #define ST7_PE_TMS ST7_PE_IO6
98 #define ST7_PC_TCK ST7_PC_IO7
99 #define ST7_PC_TDO ST7_PC_IO9
100 #define ST7_PA_DBGACK ST7_PA_IO10
102 static usb_dev_handle *pHDev;
106 * ep1 commands are up to USB_EP1OUT_SIZE bytes in length.
107 * This function takes care of zeroing the unused bytes before sending the packet.
108 * Any reply packet is not handled by this function.
112 ep1_generic_commandl(
113 usb_dev_handle *pHDev,
117 uint8_t usb_buffer[USB_EP1OUT_SIZE];
118 uint8_t *usb_buffer_p;
122 if (length > sizeof(usb_buffer)) {
123 length = sizeof(usb_buffer);
126 usb_buffer_p = usb_buffer;
128 va_start(ap, length);
130 *usb_buffer_p++ = va_arg(ap, int);
137 sizeof(usb_buffer) - (usb_buffer_p - usb_buffer)
140 usb_ret = usb_bulk_write(
143 (char *)usb_buffer, sizeof(usb_buffer),
156 usb_dev_handle *pHDev,
161 uint8_t usb_buffer[USB_EP1OUT_SIZE];
166 usb_buffer[0] = EP1_CMD_MEMORY_READ;
170 sizeof(usb_buffer) - 4
177 if (remain > sizeof(usb_buffer)) {
178 length = sizeof(usb_buffer);
183 usb_buffer[1] = addr >> 8;
184 usb_buffer[2] = addr;
185 usb_buffer[3] = length;
187 usb_ret = usb_bulk_write(
188 pHDev, USB_EP1OUT_ADDR,
189 usb_buffer, sizeof(usb_buffer),
193 if (usb_ret < sizeof(usb_buffer)) {
197 usb_ret = usb_bulk_read(
198 pHDev, USB_EP1IN_ADDR,
203 if (usb_ret < length) {
222 usb_dev_handle *pHDev,
225 uint8_t const *buffer
227 uint8_t usb_buffer[USB_EP1OUT_SIZE];
232 usb_buffer[0] = EP1_CMD_MEMORY_WRITE;
238 if (remain > (sizeof(usb_buffer) - 4)) {
239 length = (sizeof(usb_buffer) - 4);
244 usb_buffer[1] = addr >> 8;
245 usb_buffer[2] = addr;
246 usb_buffer[3] = length;
253 usb_buffer + 4 + length,
255 sizeof(usb_buffer) - 4 - length
258 usb_ret = usb_bulk_write(
259 pHDev, USB_EP1OUT_ADDR,
260 (char *)usb_buffer, sizeof(usb_buffer),
264 if ((size_t)usb_ret < sizeof(usb_buffer)) {
282 usb_dev_handle *pHDev,
287 uint8_t buffer[USB_EP1OUT_SIZE - 4];
292 if (length > sizeof(buffer)) {
293 length = sizeof(buffer);
299 va_start(ap, length);
301 *buffer_p++ = va_arg(ap, int);
305 return(ep1_memory_write(pHDev, addr, length, buffer));
310 #define DTCLOAD_COMMENT (0)
311 #define DTCLOAD_ENTRY (1)
312 #define DTCLOAD_LOAD (2)
313 #define DTCLOAD_RUN (3)
314 #define DTCLOAD_LUT_START (4)
315 #define DTCLOAD_LUT (5)
317 #define DTC_LOAD_BUFFER ST7_USB_BUF_EP2UIDO
319 /* This gets set by the DTC loader */
320 static uint8_t dtc_entry_download;
323 /* The buffer is specially formatted to represent a valid image to load into the DTC. */
326 dtc_load_from_buffer(
327 usb_dev_handle *pHDev,
328 const uint8_t *buffer,
337 struct header_s *header;
338 uint8_t lut_start = 0xc0;
340 dtc_entry_download = 0;
342 /* Stop the DTC before loading anything. */
343 usb_err = ep1_generic_commandl(
347 if (usb_err < 0) return(usb_err);
350 if (length < sizeof(*header)) {
351 LOG_ERROR("Malformed DTC image\n");
355 header = (struct header_s *)buffer;
356 buffer += sizeof(*header);
357 length -= sizeof(*header);
359 if (length < (size_t)header->length + 1) {
360 LOG_ERROR("Malformed DTC image\n");
364 switch (header->type) {
365 case DTCLOAD_COMMENT:
369 /* store entry addresses somewhere */
370 if (!strncmp("download", (char *)buffer + 1, 8)) {
371 dtc_entry_download = buffer[0];
376 /* Send the DTC program to ST7 RAM. */
377 usb_err = ep1_memory_write(
380 header->length + 1, buffer
382 if (usb_err < 0) return(usb_err);
384 /* Load it into the DTC. */
385 usb_err = ep1_generic_commandl(
388 (DTC_LOAD_BUFFER >> 8),
391 if (usb_err < 0) return(usb_err);
396 usb_err = ep1_generic_commandl(
402 if (usb_err < 0) return(usb_err);
406 case DTCLOAD_LUT_START:
407 lut_start = buffer[0];
411 usb_err = ep1_memory_write(
413 ST7_USB_BUF_EP0OUT + lut_start,
414 header->length + 1, buffer
416 if (usb_err < 0) return(usb_err);
420 LOG_ERROR("Invalid DTC image record type: 0x%02x\n", header->type);
425 buffer += (header->length + 1);
426 length -= (header->length + 1);
434 * Start the DTC running in download mode (waiting for 512 byte command packets on ep2).
438 dtc_start_download(void) {
442 /* set up for download mode and make sure EP2 is set up to transmit */
443 usb_err = ep1_generic_commandl(
448 EP1_CMD_SET_DOWNLOAD,
449 EP1_CMD_MEMORY_READ, /* read EP2TXR for its data toggle */
454 if (usb_err < 0) return(usb_err);
456 /* read back ep2txr */
457 usb_err = usb_bulk_read(
458 pHDev, USB_EP1IN_ADDR,
462 if (usb_err < 0) return(usb_err);
464 usb_err = ep1_generic_commandl(
467 EP1_CMD_MEMORY_WRITE, /* preinitialize poll byte */
468 DTC_STATUS_POLL_BYTE >> 8,
469 DTC_STATUS_POLL_BYTE,
472 EP1_CMD_MEMORY_WRITE, /* set EP2IN to return data */
476 (ep2txr & ST7_EP2TXR_DTOG_TX) | ST7_EP2TXR_STAT_VALID,
477 EP1_CMD_DTC_CALL, /* start running the DTC */
479 EP1_CMD_DTC_GET_CACHED_STATUS
481 if (usb_err < 0) return(usb_err);
483 /* wait for completion */
484 usb_err = usb_bulk_read(
485 pHDev, USB_EP1IN_ADDR,
497 usb_dev_handle *pHDev,
498 uint8_t *command_buffer,
499 int command_buffer_size,
500 uint8_t *reply_buffer,
501 int reply_buffer_size
503 uint8_t ep2_buffer[USB_EP2IN_SIZE];
507 LOG_DEBUG(": %d/%d\n", command_buffer_size, reply_buffer_size);
509 usb_err = usb_bulk_write(
512 (char *)command_buffer, USB_EP2BANK_SIZE,
515 if (usb_err < 0) return(usb_err);
518 /* Wait for DTC to finish running command buffer */
520 usb_err = ep1_generic_commandl(
524 DTC_STATUS_POLL_BYTE >> 8,
525 DTC_STATUS_POLL_BYTE,
528 if (usb_err < 0) return(usb_err);
530 usb_err = usb_bulk_read(
533 (char *)ep2_buffer, 1,
536 if (usb_err < 0) return(usb_err);
538 if (ep2_buffer[0] & 0x01) break;
541 LOG_ERROR("%s, %d: too many retries waiting for DTC status\n",
549 if (!reply_buffer) reply_buffer_size = 0;
550 if (reply_buffer_size) {
551 usb_err = usb_bulk_read(
554 (char *)ep2_buffer, sizeof(ep2_buffer),
558 if (usb_err < (int)sizeof(ep2_buffer)) {
559 LOG_ERROR("%s, %d: Read of endpoint 2 returned %d\n",
560 __FILE__, __LINE__, usb_err
565 memcpy(reply_buffer, ep2_buffer, reply_buffer_size);
574 * The dtc reply queue is a singly linked list that describes what to do with the reply packet that comes from the DTC. Only SCAN_IN and SCAN_IO generate these entries.
577 struct dtc_reply_queue_entry {
578 struct dtc_reply_queue_entry *next;
579 struct jtag_command *cmd; /* the command that resulted in this entry */
582 uint8_t *buffer; /* the scan buffer */
583 int size; /* size of the scan buffer in bits */
584 int offset; /* how many bits were already done before this? */
585 int length; /* how many bits are processed in this operation? */
586 enum scan_type type; /* SCAN_IN/SCAN_OUT/SCAN_IO */
592 * The dtc_queue consists of a buffer of pending commands and a reply queue.
593 * rlink_scan and tap_state_run add to the command buffer and maybe to the reply queue.
598 struct dtc_reply_queue_entry *rq_head;
599 struct dtc_reply_queue_entry *rq_tail;
601 uint32_t reply_index;
602 uint8_t cmd_buffer[USB_EP2BANK_SIZE];
607 * The tap state queue is for accumulating TAP state changes wiithout needlessly flushing the dtc_queue. When it fills or is run, it adds the accumulated bytes to the dtc_queue.
620 dtc_queue_init(void) {
621 dtc_queue.rq_head = NULL;
622 dtc_queue.rq_tail = NULL;
623 dtc_queue.cmd_index = 0;
624 dtc_queue.reply_index = 0;
631 struct dtc_reply_queue_entry *
632 dtc_queue_enqueue_reply(
638 struct jtag_command *cmd
640 struct dtc_reply_queue_entry *rq_entry;
642 rq_entry = malloc(sizeof(struct dtc_reply_queue_entry));
643 if (rq_entry != NULL) {
644 rq_entry->scan.type = type;
645 rq_entry->scan.buffer = buffer;
646 rq_entry->scan.size = size;
647 rq_entry->scan.offset = offset;
648 rq_entry->scan.length = length;
650 rq_entry->next = NULL;
652 if (dtc_queue.rq_head == NULL)
653 dtc_queue.rq_head = rq_entry;
655 dtc_queue.rq_tail->next = rq_entry;
657 dtc_queue.rq_tail = rq_entry;
665 * Running the queue means that any pending command buffer is run and any reply data dealt with. The command buffer is then cleared for subsequent processing.
666 * The queue is automatically run by append when it is necessary to get space for the append.
671 dtc_queue_run(void) {
672 struct dtc_reply_queue_entry *rq_p, *rq_next;
677 uint8_t *dtc_p, *tdo_p;
678 uint8_t dtc_mask, tdo_mask;
679 uint8_t reply_buffer[USB_EP2IN_SIZE];
683 if (dtc_queue.cmd_index < 1) return(retval);
685 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = DTC_CMD_STOP;
688 if (dtc_queue.rq_head == NULL) {
689 usb_err = dtc_run_download(pHDev,
690 dtc_queue.cmd_buffer, dtc_queue.cmd_index,
694 LOG_ERROR("dtc_run_download: %s\n", usb_strerror());
698 usb_err = dtc_run_download(pHDev,
699 dtc_queue.cmd_buffer, dtc_queue.cmd_index,
700 reply_buffer, dtc_queue.reply_index
703 LOG_ERROR("dtc_run_download: %s\n", usb_strerror());
706 /* process the reply, which empties the reply queue and frees its entries */
707 dtc_p = reply_buffer;
709 /* The rigamarole with the masks and doing it bit-by-bit is due to the fact that the scan buffer is LSb-first and the DTC code is MSb-first for hardware reasons. It was that or craft a function to do the reversal, and that wouldn't work with bit-stuffing (supplying extra bits to use mostly byte operations), or any other scheme which would throw the byte alignment off. */
712 rq_p = dtc_queue.rq_head;
716 tdo_p = rq_p->scan.buffer + (rq_p->scan.offset / 8);
717 tdo_mask = 1 << (rq_p->scan.offset % 8);
720 bit_cnt = rq_p->scan.length;
724 dtc_mask = 1 << (8 - 1);
731 if (*dtc_p & dtc_mask) {
740 dtc_mask = 1 << (8 - 1);
750 /* extra bits or last bit */
754 rq_p->scan.type == SCAN_IN
756 rq_p->scan.offset != rq_p->scan.size - 1
758 /* extra bits were sent as a full byte with padding on the end */
759 dtc_mask = 1 << (8 - 1);
761 dtc_mask = 1 << (bit_cnt - 1);
786 if ((rq_p->scan.offset + rq_p->scan.length) >= rq_p->scan.size) {
787 /* feed scan buffer back into openocd and free it */
788 if (jtag_read_buffer(rq_p->scan.buffer, rq_p->cmd->cmd.scan) != ERROR_OK) {
789 retval = ERROR_JTAG_QUEUE_FAILED;
791 free(rq_p->scan.buffer);
794 rq_next = rq_p->next;
797 dtc_queue.rq_head = NULL;
798 dtc_queue.rq_tail = NULL;
804 /* reset state for new appends */
805 dtc_queue.cmd_index = 0;
806 dtc_queue.reply_index = 0;
815 tap_state_queue_init(void) {
816 tap_state_queue.length = 0;
817 tap_state_queue.buffer = 0;
824 tap_state_queue_run(void) {
831 if (!tap_state_queue.length) return(retval);
834 for (i = tap_state_queue.length; i--;) {
837 if (tap_state_queue.buffer & 1) {
840 if ((bits >= 8) || !i) {
843 /* make sure there's room for stop, byte op, and one byte */
844 if (dtc_queue.cmd_index >= (sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1))) {
845 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
850 #ifdef USE_HARDWARE_SHIFTER_FOR_TMS
852 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
853 DTC_CMD_SHIFT_TMS_BYTES(1);
856 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
857 DTC_CMD_SHIFT_TMS_BITS(bits);
858 #ifdef USE_HARDWARE_SHIFTER_FOR_TMS
862 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
871 tap_state_queue.buffer >>= 1;
873 retval = tap_state_queue_init();
880 tap_state_queue_append(
885 if (tap_state_queue.length >= sizeof(tap_state_queue.buffer) * 8) {
886 retval = tap_state_queue_run();
887 if (retval != 0) return(retval);
891 tap_state_queue.buffer |= (1 << tap_state_queue.length);
893 tap_state_queue.length++;
900 void rlink_end_state(tap_state_t state)
902 if (tap_is_state_stable(state))
903 tap_set_end_state(state);
906 LOG_ERROR("BUG: %i is not a valid end state", state);
913 void rlink_state_move(void) {
916 uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
917 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
919 for (i = 0; i < tms_count; i++)
921 tms = (tms_scan >> i) & 1;
922 tap_state_queue_append(tms);
925 tap_set_state(tap_get_end_state());
929 void rlink_path_move(struct pathmove_command *cmd)
931 int num_states = cmd->num_states;
938 if (tap_state_transition(tap_get_state(), false) == cmd->path[state_count])
942 else if (tap_state_transition(tap_get_state(), true) == cmd->path[state_count])
948 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(cmd->path[state_count]));
952 tap_state_queue_append(tms);
954 tap_set_state(cmd->path[state_count]);
959 tap_set_end_state(tap_get_state());
964 void rlink_runtest(int num_cycles)
968 tap_state_t saved_end_state = tap_get_end_state();
970 /* only do a state_move when we're not already in RTI */
971 if (tap_get_state() != TAP_IDLE)
973 rlink_end_state(TAP_IDLE);
977 /* execute num_cycles */
978 for (i = 0; i < num_cycles; i++)
980 tap_state_queue_append(0);
983 /* finish in end_state */
984 rlink_end_state(saved_end_state);
985 if (tap_get_state() != tap_get_end_state())
990 /* (1) assert or (0) deassert reset lines */
992 void rlink_reset(int trst, int srst)
997 /* Read port A for bit op */
998 usb_err = ep1_generic_commandl(
1000 EP1_CMD_MEMORY_READ,
1006 LOG_ERROR("%s", usb_strerror());
1010 usb_err = usb_bulk_read(
1011 pHDev, USB_EP1IN_ADDR,
1016 LOG_ERROR("%s", usb_strerror());
1021 bitmap &= ~ST7_PA_NTRST;
1023 bitmap |= ST7_PA_NTRST;
1026 /* Write port A and read port B for bit op */
1027 /* port B has no OR, and we want to emulate open drain on NSRST, so we initialize DR to 0 and assert NSRST by setting DDR to 1. */
1028 usb_err = ep1_generic_commandl(
1030 EP1_CMD_MEMORY_WRITE,
1035 EP1_CMD_MEMORY_READ,
1041 LOG_ERROR("%s", usb_strerror());
1045 usb_err = usb_bulk_read(
1046 pHDev, USB_EP1IN_ADDR,
1051 LOG_ERROR("%s", usb_strerror());
1056 bitmap |= ST7_PB_NSRST;
1058 bitmap &= ~ST7_PB_NSRST;
1061 /* write port B and read dummy to ensure completion before returning */
1062 usb_err = ep1_generic_commandl(
1064 EP1_CMD_MEMORY_WRITE,
1069 EP1_CMD_DTC_GET_CACHED_STATUS
1072 LOG_ERROR("%s", usb_strerror());
1076 usb_err = usb_bulk_read(
1077 pHDev, USB_EP1IN_ADDR,
1082 LOG_ERROR("%s", usb_strerror());
1091 struct jtag_command *cmd,
1092 enum scan_type type,
1097 tap_state_t saved_end_state;
1105 uint8_t tdi_mask, *tdi_p;
1108 if (scan_size < 1) {
1109 LOG_ERROR("scan_size cannot be less than 1 bit\n");
1113 ir_scan = cmd->cmd.scan->ir_scan;
1115 /* Move to the proper state before starting to shift TDI/TDO. */
1117 (!ir_scan && (tap_get_state() == TAP_DRSHIFT))
1119 (ir_scan && (tap_get_state() == TAP_IRSHIFT))
1121 saved_end_state = tap_get_end_state();
1122 rlink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
1124 rlink_end_state(saved_end_state);
1127 tap_state_queue_run();
1131 printf("scan_size = %d, type = 0x%x\n", scan_size, type);
1135 /* clear unused bits in scan buffer for ease of debugging */
1136 /* (it makes diffing output easier) */
1137 buffer[scan_size / 8] &= ((1 << ((scan_size - 1) % 8) + 1) - 1);
1139 printf("before scan:");
1140 for (i = 0; i < (scan_size + 7) / 8; i++) {
1141 printf(" %02x", buffer[i]);
1147 /* The number of bits that can be shifted as complete bytes */
1148 byte_bits = (int)(scan_size - 1) / 8 * 8;
1149 /* The number of bits left over, not counting the last bit */
1150 extra_bits = (scan_size - 1) - byte_bits;
1156 if (extra_bits && (type == SCAN_OUT)) {
1157 /* Schedule any extra bits into the DTC command buffer, padding as needed */
1158 /* For SCAN_OUT, this comes before the full bytes so the (leading) padding bits will fall off the end */
1159 /* make sure there's room for stop, byte op, and one byte */
1161 (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1))
1167 dtc_mask = 1 << (extra_bits - 1);
1169 while (extra_bits--) {
1170 if (*tdi_p & tdi_mask) {
1177 if (tdi_mask == 0) {
1183 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1184 DTC_CMD_SHIFT_TDI_BYTES(1);
1186 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1189 /* Loop scheduling full bytes into the DTC command buffer */
1191 if (type == SCAN_IN) {
1192 /* make sure there's room for stop and byte op */
1193 x = (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1));
1195 /* make sure there's room for stop, byte op, and at least one byte */
1196 x = (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1));
1199 if (type != SCAN_OUT) {
1200 /* make sure there's room for at least one reply byte */
1201 x |= (dtc_queue.reply_index >= USB_EP2IN_SIZE - (1));
1208 chunk_bits = byte_bits;
1209 /* we can only use up to 16 bytes at a time */
1210 if (chunk_bits > (16 * 8)) chunk_bits = (16 * 8);
1212 if (type != SCAN_IN) {
1213 /* how much is there room for, considering stop and byte op? */
1214 x = (sizeof(dtc_queue.cmd_buffer) - (dtc_queue.cmd_index + 1 + 1)) * 8;
1215 if (chunk_bits > x) chunk_bits = x;
1218 if (type != SCAN_OUT) {
1219 /* how much is there room for in the reply buffer? */
1220 x = (USB_EP2IN_SIZE - dtc_queue.reply_index) * 8;
1221 if (chunk_bits > x) chunk_bits = x;
1224 /* so the loop will end */
1225 byte_bits -= chunk_bits;
1227 if (type != SCAN_OUT) {
1228 if (dtc_queue_enqueue_reply(
1229 type, buffer, scan_size, tdi_bit_offset,
1233 LOG_ERROR("enqueuing DTC reply entry: %s\n", strerror(errno));
1237 tdi_bit_offset += chunk_bits;
1240 /* chunk_bits is a multiple of 8, so there are no rounding issues. */
1241 chunk_bytes = chunk_bits / 8;
1245 x = DTC_CMD_SHIFT_TDO_BYTES(chunk_bytes);
1248 x = DTC_CMD_SHIFT_TDI_BYTES(chunk_bytes);
1251 x = DTC_CMD_SHIFT_TDIO_BYTES(chunk_bytes);
1254 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1256 if (type != SCAN_IN) {
1258 dtc_mask = 1 << (8 - 1);
1260 while (chunk_bits--) {
1261 if (*tdi_p & tdi_mask) {
1266 if (dtc_mask == 0) {
1267 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1268 dtc_queue.reply_index++;
1270 dtc_mask = 1 << (8 - 1);
1274 if (tdi_mask == 0) {
1282 if (extra_bits && (type != SCAN_OUT)) {
1283 /* Schedule any extra bits into the DTC command buffer */
1284 /* make sure there's room for stop, byte op, and one byte */
1286 (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1))
1288 (dtc_queue.reply_index >= USB_EP2IN_SIZE - (1))
1293 if (dtc_queue_enqueue_reply(
1294 type, buffer, scan_size, tdi_bit_offset,
1298 LOG_ERROR("enqueuing DTC reply entry: %s\n", strerror(errno));
1302 tdi_bit_offset += extra_bits;
1304 if (type == SCAN_IN) {
1305 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1306 DTC_CMD_SHIFT_TDO_BYTES(1);
1309 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1310 DTC_CMD_SHIFT_TDIO_BITS(extra_bits);
1313 dtc_mask = 1 << (8 - 1);
1315 while (extra_bits--) {
1316 if (*tdi_p & tdi_mask) {
1323 if (tdi_mask == 0) {
1329 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1332 dtc_queue.reply_index++;
1335 /* Schedule the last bit into the DTC command buffer */
1337 /* make sure there's room for stop, and bit pair command */
1339 (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1))
1341 (dtc_queue.reply_index >= USB_EP2IN_SIZE - (1))
1346 if (type == SCAN_OUT) {
1347 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1348 DTC_CMD_SHIFT_TMS_TDI_BIT_PAIR(1, (*tdi_p & tdi_mask), 0);
1351 if (dtc_queue_enqueue_reply(
1352 type, buffer, scan_size, tdi_bit_offset,
1356 LOG_ERROR("enqueuing DTC reply entry: %s\n", strerror(errno));
1360 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1361 DTC_CMD_SHIFT_TMS_TDI_BIT_PAIR(1, (*tdi_p & tdi_mask), 1);
1363 dtc_queue.reply_index++;
1367 /* Move to pause state */
1368 tap_state_queue_append(0);
1369 tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
1370 if (tap_get_state() != tap_get_end_state()) rlink_state_move();
1377 int rlink_execute_queue(void)
1379 struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
1381 enum scan_type type;
1383 int retval, tmp_retval;
1385 /* return ERROR_OK, unless something goes wrong */
1388 #ifndef AUTOMATIC_BUSY_LED
1390 ep1_generic_commandl(pHDev, 2,
1391 EP1_CMD_SET_PORTD_LEDS,
1401 case JTAG_STATEMOVE:
1407 /* some events, such as resets, need a queue flush to ensure consistency */
1408 tap_state_queue_run();
1416 #ifdef _DEBUG_JTAG_IO_
1417 LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
1419 if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
1421 tap_set_state(TAP_RESET);
1423 rlink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
1426 #ifdef _DEBUG_JTAG_IO_
1427 LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
1429 if (cmd->cmd.runtest->end_state != -1)
1430 rlink_end_state(cmd->cmd.runtest->end_state);
1431 rlink_runtest(cmd->cmd.runtest->num_cycles);
1433 case JTAG_STATEMOVE:
1434 #ifdef _DEBUG_JTAG_IO_
1435 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
1437 if (cmd->cmd.statemove->end_state != -1)
1438 rlink_end_state(cmd->cmd.statemove->end_state);
1442 #ifdef _DEBUG_JTAG_IO_
1443 LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
1445 rlink_path_move(cmd->cmd.pathmove);
1448 #ifdef _DEBUG_JTAG_IO_
1449 LOG_DEBUG("%s scan end in %i", (cmd->cmd.scan->ir_scan) ? "IR" : "DR", cmd->cmd.scan->end_state);
1451 if (cmd->cmd.scan->end_state != -1)
1452 rlink_end_state(cmd->cmd.scan->end_state);
1453 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
1454 type = jtag_scan_type(cmd->cmd.scan);
1455 if (rlink_scan(cmd, type, buffer, scan_size) != ERROR_OK) {
1456 retval = ERROR_FAIL;
1460 #ifdef _DEBUG_JTAG_IO_
1461 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
1463 jtag_sleep(cmd->cmd.sleep->us);
1466 LOG_ERROR("BUG: unknown JTAG command type encountered");
1472 /* Flush the DTC queue to make sure any pending reads have been done before exiting this function */
1473 tap_state_queue_run();
1474 tmp_retval = dtc_queue_run();
1475 if (tmp_retval != ERROR_OK) {
1476 retval = tmp_retval;
1479 #ifndef AUTOMATIC_BUSY_LED
1481 ep1_generic_commandl(pHDev, 2,
1482 EP1_CMD_SET_PORTD_LEDS,
1491 /* Using an unindexed table because it is infrequently accessed and it is short. The table must be in order of ascending speed (and descending prescaler), as it is scanned in reverse. */
1494 int rlink_speed(int speed)
1500 speed = rlink_speed_table[rlink_speed_table_size - 1].prescaler;
1503 for (i = rlink_speed_table_size; i--;) {
1504 if (rlink_speed_table[i].prescaler == speed) {
1505 if (dtc_load_from_buffer(pHDev, rlink_speed_table[i].dtc, rlink_speed_table[i].dtc_size) != 0) {
1506 LOG_ERROR("An error occurred while trying to load DTC code for speed \"%d\".\n", speed);
1510 if (dtc_start_download() < 0) {
1511 LOG_ERROR("%s, %d: starting DTC: %s",
1522 LOG_ERROR("%d is not a supported speed", speed);
1528 int rlink_speed_div(
1534 for (i = rlink_speed_table_size; i--;) {
1535 if (rlink_speed_table[i].prescaler == speed) {
1536 *khz = rlink_speed_table[i].khz;
1541 LOG_ERROR("%d is not a supported speed", speed);
1554 LOG_ERROR("RCLK not supported");
1558 for (i = rlink_speed_table_size; i--;) {
1559 if (rlink_speed_table[i].khz <= khz) {
1560 *speed = rlink_speed_table[i].prescaler;
1565 LOG_WARNING("The lowest supported JTAG speed is %d KHz", rlink_speed_table[0].khz);
1566 *speed = rlink_speed_table[0].prescaler;
1572 int rlink_init(void)
1575 uint8_t reply_buffer[USB_EP1IN_SIZE];
1578 const uint16_t vids[] = { USB_IDVENDOR, 0 };
1579 const uint16_t pids[] = { USB_IDPRODUCT, 0 };
1580 if (jtag_usb_open(vids, pids, &pHDev) != ERROR_OK)
1583 struct usb_device *dev = usb_device(pHDev);
1584 if (dev->descriptor.bNumConfigurations > 1)
1586 LOG_ERROR("Whoops! NumConfigurations is not 1, don't know what to do...\n");
1589 if (dev->config->bNumInterfaces > 1)
1591 LOG_ERROR("Whoops! NumInterfaces is not 1, don't know what to do...\n");
1595 LOG_DEBUG("Opened device, pHDev = %p\n", pHDev);
1597 /* usb_set_configuration required under win32 */
1598 usb_set_configuration(pHDev, dev->config[0].bConfigurationValue);
1603 i = usb_claim_interface(pHDev,0);
1606 LOG_ERROR("usb_claim_interface: %s", usb_strerror());
1607 #ifdef LIBUSB_HAS_DETACH_KERNEL_DRIVER_NP
1608 j = usb_detach_kernel_driver_np(pHDev, 0);
1610 LOG_ERROR("detach kernel driver: %s", usb_strerror());
1615 LOG_DEBUG("interface claimed!\n");
1618 } while (--retries);
1622 LOG_ERROR("Initialisation failed.");
1625 if (usb_set_altinterface(pHDev,0) != 0)
1627 LOG_ERROR("Failed to set interface.\n");
1631 /* The device starts out in an unknown state on open. As such,
1632 * result reads time out, and it's not even known whether the
1633 * command was accepted. So, for this first command, we issue
1634 * it repeatedly until its response doesn't time out. Also, if
1635 * sending a command is going to time out, we find that out here.
1637 * It must be possible to open the device in such a way that
1638 * this special magic isn't needed, but, so far, it escapes us.
1640 for (i = 0; i < 5; i++) {
1641 j = ep1_generic_commandl(
1645 if (j < USB_EP1OUT_SIZE) {
1646 LOG_ERROR("USB write error: %s", usb_strerror());
1650 pHDev, USB_EP1IN_ADDR,
1651 (char *)reply_buffer, sizeof(reply_buffer),
1654 if (j != -ETIMEDOUT) break;
1657 if (j < (int)sizeof(reply_buffer)) {
1658 LOG_ERROR("USB read error: %s", usb_strerror());
1661 LOG_DEBUG(INTERFACE_NAME" firmware version: %d.%d.%d\n", reply_buffer[0], reply_buffer[1], reply_buffer[2]);
1663 if ((reply_buffer[0] != 0) || (reply_buffer[1] != 0) || (reply_buffer[2] != 3)) {
1664 LOG_WARNING("The rlink device is not of the version that the developers have played with. It may or may not work.\n");
1667 /* Probe port E for adapter presence */
1668 ep1_generic_commandl(
1670 EP1_CMD_MEMORY_WRITE, /* Drive sense pin with 0 */
1675 ST7_PE_ADAPTER_SENSE_OUT, /* DDR */
1676 ST7_PE_ADAPTER_SENSE_OUT, /* OR */
1677 EP1_CMD_MEMORY_READ, /* Read back */
1681 EP1_CMD_MEMORY_WRITE, /* Drive sense pin with 1 */
1685 ST7_PE_ADAPTER_SENSE_OUT
1689 pHDev, USB_EP1IN_ADDR,
1690 (char *)reply_buffer, 1,
1694 if ((reply_buffer[0] & ST7_PE_ADAPTER_SENSE_IN) != 0) {
1695 LOG_WARNING("target detection problem\n");
1698 ep1_generic_commandl(
1700 EP1_CMD_MEMORY_READ, /* Read back */
1704 EP1_CMD_MEMORY_WRITE, /* float port E */
1714 pHDev, USB_EP1IN_ADDR,
1715 (char *)reply_buffer, 1,
1720 if ((reply_buffer[0] & ST7_PE_ADAPTER_SENSE_IN) == 0) {
1721 LOG_WARNING("target not plugged in\n");
1724 /* float ports A and B */
1725 ep1_generic_commandl(
1727 EP1_CMD_MEMORY_WRITE,
1733 EP1_CMD_MEMORY_WRITE,
1740 /* make sure DTC is stopped, set VPP control, set up ports A and B */
1741 ep1_generic_commandl(
1744 EP1_CMD_SET_PORTD_VPP,
1746 EP1_CMD_MEMORY_WRITE,
1750 ((~(0)) & (ST7_PA_NTRST)),
1752 /* port B has no OR, and we want to emulate open drain on NSRST, so we set DR to 0 here and later assert NSRST by setting DDR bit to 1. */
1753 EP1_CMD_MEMORY_WRITE,
1760 /* set LED updating mode and make sure they're unlit */
1761 ep1_generic_commandl(
1763 #ifdef AUTOMATIC_BUSY_LED
1768 EP1_CMD_SET_PORTD_LEDS,
1772 tap_state_queue_init();
1774 rlink_speed(jtag_get_speed());
1782 int rlink_quit(void)
1784 /* stop DTC and make sure LEDs are off */
1785 ep1_generic_commandl(
1789 EP1_CMD_SET_PORTD_LEDS,
1791 EP1_CMD_SET_PORTD_VPP,
1795 usb_release_interface(pHDev,0);
1803 struct jtag_interface rlink_interface =
1808 .speed = rlink_speed,
1809 .speed_div = rlink_speed_div,
1811 .execute_queue = rlink_execute_queue,