1 /***************************************************************************
2 * Copyright (C) 2011-2012 by Mathias Kuester *
3 * Mathias Kuester <kesmtp@freenet.de> *
5 * Copyright (C) 2012 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
8 * This code is based on https://github.com/texane/stlink *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
15 * This program is distributed in the hope that it will be useful, *
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18 * GNU General Public License for more details. *
20 * You should have received a copy of the GNU General Public License *
21 * along with this program; if not, write to the *
22 * Free Software Foundation, Inc., *
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
24 ***************************************************************************/
30 /* project specific includes */
31 #include <helper/binarybuffer.h>
32 #include <jtag/interface.h>
33 #include <jtag/hla/hla_layout.h>
34 #include <jtag/hla/hla_transport.h>
35 #include <jtag/hla/hla_interface.h>
36 #include <target/target.h>
38 #include <target/cortex_m.h>
40 #include "libusb_common.h"
42 #define ENDPOINT_IN 0x80
43 #define ENDPOINT_OUT 0x00
45 #define STLINK_WRITE_TIMEOUT 1000
46 #define STLINK_READ_TIMEOUT 1000
48 #define STLINK_NULL_EP 0
49 #define STLINK_RX_EP (1|ENDPOINT_IN)
50 #define STLINK_TX_EP (2|ENDPOINT_OUT)
51 #define STLINK_TRACE_EP (3|ENDPOINT_IN)
52 #define STLINK_SG_SIZE (31)
53 #define STLINK_DATA_SIZE (4096)
54 #define STLINK_CMD_SIZE_V2 (16)
55 #define STLINK_CMD_SIZE_V1 (10)
57 /* the current implementation of the stlink limits
58 * 8bit read/writes to max 64 bytes. */
59 #define STLINK_MAX_RW8 (64)
61 enum stlink_jtag_api_version
{
62 STLINK_JTAG_API_V1
= 1,
67 struct stlink_usb_version
{
74 /** highest supported jtag api version */
75 enum stlink_jtag_api_version jtag_api_max
;
79 struct stlink_usb_handle_s
{
81 struct jtag_libusb_device_handle
*fd
;
83 struct libusb_transfer
*trans
;
85 uint8_t cmdbuf
[STLINK_SG_SIZE
];
91 uint8_t databuf
[STLINK_DATA_SIZE
];
93 uint32_t max_mem_packet
;
95 enum hl_transports transport
;
97 struct stlink_usb_version version
;
102 /** this is the currently used jtag api */
103 enum stlink_jtag_api_version jtag_api
;
106 /** whether SWO tracing is enabled or not */
108 /** trace data destination file */
110 /** trace module source clock (for prescaler) */
112 /** trace module clock prescaler */
117 #define STLINK_DEBUG_ERR_OK 0x80
118 #define STLINK_DEBUG_ERR_FAULT 0x81
119 #define STLINK_SWD_AP_WAIT 0x10
120 #define STLINK_SWD_DP_WAIT 0x14
122 #define STLINK_CORE_RUNNING 0x80
123 #define STLINK_CORE_HALTED 0x81
124 #define STLINK_CORE_STAT_UNKNOWN -1
126 #define STLINK_GET_VERSION 0xF1
127 #define STLINK_DEBUG_COMMAND 0xF2
128 #define STLINK_DFU_COMMAND 0xF3
129 #define STLINK_SWIM_COMMAND 0xF4
130 #define STLINK_GET_CURRENT_MODE 0xF5
131 #define STLINK_GET_TARGET_VOLTAGE 0xF7
133 #define STLINK_DEV_DFU_MODE 0x00
134 #define STLINK_DEV_MASS_MODE 0x01
135 #define STLINK_DEV_DEBUG_MODE 0x02
136 #define STLINK_DEV_SWIM_MODE 0x03
137 #define STLINK_DEV_BOOTLOADER_MODE 0x04
138 #define STLINK_DEV_UNKNOWN_MODE -1
140 #define STLINK_DFU_EXIT 0x07
142 #define STLINK_SWIM_ENTER 0x00
143 #define STLINK_SWIM_EXIT 0x01
145 #define STLINK_DEBUG_ENTER_JTAG 0x00
146 #define STLINK_DEBUG_GETSTATUS 0x01
147 #define STLINK_DEBUG_FORCEDEBUG 0x02
148 #define STLINK_DEBUG_APIV1_RESETSYS 0x03
149 #define STLINK_DEBUG_APIV1_READALLREGS 0x04
150 #define STLINK_DEBUG_APIV1_READREG 0x05
151 #define STLINK_DEBUG_APIV1_WRITEREG 0x06
152 #define STLINK_DEBUG_READMEM_32BIT 0x07
153 #define STLINK_DEBUG_WRITEMEM_32BIT 0x08
154 #define STLINK_DEBUG_RUNCORE 0x09
155 #define STLINK_DEBUG_STEPCORE 0x0a
156 #define STLINK_DEBUG_APIV1_SETFP 0x0b
157 #define STLINK_DEBUG_READMEM_8BIT 0x0c
158 #define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
159 #define STLINK_DEBUG_APIV1_CLEARFP 0x0e
160 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG 0x0f
161 #define STLINK_DEBUG_APIV1_SETWATCHPOINT 0x10
163 #define STLINK_DEBUG_ENTER_JTAG 0x00
164 #define STLINK_DEBUG_ENTER_SWD 0xa3
166 #define STLINK_DEBUG_APIV1_ENTER 0x20
167 #define STLINK_DEBUG_EXIT 0x21
168 #define STLINK_DEBUG_READCOREID 0x22
170 #define STLINK_DEBUG_APIV2_ENTER 0x30
171 #define STLINK_DEBUG_APIV2_READ_IDCODES 0x31
172 #define STLINK_DEBUG_APIV2_RESETSYS 0x32
173 #define STLINK_DEBUG_APIV2_READREG 0x33
174 #define STLINK_DEBUG_APIV2_WRITEREG 0x34
175 #define STLINK_DEBUG_APIV2_WRITEDEBUGREG 0x35
176 #define STLINK_DEBUG_APIV2_READDEBUGREG 0x36
178 #define STLINK_DEBUG_APIV2_READALLREGS 0x3A
179 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
180 #define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
182 #define STLINK_DEBUG_APIV2_START_TRACE_RX 0x40
183 #define STLINK_DEBUG_APIV2_STOP_TRACE_RX 0x41
184 #define STLINK_DEBUG_APIV2_GET_TRACE_NB 0x42
186 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
187 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
188 #define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
190 #define STLINK_TRACE_SIZE 1024
191 #define STLINK_TRACE_MAX_HZ 2000000
192 #define STLINK_TRACE_MIN_VERSION 13
196 STLINK_MODE_UNKNOWN
= 0,
199 STLINK_MODE_DEBUG_JTAG
,
200 STLINK_MODE_DEBUG_SWD
,
201 STLINK_MODE_DEBUG_SWIM
204 #define REQUEST_SENSE 0x03
205 #define REQUEST_SENSE_LENGTH 18
207 static void stlink_usb_init_buffer(void *handle
, uint8_t direction
, uint32_t size
);
210 static int stlink_usb_xfer_v1_get_status(void *handle
)
212 struct stlink_usb_handle_s
*h
;
214 assert(handle
!= NULL
);
216 h
= (struct stlink_usb_handle_s
*)handle
;
219 memset(h
->cmdbuf
, 0, STLINK_SG_SIZE
);
221 if (jtag_libusb_bulk_read(h
->fd
, STLINK_RX_EP
, (char *)h
->cmdbuf
,
222 13, STLINK_READ_TIMEOUT
) != 13)
227 t1
= buf_get_u32(h
->cmdbuf
, 0, 32);
230 if (t1
!= 0x53425355)
238 if (h
->cmdbuf
[12] != 0)
245 static int stlink_usb_xfer_rw(void *handle
, int cmdsize
, const uint8_t *buf
, int size
)
247 struct stlink_usb_handle_s
*h
;
249 assert(handle
!= NULL
);
251 h
= (struct stlink_usb_handle_s
*)handle
;
253 if (jtag_libusb_bulk_write(h
->fd
, STLINK_TX_EP
, (char *)h
->cmdbuf
, cmdsize
,
254 STLINK_WRITE_TIMEOUT
) != cmdsize
) {
258 if (h
->direction
== STLINK_TX_EP
&& size
) {
259 if (jtag_libusb_bulk_write(h
->fd
, STLINK_TX_EP
, (char *)buf
,
260 size
, STLINK_WRITE_TIMEOUT
) != size
) {
261 LOG_DEBUG("bulk write failed");
264 } else if (h
->direction
== STLINK_RX_EP
&& size
) {
265 if (jtag_libusb_bulk_read(h
->fd
, STLINK_RX_EP
, (char *)buf
,
266 size
, STLINK_READ_TIMEOUT
) != size
) {
267 LOG_DEBUG("bulk read failed");
276 static int stlink_usb_xfer_v1_get_sense(void *handle
)
279 struct stlink_usb_handle_s
*h
;
281 assert(handle
!= NULL
);
283 h
= (struct stlink_usb_handle_s
*)handle
;
285 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 16);
287 h
->cmdbuf
[h
->cmdidx
++] = REQUEST_SENSE
;
288 h
->cmdbuf
[h
->cmdidx
++] = 0;
289 h
->cmdbuf
[h
->cmdidx
++] = 0;
290 h
->cmdbuf
[h
->cmdidx
++] = 0;
291 h
->cmdbuf
[h
->cmdidx
++] = REQUEST_SENSE_LENGTH
;
293 res
= stlink_usb_xfer_rw(handle
, REQUEST_SENSE_LENGTH
, h
->databuf
, 16);
298 if (stlink_usb_xfer_v1_get_status(handle
) != ERROR_OK
)
305 static int stlink_usb_xfer(void *handle
, const uint8_t *buf
, int size
)
307 int err
, cmdsize
= STLINK_CMD_SIZE_V2
;
308 struct stlink_usb_handle_s
*h
;
310 assert(handle
!= NULL
);
312 h
= (struct stlink_usb_handle_s
*)handle
;
314 if (h
->version
.stlink
== 1)
315 cmdsize
= STLINK_SG_SIZE
;
317 err
= stlink_usb_xfer_rw(handle
, cmdsize
, buf
, size
);
322 if (h
->version
.stlink
== 1) {
323 if (stlink_usb_xfer_v1_get_status(handle
) != ERROR_OK
) {
324 /* check csw status */
325 if (h
->cmdbuf
[12] == 1) {
326 LOG_DEBUG("get sense");
327 if (stlink_usb_xfer_v1_get_sense(handle
) != ERROR_OK
)
338 static int stlink_usb_read_trace(void *handle
, const uint8_t *buf
, int size
)
340 struct stlink_usb_handle_s
*h
;
342 assert(handle
!= NULL
);
344 h
= (struct stlink_usb_handle_s
*)handle
;
346 assert(h
->version
.stlink
>= 2);
348 if (jtag_libusb_bulk_read(h
->fd
, STLINK_TRACE_EP
, (char *)buf
,
349 size
, STLINK_READ_TIMEOUT
) != size
) {
350 LOG_ERROR("bulk trace read failed");
358 static void stlink_usb_xfer_v1_create_cmd(void *handle
, uint8_t direction
, uint32_t size
)
360 struct stlink_usb_handle_s
*h
;
362 h
= (struct stlink_usb_handle_s
*)handle
;
364 /* fill the send buffer */
365 strcpy((char *)h
->cmdbuf
, "USBC");
367 /* csw tag not used */
369 buf_set_u32(h
->cmdbuf
+h
->cmdidx
, 0, 32, size
);
371 h
->cmdbuf
[h
->cmdidx
++] = (direction
== STLINK_RX_EP
? ENDPOINT_IN
: ENDPOINT_OUT
);
372 h
->cmdbuf
[h
->cmdidx
++] = 0; /* lun */
373 h
->cmdbuf
[h
->cmdidx
++] = STLINK_CMD_SIZE_V1
;
377 static void stlink_usb_init_buffer(void *handle
, uint8_t direction
, uint32_t size
)
379 struct stlink_usb_handle_s
*h
;
381 h
= (struct stlink_usb_handle_s
*)handle
;
383 h
->direction
= direction
;
387 memset(h
->cmdbuf
, 0, STLINK_SG_SIZE
);
388 memset(h
->databuf
, 0, STLINK_DATA_SIZE
);
390 if (h
->version
.stlink
== 1)
391 stlink_usb_xfer_v1_create_cmd(handle
, direction
, size
);
394 static const char * const stlink_usb_error_msg
[] = {
399 static int stlink_usb_error_check(void *handle
)
402 const char *err_msg
= 0;
403 struct stlink_usb_handle_s
*h
;
405 assert(handle
!= NULL
);
407 h
= (struct stlink_usb_handle_s
*)handle
;
409 /* TODO: no error checking yet on api V1 */
410 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
411 h
->databuf
[0] = STLINK_DEBUG_ERR_OK
;
413 switch (h
->databuf
[0]) {
414 case STLINK_DEBUG_ERR_OK
:
417 case STLINK_DEBUG_ERR_FAULT
:
419 err_msg
= stlink_usb_error_msg
[0];
425 LOG_DEBUG("status error: %d ('%s')", h
->databuf
[0], err_msg
);
431 static int stlink_usb_version(void *handle
)
435 struct stlink_usb_handle_s
*h
;
437 assert(handle
!= NULL
);
439 h
= (struct stlink_usb_handle_s
*)handle
;
441 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 6);
443 h
->cmdbuf
[h
->cmdidx
++] = STLINK_GET_VERSION
;
445 res
= stlink_usb_xfer(handle
, h
->databuf
, 6);
450 v
= (h
->databuf
[0] << 8) | h
->databuf
[1];
452 h
->version
.stlink
= (v
>> 12) & 0x0f;
453 h
->version
.jtag
= (v
>> 6) & 0x3f;
454 h
->version
.swim
= v
& 0x3f;
455 h
->vid
= buf_get_u32(h
->databuf
, 16, 16);
456 h
->pid
= buf_get_u32(h
->databuf
, 32, 16);
458 /* set the supported jtag api version
459 * API V2 is supported since JTAG V11
461 if (h
->version
.jtag
>= 11)
462 h
->version
.jtag_api_max
= STLINK_JTAG_API_V2
;
464 h
->version
.jtag_api_max
= STLINK_JTAG_API_V1
;
466 LOG_INFO("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
469 (h
->version
.jtag_api_max
== STLINK_JTAG_API_V1
) ? 1 : 2,
477 static int stlink_usb_check_voltage(void *handle
, float *target_voltage
)
479 struct stlink_usb_handle_s
*h
;
480 uint32_t adc_results
[2];
482 h
= (struct stlink_usb_handle_s
*)handle
;
484 /* only supported by stlink/v2 and for firmware >= 13 */
485 if (h
->version
.stlink
== 1 || h
->version
.jtag
< 13)
486 return ERROR_COMMAND_NOTFOUND
;
488 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 8);
490 h
->cmdbuf
[h
->cmdidx
++] = STLINK_GET_TARGET_VOLTAGE
;
492 int result
= stlink_usb_xfer(handle
, h
->databuf
, 8);
494 if (result
!= ERROR_OK
)
498 adc_results
[0] = le_to_h_u32(h
->databuf
);
499 adc_results
[1] = le_to_h_u32(h
->databuf
+ 4);
504 *target_voltage
= 2 * ((float)adc_results
[1]) * (float)(1.2 / adc_results
[0]);
506 LOG_INFO("Target voltage: %f", (double)*target_voltage
);
512 static int stlink_usb_current_mode(void *handle
, uint8_t *mode
)
515 struct stlink_usb_handle_s
*h
;
517 assert(handle
!= NULL
);
519 h
= (struct stlink_usb_handle_s
*)handle
;
521 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
523 h
->cmdbuf
[h
->cmdidx
++] = STLINK_GET_CURRENT_MODE
;
525 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
530 *mode
= h
->databuf
[0];
536 static int stlink_usb_mode_enter(void *handle
, enum stlink_mode type
)
540 struct stlink_usb_handle_s
*h
;
542 assert(handle
!= NULL
);
544 h
= (struct stlink_usb_handle_s
*)handle
;
546 /* on api V2 we are able the read the latest command
548 * TODO: we need the test on api V1 too
550 if (h
->jtag_api
== STLINK_JTAG_API_V2
)
553 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, rx_size
);
556 case STLINK_MODE_DEBUG_JTAG
:
557 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
558 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
559 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_ENTER
;
561 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_ENTER
;
562 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_ENTER_JTAG
;
564 case STLINK_MODE_DEBUG_SWD
:
565 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
566 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
567 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_ENTER
;
569 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_ENTER
;
570 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_ENTER_SWD
;
572 case STLINK_MODE_DEBUG_SWIM
:
573 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
574 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_ENTER
;
576 case STLINK_MODE_DFU
:
577 case STLINK_MODE_MASS
:
582 res
= stlink_usb_xfer(handle
, h
->databuf
, rx_size
);
587 res
= stlink_usb_error_check(h
);
593 static int stlink_usb_mode_leave(void *handle
, enum stlink_mode type
)
596 struct stlink_usb_handle_s
*h
;
598 assert(handle
!= NULL
);
600 h
= (struct stlink_usb_handle_s
*)handle
;
602 stlink_usb_init_buffer(handle
, STLINK_NULL_EP
, 0);
605 case STLINK_MODE_DEBUG_JTAG
:
606 case STLINK_MODE_DEBUG_SWD
:
607 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
608 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_EXIT
;
610 case STLINK_MODE_DEBUG_SWIM
:
611 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_COMMAND
;
612 h
->cmdbuf
[h
->cmdidx
++] = STLINK_SWIM_EXIT
;
614 case STLINK_MODE_DFU
:
615 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DFU_COMMAND
;
616 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DFU_EXIT
;
618 case STLINK_MODE_MASS
:
623 res
= stlink_usb_xfer(handle
, 0, 0);
631 static int stlink_usb_assert_srst(void *handle
, int srst
);
634 static int stlink_usb_init_mode(void *handle
, bool connect_under_reset
)
638 enum stlink_mode emode
;
639 struct stlink_usb_handle_s
*h
;
641 assert(handle
!= NULL
);
643 h
= (struct stlink_usb_handle_s
*)handle
;
645 res
= stlink_usb_current_mode(handle
, &mode
);
650 LOG_DEBUG("MODE: 0x%02X", mode
);
652 /* try to exit current mode */
654 case STLINK_DEV_DFU_MODE
:
655 emode
= STLINK_MODE_DFU
;
657 case STLINK_DEV_DEBUG_MODE
:
658 emode
= STLINK_MODE_DEBUG_SWD
;
660 case STLINK_DEV_SWIM_MODE
:
661 emode
= STLINK_MODE_DEBUG_SWIM
;
663 case STLINK_DEV_BOOTLOADER_MODE
:
664 case STLINK_DEV_MASS_MODE
:
666 emode
= STLINK_MODE_UNKNOWN
;
670 if (emode
!= STLINK_MODE_UNKNOWN
) {
671 res
= stlink_usb_mode_leave(handle
, emode
);
677 res
= stlink_usb_current_mode(handle
, &mode
);
682 /* we check the target voltage here as an aid to debugging connection problems.
683 * the stlink requires the target Vdd to be connected for reliable debugging.
684 * this cmd is supported in all modes except DFU
686 if (mode
!= STLINK_DEV_DFU_MODE
) {
688 float target_voltage
;
690 /* check target voltage (if supported) */
691 res
= stlink_usb_check_voltage(h
, &target_voltage
);
693 if (res
!= ERROR_OK
) {
694 if (res
!= ERROR_COMMAND_NOTFOUND
)
695 LOG_ERROR("voltage check failed");
696 /* attempt to continue as it is not a catastrophic failure */
698 /* check for a sensible target voltage, operating range is 1.65-5.5v
699 * according to datasheet */
700 if (target_voltage
< 1.5)
701 LOG_ERROR("target voltage may be too low for reliable debugging");
705 LOG_DEBUG("MODE: 0x%02X", mode
);
707 /* set selected mode */
708 switch (h
->transport
) {
709 case HL_TRANSPORT_SWD
:
710 emode
= STLINK_MODE_DEBUG_SWD
;
712 case HL_TRANSPORT_JTAG
:
713 emode
= STLINK_MODE_DEBUG_JTAG
;
715 case HL_TRANSPORT_SWIM
:
716 emode
= STLINK_MODE_DEBUG_SWIM
;
719 emode
= STLINK_MODE_UNKNOWN
;
723 if (emode
== STLINK_MODE_UNKNOWN
) {
724 LOG_ERROR("selected mode (transport) not supported");
728 if (connect_under_reset
) {
729 res
= stlink_usb_assert_srst(handle
, 0);
734 res
= stlink_usb_mode_enter(handle
, emode
);
739 res
= stlink_usb_current_mode(handle
, &mode
);
744 LOG_DEBUG("MODE: 0x%02X", mode
);
750 static int stlink_usb_idcode(void *handle
, uint32_t *idcode
)
753 struct stlink_usb_handle_s
*h
;
755 assert(handle
!= NULL
);
757 h
= (struct stlink_usb_handle_s
*)handle
;
759 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 4);
761 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
762 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_READCOREID
;
764 res
= stlink_usb_xfer(handle
, h
->databuf
, 4);
769 *idcode
= le_to_h_u32(h
->databuf
);
771 LOG_DEBUG("IDCODE: 0x%08X", *idcode
);
776 static int stlink_usb_v2_read_debug_reg(void *handle
, uint32_t addr
, uint32_t *val
)
778 struct stlink_usb_handle_s
*h
;
781 assert(handle
!= NULL
);
783 h
= (struct stlink_usb_handle_s
*)handle
;
785 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 8);
787 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
788 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READDEBUGREG
;
789 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
792 res
= stlink_usb_xfer(handle
, h
->databuf
, 8);
797 *val
= le_to_h_u32(h
->databuf
+ 4);
799 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
802 static int stlink_usb_write_debug_reg(void *handle
, uint32_t addr
, uint32_t val
)
805 struct stlink_usb_handle_s
*h
;
807 assert(handle
!= NULL
);
809 h
= (struct stlink_usb_handle_s
*)handle
;
811 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
813 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
814 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
815 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG
;
817 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG
;
818 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
820 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, val
);
823 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
828 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
832 static void stlink_usb_trace_read(void *handle
)
834 struct stlink_usb_handle_s
*h
;
836 assert(handle
!= NULL
);
838 h
= (struct stlink_usb_handle_s
*)handle
;
840 if (h
->trace
.enabled
&& h
->version
.jtag
>= STLINK_TRACE_MIN_VERSION
) {
843 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 10);
845 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
846 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_GET_TRACE_NB
;
848 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
849 if (res
== ERROR_OK
) {
850 uint8_t buf
[STLINK_TRACE_SIZE
];
851 size_t size
= le_to_h_u16(h
->databuf
);
854 size
= size
< sizeof(buf
) ? size
: sizeof(buf
) - 1;
856 res
= stlink_usb_read_trace(handle
, buf
, size
);
857 if (res
== ERROR_OK
) {
858 /* Log retrieved trace output */
859 if (fwrite(buf
, 1, size
, h
->trace
.output_f
) > 0)
860 fflush(h
->trace
.output_f
);
867 static enum target_state
stlink_usb_v2_get_status(void *handle
)
872 result
= stlink_usb_v2_read_debug_reg(handle
, DCB_DHCSR
, &status
);
873 if (result
!= ERROR_OK
)
874 return TARGET_UNKNOWN
;
877 return TARGET_HALTED
;
878 else if (status
& S_RESET_ST
)
881 stlink_usb_trace_read(handle
);
883 return TARGET_RUNNING
;
887 static enum target_state
stlink_usb_state(void *handle
)
890 struct stlink_usb_handle_s
*h
;
892 assert(handle
!= NULL
);
894 h
= (struct stlink_usb_handle_s
*)handle
;
896 if (h
->jtag_api
== STLINK_JTAG_API_V2
)
897 return stlink_usb_v2_get_status(handle
);
899 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
901 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
902 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_GETSTATUS
;
904 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
907 return TARGET_UNKNOWN
;
909 if (h
->databuf
[0] == STLINK_CORE_RUNNING
)
910 return TARGET_RUNNING
;
911 if (h
->databuf
[0] == STLINK_CORE_HALTED
)
912 return TARGET_HALTED
;
914 return TARGET_UNKNOWN
;
918 static int stlink_usb_reset(void *handle
)
921 struct stlink_usb_handle_s
*h
;
923 assert(handle
!= NULL
);
925 h
= (struct stlink_usb_handle_s
*)handle
;
927 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
929 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
931 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
932 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_RESETSYS
;
934 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_RESETSYS
;
936 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
941 LOG_DEBUG("RESET: 0x%08X", h
->databuf
[0]);
943 /* the following is not a error under swd (using hardware srst), so return success */
944 if (h
->databuf
[0] == STLINK_SWD_AP_WAIT
|| h
->databuf
[0] == STLINK_SWD_DP_WAIT
)
947 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
950 static int stlink_usb_assert_srst(void *handle
, int srst
)
953 struct stlink_usb_handle_s
*h
;
955 assert(handle
!= NULL
);
957 h
= (struct stlink_usb_handle_s
*)handle
;
959 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
960 return ERROR_COMMAND_NOTFOUND
;
962 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
964 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
965 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_DRIVE_NRST
;
966 h
->cmdbuf
[h
->cmdidx
++] = srst
;
968 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
973 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
977 static int stlink_configure_target_trace_port(void *handle
)
981 struct stlink_usb_handle_s
*h
;
983 assert(handle
!= NULL
);
985 h
= (struct stlink_usb_handle_s
*)handle
;
987 /* configure the TPI */
989 /* enable the trace subsystem */
990 res
= stlink_usb_v2_read_debug_reg(handle
, DCB_DEMCR
, ®
);
993 res
= stlink_usb_write_debug_reg(handle
, DCB_DEMCR
, TRCENA
|reg
);
996 /* set the TPI clock prescaler */
997 res
= stlink_usb_write_debug_reg(handle
, TPI_ACPR
, h
->trace
.prescale
);
1000 /* select the pin protocol. The STLinkv2 only supports asynchronous
1001 * UART emulation (NRZ) mode, so that's what we pick. */
1002 res
= stlink_usb_write_debug_reg(handle
, TPI_SPPR
, 0x02);
1003 if (res
!= ERROR_OK
)
1005 /* disable continuous formatting */
1006 res
= stlink_usb_write_debug_reg(handle
, TPI_FFCR
, (1<<8));
1007 if (res
!= ERROR_OK
)
1010 /* configure the ITM */
1012 /* unlock access to the ITM registers */
1013 res
= stlink_usb_write_debug_reg(handle
, ITM_LAR
, 0xC5ACCE55);
1014 if (res
!= ERROR_OK
)
1016 /* enable trace with ATB ID 1 */
1017 res
= stlink_usb_write_debug_reg(handle
, ITM_TCR
, (1<<16)|(1<<0)|(1<<2));
1018 if (res
!= ERROR_OK
)
1020 /* trace privilege */
1021 res
= stlink_usb_write_debug_reg(handle
, ITM_TPR
, 1);
1022 if (res
!= ERROR_OK
)
1024 /* trace port enable (port 0) */
1025 res
= stlink_usb_write_debug_reg(handle
, ITM_TER
, (1<<0));
1026 if (res
!= ERROR_OK
)
1035 static void stlink_usb_trace_disable(void *handle
)
1038 struct stlink_usb_handle_s
*h
;
1040 assert(handle
!= NULL
);
1042 h
= (struct stlink_usb_handle_s
*)handle
;
1044 assert(h
->version
.jtag
>= STLINK_TRACE_MIN_VERSION
);
1046 LOG_DEBUG("Tracing: disable\n");
1048 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
1049 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1050 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX
;
1051 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1053 if (res
== ERROR_OK
)
1054 h
->trace
.enabled
= false;
1059 static int stlink_usb_trace_enable(void *handle
)
1062 struct stlink_usb_handle_s
*h
;
1064 assert(handle
!= NULL
);
1066 h
= (struct stlink_usb_handle_s
*)handle
;
1068 if (h
->version
.jtag
>= STLINK_TRACE_MIN_VERSION
) {
1071 res
= stlink_configure_target_trace_port(handle
);
1072 if (res
!= ERROR_OK
)
1073 LOG_ERROR("Unable to configure tracing on target\n");
1075 trace_hz
= h
->trace
.prescale
> 0 ?
1076 h
->trace
.source_hz
/ (h
->trace
.prescale
+ 1) :
1079 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 10);
1081 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1082 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_START_TRACE_RX
;
1083 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, (uint16_t)STLINK_TRACE_SIZE
);
1085 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, trace_hz
);
1088 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1090 if (res
== ERROR_OK
) {
1091 h
->trace
.enabled
= true;
1092 LOG_DEBUG("Tracing: recording at %uHz\n", trace_hz
);
1095 LOG_ERROR("Tracing is not supported by this version.");
1103 static int stlink_usb_run(void *handle
)
1106 struct stlink_usb_handle_s
*h
;
1108 assert(handle
!= NULL
);
1110 h
= (struct stlink_usb_handle_s
*)handle
;
1112 if (h
->jtag_api
== STLINK_JTAG_API_V2
) {
1113 res
= stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_DEBUGEN
);
1115 /* Try to start tracing, if requested */
1116 if (res
== ERROR_OK
&& h
->trace
.output_f
) {
1117 if (stlink_usb_trace_enable(handle
) == ERROR_OK
)
1118 LOG_DEBUG("Tracing: enabled\n");
1120 LOG_ERROR("Tracing: enable failed\n");
1126 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
1128 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1129 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_RUNCORE
;
1131 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1133 if (res
!= ERROR_OK
)
1136 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
1140 static int stlink_usb_halt(void *handle
)
1143 struct stlink_usb_handle_s
*h
;
1145 assert(handle
!= NULL
);
1147 h
= (struct stlink_usb_handle_s
*)handle
;
1149 if (h
->jtag_api
== STLINK_JTAG_API_V2
) {
1150 res
= stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_HALT
|C_DEBUGEN
);
1152 if (res
== ERROR_OK
&& h
->trace
.enabled
)
1153 stlink_usb_trace_disable(handle
);
1158 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
1160 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1161 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_FORCEDEBUG
;
1163 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1165 if (res
!= ERROR_OK
)
1168 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
1172 static int stlink_usb_step(void *handle
)
1175 struct stlink_usb_handle_s
*h
;
1177 assert(handle
!= NULL
);
1179 h
= (struct stlink_usb_handle_s
*)handle
;
1181 if (h
->jtag_api
== STLINK_JTAG_API_V2
) {
1182 /* TODO: this emulates the v1 api, it should really use a similar auto mask isr
1183 * that the cortex-m3 currently does. */
1184 stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_HALT
|C_MASKINTS
|C_DEBUGEN
);
1185 stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_STEP
|C_MASKINTS
|C_DEBUGEN
);
1186 return stlink_usb_write_debug_reg(handle
, DCB_DHCSR
, DBGKEY
|C_HALT
|C_DEBUGEN
);
1189 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
1191 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1192 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_STEPCORE
;
1194 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1196 if (res
!= ERROR_OK
)
1199 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
1203 static int stlink_usb_read_regs(void *handle
)
1206 struct stlink_usb_handle_s
*h
;
1208 assert(handle
!= NULL
);
1210 h
= (struct stlink_usb_handle_s
*)handle
;
1212 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 84);
1214 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1215 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
1216 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_READALLREGS
;
1218 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READALLREGS
;
1220 res
= stlink_usb_xfer(handle
, h
->databuf
, 84);
1222 if (res
!= ERROR_OK
)
1229 static int stlink_usb_read_reg(void *handle
, int num
, uint32_t *val
)
1232 struct stlink_usb_handle_s
*h
;
1234 assert(handle
!= NULL
);
1236 h
= (struct stlink_usb_handle_s
*)handle
;
1238 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, h
->jtag_api
== STLINK_JTAG_API_V1
? 4 : 8);
1240 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1241 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
1242 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_READREG
;
1244 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_READREG
;
1245 h
->cmdbuf
[h
->cmdidx
++] = num
;
1247 res
= stlink_usb_xfer(handle
, h
->databuf
, h
->jtag_api
== STLINK_JTAG_API_V1
? 4 : 8);
1249 if (res
!= ERROR_OK
)
1252 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
1253 *val
= le_to_h_u32(h
->databuf
);
1255 *val
= le_to_h_u32(h
->databuf
+ 4);
1256 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
1263 static int stlink_usb_write_reg(void *handle
, int num
, uint32_t val
)
1266 struct stlink_usb_handle_s
*h
;
1268 assert(handle
!= NULL
);
1270 h
= (struct stlink_usb_handle_s
*)handle
;
1272 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
1274 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1275 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
1276 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV1_WRITEREG
;
1278 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_WRITEREG
;
1279 h
->cmdbuf
[h
->cmdidx
++] = num
;
1280 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, val
);
1283 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1285 if (res
!= ERROR_OK
)
1288 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: ERROR_FAIL
;
1291 static int stlink_usb_get_rw_status(void *handle
)
1294 struct stlink_usb_handle_s
*h
;
1296 assert(handle
!= NULL
);
1298 h
= (struct stlink_usb_handle_s
*)handle
;
1300 if (h
->jtag_api
== STLINK_JTAG_API_V1
)
1303 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, 2);
1305 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1306 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS
;
1308 res
= stlink_usb_xfer(handle
, h
->databuf
, 2);
1310 if (res
!= ERROR_OK
)
1313 return h
->databuf
[0] == STLINK_DEBUG_ERR_OK
? ERROR_OK
: res
;
1317 static int stlink_usb_read_mem8(void *handle
, uint32_t addr
, uint16_t len
,
1321 uint16_t read_len
= len
;
1322 struct stlink_usb_handle_s
*h
;
1324 assert(handle
!= NULL
);
1326 /* max 8bit read/write is 64bytes */
1327 if (len
> STLINK_MAX_RW8
) {
1328 LOG_DEBUG("max buffer length exceeded");
1332 h
= (struct stlink_usb_handle_s
*)handle
;
1334 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, read_len
);
1336 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1337 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_READMEM_8BIT
;
1338 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1340 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1343 /* we need to fix read length for single bytes */
1347 res
= stlink_usb_xfer(handle
, h
->databuf
, read_len
);
1349 if (res
!= ERROR_OK
)
1352 memcpy(buffer
, h
->databuf
, len
);
1354 return stlink_usb_get_rw_status(handle
);
1358 static int stlink_usb_write_mem8(void *handle
, uint32_t addr
, uint16_t len
,
1359 const uint8_t *buffer
)
1362 struct stlink_usb_handle_s
*h
;
1364 assert(handle
!= NULL
);
1366 /* max 8bit read/write is 64bytes */
1367 if (len
> STLINK_MAX_RW8
) {
1368 LOG_DEBUG("max buffer length exceeded");
1372 h
= (struct stlink_usb_handle_s
*)handle
;
1374 stlink_usb_init_buffer(handle
, STLINK_TX_EP
, len
);
1376 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1377 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_WRITEMEM_8BIT
;
1378 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1380 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1383 res
= stlink_usb_xfer(handle
, buffer
, len
);
1385 if (res
!= ERROR_OK
)
1388 return stlink_usb_get_rw_status(handle
);
1392 static int stlink_usb_read_mem32(void *handle
, uint32_t addr
, uint16_t len
,
1396 struct stlink_usb_handle_s
*h
;
1398 assert(handle
!= NULL
);
1400 /* data must be a multiple of 4 and word aligned */
1401 if (len
% 4 || addr
% 4) {
1402 LOG_DEBUG("Invalid data alignment");
1403 return ERROR_TARGET_UNALIGNED_ACCESS
;
1406 h
= (struct stlink_usb_handle_s
*)handle
;
1408 stlink_usb_init_buffer(handle
, STLINK_RX_EP
, len
);
1410 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1411 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_READMEM_32BIT
;
1412 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1414 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1417 res
= stlink_usb_xfer(handle
, h
->databuf
, len
);
1419 if (res
!= ERROR_OK
)
1422 memcpy(buffer
, h
->databuf
, len
);
1424 return stlink_usb_get_rw_status(handle
);
1428 static int stlink_usb_write_mem32(void *handle
, uint32_t addr
, uint16_t len
,
1429 const uint8_t *buffer
)
1432 struct stlink_usb_handle_s
*h
;
1434 assert(handle
!= NULL
);
1436 /* data must be a multiple of 4 and word aligned */
1437 if (len
% 4 || addr
% 4) {
1438 LOG_DEBUG("Invalid data alignment");
1439 return ERROR_TARGET_UNALIGNED_ACCESS
;
1442 h
= (struct stlink_usb_handle_s
*)handle
;
1444 stlink_usb_init_buffer(handle
, STLINK_TX_EP
, len
);
1446 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_COMMAND
;
1447 h
->cmdbuf
[h
->cmdidx
++] = STLINK_DEBUG_WRITEMEM_32BIT
;
1448 h_u32_to_le(h
->cmdbuf
+h
->cmdidx
, addr
);
1450 h_u16_to_le(h
->cmdbuf
+h
->cmdidx
, len
);
1453 res
= stlink_usb_xfer(handle
, buffer
, len
);
1455 if (res
!= ERROR_OK
)
1458 return stlink_usb_get_rw_status(handle
);
1461 static uint32_t stlink_max_block_size(uint32_t tar_autoincr_block
, uint32_t address
)
1463 uint32_t max_tar_block
= (tar_autoincr_block
- ((tar_autoincr_block
- 1) & address
));
1464 if (max_tar_block
== 0)
1466 return max_tar_block
;
1469 static int stlink_usb_read_mem(void *handle
, uint32_t addr
, uint32_t size
,
1470 uint32_t count
, uint8_t *buffer
)
1472 int retval
= ERROR_OK
;
1473 uint32_t bytes_remaining
;
1474 struct stlink_usb_handle_s
*h
= (struct stlink_usb_handle_s
*)handle
;
1476 /* calculate byte count */
1481 bytes_remaining
= (size
== 4) ? \
1482 stlink_max_block_size(h
->max_mem_packet
, addr
) : STLINK_MAX_RW8
;
1484 if (count
< bytes_remaining
)
1485 bytes_remaining
= count
;
1487 /* the stlink only supports 8/32bit memory read/writes
1488 * honour 32bit, all others will be handled as 8bit access */
1491 /* When in jtag mode the stlink uses the auto-increment functinality.
1492 * However it expects us to pass the data correctly, this includes
1493 * alignment and any page boundaries. We already do this as part of the
1494 * adi_v5 implementation, but the stlink is a hla adapter and so this
1495 * needs implementiong manually.
1496 * currently this only affects jtag mode, according to ST they do single
1497 * access in SWD mode - but this may change and so we do it for both modes */
1499 /* we first need to check for any unaligned bytes */
1502 uint32_t head_bytes
= 4 - (addr
% 4);
1503 retval
= stlink_usb_read_mem8(handle
, addr
, head_bytes
, buffer
);
1504 if (retval
!= ERROR_OK
)
1506 buffer
+= head_bytes
;
1508 count
-= head_bytes
;
1509 bytes_remaining
-= head_bytes
;
1512 if (bytes_remaining
% 4)
1513 retval
= stlink_usb_read_mem(handle
, addr
, 1, bytes_remaining
, buffer
);
1515 retval
= stlink_usb_read_mem32(handle
, addr
, bytes_remaining
, buffer
);
1517 retval
= stlink_usb_read_mem8(handle
, addr
, bytes_remaining
, buffer
);
1519 if (retval
!= ERROR_OK
)
1522 buffer
+= bytes_remaining
;
1523 addr
+= bytes_remaining
;
1524 count
-= bytes_remaining
;
1530 static int stlink_usb_write_mem(void *handle
, uint32_t addr
, uint32_t size
,
1531 uint32_t count
, const uint8_t *buffer
)
1533 int retval
= ERROR_OK
;
1534 uint32_t bytes_remaining
;
1535 struct stlink_usb_handle_s
*h
= (struct stlink_usb_handle_s
*)handle
;
1537 /* calculate byte count */
1542 bytes_remaining
= (size
== 4) ? \
1543 stlink_max_block_size(h
->max_mem_packet
, addr
) : STLINK_MAX_RW8
;
1545 if (count
< bytes_remaining
)
1546 bytes_remaining
= count
;
1548 /* the stlink only supports 8/32bit memory read/writes
1549 * honour 32bit, all others will be handled as 8bit access */
1552 /* When in jtag mode the stlink uses the auto-increment functinality.
1553 * However it expects us to pass the data correctly, this includes
1554 * alignment and any page boundaries. We already do this as part of the
1555 * adi_v5 implementation, but the stlink is a hla adapter and so this
1556 * needs implementiong manually.
1557 * currently this only affects jtag mode, according to ST they do single
1558 * access in SWD mode - but this may change and so we do it for both modes */
1560 /* we first need to check for any unaligned bytes */
1563 uint32_t head_bytes
= 4 - (addr
% 4);
1564 retval
= stlink_usb_write_mem8(handle
, addr
, head_bytes
, buffer
);
1565 if (retval
!= ERROR_OK
)
1567 buffer
+= head_bytes
;
1569 count
-= head_bytes
;
1570 bytes_remaining
-= head_bytes
;
1573 if (bytes_remaining
% 4)
1574 retval
= stlink_usb_write_mem(handle
, addr
, 1, bytes_remaining
, buffer
);
1576 retval
= stlink_usb_write_mem32(handle
, addr
, bytes_remaining
, buffer
);
1579 retval
= stlink_usb_write_mem8(handle
, addr
, bytes_remaining
, buffer
);
1580 if (retval
!= ERROR_OK
)
1583 buffer
+= bytes_remaining
;
1584 addr
+= bytes_remaining
;
1585 count
-= bytes_remaining
;
1592 static int stlink_usb_close(void *fd
)
1594 struct stlink_usb_handle_s
*h
;
1596 h
= (struct stlink_usb_handle_s
*)fd
;
1599 jtag_libusb_close(h
->fd
);
1607 static int stlink_usb_open(struct hl_interface_param_s
*param
, void **fd
)
1609 int err
, retry_count
= 1;
1610 struct stlink_usb_handle_s
*h
;
1611 enum stlink_jtag_api_version api
;
1613 LOG_DEBUG("stlink_usb_open");
1615 h
= calloc(1, sizeof(struct stlink_usb_handle_s
));
1618 LOG_DEBUG("malloc failed");
1622 h
->transport
= param
->transport
;
1624 const uint16_t vids
[] = { param
->vid
, 0 };
1625 const uint16_t pids
[] = { param
->pid
, 0 };
1627 LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x", param
->transport
,
1628 param
->vid
, param
->pid
);
1631 On certain host USB configurations(e.g. MacBook Air)
1632 STLINKv2 dongle seems to have its FW in a funky state if,
1633 after plugging it in, you try to use openocd with it more
1634 then once (by launching and closing openocd). In cases like
1635 that initial attempt to read the FW info via
1636 stlink_usb_version will fail and the device has to be reset
1637 in order to become operational.
1640 if (jtag_libusb_open(vids
, pids
, &h
->fd
) != ERROR_OK
) {
1641 LOG_ERROR("open failed");
1645 jtag_libusb_set_configuration(h
->fd
, 0);
1647 if (jtag_libusb_claim_interface(h
->fd
, 0) != ERROR_OK
) {
1648 LOG_DEBUG("claim interface failed");
1652 /* wrap version for first read */
1653 switch (param
->pid
) {
1655 h
->version
.stlink
= 1;
1658 h
->version
.stlink
= 2;
1662 /* get the device version */
1663 err
= stlink_usb_version(h
);
1665 if (err
== ERROR_OK
) {
1667 } else if (h
->version
.stlink
== 1 ||
1669 LOG_ERROR("read version failed");
1672 err
= jtag_libusb_release_interface(h
->fd
, 0);
1673 if (err
!= ERROR_OK
) {
1674 LOG_ERROR("release interface failed");
1678 err
= jtag_libusb_reset_device(h
->fd
);
1679 if (err
!= ERROR_OK
) {
1680 LOG_ERROR("reset device failed");
1684 jtag_libusb_close(h
->fd
);
1686 Give the device one second to settle down and
1689 usleep(1 * 1000 * 1000);
1694 /* compare usb vid/pid */
1695 if ((param
->vid
!= h
->vid
) || (param
->pid
!= h
->pid
))
1696 LOG_INFO("vid/pid are not identical: 0x%04X/0x%04X 0x%04X/0x%04X",
1697 param
->vid
, param
->pid
,
1700 /* check if mode is supported */
1703 switch (h
->transport
) {
1704 case HL_TRANSPORT_SWD
:
1705 case HL_TRANSPORT_JTAG
:
1706 if (h
->version
.jtag
== 0)
1709 case HL_TRANSPORT_SWIM
:
1710 if (h
->version
.swim
== 0)
1718 if (err
!= ERROR_OK
) {
1719 LOG_ERROR("mode (transport) not supported by device");
1723 api
= h
->version
.jtag_api_max
;
1725 /* check that user has not requested certain api version
1726 * and if they have check it is supported */
1727 if ((param
->api
!= 0) && (param
->api
<= h
->version
.jtag_api_max
)) {
1729 LOG_INFO("using stlink api v%d", api
);
1732 /* set the used jtag api, this will default to the newest supported version */
1735 if (h
->jtag_api
>= 2 && param
->trace_f
&& param
->trace_source_hz
> 0) {
1738 prescale
= param
->trace_source_hz
> STLINK_TRACE_MAX_HZ
?
1739 (param
->trace_source_hz
/ STLINK_TRACE_MAX_HZ
) - 1 : 0;
1741 h
->trace
.output_f
= param
->trace_f
;
1742 h
->trace
.source_hz
= param
->trace_source_hz
;
1743 h
->trace
.prescale
= prescale
;
1746 /* initialize the debug hardware */
1747 err
= stlink_usb_init_mode(h
, param
->connect_under_reset
);
1749 if (err
!= ERROR_OK
) {
1750 LOG_ERROR("init mode failed");
1754 /* get cpuid, so we can determine the max page size
1755 * start with a safe default */
1756 h
->max_mem_packet
= (1 << 10);
1759 err
= stlink_usb_read_mem32(h
, CPUID
, 4, buffer
);
1760 if (err
== ERROR_OK
) {
1761 uint32_t cpuid
= le_to_h_u32(buffer
);
1762 int i
= (cpuid
>> 4) & 0xf;
1763 if (i
== 4 || i
== 3) {
1764 /* Cortex-M3/M4 has 4096 bytes autoincrement range */
1765 h
->max_mem_packet
= (1 << 12);
1769 LOG_DEBUG("Using TAR autoincrement: %" PRIu32
, h
->max_mem_packet
);
1776 stlink_usb_close(h
);
1782 struct hl_layout_api_s stlink_usb_layout_api
= {
1784 .open
= stlink_usb_open
,
1786 .close
= stlink_usb_close
,
1788 .idcode
= stlink_usb_idcode
,
1790 .state
= stlink_usb_state
,
1792 .reset
= stlink_usb_reset
,
1794 .assert_srst
= stlink_usb_assert_srst
,
1796 .run
= stlink_usb_run
,
1798 .halt
= stlink_usb_halt
,
1800 .step
= stlink_usb_step
,
1802 .read_regs
= stlink_usb_read_regs
,
1804 .read_reg
= stlink_usb_read_reg
,
1806 .write_reg
= stlink_usb_write_reg
,
1808 .read_mem
= stlink_usb_read_mem
,
1810 .write_mem
= stlink_usb_write_mem
,
1812 .write_debug_reg
= stlink_usb_write_debug_reg
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)