1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
29 ***************************************************************************/
37 #include "minidriver.h"
38 #include "interface.h"
39 #include "interfaces.h"
46 #include <helper/time_support.h>
50 * Holds support for accessing JTAG-specific mechanisms from TCl scripts.
53 static const Jim_Nvp nvp_jtag_tap_event
[] = {
54 { .value
= JTAG_TRST_ASSERTED
, .name
= "post-reset" },
55 { .value
= JTAG_TAP_EVENT_SETUP
, .name
= "setup" },
56 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
57 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
59 { .name
= NULL
, .value
= -1 }
62 extern struct jtag_interface
*jtag_interface
;
64 struct jtag_tap
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
66 const char *cp
= Jim_GetString(o
, NULL
);
67 struct jtag_tap
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
71 Jim_SetResultFormatted(interp
, "Tap '%s' could not be found", cp
);
75 static bool scan_is_safe(tap_state_t state
)
88 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
91 struct scan_field
*fields
;
100 * args[3] = hex string
101 * ... repeat num bits and hex string ...
104 * args[N-2] = "-endstate"
105 * args[N-1] = statename
107 if ((argc
< 4) || ((argc
% 2) != 0)) {
108 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
114 script_debug(interp
, "drscan", argc
, args
);
116 /* validate arguments as numbers */
118 for (i
= 2; i
< argc
; i
+= 2) {
122 e
= Jim_GetLong(interp
, args
[i
], &bits
);
123 /* If valid - try next arg */
127 /* Not valid.. are we at the end? */
128 if (((i
+ 2) != argc
)) {
129 /* nope, then error */
133 /* it could be: "-endstate FOO"
134 * e.g. DRPAUSE so we can issue more instructions
135 * before entering RUN/IDLE and executing them.
138 /* get arg as a string. */
139 cp
= Jim_GetString(args
[i
], NULL
);
140 /* is it the magic? */
141 if (0 == strcmp("-endstate", cp
)) {
142 /* is the statename valid? */
143 cp
= Jim_GetString(args
[i
+ 1], NULL
);
145 /* see if it is a valid state name */
146 endstate
= tap_state_by_name(cp
);
148 /* update the error message */
149 Jim_SetResultFormatted(interp
, "endstate: %s invalid", cp
);
151 if (!scan_is_safe(endstate
))
152 LOG_WARNING("drscan with unsafe "
153 "endstate \"%s\"", cp
);
155 /* valid - so clear the error */
157 /* and remove the last 2 args */
162 /* Still an error? */
164 return e
; /* too bad */
165 } /* validate args */
169 tap
= jtag_tap_by_jim_obj(interp
, args
[1]);
173 num_fields
= (argc
-2)/2;
174 assert(num_fields
> 0);
175 fields
= malloc(sizeof(struct scan_field
) * num_fields
);
176 for (i
= 2; i
< argc
; i
+= 2) {
181 Jim_GetLong(interp
, args
[i
], &bits
);
182 str
= Jim_GetString(args
[i
+ 1], &len
);
184 fields
[field_count
].num_bits
= bits
;
185 void *t
= malloc(DIV_ROUND_UP(bits
, 8));
186 fields
[field_count
].out_value
= t
;
187 str_to_buf(str
, len
, t
, bits
, 0);
188 fields
[field_count
].in_value
= t
;
192 jtag_add_dr_scan(tap
, num_fields
, fields
, endstate
);
194 retval
= jtag_execute_queue();
195 if (retval
!= ERROR_OK
) {
196 Jim_SetResultString(interp
, "drscan: jtag execute failed", -1);
201 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
202 for (i
= 2; i
< argc
; i
+= 2) {
206 Jim_GetLong(interp
, args
[i
], &bits
);
207 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
208 free((void *)fields
[field_count
].out_value
);
210 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
215 Jim_SetResult(interp
, list
);
223 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
225 tap_state_t states
[8];
227 if ((argc
< 2) || ((size_t)argc
> (ARRAY_SIZE(states
) + 1))) {
228 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
232 script_debug(interp
, "pathmove", argc
, args
);
235 for (i
= 0; i
< argc
-1; i
++) {
237 cp
= Jim_GetString(args
[i
+ 1], NULL
);
238 states
[i
] = tap_state_by_name(cp
);
240 /* update the error message */
241 Jim_SetResultFormatted(interp
, "endstate: %s invalid", cp
);
246 if ((jtag_add_statemove(states
[0]) != ERROR_OK
) || (jtag_execute_queue() != ERROR_OK
)) {
247 Jim_SetResultString(interp
, "pathmove: jtag execute failed", -1);
251 jtag_add_pathmove(argc
- 2, states
+ 1);
253 if (jtag_execute_queue() != ERROR_OK
) {
254 Jim_SetResultString(interp
, "pathmove: failed", -1);
262 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
264 script_debug(interp
, "flush_count", argc
, args
);
266 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
271 /* REVISIT Just what about these should "move" ... ?
272 * These registrations, into the main JTAG table?
274 * There's a minor compatibility issue, these all show up twice;
275 * that's not desirable:
276 * - jtag drscan ... NOT DOCUMENTED!
279 * The "irscan" command (for example) doesn't show twice.
281 static const struct command_registration jtag_command_handlers_to_move
[] = {
284 .mode
= COMMAND_EXEC
,
285 .jim_handler
= Jim_Command_drscan
,
286 .help
= "Execute Data Register (DR) scan for one TAP. "
287 "Other TAPs must be in BYPASS mode.",
288 .usage
= "tap_name [num_bits value]* ['-endstate' state_name]",
291 .name
= "flush_count",
292 .mode
= COMMAND_EXEC
,
293 .jim_handler
= Jim_Command_flush_count
,
294 .help
= "Returns the number of times the JTAG queue "
299 .mode
= COMMAND_EXEC
,
300 .jim_handler
= Jim_Command_pathmove
,
301 .usage
= "start_state state1 [state2 [state3 ...]]",
302 .help
= "Move JTAG state machine from current state "
303 "(start_state) to state1, then state2, state3, etc.",
305 COMMAND_REGISTRATION_DONE
309 enum jtag_tap_cfg_param
{
313 static Jim_Nvp nvp_config_opts
[] = {
314 { .name
= "-event", .value
= JCFG_EVENT
},
316 { .name
= NULL
, .value
= -1 }
319 static int jtag_tap_configure_event(Jim_GetOptInfo
*goi
, struct jtag_tap
*tap
)
321 if (goi
->argc
== 0) {
322 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name> ...");
327 int e
= Jim_GetOpt_Nvp(goi
, nvp_jtag_tap_event
, &n
);
329 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
333 if (goi
->isconfigure
) {
334 if (goi
->argc
!= 1) {
335 Jim_WrongNumArgs(goi
->interp
,
338 "-event <event-name> <event-body>");
342 if (goi
->argc
!= 0) {
343 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name>");
348 struct jtag_tap_event_action
*jteap
= tap
->event_action
;
349 /* replace existing event body */
352 if (jteap
->event
== (enum jtag_event
)n
->value
) {
359 Jim_SetEmptyResult(goi
->interp
);
361 if (goi
->isconfigure
) {
363 jteap
= calloc(1, sizeof(*jteap
));
364 else if (NULL
!= jteap
->body
)
365 Jim_DecrRefCount(goi
->interp
, jteap
->body
);
367 jteap
->interp
= goi
->interp
;
368 jteap
->event
= n
->value
;
371 Jim_GetOpt_Obj(goi
, &o
);
372 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
373 Jim_IncrRefCount(jteap
->body
);
376 /* add to head of event list */
377 jteap
->next
= tap
->event_action
;
378 tap
->event_action
= jteap
;
381 jteap
->interp
= goi
->interp
;
382 Jim_SetResult(goi
->interp
,
383 Jim_DuplicateObj(goi
->interp
, jteap
->body
));
388 static int jtag_tap_configure_cmd(Jim_GetOptInfo
*goi
, struct jtag_tap
*tap
)
390 /* parse config or cget options */
391 while (goi
->argc
> 0) {
392 Jim_SetEmptyResult(goi
->interp
);
395 int e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
397 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
403 e
= jtag_tap_configure_event(goi
, tap
);
408 Jim_SetResultFormatted(goi
->interp
, "unknown event: %s", n
->name
);
416 static int is_bad_irval(int ir_length
, jim_wide w
)
426 static int jim_newtap_expected_id(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
427 struct jtag_tap
*pTap
)
430 int e
= Jim_GetOpt_Wide(goi
, &w
);
432 Jim_SetResultFormatted(goi
->interp
, "option: %s bad parameter", n
->name
);
436 unsigned expected_len
= sizeof(uint32_t) * pTap
->expected_ids_cnt
;
437 uint32_t *new_expected_ids
= malloc(expected_len
+ sizeof(uint32_t));
438 if (new_expected_ids
== NULL
) {
439 Jim_SetResultFormatted(goi
->interp
, "no memory");
443 memcpy(new_expected_ids
, pTap
->expected_ids
, expected_len
);
445 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
447 free(pTap
->expected_ids
);
448 pTap
->expected_ids
= new_expected_ids
;
449 pTap
->expected_ids_cnt
++;
454 #define NTAP_OPT_IRLEN 0
455 #define NTAP_OPT_IRMASK 1
456 #define NTAP_OPT_IRCAPTURE 2
457 #define NTAP_OPT_ENABLED 3
458 #define NTAP_OPT_DISABLED 4
459 #define NTAP_OPT_EXPECTED_ID 5
460 #define NTAP_OPT_VERSION 6
462 static int jim_newtap_ir_param(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
463 struct jtag_tap
*pTap
)
466 int e
= Jim_GetOpt_Wide(goi
, &w
);
468 Jim_SetResultFormatted(goi
->interp
,
469 "option: %s bad parameter", n
->name
);
474 if (w
> (jim_wide
) (8 * sizeof(pTap
->ir_capture_value
))) {
475 LOG_WARNING("%s: huge IR length %d",
476 pTap
->dotted_name
, (int) w
);
480 case NTAP_OPT_IRMASK
:
481 if (is_bad_irval(pTap
->ir_length
, w
)) {
482 LOG_ERROR("%s: IR mask %x too big",
488 LOG_WARNING("%s: nonstandard IR mask", pTap
->dotted_name
);
489 pTap
->ir_capture_mask
= w
;
491 case NTAP_OPT_IRCAPTURE
:
492 if (is_bad_irval(pTap
->ir_length
, w
)) {
493 LOG_ERROR("%s: IR capture %x too big",
494 pTap
->dotted_name
, (int) w
);
498 LOG_WARNING("%s: nonstandard IR value",
500 pTap
->ir_capture_value
= w
;
508 static int jim_newtap_cmd(Jim_GetOptInfo
*goi
)
510 struct jtag_tap
*pTap
;
515 const Jim_Nvp opts
[] = {
516 { .name
= "-irlen", .value
= NTAP_OPT_IRLEN
},
517 { .name
= "-irmask", .value
= NTAP_OPT_IRMASK
},
518 { .name
= "-ircapture", .value
= NTAP_OPT_IRCAPTURE
},
519 { .name
= "-enable", .value
= NTAP_OPT_ENABLED
},
520 { .name
= "-disable", .value
= NTAP_OPT_DISABLED
},
521 { .name
= "-expected-id", .value
= NTAP_OPT_EXPECTED_ID
},
522 { .name
= "-ignore-version", .value
= NTAP_OPT_VERSION
},
523 { .name
= NULL
, .value
= -1 },
526 pTap
= calloc(1, sizeof(struct jtag_tap
));
528 Jim_SetResultFormatted(goi
->interp
, "no memory");
533 * we expect CHIP + TAP + OPTIONS
536 Jim_SetResultFormatted(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
540 Jim_GetOpt_String(goi
, &cp
, NULL
);
541 pTap
->chip
= strdup(cp
);
543 Jim_GetOpt_String(goi
, &cp
, NULL
);
544 pTap
->tapname
= strdup(cp
);
546 /* name + dot + name + null */
547 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
549 sprintf(cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
550 pTap
->dotted_name
= cp
;
552 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
553 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
555 /* IEEE specifies that the two LSBs of an IR scan are 01, so make
556 * that the default. The "-irlen" and "-irmask" options are only
557 * needed to cope with nonstandard TAPs, or to specify more bits.
559 pTap
->ir_capture_mask
= 0x03;
560 pTap
->ir_capture_value
= 0x01;
563 e
= Jim_GetOpt_Nvp(goi
, opts
, &n
);
565 Jim_GetOpt_NvpUnknown(goi
, opts
, 0);
566 free((void *)pTap
->dotted_name
);
570 LOG_DEBUG("Processing option: %s", n
->name
);
572 case NTAP_OPT_ENABLED
:
573 pTap
->disabled_after_reset
= false;
575 case NTAP_OPT_DISABLED
:
576 pTap
->disabled_after_reset
= true;
578 case NTAP_OPT_EXPECTED_ID
:
579 e
= jim_newtap_expected_id(n
, goi
, pTap
);
581 free((void *)pTap
->dotted_name
);
587 case NTAP_OPT_IRMASK
:
588 case NTAP_OPT_IRCAPTURE
:
589 e
= jim_newtap_ir_param(n
, goi
, pTap
);
591 free((void *)pTap
->dotted_name
);
596 case NTAP_OPT_VERSION
:
597 pTap
->ignore_version
= true;
599 } /* switch (n->value) */
600 } /* while (goi->argc) */
602 /* default is enabled-after-reset */
603 pTap
->enabled
= !pTap
->disabled_after_reset
;
605 /* Did all the required option bits get cleared? */
606 if (pTap
->ir_length
!= 0) {
611 Jim_SetResultFormatted(goi
->interp
,
612 "newtap: %s missing IR length",
618 static void jtag_tap_handle_event(struct jtag_tap
*tap
, enum jtag_event e
)
620 struct jtag_tap_event_action
*jteap
;
622 for (jteap
= tap
->event_action
; jteap
!= NULL
; jteap
= jteap
->next
) {
623 if (jteap
->event
!= e
)
626 Jim_Nvp
*nvp
= Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
);
627 LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
628 tap
->dotted_name
, e
, nvp
->name
,
629 Jim_GetString(jteap
->body
, NULL
));
631 if (Jim_EvalObj(jteap
->interp
, jteap
->body
) != JIM_OK
) {
632 Jim_MakeErrorMessage(jteap
->interp
);
633 LOG_USER("%s", Jim_GetString(Jim_GetResult(jteap
->interp
), NULL
));
638 case JTAG_TAP_EVENT_ENABLE
:
639 case JTAG_TAP_EVENT_DISABLE
:
640 /* NOTE: we currently assume the handlers
641 * can't fail. Right here is where we should
642 * really be verifying the scan chains ...
644 tap
->enabled
= (e
== JTAG_TAP_EVENT_ENABLE
);
645 LOG_INFO("JTAG tap: %s %s", tap
->dotted_name
,
646 tap
->enabled
? "enabled" : "disabled");
654 static int jim_jtag_arp_init(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
657 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
659 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
662 struct command_context
*context
= current_command_context(interp
);
663 int e
= jtag_init_inner(context
);
665 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
666 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
667 Jim_FreeNewObj(goi
.interp
, eObj
);
673 static int jim_jtag_arp_init_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
677 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
679 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
682 struct command_context
*context
= current_command_context(interp
);
683 if (transport_is_jtag())
684 e
= jtag_init_reset(context
);
685 else if (transport_is_swd())
686 e
= swd_init_reset(context
);
689 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
690 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
691 Jim_FreeNewObj(goi
.interp
, eObj
);
697 int jim_jtag_newtap(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
700 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
701 return jim_newtap_cmd(&goi
);
704 static bool jtag_tap_enable(struct jtag_tap
*t
)
708 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_ENABLE
);
712 /* FIXME add JTAG sanity checks, w/o TLR
713 * - scan chain length grew by one (this)
714 * - IDs and IR lengths are as expected
716 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE
);
719 static bool jtag_tap_disable(struct jtag_tap
*t
)
723 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_DISABLE
);
727 /* FIXME add JTAG sanity checks, w/o TLR
728 * - scan chain length shrank by one (this)
729 * - IDs and IR lengths are as expected
731 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE
);
735 int jim_jtag_tap_enabler(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
737 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
739 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
741 Jim_SetResultFormatted(goi
.interp
, "usage: %s <name>", cmd_name
);
747 t
= jtag_tap_by_jim_obj(goi
.interp
, goi
.argv
[0]);
751 if (strcasecmp(cmd_name
, "tapisenabled") == 0) {
752 /* do nothing, just return the value */
753 } else if (strcasecmp(cmd_name
, "tapenable") == 0) {
754 if (!jtag_tap_enable(t
)) {
755 LOG_WARNING("failed to enable tap %s", t
->dotted_name
);
758 } else if (strcasecmp(cmd_name
, "tapdisable") == 0) {
759 if (!jtag_tap_disable(t
)) {
760 LOG_WARNING("failed to disable tap %s", t
->dotted_name
);
764 LOG_ERROR("command '%s' unknown", cmd_name
);
768 Jim_SetResult(goi
.interp
, Jim_NewIntObj(goi
.interp
, e
));
772 int jim_jtag_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
774 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
776 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
777 goi
.isconfigure
= !strcmp(cmd_name
, "configure");
778 if (goi
.argc
< 2 + goi
.isconfigure
) {
779 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
780 "<tap_name> <attribute> ...");
787 Jim_GetOpt_Obj(&goi
, &o
);
788 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
792 return jtag_tap_configure_cmd(&goi
, t
);
795 static int jim_jtag_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
798 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
800 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
, "Too many parameters");
803 Jim_SetResult(goi
.interp
, Jim_NewListObj(goi
.interp
, NULL
, 0));
804 struct jtag_tap
*tap
;
806 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
) {
807 Jim_ListAppendElement(goi
.interp
,
808 Jim_GetResult(goi
.interp
),
809 Jim_NewStringObj(goi
.interp
,
810 tap
->dotted_name
, -1));
815 COMMAND_HANDLER(handle_jtag_init_command
)
818 return ERROR_COMMAND_SYNTAX_ERROR
;
820 static bool jtag_initialized
;
821 if (jtag_initialized
) {
822 LOG_INFO("'jtag init' has already been called");
825 jtag_initialized
= true;
827 LOG_DEBUG("Initializing jtag devices...");
828 return jtag_init(CMD_CTX
);
831 static const struct command_registration jtag_subcommand_handlers
[] = {
835 .handler
= handle_jtag_init_command
,
836 .help
= "initialize jtag scan chain",
842 .jim_handler
= jim_jtag_arp_init
,
843 .help
= "Validates JTAG scan chain against the list of "
844 "declared TAPs using just the four standard JTAG "
848 .name
= "arp_init-reset",
850 .jim_handler
= jim_jtag_arp_init_reset
,
851 .help
= "Uses TRST and SRST to try resetting everything on "
852 "the JTAG scan chain, then performs 'jtag arp_init'."
856 .mode
= COMMAND_CONFIG
,
857 .jim_handler
= jim_jtag_newtap
,
858 .help
= "Create a new TAP instance named basename.tap_type, "
859 "and appends it to the scan chain.",
860 .usage
= "basename tap_type '-irlen' count "
861 "['-enable'|'-disable'] "
862 "['-expected_id' number] "
863 "['-ignore-version'] "
864 "['-ircapture' number] "
868 .name
= "tapisenabled",
869 .mode
= COMMAND_EXEC
,
870 .jim_handler
= jim_jtag_tap_enabler
,
871 .help
= "Returns a Tcl boolean (0/1) indicating whether "
872 "the TAP is enabled (1) or not (0).",
877 .mode
= COMMAND_EXEC
,
878 .jim_handler
= jim_jtag_tap_enabler
,
879 .help
= "Try to enable the specified TAP using the "
880 "'tap-enable' TAP event.",
884 .name
= "tapdisable",
885 .mode
= COMMAND_EXEC
,
886 .jim_handler
= jim_jtag_tap_enabler
,
887 .help
= "Try to disable the specified TAP using the "
888 "'tap-disable' TAP event.",
893 .mode
= COMMAND_EXEC
,
894 .jim_handler
= jim_jtag_configure
,
895 .help
= "Provide a Tcl handler for the specified "
897 .usage
= "tap_name '-event' event_name handler",
901 .mode
= COMMAND_EXEC
,
902 .jim_handler
= jim_jtag_configure
,
903 .help
= "Return any Tcl handler for the specified "
905 .usage
= "tap_name '-event' event_name",
910 .jim_handler
= jim_jtag_names
,
911 .help
= "Returns list of all JTAG tap names.",
914 .chain
= jtag_command_handlers_to_move
,
916 COMMAND_REGISTRATION_DONE
919 void jtag_notify_event(enum jtag_event event
)
921 struct jtag_tap
*tap
;
923 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
)
924 jtag_tap_handle_event(tap
, event
);
928 COMMAND_HANDLER(handle_scan_chain_command
)
930 struct jtag_tap
*tap
;
931 char expected_id
[12];
933 tap
= jtag_all_taps();
934 command_print(CMD_CTX
,
935 " TapName Enabled IdCode Expected IrLen IrCap IrMask");
936 command_print(CMD_CTX
,
937 "-- ------------------- -------- ---------- ---------- ----- ----- ------");
940 uint32_t expected
, expected_mask
, ii
;
942 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
943 (unsigned)((tap
->expected_ids_cnt
> 0)
944 ? tap
->expected_ids
[0]
946 if (tap
->ignore_version
)
947 expected_id
[2] = '*';
949 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
950 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
952 command_print(CMD_CTX
,
953 "%2d %-18s %c 0x%08x %s %5d 0x%02x 0x%02x",
954 tap
->abs_chain_position
,
956 tap
->enabled
? 'Y' : 'n',
957 (unsigned int)(tap
->idcode
),
959 (unsigned int)(tap
->ir_length
),
960 (unsigned int)(expected
),
961 (unsigned int)(expected_mask
));
963 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
964 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
965 (unsigned) tap
->expected_ids
[ii
]);
966 if (tap
->ignore_version
)
967 expected_id
[2] = '*';
969 command_print(CMD_CTX
,
980 COMMAND_HANDLER(handle_jtag_ntrst_delay_command
)
983 return ERROR_COMMAND_SYNTAX_ERROR
;
986 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
988 jtag_set_ntrst_delay(delay
);
990 command_print(CMD_CTX
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
994 COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command
)
997 return ERROR_COMMAND_SYNTAX_ERROR
;
1000 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
1002 jtag_set_ntrst_assert_width(delay
);
1004 command_print(CMD_CTX
, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
1008 COMMAND_HANDLER(handle_jtag_rclk_command
)
1011 return ERROR_COMMAND_SYNTAX_ERROR
;
1013 int retval
= ERROR_OK
;
1014 if (CMD_ARGC
== 1) {
1016 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], khz
);
1018 retval
= jtag_config_rclk(khz
);
1019 if (ERROR_OK
!= retval
)
1023 int cur_khz
= jtag_get_speed_khz();
1024 retval
= jtag_get_speed_readable(&cur_khz
);
1025 if (ERROR_OK
!= retval
)
1029 command_print(CMD_CTX
, "RCLK not supported - fallback to %d kHz", cur_khz
);
1031 command_print(CMD_CTX
, "RCLK - adaptive");
1036 COMMAND_HANDLER(handle_jtag_reset_command
)
1039 return ERROR_COMMAND_SYNTAX_ERROR
;
1042 if (CMD_ARGV
[0][0] == '1')
1044 else if (CMD_ARGV
[0][0] == '0')
1047 return ERROR_COMMAND_SYNTAX_ERROR
;
1050 if (CMD_ARGV
[1][0] == '1')
1052 else if (CMD_ARGV
[1][0] == '0')
1055 return ERROR_COMMAND_SYNTAX_ERROR
;
1057 if (adapter_init(CMD_CTX
) != ERROR_OK
)
1058 return ERROR_JTAG_INIT_FAILED
;
1060 jtag_add_reset(trst
, srst
);
1061 return jtag_execute_queue();
1064 COMMAND_HANDLER(handle_runtest_command
)
1067 return ERROR_COMMAND_SYNTAX_ERROR
;
1069 unsigned num_clocks
;
1070 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num_clocks
);
1072 jtag_add_runtest(num_clocks
, TAP_IDLE
);
1073 return jtag_execute_queue();
1077 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1078 * should be stable ... and *NOT* a shift state, otherwise free-running
1079 * jtag clocks could change the values latched by the update state.
1080 * Not surprisingly, this is the same constraint as SVF; the "irscan"
1081 * and "drscan" commands are a write-only subset of what SVF provides.
1084 COMMAND_HANDLER(handle_irscan_command
)
1087 struct scan_field
*fields
;
1088 struct jtag_tap
*tap
= NULL
;
1089 tap_state_t endstate
;
1091 if ((CMD_ARGC
< 2) || (CMD_ARGC
% 2))
1092 return ERROR_COMMAND_SYNTAX_ERROR
;
1094 /* optional "-endstate" "statename" at the end of the arguments,
1095 * so that e.g. IRPAUSE can let us load the data register before
1096 * entering RUN/IDLE to execute the instruction we load here.
1098 endstate
= TAP_IDLE
;
1100 if (CMD_ARGC
>= 4) {
1101 /* have at least one pair of numbers.
1102 * is last pair the magic text? */
1103 if (strcmp("-endstate", CMD_ARGV
[CMD_ARGC
- 2]) == 0) {
1104 endstate
= tap_state_by_name(CMD_ARGV
[CMD_ARGC
- 1]);
1105 if (endstate
== TAP_INVALID
)
1106 return ERROR_COMMAND_SYNTAX_ERROR
;
1107 if (!scan_is_safe(endstate
))
1108 LOG_WARNING("unstable irscan endstate \"%s\"",
1109 CMD_ARGV
[CMD_ARGC
- 1]);
1114 int num_fields
= CMD_ARGC
/ 2;
1115 if (num_fields
> 1) {
1116 /* we really should be looking at plain_ir_scan if we want
1117 * anything more fancy.
1119 LOG_ERROR("Specify a single value for tap");
1120 return ERROR_COMMAND_SYNTAX_ERROR
;
1123 fields
= calloc(num_fields
, sizeof(*fields
));
1126 for (i
= 0; i
< num_fields
; i
++) {
1127 tap
= jtag_tap_by_string(CMD_ARGV
[i
*2]);
1130 command_print(CMD_CTX
, "Tap: %s unknown", CMD_ARGV
[i
*2]);
1134 int field_size
= tap
->ir_length
;
1135 fields
[i
].num_bits
= field_size
;
1136 fields
[i
].out_value
= malloc(DIV_ROUND_UP(field_size
, 8));
1139 retval
= parse_u64(CMD_ARGV
[i
* 2 + 1], &value
);
1140 if (ERROR_OK
!= retval
)
1142 void *v
= (void *)fields
[i
].out_value
;
1143 buf_set_u64(v
, 0, field_size
, value
);
1144 fields
[i
].in_value
= NULL
;
1147 /* did we have an endstate? */
1148 jtag_add_ir_scan(tap
, fields
, endstate
);
1150 retval
= jtag_execute_queue();
1153 for (i
= 0; i
< num_fields
; i
++) {
1154 if (NULL
!= fields
[i
].out_value
)
1155 free((void *)fields
[i
].out_value
);
1163 COMMAND_HANDLER(handle_verify_ircapture_command
)
1166 return ERROR_COMMAND_SYNTAX_ERROR
;
1168 if (CMD_ARGC
== 1) {
1170 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1171 jtag_set_verify_capture_ir(enable
);
1174 const char *status
= jtag_will_verify_capture_ir() ? "enabled" : "disabled";
1175 command_print(CMD_CTX
, "verify Capture-IR is %s", status
);
1180 COMMAND_HANDLER(handle_verify_jtag_command
)
1183 return ERROR_COMMAND_SYNTAX_ERROR
;
1185 if (CMD_ARGC
== 1) {
1187 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1188 jtag_set_verify(enable
);
1191 const char *status
= jtag_will_verify() ? "enabled" : "disabled";
1192 command_print(CMD_CTX
, "verify jtag capture is %s", status
);
1197 COMMAND_HANDLER(handle_tms_sequence_command
)
1200 return ERROR_COMMAND_SYNTAX_ERROR
;
1202 if (CMD_ARGC
== 1) {
1204 if (strcmp(CMD_ARGV
[0], "short") == 0)
1205 use_new_table
= true;
1206 else if (strcmp(CMD_ARGV
[0], "long") == 0)
1207 use_new_table
= false;
1209 return ERROR_COMMAND_SYNTAX_ERROR
;
1211 tap_use_new_tms_table(use_new_table
);
1214 command_print(CMD_CTX
, "tms sequence is %s",
1215 tap_uses_new_tms_table() ? "short" : "long");
1220 COMMAND_HANDLER(handle_jtag_flush_queue_sleep
)
1223 return ERROR_COMMAND_SYNTAX_ERROR
;
1226 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], sleep_ms
);
1228 jtag_set_flush_queue_sleep(sleep_ms
);
1233 COMMAND_HANDLER(handle_wait_srst_deassert
)
1236 return ERROR_COMMAND_SYNTAX_ERROR
;
1239 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], timeout_ms
);
1240 if ((timeout_ms
<= 0) || (timeout_ms
> 100000)) {
1241 LOG_ERROR("Timeout must be an integer between 0 and 100000");
1245 LOG_USER("Waiting for srst assert + deassert for at most %dms", timeout_ms
);
1247 long long then
= timeval_ms();
1248 while (jtag_srst_asserted(&asserted_yet
) == ERROR_OK
) {
1249 if ((timeval_ms() - then
) > timeout_ms
) {
1250 LOG_ERROR("Timed out");
1256 while (jtag_srst_asserted(&asserted_yet
) == ERROR_OK
) {
1257 if ((timeval_ms() - then
) > timeout_ms
) {
1258 LOG_ERROR("Timed out");
1268 static const struct command_registration jtag_command_handlers
[] = {
1271 .name
= "jtag_flush_queue_sleep",
1272 .handler
= handle_jtag_flush_queue_sleep
,
1273 .mode
= COMMAND_ANY
,
1274 .help
= "For debug purposes(simulate long delays of interface) "
1275 "to test performance or change in behavior. Default 0ms.",
1276 .usage
= "[sleep in ms]",
1279 .name
= "jtag_rclk",
1280 .handler
= handle_jtag_rclk_command
,
1281 .mode
= COMMAND_ANY
,
1282 .help
= "With an argument, change to to use adaptive clocking "
1283 "if possible; else to use the fallback speed. "
1284 "With or without argument, display current setting.",
1285 .usage
= "[fallback_speed_khz]",
1288 .name
= "jtag_ntrst_delay",
1289 .handler
= handle_jtag_ntrst_delay_command
,
1290 .mode
= COMMAND_ANY
,
1291 .help
= "delay after deasserting trst in ms",
1292 .usage
= "[milliseconds]",
1295 .name
= "jtag_ntrst_assert_width",
1296 .handler
= handle_jtag_ntrst_assert_width_command
,
1297 .mode
= COMMAND_ANY
,
1298 .help
= "delay after asserting trst in ms",
1299 .usage
= "[milliseconds]",
1302 .name
= "scan_chain",
1303 .handler
= handle_scan_chain_command
,
1304 .mode
= COMMAND_ANY
,
1305 .help
= "print current scan chain configuration",
1309 .name
= "jtag_reset",
1310 .handler
= handle_jtag_reset_command
,
1311 .mode
= COMMAND_EXEC
,
1312 .help
= "Set reset line values. Value '1' is active, "
1313 "value '0' is inactive.",
1314 .usage
= "trst_active srst_active",
1318 .handler
= handle_runtest_command
,
1319 .mode
= COMMAND_EXEC
,
1320 .help
= "Move to Run-Test/Idle, and issue TCK for num_cycles.",
1321 .usage
= "num_cycles"
1325 .handler
= handle_irscan_command
,
1326 .mode
= COMMAND_EXEC
,
1327 .help
= "Execute Instruction Register (DR) scan. The "
1328 "specified opcodes are put into each TAP's IR, "
1329 "and other TAPs are put in BYPASS.",
1330 .usage
= "[tap_name instruction]* ['-endstate' state_name]",
1333 .name
= "verify_ircapture",
1334 .handler
= handle_verify_ircapture_command
,
1335 .mode
= COMMAND_ANY
,
1336 .help
= "Display or assign flag controlling whether to "
1337 "verify values captured during Capture-IR.",
1338 .usage
= "['enable'|'disable']",
1341 .name
= "verify_jtag",
1342 .handler
= handle_verify_jtag_command
,
1343 .mode
= COMMAND_ANY
,
1344 .help
= "Display or assign flag controlling whether to "
1345 "verify values captured during IR and DR scans.",
1346 .usage
= "['enable'|'disable']",
1349 .name
= "tms_sequence",
1350 .handler
= handle_tms_sequence_command
,
1351 .mode
= COMMAND_ANY
,
1352 .help
= "Display or change what style TMS sequences to use "
1353 "for JTAG state transitions: short (default) or "
1354 "long. Only for working around JTAG bugs.",
1355 /* Specifically for working around DRIVER bugs... */
1356 .usage
= "['short'|'long']",
1359 .name
= "wait_srst_deassert",
1360 .handler
= handle_wait_srst_deassert
,
1361 .mode
= COMMAND_ANY
,
1362 .help
= "Wait for an SRST deassert. "
1363 "Useful for cases where you need something to happen within ms "
1364 "of an srst deassert. Timeout in ms ",
1369 .mode
= COMMAND_ANY
,
1370 .help
= "perform jtag tap actions",
1373 .chain
= jtag_subcommand_handlers
,
1376 .chain
= jtag_command_handlers_to_move
,
1378 COMMAND_REGISTRATION_DONE
1381 int jtag_register_commands(struct command_context
*cmd_ctx
)
1383 return register_commands(cmd_ctx
, NULL
, jtag_command_handlers
);
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)