tcl.c 39.6 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
6
 *   oyvind.harboe@zylin.com                                               *
ntfreak's avatar
ntfreak committed
7
8
 *                                                                         *
 *   Copyright (C) 2009 SoftPLC Corporation                                *
zwelch's avatar
zwelch committed
9
 *       http://softplc.com                                                *
ntfreak's avatar
ntfreak committed
10
 *   dick@softplc.com                                                      *
11
 *                                                                         *
12
13
14
 *   Copyright (C) 2009 Zachary T Welch                                    *
 *   zw@superlucidity.net                                                  *
 *                                                                         *
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 *   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

#include "jtag.h"
zwelch's avatar
zwelch committed
35
#include "minidriver.h"
36
#include "interface.h"
37
#include "interfaces.h"
38

39
40
41
#ifdef HAVE_STRINGS_H
#include <strings.h>
#endif
42

43
44
45
46
47
48
static const Jim_Nvp nvp_jtag_tap_event[] = {
	{ .value = JTAG_TAP_EVENT_ENABLE,       .name = "tap-enable" },
	{ .value = JTAG_TAP_EVENT_DISABLE,      .name = "tap-disable" },

	{ .name = NULL, .value = -1 }
};
49

50
extern jtag_interface_t *jtag_interface;
51

52
53
54
55
56
57
/* jtag commands */
static int handle_interface_list_command(struct command_context_s *cmd_ctx,
		char *cmd, char **args, int argc);
static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
58
static int handle_jtag_rclk_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
59
60
61
62
static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
oharboe's avatar
oharboe committed
63

64
static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
65

66
67
68
69
static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
oharboe's avatar
oharboe committed
70
static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
71
static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
72

73
74
75
static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
76

77
78
extern int jtag_examine_chain(void);
extern int jtag_validate_chain(void);
79

80
81
82
83
84
85
86
87
88
89
enum jtag_tap_cfg_param {
	JCFG_EVENT
};

static Jim_Nvp nvp_config_opts[] = {
	{ .name = "-event",      .value = JCFG_EVENT },

	{ .name = NULL,          .value = -1 }
};

90
static int jtag_tap_configure_cmd(Jim_GetOptInfo *goi, jtag_tap_t * tap)
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
	Jim_Nvp *n;
	Jim_Obj *o;
	int e;

	/* parse config or cget options */
	while (goi->argc > 0) {
		Jim_SetEmptyResult (goi->interp);

		e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
		if (e != JIM_OK) {
			Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
			return e;
		}

		switch (n->value) {
			case JCFG_EVENT:
				if (goi->argc == 0) {
109
					Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
110
111
112
					return JIM_ERR;
				}

113
				e = Jim_GetOpt_Nvp(goi, nvp_jtag_tap_event, &n);
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
				if (e != JIM_OK) {
					Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
					return e;
				}

				if (goi->isconfigure) {
					if (goi->argc != 1) {
						Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
						return JIM_ERR;
					}
				} else {
					if (goi->argc != 0) {
						Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
						return JIM_ERR;
					}
				}

				{
					jtag_tap_event_action_t *jteap;

					jteap = tap->event_action;
					/* replace existing? */
					while (jteap) {
zwelch's avatar
zwelch committed
137
						if (jteap->event == (enum jtag_event)n->value) {
138
139
140
141
142
143
144
145
146
147
148
							break;
						}
						jteap = jteap->next;
					}

					if (goi->isconfigure) {
						if (jteap == NULL) {
							/* create new */
							jteap = calloc(1, sizeof (*jteap));
						}
						jteap->event = n->value;
149
						Jim_GetOpt_Obj(goi, &o);
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
						if (jteap->body) {
							Jim_DecrRefCount(interp, jteap->body);
						}
						jteap->body = Jim_DuplicateObj(goi->interp, o);
						Jim_IncrRefCount(jteap->body);

						/* add to head of event list */
						jteap->next = tap->event_action;
						tap->event_action = jteap;
						Jim_SetEmptyResult(goi->interp);
					} else {
						/* get */
						if (jteap == NULL) {
							Jim_SetEmptyResult(goi->interp);
						} else {
							Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
						}
					}
				}
				/* loop for more */
				break;
		}
	} /* while (goi->argc) */

	return JIM_OK;
}
176

zwelch's avatar
zwelch committed
177
178
179
180
181
182
183
184
185
static int is_bad_irval(int ir_length, jim_wide w)
{
	jim_wide v = 1;

	v <<= ir_length;
	v -= 1;
	v = ~v;
	return (w & v) != 0;
}
186

