xsvf.c 25.4 KB
Newer Older
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
/*
 * Copyright (C) 2005 by Dominic Rath
 * Dominic.Rath@gmx.de
 *
 * Copyright (C) 2007,2008 Øyvind Harboe
 * oyvind.harboe@zylin.com
 *
 * Copyright (C) 2008 Peter Hettkamp
 * peter.hettkamp@htp-tel.de
 *
 * Copyright (C) 2009 SoftPLC Corporation. http://softplc.com
 * Dick Hollenbeck <dick@softplc.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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
28
29
30
31
32
33
34
35
36
37
38


/* The specification for SVF is available here:
 * http://www.asset-intertech.com/support/svf.pdf
 * Below, this document is refered to as the "SVF spec".
 *
 * The specification for XSVF is available here:
 * http://www.xilinx.com/support/documentation/application_notes/xapp503.pdf
 * Below, this document is refered to as the "XSVF spec".
 */

39
40
41
42
43
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "xsvf.h"
44
#include <jtag/jtag.h>
45
#include <svf/svf.h>
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
/* XSVF commands, from appendix B of xapp503.pdf  */
#define XCOMPLETE		0x00
#define XTDOMASK			0x01
#define XSIR				0x02
#define XSDR				0x03
#define XRUNTEST			0x04
#define XREPEAT			0x07
#define XSDRSIZE			0x08
#define XSDRTDO			0x09
#define XSETSDRMASKS		0x0A
#define XSDRINC			0x0B
#define XSDRB			0x0C
#define XSDRC			0x0D
#define XSDRE			0x0E
#define XSDRTDOB			0x0F
#define XSDRTDOC			0x10
#define XSDRTDOE			0x11
#define XSTATE			0x12
#define XENDIR			0x13
#define XENDDR			0x14
#define XSIR2			0x15
#define XCOMMENT			0x16
#define XWAIT			0x17
71

72
73
74
75
76
77
/* XWAITSTATE is not in the xilinx XSVF spec, but the svf2xsvf.py translator
 * generates this.  Arguably it is needed because the XSVF XRUNTEST command
 * was ill conceived and does not directly flow out of the SVF RUNTEST command.
 * This XWAITSTATE does map directly from the SVF RUNTEST command.
 */
#define XWAITSTATE		0x18
78

79
80
81
/* Lattice has extended the SVF file format, and Dick Hollenbeck's python based
 * SVF2XSVF converter supports these 3 additional XSVF opcodes, LCOUNT, LDELAY, LSDR.
 * Here is an example of usage of the 3 lattice opcode extensions:
82

83
84
! Set the maximum loop count to 25.
LCOUNT	25;
zwelch's avatar
zwelch committed
85
! Step to DRPAUSE give 5 clocks and wait for 1.00e + 000 SEC.
86
87
88
LDELAY	DRPAUSE	5 TCK	1.00E-003 SEC;
! Test for the completed status. Match means pass.
! Loop back to LDELAY line if not match and loop count less than 25.
89

90
91
92
LSDR 1  TDI  (0)
		TDO  (1);
*/
93

94
95
96
#define LCOUNT			0x19
#define LDELAY			0x1A
#define LSDR				0x1B
97
#define XTRST			0x1C
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117


/* XSVF valid state values for the XSTATE command, from appendix B of xapp503.pdf */
#define XSV_RESET		0x00
#define XSV_IDLE			0x01
#define XSV_DRSELECT		0x02
#define XSV_DRCAPTURE	0x03
#define XSV_DRSHIFT		0x04
#define XSV_DREXIT1		0x05
#define XSV_DRPAUSE		0x06
#define XSV_DREXIT2		0x07
#define XSV_DRUPDATE		0x08
#define XSV_IRSELECT		0x09
#define XSV_IRCAPTURE	0x0A
#define XSV_IRSHIFT		0x0B
#define XSV_IREXIT1		0x0C
#define XSV_IRPAUSE		0x0D
#define XSV_IREXIT2		0x0E
#define XSV_IRUPDATE		0x0F

