Support hla_serial command for ST-LINK adapters.
[openocd.git] / src / jtag / drivers / jlink.c
index 35c1a5c4b6dee2086c45a98c18626c97451a5466..55b1e45f9fb54b13cb2f1492710fb620aa0b5bde 100644 (file)
@@ -21,7 +21,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -29,6 +29,7 @@
 #endif
 
 #include <jtag/interface.h>
+#include <jtag/swd.h>
 #include <jtag/commands.h>
 #include "libusb_common.h"
 
  * pid = ( usb_address > 0x4) ? 0x0101 : (0x101 + usb_address)
  */
 
-#define VID 0x1366, 0x1366, 0x1366, 0x1366
-#define PID 0x0101, 0x0102, 0x0103, 0x0104
+#define JLINK_OB_PID  0x0105
 
 #define JLINK_WRITE_ENDPOINT   0x02
 #define JLINK_READ_ENDPOINT            0x81
 
+#define JLINK_OB_WRITE_ENDPOINT        0x06
+#define JLINK_OB_READ_ENDPOINT 0x85
+
 static unsigned int jlink_write_ep = JLINK_WRITE_ENDPOINT;
 static unsigned int jlink_read_ep = JLINK_READ_ENDPOINT;
 static unsigned int jlink_hw_jtag_version = 2;
@@ -64,33 +67,54 @@ static unsigned int jlink_hw_jtag_version = 2;
 /*#define JLINK_TAP_BUFFER_SIZE 256*/
 /*#define JLINK_TAP_BUFFER_SIZE 384*/
 
-#define JLINK_IN_BUFFER_SIZE                   2048
+#define JLINK_IN_BUFFER_SIZE                   (2048 + 1)
 #define JLINK_OUT_BUFFER_SIZE                  (2*2048 + 4)
-#define JLINK_EMU_RESULT_BUFFER_SIZE   64
 
 /* Global USB buffers */
 static uint8_t usb_in_buffer[JLINK_IN_BUFFER_SIZE];
 static uint8_t usb_out_buffer[JLINK_OUT_BUFFER_SIZE];
-static uint8_t usb_emu_result_buffer[JLINK_EMU_RESULT_BUFFER_SIZE];
 
 /* Constants for JLink command */
 #define EMU_CMD_VERSION                        0x01
+#define EMU_CMD_RESET_TRST             0x02
+#define EMU_CMD_RESET_TARGET   0x03
 #define EMU_CMD_SET_SPEED              0x05
 #define EMU_CMD_GET_STATE              0x07
+#define EMU_CMD_SET_KS_POWER   0x08
+#define EMU_CMD_GET_SPEEDS             0xc0
+#define EMU_CMD_GET_HW_INFO            0xc1
+#define EMU_CMD_GET_COUNTERS   0xc2
+#define EMU_CMD_SELECT_IF              0xc7
 #define EMU_CMD_HW_CLOCK               0xc8
 #define EMU_CMD_HW_TMS0                        0xc9
 #define EMU_CMD_HW_TMS1                        0xca
+#define EMU_CMD_HW_DATA0               0xcb
+#define EMU_CMD_HW_DATA1               0xcc
+#define EMU_CMD_HW_JTAG                        0xcd
 #define EMU_CMD_HW_JTAG2               0xce
 #define EMU_CMD_HW_JTAG3               0xcf
+#define EMU_CMD_HW_RELEASE_RESET_STOP_EX 0xd0
+#define EMU_CMD_HW_RELEASE_RESET_STOP_TIMED 0xd1
 #define EMU_CMD_GET_MAX_MEM_BLOCK      0xd4
+#define EMU_CMD_HW_JTAG_WRITE          0xd5
+#define EMU_CMD_HW_JTAG_GET_RESULT     0xd6
 #define EMU_CMD_HW_RESET0              0xdc
 #define EMU_CMD_HW_RESET1              0xdd
 #define EMU_CMD_HW_TRST0               0xde
 #define EMU_CMD_HW_TRST1               0xdf
 #define EMU_CMD_GET_CAPS               0xe8
+#define EMU_CMD_GET_CPU_CAPS   0xe9
+#define EMU_CMD_EXEC_CPU_CMD   0xea
+#define EMU_CMD_GET_CAPS_EX            0xed
 #define EMU_CMD_GET_HW_VERSION 0xf0