187
static int jim_newtap_cmd(Jim_GetOptInfo *goi)
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
{
	jtag_tap_t *pTap;
	jim_wide w;
	int x;
	int e;
	int reqbits;
	Jim_Nvp *n;
	char *cp;
	const Jim_Nvp opts[] = {
#define NTAP_OPT_IRLEN     0
		{ .name = "-irlen"			,	.value = NTAP_OPT_IRLEN },
#define NTAP_OPT_IRMASK    1
		{ .name = "-irmask"			,	.value = NTAP_OPT_IRMASK },
#define NTAP_OPT_IRCAPTURE 2
		{ .name = "-ircapture"		,	.value = NTAP_OPT_IRCAPTURE },
#define NTAP_OPT_ENABLED   3
204
		{ .name = "-enable"			,	.value = NTAP_OPT_ENABLED },
205
#define NTAP_OPT_DISABLED  4
206
		{ .name = "-disable"		,	.value = NTAP_OPT_DISABLED },
207
#define NTAP_OPT_EXPECTED_ID 5
208
209
		{ .name = "-expected-id"	,	.value = NTAP_OPT_EXPECTED_ID },
		{ .name = NULL				,	.value = -1 },
210
211
	};

zwelch's avatar
zwelch committed
212
213
214
	pTap = calloc(1, sizeof(jtag_tap_t));
	if (!pTap) {
		Jim_SetResult_sprintf(goi->interp, "no memory");
215
216
		return JIM_ERR;
	}
zwelch's avatar
zwelch committed
217

218
219
220
	/*
	 * we expect CHIP + TAP + OPTIONS
	 * */
zwelch's avatar
zwelch committed
221
	if (goi->argc < 3) {
222
223
224
		Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
		return JIM_ERR;
	}
225
	Jim_GetOpt_String(goi, &cp, NULL);
226
227
	pTap->chip = strdup(cp);

228
	Jim_GetOpt_String(goi, &cp, NULL);
229
	pTap->tapname = strdup(cp);
oharboe's avatar
oharboe committed
230

231
	/* name + dot + name + null */
232
	x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
233
234
	cp = malloc(x);
	sprintf(cp, "%s.%s", pTap->chip, pTap->tapname);
235
236
	pTap->dotted_name = cp;

oharboe's avatar
oharboe committed
237
	LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
238
239
			  pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);

240
	/* deal with options */
241
242
243
244
#define NTREQ_IRLEN      1
#define NTREQ_IRCAPTURE  2
#define NTREQ_IRMASK     4

245
	/* clear them as we find them */
246
	reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
oharboe's avatar
oharboe committed
247

zwelch's avatar
zwelch committed
248
	while (goi->argc) {
249
		e = Jim_GetOpt_Nvp(goi, opts, &n);
zwelch's avatar
zwelch committed
250
		if (e != JIM_OK) {
251
			Jim_GetOpt_NvpUnknown(goi, opts, 0);
252
253
			return e;
		}
254
		LOG_DEBUG("Processing option: %s", n->name);
zwelch's avatar
zwelch committed
255
		switch (n->value) {
256
		case NTAP_OPT_ENABLED:
zwelch's avatar
zwelch committed
257
			pTap->disabled_after_reset = false;
258
259
			break;
		case NTAP_OPT_DISABLED:
zwelch's avatar
zwelch committed
260
			pTap->disabled_after_reset = true;
261
262
			break;
		case NTAP_OPT_EXPECTED_ID:
263
		{
264
			uint32_t *new_expected_ids;
265

266
			e = Jim_GetOpt_Wide(goi, &w);
267
			if (e != JIM_OK) {
268
269
270
271
				Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
				return e;
			}

272
			new_expected_ids = malloc(sizeof(uint32_t) * (pTap->expected_ids_cnt + 1));
273
			if (new_expected_ids == NULL) {
274
				Jim_SetResult_sprintf(goi->interp, "no memory");
275
276
277
				return JIM_ERR;
			}

278
			memcpy(new_expected_ids, pTap->expected_ids, sizeof(uint32_t) * pTap->expected_ids_cnt);
279
280

			new_expected_ids[pTap->expected_ids_cnt] = w;
281
282

			free(pTap->expected_ids);
283
284
			pTap->expected_ids = new_expected_ids;
			pTap->expected_ids_cnt++;
285
			break;
286
		}
287
288
289
		case NTAP_OPT_IRLEN:
		case NTAP_OPT_IRMASK:
		case NTAP_OPT_IRCAPTURE:
290
			e = Jim_GetOpt_Wide(goi, &w);
zwelch's avatar
zwelch committed
291
			if (e != JIM_OK) {
292
				Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
293
294
				return e;
			}
zwelch's avatar
zwelch committed
295
			switch (n->value) {
296
			case NTAP_OPT_IRLEN:
zwelch's avatar
zwelch committed
297
				if (w > (jim_wide) (8 * sizeof(pTap->ir_capture_value)))
zwelch's avatar
zwelch committed
298
					LOG_WARNING("huge IR length %d", (int) w);
299
300
301
302
				pTap->ir_length = w;
				reqbits &= (~(NTREQ_IRLEN));
				break;
			case NTAP_OPT_IRMASK:
zwelch's avatar
zwelch committed
303
304
305
306
307
				if (is_bad_irval(pTap->ir_length, w)) {
					LOG_ERROR("IR mask %x too big",
							(int) w);
					return ERROR_FAIL;
				}
308
309
310
311
				pTap->ir_capture_mask = w;
				reqbits &= (~(NTREQ_IRMASK));
				break;
			case NTAP_OPT_IRCAPTURE:
zwelch's avatar
zwelch committed
312
313
314
315
316
				if (is_bad_irval(pTap->ir_length, w)) {
					LOG_ERROR("IR capture %x too big",
							(int) w);
					return ERROR_FAIL;
				}
317
318
319
320
				pTap->ir_capture_value = w;
				reqbits &= (~(NTREQ_IRCAPTURE));
				break;
			}
zwelch's avatar
zwelch committed
321
		} /* switch (n->value) */
322
	} /* while (goi->argc) */