118
119
120
121
122
/* arguments to XTRST */
#define XTRST_ON			0
#define XTRST_OFF		1
#define XTRST_Z			2
#define XTRST_ABSENT		3
123
124

#define XSTATE_MAX_PATH 12
125

126
127
128
129

static int xsvf_fd = 0;


130
/* map xsvf tap state to an openocd "tap_state_t" */
131
static tap_state_t xsvf_to_tap(int xsvf_state)
132
{
133
134
	tap_state_t	ret;

135
	switch (xsvf_state)
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
	{
	case XSV_RESET:			ret = TAP_RESET;			break;
	case XSV_IDLE:			ret = TAP_IDLE;			break;
	case XSV_DRSELECT:		ret = TAP_DRSELECT;		break;
	case XSV_DRCAPTURE:		ret = TAP_DRCAPTURE;		break;
	case XSV_DRSHIFT:		ret = TAP_DRSHIFT;		break;
	case XSV_DREXIT1:		ret = TAP_DREXIT1;		break;
	case XSV_DRPAUSE:		ret = TAP_DRPAUSE;		break;
	case XSV_DREXIT2:		ret = TAP_DREXIT2;		break;
	case XSV_DRUPDATE:		ret = TAP_DRUPDATE;		break;
	case XSV_IRSELECT:		ret = TAP_IRSELECT;		break;
	case XSV_IRCAPTURE:		ret = TAP_IRCAPTURE;		break;
	case XSV_IRSHIFT:		ret = TAP_IRSHIFT;		break;
	case XSV_IREXIT1:		ret = TAP_IREXIT1;		break;
	case XSV_IRPAUSE:		ret = TAP_IRPAUSE;		break;
	case XSV_IREXIT2:		ret = TAP_IREXIT2;		break;
	case XSV_IRUPDATE:		ret = TAP_IRUPDATE;		break;
	default:
154
		LOG_ERROR("UNKNOWN XSVF STATE 0x%02X", xsvf_state);
155
156
157
158
159
		exit(1);
	}

	return ret;
}
160

161

162

zwelch's avatar
zwelch committed
163
static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf)
164
165
166
167
168
{
	int num_bytes;

	for (num_bytes = (num_bits + 7) / 8; num_bytes > 0; num_bytes--)
	{
169
		/* reverse the order of bytes as they are read sequentially from file */
170
171
172
173
174
175
176
		if (read(fd, buf + num_bytes - 1, 1) < 0)
			return ERROR_XSVF_EOF;
	}

	return ERROR_OK;
}

177

