JTAG: "jtag newtap ..." cleanup
[openocd.git] / src / jtag / tcl.c
index aa32085b0f22104d56387ad48dd89f49c344d3df..5056a5c5d58ac10acdd9438f65a72628979d94ae 100644 (file)
@@ -41,7 +41,8 @@
 #endif
 
 static const Jim_Nvp nvp_jtag_tap_event[] = {
-       { .value = JTAG_TAP_EVENT_POST_RESET,   .name = "post-reset" },
+       { .value = JTAG_TRST_ASSERTED,          .name = "post-reset" },
+       { .value = JTAG_TAP_EVENT_SETUP,        .name = "setup" },
        { .value = JTAG_TAP_EVENT_ENABLE,       .name = "tap-enable" },
        { .value = JTAG_TAP_EVENT_DISABLE,      .name = "tap-disable" },
 
@@ -61,6 +62,8 @@ static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *c
 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_nsrst_assert_width_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_ntrst_assert_width_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
@@ -194,7 +197,6 @@ static int jim_newtap_cmd(Jim_GetOptInfo *goi)
        jim_wide w;
        int x;
        int e;
-       int reqbits;
        Jim_Nvp *n;
        char *cp;
        const Jim_Nvp opts[] = {
@@ -249,9 +251,6 @@ static int jim_newtap_cmd(Jim_GetOptInfo *goi)
        pTap->ir_capture_mask = 0x03;
        pTap->ir_capture_value = 0x01;
 
-       /* clear flags for "required options" them as we find them */
-       reqbits = 1;
-
        while (goi->argc) {
                e = Jim_GetOpt_Nvp(goi, opts, &n);
                if (e != JIM_OK) {
@@ -314,7 +313,6 @@ static int jim_newtap_cmd(Jim_GetOptInfo *goi)
                                                        pTap->dotted_name,
                                                        (int) w);
                                pTap->ir_length = w;
-                               reqbits = 0;
                                break;
                        case NTAP_OPT_IRMASK:
                                if (is_bad_irval(pTap->ir_length, w)) {
@@ -352,14 +350,14 @@ static int jim_newtap_cmd(Jim_GetOptInfo *goi)
        pTap->enabled = !pTap->disabled_after_reset;
 
        /* Did all the required option bits get cleared? */
-       if (0 == reqbits)
+       if (pTap->ir_length != 0)
        {
                jtag_tap_init(pTap);
                return ERROR_OK;
        }
 
        Jim_SetResult_sprintf(goi->interp,
-                       "newtap: %s missing required parameters",
+                       "newtap: %s missing IR length",
                        pTap->dotted_name);
        jtag_tap_free(pTap);
        return JIM_ERR;
@@ -371,7 +369,7 @@ static void jtag_tap_handle_event(jtag_tap_t *tap, enum jtag_event e)
 
        for (jteap = tap->event_action; jteap != NULL; jteap = jteap->next) {
                if (jteap->event == e) {
-                       LOG_DEBUG("JTAG tap: %s event: %d (%s) action: %s\n",
+                       LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
                                        tap->dotted_name,
                                        e,
                                        Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
@@ -382,10 +380,12 @@ static void jtag_tap_handle_event(jtag_tap_t *tap, enum jtag_event e)
                        case JTAG_TAP_EVENT_ENABLE:
                        case JTAG_TAP_EVENT_DISABLE:
                                /* NOTE:  we currently assume the handlers
-                                * can't fail.  That presumes later code
-                                * will be verifying the scan chains ...
+                                * can't fail.  Right here is where we should
+                                * really be verifying the scan chains ...
                                 */
                                tap->enabled = (e == JTAG_TAP_EVENT_ENABLE);
+                               LOG_INFO("JTAG tap: %s %s", tap->dotted_name,
+                                       tap->enabled ? "enabled" : "disabled");
                                break;
                        default:
                                break;
@@ -405,6 +405,7 @@ static int jim_jtag_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        enum {
                JTAG_CMD_INTERFACE,
+               JTAG_CMD_INIT,
                JTAG_CMD_INIT_RESET,
                JTAG_CMD_NEWTAP,
                JTAG_CMD_TAPENABLE,
@@ -417,6 +418,7 @@ static int jim_jtag_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        const Jim_Nvp jtag_cmds[] = {
                { .name = "interface"     , .value = JTAG_CMD_INTERFACE },
+               { .name = "arp_init"      , .value = JTAG_CMD_INIT },
                { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
                { .name = "newtap"        , .value = JTAG_CMD_NEWTAP },
                { .name = "tapisenabled"     , .value = JTAG_CMD_TAPISENABLED },
@@ -450,6 +452,17 @@ static int jim_jtag_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                }
                Jim_SetResultString(goi.interp, jtag_interface->name, -1);
                return JIM_OK;
+       case JTAG_CMD_INIT:
+               if (goi.argc != 0) {
+                       Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
+                       return JIM_ERR;
+               }
+               e = jtag_init_inner(context);
+               if (e != ERROR_OK) {
+                       Jim_SetResult_sprintf(goi.interp, "error: %d", e);
+                       return JIM_ERR;
+               }
+               return JIM_OK;
        case JTAG_CMD_INIT_RESET:
                if (goi.argc != 0) {
                        Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
@@ -584,13 +597,12 @@ static int jim_jtag_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 }
 
 
-void jtag_notify_reset(void)
+void jtag_notify_event(enum jtag_event event)
 {
        jtag_tap_t *tap;
+
        for (tap = jtag_all_taps(); tap; tap = tap->next_tap)
-       {
-               jtag_tap_handle_event(tap, JTAG_TAP_EVENT_POST_RESET);
-       }
+               jtag_tap_handle_event(tap, event);
 }
 
 
@@ -614,11 +626,20 @@ int jtag_register_commands(struct command_context_s *cmd_ctx)
                COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
        register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
                COMMAND_ANY,
-               "[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
+               "reset_config "
+               "[none|trst_only|srst_only|trst_and_srst] "
+               "[srst_pulls_trst|trst_pulls_srst|combined|separate] "
+               "[srst_gates_jtag|srst_nogate] "
+               "[trst_push_pull|trst_open_drain] "
+               "[srst_push_pull|srst_open_drain]");
        register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
                COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
        register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
                COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
+       register_command(cmd_ctx, NULL, "jtag_nsrst_assert_width", handle_jtag_nsrst_assert_width_command,
+               COMMAND_ANY, "jtag_nsrst_assert_width <ms> - delay after asserting srst in ms");
+       register_command(cmd_ctx, NULL, "jtag_ntrst_assert_width", handle_jtag_ntrst_assert_width_command,
+               COMMAND_ANY, "jtag_ntrst_assert_width <ms> - delay after asserting trst in ms");
 
        register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
                COMMAND_EXEC, "print current scan chain configuration");
@@ -830,9 +851,6 @@ static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *
        int new_cfg = 0;
        int mask = 0;
 
-       if (argc < 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
        /* Original versions cared about the order of these tokens:
         *   reset_config signals [combination [trst_type [srst_type]]]
         * They also clobbered the previous configuration even on error.
@@ -844,13 +862,21 @@ static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *
                int tmp = 0;
                int m;
 
-               m = RESET_SRST_GATES_JTAG;
-               tmp = 0;
+               /* gating */
+               m = RESET_SRST_NO_GATING;
                if (strcmp(*args, "srst_gates_jtag") == 0)
-               {
-                       tmp = RESET_SRST_GATES_JTAG;
-                       goto next;
+                       /* default: don't use JTAG while SRST asserted */;
+               else if (strcmp(*args, "srst_nogate") == 0)
+                       tmp = RESET_SRST_NO_GATING;
+               else
+                       m = 0;
+               if (mask & m) {
+                       LOG_ERROR("extra reset_config %s spec (%s)",
+                                       "gating", *args);
+                       return ERROR_INVALID_ARGUMENTS;
                }
+               if (m)
+                       goto next;
 
                /* signals */
                m = RESET_HAS_TRST | RESET_HAS_SRST;
@@ -937,10 +963,81 @@ next:
        }
 
        /* clear previous values of those bits, save new values */
-       enum reset_types old_cfg = jtag_get_reset_config();
-       old_cfg &= ~mask;
-       new_cfg |= old_cfg;
-       jtag_set_reset_config(new_cfg);
+       if (mask) {
+               int old_cfg = jtag_get_reset_config();
+
+               old_cfg &= ~mask;
+               new_cfg |= old_cfg;
+               jtag_set_reset_config(new_cfg);
+       } else
+               new_cfg = jtag_get_reset_config();
+
+
+       /*
+        * Display the (now-)current reset mode
+        */
+       char *modes[5];
+
+       /* minimal JTAG has neither SRST nor TRST (so that's the default) */
+       switch (new_cfg & (RESET_HAS_TRST | RESET_HAS_SRST)) {
+       case RESET_HAS_SRST:
+               modes[0] = "srst_only";
+               break;
+       case RESET_HAS_TRST:
+               modes[0] = "trst_only";
+               break;
+       case RESET_TRST_AND_SRST:
+               modes[0] = "trst_and_srst";
+               break;
+       default:
+               modes[0] = "none";
+               break;
+       }
+
+       /* normally SRST and TRST are decoupled; but bugs happen ... */
+       switch (new_cfg & (RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST)) {
+       case RESET_SRST_PULLS_TRST:
+               modes[1] = "srst_pulls_trst";
+               break;
+       case RESET_TRST_PULLS_SRST:
+               modes[1] = "trst_pulls_srst";
+               break;
+       case RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST:
+               modes[1] = "combined";
+               break;
+       default:
+               modes[1] = "separate";
+               break;
+       }
+
+       /* TRST-less connectors include Altera, Xilinx, and minimal JTAG */
+       if (new_cfg & RESET_HAS_TRST) {
+               if (new_cfg & RESET_TRST_OPEN_DRAIN)
+                       modes[3] = " trst_open_drain";
+               else
+                       modes[3] = " trst_push_pull";
+       } else
+               modes[3] = "";
+
+       /* SRST-less connectors include TI-14, Xilinx, and minimal JTAG */
+       if (new_cfg & RESET_HAS_SRST) {
+               if (new_cfg & RESET_SRST_NO_GATING)
+                       modes[2] = " srst_nogate";
+               else
+                       modes[2] = " srst_gates_jtag";
+
+               if (new_cfg & RESET_SRST_PUSH_PULL)
+                       modes[4] = " srst_push_pull";
+               else
+                       modes[4] = " srst_open_drain";
+       } else {
+               modes[2] = "";
+               modes[4] = "";
+       }
+
+       command_print(cmd_ctx, "%s %s%s%s%s",
+                       modes[0], modes[1],
+                       modes[2], modes[3], modes[4]);
 
        return ERROR_OK;
 }
@@ -979,6 +1076,40 @@ static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx,
        return ERROR_OK;
 }
 
+static int handle_jtag_nsrst_assert_width_command(struct command_context_s *cmd_ctx,
+               char *cmd, char **args, int argc)
+{
+       if (argc > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       if (argc == 1)
+       {
+               unsigned delay;
+               int retval = parse_uint(args[0], &delay);
+               if (ERROR_OK != retval)
+                       return retval;
+               jtag_set_nsrst_assert_width(delay);
+       }
+       command_print(cmd_ctx, "jtag_nsrst_assert_width: %u", jtag_get_nsrst_assert_width());
+       return ERROR_OK;
+}
+
+static int handle_jtag_ntrst_assert_width_command(struct command_context_s *cmd_ctx,
+               char *cmd, char **args, int argc)
+{
+       if (argc > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       if (argc == 1)
+       {
+               unsigned delay;
+               int retval = parse_uint(args[0], &delay);
+               if (ERROR_OK != retval)
+                       return retval;
+               jtag_set_ntrst_assert_width(delay);
+       }
+       command_print(cmd_ctx, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
+       return ERROR_OK;
+}
+
 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int retval = ERROR_OK;
@@ -1112,6 +1243,8 @@ static int handle_runtest_command(struct command_context_s *cmd_ctx,
  * For "irscan" or "drscan" commands, the "end" (really, "next") state
  * should be stable ... and *NOT* a shift state, otherwise free-running
  * jtag clocks could change the values latched by the update state.
+ * Not surprisingly, this is the same constraint as SVF; the "irscan"
+ * and "drscan" commands are a write-only subset of what SVF provides.
  */
 static bool scan_is_safe(tap_state_t state)
 {
@@ -1149,25 +1282,14 @@ static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, c
        if (argc >= 4) {
                /* have at least one pair of numbers. */
                /* is last pair the magic text? */
-               if (0 == strcmp("-endstate", args[ argc - 2 ])) {
-                       const char *cpA;
-                       const char *cpS;
-                       cpA = args[ argc-1 ];
-                       for (endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++) {
-                               cpS = tap_state_name(endstate);
-                               if (0 == strcmp(cpA, cpS)) {
-                                       break;
-                               }
-                       }
-                       if (endstate >= TAP_NUM_STATES) {
+               if (strcmp("-endstate", args[argc - 2]) == 0) {
+                       endstate = tap_state_by_name(args[argc - 1]);
+                       if (endstate == TAP_INVALID)
                                return ERROR_COMMAND_SYNTAX_ERROR;
-                       } else {
-                               if (!scan_is_safe(endstate))
-                                       LOG_WARNING("irscan with unsafe "
-                                                       "endstate \"%s\"", cpA);
-                               /* found - remove the last 2 args */
-                               argc -= 2;
-                       }
+                       if (!scan_is_safe(endstate))
+                               LOG_WARNING("unstable irscan endstate \"%s\"",
+                                               args[argc - 1]);
+                       argc -= 2;
                }
        }
 

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)