323

zwelch's avatar
zwelch committed
324
325
326
	/* default is enabled-after-reset */
	pTap->enabled = !pTap->disabled_after_reset;

327
328
329
330
331
	/* Did all the required option bits get cleared? */
	if (0 == reqbits)
	{
		jtag_tap_init(pTap);
		return ERROR_OK;
332
333
	}

334
335
336
	Jim_SetResult_sprintf(goi->interp,
			"newtap: %s missing required parameters",
			pTap->dotted_name);
337
	jtag_tap_free(pTap);
338
339
	return JIM_ERR;
}
340

zwelch's avatar
zwelch committed
341
static void jtag_tap_handle_event(jtag_tap_t *tap, enum jtag_event e)
342
343
344
345
346
347
348
349
350
351
{
	jtag_tap_event_action_t * jteap;
	int done;

	jteap = tap->event_action;

	done = 0;
	while (jteap) {
		if (jteap->event == e) {
			done = 1;
352
			LOG_DEBUG("JTAG tap: %s event: %d (%s) action: %s\n",
353
354
355
					tap->dotted_name,
					e,
					Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
356
					Jim_GetString(jteap->body, NULL));
357
358
			if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
				Jim_PrintErrorMessage(interp);
zwelch's avatar
zwelch committed
359
360
361
362
363
364
			} else {
				/* NOTE:  we currently assume the handlers
				 * can't fail.  That presumes later code
				 * will be verifying the scan chains ...
				 */
				tap->enabled = (e == JTAG_TAP_EVENT_ENABLE);
365
366
367
368
369
370
371
			}
		}

		jteap = jteap->next;
	}

	if (!done) {
372
		LOG_DEBUG("event %d %s - no action",
373
				e,
374
				Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name);
375
376
377
378
	}
}


