Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
stlink_usb.c: add support for STLink V2-1
[openocd.git] / src / jtag / drivers / stlink_usb.c
diff --git a/src/jtag/drivers/stlink_usb.c b/src/jtag/drivers/stlink_usb.c
index 957f1d40fdd7bd642837c48a7ab484b2e3e65a7d..b4dc0de3c9e646d665d34473de32b82ed37ca755 100644 (file)
--- a/src/jtag/drivers/stlink_usb.c
+++ b/src/jtag/drivers/stlink_usb.c
@@ -45,14 +45,22 @@
 #define STLINK_WRITE_TIMEOUT 1000
 #define STLINK_READ_TIMEOUT 1000
 
-#define STLINK_NULL_EP     0
-#define STLINK_RX_EP       (1|ENDPOINT_IN)
-#define STLINK_TX_EP       (2|ENDPOINT_OUT)
-#define STLINK_TRACE_EP    (3|ENDPOINT_IN)
-#define STLINK_SG_SIZE     (31)
-#define STLINK_DATA_SIZE   (4096)
-#define STLINK_CMD_SIZE_V2 (16)
-#define STLINK_CMD_SIZE_V1 (10)
+#define STLINK_NULL_EP        0
+#define STLINK_RX_EP          (1|ENDPOINT_IN)
+#define STLINK_TX_EP          (2|ENDPOINT_OUT)
+#define STLINK_TRACE_EP       (3|ENDPOINT_IN)
+
+#define STLINK_V2_1_TX_EP     (1|ENDPOINT_OUT)
+#define STLINK_V2_1_TRACE_EP  (2|ENDPOINT_IN)
+
+#define STLINK_SG_SIZE        (31)
+#define STLINK_DATA_SIZE      (4096)
+#define STLINK_CMD_SIZE_V2    (16)
+#define STLINK_CMD_SIZE_V1    (10)
+
+#define STLINK_V1_PID         (0x3744)
+#define STLINK_V2_PID         (0x3748)
+#define STLINK_V2_1_PID       (0x374B)
 
 /* the current implementation of the stlink limits
  * 8bit read/writes to max 64 bytes. */
@@ -82,6 +90,12 @@ struct stlink_usb_handle_s {
        /** */
        struct libusb_transfer *trans;
        /** */
+       uint8_t rx_ep;
+       /** */
+       uint8_t tx_ep;
+       /** */
+       uint8_t trace_ep;
+       /** */
        uint8_t cmdbuf[STLINK_SG_SIZE];
        /** */
        uint8_t cmdidx;
@@ -216,7 +230,7 @@ static int stlink_usb_xfer_v1_get_status(void *handle)
        /* read status */
        memset(h->cmdbuf, 0, STLINK_SG_SIZE);
 
-       if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)h->cmdbuf,
+       if (jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)h->cmdbuf,
                        13, STLINK_READ_TIMEOUT) != 13)
                return ERROR_FAIL;
 
@@ -246,19 +260,19 @@ static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int
 
        assert(handle != NULL);
 
-       if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)h->cmdbuf, cmdsize,
+       if (jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)h->cmdbuf, cmdsize,
                        STLINK_WRITE_TIMEOUT) != cmdsize) {
                return ERROR_FAIL;
        }
 
-       if (h->direction == STLINK_TX_EP && size) {
-               if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)buf,
+       if (h->direction == h->tx_ep && size) {
+               if (jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)buf,
                                size, STLINK_WRITE_TIMEOUT) != size) {
                        LOG_DEBUG("bulk write failed");
                        return ERROR_FAIL;
                }
-       } else if (h->direction == STLINK_RX_EP && size) {
-               if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)buf,
+       } else if (h->direction == h->rx_ep && size) {
+               if (jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)buf,
                                size, STLINK_READ_TIMEOUT) != size) {
                        LOG_DEBUG("bulk read failed");
                        return ERROR_FAIL;
@@ -276,7 +290,7 @@ static int stlink_usb_xfer_v1_get_sense(void *handle)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 16);
+       stlink_usb_init_buffer(handle, h->rx_ep, 16);
 
        h->cmdbuf[h->cmdidx++] = REQUEST_SENSE;
        h->cmdbuf[h->cmdidx++] = 0;
@@ -335,7 +349,7 @@ static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
 
        assert(h->version.stlink >= 2);
 
