stlink: handle read/write FPU registers in HLA API
[openocd.git] / src / jtag / drivers / stlink_usb.c
index 14bac2a2f4304924399170a113e0c2672a8e8143..4545bcba02089ca65be3d71a0dc39df1f6188084 100644 (file)
@@ -36,6 +36,7 @@
 #include <jtag/hla/hla_layout.h>
 #include <jtag/hla/hla_transport.h>
 #include <jtag/hla/hla_interface.h>
+#include <jtag/swim.h>
 #include <target/target.h>
 #include <transport/transport.h>
 
@@ -95,6 +96,15 @@ enum stlink_jtag_api_version {
        STLINK_JTAG_API_V3,
 };
 
+enum stlink_mode {
+       STLINK_MODE_UNKNOWN = 0,
+       STLINK_MODE_DFU,
+       STLINK_MODE_MASS,
+       STLINK_MODE_DEBUG_JTAG,
+       STLINK_MODE_DEBUG_SWD,
+       STLINK_MODE_DEBUG_SWIM
+};
+
 /** */
 struct stlink_usb_version {
        /** */
@@ -132,7 +142,7 @@ struct stlink_usb_handle_s {
        /** */
        uint32_t max_mem_packet;
        /** */
-       enum hl_transports transport;
+       enum stlink_mode st_mode;
        /** */
        struct stlink_usb_version version;
        /** */
@@ -208,7 +218,7 @@ struct stlink_usb_handle_s {
        uint32_t address
 
        STLINK_SWIM_RESET
-       send syncronization seq (16us low, response 64 clocks low)
+       send synchronization seq (16us low, response 64 clocks low)
 */
 #define STLINK_SWIM_ENTER                  0x00
 #define STLINK_SWIM_EXIT                   0x01
@@ -289,19 +299,10 @@ struct stlink_usb_handle_s {
 
 #define STLINK_TRACE_SIZE               4096
 #define STLINK_TRACE_MAX_HZ             2000000
+#define STLINK_V3_TRACE_MAX_HZ          24000000
 
 #define STLINK_V3_MAX_FREQ_NB               10
 
-/** */
-enum stlink_mode {
-       STLINK_MODE_UNKNOWN = 0,
-       STLINK_MODE_DFU,
-       STLINK_MODE_MASS,
-       STLINK_MODE_DEBUG_JTAG,
-       STLINK_MODE_DEBUG_SWD,
-       STLINK_MODE_DEBUG_SWIM
-};
-
 #define REQUEST_SENSE        0x03
 #define REQUEST_SENSE_LENGTH 18
 
@@ -319,9 +320,13 @@ enum stlink_mode {
 #define STLINK_F_HAS_AP_INIT            BIT(7)
 #define STLINK_F_HAS_DPBANKSEL          BIT(8)
 #define STLINK_F_HAS_RW8_512BYTES       BIT(9)
+#define STLINK_F_FIX_CLOSE_AP           BIT(10)
 
 /* aliases */
 #define STLINK_F_HAS_TARGET_VOLT        STLINK_F_HAS_TRACE
+#define STLINK_F_HAS_FPU_REG            STLINK_F_HAS_GETLASTRWSTATUS2
+
+#define STLINK_REGSEL_IS_FPU(x)         ((x) > 0x1F)
 
 struct speed_map {
        int speed;
@@ -357,9 +362,10 @@ static const struct speed_map stlink_khz_to_speed_map_jtag[] = {
 
 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
 static int stlink_swim_status(void *handle);
-void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size);
+static void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size);
 static int stlink_get_com_freq(void *handle, bool is_jtag, struct speed_map *map);
 static int stlink_speed(void *handle, int khz, bool query);
+static int stlink_usb_open_ap(void *handle, unsigned short apsel);
 
 /** */
 static unsigned int stlink_usb_block(void *handle)
@@ -710,7 +716,7 @@ static int stlink_usb_error_check(void *handle)
 
        assert(handle != NULL);
 
-       if (h->transport == HL_TRANSPORT_SWIM) {
+       if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
                switch (h->databuf[0]) {
                        case STLINK_SWIM_ERR_OK:
                                return ERROR_OK;
@@ -819,13 +825,13 @@ static int stlink_cmd_allow_retry(void *handle, const uint8_t *buf, int size)
        struct stlink_usb_handle_s *h = handle;
 
        while (1) {
-               if ((h->transport != HL_TRANSPORT_SWIM) || !retries) {
+               if ((h->st_mode != STLINK_MODE_DEBUG_SWIM) || !retries) {
                        res = stlink_usb_xfer_noerrcheck(handle, buf, size);
                        if (res != ERROR_OK)
                                return res;
                }
 
-               if (h->transport == HL_TRANSPORT_SWIM) {
+               if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
                        res = stlink_swim_status(handle);
                        if (res != ERROR_OK)
                                return res;
@@ -1030,6 +1036,10 @@ static int stlink_usb_version(void *handle)
                if (h->version.jtag >= 28)
                        flags |= STLINK_F_HAS_AP_INIT;
 
+               /* API required to return proper error code on close AP from J29 */
+               if (h->version.jtag >= 29)
+                       flags |= STLINK_F_FIX_CLOSE_AP;
+
                /* Banked regs (DPv1 & DPv2) support from V2J32 */
                if (h->version.jtag >= 32)
                        flags |= STLINK_F_HAS_DPBANKSEL;
@@ -1057,6 +1067,9 @@ static int stlink_usb_version(void *handle)
                /* API required to init AP before any AP access */
                flags |= STLINK_F_HAS_AP_INIT;
 
+               /* API required to return proper error code on close AP */
+               flags |= STLINK_F_FIX_CLOSE_AP;
+
                /* Banked regs (DPv1 & DPv2) support from V3J2 */
                if (h->version.jtag >= 2)
                        flags |= STLINK_F_HAS_DPBANKSEL;
@@ -1288,20 +1301,17 @@ static enum stlink_mode stlink_get_mode(enum hl_transports t)
                return STLINK_MODE_DEBUG_SWD;
        case HL_TRANSPORT_JTAG:
                return STLINK_MODE_DEBUG_JTAG;
-       case HL_TRANSPORT_SWIM:
-               return STLINK_MODE_DEBUG_SWIM;
        default:
                return STLINK_MODE_UNKNOWN;
        }
 }
 
 /** */
-static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int initial_interface_speed)
+static int stlink_usb_exit_mode(void *handle)
 {
        int res;
        uint8_t mode;
        enum stlink_mode emode;
-       struct stlink_usb_handle_s *h = handle;
 
        assert(handle != NULL);
 
@@ -1330,12 +1340,25 @@ static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int init
                        break;
        }
 
-       if (emode != STLINK_MODE_UNKNOWN) {
-               res = stlink_usb_mode_leave(handle, emode);
+       if (emode != STLINK_MODE_UNKNOWN)
+               return stlink_usb_mode_leave(handle, emode);
 
-               if (res != ERROR_OK)
-                       return res;
-       }
+       return ERROR_OK;
+}
+
+/** */
+static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int initial_interface_speed)
+{
+       int res;
+       uint8_t mode;
+       enum stlink_mode emode;
+       struct stlink_usb_handle_s *h = handle;
+
+       assert(handle != NULL);
+
+       res = stlink_usb_exit_mode(handle);
+       if (res != ERROR_OK)
+               return res;
 
        res = stlink_usb_current_mode(handle, &mode);
 
@@ -1368,7 +1391,7 @@ static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int init
        LOG_DEBUG("MODE: 0x%02X", mode);
 
        /* set selected mode */
-       emode = stlink_get_mode(h->transport);
+       emode = h->st_mode;
 
        if (emode == STLINK_MODE_UNKNOWN) {
                LOG_ERROR("selected mode (transport) not supported");
@@ -1376,12 +1399,12 @@ static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int init
        }
 
        /* set the speed before entering the mode, as the chip discovery phase should be done at this speed too */
-       if (h->transport == HL_TRANSPORT_JTAG) {
+       if (emode == STLINK_MODE_DEBUG_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, initial_interface_speed, false);
                }
-       } else if (h->transport == HL_TRANSPORT_SWD) {
+       } else if (emode == STLINK_MODE_DEBUG_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, initial_interface_speed, false);
@@ -1391,7 +1414,7 @@ static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int init
        if (h->version.jtag_api == STLINK_JTAG_API_V3) {
                struct speed_map map[STLINK_V3_MAX_FREQ_NB];
 
-               stlink_get_com_freq(h, (h->transport == HL_TRANSPORT_JTAG), map);
+               stlink_get_com_freq(h, (emode == STLINK_MODE_DEBUG_JTAG), map);
                stlink_dump_speed_map(map, ARRAY_SIZE(map));
                stlink_speed(h, initial_interface_speed, false);
        }
@@ -1446,7 +1469,7 @@ static int stlink_swim_status(void *handle)
 }
 /*
        the purpose of this function is unknown...
-       capabilites? anyway for swim v6 it returns
+       capabilities? anyway for swim v6 it returns
        0001020600000000
 */
 __attribute__((unused))
@@ -1540,7 +1563,7 @@ static int stlink_swim_generate_rst(void *handle)
 }
 
 /*
-       send resyncronize sequence
+       send resynchronize sequence
        swim is pulled low for 16us
        reply is 64 clks low
 */
@@ -1632,7 +1655,7 @@ static int stlink_usb_idcode(void *handle, uint32_t *idcode)
        assert(handle != NULL);
 
        /* there is no swim read core id cmd */
-       if (h->transport == HL_TRANSPORT_SWIM) {
+       if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
                *idcode = 0;
                return ERROR_OK;
        }
@@ -1763,22 +1786,9 @@ static enum target_state stlink_usb_state(void *handle)
 
        assert(handle != NULL);
 
-       if (h->transport == HL_TRANSPORT_SWIM) {
-               res = stlink_usb_mode_enter(handle, stlink_get_mode(h->transport));
-               if (res != ERROR_OK)
-                       return TARGET_UNKNOWN;
-
-               res = stlink_swim_resync(handle);
-               if (res != ERROR_OK)
-                       return TARGET_UNKNOWN;
-
-               return ERROR_OK;
-       }
-
        if (h->reconnect_pending) {
                LOG_INFO("Previous state query failed, trying to reconnect");
-               res = stlink_usb_mode_enter(handle, stlink_get_mode(h->transport));
-
+               res = stlink_usb_mode_enter(handle, h->st_mode);
                if (res != ERROR_OK)
                        return TARGET_UNKNOWN;
 
@@ -1818,7 +1828,7 @@ static int stlink_usb_assert_srst(void *handle, int srst)
 
        assert(handle != NULL);
 
-       if (h->transport == HL_TRANSPORT_SWIM)
+       if (h->st_mode == STLINK_MODE_DEBUG_SWIM)
                return stlink_swim_assert_reset(handle, srst);
 
        if (h->version.stlink == 1)
@@ -1895,9 +1905,6 @@ static int stlink_usb_reset(void *handle)
 
        assert(handle != NULL);
 
-       if (h->transport == HL_TRANSPORT_SWIM)
-               return stlink_swim_generate_rst(handle);
-
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
@@ -2012,13 +2019,22 @@ static int stlink_usb_read_regs(void *handle)
 }
 
 /** */
-static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
+static int stlink_usb_read_reg(void *handle, unsigned int regsel, uint32_t *val)
 {
        int res;
        struct stlink_usb_handle_s *h = handle;
 
        assert(handle != NULL);
 
+       if (STLINK_REGSEL_IS_FPU(regsel) && !(h->version.flags & STLINK_F_HAS_FPU_REG)) {
+               res = stlink_usb_write_debug_reg(h, DCB_DCRSR, regsel & 0x7f);
+               if (res != ERROR_OK)
+                       return res;
+
+               /* FIXME: poll DHCSR.S_REGRDY before read DCRDR */
+               return stlink_usb_v2_read_debug_reg(h, DCB_DCRDR, val);
+       }
+
        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;
@@ -2026,7 +2042,7 @@ static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READREG;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
-       h->cmdbuf[h->cmdidx++] = num;
+       h->cmdbuf[h->cmdidx++] = regsel;
 
        if (h->version.jtag_api == STLINK_JTAG_API_V1) {
                res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
@@ -2044,12 +2060,21 @@ static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
 }
 
 /** */
-static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
+static int stlink_usb_write_reg(void *handle, unsigned int regsel, uint32_t val)
 {
        struct stlink_usb_handle_s *h = handle;
 
        assert(handle != NULL);
 
+       if (STLINK_REGSEL_IS_FPU(regsel) && !(h->version.flags & STLINK_F_HAS_FPU_REG)) {
+               int res = stlink_usb_write_debug_reg(h, DCB_DCRDR, val);
+               if (res != ERROR_OK)
+                       return res;
+
+               return stlink_usb_write_debug_reg(h, DCB_DCRSR, DCRSR_WnR | (regsel & 0x7f));
+               /* FIXME: poll DHCSR.S_REGRDY after write DCRSR */
+       }
+
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
@@ -2057,7 +2082,7 @@ static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEREG;
        else
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEREG;
-       h->cmdbuf[h->cmdidx++] = num;
+       h->cmdbuf[h->cmdidx++] = regsel;
        h_u32_to_le(h->cmdbuf+h->cmdidx, val);
        h->cmdidx += 4;
 
@@ -2319,17 +2344,12 @@ static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
 
        while (count) {
 
-               bytes_remaining = (size != 1) ? \
+               bytes_remaining = (size != 1) ?
                                stlink_max_block_size(h->max_mem_packet, addr) : stlink_usb_block(h);
 
                if (count < bytes_remaining)
                        bytes_remaining = count;
 
-               if (h->transport == HL_TRANSPORT_SWIM) {
-                       retval = stlink_swim_readbytes(handle, addr, bytes_remaining, buffer);
-                       if (retval != ERROR_OK)
-                               return retval;
-               } else
                /*
                 * all stlink support 8/32bit memory read/writes and only from
                 * stlink V2J26 there is support for 16 bit memory read/write.
@@ -2404,17 +2424,12 @@ static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
 
        while (count) {
 
-               bytes_remaining = (size != 1) ? \
+               bytes_remaining = (size != 1) ?
                                stlink_max_block_size(h->max_mem_packet, addr) : stlink_usb_block(h);
 
                if (count < bytes_remaining)
                        bytes_remaining = count;
 
-               if (h->transport == HL_TRANSPORT_SWIM) {
-                       retval = stlink_swim_writebytes(handle, addr, bytes_remaining, buffer);
-                       if (retval != ERROR_OK)
-                               return retval;
-               } else
                /*
                 * all stlink support 8/32bit memory read/writes and only from
                 * stlink V2J26 there is support for 16 bit memory read/write.
@@ -2480,17 +2495,20 @@ static int stlink_usb_override_target(const char *targetname)
 
 static int stlink_speed_swim(void *handle, int khz, bool query)
 {
+       int retval;
+
        /*
-                       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 (!query) {
+               retval = stlink_swim_speed(handle, (khz < SWIM_FREQ_HIGH) ? 0 : 1);
+               if (retval != ERROR_OK)
+                       LOG_ERROR("Unable to set adapter speed");
+       }
+
+       return (khz < SWIM_FREQ_HIGH) ? SWIM_FREQ_LOW : SWIM_FREQ_HIGH;
 }
 
 static int stlink_match_speed_map(const struct speed_map *map, unsigned int map_size, int khz, bool query)
@@ -2528,7 +2546,7 @@ static int stlink_match_speed_map(const struct speed_map *map, unsigned int map_
                match = false;
 
        if (!match && query) {
-               LOG_INFO("Unable to match requested speed %d kHz, using %d kHz", \
+               LOG_INFO("Unable to match requested speed %d kHz, using %d kHz",
                                khz, map[speed_index].speed);
        }
 
@@ -2581,7 +2599,7 @@ static int stlink_speed_jtag(void *handle, int khz, bool query)
        return stlink_khz_to_speed_map_jtag[speed_index].speed;
 }
 
-void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size)
+static void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size)
 {
        unsigned int i;
 
@@ -2674,16 +2692,16 @@ static int stlink_speed(void *handle, int khz, bool query)
        if (!handle)
                return khz;
 
-       switch (h->transport) {
-       case HL_TRANSPORT_SWIM:
+       switch (h->st_mode) {
+       case STLINK_MODE_DEBUG_SWIM:
                return stlink_speed_swim(handle, khz, query);
-       case HL_TRANSPORT_SWD:
+       case STLINK_MODE_DEBUG_SWD:
                if (h->version.jtag_api == STLINK_JTAG_API_V3)
                        return stlink_speed_v3(handle, false, khz, query);
                else
                        return stlink_speed_swd(handle, khz, query);
                break;
-       case HL_TRANSPORT_JTAG:
+       case STLINK_MODE_DEBUG_JTAG:
                if (h->version.jtag_api == STLINK_JTAG_API_V3)
                        return stlink_speed_v3(handle, true, khz, query);
                else
@@ -2699,45 +2717,14 @@ static int stlink_speed(void *handle, int khz, bool query)
 /** */
 static int stlink_usb_close(void *handle)
 {
-       int res;
-       uint8_t mode;
-       enum stlink_mode emode;
        struct stlink_usb_handle_s *h = handle;
 
-       if (h && h->fd)
-               res = stlink_usb_current_mode(handle, &mode);
-       else
-               res = ERROR_FAIL;
-       /* do not exit if return code != ERROR_OK,
-          it prevents us from closing jtag_libusb */
-
-       if (res == ERROR_OK) {
-               /* try to exit current mode */
-               switch (mode) {
-                       case STLINK_DEV_DFU_MODE:
-                               emode = STLINK_MODE_DFU;
-                               break;
-                       case STLINK_DEV_DEBUG_MODE:
-                               emode = STLINK_MODE_DEBUG_SWD;
-                               break;
-                       case STLINK_DEV_SWIM_MODE:
-                               emode = STLINK_MODE_DEBUG_SWIM;
-                               break;
-                       case STLINK_DEV_BOOTLOADER_MODE:
-                       case STLINK_DEV_MASS_MODE:
-                       default:
-                               emode = STLINK_MODE_UNKNOWN;
-                               break;
-               }
-
-               if (emode != STLINK_MODE_UNKNOWN)
-                       stlink_usb_mode_leave(handle, emode);
-                       /* do not check return code, it prevent
-                       us from closing jtag_libusb */
-       }
-
-       if (h && h->fd)
+       if (h && h->fd) {
+               stlink_usb_exit_mode(h);
+               /* do not check return code, it prevent
+               us from closing jtag_libusb */
                jtag_libusb_close(h->fd);
+       }
 
        free(h);
 
@@ -2760,7 +2747,7 @@ static int stlink_usb_close(void *handle)
  *    based on the length (0x1a = 26) we could easily decide if we have to fixup the serial
  *    and then we have just to convert the raw data into printable characters using sprintf
  */
-char *stlink_usb_get_alternate_serial(libusb_device_handle *device,
+static char *stlink_usb_get_alternate_serial(libusb_device_handle *device,
                struct libusb_device_descriptor *dev_desc)
 {
        int usb_retval;
@@ -2824,7 +2811,7 @@ char *stlink_usb_get_alternate_serial(libusb_device_handle *device,
 }
 
 /** */
-static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
+static int stlink_usb_open(struct hl_interface_param_s *param, enum stlink_mode mode, void **fd)
 {
        int err, retry_count = 1;
        struct stlink_usb_handle_s *h;
@@ -2838,11 +2825,11 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                return ERROR_FAIL;
        }
 
-       h->transport = param->transport;
+       h->st_mode = mode;
 
        for (unsigned i = 0; param->vid[i]; i++) {
                LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x serial: %s",
-                         param->transport, param->vid[i], param->pid[i],
+                         h->st_mode, param->vid[i], param->pid[i],
                          param->serial ? param->serial : "");
        }
 
@@ -2942,16 +2929,16 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
        /* check if mode is supported */
        err = ERROR_OK;
 
-       switch (h->transport) {
-               case HL_TRANSPORT_SWD:
+       switch (h->st_mode) {
+               case STLINK_MODE_DEBUG_SWD:
                        if (h->version.jtag_api == STLINK_JTAG_API_V1)
                                err = ERROR_FAIL;
                        /* fall-through */
-               case HL_TRANSPORT_JTAG:
+               case STLINK_MODE_DEBUG_JTAG:
                        if (h->version.jtag == 0)
                                err = ERROR_FAIL;
                        break;
-               case HL_TRANSPORT_SWIM:
+               case STLINK_MODE_DEBUG_SWIM:
                        if (h->version.swim == 0)
                                err = ERROR_FAIL;
                        break;
@@ -2973,7 +2960,7 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                goto error_open;
        }
 
-       if (h->transport == HL_TRANSPORT_SWIM) {
+       if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
                err = stlink_swim_enter(h);
                if (err != ERROR_OK) {
                        LOG_ERROR("stlink_swim_enter_failed (unable to connect to the target)");
@@ -2989,6 +2976,7 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
        h->max_mem_packet = (1 << 10);
 
        uint8_t buffer[4];
+       stlink_usb_open_ap(h, 0);
        err = stlink_usb_read_mem32(h, CPUID, 4, buffer);
        if (err == ERROR_OK) {
                uint32_t cpuid = le_to_h_u32(buffer);
@@ -3011,13 +2999,17 @@ error_open:
        return ERROR_FAIL;
 }
 
-int stlink_config_trace(void *handle, bool enabled,
+static int stlink_usb_hl_open(struct hl_interface_param_s *param, void **fd)
+{
+       return stlink_usb_open(param, stlink_get_mode(param->transport), fd);
+}
+
+static int stlink_config_trace(void *handle, bool enabled,
                enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
                unsigned int *trace_freq, unsigned int traceclkin_freq,
                uint16_t *prescaler)
 {
        struct stlink_usb_handle_s *h = handle;
-       uint16_t presc;
 
        if (enabled && (!(h->version.flags & STLINK_F_HAS_TRACE) ||
                        pin_protocol != TPIU_PIN_PROTOCOL_ASYNC_UART)) {
@@ -3025,34 +3017,42 @@ int stlink_config_trace(void *handle, bool enabled,
                return ERROR_FAIL;
        }
 
-       if (!enabled) {
-               stlink_usb_trace_disable(h);
-               return ERROR_OK;
-       }
+       unsigned int max_trace_freq = (h->version.stlink == 3) ?
+                       STLINK_V3_TRACE_MAX_HZ : STLINK_TRACE_MAX_HZ;
 
-       if (*trace_freq > STLINK_TRACE_MAX_HZ) {
+       /* Only concern ourselves with the frequency if the STlink is processing it. */
+       if (enabled && *trace_freq > max_trace_freq) {
                LOG_ERROR("ST-LINK doesn't support SWO frequency higher than %u",
-                         STLINK_TRACE_MAX_HZ);
+                         max_trace_freq);
                return ERROR_FAIL;
        }
 
        stlink_usb_trace_disable(h);
 
        if (!*trace_freq)
-               *trace_freq = STLINK_TRACE_MAX_HZ;
+               *trace_freq = max_trace_freq;
 
-       presc = traceclkin_freq / *trace_freq;
-
-       if (traceclkin_freq % *trace_freq > 0)
-               presc++;
+       unsigned int presc = (traceclkin_freq + *trace_freq / 2) / *trace_freq;
+       if (presc == 0 || presc > TPIU_ACPR_MAX_SWOSCALER + 1) {
+               LOG_ERROR("SWO frequency is not suitable. Please choose a different "
+                       "frequency.");
+               return ERROR_FAIL;
+       }
 
-       if (presc > TPIU_ACPR_MAX_SWOSCALER) {
+       /* Probe's UART speed must be within 3% of the TPIU's SWO baud rate. */
+       unsigned int max_deviation = (traceclkin_freq * 3) / 100;
+       if (presc * *trace_freq < traceclkin_freq - max_deviation ||
+                       presc * *trace_freq > traceclkin_freq + max_deviation) {
                LOG_ERROR("SWO frequency is not suitable. Please choose a different "
                        "frequency.");
                return ERROR_FAIL;
        }
 
        *prescaler = presc;
+
+       if (!enabled)
+               return ERROR_OK;
+
        h->trace.source_hz = *trace_freq;
 
        return stlink_usb_trace_enable(h);
@@ -3093,7 +3093,12 @@ static int stlink_usb_close_access_port(void *handle, unsigned char ap_num)
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_CLOSE_AP_DBG;
        h->cmdbuf[h->cmdidx++] = ap_num;
 
-       return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
+       /* ignore incorrectly returned error on bogus FW */
+       if (h->version.flags & STLINK_F_FIX_CLOSE_AP)
+               return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
+       else
+               return stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
+
 }
 
 /** */
@@ -3116,7 +3121,7 @@ static int stlink_read_dap_register(void *handle, unsigned short dap_port,
 
        retval = stlink_usb_xfer_errcheck(handle, h->databuf, 8);
        *val = le_to_h_u32(h->databuf + 4);
-       LOG_DEBUG_IO("dap_port_read = %d, addr =  0x%x, value = 0x%x", dap_port, addr, *val);
+       LOG_DEBUG_IO("dap_port_read = %d, addr =  0x%x, value = 0x%" PRIx32, dap_port, addr, *val);
        return retval;
 }
 
@@ -3131,7 +3136,7 @@ static int stlink_write_dap_register(void *handle, unsigned short dap_port,
        if (!(h->version.flags & STLINK_F_HAS_DAP_REG))
                return ERROR_COMMAND_NOTFOUND;
 
-       LOG_DEBUG_IO("dap_write port = %d, addr = 0x%x, value = 0x%x", dap_port, addr, val);
+       LOG_DEBUG_IO("dap_write port = %d, addr = 0x%x, value = 0x%" PRIx32, dap_port, addr, val);
        stlink_usb_init_buffer(handle, h->rx_ep, 16);
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITE_DAP_REG;
@@ -3144,7 +3149,7 @@ static int stlink_write_dap_register(void *handle, unsigned short dap_port,
 /** */
 struct hl_layout_api_s stlink_usb_layout_api = {
        /** */
-       .open = stlink_usb_open,
+       .open = stlink_usb_hl_open,
        /** */
        .close = stlink_usb_close,
        /** */
@@ -3211,13 +3216,13 @@ static int stlink_dap_get_and_clear_error(void)
        return retval;
 }
 
-/** */
-static int stlink_dap_open_ap(unsigned short apsel)
+static int stlink_usb_open_ap(void *handle, unsigned short apsel)
 {
+       struct stlink_usb_handle_s *h = handle;
        int retval;
 
        /* nothing to do on old versions */
-       if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT))
+       if (!(h->version.flags & STLINK_F_HAS_AP_INIT))
                return ERROR_OK;
 
        if (apsel > DP_APSEL_MAX)
@@ -3226,7 +3231,7 @@ static int stlink_dap_open_ap(unsigned short apsel)
        if (test_bit(apsel, opened_ap))
                return ERROR_OK;
 
-       retval = stlink_usb_init_access_port(stlink_dap_handle, apsel);
+       retval = stlink_usb_init_access_port(h, apsel);
        if (retval != ERROR_OK)
                return retval;
 
@@ -3235,6 +3240,11 @@ static int stlink_dap_open_ap(unsigned short apsel)
        return ERROR_OK;
 }
 
+static int stlink_dap_open_ap(unsigned short apsel)
+{
+       return stlink_usb_open_ap(stlink_dap_handle, apsel);
+}
+
 /** */
 static int stlink_dap_closeall_ap(void)
 {
@@ -3259,7 +3269,6 @@ static int stlink_dap_closeall_ap(void)
 static int stlink_dap_reinit_interface(void)
 {
        int retval;
-       enum stlink_mode mode;
 
        /*
         * On JTAG only, it should be enough to call stlink_usb_reset(). But on
@@ -3269,13 +3278,12 @@ static int stlink_dap_reinit_interface(void)
         * select the mode again.
         */
 
-       mode = stlink_get_mode(stlink_dap_param.transport);
        if (!stlink_dap_handle->reconnect_pending) {
                stlink_dap_handle->reconnect_pending = true;
-               stlink_usb_mode_leave(stlink_dap_handle, mode);
+               stlink_usb_mode_leave(stlink_dap_handle, stlink_dap_handle->st_mode);
        }
 
-       retval = stlink_usb_mode_enter(stlink_dap_handle, mode);
+       retval = stlink_usb_mode_enter(stlink_dap_handle, stlink_dap_handle->st_mode);
        if (retval != ERROR_OK)
                return retval;
 
@@ -3322,7 +3330,7 @@ static int stlink_dap_op_connect(struct adiv5_dap *dap)
        retval = stlink_usb_idcode(stlink_dap_handle, &idcode);
        if (retval == ERROR_OK)
                LOG_INFO("%s %#8.8" PRIx32,
-                       (stlink_dap_handle->transport == HL_TRANSPORT_JTAG) ? "JTAG IDCODE" : "SWD DPIDR",
+                       (stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG) ? "JTAG IDCODE" : "SWD DPIDR",
                        idcode);
        else
                dap->do_reconnect = true;
@@ -3371,7 +3379,7 @@ static int stlink_dap_op_queue_dp_read(struct adiv5_dap *dap, unsigned reg,
 
        data = data ? : &dummy;
        if (stlink_dap_handle->version.flags & STLINK_F_QUIRK_JTAG_DP_READ
-               && stlink_dap_handle->transport == HL_TRANSPORT_JTAG) {
+               && stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG) {
                /* Quirk required in JTAG. Read RDBUFF to get the data */
                retval = stlink_read_dap_register(stlink_dap_handle,
                                        STLINK_DEBUG_PORT_ACCESS, reg, &dummy);
@@ -3507,7 +3515,7 @@ static int stlink_dap_op_run(struct adiv5_dap *dap)
        }
 
        if (ctrlstat & SSTICKYERR) {
-               if (stlink_dap_param.transport == HL_TRANSPORT_JTAG)
+               if (stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG)
                        retval = stlink_dap_op_queue_dp_write(dap, DP_CTRL_STAT,
                                        ctrlstat & (dap->dp_ctrl_stat | SSTICKYERR));
                else
@@ -3541,6 +3549,68 @@ static void stlink_dap_op_quit(struct adiv5_dap *dap)
                LOG_ERROR("Error closing APs");
 }
 
+static int stlink_swim_op_srst(void)
+{
+       return stlink_swim_generate_rst(stlink_dap_handle);
+}
+
+static int stlink_swim_op_read_mem(uint32_t addr, uint32_t size,
+                                                                  uint32_t count, uint8_t *buffer)
+{
+       int retval;
+       uint32_t bytes_remaining;
+
+       LOG_DEBUG_IO("read at 0x%08" PRIx32 " len %" PRIu32 "*0x%08" PRIx32, addr, size, count);
+       count *= size;
+
+       while (count) {
+               bytes_remaining = (count > STLINK_DATA_SIZE) ? STLINK_DATA_SIZE : count;
+               retval = stlink_swim_readbytes(stlink_dap_handle, addr, bytes_remaining, buffer);
+               if (retval != ERROR_OK)
+                       return retval;
+
+               buffer += bytes_remaining;
+               addr += bytes_remaining;
+               count -= bytes_remaining;
+       }
+
+       return ERROR_OK;
+}
+
+static int stlink_swim_op_write_mem(uint32_t addr, uint32_t size,
+                                                                       uint32_t count, const uint8_t *buffer)
+{
+       int retval;
+       uint32_t bytes_remaining;
+
+       LOG_DEBUG_IO("write at 0x%08" PRIx32 " len %" PRIu32 "*0x%08" PRIx32, addr, size, count);
+       count *= size;
+
+       while (count) {
+               bytes_remaining = (count > STLINK_DATA_SIZE) ? STLINK_DATA_SIZE : count;
+               retval = stlink_swim_writebytes(stlink_dap_handle, addr, bytes_remaining, buffer);
+               if (retval != ERROR_OK)
+                       return retval;
+
+               buffer += bytes_remaining;
+               addr += bytes_remaining;
+               count -= bytes_remaining;
+       }
+
+       return ERROR_OK;
+}
+
+static int stlink_swim_op_reconnect(void)
+{
+       int retval;
+
+       retval = stlink_usb_mode_enter(stlink_dap_handle, STLINK_MODE_DEBUG_SWIM);
+       if (retval != ERROR_OK)
+               return retval;
+
+       return stlink_swim_resync(stlink_dap_handle);
+}
+
 static int stlink_dap_config_trace(bool enabled,
                enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
                unsigned int *trace_freq, unsigned int traceclkin_freq,
@@ -3635,6 +3705,7 @@ static const struct command_registration stlink_dap_command_handlers[] = {
 static int stlink_dap_init(void)
 {
        enum reset_types jtag_reset_config = jtag_get_reset_config();
+       enum stlink_mode mode;
        int retval;
 
        LOG_DEBUG("stlink_dap_init()");
@@ -3647,19 +3718,22 @@ static int stlink_dap_init(void)
        }
 
        if (transport_is_dapdirect_swd())
-               stlink_dap_param.transport = HL_TRANSPORT_SWD;
+               mode = STLINK_MODE_DEBUG_SWD;
        else if (transport_is_dapdirect_jtag())
-               stlink_dap_param.transport = HL_TRANSPORT_JTAG;
+               mode = STLINK_MODE_DEBUG_JTAG;
+       else if (transport_is_swim())
+               mode = STLINK_MODE_DEBUG_SWIM;
        else {
                LOG_ERROR("Unsupported transport");
                return ERROR_FAIL;
        }
 
-       retval = stlink_usb_open(&stlink_dap_param, (void **)&stlink_dap_handle);
+       retval = stlink_usb_open(&stlink_dap_param, mode, (void **)&stlink_dap_handle);
        if (retval != ERROR_OK)
                return retval;
 
-       if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_DAP_REG)) {
+       if ((mode != STLINK_MODE_DEBUG_SWIM) &&
+               !(stlink_dap_handle->version.flags & STLINK_F_HAS_DAP_REG)) {
                LOG_ERROR("ST-Link version does not support DAP direct transport");
                return ERROR_FAIL;
        }
@@ -3731,7 +3805,14 @@ static const struct dap_ops stlink_dap_ops = {
        .quit = stlink_dap_op_quit, /* optional */
 };
 
-static const char *const stlink_dap_transport[] = { "dapdirect_jtag", "dapdirect_swd", NULL };
+static const struct swim_driver stlink_swim_ops = {
+       .srst = stlink_swim_op_srst,
+       .read_mem = stlink_swim_op_read_mem,
+       .write_mem = stlink_swim_op_write_mem,
+       .reconnect = stlink_swim_op_reconnect,
+};
+
+static const char *const stlink_dap_transport[] = { "dapdirect_swd", "dapdirect_jtag", "swim", NULL };
 
 struct adapter_driver stlink_dap_adapter_driver = {
        .name = "st-link",
@@ -3749,4 +3830,5 @@ struct adapter_driver stlink_dap_adapter_driver = {
 
        .dap_jtag_ops = &stlink_dap_ops,
        .dap_swd_ops = &stlink_dap_ops,
+       .swim_ops = &stlink_swim_ops,
 };

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)