178
COMMAND_HANDLER(handle_xsvf_command)
179
{
180
	uint8_t *dr_out_buf = NULL;				/* from host to device (TDI) */
zwelch's avatar
zwelch committed
181
182
	uint8_t *dr_in_buf = NULL;				/* from device to host (TDO) */
	uint8_t *dr_in_mask = NULL;
183

184
185
186
187
188
189
190
	int xsdrsize = 0;
	int xruntest = 0;					/* number of TCK cycles OR microseconds */
	int xrepeat	 = 0;					/* number of retries */

	tap_state_t	xendir = TAP_IDLE;		/* see page 8 of the SVF spec, initial xendir to be TAP_IDLE */
	tap_state_t xenddr = TAP_IDLE;

191
	uint8_t		opcode;
Spencer Oliver's avatar
Spencer Oliver committed
192
	uint8_t		uc = 0;
193
194
195
196
197
198
199
	long		file_offset = 0;

	int		loop_count = 0;
	tap_state_t	loop_state = TAP_IDLE;
	int		loop_clocks = 0;
	int		loop_usecs = 0;

200
201
202
203
	int		do_abort = 0;
	int		unsupported = 0;
	int		tdo_mismatch = 0;
	int		result;
204
	int		verbose = 1;
205

206
207
208
209
210
211
212
213
	bool		collecting_path = false;
	tap_state_t	path[XSTATE_MAX_PATH];
	unsigned	pathlen = 0;

	/* a flag telling whether to clock TCK during waits,
	 * or simply sleep, controled by virt2
	 */
	int		runtest_requires_tck = 0;
214
215


216
217
	/* use NULL to indicate a "plain" xsvf file which accounts for
	   additional devices in the scan chain, otherwise the device
218
219
	   that should be affected
	*/
220
	struct jtag_tap *tap = NULL;
221

222
	if (CMD_ARGC < 2)
223
	{
Mathias K's avatar
Mathias K committed
224
		return ERROR_COMMAND_SYNTAX_ERROR;
225
226
	}

227
228
	/* we mess with CMD_ARGV starting point below, snapshot filename here */
	const char *filename = CMD_ARGV[1];
229

230
	if (strcmp(CMD_ARGV[0], "plain") != 0)
231
	{
232
		tap = jtag_tap_by_string(CMD_ARGV[0]);
233
		if (!tap)
234
		{
235
			command_print(CMD_CTX, "Tap: %s unknown", CMD_ARGV[0]);
236
237
			return ERROR_FAIL;
		}
238
239
	}

240
	if ((xsvf_fd = open(filename, O_RDONLY)) < 0)
241
	{
242
		command_print(CMD_CTX, "file \"%s\" not found", filename);
243
		return ERROR_FAIL;
244
	}
245

246
	/* if this argument is present, then interpret xruntest counts as TCK cycles rather than as usecs */
247
	if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "virt2") == 0))
248
249
	{
		runtest_requires_tck = 1;
250
		--CMD_ARGC;
251
		++CMD_ARGV;
252
253
	}

254
	if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "quiet") == 0))
255
256
	{
		verbose = 0;
257
258
	}

259
	LOG_USER("xsvf processing file: \"%s\"", filename);
260

261
	while (read(xsvf_fd, &opcode, 1) > 0)
262
	{
263
		/* record the position of this opcode within the file */
264
265
		file_offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1;

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
		/* maybe collect another state for a pathmove();
		 * or terminate a path.
		 */
		if (collecting_path) {
			tap_state_t	mystate;

			switch (opcode) {
			case XCOMMENT:
				/* ignore/show comments between XSTATE ops */
				break;
			case XSTATE:
				/* try to collect another transition */
				if (pathlen == XSTATE_MAX_PATH) {
					LOG_ERROR("XSVF: path too long");
					do_abort = 1;
					break;
				}

				if (read(xsvf_fd, &uc, 1) < 0)
				{
					do_abort = 1;
					break;
				}

				mystate = xsvf_to_tap(uc);
				path[pathlen++] = mystate;

				LOG_DEBUG("XSTATE 0x%02X %s", uc,
						tap_state_name(mystate));

				/* If path is incomplete, collect more */
				if (!svf_tap_state_is_stable(mystate))
					continue;

				/* Else execute the path transitions we've
				 * collected so far.
				 *
				 * NOTE:  Punting on the saved path is not
				 * strictly correct, but we must to do this
				 * unless jtag_add_pathmove() stops rejecting
				 * paths containing RESET.  This is probably
				 * harmless, since there aren't many options
				 * for going from a stable state to reset;
				 * at the worst, we may issue extra clocks
				 * once we get to RESET.
				 */
				if (mystate == TAP_RESET) {
					LOG_WARNING("XSVF: dodgey RESET");
					path[0] = mystate;
				}

				/* FALL THROUGH */
			default:
				/* Execute the path we collected
				 *
				 * NOTE: OpenOCD requires something that XSVF
				 * doesn't:  the last TAP state in the path
				 * must be stable.  In practice, tools that
				 * create XSVF seem to follow that rule too.
				 */
				collecting_path = false;

				if (path[0] == TAP_RESET)
					jtag_add_tlr();
				else
					jtag_add_pathmove(pathlen, path);

333
				result = jtag_execute_queue();
334
335
336
337
338
339
340
341
342
343
				if (result != ERROR_OK) {
					LOG_ERROR("XSVF: pathmove error %d",
							result);
					do_abort = 1;
					break;
				}
				continue;
			}
		}

344
		switch (opcode)
345
		{
346
347
		case XCOMPLETE:
			LOG_DEBUG("XCOMPLETE");
348

349
350
351
352
			result = jtag_execute_queue();
			if (result != ERROR_OK)
			{
				tdo_mismatch = 1;
353
				break;
354
355
			}
			break;
356

357
358
359
360
361
		case XTDOMASK:
			LOG_DEBUG("XTDOMASK");
			if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK))
				do_abort = 1;
			break;
