1
2
3
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
45
46
47
50
53
54
55
56
57
58
59
60
61
62
63
64
65
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
130
131
132
133
134
135
136
137
138
148
149
150
151
152
153
157
158
159
160
161
165
166
167
168
169
170
177
178
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
207
208
209
210
211
219
220
224
225
226
227
228
229
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
261
262
263
264
265
272
273
274
275
276
277
282
283
291
292
293
294
295
296
297
298
299
300
301
302
303
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
327
328
329
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
385
386
387
388
389
390
391
392
393
397
398
399
400
401
406
407
412
413
414
415
416
417
418
419
420
421
422
423
424
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
466
467
468
469
470
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
493
494
495
496
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
546
547
548
549
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
573
574
575
576
577
578
579
580
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
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
679
680
681
682
683
684
686
687
688
692
693
697
698
699
700
701
712
713
717
718
719
720
721
722
723
727
728
729
730
731
732
733
734
735
736
737
738
739
740
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
/* ... */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#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 "libusb_helper.h"
9 includes
#define ICDI_WRITE_ENDPOINT 0x02
#define ICDI_READ_ENDPOINT 0x83
#define ICDI_WRITE_TIMEOUT (LIBUSB_TIMEOUT_MS)
#define ICDI_READ_TIMEOUT (LIBUSB_TIMEOUT_MS)
#define ICDI_PACKET_SIZE 2048
#define PACKET_START "$"
#define PACKET_END "#"
7 defines
struct icdi_usb_handle {
struct libusb_device_handle *usb_dev;
char *read_buffer;
char *write_buffer;
int max_packet;
int read_count;
uint32_t max_rw_packet;
...};
#ifdef HLA_MULTICORE
#define TARGET_ARGUMENT , struct target *target
#define PASS_TARGET_ARGUMENT , target
/* ... */#else
#define TARGET_ARGUMENT
#define PASS_TARGET_ARGUMENT
/* ... */#endif
static int icdi_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
uint32_t count, uint8_t *buffer TARGET_ARGUMENT);
static int icdi_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
uint32_t count, const uint8_t *buffer TARGET_ARGUMENT);
static int remote_escape_output(const char *buffer, int len, char *out_buf, int *out_len, int out_maxlen)
{
int input_index, output_index;
output_index = 0;
for (input_index = 0; input_index < len; input_index++) {
char b = buffer[input_index];
if (b == '$' || b == '#' || b == '}' || b == '*') {
if (output_index + 2 > out_maxlen)
break;
out_buf[output_index++] = '}';
out_buf[output_index++] = b ^ 0x20;
}if (b == '$' || b == '#' || b == '}' || b == '*') { ... } else {
if (output_index + 1 > out_maxlen)
break;
out_buf[output_index++] = b;
}else { ... }
}for (input_index = 0; input_index < len; input_index++) { ... }
*out_len = input_index;
return output_index;
}{ ... }
static int remote_unescape_input(const char *buffer, int len, char *out_buf, int out_maxlen)
{
int input_index, output_index;
int escaped;
output_index = 0;
escaped = 0;
for (input_index = 0; input_index < len; input_index++) {
char b = buffer[input_index];
if (output_index + 1 > out_maxlen)
LOG_ERROR("Received too much data from the target.");
if (escaped) {
out_buf[output_index++] = b ^ 0x20;
escaped = 0;
}if (escaped) { ... } else if (b == '}')
escaped = 1;
else
out_buf[output_index++] = b;
}for (input_index = 0; input_index < len; input_index++) { ... }
if (escaped)
LOG_ERROR("Unmatched escape character in target response.");
return output_index;
}{ ... }
static int icdi_send_packet(void *handle, int len)
{
unsigned char cksum = 0;
struct icdi_usb_handle *h = handle;
int result, retry = 0;
int transferred = 0;
assert(handle);
if (len + 3 > h->max_packet) {
LOG_ERROR("packet buffer too small");
return ERROR_FAIL;
}if (len + 3 > h->max_packet) { ... }
for (int i = 1; i < len; i++)
cksum += h->write_buffer[i];
len += sprintf(&h->write_buffer[len], PACKET_END "%02x", cksum);
#ifdef _DEBUG_USB_COMMS_
char buffer[50];
char ch = h->write_buffer[1];
if (ch == 'x' || ch == 'X')
LOG_DEBUG("writing packet: <binary>");
else {
memcpy(buffer, h->write_buffer, len >= 50 ? 50-1 : len);
buffer[len] = 0;
LOG_DEBUG("writing packet: %s", buffer);
}else { ... }
/* ... */#endif
while (1) {
result = libusb_bulk_transfer(h->usb_dev, ICDI_WRITE_ENDPOINT, (unsigned char *)h->write_buffer, len,
&transferred, ICDI_WRITE_TIMEOUT);
if (result != 0 || transferred != len) {
LOG_DEBUG("Error TX Data %d", result);
return ERROR_FAIL;
}if (result != 0 || transferred != len) { ... }
result = libusb_bulk_transfer(h->usb_dev, ICDI_READ_ENDPOINT, (unsigned char *)h->read_buffer, h->max_packet,
&transferred, ICDI_READ_TIMEOUT);
if (result != 0 || transferred < 1) {
LOG_DEBUG("Error RX Data %d", result);
return ERROR_FAIL;
}if (result != 0 || transferred < 1) { ... }
#ifdef _DEBUG_USB_COMMS_
LOG_DEBUG("received reply: '%c' : count %d", h->read_buffer[0], transferred);
#endif
if (h->read_buffer[0] == '-') {
LOG_DEBUG("Resending packet %d", ++retry);
}if (h->read_buffer[0] == '-') { ... } else {
if (h->read_buffer[0] != '+')
LOG_DEBUG("Unexpected Reply from ICDI: %c", h->read_buffer[0]);
break;
}else { ... }
if (retry == 3) {
LOG_DEBUG("maximum nack retries attempted");
return ERROR_FAIL;
}if (retry == 3) { ... }
}while (1) { ... }
retry = 0;
h->read_count = transferred;
while (1) {
result = libusb_bulk_transfer(h->usb_dev, ICDI_READ_ENDPOINT, (unsigned char *)h->read_buffer + h->read_count,
h->max_packet - h->read_count, &transferred, ICDI_READ_TIMEOUT);
#ifdef _DEBUG_USB_COMMS_
LOG_DEBUG("received data: count %d", transferred);
#endif
if (result != 0) {
if (result == LIBUSB_ERROR_TIMEOUT) {
LOG_DEBUG("Error RX timeout %d", result);
}if (result == LIBUSB_ERROR_TIMEOUT) { ... } else {
LOG_DEBUG("Error RX Data %d", result);
return ERROR_FAIL;
}else { ... }
}if (result != 0) { ... }
h->read_count += transferred;
if (h->read_count > 5) {
/* ... */
if (h->read_buffer[h->read_count - 3] == '#')
return ERROR_OK;
}if (h->read_count > 5) { ... }
if (retry++ == 3) {
LOG_DEBUG("maximum data retries attempted");
break;
}if (retry++ == 3) { ... }
}while (1) { ... }
return ERROR_FAIL;
}{ ... }
static int icdi_send_cmd(void *handle, const char *cmd)
{
struct icdi_usb_handle *h = handle;
int cmd_len = snprintf(h->write_buffer, h->max_packet, PACKET_START "%s", cmd);
return icdi_send_packet(handle, cmd_len);
}{ ... }
static int icdi_send_remote_cmd(void *handle, const char *data)
{
struct icdi_usb_handle *h = handle;
size_t cmd_len = sprintf(h->write_buffer, PACKET_START "qRcmd,");
cmd_len += hexify(h->write_buffer + cmd_len, (const uint8_t *)data,
strlen(data), h->max_packet - cmd_len);
return icdi_send_packet(handle, cmd_len);
}{ ... }
static int icdi_get_cmd_result(void *handle)
{
struct icdi_usb_handle *h = handle;
int offset = 0;
char ch;
assert(handle);
do {
ch = h->read_buffer[offset++];
if (offset > h->read_count)
return ERROR_FAIL;
...} while (ch != '$');
if (memcmp("OK", h->read_buffer + offset, 2) == 0)
return ERROR_OK;
if (h->read_buffer[offset] == 'E') {
uint8_t result;
if (unhexify(&result, h->read_buffer + offset + 1, 1) != 1)
return ERROR_FAIL;
return result;
}if (h->read_buffer[offset] == 'E') { ... }
return ERROR_OK;
}{ ... }
static int icdi_usb_idcode(void *handle, uint32_t *idcode TARGET_ARGUMENT)
{
*idcode = 0;
return ERROR_OK;
}{ ... }
static int icdi_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val TARGET_ARGUMENT)
{
uint8_t buf[4];
/* ... */
h_u32_to_le(buf, val);
return icdi_usb_write_mem(handle, addr, 4, 1, buf PASS_TARGET_ARGUMENT);
}{ ... }
static enum target_state icdi_usb_state(void *handle TARGET_ARGUMENT)
{
int result;
struct icdi_usb_handle *h = handle;
uint32_t dhcsr;
uint8_t buf[4];
result = icdi_usb_read_mem(h, DCB_DHCSR, 4, 1, buf PASS_TARGET_ARGUMENT);
if (result != ERROR_OK)
return TARGET_UNKNOWN;
/* ... */
dhcsr = le_to_h_u32(buf);
if (dhcsr & S_HALT)
return TARGET_HALTED;
return TARGET_RUNNING;
}{ ... }
static int icdi_usb_version(void *handle)
{
struct icdi_usb_handle *h = handle;
char version[20];
int result = icdi_send_remote_cmd(handle, "version");
if (result != ERROR_OK)
return result;
if (h->read_count < 8) {
LOG_ERROR("Invalid Reply Received");
return ERROR_FAIL;
}if (h->read_count < 8) { ... }
if (unhexify((uint8_t *)version, h->read_buffer + 2, 4) != 4) {
LOG_WARNING("unable to get ICDI version");
return ERROR_OK;
}if (unhexify((uint8_t *)version, h->read_buffer + 2, 4) != 4) { ... }
version[4] = 0;
LOG_INFO("ICDI Firmware version: %s", version);
return ERROR_OK;
}{ ... }
static int icdi_usb_query(void *handle)
{
int result;
struct icdi_usb_handle *h = handle;
result = icdi_send_cmd(handle, "qSupported");
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("query supported failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
char *offset = strstr(h->read_buffer, "PacketSize");
if (offset) {
char *separator;
int max_packet;
max_packet = strtol(offset + 11, &separator, 16);
if (!max_packet)
LOG_ERROR("invalid max packet, using defaults");
else
h->max_packet = max_packet;
LOG_DEBUG("max packet supported : %i bytes", h->max_packet);
}if (offset) { ... }
if (h->max_packet != ICDI_PACKET_SIZE) {
h->read_buffer = realloc(h->read_buffer, h->max_packet);
h->write_buffer = realloc(h->write_buffer, h->max_packet);
if (!h->read_buffer || !h->write_buffer) {
LOG_ERROR("unable to reallocate memory");
return ERROR_FAIL;
}if (!h->read_buffer || !h->write_buffer) { ... }
}if (h->max_packet != ICDI_PACKET_SIZE) { ... }
result = icdi_send_cmd(handle, "!");
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("unable to enable extended mode: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
return ERROR_OK;
}{ ... }
static int icdi_usb_reset(void *handle)
{
return ERROR_OK;
}{ ... }
static int icdi_usb_assert_srst(void *handle, int srst)
{
return ERROR_COMMAND_NOTFOUND;
}{ ... }
static int icdi_usb_run(void *handle TARGET_ARGUMENT)
{
int result;
result = icdi_send_cmd(handle, "c");
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("continue failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
return result;
}{ ... }
static int icdi_usb_halt(void *handle TARGET_ARGUMENT)
{
int result;
result = icdi_send_cmd(handle, "?");
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("halt failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
return result;
}{ ... }
static int icdi_usb_step(void *handle TARGET_ARGUMENT)
{
int result;
result = icdi_send_cmd(handle, "s");
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("step failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
return result;
}{ ... }
static int icdi_usb_read_regs(void *handle TARGET_ARGUMENT)
{
return ERROR_OK;
}{ ... }
static int icdi_usb_read_reg(void *handle, unsigned regsel, uint32_t *val TARGET_ARGUMENT)
{
int result;
struct icdi_usb_handle *h = handle;
char cmd[10];
snprintf(cmd, sizeof(cmd), "p%x", regsel);
result = icdi_send_cmd(handle, cmd);
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("register read failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
uint8_t buf[4];
if (unhexify(buf, h->read_buffer + 2, 4) != 4) {
LOG_ERROR("failed to convert result");
return ERROR_FAIL;
}if (unhexify(buf, h->read_buffer + 2, 4) != 4) { ... }
*val = le_to_h_u32(buf);
return result;
}{ ... }
static int icdi_usb_write_reg(void *handle, unsigned regsel, uint32_t val TARGET_ARGUMENT)
{
int result;
char cmd[20];
uint8_t buf[4];
h_u32_to_le(buf, val);
int cmd_len = snprintf(cmd, sizeof(cmd), "P%x=", regsel);
hexify(cmd + cmd_len, buf, 4, sizeof(cmd));
result = icdi_send_cmd(handle, cmd);
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("register write failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
return result;
}{ ... }
static int icdi_usb_read_mem_int(void *handle, uint32_t addr, uint32_t len, uint8_t *buffer)
{
int result;
struct icdi_usb_handle *h = handle;
char cmd[20];
snprintf(cmd, sizeof(cmd), "x%" PRIx32 ",%" PRIx32, addr, len);
result = icdi_send_cmd(handle, cmd);
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("memory read failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
int read_len = remote_unescape_input(h->read_buffer + 5, h->read_count - 8, (char *)buffer, len);
if (read_len != (int)len) {
LOG_ERROR("read more bytes than expected: actual 0x%x expected 0x%" PRIx32, read_len, len);
return ERROR_FAIL;
}if (read_len != (int)len) { ... }
return ERROR_OK;
}{ ... }
static int icdi_usb_write_mem_int(void *handle, uint32_t addr, uint32_t len, const uint8_t *buffer)
{
int result;
struct icdi_usb_handle *h = handle;
size_t cmd_len = snprintf(h->write_buffer, h->max_packet, PACKET_START "X%" PRIx32 ",%" PRIx32 ":", addr, len);
int out_len;
cmd_len += remote_escape_output((const char *)buffer, len, h->write_buffer + cmd_len,
&out_len, h->max_packet - cmd_len);
if (out_len < (int)len) {
LOG_ERROR("memory buffer too small: requires 0x%x actual 0x%" PRIx32, out_len, len);
return ERROR_FAIL;
}if (out_len < (int)len) { ... }
result = icdi_send_packet(handle, cmd_len);
if (result != ERROR_OK)
return result;
result = icdi_get_cmd_result(handle);
if (result != ERROR_OK) {
LOG_ERROR("memory write failed: 0x%x", result);
return ERROR_FAIL;
}if (result != ERROR_OK) { ... }
return ERROR_OK;
}{ ... }
static int icdi_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
uint32_t count, uint8_t *buffer TARGET_ARGUMENT)
{
int retval = ERROR_OK;
struct icdi_usb_handle *h = handle;
uint32_t bytes_remaining;
count *= size;
while (count) {
bytes_remaining = h->max_rw_packet;
if (count < bytes_remaining)
bytes_remaining = count;
retval = icdi_usb_read_mem_int(handle, addr, bytes_remaining, buffer);
if (retval != ERROR_OK)
return retval;
buffer += bytes_remaining;
addr += bytes_remaining;
count -= bytes_remaining;
}while (count) { ... }
return retval;
}{ ... }
static int icdi_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
uint32_t count, const uint8_t *buffer TARGET_ARGUMENT)
{
int retval = ERROR_OK;
struct icdi_usb_handle *h = handle;
uint32_t bytes_remaining;
count *= size;
while (count) {
bytes_remaining = h->max_rw_packet;
if (count < bytes_remaining)
bytes_remaining = count;
retval = icdi_usb_write_mem_int(handle, addr, bytes_remaining, buffer);
if (retval != ERROR_OK)
return retval;
buffer += bytes_remaining;
addr += bytes_remaining;
count -= bytes_remaining;
}while (count) { ... }
return retval;
}{ ... }
static int icdi_usb_override_target(const char *targetname)
{
return !strcmp(targetname, "cortex_m");
}{ ... }
static int icdi_usb_close(void *handle)
{
struct icdi_usb_handle *h = handle;
if (!h)
return ERROR_OK;
if (h->usb_dev)
jtag_libusb_close(h->usb_dev);
free(h->read_buffer);
free(h->write_buffer);
free(handle);
return ERROR_OK;
}{ ... }
static int icdi_usb_open(struct hl_interface_param *param, void **fd)
{
int retval;
struct icdi_usb_handle *h;
LOG_DEBUG("icdi_usb_open");
h = calloc(1, sizeof(struct icdi_usb_handle));
if (!h) {
LOG_ERROR("unable to allocate memory");
return ERROR_FAIL;
}if (!h) { ... }
for (uint8_t i = 0; param->vid[i] && param->pid[i]; ++i)
LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x serial: %s", param->transport,
param->vid[i], param->pid[i], adapter_get_required_serial() ? adapter_get_required_serial() : "");
/* ... */
jtag_libusb_open(param->vid, param->pid, NULL, &h->usb_dev, NULL);
if (!h->usb_dev) {
LOG_ERROR("open failed");
goto error_open;
}if (!h->usb_dev) { ... }
if (libusb_claim_interface(h->usb_dev, 2)) {
LOG_DEBUG("claim interface failed");
goto error_open;
}if (libusb_claim_interface(h->usb_dev, 2)) { ... }
retval = ERROR_OK;
switch (param->transport) {
#if 0
case HL_TRANSPORT_SWD:/* ... */
#endif
case HL_TRANSPORT_JTAG:
break;case HL_TRANSPORT_JTAG:
default:
retval = ERROR_FAIL;
break;default
}switch (param->transport) { ... }
if (retval != ERROR_OK) {
LOG_ERROR("mode (transport) not supported by device");
goto error_open;
}if (retval != ERROR_OK) { ... }
h->read_buffer = malloc(ICDI_PACKET_SIZE);
h->write_buffer = malloc(ICDI_PACKET_SIZE);
h->max_packet = ICDI_PACKET_SIZE;
if (!h->read_buffer || !h->write_buffer) {
LOG_DEBUG("malloc failed");
goto error_open;
}if (!h->read_buffer || !h->write_buffer) { ... }
retval = icdi_usb_version(h);
if (retval != ERROR_OK)
goto error_open;
retval = icdi_usb_query(h);
if (retval != ERROR_OK)
goto error_open;
*fd = h;
/* ... */
h->max_rw_packet = (((h->max_packet - 64) / 4) * 4) / 2;
return ERROR_OK;
error_open:
icdi_usb_close(h);
return ERROR_FAIL;
}{ ... }
struct hl_layout_api icdi_usb_layout_api = {
.open = icdi_usb_open,
.close = icdi_usb_close,
.idcode = icdi_usb_idcode,
.state = icdi_usb_state,
.reset = icdi_usb_reset,
.assert_srst = icdi_usb_assert_srst,
.run = icdi_usb_run,
.halt = icdi_usb_halt,
.step = icdi_usb_step,
.read_regs = icdi_usb_read_regs,
.read_reg = icdi_usb_read_reg,
.write_reg = icdi_usb_write_reg,
.read_mem = icdi_usb_read_mem,
.write_mem = icdi_usb_write_mem,
.write_debug_reg = icdi_usb_write_debug_reg,
.override_target = icdi_usb_override_target,
.custom_command = icdi_send_remote_cmd,
...};