379
static int jim_jtag_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
380
381
382
383
{
	Jim_GetOptInfo goi;
	int e;
	Jim_Nvp *n;
384
	Jim_Obj *o;
385
386
387
388
389
	struct command_context_s *context;

	enum {
		JTAG_CMD_INTERFACE,
		JTAG_CMD_INIT_RESET,
390
391
392
		JTAG_CMD_NEWTAP,
		JTAG_CMD_TAPENABLE,
		JTAG_CMD_TAPDISABLE,
393
394
		JTAG_CMD_TAPISENABLED,
		JTAG_CMD_CONFIGURE,
zwelch's avatar
zwelch committed
395
396
		JTAG_CMD_CGET,
		JTAG_CMD_NAMES,
397
	};
398

399
400
401
	const Jim_Nvp jtag_cmds[] = {
		{ .name = "interface"     , .value = JTAG_CMD_INTERFACE },
		{ .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
402
403
404
405
		{ .name = "newtap"        , .value = JTAG_CMD_NEWTAP },
		{ .name = "tapisenabled"     , .value = JTAG_CMD_TAPISENABLED },
		{ .name = "tapenable"     , .value = JTAG_CMD_TAPENABLE },
		{ .name = "tapdisable"    , .value = JTAG_CMD_TAPDISABLE },
406
407
		{ .name = "configure"     , .value = JTAG_CMD_CONFIGURE },
		{ .name = "cget"          , .value = JTAG_CMD_CGET },
zwelch's avatar
zwelch committed
408
		{ .name = "names"         , .value = JTAG_CMD_NAMES },
409

410
411
412
413
		{ .name = NULL, .value = -1 },
	};

	context = Jim_GetAssocData(interp, "context");
414
	/* go past the command */
415
	Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
416

417
	e = Jim_GetOpt_Nvp(&goi, jtag_cmds, &n);
zwelch's avatar
zwelch committed
418
	if (e != JIM_OK) {
419
		Jim_GetOpt_NvpUnknown(&goi, jtag_cmds, 0);
420
421
		return e;
	}
422
		Jim_SetEmptyResult(goi.interp);
zwelch's avatar
zwelch committed
423
	switch (n->value) {
424
	case JTAG_CMD_INTERFACE:
425
426
427
		/* return the name of the interface */
		/* TCL code might need to know the exact type... */
		/* FUTURE: we allow this as a means to "set" the interface. */
zwelch's avatar
zwelch committed
428
		if (goi.argc != 0) {
429
			Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
430
431
			return JIM_ERR;
		}
432
		Jim_SetResultString(goi.interp, jtag_interface->name, -1);
433
434
		return JIM_OK;
	case JTAG_CMD_INIT_RESET:
zwelch's avatar
zwelch committed
435
		if (goi.argc != 0) {
436
			Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
437
438
439
			return JIM_ERR;
		}
		e = jtag_init_reset(context);
zwelch's avatar
zwelch committed
440
		if (e != ERROR_OK) {
441
			Jim_SetResult_sprintf(goi.interp, "error: %d", e);
442
443
444
			return JIM_ERR;
		}
		return JIM_OK;
445
	case JTAG_CMD_NEWTAP:
446
		return jim_newtap_cmd(&goi);
447
448
449
450
		break;
	case JTAG_CMD_TAPISENABLED:
	case JTAG_CMD_TAPENABLE:
	case JTAG_CMD_TAPDISABLE:
zwelch's avatar
zwelch committed
451
		if (goi.argc != 1) {
452
			Jim_SetResultString(goi.interp, "Too many parameters",-1);
453
454
			return JIM_ERR;
		}
oharboe's avatar
oharboe committed
455
456

		{
457
			jtag_tap_t *t;
zwelch's avatar
zwelch committed
458
459
460

			t = jtag_tap_by_jim_obj(goi.interp, goi.argv[0]);
			if (t == NULL)
461
				return JIM_ERR;
zwelch's avatar
zwelch committed
462
463

			switch (n->value) {
464
465
466
			case JTAG_CMD_TAPISENABLED:
				break;
			case JTAG_CMD_TAPENABLE:
zwelch's avatar
zwelch committed
467
468
469
470
471
472
473
474
475
476
				if (t->enabled)
					break;
				jtag_tap_handle_event(t, JTAG_TAP_EVENT_ENABLE);
				if (!t->enabled)
					break;

				/* FIXME add JTAG sanity checks, w/o TLR
				 *  - scan chain length grew by one (this)
				 *  - IDs and IR lengths are as expected
				 */
zwelch's avatar
zwelch committed
477
478

				jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE);
479
480
				break;
			case JTAG_CMD_TAPDISABLE:
zwelch's avatar
zwelch committed
481
482
483
484
485
486
487
488
489
490
				if (!t->enabled)
					break;
				jtag_tap_handle_event(t, JTAG_TAP_EVENT_DISABLE);
				if (t->enabled)
					break;

				/* FIXME add JTAG sanity checks, w/o TLR
				 *  - scan chain length shrank by one (this)
				 *  - IDs and IR lengths are as expected
				 */
zwelch's avatar
zwelch committed
491
492

				jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE);
493
494
				break;
			}
zwelch's avatar
zwelch committed
495
496
			e = t->enabled;
			Jim_SetResult(goi.interp, Jim_NewIntObj(goi.interp, e));
497
498
			return JIM_OK;
		}
499
500
501
		break;

	case JTAG_CMD_CGET:
zwelch's avatar
zwelch committed
502
		if (goi.argc < 2) {
zwelch's avatar
zwelch committed
503
504
			Jim_WrongNumArgs(goi.interp, 0, NULL,
					"cget tap_name queryparm");
505
506
507
508
509
510
511
			return JIM_ERR;
		}

		{
			jtag_tap_t *t;

			Jim_GetOpt_Obj(&goi, &o);
512
			t = jtag_tap_by_jim_obj(goi.interp, o);
zwelch's avatar
zwelch committed
513
			if (t == NULL) {
514
515
516
517
				return JIM_ERR;
			}

			goi.isconfigure = 0;
518
			return jtag_tap_configure_cmd(&goi, t);
519
520
521
522
		}
		break;

	case JTAG_CMD_CONFIGURE:
zwelch's avatar
zwelch committed
523
		if (goi.argc < 3) {
zwelch's avatar
zwelch committed
524
525
			Jim_WrongNumArgs(goi.interp, 0, NULL,
					"configure tap_name attribute value ...");
526
527
528
529
530
531
532
			return JIM_ERR;
		}

		{
			jtag_tap_t *t;

			Jim_GetOpt_Obj(&goi, &o);
533
			t = jtag_tap_by_jim_obj(goi.interp, o);
zwelch's avatar
zwelch committed
534
			if (t == NULL) {
535
536
537
538
				return JIM_ERR;
			}

			goi.isconfigure = 1;
539
			return jtag_tap_configure_cmd(&goi, t);
540
		}
zwelch's avatar
zwelch committed
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
		break;

	case JTAG_CMD_NAMES:
		if (goi.argc != 0) {
			Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters");
			return JIM_ERR;
		}
		Jim_SetResult(goi.interp, Jim_NewListObj(goi.interp, NULL, 0));
		{
			jtag_tap_t *tap;

			for (tap = jtag_all_taps(); tap; tap = tap->next_tap) {
				Jim_ListAppendElement(goi.interp,
					Jim_GetResult(goi.interp),
					Jim_NewStringObj(goi.interp,
						tap->dotted_name, -1));
			}
			return JIM_OK;
		}
		break;

562
	}