362

363
364
		case XRUNTEST:
			{
zwelch's avatar
zwelch committed
365
				uint8_t	xruntest_buf[4];
366
367

				if (read(xsvf_fd, xruntest_buf, 4) < 0)
368
				{
369
370
371
					do_abort = 1;
					break;
				}
372

373
374
375
376
				xruntest = be_to_h_u32(xruntest_buf);
				LOG_DEBUG("XRUNTEST %d 0x%08X", xruntest, xruntest);
			}
			break;
377

378
379
		case XREPEAT:
			{
zwelch's avatar
zwelch committed
380
				uint8_t myrepeat;
381

382
383
384
				if (read(xsvf_fd, &myrepeat, 1) < 0)
					do_abort = 1;
				else
385
				{
386
					xrepeat = myrepeat;
387
					LOG_DEBUG("XREPEAT %d", xrepeat);
388
				}
389
390
			}
			break;
391

392
393
		case XSDRSIZE:
			{
zwelch's avatar
zwelch committed
394
				uint8_t	xsdrsize_buf[4];
395
396

				if (read(xsvf_fd, xsdrsize_buf, 4) < 0)
397
				{
398
399
400
					do_abort = 1;
					break;
				}
401

402
403
				xsdrsize = be_to_h_u32(xsdrsize_buf);
				LOG_DEBUG("XSDRSIZE %d", xsdrsize);
404

405
				if (dr_out_buf) free(dr_out_buf);
406
407
				if (dr_in_buf)   free(dr_in_buf);
				if (dr_in_mask)  free(dr_in_mask);
408

409
410
411
412
413
				dr_out_buf = malloc((xsdrsize + 7) / 8);
				dr_in_buf = malloc((xsdrsize + 7) / 8);
				dr_in_mask = malloc((xsdrsize + 7) / 8);
			}
			break;
414

415
416
417
418
419
420
		case XSDR:		/* these two are identical except for the dr_in_buf */
		case XSDRTDO:
			{
				int limit = xrepeat;
				int	matched = 0;
				int attempt;
421

422
				const char* op_name = (opcode == XSDR ? "XSDR" : "XSDRTDO");
423

424
425
426
427
428
				if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK)
				{
					do_abort = 1;
					break;
				}
429

430
431
				if (opcode == XSDRTDO)
				{
432
					if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf)  != ERROR_OK)
433
					{
434
						do_abort = 1;
435
436
						break;
					}
437
				}
438

439
440
				if (limit < 1)
					limit = 1;
441

442
				LOG_DEBUG("%s %d", op_name, xsdrsize);
443

444
				for (attempt = 0; attempt < limit;  ++attempt)
445
				{
446
					struct scan_field field;
447

448
					if (attempt > 0)
449
					{
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
						/* perform the XC9500 exception handling sequence shown in xapp067.pdf and
						   illustrated in psuedo code at end of this file.  We start from state
						   DRPAUSE:
						   go to Exit2-DR
						   go to Shift-DR
						   go to Exit1-DR
						   go to Update-DR
						   go to Run-Test/Idle

						   This sequence should be harmless for other devices, and it
						   will be skipped entirely if xrepeat is set to zero.
						*/

						static tap_state_t exception_path[] = {
							TAP_DREXIT2,
							TAP_DRSHIFT,
							TAP_DREXIT1,
							TAP_DRUPDATE,
							TAP_IDLE,
						};

471
						jtag_add_pathmove(ARRAY_SIZE(exception_path), exception_path);
472
473
474
475

						if (verbose)
							LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt);
					}
