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
|
/* SPDX-License-Identifier: GPL-2.0
*
* Copyright (c) 2019 Google, LLC.
* Author: Moritz Fischer <moritzf@google.com>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <stdint.h>
#include <stdlib.h>
#include <math.h>
#include <unistd.h>
#include <linux/pci.h>
#include <jtag/interface.h>
#include <jtag/swd.h>
#include <jtag/commands.h>
#include <helper/replacements.h>
#include <helper/bits.h>
/* Available only from kernel v4.10 */
#ifndef PCI_CFG_SPACE_EXP_SIZE
#define PCI_CFG_SPACE_EXP_SIZE 4096
#endif
#define PCIE_EXT_CAP_LST 0x100
#define XLNX_XVC_EXT_CAP 0x00
#define XLNX_XVC_VSEC_HDR 0x04
#define XLNX_XVC_LEN_REG 0x0C
#define XLNX_XVC_TMS_REG 0x10
#define XLNX_XVC_TDx_REG 0x14
#define XLNX_XVC_CAP_SIZE 0x20
#define XLNX_XVC_VSEC_ID 0x8
#define XLNX_XVC_MAX_BITS 0x20
struct xlnx_pcie_xvc {
int fd;
unsigned offset;
char *device;
};
static struct xlnx_pcie_xvc xlnx_pcie_xvc_state;
static struct xlnx_pcie_xvc *xlnx_pcie_xvc = &xlnx_pcie_xvc_state;
static int xlnx_pcie_xvc_read_reg(const int offset, uint32_t *val)
{
uint32_t res;
int err;
/* Note: This should be ok endianess-wise because by going
* through sysfs the kernel does the conversion in the config
* space accessor functions
*/
err = pread(xlnx_pcie_xvc->fd, &res, sizeof(res),
xlnx_pcie_xvc->offset + offset);
if (err != sizeof(res)) {
LOG_ERROR("Failed to read offset %x", offset);
return ERROR_JTAG_DEVICE_ERROR;
}
if (val)
*val = res;
return ERROR_OK;
}
static int xlnx_pcie_xvc_write_reg(const int offset, const uint32_t val)
{
int err;
/* Note: This should be ok endianess-wise because by going
* through sysfs the kernel does the conversion in the config
* space accessor functions
*/
err = pwrite(xlnx_pcie_xvc->fd, &val, sizeof(val),
xlnx_pcie_xvc->offset + offset);
if (err != sizeof(val)) {
LOG_ERROR("Failed to write offset: %x with value: %x",
offset, val);
return ERROR_JTAG_DEVICE_ERROR;
}
return ERROR_OK;
}
static int xlnx_pcie_xvc_transact(size_t num_bits, uint32_t tms, uint32_t tdi,
uint32_t *tdo)
{
int err;
err = xlnx_pcie_xvc_write_reg(XLNX_XVC_LEN_REG, num_bits);
if (err != ERROR_OK)
return err;
err = xlnx_pcie_xvc_write_reg(XLNX_XVC_TMS_REG, tms);
if (err != ERROR_OK)
return err;
err = xlnx_pcie_xvc_write_reg(XLNX_XVC_TDx_REG, tdi);
if (err != ERROR_OK)
return err;
err = xlnx_pcie_xvc_read_reg(XLNX_XVC_TDx_REG, tdo);
if (err != ERROR_OK)
return err;
if (tdo)
LOG_DEBUG_IO("Transact num_bits: %zu, tms: %x, tdi: %x, tdo: %x",
num_bits, tms, tdi, *tdo);
else
LOG_DEBUG_IO("Transact num_bits: %zu, tms: %x, tdi: %x, tdo: <null>",
num_bits, tms, tdi);
return ERROR_OK;
}
int xlnx_pcie_xvc_execute_stableclocks(struct jtag_command *cmd)
{
int tms = tap_get_state() == TAP_RESET ? 1 : 0;
size_t left = cmd->cmd.stableclocks->num_cycles;
size_t write;
int err;
LOG_DEBUG("stableclocks %i cycles", cmd->cmd.runtest->num_cycles);
while (left) {
write = MIN(XLNX_XVC_MAX_BITS, left);
err = xlnx_pcie_xvc_transact(write, tms, 0, NULL);
if (err != ERROR_OK)
return err;
left -= write;
};
return ERROR_OK;
}
static int xlnx_pcie_xvc_execute_statemove(size_t skip)
{
uint8_t tms_scan = tap_get_tms_path(tap_get_state(),
tap_get_end_state());
int tms_count = tap_get_tms_path_len(tap_get_state(),
tap_get_end_state());
int err;
LOG_DEBUG("statemove starting at (skip: %zu) %s end in %s", skip,
tap_state_name(tap_get_state()),
tap_state_name(tap_get_end_state()));
err = xlnx_pcie_xvc_transact(tms_count - skip, tms_scan >> skip, 0, NULL);
if (err != ERROR_OK)
return err;
tap_set_state(tap_get_end_state());
return ERROR_OK;
}
static int xlnx_pcie_xvc_execute_runtest(struct jtag_command *cmd)
{
int err = ERROR_OK;
LOG_DEBUG("runtest %i cycles, end in %i",
cmd->cmd.runtest->num_cycles,
cmd->cmd.runtest->end_state);
tap_state_t tmp_state = tap_get_end_state();
if (tap_get_state() != TAP_IDLE) {
tap_set_end_state(TAP_IDLE);
err = xlnx_pcie_xvc_execute_statemove(0);
if (err != ERROR_OK)
return err;
};
size_t left = cmd->cmd.runtest->num_cycles;
size_t write;
while (left) {
write = MIN(XLNX_XVC_MAX_BITS, left);
err = xlnx_pcie_xvc_transact(write, 0, 0, NULL);
if (err != ERROR_OK)
return err;
left -= write;
};
tap_set_end_state(tmp_state);
if (tap_get_state() != tap_get_end_state())
err = xlnx_pcie_xvc_execute_statemove(0);
return err;
}
static int xlnx_pcie_xvc_execute_pathmove(struct jtag_command *cmd)
{
size_t num_states = cmd->cmd.pathmove->num_states;
tap_state_t *path = cmd->cmd.pathmove->path;
int err = ERROR_OK;
size_t i;
LOG_DEBUG("pathmove: %i states, end in %i",
cmd->cmd.pathmove->num_states,
cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
for (i = 0; i < num_states; i++) {
if (path[i] == tap_state_transition(tap_get_state(), false)) {
err = xlnx_pcie_xvc_transact(1, 1, 0, NULL);
} else if (path[i] == tap_state_transition(tap_get_state(), true)) {
err = xlnx_pcie_xvc_transact(1, 0, 0, NULL);
} else {
LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.",
tap_state_name(tap_get_state()),
tap_state_name(path[i]));
err = ERROR_JTAG_QUEUE_FAILED;
}
if (err != ERROR_OK)
return err;
tap_set_state(path[i]);
}
tap_set_end_state(tap_get_state());
return ERROR_OK;
}
static int xlnx_pcie_xvc_execute_scan(struct jtag_command *cmd)
{
enum scan_type type = jtag_scan_type(cmd->cmd.scan);
tap_state_t saved_end_state = cmd->cmd.scan->end_state;
bool ir_scan = cmd->cmd.scan->ir_scan;
uint32_t tdi, tms, tdo;
uint8_t *buf, *rd_ptr;
int err, scan_size;
size_t write;
size_t left;
scan_size = jtag_build_buffer(cmd->cmd.scan, &buf);
rd_ptr = buf;
LOG_DEBUG("%s scan type %d %d bits; starts in %s end in %s",
(cmd->cmd.scan->ir_scan) ? "IR" : "DR", type, scan_size,
tap_state_name(tap_get_state()),
tap_state_name(cmd->cmd.scan->end_state));
/* If we're in TAP_DR_SHIFT state but need to do a IR_SCAN or
* vice-versa, do a statemove to corresponding other state, then restore
* end state
*/
if (ir_scan && tap_get_state() != TAP_IRSHIFT) {
tap_set_end_state(TAP_IRSHIFT);
err = xlnx_pcie_xvc_execute_statemove(0);
if (err != ERROR_OK)
goto out_err;
tap_set_end_state(saved_end_state);
} else if (!ir_scan && (tap_get_state() != TAP_DRSHIFT)) {
tap_set_end_state(TAP_DRSHIFT);
err = xlnx_pcie_xvc_execute_statemove(0);
if (err != ERROR_OK)
goto out_err;
tap_set_end_state(saved_end_state);
}
left = scan_size;
while (left) {
write = MIN(XLNX_XVC_MAX_BITS, left);
/* the last TMS should be a 1, to leave the state */
tms = left <= XLNX_XVC_MAX_BITS ? BIT(write - 1) : 0;
tdi = (type != SCAN_IN) ? buf_get_u32(rd_ptr, 0, write) : 0;
err = xlnx_pcie_xvc_transact(write, tms, tdi, type != SCAN_OUT ?
&tdo : NULL);
if (err != ERROR_OK)
goto out_err;
left -= write;
if (type != SCAN_OUT)
buf_set_u32(rd_ptr, 0, write, tdo);
rd_ptr += sizeof(uint32_t);
};
err = jtag_read_buffer(buf, cmd->cmd.scan);
if (buf)
free(buf);
if (tap_get_state() != tap_get_end_state())
err = xlnx_pcie_xvc_execute_statemove(1);
return err;
out_err:
if (buf)
free(buf);
return err;
}
static void xlnx_pcie_xvc_execute_reset(struct jtag_command *cmd)
{
LOG_DEBUG("reset trst: %i srst: %i", cmd->cmd.reset->trst,
cmd->cmd.reset->srst);
}
static void xlnx_pcie_xvc_execute_sleep(struct jtag_command *cmd)
{
LOG_DEBUG("sleep %" PRIi32 "", cmd->cmd.sleep->us);
usleep(cmd->cmd.sleep->us);
}
static int xlnx_pcie_xvc_execute_tms(struct jtag_command *cmd)
{
const size_t num_bits = cmd->cmd.tms->num_bits;
const uint8_t *bits = cmd->cmd.tms->bits;
size_t left, write;
uint32_t tms;
int err;
LOG_DEBUG("execute tms %zu", num_bits);
left = num_bits;
while (left) {
write = MIN(XLNX_XVC_MAX_BITS, left);
tms = buf_get_u32(bits, 0, write);
err = xlnx_pcie_xvc_transact(write, tms, 0, NULL);
if (err != ERROR_OK)
return err;
left -= write;
bits += 4;
};
return ERROR_OK;
}
static int xlnx_pcie_xvc_execute_command(struct jtag_command *cmd)
{
LOG_DEBUG("%s: cmd->type: %u", __func__, cmd->type);
switch (cmd->type) {
case JTAG_STABLECLOCKS:
return xlnx_pcie_xvc_execute_stableclocks(cmd);
case JTAG_RUNTEST:
return xlnx_pcie_xvc_execute_runtest(cmd);
case JTAG_TLR_RESET:
tap_set_end_state(cmd->cmd.statemove->end_state);
return xlnx_pcie_xvc_execute_statemove(0);
case JTAG_PATHMOVE:
return xlnx_pcie_xvc_execute_pathmove(cmd);
case JTAG_SCAN:
return xlnx_pcie_xvc_execute_scan(cmd);
case JTAG_RESET:
xlnx_pcie_xvc_execute_reset(cmd);
break;
case JTAG_SLEEP:
xlnx_pcie_xvc_execute_sleep(cmd);
break;
case JTAG_TMS:
return xlnx_pcie_xvc_execute_tms(cmd);
default:
LOG_ERROR("BUG: Unknown JTAG command type encountered.");
return ERROR_JTAG_QUEUE_FAILED;
}
return ERROR_OK;
}
static int xlnx_pcie_xvc_execute_queue(void)
{
struct jtag_command *cmd = jtag_command_queue;
int ret;
while (cmd) {
ret = xlnx_pcie_xvc_execute_command(cmd);
if (ret != ERROR_OK)
return ret;
cmd = cmd->next;
}
return ERROR_OK;
}
static int xlnx_pcie_xvc_init(void)
{
char filename[PATH_MAX];
uint32_t cap, vh;
int err;
snprintf(filename, PATH_MAX, "/sys/bus/pci/devices/%s/config",
xlnx_pcie_xvc->device);
xlnx_pcie_xvc->fd = open(filename, O_RDWR | O_SYNC);
if (xlnx_pcie_xvc->fd < 0) {
LOG_ERROR("Failed to open device: %s", filename);
return ERROR_JTAG_INIT_FAILED;
}
LOG_INFO("Scanning PCIe device %s's for Xilinx XVC/PCIe ...",
xlnx_pcie_xvc->device);
/* Parse the PCIe extended capability list and try to find
* vendor specific header */
xlnx_pcie_xvc->offset = PCIE_EXT_CAP_LST;
while (xlnx_pcie_xvc->offset <= PCI_CFG_SPACE_EXP_SIZE - sizeof(cap) &&
xlnx_pcie_xvc->offset >= PCIE_EXT_CAP_LST) {
err = xlnx_pcie_xvc_read_reg(XLNX_XVC_EXT_CAP, &cap);
if (err != ERROR_OK)
return err;
LOG_DEBUG("Checking capability at 0x%x; id=0x%04x version=0x%x next=0x%x",
xlnx_pcie_xvc->offset,
PCI_EXT_CAP_ID(cap),
PCI_EXT_CAP_VER(cap),
PCI_EXT_CAP_NEXT(cap));
if (PCI_EXT_CAP_ID(cap) == PCI_EXT_CAP_ID_VNDR) {
err = xlnx_pcie_xvc_read_reg(XLNX_XVC_VSEC_HDR, &vh);
if (err != ERROR_OK)
return err;
LOG_DEBUG("Checking possible match at 0x%x; id: 0x%x; rev: 0x%x; length: 0x%x",
xlnx_pcie_xvc->offset,
PCI_VNDR_HEADER_ID(vh),
PCI_VNDR_HEADER_REV(vh),
PCI_VNDR_HEADER_LEN(vh));
if ((PCI_VNDR_HEADER_ID(vh) == XLNX_XVC_VSEC_ID) &&
(PCI_VNDR_HEADER_LEN(vh) == XLNX_XVC_CAP_SIZE))
break;
}
xlnx_pcie_xvc->offset = PCI_EXT_CAP_NEXT(cap);
}
if ((xlnx_pcie_xvc->offset > PCI_CFG_SPACE_EXP_SIZE - XLNX_XVC_CAP_SIZE) ||
xlnx_pcie_xvc->offset < PCIE_EXT_CAP_LST) {
close(xlnx_pcie_xvc->fd);
return ERROR_JTAG_INIT_FAILED;
}
LOG_INFO("Found Xilinx XVC/PCIe capability at offset: 0x%x", xlnx_pcie_xvc->offset);
return ERROR_OK;
}
static int xlnx_pcie_xvc_quit(void)
{
int err;
err = close(xlnx_pcie_xvc->fd);
if (err)
return err;
return ERROR_OK;
}
COMMAND_HANDLER(xlnx_pcie_xvc_handle_config_command)
{
if (CMD_ARGC < 1)
return ERROR_COMMAND_SYNTAX_ERROR;
/* we can't really free this in a safe manner, so at least
* limit the memory we're leaking by freeing the old one first
* before allocating a new one ...
*/
if (xlnx_pcie_xvc->device)
free(xlnx_pcie_xvc->device);
xlnx_pcie_xvc->device = strdup(CMD_ARGV[0]);
return ERROR_OK;
}
static const struct command_registration xlnx_pcie_xvc_command_handlers[] = {
{
.name = "xlnx_pcie_xvc_config",
.handler = xlnx_pcie_xvc_handle_config_command,
.mode = COMMAND_CONFIG,
.help = "Configure XVC/PCIe JTAG adapter",
.usage = "device",
},
COMMAND_REGISTRATION_DONE
};
static struct jtag_interface xlnx_pcie_xvc_interface = {
.execute_queue = &xlnx_pcie_xvc_execute_queue,
};
struct adapter_driver xlnx_pcie_xvc_adapter_driver = {
.name = "xlnx_pcie_xvc",
.transports = jtag_only,
.commands = xlnx_pcie_xvc_command_handlers,
.init = &xlnx_pcie_xvc_init,
.quit = &xlnx_pcie_xvc_quit,
.jtag_ops = &xlnx_pcie_xvc_interface,
};
|