projects / fw / openocd / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
stlink: remove reset pulse when entering in JTAG
[fw/openocd] / src / jtag / drivers / stlink_usb.c
diff --git a/src/jtag/drivers/stlink_usb.c b/src/jtag/drivers/stlink_usb.c
index 49d7391fc7a9d1e2bc50e5e46c69e5c63a7da21c..f05ffadf9e1896257426df3252ba2c7a318286d5 100644 (file)
--- a/src/jtag/drivers/stlink_usb.c
+++ b/src/jtag/drivers/stlink_usb.c
@@ -87,8 +87,10 @@ struct stlink_usb_version {
        int jtag;
        /** */
        int swim;
-       /** highest supported jtag api version */
-       enum stlink_jtag_api_version jtag_api_max;
+       /** jtag api version supported */
+       enum stlink_jtag_api_version jtag_api;
+       /** one bit for each feature supported. See macros STLINK_F_* */
+       uint32_t flags;
 };
 
 /** */
@@ -121,8 +123,6 @@ struct stlink_usb_handle_s {
        uint16_t vid;
        /** */
        uint16_t pid;
-       /** this is the currently used jtag api */
-       enum stlink_jtag_api_version jtag_api;
        /** */
        struct {
                /** whether SWO tracing is enabled or not */
@@ -205,7 +205,6 @@ struct stlink_usb_handle_s {
 #define STLINK_SWIM_READMEM                0x0b
 #define STLINK_SWIM_READBUF                0x0c
 
-#define STLINK_DEBUG_ENTER_JTAG            0x00
 #define STLINK_DEBUG_GETSTATUS             0x01
 #define STLINK_DEBUG_FORCEDEBUG            0x02
 #define STLINK_DEBUG_APIV1_RESETSYS        0x03
@@ -223,8 +222,9 @@ struct stlink_usb_handle_s {
 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG   0x0f
 #define STLINK_DEBUG_APIV1_SETWATCHPOINT   0x10
 
-#define STLINK_DEBUG_ENTER_JTAG            0x00
-#define STLINK_DEBUG_ENTER_SWD             0xa3
+#define STLINK_DEBUG_ENTER_JTAG_RESET      0x00
+#define STLINK_DEBUG_ENTER_SWD_NO_RESET    0xa3
+#define STLINK_DEBUG_ENTER_JTAG_NO_RESET   0xa4
 
 #define STLINK_DEBUG_APIV1_ENTER           0x20
 #define STLINK_DEBUG_EXIT                  0x21
@@ -257,7 +257,6 @@ struct stlink_usb_handle_s {
 
 #define STLINK_TRACE_SIZE               4096
 #define STLINK_TRACE_MAX_HZ             2000000
-#define STLINK_TRACE_MIN_VERSION        13
 
 /** */
 enum stlink_mode {
@@ -272,6 +271,18 @@ enum stlink_mode {
 #define REQUEST_SENSE        0x03
 #define REQUEST_SENSE_LENGTH 18
 
+/*
+ * Map the relevant features, quirks and workaround for specific firmware
+ * version of stlink
+ */
+#define STLINK_F_HAS_TRACE              (1UL << 0)
+#define STLINK_F_HAS_SWD_SET_FREQ       (1UL << 1)
+#define STLINK_F_HAS_JTAG_SET_FREQ      (1UL << 2)
+#define STLINK_F_HAS_MEM_16BIT          (1UL << 3)
+
+/* aliases */
+#define STLINK_F_HAS_TARGET_VOLT        STLINK_F_HAS_TRACE
+
 struct speed_map {
        int speed;
        int speed_divisor;
@@ -458,7 +469,7 @@ static int stlink_usb_error_check(void *handle)
        }
 
        /* TODO: no error checking yet on api V1 */
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                h->databuf[0] = STLINK_DEBUG_ERR_OK;
 
        switch (h->databuf[0]) {
@@ -560,7 +571,7 @@ static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
 
        assert(handle != NULL);
 
-       assert(h->version.stlink >= 2);
+       assert(h->version.flags & STLINK_F_HAS_TRACE);
 
        if (jtag_libusb_bulk_read(h->fd, h->trace_ep, (char *)buf,
                        size, STLINK_READ_TIMEOUT) != size) {
@@ -622,6 +633,7 @@ static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t siz
 static int stlink_usb_version(void *handle)
 {
        int res;
+       uint32_t flags;
        uint16_t v;
        struct stlink_usb_handle_s *h = handle;
 
@@ -644,18 +656,47 @@ static int stlink_usb_version(void *handle)
        h->vid = buf_get_u32(h->databuf, 16, 16);
        h->pid = buf_get_u32(h->databuf, 32, 16);
 
-       /* set the supported jtag api version
-        * API V2 is supported since JTAG V11
-        */
-       if (h->version.jtag >= 11)
-               h->version.jtag_api_max = STLINK_JTAG_API_V2;
-       else
-               h->version.jtag_api_max = STLINK_JTAG_API_V1;
+       flags = 0;
+       switch (h->version.stlink) {
+       case 1:
+               /* ST-LINK/V1 from J11 switch to api-v2 (and support SWD) */
+               if (h->version.jtag >= 11)
+                       h->version.jtag_api = STLINK_JTAG_API_V2;
+               else
+                       h->version.jtag_api = STLINK_JTAG_API_V1;
+
+               break;
+       case 2:
+               /* all ST-LINK/V2 and ST-Link/V2.1 use api-v2 */
+               h->version.jtag_api = STLINK_JTAG_API_V2;
+
+               /* API for trace from J13 */
+               /* API for target voltage from J13 */
+               if (h->version.jtag >= 13)
+                       flags |= STLINK_F_HAS_TRACE;
+
+               /* API to set SWD frequency from J22 */
+               if (h->version.jtag >= 22)
+                       flags |= STLINK_F_HAS_SWD_SET_FREQ;
+
+               /* API to set JTAG frequency from J24 */
+               if (h->version.jtag >= 24)
+                       flags |= STLINK_F_HAS_JTAG_SET_FREQ;
+
+               /* API to read/write memory at 16 bit from J26 */
+               if (h->version.jtag >= 26)
+                       flags |= STLINK_F_HAS_MEM_16BIT;
+
+               break;
+       default:
+               break;
+       }
+       h->version.flags = flags;
 
        LOG_INFO("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
                h->version.stlink,
                h->version.jtag,
-               (h->version.jtag_api_max == STLINK_JTAG_API_V1) ? 1 : 2,
+               (h->version.jtag_api == STLINK_JTAG_API_V1) ? 1 : 2,
                h->version.swim,
                h->vid,
                h->pid);
@@ -668,8 +709,8 @@ static int stlink_usb_check_voltage(void *handle, float *target_voltage)
        struct stlink_usb_handle_s *h = handle;
        uint32_t adc_results[2];
 
-       /* only supported by stlink/v2 and for firmware >= 13 */
-       if (h->version.stlink == 1 || h->version.jtag < 13)
+       /* no error message, simply quit with error */
+       if (!(h->version.flags & STLINK_F_HAS_TARGET_VOLT))
                return ERROR_COMMAND_NOTFOUND;
 
        stlink_usb_init_buffer(handle, h->rx_ep, 8);
@@ -701,8 +742,7 @@ static int stlink_usb_set_swdclk(void *handle, uint16_t clk_divisor)
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 22 */
-       if (h->version.stlink == 1 || h->version.jtag < 22)
+       if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
                return ERROR_COMMAND_NOTFOUND;
 
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
@@ -726,8 +766,7 @@ static int stlink_usb_set_jtagclk(void *handle, uint16_t clk_divisor)
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 24 */
-       if (h->version.stlink == 1 || h->version.jtag < 24)
+       if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
                return ERROR_COMMAND_NOTFOUND;
 
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
@@ -779,7 +818,7 @@ static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
         * status
         * TODO: we need the test on api V1 too
         */
-       if (h->jtag_api == STLINK_JTAG_API_V2)
+       if (h->version.jtag_api == STLINK_JTAG_API_V2)
                rx_size = 2;
 
        stlink_usb_init_buffer(handle, h->rx_ep, rx_size);
@@ -787,19 +826,19 @@ static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
        switch (type) {
                case STLINK_MODE_DEBUG_JTAG:
                        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-                       if (h->jtag_api == STLINK_JTAG_API_V1)
+                       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
                        else
                                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
-                       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_JTAG;
+                       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_JTAG_NO_RESET;
                        break;
                case STLINK_MODE_DEBUG_SWD:
                        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-                       if (h->jtag_api == STLINK_JTAG_API_V1)
+                       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
                        else
                                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
-                       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_SWD;
+                       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_SWD_NO_RESET;
                        break;
                case STLINK_MODE_DEBUG_SWIM:
                        h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
@@ -1237,7 +1276,7 @@ static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG;
@@ -1256,7 +1295,7 @@ static int stlink_usb_trace_read(void *handle, uint8_t *buf, size_t *size)
 
        assert(handle != NULL);
 
-       if (h->trace.enabled && h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
+       if (h->trace.enabled && (h->version.flags & STLINK_F_HAS_TRACE)) {
                int res;
 
                stlink_usb_init_buffer(handle, h->rx_ep, 10);
@@ -1329,7 +1368,7 @@ static enum target_state stlink_usb_state(void *handle)
                h->reconnect_pending = false;
        }
 
-       if (h->jtag_api == STLINK_JTAG_API_V2) {
+       if (h->version.jtag_api == STLINK_JTAG_API_V2) {
                res = stlink_usb_v2_get_status(handle);
                if (res == TARGET_UNKNOWN)
                        h->reconnect_pending = true;
@@ -1385,7 +1424,7 @@ static void stlink_usb_trace_disable(void *handle)
 
        assert(handle != NULL);
 
-       assert(h->version.jtag >= STLINK_TRACE_MIN_VERSION);
+       assert(h->version.flags & STLINK_F_HAS_TRACE);
 
        LOG_DEBUG("Tracing: disable");
 
@@ -1407,7 +1446,7 @@ static int stlink_usb_trace_enable(void *handle)
 
        assert(handle != NULL);
 
-       if (h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
+       if (h->version.flags & STLINK_F_HAS_TRACE) {
                stlink_usb_init_buffer(handle, h->rx_ep, 10);
 
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
@@ -1446,7 +1485,7 @@ static int stlink_usb_reset(void *handle)
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
 
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_RESETSYS;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_RESETSYS;
@@ -1471,7 +1510,7 @@ static int stlink_usb_run(void *handle)
 
        assert(handle != NULL);
 
-       if (h->jtag_api == STLINK_JTAG_API_V2) {
+       if (h->version.jtag_api == STLINK_JTAG_API_V2) {
                res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
 
                return res;
@@ -1493,7 +1532,7 @@ static int stlink_usb_halt(void *handle)
 
        assert(handle != NULL);
 
-       if (h->jtag_api == STLINK_JTAG_API_V2) {
+       if (h->version.jtag_api == STLINK_JTAG_API_V2) {
                res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
 
                return res;
@@ -1514,7 +1553,7 @@ static int stlink_usb_step(void *handle)
 
        assert(handle != NULL);
 
-       if (h->jtag_api == STLINK_JTAG_API_V2) {
+       if (h->version.jtag_api == STLINK_JTAG_API_V2) {
                /* TODO: this emulates the v1 api, it should really use a similar auto mask isr
                 * that the Cortex-M3 currently does. */
                stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_MASKINTS|C_DEBUGEN);
@@ -1541,7 +1580,7 @@ static int stlink_usb_read_regs(void *handle)
        stlink_usb_init_buffer(handle, h->rx_ep, 84);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READALLREGS;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READALLREGS;
@@ -1562,16 +1601,16 @@ static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, h->rx_ep, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
+       stlink_usb_init_buffer(handle, h->rx_ep, h->version.jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READREG;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
        h->cmdbuf[h->cmdidx++] = num;
 
-       if (h->jtag_api == STLINK_JTAG_API_V1) {
+       if (h->version.jtag_api == STLINK_JTAG_API_V1) {
                res = stlink_usb_xfer(handle, h->databuf, 4);
                if (res != ERROR_OK)
                        return res;
@@ -1596,7 +1635,7 @@ static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEREG;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEREG;
@@ -1614,7 +1653,7 @@ static int stlink_usb_get_rw_status(void *handle)
 
        assert(handle != NULL);
 
-       if (h->jtag_api == STLINK_JTAG_API_V1)
+       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                return ERROR_OK;
 
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
@@ -1710,9 +1749,7 @@ static int stlink_usb_read_mem16(void *handle, uint32_t addr, uint16_t len,
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 26 */
-       if (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26))
+       if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                return ERROR_COMMAND_NOTFOUND;
 
        /* data must be a multiple of 2 and half-word aligned */
@@ -1749,9 +1786,7 @@ static int stlink_usb_write_mem16(void *handle, uint32_t addr, uint16_t len,
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 26 */
-       if (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26))
+       if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                return ERROR_COMMAND_NOTFOUND;
 
        /* data must be a multiple of 2 and half-word aligned */
@@ -1863,8 +1898,7 @@ static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
        count *= size;
 
        /* switch to 8 bit if stlink does not support 16 bit memory read */
-       if (size == 2 && (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26)))
+       if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                size = 1;
 
        while (count) {
@@ -1949,8 +1983,7 @@ static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
        count *= size;
 
        /* switch to 8 bit if stlink does not support 16 bit memory read */
-       if (size == 2 && (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26)))
+       if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                size = 1;
 
        while (count) {
@@ -2087,8 +2120,8 @@ static int stlink_speed_swd(void *handle, int khz, bool query)
        int speed_index;
        struct stlink_usb_handle_s *h = handle;
 
-       /* only supported by stlink/v2 and for firmware >= 22 */
-       if (h->version.stlink == 1 || h->version.jtag < 22)
+       /* old firmware cannot change it */
+       if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
                return khz;
 
        speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_swd,
@@ -2110,8 +2143,8 @@ static int stlink_speed_jtag(void *handle, int khz, bool query)
        int speed_index;
        struct stlink_usb_handle_s *h = handle;
 
-       /* only supported by stlink/v2 and for firmware >= 24 */
-       if (h->version.stlink == 1 || h->version.jtag < 24)
+       /* old firmware cannot change it */
+       if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
                return khz;
 
        speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_jtag,
@@ -2207,7 +2240,6 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
 {
        int err, retry_count = 1;
        struct stlink_usb_handle_s *h;
-       enum stlink_jtag_api_version api;
 
        LOG_DEBUG("stlink_usb_open");
 
@@ -2262,7 +2294,6 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                        case STLINK_V1_PID:
                                h->version.stlink = 1;
                                h->tx_ep = STLINK_TX_EP;
-                               h->trace_ep = STLINK_TRACE_EP;
                                break;
                        case STLINK_V2_1_PID:
                        case STLINK_V2_1_NO_MSD_PID:
@@ -2316,7 +2347,7 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
 
        switch (h->transport) {
                case HL_TRANSPORT_SWD:
-                       if (h->version.jtag_api_max == STLINK_JTAG_API_V1)
+                       if (h->version.jtag_api == STLINK_JTAG_API_V1)
                                err = ERROR_FAIL;
                        /* fall-through */
                case HL_TRANSPORT_JTAG:
@@ -2337,13 +2368,6 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                goto error_open;
        }
 
-       api = h->version.jtag_api_max;
-
-       LOG_INFO("using stlink api v%d", api);
-
-       /* set the used jtag api, this will default to the newest supported version */
-       h->jtag_api = api;
-
        /* initialize the debug hardware */
        err = stlink_usb_init_mode(h, param->connect_under_reset);
 
@@ -2364,14 +2388,12 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
        }
 
        if (h->transport == HL_TRANSPORT_JTAG) {
-               /* jtag clock speed only supported by stlink/v2 and for firmware >= 24 */
-               if (h->version.stlink >= 2 && h->version.jtag >= 24) {
+               if (h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ) {
                        stlink_dump_speed_map(stlink_khz_to_speed_map_jtag, ARRAY_SIZE(stlink_khz_to_speed_map_jtag));
                        stlink_speed(h, param->initial_interface_speed, false);
                }
        } else if (h->transport == HL_TRANSPORT_SWD) {
-               /* clock speed only supported by stlink/v2 and for firmware >= 22 */
-               if (h->version.stlink >= 2 && h->version.jtag >= 22) {
+               if (h->version.flags & STLINK_F_HAS_SWD_SET_FREQ) {
                        stlink_dump_speed_map(stlink_khz_to_speed_map_swd, ARRAY_SIZE(stlink_khz_to_speed_map_swd));
                        stlink_speed(h, param->initial_interface_speed, false);
                }
@@ -2409,7 +2431,7 @@ int stlink_config_trace(void *handle, bool enabled, enum tpiu_pin_protocol pin_p
 {
        struct stlink_usb_handle_s *h = handle;
 
-       if (enabled && (h->jtag_api < 2 ||
+       if (enabled && (!(h->version.flags & STLINK_F_HAS_TRACE) ||
                        pin_protocol != TPIU_PIN_PROTOCOL_ASYNC_UART)) {
                LOG_ERROR("The attached ST-LINK version doesn't support this trace mode");
                return ERROR_FAIL;
openocd with support for Altus Metrum targets