Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
STLINK: add check for the supported jtag API version
[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 2a4c2f456db89fefc47862c28c81eaf7cbd975b3..466a98c30eb493e13d8d76926c6d279d2e6bc123 100644 (file)
--- a/src/jtag/drivers/stlink_usb.c
+++ b/src/jtag/drivers/stlink_usb.c
@@ -43,6 +43,11 @@
 #define STLINK_TX_SIZE (4*128)
 #define STLINK_RX_SIZE (4*128)
 
+enum stlink_jtag_api_version {
+       STLINK_JTAG_API_V1 = 0,
+       STLINK_JTAG_API_V2,
+};
+
 /** */
 struct stlink_usb_version {
        /** */
@@ -51,6 +56,8 @@ struct stlink_usb_version {
        int jtag;
        /** */
        int swim;
+       /** highest supported jtag api version */
+       enum stlink_jtag_api_version jtag_api_max;
 };
 
 /** */
@@ -71,55 +78,67 @@ struct stlink_usb_handle_s {
        uint16_t vid;
        /** */
        uint16_t pid;
+       /** */
+       uint32_t sg_tag;
+       /** this is the currently used jtag api */
+       enum stlink_jtag_api_version jtag_api;
 };
 
-#define STLINK_OK                      0x80
-#define STLINK_FALSE                   0x81
-#define STLINK_CORE_RUNNING            0x80
-#define STLINK_CORE_HALTED             0x81
-#define STLINK_CORE_STAT_UNKNOWN       -1
-
-#define STLINK_GET_VERSION             0xF1
-#define STLINK_DEBUG_COMMAND           0xF2
-#define STLINK_DFU_COMMAND             0xF3
-#define STLINK_SWIM_COMMAND            0xF4
-#define STLINK_GET_CURRENT_MODE                0xF5
-
-#define STLINK_DEV_DFU_MODE            0x00
-#define STLINK_DEV_MASS_MODE           0x01
-#define STLINK_DEV_DEBUG_MODE          0x02
-#define STLINK_DEV_SWIM_MODE           0x03
-#define STLINK_DEV_UNKNOWN_MODE                -1
-
-#define STLINK_DFU_EXIT                        0x07
-
-#define STLINK_SWIM_ENTER              0x00
-#define STLINK_SWIM_EXIT               0x01
-
-#define STLINK_DEBUG_ENTER_JTAG                0x00
-#define STLINK_DEBUG_GETSTATUS         0x01
-#define STLINK_DEBUG_FORCEDEBUG                0x02
-#define STLINK_DEBUG_RESETSYS          0x03
-#define STLINK_DEBUG_READALLREGS       0x04
-#define STLINK_DEBUG_READREG           0x05
-#define STLINK_DEBUG_WRITEREG          0x06
-#define STLINK_DEBUG_READMEM_32BIT     0x07
-#define STLINK_DEBUG_WRITEMEM_32BIT    0x08
-#define STLINK_DEBUG_RUNCORE           0x09
-#define STLINK_DEBUG_STEPCORE          0x0a
-#define STLINK_DEBUG_SETFP             0x0b
-#define STLINK_DEBUG_READMEM_8BIT      0x0c
-#define STLINK_DEBUG_WRITEMEM_8BIT     0x0d
-#define STLINK_DEBUG_CLEARFP           0x0e
-#define STLINK_DEBUG_WRITEDEBUGREG     0x0f
-
-#define STLINK_DEBUG_ENTER_JTAG                0x00
-#define STLINK_DEBUG_ENTER_SWD         0xa3
-
-#define STLINK_DEBUG_ENTER             0x20
-#define STLINK_DEBUG_EXIT              0x21
-#define STLINK_DEBUG_READCOREID                0x22
-
+#define STLINK_OK                              0x80
+#define STLINK_FALSE                           0x81
+#define STLINK_CORE_RUNNING                    0x80
+#define STLINK_CORE_HALTED                     0x81
+#define STLINK_CORE_STAT_UNKNOWN               -1
+
+#define STLINK_GET_VERSION                     0xF1
+#define STLINK_DEBUG_COMMAND                   0xF2
+#define STLINK_DFU_COMMAND                     0xF3
+#define STLINK_SWIM_COMMAND                    0xF4
+#define STLINK_GET_CURRENT_MODE                        0xF5
+
+#define STLINK_DEV_DFU_MODE                    0x00
+#define STLINK_DEV_MASS_MODE                   0x01
+#define STLINK_DEV_DEBUG_MODE                  0x02
+#define STLINK_DEV_SWIM_MODE                   0x03
+#define STLINK_DEV_UNKNOWN_MODE                        -1
+
+#define STLINK_DFU_EXIT                                0x07
+
+#define STLINK_SWIM_ENTER                      0x00
+#define STLINK_SWIM_EXIT                       0x01
+
+#define STLINK_DEBUG_ENTER_JTAG                        0x00
+#define STLINK_DEBUG_GETSTATUS                 0x01
+#define STLINK_DEBUG_FORCEDEBUG                        0x02
+#define STLINK_DEBUG_APIV1_RESETSYS            0x03
+#define STLINK_DEBUG_APIV1_READALLREGS         0x04
+#define STLINK_DEBUG_APIV1_READREG             0x05
+#define STLINK_DEBUG_APIV1_WRITEREG            0x06
+#define STLINK_DEBUG_READMEM_32BIT             0x07
+#define STLINK_DEBUG_WRITEMEM_32BIT            0x08
+#define STLINK_DEBUG_RUNCORE                   0x09
+#define STLINK_DEBUG_STEPCORE                  0x0a
+#define STLINK_DEBUG_APIV1_SETFP               0x0b
+#define STLINK_DEBUG_READMEM_8BIT              0x0c
+#define STLINK_DEBUG_WRITEMEM_8BIT             0x0d
+#define STLINK_DEBUG_APIV1_CLEARFP             0x0e
+#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_APIV1_ENTER               0x20
+#define STLINK_DEBUG_EXIT                      0x21
+#define STLINK_DEBUG_READCOREID                        0x22
+
+#define STLINK_DEBUG_APIV2_ENTER               0x30
+
+#define STLINK_DEBUG_APIV2_RESETSYS            0x32
+#define STLINK_DEBUG_APIV2_READREG             0x33
+#define STLINK_DEBUG_APIV2_WRITEREG            0x34
+
+#define STLINK_DEBUG_APIV2_READALLREGS         0x3A
 /** */
 enum stlink_mode {
        STLINK_MODE_UNKNOWN = 0,
@@ -131,7 +150,158 @@ enum stlink_mode {
 };
 
 /** */
-static int stlink_usb_recv(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
+static void stlink_usb_recv_v1_create_cmd(char *b, int s, uint32_t tag, uint32_t rxsize,
+                       uint8_t flag, uint8_t lun, uint8_t length)
+{
+       int i = 0;
+
+       memset(b, 0x00, s);
+
+       /* fill the send buffer */
+       strcpy(b, "USBC");
+       i += 4;
+
+       buf_set_u32(b+i, 0, 32, tag);
+       i += 4;
+       buf_set_u32(b+i, 0, 32, rxsize);
+       i += 4;
+       b[i++] = flag;
+       b[i++] = lun;
+       b[i++] = length;
+}
+
+/** */
+static int stlink_usb_recv_v1_mass_storage_cmd(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
+                   int rxsize)
+{
+       char sg_buffer[31];
+       struct stlink_usb_handle_s *h;
+
+       assert(handle != NULL);
+
+       h = (struct stlink_usb_handle_s *)handle;
+       h->sg_tag = (h->sg_tag + 1) & 1;
+
+       stlink_usb_recv_v1_create_cmd(sg_buffer, 31, h->sg_tag, rxsize, STLINK_TX_EP, 0x00, txsize);
+
+       memcpy(sg_buffer+15, txbuf, 10);
+
+       if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)sg_buffer, 31,
+                                  1000) != 31) {
+               printf("send failed\n");
+               return ERROR_FAIL;
+       }
+
+       return ERROR_OK;
+}
+
+#define REQUEST_SENSE          0x03
+#define REQUEST_SENSE_LENGTH   18
+
+/** */
+static int stlink_usb_recv_v1_get_status(void *handle, char *sg_buffer, int len)
+{
+       struct stlink_usb_handle_s *h;
+
+       assert(handle != NULL);
+
+       h = (struct stlink_usb_handle_s *)handle;
+
+       /* read status */
+       memset(sg_buffer, 0x00, len);
+
+       if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)sg_buffer,
+                               len, 1000) != len)
+               return ERROR_FAIL;
+
+       uint32_t t1, t2;
+
+       t1 = buf_get_u32(sg_buffer+0, 0, 32);
+       t2 = buf_get_u32(sg_buffer+4, 0, 32);
+
+       /* check for USBS */
+       if (t1 != 0x53425355)
+               return ERROR_FAIL;
+
+       return ERROR_OK;
+}
+
+/** */
+static int stlink_usb_recv_v1_get_sense(void *handle)
+{
+       struct stlink_usb_handle_s *h;
+       char cdb[16];
+       char sg_buffer[31];
+
+       assert(handle != NULL);
+
+       h = (struct stlink_usb_handle_s *)handle;
+       h->sg_tag = (h->sg_tag + 1) & 1;
+
+       cdb[0] = REQUEST_SENSE;
+       cdb[4] = REQUEST_SENSE_LENGTH;
+
+       stlink_usb_recv_v1_create_cmd(sg_buffer, 31, h->sg_tag, REQUEST_SENSE_LENGTH, STLINK_TX_EP,
+                       0x00, 16);
+
+       memcpy(sg_buffer+15, cdb, 16);
+
+       if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)sg_buffer, 16,
+                                  1000) != 16)
+               return ERROR_FAIL;
+
+       if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)cdb,
+                                 16, 1000) != 16)
+               return ERROR_FAIL;
+
+       if (stlink_usb_recv_v1_get_status(handle, sg_buffer, 13) != ERROR_OK)
+               return ERROR_FAIL;
+       /* check for sense */
+       if (sg_buffer[12] != 0)
+               return ERROR_FAIL;
+
+       /* if (sense[0] != 0x70 && sense[0] != 0x71) */
+
+       return ERROR_OK;
+}
+
+/** */
+static int stlink_usb_recv_v1(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
+                   int rxsize)
+{
+       int err;
+       char sg_buffer[31];
+       struct stlink_usb_handle_s *h;
+
+       assert(handle != NULL);
+
+       h = (struct stlink_usb_handle_s *)handle;
+
+       err = stlink_usb_recv_v1_mass_storage_cmd(handle, txbuf, txsize, rxbuf, rxsize);
+
+       if (err != ERROR_OK)
+               return err;
+
+       if (rxsize && rxbuf) {
+               if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)rxbuf,
+                                         rxsize, 1000) != rxsize) {
+                       LOG_DEBUG("jtag_libusb_bulk_read");
+                       return ERROR_FAIL;
+               }
+       }
+
+       if (stlink_usb_recv_v1_get_status(handle, sg_buffer, 13) != ERROR_OK)
+               return ERROR_FAIL;
+       /* check for sense */
+       if (sg_buffer[12] == 1) {
+               LOG_DEBUG("get sense");
+               err = stlink_usb_recv_v1_get_sense(handle);
+       }
+       return err;
+}
+
+/** */
+static int stlink_usb_recv_v2(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
                    int rxsize)
 {
        struct stlink_usb_handle_s *h;
@@ -153,6 +323,25 @@ static int stlink_usb_recv(void *handle, const uint8_t *txbuf, int txsize, uint8
        return ERROR_OK;
 }
 
+/** */
+static int stlink_usb_recv(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
+                   int rxsize)
+{
+       struct stlink_usb_handle_s *h;
+
+       assert(handle != NULL);
+
+       h = (struct stlink_usb_handle_s *)handle;
+
+       if (h->version.stlink == 1) {
+               return stlink_usb_recv_v1(handle, txbuf, txsize, rxbuf, rxsize);
+       } else {
+               if (txsize < STLINK_CMD_SIZE)
+                       txsize = STLINK_CMD_SIZE;
+               return stlink_usb_recv_v2(handle, txbuf, txsize, rxbuf, rxsize);
+       }
+}
+
 /** */
 static void stlink_usb_init_buffer(void *handle)
 {
@@ -193,9 +382,19 @@ static int stlink_usb_version(void *handle)
        h->vid = buf_get_u32(h->rxbuf, 16, 16);
        h->pid = buf_get_u32(h->rxbuf, 32, 16);
 
-       LOG_DEBUG("STLINK v%d JTAG v%d SWIM v%d VID %04X PID %04X",
+       /* set the supported jtag api version
+        * V1 doesn't support API V2 at all
+        * V2 support API V2 since JTAG V13
+        */
+       if ((h->version.stlink == 2) && (h->version.jtag > 12))
+               h->version.jtag_api_max = STLINK_JTAG_API_V2;
+       else
+               h->version.jtag_api_max = STLINK_JTAG_API_V1;
+
+       LOG_DEBUG("STLINK v%d JTAG v%d API v%d SWIM v%d VID %04X PID %04X",
                h->version.stlink,
                h->version.jtag,
+               (h->version.jtag_api_max == STLINK_JTAG_API_V1) ? 1 : 2,
                h->version.swim,
                h->vid,
                h->pid);
@@ -242,12 +441,18 @@ static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
        switch (type) {
                case STLINK_MODE_DEBUG_JTAG:
                        h->txbuf[0] = STLINK_DEBUG_COMMAND;
-                       h->txbuf[1] = STLINK_DEBUG_ENTER;
+                       if (h->jtag_api == STLINK_JTAG_API_V1)
+                               h->txbuf[1] = STLINK_DEBUG_APIV1_ENTER;
+                       else
+                               h->txbuf[1] = STLINK_DEBUG_APIV2_ENTER;
                        h->txbuf[2] = STLINK_DEBUG_ENTER_JTAG;
                        break;
                case STLINK_MODE_DEBUG_SWD:
                        h->txbuf[0] = STLINK_DEBUG_COMMAND;
-                       h->txbuf[1] = STLINK_DEBUG_ENTER;
+                       if (h->jtag_api == STLINK_JTAG_API_V1)
+                               h->txbuf[1] = STLINK_DEBUG_APIV1_ENTER;
+                       else
+                               h->txbuf[1] = STLINK_DEBUG_APIV2_ENTER;
                        h->txbuf[2] = STLINK_DEBUG_ENTER_SWD;
                        break;
                case STLINK_MODE_DEBUG_SWIM:
@@ -363,6 +568,8 @@ static int stlink_usb_init_mode(void *handle)
                        emode = STLINK_MODE_DEBUG_JTAG;
                        break;
                case STLINK_TRANSPORT_SWIM:
+                       emode = STLINK_MODE_DEBUG_SWIM;
+                       break;
                default:
                        emode = STLINK_MODE_UNKNOWN;
                        break;
@@ -425,6 +632,9 @@ static enum target_state stlink_usb_state(void *handle)
 
        h = (struct stlink_usb_handle_s *)handle;
 
+       if (h->jtag_api == STLINK_JTAG_API_V2)
+               return TARGET_UNKNOWN;
+
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
@@ -456,7 +666,11 @@ static int stlink_usb_reset(void *handle)
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
-       h->txbuf[1] = STLINK_DEBUG_RESETSYS;
+
+       if (h->jtag_api == STLINK_JTAG_API_V1)
+               h->txbuf[1] = STLINK_DEBUG_APIV1_RESETSYS;
+       else
+               h->txbuf[1] = STLINK_DEBUG_APIV2_RESETSYS;
 
        res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
 
@@ -478,6 +692,9 @@ static int stlink_usb_run(void *handle)
 
        h = (struct stlink_usb_handle_s *)handle;
 
+       if (h->jtag_api == STLINK_JTAG_API_V2)
+               return ERROR_FAIL;
+
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
@@ -501,6 +718,9 @@ static int stlink_usb_halt(void *handle)
 
        h = (struct stlink_usb_handle_s *)handle;
 
+       if (h->jtag_api == STLINK_JTAG_API_V2)
+               return ERROR_FAIL;
+
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
@@ -524,6 +744,9 @@ static int stlink_usb_step(void *handle)
 
        h = (struct stlink_usb_handle_s *)handle;
 
+       if (h->jtag_api == STLINK_JTAG_API_V2)
+               return ERROR_FAIL;
+
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
@@ -550,7 +773,11 @@ static int stlink_usb_read_regs(void *handle)
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
-       h->txbuf[1] = STLINK_DEBUG_READALLREGS;
+       if (h->jtag_api == STLINK_JTAG_API_V1)
+               h->txbuf[1] = STLINK_DEBUG_APIV1_READALLREGS;
+       else
+               h->txbuf[1] = STLINK_DEBUG_APIV2_READALLREGS;
+
 
        res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 84);
 
@@ -573,7 +800,10 @@ static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
-       h->txbuf[1] = STLINK_DEBUG_READREG;
+       if (h->jtag_api == STLINK_JTAG_API_V1)
+               h->txbuf[1] = STLINK_DEBUG_APIV1_READREG;
+       else
+               h->txbuf[1] = STLINK_DEBUG_APIV2_READREG;
        h->txbuf[2] = num;
 
        res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 4);
@@ -599,7 +829,10 @@ static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
        stlink_usb_init_buffer(handle);
 
        h->txbuf[0] = STLINK_DEBUG_COMMAND;
-       h->txbuf[1] = STLINK_DEBUG_WRITEREG;
+       if (h->jtag_api == STLINK_JTAG_API_V1)
+               h->txbuf[1] = STLINK_DEBUG_APIV1_WRITEREG;
+       else
+               h->txbuf[1] = STLINK_DEBUG_APIV2_WRITEREG;
        h->txbuf[2] = num;
        h_u32_to_le(h->txbuf + 3, val);
 
@@ -758,8 +991,8 @@ static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
        const uint16_t vids[] = { param->vid, 0 };
        const uint16_t pids[] = { param->pid, 0 };
 
-       LOG_DEBUG("vid: %04x pid: %04x", param->vid,
-                 param->pid);
+       LOG_DEBUG("transport: %d vid: %04x pid: %04x", param->transport,
+               param->vid, param->pid);
 
        if (jtag_libusb_open(vids, pids, &h->fd) != ERROR_OK) {
                LOG_ERROR("open failed");
@@ -773,6 +1006,16 @@ static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
                return ERROR_FAIL;
        }
 
+       /* wrap version for first read */
+       switch (param->pid) {
+               case 0x3744:
+                       h->version.stlink = 1;
+                       break;
+               default:
+                       h->version.stlink = 2;
+                       break;
+       }
+
        /* get the device version */
        err = stlink_usb_version(h);
 
@@ -814,6 +1057,10 @@ static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
                return err;
        }
 
+       /* set the used jtag api */
+       h->jtag_api = STLINK_JTAG_API_V1;
+
+       /* initialize the debug hardware */
        err = stlink_usb_init_mode(h);
 
        if (err != ERROR_OK) {
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)