Outline ![]()
Files ![]()
loading...
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
// SPDX-License-Identifier: GPL-2.0-or-later
/***************************************************************************
* Copyright (C) 2018 by Mickaël Thomas *
* mickael9@gmail.com *
* *
* Copyright (C) 2016 by Maksym Hilliaka *
* oter@frozen-team.com *
* *
* Copyright (C) 2016 by Phillip Pearson *
* pp@myelin.co.nz *
* *
* Copyright (C) 2014 by Paul Fertser *
* fercerpav@gmail.com *
* *
* Copyright (C) 2013 by mike brown *
* mike@theshedworks.org.uk *
* *
* Copyright (C) 2013 by Spencer Oliver *
* spen@spen-soft.co.uk *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include <hidapi.h>
#include <helper/log.h>
#include "cmsis_dap.h"
struct cmsis_dap_backend_data {
hid_device *dev_handle;
};
struct cmsis_dap_report_size {
unsigned short vid;
unsigned short pid;
unsigned int report_size;
};
static const struct cmsis_dap_report_size report_size_quirks[] = {
/* Third gen Atmel tools use a report size of 512 */
/* This list of PIDs comes from toolinfo.py in Microchip's pyedbglib. */
// Atmel JTAG-ICE 3
{ .vid = 0x03eb, .pid = 0x2140, .report_size = 512 },
// Atmel-ICE
{ .vid = 0x03eb, .pid = 0x2141, .report_size = 512 },
// Atmel Power Debugger
{ .vid = 0x03eb, .pid = 0x2144, .report_size = 512 },
// EDBG (found on Xplained Pro boards)
{ .vid = 0x03eb, .pid = 0x2111, .report_size = 512 },
// Zero (???)
{ .vid = 0x03eb, .pid = 0x2157, .report_size = 512 },
// EDBG with Mass Storage (found on Xplained Pro boards)
{ .vid = 0x03eb, .pid = 0x2169, .report_size = 512 },
// Commercially available EDBG (for third-party use)
{ .vid = 0x03eb, .pid = 0x216a, .report_size = 512 },
// Kraken (???)
{ .vid = 0x03eb, .pid = 0x2170, .report_size = 512 },
{ .vid = 0, .pid = 0, .report_size = 0 }
};
static void cmsis_dap_hid_close(struct cmsis_dap *dap);
static int cmsis_dap_hid_alloc(struct cmsis_dap *dap, unsigned int pkt_sz);
static void cmsis_dap_hid_free(struct cmsis_dap *dap);
static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t pids[], const char *serial)
{
hid_device *dev = NULL;
int i;
struct hid_device_info *devs, *cur_dev;
unsigned short target_vid, target_pid;
target_vid = 0;
target_pid = 0;
if (hid_init() != 0) {
LOG_ERROR("unable to open HIDAPI");
return ERROR_FAIL;
}
/*
* The CMSIS-DAP specification stipulates:
* "The Product String must contain "CMSIS-DAP" somewhere in the string. This is used by the
* debuggers to identify a CMSIS-DAP compliant Debug Unit that is connected to a host computer."
*/
devs = hid_enumerate(0x0, 0x0);
cur_dev = devs;
while (cur_dev) {
bool found = false;
if (vids[0] == 0) {
if (!cur_dev->product_string) {
LOG_DEBUG("Cannot read product string of device 0x%x:0x%x",
cur_dev->vendor_id, cur_dev->product_id);
} else if (wcsstr(cur_dev->product_string, L"CMSIS-DAP")) {
/* if the user hasn't specified VID:PID *and*
* product string contains "CMSIS-DAP", pick it
*/
found = true;
}
} else {
/* otherwise, exhaustively compare against all VID:PID in list */
for (i = 0; vids[i] || pids[i]; i++) {
if ((vids[i] == cur_dev->vendor_id) && (pids[i] == cur_dev->product_id))
found = true;
}
}
/* LPC-LINK2 has cmsis-dap on interface 0 and other HID functions on other interfaces */
if (cur_dev->vendor_id == 0x1fc9 && cur_dev->product_id == 0x0090 && cur_dev->interface_number != 0)
found = false;
if (found) {
/* check serial number matches if given */
if (!serial)
break;
if (cur_dev->serial_number) {
size_t len = mbstowcs(NULL, serial, 0) + 1;
wchar_t *wserial = malloc(len * sizeof(wchar_t));
if (!wserial) {
LOG_ERROR("unable to allocate serial number buffer");
return ERROR_FAIL;
}
mbstowcs(wserial, serial, len);
if (wcscmp(wserial, cur_dev->serial_number) == 0) {
free(wserial);
break;
} else {
free(wserial);
wserial = NULL;
}
}
}
cur_dev = cur_dev->next;
}
if (cur_dev) {
target_vid = cur_dev->vendor_id;
target_pid = cur_dev->product_id;
}
if (target_vid == 0 && target_pid == 0) {
hid_free_enumeration(devs);
return ERROR_FAIL;
}
dap->bdata = malloc(sizeof(struct cmsis_dap_backend_data));
if (!dap->bdata) {
LOG_ERROR("unable to allocate memory");
return ERROR_FAIL;
}
dev = hid_open_path(cur_dev->path);
hid_free_enumeration(devs);
if (!dev) {
LOG_ERROR("unable to open CMSIS-DAP device 0x%x:0x%x", target_vid, target_pid);
return ERROR_FAIL;
}
/* allocate default packet buffer, may be changed later.
* currently with HIDAPI we have no way of getting the output report length
* without this info we cannot communicate with the adapter.
* For the moment we have to hard code the packet size */
unsigned int packet_size = 64;
/* Check for adapters that are known to have unusual report lengths. */
for (i = 0; report_size_quirks[i].vid != 0; i++) {
if (report_size_quirks[i].vid == target_vid &&
report_size_quirks[i].pid == target_pid) {
packet_size = report_size_quirks[i].report_size;
}
}
/* TODO: HID report descriptor should be parsed instead of
* hardcoding a match by VID/PID */
dap->bdata->dev_handle = dev;
int retval = cmsis_dap_hid_alloc(dap, packet_size);
if (retval != ERROR_OK) {
cmsis_dap_hid_close(dap);
return ERROR_FAIL;
}
dap->command = dap->packet_buffer + REPORT_ID_SIZE;
dap->response = dap->packet_buffer;
return ERROR_OK;
}
static void cmsis_dap_hid_close(struct cmsis_dap *dap)
{
hid_close(dap->bdata->dev_handle);
hid_exit();
free(dap->bdata);
dap->bdata = NULL;
cmsis_dap_hid_free(dap);
}
static int cmsis_dap_hid_read(struct cmsis_dap *dap, int transfer_timeout_ms,
struct timeval *wait_timeout)
{
int timeout_ms;
if (wait_timeout)
timeout_ms = wait_timeout->tv_usec / 1000 + wait_timeout->tv_sec * 1000;
else
timeout_ms = transfer_timeout_ms;
int retval = hid_read_timeout(dap->bdata->dev_handle,
dap->packet_buffer, dap->packet_buffer_size,
timeout_ms);
if (retval == 0) {
return ERROR_TIMEOUT_REACHED;
} else if (retval == -1) {
LOG_ERROR("error reading data: %ls", hid_error(dap->bdata->dev_handle));
return ERROR_FAIL;
}
return retval;
}
static int cmsis_dap_hid_write(struct cmsis_dap *dap, int txlen, int timeout_ms)
{
(void) timeout_ms;
dap->packet_buffer[0] = 0; /* HID report number */
/* Pad the rest of the TX buffer with 0's */
memset(dap->command + txlen, 0, dap->packet_size - txlen);
/* write data to device */
int retval = hid_write(dap->bdata->dev_handle, dap->packet_buffer, dap->packet_buffer_size);
if (retval == -1) {
LOG_ERROR("error writing data: %ls", hid_error(dap->bdata->dev_handle));
return ERROR_FAIL;
}
return retval;
}
static int cmsis_dap_hid_alloc(struct cmsis_dap *dap, unsigned int pkt_sz)
{
unsigned int packet_buffer_size = pkt_sz + REPORT_ID_SIZE;
uint8_t *buf = malloc(packet_buffer_size);
if (!buf) {
LOG_ERROR("unable to allocate CMSIS-DAP packet buffer");
return ERROR_FAIL;
}
dap->packet_buffer = buf;
dap->packet_size = pkt_sz;
dap->packet_usable_size = pkt_sz;
dap->packet_buffer_size = packet_buffer_size;
dap->command = dap->packet_buffer + REPORT_ID_SIZE;
dap->response = dap->packet_buffer;
return ERROR_OK;
}
static void cmsis_dap_hid_free(struct cmsis_dap *dap)
{
free(dap->packet_buffer);
dap->packet_buffer = NULL;
}
static void cmsis_dap_hid_cancel_all(struct cmsis_dap *dap)
{
}
const struct cmsis_dap_backend cmsis_dap_hid_backend = {
.name = "hid",
.open = cmsis_dap_hid_open,
.close = cmsis_dap_hid_close,
.read = cmsis_dap_hid_read,
.write = cmsis_dap_hid_write,
.packet_buffer_alloc = cmsis_dap_hid_alloc,
.packet_buffer_free = cmsis_dap_hid_free,
.cancel_all = cmsis_dap_hid_cancel_all,
};
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
Click anywhere in the source to view detailed information here...