#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. */
#define STLINK_MAX_RW8 (64)
+/* "WAIT" responses will be retried (with exponential backoff) at
+ * most this many times before failing to caller.
+ */
+#define MAX_WAIT_RETRIES 8
+
enum stlink_jtag_api_version {
STLINK_JTAG_API_V1 = 1,
STLINK_JTAG_API_V2,
/** */
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;
/** trace module clock prescaler */
uint32_t prescale;
} trace;
+ /** reconnect is needed next time we try to query the
+ * status */
+ bool reconnect_pending;
};
#define STLINK_DEBUG_ERR_OK 0x80
/** */
static int stlink_usb_xfer_v1_get_status(void *handle)
{
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)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;
/** */
static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
{
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
static int stlink_usb_xfer_v1_get_sense(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
static int stlink_usb_xfer(void *handle, const uint8_t *buf, int size)
{
int err, cmdsize = STLINK_CMD_SIZE_V2;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
if (h->version.stlink == 1)
cmdsize = STLINK_SG_SIZE;
return ERROR_OK;
}
+
+/**
+ Converts an STLINK status code held in the first byte of a response
+ to an openocd error, logs any error/wait status as debug output.
+*/
+static int stlink_usb_error_check(void *handle)
+{
+ struct stlink_usb_handle_s *h = handle;
+
+ assert(handle != NULL);
+
+ /* TODO: no error checking yet on api V1 */
+ if (h->jtag_api == STLINK_JTAG_API_V1)
+ h->databuf[0] = STLINK_DEBUG_ERR_OK;
+
+ switch (h->databuf[0]) {
+ case STLINK_DEBUG_ERR_OK:
+ return ERROR_OK;
+ case STLINK_DEBUG_ERR_FAULT:
+ LOG_DEBUG("SWD fault response (0x%x)", STLINK_DEBUG_ERR_FAULT);
+ return ERROR_FAIL;
+ case STLINK_SWD_AP_WAIT:
+ LOG_DEBUG("wait status SWD_AP_WAIT (0x%x)", STLINK_SWD_AP_WAIT);
+ return ERROR_WAIT;
+ case STLINK_SWD_DP_WAIT:
+ LOG_DEBUG("wait status SWD_DP_WAIT (0x%x)", STLINK_SWD_AP_WAIT);
+ return ERROR_WAIT;
+ default:
+ LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h->databuf[0]);
+ return ERROR_FAIL;
+ }
+}
+
+
+/** Issue an STLINK command via USB transfer, with retries on any wait status responses.
+
+ Works for commands where the STLINK_DEBUG status is returned in the first
+ byte of the response packet.
+
+ Returns an openocd result code.
+*/
+static int stlink_cmd_allow_retry(void *handle, const uint8_t *buf, int size)
+{
+ int retries = 0;
+ int res;
+ while (1) {
+ res = stlink_usb_xfer(handle, buf, size);
+ if (res != ERROR_OK)
+ return res;
+ res = stlink_usb_error_check(handle);
+ if (res == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
+ usleep((1<<retries++) * 1000);
+ continue;
+ }
+ return res;
+ }
+}
+
/** */
static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
{
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
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;
/** */
static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint32_t size)
{
- struct stlink_usb_handle_s *h;
-
- h = (struct stlink_usb_handle_s *)handle;
+ struct stlink_usb_handle_s *h = handle;
/* fill the send buffer */
strcpy((char *)h->cmdbuf, "USBC");
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;
}
/** */
static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size)
{
- struct stlink_usb_handle_s *h;
-
- h = (struct stlink_usb_handle_s *)handle;
+ struct stlink_usb_handle_s *h = handle;
h->direction = direction;
stlink_usb_xfer_v1_create_cmd(handle, direction, size);
}
-static const char * const stlink_usb_error_msg[] = {
- "unknown"
-};
-
-/** */
-static int stlink_usb_error_check(void *handle)
-{
- int res;
- const char *err_msg = 0;
- struct stlink_usb_handle_s *h;
-
- assert(handle != NULL);
-
- h = (struct stlink_usb_handle_s *)handle;
-
- /* TODO: no error checking yet on api V1 */
- if (h->jtag_api == STLINK_JTAG_API_V1)
- h->databuf[0] = STLINK_DEBUG_ERR_OK;
-
- switch (h->databuf[0]) {
- case STLINK_DEBUG_ERR_OK:
- res = ERROR_OK;
- break;
- case STLINK_DEBUG_ERR_FAULT:
- default:
- err_msg = stlink_usb_error_msg[0];
- res = ERROR_FAIL;
- break;
- }
-
- if (res != ERROR_OK)
- LOG_DEBUG("status error: %d ('%s')", h->databuf[0], err_msg);
-
- return res;
-}
-
/** */
static int stlink_usb_version(void *handle)
{
int res;
uint16_t v;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
static int stlink_usb_check_voltage(void *handle, float *target_voltage)
{
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
uint32_t adc_results[2];
- h = (struct stlink_usb_handle_s *)handle;
-
/* only supported by stlink/v2 and for firmware >= 13 */
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;
static int stlink_usb_current_mode(void *handle, uint8_t *mode)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
/** */
static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
{
- int res;
int rx_size = 0;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
/* on api V2 we are able the read the latest command
* status
* TODO: we need the test on api V1 too
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:
return ERROR_FAIL;
}
- res = stlink_usb_xfer(handle, h->databuf, rx_size);
-
- if (res != ERROR_OK)
- return res;
-
- res = stlink_usb_error_check(h);
-
- return res;
+ return stlink_cmd_allow_retry(handle, h->databuf, rx_size);
}
/** */
static int stlink_usb_mode_leave(void *handle, enum stlink_mode type)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
stlink_usb_init_buffer(handle, STLINK_NULL_EP, 0);
switch (type) {
static int stlink_usb_assert_srst(void *handle, int srst);
+static enum stlink_mode stlink_get_mode(enum hl_transports t)
+{
+ switch (t) {
+ case HL_TRANSPORT_SWD:
+ 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 res;
uint8_t mode;
enum stlink_mode emode;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
res = stlink_usb_current_mode(handle, &mode);
if (res != ERROR_OK)
LOG_DEBUG("MODE: 0x%02X", mode);
/* set selected mode */
- switch (h->transport) {
- case HL_TRANSPORT_SWD:
- emode = STLINK_MODE_DEBUG_SWD;
- break;
- case HL_TRANSPORT_JTAG:
- emode = STLINK_MODE_DEBUG_JTAG;
- break;
- case HL_TRANSPORT_SWIM:
- emode = STLINK_MODE_DEBUG_SWIM;
- break;
- default:
- emode = STLINK_MODE_UNKNOWN;
- break;
- }
+ emode = stlink_get_mode(h->transport);
if (emode == STLINK_MODE_UNKNOWN) {
LOG_ERROR("selected mode (transport) not supported");
static int stlink_usb_idcode(void *handle, uint32_t *idcode)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
*idcode = le_to_h_u32(h->databuf);
- LOG_DEBUG("IDCODE: 0x%08X", *idcode);
+ LOG_DEBUG("IDCODE: 0x%08" PRIX32, *idcode);
return ERROR_OK;
}
static int stlink_usb_v2_read_debug_reg(void *handle, uint32_t addr, uint32_t *val)
{
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
int res;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
h->cmdidx += 4;
- res = stlink_usb_xfer(handle, h->databuf, 8);
-
+ res = stlink_cmd_allow_retry(handle, h->databuf, 8);
if (res != ERROR_OK)
return res;
*val = le_to_h_u32(h->databuf + 4);
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return ERROR_OK;
}
static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
{
- int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)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;
if (h->jtag_api == STLINK_JTAG_API_V1)
h_u32_to_le(h->cmdbuf+h->cmdidx, val);
h->cmdidx += 4;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
/** */
static void stlink_usb_trace_read(void *handle)
{
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)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;
res = stlink_usb_read_trace(handle, buf, size);
if (res == ERROR_OK) {
- /* Log retrieved trace output */
- if (fwrite(buf, 1, size, h->trace.output_f) > 0)
- fflush(h->trace.output_f);
+ if (h->trace.output_f) {
+ /* Log retrieved trace output */
+ if (fwrite(buf, 1, size, h->trace.output_f) > 0)
+ fflush(h->trace.output_f);
+ }
}
}
}
}
}
+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;
static enum target_state stlink_usb_state(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
+ if (h->reconnect_pending) {
+ LOG_INFO("Previous state query failed, trying to reconnect");
+ res = stlink_usb_mode_enter(handle, stlink_get_mode(h->transport));
- if (h->jtag_api == STLINK_JTAG_API_V2)
- return stlink_usb_v2_get_status(handle);
+ if (res != ERROR_OK)
+ return TARGET_UNKNOWN;
+
+ h->reconnect_pending = false;
+ }
+
+ if (h->jtag_api == STLINK_JTAG_API_V2) {
+ res = stlink_usb_v2_get_status(handle);
+ if (res == TARGET_UNKNOWN)
+ h->reconnect_pending = true;
+ 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_GETSTATUS;
if (h->databuf[0] == STLINK_CORE_HALTED)
return TARGET_HALTED;
+ h->reconnect_pending = true;
+
return TARGET_UNKNOWN;
}
/** */
static int stlink_usb_reset(void *handle)
{
- int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)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;
else
h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_RESETSYS;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- 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;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
static int stlink_usb_assert_srst(void *handle, int srst)
{
- int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
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;
h->cmdbuf[h->cmdidx++] = srst;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
/** */
{
int res;
uint32_t reg;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
/* configure the TPI */
/* enable the trace subsystem */
static void stlink_usb_trace_disable(void *handle)
{
int res = ERROR_OK;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
assert(h->version.jtag >= STLINK_TRACE_MIN_VERSION);
- LOG_DEBUG("Tracing: disable\n");
+ LOG_DEBUG("Tracing: disable");
- 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);
+ }
}
static int stlink_usb_trace_enable(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
if (h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
uint32_t trace_hz;
res = stlink_configure_target_trace_port(handle);
if (res != ERROR_OK)
- LOG_ERROR("Unable to configure tracing on target\n");
+ LOG_ERROR("Unable to configure tracing on target");
trace_hz = h->trace.prescale > 0 ?
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;
if (res == ERROR_OK) {
h->trace.enabled = true;
- LOG_DEBUG("Tracing: recording at %uHz\n", trace_hz);
+ LOG_DEBUG("Tracing: recording at %" PRIu32 "Hz", 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.");
static int stlink_usb_run(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
if (h->jtag_api == STLINK_JTAG_API_V2) {
res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
/* Try to start tracing, if requested */
- if (res == ERROR_OK && h->trace.output_f) {
+ if (res == ERROR_OK && h->trace.source_hz && !h->trace.enabled) {
if (stlink_usb_trace_enable(handle) == ERROR_OK)
- LOG_DEBUG("Tracing: enabled\n");
+ LOG_DEBUG("Tracing: enabled");
else
- LOG_ERROR("Tracing: enable failed\n");
+ LOG_ERROR("Tracing: enable failed");
}
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;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
/** */
static int stlink_usb_halt(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
if (h->jtag_api == STLINK_JTAG_API_V2) {
res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
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;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
/** */
static int stlink_usb_step(void *handle)
{
- int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
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. */
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;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
/** */
static int stlink_usb_read_regs(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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)
static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)handle;
-
- 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)
h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
h->cmdbuf[h->cmdidx++] = num;
- res = stlink_usb_xfer(handle, h->databuf, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
-
- if (res != ERROR_OK)
- return res;
-
- if (h->jtag_api == STLINK_JTAG_API_V1)
+ if (h->jtag_api == STLINK_JTAG_API_V1) {
+ res = stlink_usb_xfer(handle, h->databuf, 4);
+ if (res != ERROR_OK)
+ return res;
*val = le_to_h_u32(h->databuf);
- else {
+ return ERROR_OK;
+ } else {
+ res = stlink_cmd_allow_retry(handle, h->databuf, 8);
+ if (res != ERROR_OK)
+ return res;
*val = le_to_h_u32(h->databuf + 4);
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return ERROR_OK;
}
-
- return ERROR_OK;
}
/** */
static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
{
- int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)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;
if (h->jtag_api == STLINK_JTAG_API_V1)
h_u32_to_le(h->cmdbuf+h->cmdidx, val);
h->cmdidx += 4;
- res = stlink_usb_xfer(handle, h->databuf, 2);
-
- if (res != ERROR_OK)
- return res;
-
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
+ return stlink_cmd_allow_retry(handle, h->databuf, 2);
}
static int stlink_usb_get_rw_status(void *handle)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
- h = (struct stlink_usb_handle_s *)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;
if (res != ERROR_OK)
return res;
- return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : res;
+ return stlink_usb_error_check(h);
}
/** */
{
int res;
uint16_t read_len = len;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
return ERROR_FAIL;
}
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
const uint8_t *buffer)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
return ERROR_FAIL;
}
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
uint8_t *buffer)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
return ERROR_TARGET_UNALIGNED_ACCESS;
}
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
const uint8_t *buffer)
{
int res;
- struct stlink_usb_handle_s *h;
+ struct stlink_usb_handle_s *h = handle;
assert(handle != NULL);
return ERROR_TARGET_UNALIGNED_ACCESS;
}
- h = (struct stlink_usb_handle_s *)handle;
-
- 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;
{
int retval = ERROR_OK;
uint32_t bytes_remaining;
- struct stlink_usb_handle_s *h = (struct stlink_usb_handle_s *)handle;
+ int retries = 0;
+ struct stlink_usb_handle_s *h = handle;
/* calculate byte count */
count *= size;
uint32_t head_bytes = 4 - (addr % 4);
retval = stlink_usb_read_mem8(handle, addr, head_bytes, buffer);
+ if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
+ usleep((1<<retries++) * 1000);
+ continue;
+ }
if (retval != ERROR_OK)
return retval;
buffer += head_bytes;
} else
retval = stlink_usb_read_mem8(handle, addr, bytes_remaining, buffer);
+ if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
+ usleep((1<<retries++) * 1000);
+ continue;
+ }
if (retval != ERROR_OK)
return retval;
{
int retval = ERROR_OK;
uint32_t bytes_remaining;
- struct stlink_usb_handle_s *h = (struct stlink_usb_handle_s *)handle;
+ int retries = 0;
+ struct stlink_usb_handle_s *h = handle;
/* calculate byte count */
count *= size;
uint32_t head_bytes = 4 - (addr % 4);
retval = stlink_usb_write_mem8(handle, addr, head_bytes, buffer);
+ if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
+ usleep((1<<retries++) * 1000);
+ continue;
+ }
if (retval != ERROR_OK)
return retval;
buffer += head_bytes;
} else
retval = stlink_usb_write_mem8(handle, addr, bytes_remaining, buffer);
+ if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
+ usleep((1<<retries++) * 1000);
+ continue;
+ }
if (retval != ERROR_OK)
return retval;
}
/** */
-static int stlink_usb_close(void *fd)
+static int stlink_usb_override_target(const char *targetname)
{
- struct stlink_usb_handle_s *h;
+ return !strcmp(targetname, "cortex_m");
+}
- h = (struct stlink_usb_handle_s *)fd;
+/** */
+static int stlink_usb_close(void *fd)
+{
+ struct stlink_usb_handle_s *h = fd;
if (h->fd)
jtag_libusb_close(h->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 */
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;
- if (h->jtag_api >= 2 && param->trace_f && param->trace_source_hz > 0) {
+ if (h->jtag_api >= 2 && param->trace_source_hz > 0) {
uint32_t prescale;
prescale = param->trace_source_hz > STLINK_TRACE_MAX_HZ ?
/** */
.write_mem = stlink_usb_write_mem,
/** */
- .write_debug_reg = stlink_usb_write_debug_reg
+ .write_debug_reg = stlink_usb_write_debug_reg,
+ /** */
+ .override_target = stlink_usb_override_target,
};
Code Review / openocd.git / blobdiff