476

477
478
					field.num_bits = xsdrsize;
					field.out_value = dr_out_buf;
Zachary T Welch's avatar
Zachary T Welch committed
479
					field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
480

481
					if (tap == NULL)
482
						jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value,
483
								TAP_DRPAUSE);
484
					else
485
						jtag_add_dr_scan(tap, 1, &field, TAP_DRPAUSE);
486

oharboe's avatar
oharboe committed
487
488
489
490
491
					jtag_check_value_mask(&field, dr_in_buf, dr_in_mask);

					free(field.in_value);


492
493
494
					/* LOG_DEBUG("FLUSHING QUEUE"); */
					result = jtag_execute_queue();
					if (result == ERROR_OK)
495
					{
496
						matched = 1;
497
498
						break;
					}
499
				}
500

501
502
				if (!matched)
				{
503
					LOG_USER("%s mismatch", op_name);
504
505
506
					tdo_mismatch = 1;
					break;
				}
507

508
509
510
				/* See page 19 of XSVF spec regarding opcode "XSDR" */
				if (xruntest)
				{
David Brownell's avatar
David Brownell committed
511
					result = svf_add_statemove(TAP_IDLE);
512
513
					if (result != ERROR_OK)
						return result;
514
515
516
517
518

					if (runtest_requires_tck)
						jtag_add_clocks(xruntest);
					else
						jtag_add_sleep(xruntest);
519
520
				} else if (xendir != TAP_DRPAUSE) {
					/* we are already in TAP_DRPAUSE */
David Brownell's avatar
David Brownell committed
521
					result = svf_add_statemove(xenddr);
522
523
524
					if (result != ERROR_OK)
						return result;
				}
525
526
			}
			break;
527

528
		case XSETSDRMASKS:
529
			LOG_ERROR("unsupported XSETSDRMASKS");
530
531
			unsupported = 1;
			break;
532

533
		case XSDRINC:
534
			LOG_ERROR("unsupported XSDRINC");
535
536
			unsupported = 1;
			break;
537

538
		case XSDRB:
539
			LOG_ERROR("unsupported XSDRB");
540
541
			unsupported = 1;
			break;
542

543
		case XSDRC:
544
			LOG_ERROR("unsupported XSDRC");
545
546
			unsupported = 1;
			break;
547

548
		case XSDRE:
549
			LOG_ERROR("unsupported XSDRE");
550
551
			unsupported = 1;
			break;
552

553
		case XSDRTDOB:
554
			LOG_ERROR("unsupported XSDRTDOB");
555
556
			unsupported = 1;
			break;
557

558
		case XSDRTDOC:
559
			LOG_ERROR("unsupported XSDRTDOC");
560
561
			unsupported = 1;
			break;
562

563
		case XSDRTDOE:
564
			LOG_ERROR("unsupported XSDRTDOE");
565
566
567
568
569
570
			unsupported = 1;
			break;

		case XSTATE:
			{
				tap_state_t	mystate;
571

572
				if (read(xsvf_fd, &uc, 1) < 0)
573
				{
574
575
576
					do_abort = 1;
					break;
				}
577

578
				mystate = xsvf_to_tap(uc);
579

580
				LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate));
581

582
583
584
585
586
587
				if (mystate == TAP_INVALID) {
					LOG_ERROR("XSVF: bad XSTATE %02x", uc);
					do_abort = 1;
					break;
				}

David Brownell's avatar
David Brownell committed
588
589
590
591
592
593
				/* NOTE: the current state is SVF-stable! */

				/* no change == NOP */
				if (mystate == cmd_queue_cur_state
						&& mystate != TAP_RESET)
					break;
594

David Brownell's avatar
David Brownell committed
595
596
				/* Hand off to SVF? */
				if (svf_tap_state_is_stable(mystate))
