1 /***************************************************************************
2 * SWIM contributions by Ake Rehnman *
3 * Copyright (C) 2017 Ake Rehnman *
4 * ake.rehnman(at)gmail.com *
6 * Copyright (C) 2011-2012 by Mathias Kuester *
7 * Mathias Kuester <kesmtp@freenet.de> *
9 * Copyright (C) 2012 by Spencer Oliver *
10 * spen@spen-soft.co.uk *
12 * This code is based on https://github.com/texane/stlink *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
26 ***************************************************************************/
32 /* project specific includes */
33 #include <helper/binarybuffer.h>
34 #include <helper/bits.h>
35 #include <jtag/interface.h>
36 #include <jtag/hla/hla_layout.h>
37 #include <jtag/hla/hla_transport.h>
38 #include <jtag/hla/hla_interface.h>
39 #include <jtag/swim.h>
40 #include <target/target.h>
41 #include <transport/transport.h>
43 #include <target/cortex_m.h>
45 #include "libusb_helper.h"
48 #define USE_LIBUSB_ASYNCIO
51 #define STLINK_SERIAL_LEN 24
53 #define ENDPOINT_IN 0x80
54 #define ENDPOINT_OUT 0x00
56 #define STLINK_WRITE_TIMEOUT 1000
57 #define STLINK_READ_TIMEOUT 1000
59 #define STLINK_RX_EP (1|ENDPOINT_IN)
60 #define STLINK_TX_EP (2|ENDPOINT_OUT)
61 #define STLINK_TRACE_EP (3|ENDPOINT_IN)
63 #define STLINK_V2_1_TX_EP (1|ENDPOINT_OUT)
64 #define STLINK_V2_1_TRACE_EP (2|ENDPOINT_IN)
66 #define STLINK_SG_SIZE (31)
67 #define STLINK_DATA_SIZE (4096)
68 #define STLINK_CMD_SIZE_V2 (16)
69 #define STLINK_CMD_SIZE_V1 (10)
71 #define STLINK_V1_PID (0x3744)
72 #define STLINK_V2_PID (0x3748)
73 #define STLINK_V2_1_PID (0x374B)
74 #define STLINK_V2_1_NO_MSD_PID (0x3752)
75 #define STLINK_V3_USBLOADER_PID (0x374D)
76 #define STLINK_V3E_PID (0x374E)
77 #define STLINK_V3S_PID (0x374F)
78 #define STLINK_V3_2VCP_PID (0x3753)
81 * ST-Link/V1, ST-Link/V2 and ST-Link/V2.1 are full-speed USB devices and
82 * this limits the bulk packet size and the 8bit read/writes to max 64 bytes.
83 * STLINK-V3 is a high speed USB 2.0 and the limit is 512 bytes from FW V3J6.
85 #define STLINK_MAX_RW8 (64)
86 #define STLINKV3_MAX_RW8 (512)
88 /* "WAIT" responses will be retried (with exponential backoff) at
89 * most this many times before failing to caller.
91 #define MAX_WAIT_RETRIES 8
93 enum stlink_jtag_api_version {
94 STLINK_JTAG_API_V1 = 1,
100 STLINK_MODE_UNKNOWN = 0,
103 STLINK_MODE_DEBUG_JTAG,
104 STLINK_MODE_DEBUG_SWD,
105 STLINK_MODE_DEBUG_SWIM
109 struct stlink_usb_version {
116 /** jtag api version supported */
117 enum stlink_jtag_api_version jtag_api;
118 /** one bit for each feature supported. See macros STLINK_F_* */
123 struct stlink_usb_handle_s {
125 struct libusb_device_handle *fd;
127 struct libusb_transfer *trans;
135 uint8_t cmdbuf[STLINK_SG_SIZE];
141 uint8_t databuf[STLINK_DATA_SIZE];
143 uint32_t max_mem_packet;
145 enum stlink_mode st_mode;
147 struct stlink_usb_version version;
154 /** whether SWO tracing is enabled or not */
156 /** trace module source clock */
159 /** reconnect is needed next time we try to query the
161 bool reconnect_pending;
164 #define STLINK_SWIM_ERR_OK 0x00
165 #define STLINK_SWIM_BUSY 0x01
166 #define STLINK_DEBUG_ERR_OK 0x80
167 #define STLINK_DEBUG_ERR_FAULT 0x81
168 #define STLINK_SWD_AP_WAIT 0x10
169 #define STLINK_SWD_AP_FAULT 0x11
170 #define STLINK_SWD_AP_ERROR 0x12
171 #define STLINK_SWD_AP_PARITY_ERROR 0x13
172 #define STLINK_JTAG_GET_IDCODE_ERROR 0x09
173 #define STLINK_JTAG_WRITE_ERROR 0x0c
174 #define STLINK_JTAG_WRITE_VERIF_ERROR 0x0d
175 #define STLINK_SWD_DP_WAIT 0x14
176 #define STLINK_SWD_DP_FAULT 0x15
177 #define STLINK_SWD_DP_ERROR 0x16
178 #define STLINK_SWD_DP_PARITY_ERROR 0x17
180 #define STLINK_SWD_AP_WDATA_ERROR 0x18
181 #define STLINK_SWD_AP_STICKY_ERROR 0x19
182 #define STLINK_SWD_AP_STICKYORUN_ERROR 0x1a
184 #define STLINK_BAD_AP_ERROR 0x1d
186 #define STLINK_CORE_RUNNING 0x80
187 #define STLINK_CORE_HALTED 0x81
188 #define STLINK_CORE_STAT_UNKNOWN -1
190 #define STLINK_GET_VERSION 0xF1
191 #define STLINK_DEBUG_COMMAND 0xF2
192 #define STLINK_DFU_COMMAND 0xF3
193 #define STLINK_SWIM_COMMAND 0xF4
194 #define STLINK_GET_CURRENT_MODE 0xF5
195 #define STLINK_GET_TARGET_VOLTAGE 0xF7
197 #define STLINK_DEV_DFU_MODE 0x00
198 #define STLINK_DEV_MASS_MODE 0x01
199 #define STLINK_DEV_DEBUG_MODE 0x02
200 #define STLINK_DEV_SWIM_MODE 0x03
201 #define STLINK_DEV_BOOTLOADER_MODE 0x04
202 #define STLINK_DEV_UNKNOWN_MODE -1
204 #define STLINK_DFU_EXIT 0x07
207 STLINK_SWIM_ENTER_SEQ
208 1.3ms low then 750Hz then 1.5kHz
211 STM8 DM pulls reset pin low 50us
214 uint8_t (0=low|1=high)
221 send syncronization seq (16us low, response 64 clocks low)
223 #define STLINK_SWIM_ENTER 0x00
224 #define STLINK_SWIM_EXIT 0x01
225 #define STLINK_SWIM_READ_CAP 0x02
226 #define STLINK_SWIM_SPEED 0x03
227 #define STLINK_SWIM_ENTER_SEQ 0x04
228 #define STLINK_SWIM_GEN_RST 0x05
229 #define STLINK_SWIM_RESET 0x06
230 #define STLINK_SWIM_ASSERT_RESET 0x07
231 #define STLINK_SWIM_DEASSERT_RESET 0x08
232 #define STLINK_SWIM_READSTATUS 0x09
233 #define STLINK_SWIM_WRITEMEM 0x0a
234 #define STLINK_SWIM_READMEM 0x0b
235 #define STLINK_SWIM_READBUF 0x0c
237 #define STLINK_DEBUG_GETSTATUS 0x01
238 #define STLINK_DEBUG_FORCEDEBUG 0x02
239 #define STLINK_DEBUG_APIV1_RESETSYS 0x03
240 #define STLINK_DEBUG_APIV1_READALLREGS 0x04
241 #define STLINK_DEBUG_APIV1_READREG 0x05
242 #define STLINK_DEBUG_APIV1_WRITEREG 0x06
243 #define STLINK_DEBUG_READMEM_32BIT 0x07
244 #define STLINK_DEBUG_WRITEMEM_32BIT 0x08
245 #define STLINK_DEBUG_RUNCORE 0x09
246 #define STLINK_DEBUG_STEPCORE 0x0a
247 #define STLINK_DEBUG_APIV1_SETFP 0x0b
248 #define STLINK_DEBUG_READMEM_8BIT 0x0c
249 #define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
250 #define STLINK_DEBUG_APIV1_CLEARFP 0x0e
251 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG 0x0f
252 #define STLINK_DEBUG_APIV1_SETWATCHPOINT 0x10
254 #define STLINK_DEBUG_ENTER_JTAG_RESET 0x00
255 #define STLINK_DEBUG_ENTER_SWD_NO_RESET 0xa3
256 #define STLINK_DEBUG_ENTER_JTAG_NO_RESET 0xa4
258 #define STLINK_DEBUG_APIV1_ENTER 0x20
259 #define STLINK_DEBUG_EXIT 0x21
260 #define STLINK_DEBUG_READCOREID 0x22
262 #define STLINK_DEBUG_APIV2_ENTER 0x30
263 #define STLINK_DEBUG_APIV2_READ_IDCODES 0x31
264 #define STLINK_DEBUG_APIV2_RESETSYS 0x32
265 #define STLINK_DEBUG_APIV2_READREG 0x33
266 #define STLINK_DEBUG_APIV2_WRITEREG 0x34
267 #define STLINK_DEBUG_APIV2_WRITEDEBUGREG 0x35
268 #define STLINK_DEBUG_APIV2_READDEBUGREG 0x36
270 #define STLINK_DEBUG_APIV2_READALLREGS 0x3A
271 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
272 #define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
274 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS2 0x3E
276 #define STLINK_DEBUG_APIV2_START_TRACE_RX 0x40
277 #define STLINK_DEBUG_APIV2_STOP_TRACE_RX 0x41
278 #define STLINK_DEBUG_APIV2_GET_TRACE_NB 0x42
279 #define STLINK_DEBUG_APIV2_SWD_SET_FREQ 0x43
280 #define STLINK_DEBUG_APIV2_JTAG_SET_FREQ 0x44
281 #define STLINK_DEBUG_APIV2_READ_DAP_REG 0x45
282 #define STLINK_DEBUG_APIV2_WRITE_DAP_REG 0x46
283 #define STLINK_DEBUG_APIV2_READMEM_16BIT 0x47
284 #define STLINK_DEBUG_APIV2_WRITEMEM_16BIT 0x48
286 #define STLINK_DEBUG_APIV2_INIT_AP 0x4B
287 #define STLINK_DEBUG_APIV2_CLOSE_AP_DBG 0x4C
289 #define STLINK_APIV3_SET_COM_FREQ 0x61
290 #define STLINK_APIV3_GET_COM_FREQ 0x62
292 #define STLINK_APIV3_GET_VERSION_EX 0xFB
294 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
295 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
296 #define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
298 #define STLINK_DEBUG_PORT_ACCESS 0xffff
300 #define STLINK_TRACE_SIZE 4096
301 #define STLINK_TRACE_MAX_HZ 2000000
303 #define STLINK_V3_MAX_FREQ_NB 10
305 #define REQUEST_SENSE 0x03
306 #define REQUEST_SENSE_LENGTH 18
309 * Map the relevant features, quirks and workaround for specific firmware
312 #define STLINK_F_HAS_TRACE BIT(0)
313 #define STLINK_F_HAS_SWD_SET_FREQ BIT(1)
314 #define STLINK_F_HAS_JTAG_SET_FREQ BIT(2)
315 #define STLINK_F_HAS_MEM_16BIT BIT(3)
316 #define STLINK_F_HAS_GETLASTRWSTATUS2 BIT(4)
317 #define STLINK_F_HAS_DAP_REG BIT(5)
318 #define STLINK_F_QUIRK_JTAG_DP_READ BIT(6)
319 #define STLINK_F_HAS_AP_INIT BIT(7)
320 #define STLINK_F_HAS_DPBANKSEL BIT(8)
321 #define STLINK_F_HAS_RW8_512BYTES BIT(9)
324 #define STLINK_F_HAS_TARGET_VOLT STLINK_F_HAS_TRACE
331 /* SWD clock speed */
332 static const struct speed_map stlink_khz_to_speed_map_swd[] = {
334 {1800, 1}, /* default */
347 /* JTAG clock speed */
348 static const struct speed_map stlink_khz_to_speed_map_jtag[] = {
352 {1125, 32}, /* default */
358 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
359 static int stlink_swim_status(void *handle);
360 void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size);
361 static int stlink_get_com_freq(void *handle, bool is_jtag, struct speed_map *map);
362 static int stlink_speed(void *handle, int khz, bool query);
365 static unsigned int stlink_usb_block(void *handle)
367 struct stlink_usb_handle_s *h = handle;
369 assert(handle != NULL);
371 if (h->version.flags & STLINK_F_HAS_RW8_512BYTES)
372 return STLINKV3_MAX_RW8;
374 return STLINK_MAX_RW8;
379 #ifdef USE_LIBUSB_ASYNCIO
381 static LIBUSB_CALL void sync_transfer_cb(struct libusb_transfer *transfer)
383 int *completed = transfer->user_data;
385 /* caller interprets result and frees transfer */
389 static void sync_transfer_wait_for_completion(struct libusb_transfer *transfer)
391 int r, *completed = transfer->user_data;
393 /* Assuming a single libusb context exists. There no existing interface into this
394 * module to pass a libusb context.
396 struct libusb_context *ctx = NULL;
398 while (!*completed) {
399 r = libusb_handle_events_completed(ctx, completed);
401 if (r == LIBUSB_ERROR_INTERRUPTED)
403 libusb_cancel_transfer(transfer);
410 static int transfer_error_status(const struct libusb_transfer *transfer)
414 switch (transfer->status) {
415 case LIBUSB_TRANSFER_COMPLETED:
418 case LIBUSB_TRANSFER_TIMED_OUT:
419 r = LIBUSB_ERROR_TIMEOUT;
421 case LIBUSB_TRANSFER_STALL:
422 r = LIBUSB_ERROR_PIPE;
424 case LIBUSB_TRANSFER_OVERFLOW:
425 r = LIBUSB_ERROR_OVERFLOW;
427 case LIBUSB_TRANSFER_NO_DEVICE:
428 r = LIBUSB_ERROR_NO_DEVICE;
430 case LIBUSB_TRANSFER_ERROR:
431 case LIBUSB_TRANSFER_CANCELLED:
435 r = LIBUSB_ERROR_OTHER;
449 size_t transfer_size;
450 struct libusb_transfer *transfer;
453 static int jtag_libusb_bulk_transfer_n(
454 struct libusb_device_handle *dev_handle,
455 struct jtag_xfer *transfers,
460 int returnval = ERROR_OK;
463 for (size_t i = 0; i < n_transfers; ++i) {
464 transfers[i].retval = 0;
465 transfers[i].completed = 0;
466 transfers[i].transfer_size = 0;
467 transfers[i].transfer = libusb_alloc_transfer(0);
469 if (transfers[i].transfer == NULL) {
470 for (size_t j = 0; j < i; ++j)
471 libusb_free_transfer(transfers[j].transfer);
473 LOG_DEBUG("ERROR, failed to alloc usb transfers");
474 for (size_t k = 0; k < n_transfers; ++k)
475 transfers[k].retval = LIBUSB_ERROR_NO_MEM;
480 for (size_t i = 0; i < n_transfers; ++i) {
481 libusb_fill_bulk_transfer(
482 transfers[i].transfer,
484 transfers[i].ep, transfers[i].buf, transfers[i].size,
485 sync_transfer_cb, &transfers[i].completed, timeout);
486 transfers[i].transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
488 retval = libusb_submit_transfer(transfers[i].transfer);
490 LOG_DEBUG("ERROR, failed to submit transfer %zu, error %d", i, retval);
492 /* Probably no point continuing to submit transfers once a submission fails.
493 * As a result, tag all remaining transfers as errors.
495 for (size_t j = i; j < n_transfers; ++j)
496 transfers[j].retval = retval;
498 returnval = ERROR_FAIL;
503 /* Wait for every submitted USB transfer to complete.
505 for (size_t i = 0; i < n_transfers; ++i) {
506 if (transfers[i].retval == 0) {
507 sync_transfer_wait_for_completion(transfers[i].transfer);
509 retval = transfer_error_status(transfers[i].transfer);
511 returnval = ERROR_FAIL;
512 transfers[i].retval = retval;
513 LOG_DEBUG("ERROR, transfer %zu failed, error %d", i, retval);
515 /* Assuming actual_length is only valid if there is no transfer error.
517 transfers[i].transfer_size = transfers[i].transfer->actual_length;
521 libusb_free_transfer(transfers[i].transfer);
522 transfers[i].transfer = NULL;
532 static int stlink_usb_xfer_v1_get_status(void *handle)
534 struct stlink_usb_handle_s *h = handle;
537 assert(handle != NULL);
540 memset(h->cmdbuf, 0, STLINK_SG_SIZE);
542 ret = jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)h->cmdbuf, 13,
543 STLINK_READ_TIMEOUT, &tr);
549 t1 = buf_get_u32(h->cmdbuf, 0, 32);
552 if (t1 != 0x53425355)
560 if (h->cmdbuf[12] != 0)
566 #ifdef USE_LIBUSB_ASYNCIO
567 static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
569 struct stlink_usb_handle_s *h = handle;
571 assert(handle != NULL);
573 size_t n_transfers = 0;
574 struct jtag_xfer transfers[2];
576 memset(transfers, 0, sizeof(transfers));
578 transfers[0].ep = h->tx_ep;
579 transfers[0].buf = h->cmdbuf;
580 transfers[0].size = cmdsize;
584 if (h->direction == h->tx_ep && size) {
585 transfers[1].ep = h->tx_ep;
586 transfers[1].buf = (uint8_t *)buf;
587 transfers[1].size = size;
590 } else if (h->direction == h->rx_ep && size) {
591 transfers[1].ep = h->rx_ep;
592 transfers[1].buf = (uint8_t *)buf;
593 transfers[1].size = size;
598 return jtag_libusb_bulk_transfer_n(
602 STLINK_WRITE_TIMEOUT);
605 static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
607 struct stlink_usb_handle_s *h = handle;
610 assert(handle != NULL);
612 ret = jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)h->cmdbuf,
613 cmdsize, STLINK_WRITE_TIMEOUT, &tr);
614 if (ret || tr != cmdsize)
617 if (h->direction == h->tx_ep && size) {
618 ret = jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)buf,
619 size, STLINK_WRITE_TIMEOUT, &tr);
620 if (ret || tr != size) {
621 LOG_DEBUG("bulk write failed");
624 } else if (h->direction == h->rx_ep && size) {
625 ret = jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)buf,
626 size, STLINK_READ_TIMEOUT, &tr);
627 if (ret || tr != size) {
628 LOG_DEBUG("bulk read failed");
638 static int stlink_usb_xfer_v1_get_sense(void *handle)
641 struct stlink_usb_handle_s *h = handle;
643 assert(handle != NULL);
645 stlink_usb_init_buffer(handle, h->rx_ep, 16);
647 h->cmdbuf[h->cmdidx++] = REQUEST_SENSE;
648 h->cmdbuf[h->cmdidx++] = 0;
649 h->cmdbuf[h->cmdidx++] = 0;
650 h->cmdbuf[h->cmdidx++] = 0;
651 h->cmdbuf[h->cmdidx++] = REQUEST_SENSE_LENGTH;
653 res = stlink_usb_xfer_rw(handle, REQUEST_SENSE_LENGTH, h->databuf, 16);
658 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK)
665 transfers block in cmdbuf
666 <size> indicates number of bytes in the following
668 Ignore the (eventual) error code in the received packet.
670 static int stlink_usb_xfer_noerrcheck(void *handle, const uint8_t *buf, int size)
672 int err, cmdsize = STLINK_CMD_SIZE_V2;
673 struct stlink_usb_handle_s *h = handle;
675 assert(handle != NULL);
677 if (h->version.stlink == 1) {
678 cmdsize = STLINK_SG_SIZE;
679 /* put length in bCBWCBLength */
680 h->cmdbuf[14] = h->cmdidx-15;
683 err = stlink_usb_xfer_rw(handle, cmdsize, buf, size);
688 if (h->version.stlink == 1) {
689 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK) {
690 /* check csw status */
691 if (h->cmdbuf[12] == 1) {
692 LOG_DEBUG("get sense");
693 if (stlink_usb_xfer_v1_get_sense(handle) != ERROR_OK)
704 Converts an STLINK status code held in the first byte of a response
705 to an openocd error, logs any error/wait status as debug output.
707 static int stlink_usb_error_check(void *handle)
709 struct stlink_usb_handle_s *h = handle;
711 assert(handle != NULL);
713 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
714 switch (h->databuf[0]) {
715 case STLINK_SWIM_ERR_OK:
717 case STLINK_SWIM_BUSY:
720 LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h->databuf[0]);
725 /* TODO: no error checking yet on api V1 */
726 if (h->version.jtag_api == STLINK_JTAG_API_V1)
727 h->databuf[0] = STLINK_DEBUG_ERR_OK;
729 switch (h->databuf[0]) {
730 case STLINK_DEBUG_ERR_OK:
732 case STLINK_DEBUG_ERR_FAULT:
733 LOG_DEBUG("SWD fault response (0x%x)", STLINK_DEBUG_ERR_FAULT);
735 case STLINK_SWD_AP_WAIT:
736 LOG_DEBUG("wait status SWD_AP_WAIT (0x%x)", STLINK_SWD_AP_WAIT);
738 case STLINK_SWD_DP_WAIT:
739 LOG_DEBUG("wait status SWD_DP_WAIT (0x%x)", STLINK_SWD_DP_WAIT);
741 case STLINK_JTAG_GET_IDCODE_ERROR:
742 LOG_DEBUG("STLINK_JTAG_GET_IDCODE_ERROR");
744 case STLINK_JTAG_WRITE_ERROR:
745 LOG_DEBUG("Write error");
747 case STLINK_JTAG_WRITE_VERIF_ERROR:
748 LOG_DEBUG("Write verify error, ignoring");
750 case STLINK_SWD_AP_FAULT:
751 /* git://git.ac6.fr/openocd commit 657e3e885b9ee10
752 * returns ERROR_OK with the comment:
753 * Change in error status when reading outside RAM.
754 * This fix allows CDT plugin to visualize memory.
756 LOG_DEBUG("STLINK_SWD_AP_FAULT");
758 case STLINK_SWD_AP_ERROR:
759 LOG_DEBUG("STLINK_SWD_AP_ERROR");
761 case STLINK_SWD_AP_PARITY_ERROR:
762 LOG_DEBUG("STLINK_SWD_AP_PARITY_ERROR");
764 case STLINK_SWD_DP_FAULT:
765 LOG_DEBUG("STLINK_SWD_DP_FAULT");
767 case STLINK_SWD_DP_ERROR:
768 LOG_DEBUG("STLINK_SWD_DP_ERROR");
770 case STLINK_SWD_DP_PARITY_ERROR:
771 LOG_DEBUG("STLINK_SWD_DP_PARITY_ERROR");
773 case STLINK_SWD_AP_WDATA_ERROR:
774 LOG_DEBUG("STLINK_SWD_AP_WDATA_ERROR");
776 case STLINK_SWD_AP_STICKY_ERROR:
777 LOG_DEBUG("STLINK_SWD_AP_STICKY_ERROR");
779 case STLINK_SWD_AP_STICKYORUN_ERROR:
780 LOG_DEBUG("STLINK_SWD_AP_STICKYORUN_ERROR");
782 case STLINK_BAD_AP_ERROR:
783 LOG_DEBUG("STLINK_BAD_AP_ERROR");
786 LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h->databuf[0]);
792 * Wrapper around stlink_usb_xfer_noerrcheck()
793 * to check the error code in the received packet
795 static int stlink_usb_xfer_errcheck(void *handle, const uint8_t *buf, int size)
801 retval = stlink_usb_xfer_noerrcheck(handle, buf, size);
802 if (retval != ERROR_OK)
805 return stlink_usb_error_check(handle);
808 /** Issue an STLINK command via USB transfer, with retries on any wait status responses.
810 Works for commands where the STLINK_DEBUG status is returned in the first
811 byte of the response packet. For SWIM a SWIM_READSTATUS is requested instead.
813 Returns an openocd result code.
815 static int stlink_cmd_allow_retry(void *handle, const uint8_t *buf, int size)
819 struct stlink_usb_handle_s *h = handle;
822 if ((h->st_mode != STLINK_MODE_DEBUG_SWIM) || !retries) {
823 res = stlink_usb_xfer_noerrcheck(handle, buf, size);
828 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
829 res = stlink_swim_status(handle);
834 res = stlink_usb_error_check(handle);
835 if (res == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
836 unsigned int delay_us = (1<<retries++) * 1000;
837 LOG_DEBUG("stlink_cmd_allow_retry ERROR_WAIT, retry %d, delaying %u microseconds", retries, delay_us);
846 static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
848 struct stlink_usb_handle_s *h = handle;
851 assert(handle != NULL);
853 assert(h->version.flags & STLINK_F_HAS_TRACE);
855 ret = jtag_libusb_bulk_read(h->fd, h->trace_ep, (char *)buf, size,
856 STLINK_READ_TIMEOUT, &tr);
857 if (ret || tr != size) {
858 LOG_ERROR("bulk trace read failed");
866 this function writes transfer length in
867 the right place in the cb
869 static void stlink_usb_set_cbw_transfer_datalength(void *handle, uint32_t size)
871 struct stlink_usb_handle_s *h = handle;
873 buf_set_u32(h->cmdbuf+8, 0, 32, size);
876 static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint32_t size)
878 struct stlink_usb_handle_s *h = handle;
880 /* fill the send buffer */
881 strcpy((char *)h->cmdbuf, "USBC");
883 /* csw tag not used */
884 buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, 0);
886 /* cbw data transfer length (in the following data phase in or out) */
887 buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, size);
890 h->cmdbuf[h->cmdidx++] = (direction == h->rx_ep ? ENDPOINT_IN : ENDPOINT_OUT);
891 h->cmdbuf[h->cmdidx++] = 0; /* lun */
892 /* cdb clength (is filled in at xfer) */
893 h->cmdbuf[h->cmdidx++] = 0;
897 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size)
899 struct stlink_usb_handle_s *h = handle;
901 h->direction = direction;
905 memset(h->cmdbuf, 0, STLINK_SG_SIZE);
906 memset(h->databuf, 0, STLINK_DATA_SIZE);
908 if (h->version.stlink == 1)
909 stlink_usb_xfer_v1_create_cmd(handle, direction, size);
913 static int stlink_usb_version(void *handle)
918 uint8_t v, x, y, jtag, swim, msd, bridge = 0;
919 char v_str[5 * (1 + 3) + 1]; /* VvJjMmBbSs */
921 struct stlink_usb_handle_s *h = handle;
923 assert(handle != NULL);
925 stlink_usb_init_buffer(handle, h->rx_ep, 6);
927 h->cmdbuf[h->cmdidx++] = STLINK_GET_VERSION;
929 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 6);
934 version = be_to_h_u16(h->databuf);
935 v = (version >> 12) & 0x0f;
936 x = (version >> 6) & 0x3f;
939 h->vid = le_to_h_u16(h->databuf + 2);
940 h->pid = le_to_h_u16(h->databuf + 4);
943 case STLINK_V2_1_PID:
944 case STLINK_V2_1_NO_MSD_PID:
945 if ((x <= 22 && y == 7) || (x >= 25 && y >= 7 && y <= 12)) {
946 /* MxSy : STM8 V2.1 - SWIM only */
951 /* JxMy : STM32 V2.1 - JTAG/SWD only */
964 /* STLINK-V3 requires a specific command */
965 if (v == 3 && x == 0 && y == 0) {
966 stlink_usb_init_buffer(handle, h->rx_ep, 16);
968 h->cmdbuf[h->cmdidx++] = STLINK_APIV3_GET_VERSION_EX;
970 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 12);
975 swim = h->databuf[1];
976 jtag = h->databuf[2];
978 bridge = h->databuf[4];
979 h->vid = le_to_h_u16(h->databuf + 8);
980 h->pid = le_to_h_u16(h->databuf + 10);
983 h->version.stlink = v;
984 h->version.jtag = jtag;
985 h->version.swim = swim;
988 switch (h->version.stlink) {
990 /* ST-LINK/V1 from J11 switch to api-v2 (and support SWD) */
991 if (h->version.jtag >= 11)
992 h->version.jtag_api = STLINK_JTAG_API_V2;
994 h->version.jtag_api = STLINK_JTAG_API_V1;
998 /* all ST-LINK/V2 and ST-Link/V2.1 use api-v2 */
999 h->version.jtag_api = STLINK_JTAG_API_V2;
1001 /* API for trace from J13 */
1002 /* API for target voltage from J13 */
1003 if (h->version.jtag >= 13)
1004 flags |= STLINK_F_HAS_TRACE;
1006 /* preferred API to get last R/W status from J15 */
1007 if (h->version.jtag >= 15)
1008 flags |= STLINK_F_HAS_GETLASTRWSTATUS2;
1010 /* API to set SWD frequency from J22 */
1011 if (h->version.jtag >= 22)
1012 flags |= STLINK_F_HAS_SWD_SET_FREQ;
1014 /* API to set JTAG frequency from J24 */
1015 /* API to access DAP registers from J24 */
1016 if (h->version.jtag >= 24) {
1017 flags |= STLINK_F_HAS_JTAG_SET_FREQ;
1018 flags |= STLINK_F_HAS_DAP_REG;
1021 /* Quirk for read DP in JTAG mode (V2 only) from J24, fixed in J32 */
1022 if (h->version.jtag >= 24 && h->version.jtag < 32)
1023 flags |= STLINK_F_QUIRK_JTAG_DP_READ;
1025 /* API to read/write memory at 16 bit from J26 */
1026 if (h->version.jtag >= 26)
1027 flags |= STLINK_F_HAS_MEM_16BIT;
1029 /* API required to init AP before any AP access from J28 */
1030 if (h->version.jtag >= 28)
1031 flags |= STLINK_F_HAS_AP_INIT;
1033 /* Banked regs (DPv1 & DPv2) support from V2J32 */
1034 if (h->version.jtag >= 32)
1035 flags |= STLINK_F_HAS_DPBANKSEL;
1039 /* all STLINK-V3 use api-v3 */
1040 h->version.jtag_api = STLINK_JTAG_API_V3;
1042 /* STLINK-V3 is a superset of ST-LINK/V2 */
1045 /* API for target voltage */
1046 flags |= STLINK_F_HAS_TRACE;
1048 /* preferred API to get last R/W status */
1049 flags |= STLINK_F_HAS_GETLASTRWSTATUS2;
1051 /* API to access DAP registers */
1052 flags |= STLINK_F_HAS_DAP_REG;
1054 /* API to read/write memory at 16 bit */
1055 flags |= STLINK_F_HAS_MEM_16BIT;
1057 /* API required to init AP before any AP access */
1058 flags |= STLINK_F_HAS_AP_INIT;
1060 /* Banked regs (DPv1 & DPv2) support from V3J2 */
1061 if (h->version.jtag >= 2)
1062 flags |= STLINK_F_HAS_DPBANKSEL;
1064 /* 8bit read/write max packet size 512 bytes from V3J6 */
1065 if (h->version.jtag >= 6)
1066 flags |= STLINK_F_HAS_RW8_512BYTES;
1072 h->version.flags = flags;
1075 p += sprintf(p, "V%d", v);
1077 p += sprintf(p, "J%d", jtag);
1079 p += sprintf(p, "M%d", msd);
1081 p += sprintf(p, "B%d", bridge);
1083 sprintf(p, "S%d", swim);
1085 LOG_INFO("STLINK %s (API v%d) VID:PID %04X:%04X",
1087 h->version.jtag_api,
1094 static int stlink_usb_check_voltage(void *handle, float *target_voltage)
1096 struct stlink_usb_handle_s *h = handle;
1097 uint32_t adc_results[2];
1099 /* no error message, simply quit with error */
1100 if (!(h->version.flags & STLINK_F_HAS_TARGET_VOLT))
1101 return ERROR_COMMAND_NOTFOUND;
1103 stlink_usb_init_buffer(handle, h->rx_ep, 8);
1105 h->cmdbuf[h->cmdidx++] = STLINK_GET_TARGET_VOLTAGE;
1107 int result = stlink_usb_xfer_noerrcheck(handle, h->databuf, 8);
1109 if (result != ERROR_OK)
1112 /* convert result */
1113 adc_results[0] = le_to_h_u32(h->databuf);
1114 adc_results[1] = le_to_h_u32(h->databuf + 4);
1116 *target_voltage = 0;
1119 *target_voltage = 2 * ((float)adc_results[1]) * (float)(1.2 / adc_results[0]);
1121 LOG_INFO("Target voltage: %f", (double)*target_voltage);
1126 static int stlink_usb_set_swdclk(void *handle, uint16_t clk_divisor)
1128 struct stlink_usb_handle_s *h = handle;
1130 assert(handle != NULL);
1132 if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
1133 return ERROR_COMMAND_NOTFOUND;
1135 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1137 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1138 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_SWD_SET_FREQ;
1139 h_u16_to_le(h->cmdbuf+h->cmdidx, clk_divisor);
1142 int result = stlink_cmd_allow_retry(handle, h->databuf, 2);
1144 if (result != ERROR_OK)
1150 static int stlink_usb_set_jtagclk(void *handle, uint16_t clk_divisor)
1152 struct stlink_usb_handle_s *h = handle;
1154 assert(handle != NULL);
1156 if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
1157 return ERROR_COMMAND_NOTFOUND;
1159 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1161 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1162 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_JTAG_SET_FREQ;
1163 h_u16_to_le(h->cmdbuf+h->cmdidx, clk_divisor);
1166 int result = stlink_cmd_allow_retry(handle, h->databuf, 2);
1168 if (result != ERROR_OK)
1175 static int stlink_usb_current_mode(void *handle, uint8_t *mode)
1178 struct stlink_usb_handle_s *h = handle;
1180 assert(handle != NULL);
1182 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1184 h->cmdbuf[h->cmdidx++] = STLINK_GET_CURRENT_MODE;
1186 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
1188 if (res != ERROR_OK)
1191 *mode = h->databuf[0];
1197 static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
1200 struct stlink_usb_handle_s *h = handle;
1202 assert(handle != NULL);
1204 /* on api V2 we are able the read the latest command
1206 * TODO: we need the test on api V1 too
1208 if (h->version.jtag_api != STLINK_JTAG_API_V1)
1211 stlink_usb_init_buffer(handle, h->rx_ep, rx_size);
1214 case STLINK_MODE_DEBUG_JTAG:
1215 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1216 if (h->version.jtag_api == STLINK_JTAG_API_V1)
1217 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
1219 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
1220 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_JTAG_NO_RESET;
1222 case STLINK_MODE_DEBUG_SWD:
1223 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1224 if (h->version.jtag_api == STLINK_JTAG_API_V1)
1225 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
1227 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
1228 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_SWD_NO_RESET;
1230 case STLINK_MODE_DEBUG_SWIM:
1231 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1232 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ENTER;
1233 /* swim enter does not return any response or status */
1234 return stlink_usb_xfer_noerrcheck(handle, h->databuf, 0);
1235 case STLINK_MODE_DFU:
1236 case STLINK_MODE_MASS:
1241 return stlink_cmd_allow_retry(handle, h->databuf, rx_size);
1245 static int stlink_usb_mode_leave(void *handle, enum stlink_mode type)
1248 struct stlink_usb_handle_s *h = handle;
1250 assert(handle != NULL);
1252 /* command with no reply, use a valid endpoint but zero size */
1253 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1256 case STLINK_MODE_DEBUG_JTAG:
1257 case STLINK_MODE_DEBUG_SWD:
1258 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1259 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_EXIT;
1261 case STLINK_MODE_DEBUG_SWIM:
1262 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1263 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_EXIT;
1265 case STLINK_MODE_DFU:
1266 h->cmdbuf[h->cmdidx++] = STLINK_DFU_COMMAND;
1267 h->cmdbuf[h->cmdidx++] = STLINK_DFU_EXIT;
1269 case STLINK_MODE_MASS:
1274 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 0);
1276 if (res != ERROR_OK)
1282 static int stlink_usb_assert_srst(void *handle, int srst);
1284 static enum stlink_mode stlink_get_mode(enum hl_transports t)
1287 case HL_TRANSPORT_SWD:
1288 return STLINK_MODE_DEBUG_SWD;
1289 case HL_TRANSPORT_JTAG:
1290 return STLINK_MODE_DEBUG_JTAG;
1291 case HL_TRANSPORT_SWIM:
1292 return STLINK_MODE_DEBUG_SWIM;
1294 return STLINK_MODE_UNKNOWN;
1299 static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int initial_interface_speed)
1303 enum stlink_mode emode;
1304 struct stlink_usb_handle_s *h = handle;
1306 assert(handle != NULL);
1308 res = stlink_usb_current_mode(handle, &mode);
1310 if (res != ERROR_OK)
1313 LOG_DEBUG("MODE: 0x%02X", mode);
1315 /* try to exit current mode */
1317 case STLINK_DEV_DFU_MODE:
1318 emode = STLINK_MODE_DFU;
1320 case STLINK_DEV_DEBUG_MODE:
1321 emode = STLINK_MODE_DEBUG_SWD;
1323 case STLINK_DEV_SWIM_MODE:
1324 emode = STLINK_MODE_DEBUG_SWIM;
1326 case STLINK_DEV_BOOTLOADER_MODE:
1327 case STLINK_DEV_MASS_MODE:
1329 emode = STLINK_MODE_UNKNOWN;
1333 if (emode != STLINK_MODE_UNKNOWN) {
1334 res = stlink_usb_mode_leave(handle, emode);
1336 if (res != ERROR_OK)
1340 res = stlink_usb_current_mode(handle, &mode);
1342 if (res != ERROR_OK)
1345 /* we check the target voltage here as an aid to debugging connection problems.
1346 * the stlink requires the target Vdd to be connected for reliable debugging.
1347 * this cmd is supported in all modes except DFU
1349 if (mode != STLINK_DEV_DFU_MODE) {
1351 float target_voltage;
1353 /* check target voltage (if supported) */
1354 res = stlink_usb_check_voltage(h, &target_voltage);
1356 if (res != ERROR_OK) {
1357 if (res != ERROR_COMMAND_NOTFOUND)
1358 LOG_ERROR("voltage check failed");
1359 /* attempt to continue as it is not a catastrophic failure */
1361 /* check for a sensible target voltage, operating range is 1.65-5.5v
1362 * according to datasheet */
1363 if (target_voltage < 1.5)
1364 LOG_ERROR("target voltage may be too low for reliable debugging");
1368 LOG_DEBUG("MODE: 0x%02X", mode);
1370 /* set selected mode */
1373 if (emode == STLINK_MODE_UNKNOWN) {
1374 LOG_ERROR("selected mode (transport) not supported");
1378 /* set the speed before entering the mode, as the chip discovery phase should be done at this speed too */
1379 if (emode == STLINK_MODE_DEBUG_JTAG) {
1380 if (h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ) {
1381 stlink_dump_speed_map(stlink_khz_to_speed_map_jtag, ARRAY_SIZE(stlink_khz_to_speed_map_jtag));
1382 stlink_speed(h, initial_interface_speed, false);
1384 } else if (emode == STLINK_MODE_DEBUG_SWD) {
1385 if (h->version.flags & STLINK_F_HAS_SWD_SET_FREQ) {
1386 stlink_dump_speed_map(stlink_khz_to_speed_map_swd, ARRAY_SIZE(stlink_khz_to_speed_map_swd));
1387 stlink_speed(h, initial_interface_speed, false);
1391 if (h->version.jtag_api == STLINK_JTAG_API_V3) {
1392 struct speed_map map[STLINK_V3_MAX_FREQ_NB];
1394 stlink_get_com_freq(h, (emode == STLINK_MODE_DEBUG_JTAG), map);
1395 stlink_dump_speed_map(map, ARRAY_SIZE(map));
1396 stlink_speed(h, initial_interface_speed, false);
1399 /* preliminary SRST assert:
1400 * We want SRST is asserted before activating debug signals (mode_enter).
1401 * As the required mode has not been set, the adapter may not know what pin to use.
1402 * Tested firmware STLINK v2 JTAG v29 API v2 SWIM v0 uses T_NRST pin by default
1403 * Tested firmware STLINK v2 JTAG v27 API v2 SWIM v6 uses T_NRST pin by default
1404 * after power on, SWIM_RST stays unchanged */
1405 if (connect_under_reset && emode != STLINK_MODE_DEBUG_SWIM)
1406 stlink_usb_assert_srst(handle, 0);
1407 /* do not check the return status here, we will
1408 proceed and enter the desired mode below
1409 and try asserting srst again. */
1411 res = stlink_usb_mode_enter(handle, emode);
1412 if (res != ERROR_OK)
1415 /* assert SRST again: a little bit late but now the adapter knows for sure what pin to use */
1416 if (connect_under_reset) {
1417 res = stlink_usb_assert_srst(handle, 0);
1418 if (res != ERROR_OK)
1422 res = stlink_usb_current_mode(handle, &mode);
1424 if (res != ERROR_OK)
1427 LOG_DEBUG("MODE: 0x%02X", mode);
1432 /* request status from last swim request */
1433 static int stlink_swim_status(void *handle)
1435 struct stlink_usb_handle_s *h = handle;
1438 stlink_usb_init_buffer(handle, h->rx_ep, 4);
1439 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1440 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READSTATUS;
1441 /* error is checked by the caller */
1442 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
1443 if (res != ERROR_OK)
1448 the purpose of this function is unknown...
1449 capabilites? anyway for swim v6 it returns
1452 __attribute__((unused))
1453 static int stlink_swim_cap(void *handle, uint8_t *cap)
1455 struct stlink_usb_handle_s *h = handle;
1458 stlink_usb_init_buffer(handle, h->rx_ep, 8);
1459 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1460 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READ_CAP;
1461 h->cmdbuf[h->cmdidx++] = 0x01;
1462 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 8);
1463 if (res != ERROR_OK)
1465 memcpy(cap, h->databuf, 8);
1469 /* debug dongle assert/deassert sreset line */
1470 static int stlink_swim_assert_reset(void *handle, int reset)
1472 struct stlink_usb_handle_s *h = handle;
1475 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1476 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1478 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ASSERT_RESET;
1480 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_DEASSERT_RESET;
1481 res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1482 if (res != ERROR_OK)
1489 1.3ms low then 750Hz then 1.5kHz
1491 static int stlink_swim_enter(void *handle)
1493 struct stlink_usb_handle_s *h = handle;
1496 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1497 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1498 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ENTER_SEQ;
1499 res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1500 if (res != ERROR_OK)
1505 /* switch high/low speed swim */
1506 static int stlink_swim_speed(void *handle, int speed)
1508 struct stlink_usb_handle_s *h = handle;
1511 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1512 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1513 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_SPEED;
1515 h->cmdbuf[h->cmdidx++] = 1;
1517 h->cmdbuf[h->cmdidx++] = 0;
1518 res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1519 if (res != ERROR_OK)
1525 initiate srst from swim.
1526 nrst is pulled low for 50us.
1528 static int stlink_swim_generate_rst(void *handle)
1530 struct stlink_usb_handle_s *h = handle;
1533 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1534 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1535 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_GEN_RST;
1536 res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1537 if (res != ERROR_OK)
1543 send resyncronize sequence
1544 swim is pulled low for 16us
1545 reply is 64 clks low
1547 static int stlink_swim_resync(void *handle)
1549 struct stlink_usb_handle_s *h = handle;
1552 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1553 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1554 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_RESET;
1555 res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1556 if (res != ERROR_OK)
1561 static int stlink_swim_writebytes(void *handle, uint32_t addr, uint32_t len, const uint8_t *data)
1563 struct stlink_usb_handle_s *h = handle;
1566 unsigned int datalen = 0;
1567 int cmdsize = STLINK_CMD_SIZE_V2;
1569 if (len > STLINK_DATA_SIZE)
1572 if (h->version.stlink == 1)
1573 cmdsize = STLINK_SG_SIZE;
1575 stlink_usb_init_buffer(handle, h->tx_ep, 0);
1576 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1577 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_WRITEMEM;
1578 h_u16_to_be(h->cmdbuf+h->cmdidx, len);
1580 h_u32_to_be(h->cmdbuf+h->cmdidx, addr);
1582 for (i = 0; i < len; i++) {
1583 if (h->cmdidx == cmdsize)
1584 h->databuf[datalen++] = *(data++);
1586 h->cmdbuf[h->cmdidx++] = *(data++);
1588 if (h->version.stlink == 1)
1589 stlink_usb_set_cbw_transfer_datalength(handle, datalen);
1591 res = stlink_cmd_allow_retry(handle, h->databuf, datalen);
1592 if (res != ERROR_OK)
1597 static int stlink_swim_readbytes(void *handle, uint32_t addr, uint32_t len, uint8_t *data)
1599 struct stlink_usb_handle_s *h = handle;
1602 if (len > STLINK_DATA_SIZE)
1605 stlink_usb_init_buffer(handle, h->rx_ep, 0);
1606 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1607 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READMEM;
1608 h_u16_to_be(h->cmdbuf+h->cmdidx, len);
1610 h_u32_to_be(h->cmdbuf+h->cmdidx, addr);
1612 res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1613 if (res != ERROR_OK)
1616 stlink_usb_init_buffer(handle, h->rx_ep, len);
1617 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1618 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READBUF;
1619 res = stlink_usb_xfer_noerrcheck(handle, data, len);
1620 if (res != ERROR_OK)
1627 static int stlink_usb_idcode(void *handle, uint32_t *idcode)
1630 struct stlink_usb_handle_s *h = handle;
1632 assert(handle != NULL);
1634 /* there is no swim read core id cmd */
1635 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
1640 stlink_usb_init_buffer(handle, h->rx_ep, 12);
1642 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1643 if (h->version.jtag_api == STLINK_JTAG_API_V1) {
1644 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READCOREID;
1646 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
1649 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READ_IDCODES;
1651 res = stlink_usb_xfer_errcheck(handle, h->databuf, 12);
1655 if (res != ERROR_OK)
1658 *idcode = le_to_h_u32(h->databuf + offset);
1660 LOG_DEBUG("IDCODE: 0x%08" PRIX32, *idcode);
1665 static int stlink_usb_v2_read_debug_reg(void *handle, uint32_t addr, uint32_t *val)
1667 struct stlink_usb_handle_s *h = handle;
1670 assert(handle != NULL);
1672 stlink_usb_init_buffer(handle, h->rx_ep, 8);
1674 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1675 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READDEBUGREG;
1676 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1679 res = stlink_cmd_allow_retry(handle, h->databuf, 8);
1680 if (res != ERROR_OK)
1683 *val = le_to_h_u32(h->databuf + 4);
1687 static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
1689 struct stlink_usb_handle_s *h = handle;
1691 assert(handle != NULL);
1693 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1695 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1696 if (h->version.jtag_api == STLINK_JTAG_API_V1)
1697 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG;
1699 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG;
1700 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1702 h_u32_to_le(h->cmdbuf+h->cmdidx, val);
1705 return stlink_cmd_allow_retry(handle, h->databuf, 2);
1709 static int stlink_usb_trace_read(void *handle, uint8_t *buf, size_t *size)
1711 struct stlink_usb_handle_s *h = handle;
1713 assert(handle != NULL);
1715 if (h->trace.enabled && (h->version.flags & STLINK_F_HAS_TRACE)) {
1718 stlink_usb_init_buffer(handle, h->rx_ep, 10);
1720 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1721 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GET_TRACE_NB;
1723 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
1724 if (res != ERROR_OK)
1727 size_t bytes_avail = le_to_h_u16(h->databuf);
1728 *size = bytes_avail < *size ? bytes_avail : *size - 1;
1731 res = stlink_usb_read_trace(handle, buf, *size);
1732 if (res != ERROR_OK)
1741 static enum target_state stlink_usb_v2_get_status(void *handle)
1746 result = stlink_usb_v2_read_debug_reg(handle, DCB_DHCSR, &status);
1747 if (result != ERROR_OK)
1748 return TARGET_UNKNOWN;
1750 if (status & S_HALT)
1751 return TARGET_HALTED;
1752 else if (status & S_RESET_ST)
1753 return TARGET_RESET;
1755 return TARGET_RUNNING;
1759 static enum target_state stlink_usb_state(void *handle)
1762 struct stlink_usb_handle_s *h = handle;
1764 assert(handle != NULL);
1766 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
1767 res = stlink_usb_mode_enter(handle, h->st_mode);
1768 if (res != ERROR_OK)
1769 return TARGET_UNKNOWN;
1771 res = stlink_swim_resync(handle);
1772 if (res != ERROR_OK)
1773 return TARGET_UNKNOWN;
1778 if (h->reconnect_pending) {
1779 LOG_INFO("Previous state query failed, trying to reconnect");
1780 res = stlink_usb_mode_enter(handle, h->st_mode);
1781 if (res != ERROR_OK)
1782 return TARGET_UNKNOWN;
1784 h->reconnect_pending = false;
1787 if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1788 res = stlink_usb_v2_get_status(handle);
1789 if (res == TARGET_UNKNOWN)
1790 h->reconnect_pending = true;
1794 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1796 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1797 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_GETSTATUS;
1799 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
1801 if (res != ERROR_OK)
1802 return TARGET_UNKNOWN;
1804 if (h->databuf[0] == STLINK_CORE_RUNNING)
1805 return TARGET_RUNNING;
1806 if (h->databuf[0] == STLINK_CORE_HALTED)
1807 return TARGET_HALTED;
1809 h->reconnect_pending = true;
1811 return TARGET_UNKNOWN;
1814 static int stlink_usb_assert_srst(void *handle, int srst)
1816 struct stlink_usb_handle_s *h = handle;
1818 assert(handle != NULL);
1820 if (h->st_mode == STLINK_MODE_DEBUG_SWIM)
1821 return stlink_swim_assert_reset(handle, srst);
1823 if (h->version.stlink == 1)
1824 return ERROR_COMMAND_NOTFOUND;
1826 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1828 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1829 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_DRIVE_NRST;
1830 h->cmdbuf[h->cmdidx++] = srst;
1832 return stlink_cmd_allow_retry(handle, h->databuf, 2);
1836 static void stlink_usb_trace_disable(void *handle)
1839 struct stlink_usb_handle_s *h = handle;
1841 assert(handle != NULL);
1843 assert(h->version.flags & STLINK_F_HAS_TRACE);
1845 LOG_DEBUG("Tracing: disable");
1847 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1848 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1849 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX;
1850 res = stlink_usb_xfer_errcheck(handle, h->databuf, 2);
1852 if (res == ERROR_OK)
1853 h->trace.enabled = false;
1858 static int stlink_usb_trace_enable(void *handle)
1861 struct stlink_usb_handle_s *h = handle;
1863 assert(handle != NULL);
1865 if (h->version.flags & STLINK_F_HAS_TRACE) {
1866 stlink_usb_init_buffer(handle, h->rx_ep, 10);
1868 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1869 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_START_TRACE_RX;
1870 h_u16_to_le(h->cmdbuf+h->cmdidx, (uint16_t)STLINK_TRACE_SIZE);
1872 h_u32_to_le(h->cmdbuf+h->cmdidx, h->trace.source_hz);
1875 res = stlink_usb_xfer_errcheck(handle, h->databuf, 2);
1877 if (res == ERROR_OK) {
1878 h->trace.enabled = true;
1879 LOG_DEBUG("Tracing: recording at %" PRIu32 "Hz", h->trace.source_hz);
1882 LOG_ERROR("Tracing is not supported by this version.");
1890 static int stlink_usb_reset(void *handle)
1892 struct stlink_usb_handle_s *h = handle;
1895 assert(handle != NULL);
1897 if (h->st_mode == STLINK_MODE_DEBUG_SWIM)
1898 return stlink_swim_generate_rst(handle);
1900 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1902 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1904 if (h->version.jtag_api == STLINK_JTAG_API_V1)
1905 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_RESETSYS;
1907 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_RESETSYS;
1909 retval = stlink_cmd_allow_retry(handle, h->databuf, 2);
1910 if (retval != ERROR_OK)
1913 if (h->trace.enabled) {
1914 stlink_usb_trace_disable(h);
1915 return stlink_usb_trace_enable(h);
1922 static int stlink_usb_run(void *handle)
1925 struct stlink_usb_handle_s *h = handle;
1927 assert(handle != NULL);
1929 if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1930 res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
1935 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1937 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1938 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_RUNCORE;
1940 return stlink_cmd_allow_retry(handle, h->databuf, 2);
1944 static int stlink_usb_halt(void *handle)
1947 struct stlink_usb_handle_s *h = handle;
1949 assert(handle != NULL);
1951 if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1952 res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
1957 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1959 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1960 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_FORCEDEBUG;
1962 return stlink_cmd_allow_retry(handle, h->databuf, 2);
1966 static int stlink_usb_step(void *handle)
1968 struct stlink_usb_handle_s *h = handle;
1970 assert(handle != NULL);
1972 if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1973 /* TODO: this emulates the v1 api, it should really use a similar auto mask isr
1974 * that the Cortex-M3 currently does. */
1975 stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_MASKINTS|C_DEBUGEN);
1976 stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_STEP|C_MASKINTS|C_DEBUGEN);
1977 return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
1980 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1982 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1983 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_STEPCORE;
1985 return stlink_cmd_allow_retry(handle, h->databuf, 2);
1989 static int stlink_usb_read_regs(void *handle)
1992 struct stlink_usb_handle_s *h = handle;
1994 assert(handle != NULL);
1996 stlink_usb_init_buffer(handle, h->rx_ep, 88);
1998 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1999 if (h->version.jtag_api == STLINK_JTAG_API_V1) {
2001 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READALLREGS;
2002 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 84);
2003 /* regs data from offset 0 */
2005 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READALLREGS;
2006 res = stlink_usb_xfer_errcheck(handle, h->databuf, 88);
2007 /* status at offset 0, regs data from offset 4 */
2014 static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
2017 struct stlink_usb_handle_s *h = handle;
2019 assert(handle != NULL);
2021 stlink_usb_init_buffer(handle, h->rx_ep, h->version.jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
2023 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2024 if (h->version.jtag_api == STLINK_JTAG_API_V1)
2025 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READREG;
2027 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
2028 h->cmdbuf[h->cmdidx++] = num;
2030 if (h->version.jtag_api == STLINK_JTAG_API_V1) {
2031 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
2032 if (res != ERROR_OK)
2034 *val = le_to_h_u32(h->databuf);
2037 res = stlink_cmd_allow_retry(handle, h->databuf, 8);
2038 if (res != ERROR_OK)
2040 *val = le_to_h_u32(h->databuf + 4);
2046 static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
2048 struct stlink_usb_handle_s *h = handle;
2050 assert(handle != NULL);
2052 stlink_usb_init_buffer(handle, h->rx_ep, 2);
2054 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2055 if (h->version.jtag_api == STLINK_JTAG_API_V1)
2056 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEREG;
2058 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEREG;
2059 h->cmdbuf[h->cmdidx++] = num;
2060 h_u32_to_le(h->cmdbuf+h->cmdidx, val);
2063 return stlink_cmd_allow_retry(handle, h->databuf, 2);
2066 static int stlink_usb_get_rw_status(void *handle)
2068 struct stlink_usb_handle_s *h = handle;
2070 assert(handle != NULL);
2072 if (h->version.jtag_api == STLINK_JTAG_API_V1)
2075 stlink_usb_init_buffer(handle, h->rx_ep, 2);
2077 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2078 if (h->version.flags & STLINK_F_HAS_GETLASTRWSTATUS2) {
2079 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS2;
2080 return stlink_usb_xfer_errcheck(handle, h->databuf, 12);
2082 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
2083 return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
2088 static int stlink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
2092 uint16_t read_len = len;
2093 struct stlink_usb_handle_s *h = handle;
2095 assert(handle != NULL);
2097 /* max 8 bit read/write is 64 bytes or 512 bytes for v3 */
2098 if (len > stlink_usb_block(h)) {
2099 LOG_DEBUG("max buffer (%d) length exceeded", stlink_usb_block(h));
2103 stlink_usb_init_buffer(handle, h->rx_ep, read_len);
2105 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2106 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_8BIT;
2107 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2109 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2112 /* we need to fix read length for single bytes */
2116 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, read_len);
2118 if (res != ERROR_OK)
2121 memcpy(buffer, h->databuf, len);
2123 return stlink_usb_get_rw_status(handle);
2127 static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
2128 const uint8_t *buffer)
2131 struct stlink_usb_handle_s *h = handle;
2133 assert(handle != NULL);
2135 /* max 8 bit read/write is 64 bytes or 512 bytes for v3 */
2136 if (len > stlink_usb_block(h)) {
2137 LOG_DEBUG("max buffer length (%d) exceeded", stlink_usb_block(h));
2141 stlink_usb_init_buffer(handle, h->tx_ep, len);
2143 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2144 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_8BIT;
2145 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2147 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2150 res = stlink_usb_xfer_noerrcheck(handle, buffer, len);
2152 if (res != ERROR_OK)
2155 return stlink_usb_get_rw_status(handle);
2159 static int stlink_usb_read_mem16(void *handle, uint32_t addr, uint16_t len,
2163 struct stlink_usb_handle_s *h = handle;
2165 assert(handle != NULL);
2167 if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2168 return ERROR_COMMAND_NOTFOUND;
2170 /* data must be a multiple of 2 and half-word aligned */
2171 if (len % 2 || addr % 2) {
2172 LOG_DEBUG("Invalid data alignment");
2173 return ERROR_TARGET_UNALIGNED_ACCESS;
2176 stlink_usb_init_buffer(handle, h->rx_ep, len);
2178 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2179 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READMEM_16BIT;
2180 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2182 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2185 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, len);
2187 if (res != ERROR_OK)
2190 memcpy(buffer, h->databuf, len);
2192 return stlink_usb_get_rw_status(handle);
2196 static int stlink_usb_write_mem16(void *handle, uint32_t addr, uint16_t len,
2197 const uint8_t *buffer)
2200 struct stlink_usb_handle_s *h = handle;
2202 assert(handle != NULL);
2204 if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2205 return ERROR_COMMAND_NOTFOUND;
2207 /* data must be a multiple of 2 and half-word aligned */
2208 if (len % 2 || addr % 2) {
2209 LOG_DEBUG("Invalid data alignment");
2210 return ERROR_TARGET_UNALIGNED_ACCESS;
2213 stlink_usb_init_buffer(handle, h->tx_ep, len);
2215 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2216 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEMEM_16BIT;
2217 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2219 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2222 res = stlink_usb_xfer_noerrcheck(handle, buffer, len);
2224 if (res != ERROR_OK)
2227 return stlink_usb_get_rw_status(handle);
2231 static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
2235 struct stlink_usb_handle_s *h = handle;
2237 assert(handle != NULL);
2239 /* data must be a multiple of 4 and word aligned */
2240 if (len % 4 || addr % 4) {
2241 LOG_DEBUG("Invalid data alignment");
2242 return ERROR_TARGET_UNALIGNED_ACCESS;
2245 stlink_usb_init_buffer(handle, h->rx_ep, len);
2247 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2248 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_32BIT;
2249 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2251 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2254 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, len);
2256 if (res != ERROR_OK)
2259 memcpy(buffer, h->databuf, len);
2261 return stlink_usb_get_rw_status(handle);
2265 static int stlink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
2266 const uint8_t *buffer)
2269 struct stlink_usb_handle_s *h = handle;
2271 assert(handle != NULL);
2273 /* data must be a multiple of 4 and word aligned */
2274 if (len % 4 || addr % 4) {
2275 LOG_DEBUG("Invalid data alignment");
2276 return ERROR_TARGET_UNALIGNED_ACCESS;
2279 stlink_usb_init_buffer(handle, h->tx_ep, len);
2281 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2282 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_32BIT;
2283 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2285 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2288 res = stlink_usb_xfer_noerrcheck(handle, buffer, len);
2290 if (res != ERROR_OK)
2293 return stlink_usb_get_rw_status(handle);
2296 static uint32_t stlink_max_block_size(uint32_t tar_autoincr_block, uint32_t address)
2298 uint32_t max_tar_block = (tar_autoincr_block - ((tar_autoincr_block - 1) & address));
2299 if (max_tar_block == 0)
2301 return max_tar_block;
2304 static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
2305 uint32_t count, uint8_t *buffer)
2307 int retval = ERROR_OK;
2308 uint32_t bytes_remaining;
2310 struct stlink_usb_handle_s *h = handle;
2312 /* calculate byte count */
2315 /* switch to 8 bit if stlink does not support 16 bit memory read */
2316 if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2321 bytes_remaining = (size != 1) ?
2322 stlink_max_block_size(h->max_mem_packet, addr) : stlink_usb_block(h);
2324 if (count < bytes_remaining)
2325 bytes_remaining = count;
2327 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
2328 retval = stlink_swim_readbytes(handle, addr, bytes_remaining, buffer);
2329 if (retval != ERROR_OK)
2333 * all stlink support 8/32bit memory read/writes and only from
2334 * stlink V2J26 there is support for 16 bit memory read/write.
2335 * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
2340 /* When in jtag mode the stlink uses the auto-increment functionality.
2341 * However it expects us to pass the data correctly, this includes
2342 * alignment and any page boundaries. We already do this as part of the
2343 * adi_v5 implementation, but the stlink is a hla adapter and so this
2344 * needs implementing manually.
2345 * currently this only affects jtag mode, according to ST they do single
2346 * access in SWD mode - but this may change and so we do it for both modes */
2348 /* we first need to check for any unaligned bytes */
2349 if (addr & (size - 1)) {
2351 uint32_t head_bytes = size - (addr & (size - 1));
2352 retval = stlink_usb_read_mem8(handle, addr, head_bytes, buffer);
2353 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2354 usleep((1<<retries++) * 1000);
2357 if (retval != ERROR_OK)
2359 buffer += head_bytes;
2361 count -= head_bytes;
2362 bytes_remaining -= head_bytes;
2365 if (bytes_remaining & (size - 1))
2366 retval = stlink_usb_read_mem(handle, addr, 1, bytes_remaining, buffer);
2368 retval = stlink_usb_read_mem16(handle, addr, bytes_remaining, buffer);
2370 retval = stlink_usb_read_mem32(handle, addr, bytes_remaining, buffer);
2372 retval = stlink_usb_read_mem8(handle, addr, bytes_remaining, buffer);
2374 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2375 usleep((1<<retries++) * 1000);
2378 if (retval != ERROR_OK)
2381 buffer += bytes_remaining;
2382 addr += bytes_remaining;
2383 count -= bytes_remaining;
2389 static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
2390 uint32_t count, const uint8_t *buffer)
2392 int retval = ERROR_OK;
2393 uint32_t bytes_remaining;
2395 struct stlink_usb_handle_s *h = handle;
2397 /* calculate byte count */
2400 /* switch to 8 bit if stlink does not support 16 bit memory read */
2401 if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2406 bytes_remaining = (size != 1) ?
2407 stlink_max_block_size(h->max_mem_packet, addr) : stlink_usb_block(h);
2409 if (count < bytes_remaining)
2410 bytes_remaining = count;
2412 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
2413 retval = stlink_swim_writebytes(handle, addr, bytes_remaining, buffer);
2414 if (retval != ERROR_OK)
2418 * all stlink support 8/32bit memory read/writes and only from
2419 * stlink V2J26 there is support for 16 bit memory read/write.
2420 * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
2425 /* When in jtag mode the stlink uses the auto-increment functionality.
2426 * However it expects us to pass the data correctly, this includes
2427 * alignment and any page boundaries. We already do this as part of the
2428 * adi_v5 implementation, but the stlink is a hla adapter and so this
2429 * needs implementing manually.
2430 * currently this only affects jtag mode, according to ST they do single
2431 * access in SWD mode - but this may change and so we do it for both modes */
2433 /* we first need to check for any unaligned bytes */
2434 if (addr & (size - 1)) {
2436 uint32_t head_bytes = size - (addr & (size - 1));
2437 retval = stlink_usb_write_mem8(handle, addr, head_bytes, buffer);
2438 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2439 usleep((1<<retries++) * 1000);
2442 if (retval != ERROR_OK)
2444 buffer += head_bytes;
2446 count -= head_bytes;
2447 bytes_remaining -= head_bytes;
2450 if (bytes_remaining & (size - 1))
2451 retval = stlink_usb_write_mem(handle, addr, 1, bytes_remaining, buffer);
2453 retval = stlink_usb_write_mem16(handle, addr, bytes_remaining, buffer);
2455 retval = stlink_usb_write_mem32(handle, addr, bytes_remaining, buffer);
2458 retval = stlink_usb_write_mem8(handle, addr, bytes_remaining, buffer);
2459 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2460 usleep((1<<retries++) * 1000);
2463 if (retval != ERROR_OK)
2466 buffer += bytes_remaining;
2467 addr += bytes_remaining;
2468 count -= bytes_remaining;
2475 static int stlink_usb_override_target(const char *targetname)
2477 return !strcmp(targetname, "cortex_m");
2480 static int stlink_speed_swim(void *handle, int khz, bool query)
2485 we only have low and high speed...
2486 before changing speed the SWIM_CSR HS bit
2490 retval = stlink_swim_speed(handle, (khz < SWIM_FREQ_HIGH) ? 0 : 1);
2491 if (retval != ERROR_OK)
2492 LOG_ERROR("Unable to set adapter speed");
2495 return (khz < SWIM_FREQ_HIGH) ? SWIM_FREQ_LOW : SWIM_FREQ_HIGH;
2498 static int stlink_match_speed_map(const struct speed_map *map, unsigned int map_size, int khz, bool query)
2501 int speed_index = -1;
2502 int speed_diff = INT_MAX;
2503 int last_valid_speed = -1;
2506 for (i = 0; i < map_size; i++) {
2509 last_valid_speed = i;
2510 if (khz == map[i].speed) {
2514 int current_diff = khz - map[i].speed;
2515 /* get abs value for comparison */
2516 current_diff = (current_diff > 0) ? current_diff : -current_diff;
2517 if ((current_diff < speed_diff) && khz >= map[i].speed) {
2518 speed_diff = current_diff;
2524 if (speed_index == -1) {
2525 /* this will only be here if we cannot match the slow speed.
2526 * use the slowest speed we support.*/
2527 speed_index = last_valid_speed;
2529 } else if (i == map_size)
2532 if (!match && query) {
2533 LOG_INFO("Unable to match requested speed %d kHz, using %d kHz",
2534 khz, map[speed_index].speed);
2540 static int stlink_speed_swd(void *handle, int khz, bool query)
2543 struct stlink_usb_handle_s *h = handle;
2545 /* old firmware cannot change it */
2546 if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
2549 speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_swd,
2550 ARRAY_SIZE(stlink_khz_to_speed_map_swd), khz, query);
2553 int result = stlink_usb_set_swdclk(h, stlink_khz_to_speed_map_swd[speed_index].speed_divisor);
2554 if (result != ERROR_OK) {
2555 LOG_ERROR("Unable to set adapter speed");
2560 return stlink_khz_to_speed_map_swd[speed_index].speed;
2563 static int stlink_speed_jtag(void *handle, int khz, bool query)
2566 struct stlink_usb_handle_s *h = handle;
2568 /* old firmware cannot change it */
2569 if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
2572 speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_jtag,
2573 ARRAY_SIZE(stlink_khz_to_speed_map_jtag), khz, query);
2576 int result = stlink_usb_set_jtagclk(h, stlink_khz_to_speed_map_jtag[speed_index].speed_divisor);
2577 if (result != ERROR_OK) {
2578 LOG_ERROR("Unable to set adapter speed");
2583 return stlink_khz_to_speed_map_jtag[speed_index].speed;
2586 void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size)
2590 LOG_DEBUG("Supported clock speeds are:");
2591 for (i = 0; i < map_size; i++)
2593 LOG_DEBUG("%d kHz", map[i].speed);
2596 static int stlink_get_com_freq(void *handle, bool is_jtag, struct speed_map *map)
2598 struct stlink_usb_handle_s *h = handle;
2601 if (h->version.jtag_api != STLINK_JTAG_API_V3) {
2602 LOG_ERROR("Unknown command");
2606 stlink_usb_init_buffer(handle, h->rx_ep, 16);
2608 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2609 h->cmdbuf[h->cmdidx++] = STLINK_APIV3_GET_COM_FREQ;
2610 h->cmdbuf[h->cmdidx++] = is_jtag ? 1 : 0;
2612 int res = stlink_usb_xfer_errcheck(handle, h->databuf, 52);
2614 int size = h->databuf[8];
2616 if (size > STLINK_V3_MAX_FREQ_NB)
2617 size = STLINK_V3_MAX_FREQ_NB;
2619 for (i = 0; i < size; i++) {
2620 map[i].speed = le_to_h_u32(&h->databuf[12 + 4 * i]);
2621 map[i].speed_divisor = i;
2624 /* set to zero all the next entries */
2625 for (i = size; i < STLINK_V3_MAX_FREQ_NB; i++)
2631 static int stlink_set_com_freq(void *handle, bool is_jtag, unsigned int frequency)
2633 struct stlink_usb_handle_s *h = handle;
2635 if (h->version.jtag_api != STLINK_JTAG_API_V3) {
2636 LOG_ERROR("Unknown command");
2640 stlink_usb_init_buffer(handle, h->rx_ep, 16);
2642 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2643 h->cmdbuf[h->cmdidx++] = STLINK_APIV3_SET_COM_FREQ;
2644 h->cmdbuf[h->cmdidx++] = is_jtag ? 1 : 0;
2645 h->cmdbuf[h->cmdidx++] = 0;
2647 h_u32_to_le(&h->cmdbuf[4], frequency);
2649 return stlink_usb_xfer_errcheck(handle, h->databuf, 8);
2652 static int stlink_speed_v3(void *handle, bool is_jtag, int khz, bool query)
2654 struct stlink_usb_handle_s *h = handle;
2656 struct speed_map map[STLINK_V3_MAX_FREQ_NB];
2658 stlink_get_com_freq(h, is_jtag, map);
2660 speed_index = stlink_match_speed_map(map, ARRAY_SIZE(map), khz, query);
2663 int result = stlink_set_com_freq(h, is_jtag, map[speed_index].speed);
2664 if (result != ERROR_OK) {
2665 LOG_ERROR("Unable to set adapter speed");
2669 return map[speed_index].speed;
2672 static int stlink_speed(void *handle, int khz, bool query)
2674 struct stlink_usb_handle_s *h = handle;
2679 switch (h->st_mode) {
2680 case STLINK_MODE_DEBUG_SWIM:
2681 return stlink_speed_swim(handle, khz, query);
2682 case STLINK_MODE_DEBUG_SWD:
2683 if (h->version.jtag_api == STLINK_JTAG_API_V3)
2684 return stlink_speed_v3(handle, false, khz, query);
2686 return stlink_speed_swd(handle, khz, query);
2688 case STLINK_MODE_DEBUG_JTAG:
2689 if (h->version.jtag_api == STLINK_JTAG_API_V3)
2690 return stlink_speed_v3(handle, true, khz, query);
2692 return stlink_speed_jtag(handle, khz, query);
2702 static int stlink_usb_close(void *handle)
2706 enum stlink_mode emode;
2707 struct stlink_usb_handle_s *h = handle;
2710 res = stlink_usb_current_mode(handle, &mode);
2713 /* do not exit if return code != ERROR_OK,
2714 it prevents us from closing jtag_libusb */
2716 if (res == ERROR_OK) {
2717 /* try to exit current mode */
2719 case STLINK_DEV_DFU_MODE:
2720 emode = STLINK_MODE_DFU;
2722 case STLINK_DEV_DEBUG_MODE:
2723 emode = STLINK_MODE_DEBUG_SWD;
2725 case STLINK_DEV_SWIM_MODE:
2726 emode = STLINK_MODE_DEBUG_SWIM;
2728 case STLINK_DEV_BOOTLOADER_MODE:
2729 case STLINK_DEV_MASS_MODE:
2731 emode = STLINK_MODE_UNKNOWN;
2735 if (emode != STLINK_MODE_UNKNOWN)
2736 stlink_usb_mode_leave(handle, emode);
2737 /* do not check return code, it prevent
2738 us from closing jtag_libusb */
2742 jtag_libusb_close(h->fd);
2749 /* Compute ST-Link serial number from the device descriptor
2750 * this function will help to work-around a bug in old ST-Link/V2 DFU
2751 * the buggy DFU returns an incorrect serial in the USB descriptor
2752 * example for the following serial "57FF72067265575742132067"
2753 * - the correct descriptor serial is:
2754 * 0x32, 0x03, 0x35, 0x00, 0x37, 0x00, 0x46, 0x00, 0x46, 0x00, 0x37, 0x00, 0x32, 0x00 ...
2755 * this contains the length (0x32 = 50), the type (0x3 = DT_STRING) and the serial in unicode format
2756 * the serial part is: 0x0035, 0x0037, 0x0046, 0x0046, 0x0037, 0x0032 ... >> 57FF72 ...
2757 * this format could be read correctly by 'libusb_get_string_descriptor_ascii'
2758 * so this case is managed by libusb_helper::string_descriptor_equal
2759 * - the buggy DFU is not doing any unicode conversion and returns a raw serial data in the descriptor
2760 * 0x1a, 0x03, 0x57, 0x00, 0xFF, 0x00, 0x72, 0x00 ...
2762 * based on the length (0x1a = 26) we could easily decide if we have to fixup the serial
2763 * and then we have just to convert the raw data into printable characters using sprintf
2765 char *stlink_usb_get_alternate_serial(libusb_device_handle *device,
2766 struct libusb_device_descriptor *dev_desc)
2769 unsigned char desc_serial[(STLINK_SERIAL_LEN + 1) * 2];
2771 if (dev_desc->iSerialNumber == 0)
2774 /* get the LANGID from String Descriptor Zero */
2775 usb_retval = libusb_get_string_descriptor(device, 0, 0, desc_serial,
2776 sizeof(desc_serial));
2778 if (usb_retval < LIBUSB_SUCCESS) {
2779 LOG_ERROR("libusb_get_string_descriptor() failed: %s(%d)",
2780 libusb_error_name(usb_retval), usb_retval);
2782 } else if (usb_retval < 4) {
2783 /* the size should be least 4 bytes to contain a minimum of 1 supported LANGID */
2784 LOG_ERROR("could not get the LANGID");
2788 uint32_t langid = desc_serial[2] | (desc_serial[3] << 8);
2790 /* get the serial */
2791 usb_retval = libusb_get_string_descriptor(device, dev_desc->iSerialNumber,
2792 langid, desc_serial, sizeof(desc_serial));
2794 unsigned char len = desc_serial[0];
2796 if (usb_retval < LIBUSB_SUCCESS) {
2797 LOG_ERROR("libusb_get_string_descriptor() failed: %s(%d)",
2798 libusb_error_name(usb_retval), usb_retval);
2800 } else if (desc_serial[1] != LIBUSB_DT_STRING || len > usb_retval) {
2801 LOG_ERROR("invalid string in ST-LINK USB serial descriptor");
2805 if (len == ((STLINK_SERIAL_LEN + 1) * 2)) {
2806 /* good ST-Link adapter, this case is managed by
2807 * libusb::libusb_get_string_descriptor_ascii */
2809 } else if (len != ((STLINK_SERIAL_LEN / 2 + 1) * 2)) {
2810 LOG_ERROR("unexpected serial length (%d) in descriptor", len);
2814 /* else (len == 26) => buggy ST-Link */
2816 char *alternate_serial = malloc((STLINK_SERIAL_LEN + 1) * sizeof(char));
2817 if (alternate_serial == NULL)
2820 for (unsigned int i = 0; i < STLINK_SERIAL_LEN; i += 2)
2821 sprintf(alternate_serial + i, "%02X", desc_serial[i + 2]);
2823 alternate_serial[STLINK_SERIAL_LEN] = '\0';
2825 return alternate_serial;
2829 static int stlink_usb_open(struct hl_interface_param_s *param, enum stlink_mode mode, void **fd)
2831 int err, retry_count = 1;
2832 struct stlink_usb_handle_s *h;
2834 LOG_DEBUG("stlink_usb_open");
2836 h = calloc(1, sizeof(struct stlink_usb_handle_s));
2839 LOG_DEBUG("malloc failed");
2845 for (unsigned i = 0; param->vid[i]; i++) {
2846 LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x serial: %s",
2847 h->st_mode, param->vid[i], param->pid[i],
2848 param->serial ? param->serial : "");
2852 On certain host USB configurations(e.g. MacBook Air)
2853 STLINKv2 dongle seems to have its FW in a funky state if,
2854 after plugging it in, you try to use openocd with it more
2855 then once (by launching and closing openocd). In cases like
2856 that initial attempt to read the FW info via
2857 stlink_usb_version will fail and the device has to be reset
2858 in order to become operational.
2861 if (jtag_libusb_open(param->vid, param->pid, param->serial,
2862 &h->fd, stlink_usb_get_alternate_serial) != ERROR_OK) {
2863 LOG_ERROR("open failed");
2867 jtag_libusb_set_configuration(h->fd, 0);
2869 if (libusb_claim_interface(h->fd, 0) != ERROR_OK) {
2870 LOG_DEBUG("claim interface failed");
2874 /* RX EP is common for all versions */
2875 h->rx_ep = STLINK_RX_EP;
2878 if (jtag_libusb_get_pid(libusb_get_device(h->fd), &pid) != ERROR_OK) {
2879 LOG_DEBUG("libusb_get_pid failed");
2883 /* wrap version for first read */
2886 h->version.stlink = 1;
2887 h->tx_ep = STLINK_TX_EP;
2889 case STLINK_V3_USBLOADER_PID:
2890 case STLINK_V3E_PID:
2891 case STLINK_V3S_PID:
2892 case STLINK_V3_2VCP_PID:
2893 h->version.stlink = 3;
2894 h->tx_ep = STLINK_V2_1_TX_EP;
2895 h->trace_ep = STLINK_V2_1_TRACE_EP;
2897 case STLINK_V2_1_PID:
2898 case STLINK_V2_1_NO_MSD_PID:
2899 h->version.stlink = 2;
2900 h->tx_ep = STLINK_V2_1_TX_EP;
2901 h->trace_ep = STLINK_V2_1_TRACE_EP;
2904 /* fall through - we assume V2 to be the default version*/
2906 h->version.stlink = 2;
2907 h->tx_ep = STLINK_TX_EP;
2908 h->trace_ep = STLINK_TRACE_EP;
2912 /* get the device version */
2913 err = stlink_usb_version(h);
2915 if (err == ERROR_OK) {
2917 } else if (h->version.stlink == 1 ||
2919 LOG_ERROR("read version failed");
2922 err = libusb_release_interface(h->fd, 0);
2923 if (err != ERROR_OK) {
2924 LOG_ERROR("release interface failed");
2928 err = libusb_reset_device(h->fd);
2929 if (err != ERROR_OK) {
2930 LOG_ERROR("reset device failed");
2934 jtag_libusb_close(h->fd);
2936 Give the device one second to settle down and
2939 usleep(1 * 1000 * 1000);
2944 /* check if mode is supported */
2947 switch (h->st_mode) {
2948 case STLINK_MODE_DEBUG_SWD:
2949 if (h->version.jtag_api == STLINK_JTAG_API_V1)
2952 case STLINK_MODE_DEBUG_JTAG:
2953 if (h->version.jtag == 0)
2956 case STLINK_MODE_DEBUG_SWIM:
2957 if (h->version.swim == 0)
2965 if (err != ERROR_OK) {
2966 LOG_ERROR("mode (transport) not supported by device");
2970 /* initialize the debug hardware */
2971 err = stlink_usb_init_mode(h, param->connect_under_reset, param->initial_interface_speed);
2973 if (err != ERROR_OK) {
2974 LOG_ERROR("init mode failed (unable to connect to the target)");
2978 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
2979 err = stlink_swim_enter(h);
2980 if (err != ERROR_OK) {
2981 LOG_ERROR("stlink_swim_enter_failed (unable to connect to the target)");
2985 h->max_mem_packet = STLINK_DATA_SIZE;
2989 /* get cpuid, so we can determine the max page size
2990 * start with a safe default */
2991 h->max_mem_packet = (1 << 10);
2994 err = stlink_usb_read_mem32(h, CPUID, 4, buffer);
2995 if (err == ERROR_OK) {
2996 uint32_t cpuid = le_to_h_u32(buffer);
2997 int i = (cpuid >> 4) & 0xf;
2998 if (i == 4 || i == 3) {
2999 /* Cortex-M3/M4 has 4096 bytes autoincrement range */
3000 h->max_mem_packet = (1 << 12);
3004 LOG_DEBUG("Using TAR autoincrement: %" PRIu32, h->max_mem_packet);
3011 stlink_usb_close(h);
3016 static int stlink_usb_hl_open(struct hl_interface_param_s *param, void **fd)
3018 return stlink_usb_open(param, stlink_get_mode(param->transport), fd);
3021 int stlink_config_trace(void *handle, bool enabled,
3022 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
3023 unsigned int *trace_freq, unsigned int traceclkin_freq,
3024 uint16_t *prescaler)
3026 struct stlink_usb_handle_s *h = handle;
3029 if (enabled && (!(h->version.flags & STLINK_F_HAS_TRACE) ||
3030 pin_protocol != TPIU_PIN_PROTOCOL_ASYNC_UART)) {
3031 LOG_ERROR("The attached ST-LINK version doesn't support this trace mode");
3036 stlink_usb_trace_disable(h);
3040 if (*trace_freq > STLINK_TRACE_MAX_HZ) {
3041 LOG_ERROR("ST-LINK doesn't support SWO frequency higher than %u",
3042 STLINK_TRACE_MAX_HZ);
3046 stlink_usb_trace_disable(h);
3049 *trace_freq = STLINK_TRACE_MAX_HZ;
3051 presc = traceclkin_freq / *trace_freq;
3053 if (traceclkin_freq % *trace_freq > 0)
3056 if (presc > TPIU_ACPR_MAX_SWOSCALER) {
3057 LOG_ERROR("SWO frequency is not suitable. Please choose a different "
3063 h->trace.source_hz = *trace_freq;
3065 return stlink_usb_trace_enable(h);
3069 static int stlink_usb_init_access_port(void *handle, unsigned char ap_num)
3071 struct stlink_usb_handle_s *h = handle;
3073 assert(handle != NULL);
3075 if (!(h->version.flags & STLINK_F_HAS_AP_INIT))
3076 return ERROR_COMMAND_NOTFOUND;
3078 LOG_DEBUG_IO("init ap_num = %d", ap_num);
3079 stlink_usb_init_buffer(handle, h->rx_ep, 16);
3080 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3081 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_INIT_AP;
3082 h->cmdbuf[h->cmdidx++] = ap_num;
3084 return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
3088 static int stlink_usb_close_access_port(void *handle, unsigned char ap_num)
3090 struct stlink_usb_handle_s *h = handle;
3092 assert(handle != NULL);
3094 if (!(h->version.flags & STLINK_F_HAS_AP_INIT))
3095 return ERROR_COMMAND_NOTFOUND;
3097 LOG_DEBUG_IO("close ap_num = %d", ap_num);
3098 stlink_usb_init_buffer(handle, h->rx_ep, 16);
3099 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3100 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_CLOSE_AP_DBG;
3101 h->cmdbuf[h->cmdidx++] = ap_num;
3103 return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
3107 static int stlink_read_dap_register(void *handle, unsigned short dap_port,
3108 unsigned short addr, uint32_t *val)
3110 struct stlink_usb_handle_s *h = handle;
3113 assert(handle != NULL);
3115 if (!(h->version.flags & STLINK_F_HAS_DAP_REG))
3116 return ERROR_COMMAND_NOTFOUND;
3118 stlink_usb_init_buffer(handle, h->rx_ep, 16);
3119 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3120 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READ_DAP_REG;
3121 h_u16_to_le(&h->cmdbuf[2], dap_port);
3122 h_u16_to_le(&h->cmdbuf[4], addr);
3124 retval = stlink_usb_xfer_errcheck(handle, h->databuf, 8);
3125 *val = le_to_h_u32(h->databuf + 4);
3126 LOG_DEBUG_IO("dap_port_read = %d, addr = 0x%x, value = 0x%x", dap_port, addr, *val);
3131 static int stlink_write_dap_register(void *handle, unsigned short dap_port,
3132 unsigned short addr, uint32_t val)
3134 struct stlink_usb_handle_s *h = handle;
3136 assert(handle != NULL);
3138 if (!(h->version.flags & STLINK_F_HAS_DAP_REG))
3139 return ERROR_COMMAND_NOTFOUND;
3141 LOG_DEBUG_IO("dap_write port = %d, addr = 0x%x, value = 0x%x", dap_port, addr, val);
3142 stlink_usb_init_buffer(handle, h->rx_ep, 16);
3143 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3144 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITE_DAP_REG;
3145 h_u16_to_le(&h->cmdbuf[2], dap_port);
3146 h_u16_to_le(&h->cmdbuf[4], addr);
3147 h_u32_to_le(&h->cmdbuf[6], val);
3148 return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
3152 struct hl_layout_api_s stlink_usb_layout_api = {
3154 .open = stlink_usb_hl_open,
3156 .close = stlink_usb_close,
3158 .idcode = stlink_usb_idcode,
3160 .state = stlink_usb_state,
3162 .reset = stlink_usb_reset,
3164 .assert_srst = stlink_usb_assert_srst,
3166 .run = stlink_usb_run,
3168 .halt = stlink_usb_halt,
3170 .step = stlink_usb_step,
3172 .read_regs = stlink_usb_read_regs,
3174 .read_reg = stlink_usb_read_reg,
3176 .write_reg = stlink_usb_write_reg,
3178 .read_mem = stlink_usb_read_mem,
3180 .write_mem = stlink_usb_write_mem,
3182 .write_debug_reg = stlink_usb_write_debug_reg,
3184 .override_target = stlink_usb_override_target,
3186 .speed = stlink_speed,
3188 .config_trace = stlink_config_trace,
3190 .poll_trace = stlink_usb_trace_read,
3193 /*****************************************************************************
3194 * DAP direct interface
3197 static struct stlink_usb_handle_s *stlink_dap_handle;
3198 static struct hl_interface_param_s stlink_dap_param;
3199 static DECLARE_BITMAP(opened_ap, DP_APSEL_MAX + 1);
3200 static int stlink_dap_error = ERROR_OK;
3202 static int stlink_dap_op_queue_dp_read(struct adiv5_dap *dap, unsigned reg,
3206 static int stlink_dap_record_error(int error)
3208 if (stlink_dap_error == ERROR_OK)
3209 stlink_dap_error = error;
3214 static int stlink_dap_get_and_clear_error(void)
3216 int retval = stlink_dap_error;
3217 stlink_dap_error = ERROR_OK;
3222 static int stlink_dap_open_ap(unsigned short apsel)
3226 /* nothing to do on old versions */
3227 if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT))
3230 if (apsel > DP_APSEL_MAX)
3233 if (test_bit(apsel, opened_ap))
3236 retval = stlink_usb_init_access_port(stlink_dap_handle, apsel);
3237 if (retval != ERROR_OK)
3240 LOG_DEBUG("AP %d enabled", apsel);
3241 set_bit(apsel, opened_ap);
3246 static int stlink_dap_closeall_ap(void)
3250 /* nothing to do on old versions */
3251 if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT))
3254 for (apsel = 0; apsel <= DP_APSEL_MAX; apsel++) {
3255 if (!test_bit(apsel, opened_ap))
3257 retval = stlink_usb_close_access_port(stlink_dap_handle, apsel);
3258 if (retval != ERROR_OK)
3260 clear_bit(apsel, opened_ap);
3266 static int stlink_dap_reinit_interface(void)
3271 * On JTAG only, it should be enough to call stlink_usb_reset(). But on
3272 * some firmware version it does not work as expected, and there is no
3273 * equivalent for SWD.
3274 * At least for now, to reset the interface quit from JTAG/SWD mode then
3275 * select the mode again.
3278 if (!stlink_dap_handle->reconnect_pending) {
3279 stlink_dap_handle->reconnect_pending = true;
3280 stlink_usb_mode_leave(stlink_dap_handle, stlink_dap_handle->st_mode);
3283 retval = stlink_usb_mode_enter(stlink_dap_handle, stlink_dap_handle->st_mode);
3284 if (retval != ERROR_OK)
3287 stlink_dap_handle->reconnect_pending = false;
3288 /* on new FW, calling mode-leave closes all the opened AP; reopen them! */
3289 if (stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT)
3290 for (int apsel = 0; apsel <= DP_APSEL_MAX; apsel++)
3291 if (test_bit(apsel, opened_ap)) {
3292 clear_bit(apsel, opened_ap);
3293 stlink_dap_open_ap(apsel);
3299 static int stlink_dap_op_connect(struct adiv5_dap *dap)
3304 LOG_INFO("stlink_dap_op_connect(%sconnect)", dap->do_reconnect ? "re" : "");
3306 /* Check if we should reset srst already when connecting, but not if reconnecting. */
3307 if (!dap->do_reconnect) {
3308 enum reset_types jtag_reset_config = jtag_get_reset_config();
3310 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
3311 if (jtag_reset_config & RESET_SRST_NO_GATING)
3312 adapter_assert_reset();
3314 LOG_WARNING("\'srst_nogate\' reset_config option is required");
3318 dap->do_reconnect = false;
3319 dap_invalidate_cache(dap);
3321 retval = dap_dp_init(dap);
3322 if (retval != ERROR_OK) {
3323 dap->do_reconnect = true;
3327 retval = stlink_usb_idcode(stlink_dap_handle, &idcode);
3328 if (retval == ERROR_OK)
3329 LOG_INFO("%s %#8.8" PRIx32,
3330 (stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG) ? "JTAG IDCODE" : "SWD DPIDR",
3333 dap->do_reconnect = true;
3339 static int stlink_dap_check_reconnect(struct adiv5_dap *dap)
3343 if (!dap->do_reconnect)
3346 retval = stlink_dap_reinit_interface();
3347 if (retval != ERROR_OK)
3350 return stlink_dap_op_connect(dap);
3354 static int stlink_dap_op_send_sequence(struct adiv5_dap *dap, enum swd_special_seq seq)
3356 /* Ignore the request */
3361 static int stlink_dap_op_queue_dp_read(struct adiv5_dap *dap, unsigned reg,
3367 if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_DPBANKSEL))
3368 if (reg & 0x000000F0) {
3369 LOG_ERROR("Banked DP registers not supported in current STLink FW");
3370 return ERROR_COMMAND_NOTFOUND;
3373 retval = stlink_dap_check_reconnect(dap);
3374 if (retval != ERROR_OK)
3377 data = data ? : &dummy;
3378 if (stlink_dap_handle->version.flags & STLINK_F_QUIRK_JTAG_DP_READ
3379 && stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG) {
3380 /* Quirk required in JTAG. Read RDBUFF to get the data */
3381 retval = stlink_read_dap_register(stlink_dap_handle,
3382 STLINK_DEBUG_PORT_ACCESS, reg, &dummy);
3383 if (retval == ERROR_OK)
3384 retval = stlink_read_dap_register(stlink_dap_handle,
3385 STLINK_DEBUG_PORT_ACCESS, DP_RDBUFF, data);
3387 retval = stlink_read_dap_register(stlink_dap_handle,
3388 STLINK_DEBUG_PORT_ACCESS, reg, data);
3391 return stlink_dap_record_error(retval);
3395 static int stlink_dap_op_queue_dp_write(struct adiv5_dap *dap, unsigned reg,
3400 if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_DPBANKSEL))
3401 if (reg & 0x000000F0) {
3402 LOG_ERROR("Banked DP registers not supported in current STLink FW");
3403 return ERROR_COMMAND_NOTFOUND;
3406 if (reg == DP_SELECT && (data & DP_SELECT_DPBANK) != 0) {
3407 /* ignored if STLINK_F_HAS_DPBANKSEL, not properly managed otherwise */
3408 LOG_DEBUG("Ignoring DPBANKSEL while write SELECT");
3409 data &= ~DP_SELECT_DPBANK;
3412 retval = stlink_dap_check_reconnect(dap);
3413 if (retval != ERROR_OK)
3416 /* ST-Link does not like that we set CORUNDETECT */
3417 if (reg == DP_CTRL_STAT)
3418 data &= ~CORUNDETECT;
3420 retval = stlink_write_dap_register(stlink_dap_handle,
3421 STLINK_DEBUG_PORT_ACCESS, reg, data);
3422 return stlink_dap_record_error(retval);
3426 static int stlink_dap_op_queue_ap_read(struct adiv5_ap *ap, unsigned reg,
3429 struct adiv5_dap *dap = ap->dap;
3433 retval = stlink_dap_check_reconnect(dap);
3434 if (retval != ERROR_OK)
3437 if (reg != AP_REG_IDR) {
3438 retval = stlink_dap_open_ap(ap->ap_num);
3439 if (retval != ERROR_OK)
3442 data = data ? : &dummy;
3443 retval = stlink_read_dap_register(stlink_dap_handle, ap->ap_num, reg,
3445 dap->stlink_flush_ap_write = false;
3446 return stlink_dap_record_error(retval);
3450 static int stlink_dap_op_queue_ap_write(struct adiv5_ap *ap, unsigned reg,
3453 struct adiv5_dap *dap = ap->dap;
3456 retval = stlink_dap_check_reconnect(dap);
3457 if (retval != ERROR_OK)
3460 retval = stlink_dap_open_ap(ap->ap_num);
3461 if (retval != ERROR_OK)
3464 retval = stlink_write_dap_register(stlink_dap_handle, ap->ap_num, reg,
3466 dap->stlink_flush_ap_write = true;
3467 return stlink_dap_record_error(retval);
3471 static int stlink_dap_op_queue_ap_abort(struct adiv5_dap *dap, uint8_t *ack)
3473 LOG_WARNING("stlink_dap_op_queue_ap_abort()");
3478 static int stlink_dap_op_run(struct adiv5_dap *dap)
3480 uint32_t ctrlstat, pwrmask;
3481 int retval, saved_retval;
3483 /* Here no LOG_DEBUG. This is called continuously! */
3486 * ST-Link returns immediately after a DAP write, without waiting for it
3488 * Run a dummy read to DP_RDBUFF, as suggested in
3489 * http://infocenter.arm.com/help/topic/com.arm.doc.faqs/ka16363.html
3491 if (dap->stlink_flush_ap_write) {
3492 dap->stlink_flush_ap_write = false;
3493 retval = stlink_dap_op_queue_dp_read(dap, DP_RDBUFF, NULL);
3494 if (retval != ERROR_OK) {
3495 dap->do_reconnect = true;
3500 saved_retval = stlink_dap_get_and_clear_error();
3502 retval = stlink_dap_op_queue_dp_read(dap, DP_CTRL_STAT, &ctrlstat);
3503 if (retval != ERROR_OK) {
3504 dap->do_reconnect = true;
3507 retval = stlink_dap_get_and_clear_error();
3508 if (retval != ERROR_OK) {
3509 LOG_ERROR("Fail reading CTRL/STAT register. Force reconnect");
3510 dap->do_reconnect = true;
3514 if (ctrlstat & SSTICKYERR) {
3515 if (stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG)
3516 retval = stlink_dap_op_queue_dp_write(dap, DP_CTRL_STAT,
3517 ctrlstat & (dap->dp_ctrl_stat | SSTICKYERR));
3519 retval = stlink_dap_op_queue_dp_write(dap, DP_ABORT, STKERRCLR);
3520 if (retval != ERROR_OK) {
3521 dap->do_reconnect = true;
3524 retval = stlink_dap_get_and_clear_error();
3525 if (retval != ERROR_OK) {
3526 dap->do_reconnect = true;
3531 /* check for power lost */
3532 pwrmask = dap->dp_ctrl_stat & (CDBGPWRUPREQ | CSYSPWRUPREQ);
3533 if ((ctrlstat & pwrmask) != pwrmask)
3534 dap->do_reconnect = true;
3536 return saved_retval;
3540 static void stlink_dap_op_quit(struct adiv5_dap *dap)
3544 retval = stlink_dap_closeall_ap();
3545 if (retval != ERROR_OK)
3546 LOG_ERROR("Error closing APs");
3549 static int stlink_dap_config_trace(bool enabled,
3550 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
3551 unsigned int *trace_freq, unsigned int traceclkin_freq,
3552 uint16_t *prescaler)
3554 return stlink_config_trace(stlink_dap_handle, enabled, pin_protocol,
3555 port_size, trace_freq, traceclkin_freq,
3559 static int stlink_dap_trace_read(uint8_t *buf, size_t *size)
3561 return stlink_usb_trace_read(stlink_dap_handle, buf, size);
3565 COMMAND_HANDLER(stlink_dap_serial_command)
3567 LOG_DEBUG("stlink_dap_serial_command");
3569 if (CMD_ARGC != 1) {
3570 LOG_ERROR("Expected exactly one argument for \"st-link serial <serial-number>\".");
3571 return ERROR_COMMAND_SYNTAX_ERROR;
3574 if (stlink_dap_param.serial) {
3575 LOG_WARNING("Command \"st-link serial\" already used. Replacing previous value");
3576 free((void *)stlink_dap_param.serial);
3579 stlink_dap_param.serial = strdup(CMD_ARGV[0]);
3584 COMMAND_HANDLER(stlink_dap_vid_pid)
3586 unsigned int i, max_usb_ids = HLA_MAX_USB_IDS;
3588 if (CMD_ARGC > max_usb_ids * 2) {
3589 LOG_WARNING("ignoring extra IDs in vid_pid "
3590 "(maximum is %d pairs)", max_usb_ids);
3591 CMD_ARGC = max_usb_ids * 2;
3593 if (CMD_ARGC < 2 || (CMD_ARGC & 1)) {
3594 LOG_WARNING("incomplete vid_pid configuration directive");
3595 return ERROR_COMMAND_SYNTAX_ERROR;
3597 for (i = 0; i < CMD_ARGC; i += 2) {
3598 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i], stlink_dap_param.vid[i / 2]);
3599 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], stlink_dap_param.pid[i / 2]);
3602 /* null termination */
3603 stlink_dap_param.vid[i / 2] = stlink_dap_param.pid[i / 2] = 0;
3609 static const struct command_registration stlink_dap_subcommand_handlers[] = {
3612 .handler = stlink_dap_serial_command,
3613 .mode = COMMAND_CONFIG,
3614 .help = "set the serial number of the adapter",
3615 .usage = "<serial_number>",
3619 .handler = stlink_dap_vid_pid,
3620 .mode = COMMAND_CONFIG,
3621 .help = "USB VID and PID of the adapter",
3622 .usage = "(vid pid)+",
3624 COMMAND_REGISTRATION_DONE
3628 static const struct command_registration stlink_dap_command_handlers[] = {
3631 .mode = COMMAND_ANY,
3632 .help = "perform st-link management",
3633 .chain = stlink_dap_subcommand_handlers,
3636 COMMAND_REGISTRATION_DONE
3640 static int stlink_dap_init(void)
3642 enum reset_types jtag_reset_config = jtag_get_reset_config();
3643 enum stlink_mode mode;
3646 LOG_DEBUG("stlink_dap_init()");
3648 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
3649 if (jtag_reset_config & RESET_SRST_NO_GATING)
3650 stlink_dap_param.connect_under_reset = true;
3652 LOG_WARNING("\'srst_nogate\' reset_config option is required");
3655 if (transport_is_dapdirect_swd())
3656 mode = STLINK_MODE_DEBUG_SWD;
3657 else if (transport_is_dapdirect_jtag())
3658 mode = STLINK_MODE_DEBUG_JTAG;
3660 LOG_ERROR("Unsupported transport");
3664 retval = stlink_usb_open(&stlink_dap_param, mode, (void **)&stlink_dap_handle);
3665 if (retval != ERROR_OK)
3668 if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_DAP_REG)) {
3669 LOG_ERROR("ST-Link version does not support DAP direct transport");
3676 static int stlink_dap_quit(void)
3678 LOG_DEBUG("stlink_dap_quit()");
3680 free((void *)stlink_dap_param.serial);
3681 stlink_dap_param.serial = NULL;
3683 return stlink_usb_close(stlink_dap_handle);
3687 static int stlink_dap_reset(int req_trst, int req_srst)
3689 LOG_DEBUG("stlink_dap_reset(%d)", req_srst);
3690 return stlink_usb_assert_srst(stlink_dap_handle,
3691 req_srst ? STLINK_DEBUG_APIV2_DRIVE_NRST_LOW
3692 : STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH);
3696 static int stlink_dap_speed(int speed)
3699 LOG_ERROR("RTCK not supported. Set nonzero adapter_khz.");
3700 return ERROR_JTAG_NOT_IMPLEMENTED;
3703 stlink_dap_param.initial_interface_speed = speed;
3704 stlink_speed(stlink_dap_handle, speed, false);
3709 static int stlink_dap_khz(int khz, int *jtag_speed)
3712 LOG_ERROR("RCLK not supported");
3716 *jtag_speed = stlink_speed(stlink_dap_handle, khz, true);
3721 static int stlink_dap_speed_div(int speed, int *khz)
3727 static const struct dap_ops stlink_dap_ops = {
3728 .connect = stlink_dap_op_connect,
3729 .send_sequence = stlink_dap_op_send_sequence,
3730 .queue_dp_read = stlink_dap_op_queue_dp_read,
3731 .queue_dp_write = stlink_dap_op_queue_dp_write,
3732 .queue_ap_read = stlink_dap_op_queue_ap_read,
3733 .queue_ap_write = stlink_dap_op_queue_ap_write,
3734 .queue_ap_abort = stlink_dap_op_queue_ap_abort,
3735 .run = stlink_dap_op_run,
3736 .sync = NULL, /* optional */
3737 .quit = stlink_dap_op_quit, /* optional */
3740 static const char *const stlink_dap_transport[] = { "dapdirect_jtag", "dapdirect_swd", NULL };
3742 struct adapter_driver stlink_dap_adapter_driver = {
3744 .transports = stlink_dap_transport,
3745 .commands = stlink_dap_command_handlers,
3747 .init = stlink_dap_init,
3748 .quit = stlink_dap_quit,
3749 .reset = stlink_dap_reset,
3750 .speed = stlink_dap_speed,
3751 .khz = stlink_dap_khz,
3752 .speed_div = stlink_dap_speed_div,
3753 .config_trace = stlink_dap_config_trace,
3754 .poll_trace = stlink_dap_trace_read,
3756 .dap_jtag_ops = &stlink_dap_ops,
3757 .dap_swd_ops = &stlink_dap_ops,