stlink: format src defines
[openocd.git] / src / jtag / drivers / stlink_usb.c
index 1de42efb92790a7e73a5fcc6e656e7c40d668931..4382538d2d339a43a57b20bfedc775bdc4d022ab 100644 (file)
@@ -2,6 +2,9 @@
  *   Copyright (C) 2011-2012 by Mathias Kuester                            *
  *   Mathias Kuester <kesmtp@freenet.de>                                   *
  *                                                                         *
+ *   Copyright (C) 2012 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This code is based on https://github.com/texane/stlink                *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 
 #include "libusb_common.h"
 
-#define ENDPOINT_IN    0x80
-#define ENDPOINT_OUT   0x00
+#define ENDPOINT_IN  0x80
+#define ENDPOINT_OUT 0x00
 
-#define STLINK_NULL_EP         0
-#define STLINK_RX_EP           (1|ENDPOINT_IN)
-#define STLINK_TX_EP           (2|ENDPOINT_OUT)
-#define STLINK_SG_SIZE         (31)
-#define STLINK_DATA_SIZE       (4*128)
-#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_SG_SIZE     (31)
+#define STLINK_DATA_SIZE   (4*128)
+#define STLINK_CMD_SIZE_V2 (16)
+#define STLINK_CMD_SIZE_V1 (10)
 
 enum stlink_jtag_api_version {
-       STLINK_JTAG_API_V1 = 0,
+       STLINK_JTAG_API_V1 = 1,
        STLINK_JTAG_API_V2,
 };
 
@@ -90,70 +93,73 @@ struct stlink_usb_handle_s {
        enum stlink_jtag_api_version jtag_api;
 };
 
-#define STLINK_DEBUG_ERR_OK                    0x80
-#define STLINK_DEBUG_ERR_FAULT                 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_BOOTLOADER_MODE             0x04
-#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_READ_IDCODES                0x31
-#define STLINK_DEBUG_APIV2_RESETSYS            0x32
-#define STLINK_DEBUG_APIV2_READREG             0x33
-#define STLINK_DEBUG_APIV2_WRITEREG            0x34
-#define STLINK_DEBUG_APIV2_WRITEDEBUGREG       0x35
-#define STLINK_DEBUG_APIV2_READDEBUGREG        0x36
-
-#define STLINK_DEBUG_APIV2_READALLREGS         0x3A
-#define STLINK_DEBUG_APIV2_GETLASTRWSTATUS     0x3B
-#define STLINK_DEBUG_APIV2_DRIVE_NRST          0x3C
-
-#define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW      0x00
-#define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH     0x01
-#define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE    0x02
+#define STLINK_DEBUG_ERR_OK            0x80
+#define STLINK_DEBUG_ERR_FAULT         0x81
+#define STLINK_SWD_AP_WAIT             0x10
+#define STLINK_SWD_DP_WAIT             0x14
+
+#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_BOOTLOADER_MODE     0x04
+#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_READ_IDCODES    0x31
+#define STLINK_DEBUG_APIV2_RESETSYS        0x32
+#define STLINK_DEBUG_APIV2_READREG         0x33
+#define STLINK_DEBUG_APIV2_WRITEREG        0x34
+#define STLINK_DEBUG_APIV2_WRITEDEBUGREG   0x35
+#define STLINK_DEBUG_APIV2_READDEBUGREG    0x36
+
+#define STLINK_DEBUG_APIV2_READALLREGS     0x3A
+#define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
+#define STLINK_DEBUG_APIV2_DRIVE_NRST      0x3C
+
+#define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW   0x00
+#define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH  0x01
+#define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
 
 /** */
 enum stlink_mode {
@@ -165,8 +171,8 @@ enum stlink_mode {
        STLINK_MODE_DEBUG_SWIM
 };
 
-#define REQUEST_SENSE          0x03
-#define REQUEST_SENSE_LENGTH   18
+#define REQUEST_SENSE        0x03
+#define REQUEST_SENSE_LENGTH 18
 
 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
 
@@ -781,6 +787,10 @@ static int stlink_usb_reset(void *handle)
 
        LOG_DEBUG("RESET: 0x%08X", h->databuf[0]);
 
+       /* the following is not a error under swd (using hardware srst), so return success */
+       if (h->databuf[0] == STLINK_SWD_AP_WAIT || h->databuf[0] == STLINK_SWD_DP_WAIT)
+               return ERROR_OK;
+
        return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
 }
 
@@ -872,8 +882,13 @@ static int stlink_usb_step(void *handle)
 
        h = (struct stlink_usb_handle_s *)handle;
 
-       if (h->jtag_api == STLINK_JTAG_API_V2)
-               return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_STEP|C_DEBUGEN);
+       if (h->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);
+               stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_STEP|C_MASKINTS|C_DEBUGEN);
+               return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
+       }
 
        stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
 
@@ -1132,6 +1147,7 @@ static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
 {
        int err;
        struct stlink_usb_handle_s *h;
+       enum stlink_jtag_api_version api;
 
        LOG_DEBUG("stlink_usb_open");
 
@@ -1213,8 +1229,17 @@ static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
                return err;
        }
 
+       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);
+       }
+
        /* set the used jtag api, this will default to the newest supported version */
-       h->jtag_api = h->version.jtag_api_max;
+       h->jtag_api = api;
 
        /* initialize the debug hardware */
        err = stlink_usb_init_mode(h);

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)