597
				{
David Brownell's avatar
David Brownell committed
598
599
600
601
					result = svf_add_statemove(mystate);
					if (result != ERROR_OK)
						unsupported = 1;
					break;
602
				}
David Brownell's avatar
David Brownell committed
603
604
605

				/*
				 * A sequence of XSTATE transitions, each TAP
606
607
				 * state adjacent to the previous one.  Start
				 * collecting them.
David Brownell's avatar
David Brownell committed
608
				 */
609
610
611
				collecting_path = true;
				pathlen = 1;
				path[0] = mystate;
612
613
			}
			break;
614

615
		case XENDIR:
616

617
618
619
620
621
622
623
			if (read(xsvf_fd, &uc, 1) < 0)
			{
				do_abort = 1;
				break;
			}

			/* see page 22 of XSVF spec */
624
			if (uc == 0)
625
				xendir = TAP_IDLE;
626
			else if (uc == 1)
627
628
629
630
631
632
633
				xendir = TAP_IRPAUSE;
			else
			{
				LOG_ERROR("illegial XENDIR argument: 0x%02X", uc);
				unsupported = 1;
				break;
			}
634

635
636
			LOG_DEBUG("XENDIR 0x%02X %s", uc, tap_state_name(xendir));
			break;
637

638
		case XENDDR:
639

640
641
642
			if (read(xsvf_fd, &uc, 1) < 0)
			{
				do_abort = 1;
643
				break;
644
645
646
			}

			/* see page 22 of XSVF spec */
647
			if (uc == 0)
648
				xenddr = TAP_IDLE;
649
			else if (uc == 1)
650
651
652
653
654
655
656
				xenddr = TAP_DRPAUSE;
			else
			{
				LOG_ERROR("illegial XENDDR argument: 0x%02X", uc);
				unsupported = 1;
				break;
			}
657

658
659
			LOG_DEBUG("XENDDR %02X %s", uc, tap_state_name(xenddr));
			break;
660

661
662
663
		case XSIR:
		case XSIR2:
			{
zwelch's avatar
zwelch committed
664
665
				uint8_t	short_buf[2];
				uint8_t*	ir_buf;
666
667
668
				int bitcount;
				tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir;

669
				if (opcode == XSIR)
670
671
672
				{
					/* one byte bitcount */
					if (read(xsvf_fd, short_buf, 1) < 0)
673
					{
674
675
676
						do_abort = 1;
						break;
					}
677
678
679
680
681
682
					bitcount = short_buf[0];
					LOG_DEBUG("XSIR %d", bitcount);
				}
				else
				{
					if (read(xsvf_fd, short_buf, 2) < 0)
683
					{
684
						do_abort = 1;
685
						break;
686
					}
687
688
					bitcount = be_to_h_u16(short_buf);
					LOG_DEBUG("XSIR2 %d", bitcount);
689
				}
690

zwelch's avatar
zwelch committed
691
				ir_buf = malloc((bitcount + 7) / 8);
692

693
694
695
696
				if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK)
					do_abort = 1;
				else
				{
697
					struct scan_field field;
698
699
700

					field.num_bits = bitcount;
					field.out_value = ir_buf;
oharboe's avatar
oharboe committed
701

702
					field.in_value = NULL;
oharboe's avatar
oharboe committed
703
704


705

706
707

					if (tap == NULL)
708
709
						jtag_add_plain_ir_scan(field.num_bits,
								field.out_value, field.in_value, my_end_state);
710
					else
711
						jtag_add_ir_scan(tap, &field, my_end_state);
712

713
					if (xruntest)
714
					{
715
716
						if (runtest_requires_tck)
							jtag_add_clocks(xruntest);
717
						else
718
719
							jtag_add_sleep(xruntest);
					}
720

721
722
723
724
					/* Note that an -irmask of non-zero in your config file
					 * can cause this to fail.  Setting -irmask to zero cand work
					 * around the problem.
					 */
725

726
727
					/* LOG_DEBUG("FLUSHING QUEUE"); */
					result = jtag_execute_queue();
zwelch's avatar
zwelch committed
728
					if (result != ERROR_OK)
729
730
					{
						tdo_mismatch = 1;
731
732
					}
				}
