stlink: dump version in the same format of ST firmware upgrade tool
[openocd.git] / src / jtag / drivers / stlink_usb.c
index 01f94713102edc29c68ed13467e00b3bc771c5d8..5837393ca31104d782094ff3be2bf49acbff1a16 100644 (file)
@@ -63,6 +63,7 @@
 #define STLINK_V1_PID         (0x3744)
 #define STLINK_V2_PID         (0x3748)
 #define STLINK_V2_1_PID       (0x374B)
+#define STLINK_V2_1_NO_MSD_PID  (0x3752)
 
 /* the current implementation of the stlink limits
  * 8bit read/writes to max 64 bytes. */
@@ -86,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;
 };
 
 /** */
@@ -120,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 */
@@ -204,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
@@ -222,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
@@ -241,10 +242,16 @@ struct stlink_usb_handle_s {
 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
 #define STLINK_DEBUG_APIV2_DRIVE_NRST      0x3C
 
+#define STLINK_DEBUG_APIV2_GETLASTRWSTATUS2 0x3E
+
 #define STLINK_DEBUG_APIV2_START_TRACE_RX  0x40
 #define STLINK_DEBUG_APIV2_STOP_TRACE_RX   0x41
 #define STLINK_DEBUG_APIV2_GET_TRACE_NB    0x42
 #define STLINK_DEBUG_APIV2_SWD_SET_FREQ    0x43
+#define STLINK_DEBUG_APIV2_JTAG_SET_FREQ   0x44
+
+#define STLINK_DEBUG_APIV2_READMEM_16BIT   0x47
+#define STLINK_DEBUG_APIV2_WRITEMEM_16BIT  0x48
 
 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW   0x00
 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH  0x01
@@ -252,7 +259,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 {
@@ -267,10 +273,26 @@ enum stlink_mode {
 #define REQUEST_SENSE        0x03
 #define REQUEST_SENSE_LENGTH 18
 
-static const struct {
+/*
+ * 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)
+#define STLINK_F_HAS_GETLASTRWSTATUS2   (1UL << 4)
+
+/* aliases */
+#define STLINK_F_HAS_TARGET_VOLT        STLINK_F_HAS_TRACE
+
+struct speed_map {
        int speed;
        int speed_divisor;
-} stlink_khz_to_speed_map[] = {
+};
+
+/* SWD clock speed */
+static const struct speed_map stlink_khz_to_speed_map_swd[] = {
        {4000, 0},
        {1800, 1}, /* default */
        {1200, 2},
@@ -285,6 +307,18 @@ static const struct {
        {5,  798}
 };
 
+/* JTAG clock speed */
+static const struct speed_map stlink_khz_to_speed_map_jtag[] = {
+       {18000, 2},
+       {9000,  4},
+       {4500,  8},
+       {2250, 16},
+       {1125, 32}, /* default */
+       {562,  64},
+       {281, 128},
+       {140, 256}
+};
+
 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
 static int stlink_swim_status(void *handle);
 
@@ -438,7 +472,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]) {
@@ -540,7 +574,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) {
@@ -602,7 +636,11 @@ static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t siz
 static int stlink_usb_version(void *handle)
 {
        int res;
-       uint16_t v;
+       uint32_t flags;
+       uint16_t version;
+       uint8_t v, x, y, jtag, swim, msd;
+       char v_str[4 * (1 + 3) + 1]; /* VvJjMmSs */
+       char *p;
        struct stlink_usb_handle_s *h = handle;
 
        assert(handle != NULL);
@@ -616,27 +654,86 @@ static int stlink_usb_version(void *handle)
        if (res != ERROR_OK)
                return res;
 
-       v = (h->databuf[0] << 8) | h->databuf[1];
+       version = be_to_h_u16(h->databuf);
+       v = (version >> 12) & 0x0f;
+       x = (version >> 6) & 0x3f;
+       y = version & 0x3f;
+
+       h->vid = le_to_h_u16(h->databuf + 2);
+       h->pid = le_to_h_u16(h->databuf + 4);
+
+       switch (h->pid) {
+       case STLINK_V2_1_PID:
+       case STLINK_V2_1_NO_MSD_PID:
+               /* JxMy : STM32 V2.1 - JTAG/SWD only */
+               jtag = x;
+               msd = y;
+               swim = 0;
+               break;
+       default:
+               jtag = x;
+               swim = y;
+               msd = 0;
+               break;
+       }
 
-       h->version.stlink = (v >> 12) & 0x0f;
-       h->version.jtag = (v >> 6) & 0x3f;
-       h->version.swim = v & 0x3f;
-       h->vid = buf_get_u32(h->databuf, 16, 16);
-       h->pid = buf_get_u32(h->databuf, 32, 16);
+       h->version.stlink = v;
+       h->version.jtag = jtag;
+       h->version.swim = swim;
 
-       /* 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;
 
-       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.swim,
+               /* API for trace from J13 */
+               /* API for target voltage from J13 */
+               if (h->version.jtag >= 13)
+                       flags |= STLINK_F_HAS_TRACE;
+
+               /* preferred API to get last R/W status from J15 */
+               if (h->version.jtag >= 15)
+                       flags |= STLINK_F_HAS_GETLASTRWSTATUS2;
+
+               /* 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;
+
+       p = v_str;
+       p += sprintf(p, "V%d", v);
+       if (jtag || !msd)
+               p += sprintf(p, "J%d", jtag);
+       if (msd)
+               p += sprintf(p, "M%d", msd);
+       if (swim || !msd)
+               p += sprintf(p, "S%d", swim);
+
+       LOG_INFO("STLINK %s (API v%d) VID:PID %04X:%04X",
+               v_str,
+               h->version.jtag_api,
                h->vid,
                h->pid);
 
@@ -648,8 +745,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);
@@ -681,8 +778,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);
@@ -700,6 +796,30 @@ static int stlink_usb_set_swdclk(void *handle, uint16_t clk_divisor)
        return ERROR_OK;
 }
 
+static int stlink_usb_set_jtagclk(void *handle, uint16_t clk_divisor)
+{
+       struct stlink_usb_handle_s *h = handle;
+
+       assert(handle != NULL);
+
+       if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
+               return ERROR_COMMAND_NOTFOUND;
+
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
+
+       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
+       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_JTAG_SET_FREQ;
+       h_u16_to_le(h->cmdbuf+h->cmdidx, clk_divisor);
+       h->cmdidx += 2;
+
+       int result = stlink_cmd_allow_retry(handle, h->databuf, 2);
+
+       if (result != ERROR_OK)
+               return result;
+
+       return ERROR_OK;
+}
+
 /** */
 static int stlink_usb_current_mode(void *handle, uint8_t *mode)
 {
@@ -734,7 +854,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);
@@ -742,19 +862,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;
@@ -1192,7 +1312,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;
@@ -1211,7 +1331,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);
@@ -1284,7 +1404,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;
@@ -1340,7 +1460,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");
 
@@ -1362,7 +1482,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;
@@ -1401,7 +1521,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;
@@ -1426,7 +1546,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;
@@ -1448,7 +1568,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;
@@ -1469,7 +1589,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);
@@ -1496,7 +1616,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;
@@ -1517,16 +1637,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;
@@ -1551,7 +1671,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;
@@ -1569,15 +1689,21 @@ 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);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
-       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
+       if (h->version.flags & STLINK_F_HAS_GETLASTRWSTATUS2) {
+               h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS2;
 
-       res = stlink_usb_xfer(handle, h->databuf, 2);
+               res = stlink_usb_xfer(handle, h->databuf, 12);
+       } else {
+               h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
+
+               res = stlink_usb_xfer(handle, h->databuf, 2);
+       }
 
        if (res != ERROR_OK)
                return res;
@@ -1656,6 +1782,78 @@ static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
        return stlink_usb_get_rw_status(handle);
 }
 
+/** */
+static int stlink_usb_read_mem16(void *handle, uint32_t addr, uint16_t len,
+                         uint8_t *buffer)
+{
+       int res;
+       struct stlink_usb_handle_s *h = handle;
+
+       assert(handle != NULL);
+
+       if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
+               return ERROR_COMMAND_NOTFOUND;
+
+       /* data must be a multiple of 2 and half-word aligned */
+       if (len % 2 || addr % 2) {
+               LOG_DEBUG("Invalid data alignment");
+               return ERROR_TARGET_UNALIGNED_ACCESS;
+       }
+
+       stlink_usb_init_buffer(handle, h->rx_ep, len);
+
+       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
+       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READMEM_16BIT;
+       h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
+       h->cmdidx += 4;
+       h_u16_to_le(h->cmdbuf+h->cmdidx, len);
+       h->cmdidx += 2;
+
+       res = stlink_usb_xfer(handle, h->databuf, len);
+
+       if (res != ERROR_OK)
+               return res;
+
+       memcpy(buffer, h->databuf, len);
+
+       return stlink_usb_get_rw_status(handle);
+}
+
+/** */
+static int stlink_usb_write_mem16(void *handle, uint32_t addr, uint16_t len,
+                          const uint8_t *buffer)
+{
+       int res;
+       struct stlink_usb_handle_s *h = handle;
+
+       assert(handle != NULL);
+
+       if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
+               return ERROR_COMMAND_NOTFOUND;
+
+       /* data must be a multiple of 2 and half-word aligned */
+       if (len % 2 || addr % 2) {
+               LOG_DEBUG("Invalid data alignment");
+               return ERROR_TARGET_UNALIGNED_ACCESS;
+       }
+
+       stlink_usb_init_buffer(handle, h->tx_ep, len);
+
+       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
+       h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEMEM_16BIT;
+       h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
+       h->cmdidx += 4;
+       h_u16_to_le(h->cmdbuf+h->cmdidx, len);
+       h->cmdidx += 2;
+
+       res = stlink_usb_xfer(handle, buffer, len);
+
+       if (res != ERROR_OK)
+               return res;
+
+       return stlink_usb_get_rw_status(handle);
+}
+
 /** */
 static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
                          uint8_t *buffer)
