driver.c 16 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007-2009 Øyvind Harboe                                 *
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
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
 *   Copyright (C) 2009 SoftPLC Corporation                                *
 *       http://softplc.com                                                *
 *   dick@softplc.com                                                      *
 *                                                                         *
 *   Copyright (C) 2009 Zachary T Welch                                    *
 *   zw@superlucidity.net                                                  *
 *                                                                         *
 *   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.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

34
#include <jtag/jtag.h>
35
#include <jtag/interface.h>
36
#include <jtag/commands.h>
37
#include <jtag/minidriver.h>
38
#include <helper/command.h>
39
40
41
42
43
44

struct jtag_callback_entry
{
	struct jtag_callback_entry *next;

	jtag_callback_t callback;
45
	jtag_callback_data_t data0;
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
	jtag_callback_data_t data1;
	jtag_callback_data_t data2;
	jtag_callback_data_t data3;
};

static struct jtag_callback_entry *jtag_callback_queue_head = NULL;
static struct jtag_callback_entry *jtag_callback_queue_tail = NULL;

static void jtag_callback_queue_reset(void)
{
	jtag_callback_queue_head = NULL;
	jtag_callback_queue_tail = NULL;
}

/**
61
 * Copy a struct scan_field for insertion into the queue.
62
63
64
 *
 * This allocates a new copy of out_value using cmd_queue_alloc.
 */
65
static void cmd_queue_scan_field_clone(struct scan_field * dst, const struct scan_field * src)
66
67
68
{
	dst->tap		= src->tap;
	dst->num_bits	= src->num_bits;
Zachary T Welch's avatar
Zachary T Welch committed
69
	dst->out_value	= buf_cpy(src->out_value, cmd_queue_alloc(DIV_ROUND_UP(src->num_bits, 8)), src->num_bits);
70
71
72
	dst->in_value	= src->in_value;
}

oharboe's avatar
oharboe committed
73

74
75
76
77
/**
 * see jtag_add_ir_scan()
 *
 */
78
int interface_jtag_add_ir_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
79
{
80
	size_t num_taps = jtag_tap_count_enabled();
81

82
	struct jtag_command * cmd		= cmd_queue_alloc(sizeof(struct jtag_command));
83
	struct scan_command * scan		= cmd_queue_alloc(sizeof(struct scan_command));
84
	struct scan_field * out_fields	= cmd_queue_alloc(num_taps  * sizeof(struct scan_field));
85
86
87
88
89
90
91
92
93
94
95
96

	jtag_queue_command(cmd);

	cmd->type				= JTAG_SCAN;
	cmd->cmd.scan			= scan;

	scan->ir_scan			= true;
	scan->num_fields		= num_taps;	/* one field per device */
	scan->fields			= out_fields;
	scan->end_state			= state;


97
	struct scan_field * field = out_fields;	/* keep track where we insert data */
98
99
100

	/* loop over all enabled TAPs */

101
	for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
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
	{
		/* search the input field list for fields for the current TAP */

		bool found = false;

		for (int j = 0; j < in_num_fields; j++)
		{
			if (tap != in_fields[j].tap)
				continue;

			/* if TAP is listed in input fields, copy the value */

			found = true;

			tap->bypass = 0;

			assert(in_fields[j].num_bits == tap->ir_length); /* input fields must have the same length as the TAP's IR */

			cmd_queue_scan_field_clone(field, in_fields + j);

			break;
		}

		if (!found)
		{
			/* if a TAP isn't listed in input fields, set it to BYPASS */

			tap->bypass = 1;

			field->tap			= tap;
			field->num_bits		= tap->ir_length;
Zachary T Welch's avatar
Zachary T Welch committed
133
			field->out_value	= buf_set_ones(cmd_queue_alloc(DIV_ROUND_UP(tap->ir_length, 8)), tap->ir_length);
134
135
136
137
138
139
140
141
142
			field->in_value		= NULL; /* do not collect input for tap's in bypass */
		}

		/* update device information */
		buf_cpy(field->out_value, tap->cur_instr, tap->ir_length);

		field++;
	}

143
	assert(field == out_fields + num_taps); /* paranoia: jtag_tap_count_enabled() and jtag_tap_next_enabled() not in sync */
144
145
146
147
148
149
150
151

	return ERROR_OK;
}

/**
 * see jtag_add_plain_ir_scan()
 *
 */
