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 <jtag/interface.h>
32 #include <jtag/commands.h>
34 #include "rlink_st7.h"
35 #include "rlink_ep1_cmd.h"
36 #include "rlink_dtc_cmd.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_param,
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_param,
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_param, 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_param,
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");
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");
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", 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_param,
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", 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("too many retries waiting for DTC status");
547 if (!reply_buffer) reply_buffer_size = 0;
548 if (reply_buffer_size) {
549 usb_err = usb_bulk_read(
552 (char *)ep2_buffer, sizeof(ep2_buffer),
556 if (usb_err < (int)sizeof(ep2_buffer)) {
557 LOG_ERROR("Read of endpoint 2 returned %d, expected %d",
558 usb_err, reply_buffer_size
563 memcpy(reply_buffer, ep2_buffer, reply_buffer_size);
572 * 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.
575 struct dtc_reply_queue_entry {
576 struct dtc_reply_queue_entry *next;
577 struct jtag_command *cmd; /* the command that resulted in this entry */
580 uint8_t *buffer; /* the scan buffer */
581 int size; /* size of the scan buffer in bits */
582 int offset; /* how many bits were already done before this? */
583 int length; /* how many bits are processed in this operation? */
584 enum scan_type type; /* SCAN_IN/SCAN_OUT/SCAN_IO */
590 * The dtc_queue consists of a buffer of pending commands and a reply queue.
591 * rlink_scan and tap_state_run add to the command buffer and maybe to the reply queue.
596 struct dtc_reply_queue_entry *rq_head;
597 struct dtc_reply_queue_entry *rq_tail;
599 uint32_t reply_index;
600 uint8_t cmd_buffer[USB_EP2BANK_SIZE];
605 * 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.
618 dtc_queue_init(void) {
619 dtc_queue.rq_head = NULL;
620 dtc_queue.rq_tail = NULL;
621 dtc_queue.cmd_index = 0;
622 dtc_queue.reply_index = 0;
629 struct dtc_reply_queue_entry *
630 dtc_queue_enqueue_reply(
636 struct jtag_command *cmd
638 struct dtc_reply_queue_entry *rq_entry;
640 rq_entry = malloc(sizeof(struct dtc_reply_queue_entry));
641 if (rq_entry != NULL) {
642 rq_entry->scan.type = type;
643 rq_entry->scan.buffer = buffer;
644 rq_entry->scan.size = size;
645 rq_entry->scan.offset = offset;
646 rq_entry->scan.length = length;
648 rq_entry->next = NULL;
650 if (dtc_queue.rq_head == NULL)
651 dtc_queue.rq_head = rq_entry;
653 dtc_queue.rq_tail->next = rq_entry;
655 dtc_queue.rq_tail = rq_entry;
663 * 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.
664 * The queue is automatically run by append when it is necessary to get space for the append.
669 dtc_queue_run(void) {
670 struct dtc_reply_queue_entry *rq_p, *rq_next;
675 uint8_t *dtc_p, *tdo_p;
676 uint8_t dtc_mask, tdo_mask;
677 uint8_t reply_buffer[USB_EP2IN_SIZE];
679 assert((dtc_queue.rq_head != 0) == (dtc_queue.reply_index > 0));
680 assert(dtc_queue.cmd_index < USB_EP2BANK_SIZE);
681 assert(dtc_queue.reply_index <= USB_EP2IN_SIZE);
685 if (dtc_queue.cmd_index < 1) return(retval);
687 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = DTC_CMD_STOP;
689 usb_err = dtc_run_download(pHDev,
690 dtc_queue.cmd_buffer, dtc_queue.cmd_index,
691 reply_buffer, dtc_queue.reply_index
694 LOG_ERROR("dtc_run_download: %s", usb_strerror());
698 if (dtc_queue.rq_head != NULL) {
699 /* process the reply, which empties the reply queue and frees its entries */
700 dtc_p = reply_buffer;
702 /* 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. */
705 rq_p = dtc_queue.rq_head;
709 tdo_p = rq_p->scan.buffer + (rq_p->scan.offset / 8);
710 tdo_mask = 1 << (rq_p->scan.offset % 8);
713 bit_cnt = rq_p->scan.length;
717 dtc_mask = 1 << (8 - 1);
724 if (*dtc_p & dtc_mask) {
733 dtc_mask = 1 << (8 - 1);
743 /* extra bits or last bit */
747 rq_p->scan.type == SCAN_IN
749 rq_p->scan.offset != rq_p->scan.size - 1
751 /* extra bits were sent as a full byte with padding on the end */
752 dtc_mask = 1 << (8 - 1);
754 dtc_mask = 1 << (bit_cnt - 1);
779 if ((rq_p->scan.offset + rq_p->scan.length) >= rq_p->scan.size) {
780 /* feed scan buffer back into openocd and free it */
781 if (jtag_read_buffer(rq_p->scan.buffer, rq_p->cmd->cmd.scan) != ERROR_OK) {
782 retval = ERROR_JTAG_QUEUE_FAILED;
784 free(rq_p->scan.buffer);
787 rq_next = rq_p->next;
790 dtc_queue.rq_head = NULL;
791 dtc_queue.rq_tail = NULL;
795 /* reset state for new appends */
796 dtc_queue.cmd_index = 0;
797 dtc_queue.reply_index = 0;
804 tap_state_queue_init(void) {
805 tap_state_queue.length = 0;
806 tap_state_queue.buffer = 0;
813 tap_state_queue_run(void) {
820 if (!tap_state_queue.length) return(retval);
823 for (i = tap_state_queue.length; i--;) {
826 if (tap_state_queue.buffer & 1) {
829 if ((bits >= 8) || !i) {
830 byte_param <<= (8 - bits);
832 /* make sure there's room for stop, byte op, and one byte */
833 if (dtc_queue.cmd_index >= (sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1))) {
834 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
839 #ifdef USE_HARDWARE_SHIFTER_FOR_TMS
841 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
842 DTC_CMD_SHIFT_TMS_BYTES(1);
845 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
846 DTC_CMD_SHIFT_TMS_BITS(bits);
847 #ifdef USE_HARDWARE_SHIFTER_FOR_TMS
851 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
860 tap_state_queue.buffer >>= 1;
862 retval = tap_state_queue_init();
869 tap_state_queue_append(
874 if (tap_state_queue.length >= sizeof(tap_state_queue.buffer) * 8) {
875 retval = tap_state_queue_run();
876 if (retval != 0) return(retval);
880 tap_state_queue.buffer |= (1 << tap_state_queue.length);
882 tap_state_queue.length++;
889 void rlink_end_state(tap_state_t state)
891 if (tap_is_state_stable(state))
892 tap_set_end_state(state);
895 LOG_ERROR("BUG: %i is not a valid end state", state);
902 void rlink_state_move(void) {
905 uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
906 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
908 for (i = 0; i < tms_count; i++)
910 tms = (tms_scan >> i) & 1;
911 tap_state_queue_append(tms);
914 tap_set_state(tap_get_end_state());
918 void rlink_path_move(struct pathmove_command *cmd)
920 int num_states = cmd->num_states;
927 if (tap_state_transition(tap_get_state(), false) == cmd->path[state_count])
931 else if (tap_state_transition(tap_get_state(), true) == cmd->path[state_count])
937 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(cmd->path[state_count]));
941 tap_state_queue_append(tms);
943 tap_set_state(cmd->path[state_count]);
948 tap_set_end_state(tap_get_state());
953 void rlink_runtest(int num_cycles)
957 tap_state_t saved_end_state = tap_get_end_state();
959 /* only do a state_move when we're not already in RTI */
960 if (tap_get_state() != TAP_IDLE)
962 rlink_end_state(TAP_IDLE);
966 /* execute num_cycles */
967 for (i = 0; i < num_cycles; i++)
969 tap_state_queue_append(0);
972 /* finish in end_state */
973 rlink_end_state(saved_end_state);
974 if (tap_get_state() != tap_get_end_state())
979 /* (1) assert or (0) deassert reset lines */
981 void rlink_reset(int trst, int srst)
986 /* Read port A for bit op */
987 usb_err = ep1_generic_commandl(
995 LOG_ERROR("%s", usb_strerror());
999 usb_err = usb_bulk_read(
1000 pHDev, USB_EP1IN_ADDR,
1005 LOG_ERROR("%s", usb_strerror());
1010 bitmap &= ~ST7_PA_NTRST;
1012 bitmap |= ST7_PA_NTRST;
1015 /* Write port A and read port B for bit op */
1016 /* 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. */
1017 usb_err = ep1_generic_commandl(
1019 EP1_CMD_MEMORY_WRITE,
1024 EP1_CMD_MEMORY_READ,
1030 LOG_ERROR("%s", usb_strerror());
1034 usb_err = usb_bulk_read(
1035 pHDev, USB_EP1IN_ADDR,
1040 LOG_ERROR("%s", usb_strerror());
1045 bitmap |= ST7_PB_NSRST;
1047 bitmap &= ~ST7_PB_NSRST;
1050 /* write port B and read dummy to ensure completion before returning */
1051 usb_err = ep1_generic_commandl(
1053 EP1_CMD_MEMORY_WRITE,
1058 EP1_CMD_DTC_GET_CACHED_STATUS
1061 LOG_ERROR("%s", usb_strerror());
1065 usb_err = usb_bulk_read(
1066 pHDev, USB_EP1IN_ADDR,
1071 LOG_ERROR("%s", usb_strerror());
1080 struct jtag_command *cmd,
1081 enum scan_type type,
1086 tap_state_t saved_end_state;
1094 uint8_t tdi_mask, *tdi_p;
1097 if (scan_size < 1) {
1098 LOG_ERROR("scan_size cannot be less than 1 bit");
1102 ir_scan = cmd->cmd.scan->ir_scan;
1104 /* Move to the proper state before starting to shift TDI/TDO. */
1106 (!ir_scan && (tap_get_state() == TAP_DRSHIFT))
1108 (ir_scan && (tap_get_state() == TAP_IRSHIFT))
1110 saved_end_state = tap_get_end_state();
1111 rlink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
1113 rlink_end_state(saved_end_state);
1116 tap_state_queue_run();
1120 printf("scan_size = %d, type = 0x%x\n", scan_size, type);
1124 /* clear unused bits in scan buffer for ease of debugging */
1125 /* (it makes diffing output easier) */
1126 buffer[scan_size / 8] &= ((1 << ((scan_size - 1) % 8) + 1) - 1);
1128 printf("before scan:");
1129 for (i = 0; i < (scan_size + 7) / 8; i++) {
1130 printf(" %02x", buffer[i]);
1136 /* The number of bits that can be shifted as complete bytes */
1137 byte_bits = (int)(scan_size - 1) / 8 * 8;
1138 /* The number of bits left over, not counting the last bit */
1139 extra_bits = (scan_size - 1) - byte_bits;
1145 if (extra_bits && (type == SCAN_OUT)) {
1146 /* Schedule any extra bits into the DTC command buffer, padding as needed */
1147 /* For SCAN_OUT, this comes before the full bytes so the (leading) padding bits will fall off the end */
1148 /* make sure there's room for stop, byte op, and one byte */
1150 (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1))
1156 dtc_mask = 1 << (extra_bits - 1);
1158 while (extra_bits--) {
1159 if (*tdi_p & tdi_mask) {
1166 if (tdi_mask == 0) {
1172 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1173 DTC_CMD_SHIFT_TDI_BYTES(1);
1175 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1178 /* Loop scheduling full bytes into the DTC command buffer */
1180 if (type == SCAN_IN) {
1181 /* make sure there's room for stop and byte op */
1182 x = (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1));
1184 /* make sure there's room for stop, byte op, and at least one byte */
1185 x = (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1));
1188 if (type != SCAN_OUT) {
1189 /* make sure there's room for at least one reply byte */
1190 x |= (dtc_queue.reply_index >= USB_EP2IN_SIZE - (1));
1197 chunk_bits = byte_bits;
1198 /* we can only use up to 16 bytes at a time */
1199 if (chunk_bits > (16 * 8)) chunk_bits = (16 * 8);
1201 if (type != SCAN_IN) {
1202 /* how much is there room for, considering stop and byte op? */
1203 x = (sizeof(dtc_queue.cmd_buffer) - (dtc_queue.cmd_index + 1 + 1)) * 8;
1204 if (chunk_bits > x) chunk_bits = x;
1207 if (type != SCAN_OUT) {
1208 /* how much is there room for in the reply buffer? */
1209 x = (USB_EP2IN_SIZE - dtc_queue.reply_index) * 8;
1210 if (chunk_bits > x) chunk_bits = x;
1213 /* so the loop will end */
1214 byte_bits -= chunk_bits;
1216 if (type != SCAN_OUT) {
1217 if (dtc_queue_enqueue_reply(
1218 type, buffer, scan_size, tdi_bit_offset,
1222 LOG_ERROR("enqueuing DTC reply entry: %s", strerror(errno));
1225 dtc_queue.reply_index += (chunk_bits + 7) / 8;
1227 tdi_bit_offset += chunk_bits;
1230 /* chunk_bits is a multiple of 8, so there are no rounding issues. */
1231 chunk_bytes = chunk_bits / 8;
1235 x = DTC_CMD_SHIFT_TDO_BYTES(chunk_bytes);
1238 x = DTC_CMD_SHIFT_TDI_BYTES(chunk_bytes);
1241 x = DTC_CMD_SHIFT_TDIO_BYTES(chunk_bytes);
1244 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1246 if (type != SCAN_IN) {
1248 dtc_mask = 1 << (8 - 1);
1250 while (chunk_bits--) {
1251 if (*tdi_p & tdi_mask) {
1256 if (dtc_mask == 0) {
1257 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1259 dtc_mask = 1 << (8 - 1);
1263 if (tdi_mask == 0) {
1271 if (extra_bits && (type != SCAN_OUT)) {
1272 /* Schedule any extra bits into the DTC command buffer */
1273 /* make sure there's room for stop, byte op, and one byte */
1275 (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1 + 1))
1277 (dtc_queue.reply_index >= USB_EP2IN_SIZE - (1))
1282 if (dtc_queue_enqueue_reply(
1283 type, buffer, scan_size, tdi_bit_offset,
1287 LOG_ERROR("enqueuing DTC reply entry: %s", strerror(errno));
1291 dtc_queue.reply_index++;
1293 tdi_bit_offset += extra_bits;
1295 if (type == SCAN_IN) {
1296 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1297 DTC_CMD_SHIFT_TDO_BYTES(1);
1300 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1301 DTC_CMD_SHIFT_TDIO_BITS(extra_bits);
1304 dtc_mask = 1 << (8 - 1);
1306 while (extra_bits--) {
1307 if (*tdi_p & tdi_mask) {
1314 if (tdi_mask == 0) {
1320 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] = x;
1324 /* Schedule the last bit into the DTC command buffer */
1325 /* make sure there's room for stop, and bit pair command */
1327 (dtc_queue.cmd_index >= sizeof(dtc_queue.cmd_buffer) - (1 + 1))
1329 (dtc_queue.reply_index >= USB_EP2IN_SIZE - (1))
1334 if (type == SCAN_OUT) {
1335 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1336 DTC_CMD_SHIFT_TMS_TDI_BIT_PAIR(1, (*tdi_p & tdi_mask), 0);
1339 if (dtc_queue_enqueue_reply(
1340 type, buffer, scan_size, tdi_bit_offset,
1344 LOG_ERROR("enqueuing DTC reply entry: %s", strerror(errno));
1348 dtc_queue.reply_index++;
1350 dtc_queue.cmd_buffer[dtc_queue.cmd_index++] =
1351 DTC_CMD_SHIFT_TMS_TDI_BIT_PAIR(1, (*tdi_p & tdi_mask), 1);
1354 /* Move to pause state */
1355 tap_state_queue_append(0);
1356 tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
1357 if (tap_get_state() != tap_get_end_state()) rlink_state_move();
1364 int rlink_execute_queue(void)
1366 struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
1368 enum scan_type type;
1370 int retval, tmp_retval;
1372 /* return ERROR_OK, unless something goes wrong */
1375 #ifndef AUTOMATIC_BUSY_LED
1377 ep1_generic_commandl(pHDev, 2,
1378 EP1_CMD_SET_PORTD_LEDS,
1388 case JTAG_TLR_RESET:
1394 /* some events, such as resets, need a queue flush to ensure consistency */
1395 tap_state_queue_run();
1403 #ifdef _DEBUG_JTAG_IO_
1404 LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
1406 if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
1408 tap_set_state(TAP_RESET);
1410 rlink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
1413 #ifdef _DEBUG_JTAG_IO_
1414 LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
1416 if (cmd->cmd.runtest->end_state != -1)
1417 rlink_end_state(cmd->cmd.runtest->end_state);
1418 rlink_runtest(cmd->cmd.runtest->num_cycles);
1420 case JTAG_TLR_RESET:
1421 #ifdef _DEBUG_JTAG_IO_
1422 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
1424 if (cmd->cmd.statemove->end_state != -1)
1425 rlink_end_state(cmd->cmd.statemove->end_state);
1429 #ifdef _DEBUG_JTAG_IO_
1430 LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
1432 rlink_path_move(cmd->cmd.pathmove);
1435 #ifdef _DEBUG_JTAG_IO_
1436 LOG_DEBUG("%s scan end in %i", (cmd->cmd.scan->ir_scan) ? "IR" : "DR", cmd->cmd.scan->end_state);
1438 if (cmd->cmd.scan->end_state != -1)
1439 rlink_end_state(cmd->cmd.scan->end_state);
1440 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
1441 type = jtag_scan_type(cmd->cmd.scan);
1442 if (rlink_scan(cmd, type, buffer, scan_size) != ERROR_OK) {
1443 retval = ERROR_FAIL;
1447 #ifdef _DEBUG_JTAG_IO_
1448 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
1450 jtag_sleep(cmd->cmd.sleep->us);
1453 LOG_ERROR("BUG: unknown JTAG command type encountered");
1459 /* Flush the DTC queue to make sure any pending reads have been done before exiting this function */
1460 tap_state_queue_run();
1461 tmp_retval = dtc_queue_run();
1462 if (tmp_retval != ERROR_OK) {
1463 retval = tmp_retval;
1466 #ifndef AUTOMATIC_BUSY_LED
1468 ep1_generic_commandl(pHDev, 2,
1469 EP1_CMD_SET_PORTD_LEDS,
1478 /* 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. */
1481 int rlink_speed(int speed)
1487 speed = rlink_speed_table[rlink_speed_table_size - 1].prescaler;
1490 for (i = rlink_speed_table_size; i--;) {
1491 if (rlink_speed_table[i].prescaler == speed) {
1492 if (dtc_load_from_buffer(pHDev, rlink_speed_table[i].dtc, rlink_speed_table[i].dtc_size) != 0) {
1493 LOG_ERROR("An error occurred while trying to load DTC code for speed \"%d\".", speed);
1497 if (dtc_start_download() < 0) {
1498 LOG_ERROR("starting DTC: %s", usb_strerror());
1506 LOG_ERROR("%d is not a supported speed", speed);
1512 int rlink_speed_div(
1518 for (i = rlink_speed_table_size; i--;) {
1519 if (rlink_speed_table[i].prescaler == speed) {
1520 *khz = rlink_speed_table[i].khz;
1525 LOG_ERROR("%d is not a supported speed", speed);
1538 LOG_ERROR("RCLK not supported");
1542 for (i = rlink_speed_table_size; i--;) {
1543 if (rlink_speed_table[i].khz <= khz) {
1544 *speed = rlink_speed_table[i].prescaler;
1549 LOG_WARNING("The lowest supported JTAG speed is %d KHz", rlink_speed_table[0].khz);
1550 *speed = rlink_speed_table[0].prescaler;
1556 int rlink_init(void)
1559 uint8_t reply_buffer[USB_EP1IN_SIZE];
1562 const uint16_t vids[] = { USB_IDVENDOR, 0 };
1563 const uint16_t pids[] = { USB_IDPRODUCT, 0 };
1564 if (jtag_usb_open(vids, pids, &pHDev) != ERROR_OK)
1567 struct usb_device *dev = usb_device(pHDev);
1568 if (dev->descriptor.bNumConfigurations > 1)
1570 LOG_ERROR("Whoops! NumConfigurations is not 1, don't know what to do...");
1573 if (dev->config->bNumInterfaces > 1)
1575 LOG_ERROR("Whoops! NumInterfaces is not 1, don't know what to do...");
1579 LOG_DEBUG("Opened device, pHDev = %p", pHDev);
1581 /* usb_set_configuration required under win32 */
1582 usb_set_configuration(pHDev, dev->config[0].bConfigurationValue);
1587 i = usb_claim_interface(pHDev,0);
1590 LOG_ERROR("usb_claim_interface: %s", usb_strerror());
1591 #ifdef LIBUSB_HAS_DETACH_KERNEL_DRIVER_NP
1592 j = usb_detach_kernel_driver_np(pHDev, 0);
1594 LOG_ERROR("detach kernel driver: %s", usb_strerror());
1599 LOG_DEBUG("interface claimed!");
1602 } while (--retries);
1606 LOG_ERROR("Initialisation failed.");
1609 if (usb_set_altinterface(pHDev,0) != 0)
1611 LOG_ERROR("Failed to set interface.");
1615 /* The device starts out in an unknown state on open. As such,
1616 * result reads time out, and it's not even known whether the
1617 * command was accepted. So, for this first command, we issue
1618 * it repeatedly until its response doesn't time out. Also, if
1619 * sending a command is going to time out, we find that out here.
1621 * It must be possible to open the device in such a way that
1622 * this special magic isn't needed, but, so far, it escapes us.
1624 for (i = 0; i < 5; i++) {
1625 j = ep1_generic_commandl(
1629 if (j < USB_EP1OUT_SIZE) {
1630 LOG_ERROR("USB write error: %s", usb_strerror());
1634 pHDev, USB_EP1IN_ADDR,
1635 (char *)reply_buffer, sizeof(reply_buffer),
1638 if (j != -ETIMEDOUT) break;
1641 if (j < (int)sizeof(reply_buffer)) {
1642 LOG_ERROR("USB read error: %s", usb_strerror());
1645 LOG_DEBUG(INTERFACE_NAME" firmware version: %d.%d.%d", reply_buffer[0], reply_buffer[1], reply_buffer[2]);
1647 if ((reply_buffer[0] != 0) || (reply_buffer[1] != 0) || (reply_buffer[2] != 3)) {
1648 LOG_WARNING("The rlink device is not of the version that the developers have played with. It may or may not work.");
1651 /* Probe port E for adapter presence */
1652 ep1_generic_commandl(
1654 EP1_CMD_MEMORY_WRITE, /* Drive sense pin with 0 */
1659 ST7_PE_ADAPTER_SENSE_OUT, /* DDR */
1660 ST7_PE_ADAPTER_SENSE_OUT, /* OR */
1661 EP1_CMD_MEMORY_READ, /* Read back */
1665 EP1_CMD_MEMORY_WRITE, /* Drive sense pin with 1 */
1669 ST7_PE_ADAPTER_SENSE_OUT
1673 pHDev, USB_EP1IN_ADDR,
1674 (char *)reply_buffer, 1,
1678 if ((reply_buffer[0] & ST7_PE_ADAPTER_SENSE_IN) != 0) {
1679 LOG_WARNING("target detection problem");
1682 ep1_generic_commandl(
1684 EP1_CMD_MEMORY_READ, /* Read back */
1688 EP1_CMD_MEMORY_WRITE, /* float port E */
1698 pHDev, USB_EP1IN_ADDR,
1699 (char *)reply_buffer, 1,
1704 if ((reply_buffer[0] & ST7_PE_ADAPTER_SENSE_IN) == 0) {
1705 LOG_WARNING("target not plugged in");
1708 /* float ports A and B */
1709 ep1_generic_commandl(
1711 EP1_CMD_MEMORY_WRITE,
1717 EP1_CMD_MEMORY_WRITE,
1724 /* make sure DTC is stopped, set VPP control, set up ports A and B */
1725 ep1_generic_commandl(
1728 EP1_CMD_SET_PORTD_VPP,
1730 EP1_CMD_MEMORY_WRITE,
1734 ((~(0)) & (ST7_PA_NTRST)),
1736 /* 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. */
1737 EP1_CMD_MEMORY_WRITE,
1744 /* set LED updating mode and make sure they're unlit */
1745 ep1_generic_commandl(
1747 #ifdef AUTOMATIC_BUSY_LED
1752 EP1_CMD_SET_PORTD_LEDS,
1756 tap_state_queue_init();
1765 int rlink_quit(void)
1767 /* stop DTC and make sure LEDs are off */
1768 ep1_generic_commandl(
1772 EP1_CMD_SET_PORTD_LEDS,
1774 EP1_CMD_SET_PORTD_VPP,
1778 usb_release_interface(pHDev,0);
1786 struct jtag_interface rlink_interface =
1791 .speed = rlink_speed,
1792 .speed_div = rlink_speed_div,
1794 .execute_queue = rlink_execute_queue,