563

564
565
566
	return JIM_ERR;
}

567
568
int jtag_register_commands(struct command_context_s *cmd_ctx)
{
569
	register_jim(cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
570

571
	register_command(cmd_ctx, NULL, "interface", handle_interface_command,
oharboe's avatar
oharboe committed
572
		COMMAND_CONFIG, "try to configure interface");
573
574
575
	register_command(cmd_ctx, NULL,
		"interface_list", &handle_interface_list_command,
		COMMAND_ANY, "list all built-in interfaces");
576
	register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
zwelch's avatar
zwelch committed
577
		COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
578
	register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
zwelch's avatar
zwelch committed
579
580
		COMMAND_ANY, "set maximum jtag speed (if supported); "
		"parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
581
582
	register_command(cmd_ctx, NULL, "jtag_rclk", handle_jtag_rclk_command,
		COMMAND_ANY, "fallback_speed_khz - set JTAG speed to RCLK or use fallback speed");
583
	register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
zwelch's avatar
zwelch committed
584
		COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
585
	register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
586
587
		COMMAND_ANY,
		"[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
588
	register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
589
		COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
590
	register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
591
		COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
592

593
594
595
596
597
598
599
600
601
	register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
		COMMAND_EXEC, "print current scan chain configuration");

	register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
		COMMAND_EXEC, "toggle reset lines <trst> <srst>");
	register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
		COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
	register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
		COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
602
	register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
603
	register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
oharboe's avatar
oharboe committed
604
	register_jim(cmd_ctx, "pathmove", Jim_Command_pathmove, "move JTAG to state1 then to state2, state3, etc. <state1>,<state2>,<stat3>...");
605
606

	register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
zwelch's avatar
zwelch committed
607
		COMMAND_ANY, "verify value captured during Capture-IR <enable | disable>");
oharboe's avatar
oharboe committed
608
	register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
zwelch's avatar
zwelch committed
609
		COMMAND_ANY, "verify value capture <enable | disable>");
610
	register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
zwelch's avatar
zwelch committed
611
		COMMAND_ANY, "choose short(default) or long tms_sequence <short | long>");
612
613
614
	return ERROR_OK;
}

615
616
static int default_khz(int khz, int *jtag_speed)
{
617
	LOG_ERROR("Translation from khz to jtag_speed not implemented");
618
619
620
	return ERROR_FAIL;
}

oharboe's avatar
oharboe committed
621
static int default_speed_div(int speed, int *khz)
622
{
623
	LOG_ERROR("Translation from jtag_speed to khz not implemented");
624
625
626
627
628
	return ERROR_FAIL;
}

static int default_power_dropout(int *dropout)
{
zwelch's avatar
zwelch committed
629
	*dropout = 0; /* by default we can't detect power dropout */
630
631
632
633
634
	return ERROR_OK;
}

static int default_srst_asserted(int *srst_asserted)
{
zwelch's avatar
zwelch committed
635
	*srst_asserted = 0; /* by default we can't detect srst asserted */
636
	return ERROR_OK;
637
638
}

639
640
static int handle_interface_command(struct command_context_s *cmd_ctx,
		char *cmd, char **args, int argc)