-       if (jtag_libusb_bulk_read(h->fd, STLINK_TRACE_EP, (char *)buf,
+       if (jtag_libusb_bulk_read(h->fd, h->trace_ep, (char *)buf,
                        size, STLINK_READ_TIMEOUT) != size) {
                LOG_ERROR("bulk trace read failed");
                return ERROR_FAIL;
@@ -356,7 +370,7 @@ static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint3
        h->cmdidx += 4;
        buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, size);
        h->cmdidx += 4;
-       h->cmdbuf[h->cmdidx++] = (direction == STLINK_RX_EP ? ENDPOINT_IN : ENDPOINT_OUT);
+       h->cmdbuf[h->cmdidx++] = (direction == h->rx_ep ? ENDPOINT_IN : ENDPOINT_OUT);
        h->cmdbuf[h->cmdidx++] = 0; /* lun */
        h->cmdbuf[h->cmdidx++] = STLINK_CMD_SIZE_V1;
 }
@@ -420,7 +434,7 @@ static int stlink_usb_version(void *handle)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 6);
+       stlink_usb_init_buffer(handle, h->rx_ep, 6);
 
        h->cmdbuf[h->cmdidx++] = STLINK_GET_VERSION;
 
@@ -465,7 +479,7 @@ static int stlink_usb_check_voltage(void *handle, float *target_voltage)
        if (h->version.stlink == 1 || h->version.jtag < 13)
                return ERROR_COMMAND_NOTFOUND;
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 8);
+       stlink_usb_init_buffer(handle, h->rx_ep, 8);
 
        h->cmdbuf[h->cmdidx++] = STLINK_GET_TARGET_VOLTAGE;
 
@@ -496,7 +510,7 @@ static int stlink_usb_current_mode(void *handle, uint8_t *mode)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_GET_CURRENT_MODE;
 
@@ -526,7 +540,7 @@ static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
        if (h->jtag_api == STLINK_JTAG_API_V2)
                rx_size = 2;
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, rx_size);
+       stlink_usb_init_buffer(handle, h->rx_ep, rx_size);
 
        switch (type) {
                case STLINK_MODE_DEBUG_JTAG:
@@ -726,7 +740,7 @@ static int stlink_usb_idcode(void *handle, uint32_t *idcode)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 4);
+       stlink_usb_init_buffer(handle, h->rx_ep, 4);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READCOREID;
@@ -738,7 +752,7 @@ static int stlink_usb_idcode(void *handle, uint32_t *idcode)
 
        *idcode = le_to_h_u32(h->databuf);
 
-       LOG_DEBUG("IDCODE: 0x%08X", *idcode);
+       LOG_DEBUG("IDCODE: 0x%08" PRIX32, *idcode);
 
        return ERROR_OK;
 }
@@ -750,7 +764,7 @@ static int stlink_usb_v2_read_debug_reg(void *handle, uint32_t addr, uint32_t *v
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 8);
+       stlink_usb_init_buffer(handle, h->rx_ep, 8);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READDEBUGREG;
@@ -774,7 +788,7 @@ static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        if (h->jtag_api == STLINK_JTAG_API_V1)
@@ -804,7 +818,7 @@ static void stlink_usb_trace_read(void *handle)
        if (h->trace.enabled && h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
                int res;
 
-               stlink_usb_init_buffer(handle, STLINK_RX_EP, 10);
+               stlink_usb_init_buffer(handle, h->rx_ep, 10);
 
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GET_TRACE_NB;
@@ -830,6 +844,12 @@ static void stlink_usb_trace_read(void *handle)
        }
 }
 
+static int stlink_usb_trace_read_callback(void *handle)
+{
+       stlink_usb_trace_read(handle);
+       return ERROR_OK;
+}
+
 static enum target_state stlink_usb_v2_get_status(void *handle)
 {
        int result;
@@ -860,7 +880,7 @@ static enum target_state stlink_usb_state(void *handle)
        if (h->jtag_api == STLINK_JTAG_API_V2)
                return stlink_usb_v2_get_status(handle);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_GETSTATUS;
@@ -886,7 +906,7 @@ static int stlink_usb_reset(void *handle)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
 
@@ -919,7 +939,7 @@ static int stlink_usb_assert_srst(void *handle, int srst)
        if (h->jtag_api == STLINK_JTAG_API_V1)
                return ERROR_COMMAND_NOTFOUND;
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_DRIVE_NRST;
@@ -1001,13 +1021,15 @@ static void stlink_usb_trace_disable(void *handle)
 
        LOG_DEBUG("Tracing: disable\n");
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX;
        res = stlink_usb_xfer(handle, h->databuf, 2);
 
-       if (res == ERROR_OK)
+       if (res == ERROR_OK) {
                h->trace.enabled = false;
+               target_unregister_timer_callback(stlink_usb_trace_read_callback, handle);
+       }
 }
 
 
@@ -1030,7 +1052,7 @@ static int stlink_usb_trace_enable(void *handle)
                        h->trace.source_hz / (h->trace.prescale + 1) :
                        h->trace.source_hz;
 
-               stlink_usb_init_buffer(handle, STLINK_RX_EP, 10);
+               stlink_usb_init_buffer(handle, h->rx_ep, 10);
 
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
                h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_START_TRACE_RX;
