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
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
|
/***************************************************************************
* Copyright (C) 2016-2017 by Nuvoton *
* Zale Yu <cyyu@nuvoton.com> *
* *
* 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, see <http://www.gnu.org/licenses/>. *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
/* project specific includes */
#include <helper/binarybuffer.h>
#include <jtag/adapter.h>
#include <jtag/interface.h>
#include <jtag/hla/hla_layout.h>
#include <jtag/hla/hla_transport.h>
#include <jtag/hla/hla_interface.h>
#include <target/target.h>
#include <target/cortex_m.h>
#include <hidapi.h>
#include "libusb_helper.h"
#define NULINK_READ_TIMEOUT LIBUSB_TIMEOUT_MS
#define NULINK_HID_MAX_SIZE (64)
#define NULINK2_HID_MAX_SIZE (1024)
#define V6M_MAX_COMMAND_LENGTH (NULINK_HID_MAX_SIZE - 2)
#define V7M_MAX_COMMAND_LENGTH (NULINK_HID_MAX_SIZE - 3)
#define NULINK2_USB_PID1 (0x5200)
#define NULINK2_USB_PID2 (0x5201)
struct nulink_usb_handle_s {
hid_device *dev_handle;
uint16_t max_packet_size;
uint8_t usbcmdidx;
uint8_t cmdidx;
uint8_t cmdsize;
uint8_t cmdbuf[NULINK2_HID_MAX_SIZE + 1];
uint8_t tempbuf[NULINK2_HID_MAX_SIZE];
uint8_t databuf[NULINK2_HID_MAX_SIZE];
uint32_t max_mem_packet;
uint16_t hardware_config; /* bit 0: 1:Nu-Link-Pro, 0:Nu-Link */
int (*xfer)(void *handle, uint8_t *buf, int size);
void (*init_buffer)(void *handle, uint32_t size);
};
/* ICE Command */
#define CMD_READ_REG 0xB5UL
#define CMD_READ_RAM 0xB1UL
#define CMD_WRITE_REG 0xB8UL
#define CMD_WRITE_RAM 0xB9UL
#define CMD_CHECK_ID 0xA3UL
#define CMD_MCU_RESET 0xE2UL
#define CMD_CHECK_MCU_STOP 0xD8UL
#define CMD_MCU_STEP_RUN 0xD1UL
#define CMD_MCU_STOP_RUN 0xD2UL
#define CMD_MCU_FREE_RUN 0xD3UL
#define CMD_SET_CONFIG 0xA2UL
#define ARM_SRAM_BASE 0x20000000UL
#define HARDWARE_CONFIG_NULINKPRO 1
#define HARDWARE_CONFIG_NULINK2 2
enum nulink_reset {
RESET_AUTO = 0,
RESET_HW = 1,
RESET_SYSRESETREQ = 2,
RESET_VECTRESET = 3,
RESET_FAST_RESCUE = 4, /* Rescue and erase the chip, need very fast speed */
};
enum nulink_connect {
CONNECT_NORMAL = 0, /* Support all reset method */
CONNECT_PRE_RESET = 1, /* Support all reset method */
CONNECT_UNDER_RESET = 2, /* Support all reset method */
CONNECT_NONE = 3, /* Support RESET_HW, (RESET_AUTO = RESET_HW) */
CONNECT_DISCONNECT = 4, /* Support RESET_NONE, (RESET_AUTO = RESET_NONE) */
CONNECT_ICP_MODE = 5 /* Support NUC505 ICP mode*/
};
static int nulink_usb_xfer_rw(void *handle, uint8_t *buf)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
int ret = hid_write(h->dev_handle, h->cmdbuf, h->max_packet_size + 1);
if (ret < 0) {
LOG_ERROR("hid_write");
return ERROR_FAIL;
}
ret = hid_read_timeout(h->dev_handle, buf, h->max_packet_size, NULINK_READ_TIMEOUT);
if (ret < 0) {
LOG_ERROR("hid_read_timeout");
return ERROR_FAIL;
}
return ERROR_OK;
}
static int nulink1_usb_xfer(void *handle, uint8_t *buf, int size)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
int err = nulink_usb_xfer_rw(h, h->tempbuf);
memcpy(buf, h->tempbuf + 2, V6M_MAX_COMMAND_LENGTH);
return err;
}
static int nulink2_usb_xfer(void *handle, uint8_t *buf, int size)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
int err = nulink_usb_xfer_rw(h, h->tempbuf);
memcpy(buf, h->tempbuf + 3, V7M_MAX_COMMAND_LENGTH);
return err;
}
static void nulink1_usb_init_buffer(void *handle, uint32_t size)
{
struct nulink_usb_handle_s *h = handle;
h->cmdidx = 0;
memset(h->cmdbuf, 0, h->max_packet_size + 1);
memset(h->tempbuf, 0, h->max_packet_size);
memset(h->databuf, 0, h->max_packet_size);
h->cmdbuf[0] = 0; /* report number */
h->cmdbuf[1] = ++h->usbcmdidx & 0x7F;
h->cmdbuf[2] = size;
h->cmdidx += 3;
}
static void nulink2_usb_init_buffer(void *handle, uint32_t size)
{
struct nulink_usb_handle_s *h = handle;
h->cmdidx = 0;
memset(h->cmdbuf, 0, h->max_packet_size + 1);
memset(h->tempbuf, 0, h->max_packet_size);
memset(h->databuf, 0, h->max_packet_size);
h->cmdbuf[0] = 0; /* report number */
h->cmdbuf[1] = ++h->usbcmdidx & 0x7F;
h_u16_to_le(h->cmdbuf + 2, size);
h->cmdidx += 4;
}
static inline int nulink_usb_xfer(void *handle, uint8_t *buf, int size)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
return h->xfer(handle, buf, size);
}
static inline void nulink_usb_init_buffer(void *handle, uint32_t size)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
h->init_buffer(handle, size);
}
static int nulink_usb_version(void *handle)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_version");
assert(handle);
nulink_usb_init_buffer(handle, V6M_MAX_COMMAND_LENGTH);
memset(h->cmdbuf + h->cmdidx, 0xFF, V6M_MAX_COMMAND_LENGTH);
h->cmdbuf[h->cmdidx + 4] = 0xA1; /* host_rev_num: 6561 */;
h->cmdbuf[h->cmdidx + 5] = 0x19;
int res = nulink_usb_xfer(handle, h->databuf, h->cmdsize);
if (res != ERROR_OK)
return res;
LOG_INFO("Nu-Link firmware_version %" PRIu32 ", product_id (0x%08" PRIx32 ")",
le_to_h_u32(h->databuf),
le_to_h_u32(h->databuf + 4 * 1));
const bool is_nulinkpro = !!(le_to_h_u32(h->databuf + 4 * 2) & 1);
if (is_nulinkpro) {
LOG_INFO("Adapter is Nu-Link-Pro, target_voltage_mv(%" PRIu16 "), usb_voltage_mv(%" PRIu16 ")",
le_to_h_u16(h->databuf + 4 * 3 + 0),
le_to_h_u16(h->databuf + 4 * 3 + 2));
h->hardware_config |= HARDWARE_CONFIG_NULINKPRO;
} else {
LOG_INFO("Adapter is Nu-Link");
}
return ERROR_OK;
}
static int nulink_usb_idcode(void *handle, uint32_t *idcode)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_idcode");
assert(handle);
nulink_usb_init_buffer(handle, 4 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_CHECK_ID);
h->cmdidx += 4;
int res = nulink_usb_xfer(handle, h->databuf, 4 * 2);
if (res != ERROR_OK)
return res;
*idcode = le_to_h_u32(h->databuf + 4 * 1);
LOG_INFO("IDCODE: 0x%08" PRIX32, *idcode);
return ERROR_OK;
}
static int nulink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_write_debug_reg 0x%08" PRIX32 " 0x%08" PRIX32, addr, val);
nulink_usb_init_buffer(handle, 8 + 12 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_RAM);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = 1;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, addr);
h->cmdidx += 4;
/* u32Data */
h_u32_to_le(h->cmdbuf + h->cmdidx, val);
h->cmdidx += 4;
/* u32Mask */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0x00000000UL);
h->cmdidx += 4;
return nulink_usb_xfer(handle, h->databuf, 4 * 2);
}
static enum target_state nulink_usb_state(void *handle)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
nulink_usb_init_buffer(handle, 4 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_CHECK_MCU_STOP);
h->cmdidx += 4;
int res = nulink_usb_xfer(handle, h->databuf, 4 * 4);
if (res != ERROR_OK)
return TARGET_UNKNOWN;
if (!le_to_h_u32(h->databuf + 4 * 2))
return TARGET_HALTED;
else
return TARGET_RUNNING;
}
static int nulink_usb_assert_srst(void *handle, int srst)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_assert_srst");
assert(handle);
nulink_usb_init_buffer(handle, 4 * 4);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_MCU_RESET);
h->cmdidx += 4;
/* set reset type */
h_u32_to_le(h->cmdbuf + h->cmdidx, RESET_SYSRESETREQ);
h->cmdidx += 4;
/* set connect type */
h_u32_to_le(h->cmdbuf + h->cmdidx, CONNECT_NORMAL);
h->cmdidx += 4;
/* set extMode */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
return nulink_usb_xfer(handle, h->databuf, 4 * 4);
}
static int nulink_usb_reset(void *handle)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_reset");
assert(handle);
nulink_usb_init_buffer(handle, 4 * 4);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_MCU_RESET);
h->cmdidx += 4;
/* set reset type */
h_u32_to_le(h->cmdbuf + h->cmdidx, RESET_HW);
h->cmdidx += 4;
/* set connect type */
h_u32_to_le(h->cmdbuf + h->cmdidx, CONNECT_NORMAL);
h->cmdidx += 4;
/* set extMode */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
return nulink_usb_xfer(handle, h->databuf, 4 * 4);
}
static int nulink_usb_run(void *handle)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_run");
assert(handle);
nulink_usb_init_buffer(handle, 4 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_MCU_FREE_RUN);
h->cmdidx += 4;
return nulink_usb_xfer(handle, h->databuf, 4 * 4);
}
static int nulink_usb_halt(void *handle)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_halt");
assert(handle);
nulink_usb_init_buffer(handle, 4 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_MCU_STOP_RUN);
h->cmdidx += 4;
int res = nulink_usb_xfer(handle, h->databuf, 4 * 4);
LOG_DEBUG("Nu-Link stop_pc 0x%08" PRIx32, le_to_h_u32(h->databuf + 4));
return res;
}
static int nulink_usb_step(void *handle)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_step");
assert(handle);
nulink_usb_init_buffer(handle, 4 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_MCU_STEP_RUN);
h->cmdidx += 4;
int res = nulink_usb_xfer(handle, h->databuf, 4 * 4);
LOG_DEBUG("Nu-Link pc 0x%08" PRIx32, le_to_h_u32(h->databuf + 4));
return res;
}
static int nulink_usb_read_reg(void *handle, unsigned int regsel, uint32_t *val)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
nulink_usb_init_buffer(handle, 8 + 12 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_REG);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = 1;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0xFF;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, regsel);
h->cmdidx += 4;
/* u32Data */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
/* u32Mask */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFFFFFFFFUL);
h->cmdidx += 4;
int res = nulink_usb_xfer(handle, h->databuf, 4 * 2);
*val = le_to_h_u32(h->databuf + 4 * 1);
return res;
}
static int nulink_usb_write_reg(void *handle, unsigned int regsel, uint32_t val)
{
struct nulink_usb_handle_s *h = handle;
assert(handle);
nulink_usb_init_buffer(handle, 8 + 12 * 1);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_REG);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = 1;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, regsel);
h->cmdidx += 4;
/* u32Data */
h_u32_to_le(h->cmdbuf + h->cmdidx, val);
h->cmdidx += 4;
/* u32Mask */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0x00000000UL);
h->cmdidx += 4;
return nulink_usb_xfer(handle, h->databuf, 4 * 2);
}
static int nulink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
uint8_t *buffer)
{
int res = ERROR_OK;
uint32_t offset = 0;
uint32_t bytes_remaining = 12;
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_read_mem8: addr 0x%08" PRIx32 ", len %" PRId16, addr, len);
assert(handle);
/* check whether data is word aligned */
if (addr % 4) {
uint32_t aligned_addr = addr / 4;
aligned_addr = aligned_addr * 4;
offset = addr - aligned_addr;
LOG_DEBUG("nulink_usb_read_mem8: unaligned address addr 0x%08" PRIx32
"/aligned addr 0x%08" PRIx32 " offset %" PRIu32,
addr, aligned_addr, offset);
addr = aligned_addr;
}
while (len) {
unsigned int count;
if (len < bytes_remaining)
bytes_remaining = len;
if (len < 4)
count = 1;
else
count = 2;
nulink_usb_init_buffer(handle, 8 + 12 * count);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_RAM);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = count;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0xFF;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
for (unsigned int i = 0; i < count; i++) {
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, addr);
h->cmdidx += 4;
/* u32Data */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
/* u32Mask */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFFFFFFFFUL);
h->cmdidx += 4;
/* proceed to the next one */
addr += 4;
}
res = nulink_usb_xfer(handle, h->databuf, 4 * count * 2);
if (res != ERROR_OK)
break;
/* fill in the output buffer */
for (unsigned int i = 0; i < count; i++) {
if (i == 0)
memcpy(buffer, h->databuf + 4 + offset, len);
else
memcpy(buffer + 2 * i, h->databuf + 4 * (2 * i + 1), len - 2);
}
if (len >= bytes_remaining)
len -= bytes_remaining;
}
return res;
}
static int nulink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
const uint8_t *buffer)
{
int res = ERROR_OK;
uint32_t offset = 0;
uint32_t bytes_remaining = 12;
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_write_mem8: addr 0x%08" PRIx32 ", len %" PRIu16, addr, len);
assert(handle);
/* check whether data is word aligned */
if (addr % 4) {
uint32_t aligned_addr = addr / 4;
aligned_addr = aligned_addr * 4;
offset = addr - aligned_addr;
LOG_DEBUG("nulink_usb_write_mem8: address not aligned. addr(0x%08" PRIx32
")/aligned_addr(0x%08" PRIx32 ")/offset(%" PRIu32 ")",
addr, aligned_addr, offset);
addr = aligned_addr;
}
while (len) {
unsigned int count;
if (len < bytes_remaining)
bytes_remaining = len;
if (len < 4)
count = 1;
else
count = 2;
nulink_usb_init_buffer(handle, 8 + 12 * count);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_RAM);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = count;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
for (unsigned int i = 0; i < count; i++) {
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, addr);
h->cmdidx += 4;
/* u32Data */
uint32_t u32buffer = buf_get_u32(buffer, 0, len * 8);
u32buffer = (u32buffer << offset * 8);
h_u32_to_le(h->cmdbuf + h->cmdidx, u32buffer);
h->cmdidx += 4;
/* u32Mask */
if (i == 0) {
if (offset == 0) {
if (len == 1) {
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFFFFFF00UL);
LOG_DEBUG("nulink_usb_write_mem8: count(%u), mask: 0xFFFFFF00", i);
} else {
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFFFF0000UL);
LOG_DEBUG("nulink_usb_write_mem8: count(%u), mask: 0xFFFF0000", i);
}
} else {
if (len == 1) {
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFF00FFFFUL);
LOG_DEBUG("nulink_usb_write_mem8: count(%u), mask: 0xFF00FFFF", i);
} else {
h_u32_to_le(h->cmdbuf + h->cmdidx, 0x0000FFFFUL);
LOG_DEBUG("nulink_usb_write_mem8: count(%u), mask: 0x0000FFFF", i);
}
}
} else {
if (len == 4) {
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFFFF0000UL);
LOG_DEBUG("nulink_usb_write_mem8: count(%u), mask: 0xFFFF0000", i);
} else {
h_u32_to_le(h->cmdbuf + h->cmdidx, 0x00000000UL);
LOG_DEBUG("nulink_usb_write_mem8: count(%u), mask: 0x00000000", i);
}
}
h->cmdidx += 4;
/* proceed to the next one */
addr += 4;
buffer += 4;
}
res = nulink_usb_xfer(handle, h->databuf, 4 * count * 2);
if (res != ERROR_OK)
break;
if (len >= bytes_remaining)
len -= bytes_remaining;
}
return res;
}
static int nulink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
uint8_t *buffer)
{
int res = ERROR_OK;
uint32_t bytes_remaining = 12;
struct nulink_usb_handle_s *h = handle;
assert(handle);
/* data must be a multiple of 4 and word aligned */
if (len % 4 || addr % 4) {
LOG_ERROR("Invalid data alignment");
return ERROR_TARGET_UNALIGNED_ACCESS;
}
while (len) {
if (len < bytes_remaining)
bytes_remaining = len;
unsigned int count = bytes_remaining / 4;
nulink_usb_init_buffer(handle, 8 + 12 * count);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_RAM);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = count;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0xFF;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
for (unsigned int i = 0; i < count; i++) {
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, addr);
h->cmdidx += 4;
/* u32Data */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
/* u32Mask */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0xFFFFFFFFUL);
h->cmdidx += 4;
/* proceed to the next one */
addr += 4;
}
res = nulink_usb_xfer(handle, h->databuf, 4 * count * 2);
/* fill in the output buffer */
for (unsigned int i = 0; i < count; i++) {
memcpy(buffer, h->databuf + 4 * (2 * i + 1), 4);
buffer += 4;
}
if (len >= bytes_remaining)
len -= bytes_remaining;
else
len = 0;
}
return res;
}
static int nulink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
const uint8_t *buffer)
{
int res = ERROR_OK;
uint32_t bytes_remaining = 12;
struct nulink_usb_handle_s *h = handle;
assert(handle);
/* data must be a multiple of 4 and word aligned */
if (len % 4 || addr % 4) {
LOG_ERROR("Invalid data alignment");
return ERROR_TARGET_UNALIGNED_ACCESS;
}
while (len) {
if (len < bytes_remaining)
bytes_remaining = len;
unsigned int count = bytes_remaining / 4;
nulink_usb_init_buffer(handle, 8 + 12 * count);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_WRITE_RAM);
h->cmdidx += 4;
/* Count of registers */
h->cmdbuf[h->cmdidx] = count;
h->cmdidx += 1;
/* Array of bool value (u8ReadOld) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* Array of bool value (u8Verify) */
h->cmdbuf[h->cmdidx] = 0x00;
h->cmdidx += 1;
/* ignore */
h->cmdbuf[h->cmdidx] = 0;
h->cmdidx += 1;
for (unsigned int i = 0; i < count; i++) {
/* u32Addr */
h_u32_to_le(h->cmdbuf + h->cmdidx, addr);
h->cmdidx += 4;
/* u32Data */
uint32_t u32buffer = buf_get_u32(buffer, 0, 32);
h_u32_to_le(h->cmdbuf + h->cmdidx, u32buffer);
h->cmdidx += 4;
/* u32Mask */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0x00000000);
h->cmdidx += 4;
/* proceed to the next one */
addr += 4;
buffer += 4;
}
res = nulink_usb_xfer(handle, h->databuf, 4 * count * 2);
if (len >= bytes_remaining)
len -= bytes_remaining;
else
len = 0;
}
return res;
}
static uint32_t nulink_max_block_size(uint32_t tar_autoincr_block, uint32_t address)
{
uint32_t max_tar_block = (tar_autoincr_block - ((tar_autoincr_block - 1) & address));
if (max_tar_block == 0)
max_tar_block = 4;
return max_tar_block;
}
static int nulink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
uint32_t count, uint8_t *buffer)
{
int retval = ERROR_OK;
struct nulink_usb_handle_s *h = handle;
/* calculate byte count */
count *= size;
while (count) {
uint32_t bytes_remaining = nulink_max_block_size(h->max_mem_packet, addr);
if (count < bytes_remaining)
bytes_remaining = count;
if (bytes_remaining >= 4)
size = 4;
/* the nulink only supports 8/32bit memory read/writes
* honour 32bit, all others will be handled as 8bit access */
if (size == 4) {
/* When in jtag mode the nulink uses the auto-increment functionality.
* However it expects us to pass the data correctly, this includes
* alignment and any page boundaries. We already do this as part of the
* adi_v5 implementation, but the nulink is a hla adapter and so this
* needs implementing manually.
* currently this only affects jtag mode, they do single
* access in SWD mode - but this may change and so we do it for both modes */
/* we first need to check for any unaligned bytes */
if (addr % 4) {
uint32_t head_bytes = 4 - (addr % 4);
retval = nulink_usb_read_mem8(handle, addr, head_bytes, buffer);
if (retval != ERROR_OK)
return retval;
buffer += head_bytes;
addr += head_bytes;
count -= head_bytes;
bytes_remaining -= head_bytes;
}
if (bytes_remaining % 4)
retval = nulink_usb_read_mem(handle, addr, 1, bytes_remaining, buffer);
else
retval = nulink_usb_read_mem32(handle, addr, bytes_remaining, buffer);
} else {
retval = nulink_usb_read_mem8(handle, addr, bytes_remaining, buffer);
}
if (retval != ERROR_OK)
return retval;
buffer += bytes_remaining;
addr += bytes_remaining;
count -= bytes_remaining;
}
return retval;
}
static int nulink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
uint32_t count, const uint8_t *buffer)
{
int retval = ERROR_OK;
struct nulink_usb_handle_s *h = handle;
if (addr < ARM_SRAM_BASE) {
LOG_DEBUG("nulink_usb_write_mem: address below ARM_SRAM_BASE, not supported.\n");
return retval;
}
/* calculate byte count */
count *= size;
while (count) {
uint32_t bytes_remaining = nulink_max_block_size(h->max_mem_packet, addr);
if (count < bytes_remaining)
bytes_remaining = count;
if (bytes_remaining >= 4)
size = 4;
/* the nulink only supports 8/32bit memory read/writes
* honour 32bit, all others will be handled as 8bit access */
if (size == 4) {
/* When in jtag mode the nulink uses the auto-increment functionality.
* However it expects us to pass the data correctly, this includes
* alignment and any page boundaries. We already do this as part of the
* adi_v5 implementation, but the nulink is a hla adapter and so this
* needs implementing manually.
* currently this only affects jtag mode, do single
* access in SWD mode - but this may change and so we do it for both modes */
/* we first need to check for any unaligned bytes */
if (addr % 4) {
uint32_t head_bytes = 4 - (addr % 4);
retval = nulink_usb_write_mem8(handle, addr, head_bytes, buffer);
if (retval != ERROR_OK)
return retval;
buffer += head_bytes;
addr += head_bytes;
count -= head_bytes;
bytes_remaining -= head_bytes;
}
if (bytes_remaining % 4)
retval = nulink_usb_write_mem(handle, addr, 1, bytes_remaining, buffer);
else
retval = nulink_usb_write_mem32(handle, addr, bytes_remaining, buffer);
} else {
retval = nulink_usb_write_mem8(handle, addr, bytes_remaining, buffer);
}
if (retval != ERROR_OK)
return retval;
buffer += bytes_remaining;
addr += bytes_remaining;
count -= bytes_remaining;
}
return retval;
}
static int nulink_usb_override_target(const char *targetname)
{
LOG_DEBUG("nulink_usb_override_target");
return !strcmp(targetname, "cortex_m");
}
static int nulink_speed(void *handle, int khz, bool query)
{
struct nulink_usb_handle_s *h = handle;
unsigned long max_ice_clock = khz;
LOG_DEBUG("nulink_speed: query %s", query ? "yes" : "no");
if (max_ice_clock > 12000)
max_ice_clock = 12000;
else if ((max_ice_clock == 3 * 512) || (max_ice_clock == 1500))
max_ice_clock = 1500;
else if (max_ice_clock >= 1000)
max_ice_clock = max_ice_clock / 1000 * 1000;
else
max_ice_clock = max_ice_clock / 100 * 100;
LOG_DEBUG("Nu-Link nulink_speed: %lu", max_ice_clock);
if (!query) {
nulink_usb_init_buffer(handle, 4 * 6);
/* set command ID */
h_u32_to_le(h->cmdbuf + h->cmdidx, CMD_SET_CONFIG);
h->cmdidx += 4;
/* set max SWD clock */
h_u32_to_le(h->cmdbuf + h->cmdidx, max_ice_clock);
h->cmdidx += 4;
/* chip type: NUC_CHIP_TYPE_GENERAL_V6M */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
/* IO voltage */
h_u32_to_le(h->cmdbuf + h->cmdidx, 5000);
h->cmdidx += 4;
/* If supply voltage to target or not */
h_u32_to_le(h->cmdbuf + h->cmdidx, 0);
h->cmdidx += 4;
/* USB_FUNC_E: USB_FUNC_HID_BULK */
h_u32_to_le(h->cmdbuf + h->cmdidx, 2);
h->cmdidx += 4;
nulink_usb_xfer(handle, h->databuf, 4 * 3);
LOG_DEBUG("nulink_speed: h->hardware_config(%" PRId16 ")", h->hardware_config);
if (h->hardware_config & HARDWARE_CONFIG_NULINKPRO)
LOG_INFO("Nu-Link target_voltage_mv[0](%04" PRIx16 "), target_voltage_mv[1](%04" PRIx16
"), target_voltage_mv[2](%04" PRIx16 "), if_target_power_supplied(%d)",
le_to_h_u16(h->databuf + 4 * 1 + 0),
le_to_h_u16(h->databuf + 4 * 1 + 2),
le_to_h_u16(h->databuf + 4 * 2 + 0),
le_to_h_u16(h->databuf + 4 * 2 + 2) & 1);
}
return max_ice_clock;
}
static int nulink_usb_close(void *handle)
{
struct nulink_usb_handle_s *h = handle;
LOG_DEBUG("nulink_usb_close");
if (h && h->dev_handle)
hid_close(h->dev_handle);
free(h);
hid_exit();
return ERROR_OK;
}
static int nulink_usb_open(struct hl_interface_param_s *param, void **fd)
{
struct hid_device_info *devs, *cur_dev;
uint16_t target_vid = 0;
uint16_t target_pid = 0;
wchar_t *target_serial = NULL;
LOG_DEBUG("nulink_usb_open");
if (param->transport != HL_TRANSPORT_SWD)
return TARGET_UNKNOWN;
if (!param->vid[0] && !param->pid[0]) {
LOG_ERROR("Missing vid/pid");
return ERROR_FAIL;
}
if (hid_init() != 0) {
LOG_ERROR("unable to open HIDAPI");
return ERROR_FAIL;
}
struct nulink_usb_handle_s *h = calloc(1, sizeof(*h));
if (!h) {
LOG_ERROR("Out of memory");
goto error_open;
}
const char *serial = adapter_get_required_serial();
if (serial) {
size_t len = mbstowcs(NULL, serial, 0);
target_serial = calloc(len + 1, sizeof(wchar_t));
if (!target_serial) {
LOG_ERROR("Out of memory");
goto error_open;
}
if (mbstowcs(target_serial, serial, len + 1) == (size_t)(-1)) {
LOG_WARNING("unable to convert serial");
free(target_serial);
target_serial = NULL;
}
}
devs = hid_enumerate(0, 0);
cur_dev = devs;
while (cur_dev) {
bool found = false;
for (unsigned int i = 0; param->vid[i] || param->pid[i]; i++) {
if (param->vid[i] == cur_dev->vendor_id && param->pid[i] == cur_dev->product_id) {
found = true;
break;
}
}
if (found) {
if (!target_serial)
break;
if (cur_dev->serial_number && wcscmp(target_serial, cur_dev->serial_number) == 0)
break;
}
cur_dev = cur_dev->next;
}
if (cur_dev) {
target_vid = cur_dev->vendor_id;
target_pid = cur_dev->product_id;
}
hid_free_enumeration(devs);
if (target_vid == 0 && target_pid == 0) {
LOG_ERROR("unable to find Nu-Link");
goto error_open;
}
hid_device *dev = hid_open(target_vid, target_pid, target_serial);
if (!dev) {
LOG_ERROR("unable to open Nu-Link device 0x%" PRIx16 ":0x%" PRIx16, target_vid, target_pid);
goto error_open;
}
h->dev_handle = dev;
h->usbcmdidx = 0;
switch (target_pid) {
case NULINK2_USB_PID1:
case NULINK2_USB_PID2:
h->hardware_config = HARDWARE_CONFIG_NULINK2;
h->max_packet_size = NULINK2_HID_MAX_SIZE;
h->init_buffer = nulink2_usb_init_buffer;
h->xfer = nulink2_usb_xfer;
break;
default:
h->hardware_config = 0;
h->max_packet_size = NULINK_HID_MAX_SIZE;
h->init_buffer = nulink1_usb_init_buffer;
h->xfer = nulink1_usb_xfer;
break;
}
/* get the device version */
h->cmdsize = 4 * 5;
int err = nulink_usb_version(h);
if (err != ERROR_OK) {
LOG_DEBUG("nulink_usb_version failed with cmdSize(4 * 5)");
h->cmdsize = 4 * 6;
err = nulink_usb_version(h);
if (err != ERROR_OK)
LOG_DEBUG("nulink_usb_version failed with cmdSize(4 * 6)");
}
/* SWD clock rate : 1MHz */
nulink_speed(h, 1000, false);
/* get cpuid, so we can determine the max page size
* start with a safe default */
h->max_mem_packet = (1 << 10);
LOG_DEBUG("nulink_usb_open: we manually perform nulink_usb_reset");
nulink_usb_reset(h);
*fd = h;
free(target_serial);
return ERROR_OK;
error_open:
nulink_usb_close(h);
free(target_serial);
return ERROR_FAIL;
}
struct hl_layout_api_s nulink_usb_layout_api = {
.open = nulink_usb_open,
.close = nulink_usb_close,
.idcode = nulink_usb_idcode,
.state = nulink_usb_state,
.reset = nulink_usb_reset,
.assert_srst = nulink_usb_assert_srst,
.run = nulink_usb_run,
.halt = nulink_usb_halt,
.step = nulink_usb_step,
.read_reg = nulink_usb_read_reg,
.write_reg = nulink_usb_write_reg,
.read_mem = nulink_usb_read_mem,
.write_mem = nulink_usb_write_mem,
.write_debug_reg = nulink_usb_write_debug_reg,
.override_target = nulink_usb_override_target,
.speed = nulink_speed,
};
|