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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
29 ***************************************************************************/
35 #include "minidriver.h"
36 #include "interface.h"
37 #include "interfaces.h"
45 * Holds support for accessing JTAG-specific mechanisms from TCl scripts.
48 static const Jim_Nvp nvp_jtag_tap_event
[] = {
49 { .value
= JTAG_TRST_ASSERTED
, .name
= "post-reset" },
50 { .value
= JTAG_TAP_EVENT_SETUP
, .name
= "setup" },
51 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
52 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
54 { .name
= NULL
, .value
= -1 }
57 extern struct jtag_interface
*jtag_interface
;
59 struct jtag_tap
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
61 const char *cp
= Jim_GetString(o
, NULL
);
62 struct jtag_tap
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
66 Jim_SetResultFormatted(interp
, "Tap '%s' could not be found", cp
);
70 static bool scan_is_safe(tap_state_t state
)
84 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
87 struct scan_field
*fields
;
96 * args[3] = hex string
97 * ... repeat num bits and hex string ...
100 * args[N-2] = "-endstate"
101 * args[N-1] = statename
103 if ((argc
< 4) || ((argc
% 2) != 0))
105 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
111 script_debug(interp
, "drscan", argc
, args
);
113 /* validate arguments as numbers */
115 for (i
= 2; i
< argc
; i
+= 2)
120 e
= Jim_GetLong(interp
, args
[i
], &bits
);
121 /* If valid - try next arg */
126 /* Not valid.. are we at the end? */
127 if (((i
+ 2) != argc
)) {
128 /* nope, then error */
132 /* it could be: "-endstate FOO"
133 * e.g. DRPAUSE so we can issue more instructions
134 * before entering RUN/IDLE and executing them.
137 /* get arg as a string. */
138 cp
= Jim_GetString(args
[i
], NULL
);
139 /* is it the magic? */
140 if (0 == strcmp("-endstate", cp
)) {
141 /* is the statename valid? */
142 cp
= Jim_GetString(args
[i
+ 1], NULL
);
144 /* see if it is a valid state name */
145 endstate
= tap_state_by_name(cp
);
147 /* update the error message */
148 Jim_SetResultFormatted(interp
,"endstate: %s invalid", cp
);
150 if (!scan_is_safe(endstate
))
151 LOG_WARNING("drscan with unsafe "
152 "endstate \"%s\"", cp
);
154 /* valid - so clear the error */
156 /* and remove the last 2 args */
161 /* Still an error? */
163 return e
; /* too bad */
165 } /* validate args */
167 tap
= jtag_tap_by_jim_obj(interp
, args
[1]);
172 num_fields
= (argc
-2)/2;
173 fields
= malloc(sizeof(struct scan_field
) * num_fields
);
174 for (i
= 2; i
< argc
; i
+= 2)
180 Jim_GetLong(interp
, args
[i
], &bits
);
181 str
= Jim_GetString(args
[i
+ 1], &len
);
183 fields
[field_count
].num_bits
= bits
;
184 void * t
= malloc(DIV_ROUND_UP(bits
, 8));
185 fields
[field_count
].out_value
= t
;
186 str_to_buf(str
, len
, t
, bits
, 0);
187 fields
[field_count
].in_value
= t
;
191 jtag_add_dr_scan(tap
, num_fields
, fields
, endstate
);
193 retval
= jtag_execute_queue();
194 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)
207 Jim_GetLong(interp
, args
[i
], &bits
);
208 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
209 free((void *)fields
[field_count
].out_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)))
230 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
234 script_debug(interp
, "pathmove", argc
, args
);
237 for (i
= 0; i
< argc
-1; i
++)
240 cp
= Jim_GetString(args
[i
+ 1], NULL
);
241 states
[i
] = tap_state_by_name(cp
);
244 /* update the error message */
245 Jim_SetResultFormatted(interp
,"endstate: %s invalid", cp
);
250 if ((jtag_add_statemove(states
[0]) != ERROR_OK
) || (jtag_execute_queue()!= ERROR_OK
))
252 Jim_SetResultString(interp
, "pathmove: jtag execute failed",-1);
256 jtag_add_pathmove(argc
-2, states
+ 1);
258 if (jtag_execute_queue()!= ERROR_OK
)
260 Jim_SetResultString(interp
, "pathmove: failed",-1);
268 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
270 script_debug(interp
, "flush_count", argc
, args
);
272 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
277 /* REVISIT Just what about these should "move" ... ?
278 * These registrations, into the main JTAG table?
280 * There's a minor compatibility issue, these all show up twice;
281 * that's not desirable:
282 * - jtag drscan ... NOT DOCUMENTED!
285 * The "irscan" command (for example) doesn't show twice.
287 static const struct command_registration jtag_command_handlers_to_move
[] = {
290 .mode
= COMMAND_EXEC
,
291 .jim_handler
= Jim_Command_drscan
,
292 .help
= "Execute Data Register (DR) scan for one TAP. "
293 "Other TAPs must be in BYPASS mode.",
294 .usage
= "tap_name [num_bits value]* ['-endstate' state_name]",
297 .name
= "flush_count",
298 .mode
= COMMAND_EXEC
,
299 .jim_handler
= Jim_Command_flush_count
,
300 .help
= "Returns the number of times the JTAG queue "
305 .mode
= COMMAND_EXEC
,
306 .jim_handler
= Jim_Command_pathmove
,
307 .usage
= "start_state state1 [state2 [state3 ...]]",
308 .help
= "Move JTAG state machine from current state "
309 "(start_state) to state1, then state2, state3, etc.",
311 COMMAND_REGISTRATION_DONE
315 enum jtag_tap_cfg_param
{
319 static Jim_Nvp nvp_config_opts
[] = {
320 { .name
= "-event", .value
= JCFG_EVENT
},
322 { .name
= NULL
, .value
= -1 }
325 static int jtag_tap_configure_event(Jim_GetOptInfo
*goi
, struct jtag_tap
* tap
)
329 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name> ...");
334 int e
= Jim_GetOpt_Nvp(goi
, nvp_jtag_tap_event
, &n
);
337 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
341 if (goi
->isconfigure
) {
342 if (goi
->argc
!= 1) {
343 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name> <event-body>");
347 if (goi
->argc
!= 0) {
348 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event <event-name>");
353 struct jtag_tap_event_action
*jteap
= tap
->event_action
;
354 /* replace existing event body */
358 if (jteap
->event
== (enum jtag_event
)n
->value
)
366 Jim_SetEmptyResult(goi
->interp
);
368 if (goi
->isconfigure
)
371 jteap
= calloc(1, sizeof(*jteap
));
372 else if (NULL
!= jteap
->body
)
373 Jim_DecrRefCount(goi
->interp
, jteap
->body
);
375 jteap
->interp
= goi
->interp
;
376 jteap
->event
= n
->value
;
379 Jim_GetOpt_Obj(goi
, &o
);
380 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
381 Jim_IncrRefCount(jteap
->body
);
385 /* add to head of event list */
386 jteap
->next
= tap
->event_action
;
387 tap
->event_action
= jteap
;
392 jteap
->interp
= goi
->interp
;
393 Jim_SetResult(goi
->interp
,
394 Jim_DuplicateObj(goi
->interp
, jteap
->body
));
399 static int jtag_tap_configure_cmd(Jim_GetOptInfo
*goi
, struct jtag_tap
* tap
)
401 /* parse config or cget options */
402 while (goi
->argc
> 0)
404 Jim_SetEmptyResult (goi
->interp
);
407 int e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
410 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
417 e
= jtag_tap_configure_event(goi
, tap
);
422 Jim_SetResultFormatted(goi
->interp
, "unknown event: %s", n
->name
);
430 static int is_bad_irval(int ir_length
, jim_wide w
)
440 static int jim_newtap_expected_id(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
441 struct jtag_tap
*pTap
)
444 int e
= Jim_GetOpt_Wide(goi
, &w
);
446 Jim_SetResultFormatted(goi
->interp
, "option: %s bad parameter", n
->name
);
450 unsigned expected_len
= sizeof(uint32_t) * pTap
->expected_ids_cnt
;
451 uint32_t *new_expected_ids
= malloc(expected_len
+ sizeof(uint32_t));
452 if (new_expected_ids
== NULL
)
454 Jim_SetResultFormatted(goi
->interp
, "no memory");
458 memcpy(new_expected_ids
, pTap
->expected_ids
, expected_len
);
460 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
462 free(pTap
->expected_ids
);
463 pTap
->expected_ids
= new_expected_ids
;
464 pTap
->expected_ids_cnt
++;
469 #define NTAP_OPT_IRLEN 0
470 #define NTAP_OPT_IRMASK 1
471 #define NTAP_OPT_IRCAPTURE 2
472 #define NTAP_OPT_ENABLED 3
473 #define NTAP_OPT_DISABLED 4
474 #define NTAP_OPT_EXPECTED_ID 5
475 #define NTAP_OPT_VERSION 6
477 static int jim_newtap_ir_param(Jim_Nvp
*n
, Jim_GetOptInfo
*goi
,
478 struct jtag_tap
*pTap
)
481 int e
= Jim_GetOpt_Wide(goi
, &w
);
484 Jim_SetResultFormatted(goi
->interp
,
485 "option: %s bad parameter", n
->name
);
486 free((void *)pTap
->dotted_name
);
491 if (w
> (jim_wide
) (8 * sizeof(pTap
->ir_capture_value
)))
493 LOG_WARNING("%s: huge IR length %d",
494 pTap
->dotted_name
, (int) w
);
498 case NTAP_OPT_IRMASK
:
499 if (is_bad_irval(pTap
->ir_length
, w
))
501 LOG_ERROR("%s: IR mask %x too big",
507 LOG_WARNING("%s: nonstandard IR mask", pTap
->dotted_name
);
508 pTap
->ir_capture_mask
= w
;
510 case NTAP_OPT_IRCAPTURE
:
511 if (is_bad_irval(pTap
->ir_length
, w
))
513 LOG_ERROR("%s: IR capture %x too big",
514 pTap
->dotted_name
, (int) w
);
518 LOG_WARNING("%s: nonstandard IR value",
520 pTap
->ir_capture_value
= w
;
528 static int jim_newtap_cmd(Jim_GetOptInfo
*goi
)
530 struct jtag_tap
*pTap
;
535 const Jim_Nvp opts
[] = {
536 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
537 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
538 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
539 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
540 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
541 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
542 { .name
= "-ignore-version" , .value
= NTAP_OPT_VERSION
},
543 { .name
= NULL
, .value
= -1 },
546 pTap
= calloc(1, sizeof(struct jtag_tap
));
548 Jim_SetResultFormatted(goi
->interp
, "no memory");
553 * we expect CHIP + TAP + OPTIONS
556 Jim_SetResultFormatted(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
560 Jim_GetOpt_String(goi
, &cp
, NULL
);
561 pTap
->chip
= strdup(cp
);
563 Jim_GetOpt_String(goi
, &cp
, NULL
);
564 pTap
->tapname
= strdup(cp
);
566 /* name + dot + name + null */
567 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
569 sprintf(cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
570 pTap
->dotted_name
= cp
;
572 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
573 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
575 /* IEEE specifies that the two LSBs of an IR scan are 01, so make
576 * that the default. The "-irlen" and "-irmask" options are only
577 * needed to cope with nonstandard TAPs, or to specify more bits.
579 pTap
->ir_capture_mask
= 0x03;
580 pTap
->ir_capture_value
= 0x01;
583 e
= Jim_GetOpt_Nvp(goi
, opts
, &n
);
585 Jim_GetOpt_NvpUnknown(goi
, opts
, 0);
586 free((void *)pTap
->dotted_name
);
590 LOG_DEBUG("Processing option: %s", n
->name
);
592 case NTAP_OPT_ENABLED
:
593 pTap
->disabled_after_reset
= false;
595 case NTAP_OPT_DISABLED
:
596 pTap
->disabled_after_reset
= true;
598 case NTAP_OPT_EXPECTED_ID
:
599 e
= jim_newtap_expected_id(n
, goi
, pTap
);
602 free((void *)pTap
->dotted_name
);
608 case NTAP_OPT_IRMASK
:
609 case NTAP_OPT_IRCAPTURE
:
610 e
= jim_newtap_ir_param(n
, goi
, pTap
);
613 free((void *)pTap
->dotted_name
);
618 case NTAP_OPT_VERSION
:
619 pTap
->ignore_version
= true;
621 } /* switch (n->value) */
622 } /* while (goi->argc) */
624 /* default is enabled-after-reset */
625 pTap
->enabled
= !pTap
->disabled_after_reset
;
627 /* Did all the required option bits get cleared? */
628 if (pTap
->ir_length
!= 0)
634 Jim_SetResultFormatted(goi
->interp
,
635 "newtap: %s missing IR length",
641 static void jtag_tap_handle_event(struct jtag_tap
*tap
, enum jtag_event e
)
643 struct jtag_tap_event_action
* jteap
;
645 for (jteap
= tap
->event_action
; jteap
!= NULL
; jteap
= jteap
->next
)
647 if (jteap
->event
!= e
)
650 Jim_Nvp
*nvp
= Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
);
651 LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
652 tap
->dotted_name
, e
, nvp
->name
,
653 Jim_GetString(jteap
->body
, NULL
));
655 if (Jim_EvalObj(jteap
->interp
, jteap
->body
) != JIM_OK
)
657 Jim_MakeErrorMessage(jteap
->interp
);
658 LOG_USER_N("%s\n", Jim_GetString(Jim_GetResult(jteap
->interp
), NULL
));
664 case JTAG_TAP_EVENT_ENABLE
:
665 case JTAG_TAP_EVENT_DISABLE
:
666 /* NOTE: we currently assume the handlers
667 * can't fail. Right here is where we should
668 * really be verifying the scan chains ...
670 tap
->enabled
= (e
== JTAG_TAP_EVENT_ENABLE
);
671 LOG_INFO("JTAG tap: %s %s", tap
->dotted_name
,
672 tap
->enabled
? "enabled" : "disabled");
680 static int jim_jtag_arp_init(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
683 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
685 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
688 struct command_context
*context
= current_command_context(interp
);
689 int e
= jtag_init_inner(context
);
691 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
692 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
693 Jim_FreeNewObj(goi
.interp
, eObj
);
699 static int jim_jtag_arp_init_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
702 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
704 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
707 struct command_context
*context
= current_command_context(interp
);
708 int e
= jtag_init_reset(context
);
710 Jim_Obj
*eObj
= Jim_NewIntObj(goi
.interp
, e
);
711 Jim_SetResultFormatted(goi
.interp
, "error: %#s", eObj
);
712 Jim_FreeNewObj(goi
.interp
, eObj
);
718 int jim_jtag_newtap(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
721 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
722 return jim_newtap_cmd(&goi
);
725 static bool jtag_tap_enable(struct jtag_tap
*t
)
729 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_ENABLE
);
733 /* FIXME add JTAG sanity checks, w/o TLR
734 * - scan chain length grew by one (this)
735 * - IDs and IR lengths are as expected
737 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE
);
740 static bool jtag_tap_disable(struct jtag_tap
*t
)
744 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_DISABLE
);
748 /* FIXME add JTAG sanity checks, w/o TLR
749 * - scan chain length shrank by one (this)
750 * - IDs and IR lengths are as expected
752 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE
);
756 static int jim_jtag_tap_enabler(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
758 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
760 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
762 Jim_SetResultFormatted(goi
.interp
, "usage: %s <name>", cmd_name
);
768 t
= jtag_tap_by_jim_obj(goi
.interp
, goi
.argv
[0]);
772 if (strcasecmp(cmd_name
, "tapisenabled") == 0) {
773 // do nothing, just return the value
774 } else if (strcasecmp(cmd_name
, "tapenable") == 0) {
775 if (!jtag_tap_enable(t
))
776 LOG_WARNING("failed to enable tap %s", t
->dotted_name
);
777 } else if (strcasecmp(cmd_name
, "tapdisable") == 0) {
778 if (!jtag_tap_disable(t
))
779 LOG_WARNING("failed to disable tap %s", t
->dotted_name
);
781 LOG_ERROR("command '%s' unknown", cmd_name
);
785 Jim_SetResult(goi
.interp
, Jim_NewIntObj(goi
.interp
, e
));
789 static int jim_jtag_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
791 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
793 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
794 goi
.isconfigure
= !strcmp(cmd_name
, "configure");
795 if (goi
.argc
< 2 + goi
.isconfigure
) {
796 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
797 "<tap_name> <attribute> ...");
804 Jim_GetOpt_Obj(&goi
, &o
);
805 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
810 return jtag_tap_configure_cmd(&goi
, t
);
813 static int jim_jtag_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
816 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
818 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
, "Too many parameters");
821 Jim_SetResult(goi
.interp
, Jim_NewListObj(goi
.interp
, NULL
, 0));
822 struct jtag_tap
*tap
;
824 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
) {
825 Jim_ListAppendElement(goi
.interp
,
826 Jim_GetResult(goi
.interp
),
827 Jim_NewStringObj(goi
.interp
,
828 tap
->dotted_name
, -1));
833 COMMAND_HANDLER(handle_jtag_init_command
)
836 return ERROR_COMMAND_SYNTAX_ERROR
;
838 static bool jtag_initialized
= false;
839 if (jtag_initialized
)
841 LOG_INFO("'jtag init' has already been called");
844 jtag_initialized
= true;
846 LOG_DEBUG("Initializing jtag devices...");
847 return jtag_init(CMD_CTX
);
850 static const struct command_registration jtag_subcommand_handlers
[] = {
854 .handler
= handle_jtag_init_command
,
855 .help
= "initialize jtag scan chain",
860 .jim_handler
= jim_jtag_arp_init
,
861 .help
= "Validates JTAG scan chain against the list of "
862 "declared TAPs using just the four standard JTAG "
866 .name
= "arp_init-reset",
868 .jim_handler
= jim_jtag_arp_init_reset
,
869 .help
= "Uses TRST and SRST to try resetting everything on "
870 "the JTAG scan chain, then performs 'jtag arp_init'."
874 .mode
= COMMAND_CONFIG
,
875 .jim_handler
= jim_jtag_newtap
,
876 .help
= "Create a new TAP instance named basename.tap_type, "
877 "and appends it to the scan chain.",
878 .usage
= "basename tap_type '-irlen' count "
879 "['-enable'|'-disable'] "
880 "['-expected_id' number] "
881 "['-ignore-version'] "
882 "['-ircapture' number] "
886 .name
= "tapisenabled",
887 .mode
= COMMAND_EXEC
,
888 .jim_handler
= jim_jtag_tap_enabler
,
889 .help
= "Returns a Tcl boolean (0/1) indicating whether "
890 "the TAP is enabled (1) or not (0).",
895 .mode
= COMMAND_EXEC
,
896 .jim_handler
= jim_jtag_tap_enabler
,
897 .help
= "Try to enable the specified TAP using the "
898 "'tap-enable' TAP event.",
902 .name
= "tapdisable",
903 .mode
= COMMAND_EXEC
,
904 .jim_handler
= jim_jtag_tap_enabler
,
905 .help
= "Try to disable the specified TAP using the "
906 "'tap-disable' TAP event.",
911 .mode
= COMMAND_EXEC
,
912 .jim_handler
= jim_jtag_configure
,
913 .help
= "Provide a Tcl handler for the specified "
915 .usage
= "tap_name '-event' event_name handler",
919 .mode
= COMMAND_EXEC
,
920 .jim_handler
= jim_jtag_configure
,
921 .help
= "Return any Tcl handler for the specified "
923 .usage
= "tap_name '-event' event_name",
928 .jim_handler
= jim_jtag_names
,
929 .help
= "Returns list of all JTAG tap names.",
932 .chain
= jtag_command_handlers_to_move
,
934 COMMAND_REGISTRATION_DONE
937 void jtag_notify_event(enum jtag_event event
)
939 struct jtag_tap
*tap
;
941 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
)
942 jtag_tap_handle_event(tap
, event
);
946 COMMAND_HANDLER(handle_scan_chain_command
)
948 struct jtag_tap
*tap
;
949 char expected_id
[12];
951 tap
= jtag_all_taps();
952 command_print(CMD_CTX
,
953 " TapName Enabled IdCode Expected IrLen IrCap IrMask");
954 command_print(CMD_CTX
,
955 "-- ------------------- -------- ---------- ---------- ----- ----- ------");
958 uint32_t expected
, expected_mask
, ii
;
960 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
961 (unsigned)((tap
->expected_ids_cnt
> 0)
962 ? tap
->expected_ids
[0]
964 if (tap
->ignore_version
)
965 expected_id
[2] = '*';
967 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
968 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
970 command_print(CMD_CTX
,
971 "%2d %-18s %c 0x%08x %s %5d 0x%02x 0x%02x",
972 tap
->abs_chain_position
,
974 tap
->enabled
? 'Y' : 'n',
975 (unsigned int)(tap
->idcode
),
977 (unsigned int)(tap
->ir_length
),
978 (unsigned int)(expected
),
979 (unsigned int)(expected_mask
));
981 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
982 snprintf(expected_id
, sizeof expected_id
, "0x%08x",
983 (unsigned) tap
->expected_ids
[1]);
984 if (tap
->ignore_version
)
985 expected_id
[2] = '*';
987 command_print(CMD_CTX
,
998 COMMAND_HANDLER(handle_jtag_ntrst_delay_command
)
1001 return ERROR_COMMAND_SYNTAX_ERROR
;
1005 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
1007 jtag_set_ntrst_delay(delay
);
1009 command_print(CMD_CTX
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
1013 COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command
)
1016 return ERROR_COMMAND_SYNTAX_ERROR
;
1020 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
1022 jtag_set_ntrst_assert_width(delay
);
1024 command_print(CMD_CTX
, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
1028 COMMAND_HANDLER(handle_jtag_rclk_command
)
1031 return ERROR_COMMAND_SYNTAX_ERROR
;
1033 int retval
= ERROR_OK
;
1037 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], khz
);
1039 retval
= jtag_config_rclk(khz
);
1040 if (ERROR_OK
!= retval
)
1044 int cur_khz
= jtag_get_speed_khz();
1045 retval
= jtag_get_speed_readable(&cur_khz
);
1046 if (ERROR_OK
!= retval
)
1050 command_print(CMD_CTX
, "RCLK not supported - fallback to %d kHz", cur_khz
);
1052 command_print(CMD_CTX
, "RCLK - adaptive");
1057 COMMAND_HANDLER(handle_jtag_reset_command
)
1060 return ERROR_COMMAND_SYNTAX_ERROR
;
1063 if (CMD_ARGV
[0][0] == '1')
1065 else if (CMD_ARGV
[0][0] == '0')
1068 return ERROR_COMMAND_SYNTAX_ERROR
;
1071 if (CMD_ARGV
[1][0] == '1')
1073 else if (CMD_ARGV
[1][0] == '0')
1076 return ERROR_COMMAND_SYNTAX_ERROR
;
1078 if (adapter_init(CMD_CTX
) != ERROR_OK
)
1079 return ERROR_JTAG_INIT_FAILED
;
1081 jtag_add_reset(trst
, srst
);
1082 return jtag_execute_queue();
1085 COMMAND_HANDLER(handle_runtest_command
)
1088 return ERROR_COMMAND_SYNTAX_ERROR
;
1090 unsigned num_clocks
;
1091 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num_clocks
);
1093 jtag_add_runtest(num_clocks
, TAP_IDLE
);
1094 return jtag_execute_queue();
1098 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1099 * should be stable ... and *NOT* a shift state, otherwise free-running
1100 * jtag clocks could change the values latched by the update state.
1101 * Not surprisingly, this is the same constraint as SVF; the "irscan"
1102 * and "drscan" commands are a write-only subset of what SVF provides.
1105 COMMAND_HANDLER(handle_irscan_command
)
1108 struct scan_field
*fields
;
1109 struct jtag_tap
*tap
= NULL
;
1110 tap_state_t endstate
;
1112 if ((CMD_ARGC
< 2) || (CMD_ARGC
% 2))
1114 return ERROR_COMMAND_SYNTAX_ERROR
;
1117 /* optional "-endstate" "statename" at the end of the arguments,
1118 * so that e.g. IRPAUSE can let us load the data register before
1119 * entering RUN/IDLE to execute the instruction we load here.
1121 endstate
= TAP_IDLE
;
1123 if (CMD_ARGC
>= 4) {
1124 /* have at least one pair of numbers. */
1125 /* is last pair the magic text? */
1126 if (strcmp("-endstate", CMD_ARGV
[CMD_ARGC
- 2]) == 0) {
1127 endstate
= tap_state_by_name(CMD_ARGV
[CMD_ARGC
- 1]);
1128 if (endstate
== TAP_INVALID
)
1129 return ERROR_COMMAND_SYNTAX_ERROR
;
1130 if (!scan_is_safe(endstate
))
1131 LOG_WARNING("unstable irscan endstate \"%s\"",
1132 CMD_ARGV
[CMD_ARGC
- 1]);
1137 int num_fields
= CMD_ARGC
/ 2;
1140 /* we really should be looking at plain_ir_scan if we want
1141 * anything more fancy.
1143 LOG_ERROR("Specify a single value for tap");
1144 return ERROR_COMMAND_SYNTAX_ERROR
;
1147 size_t fields_len
= sizeof(struct scan_field
) * num_fields
;
1148 fields
= malloc(fields_len
);
1149 memset(fields
, 0, fields_len
);
1152 for (i
= 0; i
< num_fields
; i
++)
1154 tap
= jtag_tap_by_string(CMD_ARGV
[i
*2]);
1158 for (j
= 0; j
< i
; j
++)
1159 free((void *)fields
[j
].out_value
);
1161 command_print(CMD_CTX
, "Tap: %s unknown", CMD_ARGV
[i
*2]);
1165 int field_size
= tap
->ir_length
;
1166 fields
[i
].num_bits
= field_size
;
1167 fields
[i
].out_value
= malloc(DIV_ROUND_UP(field_size
, 8));
1170 retval
= parse_u32(CMD_ARGV
[i
* 2 + 1], &value
);
1171 if (ERROR_OK
!= retval
)
1173 void *v
= (void *)fields
[i
].out_value
;
1174 buf_set_u32(v
, 0, field_size
, value
);
1175 fields
[i
].in_value
= NULL
;
1178 /* did we have an endstate? */
1179 jtag_add_ir_scan(tap
, fields
, endstate
);
1181 retval
= jtag_execute_queue();
1184 for (i
= 0; i
< num_fields
; i
++)
1186 if (NULL
!= fields
[i
].out_value
)
1187 free((void *)fields
[i
].out_value
);
1196 COMMAND_HANDLER(handle_verify_ircapture_command
)
1199 return ERROR_COMMAND_SYNTAX_ERROR
;
1204 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1205 jtag_set_verify_capture_ir(enable
);
1208 const char *status
= jtag_will_verify_capture_ir() ? "enabled": "disabled";
1209 command_print(CMD_CTX
, "verify Capture-IR is %s", status
);
1214 COMMAND_HANDLER(handle_verify_jtag_command
)
1217 return ERROR_COMMAND_SYNTAX_ERROR
;
1222 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], enable
);
1223 jtag_set_verify(enable
);
1226 const char *status
= jtag_will_verify() ? "enabled": "disabled";
1227 command_print(CMD_CTX
, "verify jtag capture is %s", status
);
1232 COMMAND_HANDLER(handle_tms_sequence_command
)
1235 return ERROR_COMMAND_SYNTAX_ERROR
;
1240 if (strcmp(CMD_ARGV
[0], "short") == 0)
1241 use_new_table
= true;
1242 else if (strcmp(CMD_ARGV
[0], "long") == 0)
1243 use_new_table
= false;
1245 return ERROR_COMMAND_SYNTAX_ERROR
;
1247 tap_use_new_tms_table(use_new_table
);
1250 command_print(CMD_CTX
, "tms sequence is %s",
1251 tap_uses_new_tms_table() ? "short": "long");
1256 COMMAND_HANDLER(handle_jtag_flush_queue_sleep
)
1259 return ERROR_COMMAND_SYNTAX_ERROR
;
1262 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], sleep_ms
);
1264 jtag_set_flush_queue_sleep(sleep_ms
);
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",
1311 .name
= "jtag_reset",
1312 .handler
= handle_jtag_reset_command
,
1313 .mode
= COMMAND_EXEC
,
1314 .help
= "Set reset line values. Value '1' is active, "
1315 "value '0' is inactive.",
1316 .usage
= "trst_active srst_active",
1320 .handler
= handle_runtest_command
,
1321 .mode
= COMMAND_EXEC
,
1322 .help
= "Move to Run-Test/Idle, and issue TCK for num_cycles.",
1323 .usage
= "num_cycles"
1327 .handler
= handle_irscan_command
,
1328 .mode
= COMMAND_EXEC
,
1329 .help
= "Execute Instruction Register (DR) scan. The "
1330 "specified opcodes are put into each TAP's IR, "
1331 "and other TAPs are put in BYPASS.",
1332 .usage
= "[tap_name instruction]* ['-endstate' state_name]",
1335 .name
= "verify_ircapture",
1336 .handler
= handle_verify_ircapture_command
,
1337 .mode
= COMMAND_ANY
,
1338 .help
= "Display or assign flag controlling whether to "
1339 "verify values captured during Capture-IR.",
1340 .usage
= "['enable'|'disable']",
1343 .name
= "verify_jtag",
1344 .handler
= handle_verify_jtag_command
,
1345 .mode
= COMMAND_ANY
,
1346 .help
= "Display or assign flag controlling whether to "
1347 "verify values captured during IR and DR scans.",
1348 .usage
= "['enable'|'disable']",
1351 .name
= "tms_sequence",
1352 .handler
= handle_tms_sequence_command
,
1353 .mode
= COMMAND_ANY
,
1354 .help
= "Display or change what style TMS sequences to use "
1355 "for JTAG state transitions: short (default) or "
1356 "long. Only for working around JTAG bugs.",
1357 /* Specifically for working around DRIVER bugs... */
1358 .usage
= "['short'|'long']",
1362 .mode
= COMMAND_ANY
,
1363 .help
= "perform jtag tap actions",
1365 .chain
= jtag_subcommand_handlers
,
1368 .chain
= jtag_command_handlers_to_move
,
1370 COMMAND_REGISTRATION_DONE
1373 int jtag_register_commands(struct command_context
*cmd_ctx
)
1375 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)