152
int interface_jtag_add_plain_ir_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
153
154
{

155
	struct jtag_command * cmd		= cmd_queue_alloc(sizeof(struct jtag_command));
156
	struct scan_command * scan		= cmd_queue_alloc(sizeof(struct scan_command));
157
	struct scan_field * out_fields	= cmd_queue_alloc(in_num_fields * sizeof(struct scan_field));
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

	jtag_queue_command(cmd);

	cmd->type				= JTAG_SCAN;
	cmd->cmd.scan			= scan;

	scan->ir_scan			= true;
	scan->num_fields		= in_num_fields;
	scan->fields			= out_fields;
	scan->end_state			= state;

	for (int i = 0; i < in_num_fields; i++)
		cmd_queue_scan_field_clone(out_fields + i, in_fields + i);

	return ERROR_OK;
}



/**
 * see jtag_add_dr_scan()
 *
 */
181
int interface_jtag_add_dr_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
182
183
184
185
186
{
	/* count devices in bypass */

	size_t bypass_devices = 0;

187
	for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
188
189
190
191
192
	{
		if (tap->bypass)
			bypass_devices++;
	}

193
	struct jtag_command * cmd		= cmd_queue_alloc(sizeof(struct jtag_command));
194
	struct scan_command * scan		= cmd_queue_alloc(sizeof(struct scan_command));
195
	struct scan_field * out_fields	= cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(struct scan_field));
196
197
198
199
200
201
202
203
204
205
206
207

	jtag_queue_command(cmd);

	cmd->type				= JTAG_SCAN;
	cmd->cmd.scan			= scan;

	scan->ir_scan			= false;
	scan->num_fields		= in_num_fields + bypass_devices;
	scan->fields			= out_fields;
	scan->end_state			= state;


208
	struct scan_field * field = out_fields;	/* keep track where we insert data */
209
210
211

	/* loop over all enabled TAPs */

212
	for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
213
214
215
216
217
	{
		/* if TAP is not bypassed insert matching input fields */

		if (!tap->bypass)
		{
David Brownell's avatar
David Brownell committed
218
219
220
221
#ifndef NDEBUG
			/* remember initial position for assert() */
			struct scan_field *start_field = field;
#endif /* NDEBUG */
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

			for (int j = 0; j < in_num_fields; j++)
			{
				if (tap != in_fields[j].tap)
					continue;

				cmd_queue_scan_field_clone(field, in_fields + j);

				field++;
			}

			assert(field > start_field);	/* must have at least one input field per not bypassed TAP */
		}

		/* if a TAP is bypassed, generated a dummy bit*/
		else
		{
			field->tap			= tap;
			field->num_bits		= 1;
			field->out_value	= NULL;
			field->in_value		= NULL;

			field++;
		}
	}

	assert(field == out_fields + scan->num_fields); /* no superfluous input fields permitted */

	return ERROR_OK;
}



/**
 * Generate a DR SCAN using the array of output values passed to the function
 *
 * This function assumes that the parameter target_tap specifies the one TAP
 * that is not bypassed. All other TAPs must be bypassed and the function will
 * generate a dummy 1bit field for them.
 *
 * For the target_tap a sequence of output-only fields will be generated where
 * each field has the size num_bits and the field's values are taken from
 * the array value.
 *
 * The bypass status of TAPs is set by jtag_add_ir_scan().
 *
 */
269
void interface_jtag_add_dr_out(struct jtag_tap *target_tap,
270
271
		int in_num_fields,
		const int *num_bits,
272
		const uint32_t *value,
273
274
275
276
277
278
		tap_state_t end_state)
{
	/* count devices in bypass */

	size_t bypass_devices = 0;

279
	for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
280
281
282
283
284
285
	{
		if (tap->bypass)
			bypass_devices++;
	}


286
	struct jtag_command * cmd		= cmd_queue_alloc(sizeof(struct jtag_command));
287
	struct scan_command * scan		= cmd_queue_alloc(sizeof(struct scan_command));
288
	struct scan_field * out_fields	= cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(struct scan_field));
289
290
291
292
293
294
295
296
297
298
299
300
301
302

	jtag_queue_command(cmd);

	cmd->type				= JTAG_SCAN;
	cmd->cmd.scan			= scan;

	scan->ir_scan			= false;
	scan->num_fields		= in_num_fields + bypass_devices;
	scan->fields			= out_fields;
	scan->end_state			= end_state;


	bool target_tap_match	= false;

303
	struct scan_field * field = out_fields;	/* keep track where we insert data */
304
305
306

	/* loop over all enabled TAPs */

307
	for (struct jtag_tap * tap = jtag_tap_next_enabled(NULL); tap != NULL; tap = jtag_tap_next_enabled(tap))