+#define EMU_CMD_WRITE_DCC              0xf1
 #define EMU_CMD_READ_CONFIG            0xf2
 #define EMU_CMD_WRITE_CONFIG           0xf3
+#define EMU_CMD_WRITE_MEM                      0xf4
+#define EMU_CMD_READ_MEM                       0xf5
+#define EMU_CMD_MEASURE_RTCK_REACT     0xf6
+#define EMU_CMD_WRITE_MEM_ARM79                0xf7
+#define EMU_CMD_READ_MEM_ARM79         0xf8
 
 /* bits return from EMU_CMD_GET_CAPS */
 #define EMU_CAP_RESERVED_1             0
@@ -126,7 +150,7 @@ static uint8_t usb_emu_result_buffer[JLINK_EMU_RESULT_BUFFER_SIZE];
 #define EMU_CAP_RAWTRACE               30
 #define EMU_CAP_RESERVED_3             31
 
-static char *jlink_cap_str[] = {
+static const char * const jlink_cap_str[] = {
        "Always 1.",
        "Supports command EMU_CMD_GET_HARDWARE_VERSION",
        "Supports command EMU_CMD_WRITE_DCC",
@@ -165,19 +189,27 @@ static char *jlink_cap_str[] = {
 #define JLINK_MAX_SPEED 12000
 
 /* J-Link hardware versions */
-#define JLINK_HW_TYPE_JLINK    0
-#define JLINK_HW_TYPE_JTRACE   1
-#define JLINK_HW_TYPE_FLASHER  2
-#define JLINK_HW_TYPE_JLINK_PRO        3
-#define JLINK_HW_TYPE_MAX      4
-
-static char *jlink_hw_type_str[] = {
+#define JLINK_HW_TYPE_JLINK                            0
+#define JLINK_HW_TYPE_JTRACE                   1
+#define JLINK_HW_TYPE_FLASHER                  2
+#define JLINK_HW_TYPE_JLINK_PRO                        3
+#define JLINK_HW_TYPE_JLINK_LITE_ADI   5
+#define JLINK_HW_TYPE_MAX                              6
+
+static const char * const jlink_hw_type_str[] = {
        "J-Link",
        "J-Trace",
        "Flasher",
        "J-Link Pro",
+       "Unknown",
+       "J-Link Lite-ADI",
 };
 
+#define JLINK_TIF_JTAG         0
+#define JLINK_TIF_SWD          1
+#define JLINK_SWD_DIR_IN       0
+#define JLINK_SWD_DIR_OUT      1
+
 /* Queue command functions */
 static void jlink_end_state(tap_state_t state);
 static void jlink_state_move(void);
@@ -188,6 +220,9 @@ static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
 static void jlink_reset(int trst, int srst);
 static void jlink_simple_command(uint8_t command);
 static int jlink_get_status(void);
+static int jlink_swd_run_queue(struct adiv5_dap *dap);
+static void jlink_swd_queue_cmd(struct adiv5_dap *dap, uint8_t cmd, uint32_t *dst, uint32_t data);
+static int jlink_swd_switch_seq(struct adiv5_dap *dap, enum swd_special_seq seq);
 
 /* J-Link tap buffer functions */
 static void jlink_tap_init(void);
@@ -205,9 +240,9 @@ struct jlink {
 static struct jlink *jlink_usb_open(void);
 static void jlink_usb_close(struct jlink *jlink);
 static int jlink_usb_message(struct jlink *jlink, int out_length, int in_length);
+static int jlink_usb_io(struct jlink *jlink, int out_length, int in_length);
 static int jlink_usb_write(struct jlink *jlink, int out_length);
 static int jlink_usb_read(struct jlink *jlink, int expected_size);
-static int jlink_usb_read_emu_result(struct jlink *jlink);
 
 /* helper functions */
 static int jlink_get_version_info(void);
@@ -225,12 +260,15 @@ static enum tap_state jlink_last_state = TAP_RESET;
 static struct jlink *jlink_handle;
 
 /* pid could be specified at runtime */
-static uint16_t vids[] = { VID, 0 };
-static uint16_t pids[] = { PID, 0 };
+static uint16_t vids[] = { 0x1366, 0x1366, 0x1366, 0x1366, 0x1366, 0 };
+static uint16_t pids[] = { 0x0101, 0x0102, 0x0103, 0x0104, 0x0105, 0 };
 
 static uint32_t jlink_caps;
 static uint32_t jlink_hw_type;
 
+static int queued_retval;
+static bool swd_mode;
+
 /* 256 byte non-volatile memory */
 struct jlink_config {
        uint8_t usb_address;
@@ -399,6 +437,67 @@ static int jlink_khz(int khz, int *jtag_speed)
        return ERROR_OK;
 }
 
+/*
+ * select transport interface
+ *
+ * @param      iface [0..31] currently: 0=JTAG, 1=SWD
+ * @returns    ERROR_OK or ERROR_ code
+ *
+ * @pre jlink_handle must be opened
+ * @pre function may be called only for devices, that have
+ *             EMU_CAP_SELECT_IF capability enabled
+ */
+static int jlink_select_interface(int iface)
+{
+       /* According to Segger's document RM08001-R7 Date: October 8, 2010,
+        * http://www.segger.com/admin/uploads/productDocs/RM08001_JLinkUSBProtocol.pdf
+        * section 5.5.3 EMU_CMD_SELECT_IF
+        * > SubCmd 1..31 to select interface (0..31)
+        *
+        * The table below states:
+        *  0 TIF_JTAG
+        *  1 TIF_SWD
+        *
+        * This obviosly means that to select TIF_JTAG one should write SubCmd = 1.
+        *
+        * In fact, JTAG interface operates when SubCmd=0
+        *
+        * It looks like a typo in documentation, because interfaces 0..31 could not
+        * be selected by 1..31 range command.
+        */
+       assert(iface >= 0 && iface < 32);
+       int result;
+
+       /* get available interfaces */
+       usb_out_buffer[0] = EMU_CMD_SELECT_IF;
+       usb_out_buffer[1] = 0xff;
+
+       result = jlink_usb_io(jlink_handle, 2, 4);
+       if (result != ERROR_OK) {
+               LOG_ERROR("J-Link query interface failed (%d)", result);
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
+
+       uint32_t iface_mask = buf_get_u32(usb_in_buffer, 0, 32);
+
+       if (!(iface_mask & (1<<iface))) {
+               LOG_ERROR("J-Link requesting to select unsupported interface (%" PRIx32 ")", iface_mask);
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
+
+       /* Select interface */
+       usb_out_buffer[0] = EMU_CMD_SELECT_IF;
+       usb_out_buffer[1] = iface;
+
+       result = jlink_usb_io(jlink_handle, 2, 4);
+       if (result != ERROR_OK) {
+               LOG_ERROR("J-Link interface select failed (%d)", result);
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
+
+       return ERROR_OK;
+}
+
 static int jlink_init(void)
 {
        int i;
@@ -411,28 +510,6 @@ static int jlink_init(void)
                return ERROR_JTAG_INIT_FAILED;
        }
 
-       /*
-        * The next three instructions were added after discovering a problem
-        * while using an oscilloscope.
-        * For the V8 SAM-ICE dongle (and likely other j-link device variants),
-        * the reset line to the target microprocessor was found to cycle only
-        * intermittently during emulator startup (even after encountering the
-        * downstream reset instruction later in the code).
-        * This was found to create two issues:
-        * 1) In general it is a bad practice to not reset a CPU to a known
-        * state when starting an emulator and
-        * 2) something critical happens inside the dongle when it does the
-        * first read following a new USB session.
-        * Keeping the processor in reset during the first read collecting
-        * version information seems to prevent errant
-        * "J-Link command EMU_CMD_VERSION failed" issues.
-        */
-
-       LOG_INFO("J-Link initialization started / target CPU reset initiated");
-       jlink_simple_command(EMU_CMD_HW_TRST0);
-       jlink_simple_command(EMU_CMD_HW_RESET0);
-       usleep(1000);
-
        jlink_hw_jtag_version = 2;
 
        if (jlink_get_version_info() == ERROR_OK) {
@@ -440,17 +517,44 @@ static int jlink_init(void)
                jlink_get_status();
        }
 
+       /*
+        * Some versions of Segger's software do not select JTAG interface by default.
+        *
+        * Segger recommends to select interface necessarily as a part of init process,
+        * in case any previous session leaves improper interface selected.
+        */
+       int retval;
+       if (jlink_caps & (1<<EMU_CAP_SELECT_IF))
+               retval = jlink_select_interface(swd_mode ? JLINK_TIF_SWD : JLINK_TIF_JTAG);
+       else
+               retval = swd_mode ? ERROR_JTAG_DEVICE_ERROR : ERROR_OK;
+
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Selected transport mode is not supported.");
+               return ERROR_JTAG_INIT_FAILED;
+       }
+
        LOG_INFO("J-Link JTAG Interface ready");
 
        jlink_reset(0, 0);
        jtag_sleep(3000);
        jlink_tap_init();
 
-       /* v5/6 jlink seems to have an issue if the first tap move
-        * is not divisible by 8, so we send a TLR on first power up */
-       for (i = 0; i < 8; i++)
-               jlink_tap_append_step(1, 0);
-       jlink_tap_execute();
+       jlink_speed(jtag_get_speed_khz());
+
+       if (!swd_mode) {
+               /* v5/6 jlink seems to have an issue if the first tap move
+                * is not divisible by 8, so we send a TLR on first power up */
+               for (i = 0; i < 8; i++)
+                       jlink_tap_append_step(1, 0);
+               jlink_tap_execute();
+       }
+
+       if (swd_mode)
+               jlink_swd_switch_seq(NULL, JTAG_TO_SWD);
+       else
+               jlink_swd_switch_seq(NULL, SWD_TO_JTAG);
+       jlink_swd_run_queue(NULL);
 
        return ERROR_OK;
 }
@@ -653,7 +757,7 @@ static void jlink_config_kickstart_dump(struct command_context *ctx, struct jlin
        if (!cfg)
                return;
 
-       jlink_dump_printf(ctx, "Kickstart power on JTAG-pin 19: 0x%x",
+       jlink_dump_printf(ctx, "Kickstart power on JTAG-pin 19: 0x%" PRIx32,
                cfg->kickstart_power_on_jtag_pin_19);
 }
 
@@ -701,22 +805,15 @@ static int jlink_get_config(struct jlink_config *cfg)
        int result;
        int size = sizeof(struct jlink_config);
 
-       jlink_simple_command(EMU_CMD_READ_CONFIG);
+       usb_out_buffer[0] = EMU_CMD_READ_CONFIG;
+       result = jlink_usb_io(jlink_handle, 1, size);
 
-       result = jlink_usb_read(jlink_handle, size);
-       if (size != result) {
+       if (result != ERROR_OK) {
                LOG_ERROR("jlink_usb_read failed (requested=%d, result=%d)", size, result);
                return ERROR_FAIL;
        }
 
        memcpy(cfg, usb_in_buffer, size);
-
-       /*
-        * Section 4.2.4 IN-transaction
-        * read dummy 0-byte packet
-        */
-       jlink_usb_read(jlink_handle, 1);
-
        return ERROR_OK;
 }
 
@@ -738,6 +835,40 @@ static int jlink_set_config(struct jlink_config *cfg)
        return ERROR_OK;
 }
 
+/*
+ * List of unsupported version string markers.
+ *
+ * The firmware versions does not correspond directly with
+ * "Software and documentation pack for Windows", it may be
+ * distinguished by the "compile" date in the information string.
+ *
+ * For example, version string is:
+ *   "J-Link ARM V8 compiled May  3 2012 18:36:22"
+ * Marker sould be:
+ *   "May  3 2012"
+ *
+ * The list must be terminated by NULL string.
+ */
+static const char * const unsupported_versions[] = {
+       "Jan 31 2011",
+       "JAN 31 2011",
+       NULL                    /* End of list */
+};
+
+static void jlink_check_supported(const char *str)
+{
+       const char * const *p = unsupported_versions;
+       while (*p) {
+               if (NULL != strstr(str, *p)) {
+                       LOG_WARNING(
+                       "Unsupported J-Link firmware version.\n"
+                       "       Please check http://www.segger.com/j-link-older-versions.html for updates");
+                       return;
+               }
+               p++;
+       }
+}
+
 static int jlink_get_version_info(void)
 {
        int result;
@@ -767,6 +898,7 @@ static int jlink_get_version_info(void)
 
        usb_in_buffer[result] = 0;
        LOG_INFO("%s", (char *)usb_in_buffer);
+       jlink_check_supported((char *)usb_in_buffer);
 
        /* query hardware capabilities */
        jlink_simple_command(EMU_CMD_GET_CAPS);
@@ -799,7 +931,7 @@ static int jlink_get_version_info(void)
                LOG_INFO("J-Link hw version %i", (int)jlink_hw_version);
 
                if (jlink_hw_type >= JLINK_HW_TYPE_MAX)
-                       LOG_INFO("J-Link hw type uknown 0x%x", jlink_hw_type);
+                       LOG_INFO("J-Link hw type unknown 0x%" PRIx32, jlink_hw_type);
                else
                        LOG_INFO("J-Link hw type %s", jlink_hw_type_str[jlink_hw_type]);
        }
@@ -1171,9 +1303,50 @@ static const struct command_registration jlink_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
+static int jlink_swd_init(void)
+{
+       LOG_INFO("JLink SWD mode enabled");
+       swd_mode = true;
+
+       return ERROR_OK;
+}
+
+static void jlink_swd_write_reg(struct adiv5_dap *dap, uint8_t cmd, uint32_t value)
+{
+       assert(!(cmd & SWD_CMD_RnW));
+       jlink_swd_queue_cmd(dap, cmd, NULL, value);
+}
+
+static void jlink_swd_read_reg(struct adiv5_dap *dap, uint8_t cmd, uint32_t *value)
+{
+       assert(cmd & SWD_CMD_RnW);
+       jlink_swd_queue_cmd(dap, cmd, value, 0);
+}
+
+static int_least32_t jlink_swd_frequency(struct adiv5_dap *dap, int_least32_t hz)
+{
+       if (hz > 0)
+               jlink_speed(hz / 1000);
+
+       return hz;
+}
+
+static const struct swd_driver jlink_swd = {
+       .init = jlink_swd_init,
+       .frequency = jlink_swd_frequency,
+       .switch_seq = jlink_swd_switch_seq,
+       .read_reg = jlink_swd_read_reg,
+       .write_reg = jlink_swd_write_reg,
+       .run = jlink_swd_run_queue,
+};
+
+static const char * const jlink_transports[] = { "jtag", "swd", NULL };
+
 struct jtag_interface jlink_interface = {
        .name = "jlink",
        .commands = jlink_command_handlers,
+       .transports = jlink_transports,
+       .swd = &jlink_swd,
 
        .execute_queue = jlink_execute_queue,
        .speed = jlink_speed,
@@ -1188,6 +1361,7 @@ struct jtag_interface jlink_interface = {
 
 
 static unsigned tap_length;
+/* In SWD mode use tms buffer for direction control */
 static uint8_t tms_buffer[JLINK_TAP_BUFFER_SIZE];
 static uint8_t tdi_buffer[JLINK_TAP_BUFFER_SIZE];
 static uint8_t tdo_buffer[JLINK_TAP_BUFFER_SIZE];
@@ -1196,7 +1370,7 @@ struct pending_scan_result {
        int first;      /* First bit position in tdo_buffer to read */
        int length; /* Number of bits to read */
        struct scan_command *command; /* Corresponding scan command */
-       uint8_t *buffer;
+       void *buffer;
 };
 
 #define MAX_PENDING_SCAN_RESULTS 256
@@ -1223,11 +1397,7 @@ static void jlink_tap_append_step(int tms, int tdi)
 {
        int index_var = tap_length / 8;
 
-       if (index_var >= JLINK_TAP_BUFFER_SIZE) {
-               LOG_ERROR("jlink_tap_append_step: overflow");
-               *(uint32_t *)0xFFFFFFFF = 0;
-               exit(-1);
-       }
+       assert(index_var < JLINK_TAP_BUFFER_SIZE);
 
        int bit_index = tap_length % 8;
        uint8_t bit = 1 << bit_index;
@@ -1300,10 +1470,18 @@ static int jlink_tap_execute(void)
        jlink_last_state = jtag_debug_state_machine(tms_buffer, tdi_buffer,
                        tap_length, jlink_last_state);
 
-       result = jlink_usb_message(jlink_handle, 4 + 2 * byte_length, byte_length);
-       if (result != byte_length) {
-               LOG_ERROR("jlink_tap_execute, wrong result %d (expected %d)",
-                               result, byte_length);
+       result = jlink_usb_message(jlink_handle, 4 + 2 * byte_length,
+                       use_jtag3 ? byte_length + 1 : byte_length);
+       if (result != ERROR_OK) {
+               LOG_ERROR("jlink_tap_execute failed USB io (%d)", result);
+               jlink_tap_init();
+               return ERROR_JTAG_QUEUE_FAILED;
+       }
+
+       result = use_jtag3 ? usb_in_buffer[byte_length] : 0;
+       if (result != 0) {
+               LOG_ERROR("jlink_tap_execute failed, result %d (%s)", result,
+                         result == 1 ? "adaptive clocking timeout" : "unknown");
                jlink_tap_init();
                return ERROR_JTAG_QUEUE_FAILED;
        }
@@ -1337,13 +1515,191 @@ static int jlink_tap_execute(void)
        return ERROR_OK;
 }
 
+static void fill_buffer(uint8_t *buf, uint32_t val, uint32_t len)
+{
+       unsigned int tap_pos = tap_length;
+
+       while (len > 32) {
+               buf_set_u32(buf, tap_pos, 32, val);
+               len -= 32;
+               tap_pos += 32;
+       }
+       if (len)
+               buf_set_u32(buf, tap_pos, len, val);
+}
+
+static void jlink_queue_data_out(const uint8_t *data, uint32_t len)
+{
+       const uint32_t dir_out = 0xffffffff;
+
+       if (data)
+               bit_copy(tdi_buffer, tap_length, data, 0, len);
+       else
+               fill_buffer(tdi_buffer, 0, len);
+       fill_buffer(tms_buffer, dir_out, len);
+       tap_length += len;
+}
+
+static void jlink_queue_data_in(uint32_t len)
+{
+       const uint32_t dir_in = 0;
+
+       fill_buffer(tms_buffer, dir_in, len);
+       tap_length += len;
+}
+
+static int jlink_swd_switch_seq(struct adiv5_dap *dap, enum swd_special_seq seq)
+{
+       const uint8_t *s;
+       unsigned int s_len;
+
+       switch (seq) {
+       case LINE_RESET:
+               LOG_DEBUG("SWD line reset");
+               s = swd_seq_line_reset;
+               s_len = swd_seq_line_reset_len;
+               break;
+       case JTAG_TO_SWD:
+               LOG_DEBUG("JTAG-to-SWD");
+               s = swd_seq_jtag_to_swd;
+               s_len = swd_seq_jtag_to_swd_len;
+               break;
+       case SWD_TO_JTAG:
+               LOG_DEBUG("SWD-to-JTAG");
+               s = swd_seq_swd_to_jtag;
+               s_len = swd_seq_swd_to_jtag_len;
+               break;
+       default:
+               LOG_ERROR("Sequence %d not supported", seq);
+               return ERROR_FAIL;
+       }
+
+       jlink_queue_data_out(s, s_len);
+
+       return ERROR_OK;
+}
+
+static int jlink_swd_run_queue(struct adiv5_dap *dap)
+{
+       LOG_DEBUG("Executing %d queued transactions", pending_scan_results_length);
+       int retval;
+
+       if (queued_retval != ERROR_OK) {
+               LOG_DEBUG("Skipping due to previous errors: %d", queued_retval);
+               goto skip;
+       }
+
+       /* A transaction must be followed by another transaction or at least 8 idle cycles to
+        * ensure that data is clocked through the AP. */
+       jlink_queue_data_out(NULL, 8);
+
+       size_t byte_length = DIV_ROUND_UP(tap_length, 8);
+
+       /* There's a comment in jlink_tap_execute saying JLink returns
+        * an extra NULL in packet when size of incoming message is a
+        * multiple of 64. Someone should verify if that's still the
+        * case with the current jlink firmware */
+
+       usb_out_buffer[0] = EMU_CMD_HW_JTAG3;
+       usb_out_buffer[1] = 0;
+       usb_out_buffer[2] = (tap_length >> 0) & 0xff;
+       usb_out_buffer[3] = (tap_length >> 8) & 0xff;
+       memcpy(usb_out_buffer + 4, tms_buffer, byte_length);
+       memcpy(usb_out_buffer + 4 + byte_length, tdi_buffer, byte_length);
+
+       retval = jlink_usb_message(jlink_handle, 4 + 2 * byte_length,
+                                  byte_length + 1);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("jlink_swd_run_queue failed USB io (%d)", retval);
+               goto skip;
+       }
+
+       retval = usb_in_buffer[byte_length];
+       if (retval) {
+               LOG_ERROR("jlink_swd_run_queue failed, result %d", retval);
+               goto skip;
+       }
+
+       for (int i = 0; i < pending_scan_results_length; i++) {
+               int ack = buf_get_u32(usb_in_buffer, pending_scan_results_buffer[i].first, 3);
+
+               if (ack != SWD_ACK_OK) {
+                       LOG_ERROR("SWD ack not OK: %d %s", ack,
+                                 ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK");
+                       queued_retval = ack;
+                       goto skip;
+               } else if (pending_scan_results_buffer[i].length) {
+                       uint32_t data = buf_get_u32(usb_in_buffer, 3 + pending_scan_results_buffer[i].first, 32);
+                       int parity = buf_get_u32(usb_in_buffer, 3 + 32 + pending_scan_results_buffer[i].first, 1);
+
+                       if (parity != parity_u32(data)) {
+                               LOG_ERROR("SWD Read data parity mismatch");
+                               queued_retval = ERROR_FAIL;
+                               goto skip;
+                       }
+
+                       if (pending_scan_results_buffer[i].buffer)
+                               *(uint32_t *)pending_scan_results_buffer[i].buffer = data;
+               }
+       }
+
+skip:
+       jlink_tap_init();
+       retval = queued_retval;
+       queued_retval = ERROR_OK;
+
+       return retval;
+}
+
+static void jlink_swd_queue_cmd(struct adiv5_dap *dap, uint8_t cmd, uint32_t *dst, uint32_t data)
+{
+       uint8_t data_parity_trn[DIV_ROUND_UP(32 + 1, 8)];
+       if (tap_length + 46 + 8 + dap->memaccess_tck >= sizeof(tdi_buffer) * 8 ||
+           pending_scan_results_length == MAX_PENDING_SCAN_RESULTS) {
+               /* Not enough room in the queue. Run the queue. */
+               queued_retval = jlink_swd_run_queue(dap);
+       }
+
+       if (queued_retval != ERROR_OK)
+               return;
+
+       cmd |= SWD_CMD_START | SWD_CMD_PARK;
+
+       jlink_queue_data_out(&cmd, 8);
+
+       pending_scan_results_buffer[pending_scan_results_length].first = tap_length;
+
+       if (cmd & SWD_CMD_RnW) {
+               /* Queue a read transaction */
+               pending_scan_results_buffer[pending_scan_results_length].length = 32;
+               pending_scan_results_buffer[pending_scan_results_length].buffer = dst;
+
+               jlink_queue_data_in(1 + 3 + 32 + 1 + 1);
+       } else {
+               /* Queue a write transaction */
+               pending_scan_results_buffer[pending_scan_results_length].length = 0;
+               jlink_queue_data_in(1 + 3 + 1);
+
+               buf_set_u32(data_parity_trn, 0, 32, data);
+               buf_set_u32(data_parity_trn, 32, 1, parity_u32(data));
+
+               jlink_queue_data_out(data_parity_trn, 32 + 1);
+       }
+
+       pending_scan_results_length++;
+
+       /* Insert idle cycles after AP accesses to avoid WAIT */
+       if (cmd & SWD_CMD_APnDP)
+               jlink_queue_data_out(NULL, dap->memaccess_tck);
+}
+
 /*****************************************************************************/
 /* JLink USB low-level functions */
 
 static struct jlink *jlink_usb_open()
 {
        struct jtag_libusb_device_handle *devh;
-       if (jtag_libusb_open(vids, pids, &devh) != ERROR_OK)
+       if (jtag_libusb_open(vids, pids, NULL, &devh) != ERROR_OK)
                return NULL;
 
        /* BE ***VERY CAREFUL*** ABOUT MAKING CHANGES IN THIS
@@ -1367,7 +1723,7 @@ static struct jlink *jlink_usb_open()
        /* reopen jlink after usb_reset
         * on win32 this may take a second or two to re-enumerate */
        int retval;
-       while ((retval = jtag_libusb_open(vids, pids, &devh)) != ERROR_OK) {
+       while ((retval = jtag_libusb_open(vids, pids, NULL, &devh)) != ERROR_OK) {
                usleep(1000);
                timeout--;
                if (!timeout)
@@ -1392,6 +1748,15 @@ static struct jlink *jlink_usb_open()
        usb_set_altinterface(result->usb_handle, 0);
 #endif
 
+       /* Use the OB endpoints if the JLink we matched is a Jlink-OB adapter */
+       uint16_t matched_pid;
+       if (jtag_libusb_get_pid(udev, &matched_pid) == ERROR_OK) {
+               if (matched_pid == JLINK_OB_PID) {
+                       jlink_read_ep = JLINK_OB_WRITE_ENDPOINT;
+                       jlink_write_ep = JLINK_OB_READ_ENDPOINT;
+               }
+       }
+
        jtag_libusb_get_endpoints(udev, &jlink_read_ep, &jlink_write_ep);
 
        struct jlink *result = malloc(sizeof(struct jlink));
@@ -1418,44 +1783,12 @@ static int jlink_usb_message(struct jlink *jlink, int out_length, int in_length)
        }
 
        result = jlink_usb_read(jlink, in_length);
-       if ((result != in_length) && (result != (in_length + 1))) {
+       if (result != in_length) {
                LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
                                in_length, result);
                return ERROR_JTAG_DEVICE_ERROR;
        }
-
-       if (jlink_hw_jtag_version < 3)
-               return result;
-
-       int result2 = ERROR_OK;
-       if (result == in_length) {
-               /* Must read the result from the EMU too */
-               result2 = jlink_usb_read_emu_result(jlink);
-               if (1 != result2) {
-                       LOG_ERROR("jlink_usb_read_emu_result retried requested = 1, "
-                                       "result=%d, in_length=%i", result2, in_length);
-                       /* Try again once, should only happen if (in_length%64 == 0) */
-                       result2 = jlink_usb_read_emu_result(jlink);
-                       if (1 != result2) {
-                               LOG_ERROR("jlink_usb_read_emu_result failed "
-                                       "(requested = 1, result=%d)", result2);
-                               return ERROR_JTAG_DEVICE_ERROR;
-                       }
-               }
-
-               /* Check the result itself */
-               result2 = usb_emu_result_buffer[0];
-       } else {
-               /* Save the result, then remove it from return value */
-               result2 = usb_in_buffer[result--];
-       }
-
-       if (result2) {
-               LOG_ERROR("jlink_usb_message failed with result=%d)", result2);
-               return ERROR_JTAG_DEVICE_ERROR;
-       }
-
-       return result;
+       return ERROR_OK;
 }
 
 /* calls the given usb_bulk_* function, allowing for the data to
@@ -1531,17 +1864,46 @@ static int jlink_usb_read(struct jlink *jlink, int expected_size)
        return result;
 }
 
-/* Read the result from the previous EMU cmd into result_buffer. */
-static int jlink_usb_read_emu_result(struct jlink *jlink)
+/*
+ * Send a message and receive the reply - simple messages.
+ *
+ * @param jlink pointer to driver data
+ * @param out_length data length in @c usb_out_buffer
+ * @param in_length data length to be read to @c usb_in_buffer
+ */
+static int jlink_usb_io(struct jlink *jlink, int out_length, int in_length)
 {
-       int result = usb_bulk_read_ex(jlink->usb_handle, jlink_read_ep,
-               (char *)usb_emu_result_buffer, 1 /* JLINK_EMU_RESULT_BUFFER_SIZE */,
-               JLINK_USB_TIMEOUT);
+       int result;
 
-       DEBUG_JTAG_IO("jlink_usb_read_result, result = %d", result);
+       result = jlink_usb_write(jlink, out_length);
+       if (result != out_length) {
+               LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)",
+                               out_length, result);
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
 
-       jlink_debug_buffer(usb_emu_result_buffer, result);
-       return result;
+       result = jlink_usb_read(jlink, in_length);
+       if (result != in_length) {
+               LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
+                               in_length, result);
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
+
+       /*
+        * Section 4.2.4 IN-transaction:
+        * read dummy 0-byte packet if transaction size is
+        * multiple of 64 bytes but not max. size of 0x8000
+        */
+       if ((in_length % 64) == 0 && in_length != 0x8000) {
+               char dummy_buffer;
+               result = usb_bulk_read_ex(jlink->usb_handle, jlink_read_ep,
+                       &dummy_buffer, 1, JLINK_USB_TIMEOUT);
+               if (result != 0) {
+                       LOG_ERROR("dummy byte read failed");
+                       return ERROR_JTAG_DEVICE_ERROR;
+               }
+       }
+       return ERROR_OK;
 }
 
 #ifdef _DEBUG_USB_COMMS_

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)