@@ -1741,9 +1939,13 @@ static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
        /* calculate byte count */
        count *= size;
 
+       /* switch to 8 bit if stlink does not support 16 bit memory read */
+       if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
+               size = 1;
+
        while (count) {
 
-               bytes_remaining = (size == 4) ? \
+               bytes_remaining = (size != 1) ? \
                                stlink_max_block_size(h->max_mem_packet, addr) : STLINK_MAX_RW8;
 
                if (count < bytes_remaining)
@@ -1754,22 +1956,26 @@ static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
                        if (retval != ERROR_OK)
                                return retval;
                } else
-               /* the stlink only supports 8/32bit memory read/writes
-                * honour 32bit, all others will be handled as 8bit access */
-               if (size == 4) {
+               /*
+                * all stlink support 8/32bit memory read/writes and only from
+                * stlink V2J26 there is support for 16 bit memory read/write.
+                * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
+                * as 8bit access.
+                */
+               if (size != 1) {
 
-                       /* When in jtag mode the stlink uses the auto-increment functinality.
+                       /* When in jtag mode the stlink uses the auto-increment functionality.
                         * However it expects us to pass the data correctly, this includes
                         * alignment and any page boundaries. We already do this as part of the
                         * adi_v5 implementation, but the stlink is a hla adapter and so this
-                        * needs implementiong manually.
+                        * needs implementing manually.
                         * currently this only affects jtag mode, according to ST they do single
                         * access in SWD mode - but this may change and so we do it for both modes */
 
                        /* we first need to check for any unaligned bytes */
-                       if (addr % 4) {
+                       if (addr & (size - 1)) {
 
-                               uint32_t head_bytes = 4 - (addr % 4);
+                               uint32_t head_bytes = size - (addr & (size - 1));
                                retval = stlink_usb_read_mem8(handle, addr, head_bytes, buffer);
                                if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
                                        usleep((1<<retries++) * 1000);
@@ -1783,8 +1989,10 @@ static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
                                bytes_remaining -= head_bytes;
                        }
 
-                       if (bytes_remaining % 4)
+                       if (bytes_remaining & (size - 1))
                                retval = stlink_usb_read_mem(handle, addr, 1, bytes_remaining, buffer);
+                       else if (size == 2)
+                               retval = stlink_usb_read_mem16(handle, addr, bytes_remaining, buffer);
                        else
                                retval = stlink_usb_read_mem32(handle, addr, bytes_remaining, buffer);
                } else
@@ -1816,9 +2024,13 @@ static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
        /* calculate byte count */
        count *= size;
 
+       /* switch to 8 bit if stlink does not support 16 bit memory read */
+       if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
+               size = 1;
+
        while (count) {
 
-               bytes_remaining = (size == 4) ? \
+               bytes_remaining = (size != 1) ? \
                                stlink_max_block_size(h->max_mem_packet, addr) : STLINK_MAX_RW8;
 
                if (count < bytes_remaining)
@@ -1829,22 +2041,26 @@ static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
                        if (retval != ERROR_OK)
                                return retval;
                } else
-               /* the stlink only supports 8/32bit memory read/writes
-                * honour 32bit, all others will be handled as 8bit access */
-               if (size == 4) {
+               /*
+                * all stlink support 8/32bit memory read/writes and only from
+                * stlink V2J26 there is support for 16 bit memory read/write.
+                * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
+                * as 8bit access.
+                */
+               if (size != 1) {
 
-                       /* When in jtag mode the stlink uses the auto-increment functinality.
+                       /* When in jtag mode the stlink uses the auto-increment functionality.
                         * However it expects us to pass the data correctly, this includes
                         * alignment and any page boundaries. We already do this as part of the
                         * adi_v5 implementation, but the stlink is a hla adapter and so this
-                        * needs implementiong manually.
+                        * needs implementing manually.
                         * currently this only affects jtag mode, according to ST they do single
                         * access in SWD mode - but this may change and so we do it for both modes */
 
                        /* we first need to check for any unaligned bytes */
-                       if (addr % 4) {
+                       if (addr & (size - 1)) {
 
-                               uint32_t head_bytes = 4 - (addr % 4);
+                               uint32_t head_bytes = size - (addr & (size - 1));
                                retval = stlink_usb_write_mem8(handle, addr, head_bytes, buffer);
                                if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
                                        usleep((1<<retries++) * 1000);
@@ -1858,8 +2074,10 @@ static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
                                bytes_remaining -= head_bytes;
                        }
 
-                       if (bytes_remaining % 4)
+                       if (bytes_remaining & (size - 1))
                                retval = stlink_usb_write_mem(handle, addr, 1, bytes_remaining, buffer);
+                       else if (size == 2)
+                               retval = stlink_usb_write_mem16(handle, addr, bytes_remaining, buffer);
                        else
                                retval = stlink_usb_write_mem32(handle, addr, bytes_remaining, buffer);
 
@@ -1886,70 +2104,129 @@ static int stlink_usb_override_target(const char *targetname)
        return !strcmp(targetname, "cortex_m");
 }
 
-static int stlink_speed(void *handle, int khz, bool query)
+static int stlink_speed_swim(void *handle, int khz, bool query)
 {
-       unsigned i;
-       int speed_index = -1;
-       int speed_diff = INT_MAX;
-       struct stlink_usb_handle_s *h = handle;
-
-       if (h && (h->transport == HL_TRANSPORT_SWIM)) {
-               /*
+       /*
                        we dont care what the khz rate is
                        we only have low and high speed...
                        before changing speed the SWIM_CSR HS bit
                        must be updated
-                */
-               if (khz == 0)
-                       stlink_swim_speed(handle, 0);
-               else
-                       stlink_swim_speed(handle, 1);
-               return khz;
-       }
+        */
+       if (khz == 0)
+               stlink_swim_speed(handle, 0);
+       else
+               stlink_swim_speed(handle, 1);
+       return khz;
+}
 
-       /* only supported by stlink/v2 and for firmware >= 22 */
-       if (h && (h->version.stlink == 1 || h->version.jtag < 22))
-               return khz;
+static int stlink_match_speed_map(const struct speed_map *map, unsigned int map_size, int khz, bool query)
+{
+       unsigned int i;
+       int speed_index = -1;
+       int speed_diff = INT_MAX;
+       bool match = true;
 
-       for (i = 0; i < ARRAY_SIZE(stlink_khz_to_speed_map); i++) {
-               if (khz == stlink_khz_to_speed_map[i].speed) {
+       for (i = 0; i < map_size; i++) {
+               if (khz == map[i].speed) {
                        speed_index = i;
                        break;
                } else {
-                       int current_diff = khz - stlink_khz_to_speed_map[i].speed;
+                       int current_diff = khz - map[i].speed;
                        /* get abs value for comparison */
                        current_diff = (current_diff > 0) ? current_diff : -current_diff;
-                       if ((current_diff < speed_diff) && khz >= stlink_khz_to_speed_map[i].speed) {
+                       if ((current_diff < speed_diff) && khz >= map[i].speed) {
                                speed_diff = current_diff;
                                speed_index = i;
                        }
                }
        }
 
-       bool match = true;
-
        if (speed_index == -1) {
                /* this will only be here if we cannot match the slow speed.
                 * use the slowest speed we support.*/
-               speed_index = ARRAY_SIZE(stlink_khz_to_speed_map) - 1;
+               speed_index = map_size - 1;
                match = false;
-       } else if (i == ARRAY_SIZE(stlink_khz_to_speed_map))
+       } else if (i == map_size)
                match = false;
 
        if (!match && query) {
                LOG_INFO("Unable to match requested speed %d kHz, using %d kHz", \
-                               khz, stlink_khz_to_speed_map[speed_index].speed);
+                               khz, map[speed_index].speed);
        }
 
-       if (h && !query) {
-               int result = stlink_usb_set_swdclk(h, stlink_khz_to_speed_map[speed_index].speed_divisor);
+       return speed_index;
+}
+
+static int stlink_speed_swd(void *handle, int khz, bool query)
+{
+       int speed_index;
+       struct stlink_usb_handle_s *h = handle;
+
+       /* 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,
+               ARRAY_SIZE(stlink_khz_to_speed_map_swd), khz, query);
+
+       if (!query) {
+               int result = stlink_usb_set_swdclk(h, stlink_khz_to_speed_map_swd[speed_index].speed_divisor);
                if (result != ERROR_OK) {
                        LOG_ERROR("Unable to set adapter speed");
                        return khz;
                }
        }
 
-       return stlink_khz_to_speed_map[speed_index].speed;
+       return stlink_khz_to_speed_map_swd[speed_index].speed;
+}
+
+static int stlink_speed_jtag(void *handle, int khz, bool query)
+{
+       int speed_index;
+       struct stlink_usb_handle_s *h = handle;
+
+       /* 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,
+               ARRAY_SIZE(stlink_khz_to_speed_map_jtag), khz, query);
+
+       if (!query) {
+               int result = stlink_usb_set_jtagclk(h, stlink_khz_to_speed_map_jtag[speed_index].speed_divisor);
+               if (result != ERROR_OK) {
+                       LOG_ERROR("Unable to set adapter speed");
+                       return khz;
+               }
+       }
+
+       return stlink_khz_to_speed_map_jtag[speed_index].speed;
+}
+
+void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size)
+{
+       unsigned int i;
+
+       LOG_DEBUG("Supported clock speeds are:");
+       for (i = 0; i < map_size; i++)
+               LOG_DEBUG("%d kHz", map[i].speed);
+}
+
+static int stlink_speed(void *handle, int khz, bool query)
+{
+       struct stlink_usb_handle_s *h = handle;
+
+       if (!handle)
+               return khz;
+
+       if (h->transport == HL_TRANSPORT_SWIM)
+               return stlink_speed_swim(handle, khz, query);
+       else if (h->transport == HL_TRANSPORT_SWD)
+               return stlink_speed_swd(handle, khz, query);
+       else if (h->transport == HL_TRANSPORT_JTAG)
+               return stlink_speed_jtag(handle, khz, query);
+
+       return khz;
 }
 
 /** */
@@ -2005,7 +2282,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");
 
@@ -2060,9 +2336,9 @@ 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:
                                h->version.stlink = 2;
                                h->tx_ep = STLINK_V2_1_TX_EP;
                                h->trace_ep = STLINK_V2_1_TRACE_EP;
@@ -2113,6 +2389,9 @@ 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 == STLINK_JTAG_API_V1)
+                               err = ERROR_FAIL;
+                       /* fall-through */
                case HL_TRANSPORT_JTAG:
                        if (h->version.jtag == 0)
                                err = ERROR_FAIL;
@@ -2131,13 +2410,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);
 
@@ -2157,14 +2429,16 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                return ERROR_OK;
        }
 
-       /* clock speed only supported by stlink/v2 and for firmware >= 22 */
-       if (h->version.stlink >= 2 && h->version.jtag >= 22) {
-               LOG_DEBUG("Supported clock speeds are:");
-
-               for (unsigned i = 0; i < ARRAY_SIZE(stlink_khz_to_speed_map); i++)
-                       LOG_DEBUG("%d kHz", stlink_khz_to_speed_map[i].speed);
-
-               stlink_speed(h, param->initial_interface_speed, false);
+       if (h->transport == HL_TRANSPORT_JTAG) {
+               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) {
+               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);
+               }
        }
 
        /* get cpuid, so we can determine the max page size
@@ -2199,7 +2473,8 @@ 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 || pin_protocol != ASYNC_UART)) {
+       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;
        }

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)