733
734
735
				free(ir_buf);
			}
			break;
736

737
738
		case XCOMMENT:
			{
739
				unsigned int ndx = 0;
740
				char	comment[128];
741

742
743
744
				do
				{
					if (read(xsvf_fd, &uc, 1) < 0)
745
					{
746
747
748
						do_abort = 1;
						break;
					}
749

750
					if (ndx < sizeof(comment)-1)
751
						comment[ndx++] = uc;
752

753
				} while (uc != 0);
754

755
756
				comment[sizeof(comment)-1] = 0;		/* regardless, terminate */
				if (verbose)
757
					LOG_USER("# %s", comment);
758
759
			}
			break;
760

761
762
763
		case XWAIT:
			{
				/* expected in stream:
764
				   XWAIT <uint8_t wait_state> <uint8_t end_state> <uint32_t usecs>
765
				*/
766

767
				uint8_t	wait_local;
zwelch's avatar
zwelch committed
768
769
				uint8_t	end;
				uint8_t	delay_buf[4];
770

771
772
				tap_state_t wait_state;
				tap_state_t end_state;
773
				int	delay;
774

775
				if (read(xsvf_fd, &wait_local, 1) < 0
776
777
778
779
780
781
				  || read(xsvf_fd, &end, 1) < 0
				  || read(xsvf_fd, delay_buf, 4) < 0)
				{
					do_abort = 1;
					break;
				}
782

783
				wait_state = xsvf_to_tap(wait_local);
784
785
				end_state  = xsvf_to_tap(end);
				delay      = be_to_h_u32(delay_buf);
786

787
				LOG_DEBUG("XWAIT %s %s usecs:%d", tap_state_name(wait_state), tap_state_name(end_state), delay);
788

789
				if (runtest_requires_tck && wait_state == TAP_IDLE)
790
791
				{
					jtag_add_runtest(delay, end_state);
792
				}
793
				else
794
				{
David Brownell's avatar
David Brownell committed
795
796
					/* FIXME handle statemove errors ... */
					result = svf_add_statemove(wait_state);
797
798
					if (result != ERROR_OK)
						return result;
799
					jtag_add_sleep(delay);
David Brownell's avatar
David Brownell committed
800
					result = svf_add_statemove(end_state);
801
802
					if (result != ERROR_OK)
						return result;
803
804
805
				}
			}
			break;
806

807
808
809
		case XWAITSTATE:
			{
				/* expected in stream:
810
				   XWAITSTATE <uint8_t wait_state> <uint8_t end_state> <uint32_t clock_count> <uint32_t usecs>
811
812
				*/

zwelch's avatar
zwelch committed
813
				uint8_t  clock_buf[4];
814
				uint8_t	usecs_buf[4];
815
				uint8_t	wait_local;
zwelch's avatar
zwelch committed
816
				uint8_t	end;
817
818
819
820
821
				tap_state_t wait_state;
				tap_state_t end_state;
				int clock_count;
				int usecs;

822
				if (read(xsvf_fd, &wait_local, 1) < 0
823
824
				 ||  read(xsvf_fd, &end, 1) < 0
				 ||  read(xsvf_fd, clock_buf, 4) < 0
825
				 ||  read(xsvf_fd, usecs_buf, 4) < 0)
826
827
828
829
				{
					do_abort = 1;
					break;
				}
830

831
				wait_state = xsvf_to_tap(wait_local);
832
				end_state  = xsvf_to_tap(end);
833

834
835
				clock_count = be_to_h_u32(clock_buf);
				usecs       = be_to_h_u32(usecs_buf);
836

837
838
839
840
				LOG_DEBUG("XWAITSTATE %s %s clocks:%i usecs:%i",
					tap_state_name(wait_state),
					tap_state_name(end_state),
					clock_count, usecs);
841

842
843
844
845
846
				/* the following states are 'stable', meaning that they have a transition
				 * in the state diagram back to themselves.  This is necessary because we will
				 * be issuing a number of clocks in this state.  This set of allowed states is also
				 * determined by the SVF RUNTEST command's allowed states.
				 */
David Brownell's avatar
David Brownell committed
847
				if (!svf_tap_state_is_stable(wait_state))
848
				{
David Brownell's avatar
David Brownell committed
849
850
					LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"",
							tap_state_name(wait_state));
851
					unsupported = 1;
David Brownell's avatar
David Brownell committed
852
					/* REVISIT "break" so we won't run? */
853
				}
