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)
53 #define STLINK_V2_1_TX_EP (1|ENDPOINT_OUT)
54 #define STLINK_V2_1_TRACE_EP (2|ENDPOINT_IN)
56 #define STLINK_SG_SIZE (31)
57 #define STLINK_DATA_SIZE (4096)
58 #define STLINK_CMD_SIZE_V2 (16)
59 #define STLINK_CMD_SIZE_V1 (10)
61 #define STLINK_V1_PID (0x3744)
62 #define STLINK_V2_PID (0x3748)
63 #define STLINK_V2_1_PID (0x374B)
65 /* the current implementation of the stlink limits
66 * 8bit read/writes to max 64 bytes. */
67 #define STLINK_MAX_RW8 (64)
69 enum stlink_jtag_api_version {
70 STLINK_JTAG_API_V1 = 1,
75 struct stlink_usb_version {
82 /** highest supported jtag api version */
83 enum stlink_jtag_api_version jtag_api_max;
87 struct stlink_usb_handle_s {
89 struct jtag_libusb_device_handle *fd;
91 struct libusb_transfer *trans;
99 uint8_t cmdbuf[STLINK_SG_SIZE];
105 uint8_t databuf[STLINK_DATA_SIZE];
107 uint32_t max_mem_packet;
109 enum hl_transports transport;
111 struct stlink_usb_version version;
116 /** this is the currently used jtag api */
117 enum stlink_jtag_api_version jtag_api;
120 /** whether SWO tracing is enabled or not */
122 /** trace data destination file */
124 /** trace module source clock (for prescaler) */
126 /** trace module clock prescaler */
131 #define STLINK_DEBUG_ERR_OK 0x80
132 #define STLINK_DEBUG_ERR_FAULT 0x81
133 #define STLINK_SWD_AP_WAIT 0x10
134 #define STLINK_SWD_DP_WAIT 0x14
136 #define STLINK_CORE_RUNNING 0x80
137 #define STLINK_CORE_HALTED 0x81
138 #define STLINK_CORE_STAT_UNKNOWN -1
140 #define STLINK_GET_VERSION 0xF1
141 #define STLINK_DEBUG_COMMAND 0xF2
142 #define STLINK_DFU_COMMAND 0xF3
143 #define STLINK_SWIM_COMMAND 0xF4
144 #define STLINK_GET_CURRENT_MODE 0xF5
145 #define STLINK_GET_TARGET_VOLTAGE 0xF7
147 #define STLINK_DEV_DFU_MODE 0x00
148 #define STLINK_DEV_MASS_MODE 0x01
149 #define STLINK_DEV_DEBUG_MODE 0x02
150 #define STLINK_DEV_SWIM_MODE 0x03
151 #define STLINK_DEV_BOOTLOADER_MODE 0x04
152 #define STLINK_DEV_UNKNOWN_MODE -1
154 #define STLINK_DFU_EXIT 0x07
156 #define STLINK_SWIM_ENTER 0x00
157 #define STLINK_SWIM_EXIT 0x01
159 #define STLINK_DEBUG_ENTER_JTAG 0x00
160 #define STLINK_DEBUG_GETSTATUS 0x01
161 #define STLINK_DEBUG_FORCEDEBUG 0x02
162 #define STLINK_DEBUG_APIV1_RESETSYS 0x03
163 #define STLINK_DEBUG_APIV1_READALLREGS 0x04
164 #define STLINK_DEBUG_APIV1_READREG 0x05
165 #define STLINK_DEBUG_APIV1_WRITEREG 0x06
166 #define STLINK_DEBUG_READMEM_32BIT 0x07
167 #define STLINK_DEBUG_WRITEMEM_32BIT 0x08
168 #define STLINK_DEBUG_RUNCORE 0x09
169 #define STLINK_DEBUG_STEPCORE 0x0a
170 #define STLINK_DEBUG_APIV1_SETFP 0x0b
171 #define STLINK_DEBUG_READMEM_8BIT 0x0c
172 #define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
173 #define STLINK_DEBUG_APIV1_CLEARFP 0x0e
174 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG 0x0f
175 #define STLINK_DEBUG_APIV1_SETWATCHPOINT 0x10
177 #define STLINK_DEBUG_ENTER_JTAG 0x00
178 #define STLINK_DEBUG_ENTER_SWD 0xa3
180 #define STLINK_DEBUG_APIV1_ENTER 0x20
181 #define STLINK_DEBUG_EXIT 0x21
182 #define STLINK_DEBUG_READCOREID 0x22
184 #define STLINK_DEBUG_APIV2_ENTER 0x30
185 #define STLINK_DEBUG_APIV2_READ_IDCODES 0x31
186 #define STLINK_DEBUG_APIV2_RESETSYS 0x32
187 #define STLINK_DEBUG_APIV2_READREG 0x33
188 #define STLINK_DEBUG_APIV2_WRITEREG 0x34
189 #define STLINK_DEBUG_APIV2_WRITEDEBUGREG 0x35
190 #define STLINK_DEBUG_APIV2_READDEBUGREG 0x36
192 #define STLINK_DEBUG_APIV2_READALLREGS 0x3A
193 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
194 #define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
196 #define STLINK_DEBUG_APIV2_START_TRACE_RX 0x40
197 #define STLINK_DEBUG_APIV2_STOP_TRACE_RX 0x41
198 #define STLINK_DEBUG_APIV2_GET_TRACE_NB 0x42
200 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
201 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
202 #define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
204 #define STLINK_TRACE_SIZE 1024
205 #define STLINK_TRACE_MAX_HZ 2000000
206 #define STLINK_TRACE_MIN_VERSION 13
210 STLINK_MODE_UNKNOWN = 0,
213 STLINK_MODE_DEBUG_JTAG,
214 STLINK_MODE_DEBUG_SWD,
215 STLINK_MODE_DEBUG_SWIM
218 #define REQUEST_SENSE 0x03
219 #define REQUEST_SENSE_LENGTH 18
221 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
224 static int stlink_usb_xfer_v1_get_status(void *handle)
226 struct stlink_usb_handle_s *h = handle;
228 assert(handle != NULL);
231 memset(h->cmdbuf, 0, STLINK_SG_SIZE);
233 if (jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)h->cmdbuf,
234 13, STLINK_READ_TIMEOUT) != 13)
239 t1 = buf_get_u32(h->cmdbuf, 0, 32);
242 if (t1 != 0x53425355)
250 if (h->cmdbuf[12] != 0)
257 static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
259 struct stlink_usb_handle_s *h = handle;
261 assert(handle != NULL);
263 if (jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)h->cmdbuf, cmdsize,
264 STLINK_WRITE_TIMEOUT) != cmdsize) {
268 if (h->direction == h->tx_ep && size) {
269 if (jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)buf,
270 size, STLINK_WRITE_TIMEOUT) != size) {
271 LOG_DEBUG("bulk write failed");
274 } else if (h->direction == h->rx_ep && size) {
275 if (jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)buf,
276 size, STLINK_READ_TIMEOUT) != size) {
277 LOG_DEBUG("bulk read failed");
286 static int stlink_usb_xfer_v1_get_sense(void *handle)
289 struct stlink_usb_handle_s *h = handle;
291 assert(handle != NULL);
293 stlink_usb_init_buffer(handle, h->rx_ep, 16);
295 h->cmdbuf[h->cmdidx++] = REQUEST_SENSE;
296 h->cmdbuf[h->cmdidx++] = 0;
297 h->cmdbuf[h->cmdidx++] = 0;
298 h->cmdbuf[h->cmdidx++] = 0;
299 h->cmdbuf[h->cmdidx++] = REQUEST_SENSE_LENGTH;
301 res = stlink_usb_xfer_rw(handle, REQUEST_SENSE_LENGTH, h->databuf, 16);
306 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK)
313 static int stlink_usb_xfer(void *handle, const uint8_t *buf, int size)
315 int err, cmdsize = STLINK_CMD_SIZE_V2;
316 struct stlink_usb_handle_s *h = handle;
318 assert(handle != NULL);
320 if (h->version.stlink == 1)
321 cmdsize = STLINK_SG_SIZE;
323 err = stlink_usb_xfer_rw(handle, cmdsize, buf, size);
328 if (h->version.stlink == 1) {
329 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK) {
330 /* check csw status */
331 if (h->cmdbuf[12] == 1) {
332 LOG_DEBUG("get sense");
333 if (stlink_usb_xfer_v1_get_sense(handle) != ERROR_OK)
344 static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
346 struct stlink_usb_handle_s *h = handle;
348 assert(handle != NULL);
350 assert(h->version.stlink >= 2);
352 if (jtag_libusb_bulk_read(h->fd, h->trace_ep, (char *)buf,
353 size, STLINK_READ_TIMEOUT) != size) {
354 LOG_ERROR("bulk trace read failed");
362 static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint32_t size)
364 struct stlink_usb_handle_s *h = handle;
366 /* fill the send buffer */
367 strcpy((char *)h->cmdbuf, "USBC");
369 /* csw tag not used */
371 buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, size);
373 h->cmdbuf[h->cmdidx++] = (direction == h->rx_ep ? ENDPOINT_IN : ENDPOINT_OUT);
374 h->cmdbuf[h->cmdidx++] = 0; /* lun */
375 h->cmdbuf[h->cmdidx++] = STLINK_CMD_SIZE_V1;
379 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size)
381 struct stlink_usb_handle_s *h = 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 = handle;
405 assert(handle != NULL);
407 /* TODO: no error checking yet on api V1 */
408 if (h->jtag_api == STLINK_JTAG_API_V1)
409 h->databuf[0] = STLINK_DEBUG_ERR_OK;
411 switch (h->databuf[0]) {
412 case STLINK_DEBUG_ERR_OK:
415 case STLINK_DEBUG_ERR_FAULT:
417 err_msg = stlink_usb_error_msg[0];
423 LOG_DEBUG("status error: %d ('%s')", h->databuf[0], err_msg);
429 static int stlink_usb_version(void *handle)
433 struct stlink_usb_handle_s *h = handle;
435 assert(handle != NULL);
437 stlink_usb_init_buffer(handle, h->rx_ep, 6);
439 h->cmdbuf[h->cmdidx++] = STLINK_GET_VERSION;
441 res = stlink_usb_xfer(handle, h->databuf, 6);
446 v = (h->databuf[0] << 8) | h->databuf[1];
448 h->version.stlink = (v >> 12) & 0x0f;
449 h->version.jtag = (v >> 6) & 0x3f;
450 h->version.swim = v & 0x3f;
451 h->vid = buf_get_u32(h->databuf, 16, 16);
452 h->pid = buf_get_u32(h->databuf, 32, 16);
454 /* set the supported jtag api version
455 * API V2 is supported since JTAG V11
457 if (h->version.jtag >= 11)
458 h->version.jtag_api_max = STLINK_JTAG_API_V2;
460 h->version.jtag_api_max = STLINK_JTAG_API_V1;
462 LOG_INFO("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
465 (h->version.jtag_api_max == STLINK_JTAG_API_V1) ? 1 : 2,
473 static int stlink_usb_check_voltage(void *handle, float *target_voltage)
475 struct stlink_usb_handle_s *h = handle;
476 uint32_t adc_results[2];
478 /* only supported by stlink/v2 and for firmware >= 13 */
479 if (h->version.stlink == 1 || h->version.jtag < 13)
480 return ERROR_COMMAND_NOTFOUND;
482 stlink_usb_init_buffer(handle, h->rx_ep, 8);
484 h->cmdbuf[h->cmdidx++] = STLINK_GET_TARGET_VOLTAGE;
486 int result = stlink_usb_xfer(handle, h->databuf, 8);
488 if (result != ERROR_OK)
492 adc_results[0] = le_to_h_u32(h->databuf);
493 adc_results[1] = le_to_h_u32(h->databuf + 4);
498 *target_voltage = 2 * ((float)adc_results[1]) * (float)(1.2 / adc_results[0]);
500 LOG_INFO("Target voltage: %f", (double)*target_voltage);
506 static int stlink_usb_current_mode(void *handle, uint8_t *mode)
509 struct stlink_usb_handle_s *h = handle;
511 assert(handle != NULL);
513 stlink_usb_init_buffer(handle, h->rx_ep, 2);
515 h->cmdbuf[h->cmdidx++] = STLINK_GET_CURRENT_MODE;
517 res = stlink_usb_xfer(handle, h->databuf, 2);
522 *mode = h->databuf[0];
528 static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
532 struct stlink_usb_handle_s *h = handle;
534 assert(handle != NULL);
536 /* on api V2 we are able the read the latest command
538 * TODO: we need the test on api V1 too
540 if (h->jtag_api == STLINK_JTAG_API_V2)
543 stlink_usb_init_buffer(handle, h->rx_ep, rx_size);
546 case STLINK_MODE_DEBUG_JTAG:
547 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
548 if (h->jtag_api == STLINK_JTAG_API_V1)
549 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
551 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
552 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_JTAG;
554 case STLINK_MODE_DEBUG_SWD:
555 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
556 if (h->jtag_api == STLINK_JTAG_API_V1)
557 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
559 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
560 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_SWD;
562 case STLINK_MODE_DEBUG_SWIM:
563 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
564 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ENTER;
566 case STLINK_MODE_DFU:
567 case STLINK_MODE_MASS:
572 res = stlink_usb_xfer(handle, h->databuf, rx_size);
577 res = stlink_usb_error_check(h);
583 static int stlink_usb_mode_leave(void *handle, enum stlink_mode type)
586 struct stlink_usb_handle_s *h = handle;
588 assert(handle != NULL);
590 stlink_usb_init_buffer(handle, STLINK_NULL_EP, 0);
593 case STLINK_MODE_DEBUG_JTAG:
594 case STLINK_MODE_DEBUG_SWD:
595 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
596 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_EXIT;
598 case STLINK_MODE_DEBUG_SWIM:
599 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
600 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_EXIT;
602 case STLINK_MODE_DFU:
603 h->cmdbuf[h->cmdidx++] = STLINK_DFU_COMMAND;
604 h->cmdbuf[h->cmdidx++] = STLINK_DFU_EXIT;
606 case STLINK_MODE_MASS:
611 res = stlink_usb_xfer(handle, 0, 0);
619 static int stlink_usb_assert_srst(void *handle, int srst);
622 static int stlink_usb_init_mode(void *handle, bool connect_under_reset)
626 enum stlink_mode emode;
627 struct stlink_usb_handle_s *h = handle;
629 assert(handle != NULL);
631 res = stlink_usb_current_mode(handle, &mode);
636 LOG_DEBUG("MODE: 0x%02X", mode);
638 /* try to exit current mode */
640 case STLINK_DEV_DFU_MODE:
641 emode = STLINK_MODE_DFU;
643 case STLINK_DEV_DEBUG_MODE:
644 emode = STLINK_MODE_DEBUG_SWD;
646 case STLINK_DEV_SWIM_MODE:
647 emode = STLINK_MODE_DEBUG_SWIM;
649 case STLINK_DEV_BOOTLOADER_MODE:
650 case STLINK_DEV_MASS_MODE:
652 emode = STLINK_MODE_UNKNOWN;
656 if (emode != STLINK_MODE_UNKNOWN) {
657 res = stlink_usb_mode_leave(handle, emode);
663 res = stlink_usb_current_mode(handle, &mode);
668 /* we check the target voltage here as an aid to debugging connection problems.
669 * the stlink requires the target Vdd to be connected for reliable debugging.
670 * this cmd is supported in all modes except DFU
672 if (mode != STLINK_DEV_DFU_MODE) {
674 float target_voltage;
676 /* check target voltage (if supported) */
677 res = stlink_usb_check_voltage(h, &target_voltage);
679 if (res != ERROR_OK) {
680 if (res != ERROR_COMMAND_NOTFOUND)
681 LOG_ERROR("voltage check failed");
682 /* attempt to continue as it is not a catastrophic failure */
684 /* check for a sensible target voltage, operating range is 1.65-5.5v
685 * according to datasheet */
686 if (target_voltage < 1.5)
687 LOG_ERROR("target voltage may be too low for reliable debugging");
691 LOG_DEBUG("MODE: 0x%02X", mode);
693 /* set selected mode */
694 switch (h->transport) {
695 case HL_TRANSPORT_SWD:
696 emode = STLINK_MODE_DEBUG_SWD;
698 case HL_TRANSPORT_JTAG:
699 emode = STLINK_MODE_DEBUG_JTAG;
701 case HL_TRANSPORT_SWIM:
702 emode = STLINK_MODE_DEBUG_SWIM;
705 emode = STLINK_MODE_UNKNOWN;
709 if (emode == STLINK_MODE_UNKNOWN) {
710 LOG_ERROR("selected mode (transport) not supported");
714 if (connect_under_reset) {
715 res = stlink_usb_assert_srst(handle, 0);
720 res = stlink_usb_mode_enter(handle, emode);
725 res = stlink_usb_current_mode(handle, &mode);
730 LOG_DEBUG("MODE: 0x%02X", mode);
736 static int stlink_usb_idcode(void *handle, uint32_t *idcode)
739 struct stlink_usb_handle_s *h = handle;
741 assert(handle != NULL);
743 stlink_usb_init_buffer(handle, h->rx_ep, 4);
745 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
746 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READCOREID;
748 res = stlink_usb_xfer(handle, h->databuf, 4);
753 *idcode = le_to_h_u32(h->databuf);
755 LOG_DEBUG("IDCODE: 0x%08" PRIX32, *idcode);
760 static int stlink_usb_v2_read_debug_reg(void *handle, uint32_t addr, uint32_t *val)
762 struct stlink_usb_handle_s *h = handle;
765 assert(handle != NULL);
767 stlink_usb_init_buffer(handle, h->rx_ep, 8);
769 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
770 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READDEBUGREG;
771 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
774 res = stlink_usb_xfer(handle, h->databuf, 8);
779 *val = le_to_h_u32(h->databuf + 4);
781 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
784 static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
787 struct stlink_usb_handle_s *h = handle;
789 assert(handle != NULL);
791 stlink_usb_init_buffer(handle, h->rx_ep, 2);
793 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
794 if (h->jtag_api == STLINK_JTAG_API_V1)
795 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG;
797 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG;
798 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
800 h_u32_to_le(h->cmdbuf+h->cmdidx, val);
803 res = stlink_usb_xfer(handle, h->databuf, 2);
808 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
812 static void stlink_usb_trace_read(void *handle)
814 struct stlink_usb_handle_s *h = handle;
816 assert(handle != NULL);
818 if (h->trace.enabled && h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
821 stlink_usb_init_buffer(handle, h->rx_ep, 10);
823 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
824 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GET_TRACE_NB;
826 res = stlink_usb_xfer(handle, h->databuf, 2);
827 if (res == ERROR_OK) {
828 uint8_t buf[STLINK_TRACE_SIZE];
829 size_t size = le_to_h_u16(h->databuf);
832 size = size < sizeof(buf) ? size : sizeof(buf) - 1;
834 res = stlink_usb_read_trace(handle, buf, size);
835 if (res == ERROR_OK) {
836 if (h->trace.output_f) {
837 /* Log retrieved trace output */
838 if (fwrite(buf, 1, size, h->trace.output_f) > 0)
839 fflush(h->trace.output_f);
847 static int stlink_usb_trace_read_callback(void *handle)
849 stlink_usb_trace_read(handle);
853 static enum target_state stlink_usb_v2_get_status(void *handle)
858 result = stlink_usb_v2_read_debug_reg(handle, DCB_DHCSR, &status);
859 if (result != ERROR_OK)
860 return TARGET_UNKNOWN;
863 return TARGET_HALTED;
864 else if (status & S_RESET_ST)
867 stlink_usb_trace_read(handle);
869 return TARGET_RUNNING;
873 static enum target_state stlink_usb_state(void *handle)
876 struct stlink_usb_handle_s *h = handle;
878 assert(handle != NULL);
880 if (h->jtag_api == STLINK_JTAG_API_V2)
881 return stlink_usb_v2_get_status(handle);
883 stlink_usb_init_buffer(handle, h->rx_ep, 2);
885 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
886 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_GETSTATUS;
888 res = stlink_usb_xfer(handle, h->databuf, 2);
891 return TARGET_UNKNOWN;
893 if (h->databuf[0] == STLINK_CORE_RUNNING)
894 return TARGET_RUNNING;
895 if (h->databuf[0] == STLINK_CORE_HALTED)
896 return TARGET_HALTED;
898 return TARGET_UNKNOWN;
902 static int stlink_usb_reset(void *handle)
905 struct stlink_usb_handle_s *h = handle;
907 assert(handle != NULL);
909 stlink_usb_init_buffer(handle, h->rx_ep, 2);
911 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
913 if (h->jtag_api == STLINK_JTAG_API_V1)
914 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_RESETSYS;
916 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_RESETSYS;
918 res = stlink_usb_xfer(handle, h->databuf, 2);
923 LOG_DEBUG("RESET: 0x%08X", h->databuf[0]);
925 /* the following is not a error under swd (using hardware srst), so return success */
926 if (h->databuf[0] == STLINK_SWD_AP_WAIT || h->databuf[0] == STLINK_SWD_DP_WAIT)
929 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
932 static int stlink_usb_assert_srst(void *handle, int srst)
935 struct stlink_usb_handle_s *h = handle;
937 assert(handle != NULL);
939 if (h->jtag_api == STLINK_JTAG_API_V1)
940 return ERROR_COMMAND_NOTFOUND;
942 stlink_usb_init_buffer(handle, h->rx_ep, 2);
944 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
945 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_DRIVE_NRST;
946 h->cmdbuf[h->cmdidx++] = srst;
948 res = stlink_usb_xfer(handle, h->databuf, 2);
953 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
957 static int stlink_configure_target_trace_port(void *handle)
961 struct stlink_usb_handle_s *h = handle;
963 assert(handle != NULL);
965 /* configure the TPI */
967 /* enable the trace subsystem */
968 res = stlink_usb_v2_read_debug_reg(handle, DCB_DEMCR, ®);
971 res = stlink_usb_write_debug_reg(handle, DCB_DEMCR, TRCENA|reg);
974 /* set the TPI clock prescaler */
975 res = stlink_usb_write_debug_reg(handle, TPI_ACPR, h->trace.prescale);
978 /* select the pin protocol. The STLinkv2 only supports asynchronous
979 * UART emulation (NRZ) mode, so that's what we pick. */
980 res = stlink_usb_write_debug_reg(handle, TPI_SPPR, 0x02);
983 /* disable continuous formatting */
984 res = stlink_usb_write_debug_reg(handle, TPI_FFCR, (1<<8));
988 /* configure the ITM */
990 /* unlock access to the ITM registers */
991 res = stlink_usb_write_debug_reg(handle, ITM_LAR, 0xC5ACCE55);
994 /* enable trace with ATB ID 1 */
995 res = stlink_usb_write_debug_reg(handle, ITM_TCR, (1<<16)|(1<<0)|(1<<2));
998 /* trace privilege */
999 res = stlink_usb_write_debug_reg(handle, ITM_TPR, 1);
1000 if (res != ERROR_OK)
1002 /* trace port enable (port 0) */
1003 res = stlink_usb_write_debug_reg(handle, ITM_TER, (1<<0));
1004 if (res != ERROR_OK)
1013 static void stlink_usb_trace_disable(void *handle)
1016 struct stlink_usb_handle_s *h = handle;
1018 assert(handle != NULL);
1020 assert(h->version.jtag >= STLINK_TRACE_MIN_VERSION);
1022 LOG_DEBUG("Tracing: disable\n");
1024 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1025 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1026 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX;
1027 res = stlink_usb_xfer(handle, h->databuf, 2);
1029 if (res == ERROR_OK) {
1030 h->trace.enabled = false;
1031 target_unregister_timer_callback(stlink_usb_trace_read_callback, handle);
1037 static int stlink_usb_trace_enable(void *handle)
1040 struct stlink_usb_handle_s *h = handle;
1042 assert(handle != NULL);
1044 if (h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
1047 res = stlink_configure_target_trace_port(handle);
1048 if (res != ERROR_OK)
1049 LOG_ERROR("Unable to configure tracing on target\n");
1051 trace_hz = h->trace.prescale > 0 ?
1052 h->trace.source_hz / (h->trace.prescale + 1) :
1055 stlink_usb_init_buffer(handle, h->rx_ep, 10);
1057 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1058 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_START_TRACE_RX;
1059 h_u16_to_le(h->cmdbuf+h->cmdidx, (uint16_t)STLINK_TRACE_SIZE);
1061 h_u32_to_le(h->cmdbuf+h->cmdidx, trace_hz);
1064 res = stlink_usb_xfer(handle, h->databuf, 2);
1066 if (res == ERROR_OK) {
1067 h->trace.enabled = true;
1068 LOG_DEBUG("Tracing: recording at %" PRIu32 "Hz\n", trace_hz);
1069 /* We need the trace read function to be called at a
1070 * high-enough frequency to ensure reasonable
1071 * "timeliness" in processing ITM/DWT data.
1072 * TODO: An alternative could be using the asynchronous
1073 * features of the libusb-1.0 API to queue up one or more
1074 * reads in advance and requeue them once they are
1076 target_register_timer_callback(stlink_usb_trace_read_callback, 1, 1, handle);
1079 LOG_ERROR("Tracing is not supported by this version.");
1087 static int stlink_usb_run(void *handle)
1090 struct stlink_usb_handle_s *h = handle;
1092 assert(handle != NULL);
1094 if (h->jtag_api == STLINK_JTAG_API_V2) {
1095 res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
1097 /* Try to start tracing, if requested */
1098 if (res == ERROR_OK && h->trace.source_hz && !h->trace.enabled) {
1099 if (stlink_usb_trace_enable(handle) == ERROR_OK)
1100 LOG_DEBUG("Tracing: enabled\n");
1102 LOG_ERROR("Tracing: enable failed\n");
1108 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1110 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1111 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_RUNCORE;
1113 res = stlink_usb_xfer(handle, h->databuf, 2);
1115 if (res != ERROR_OK)
1118 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
1122 static int stlink_usb_halt(void *handle)
1125 struct stlink_usb_handle_s *h = handle;
1127 assert(handle != NULL);
1129 if (h->jtag_api == STLINK_JTAG_API_V2) {
1130 res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
1132 if (res == ERROR_OK && h->trace.enabled)
1133 stlink_usb_trace_disable(handle);
1138 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1140 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1141 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_FORCEDEBUG;
1143 res = stlink_usb_xfer(handle, h->databuf, 2);
1145 if (res != ERROR_OK)
1148 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
1152 static int stlink_usb_step(void *handle)
1155 struct stlink_usb_handle_s *h = handle;
1157 assert(handle != NULL);
1159 if (h->jtag_api == STLINK_JTAG_API_V2) {
1160 /* TODO: this emulates the v1 api, it should really use a similar auto mask isr
1161 * that the cortex-m3 currently does. */
1162 stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_MASKINTS|C_DEBUGEN);
1163 stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_STEP|C_MASKINTS|C_DEBUGEN);
1164 return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
1167 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1169 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1170 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_STEPCORE;
1172 res = stlink_usb_xfer(handle, h->databuf, 2);
1174 if (res != ERROR_OK)
1177 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
1181 static int stlink_usb_read_regs(void *handle)
1184 struct stlink_usb_handle_s *h = handle;
1186 assert(handle != NULL);
1188 stlink_usb_init_buffer(handle, h->rx_ep, 84);
1190 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1191 if (h->jtag_api == STLINK_JTAG_API_V1)
1192 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READALLREGS;
1194 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READALLREGS;
1196 res = stlink_usb_xfer(handle, h->databuf, 84);
1198 if (res != ERROR_OK)
1205 static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
1208 struct stlink_usb_handle_s *h = handle;
1210 assert(handle != NULL);
1212 stlink_usb_init_buffer(handle, h->rx_ep, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
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_READREG;
1218 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
1219 h->cmdbuf[h->cmdidx++] = num;
1221 res = stlink_usb_xfer(handle, h->databuf, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
1223 if (res != ERROR_OK)
1226 if (h->jtag_api == STLINK_JTAG_API_V1)
1227 *val = le_to_h_u32(h->databuf);
1229 *val = le_to_h_u32(h->databuf + 4);
1230 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
1237 static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
1240 struct stlink_usb_handle_s *h = handle;
1242 assert(handle != NULL);
1244 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1246 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1247 if (h->jtag_api == STLINK_JTAG_API_V1)
1248 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEREG;
1250 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEREG;
1251 h->cmdbuf[h->cmdidx++] = num;
1252 h_u32_to_le(h->cmdbuf+h->cmdidx, val);
1255 res = stlink_usb_xfer(handle, h->databuf, 2);
1257 if (res != ERROR_OK)
1260 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
1263 static int stlink_usb_get_rw_status(void *handle)
1266 struct stlink_usb_handle_s *h = handle;
1268 assert(handle != NULL);
1270 if (h->jtag_api == STLINK_JTAG_API_V1)
1273 stlink_usb_init_buffer(handle, h->rx_ep, 2);
1275 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1276 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
1278 res = stlink_usb_xfer(handle, h->databuf, 2);
1280 if (res != ERROR_OK)
1283 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : res;
1287 static int stlink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
1291 uint16_t read_len = len;
1292 struct stlink_usb_handle_s *h = handle;
1294 assert(handle != NULL);
1296 /* max 8bit read/write is 64bytes */
1297 if (len > STLINK_MAX_RW8) {
1298 LOG_DEBUG("max buffer length exceeded");
1302 stlink_usb_init_buffer(handle, h->rx_ep, read_len);
1304 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1305 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_8BIT;
1306 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1308 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1311 /* we need to fix read length for single bytes */
1315 res = stlink_usb_xfer(handle, h->databuf, read_len);
1317 if (res != ERROR_OK)
1320 memcpy(buffer, h->databuf, len);
1322 return stlink_usb_get_rw_status(handle);
1326 static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
1327 const uint8_t *buffer)
1330 struct stlink_usb_handle_s *h = handle;
1332 assert(handle != NULL);
1334 /* max 8bit read/write is 64bytes */
1335 if (len > STLINK_MAX_RW8) {
1336 LOG_DEBUG("max buffer length exceeded");
1340 stlink_usb_init_buffer(handle, h->tx_ep, len);
1342 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1343 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_8BIT;
1344 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1346 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1349 res = stlink_usb_xfer(handle, buffer, len);
1351 if (res != ERROR_OK)
1354 return stlink_usb_get_rw_status(handle);
1358 static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
1362 struct stlink_usb_handle_s *h = handle;
1364 assert(handle != NULL);
1366 /* data must be a multiple of 4 and word aligned */
1367 if (len % 4 || addr % 4) {
1368 LOG_DEBUG("Invalid data alignment");
1369 return ERROR_TARGET_UNALIGNED_ACCESS;
1372 stlink_usb_init_buffer(handle, h->rx_ep, len);
1374 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1375 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_32BIT;
1376 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1378 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1381 res = stlink_usb_xfer(handle, h->databuf, len);
1383 if (res != ERROR_OK)
1386 memcpy(buffer, h->databuf, len);
1388 return stlink_usb_get_rw_status(handle);
1392 static int stlink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
1393 const uint8_t *buffer)
1396 struct stlink_usb_handle_s *h = handle;
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 stlink_usb_init_buffer(handle, h->tx_ep, len);
1408 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1409 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_32BIT;
1410 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1412 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1415 res = stlink_usb_xfer(handle, buffer, len);
1417 if (res != ERROR_OK)
1420 return stlink_usb_get_rw_status(handle);
1423 static uint32_t stlink_max_block_size(uint32_t tar_autoincr_block, uint32_t address)
1425 uint32_t max_tar_block = (tar_autoincr_block - ((tar_autoincr_block - 1) & address));
1426 if (max_tar_block == 0)
1428 return max_tar_block;
1431 static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
1432 uint32_t count, uint8_t *buffer)
1434 int retval = ERROR_OK;
1435 uint32_t bytes_remaining;
1436 struct stlink_usb_handle_s *h = handle;
1438 /* calculate byte count */
1443 bytes_remaining = (size == 4) ? \
1444 stlink_max_block_size(h->max_mem_packet, addr) : STLINK_MAX_RW8;
1446 if (count < bytes_remaining)
1447 bytes_remaining = count;
1449 /* the stlink only supports 8/32bit memory read/writes
1450 * honour 32bit, all others will be handled as 8bit access */
1453 /* When in jtag mode the stlink uses the auto-increment functinality.
1454 * However it expects us to pass the data correctly, this includes
1455 * alignment and any page boundaries. We already do this as part of the
1456 * adi_v5 implementation, but the stlink is a hla adapter and so this
1457 * needs implementiong manually.
1458 * currently this only affects jtag mode, according to ST they do single
1459 * access in SWD mode - but this may change and so we do it for both modes */
1461 /* we first need to check for any unaligned bytes */
1464 uint32_t head_bytes = 4 - (addr % 4);
1465 retval = stlink_usb_read_mem8(handle, addr, head_bytes, buffer);
1466 if (retval != ERROR_OK)
1468 buffer += head_bytes;
1470 count -= head_bytes;
1471 bytes_remaining -= head_bytes;
1474 if (bytes_remaining % 4)
1475 retval = stlink_usb_read_mem(handle, addr, 1, bytes_remaining, buffer);
1477 retval = stlink_usb_read_mem32(handle, addr, bytes_remaining, buffer);
1479 retval = stlink_usb_read_mem8(handle, addr, bytes_remaining, buffer);
1481 if (retval != ERROR_OK)
1484 buffer += bytes_remaining;
1485 addr += bytes_remaining;
1486 count -= bytes_remaining;
1492 static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
1493 uint32_t count, const uint8_t *buffer)
1495 int retval = ERROR_OK;
1496 uint32_t bytes_remaining;
1497 struct stlink_usb_handle_s *h = handle;
1499 /* calculate byte count */
1504 bytes_remaining = (size == 4) ? \
1505 stlink_max_block_size(h->max_mem_packet, addr) : STLINK_MAX_RW8;
1507 if (count < bytes_remaining)
1508 bytes_remaining = count;
1510 /* the stlink only supports 8/32bit memory read/writes
1511 * honour 32bit, all others will be handled as 8bit access */
1514 /* When in jtag mode the stlink uses the auto-increment functinality.
1515 * However it expects us to pass the data correctly, this includes
1516 * alignment and any page boundaries. We already do this as part of the
1517 * adi_v5 implementation, but the stlink is a hla adapter and so this
1518 * needs implementiong manually.
1519 * currently this only affects jtag mode, according to ST they do single
1520 * access in SWD mode - but this may change and so we do it for both modes */
1522 /* we first need to check for any unaligned bytes */
1525 uint32_t head_bytes = 4 - (addr % 4);
1526 retval = stlink_usb_write_mem8(handle, addr, head_bytes, buffer);
1527 if (retval != ERROR_OK)
1529 buffer += head_bytes;
1531 count -= head_bytes;
1532 bytes_remaining -= head_bytes;
1535 if (bytes_remaining % 4)
1536 retval = stlink_usb_write_mem(handle, addr, 1, bytes_remaining, buffer);
1538 retval = stlink_usb_write_mem32(handle, addr, bytes_remaining, buffer);
1541 retval = stlink_usb_write_mem8(handle, addr, bytes_remaining, buffer);
1542 if (retval != ERROR_OK)
1545 buffer += bytes_remaining;
1546 addr += bytes_remaining;
1547 count -= bytes_remaining;
1554 static int stlink_usb_close(void *fd)
1556 struct stlink_usb_handle_s *h = fd;
1559 jtag_libusb_close(h->fd);
1567 static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
1569 int err, retry_count = 1;
1570 struct stlink_usb_handle_s *h;
1571 enum stlink_jtag_api_version api;
1573 LOG_DEBUG("stlink_usb_open");
1575 h = calloc(1, sizeof(struct stlink_usb_handle_s));
1578 LOG_DEBUG("malloc failed");
1582 h->transport = param->transport;
1584 const uint16_t vids[] = { param->vid, 0 };
1585 const uint16_t pids[] = { param->pid, 0 };
1587 LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x", param->transport,
1588 param->vid, param->pid);
1591 On certain host USB configurations(e.g. MacBook Air)
1592 STLINKv2 dongle seems to have its FW in a funky state if,
1593 after plugging it in, you try to use openocd with it more
1594 then once (by launching and closing openocd). In cases like
1595 that initial attempt to read the FW info via
1596 stlink_usb_version will fail and the device has to be reset
1597 in order to become operational.
1600 if (jtag_libusb_open(vids, pids, &h->fd) != ERROR_OK) {
1601 LOG_ERROR("open failed");
1605 jtag_libusb_set_configuration(h->fd, 0);
1607 if (jtag_libusb_claim_interface(h->fd, 0) != ERROR_OK) {
1608 LOG_DEBUG("claim interface failed");
1612 /* RX EP is common for all versions */
1613 h->rx_ep = STLINK_RX_EP;
1615 /* wrap version for first read */
1616 switch (param->pid) {
1618 h->version.stlink = 1;
1619 h->tx_ep = STLINK_TX_EP;
1620 h->trace_ep = STLINK_TRACE_EP;
1622 case STLINK_V2_1_PID:
1623 h->version.stlink = 2;
1624 h->tx_ep = STLINK_V2_1_TX_EP;
1625 h->trace_ep = STLINK_V2_1_TRACE_EP;
1628 /* fall through - we assume V2 to be the default version*/
1630 h->version.stlink = 2;
1631 h->tx_ep = STLINK_TX_EP;
1632 h->trace_ep = STLINK_TRACE_EP;
1636 /* get the device version */
1637 err = stlink_usb_version(h);
1639 if (err == ERROR_OK) {
1641 } else if (h->version.stlink == 1 ||
1643 LOG_ERROR("read version failed");
1646 err = jtag_libusb_release_interface(h->fd, 0);
1647 if (err != ERROR_OK) {
1648 LOG_ERROR("release interface failed");
1652 err = jtag_libusb_reset_device(h->fd);
1653 if (err != ERROR_OK) {
1654 LOG_ERROR("reset device failed");
1658 jtag_libusb_close(h->fd);
1660 Give the device one second to settle down and
1663 usleep(1 * 1000 * 1000);
1668 /* compare usb vid/pid */
1669 if ((param->vid != h->vid) || (param->pid != h->pid))
1670 LOG_INFO("vid/pid are not identical: 0x%04X/0x%04X 0x%04X/0x%04X",
1671 param->vid, param->pid,
1674 /* check if mode is supported */
1677 switch (h->transport) {
1678 case HL_TRANSPORT_SWD:
1679 case HL_TRANSPORT_JTAG:
1680 if (h->version.jtag == 0)
1683 case HL_TRANSPORT_SWIM:
1684 if (h->version.swim == 0)
1692 if (err != ERROR_OK) {
1693 LOG_ERROR("mode (transport) not supported by device");
1697 api = h->version.jtag_api_max;
1699 LOG_INFO("using stlink api v%d", api);
1701 /* set the used jtag api, this will default to the newest supported version */
1704 if (h->jtag_api >= 2 && param->trace_source_hz > 0) {
1707 prescale = param->trace_source_hz > STLINK_TRACE_MAX_HZ ?
1708 (param->trace_source_hz / STLINK_TRACE_MAX_HZ) - 1 : 0;
1710 h->trace.output_f = param->trace_f;
1711 h->trace.source_hz = param->trace_source_hz;
1712 h->trace.prescale = prescale;
1715 /* initialize the debug hardware */
1716 err = stlink_usb_init_mode(h, param->connect_under_reset);
1718 if (err != ERROR_OK) {
1719 LOG_ERROR("init mode failed");
1723 /* get cpuid, so we can determine the max page size
1724 * start with a safe default */
1725 h->max_mem_packet = (1 << 10);
1728 err = stlink_usb_read_mem32(h, CPUID, 4, buffer);
1729 if (err == ERROR_OK) {
1730 uint32_t cpuid = le_to_h_u32(buffer);
1731 int i = (cpuid >> 4) & 0xf;
1732 if (i == 4 || i == 3) {
1733 /* Cortex-M3/M4 has 4096 bytes autoincrement range */
1734 h->max_mem_packet = (1 << 12);
1738 LOG_DEBUG("Using TAR autoincrement: %" PRIu32, h->max_mem_packet);
1745 stlink_usb_close(h);
1751 struct hl_layout_api_s stlink_usb_layout_api = {
1753 .open = stlink_usb_open,
1755 .close = stlink_usb_close,
1757 .idcode = stlink_usb_idcode,
1759 .state = stlink_usb_state,
1761 .reset = stlink_usb_reset,
1763 .assert_srst = stlink_usb_assert_srst,
1765 .run = stlink_usb_run,
1767 .halt = stlink_usb_halt,
1769 .step = stlink_usb_step,
1771 .read_regs = stlink_usb_read_regs,
1773 .read_reg = stlink_usb_read_reg,
1775 .write_reg = stlink_usb_write_reg,
1777 .read_mem = stlink_usb_read_mem,
1779 .write_mem = stlink_usb_write_mem,
1781 .write_debug_reg = stlink_usb_write_debug_reg