641
642
643
644
{
	/* check whether the interface is already configured */
	if (jtag_interface)
	{
645
		LOG_WARNING("Interface already configured, ignoring");
646
647
648
649
		return ERROR_OK;
	}

	/* interface name is a mandatory argument */
650
	if (argc != 1 || args[0][0] == '\0')
651
652
		return ERROR_COMMAND_SYNTAX_ERROR;

653
	for (unsigned i = 0; NULL != jtag_interfaces[i]; i++)
654
	{
655
656
657
658
659
		if (strcmp(args[0], jtag_interfaces[i]->name) != 0)
			continue;

		int retval = jtag_interfaces[i]->register_commands(cmd_ctx);
		if (ERROR_OK != retval)
660
				return retval;
661

662
		jtag_interface = jtag_interfaces[i];
663

664
665
666
667
668
669
670
671
		if (jtag_interface->khz == NULL)
			jtag_interface->khz = default_khz;
		if (jtag_interface->speed_div == NULL)
			jtag_interface->speed_div = default_speed_div;
		if (jtag_interface->power_dropout == NULL)
			jtag_interface->power_dropout = default_power_dropout;
		if (jtag_interface->srst_asserted == NULL)
			jtag_interface->srst_asserted = default_srst_asserted;
672

673
		return ERROR_OK;
674
675
676
677
678
	}

	/* no valid interface was found (i.e. the configuration option,
	 * didn't match one of the compiled-in interfaces
	 */
679
	LOG_ERROR("The specified JTAG interface was not found (%s)", args[0]);
680
681
682
683
684
685
686
687
688
689
690
	handle_interface_list_command(cmd_ctx, cmd, args, argc);
	return ERROR_JTAG_INVALID_INTERFACE;
}

static int handle_interface_list_command(struct command_context_s *cmd_ctx,
		char *cmd, char **args, int argc)
{
	if (strcmp(cmd, "interface_list") == 0 && argc > 0)
		return ERROR_COMMAND_SYNTAX_ERROR;

	command_print(cmd_ctx, "The following JTAG interfaces are available:");
691
	for (unsigned i = 0; NULL != jtag_interfaces[i]; i++)
692
693
694
695
	{
		const char *name = jtag_interfaces[i]->name;
		command_print(cmd_ctx, "%u: %s", i + 1, name);
	}
696

697
	return ERROR_OK;
698
699
}