308
309
310
311
312
313
314
315
316
317
318
	{
		/* if TAP is not bypassed insert matching input fields */

		if (!tap->bypass)
		{
			assert(tap == target_tap); /* target_tap must match the one not bypassed TAP */

			target_tap_match = true;

			for (int j = 0; j < in_num_fields; j++)
			{
zwelch's avatar
zwelch committed
319
				uint8_t out_value[4];
320
321
322
323
324
				size_t scan_size = num_bits[j];
				buf_set_u32(out_value, 0, scan_size, value[j]);

				field->tap			= tap;
				field->num_bits		= scan_size;
Zachary T Welch's avatar
Zachary T Welch committed
325
				field->out_value	= buf_cpy(out_value, cmd_queue_alloc(DIV_ROUND_UP(scan_size, 8)), scan_size);
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
				field->in_value		= NULL;

				field++;
			}
		}

		/* if a TAP is bypassed, generated a dummy bit*/
		else
		{

			field->tap				= tap;
			field->num_bits			= 1;
			field->out_value		= NULL;
			field->in_value			= NULL;

			field++;
		}
	}

	assert(target_tap_match);	/* target_tap should be enabled and not bypassed */
}

/**
 * see jtag_add_plain_dr_scan()
 *
 */
352
int interface_jtag_add_plain_dr_scan(int in_num_fields, const struct scan_field *in_fields, tap_state_t state)
353
{
354
	struct jtag_command * cmd		= cmd_queue_alloc(sizeof(struct jtag_command));
355
	struct scan_command * scan		= cmd_queue_alloc(sizeof(struct scan_command));
356
	struct scan_field * out_fields	= cmd_queue_alloc(in_num_fields * sizeof(struct scan_field));
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373

	jtag_queue_command(cmd);

	cmd->type				= JTAG_SCAN;
	cmd->cmd.scan			= scan;

	scan->ir_scan			= false;
	scan->num_fields		= in_num_fields;
	scan->fields			= out_fields;
	scan->end_state			= state;

	for (int i = 0; i < in_num_fields; i++)
		cmd_queue_scan_field_clone(out_fields + i, in_fields + i);

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
374
int interface_jtag_add_tlr(void)
375
376
377
378
{
	tap_state_t state = TAP_RESET;

	/* allocate memory for a new list member */
379
	struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
380
381
382
383
384

	jtag_queue_command(cmd);

	cmd->type = JTAG_STATEMOVE;

385
	cmd->cmd.statemove = cmd_queue_alloc(sizeof(struct statemove_command));
386
387
388
389
390
	cmd->cmd.statemove->end_state = state;

	return ERROR_OK;
}

391
int interface_add_tms_seq(unsigned num_bits, const uint8_t *seq, enum tap_state state)
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
{
	struct jtag_command *cmd;

	cmd = cmd_queue_alloc(sizeof(struct jtag_command));
	if (cmd == NULL)
		return ERROR_FAIL;

	cmd->type = JTAG_TMS;
	cmd->cmd.tms = cmd_queue_alloc(sizeof(*cmd->cmd.tms));
	if (!cmd->cmd.tms)
		return ERROR_FAIL;

	/* copy the bits; our caller doesn't guarantee they'll persist */
	cmd->cmd.tms->num_bits = num_bits;
	cmd->cmd.tms->bits = buf_cpy(seq,
			cmd_queue_alloc(DIV_ROUND_UP(num_bits, 8)), num_bits);
	if (!cmd->cmd.tms->bits)
		return ERROR_FAIL;

	jtag_queue_command(cmd);

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
416
int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
417
418
{
	/* allocate memory for a new list member */
419
	struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
420
421
422
423
424

	jtag_queue_command(cmd);

	cmd->type = JTAG_PATHMOVE;

425
	cmd->cmd.pathmove = cmd_queue_alloc(sizeof(struct pathmove_command));
426
427
428
429
430
431
432
433
434
	cmd->cmd.pathmove->num_states = num_states;
	cmd->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);

	for (int i = 0; i < num_states; i++)
		cmd->cmd.pathmove->path[i] = path[i];

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
435
int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
436
437
{
	/* allocate memory for a new list member */
438
	struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
439
440
441
442
443

	jtag_queue_command(cmd);

	cmd->type = JTAG_RUNTEST;

444
	cmd->cmd.runtest = cmd_queue_alloc(sizeof(struct runtest_command));
445
446
447
448
449
450
	cmd->cmd.runtest->num_cycles = num_cycles;
	cmd->cmd.runtest->end_state = state;

	return ERROR_OK;
}

451
int interface_jtag_add_clocks(int num_cycles)
452
453
{
	/* allocate memory for a new list member */
454
	struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
455
456
457
458
459

	jtag_queue_command(cmd);

	cmd->type = JTAG_STABLECLOCKS;

460
	cmd->cmd.stableclocks = cmd_queue_alloc(sizeof(struct stableclocks_command));
461
462
463
464
465
	cmd->cmd.stableclocks->num_cycles = num_cycles;

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
466
int interface_jtag_add_reset(int req_trst, int req_srst)
467
468
{
	/* allocate memory for a new list member */
469
	struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
470
471
472
473
474

	jtag_queue_command(cmd);

	cmd->type = JTAG_RESET;

475
	cmd->cmd.reset = cmd_queue_alloc(sizeof(struct reset_command));
476
477
478
479
480
481
	cmd->cmd.reset->trst = req_trst;
	cmd->cmd.reset->srst = req_srst;

	return ERROR_OK;
}

482
int interface_jtag_add_sleep(uint32_t us)
483
484
{
	/* allocate memory for a new list member */
485
	struct jtag_command * cmd = cmd_queue_alloc(sizeof(struct jtag_command));
486
487
488
489
490

	jtag_queue_command(cmd);

	cmd->type = JTAG_SLEEP;

491
	cmd->cmd.sleep = cmd_queue_alloc(sizeof(struct sleep_command));
492
493
494
495
496
497
	cmd->cmd.sleep->us = us;

	return ERROR_OK;
}

/* add callback to end of queue */
498
void interface_jtag_add_callback4(jtag_callback_t callback, jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
499
{
zwelch's avatar
zwelch committed
500
	struct jtag_callback_entry *entry = cmd_queue_alloc(sizeof(struct jtag_callback_entry));
501

zwelch's avatar
zwelch committed
502
503
504
505
506
507
	entry->next = NULL;
	entry->callback = callback;
	entry->data0 = data0;
	entry->data1 = data1;
	entry->data2 = data2;
	entry->data3 = data3;
508

zwelch's avatar
zwelch committed
509
	if (jtag_callback_queue_head == NULL)
510
	{
zwelch's avatar
zwelch committed
511
512
		jtag_callback_queue_head = entry;
		jtag_callback_queue_tail = entry;
513
514
	} else
	{
zwelch's avatar
zwelch committed
515
516
		jtag_callback_queue_tail->next = entry;
		jtag_callback_queue_tail = entry;
517
518
519
520
521
	}
}

int interface_jtag_execute_queue(void)
{
oharboe's avatar
oharboe committed
522
523
524
525
526
	static int reentry = 0;

	assert(reentry==0);
	reentry++;

527
528
529
530
	int retval = default_interface_jtag_execute_queue();
	if (retval == ERROR_OK)
	{
		struct jtag_callback_entry *entry;
zwelch's avatar
zwelch committed
531
		for (entry = jtag_callback_queue_head; entry != NULL; entry = entry->next)
532
		{
zwelch's avatar
zwelch committed
533
			retval = entry->callback(entry->data0, entry->data1, entry->data2, entry->data3);
zwelch's avatar
zwelch committed
534
			if (retval != ERROR_OK)
535
536
537
538
539
540
541
				break;
		}
	}

	jtag_command_queue_reset();
	jtag_callback_queue_reset();

oharboe's avatar
oharboe committed
542
543
	reentry--;

544
545
546
	return retval;
}

547
static int jtag_convert_to_callback4(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
oharboe's avatar
oharboe committed
548
{
549
	((jtag_callback1_t)data1)(data0);
oharboe's avatar
oharboe committed
550
551
552
	return ERROR_OK;
}

553
void interface_jtag_add_callback(jtag_callback1_t callback, jtag_callback_data_t data0)
oharboe's avatar
oharboe committed
554
{
555
	jtag_add_callback4(jtag_convert_to_callback4, data0, (jtag_callback_data_t)callback, 0, 0);
oharboe's avatar
oharboe committed
556
557
}

558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584

/* A minidriver can use use an inline versions of this API level fn */
void jtag_add_dr_out(struct jtag_tap* tap,
		int num_fields, const int* num_bits, const uint32_t* value,
		tap_state_t end_state)
{
	assert(end_state != TAP_RESET);
	assert(end_state != TAP_INVALID);

	cmd_queue_cur_state = end_state;

	interface_jtag_add_dr_out(tap,
			num_fields, num_bits, value,
			end_state);
}

void jtag_add_callback(jtag_callback1_t f, jtag_callback_data_t data0)
{
	interface_jtag_add_callback(f, data0);
}

void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
		jtag_callback_data_t data1, jtag_callback_data_t data2,
		jtag_callback_data_t data3)
{
	interface_jtag_add_callback4(f, data0, data1, data2, data3);
}