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 struct jtag_tap
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
64 const char *cp
= Jim_GetString(o
, NULL
);
65 struct jtag_tap
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
69 Jim_SetResultFormatted(interp
, "Tap '%s' could not be found", cp
);
73 static bool scan_is_safe(tap_state_t state
)
86 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
89 struct scan_field
*fields
;
98 * args[3] = hex string
99 * ... repeat num bits and hex string ...
102 * args[N-2] = "-endstate"
103 * args[N-1] = statename
105 if ((argc
< 4) || ((argc
% 2) != 0)) {
106 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
112 script_debug(interp
, "drscan", argc
, args
);
114 /* validate arguments as numbers */
116 for (i
= 2; i
< argc
; i
+= 2) {
120 e
= Jim_GetLong(interp
, args
[i
], &bits
);
121 /* If valid - try next arg */
125 /* Not valid.. are we at the end? */
126 if (((i
+ 2) != argc
)) {
127 /* nope, then error */
131 /* it could be: "-endstate FOO"
132 * e.g. DRPAUSE so we can issue more instructions
133 * before entering RUN/IDLE and executing them.
136 /* get arg as a string. */
137 cp
= Jim_GetString(args
[i
], NULL
);
138 /* is it the magic? */
139 if (0 == strcmp("-endstate", cp
)) {
140 /* is the statename valid? */
141 cp
= Jim_GetString(args
[i
+ 1], NULL
);
143 /* see if it is a valid state name */
144 endstate
= tap_state_by_name(cp
);
146 /* update the error message */
147 Jim_SetResultFormatted(interp
, "endstate: %s invalid", cp
);
149 if (!scan_is_safe(endstate
))
150 LOG_WARNING("drscan with unsafe "
151 "endstate \"%s\"", cp
);
153 /* valid - so clear the error */
155 /* and remove the last 2 args */
160 /* Still an error? */
162 return e
; /* too bad */
163 } /* validate args */
167 tap
= jtag_tap_by_jim_obj(interp
, args
[1]);
171 num_fields
= (argc
-2)/2;
172 if (num_fields
<= 0) {
173 Jim_SetResultString(interp
, "drscan: no scan fields supplied", -1);
176 fields
= malloc(sizeof(struct scan_field
) * num_fields
);
177 for (i
= 2; i
< argc
; i
+= 2) {
182 Jim_GetLong(interp
, args
[i
], &bits
);
183 str
= Jim_GetString(args
[i
+ 1], &len
);
185 fields
[field_count
].num_bits
= bits
;
186 void *t
= malloc(DIV_ROUND_UP(bits
, 8));
187 fields
[field_count
].out_value
= t
;
188 str_to_buf(str
, len
, t
, bits
, 0);
189 fields
[field_count
].in_value
= t
;
193 jtag_add_dr_scan(tap
, num_fields
, fields
, endstate
);
195 retval
= jtag_execute_queue();
196 if (retval
!= ERROR_OK
) {
197 Jim_SetResultString(interp
, "drscan: jtag execute failed", -1);
202 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
203 for (i
= 2; i
< argc
; i
+= 2) {
207 Jim_GetLong(interp
, args
[i
], &bits
);
208 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
209 free(fields
[field_count
].in_value
);
211 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
216 Jim_SetResult(interp
, list
);
224 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
226 tap_state_t states
[8];
228 if ((argc
< 2) || ((size_t)argc
> (ARRAY_SIZE(states
) + 1))) {
229 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
233 script_debug(interp
, "pathmove", argc
, args
);
236 for (i
= 0; i
< argc
-1; i
++) {
238 cp
= Jim_GetString(args
[i
+ 1], NULL
);
239 states
[i
] = tap_state_by_name(cp
);
241 /* update the error message */
242 Jim_SetResultFormatted(interp
, "endstate: %s invalid", cp
);
247 if ((jtag_add_statemove(states
[0]) != ERROR_OK
) || (jtag_execute_queue() != ERROR_OK
)) {
248 Jim_SetResultString(interp
, "pathmove: jtag execute failed", -1);
252 jtag_add_pathmove(argc
- 2, states
+ 1);
254 if (jtag_execute_queue() != ERROR_OK
) {
255 Jim_SetResultString(interp
, "pathmove: failed", -1);
263 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
265 script_debug(interp
, "flush_count", argc
, args
);
267 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
272 /* REVISIT Just what about these should "move" ... ?
273 * These registrations, into the main JTAG table?
275 * There's a minor compatibility issue, these all show up twice;
276 * that's not desirable:
277 * - jtag drscan ... NOT DOCUMENTED!
280 * The "irscan" command (for example) doesn't show twice.
282 static const struct command_registration jtag_command_handlers_to_move
[] = {
285 .mode
= COMMAND_EXEC
,
286 .jim_handler
= Jim_Command_drscan
,
287 .help
= "Execute Data Register (DR) scan for one TAP. "
288 "Other TAPs must be in BYPASS mode.",
289 .usage
= "tap_name [num_bits value]* ['-endstate' state_name]",
292 .name
= "flush_count",
293 .mode
= COMMAND_EXEC
,
294 .jim_handler
= Jim_Command_flush_count
,
295 .help
= "Returns the number of times the JTAG queue "
300 .mode
= COMMAND_EXEC
,
301 .jim_handler
= Jim_Command_pathmove
,
302 .usage
= "start_state state1 [state2 [state3 ...]]",
303 .help
= "Move JTAG state machine from current state "
304 "(start_state) to state1, then state2, state3, etc.",
306 COMMAND_REGISTRATION_DONE
310 enum jtag_tap_cfg_param
{
314 static Jim_Nvp nvp_config_opts
[] = {
315 { .name
= "-event", .value
= JCFG_EVENT
},
317 { .name
= NULL
, .value
= -1 }
320 static int jtag_tap_configure_event(Jim_GetOptInfo
*goi
, struct jtag_tap
*tap
)
322 if (goi
->argc
== 0) {
323 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name> ...");
328 int e
= Jim_GetOpt_Nvp(goi
, nvp_jtag_tap_event
, &n
);
330 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
334 if (goi
->isconfigure
) {
335 if (goi
->argc
!= 1) {
336 Jim_WrongNumArgs(goi
->interp
,
339 "-event <event-name> <event-body>");
343 if (goi
->argc
!= 0) {
344 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name>");
349 struct jtag_tap_event_action
*jteap
= tap
->event_action
;
350 /* replace existing event body */
353 if (jteap
->event
== (enum jtag_event
)n
->value
) {
360 Jim_SetEmptyResult(goi
->interp
);
362 if (goi
->isconfigure
) {
364 jteap
= calloc(1, sizeof(*jteap
));
365 else if (NULL
!= jteap
->body
)
366 Jim_DecrRefCount(goi
->interp
, jteap
->body
);
368 jteap
->interp
= goi
->interp
;
369 jteap
->event
= n
->value
;
372 Jim_GetOpt_Obj(goi
, &o
);
373 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
374 Jim_IncrRefCount(jteap
->body
);
377 /* add to head of event list */
378 jteap
->next
= tap
->event_action
;
379 tap
->event_action
= jteap
;
382 jteap
->interp
= goi
->interp
;
383 Jim_SetResult(goi
->interp
,
384 Jim_DuplicateObj(goi
->interp
, jteap
->body
));
389 static int jtag_tap_configure_cmd(Jim_GetOptInfo
*goi
, struct jtag_tap
*tap
)
391 /* parse config or cget options */
392 while (goi
->argc
> 0) {
393 Jim_SetEmptyResult(goi
->interp
);
396 int e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
398 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
404 e
= jtag_tap_configure_event(goi
, tap
);
409 Jim_SetResultFormatted(goi
->interp
, "unknown event: %s", n
->name
);
417 static int is_bad_irval(int ir_length
, jim_wide w
)
427 static int jim_newtap_expected_id(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
428 struct jtag_tap
*pTap
)
431 int e
= Jim_GetOpt_Wide(goi
, &w
);
433 Jim_SetResultFormatted(goi
->interp
, "option: %s bad parameter", n
->name
);
437 unsigned expected_len
= sizeof(uint32_t) * pTap
->expected_ids_cnt
;
438 uint32_t *new_expected_ids
= malloc(expected_len
+ sizeof(uint32_t));
439 if (new_expected_ids
== NULL
) {
440 Jim_SetResultFormatted(goi
->interp
, "no memory");
444 memcpy(new_expected_ids
, pTap
->expected_ids
, expected_len
);
446 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
448 free(pTap
->expected_ids
);
449 pTap
->expected_ids
= new_expected_ids
;
450 pTap
->expected_ids_cnt
++;
455 #define NTAP_OPT_IRLEN 0
456 #define NTAP_OPT_IRMASK 1
457 #define NTAP_OPT_IRCAPTURE 2
458 #define NTAP_OPT_ENABLED 3
459 #define NTAP_OPT_DISABLED 4
460 #define NTAP_OPT_EXPECTED_ID 5
461 #define NTAP_OPT_VERSION 6
463 static int jim_newtap_ir_param(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
464 struct jtag_tap
*pTap
)
467 int e
= Jim_GetOpt_Wide(goi
, &w
);
469 Jim_SetResultFormatted(goi
->interp
,
470 "option: %s bad parameter", n
->name
);
475 if (w
> (jim_wide
) (8 * sizeof(pTap
->ir_capture_value
))) {
476 LOG_WARNING("%s: huge IR length %d",
477 pTap
->dotted_name
, (int) w
);
481 case NTAP_OPT_IRMASK
:
482 if (is_bad_irval(pTap
->ir_length
, w
)) {
483 LOG_ERROR("%s: IR mask %x too big",
489 LOG_WARNING("%s: nonstandard IR mask", pTap
->dotted_name
);
490 pTap
->ir_capture_mask
= w
;
492 case NTAP_OPT_IRCAPTURE
:
493 if (is_bad_irval(pTap
->ir_length
, w
)) {
494 LOG_ERROR("%s: IR capture %x too big",
495 pTap
->dotted_name
, (int) w
);
499 LOG_WARNING("%s: nonstandard IR value",
501 pTap
->ir_capture_value
= w
;
509 static int jim_newtap_cmd(Jim_GetOptInfo
*goi
)
511 struct jtag_tap
*pTap
;
516 const Jim_Nvp opts
[] = {
517 { .name
= "-irlen", .value
= NTAP_OPT_IRLEN
},
518 { .name
= "-irmask", .value
= NTAP_OPT_IRMASK
},
519 { .name
= "-ircapture", .value
= NTAP_OPT_IRCAPTURE
},
520 { .name
= "-enable", .value
= NTAP_OPT_ENABLED
},
521 { .name
= "-disable", .value
= NTAP_OPT_DISABLED
},
522 { .name
= "-expected-id", .value
= NTAP_OPT_EXPECTED_ID
},
523 { .name
= "-ignore-version", .value
= NTAP_OPT_VERSION
},
524 { .name
= NULL
, .value
= -1 },
527 pTap
= calloc(1, sizeof(struct jtag_tap
));
529 Jim_SetResultFormatted(goi
->interp
, "no memory");
534 * we expect CHIP + TAP + OPTIONS
537 Jim_SetResultFormatted(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
541 Jim_GetOpt_String(goi
, &cp
, NULL
);
542 pTap
->chip
= strdup(cp
);
544 Jim_GetOpt_String(goi
, &cp
, NULL
);
545 pTap
->tapname
= strdup(cp
);
547 /* name + dot + name + null */
548 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
550 sprintf(cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
551 pTap
->dotted_name
= cp
;
553 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
554 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
556 /* IEEE specifies that the two LSBs of an IR scan are 01, so make
557 * that the default. The "-irlen" and "-irmask" options are only
558 * needed to cope with nonstandard TAPs, or to specify more bits.
560 pTap
->ir_capture_mask
= 0x03;
561 pTap
->ir_capture_value
= 0x01;
564 e
= Jim_GetOpt_Nvp(goi
, opts
, &n
);
566 Jim_GetOpt_NvpUnknown(goi
, opts
, 0);
571 LOG_DEBUG("Processing option: %s", n
->name
);
573 case NTAP_OPT_ENABLED
:
574 pTap
->disabled_after_reset
= false;
576 case NTAP_OPT_DISABLED
:
577 pTap
->disabled_after_reset
= true;
579 case NTAP_OPT_EXPECTED_ID
:
580 e
= jim_newtap_expected_id(n
, goi
, pTap
);
588 case NTAP_OPT_IRMASK
:
589 case NTAP_OPT_IRCAPTURE
:
590 e
= jim_newtap_ir_param(n
, goi
, pTap
);
597 case NTAP_OPT_VERSION
:
598 pTap
->ignore_version
= true;
600 } /* switch (n->value) */
601 } /* while (goi->argc) */
603 /* default is enabled-after-reset */
604 pTap
->enabled
= !pTap
->disabled_after_reset
;
606 /* Did all the required option bits get cleared? */
607 if (pTap
->ir_length
!= 0) {
612 Jim_SetResultFormatted(goi
->interp
,
613 "newtap: %s missing IR length",
619 static void jtag_tap_handle_event(struct jtag_tap
*tap
, enum jtag_event e
)
621 struct jtag_tap_event_action
*jteap
;
623 for (jteap
= tap
->event_action
; jteap
!= NULL
; jteap
= jteap
->next
) {
624 if (jteap
->event
!= e
)
627 Jim_Nvp
*nvp
= Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
);
628 LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
629 tap
->dotted_name
, e
, nvp
->name
,
630 Jim_GetString(jteap
->body
, NULL
));
632 if (Jim_EvalObj(jteap
->interp
, jteap
->body
) != JIM_OK
) {
633 Jim_MakeErrorMessage(jteap
->interp
);
634 LOG_USER("%s", Jim_GetString(Jim_GetResult(jteap
->interp
), NULL
));
639 case JTAG_TAP_EVENT_ENABLE
:
640 case JTAG_TAP_EVENT_DISABLE
:
641 /* NOTE: we currently assume the handlers
642 * can't fail. Right here is where we should
643 * really be verifying the scan chains ...
645 tap
->enabled
= (e
== JTAG_TAP_EVENT_ENABLE
);
646 LOG_INFO("JTAG tap: %s %s", tap
->dotted_name
,
647 tap
->enabled
? "enabled" : "disabled");
655 static int jim_jtag_arp_init(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
658 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
660 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
663 struct command_context
*context
= current_command_context(interp
);
664 int e
= jtag_init_inner(context
);
666 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
667 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
668 Jim_FreeNewObj(goi
.interp
, eObj
);
674 static int jim_jtag_arp_init_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
678 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
680 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
683 struct command_context
*context
= current_command_context(interp
);
684 if (transport_is_jtag())
685 e
= jtag_init_reset(context
);
686 else if (transport_is_swd())
687 e
= swd_init_reset(context
);
690 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
691 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
692 Jim_FreeNewObj(goi
.interp
, eObj
);
698 int jim_jtag_newtap(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
701 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
702 return jim_newtap_cmd(&goi
);
705 static bool jtag_tap_enable(struct jtag_tap
*t
)
709 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_ENABLE
);
713 /* FIXME add JTAG sanity checks, w/o TLR
714 * - scan chain length grew by one (this)
715 * - IDs and IR lengths are as expected
717 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE
);
720 static bool jtag_tap_disable(struct jtag_tap
*t
)
724 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_DISABLE
);
728 /* FIXME add JTAG sanity checks, w/o TLR
729 * - scan chain length shrank by one (this)
730 * - IDs and IR lengths are as expected
732 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE
);
736 int jim_jtag_tap_enabler(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
738 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
740 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
742 Jim_SetResultFormatted(goi
.interp
, "usage: %s <name>", cmd_name
);
748 t
= jtag_tap_by_jim_obj(goi
.interp
, goi
.argv
[0]);
752 if (strcasecmp(cmd_name
, "tapisenabled") == 0) {
753 /* do nothing, just return the value */
754 } else if (strcasecmp(cmd_name
, "tapenable") == 0) {
755 if (!jtag_tap_enable(t
)) {
756 LOG_WARNING("failed to enable tap %s", t
->dotted_name
);
759 } else if (strcasecmp(cmd_name
, "tapdisable") == 0) {
760 if (!jtag_tap_disable(t
)) {
761 LOG_WARNING("failed to disable tap %s", t
->dotted_name
);
765 LOG_ERROR("command '%s' unknown", cmd_name
);
769 Jim_SetResult(goi
.interp
, Jim_NewIntObj(goi
.interp
, e
));
773 int jim_jtag_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
775 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
777 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
778 goi
.isconfigure
= !strcmp(cmd_name
, "configure");
779 if (goi
.argc
< 2 + goi
.isconfigure
) {
780 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
781 "<tap_name> <attribute> ...");
788 Jim_GetOpt_Obj(&goi
, &o
);
789 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
793 return jtag_tap_configure_cmd(&goi
, t
);
796 static int jim_jtag_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
799 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
801 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
, "Too many parameters");
804 Jim_SetResult(goi
.interp
, Jim_NewListObj(goi
.interp
, NULL
, 0));
805 struct jtag_tap
*tap
;
807 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
) {
808 Jim_ListAppendElement(goi
.interp
,
809 Jim_GetResult(goi
.interp
),
810 Jim_NewStringObj(goi
.interp
,
811 tap
->dotted_name
, -1));
816 COMMAND_HANDLER(handle_jtag_init_command
)
819 return ERROR_COMMAND_SYNTAX_ERROR
;
821 static bool jtag_initialized
;
822 if (jtag_initialized
) {
823 LOG_INFO("'jtag init' has already been called");
826 jtag_initialized
= true;
828 LOG_DEBUG("Initializing jtag devices...");
829 return jtag_init(CMD_CTX
);
832 static const struct command_registration jtag_subcommand_handlers
[] = {
836 .handler
= handle_jtag_init_command
,
837 .help
= "initialize jtag scan chain",
843 .jim_handler
= jim_jtag_arp_init
,
844 .help
= "Validates JTAG scan chain against the list of "
845 "declared TAPs using just the four standard JTAG "
849 .name
= "arp_init-reset",
851 .jim_handler
= jim_jtag_arp_init_reset
,
852 .help
= "Uses TRST and SRST to try resetting everything on "
853 "the JTAG scan chain, then performs 'jtag arp_init'."
857 .mode
= COMMAND_CONFIG
,
858 .jim_handler
= jim_jtag_newtap
,
859 .help
= "Create a new TAP instance named basename.tap_type, "
860 "and appends it to the scan chain.",
861 .usage
= "basename tap_type '-irlen' count "
862 "['-enable'|'-disable'] "
863 "['-expected_id' number] "
864 "['-ignore-version'] "
865 "['-ircapture' number] "
869 .name
= "tapisenabled",
870 .mode
= COMMAND_EXEC
,
871 .jim_handler
= jim_jtag_tap_enabler
,
872 .help
= "Returns a Tcl boolean (0/1) indicating whether "
873 "the TAP is enabled (1) or not (0).",
878 .mode
= COMMAND_EXEC
,
879 .jim_handler
= jim_jtag_tap_enabler
,
880 .help
= "Try to enable the specified TAP using the "
881 "'tap-enable' TAP event.",
885 .name
= "tapdisable",
886 .mode
= COMMAND_EXEC
,
887 .jim_handler
= jim_jtag_tap_enabler
,
888 .help
= "Try to disable the specified TAP using the "
889 "'tap-disable' TAP event.",
894 .mode
= COMMAND_EXEC
,
895 .jim_handler
= jim_jtag_configure
,
896 .help
= "Provide a Tcl handler for the specified "
898 .usage
= "tap_name '-event' event_name handler",
902 .mode
= COMMAND_EXEC
,
903 .jim_handler
= jim_jtag_configure
,
904 .help
= "Return any Tcl handler for the specified "
906 .usage
= "tap_name '-event' event_name",
911 .jim_handler
= jim_jtag_names
,
912 .help
= "Returns list of all JTAG tap names.",
915 .chain
= jtag_command_handlers_to_move
,
917 COMMAND_REGISTRATION_DONE
920 void jtag_notify_event(enum jtag_event event
)
922 struct jtag_tap
*tap
;
924 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
)
925 jtag_tap_handle_event(tap
, event
);
929 COMMAND_HANDLER(handle_scan_chain_command
)
931 struct jtag_tap
*tap
;
932 char expected_id
[12];
934 tap
= jtag_all_taps();
935 command_print(CMD_CTX
,
936 " TapName Enabled IdCode Expected IrLen IrCap IrMask");
937 command_print(CMD_CTX
,
938 "-- ------------------- -------- ---------- ---------- ----- ----- ------");
941 uint32_t expected
, expected_mask
, ii
;
943 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
944 (unsigned)((tap
->expected_ids_cnt
> 0)
945 ? tap
->expected_ids
[0]
947 if (tap
->ignore_version
)
948 expected_id
[2] = '*';
950 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
951 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
953 command_print(CMD_CTX
,
954 "%2d %-18s %c 0x%08x %s %5d 0x%02x 0x%02x",
955 tap
->abs_chain_position
,
957 tap
->enabled
? 'Y' : 'n',
958 (unsigned int)(tap
->idcode
),
960 (unsigned int)(tap
->ir_length
),
961 (unsigned int)(expected
),
962 (unsigned int)(expected_mask
));
964 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
965 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
966 (unsigned) tap
->expected_ids
[ii
]);
967 if (tap
->ignore_version
)
968 expected_id
[2] = '*';
970 command_print(CMD_CTX
,
981 COMMAND_HANDLER(handle_jtag_ntrst_delay_command
)
984 return ERROR_COMMAND_SYNTAX_ERROR
;
987 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
989 jtag_set_ntrst_delay(delay
);
991 command_print(CMD_CTX
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
995 COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command
)
998 return ERROR_COMMAND_SYNTAX_ERROR
;
1001 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
1003 jtag_set_ntrst_assert_width(delay
);
1005 command_print(CMD_CTX
, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
1009 COMMAND_HANDLER(handle_jtag_rclk_command
)
1012 return ERROR_COMMAND_SYNTAX_ERROR
;
1014 int retval
= ERROR_OK
;
1015 if (CMD_ARGC
== 1) {
1017 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], khz
);
1019 retval
= jtag_config_rclk(khz
);
1020 if (ERROR_OK
!= retval
)
1024 int cur_khz
= jtag_get_speed_khz();
1025 retval
= jtag_get_speed_readable(&cur_khz
);
1026 if (ERROR_OK
!= retval
)
1030 command_print(CMD_CTX
, "RCLK not supported - fallback to %d kHz", cur_khz
);
1032 command_print(CMD_CTX
, "RCLK - adaptive");
1037 COMMAND_HANDLER(handle_jtag_reset_command
)
1040 return ERROR_COMMAND_SYNTAX_ERROR
;
1043 if (CMD_ARGV
[0][0] == '1')
1045 else if (CMD_ARGV
[0][0] == '0')
1048 return ERROR_COMMAND_SYNTAX_ERROR
;
1051 if (CMD_ARGV
[1][0] == '1')
1053 else if (CMD_ARGV
[1][0] == '0')
1056 return ERROR_COMMAND_SYNTAX_ERROR
;
1058 if (adapter_init(CMD_CTX
) != ERROR_OK
)
1059 return ERROR_JTAG_INIT_FAILED
;
1061 jtag_add_reset(trst
, srst
);
1062 return jtag_execute_queue();
1065 COMMAND_HANDLER(handle_runtest_command
)
1068 return ERROR_COMMAND_SYNTAX_ERROR
;
1070 unsigned num_clocks
;
1071 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num_clocks
);
1073 jtag_add_runtest(num_clocks
, TAP_IDLE
);
1074 return jtag_execute_queue();
1078 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1079 * should be stable ... and *NOT* a shift state, otherwise free-running
1080 * jtag clocks could change the values latched by the update state.
1081 * Not surprisingly, this is the same constraint as SVF; the "irscan"
1082 * and "drscan" commands are a write-only subset of what SVF provides.
1085 COMMAND_HANDLER(handle_irscan_command
)
1088 struct scan_field
*fields
;
1089 struct jtag_tap
*tap
= NULL
;
1090 tap_state_t endstate
;
1092 if ((CMD_ARGC
< 2) || (CMD_ARGC
% 2))
1093 return ERROR_COMMAND_SYNTAX_ERROR
;
1095 /* optional "-endstate" "statename" at the end of the arguments,
1096 * so that e.g. IRPAUSE can let us load the data register before
1097 * entering RUN/IDLE to execute the instruction we load here.
1099 endstate
= TAP_IDLE
;
1101 if (CMD_ARGC
>= 4) {
1102 /* have at least one pair of numbers.
1103 * is last pair the magic text? */
1104 if (strcmp("-endstate", CMD_ARGV
[CMD_ARGC
- 2]) == 0) {
1105 endstate
= tap_state_by_name(CMD_ARGV
[CMD_ARGC
- 1]);
1106 if (endstate
== TAP_INVALID
)
1107 return ERROR_COMMAND_SYNTAX_ERROR
;
1108 if (!scan_is_safe(endstate
))
1109 LOG_WARNING("unstable irscan endstate \"%s\"",
1110 CMD_ARGV
[CMD_ARGC
- 1]);
1115 int num_fields
= CMD_ARGC
/ 2;
1116 if (num_fields
> 1) {
1117 /* we really should be looking at plain_ir_scan if we want
1118 * anything more fancy.
1120 LOG_ERROR("Specify a single value for tap");
1121 return ERROR_COMMAND_SYNTAX_ERROR
;
1124 fields
= calloc(num_fields
, sizeof(*fields
));
1127 for (i
= 0; i
< num_fields
; i
++) {
1128 tap
= jtag_tap_by_string(CMD_ARGV
[i
*2]);
1131 command_print(CMD_CTX
, "Tap: %s unknown", CMD_ARGV
[i
*2]);
1135 int field_size
= tap
->ir_length
;
1136 fields
[i
].num_bits
= field_size
;
1137 uint8_t *v
= malloc(DIV_ROUND_UP(field_size
, 8));
1140 retval
= parse_u64(CMD_ARGV
[i
* 2 + 1], &value
);
1141 if (ERROR_OK
!= retval
)
1143 buf_set_u64(v
, 0, field_size
, value
);
1144 fields
[i
].out_value
= v
;
1145 fields
[i
].in_value
= NULL
;
1148 /* did we have an endstate? */
1149 jtag_add_ir_scan(tap
, fields
, endstate
);
1151 retval
= jtag_execute_queue();
1154 for (i
= 0; i
< num_fields
; i
++) {
1155 if (NULL
!= fields
[i
].out_value
)
1156 free((void *)fields
[i
].out_value
);
1164 COMMAND_HANDLER(handle_verify_ircapture_command
)
1167 return ERROR_COMMAND_SYNTAX_ERROR
;
1169 if (CMD_ARGC
== 1) {
1171 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1172 jtag_set_verify_capture_ir(enable
);
1175 const char *status
= jtag_will_verify_capture_ir() ? "enabled" : "disabled";
1176 command_print(CMD_CTX
, "verify Capture-IR is %s", status
);
1181 COMMAND_HANDLER(handle_verify_jtag_command
)
1184 return ERROR_COMMAND_SYNTAX_ERROR
;
1186 if (CMD_ARGC
== 1) {
1188 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1189 jtag_set_verify(enable
);
1192 const char *status
= jtag_will_verify() ? "enabled" : "disabled";
1193 command_print(CMD_CTX
, "verify jtag capture is %s", status
);
1198 COMMAND_HANDLER(handle_tms_sequence_command
)
1201 return ERROR_COMMAND_SYNTAX_ERROR
;
1203 if (CMD_ARGC
== 1) {
1205 if (strcmp(CMD_ARGV
[0], "short") == 0)
1206 use_new_table
= true;
1207 else if (strcmp(CMD_ARGV
[0], "long") == 0)
1208 use_new_table
= false;
1210 return ERROR_COMMAND_SYNTAX_ERROR
;
1212 tap_use_new_tms_table(use_new_table
);
1215 command_print(CMD_CTX
, "tms sequence is %s",
1216 tap_uses_new_tms_table() ? "short" : "long");
1221 COMMAND_HANDLER(handle_jtag_flush_queue_sleep
)
1224 return ERROR_COMMAND_SYNTAX_ERROR
;
1227 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], sleep_ms
);
1229 jtag_set_flush_queue_sleep(sleep_ms
);
1234 COMMAND_HANDLER(handle_wait_srst_deassert
)
1237 return ERROR_COMMAND_SYNTAX_ERROR
;
1240 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], timeout_ms
);
1241 if ((timeout_ms
<= 0) || (timeout_ms
> 100000)) {
1242 LOG_ERROR("Timeout must be an integer between 0 and 100000");
1246 LOG_USER("Waiting for srst assert + deassert for at most %dms", timeout_ms
);
1248 long long then
= timeval_ms();
1249 while (jtag_srst_asserted(&asserted_yet
) == ERROR_OK
) {
1250 if ((timeval_ms() - then
) > timeout_ms
) {
1251 LOG_ERROR("Timed out");
1257 while (jtag_srst_asserted(&asserted_yet
) == ERROR_OK
) {
1258 if ((timeval_ms() - then
) > timeout_ms
) {
1259 LOG_ERROR("Timed out");
1269 static const struct command_registration jtag_command_handlers
[] = {
1272 .name
= "jtag_flush_queue_sleep",
1273 .handler
= handle_jtag_flush_queue_sleep
,
1274 .mode
= COMMAND_ANY
,
1275 .help
= "For debug purposes(simulate long delays of interface) "
1276 "to test performance or change in behavior. Default 0ms.",
1277 .usage
= "[sleep in ms]",
1280 .name
= "jtag_rclk",
1281 .handler
= handle_jtag_rclk_command
,
1282 .mode
= COMMAND_ANY
,
1283 .help
= "With an argument, change to to use adaptive clocking "
1284 "if possible; else to use the fallback speed. "
1285 "With or without argument, display current setting.",
1286 .usage
= "[fallback_speed_khz]",
1289 .name
= "jtag_ntrst_delay",
1290 .handler
= handle_jtag_ntrst_delay_command
,
1291 .mode
= COMMAND_ANY
,
1292 .help
= "delay after deasserting trst in ms",
1293 .usage
= "[milliseconds]",
1296 .name
= "jtag_ntrst_assert_width",
1297 .handler
= handle_jtag_ntrst_assert_width_command
,
1298 .mode
= COMMAND_ANY
,
1299 .help
= "delay after asserting trst in ms",
1300 .usage
= "[milliseconds]",
1303 .name
= "scan_chain",
1304 .handler
= handle_scan_chain_command
,
1305 .mode
= COMMAND_ANY
,
1306 .help
= "print current scan chain configuration",
1310 .name
= "jtag_reset",
1311 .handler
= handle_jtag_reset_command
,
1312 .mode
= COMMAND_EXEC
,
1313 .help
= "Set reset line values. Value '1' is active, "
1314 "value '0' is inactive.",
1315 .usage
= "trst_active srst_active",
1319 .handler
= handle_runtest_command
,
1320 .mode
= COMMAND_EXEC
,
1321 .help
= "Move to Run-Test/Idle, and issue TCK for num_cycles.",
1322 .usage
= "num_cycles"
1326 .handler
= handle_irscan_command
,
1327 .mode
= COMMAND_EXEC
,
1328 .help
= "Execute Instruction Register (DR) scan. The "
1329 "specified opcodes are put into each TAP's IR, "
1330 "and other TAPs are put in BYPASS.",
1331 .usage
= "[tap_name instruction]* ['-endstate' state_name]",
1334 .name
= "verify_ircapture",
1335 .handler
= handle_verify_ircapture_command
,
1336 .mode
= COMMAND_ANY
,
1337 .help
= "Display or assign flag controlling whether to "
1338 "verify values captured during Capture-IR.",
1339 .usage
= "['enable'|'disable']",
1342 .name
= "verify_jtag",
1343 .handler
= handle_verify_jtag_command
,
1344 .mode
= COMMAND_ANY
,
1345 .help
= "Display or assign flag controlling whether to "
1346 "verify values captured during IR and DR scans.",
1347 .usage
= "['enable'|'disable']",
1350 .name
= "tms_sequence",
1351 .handler
= handle_tms_sequence_command
,
1352 .mode
= COMMAND_ANY
,
1353 .help
= "Display or change what style TMS sequences to use "
1354 "for JTAG state transitions: short (default) or "
1355 "long. Only for working around JTAG bugs.",
1356 /* Specifically for working around DRIVER bugs... */
1357 .usage
= "['short'|'long']",
1360 .name
= "wait_srst_deassert",
1361 .handler
= handle_wait_srst_deassert
,
1362 .mode
= COMMAND_ANY
,
1363 .help
= "Wait for an SRST deassert. "
1364 "Useful for cases where you need something to happen within ms "
1365 "of an srst deassert. Timeout in ms ",
1370 .mode
= COMMAND_ANY
,
1371 .help
= "perform jtag tap actions",
1374 .chain
= jtag_subcommand_handlers
,
1377 .chain
= jtag_command_handlers_to_move
,
1379 COMMAND_REGISTRATION_DONE
1382 int jtag_register_commands(struct command_context
*cmd_ctx
)
1384 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)