jtag: rewrite command 'jtag arp_init-reset' as COMMAND_HANDLER
[openocd.git] / src / jtag / tcl.c
index 79eea5460a7b408c6d91649936a1308f9649848c..c6ca048104258f662a65024ef3ba853767176e42 100644 (file)
@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
  *   Copyright (C) 2009 Zachary T Welch                                    *
  *   zw@superlucidity.net                                                  *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include "adapter.h"
 #include "jtag.h"
 #include "swd.h"
 #include "minidriver.h"
@@ -62,9 +52,9 @@ struct jtag_tap *jtag_tap_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
 {
        const char *cp = Jim_GetString(o, NULL);
        struct jtag_tap *t = cp ? jtag_tap_by_string(cp) : NULL;
-       if (NULL == cp)
+       if (!cp)
                cp = "(unknown)";
-       if (NULL == t)
+       if (!t)
                Jim_SetResultFormatted(interp, "Tap '%s' could not be found", cp);
        return t;
 }
@@ -133,7 +123,7 @@ static int jim_command_drscan(Jim_Interp *interp, int argc, Jim_Obj * const *arg
                /* get arg as a string. */
                cp = Jim_GetString(args[i], NULL);
                /* is it the magic? */
-               if (0 == strcmp("-endstate", cp)) {
+               if (strcmp("-endstate", cp) == 0) {
                        /* is the statename valid? */
                        cp = Jim_GetString(args[i + 1], NULL);
 
@@ -162,7 +152,7 @@ static int jim_command_drscan(Jim_Interp *interp, int argc, Jim_Obj * const *arg
        assert(e == JIM_OK);
 
        tap = jtag_tap_by_jim_obj(interp, args[1]);
-       if (tap == NULL)
+       if (!tap)
                return JIM_ERR;
 
        num_fields = (argc-2)/2;
@@ -362,7 +352,7 @@ static int jtag_tap_configure_event(struct jim_getopt_info *goi, struct jtag_tap
        if (goi->isconfigure) {
                if (!found)
                        jteap = calloc(1, sizeof(*jteap));
-               else if (NULL != jteap->body)
+               else if (jteap->body)
                        Jim_DecrRefCount(goi->interp, jteap->body);
 
                jteap->interp = goi->interp;
@@ -469,6 +459,7 @@ static int jim_newtap_expected_id(struct jim_nvp *n, struct jim_getopt_info *goi
 #define NTAP_OPT_DISABLED  4
 #define NTAP_OPT_EXPECTED_ID 5
 #define NTAP_OPT_VERSION   6
+#define NTAP_OPT_BYPASS    7
 
 static int jim_newtap_ir_param(struct jim_nvp *n, struct jim_getopt_info *goi,
        struct jtag_tap *tap)
@@ -531,6 +522,7 @@ static int jim_newtap_cmd(struct jim_getopt_info *goi)
                { .name = "-disable",       .value = NTAP_OPT_DISABLED },
                { .name = "-expected-id",       .value = NTAP_OPT_EXPECTED_ID },
                { .name = "-ignore-version",       .value = NTAP_OPT_VERSION },
+               { .name = "-ignore-bypass",       .value = NTAP_OPT_BYPASS },
                { .name = NULL,       .value = -1 },
        };
 
@@ -565,13 +557,6 @@ static int jim_newtap_cmd(struct jim_getopt_info *goi)
        LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
                tap->chip, tap->tapname, tap->dotted_name, goi->argc);
 
-       if (!transport_is_jtag()) {
-               /* SWD doesn't require any JTAG tap parameters */
-               tap->enabled = true;
-               jtag_tap_init(tap);
-               return JIM_OK;
-       }
-
        /* IEEE specifies that the two LSBs of an IR scan are 01, so make
         * that the default.  The "-ircapture" and "-irmask" options are only
         * needed to cope with nonstandard TAPs, or to specify more bits.
@@ -616,6 +601,9 @@ static int jim_newtap_cmd(struct jim_getopt_info *goi)
                    case NTAP_OPT_VERSION:
                            tap->ignore_version = true;
                            break;
+                   case NTAP_OPT_BYPASS:
+                           tap->ignore_bypass = true;
+                           break;
                }       /* switch (n->value) */
        }       /* while (goi->argc) */
 
@@ -623,7 +611,7 @@ static int jim_newtap_cmd(struct jim_getopt_info *goi)
        tap->enabled = !tap->disabled_after_reset;
 
        /* Did all the required option bits get cleared? */
-       if (tap->ir_length != 0) {
+       if (!transport_is_jtag() || tap->ir_length != 0) {
                jtag_tap_init(tap);
                return JIM_OK;
        }
@@ -640,7 +628,7 @@ static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
        struct jtag_tap_event_action *jteap;
        int retval;
 
-       for (jteap = tap->event_action; jteap != NULL; jteap = jteap->next) {
+       for (jteap = tap->event_action; jteap; jteap = jteap->next) {
                if (jteap->event != e)
                        continue;
 
@@ -676,45 +664,26 @@ static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
        }
 }
 
-static int jim_jtag_arp_init(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+COMMAND_HANDLER(handle_jtag_arp_init)
 {
-       struct jim_getopt_info goi;
-       jim_getopt_setup(&goi, interp, argc-1, argv + 1);
-       if (goi.argc != 0) {
-               Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
-               return JIM_ERR;
-       }
-       struct command_context *context = current_command_context(interp);
-       int e = jtag_init_inner(context);
-       if (e != ERROR_OK) {
-               Jim_Obj *obj = Jim_NewIntObj(goi.interp, e);
-               Jim_SetResultFormatted(goi.interp, "error: %#s", obj);
-               return JIM_ERR;
-       }
-       return JIM_OK;
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       return jtag_init_inner(CMD_CTX);
 }
 
-static int jim_jtag_arp_init_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+COMMAND_HANDLER(handle_jtag_arp_init_reset)
 {
-       int e = ERROR_OK;
-       struct jim_getopt_info goi;
-       jim_getopt_setup(&goi, interp, argc-1, argv + 1);
-       if (goi.argc != 0) {
-               Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
-               return JIM_ERR;
-       }
-       struct command_context *context = current_command_context(interp);
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
        if (transport_is_jtag())
-               e = jtag_init_reset(context);
-       else if (transport_is_swd())
-               e = swd_init_reset(context);
+               return jtag_init_reset(CMD_CTX);
 
-       if (e != ERROR_OK) {
-               Jim_Obj *obj = Jim_NewIntObj(goi.interp, e);
-               Jim_SetResultFormatted(goi.interp, "error: %#s", obj);
-               return JIM_ERR;
-       }
-       return JIM_OK;
+       if (transport_is_swd())
+               return swd_init_reset(CMD_CTX);
+
+       return ERROR_OK;
 }
 
 int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
@@ -769,7 +738,7 @@ int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        struct jtag_tap *t;
 
        t = jtag_tap_by_jim_obj(goi.interp, goi.argv[0]);
-       if (t == NULL)
+       if (!t)
                return JIM_ERR;
 
        if (strcasecmp(cmd_name, "tapisenabled") == 0) {
@@ -811,30 +780,21 @@ int jim_jtag_configure(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        Jim_Obj *o;
        jim_getopt_obj(&goi, &o);
        t = jtag_tap_by_jim_obj(goi.interp, o);
-       if (t == NULL)
+       if (!t)
                return JIM_ERR;
 
        return jtag_tap_configure_cmd(&goi, t);
 }
 
-static int jim_jtag_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+COMMAND_HANDLER(handle_jtag_names)
 {
-       struct jim_getopt_info goi;
-       jim_getopt_setup(&goi, interp, argc-1, argv + 1);
-       if (goi.argc != 0) {
-               Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters");
-               return JIM_ERR;
-       }
-       Jim_SetResult(goi.interp, Jim_NewListObj(goi.interp, NULL, 0));
-       struct jtag_tap *tap;
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       for (tap = jtag_all_taps(); tap; tap = tap->next_tap) {
-               Jim_ListAppendElement(goi.interp,
-                       Jim_GetResult(goi.interp),
-                       Jim_NewStringObj(goi.interp,
-                               tap->dotted_name, -1));
-       }
-       return JIM_OK;
+       for (struct jtag_tap *tap = jtag_all_taps(); tap; tap = tap->next_tap)
+               command_print(CMD, "%s", tap->dotted_name);
+
+       return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_jtag_init_command)
@@ -864,17 +824,19 @@ static const struct command_registration jtag_subcommand_handlers[] = {
        {
                .name = "arp_init",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_jtag_arp_init,
+               .handler = handle_jtag_arp_init,
                .help = "Validates JTAG scan chain against the list of "
                        "declared TAPs using just the four standard JTAG "
                        "signals.",
+               .usage = "",
        },
        {
                .name = "arp_init-reset",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_jtag_arp_init_reset,
+               .handler = handle_jtag_arp_init_reset,
                .help = "Uses TRST and SRST to try resetting everything on "
-                       "the JTAG scan chain, then performs 'jtag arp_init'."
+                       "the JTAG scan chain, then performs 'jtag arp_init'.",
+               .usage = "",
        },
        {
                .name = "newtap",
@@ -886,6 +848,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
                        "['-enable'|'-disable'] "
                        "['-expected_id' number] "
                        "['-ignore-version'] "
+                       "['-ignore-bypass'] "
                        "['-ircapture' number] "
                        "['-mask' number]",
        },
@@ -932,8 +895,9 @@ static const struct command_registration jtag_subcommand_handlers[] = {
        {
                .name = "names",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_jtag_names,
+               .handler = handle_jtag_names,
                .help = "Returns list of all JTAG tap names.",
+               .usage = "",
        },
        {
                .chain = jtag_command_handlers_to_move,
@@ -1040,13 +1004,13 @@ COMMAND_HANDLER(handle_jtag_rclk_command)
                unsigned khz = 0;
                COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz);
 
-               retval = jtag_config_rclk(khz);
+               retval = adapter_config_rclk(khz);
                if (retval != ERROR_OK)
                        return retval;
        }
 
-       int cur_khz = jtag_get_speed_khz();
-       retval = jtag_get_speed_readable(&cur_khz);
+       int cur_khz = adapter_get_speed_khz();
+       retval = adapter_get_speed_readable(&cur_khz);
        if (retval != ERROR_OK)
                return retval;
 
@@ -1122,7 +1086,7 @@ COMMAND_HANDLER(handle_irscan_command)
        int retval;
        for (i = 0; i < num_fields; i++) {
                tap = jtag_tap_by_string(CMD_ARGV[i*2]);
-               if (tap == NULL) {
+               if (!tap) {
                        free(fields);
                        command_print(CMD, "Tap: %s unknown", CMD_ARGV[i*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)