700
static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
701
{
702
703
704
	int e;
	char buf[1024];
	Jim_Obj *newargs[ 10 ];
705
706
707
708
709
710
711
712
	/*
	 * CONVERT SYNTAX
	 * argv[-1] = command
	 * argv[ 0] = ir length
	 * argv[ 1] = ir capture
	 * argv[ 2] = ir mask
	 * argv[ 3] = not actually used by anything but in the docs
	 */
oharboe's avatar
oharboe committed
713

zwelch's avatar
zwelch committed
714
	if (argc < 4) {
715
		command_print(cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
716
		return ERROR_OK;
717
	}
718
719
	command_print(cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
	command_print(cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
720
721
				   args[0],
				   args[1],
722
				   args[2]);
723
724
725
726
727
	command_print(cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
	command_print(cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
	command_print(cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
	command_print(cmd_ctx, "And then refer to the taps by the dotted name.");

728
729
730
731
732
733
734
735
736
737
738
739
	newargs[0] = Jim_NewStringObj(interp, "jtag", -1);
	newargs[1] = Jim_NewStringObj(interp, "newtap", -1);
	sprintf(buf, "chip%d", jtag_tap_count());
	newargs[2] = Jim_NewStringObj(interp, buf, -1);
	sprintf(buf, "tap%d", jtag_tap_count());
	newargs[3] = Jim_NewStringObj(interp, buf, -1);
	newargs[4] = Jim_NewStringObj(interp, "-irlen", -1);
	newargs[5] = Jim_NewStringObj(interp, args[0], -1);
	newargs[6] = Jim_NewStringObj(interp, "-ircapture", -1);
	newargs[7] = Jim_NewStringObj(interp, args[1], -1);
	newargs[8] = Jim_NewStringObj(interp, "-irmask", -1);
	newargs[9] = Jim_NewStringObj(interp, args[2], -1);
740
741
742

	command_print(cmd_ctx, "NEW COMMAND:");
	sprintf(buf, "%s %s %s %s %s %s %s %s %s %s",
743
744
745
746
747
748
749
750
751
752
753
754
			 Jim_GetString(newargs[0], NULL),
			 Jim_GetString(newargs[1], NULL),
			 Jim_GetString(newargs[2], NULL),
			 Jim_GetString(newargs[3], NULL),
			 Jim_GetString(newargs[4], NULL),
			 Jim_GetString(newargs[5], NULL),
			 Jim_GetString(newargs[6], NULL),
			 Jim_GetString(newargs[7], NULL),
			 Jim_GetString(newargs[8], NULL),
			 Jim_GetString(newargs[9], NULL));

	e = jim_jtag_command(interp, 10, newargs);
zwelch's avatar
zwelch committed
755
	if (e != JIM_OK) {
756
		command_print(cmd_ctx, "%s", Jim_GetString(Jim_GetResult(interp), NULL));
757
758
	}
	return e;
759
760
}

761
static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
762
{
763
	jtag_tap_t *tap;
764

765
	tap = jtag_all_taps();
766
767
768
	command_print(cmd_ctx, "     TapName            | Enabled |   IdCode      Expected    IrLen IrCap  IrMask Instr     ");
	command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");

zwelch's avatar
zwelch committed
769
	while (tap) {
770
		uint32_t expected, expected_mask, cur_instr, ii;
771
772
773
		expected = buf_get_u32(tap->expected, 0, tap->ir_length);
		expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
		cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
774

775
776
777
778
779
		command_print(cmd_ctx,
					  "%2d | %-18s |    %c    | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
					  tap->abs_chain_position,
					  tap->dotted_name,
					  tap->enabled ? 'Y' : 'n',
780
781
782
783
784
785
					  (unsigned int)(tap->idcode),
					  (unsigned int)(tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
					  (unsigned int)(tap->ir_length),
					  (unsigned int)(expected),
					  (unsigned int)(expected_mask),
					  (unsigned int)(cur_instr));
786
787
788

		for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
			command_print(cmd_ctx, "   |                    |         |            | 0x%08x |      |      |      |         ",
789
						  (unsigned int)(tap->expected_ids[ii]));
790
791
		}

792
		tap = tap->next_tap;
793
794
795
796
797
	}

	return ERROR_OK;
}

798
static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
799
{
zwelch's avatar
zwelch committed
800
801
802
	int new_cfg = 0;
	int mask = 0;

803
804
	if (argc < 1)
		return ERROR_COMMAND_SYNTAX_ERROR;
805

zwelch's avatar
zwelch committed
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
	/* Original versions cared about the order of these tokens:
	 *   reset_config signals [combination [trst_type [srst_type]]]
	 * They also clobbered the previous configuration even on error.
	 *
	 * Here we don't care about the order, and only change values
	 * which have been explicitly specified.
	 */
	for (; argc; argc--, args++) {
		int tmp = 0;
		int m;

		/* signals */
		m = RESET_HAS_TRST | RESET_HAS_SRST;
		if (strcmp(*args, "none") == 0)
			tmp = RESET_NONE;
		else if (strcmp(*args, "trst_only") == 0)
			tmp = RESET_HAS_TRST;
		else if (strcmp(*args, "srst_only") == 0)
			tmp = RESET_HAS_SRST;
		else if (strcmp(*args, "trst_and_srst") == 0)
			tmp = RESET_HAS_TRST | RESET_HAS_SRST;
827
		else
zwelch's avatar
zwelch committed
828
829
830
831
			m = 0;
		if (mask & m) {
			LOG_ERROR("extra reset_config %s spec (%s)",
					"signal", *args);
832
833
			return ERROR_INVALID_ARGUMENTS;
		}
zwelch's avatar
zwelch committed
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
		if (m)
			goto next;

		/* combination (options for broken wiring) */
		m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
		if (strcmp(*args, "separate") == 0)
			/* separate reset lines - default */;
		else if (strcmp(*args, "srst_pulls_trst") == 0)
			tmp |= RESET_SRST_PULLS_TRST;
		else if (strcmp(*args, "trst_pulls_srst") == 0)
			tmp |= RESET_TRST_PULLS_SRST;
		else if (strcmp(*args, "combined") == 0)
			tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
		else
			m = 0;
		if (mask & m) {
			LOG_ERROR("extra reset_config %s spec (%s)",
					"combination", *args);
			return ERROR_INVALID_ARGUMENTS;
853
		}
zwelch's avatar
zwelch committed
854
855
856
857
858
859
860
861
862
		if (m)
			goto next;

		/* trst_type (NOP without HAS_TRST) */
		m = RESET_TRST_OPEN_DRAIN;
		if (strcmp(*args, "trst_open_drain") == 0)
			tmp |= RESET_TRST_OPEN_DRAIN;
		else if (strcmp(*args, "trst_push_pull") == 0)
			/* push/pull from adapter - default */;
863
		else
zwelch's avatar
zwelch committed
864
865
866
867
			m = 0;
		if (mask & m) {
			LOG_ERROR("extra reset_config %s spec (%s)",
					"trst_type", *args);
868
869
			return ERROR_INVALID_ARGUMENTS;
		}
zwelch's avatar
zwelch committed
870
871
872
873
874
875
876
877
878
		if (m)
			goto next;

		/* srst_type (NOP without HAS_SRST) */
		m |= RESET_SRST_PUSH_PULL;
		if (strcmp(*args, "srst_push_pull") == 0)
			tmp |= RESET_SRST_PUSH_PULL;
		else if (strcmp(*args, "srst_open_drain") == 0)
			/* open drain from adapter - default */;
879
		else
zwelch's avatar
zwelch committed
880
881
882
883
			m = 0;
		if (mask & m) {
			LOG_ERROR("extra reset_config %s spec (%s)",
					"srst_type", *args);
884
885
			return ERROR_INVALID_ARGUMENTS;
		}
zwelch's avatar
zwelch committed
886
887
888
889
890
891
892
893
894
895
896
897
898
		if (m)
			goto next;

		/* caller provided nonsense; fail */
		LOG_ERROR("unknown reset_config flag (%s)", *args);
		return ERROR_INVALID_ARGUMENTS;

next:
		/* Remember the bits which were specified (mask)
		 * and their new values (new_cfg).
		 */
		mask |= m;
		new_cfg |= tmp;
899
	}
900

zwelch's avatar
zwelch committed
901
	/* clear previous values of those bits, save new values */
902
903
904
905
	enum reset_types old_cfg = jtag_get_reset_config();
	old_cfg &= ~mask;
	new_cfg |= old_cfg;
	jtag_set_reset_config(new_cfg);
zwelch's avatar
zwelch committed
906

907
908
909
	return ERROR_OK;
}

910
911
static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx,
		char *cmd, char **args, int argc)
912
{
913
	if (argc > 1)
914
		return ERROR_COMMAND_SYNTAX_ERROR;
915
	if (argc == 1)
916
917
918
919
920
921
922
	{
		unsigned delay;
		int retval = parse_uint(args[0], &delay);
		if (ERROR_OK != retval)
			return retval;
		jtag_set_nsrst_delay(delay);
	}
923
	command_print(cmd_ctx, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
924
925
926
	return ERROR_OK;
}

927
928
static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx,
		char *cmd, char **args, int argc)
929
{
930
	if (argc > 1)
931
		return ERROR_COMMAND_SYNTAX_ERROR;
932
	if (argc == 1)
933
934
935
936
937
938
939
	{
		unsigned delay;
		int retval = parse_uint(args[0], &delay);
		if (ERROR_OK != retval)
			return retval;
		jtag_set_ntrst_delay(delay);
	}
940
	command_print(cmd_ctx, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
941
942
943
	return ERROR_OK;
}

944
static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
945
{
946
	int retval = ERROR_OK;
947

948
949
950
	command_print(cmd_ctx, "OLD SYNTAX: DEPRECATED - "
			"use jtag_khz, not jtag_speed");

951
952
	if (argc > 1)
		return ERROR_COMMAND_SYNTAX_ERROR;
oharboe's avatar
   
oharboe committed
953
	if (argc == 1)
oharboe's avatar
oharboe committed
954
955
	{
		LOG_DEBUG("handle jtag speed");
oharboe's avatar
   
oharboe committed
956

957
958
959
960
		unsigned cur_speed = 0;
		int retval = parse_uint(args[0], &cur_speed);
		if (ERROR_OK != retval)
			return retval;
961
		retval = jtag_config_speed(cur_speed);
962

oharboe's avatar
   
oharboe committed
963
	}
964
	command_print(cmd_ctx, "jtag_speed: %d", jtag_get_speed());
965

oharboe's avatar
   
oharboe committed
966
	return retval;
967
968
}

969
static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
970
{
971
972
	if (argc > 1)
		return ERROR_COMMAND_SYNTAX_ERROR;
973

974
975
	int retval = ERROR_OK;
	if (argc == 1)
oharboe's avatar
   
oharboe committed
976
	{
977
978
979
980
981
		unsigned khz = 0;
		int retval = parse_uint(args[0], &khz);
		if (ERROR_OK != retval)
			return retval;
		retval = jtag_config_khz(khz);
982
		if (ERROR_OK != retval)
983
			return retval;
oharboe's avatar
   
oharboe committed
984
	}
985

986
	int cur_speed = jtag_get_speed_khz();
987
988
989
990
	retval = jtag_get_speed_readable(&cur_speed);
	if (ERROR_OK != retval)
		return retval;

991
992
993
	if (cur_speed)
		command_print(cmd_ctx, "%d kHz", cur_speed);
	else
994
		command_print(cmd_ctx, "RCLK - adaptive");
oharboe's avatar
   
oharboe committed
995

996
	return retval;
997
998
}

999
1000
static int handle_jtag_rclk_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
For faster browsing, not all history is shown. View entire blame