jtag: rewrite jim_jtag_configure() as COMMAND_HANDLER

The function is used for commands:
- jtag configure
- jtag cget

While there, add the missing .usage field.

Change-Id: I97ddc4898259ddb7fd2d057a997f33a6f4b0e2a8
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/8058
Tested-by: jenkins

diff --git a/src/jtag/hla/hla_transport.c b/src/jtag/hla/hla_transport.c
index c0443d8356e0d80598baaab88cced6fdbcb370b4..b826eb0fe6ace341c5aae5136b7ee5662b51dfd7 100644 (file)
--- a/src/jtag/hla/hla_transport.c
+++ b/src/jtag/hla/hla_transport.c
@@ -127,7 +127,8 @@ static const struct command_registration hl_transport_jtag_subcommand_handlers[]
        {
         .name = "cget",
         .mode = COMMAND_EXEC,
-        .jim_handler = jim_jtag_configure,
+        .handler = handle_jtag_configure,
+        .usage = "",
         },
        {
         .name = "names",

diff --git a/src/jtag/tcl.c b/src/jtag/tcl.c
index 407aeb1d80cd0ce25b7f135e8f8cb079083944f2..163edfa19e34f94932915e55d1cfa94fa60f184e 100644 (file)
--- a/src/jtag/tcl.c
+++ b/src/jtag/tcl.c
@@ -41,7 +41,7 @@
  * Holds support for accessing JTAG-specific mechanisms from TCl scripts.
  */
 
-static const struct jim_nvp nvp_jtag_tap_event[] = {
+static const struct nvp nvp_jtag_tap_event[] = {
        { .value = JTAG_TRST_ASSERTED,          .name = "post-reset" },
        { .value = JTAG_TAP_EVENT_SETUP,        .name = "setup" },
        { .value = JTAG_TAP_EVENT_ENABLE,       .name = "tap-enable" },
@@ -259,123 +259,104 @@ enum jtag_tap_cfg_param {
        JCFG_IDCODE,
 };
 
-static struct jim_nvp nvp_config_opts[] = {
+static struct nvp nvp_config_opts[] = {
        { .name = "-event",      .value = JCFG_EVENT },
        { .name = "-idcode",     .value = JCFG_IDCODE },
 
        { .name = NULL,          .value = -1 }
 };
 
-static int jtag_tap_configure_event(struct jim_getopt_info *goi, struct jtag_tap *tap)
+static int jtag_tap_set_event(struct command_context *cmd_ctx, struct jtag_tap *tap,
+                const struct nvp *event, Jim_Obj *body)
 {
-       if (goi->argc == 0) {
-               Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event <event-name> ...");
-               return JIM_ERR;
-       }
-
-       struct jim_nvp *n;
-       int e = jim_getopt_nvp(goi, nvp_jtag_tap_event, &n);
-       if (e != JIM_OK) {
-               jim_getopt_nvp_unknown(goi, nvp_jtag_tap_event, 1);
-               return e;
-       }
-
-       if (goi->isconfigure) {
-               if (goi->argc != 1) {
-                       Jim_WrongNumArgs(goi->interp,
-                               goi->argc,
-                               goi->argv,
-                               "-event <event-name> <event-body>");
-                       return JIM_ERR;
-               }
-       } else {
-               if (goi->argc != 0) {
-                       Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event <event-name>");
-                       return JIM_ERR;
-               }
-       }
+       struct jtag_tap_event_action *jteap = tap->event_action;
 
-       struct jtag_tap_event_action *jteap  = tap->event_action;
-       /* replace existing event body */
-       bool found = false;
        while (jteap) {
-               if (jteap->event == (enum jtag_event)n->value) {
-                       found = true;
+               if (jteap->event == (enum jtag_event)event->value)
                        break;
-               }
                jteap = jteap->next;
        }
 
-       Jim_SetEmptyResult(goi->interp);
-
-       if (goi->isconfigure) {
-               if (!found)
-                       jteap = calloc(1, sizeof(*jteap));
-               else if (jteap->body)
-                       Jim_DecrRefCount(goi->interp, jteap->body);
+       if (!jteap) {
+               jteap = calloc(1, sizeof(*jteap));
+               if (!jteap) {
+                       LOG_ERROR("Out of memory");
+                       return ERROR_FAIL;
+               }
 
-               jteap->interp = goi->interp;
-               jteap->event = n->value;
+               /* add to head of event list */
+               jteap->next = tap->event_action;
+               tap->event_action = jteap;
+       } else {
+               Jim_DecrRefCount(cmd_ctx->interp, jteap->body);
+       }
 
-               Jim_Obj *o;
-               jim_getopt_obj(goi, &o);
-               jteap->body = Jim_DuplicateObj(goi->interp, o);
-               Jim_IncrRefCount(jteap->body);
+       jteap->interp = cmd_ctx->interp;
+       jteap->event = (enum jtag_event)event->value;
+       jteap->body = Jim_DuplicateObj(cmd_ctx->interp, body);
+       Jim_IncrRefCount(jteap->body);
 
-               if (!found) {
-                       /* add to head of event list */
-                       jteap->next = tap->event_action;
-                       tap->event_action = jteap;
-               }
-       } else if (found) {
-               jteap->interp = goi->interp;
-               Jim_SetResult(goi->interp,
-                       Jim_DuplicateObj(goi->interp, jteap->body));
-       }
-       return JIM_OK;
+       return ERROR_OK;
 }
 
-static int jtag_tap_configure_cmd(struct jim_getopt_info *goi, struct jtag_tap *tap)
+__COMMAND_HANDLER(handle_jtag_configure)
 {
-       /* parse config or cget options */
-       while (goi->argc > 0) {
-               Jim_SetEmptyResult(goi->interp);
-
-               struct jim_nvp *n;
-               int e = jim_getopt_nvp(goi, nvp_config_opts, &n);
-               if (e != JIM_OK) {
-                       jim_getopt_nvp_unknown(goi, nvp_config_opts, 0);
-                       return e;
-               }
+       bool is_configure = !strcmp(CMD_NAME, "configure");
+
+       if (CMD_ARGC < (is_configure ? 3 : 2))
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
+       /* FIXME: rework jtag_tap_by_jim_obj */
+       struct jtag_tap *tap = jtag_tap_by_jim_obj(CMD_CTX->interp, CMD_JIMTCL_ARGV[0]);
+       if (!tap)
+               return ERROR_FAIL;
+
+       for (unsigned int i = 1; i < CMD_ARGC; i++) {
+               const struct nvp *n = nvp_name2value(nvp_config_opts, CMD_ARGV[i]);
                switch (n->value) {
-                       case JCFG_EVENT:
-                               e = jtag_tap_configure_event(goi, tap);
-                               if (e != JIM_OK)
-                                       return e;
-                               break;
-                       case JCFG_IDCODE:
-                               if (goi->isconfigure) {
-                                       Jim_SetResultFormatted(goi->interp,
-                                                       "not settable: %s", n->name);
-                                       return JIM_ERR;
-                               } else {
-                                       if (goi->argc != 0) {
-                                               Jim_WrongNumArgs(goi->interp,
-                                                               goi->argc, goi->argv,
-                                                               "NO PARAMS");
-                                               return JIM_ERR;
+               case JCFG_EVENT:
+                       if (i + (is_configure ? 3 : 2) >= CMD_ARGC) {
+                               command_print(CMD, "wrong # args: should be \"-event <event-name>%s\"",
+                                               is_configure ? " <event-body>" : "");
+                               return ERROR_COMMAND_ARGUMENT_INVALID;
+                       }
+
+                       const struct nvp *event = nvp_name2value(nvp_jtag_tap_event, CMD_ARGV[i + 1]);
+                       if (!event->name) {
+                               nvp_unknown_command_print(CMD, nvp_jtag_tap_event, CMD_ARGV[i], CMD_ARGV[i + 1]);
+                               return ERROR_COMMAND_ARGUMENT_INVALID;
+                       }
+
+                       if (is_configure) {
+                               int retval = jtag_tap_set_event(CMD_CTX, tap, event, CMD_JIMTCL_ARGV[i + 2]);
+                               if (retval != ERROR_OK)
+                                       return retval;
+                       } else {
+                               struct jtag_tap_event_action *jteap = tap->event_action;
+                               while (jteap) {
+                                       if (jteap->event == (enum jtag_event)event->value) {
+                                               command_print(CMD, "%s", Jim_GetString(jteap->body, NULL));
+                                               break;
                                        }
+                                       jteap = jteap->next;
                                }
-                               Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, tap->idcode));
-                               break;
-                       default:
-                               Jim_SetResultFormatted(goi->interp, "unknown value: %s", n->name);
-                               return JIM_ERR;
+                       }
+
+                       i += is_configure ? 2 : 1;
+                       break;
+               case JCFG_IDCODE:
+                       if (is_configure) {
+                               command_print(CMD, "not settable: %s", n->name);
+                               return ERROR_COMMAND_ARGUMENT_INVALID;
+                       }
+                       command_print(CMD, "0x%08x", tap->idcode);
+                       break;
+               default:
+                       nvp_unknown_command_print(CMD, nvp_config_opts, NULL, CMD_ARGV[i]);
+                       return ERROR_COMMAND_ARGUMENT_INVALID;
                }
        }
-
-       return JIM_OK;
+       return ERROR_OK;
 }
 
 #define NTAP_OPT_IRLEN     0
@@ -558,7 +539,7 @@ static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
                if (jteap->event != e)
                        continue;
 
-               struct jim_nvp *nvp = jim_nvp_value2name_simple(nvp_jtag_tap_event, e);
+               const struct nvp *nvp = nvp_value2name(nvp_jtag_tap_event, e);
                LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
                        tap->dotted_name, e, nvp->name,
                        Jim_GetString(jteap->body, NULL));
@@ -675,30 +656,6 @@ __COMMAND_HANDLER(handle_jtag_tap_enabler)
        return ERROR_OK;
 }
 
-int jim_jtag_configure(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       struct command *c = jim_to_command(interp);
-       const char *cmd_name = c->name;
-       struct jim_getopt_info goi;
-       jim_getopt_setup(&goi, interp, argc-1, argv + 1);
-       goi.isconfigure = !strcmp(cmd_name, "configure");
-       if (goi.argc < 2 + goi.isconfigure) {
-               Jim_WrongNumArgs(goi.interp, 0, NULL,
-                       "<tap_name> <attribute> ...");
-               return JIM_ERR;
-       }
-
-       struct jtag_tap *t;
-
-       Jim_Obj *o;
-       jim_getopt_obj(&goi, &o);
-       t = jtag_tap_by_jim_obj(goi.interp, o);
-       if (!t)
-               return JIM_ERR;
-
-       return jtag_tap_configure_cmd(&goi, t);
-}
-
 COMMAND_HANDLER(handle_jtag_names)
 {
        if (CMD_ARGC != 0)
@@ -793,7 +750,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
        {
                .name = "configure",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_jtag_configure,
+               .handler = handle_jtag_configure,
                .help = "Provide a Tcl handler for the specified "
                        "TAP event.",
                .usage = "tap_name '-event' event_name handler",
@@ -801,7 +758,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
        {
                .name = "cget",
                .mode = COMMAND_EXEC,
-               .jim_handler = jim_jtag_configure,
+               .handler = handle_jtag_configure,
                .help = "Return any Tcl handler for the specified "
                        "TAP event.",
                .usage = "tap_name '-event' event_name",

diff --git a/src/jtag/tcl.h b/src/jtag/tcl.h
index 66867ab0ff63195831f506c3303ab6a8d2aa0e90..4e49e8579f8529ef7d0ff94d6a019a3383281741 100644 (file)
--- a/src/jtag/tcl.h
+++ b/src/jtag/tcl.h
@@ -20,8 +20,7 @@
 
 #include <helper/command.h>
 
-int jim_jtag_configure(Jim_Interp *interp, int argc,
-               Jim_Obj * const *argv);
+__COMMAND_HANDLER(handle_jtag_configure);
 __COMMAND_HANDLER(handle_jtag_tap_enabler);
 
 #endif /* OPENOCD_JTAG_TCL_H */

diff --git a/src/target/adi_v5_dapdirect.c b/src/target/adi_v5_dapdirect.c
index f3a90c0b17286b47840f062951f3a69ca42e8652..d198dacf3913953e6938bef9b7cc378ecd4aab61 100644 (file)
--- a/src/target/adi_v5_dapdirect.c
+++ b/src/target/adi_v5_dapdirect.c
@@ -118,7 +118,8 @@ static const struct command_registration dapdirect_jtag_subcommand_handlers[] =
        {
                .name = "cget",
                .mode = COMMAND_EXEC,
-               .jim_handler = jim_jtag_configure,
+               .handler = handle_jtag_configure,
+               .usage = "",
        },
        {
                .name = "names",