1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
|
/***************************************************************************
* Copyright (C) 2011-2012 by Mathias Kuester *
* Mathias Kuester <kesmtp@freenet.de> *
* *
* This code is based on https://github.com/texane/stlink *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
/* project specific includes */
#include <helper/binarybuffer.h>
#include <jtag/interface.h>
#include <jtag/stlink/stlink_layout.h>
#include <jtag/stlink/stlink_transport.h>
#include <jtag/stlink/stlink_interface.h>
#include <target/target.h>
#include "libusb_common.h"
#define ENDPOINT_IN 0x80
#define ENDPOINT_OUT 0x00
#define STLINK_RX_EP (1|ENDPOINT_IN)
#define STLINK_TX_EP (2|ENDPOINT_OUT)
#define STLINK_CMD_SIZE (16)
#define STLINK_TX_SIZE (4*128)
#define STLINK_RX_SIZE (4*128)
enum stlink_jtag_api_version {
STLINK_JTAG_API_V1 = 0,
STLINK_JTAG_API_V2,
};
/** */
struct stlink_usb_version {
/** */
int stlink;
/** */
int jtag;
/** */
int swim;
/** highest supported jtag api version */
enum stlink_jtag_api_version jtag_api_max;
};
/** */
struct stlink_usb_handle_s {
/** */
struct jtag_libusb_device_handle *fd;
/** */
struct libusb_transfer *trans;
/** */
uint8_t txbuf[STLINK_TX_SIZE];
/** */
uint8_t rxbuf[STLINK_RX_SIZE];
/** */
enum stlink_transports transport;
/** */
struct stlink_usb_version version;
/** */
uint16_t vid;
/** */
uint16_t pid;
/** */
uint32_t sg_tag;
/** this is the currently used jtag api */
enum stlink_jtag_api_version jtag_api;
};
#define STLINK_DEBUG_ERR_OK 0x80
#define STLINK_DEBUG_ERR_FAULT 0x81
#define STLINK_CORE_RUNNING 0x80
#define STLINK_CORE_HALTED 0x81
#define STLINK_CORE_STAT_UNKNOWN -1
#define STLINK_GET_VERSION 0xF1
#define STLINK_DEBUG_COMMAND 0xF2
#define STLINK_DFU_COMMAND 0xF3
#define STLINK_SWIM_COMMAND 0xF4
#define STLINK_GET_CURRENT_MODE 0xF5
#define STLINK_DEV_DFU_MODE 0x00
#define STLINK_DEV_MASS_MODE 0x01
#define STLINK_DEV_DEBUG_MODE 0x02
#define STLINK_DEV_SWIM_MODE 0x03
#define STLINK_DEV_BOOTLOADER_MODE 0x04
#define STLINK_DEV_UNKNOWN_MODE -1
#define STLINK_DFU_EXIT 0x07
#define STLINK_SWIM_ENTER 0x00
#define STLINK_SWIM_EXIT 0x01
#define STLINK_DEBUG_ENTER_JTAG 0x00
#define STLINK_DEBUG_GETSTATUS 0x01
#define STLINK_DEBUG_FORCEDEBUG 0x02
#define STLINK_DEBUG_APIV1_RESETSYS 0x03
#define STLINK_DEBUG_APIV1_READALLREGS 0x04
#define STLINK_DEBUG_APIV1_READREG 0x05
#define STLINK_DEBUG_APIV1_WRITEREG 0x06
#define STLINK_DEBUG_READMEM_32BIT 0x07
#define STLINK_DEBUG_WRITEMEM_32BIT 0x08
#define STLINK_DEBUG_RUNCORE 0x09
#define STLINK_DEBUG_STEPCORE 0x0a
#define STLINK_DEBUG_APIV1_SETFP 0x0b
#define STLINK_DEBUG_READMEM_8BIT 0x0c
#define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
#define STLINK_DEBUG_APIV1_CLEARFP 0x0e
#define STLINK_DEBUG_APIV1_WRITEDEBUGREG 0x0f
#define STLINK_DEBUG_APIV1_SETWATCHPOINT 0x10
#define STLINK_DEBUG_ENTER_JTAG 0x00
#define STLINK_DEBUG_ENTER_SWD 0xa3
#define STLINK_DEBUG_APIV1_ENTER 0x20
#define STLINK_DEBUG_EXIT 0x21
#define STLINK_DEBUG_READCOREID 0x22
#define STLINK_DEBUG_APIV2_ENTER 0x30
#define STLINK_DEBUG_APIV2_READ_IDCODES 0x31
#define STLINK_DEBUG_APIV2_RESETSYS 0x32
#define STLINK_DEBUG_APIV2_READREG 0x33
#define STLINK_DEBUG_APIV2_WRITEREG 0x34
#define STLINK_DEBUG_APIV2_READALLREGS 0x3A
#define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
#define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
#define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
#define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
/** */
enum stlink_mode {
STLINK_MODE_UNKNOWN = 0,
STLINK_MODE_DFU,
STLINK_MODE_MASS,
STLINK_MODE_DEBUG_JTAG,
STLINK_MODE_DEBUG_SWD,
STLINK_MODE_DEBUG_SWIM
};
/** */
static void stlink_usb_recv_v1_create_cmd(char *b, int s, uint32_t tag, uint32_t rxsize,
uint8_t flag, uint8_t lun, uint8_t length)
{
int i = 0;
memset(b, 0x00, s);
/* fill the send buffer */
strcpy(b, "USBC");
i += 4;
buf_set_u32(b+i, 0, 32, tag);
i += 4;
buf_set_u32(b+i, 0, 32, rxsize);
i += 4;
b[i++] = flag;
b[i++] = lun;
b[i++] = length;
}
/** */
static int stlink_usb_recv_v1_mass_storage_cmd(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
int rxsize)
{
char sg_buffer[31];
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
h->sg_tag = (h->sg_tag + 1) & 1;
stlink_usb_recv_v1_create_cmd(sg_buffer, 31, h->sg_tag, rxsize, STLINK_TX_EP, 0x00, txsize);
memcpy(sg_buffer+15, txbuf, 10);
if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)sg_buffer, 31,
1000) != 31) {
printf("send failed\n");
return ERROR_FAIL;
}
return ERROR_OK;
}
#define REQUEST_SENSE 0x03
#define REQUEST_SENSE_LENGTH 18
/** */
static int stlink_usb_recv_v1_get_status(void *handle, char *sg_buffer, int len)
{
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
/* read status */
memset(sg_buffer, 0x00, len);
if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)sg_buffer,
len, 1000) != len)
return ERROR_FAIL;
uint32_t t1, t2;
t1 = buf_get_u32(sg_buffer+0, 0, 32);
t2 = buf_get_u32(sg_buffer+4, 0, 32);
/* check for USBS */
if (t1 != 0x53425355)
return ERROR_FAIL;
return ERROR_OK;
}
/** */
static int stlink_usb_recv_v1_get_sense(void *handle)
{
struct stlink_usb_handle_s *h;
char cdb[16];
char sg_buffer[31];
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
h->sg_tag = (h->sg_tag + 1) & 1;
cdb[0] = REQUEST_SENSE;
cdb[4] = REQUEST_SENSE_LENGTH;
stlink_usb_recv_v1_create_cmd(sg_buffer, 31, h->sg_tag, REQUEST_SENSE_LENGTH, STLINK_TX_EP,
0x00, 16);
memcpy(sg_buffer+15, cdb, 16);
if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)sg_buffer, 16,
1000) != 16)
return ERROR_FAIL;
if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)cdb,
16, 1000) != 16)
return ERROR_FAIL;
if (stlink_usb_recv_v1_get_status(handle, sg_buffer, 13) != ERROR_OK)
return ERROR_FAIL;
/* check for sense */
if (sg_buffer[12] != 0)
return ERROR_FAIL;
/* if (sense[0] != 0x70 && sense[0] != 0x71) */
return ERROR_OK;
}
/** */
static int stlink_usb_recv_v1(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
int rxsize)
{
int err;
char sg_buffer[31];
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
err = stlink_usb_recv_v1_mass_storage_cmd(handle, txbuf, txsize, rxbuf, rxsize);
if (err != ERROR_OK)
return err;
if (rxsize && rxbuf) {
if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)rxbuf,
rxsize, 1000) != rxsize) {
LOG_DEBUG("jtag_libusb_bulk_read");
return ERROR_FAIL;
}
}
if (stlink_usb_recv_v1_get_status(handle, sg_buffer, 13) != ERROR_OK)
return ERROR_FAIL;
/* check for sense */
if (sg_buffer[12] == 1) {
LOG_DEBUG("get sense");
err = stlink_usb_recv_v1_get_sense(handle);
}
return err;
}
/** */
static int stlink_usb_recv_v2(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
int rxsize)
{
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
if (jtag_libusb_bulk_write(h->fd, STLINK_TX_EP, (char *)txbuf, txsize,
1000) != txsize) {
return ERROR_FAIL;
}
if (rxsize && rxbuf) {
if (jtag_libusb_bulk_read(h->fd, STLINK_RX_EP, (char *)rxbuf,
rxsize, 1000) != rxsize) {
return ERROR_FAIL;
}
}
return ERROR_OK;
}
/** */
static int stlink_usb_recv(void *handle, const uint8_t *txbuf, int txsize, uint8_t *rxbuf,
int rxsize)
{
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
if (h->version.stlink == 1) {
return stlink_usb_recv_v1(handle, txbuf, txsize, rxbuf, rxsize);
} else {
if (txsize < STLINK_CMD_SIZE)
txsize = STLINK_CMD_SIZE;
return stlink_usb_recv_v2(handle, txbuf, txsize, rxbuf, rxsize);
}
}
/** */
static int stlink_usb_send(void *handle, const uint8_t *cmd, int cmdsize, uint8_t *txbuf,
int txsize)
{
return stlink_usb_xfer(handle, cmd, cmdsize, STLINK_TX_EP, txbuf, txsize);
}
/** */
static void stlink_usb_init_buffer(void *handle)
{
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
memset(h->txbuf, 0, STLINK_TX_SIZE);
memset(h->rxbuf, 0, STLINK_RX_SIZE);
}
static const char * const stlink_usb_error_msg[] = {
"unknown"
};
/** */
static int stlink_usb_error_check(void *handle)
{
int res;
const char *err_msg = 0;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
/* TODO: no error checking yet on api V1 */
if (h->jtag_api == STLINK_JTAG_API_V1)
h->rxbuf[0] = STLINK_DEBUG_ERR_OK;
switch (h->rxbuf[0]) {
case STLINK_DEBUG_ERR_OK:
res = ERROR_OK;
break;
case STLINK_DEBUG_ERR_FAULT:
default:
err_msg = stlink_usb_error_msg[0];
res = ERROR_FAIL;
break;
}
if (res != ERROR_OK)
LOG_DEBUG("status error: %d ('%s')", h->rxbuf[0], err_msg);
return res;
}
/** */
static int stlink_usb_version(void *handle)
{
int res;
uint16_t v;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_GET_VERSION;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 6);
if (res != ERROR_OK)
return res;
v = (h->rxbuf[0] << 8) | h->rxbuf[1];
h->version.stlink = (v >> 12) & 0x0f;
h->version.jtag = (v >> 6) & 0x3f;
h->version.swim = v & 0x3f;
h->vid = buf_get_u32(h->rxbuf, 16, 16);
h->pid = buf_get_u32(h->rxbuf, 32, 16);
/* set the supported jtag api version
* V1 doesn't support API V2 at all
* V2 support API V2 since JTAG V13
*/
if ((h->version.stlink == 2) && (h->version.jtag > 12))
h->version.jtag_api_max = STLINK_JTAG_API_V2;
else
h->version.jtag_api_max = STLINK_JTAG_API_V1;
LOG_DEBUG("STLINK v%d JTAG v%d API v%d SWIM v%d VID %04X PID %04X",
h->version.stlink,
h->version.jtag,
(h->version.jtag_api_max == STLINK_JTAG_API_V1) ? 1 : 2,
h->version.swim,
h->vid,
h->pid);
return ERROR_OK;
}
/** */
static int stlink_usb_current_mode(void *handle, uint8_t *mode)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_GET_CURRENT_MODE;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return res;
*mode = h->rxbuf[0];
return ERROR_OK;
}
/** */
static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
{
int res;
int rx_size = 0;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
switch (type) {
case STLINK_MODE_DEBUG_JTAG:
h->txbuf[0] = STLINK_DEBUG_COMMAND;
if (h->jtag_api == STLINK_JTAG_API_V1)
h->txbuf[1] = STLINK_DEBUG_APIV1_ENTER;
else
h->txbuf[1] = STLINK_DEBUG_APIV2_ENTER;
h->txbuf[2] = STLINK_DEBUG_ENTER_JTAG;
break;
case STLINK_MODE_DEBUG_SWD:
h->txbuf[0] = STLINK_DEBUG_COMMAND;
if (h->jtag_api == STLINK_JTAG_API_V1)
h->txbuf[1] = STLINK_DEBUG_APIV1_ENTER;
else
h->txbuf[1] = STLINK_DEBUG_APIV2_ENTER;
h->txbuf[2] = STLINK_DEBUG_ENTER_SWD;
break;
case STLINK_MODE_DEBUG_SWIM:
h->txbuf[0] = STLINK_SWIM_COMMAND;
h->txbuf[1] = STLINK_SWIM_ENTER;
break;
case STLINK_MODE_DFU:
case STLINK_MODE_MASS:
default:
return ERROR_FAIL;
}
/* on api V2 we are able the read the latest command
* status
* TODO: we need the test on api V1 too
*/
if (h->jtag_api == STLINK_JTAG_API_V2)
rx_size = 2;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, rx_size);
if (res != ERROR_OK)
return res;
res = stlink_usb_error_check(h);
return res;
}
/** */
static int stlink_usb_mode_leave(void *handle, enum stlink_mode type)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
switch (type) {
case STLINK_MODE_DEBUG_JTAG:
case STLINK_MODE_DEBUG_SWD:
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_EXIT;
break;
case STLINK_MODE_DEBUG_SWIM:
h->txbuf[0] = STLINK_SWIM_COMMAND;
h->txbuf[1] = STLINK_SWIM_EXIT;
break;
case STLINK_MODE_DFU:
h->txbuf[0] = STLINK_DFU_COMMAND;
h->txbuf[1] = STLINK_DFU_EXIT;
break;
case STLINK_MODE_MASS:
default:
return ERROR_FAIL;
}
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, 0, 0);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_init_mode(void *handle)
{
int res;
uint8_t mode;
enum stlink_mode emode;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
res = stlink_usb_current_mode(handle, &mode);
if (res != ERROR_OK)
return res;
LOG_DEBUG("MODE: %02X", mode);
/* try to exit current mode */
switch (mode) {
case STLINK_DEV_DFU_MODE:
emode = STLINK_MODE_DFU;
break;
case STLINK_DEV_DEBUG_MODE:
emode = STLINK_MODE_DEBUG_SWD;
break;
case STLINK_DEV_SWIM_MODE:
emode = STLINK_MODE_DEBUG_SWIM;
break;
case STLINK_DEV_BOOTLOADER_MODE:
case STLINK_DEV_MASS_MODE:
default:
emode = STLINK_MODE_UNKNOWN;
break;
}
if (emode != STLINK_MODE_UNKNOWN) {
res = stlink_usb_mode_leave(handle, emode);
if (res != ERROR_OK)
return res;
}
res = stlink_usb_current_mode(handle, &mode);
if (res != ERROR_OK)
return res;
LOG_DEBUG("MODE: %02X", mode);
/* set selected mode */
switch (h->transport) {
case STLINK_TRANSPORT_SWD:
emode = STLINK_MODE_DEBUG_SWD;
break;
case STLINK_TRANSPORT_JTAG:
emode = STLINK_MODE_DEBUG_JTAG;
break;
case STLINK_TRANSPORT_SWIM:
emode = STLINK_MODE_DEBUG_SWIM;
break;
default:
emode = STLINK_MODE_UNKNOWN;
break;
}
if (emode == STLINK_MODE_UNKNOWN) {
LOG_ERROR("selected mode (transport) not supported");
return ERROR_FAIL;
}
res = stlink_usb_mode_enter(handle, emode);
if (res != ERROR_OK)
return res;
res = stlink_usb_current_mode(handle, &mode);
if (res != ERROR_OK)
return res;
LOG_DEBUG("MODE: %02X", mode);
return ERROR_OK;
}
/** */
static int stlink_usb_idcode(void *handle, uint32_t *idcode)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_READCOREID;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 4);
if (res != ERROR_OK)
return res;
*idcode = le_to_h_u32(h->rxbuf);
LOG_DEBUG("IDCODE: %08X", *idcode);
return ERROR_OK;
}
/** */
static enum target_state stlink_usb_state(void *handle)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
if (h->jtag_api == STLINK_JTAG_API_V2)
return TARGET_UNKNOWN;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_GETSTATUS;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return TARGET_UNKNOWN;
if (h->rxbuf[0] == STLINK_CORE_RUNNING)
return TARGET_RUNNING;
if (h->rxbuf[0] == STLINK_CORE_HALTED)
return TARGET_HALTED;
return TARGET_UNKNOWN;
}
/** */
static int stlink_usb_reset(void *handle)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
if (h->jtag_api == STLINK_JTAG_API_V1)
h->txbuf[1] = STLINK_DEBUG_APIV1_RESETSYS;
else
h->txbuf[1] = STLINK_DEBUG_APIV2_RESETSYS;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return res;
LOG_DEBUG("RESET: %08X", h->rxbuf[0]);
return ERROR_OK;
}
/** */
static int stlink_usb_run(void *handle)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
if (h->jtag_api == STLINK_JTAG_API_V2)
return ERROR_FAIL;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_RUNCORE;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_halt(void *handle)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
if (h->jtag_api == STLINK_JTAG_API_V2)
return ERROR_FAIL;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_FORCEDEBUG;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_step(void *handle)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
if (h->jtag_api == STLINK_JTAG_API_V2)
return ERROR_FAIL;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_STEPCORE;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_read_regs(void *handle)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
if (h->jtag_api == STLINK_JTAG_API_V1)
h->txbuf[1] = STLINK_DEBUG_APIV1_READALLREGS;
else
h->txbuf[1] = STLINK_DEBUG_APIV2_READALLREGS;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 84);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
if (h->jtag_api == STLINK_JTAG_API_V1)
h->txbuf[1] = STLINK_DEBUG_APIV1_READREG;
else
h->txbuf[1] = STLINK_DEBUG_APIV2_READREG;
h->txbuf[2] = num;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 4);
if (res != ERROR_OK)
return res;
*val = le_to_h_u32(h->rxbuf);
return ERROR_OK;
}
/** */
static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
if (h->jtag_api == STLINK_JTAG_API_V1)
h->txbuf[1] = STLINK_DEBUG_APIV1_WRITEREG;
else
h->txbuf[1] = STLINK_DEBUG_APIV2_WRITEREG;
h->txbuf[2] = num;
h_u32_to_le(h->txbuf + 3, val);
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, 2);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
uint8_t *buffer)
{
int res;
uint16_t read_len = len;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_READMEM_8BIT;
h_u32_to_le(h->txbuf + 2, addr);
h_u16_to_le(h->txbuf + 2 + 4, len);
/* we need to fix read length for single bytes */
if (read_len == 1)
read_len++;
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, read_len);
if (res != ERROR_OK)
return res;
memcpy(buffer, h->rxbuf, len);
return ERROR_OK;
}
/** */
static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
const uint8_t *buffer)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_WRITEMEM_8BIT;
h_u32_to_le(h->txbuf + 2, addr);
h_u16_to_le(h->txbuf + 2 + 4, len);
res = stlink_usb_send(handle, h->txbuf, STLINK_CMD_SIZE, (uint8_t *) buffer, len);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
uint32_t *buffer)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
len *= 4;
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_READMEM_32BIT;
h_u32_to_le(h->txbuf + 2, addr);
h_u16_to_le(h->txbuf + 2 + 4, len);
res = stlink_usb_recv(handle, h->txbuf, STLINK_CMD_SIZE, h->rxbuf, len);
if (res != ERROR_OK)
return res;
memcpy(buffer, h->rxbuf, len);
return ERROR_OK;
}
/** */
static int stlink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
const uint32_t *buffer)
{
int res;
struct stlink_usb_handle_s *h;
assert(handle != NULL);
h = (struct stlink_usb_handle_s *)handle;
stlink_usb_init_buffer(handle);
len *= 4;
h->txbuf[0] = STLINK_DEBUG_COMMAND;
h->txbuf[1] = STLINK_DEBUG_WRITEMEM_32BIT;
h_u32_to_le(h->txbuf + 2, addr);
h_u16_to_le(h->txbuf + 2 + 4, len);
res = stlink_usb_send(handle, h->txbuf, STLINK_CMD_SIZE, (uint8_t *) buffer, len);
if (res != ERROR_OK)
return res;
return ERROR_OK;
}
/** */
static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
{
int err;
struct stlink_usb_handle_s *h;
LOG_DEBUG("stlink_usb_open");
h = malloc(sizeof(struct stlink_usb_handle_s));
if (h == 0) {
LOG_DEBUG("malloc failed");
return ERROR_FAIL;
}
h->transport = param->transport;
const uint16_t vids[] = { param->vid, 0 };
const uint16_t pids[] = { param->pid, 0 };
LOG_DEBUG("transport: %d vid: %04x pid: %04x", param->transport,
param->vid, param->pid);
if (jtag_libusb_open(vids, pids, &h->fd) != ERROR_OK) {
LOG_ERROR("open failed");
return ERROR_FAIL;
}
jtag_libusb_set_configuration(h->fd, 0);
if (jtag_libusb_claim_interface(h->fd, 0) != ERROR_OK) {
LOG_DEBUG("claim interface failed");
return ERROR_FAIL;
}
/* wrap version for first read */
switch (param->pid) {
case 0x3744:
h->version.stlink = 1;
break;
default:
h->version.stlink = 2;
break;
}
/* get the device version */
err = stlink_usb_version(h);
if (err != ERROR_OK) {
LOG_ERROR("read version failed");
jtag_libusb_close(h->fd);
free(h);
return err;
}
/* compare usb vid/pid */
if ((param->vid != h->vid) || (param->pid != h->pid))
LOG_INFO("vid/pid are not identical: %04X/%04X %04X/%04X",
param->vid, param->pid,
h->vid, h->pid);
/* check if mode is supported */
err = ERROR_OK;
switch (h->transport) {
case STLINK_TRANSPORT_SWD:
case STLINK_TRANSPORT_JTAG:
if (h->version.jtag == 0)
err = ERROR_FAIL;
break;
case STLINK_TRANSPORT_SWIM:
if (h->version.swim == 0)
err = ERROR_FAIL;
break;
default:
err = ERROR_FAIL;
break;
}
if (err != ERROR_OK) {
LOG_ERROR("mode (transport) not supported by device");
jtag_libusb_close(h->fd);
free(h);
return err;
}
/* set the used jtag api */
h->jtag_api = STLINK_JTAG_API_V1;
/* initialize the debug hardware */
err = stlink_usb_init_mode(h);
if (err != ERROR_OK) {
LOG_ERROR("init mode failed");
jtag_libusb_close(h->fd);
free(h);
return err;
}
*fd = h;
return ERROR_OK;
}
/** */
static int stlink_usb_close(void *fd)
{
return ERROR_OK;
}
/** */
struct stlink_layout_api_s stlink_usb_layout_api = {
/** */
.open = stlink_usb_open,
/** */
.close = stlink_usb_close,
/** */
.idcode = stlink_usb_idcode,
/** */
.state = stlink_usb_state,
/** */
.reset = stlink_usb_reset,
/** */
.run = stlink_usb_run,
/** */
.halt = stlink_usb_halt,
/** */
.step = stlink_usb_step,
/** */
.read_regs = stlink_usb_read_regs,
/** */
.read_reg = stlink_usb_read_reg,
/** */
.write_reg = stlink_usb_write_reg,
/** */
.read_mem8 = stlink_usb_read_mem8,
/** */
.write_mem8 = stlink_usb_write_mem8,
/** */
.read_mem32 = stlink_usb_read_mem32,
/** */
.write_mem32 = stlink_usb_write_mem32,
};
|