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 <jtag/interface.h>
35 #include <jtag/hla/hla_layout.h>
36 #include <jtag/hla/hla_transport.h>
37 #include <jtag/hla/hla_interface.h>
38 #include <target/target.h>
40 #include <target/cortex_m.h>
42 #include "libusb_common.h"
44 #define ENDPOINT_IN 0x80
45 #define ENDPOINT_OUT 0x00
47 #define STLINK_WRITE_TIMEOUT 1000
48 #define STLINK_READ_TIMEOUT 1000
50 #define STLINK_NULL_EP 0
51 #define STLINK_RX_EP (1|ENDPOINT_IN)
52 #define STLINK_TX_EP (2|ENDPOINT_OUT)
53 #define STLINK_TRACE_EP (3|ENDPOINT_IN)
55 #define STLINK_V2_1_TX_EP (1|ENDPOINT_OUT)
56 #define STLINK_V2_1_TRACE_EP (2|ENDPOINT_IN)
58 #define STLINK_SG_SIZE (31)
59 #define STLINK_DATA_SIZE (4096)
60 #define STLINK_CMD_SIZE_V2 (16)
61 #define STLINK_CMD_SIZE_V1 (10)
63 #define STLINK_V1_PID (0x3744)
64 #define STLINK_V2_PID (0x3748)
65 #define STLINK_V2_1_PID (0x374B)
66 #define STLINK_V2_1_NO_MSD_PID (0x3752)
68 /* the current implementation of the stlink limits
69 * 8bit read/writes to max 64 bytes. */
70 #define STLINK_MAX_RW8 (64)
72 /* "WAIT" responses will be retried (with exponential backoff) at
73 * most this many times before failing to caller.
75 #define MAX_WAIT_RETRIES 8
77 enum stlink_jtag_api_version
{
78 STLINK_JTAG_API_V1
= 1,
83 struct stlink_usb_version
{
90 /** jtag api version supported */
91 enum stlink_jtag_api_version jtag_api
;
92 /** one bit for each feature supported. See macros STLINK_F_* */
97 struct stlink_usb_handle_s
{
99 struct jtag_libusb_device_handle
*fd
;
101 struct libusb_transfer
*trans
;
109 uint8_t cmdbuf
[STLINK_SG_SIZE
];
115 uint8_t databuf
[STLINK_DATA_SIZE
];
117 uint32_t max_mem_packet
;
119 enum hl_transports transport
;
121 struct stlink_usb_version version
;
128 /** whether SWO tracing is enabled or not */
130 /** trace module source clock */
133 /** reconnect is needed next time we try to query the
135 bool reconnect_pending
;
138 #define STLINK_SWIM_ERR_OK 0x00
139 #define STLINK_SWIM_BUSY 0x01
140 #define STLINK_DEBUG_ERR_OK 0x80
141 #define STLINK_DEBUG_ERR_FAULT 0x81
142 #define STLINK_SWD_AP_WAIT 0x10
143 #define STLINK_SWD_AP_FAULT 0x11
144 #define STLINK_SWD_AP_ERROR 0x12
145 #define STLINK_SWD_AP_PARITY_ERROR 0x13
146 #define STLINK_JTAG_WRITE_ERROR 0x0c
147 #define STLINK_JTAG_WRITE_VERIF_ERROR 0x0d
148 #define STLINK_SWD_DP_WAIT 0x14
149 #define STLINK_SWD_DP_FAULT 0x15
150 #define STLINK_SWD_DP_ERROR 0x16
151 #define STLINK_SWD_DP_PARITY_ERROR 0x17
153 #define STLINK_SWD_AP_WDATA_ERROR 0x18
154 #define STLINK_SWD_AP_STICKY_ERROR 0x19
155 #define STLINK_SWD_AP_STICKYORUN_ERROR 0x1a
157 #define STLINK_CORE_RUNNING 0x80
158 #define STLINK_CORE_HALTED 0x81
159 #define STLINK_CORE_STAT_UNKNOWN -1
161 #define STLINK_GET_VERSION 0xF1
162 #define STLINK_DEBUG_COMMAND 0xF2
163 #define STLINK_DFU_COMMAND 0xF3
164 #define STLINK_SWIM_COMMAND 0xF4
165 #define STLINK_GET_CURRENT_MODE 0xF5
166 #define STLINK_GET_TARGET_VOLTAGE 0xF7
168 #define STLINK_DEV_DFU_MODE 0x00
169 #define STLINK_DEV_MASS_MODE 0x01
170 #define STLINK_DEV_DEBUG_MODE 0x02
171 #define STLINK_DEV_SWIM_MODE 0x03
172 #define STLINK_DEV_BOOTLOADER_MODE 0x04
173 #define STLINK_DEV_UNKNOWN_MODE -1
175 #define STLINK_DFU_EXIT 0x07
178 STLINK_SWIM_ENTER_SEQ
179 1.3ms low then 750Hz then 1.5kHz
182 STM8 DM pulls reset pin low 50us
185 uint8_t (0=low|1=high)
192 send syncronization seq (16us low, response 64 clocks low)
194 #define STLINK_SWIM_ENTER 0x00
195 #define STLINK_SWIM_EXIT 0x01
196 #define STLINK_SWIM_READ_CAP 0x02
197 #define STLINK_SWIM_SPEED 0x03
198 #define STLINK_SWIM_ENTER_SEQ 0x04
199 #define STLINK_SWIM_GEN_RST 0x05
200 #define STLINK_SWIM_RESET 0x06
201 #define STLINK_SWIM_ASSERT_RESET 0x07
202 #define STLINK_SWIM_DEASSERT_RESET 0x08
203 #define STLINK_SWIM_READSTATUS 0x09
204 #define STLINK_SWIM_WRITEMEM 0x0a
205 #define STLINK_SWIM_READMEM 0x0b
206 #define STLINK_SWIM_READBUF 0x0c
208 #define STLINK_DEBUG_GETSTATUS 0x01
209 #define STLINK_DEBUG_FORCEDEBUG 0x02
210 #define STLINK_DEBUG_APIV1_RESETSYS 0x03
211 #define STLINK_DEBUG_APIV1_READALLREGS 0x04
212 #define STLINK_DEBUG_APIV1_READREG 0x05
213 #define STLINK_DEBUG_APIV1_WRITEREG 0x06
214 #define STLINK_DEBUG_READMEM_32BIT 0x07
215 #define STLINK_DEBUG_WRITEMEM_32BIT 0x08
216 #define STLINK_DEBUG_RUNCORE 0x09
217 #define STLINK_DEBUG_STEPCORE 0x0a
218 #define STLINK_DEBUG_APIV1_SETFP 0x0b
219 #define STLINK_DEBUG_READMEM_8BIT 0x0c
220 #define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
221 #define STLINK_DEBUG_APIV1_CLEARFP 0x0e
222 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG 0x0f
223 #define STLINK_DEBUG_APIV1_SETWATCHPOINT 0x10
225 #define STLINK_DEBUG_ENTER_JTAG_RESET 0x00
226 #define STLINK_DEBUG_ENTER_SWD_NO_RESET 0xa3
227 #define STLINK_DEBUG_ENTER_JTAG_NO_RESET 0xa4
229 #define STLINK_DEBUG_APIV1_ENTER 0x20
230 #define STLINK_DEBUG_EXIT 0x21
231 #define STLINK_DEBUG_READCOREID 0x22
233 #define STLINK_DEBUG_APIV2_ENTER 0x30
234 #define STLINK_DEBUG_APIV2_READ_IDCODES 0x31
235 #define STLINK_DEBUG_APIV2_RESETSYS 0x32
236 #define STLINK_DEBUG_APIV2_READREG 0x33
237 #define STLINK_DEBUG_APIV2_WRITEREG 0x34
238 #define STLINK_DEBUG_APIV2_WRITEDEBUGREG 0x35
239 #define STLINK_DEBUG_APIV2_READDEBUGREG 0x36
241 #define STLINK_DEBUG_APIV2_READALLREGS 0x3A
242 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
243 #define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
245 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS2 0x3E
247 #define STLINK_DEBUG_APIV2_START_TRACE_RX 0x40
248 #define STLINK_DEBUG_APIV2_STOP_TRACE_RX 0x41
249 #define STLINK_DEBUG_APIV2_GET_TRACE_NB 0x42
250 #define STLINK_DEBUG_APIV2_SWD_SET_FREQ 0x43
251 #define STLINK_DEBUG_APIV2_JTAG_SET_FREQ 0x44
253 #define STLINK_DEBUG_APIV2_READMEM_16BIT 0x47
254 #define STLINK_DEBUG_APIV2_WRITEMEM_16BIT 0x48
256 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
257 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
258 #define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
260 #define STLINK_TRACE_SIZE 4096
261 #define STLINK_TRACE_MAX_HZ 2000000
265 STLINK_MODE_UNKNOWN
= 0,
268 STLINK_MODE_DEBUG_JTAG
,
269 STLINK_MODE_DEBUG_SWD
,
270 STLINK_MODE_DEBUG_SWIM
273 #define REQUEST_SENSE 0x03
274 #define REQUEST_SENSE_LENGTH 18
277 * Map the relevant features, quirks and workaround for specific firmware
280 #define STLINK_F_HAS_TRACE (1UL << 0)
281 #define STLINK_F_HAS_SWD_SET_FREQ (1UL << 1)
282 #define STLINK_F_HAS_JTAG_SET_FREQ (1UL << 2)
283 #define STLINK_F_HAS_MEM_16BIT (1UL << 3)
284 #define STLINK_F_HAS_GETLASTRWSTATUS2 (1UL << 4)
287 #define STLINK_F_HAS_TARGET_VOLT STLINK_F_HAS_TRACE
294 /* SWD clock speed */
295 static const struct speed_map stlink_khz_to_speed_map_swd
[] = {
297 {1800, 1}, /* default */
310 /* JTAG clock speed */
311 static const struct speed_map stlink_khz_to_speed_map_jtag
[] = {
316 {1125, 32}, /* default */
322 static void stlink_usb_init_buffer(void *handle
, uint8_t direction
, uint32_t size
);
323 static int stlink_swim_status(void *handle
);
326 static int stlink_usb_xfer_v1_get_status(void *handle
)
328 struct stlink_usb_handle_s
*h
= handle
;
330 assert(handle
!= NULL
);
333 memset(h
->cmdbuf
, 0, STLINK_SG_SIZE
);
335 if (jtag_libusb_bulk_read(h
->fd
, h
->rx_ep
, (char *)h
->cmdbuf
,
336 13, STLINK_READ_TIMEOUT
) != 13)
341 t1
= buf_get_u32(h
->cmdbuf
, 0, 32);
344 if (t1
!= 0x53425355)
352 if (h
->cmdbuf
[12] != 0)
359 static int stlink_usb_xfer_rw(void *handle
, int cmdsize
, const uint8_t *buf
, int size
)
361 struct stlink_usb_handle_s
*h
= handle
;
363 assert(handle
!= NULL
);
365 if (jtag_libusb_bulk_write(h
->fd
, h
->tx_ep
, (char *)h
->cmdbuf
, cmdsize
,
366 STLINK_WRITE_TIMEOUT
) != cmdsize
) {
370 if (h
->direction
== h
->tx_ep
&& size
) {
371 if (jtag_libusb_bulk_write(h
->fd
, h
->tx_ep
, (char *)buf
,
372 size
, STLINK_WRITE_TIMEOUT
) != size
) {
373 LOG_DEBUG("bulk write failed");
376 } else if (h
->direction
== h
->rx_ep
&& size
) {
377 if (jtag_libusb_bulk_read(h
->fd
, h
->rx_ep
, (char *)buf
,
378 size
, STLINK_READ_TIMEOUT
) != size
) {
379 LOG_DEBUG("bulk read failed");
388 static int stlink_usb_xfer_v1_get_sense(void *handle
)
391 struct stlink_usb_handle_s
*h
= handle
;
393 assert(handle
!= NULL
);
395 stlink_usb_init_buffer(handle
, h
->rx_ep
, 16);
397 h
->cmdbuf
[h
->cmdidx
++] = REQUEST_SENSE
;
398 h
->cmdbuf
[h
->cmdidx
++] = 0;
399 h
->cmdbuf
[h
->cmdidx
++] = 0;
400 h
->cmdbuf
[h
->cmdidx
++] = 0;
401 h
->cmdbuf
[h
->cmdidx
++] = REQUEST_SENSE_LENGTH
;
403 res
= stlink_usb_xfer_rw(handle
, REQUEST_SENSE_LENGTH
, h
->databuf
, 16);
408 if (stlink_usb_xfer_v1_get_status(handle
) != ERROR_OK
)
415 transfers block in cmdbuf
416 <size> indicates number of bytes in the following
419 static int stlink_usb_xfer(void *handle
, const uint8_t *buf
, int size
)
421 int err
, cmdsize
= STLINK_CMD_SIZE_V2
;
422 struct stlink_usb_handle_s
*h
= handle
;
424 assert(handle
!= NULL
);
426 if (h
->version
.stlink
== 1) {
427 cmdsize
= STLINK_SG_SIZE
;
428 /* put length in bCBWCBLength */
429 h
->cmdbuf
[14] = h
->cmdidx
-15;
432 err
= stlink_usb_xfer_rw(handle
, cmdsize
, buf
, size
);
437 if (h
->version
.stlink
== 1) {
438 if (stlink_usb_xfer_v1_get_status(handle
) != ERROR_OK
) {
439 /* check csw status */
440 if (h
->cmdbuf
[12] == 1) {
441 LOG_DEBUG("get sense");
442 if (stlink_usb_xfer_v1_get_sense(handle
) != ERROR_OK
)
453 Converts an STLINK status code held in the first byte of a response
454 to an openocd error, logs any error/wait status as debug output.
456 static int stlink_usb_error_check(void *handle
)
458 struct stlink_usb_handle_s
*h
= handle
;
460 assert(handle
!= NULL
);
462 if (h
->transport
== HL_TRANSPORT_SWIM
) {
463 switch (h
->databuf
[0]) {
464 case STLINK_SWIM_ERR_OK
:
466 case STLINK_SWIM_BUSY
:
469 LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h
->databuf
[0]);
474 /* TODO: no error checking yet on api V1 */
475 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
476 h
->databuf
[0] = STLINK_DEBUG_ERR_OK
;
478 switch (h
->databuf
[0]) {
479 case STLINK_DEBUG_ERR_OK
:
481 case STLINK_DEBUG_ERR_FAULT
:
482 LOG_DEBUG("SWD fault response (0x%x)", STLINK_DEBUG_ERR_FAULT
);
484 case STLINK_SWD_AP_WAIT
:
485 LOG_DEBUG("wait status SWD_AP_WAIT (0x%x)", STLINK_SWD_AP_WAIT
);
487 case STLINK_SWD_DP_WAIT
:
488 LOG_DEBUG("wait status SWD_DP_WAIT (0x%x)", STLINK_SWD_DP_WAIT
);
490 case STLINK_JTAG_WRITE_ERROR
:
491 LOG_DEBUG("Write error");
493 case STLINK_JTAG_WRITE_VERIF_ERROR
:
494 LOG_DEBUG("Write verify error, ignoring");
496 case STLINK_SWD_AP_FAULT
:
497 /* git://git.ac6.fr/openocd commit 657e3e885b9ee10
498 * returns ERROR_OK with the comment:
499 * Change in error status when reading outside RAM.
500 * This fix allows CDT plugin to visualize memory.
502 LOG_DEBUG("STLINK_SWD_AP_FAULT");
504 case STLINK_SWD_AP_ERROR
:
505 LOG_DEBUG("STLINK_SWD_AP_ERROR");
507 case STLINK_SWD_AP_PARITY_ERROR
:
508 LOG_DEBUG("STLINK_SWD_AP_PARITY_ERROR");
510 case STLINK_SWD_DP_FAULT
:
511 LOG_DEBUG("STLINK_SWD_DP_FAULT");
513 case STLINK_SWD_DP_ERROR
:
514 LOG_DEBUG("STLINK_SWD_DP_ERROR");
516 case STLINK_SWD_DP_PARITY_ERROR
:
517 LOG_DEBUG("STLINK_SWD_DP_PARITY_ERROR");
519 case STLINK_SWD_AP_WDATA_ERROR
:
520 LOG_DEBUG("STLINK_SWD_AP_WDATA_ERROR");
522 case STLINK_SWD_AP_STICKY_ERROR
:
523 LOG_DEBUG("STLINK_SWD_AP_STICKY_ERROR");
525 case STLINK_SWD_AP_STICKYORUN_ERROR
:
526 LOG_DEBUG("STLINK_SWD_AP_STICKYORUN_ERROR");
529 LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h
->databuf
[0]);
535 /** Issue an STLINK command via USB transfer, with retries on any wait status responses.
537 Works for commands where the STLINK_DEBUG status is returned in the first
538 byte of the response packet. For SWIM a SWIM_READSTATUS is requested instead.
540 Returns an openocd result code.
542 static int stlink_cmd_allow_retry(void *handle
, const uint8_t *buf
, int size
)
546 struct stlink_usb_handle_s
*h
= handle
;
549 if ((h
->transport
!= HL_TRANSPORT_SWIM
) || !retries
) {
550 res
= stlink_usb_xfer(handle
, buf
, size
);
555 if (h
->transport
== HL_TRANSPORT_SWIM
) {
556 res
= stlink_swim_status(handle
);
561 res
= stlink_usb_error_check(handle
);
562 if (res
== ERROR_WAIT
&& retries
< MAX_WAIT_RETRIES
) {
563 usleep((1<<retries
++) * 1000);
571 static int stlink_usb_read_trace(void *handle
, const uint8_t *buf
, int size
)
573 struct stlink_usb_handle_s
*h
= handle
;
575 assert(handle
!= NULL
);
577 assert(h
->version
.flags
& STLINK_F_HAS_TRACE
);
579 if (jtag_libusb_bulk_read(h
->fd
, h
->trace_ep
, (char *)buf
,
580 size
, STLINK_READ_TIMEOUT
) != size
) {
581 LOG_ERROR("bulk trace read failed");
589 this function writes transfer length in
590 the right place in the cb
592 static void stlink_usb_set_cbw_transfer_datalength(void *handle
, uint32_t size
)
594 struct stlink_usb_handle_s
*h
= handle
;
596 buf_set_u32(h
->cmdbuf
+8, 0, 32, size
);
599 static void stlink_usb_xfer_v1_create_cmd(void *handle
, uint8_t direction
, uint32_t size
)
601 struct stlink_usb_handle_s
*h
= handle
;
603 /* fill the send buffer */
604 strcpy((char *)h
->cmdbuf
, "USBC");
606 /* csw tag not used */
607 buf_set_u32(h
->cmdbuf
+h
->cmdidx
, 0, 32, 0);
609 /* cbw data transfer length (in the following data phase in or out) */
610 buf_set_u32(h
->cmdbuf
+h
->cmdidx
, 0, 32, size
);
613 h
->cmdbuf
[h
->cmdidx
++] = (direction
== h
->rx_ep
? ENDPOINT_IN
: ENDPOINT_OUT
);
614 h
->cmdbuf
[h
->cmdidx
++] = 0; /* lun */
615 /* cdb clength (is filled in at xfer) */
616 h
->cmdbuf
[h
->cmdidx
++] = 0;
620 static void stlink_usb_init_buffer(void *handle
, uint8_t direction
, uint32_t size
)
622 struct stlink_usb_handle_s
*h
= handle
;
624 h
->direction
= direction
;
628 memset(h
->cmdbuf
, 0, STLINK_SG_SIZE
);
629 memset(h
->databuf
, 0, STLINK_DATA_SIZE
);
631 if (h
->version
.stlink
== 1)
632 stlink_usb_xfer_v1_create_cmd(handle
, direction
, size
);
636 static int stlink_usb_version(void *handle
)
641 struct stlink_usb_handle_s
*h
= handle
;
643 assert(handle
!= NULL
);
645 stlink_usb_init_buffer(handle
, h
->rx_ep
, 6);
647 h
->cmdbuf
[h
->cmdidx
++] = STLINK_GET_VERSION
;
649 res
= stlink_usb_xfer(handle
, h
->databuf
, 6);
654 v
= (h
->databuf
[0] << 8) | h
->databuf
[1];
656 h
->version
.stlink
= (v
>> 12) & 0x0f;
657 h
->version
.jtag
= (v
>> 6) & 0x3f;
658 h
->version
.swim
= v
& 0x3f;
659 h
->vid
= buf_get_u32(h
->databuf
, 16, 16);
660 h
->pid
= buf_get_u32(h
->databuf
, 32, 16);
663 switch (h
->version
.stlink
) {
665 /* ST-LINK/V1 from J11 switch to api-v2 (and support SWD) */
666 if (h
->version
.jtag
>= 11)
667 h
->version
.jtag_api
= STLINK_JTAG_API_V2
;
669 h
->version
.jtag_api
= STLINK_JTAG_API_V1
;
673 /* all ST-LINK/V2 and ST-Link/V2.1 use api-v2 */
674 h
->version
.jtag_api
= STLINK_JTAG_API_V2
;
676 /* API for trace from J13 */
677 /* API for target voltage from J13 */
678 if (h
->version
.jtag
>= 13)
679 flags
|= STLINK_F_HAS_TRACE
;
681 /* preferred API to get last R/W status from J15 */
682 if (h
->version
.jtag
>= 15)
683 flags
|= STLINK_F_HAS_GETLASTRWSTATUS2
;
685 /* API to set SWD frequency from J22 */
686 if (h
->version
.jtag
>= 22)
687 flags
|= STLINK_F_HAS_SWD_SET_FREQ
;
689 /* API to set JTAG frequency from J24 */
690 if (h
->version
.jtag
>= 24)
691 flags
|= STLINK_F_HAS_JTAG_SET_FREQ
;
693 /* API to read/write memory at 16 bit from J26 */
694 if (h
->version
.jtag
>= 26)
695 flags
|= STLINK_F_HAS_MEM_16BIT
;
701 h
->version
.flags
= flags
;
703 LOG_INFO("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
706 (h
->version
.jtag_api
== STLINK_JTAG_API_V1
) ? 1 : 2,
714 static int stlink_usb_check_voltage(void *handle
, float *target_voltage
)
716 struct stlink_usb_handle_s
*h
= handle
;
717 uint32_t adc_results
[2];
719 /* no error message, simply quit with error */
720 if (!(h
->version
.flags
& STLINK_F_HAS_TARGET_VOLT
))
721 return ERROR_COMMAND_NOTFOUND
;
723 stlink_usb_init_buffer(handle
, h
->rx_ep
, 8);
725 h
->cmdbuf
[h
->cmdidx
++] = STLINK_GET_TARGET_VOLTAGE
;
727 int result
= stlink_usb_xfer(handle
, h
->databuf
, 8);
729 if (result
!= ERROR_OK
)
733 adc_results
[0] = le_to_h_u32(h
->databuf
);
734 adc_results
[1] = le_to_h_u32(h
->databuf
+ 4);
739 *target_voltage
= 2 * ((float)adc_results
[1]) * (float)(1.2 / adc_results
[0]);
741 LOG_INFO("Target voltage: %f", (double)*target_voltage
);
746 static int stlink_usb_set_swdclk(void *handle
, uint16_t clk_divisor
)
748 struct stlink_usb_handle_s
*h
= handle
;
750 assert(handle
!= NULL
);
752 if (!(h
->version
.flags
& STLINK_F_HAS_SWD_SET_FREQ
))
753 return ERROR_COMMAND_NOTFOUND
;
755 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
757 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
758 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_SWD_SET_FREQ
;
759 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, clk_divisor
);
762 int result
= stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
764 if (result
!= ERROR_OK
)
770 static int stlink_usb_set_jtagclk(void *handle
, uint16_t clk_divisor
)
772 struct stlink_usb_handle_s
*h
= handle
;
774 assert(handle
!= NULL
);
776 if (!(h
->version
.flags
& STLINK_F_HAS_JTAG_SET_FREQ
))
777 return ERROR_COMMAND_NOTFOUND
;
779 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
781 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
782 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_JTAG_SET_FREQ
;
783 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, clk_divisor
);
786 int result
= stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
788 if (result
!= ERROR_OK
)
795 static int stlink_usb_current_mode(void *handle
, uint8_t *mode
)
798 struct stlink_usb_handle_s
*h
= handle
;
800 assert(handle
!= NULL
);
802 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
804 h
->cmdbuf
[h
->cmdidx
++] = STLINK_GET_CURRENT_MODE
;
806 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
811 *mode
= h
->databuf
[0];
817 static int stlink_usb_mode_enter(void *handle
, enum stlink_mode type
)
820 struct stlink_usb_handle_s
*h
= handle
;
822 assert(handle
!= NULL
);
824 /* on api V2 we are able the read the latest command
826 * TODO: we need the test on api V1 too
828 if (h
->version
.jtag_api
== STLINK_JTAG_API_V2
)
831 stlink_usb_init_buffer(handle
, h
->rx_ep
, rx_size
);
834 case STLINK_MODE_DEBUG_JTAG
:
835 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
836 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
837 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_ENTER
;
839 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_ENTER
;
840 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_ENTER_JTAG_NO_RESET
;
842 case STLINK_MODE_DEBUG_SWD
:
843 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
844 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
845 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_ENTER
;
847 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_ENTER
;
848 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_ENTER_SWD_NO_RESET
;
850 case STLINK_MODE_DEBUG_SWIM
:
851 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
852 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_ENTER
;
853 /* no answer for this function... */
856 case STLINK_MODE_DFU
:
857 case STLINK_MODE_MASS
:
862 return stlink_cmd_allow_retry(handle
, h
->databuf
, rx_size
);
866 static int stlink_usb_mode_leave(void *handle
, enum stlink_mode type
)
869 struct stlink_usb_handle_s
*h
= handle
;
871 assert(handle
!= NULL
);
873 stlink_usb_init_buffer(handle
, STLINK_NULL_EP
, 0);
876 case STLINK_MODE_DEBUG_JTAG
:
877 case STLINK_MODE_DEBUG_SWD
:
878 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
879 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_EXIT
;
881 case STLINK_MODE_DEBUG_SWIM
:
882 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
883 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_EXIT
;
885 case STLINK_MODE_DFU
:
886 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DFU_COMMAND
;
887 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DFU_EXIT
;
889 case STLINK_MODE_MASS
:
894 res
= stlink_usb_xfer(handle
, 0, 0);
902 static int stlink_usb_assert_srst(void *handle
, int srst
);
904 static enum stlink_mode
stlink_get_mode(enum hl_transports t
)
907 case HL_TRANSPORT_SWD
:
908 return STLINK_MODE_DEBUG_SWD
;
909 case HL_TRANSPORT_JTAG
:
910 return STLINK_MODE_DEBUG_JTAG
;
911 case HL_TRANSPORT_SWIM
:
912 return STLINK_MODE_DEBUG_SWIM
;
914 return STLINK_MODE_UNKNOWN
;
919 static int stlink_usb_init_mode(void *handle
, bool connect_under_reset
)
923 enum stlink_mode emode
;
924 struct stlink_usb_handle_s
*h
= handle
;
926 assert(handle
!= NULL
);
928 res
= stlink_usb_current_mode(handle
, &mode
);
933 LOG_DEBUG("MODE: 0x%02X", mode
);
935 /* try to exit current mode */
937 case STLINK_DEV_DFU_MODE
:
938 emode
= STLINK_MODE_DFU
;
940 case STLINK_DEV_DEBUG_MODE
:
941 emode
= STLINK_MODE_DEBUG_SWD
;
943 case STLINK_DEV_SWIM_MODE
:
944 emode
= STLINK_MODE_DEBUG_SWIM
;
946 case STLINK_DEV_BOOTLOADER_MODE
:
947 case STLINK_DEV_MASS_MODE
:
949 emode
= STLINK_MODE_UNKNOWN
;
953 if (emode
!= STLINK_MODE_UNKNOWN
) {
954 res
= stlink_usb_mode_leave(handle
, emode
);
960 res
= stlink_usb_current_mode(handle
, &mode
);
965 /* we check the target voltage here as an aid to debugging connection problems.
966 * the stlink requires the target Vdd to be connected for reliable debugging.
967 * this cmd is supported in all modes except DFU
969 if (mode
!= STLINK_DEV_DFU_MODE
) {
971 float target_voltage
;
973 /* check target voltage (if supported) */
974 res
= stlink_usb_check_voltage(h
, &target_voltage
);
976 if (res
!= ERROR_OK
) {
977 if (res
!= ERROR_COMMAND_NOTFOUND
)
978 LOG_ERROR("voltage check failed");
979 /* attempt to continue as it is not a catastrophic failure */
981 /* check for a sensible target voltage, operating range is 1.65-5.5v
982 * according to datasheet */
983 if (target_voltage
< 1.5)
984 LOG_ERROR("target voltage may be too low for reliable debugging");
988 LOG_DEBUG("MODE: 0x%02X", mode
);
990 /* set selected mode */
991 emode
= stlink_get_mode(h
->transport
);
993 if (emode
== STLINK_MODE_UNKNOWN
) {
994 LOG_ERROR("selected mode (transport) not supported");
998 /* preliminary SRST assert:
999 * We want SRST is asserted before activating debug signals (mode_enter).
1000 * As the required mode has not been set, the adapter may not know what pin to use.
1001 * Tested firmware STLINK v2 JTAG v29 API v2 SWIM v0 uses T_NRST pin by default
1002 * Tested firmware STLINK v2 JTAG v27 API v2 SWIM v6 uses T_NRST pin by default
1003 * after power on, SWIM_RST stays unchanged */
1004 if (connect_under_reset
&& emode
!= STLINK_MODE_DEBUG_SWIM
)
1005 stlink_usb_assert_srst(handle
, 0);
1006 /* do not check the return status here, we will
1007 proceed and enter the desired mode below
1008 and try asserting srst again. */
1010 res
= stlink_usb_mode_enter(handle
, emode
);
1011 if (res
!= ERROR_OK
)
1014 /* assert SRST again: a little bit late but now the adapter knows for sure what pin to use */
1015 if (connect_under_reset
) {
1016 res
= stlink_usb_assert_srst(handle
, 0);
1017 if (res
!= ERROR_OK
)
1021 res
= stlink_usb_current_mode(handle
, &mode
);
1023 if (res
!= ERROR_OK
)
1026 LOG_DEBUG("MODE: 0x%02X", mode
);
1031 /* request status from last swim request */
1032 static int stlink_swim_status(void *handle
)
1034 struct stlink_usb_handle_s
*h
= handle
;
1037 stlink_usb_init_buffer(handle
, h
->rx_ep
, 4);
1038 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1039 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_READSTATUS
;
1040 res
= stlink_usb_xfer(handle
, h
->databuf
, 4);
1041 if (res
!= ERROR_OK
)
1046 the purpose of this function is unknown...
1047 capabilites? anyway for swim v6 it returns
1050 __attribute__((unused
))
1051 static int stlink_swim_cap(void *handle
, uint8_t *cap
)
1053 struct stlink_usb_handle_s
*h
= handle
;
1056 stlink_usb_init_buffer(handle
, h
->rx_ep
, 8);
1057 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1058 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_READ_CAP
;
1059 h
->cmdbuf
[h
->cmdidx
++] = 0x01;
1060 res
= stlink_usb_xfer(handle
, h
->databuf
, 8);
1061 if (res
!= ERROR_OK
)
1063 memcpy(cap
, h
->databuf
, 8);
1067 /* debug dongle assert/deassert sreset line */
1068 static int stlink_swim_assert_reset(void *handle
, int reset
)
1070 struct stlink_usb_handle_s
*h
= handle
;
1073 stlink_usb_init_buffer(handle
, h
->rx_ep
, 0);
1074 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1076 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_ASSERT_RESET
;
1078 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_DEASSERT_RESET
;
1079 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 0);
1080 if (res
!= ERROR_OK
)
1087 1.3ms low then 750Hz then 1.5kHz
1089 static int stlink_swim_enter(void *handle
)
1091 struct stlink_usb_handle_s
*h
= handle
;
1094 stlink_usb_init_buffer(handle
, h
->rx_ep
, 0);
1095 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1096 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_ENTER_SEQ
;
1097 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 0);
1098 if (res
!= ERROR_OK
)
1103 /* switch high/low speed swim */
1104 static int stlink_swim_speed(void *handle
, int speed
)
1106 struct stlink_usb_handle_s
*h
= handle
;
1109 stlink_usb_init_buffer(handle
, h
->rx_ep
, 0);
1110 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1111 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_SPEED
;
1113 h
->cmdbuf
[h
->cmdidx
++] = 1;
1115 h
->cmdbuf
[h
->cmdidx
++] = 0;
1116 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 0);
1117 if (res
!= ERROR_OK
)
1123 initiate srst from swim.
1124 nrst is pulled low for 50us.
1126 static int stlink_swim_generate_rst(void *handle
)
1128 struct stlink_usb_handle_s
*h
= handle
;
1131 stlink_usb_init_buffer(handle
, h
->rx_ep
, 0);
1132 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1133 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_GEN_RST
;
1134 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 0);
1135 if (res
!= ERROR_OK
)
1141 send resyncronize sequence
1142 swim is pulled low for 16us
1143 reply is 64 clks low
1145 static int stlink_swim_resync(void *handle
)
1147 struct stlink_usb_handle_s
*h
= handle
;
1150 stlink_usb_init_buffer(handle
, h
->rx_ep
, 0);
1151 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1152 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_RESET
;
1153 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 0);
1154 if (res
!= ERROR_OK
)
1159 static int stlink_swim_writebytes(void *handle
, uint32_t addr
, uint32_t len
, const uint8_t *data
)
1161 struct stlink_usb_handle_s
*h
= handle
;
1164 unsigned int datalen
= 0;
1165 int cmdsize
= STLINK_CMD_SIZE_V2
;
1167 if (len
> STLINK_DATA_SIZE
)
1170 if (h
->version
.stlink
== 1)
1171 cmdsize
= STLINK_SG_SIZE
;
1173 stlink_usb_init_buffer(handle
, h
->tx_ep
, 0);
1174 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1175 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_WRITEMEM
;
1176 h_u16_to_be(h
->cmdbuf
+h
->cmdidx
, len
);
1178 h_u32_to_be(h
->cmdbuf
+h
->cmdidx
, addr
);
1180 for (i
= 0; i
< len
; i
++) {
1181 if (h
->cmdidx
== cmdsize
)
1182 h
->databuf
[datalen
++] = *(data
++);
1184 h
->cmdbuf
[h
->cmdidx
++] = *(data
++);
1186 if (h
->version
.stlink
== 1)
1187 stlink_usb_set_cbw_transfer_datalength(handle
, datalen
);
1189 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, datalen
);
1190 if (res
!= ERROR_OK
)
1195 static int stlink_swim_readbytes(void *handle
, uint32_t addr
, uint32_t len
, uint8_t *data
)
1197 struct stlink_usb_handle_s
*h
= handle
;
1200 if (len
> STLINK_DATA_SIZE
)
1203 stlink_usb_init_buffer(handle
, h
->rx_ep
, 0);
1204 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1205 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_READMEM
;
1206 h_u16_to_be(h
->cmdbuf
+h
->cmdidx
, len
);
1208 h_u32_to_be(h
->cmdbuf
+h
->cmdidx
, addr
);
1210 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 0);
1211 if (res
!= ERROR_OK
)
1214 stlink_usb_init_buffer(handle
, h
->rx_ep
, len
);
1215 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
1216 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_READBUF
;
1217 res
= stlink_usb_xfer(handle
, data
, len
);
1218 if (res
!= ERROR_OK
)
1225 static int stlink_usb_idcode(void *handle
, uint32_t *idcode
)
1228 struct stlink_usb_handle_s
*h
= handle
;
1230 assert(handle
!= NULL
);
1232 /* there is no swim read core id cmd */
1233 if (h
->transport
== HL_TRANSPORT_SWIM
) {
1238 stlink_usb_init_buffer(handle
, h
->rx_ep
, 4);
1240 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1241 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_READCOREID
;
1243 res
= stlink_usb_xfer(handle
, h
->databuf
, 4);
1245 if (res
!= ERROR_OK
)
1248 *idcode
= le_to_h_u32(h
->databuf
);
1250 LOG_DEBUG("IDCODE: 0x%08" PRIX32
, *idcode
);
1255 static int stlink_usb_v2_read_debug_reg(void *handle
, uint32_t addr
, uint32_t *val
)
1257 struct stlink_usb_handle_s
*h
= handle
;
1260 assert(handle
!= NULL
);
1262 stlink_usb_init_buffer(handle
, h
->rx_ep
, 8);
1264 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1265 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READDEBUGREG
;
1266 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1269 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 8);
1270 if (res
!= ERROR_OK
)
1273 *val
= le_to_h_u32(h
->databuf
+ 4);
1277 static int stlink_usb_write_debug_reg(void *handle
, uint32_t addr
, uint32_t val
)
1279 struct stlink_usb_handle_s
*h
= handle
;
1281 assert(handle
!= NULL
);
1283 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1285 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1286 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
1287 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG
;
1289 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG
;
1290 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1292 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, val
);
1295 return stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1299 static int stlink_usb_trace_read(void *handle
, uint8_t *buf
, size_t *size
)
1301 struct stlink_usb_handle_s
*h
= handle
;
1303 assert(handle
!= NULL
);
1305 if (h
->trace
.enabled
&& (h
->version
.flags
& STLINK_F_HAS_TRACE
)) {
1308 stlink_usb_init_buffer(handle
, h
->rx_ep
, 10);
1310 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1311 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_GET_TRACE_NB
;
1313 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1314 if (res
!= ERROR_OK
)
1317 size_t bytes_avail
= le_to_h_u16(h
->databuf
);
1318 *size
= bytes_avail
< *size
? bytes_avail
: *size
- 1;
1321 res
= stlink_usb_read_trace(handle
, buf
, *size
);
1322 if (res
!= ERROR_OK
)
1331 static enum target_state
stlink_usb_v2_get_status(void *handle
)
1336 result
= stlink_usb_v2_read_debug_reg(handle
, DCB_DHCSR
, &status
);
1337 if (result
!= ERROR_OK
)
1338 return TARGET_UNKNOWN
;
1340 if (status
& S_HALT
)
1341 return TARGET_HALTED
;
1342 else if (status
& S_RESET_ST
)
1343 return TARGET_RESET
;
1345 return TARGET_RUNNING
;
1349 static enum target_state
stlink_usb_state(void *handle
)
1352 struct stlink_usb_handle_s
*h
= handle
;
1354 assert(handle
!= NULL
);
1356 if (h
->transport
== HL_TRANSPORT_SWIM
) {
1357 res
= stlink_usb_mode_enter(handle
, stlink_get_mode(h
->transport
));
1358 if (res
!= ERROR_OK
)
1359 return TARGET_UNKNOWN
;
1361 res
= stlink_swim_resync(handle
);
1362 if (res
!= ERROR_OK
)
1363 return TARGET_UNKNOWN
;
1368 if (h
->reconnect_pending
) {
1369 LOG_INFO("Previous state query failed, trying to reconnect");
1370 res
= stlink_usb_mode_enter(handle
, stlink_get_mode(h
->transport
));
1372 if (res
!= ERROR_OK
)
1373 return TARGET_UNKNOWN
;
1375 h
->reconnect_pending
= false;
1378 if (h
->version
.jtag_api
== STLINK_JTAG_API_V2
) {
1379 res
= stlink_usb_v2_get_status(handle
);
1380 if (res
== TARGET_UNKNOWN
)
1381 h
->reconnect_pending
= true;
1385 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1387 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1388 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_GETSTATUS
;
1390 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1392 if (res
!= ERROR_OK
)
1393 return TARGET_UNKNOWN
;
1395 if (h
->databuf
[0] == STLINK_CORE_RUNNING
)
1396 return TARGET_RUNNING
;
1397 if (h
->databuf
[0] == STLINK_CORE_HALTED
)
1398 return TARGET_HALTED
;
1400 h
->reconnect_pending
= true;
1402 return TARGET_UNKNOWN
;
1405 static int stlink_usb_assert_srst(void *handle
, int srst
)
1407 struct stlink_usb_handle_s
*h
= handle
;
1409 assert(handle
!= NULL
);
1411 if (h
->transport
== HL_TRANSPORT_SWIM
)
1412 return stlink_swim_assert_reset(handle
, srst
);
1414 if (h
->version
.stlink
== 1)
1415 return ERROR_COMMAND_NOTFOUND
;
1417 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1419 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1420 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_DRIVE_NRST
;
1421 h
->cmdbuf
[h
->cmdidx
++] = srst
;
1423 return stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1427 static void stlink_usb_trace_disable(void *handle
)
1430 struct stlink_usb_handle_s
*h
= handle
;
1432 assert(handle
!= NULL
);
1434 assert(h
->version
.flags
& STLINK_F_HAS_TRACE
);
1436 LOG_DEBUG("Tracing: disable");
1438 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1439 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1440 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX
;
1441 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1443 if (res
== ERROR_OK
)
1444 h
->trace
.enabled
= false;
1449 static int stlink_usb_trace_enable(void *handle
)
1452 struct stlink_usb_handle_s
*h
= handle
;
1454 assert(handle
!= NULL
);
1456 if (h
->version
.flags
& STLINK_F_HAS_TRACE
) {
1457 stlink_usb_init_buffer(handle
, h
->rx_ep
, 10);
1459 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1460 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_START_TRACE_RX
;
1461 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, (uint16_t)STLINK_TRACE_SIZE
);
1463 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, h
->trace
.source_hz
);
1466 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1468 if (res
== ERROR_OK
) {
1469 h
->trace
.enabled
= true;
1470 LOG_DEBUG("Tracing: recording at %" PRIu32
"Hz", h
->trace
.source_hz
);
1473 LOG_ERROR("Tracing is not supported by this version.");
1481 static int stlink_usb_reset(void *handle
)
1483 struct stlink_usb_handle_s
*h
= handle
;
1486 assert(handle
!= NULL
);
1488 if (h
->transport
== HL_TRANSPORT_SWIM
)
1489 return stlink_swim_generate_rst(handle
);
1491 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1493 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1495 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
1496 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_RESETSYS
;
1498 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_RESETSYS
;
1500 retval
= stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1501 if (retval
!= ERROR_OK
)
1504 if (h
->trace
.enabled
) {
1505 stlink_usb_trace_disable(h
);
1506 return stlink_usb_trace_enable(h
);
1513 static int stlink_usb_run(void *handle
)
1516 struct stlink_usb_handle_s
*h
= handle
;
1518 assert(handle
!= NULL
);
1520 if (h
->version
.jtag_api
== STLINK_JTAG_API_V2
) {
1521 res
= stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_DEBUGEN
);
1526 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1528 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1529 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_RUNCORE
;
1531 return stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1535 static int stlink_usb_halt(void *handle
)
1538 struct stlink_usb_handle_s
*h
= handle
;
1540 assert(handle
!= NULL
);
1542 if (h
->version
.jtag_api
== STLINK_JTAG_API_V2
) {
1543 res
= stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_HALT
|C_DEBUGEN
);
1548 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1550 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1551 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_FORCEDEBUG
;
1553 return stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1557 static int stlink_usb_step(void *handle
)
1559 struct stlink_usb_handle_s
*h
= handle
;
1561 assert(handle
!= NULL
);
1563 if (h
->version
.jtag_api
== STLINK_JTAG_API_V2
) {
1564 /* TODO: this emulates the v1 api, it should really use a similar auto mask isr
1565 * that the Cortex-M3 currently does. */
1566 stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_HALT
|C_MASKINTS
|C_DEBUGEN
);
1567 stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_STEP
|C_MASKINTS
|C_DEBUGEN
);
1568 return stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_HALT
|C_DEBUGEN
);
1571 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1573 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1574 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_STEPCORE
;
1576 return stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1580 static int stlink_usb_read_regs(void *handle
)
1583 struct stlink_usb_handle_s
*h
= handle
;
1585 assert(handle
!= NULL
);
1587 stlink_usb_init_buffer(handle
, h
->rx_ep
, 84);
1589 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1590 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
1591 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_READALLREGS
;
1593 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READALLREGS
;
1595 res
= stlink_usb_xfer(handle
, h
->databuf
, 84);
1597 if (res
!= ERROR_OK
)
1604 static int stlink_usb_read_reg(void *handle
, int num
, uint32_t *val
)
1607 struct stlink_usb_handle_s
*h
= handle
;
1609 assert(handle
!= NULL
);
1611 stlink_usb_init_buffer(handle
, h
->rx_ep
, h
->version
.jtag_api
== STLINK_JTAG_API_V1
? 4 : 8);
1613 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1614 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
1615 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_READREG
;
1617 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READREG
;
1618 h
->cmdbuf
[h
->cmdidx
++] = num
;
1620 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
) {
1621 res
= stlink_usb_xfer(handle
, h
->databuf
, 4);
1622 if (res
!= ERROR_OK
)
1624 *val
= le_to_h_u32(h
->databuf
);
1627 res
= stlink_cmd_allow_retry(handle
, h
->databuf
, 8);
1628 if (res
!= ERROR_OK
)
1630 *val
= le_to_h_u32(h
->databuf
+ 4);
1636 static int stlink_usb_write_reg(void *handle
, int num
, uint32_t val
)
1638 struct stlink_usb_handle_s
*h
= handle
;
1640 assert(handle
!= NULL
);
1642 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1644 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1645 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
1646 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_WRITEREG
;
1648 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_WRITEREG
;
1649 h
->cmdbuf
[h
->cmdidx
++] = num
;
1650 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, val
);
1653 return stlink_cmd_allow_retry(handle
, h
->databuf
, 2);
1656 static int stlink_usb_get_rw_status(void *handle
)
1659 struct stlink_usb_handle_s
*h
= handle
;
1661 assert(handle
!= NULL
);
1663 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
1666 stlink_usb_init_buffer(handle
, h
->rx_ep
, 2);
1668 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1669 if (h
->version
.flags
& STLINK_F_HAS_GETLASTRWSTATUS2
) {
1670 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS2
;
1672 res
= stlink_usb_xfer(handle
, h
->databuf
, 12);
1674 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS
;
1676 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1679 if (res
!= ERROR_OK
)
1682 return stlink_usb_error_check(h
);
1686 static int stlink_usb_read_mem8(void *handle
, uint32_t addr
, uint16_t len
,
1690 uint16_t read_len
= len
;
1691 struct stlink_usb_handle_s
*h
= handle
;
1693 assert(handle
!= NULL
);
1695 /* max 8bit read/write is 64bytes */
1696 if (len
> STLINK_MAX_RW8
) {
1697 LOG_DEBUG("max buffer length exceeded");
1701 stlink_usb_init_buffer(handle
, h
->rx_ep
, read_len
);
1703 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1704 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_READMEM_8BIT
;
1705 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1707 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1710 /* we need to fix read length for single bytes */
1714 res
= stlink_usb_xfer(handle
, h
->databuf
, read_len
);
1716 if (res
!= ERROR_OK
)
1719 memcpy(buffer
, h
->databuf
, len
);
1721 return stlink_usb_get_rw_status(handle
);
1725 static int stlink_usb_write_mem8(void *handle
, uint32_t addr
, uint16_t len
,
1726 const uint8_t *buffer
)
1729 struct stlink_usb_handle_s
*h
= handle
;
1731 assert(handle
!= NULL
);
1733 /* max 8bit read/write is 64bytes */
1734 if (len
> STLINK_MAX_RW8
) {
1735 LOG_DEBUG("max buffer length exceeded");
1739 stlink_usb_init_buffer(handle
, h
->tx_ep
, len
);
1741 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1742 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_WRITEMEM_8BIT
;
1743 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1745 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1748 res
= stlink_usb_xfer(handle
, buffer
, len
);
1750 if (res
!= ERROR_OK
)
1753 return stlink_usb_get_rw_status(handle
);
1757 static int stlink_usb_read_mem16(void *handle
, uint32_t addr
, uint16_t len
,
1761 struct stlink_usb_handle_s
*h
= handle
;
1763 assert(handle
!= NULL
);
1765 if (!(h
->version
.flags
& STLINK_F_HAS_MEM_16BIT
))
1766 return ERROR_COMMAND_NOTFOUND
;
1768 /* data must be a multiple of 2 and half-word aligned */
1769 if (len
% 2 || addr
% 2) {
1770 LOG_DEBUG("Invalid data alignment");
1771 return ERROR_TARGET_UNALIGNED_ACCESS
;
1774 stlink_usb_init_buffer(handle
, h
->rx_ep
, len
);
1776 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1777 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READMEM_16BIT
;
1778 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1780 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1783 res
= stlink_usb_xfer(handle
, h
->databuf
, len
);
1785 if (res
!= ERROR_OK
)
1788 memcpy(buffer
, h
->databuf
, len
);
1790 return stlink_usb_get_rw_status(handle
);
1794 static int stlink_usb_write_mem16(void *handle
, uint32_t addr
, uint16_t len
,
1795 const uint8_t *buffer
)
1798 struct stlink_usb_handle_s
*h
= handle
;
1800 assert(handle
!= NULL
);
1802 if (!(h
->version
.flags
& STLINK_F_HAS_MEM_16BIT
))
1803 return ERROR_COMMAND_NOTFOUND
;
1805 /* data must be a multiple of 2 and half-word aligned */
1806 if (len
% 2 || addr
% 2) {
1807 LOG_DEBUG("Invalid data alignment");
1808 return ERROR_TARGET_UNALIGNED_ACCESS
;
1811 stlink_usb_init_buffer(handle
, h
->tx_ep
, len
);
1813 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1814 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_WRITEMEM_16BIT
;
1815 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1817 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1820 res
= stlink_usb_xfer(handle
, buffer
, len
);
1822 if (res
!= ERROR_OK
)
1825 return stlink_usb_get_rw_status(handle
);
1829 static int stlink_usb_read_mem32(void *handle
, uint32_t addr
, uint16_t len
,
1833 struct stlink_usb_handle_s
*h
= handle
;
1835 assert(handle
!= NULL
);
1837 /* data must be a multiple of 4 and word aligned */
1838 if (len
% 4 || addr
% 4) {
1839 LOG_DEBUG("Invalid data alignment");
1840 return ERROR_TARGET_UNALIGNED_ACCESS
;
1843 stlink_usb_init_buffer(handle
, h
->rx_ep
, len
);
1845 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1846 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_READMEM_32BIT
;
1847 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1849 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1852 res
= stlink_usb_xfer(handle
, h
->databuf
, len
);
1854 if (res
!= ERROR_OK
)
1857 memcpy(buffer
, h
->databuf
, len
);
1859 return stlink_usb_get_rw_status(handle
);
1863 static int stlink_usb_write_mem32(void *handle
, uint32_t addr
, uint16_t len
,
1864 const uint8_t *buffer
)
1867 struct stlink_usb_handle_s
*h
= handle
;
1869 assert(handle
!= NULL
);
1871 /* data must be a multiple of 4 and word aligned */
1872 if (len
% 4 || addr
% 4) {
1873 LOG_DEBUG("Invalid data alignment");
1874 return ERROR_TARGET_UNALIGNED_ACCESS
;
1877 stlink_usb_init_buffer(handle
, h
->tx_ep
, len
);
1879 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1880 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_WRITEMEM_32BIT
;
1881 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1883 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1886 res
= stlink_usb_xfer(handle
, buffer
, len
);
1888 if (res
!= ERROR_OK
)
1891 return stlink_usb_get_rw_status(handle
);
1894 static uint32_t stlink_max_block_size(uint32_t tar_autoincr_block
, uint32_t address
)
1896 uint32_t max_tar_block
= (tar_autoincr_block
- ((tar_autoincr_block
- 1) & address
));
1897 if (max_tar_block
== 0)
1899 return max_tar_block
;
1902 static int stlink_usb_read_mem(void *handle
, uint32_t addr
, uint32_t size
,
1903 uint32_t count
, uint8_t *buffer
)
1905 int retval
= ERROR_OK
;
1906 uint32_t bytes_remaining
;
1908 struct stlink_usb_handle_s
*h
= handle
;
1910 /* calculate byte count */
1913 /* switch to 8 bit if stlink does not support 16 bit memory read */
1914 if (size
== 2 && !(h
->version
.flags
& STLINK_F_HAS_MEM_16BIT
))
1919 bytes_remaining
= (size
!= 1) ? \
1920 stlink_max_block_size(h
->max_mem_packet
, addr
) : STLINK_MAX_RW8
;
1922 if (count
< bytes_remaining
)
1923 bytes_remaining
= count
;
1925 if (h
->transport
== HL_TRANSPORT_SWIM
) {
1926 retval
= stlink_swim_readbytes(handle
, addr
, bytes_remaining
, buffer
);
1927 if (retval
!= ERROR_OK
)
1931 * all stlink support 8/32bit memory read/writes and only from
1932 * stlink V2J26 there is support for 16 bit memory read/write.
1933 * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
1938 /* When in jtag mode the stlink uses the auto-increment functionality.
1939 * However it expects us to pass the data correctly, this includes
1940 * alignment and any page boundaries. We already do this as part of the
1941 * adi_v5 implementation, but the stlink is a hla adapter and so this
1942 * needs implementing manually.
1943 * currently this only affects jtag mode, according to ST they do single
1944 * access in SWD mode - but this may change and so we do it for both modes */
1946 /* we first need to check for any unaligned bytes */
1947 if (addr
& (size
- 1)) {
1949 uint32_t head_bytes
= size
- (addr
& (size
- 1));
1950 retval
= stlink_usb_read_mem8(handle
, addr
, head_bytes
, buffer
);
1951 if (retval
== ERROR_WAIT
&& retries
< MAX_WAIT_RETRIES
) {
1952 usleep((1<<retries
++) * 1000);
1955 if (retval
!= ERROR_OK
)
1957 buffer
+= head_bytes
;
1959 count
-= head_bytes
;
1960 bytes_remaining
-= head_bytes
;
1963 if (bytes_remaining
& (size
- 1))
1964 retval
= stlink_usb_read_mem(handle
, addr
, 1, bytes_remaining
, buffer
);
1966 retval
= stlink_usb_read_mem16(handle
, addr
, bytes_remaining
, buffer
);
1968 retval
= stlink_usb_read_mem32(handle
, addr
, bytes_remaining
, buffer
);
1970 retval
= stlink_usb_read_mem8(handle
, addr
, bytes_remaining
, buffer
);
1972 if (retval
== ERROR_WAIT
&& retries
< MAX_WAIT_RETRIES
) {
1973 usleep((1<<retries
++) * 1000);
1976 if (retval
!= ERROR_OK
)
1979 buffer
+= bytes_remaining
;
1980 addr
+= bytes_remaining
;
1981 count
-= bytes_remaining
;
1987 static int stlink_usb_write_mem(void *handle
, uint32_t addr
, uint32_t size
,
1988 uint32_t count
, const uint8_t *buffer
)
1990 int retval
= ERROR_OK
;
1991 uint32_t bytes_remaining
;
1993 struct stlink_usb_handle_s
*h
= handle
;
1995 /* calculate byte count */
1998 /* switch to 8 bit if stlink does not support 16 bit memory read */
1999 if (size
== 2 && !(h
->version
.flags
& STLINK_F_HAS_MEM_16BIT
))
2004 bytes_remaining
= (size
!= 1) ? \
2005 stlink_max_block_size(h
->max_mem_packet
, addr
) : STLINK_MAX_RW8
;
2007 if (count
< bytes_remaining
)
2008 bytes_remaining
= count
;
2010 if (h
->transport
== HL_TRANSPORT_SWIM
) {
2011 retval
= stlink_swim_writebytes(handle
, addr
, bytes_remaining
, buffer
);
2012 if (retval
!= ERROR_OK
)
2016 * all stlink support 8/32bit memory read/writes and only from
2017 * stlink V2J26 there is support for 16 bit memory read/write.
2018 * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
2023 /* When in jtag mode the stlink uses the auto-increment functionality.
2024 * However it expects us to pass the data correctly, this includes
2025 * alignment and any page boundaries. We already do this as part of the
2026 * adi_v5 implementation, but the stlink is a hla adapter and so this
2027 * needs implementing manually.
2028 * currently this only affects jtag mode, according to ST they do single
2029 * access in SWD mode - but this may change and so we do it for both modes */
2031 /* we first need to check for any unaligned bytes */
2032 if (addr
& (size
- 1)) {
2034 uint32_t head_bytes
= size
- (addr
& (size
- 1));
2035 retval
= stlink_usb_write_mem8(handle
, addr
, head_bytes
, buffer
);
2036 if (retval
== ERROR_WAIT
&& retries
< MAX_WAIT_RETRIES
) {
2037 usleep((1<<retries
++) * 1000);
2040 if (retval
!= ERROR_OK
)
2042 buffer
+= head_bytes
;
2044 count
-= head_bytes
;
2045 bytes_remaining
-= head_bytes
;
2048 if (bytes_remaining
& (size
- 1))
2049 retval
= stlink_usb_write_mem(handle
, addr
, 1, bytes_remaining
, buffer
);
2051 retval
= stlink_usb_write_mem16(handle
, addr
, bytes_remaining
, buffer
);
2053 retval
= stlink_usb_write_mem32(handle
, addr
, bytes_remaining
, buffer
);
2056 retval
= stlink_usb_write_mem8(handle
, addr
, bytes_remaining
, buffer
);
2057 if (retval
== ERROR_WAIT
&& retries
< MAX_WAIT_RETRIES
) {
2058 usleep((1<<retries
++) * 1000);
2061 if (retval
!= ERROR_OK
)
2064 buffer
+= bytes_remaining
;
2065 addr
+= bytes_remaining
;
2066 count
-= bytes_remaining
;
2073 static int stlink_usb_override_target(const char *targetname
)
2075 return !strcmp(targetname
, "cortex_m");
2078 static int stlink_speed_swim(void *handle
, int khz
, bool query
)
2081 we dont care what the khz rate is
2082 we only have low and high speed...
2083 before changing speed the SWIM_CSR HS bit
2087 stlink_swim_speed(handle
, 0);
2089 stlink_swim_speed(handle
, 1);
2093 static int stlink_match_speed_map(const struct speed_map
*map
, unsigned int map_size
, int khz
, bool query
)
2096 int speed_index
= -1;
2097 int speed_diff
= INT_MAX
;
2100 for (i
= 0; i
< map_size
; i
++) {
2101 if (khz
== map
[i
].speed
) {
2105 int current_diff
= khz
- map
[i
].speed
;
2106 /* get abs value for comparison */
2107 current_diff
= (current_diff
> 0) ? current_diff
: -current_diff
;
2108 if ((current_diff
< speed_diff
) && khz
>= map
[i
].speed
) {
2109 speed_diff
= current_diff
;
2115 if (speed_index
== -1) {
2116 /* this will only be here if we cannot match the slow speed.
2117 * use the slowest speed we support.*/
2118 speed_index
= map_size
- 1;
2120 } else if (i
== map_size
)
2123 if (!match
&& query
) {
2124 LOG_INFO("Unable to match requested speed %d kHz, using %d kHz", \
2125 khz
, map
[speed_index
].speed
);
2131 static int stlink_speed_swd(void *handle
, int khz
, bool query
)
2134 struct stlink_usb_handle_s
*h
= handle
;
2136 /* old firmware cannot change it */
2137 if (!(h
->version
.flags
& STLINK_F_HAS_SWD_SET_FREQ
))
2140 speed_index
= stlink_match_speed_map(stlink_khz_to_speed_map_swd
,
2141 ARRAY_SIZE(stlink_khz_to_speed_map_swd
), khz
, query
);
2144 int result
= stlink_usb_set_swdclk(h
, stlink_khz_to_speed_map_swd
[speed_index
].speed_divisor
);
2145 if (result
!= ERROR_OK
) {
2146 LOG_ERROR("Unable to set adapter speed");
2151 return stlink_khz_to_speed_map_swd
[speed_index
].speed
;
2154 static int stlink_speed_jtag(void *handle
, int khz
, bool query
)
2157 struct stlink_usb_handle_s
*h
= handle
;
2159 /* old firmware cannot change it */
2160 if (!(h
->version
.flags
& STLINK_F_HAS_JTAG_SET_FREQ
))
2163 speed_index
= stlink_match_speed_map(stlink_khz_to_speed_map_jtag
,
2164 ARRAY_SIZE(stlink_khz_to_speed_map_jtag
), khz
, query
);
2167 int result
= stlink_usb_set_jtagclk(h
, stlink_khz_to_speed_map_jtag
[speed_index
].speed_divisor
);
2168 if (result
!= ERROR_OK
) {
2169 LOG_ERROR("Unable to set adapter speed");
2174 return stlink_khz_to_speed_map_jtag
[speed_index
].speed
;
2177 void stlink_dump_speed_map(const struct speed_map
*map
, unsigned int map_size
)
2181 LOG_DEBUG("Supported clock speeds are:");
2182 for (i
= 0; i
< map_size
; i
++)
2183 LOG_DEBUG("%d kHz", map
[i
].speed
);
2186 static int stlink_speed(void *handle
, int khz
, bool query
)
2188 struct stlink_usb_handle_s
*h
= handle
;
2193 if (h
->transport
== HL_TRANSPORT_SWIM
)
2194 return stlink_speed_swim(handle
, khz
, query
);
2195 else if (h
->transport
== HL_TRANSPORT_SWD
)
2196 return stlink_speed_swd(handle
, khz
, query
);
2197 else if (h
->transport
== HL_TRANSPORT_JTAG
)
2198 return stlink_speed_jtag(handle
, khz
, query
);
2204 static int stlink_usb_close(void *handle
)
2208 enum stlink_mode emode
;
2209 struct stlink_usb_handle_s
*h
= handle
;
2212 res
= stlink_usb_current_mode(handle
, &mode
);
2215 /* do not exit if return code != ERROR_OK,
2216 it prevents us from closing jtag_libusb */
2218 if (res
== ERROR_OK
) {
2219 /* try to exit current mode */
2221 case STLINK_DEV_DFU_MODE
:
2222 emode
= STLINK_MODE_DFU
;
2224 case STLINK_DEV_DEBUG_MODE
:
2225 emode
= STLINK_MODE_DEBUG_SWD
;
2227 case STLINK_DEV_SWIM_MODE
:
2228 emode
= STLINK_MODE_DEBUG_SWIM
;
2230 case STLINK_DEV_BOOTLOADER_MODE
:
2231 case STLINK_DEV_MASS_MODE
:
2233 emode
= STLINK_MODE_UNKNOWN
;
2237 if (emode
!= STLINK_MODE_UNKNOWN
)
2238 stlink_usb_mode_leave(handle
, emode
);
2239 /* do not check return code, it prevent
2240 us from closing jtag_libusb */
2244 jtag_libusb_close(h
->fd
);
2252 static int stlink_usb_open(struct hl_interface_param_s
*param
, void **fd
)
2254 int err
, retry_count
= 1;
2255 struct stlink_usb_handle_s
*h
;
2257 LOG_DEBUG("stlink_usb_open");
2259 h
= calloc(1, sizeof(struct stlink_usb_handle_s
));
2262 LOG_DEBUG("malloc failed");
2266 h
->transport
= param
->transport
;
2268 for (unsigned i
= 0; param
->vid
[i
]; i
++) {
2269 LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x serial: %s",
2270 param
->transport
, param
->vid
[i
], param
->pid
[i
],
2271 param
->serial
? param
->serial
: "");
2275 On certain host USB configurations(e.g. MacBook Air)
2276 STLINKv2 dongle seems to have its FW in a funky state if,
2277 after plugging it in, you try to use openocd with it more
2278 then once (by launching and closing openocd). In cases like
2279 that initial attempt to read the FW info via
2280 stlink_usb_version will fail and the device has to be reset
2281 in order to become operational.
2284 if (jtag_libusb_open(param
->vid
, param
->pid
, param
->serial
, &h
->fd
) != ERROR_OK
) {
2285 LOG_ERROR("open failed");
2289 jtag_libusb_set_configuration(h
->fd
, 0);
2291 if (jtag_libusb_claim_interface(h
->fd
, 0) != ERROR_OK
) {
2292 LOG_DEBUG("claim interface failed");
2296 /* RX EP is common for all versions */
2297 h
->rx_ep
= STLINK_RX_EP
;
2300 if (jtag_libusb_get_pid(jtag_libusb_get_device(h
->fd
), &pid
) != ERROR_OK
) {
2301 LOG_DEBUG("libusb_get_pid failed");
2305 /* wrap version for first read */
2308 h
->version
.stlink
= 1;
2309 h
->tx_ep
= STLINK_TX_EP
;
2311 case STLINK_V2_1_PID
:
2312 case STLINK_V2_1_NO_MSD_PID
:
2313 h
->version
.stlink
= 2;
2314 h
->tx_ep
= STLINK_V2_1_TX_EP
;
2315 h
->trace_ep
= STLINK_V2_1_TRACE_EP
;
2318 /* fall through - we assume V2 to be the default version*/
2320 h
->version
.stlink
= 2;
2321 h
->tx_ep
= STLINK_TX_EP
;
2322 h
->trace_ep
= STLINK_TRACE_EP
;
2326 /* get the device version */
2327 err
= stlink_usb_version(h
);
2329 if (err
== ERROR_OK
) {
2331 } else if (h
->version
.stlink
== 1 ||
2333 LOG_ERROR("read version failed");
2336 err
= jtag_libusb_release_interface(h
->fd
, 0);
2337 if (err
!= ERROR_OK
) {
2338 LOG_ERROR("release interface failed");
2342 err
= jtag_libusb_reset_device(h
->fd
);
2343 if (err
!= ERROR_OK
) {
2344 LOG_ERROR("reset device failed");
2348 jtag_libusb_close(h
->fd
);
2350 Give the device one second to settle down and
2353 usleep(1 * 1000 * 1000);
2358 /* check if mode is supported */
2361 switch (h
->transport
) {
2362 case HL_TRANSPORT_SWD
:
2363 if (h
->version
.jtag_api
== STLINK_JTAG_API_V1
)
2366 case HL_TRANSPORT_JTAG
:
2367 if (h
->version
.jtag
== 0)
2370 case HL_TRANSPORT_SWIM
:
2371 if (h
->version
.swim
== 0)
2379 if (err
!= ERROR_OK
) {
2380 LOG_ERROR("mode (transport) not supported by device");
2384 /* initialize the debug hardware */
2385 err
= stlink_usb_init_mode(h
, param
->connect_under_reset
);
2387 if (err
!= ERROR_OK
) {
2388 LOG_ERROR("init mode failed (unable to connect to the target)");
2392 if (h
->transport
== HL_TRANSPORT_SWIM
) {
2393 err
= stlink_swim_enter(h
);
2394 if (err
!= ERROR_OK
) {
2395 LOG_ERROR("stlink_swim_enter_failed (unable to connect to the target)");
2399 h
->max_mem_packet
= STLINK_DATA_SIZE
;
2403 if (h
->transport
== HL_TRANSPORT_JTAG
) {
2404 if (h
->version
.flags
& STLINK_F_HAS_JTAG_SET_FREQ
) {
2405 stlink_dump_speed_map(stlink_khz_to_speed_map_jtag
, ARRAY_SIZE(stlink_khz_to_speed_map_jtag
));
2406 stlink_speed(h
, param
->initial_interface_speed
, false);
2408 } else if (h
->transport
== HL_TRANSPORT_SWD
) {
2409 if (h
->version
.flags
& STLINK_F_HAS_SWD_SET_FREQ
) {
2410 stlink_dump_speed_map(stlink_khz_to_speed_map_swd
, ARRAY_SIZE(stlink_khz_to_speed_map_swd
));
2411 stlink_speed(h
, param
->initial_interface_speed
, false);
2415 /* get cpuid, so we can determine the max page size
2416 * start with a safe default */
2417 h
->max_mem_packet
= (1 << 10);
2420 err
= stlink_usb_read_mem32(h
, CPUID
, 4, buffer
);
2421 if (err
== ERROR_OK
) {
2422 uint32_t cpuid
= le_to_h_u32(buffer
);
2423 int i
= (cpuid
>> 4) & 0xf;
2424 if (i
== 4 || i
== 3) {
2425 /* Cortex-M3/M4 has 4096 bytes autoincrement range */
2426 h
->max_mem_packet
= (1 << 12);
2430 LOG_DEBUG("Using TAR autoincrement: %" PRIu32
, h
->max_mem_packet
);
2437 stlink_usb_close(h
);
2442 int stlink_config_trace(void *handle
, bool enabled
, enum tpiu_pin_protocol pin_protocol
,
2443 uint32_t port_size
, unsigned int *trace_freq
)
2445 struct stlink_usb_handle_s
*h
= handle
;
2447 if (enabled
&& (!(h
->version
.flags
& STLINK_F_HAS_TRACE
) ||
2448 pin_protocol
!= TPIU_PIN_PROTOCOL_ASYNC_UART
)) {
2449 LOG_ERROR("The attached ST-LINK version doesn't support this trace mode");
2454 stlink_usb_trace_disable(h
);
2458 if (*trace_freq
> STLINK_TRACE_MAX_HZ
) {
2459 LOG_ERROR("ST-LINK doesn't support SWO frequency higher than %u",
2460 STLINK_TRACE_MAX_HZ
);
2464 stlink_usb_trace_disable(h
);
2467 *trace_freq
= STLINK_TRACE_MAX_HZ
;
2468 h
->trace
.source_hz
= *trace_freq
;
2470 return stlink_usb_trace_enable(h
);
2474 struct hl_layout_api_s stlink_usb_layout_api
= {
2476 .open
= stlink_usb_open
,
2478 .close
= stlink_usb_close
,
2480 .idcode
= stlink_usb_idcode
,
2482 .state
= stlink_usb_state
,
2484 .reset
= stlink_usb_reset
,
2486 .assert_srst
= stlink_usb_assert_srst
,
2488 .run
= stlink_usb_run
,
2490 .halt
= stlink_usb_halt
,
2492 .step
= stlink_usb_step
,
2494 .read_regs
= stlink_usb_read_regs
,
2496 .read_reg
= stlink_usb_read_reg
,
2498 .write_reg
= stlink_usb_write_reg
,
2500 .read_mem
= stlink_usb_read_mem
,
2502 .write_mem
= stlink_usb_write_mem
,
2504 .write_debug_reg
= stlink_usb_write_debug_reg
,
2506 .override_target
= stlink_usb_override_target
,
2508 .speed
= stlink_speed
,
2510 .config_trace
= stlink_config_trace
,
2512 .poll_trace
= stlink_usb_trace_read
,