1 /***************************************************************************
2 * Copyright (C) 2011-2012 by Mathias Kuester *
3 * Mathias Kuester <kesmtp@freenet.de> *
5 * This code is based on https://github.com/texane/stlink *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
17 * You should have received a copy of the GNU General Public License *
18 * along with this program; if not, write to the *
19 * Free Software Foundation, Inc., *
20 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
21 ***************************************************************************/
27 /* project specific includes */
28 #include <helper/binarybuffer.h>
29 #include <jtag/interface.h>
30 #include <jtag/stlink/stlink_layout.h>
31 #include <jtag/stlink/stlink_transport.h>
32 #include <jtag/stlink/stlink_interface.h>
33 #include <target/target.h>
35 #include <target/cortex_m.h>
37 #include "libusb_common.h"
39 #define ENDPOINT_IN 0x80
40 #define ENDPOINT_OUT 0x00
42 #define STLINK_NULL_EP 0
43 #define STLINK_RX_EP (1|ENDPOINT_IN)
44 #define STLINK_TX_EP (2|ENDPOINT_OUT)
45 #define STLINK_SG_SIZE (31)
46 #define STLINK_DATA_SIZE (4*128)
47 #define STLINK_CMD_SIZE_V2 (16)
48 #define STLINK_CMD_SIZE_V1 (10)
50 enum stlink_jtag_api_version {
51 STLINK_JTAG_API_V1 = 0,
56 struct stlink_usb_version {
63 /** highest supported jtag api version */
64 enum stlink_jtag_api_version jtag_api_max;
68 struct stlink_usb_handle_s {
70 struct jtag_libusb_device_handle *fd;
72 struct libusb_transfer *trans;
74 uint8_t cmdbuf[STLINK_SG_SIZE];
80 uint8_t databuf[STLINK_DATA_SIZE];
82 enum stlink_transports transport;
84 struct stlink_usb_version version;
89 /** this is the currently used jtag api */
90 enum stlink_jtag_api_version jtag_api;
93 #define STLINK_DEBUG_ERR_OK 0x80
94 #define STLINK_DEBUG_ERR_FAULT 0x81
95 #define STLINK_CORE_RUNNING 0x80
96 #define STLINK_CORE_HALTED 0x81
97 #define STLINK_CORE_STAT_UNKNOWN -1
99 #define STLINK_GET_VERSION 0xF1
100 #define STLINK_DEBUG_COMMAND 0xF2
101 #define STLINK_DFU_COMMAND 0xF3
102 #define STLINK_SWIM_COMMAND 0xF4
103 #define STLINK_GET_CURRENT_MODE 0xF5
105 #define STLINK_DEV_DFU_MODE 0x00
106 #define STLINK_DEV_MASS_MODE 0x01
107 #define STLINK_DEV_DEBUG_MODE 0x02
108 #define STLINK_DEV_SWIM_MODE 0x03
109 #define STLINK_DEV_BOOTLOADER_MODE 0x04
110 #define STLINK_DEV_UNKNOWN_MODE -1
112 #define STLINK_DFU_EXIT 0x07
114 #define STLINK_SWIM_ENTER 0x00
115 #define STLINK_SWIM_EXIT 0x01
117 #define STLINK_DEBUG_ENTER_JTAG 0x00
118 #define STLINK_DEBUG_GETSTATUS 0x01
119 #define STLINK_DEBUG_FORCEDEBUG 0x02
120 #define STLINK_DEBUG_APIV1_RESETSYS 0x03
121 #define STLINK_DEBUG_APIV1_READALLREGS 0x04
122 #define STLINK_DEBUG_APIV1_READREG 0x05
123 #define STLINK_DEBUG_APIV1_WRITEREG 0x06
124 #define STLINK_DEBUG_READMEM_32BIT 0x07
125 #define STLINK_DEBUG_WRITEMEM_32BIT 0x08
126 #define STLINK_DEBUG_RUNCORE 0x09
127 #define STLINK_DEBUG_STEPCORE 0x0a
128 #define STLINK_DEBUG_APIV1_SETFP 0x0b
129 #define STLINK_DEBUG_READMEM_8BIT 0x0c
130 #define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
131 #define STLINK_DEBUG_APIV1_CLEARFP 0x0e
132 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG 0x0f
133 #define STLINK_DEBUG_APIV1_SETWATCHPOINT 0x10
135 #define STLINK_DEBUG_ENTER_JTAG 0x00
136 #define STLINK_DEBUG_ENTER_SWD 0xa3
138 #define STLINK_DEBUG_APIV1_ENTER 0x20
139 #define STLINK_DEBUG_EXIT 0x21
140 #define STLINK_DEBUG_READCOREID 0x22
142 #define STLINK_DEBUG_APIV2_ENTER 0x30
143 #define STLINK_DEBUG_APIV2_READ_IDCODES 0x31
144 #define STLINK_DEBUG_APIV2_RESETSYS 0x32
145 #define STLINK_DEBUG_APIV2_READREG 0x33
146 #define STLINK_DEBUG_APIV2_WRITEREG 0x34
147 #define STLINK_DEBUG_APIV2_WRITEDEBUGREG 0x35
148 #define STLINK_DEBUG_APIV2_READDEBUGREG 0x36
150 #define STLINK_DEBUG_APIV2_READALLREGS 0x3A
151 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
152 #define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
154 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
155 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
156 #define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
160 STLINK_MODE_UNKNOWN = 0,
163 STLINK_MODE_DEBUG_JTAG,
164 STLINK_MODE_DEBUG_SWD,
165 STLINK_MODE_DEBUG_SWIM
168 #define REQUEST_SENSE 0x03
169 #define REQUEST_SENSE_LENGTH 18
171 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
174 static int stlink_usb_xfer_v1_get_status(void *handle)
176 struct stlink_usb_handle_s *h;
178 assert(handle != NULL);
180 h = (struct stlink_usb_handle_s *)handle;
183 memset(h->cmdbuf, 0, STLINK_SG_SIZE);
185 if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)h->cmdbuf,
191 t1 = buf_get_u32(h->cmdbuf, 0, 32);
194 if (t1 != 0x53425355)
202 if (h->cmdbuf[12] != 0)
209 static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
211 struct stlink_usb_handle_s *h;
213 assert(handle != NULL);
215 h = (struct stlink_usb_handle_s *)handle;
217 if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)h->cmdbuf, cmdsize,
222 if (h->direction == STLINK_TX_EP && size) {
223 if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)buf,
224 size, 1000) != size) {
225 LOG_DEBUG("bulk write failed");
228 } else if (h->direction == STLINK_RX_EP && size) {
229 if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)buf,
230 size, 1000) != size) {
231 LOG_DEBUG("bulk read failed");
240 static int stlink_usb_xfer_v1_get_sense(void *handle)
243 struct stlink_usb_handle_s *h;
245 assert(handle != NULL);
247 h = (struct stlink_usb_handle_s *)handle;
249 stlink_usb_init_buffer(handle, STLINK_RX_EP, 16);
251 h->cmdbuf[h->cmdidx++] = REQUEST_SENSE;
252 h->cmdbuf[h->cmdidx++] = 0;
253 h->cmdbuf[h->cmdidx++] = 0;
254 h->cmdbuf[h->cmdidx++] = 0;
255 h->cmdbuf[h->cmdidx++] = REQUEST_SENSE_LENGTH;
257 res = stlink_usb_xfer_rw(handle, REQUEST_SENSE_LENGTH, h->databuf, 16);
262 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK)
269 static int stlink_usb_xfer(void *handle, const uint8_t *buf, int size)
271 int err, cmdsize = STLINK_CMD_SIZE_V2;
272 struct stlink_usb_handle_s *h;
274 assert(handle != NULL);
276 h = (struct stlink_usb_handle_s *)handle;
278 if (h->version.stlink == 1)
279 cmdsize = STLINK_SG_SIZE;
281 err = stlink_usb_xfer_rw(handle, cmdsize, buf, size);
286 if (h->version.stlink == 1) {
287 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK) {
288 /* check csw status */
289 if (h->cmdbuf[12] == 1) {
290 LOG_DEBUG("get sense");
291 if (stlink_usb_xfer_v1_get_sense(handle) != ERROR_OK)
302 static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint32_t size)
304 struct stlink_usb_handle_s *h;
306 h = (struct stlink_usb_handle_s *)handle;
308 /* fill the send buffer */
309 strcpy((char *)h->cmdbuf, "USBC");
311 /* csw tag not used */
313 buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, size);
315 h->cmdbuf[h->cmdidx++] = (direction == STLINK_RX_EP ? ENDPOINT_IN : ENDPOINT_OUT);
316 h->cmdbuf[h->cmdidx++] = 0; /* lun */
317 h->cmdbuf[h->cmdidx++] = STLINK_CMD_SIZE_V1;
321 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size)
323 struct stlink_usb_handle_s *h;
325 h = (struct stlink_usb_handle_s *)handle;
327 h->direction = direction;
331 memset(h->cmdbuf, 0, STLINK_SG_SIZE);
332 memset(h->databuf, 0, STLINK_DATA_SIZE);
334 if (h->version.stlink == 1)
335 stlink_usb_xfer_v1_create_cmd(handle, direction, size);
338 static const char * const stlink_usb_error_msg[] = {
343 static int stlink_usb_error_check(void *handle)
346 const char *err_msg = 0;
347 struct stlink_usb_handle_s *h;
349 assert(handle != NULL);
351 h = (struct stlink_usb_handle_s *)handle;
353 /* TODO: no error checking yet on api V1 */
354 if (h->jtag_api == STLINK_JTAG_API_V1)
355 h->databuf[0] = STLINK_DEBUG_ERR_OK;
357 switch (h->databuf[0]) {
358 case STLINK_DEBUG_ERR_OK:
361 case STLINK_DEBUG_ERR_FAULT:
363 err_msg = stlink_usb_error_msg[0];
369 LOG_DEBUG("status error: %d ('%s')", h->databuf[0], err_msg);
375 static int stlink_usb_version(void *handle)
379 struct stlink_usb_handle_s *h;
381 assert(handle != NULL);
383 h = (struct stlink_usb_handle_s *)handle;
385 stlink_usb_init_buffer(handle, STLINK_RX_EP, 6);
387 h->cmdbuf[h->cmdidx++] = STLINK_GET_VERSION;
389 res = stlink_usb_xfer(handle, h->databuf, 6);
394 v = (h->databuf[0] << 8) | h->databuf[1];
396 h->version.stlink = (v >> 12) & 0x0f;
397 h->version.jtag = (v >> 6) & 0x3f;
398 h->version.swim = v & 0x3f;
399 h->vid = buf_get_u32(h->databuf, 16, 16);
400 h->pid = buf_get_u32(h->databuf, 32, 16);
402 /* set the supported jtag api version
403 * V1 doesn't support API V2 at all
404 * V2 support API V2 since JTAG V13
406 if ((h->version.stlink == 2) && (h->version.jtag > 12))
407 h->version.jtag_api_max = STLINK_JTAG_API_V2;
409 h->version.jtag_api_max = STLINK_JTAG_API_V1;
411 LOG_DEBUG("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
414 (h->version.jtag_api_max == STLINK_JTAG_API_V1) ? 1 : 2,
423 static int stlink_usb_current_mode(void *handle, uint8_t *mode)
426 struct stlink_usb_handle_s *h;
428 assert(handle != NULL);
430 h = (struct stlink_usb_handle_s *)handle;
432 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
434 h->cmdbuf[h->cmdidx++] = STLINK_GET_CURRENT_MODE;
436 res = stlink_usb_xfer(handle, h->databuf, 2);
441 *mode = h->databuf[0];
447 static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
451 struct stlink_usb_handle_s *h;
453 assert(handle != NULL);
455 h = (struct stlink_usb_handle_s *)handle;
457 /* on api V2 we are able the read the latest command
459 * TODO: we need the test on api V1 too
461 if (h->jtag_api == STLINK_JTAG_API_V2)
464 stlink_usb_init_buffer(handle, STLINK_RX_EP, rx_size);
467 case STLINK_MODE_DEBUG_JTAG:
468 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
469 if (h->jtag_api == STLINK_JTAG_API_V1)
470 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
472 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
473 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_JTAG;
475 case STLINK_MODE_DEBUG_SWD:
476 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
477 if (h->jtag_api == STLINK_JTAG_API_V1)
478 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
480 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
481 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_SWD;
483 case STLINK_MODE_DEBUG_SWIM:
484 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
485 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ENTER;
487 case STLINK_MODE_DFU:
488 case STLINK_MODE_MASS:
493 res = stlink_usb_xfer(handle, h->databuf, rx_size);
498 res = stlink_usb_error_check(h);
504 static int stlink_usb_mode_leave(void *handle, enum stlink_mode type)
507 struct stlink_usb_handle_s *h;
509 assert(handle != NULL);
511 h = (struct stlink_usb_handle_s *)handle;
513 stlink_usb_init_buffer(handle, STLINK_NULL_EP, 0);
516 case STLINK_MODE_DEBUG_JTAG:
517 case STLINK_MODE_DEBUG_SWD:
518 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
519 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_EXIT;
521 case STLINK_MODE_DEBUG_SWIM:
522 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
523 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_EXIT;
525 case STLINK_MODE_DFU:
526 h->cmdbuf[h->cmdidx++] = STLINK_DFU_COMMAND;
527 h->cmdbuf[h->cmdidx++] = STLINK_DFU_EXIT;
529 case STLINK_MODE_MASS:
534 res = stlink_usb_xfer(handle, 0, 0);
543 static int stlink_usb_init_mode(void *handle)
547 enum stlink_mode emode;
548 struct stlink_usb_handle_s *h;
550 assert(handle != NULL);
552 h = (struct stlink_usb_handle_s *)handle;
554 res = stlink_usb_current_mode(handle, &mode);
559 LOG_DEBUG("MODE: 0x%02X", mode);
561 /* try to exit current mode */
563 case STLINK_DEV_DFU_MODE:
564 emode = STLINK_MODE_DFU;
566 case STLINK_DEV_DEBUG_MODE:
567 emode = STLINK_MODE_DEBUG_SWD;
569 case STLINK_DEV_SWIM_MODE:
570 emode = STLINK_MODE_DEBUG_SWIM;
572 case STLINK_DEV_BOOTLOADER_MODE:
573 case STLINK_DEV_MASS_MODE:
575 emode = STLINK_MODE_UNKNOWN;
579 if (emode != STLINK_MODE_UNKNOWN) {
580 res = stlink_usb_mode_leave(handle, emode);
586 res = stlink_usb_current_mode(handle, &mode);
591 LOG_DEBUG("MODE: 0x%02X", mode);
593 /* set selected mode */
594 switch (h->transport) {
595 case STLINK_TRANSPORT_SWD:
596 emode = STLINK_MODE_DEBUG_SWD;
598 case STLINK_TRANSPORT_JTAG:
599 emode = STLINK_MODE_DEBUG_JTAG;
601 case STLINK_TRANSPORT_SWIM:
602 emode = STLINK_MODE_DEBUG_SWIM;
605 emode = STLINK_MODE_UNKNOWN;
609 if (emode == STLINK_MODE_UNKNOWN) {
610 LOG_ERROR("selected mode (transport) not supported");
614 res = stlink_usb_mode_enter(handle, emode);
619 res = stlink_usb_current_mode(handle, &mode);
624 LOG_DEBUG("MODE: 0x%02X", mode);
630 static int stlink_usb_idcode(void *handle, uint32_t *idcode)
633 struct stlink_usb_handle_s *h;
635 assert(handle != NULL);
637 h = (struct stlink_usb_handle_s *)handle;
639 stlink_usb_init_buffer(handle, STLINK_RX_EP, 4);
641 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
642 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READCOREID;
644 res = stlink_usb_xfer(handle, h->databuf, 4);
649 *idcode = le_to_h_u32(h->databuf);
651 LOG_DEBUG("IDCODE: 0x%08X", *idcode);
656 static int stlink_usb_v2_read_debug_reg(void *handle, uint32_t addr, uint32_t *val)
658 struct stlink_usb_handle_s *h;
661 assert(handle != NULL);
663 h = (struct stlink_usb_handle_s *)handle;
665 stlink_usb_init_buffer(handle, STLINK_RX_EP, 8);
667 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
668 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READDEBUGREG;
669 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
672 res = stlink_usb_xfer(handle, h->databuf, 8);
677 *val = le_to_h_u32(h->databuf + 4);
679 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
682 static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
685 struct stlink_usb_handle_s *h;
687 assert(handle != NULL);
689 h = (struct stlink_usb_handle_s *)handle;
691 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
693 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
694 if (h->jtag_api == STLINK_JTAG_API_V1)
695 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG;
697 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG;
698 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
700 h_u32_to_le(h->cmdbuf+h->cmdidx, val);
703 res = stlink_usb_xfer(handle, h->databuf, 2);
708 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
711 static enum target_state stlink_usb_v2_get_status(void *handle)
716 result = stlink_usb_v2_read_debug_reg(handle, DCB_DHCSR, &status);
717 if (result != ERROR_OK)
718 return TARGET_UNKNOWN;
721 return TARGET_HALTED;
722 else if (status & S_RESET_ST)
725 return TARGET_RUNNING;
729 static enum target_state stlink_usb_state(void *handle)
732 struct stlink_usb_handle_s *h;
734 assert(handle != NULL);
736 h = (struct stlink_usb_handle_s *)handle;
738 if (h->jtag_api == STLINK_JTAG_API_V2)
739 return stlink_usb_v2_get_status(handle);
741 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
743 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
744 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_GETSTATUS;
746 res = stlink_usb_xfer(handle, h->databuf, 2);
749 return TARGET_UNKNOWN;
751 if (h->databuf[0] == STLINK_CORE_RUNNING)
752 return TARGET_RUNNING;
753 if (h->databuf[0] == STLINK_CORE_HALTED)
754 return TARGET_HALTED;
756 return TARGET_UNKNOWN;
760 static int stlink_usb_reset(void *handle)
763 struct stlink_usb_handle_s *h;
765 assert(handle != NULL);
767 h = (struct stlink_usb_handle_s *)handle;
769 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
771 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
773 if (h->jtag_api == STLINK_JTAG_API_V1)
774 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_RESETSYS;
776 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_RESETSYS;
778 res = stlink_usb_xfer(handle, h->databuf, 2);
783 LOG_DEBUG("RESET: 0x%08X", h->databuf[0]);
785 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
788 static int stlink_usb_assert_srst(void *handle, int srst)
791 struct stlink_usb_handle_s *h;
793 assert(handle != NULL);
795 h = (struct stlink_usb_handle_s *)handle;
797 if (h->jtag_api == STLINK_JTAG_API_V1)
798 return ERROR_COMMAND_NOTFOUND;
800 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
802 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
803 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_DRIVE_NRST;
804 h->cmdbuf[h->cmdidx++] = srst;
806 res = stlink_usb_xfer(handle, h->databuf, 2);
811 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
815 static int stlink_usb_run(void *handle)
818 struct stlink_usb_handle_s *h;
820 assert(handle != NULL);
822 h = (struct stlink_usb_handle_s *)handle;
824 if (h->jtag_api == STLINK_JTAG_API_V2)
825 return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
827 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
829 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
830 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_RUNCORE;
832 res = stlink_usb_xfer(handle, h->databuf, 2);
837 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
841 static int stlink_usb_halt(void *handle)
844 struct stlink_usb_handle_s *h;
846 assert(handle != NULL);
848 h = (struct stlink_usb_handle_s *)handle;
850 if (h->jtag_api == STLINK_JTAG_API_V2)
851 return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
853 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
855 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
856 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_FORCEDEBUG;
858 res = stlink_usb_xfer(handle, h->databuf, 2);
863 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
867 static int stlink_usb_step(void *handle)
870 struct stlink_usb_handle_s *h;
872 assert(handle != NULL);
874 h = (struct stlink_usb_handle_s *)handle;
876 if (h->jtag_api == STLINK_JTAG_API_V2)
877 return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_STEP|C_DEBUGEN);
879 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
881 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
882 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_STEPCORE;
884 res = stlink_usb_xfer(handle, h->databuf, 2);
889 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
893 static int stlink_usb_read_regs(void *handle)
896 struct stlink_usb_handle_s *h;
898 assert(handle != NULL);
900 h = (struct stlink_usb_handle_s *)handle;
902 stlink_usb_init_buffer(handle, STLINK_RX_EP, 84);
904 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
905 if (h->jtag_api == STLINK_JTAG_API_V1)
906 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READALLREGS;
908 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READALLREGS;
910 res = stlink_usb_xfer(handle, h->databuf, 84);
919 static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
922 struct stlink_usb_handle_s *h;
924 assert(handle != NULL);
926 h = (struct stlink_usb_handle_s *)handle;
928 stlink_usb_init_buffer(handle, STLINK_RX_EP, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
930 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
931 if (h->jtag_api == STLINK_JTAG_API_V1)
932 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READREG;
934 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
935 h->cmdbuf[h->cmdidx++] = num;
937 res = stlink_usb_xfer(handle, h->databuf, h->jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
942 if (h->jtag_api == STLINK_JTAG_API_V1)
943 *val = le_to_h_u32(h->databuf);
945 *val = le_to_h_u32(h->databuf + 4);
946 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
953 static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
956 struct stlink_usb_handle_s *h;
958 assert(handle != NULL);
960 h = (struct stlink_usb_handle_s *)handle;
962 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
964 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
965 if (h->jtag_api == STLINK_JTAG_API_V1)
966 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEREG;
968 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEREG;
969 h->cmdbuf[h->cmdidx++] = num;
970 h_u32_to_le(h->cmdbuf+h->cmdidx, val);
973 res = stlink_usb_xfer(handle, h->databuf, 2);
978 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
981 static int stlink_usb_get_rw_status(void *handle)
984 struct stlink_usb_handle_s *h;
986 assert(handle != NULL);
988 h = (struct stlink_usb_handle_s *)handle;
990 if (h->jtag_api == STLINK_JTAG_API_V1)
993 stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
995 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
996 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
998 res = stlink_usb_xfer(handle, h->databuf, 2);
1000 if (res != ERROR_OK)
1003 return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : res;
1007 static int stlink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
1011 uint16_t read_len = len;
1012 struct stlink_usb_handle_s *h;
1014 assert(handle != NULL);
1016 h = (struct stlink_usb_handle_s *)handle;
1018 stlink_usb_init_buffer(handle, STLINK_RX_EP, read_len);
1020 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1021 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_8BIT;
1022 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1024 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1027 /* we need to fix read length for single bytes */
1031 res = stlink_usb_xfer(handle, h->databuf, read_len);
1033 if (res != ERROR_OK)
1036 memcpy(buffer, h->databuf, len);
1038 return stlink_usb_get_rw_status(handle);
1042 static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
1043 const uint8_t *buffer)
1046 struct stlink_usb_handle_s *h;
1048 assert(handle != NULL);
1050 h = (struct stlink_usb_handle_s *)handle;
1052 stlink_usb_init_buffer(handle, STLINK_TX_EP, len);
1054 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1055 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_8BIT;
1056 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1058 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1061 res = stlink_usb_xfer(handle, buffer, len);
1063 if (res != ERROR_OK)
1066 return stlink_usb_get_rw_status(handle);
1070 static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
1074 struct stlink_usb_handle_s *h;
1076 assert(handle != NULL);
1078 h = (struct stlink_usb_handle_s *)handle;
1082 stlink_usb_init_buffer(handle, STLINK_RX_EP, len);
1084 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1085 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_32BIT;
1086 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1088 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1091 res = stlink_usb_xfer(handle, h->databuf, len);
1093 if (res != ERROR_OK)
1096 memcpy(buffer, h->databuf, len);
1098 return stlink_usb_get_rw_status(handle);
1102 static int stlink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
1103 const uint8_t *buffer)
1106 struct stlink_usb_handle_s *h;
1108 assert(handle != NULL);
1110 h = (struct stlink_usb_handle_s *)handle;
1114 stlink_usb_init_buffer(handle, STLINK_TX_EP, len);
1116 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1117 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_32BIT;
1118 h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1120 h_u16_to_le(h->cmdbuf+h->cmdidx, len);
1123 res = stlink_usb_xfer(handle, buffer, len);
1125 if (res != ERROR_OK)
1128 return stlink_usb_get_rw_status(handle);
1132 static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
1135 struct stlink_usb_handle_s *h;
1137 LOG_DEBUG("stlink_usb_open");
1139 h = malloc(sizeof(struct stlink_usb_handle_s));
1142 LOG_DEBUG("malloc failed");
1146 h->transport = param->transport;
1148 const uint16_t vids[] = { param->vid, 0 };
1149 const uint16_t pids[] = { param->pid, 0 };
1151 LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x", param->transport,
1152 param->vid, param->pid);
1154 if (jtag_libusb_open(vids, pids, &h->fd) != ERROR_OK) {
1155 LOG_ERROR("open failed");
1159 jtag_libusb_set_configuration(h->fd, 0);
1161 if (jtag_libusb_claim_interface(h->fd, 0) != ERROR_OK) {
1162 LOG_DEBUG("claim interface failed");
1166 /* wrap version for first read */
1167 switch (param->pid) {
1169 h->version.stlink = 1;
1172 h->version.stlink = 2;
1176 /* get the device version */
1177 err = stlink_usb_version(h);
1179 if (err != ERROR_OK) {
1180 LOG_ERROR("read version failed");
1181 jtag_libusb_close(h->fd);
1186 /* compare usb vid/pid */
1187 if ((param->vid != h->vid) || (param->pid != h->pid))
1188 LOG_INFO("vid/pid are not identical: 0x%04X/0x%04X 0x%04X/0x%04X",
1189 param->vid, param->pid,
1192 /* check if mode is supported */
1195 switch (h->transport) {
1196 case STLINK_TRANSPORT_SWD:
1197 case STLINK_TRANSPORT_JTAG:
1198 if (h->version.jtag == 0)
1201 case STLINK_TRANSPORT_SWIM:
1202 if (h->version.swim == 0)
1210 if (err != ERROR_OK) {
1211 LOG_ERROR("mode (transport) not supported by device");
1212 jtag_libusb_close(h->fd);
1217 /* set the used jtag api, this will default to the newest supported version */
1218 h->jtag_api = h->version.jtag_api_max;
1220 /* initialize the debug hardware */
1221 err = stlink_usb_init_mode(h);
1223 if (err != ERROR_OK) {
1224 LOG_ERROR("init mode failed");
1225 jtag_libusb_close(h->fd);
1236 static int stlink_usb_close(void *fd)
1242 struct stlink_layout_api_s stlink_usb_layout_api = {
1244 .open = stlink_usb_open,
1246 .close = stlink_usb_close,
1248 .idcode = stlink_usb_idcode,
1250 .state = stlink_usb_state,
1252 .reset = stlink_usb_reset,
1254 .assert_srst = stlink_usb_assert_srst,
1256 .run = stlink_usb_run,
1258 .halt = stlink_usb_halt,
1260 .step = stlink_usb_step,
1262 .read_regs = stlink_usb_read_regs,
1264 .read_reg = stlink_usb_read_reg,
1266 .write_reg = stlink_usb_write_reg,
1268 .read_mem8 = stlink_usb_read_mem8,
1270 .write_mem8 = stlink_usb_write_mem8,
1272 .read_mem32 = stlink_usb_read_mem32,
1274 .write_mem32 = stlink_usb_write_mem32,