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, see <http://www.gnu.org/licenses/>. *
27 ***************************************************************************/
36 #include "minidriver.h"
37 #include "interface.h"
38 #include "interfaces.h"
45 #include <helper/time_support.h>
46 #include "transport/transport.h"
50 * Holds support for accessing JTAG-specific mechanisms from TCl scripts.
53 static const struct 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 /* validate arguments as numbers */
114 for (i = 2; i < argc; i += 2) {
118 e = Jim_GetLong(interp, args[i], &bits);
119 /* If valid - try next arg */
123 /* Not valid.. are we at the end? */
124 if (((i + 2) != argc)) {
125 /* nope, then error */
129 /* it could be: "-endstate FOO"
130 * e.g. DRPAUSE so we can issue more instructions
131 * before entering RUN/IDLE and executing them.
134 /* get arg as a string. */
135 cp = Jim_GetString(args[i], NULL);
136 /* is it the magic? */
137 if (strcmp("-endstate", cp) == 0) {
138 /* is the statename valid? */
139 cp = Jim_GetString(args[i + 1], NULL);
141 /* see if it is a valid state name */
142 endstate = tap_state_by_name(cp);
144 /* update the error message */
145 Jim_SetResultFormatted(interp, "endstate: %s invalid", cp);
147 if (!scan_is_safe(endstate))
148 LOG_WARNING("drscan with unsafe "
149 "endstate \"%s\"", cp);
151 /* valid - so clear the error */
153 /* and remove the last 2 args */
158 /* Still an error? */
160 return e; /* too bad */
161 } /* validate args */
165 tap = jtag_tap_by_jim_obj(interp, args[1]);
169 num_fields = (argc-2)/2;
170 if (num_fields <= 0) {
171 Jim_SetResultString(interp, "drscan: no scan fields supplied", -1);
174 fields = malloc(sizeof(struct scan_field) * num_fields);
175 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) {
195 Jim_SetResultString(interp, "drscan: jtag execute failed", -1);
197 for (i = 0; i < field_count; i++)
198 free(fields[i].in_value);
205 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
206 for (i = 2; i < argc; i += 2) {
210 Jim_GetLong(interp, args[i], &bits);
211 str = buf_to_hex_str(fields[field_count].in_value, bits);
212 free(fields[field_count].in_value);
214 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
219 Jim_SetResult(interp, list);
227 static int jim_command_pathmove(Jim_Interp *interp, int argc, Jim_Obj * const *args)
229 tap_state_t states[8];
231 if ((argc < 2) || ((size_t)argc > (ARRAY_SIZE(states) + 1))) {
232 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
237 for (i = 0; i < argc-1; i++) {
239 cp = Jim_GetString(args[i + 1], NULL);
240 states[i] = tap_state_by_name(cp);
242 /* update the error message */
243 Jim_SetResultFormatted(interp, "endstate: %s invalid", cp);
248 if ((jtag_add_statemove(states[0]) != ERROR_OK) || (jtag_execute_queue() != ERROR_OK)) {
249 Jim_SetResultString(interp, "pathmove: jtag execute failed", -1);
253 jtag_add_pathmove(argc - 2, states + 1);
255 if (jtag_execute_queue() != ERROR_OK) {
256 Jim_SetResultString(interp, "pathmove: failed", -1);
264 static int jim_command_flush_count(Jim_Interp *interp, int argc, Jim_Obj * const *args)
266 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_get_flush_queue_count()));
271 /* REVISIT Just what about these should "move" ... ?
272 * These registrations, into the main JTAG table?
274 * There's a minor compatibility issue, these all show up twice;
275 * that's not desirable:
276 * - jtag drscan ... NOT DOCUMENTED!
279 * The "irscan" command (for example) doesn't show twice.
281 static const struct command_registration jtag_command_handlers_to_move[] = {
284 .mode = COMMAND_EXEC,
285 .jim_handler = jim_command_drscan,
286 .help = "Execute Data Register (DR) scan for one TAP. "
287 "Other TAPs must be in BYPASS mode.",
288 .usage = "tap_name [num_bits value]* ['-endstate' state_name]",
291 .name = "flush_count",
292 .mode = COMMAND_EXEC,
293 .jim_handler = jim_command_flush_count,
294 .help = "Returns the number of times the JTAG queue "
299 .mode = COMMAND_EXEC,
300 .jim_handler = jim_command_pathmove,
301 .usage = "start_state state1 [state2 [state3 ...]]",
302 .help = "Move JTAG state machine from current state "
303 "(start_state) to state1, then state2, state3, etc.",
305 COMMAND_REGISTRATION_DONE
309 enum jtag_tap_cfg_param {
314 static struct jim_nvp nvp_config_opts[] = {
315 { .name = "-event", .value = JCFG_EVENT },
316 { .name = "-idcode", .value = JCFG_IDCODE },
318 { .name = NULL, .value = -1 }
321 static int jtag_tap_configure_event(struct jim_getopt_info *goi, struct jtag_tap *tap)
323 if (goi->argc == 0) {
324 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event <event-name> ...");
329 int e = jim_getopt_nvp(goi, nvp_jtag_tap_event, &n);
331 jim_getopt_nvp_unknown(goi, nvp_jtag_tap_event, 1);
335 if (goi->isconfigure) {
336 if (goi->argc != 1) {
337 Jim_WrongNumArgs(goi->interp,
340 "-event <event-name> <event-body>");
344 if (goi->argc != 0) {
345 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event <event-name>");
350 struct jtag_tap_event_action *jteap = tap->event_action;
351 /* replace existing event body */
354 if (jteap->event == (enum jtag_event)n->value) {
361 Jim_SetEmptyResult(goi->interp);
363 if (goi->isconfigure) {
365 jteap = calloc(1, sizeof(*jteap));
366 else if (jteap->body)
367 Jim_DecrRefCount(goi->interp, jteap->body);
369 jteap->interp = goi->interp;
370 jteap->event = n->value;
373 jim_getopt_obj(goi, &o);
374 jteap->body = Jim_DuplicateObj(goi->interp, o);
375 Jim_IncrRefCount(jteap->body);
378 /* add to head of event list */
379 jteap->next = tap->event_action;
380 tap->event_action = jteap;
383 jteap->interp = goi->interp;
384 Jim_SetResult(goi->interp,
385 Jim_DuplicateObj(goi->interp, jteap->body));
390 static int jtag_tap_configure_cmd(struct jim_getopt_info *goi, struct jtag_tap *tap)
392 /* parse config or cget options */
393 while (goi->argc > 0) {
394 Jim_SetEmptyResult(goi->interp);
397 int e = jim_getopt_nvp(goi, nvp_config_opts, &n);
399 jim_getopt_nvp_unknown(goi, nvp_config_opts, 0);
405 e = jtag_tap_configure_event(goi, tap);
410 if (goi->isconfigure) {
411 Jim_SetResultFormatted(goi->interp,
412 "not settable: %s", n->name);
415 if (goi->argc != 0) {
416 Jim_WrongNumArgs(goi->interp,
417 goi->argc, goi->argv,
422 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, tap->idcode));
425 Jim_SetResultFormatted(goi->interp, "unknown value: %s", n->name);
433 static int is_bad_irval(int ir_length, jim_wide w)
443 static int jim_newtap_expected_id(struct jim_nvp *n, struct jim_getopt_info *goi,
444 struct jtag_tap *tap)
447 int e = jim_getopt_wide(goi, &w);
449 Jim_SetResultFormatted(goi->interp, "option: %s bad parameter", n->name);
453 uint32_t *p = realloc(tap->expected_ids,
454 (tap->expected_ids_cnt + 1) * sizeof(uint32_t));
456 Jim_SetResultFormatted(goi->interp, "no memory");
460 tap->expected_ids = p;
461 tap->expected_ids[tap->expected_ids_cnt++] = w;
466 #define NTAP_OPT_IRLEN 0
467 #define NTAP_OPT_IRMASK 1
468 #define NTAP_OPT_IRCAPTURE 2
469 #define NTAP_OPT_ENABLED 3
470 #define NTAP_OPT_DISABLED 4
471 #define NTAP_OPT_EXPECTED_ID 5
472 #define NTAP_OPT_VERSION 6
474 static int jim_newtap_ir_param(struct jim_nvp *n, struct jim_getopt_info *goi,
475 struct jtag_tap *tap)
478 int e = jim_getopt_wide(goi, &w);
480 Jim_SetResultFormatted(goi->interp,
481 "option: %s bad parameter", n->name);
486 if (w > (jim_wide) (8 * sizeof(tap->ir_capture_value))) {
487 LOG_WARNING("%s: huge IR length %d",
488 tap->dotted_name, (int) w);
492 case NTAP_OPT_IRMASK:
493 if (is_bad_irval(tap->ir_length, w)) {
494 LOG_ERROR("%s: IR mask %x too big",
500 LOG_WARNING("%s: nonstandard IR mask", tap->dotted_name);
501 tap->ir_capture_mask = w;
503 case NTAP_OPT_IRCAPTURE:
504 if (is_bad_irval(tap->ir_length, w)) {
505 LOG_ERROR("%s: IR capture %x too big",
506 tap->dotted_name, (int) w);
510 LOG_WARNING("%s: nonstandard IR value",
512 tap->ir_capture_value = w;
520 static int jim_newtap_cmd(struct jim_getopt_info *goi)
522 struct jtag_tap *tap;
527 const struct jim_nvp opts[] = {
528 { .name = "-irlen", .value = NTAP_OPT_IRLEN },
529 { .name = "-irmask", .value = NTAP_OPT_IRMASK },
530 { .name = "-ircapture", .value = NTAP_OPT_IRCAPTURE },
531 { .name = "-enable", .value = NTAP_OPT_ENABLED },
532 { .name = "-disable", .value = NTAP_OPT_DISABLED },
533 { .name = "-expected-id", .value = NTAP_OPT_EXPECTED_ID },
534 { .name = "-ignore-version", .value = NTAP_OPT_VERSION },
535 { .name = NULL, .value = -1 },
538 tap = calloc(1, sizeof(struct jtag_tap));
540 Jim_SetResultFormatted(goi->interp, "no memory");
545 * we expect CHIP + TAP + OPTIONS
548 Jim_SetResultFormatted(goi->interp, "Missing CHIP TAP OPTIONS ....");
554 jim_getopt_string(goi, &tmp, NULL);
555 tap->chip = strdup(tmp);
557 jim_getopt_string(goi, &tmp, NULL);
558 tap->tapname = strdup(tmp);
560 /* name + dot + name + null */
561 x = strlen(tap->chip) + 1 + strlen(tap->tapname) + 1;
563 sprintf(cp, "%s.%s", tap->chip, tap->tapname);
564 tap->dotted_name = cp;
566 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
567 tap->chip, tap->tapname, tap->dotted_name, goi->argc);
569 if (!transport_is_jtag()) {
570 /* SWD doesn't require any JTAG tap parameters */
576 /* IEEE specifies that the two LSBs of an IR scan are 01, so make
577 * that the default. The "-ircapture" and "-irmask" options are only
578 * needed to cope with nonstandard TAPs, or to specify more bits.
580 tap->ir_capture_mask = 0x03;
581 tap->ir_capture_value = 0x01;
584 e = jim_getopt_nvp(goi, opts, &n);
586 jim_getopt_nvp_unknown(goi, opts, 0);
591 LOG_DEBUG("Processing option: %s", n->name);
593 case NTAP_OPT_ENABLED:
594 tap->disabled_after_reset = false;
596 case NTAP_OPT_DISABLED:
597 tap->disabled_after_reset = true;
599 case NTAP_OPT_EXPECTED_ID:
600 e = jim_newtap_expected_id(n, goi, tap);
608 case NTAP_OPT_IRMASK:
609 case NTAP_OPT_IRCAPTURE:
610 e = jim_newtap_ir_param(n, goi, tap);
617 case NTAP_OPT_VERSION:
618 tap->ignore_version = true;
620 } /* switch (n->value) */
621 } /* while (goi->argc) */
623 /* default is enabled-after-reset */
624 tap->enabled = !tap->disabled_after_reset;
626 /* Did all the required option bits get cleared? */
627 if (tap->ir_length != 0) {
632 Jim_SetResultFormatted(goi->interp,
633 "newtap: %s missing IR length",
639 static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
641 struct jtag_tap_event_action *jteap;
644 for (jteap = tap->event_action; jteap; jteap = jteap->next) {
645 if (jteap->event != e)
648 struct jim_nvp *nvp = jim_nvp_value2name_simple(nvp_jtag_tap_event, e);
649 LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
650 tap->dotted_name, e, nvp->name,
651 Jim_GetString(jteap->body, NULL));
653 retval = Jim_EvalObj(jteap->interp, jteap->body);
654 if (retval == JIM_RETURN)
655 retval = jteap->interp->returnCode;
657 if (retval != JIM_OK) {
658 Jim_MakeErrorMessage(jteap->interp);
659 LOG_USER("%s", 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)
682 struct jim_getopt_info goi;
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 *obj = Jim_NewIntObj(goi.interp, e);
692 Jim_SetResultFormatted(goi.interp, "error: %#s", obj);
698 static int jim_jtag_arp_init_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
701 struct jim_getopt_info goi;
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 if (transport_is_jtag())
709 e = jtag_init_reset(context);
710 else if (transport_is_swd())
711 e = swd_init_reset(context);
714 Jim_Obj *obj = Jim_NewIntObj(goi.interp, e);
715 Jim_SetResultFormatted(goi.interp, "error: %#s", obj);
721 int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
723 struct jim_getopt_info goi;
724 jim_getopt_setup(&goi, interp, argc-1, argv + 1);
725 return jim_newtap_cmd(&goi);
728 static bool jtag_tap_enable(struct jtag_tap *t)
732 jtag_tap_handle_event(t, JTAG_TAP_EVENT_ENABLE);
736 /* FIXME add JTAG sanity checks, w/o TLR
737 * - scan chain length grew by one (this)
738 * - IDs and IR lengths are as expected
740 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE);
743 static bool jtag_tap_disable(struct jtag_tap *t)
747 jtag_tap_handle_event(t, JTAG_TAP_EVENT_DISABLE);
751 /* FIXME add JTAG sanity checks, w/o TLR
752 * - scan chain length shrank by one (this)
753 * - IDs and IR lengths are as expected
755 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE);
759 int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
761 struct command *c = jim_to_command(interp);
762 const char *cmd_name = c->name;
763 struct jim_getopt_info goi;
764 jim_getopt_setup(&goi, interp, argc-1, argv + 1);
766 Jim_SetResultFormatted(goi.interp, "usage: %s <name>", cmd_name);
772 t = jtag_tap_by_jim_obj(goi.interp, goi.argv[0]);
776 if (strcasecmp(cmd_name, "tapisenabled") == 0) {
777 /* do nothing, just return the value */
778 } else if (strcasecmp(cmd_name, "tapenable") == 0) {
779 if (!jtag_tap_enable(t)) {
780 LOG_WARNING("failed to enable tap %s", t->dotted_name);
783 } else if (strcasecmp(cmd_name, "tapdisable") == 0) {
784 if (!jtag_tap_disable(t)) {
785 LOG_WARNING("failed to disable tap %s", t->dotted_name);
789 LOG_ERROR("command '%s' unknown", cmd_name);
793 Jim_SetResult(goi.interp, Jim_NewIntObj(goi.interp, e));
797 int jim_jtag_configure(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
799 struct command *c = jim_to_command(interp);
800 const char *cmd_name = c->name;
801 struct jim_getopt_info goi;
802 jim_getopt_setup(&goi, interp, argc-1, argv + 1);
803 goi.isconfigure = !strcmp(cmd_name, "configure");
804 if (goi.argc < 2 + goi.isconfigure) {
805 Jim_WrongNumArgs(goi.interp, 0, NULL,
806 "<tap_name> <attribute> ...");
813 jim_getopt_obj(&goi, &o);
814 t = jtag_tap_by_jim_obj(goi.interp, o);
818 return jtag_tap_configure_cmd(&goi, t);
821 static int jim_jtag_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
823 struct jim_getopt_info goi;
824 jim_getopt_setup(&goi, interp, argc-1, argv + 1);
826 Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters");
829 Jim_SetResult(goi.interp, Jim_NewListObj(goi.interp, NULL, 0));
830 struct jtag_tap *tap;
832 for (tap = jtag_all_taps(); tap; tap = tap->next_tap) {
833 Jim_ListAppendElement(goi.interp,
834 Jim_GetResult(goi.interp),
835 Jim_NewStringObj(goi.interp,
836 tap->dotted_name, -1));
841 COMMAND_HANDLER(handle_jtag_init_command)
844 return ERROR_COMMAND_SYNTAX_ERROR;
846 static bool jtag_initialized;
847 if (jtag_initialized) {
848 LOG_INFO("'jtag init' has already been called");
851 jtag_initialized = true;
853 LOG_DEBUG("Initializing jtag devices...");
854 return jtag_init(CMD_CTX);
857 static const struct command_registration jtag_subcommand_handlers[] = {
861 .handler = handle_jtag_init_command,
862 .help = "initialize jtag scan chain",
868 .jim_handler = jim_jtag_arp_init,
869 .help = "Validates JTAG scan chain against the list of "
870 "declared TAPs using just the four standard JTAG "
874 .name = "arp_init-reset",
876 .jim_handler = jim_jtag_arp_init_reset,
877 .help = "Uses TRST and SRST to try resetting everything on "
878 "the JTAG scan chain, then performs 'jtag arp_init'."
882 .mode = COMMAND_CONFIG,
883 .jim_handler = jim_jtag_newtap,
884 .help = "Create a new TAP instance named basename.tap_type, "
885 "and appends it to the scan chain.",
886 .usage = "basename tap_type '-irlen' count "
887 "['-enable'|'-disable'] "
888 "['-expected_id' number] "
889 "['-ignore-version'] "
890 "['-ircapture' number] "
894 .name = "tapisenabled",
895 .mode = COMMAND_EXEC,
896 .jim_handler = jim_jtag_tap_enabler,
897 .help = "Returns a Tcl boolean (0/1) indicating whether "
898 "the TAP is enabled (1) or not (0).",
903 .mode = COMMAND_EXEC,
904 .jim_handler = jim_jtag_tap_enabler,
905 .help = "Try to enable the specified TAP using the "
906 "'tap-enable' TAP event.",
910 .name = "tapdisable",
911 .mode = COMMAND_EXEC,
912 .jim_handler = jim_jtag_tap_enabler,
913 .help = "Try to disable the specified TAP using the "
914 "'tap-disable' TAP event.",
920 .jim_handler = jim_jtag_configure,
921 .help = "Provide a Tcl handler for the specified "
923 .usage = "tap_name '-event' event_name handler",
927 .mode = COMMAND_EXEC,
928 .jim_handler = jim_jtag_configure,
929 .help = "Return any Tcl handler for the specified "
931 .usage = "tap_name '-event' event_name",
936 .jim_handler = jim_jtag_names,
937 .help = "Returns list of all JTAG tap names.",
940 .chain = jtag_command_handlers_to_move,
942 COMMAND_REGISTRATION_DONE
945 void jtag_notify_event(enum jtag_event event)
947 struct jtag_tap *tap;
949 for (tap = jtag_all_taps(); tap; tap = tap->next_tap)
950 jtag_tap_handle_event(tap, event);
954 COMMAND_HANDLER(handle_scan_chain_command)
956 struct jtag_tap *tap;
957 char expected_id[12];
959 tap = jtag_all_taps();
961 " TapName Enabled IdCode Expected IrLen IrCap IrMask");
963 "-- ------------------- -------- ---------- ---------- ----- ----- ------");
966 uint32_t expected, expected_mask, ii;
968 snprintf(expected_id, sizeof(expected_id), "0x%08x",
969 (unsigned)((tap->expected_ids_cnt > 0)
970 ? tap->expected_ids[0]
972 if (tap->ignore_version)
973 expected_id[2] = '*';
975 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
976 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
979 "%2d %-18s %c 0x%08x %s %5d 0x%02x 0x%02x",
980 tap->abs_chain_position,
982 tap->enabled ? 'Y' : 'n',
983 (unsigned int)(tap->idcode),
985 (unsigned int)(tap->ir_length),
986 (unsigned int)(expected),
987 (unsigned int)(expected_mask));
989 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
990 snprintf(expected_id, sizeof(expected_id), "0x%08x",
991 (unsigned) tap->expected_ids[ii]);
992 if (tap->ignore_version)
993 expected_id[2] = '*';
1000 tap = tap->next_tap;
1006 COMMAND_HANDLER(handle_jtag_ntrst_delay_command)
1009 return ERROR_COMMAND_SYNTAX_ERROR;
1010 if (CMD_ARGC == 1) {
1012 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay);
1014 jtag_set_ntrst_delay(delay);
1016 command_print(CMD, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
1020 COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command)
1023 return ERROR_COMMAND_SYNTAX_ERROR;
1024 if (CMD_ARGC == 1) {
1026 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay);
1028 jtag_set_ntrst_assert_width(delay);
1030 command_print(CMD, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
1034 COMMAND_HANDLER(handle_jtag_rclk_command)
1037 return ERROR_COMMAND_SYNTAX_ERROR;
1039 int retval = ERROR_OK;
1040 if (CMD_ARGC == 1) {
1042 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz);
1044 retval = adapter_config_rclk(khz);
1045 if (retval != ERROR_OK)
1049 int cur_khz = adapter_get_speed_khz();
1050 retval = adapter_get_speed_readable(&cur_khz);
1051 if (retval != ERROR_OK)
1055 command_print(CMD, "RCLK not supported - fallback to %d kHz", cur_khz);
1057 command_print(CMD, "RCLK - adaptive");
1062 COMMAND_HANDLER(handle_runtest_command)
1065 return ERROR_COMMAND_SYNTAX_ERROR;
1067 unsigned num_clocks;
1068 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num_clocks);
1070 jtag_add_runtest(num_clocks, TAP_IDLE);
1071 return jtag_execute_queue();
1075 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1076 * should be stable ... and *NOT* a shift state, otherwise free-running
1077 * jtag clocks could change the values latched by the update state.
1078 * Not surprisingly, this is the same constraint as SVF; the "irscan"
1079 * and "drscan" commands are a write-only subset of what SVF provides.
1082 COMMAND_HANDLER(handle_irscan_command)
1085 struct scan_field *fields;
1086 struct jtag_tap *tap = NULL;
1087 tap_state_t endstate;
1089 if ((CMD_ARGC < 2) || (CMD_ARGC % 2))
1090 return ERROR_COMMAND_SYNTAX_ERROR;
1092 /* optional "-endstate" "statename" at the end of the arguments,
1093 * so that e.g. IRPAUSE can let us load the data register before
1094 * entering RUN/IDLE to execute the instruction we load here.
1096 endstate = TAP_IDLE;
1098 if (CMD_ARGC >= 4) {
1099 /* have at least one pair of numbers.
1100 * is last pair the magic text? */
1101 if (strcmp("-endstate", CMD_ARGV[CMD_ARGC - 2]) == 0) {
1102 endstate = tap_state_by_name(CMD_ARGV[CMD_ARGC - 1]);
1103 if (endstate == TAP_INVALID)
1104 return ERROR_COMMAND_SYNTAX_ERROR;
1105 if (!scan_is_safe(endstate))
1106 LOG_WARNING("unstable irscan endstate \"%s\"",
1107 CMD_ARGV[CMD_ARGC - 1]);
1112 int num_fields = CMD_ARGC / 2;
1113 if (num_fields > 1) {
1114 /* we really should be looking at plain_ir_scan if we want
1115 * anything more fancy.
1117 LOG_ERROR("Specify a single value for tap");
1118 return ERROR_COMMAND_SYNTAX_ERROR;
1121 fields = calloc(num_fields, sizeof(*fields));
1124 for (i = 0; i < num_fields; i++) {
1125 tap = jtag_tap_by_string(CMD_ARGV[i*2]);
1128 command_print(CMD, "Tap: %s unknown", CMD_ARGV[i*2]);
1133 retval = parse_u64(CMD_ARGV[i * 2 + 1], &value);
1134 if (retval != ERROR_OK)
1137 int field_size = tap->ir_length;
1138 fields[i].num_bits = field_size;
1139 uint8_t *v = calloc(1, DIV_ROUND_UP(field_size, 8));
1141 LOG_ERROR("Out of memory");
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 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, "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, "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, "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 int64_t 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",
1311 .handler = handle_runtest_command,
1312 .mode = COMMAND_EXEC,
1313 .help = "Move to Run-Test/Idle, and issue TCK for num_cycles.",
1314 .usage = "num_cycles"
1318 .handler = handle_irscan_command,
1319 .mode = COMMAND_EXEC,
1320 .help = "Execute Instruction Register (IR) scan. The "
1321 "specified opcodes are put into each TAP's IR, "
1322 "and other TAPs are put in BYPASS.",
1323 .usage = "[tap_name instruction]* ['-endstate' state_name]",
1326 .name = "verify_ircapture",
1327 .handler = handle_verify_ircapture_command,
1328 .mode = COMMAND_ANY,
1329 .help = "Display or assign flag controlling whether to "
1330 "verify values captured during Capture-IR.",
1331 .usage = "['enable'|'disable']",
1334 .name = "verify_jtag",
1335 .handler = handle_verify_jtag_command,
1336 .mode = COMMAND_ANY,
1337 .help = "Display or assign flag controlling whether to "
1338 "verify values captured during IR and DR scans.",
1339 .usage = "['enable'|'disable']",
1342 .name = "tms_sequence",
1343 .handler = handle_tms_sequence_command,
1344 .mode = COMMAND_ANY,
1345 .help = "Display or change what style TMS sequences to use "
1346 "for JTAG state transitions: short (default) or "
1347 "long. Only for working around JTAG bugs.",
1348 /* Specifically for working around DRIVER bugs... */
1349 .usage = "['short'|'long']",
1352 .name = "wait_srst_deassert",
1353 .handler = handle_wait_srst_deassert,
1354 .mode = COMMAND_ANY,
1355 .help = "Wait for an SRST deassert. "
1356 "Useful for cases where you need something to happen within ms "
1357 "of an srst deassert. Timeout in ms",
1362 .mode = COMMAND_ANY,
1363 .help = "perform jtag tap actions",
1366 .chain = jtag_subcommand_handlers,
1369 .chain = jtag_command_handlers_to_move,
1371 COMMAND_REGISTRATION_DONE
1374 int jtag_register_commands(struct command_context *cmd_ctx)
1376 return register_commands(cmd_ctx, NULL, jtag_command_handlers);