stlink: add STLINK_F_HAS_MEM_16BIT
[openocd.git] / src / jtag / drivers / stlink_usb.c
index 9d6e222017f7ccd7038142a9ecac6d8240fa5426..5e0411ff609dc3c2d4949ef1cbacdd9cc21f8823 100644 (file)
@@ -259,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 {
@@ -278,8 +277,13 @@ enum stlink_mode {
  * Map the relevant features, quirks and workaround for specific firmware
  * version of stlink
  */
+#define STLINK_F_HAS_TRACE              (1UL << 0)
+#define STLINK_F_HAS_SWD_SET_FREQ       (1UL << 1)
+#define STLINK_F_HAS_JTAG_SET_FREQ      (1UL << 2)
+#define STLINK_F_HAS_MEM_16BIT          (1UL << 3)
 
 /* aliases */
+#define STLINK_F_HAS_TARGET_VOLT        STLINK_F_HAS_TRACE
 
 struct speed_map {
        int speed;
@@ -569,7 +573,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) {
@@ -668,6 +672,23 @@ static int stlink_usb_version(void *handle)
                /* all ST-LINK/V2 and ST-Link/V2.1 use api-v2 */
                h->version.jtag_api_max = STLINK_JTAG_API_V2;
 
+               /* API for trace from J13 */
+               /* API for target voltage from J13 */
+               if (h->version.jtag >= 13)
+                       flags |= STLINK_F_HAS_TRACE;
+
+               /* API to set SWD frequency from J22 */
+               if (h->version.jtag >= 22)
+                       flags |= STLINK_F_HAS_SWD_SET_FREQ;
+
+               /* API to set JTAG frequency from J24 */
+               if (h->version.jtag >= 24)
+                       flags |= STLINK_F_HAS_JTAG_SET_FREQ;
+
+               /* API to read/write memory at 16 bit from J26 */
+               if (h->version.jtag >= 26)
+                       flags |= STLINK_F_HAS_MEM_16BIT;
+
                break;
        default:
                break;
@@ -690,8 +711,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);
@@ -723,8 +744,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);
@@ -748,8 +768,7 @@ static int stlink_usb_set_jtagclk(void *handle, uint16_t clk_divisor)
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 24 */
-       if (h->version.stlink == 1 || h->version.jtag < 24)
+       if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
                return ERROR_COMMAND_NOTFOUND;
 
        stlink_usb_init_buffer(handle, h->rx_ep, 2);
@@ -1278,7 +1297,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);
@@ -1407,7 +1426,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");
 
@@ -1429,7 +1448,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;
@@ -1732,9 +1751,7 @@ static int stlink_usb_read_mem16(void *handle, uint32_t addr, uint16_t len,
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 26 */
-       if (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26))
+       if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                return ERROR_COMMAND_NOTFOUND;
 
        /* data must be a multiple of 2 and half-word aligned */
@@ -1771,9 +1788,7 @@ static int stlink_usb_write_mem16(void *handle, uint32_t addr, uint16_t len,
 
        assert(handle != NULL);
 
-       /* only supported by stlink/v2 and for firmware >= 26 */
-       if (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26))
+       if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                return ERROR_COMMAND_NOTFOUND;
 
        /* data must be a multiple of 2 and half-word aligned */
@@ -1885,8 +1900,7 @@ static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
        count *= size;
 
        /* switch to 8 bit if stlink does not support 16 bit memory read */
-       if (size == 2 && (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26)))
+       if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                size = 1;
 
        while (count) {
@@ -1971,8 +1985,7 @@ static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
        count *= size;
 
        /* switch to 8 bit if stlink does not support 16 bit memory read */
-       if (size == 2 && (h->jtag_api == STLINK_JTAG_API_V1 ||
-               (h->jtag_api == STLINK_JTAG_API_V2 && h->version.jtag < 26)))
+       if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
                size = 1;
 
        while (count) {
@@ -2109,8 +2122,8 @@ static int stlink_speed_swd(void *handle, int khz, bool query)
        int speed_index;
        struct stlink_usb_handle_s *h = handle;
 
-       /* only supported by stlink/v2 and for firmware >= 22 */
-       if (h->version.stlink == 1 || h->version.jtag < 22)
+       /* old firmware cannot change it */
+       if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
                return khz;
 
        speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_swd,
@@ -2132,8 +2145,8 @@ static int stlink_speed_jtag(void *handle, int khz, bool query)
        int speed_index;
        struct stlink_usb_handle_s *h = handle;
 
-       /* only supported by stlink/v2 and for firmware >= 24 */
-       if (h->version.stlink == 1 || h->version.jtag < 24)
+       /* old firmware cannot change it */
+       if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
                return khz;
 
        speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_jtag,
@@ -2284,7 +2297,6 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
                        case STLINK_V1_PID:
                                h->version.stlink = 1;
                                h->tx_ep = STLINK_TX_EP;
-                               h->trace_ep = STLINK_TRACE_EP;
                                break;
                        case STLINK_V2_1_PID:
                        case STLINK_V2_1_NO_MSD_PID:
@@ -2386,14 +2398,12 @@ static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
        }
 
        if (h->transport == HL_TRANSPORT_JTAG) {
-               /* jtag clock speed only supported by stlink/v2 and for firmware >= 24 */
-               if (h->version.stlink >= 2 && h->version.jtag >= 24) {
+               if (h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ) {
                        stlink_dump_speed_map(stlink_khz_to_speed_map_jtag, ARRAY_SIZE(stlink_khz_to_speed_map_jtag));
                        stlink_speed(h, param->initial_interface_speed, false);
                }
        } else if (h->transport == HL_TRANSPORT_SWD) {
-               /* clock speed only supported by stlink/v2 and for firmware >= 22 */
-               if (h->version.stlink >= 2 && h->version.jtag >= 22) {
+               if (h->version.flags & STLINK_F_HAS_SWD_SET_FREQ) {
                        stlink_dump_speed_map(stlink_khz_to_speed_map_swd, ARRAY_SIZE(stlink_khz_to_speed_map_swd));
                        stlink_speed(h, param->initial_interface_speed, false);
                }
@@ -2431,7 +2441,7 @@ int stlink_config_trace(void *handle, bool enabled, enum tpiu_pin_protocol pin_p
 {
        struct stlink_usb_handle_s *h = handle;
 
-       if (enabled && (h->jtag_api < 2 ||
+       if (enabled && (!(h->version.flags & STLINK_F_HAS_TRACE) ||
                        pin_protocol != TPIU_PIN_PROTOCOL_ASYNC_UART)) {
                LOG_ERROR("The attached ST-LINK version doesn't support this trace mode");
                return ERROR_FAIL;

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)