854

David Brownell's avatar
David Brownell committed
855
856
				/* FIXME handle statemove errors ... */
				result = svf_add_statemove(wait_state);
857
858
				if (result != ERROR_OK)
					return result;
859

860
				jtag_add_clocks(clock_count);
861

862
				jtag_add_sleep(usecs);
863

David Brownell's avatar
David Brownell committed
864
				result = svf_add_statemove(end_state);
865
866
				if (result != ERROR_OK)
					return result;
867
868
			}
			break;
869

870
871
872
		case LCOUNT:
			{
				/* expected in stream:
873
				   LCOUNT <uint32_t loop_count>
874
				*/
zwelch's avatar
zwelch committed
875
				uint8_t  count_buf[4];
876

877
				if (read(xsvf_fd, count_buf, 4) < 0)
878
				{
879
880
881
					do_abort = 1;
					break;
				}
882

883
884
885
886
				loop_count = be_to_h_u32(count_buf);
				LOG_DEBUG("LCOUNT %d", loop_count);
			}
			break;
887

888
889
890
		case LDELAY:
			{
				/* expected in stream:
891
				   LDELAY <uint8_t wait_state> <uint32_t clock_count> <uint32_t usecs_to_sleep>
892
				*/
zwelch's avatar
zwelch committed
893
894
895
				uint8_t	state;
				uint8_t  clock_buf[4];
				uint8_t  usecs_buf[4];
896

897
				if (read(xsvf_fd, &state, 1) < 0
898
				  || read(xsvf_fd, clock_buf, 4) < 0
899
				  ||	 read(xsvf_fd, usecs_buf, 4) < 0)
900
901
902
				{
					do_abort = 1;
					break;
903
904
				}

David Brownell's avatar
David Brownell committed
905
				/* NOTE:  loop_state must be stable! */
906
907
908
				loop_state  = xsvf_to_tap(state);
				loop_clocks = be_to_h_u32(clock_buf);
				loop_usecs  = be_to_h_u32(usecs_buf);
909

910
911
912
				LOG_DEBUG("LDELAY %s clocks:%d usecs:%d", tap_state_name(loop_state), loop_clocks, loop_usecs);
			}
			break;
913

914
915
916
917
918
919
920
921
		/* LSDR is more like XSDRTDO than it is like XSDR.  It uses LDELAY which
		 * comes with clocks !AND! sleep requirements.
		 */
		case LSDR:
			{
				int limit = loop_count;
				int matched = 0;
				int attempt;
922

923
				LOG_DEBUG("LSDR");
924

925
				if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK
926
				  || xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK)
927
928
929
930
				{
					do_abort = 1;
					break;
				}
931

932
933
				if (limit < 1)
					limit = 1;
934

935
				for (attempt = 0; attempt < limit;  ++attempt)
936
				{
937
					struct scan_field field;
938

David Brownell's avatar
David Brownell committed
939
					result = svf_add_statemove(loop_state);
940
941
					if (result != ERROR_OK)
						return result;
942
943
					jtag_add_clocks(loop_clocks);
					jtag_add_sleep(loop_usecs);
944

945
946
					field.num_bits = xsdrsize;
					field.out_value = dr_out_buf;
Zachary T Welch's avatar
Zachary T Welch committed
947
					field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
948

949
950
951
952
					if (attempt > 0 && verbose)
						LOG_USER("LSDR retry %d", attempt);

					if (tap == NULL)
953
						jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value,