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 uint32_t *p
= realloc(pTap
->expected_ids
,
438 (pTap
->expected_ids_cnt
+ 1) * sizeof(uint32_t));
440 Jim_SetResultFormatted(goi
->interp
, "no memory");
444 pTap
->expected_ids
= p
;
445 pTap
->expected_ids
[pTap
->expected_ids_cnt
++] = w
;
450 #define NTAP_OPT_IRLEN 0
451 #define NTAP_OPT_IRMASK 1
452 #define NTAP_OPT_IRCAPTURE 2
453 #define NTAP_OPT_ENABLED 3
454 #define NTAP_OPT_DISABLED 4
455 #define NTAP_OPT_EXPECTED_ID 5
456 #define NTAP_OPT_VERSION 6
458 static int jim_newtap_ir_param(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
459 struct jtag_tap
*pTap
)
462 int e
= Jim_GetOpt_Wide(goi
, &w
);
464 Jim_SetResultFormatted(goi
->interp
,
465 "option: %s bad parameter", n
->name
);
470 if (w
> (jim_wide
) (8 * sizeof(pTap
->ir_capture_value
))) {
471 LOG_WARNING("%s: huge IR length %d",
472 pTap
->dotted_name
, (int) w
);
476 case NTAP_OPT_IRMASK
:
477 if (is_bad_irval(pTap
->ir_length
, w
)) {
478 LOG_ERROR("%s: IR mask %x too big",
484 LOG_WARNING("%s: nonstandard IR mask", pTap
->dotted_name
);
485 pTap
->ir_capture_mask
= w
;
487 case NTAP_OPT_IRCAPTURE
:
488 if (is_bad_irval(pTap
->ir_length
, w
)) {
489 LOG_ERROR("%s: IR capture %x too big",
490 pTap
->dotted_name
, (int) w
);
494 LOG_WARNING("%s: nonstandard IR value",
496 pTap
->ir_capture_value
= w
;
504 static int jim_newtap_cmd(Jim_GetOptInfo
*goi
)
506 struct jtag_tap
*pTap
;
511 const Jim_Nvp opts
[] = {
512 { .name
= "-irlen", .value
= NTAP_OPT_IRLEN
},
513 { .name
= "-irmask", .value
= NTAP_OPT_IRMASK
},
514 { .name
= "-ircapture", .value
= NTAP_OPT_IRCAPTURE
},
515 { .name
= "-enable", .value
= NTAP_OPT_ENABLED
},
516 { .name
= "-disable", .value
= NTAP_OPT_DISABLED
},
517 { .name
= "-expected-id", .value
= NTAP_OPT_EXPECTED_ID
},
518 { .name
= "-ignore-version", .value
= NTAP_OPT_VERSION
},
519 { .name
= NULL
, .value
= -1 },
522 pTap
= calloc(1, sizeof(struct jtag_tap
));
524 Jim_SetResultFormatted(goi
->interp
, "no memory");
529 * we expect CHIP + TAP + OPTIONS
532 Jim_SetResultFormatted(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
536 Jim_GetOpt_String(goi
, &cp
, NULL
);
537 pTap
->chip
= strdup(cp
);
539 Jim_GetOpt_String(goi
, &cp
, NULL
);
540 pTap
->tapname
= strdup(cp
);
542 /* name + dot + name + null */
543 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
545 sprintf(cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
546 pTap
->dotted_name
= cp
;
548 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
549 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
551 if (!transport_is_jtag()) {
552 /* SWD doesn't require any JTAG tap parameters */
553 pTap
->enabled
= true;
558 /* IEEE specifies that the two LSBs of an IR scan are 01, so make
559 * that the default. The "-ircapture" and "-irmask" options are only
560 * needed to cope with nonstandard TAPs, or to specify more bits.
562 pTap
->ir_capture_mask
= 0x03;
563 pTap
->ir_capture_value
= 0x01;
566 e
= Jim_GetOpt_Nvp(goi
, opts
, &n
);
568 Jim_GetOpt_NvpUnknown(goi
, opts
, 0);
573 LOG_DEBUG("Processing option: %s", n
->name
);
575 case NTAP_OPT_ENABLED
:
576 pTap
->disabled_after_reset
= false;
578 case NTAP_OPT_DISABLED
:
579 pTap
->disabled_after_reset
= true;
581 case NTAP_OPT_EXPECTED_ID
:
582 e
= jim_newtap_expected_id(n
, goi
, pTap
);
590 case NTAP_OPT_IRMASK
:
591 case NTAP_OPT_IRCAPTURE
:
592 e
= jim_newtap_ir_param(n
, goi
, pTap
);
599 case NTAP_OPT_VERSION
:
600 pTap
->ignore_version
= true;
602 } /* switch (n->value) */
603 } /* while (goi->argc) */
605 /* default is enabled-after-reset */
606 pTap
->enabled
= !pTap
->disabled_after_reset
;
608 /* Did all the required option bits get cleared? */
609 if (pTap
->ir_length
!= 0) {
614 Jim_SetResultFormatted(goi
->interp
,
615 "newtap: %s missing IR length",
621 static void jtag_tap_handle_event(struct jtag_tap
*tap
, enum jtag_event e
)
623 struct jtag_tap_event_action
*jteap
;
625 for (jteap
= tap
->event_action
; jteap
!= NULL
; jteap
= jteap
->next
) {
626 if (jteap
->event
!= e
)
629 Jim_Nvp
*nvp
= Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
);
630 LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
631 tap
->dotted_name
, e
, nvp
->name
,
632 Jim_GetString(jteap
->body
, NULL
));
634 if (Jim_EvalObj(jteap
->interp
, jteap
->body
) != JIM_OK
) {
635 Jim_MakeErrorMessage(jteap
->interp
);
636 LOG_USER("%s", Jim_GetString(Jim_GetResult(jteap
->interp
), NULL
));
641 case JTAG_TAP_EVENT_ENABLE
:
642 case JTAG_TAP_EVENT_DISABLE
:
643 /* NOTE: we currently assume the handlers
644 * can't fail. Right here is where we should
645 * really be verifying the scan chains ...
647 tap
->enabled
= (e
== JTAG_TAP_EVENT_ENABLE
);
648 LOG_INFO("JTAG tap: %s %s", tap
->dotted_name
,
649 tap
->enabled
? "enabled" : "disabled");
657 static int jim_jtag_arp_init(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
660 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
662 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
665 struct command_context
*context
= current_command_context(interp
);
666 int e
= jtag_init_inner(context
);
668 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
669 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
670 Jim_FreeNewObj(goi
.interp
, eObj
);
676 static int jim_jtag_arp_init_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
680 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
682 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
685 struct command_context
*context
= current_command_context(interp
);
686 if (transport_is_jtag())
687 e
= jtag_init_reset(context
);
688 else if (transport_is_swd())
689 e
= swd_init_reset(context
);
692 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
693 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
694 Jim_FreeNewObj(goi
.interp
, eObj
);
700 int jim_jtag_newtap(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
703 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
704 return jim_newtap_cmd(&goi
);
707 static bool jtag_tap_enable(struct jtag_tap
*t
)
711 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_ENABLE
);
715 /* FIXME add JTAG sanity checks, w/o TLR
716 * - scan chain length grew by one (this)
717 * - IDs and IR lengths are as expected
719 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE
);
722 static bool jtag_tap_disable(struct jtag_tap
*t
)
726 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_DISABLE
);
730 /* FIXME add JTAG sanity checks, w/o TLR
731 * - scan chain length shrank by one (this)
732 * - IDs and IR lengths are as expected
734 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE
);
738 int jim_jtag_tap_enabler(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
740 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
742 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
744 Jim_SetResultFormatted(goi
.interp
, "usage: %s <name>", cmd_name
);
750 t
= jtag_tap_by_jim_obj(goi
.interp
, goi
.argv
[0]);
754 if (strcasecmp(cmd_name
, "tapisenabled") == 0) {
755 /* do nothing, just return the value */
756 } else if (strcasecmp(cmd_name
, "tapenable") == 0) {
757 if (!jtag_tap_enable(t
)) {
758 LOG_WARNING("failed to enable tap %s", t
->dotted_name
);
761 } else if (strcasecmp(cmd_name
, "tapdisable") == 0) {
762 if (!jtag_tap_disable(t
)) {
763 LOG_WARNING("failed to disable tap %s", t
->dotted_name
);
767 LOG_ERROR("command '%s' unknown", cmd_name
);
771 Jim_SetResult(goi
.interp
, Jim_NewIntObj(goi
.interp
, e
));
775 int jim_jtag_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
777 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
779 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
780 goi
.isconfigure
= !strcmp(cmd_name
, "configure");
781 if (goi
.argc
< 2 + goi
.isconfigure
) {
782 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
783 "<tap_name> <attribute> ...");
790 Jim_GetOpt_Obj(&goi
, &o
);
791 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
795 return jtag_tap_configure_cmd(&goi
, t
);
798 static int jim_jtag_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
801 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
803 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
, "Too many parameters");
806 Jim_SetResult(goi
.interp
, Jim_NewListObj(goi
.interp
, NULL
, 0));
807 struct jtag_tap
*tap
;
809 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
) {
810 Jim_ListAppendElement(goi
.interp
,
811 Jim_GetResult(goi
.interp
),
812 Jim_NewStringObj(goi
.interp
,
813 tap
->dotted_name
, -1));
818 COMMAND_HANDLER(handle_jtag_init_command
)
821 return ERROR_COMMAND_SYNTAX_ERROR
;
823 static bool jtag_initialized
;
824 if (jtag_initialized
) {
825 LOG_INFO("'jtag init' has already been called");
828 jtag_initialized
= true;
830 LOG_DEBUG("Initializing jtag devices...");
831 return jtag_init(CMD_CTX
);
834 static const struct command_registration jtag_subcommand_handlers
[] = {
838 .handler
= handle_jtag_init_command
,
839 .help
= "initialize jtag scan chain",
845 .jim_handler
= jim_jtag_arp_init
,
846 .help
= "Validates JTAG scan chain against the list of "
847 "declared TAPs using just the four standard JTAG "
851 .name
= "arp_init-reset",
853 .jim_handler
= jim_jtag_arp_init_reset
,
854 .help
= "Uses TRST and SRST to try resetting everything on "
855 "the JTAG scan chain, then performs 'jtag arp_init'."
859 .mode
= COMMAND_CONFIG
,
860 .jim_handler
= jim_jtag_newtap
,
861 .help
= "Create a new TAP instance named basename.tap_type, "
862 "and appends it to the scan chain.",
863 .usage
= "basename tap_type '-irlen' count "
864 "['-enable'|'-disable'] "
865 "['-expected_id' number] "
866 "['-ignore-version'] "
867 "['-ircapture' number] "
871 .name
= "tapisenabled",
872 .mode
= COMMAND_EXEC
,
873 .jim_handler
= jim_jtag_tap_enabler
,
874 .help
= "Returns a Tcl boolean (0/1) indicating whether "
875 "the TAP is enabled (1) or not (0).",
880 .mode
= COMMAND_EXEC
,
881 .jim_handler
= jim_jtag_tap_enabler
,
882 .help
= "Try to enable the specified TAP using the "
883 "'tap-enable' TAP event.",
887 .name
= "tapdisable",
888 .mode
= COMMAND_EXEC
,
889 .jim_handler
= jim_jtag_tap_enabler
,
890 .help
= "Try to disable the specified TAP using the "
891 "'tap-disable' TAP event.",
896 .mode
= COMMAND_EXEC
,
897 .jim_handler
= jim_jtag_configure
,
898 .help
= "Provide a Tcl handler for the specified "
900 .usage
= "tap_name '-event' event_name handler",
904 .mode
= COMMAND_EXEC
,
905 .jim_handler
= jim_jtag_configure
,
906 .help
= "Return any Tcl handler for the specified "
908 .usage
= "tap_name '-event' event_name",
913 .jim_handler
= jim_jtag_names
,
914 .help
= "Returns list of all JTAG tap names.",
917 .chain
= jtag_command_handlers_to_move
,
919 COMMAND_REGISTRATION_DONE
922 void jtag_notify_event(enum jtag_event event
)
924 struct jtag_tap
*tap
;
926 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
)
927 jtag_tap_handle_event(tap
, event
);
931 COMMAND_HANDLER(handle_scan_chain_command
)
933 struct jtag_tap
*tap
;
934 char expected_id
[12];
936 tap
= jtag_all_taps();
937 command_print(CMD_CTX
,
938 " TapName Enabled IdCode Expected IrLen IrCap IrMask");
939 command_print(CMD_CTX
,
940 "-- ------------------- -------- ---------- ---------- ----- ----- ------");
943 uint32_t expected
, expected_mask
, ii
;
945 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
946 (unsigned)((tap
->expected_ids_cnt
> 0)
947 ? tap
->expected_ids
[0]
949 if (tap
->ignore_version
)
950 expected_id
[2] = '*';
952 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
953 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
955 command_print(CMD_CTX
,
956 "%2d %-18s %c 0x%08x %s %5d 0x%02x 0x%02x",
957 tap
->abs_chain_position
,
959 tap
->enabled
? 'Y' : 'n',
960 (unsigned int)(tap
->idcode
),
962 (unsigned int)(tap
->ir_length
),
963 (unsigned int)(expected
),
964 (unsigned int)(expected_mask
));
966 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
967 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
968 (unsigned) tap
->expected_ids
[ii
]);
969 if (tap
->ignore_version
)
970 expected_id
[2] = '*';
972 command_print(CMD_CTX
,
983 COMMAND_HANDLER(handle_jtag_ntrst_delay_command
)
986 return ERROR_COMMAND_SYNTAX_ERROR
;
989 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
991 jtag_set_ntrst_delay(delay
);
993 command_print(CMD_CTX
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
997 COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command
)
1000 return ERROR_COMMAND_SYNTAX_ERROR
;
1001 if (CMD_ARGC
== 1) {
1003 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
1005 jtag_set_ntrst_assert_width(delay
);
1007 command_print(CMD_CTX
, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
1011 COMMAND_HANDLER(handle_jtag_rclk_command
)
1014 return ERROR_COMMAND_SYNTAX_ERROR
;
1016 int retval
= ERROR_OK
;
1017 if (CMD_ARGC
== 1) {
1019 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], khz
);
1021 retval
= jtag_config_rclk(khz
);
1022 if (ERROR_OK
!= retval
)
1026 int cur_khz
= jtag_get_speed_khz();
1027 retval
= jtag_get_speed_readable(&cur_khz
);
1028 if (ERROR_OK
!= retval
)
1032 command_print(CMD_CTX
, "RCLK not supported - fallback to %d kHz", cur_khz
);
1034 command_print(CMD_CTX
, "RCLK - adaptive");
1039 COMMAND_HANDLER(handle_jtag_reset_command
)
1042 return ERROR_COMMAND_SYNTAX_ERROR
;
1045 if (CMD_ARGV
[0][0] == '1')
1047 else if (CMD_ARGV
[0][0] == '0')
1050 return ERROR_COMMAND_SYNTAX_ERROR
;
1053 if (CMD_ARGV
[1][0] == '1')
1055 else if (CMD_ARGV
[1][0] == '0')
1058 return ERROR_COMMAND_SYNTAX_ERROR
;
1060 if (adapter_init(CMD_CTX
) != ERROR_OK
)
1061 return ERROR_JTAG_INIT_FAILED
;
1063 jtag_add_reset(trst
, srst
);
1064 return jtag_execute_queue();
1067 COMMAND_HANDLER(handle_runtest_command
)
1070 return ERROR_COMMAND_SYNTAX_ERROR
;
1072 unsigned num_clocks
;
1073 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num_clocks
);
1075 jtag_add_runtest(num_clocks
, TAP_IDLE
);
1076 return jtag_execute_queue();
1080 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1081 * should be stable ... and *NOT* a shift state, otherwise free-running
1082 * jtag clocks could change the values latched by the update state.
1083 * Not surprisingly, this is the same constraint as SVF; the "irscan"
1084 * and "drscan" commands are a write-only subset of what SVF provides.
1087 COMMAND_HANDLER(handle_irscan_command
)
1090 struct scan_field
*fields
;
1091 struct jtag_tap
*tap
= NULL
;
1092 tap_state_t endstate
;
1094 if ((CMD_ARGC
< 2) || (CMD_ARGC
% 2))
1095 return ERROR_COMMAND_SYNTAX_ERROR
;
1097 /* optional "-endstate" "statename" at the end of the arguments,
1098 * so that e.g. IRPAUSE can let us load the data register before
1099 * entering RUN/IDLE to execute the instruction we load here.
1101 endstate
= TAP_IDLE
;
1103 if (CMD_ARGC
>= 4) {
1104 /* have at least one pair of numbers.
1105 * is last pair the magic text? */
1106 if (strcmp("-endstate", CMD_ARGV
[CMD_ARGC
- 2]) == 0) {
1107 endstate
= tap_state_by_name(CMD_ARGV
[CMD_ARGC
- 1]);
1108 if (endstate
== TAP_INVALID
)
1109 return ERROR_COMMAND_SYNTAX_ERROR
;
1110 if (!scan_is_safe(endstate
))
1111 LOG_WARNING("unstable irscan endstate \"%s\"",
1112 CMD_ARGV
[CMD_ARGC
- 1]);
1117 int num_fields
= CMD_ARGC
/ 2;
1118 if (num_fields
> 1) {
1119 /* we really should be looking at plain_ir_scan if we want
1120 * anything more fancy.
1122 LOG_ERROR("Specify a single value for tap");
1123 return ERROR_COMMAND_SYNTAX_ERROR
;
1126 fields
= calloc(num_fields
, sizeof(*fields
));
1129 for (i
= 0; i
< num_fields
; i
++) {
1130 tap
= jtag_tap_by_string(CMD_ARGV
[i
*2]);
1133 command_print(CMD_CTX
, "Tap: %s unknown", CMD_ARGV
[i
*2]);
1137 int field_size
= tap
->ir_length
;
1138 fields
[i
].num_bits
= field_size
;
1139 uint8_t *v
= malloc(DIV_ROUND_UP(field_size
, 8));
1142 retval
= parse_u64(CMD_ARGV
[i
* 2 + 1], &value
);
1143 if (ERROR_OK
!= retval
)
1145 buf_set_u64(v
, 0, field_size
, value
);
1146 fields
[i
].out_value
= v
;
1147 fields
[i
].in_value
= NULL
;
1150 /* did we have an endstate? */
1151 jtag_add_ir_scan(tap
, fields
, endstate
);
1153 retval
= jtag_execute_queue();
1156 for (i
= 0; i
< num_fields
; i
++) {
1157 if (NULL
!= fields
[i
].out_value
)
1158 free((void *)fields
[i
].out_value
);
1166 COMMAND_HANDLER(handle_verify_ircapture_command
)
1169 return ERROR_COMMAND_SYNTAX_ERROR
;
1171 if (CMD_ARGC
== 1) {
1173 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1174 jtag_set_verify_capture_ir(enable
);
1177 const char *status
= jtag_will_verify_capture_ir() ? "enabled" : "disabled";
1178 command_print(CMD_CTX
, "verify Capture-IR is %s", status
);
1183 COMMAND_HANDLER(handle_verify_jtag_command
)
1186 return ERROR_COMMAND_SYNTAX_ERROR
;
1188 if (CMD_ARGC
== 1) {
1190 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1191 jtag_set_verify(enable
);
1194 const char *status
= jtag_will_verify() ? "enabled" : "disabled";
1195 command_print(CMD_CTX
, "verify jtag capture is %s", status
);
1200 COMMAND_HANDLER(handle_tms_sequence_command
)
1203 return ERROR_COMMAND_SYNTAX_ERROR
;
1205 if (CMD_ARGC
== 1) {
1207 if (strcmp(CMD_ARGV
[0], "short") == 0)
1208 use_new_table
= true;
1209 else if (strcmp(CMD_ARGV
[0], "long") == 0)
1210 use_new_table
= false;
1212 return ERROR_COMMAND_SYNTAX_ERROR
;
1214 tap_use_new_tms_table(use_new_table
);
1217 command_print(CMD_CTX
, "tms sequence is %s",
1218 tap_uses_new_tms_table() ? "short" : "long");
1223 COMMAND_HANDLER(handle_jtag_flush_queue_sleep
)
1226 return ERROR_COMMAND_SYNTAX_ERROR
;
1229 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], sleep_ms
);
1231 jtag_set_flush_queue_sleep(sleep_ms
);
1236 COMMAND_HANDLER(handle_wait_srst_deassert
)
1239 return ERROR_COMMAND_SYNTAX_ERROR
;
1242 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], timeout_ms
);
1243 if ((timeout_ms
<= 0) || (timeout_ms
> 100000)) {
1244 LOG_ERROR("Timeout must be an integer between 0 and 100000");
1248 LOG_USER("Waiting for srst assert + deassert for at most %dms", timeout_ms
);
1250 long long then
= timeval_ms();
1251 while (jtag_srst_asserted(&asserted_yet
) == ERROR_OK
) {
1252 if ((timeval_ms() - then
) > timeout_ms
) {
1253 LOG_ERROR("Timed out");
1259 while (jtag_srst_asserted(&asserted_yet
) == ERROR_OK
) {
1260 if ((timeval_ms() - then
) > timeout_ms
) {
1261 LOG_ERROR("Timed out");
1271 static const struct command_registration jtag_command_handlers
[] = {
1274 .name
= "jtag_flush_queue_sleep",
1275 .handler
= handle_jtag_flush_queue_sleep
,
1276 .mode
= COMMAND_ANY
,
1277 .help
= "For debug purposes(simulate long delays of interface) "
1278 "to test performance or change in behavior. Default 0ms.",
1279 .usage
= "[sleep in ms]",
1282 .name
= "jtag_rclk",
1283 .handler
= handle_jtag_rclk_command
,
1284 .mode
= COMMAND_ANY
,
1285 .help
= "With an argument, change to to use adaptive clocking "
1286 "if possible; else to use the fallback speed. "
1287 "With or without argument, display current setting.",
1288 .usage
= "[fallback_speed_khz]",
1291 .name
= "jtag_ntrst_delay",
1292 .handler
= handle_jtag_ntrst_delay_command
,
1293 .mode
= COMMAND_ANY
,
1294 .help
= "delay after deasserting trst in ms",
1295 .usage
= "[milliseconds]",
1298 .name
= "jtag_ntrst_assert_width",
1299 .handler
= handle_jtag_ntrst_assert_width_command
,
1300 .mode
= COMMAND_ANY
,
1301 .help
= "delay after asserting trst in ms",
1302 .usage
= "[milliseconds]",
1305 .name
= "scan_chain",
1306 .handler
= handle_scan_chain_command
,
1307 .mode
= COMMAND_ANY
,
1308 .help
= "print current scan chain configuration",
1312 .name
= "jtag_reset",
1313 .handler
= handle_jtag_reset_command
,
1314 .mode
= COMMAND_EXEC
,
1315 .help
= "Set reset line values. Value '1' is active, "
1316 "value '0' is inactive.",
1317 .usage
= "trst_active srst_active",
1321 .handler
= handle_runtest_command
,
1322 .mode
= COMMAND_EXEC
,
1323 .help
= "Move to Run-Test/Idle, and issue TCK for num_cycles.",
1324 .usage
= "num_cycles"
1328 .handler
= handle_irscan_command
,
1329 .mode
= COMMAND_EXEC
,
1330 .help
= "Execute Instruction Register (DR) scan. The "
1331 "specified opcodes are put into each TAP's IR, "
1332 "and other TAPs are put in BYPASS.",
1333 .usage
= "[tap_name instruction]* ['-endstate' state_name]",
1336 .name
= "verify_ircapture",
1337 .handler
= handle_verify_ircapture_command
,
1338 .mode
= COMMAND_ANY
,
1339 .help
= "Display or assign flag controlling whether to "
1340 "verify values captured during Capture-IR.",
1341 .usage
= "['enable'|'disable']",
1344 .name
= "verify_jtag",
1345 .handler
= handle_verify_jtag_command
,
1346 .mode
= COMMAND_ANY
,
1347 .help
= "Display or assign flag controlling whether to "
1348 "verify values captured during IR and DR scans.",
1349 .usage
= "['enable'|'disable']",
1352 .name
= "tms_sequence",
1353 .handler
= handle_tms_sequence_command
,
1354 .mode
= COMMAND_ANY
,
1355 .help
= "Display or change what style TMS sequences to use "
1356 "for JTAG state transitions: short (default) or "
1357 "long. Only for working around JTAG bugs.",
1358 /* Specifically for working around DRIVER bugs... */
1359 .usage
= "['short'|'long']",
1362 .name
= "wait_srst_deassert",
1363 .handler
= handle_wait_srst_deassert
,
1364 .mode
= COMMAND_ANY
,
1365 .help
= "Wait for an SRST deassert. "
1366 "Useful for cases where you need something to happen within ms "
1367 "of an srst deassert. Timeout in ms ",
1372 .mode
= COMMAND_ANY
,
1373 .help
= "perform jtag tap actions",
1376 .chain
= jtag_subcommand_handlers
,
1379 .chain
= jtag_command_handlers_to_move
,
1381 COMMAND_REGISTRATION_DONE
1384 int jtag_register_commands(struct command_context
*cmd_ctx
)
1386 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)