cmd: add missing usage vars

[openocd.git] / src / jtag / tcl.c

diff --git a/src/jtag/tcl.c b/src/jtag/tcl.c
index 89b405c901de2b0d7a02c5afcb4888ba1ac31d4f..291ba2382bdb278a58783024618a89f6eb472f0e 100644 (file)
--- a/src/jtag/tcl.c
+++ b/src/jtag/tcl.c
@@ -35,11 +35,14 @@
 #include "minidriver.h"
 #include "interface.h"
 #include "interfaces.h"
+#include "tcl.h"
 
 #ifdef HAVE_STRINGS_H
 #include <strings.h>
 #endif
 
+#include <helper/time_support.h>
+
 /**
  * @file
  * Holds support for accessing JTAG-specific mechanisms from TCl scripts.
@@ -164,12 +167,15 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args
                }
        } /* validate args */
 
+       assert(e == JIM_OK);
+
        tap = jtag_tap_by_jim_obj(interp, args[1]);
        if (tap == NULL) {
                return JIM_ERR;
        }
 
        num_fields = (argc-2)/2;
+       assert(num_fields > 0);
        fields = malloc(sizeof(struct scan_field) * num_fields);
        for (i = 2; i < argc; i += 2)
        {
@@ -655,7 +661,7 @@ static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
                if (Jim_EvalObj(jteap->interp, jteap->body) != JIM_OK)
                {
                        Jim_MakeErrorMessage(jteap->interp);
-                       LOG_USER_N("%s\n", Jim_GetString(Jim_GetResult(jteap->interp), NULL));
+                       LOG_USER("%s", Jim_GetString(Jim_GetResult(jteap->interp), NULL));
                        continue;
                }
 
@@ -715,7 +721,7 @@ static int jim_jtag_arp_init_reset(Jim_Interp *interp, int argc, Jim_Obj *const
        return JIM_OK;
 }
 
-static int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        Jim_GetOptInfo goi;
        Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
@@ -753,7 +759,7 @@ static bool jtag_tap_disable(struct jtag_tap *t)
        return true;
 }
 
-static int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
 {
        const char *cmd_name = Jim_GetString(argv[0], NULL);
        Jim_GetOptInfo goi;
@@ -772,11 +778,15 @@ static int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *ar
        if (strcasecmp(cmd_name, "tapisenabled") == 0) {
                // do nothing, just return the value
        } else if (strcasecmp(cmd_name, "tapenable") == 0) {
-               if (!jtag_tap_enable(t))
+               if (!jtag_tap_enable(t)){
                        LOG_WARNING("failed to enable tap %s", t->dotted_name);
+                        return JIM_ERR;
+                }
        } else if (strcasecmp(cmd_name, "tapdisable") == 0) {
-               if (!jtag_tap_disable(t))
+               if (!jtag_tap_disable(t)){
                        LOG_WARNING("failed to disable tap %s", t->dotted_name);
+                        return JIM_ERR;
+                }
        } else {
                LOG_ERROR("command '%s' unknown", cmd_name);
                return JIM_ERR;
@@ -786,7 +796,7 @@ static int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *ar
        return JIM_OK;
 }
 
-static int jim_jtag_configure(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+int jim_jtag_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
 {
        const char *cmd_name = Jim_GetString(argv[0], NULL);
        Jim_GetOptInfo goi;
@@ -853,6 +863,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
                .mode = COMMAND_ANY,
                .handler = handle_jtag_init_command,
                .help = "initialize jtag scan chain",
+               .usage = ""
        },
        {
                .name = "arp_init",
@@ -1266,6 +1277,46 @@ COMMAND_HANDLER(handle_jtag_flush_queue_sleep)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(handle_wait_srst_deassert)
+{
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       int timeout_ms;
+       COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], timeout_ms);
+       if ((timeout_ms <= 0) || (timeout_ms > 100000))
+       {
+               LOG_ERROR("Timeout must be an integer between 0 and 100000");
+               return ERROR_FAIL;
+       }
+
+       LOG_USER("Waiting for srst assert + deassert for at most %dms", timeout_ms);
+       int asserted_yet;
+       long long then = timeval_ms();
+       while (jtag_srst_asserted(&asserted_yet) == ERROR_OK)
+       {
+               if ((timeval_ms() - then) > timeout_ms)
+               {
+                       LOG_ERROR("Timed out");
+                       return ERROR_FAIL;
+               }
+               if (asserted_yet)
+                       break;
+       }
+       while (jtag_srst_asserted(&asserted_yet) == ERROR_OK)
+       {
+               if ((timeval_ms() - then) > timeout_ms)
+               {
+                       LOG_ERROR("Timed out");
+                       return ERROR_FAIL;
+               }
+               if (!asserted_yet)
+                       break;
+       }
+
+       return ERROR_OK;
+}
+
 
 
 static const struct command_registration jtag_command_handlers[] = {
@@ -1306,6 +1357,7 @@ static const struct command_registration jtag_command_handlers[] = {
                .handler = handle_scan_chain_command,
                .mode = COMMAND_ANY,
                .help = "print current scan chain configuration",
+               .usage = ""
        },
        {
                .name = "jtag_reset",
@@ -1357,10 +1409,20 @@ static const struct command_registration jtag_command_handlers[] = {
                        /* Specifically for working around DRIVER bugs... */
                .usage = "['short'|'long']",
        },
+       {
+               .name = "wait_srst_deassert",
+               .handler = handle_wait_srst_deassert,
+               .mode = COMMAND_ANY,
+               .help = "Wait for an SRST deassert. "
+                       "Useful for cases where you need something to happen within ms "
+                       "of an srst deassert. Timeout in ms ",
+               .usage = "ms",
+       },
        {
                .name = "jtag",
                .mode = COMMAND_ANY,
                .help = "perform jtag tap actions",
+               .usage = "",
 
                .chain = jtag_subcommand_handlers,
        },