@@ -1043,7 +1065,15 @@ static int stlink_usb_trace_enable(void *handle)
 
                if (res == ERROR_OK)  {
                        h->trace.enabled = true;
-                       LOG_DEBUG("Tracing: recording at %uHz\n", trace_hz);
+                       LOG_DEBUG("Tracing: recording at %" PRIu32 "Hz\n", trace_hz);
+                       /* We need the trace read function to be called at a
+                        * high-enough frequency to ensure reasonable
+                        * "timeliness" in processing ITM/DWT data.
+                        * TODO: An alternative could be using the asynchronous
+                        * features of the libusb-1.0 API to queue up one or more
+                        * reads in advance and requeue them once they are
+                        * completed. */
+                       target_register_timer_callback(stlink_usb_trace_read_callback, 1, 1, handle);
                }
        } else {
                LOG_ERROR("Tracing is not supported by this version.");
@@ -1065,7 +1095,7 @@ static int stlink_usb_run(void *handle)
                res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
 
                /* Try to start tracing, if requested */
-               if (res == ERROR_OK && h->trace.source_hz) {
+               if (res == ERROR_OK && h->trace.source_hz && !h->trace.enabled) {
                        if (stlink_usb_trace_enable(handle) == ERROR_OK)
                                LOG_DEBUG("Tracing: enabled\n");
                        else
@@ -1075,7 +1105,7 @@ static int stlink_usb_run(void *handle)
                return res;
        }
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_RUNCORE;
@@ -1105,7 +1135,7 @@ static int stlink_usb_halt(void *handle)
                return res;
        }
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_FORCEDEBUG;
@@ -1134,7 +1164,7 @@ static int stlink_usb_step(void *handle)
                return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
        }
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_STEPCORE;
@@ -1155,7 +1185,7 @@ static int stlink_usb_read_regs(void *handle)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 84);
+       stlink_usb_init_buffer(handle, h->rx_ep, 84);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        if (h->jtag_api == STLINK_JTAG_API_V1)
@@ -1179,7 +1209,7 @@ static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
+       stlink_usb_init_buffer(handle, h->rx_ep, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        if (h->jtag_api == STLINK_JTAG_API_V1)
@@ -1211,7 +1241,7 @@ static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
 
        assert(handle != NULL);
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        if (h->jtag_api == STLINK_JTAG_API_V1)
@@ -1240,7 +1270,7 @@ static int stlink_usb_get_rw_status(void *handle)
        if (h->jtag_api == STLINK_JTAG_API_V1)
                return ERROR_OK;
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+       stlink_usb_init_buffer(handle, h->rx_ep, 2);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
@@ -1269,7 +1299,7 @@ static int stlink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
                return ERROR_FAIL;
        }
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, read_len);
+       stlink_usb_init_buffer(handle, h->rx_ep, read_len);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_8BIT;
@@ -1307,7 +1337,7 @@ static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
                return ERROR_FAIL;
        }
 
-       stlink_usb_init_buffer(handle, STLINK_TX_EP, len);
+       stlink_usb_init_buffer(handle, h->tx_ep, len);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_8BIT;
@@ -1339,7 +1369,7 @@ static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
                return ERROR_TARGET_UNALIGNED_ACCESS;
        }
 
-       stlink_usb_init_buffer(handle, STLINK_RX_EP, len);
+       stlink_usb_init_buffer(handle, h->rx_ep, len);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_32BIT;
@@ -1373,7 +1403,7 @@ static int stlink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
                return ERROR_TARGET_UNALIGNED_ACCESS;
        }
 
-       stlink_usb_init_buffer(handle, STLINK_TX_EP, len);
+       stlink_usb_init_buffer(handle, h->tx_ep, len);
 
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
        h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_32BIT;
@@ -1579,14 +1609,28 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                        goto error_open;
                }
 
+               /* RX EP is common for all versions */
+               h->rx_ep = STLINK_RX_EP;
+
                /* wrap version for first read */
                switch (param->pid) {
-               case 0x3744:
-                       h->version.stlink = 1;
-                       break;
-               default:
-                       h->version.stlink = 2;
-                       break;
+                       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:
+                               h->version.stlink = 2;
+                               h->tx_ep = STLINK_V2_1_TX_EP;
+                               h->trace_ep = STLINK_V2_1_TRACE_EP;
+                               break;
+                       default:
+                       /* fall through - we assume V2 to be the default version*/
+                       case STLINK_V2_PID:
+                               h->version.stlink = 2;
+                               h->tx_ep = STLINK_TX_EP;
+                               h->trace_ep = STLINK_TRACE_EP;
+                               break;
                }
 
                /* get the device version */
@@ -1652,12 +1696,7 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
 
        api = h->version.jtag_api_max;
 
-       /* check that user has not requested certain api version
-        * and if they have check it is supported */
-       if ((param->api != 0) && (param->api <= h->version.jtag_api_max)) {
-               api = param->api;
-               LOG_INFO("using stlink api v%d", api);
-       }
+       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;
Open On-Chip Debugger

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)