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
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
/*
* This file is part of the libjaylink project.
*
* Copyright (C) 2014-2015 Marc Schink <jaylink-dev@marcschink.de>
*
* 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/>.
*/
#include <stdint.h>
#include <stdbool.h>
#include "libjaylink.h"
#include "libjaylink-internal.h"
/**
* @file
*
* JTAG functions.
*/
/** @cond PRIVATE */
#define CMD_JTAG_IO_V2 0xce
#define CMD_JTAG_IO_V3 0xcf
#define CMD_JTAG_CLEAR_TRST 0xde
#define CMD_JTAG_SET_TRST 0xdf
#define CMD_JTAG_CLEAR_TMS 0xc9
#define CMD_JTAG_SET_TMS 0xca
#define CMD_JTAG_CLEAR_TCK 0xda
#define CMD_JTAG_SET_TCK 0xdb
/**
* Error code indicating that there is not enough free memory on the device to
* perform the JTAG I/O operation.
*/
#define JTAG_IO_ERR_NO_MEMORY 0x06
/** @endcond */
/**
* Perform a JTAG I/O operation.
*
* @note This function must only be used if the #JAYLINK_TIF_JTAG interface is
* available and selected. Nevertheless, this function can be used if the
* device doesn't have the #JAYLINK_DEV_CAP_SELECT_TIF capability.
*
* @param[in,out] devh Device handle.
* @param[in] tms Buffer to read TMS data from.
* @param[in] tdi Buffer to read TDI data from.
* @param[out] tdo Buffer to store TDO data on success. Its content is
* undefined on failure. The buffer must be large enough to
* contain at least the specified number of bits to transfer.
* @param[in] length Number of bits to transfer.
* @param[in] version Version of the JTAG command to use.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR_DEV_NO_MEMORY Not enough memory on the device to perform
* the operation.
* @retval JAYLINK_ERR_DEV Unspecified device error.
* @retval JAYLINK_ERR Other error conditions.
*
* @see jaylink_select_interface()
* @see jaylink_set_speed()
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_jtag_io(struct jaylink_device_handle *devh,
const uint8_t *tms, const uint8_t *tdi, uint8_t *tdo,
uint16_t length, enum jaylink_jtag_version version)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[4];
uint16_t num_bytes;
uint16_t read_length;
uint8_t status;
uint8_t cmd;
if (!devh || !tms || !tdi || !tdo || !length)
return JAYLINK_ERR_ARG;
num_bytes = (length + 7) / 8;
read_length = num_bytes;
switch (version) {
case JAYLINK_JTAG_VERSION_2:
cmd = CMD_JTAG_IO_V2;
break;
case JAYLINK_JTAG_VERSION_3:
cmd = CMD_JTAG_IO_V3;
/* In this version, the response includes a status byte. */
read_length++;
break;
default:
return JAYLINK_ERR_ARG;
}
ctx = devh->dev->ctx;
ret = transport_start_write_read(devh, 4 + 2 * num_bytes,
read_length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = cmd;
buf[1] = 0x00;
buffer_set_u16(buf, length, 2);
ret = transport_write(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_write(devh, tms, num_bytes);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_write(devh, tdi, num_bytes);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, tdo, num_bytes);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
if (version == JAYLINK_JTAG_VERSION_2)
return JAYLINK_OK;
ret = transport_read(devh, &status, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
if (status == JTAG_IO_ERR_NO_MEMORY) {
return JAYLINK_ERR_DEV_NO_MEMORY;
} else if (status > 0) {
log_err(ctx, "JTAG I/O operation failed: 0x%x", status);
return JAYLINK_ERR_DEV;
}
return JAYLINK_OK;
}
/**
* Clear the JTAG test reset (TRST) signal.
*
* @param[in,out] devh Device handle.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_jtag_clear_trst(struct jaylink_device_handle *devh)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_JTAG_CLEAR_TRST;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Set the JTAG test reset (TRST) signal.
*
* @param[in,out] devh Device handle.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_jtag_set_trst(struct jaylink_device_handle *devh)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_JTAG_SET_TRST;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Clear the JTAG test mode select (TMS) signal.
*
* @param[in,out] devh Device handle.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.3.0
*/
JAYLINK_API int jaylink_jtag_clear_tms(struct jaylink_device_handle *devh)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_JTAG_CLEAR_TMS;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Set the JTAG test mode select (TMS) signal.
*
* @param[in,out] devh Device handle.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.3.0
*/
JAYLINK_API int jaylink_jtag_set_tms(struct jaylink_device_handle *devh)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_JTAG_SET_TMS;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Clear the JTAG test clock (TCK) signal.
*
* @param[in,out] devh Device handle.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.3.0
*/
JAYLINK_API int jaylink_jtag_clear_tck(struct jaylink_device_handle *devh)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_JTAG_CLEAR_TCK;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
/**
* Set the JTAG test clock (TCK) signal.
*
* @param[in,out] devh Device handle.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.3.0
*/
JAYLINK_API int jaylink_jtag_set_tck(struct jaylink_device_handle *devh)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[1];
if (!devh)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 1, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_JTAG_SET_TCK;
ret = transport_write(devh, buf, 1);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
return JAYLINK_OK;
}
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...