openocd: fix SPDX tag format for files .c
[fw/openocd] / src / jtag / tcl.c
index 970bd37eca663972e412fc9bca32e81954fdb1b4..b1815b79da7d0796d4dbecc46d19f171be7caa77 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;
 }
@@ -82,7 +72,7 @@ static bool scan_is_safe(tap_state_t state)
        }
 }
 
-static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
+static int jim_command_drscan(Jim_Interp *interp, int argc, Jim_Obj * const *args)
 {
        int retval;
        struct scan_field *fields;
@@ -133,7 +123,7 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args
                /* 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 *args
        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;
@@ -223,7 +213,7 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args
 }
 
 
-static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *args)
+static int jim_command_pathmove(Jim_Interp *interp, int argc, Jim_Obj * const *args)
 {
        tap_state_t states[8];
 
@@ -260,7 +250,7 @@ static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *ar
 }
 
 
-static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
+static int jim_command_flush_count(Jim_Interp *interp, int argc, Jim_Obj * const *args)
 {
        Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_get_flush_queue_count()));
 
@@ -281,7 +271,7 @@ static const struct command_registration jtag_command_handlers_to_move[] = {
        {
                .name = "drscan",
                .mode = COMMAND_EXEC,
-               .jim_handler = Jim_Command_drscan,
+               .jim_handler = jim_command_drscan,
                .help = "Execute Data Register (DR) scan for one TAP.  "
                        "Other TAPs must be in BYPASS mode.",
                .usage = "tap_name [num_bits value]* ['-endstate' state_name]",
@@ -289,14 +279,14 @@ static const struct command_registration jtag_command_handlers_to_move[] = {
        {
                .name = "flush_count",
                .mode = COMMAND_EXEC,
-               .jim_handler = Jim_Command_flush_count,
+               .jim_handler = jim_command_flush_count,
                .help = "Returns the number of times the JTAG queue "
                        "has been flushed.",
        },
        {
                .name = "pathmove",
                .mode = COMMAND_EXEC,
-               .jim_handler = Jim_Command_pathmove,
+               .jim_handler = jim_command_pathmove,
                .usage = "start_state state1 [state2 [state3 ...]]",
                .help = "Move JTAG state machine from current state "
                        "(start_state) to state1, then state2, state3, etc.",
@@ -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;
@@ -440,7 +430,7 @@ static int is_bad_irval(int ir_length, jim_wide w)
 }
 
 static int jim_newtap_expected_id(struct jim_nvp *n, struct jim_getopt_info *goi,
-       struct jtag_tap *pTap)
+       struct jtag_tap *tap)
 {
        jim_wide w;
        int e = jim_getopt_wide(goi, &w);
@@ -449,15 +439,15 @@ static int jim_newtap_expected_id(struct jim_nvp *n, struct jim_getopt_info *goi
                return e;
        }
 
-       uint32_t *p = realloc(pTap->expected_ids,
-                             (pTap->expected_ids_cnt + 1) * sizeof(uint32_t));
+       uint32_t *p = realloc(tap->expected_ids,
+                             (tap->expected_ids_cnt + 1) * sizeof(uint32_t));
        if (!p) {
                Jim_SetResultFormatted(goi->interp, "no memory");
                return JIM_ERR;
        }
 
-       pTap->expected_ids = p;
-       pTap->expected_ids[pTap->expected_ids_cnt++] = w;
+       tap->expected_ids = p;
+       tap->expected_ids[tap->expected_ids_cnt++] = w;
 
        return JIM_OK;
 }
@@ -469,9 +459,10 @@ 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 *pTap)
+       struct jtag_tap *tap)
 {
        jim_wide w;
        int e = jim_getopt_wide(goi, &w);
@@ -482,33 +473,33 @@ static int jim_newtap_ir_param(struct jim_nvp *n, struct jim_getopt_info *goi,
        }
        switch (n->value) {
            case NTAP_OPT_IRLEN:
-                   if (w > (jim_wide) (8 * sizeof(pTap->ir_capture_value))) {
+                   if (w > (jim_wide) (8 * sizeof(tap->ir_capture_value))) {
                            LOG_WARNING("%s: huge IR length %d",
-                                   pTap->dotted_name, (int) w);
+                                   tap->dotted_name, (int) w);
                    }
-                   pTap->ir_length = w;
+                   tap->ir_length = w;
                    break;
            case NTAP_OPT_IRMASK:
-                   if (is_bad_irval(pTap->ir_length, w)) {
+                   if (is_bad_irval(tap->ir_length, w)) {
                            LOG_ERROR("%s: IR mask %x too big",
-                                   pTap->dotted_name,
+                                   tap->dotted_name,
                                    (int) w);
                            return JIM_ERR;
                    }
                    if ((w & 3) != 3)
-                           LOG_WARNING("%s: nonstandard IR mask", pTap->dotted_name);
-                   pTap->ir_capture_mask = w;
+                           LOG_WARNING("%s: nonstandard IR mask", tap->dotted_name);
+                   tap->ir_capture_mask = w;
                    break;
            case NTAP_OPT_IRCAPTURE:
-                   if (is_bad_irval(pTap->ir_length, w)) {
+                   if (is_bad_irval(tap->ir_length, w)) {
                            LOG_ERROR("%s: IR capture %x too big",
-                                   pTap->dotted_name, (int) w);
+                                   tap->dotted_name, (int) w);
                            return JIM_ERR;
                    }
                    if ((w & 3) != 1)
                            LOG_WARNING("%s: nonstandard IR value",
-                                   pTap->dotted_name);
-                   pTap->ir_capture_value = w;
+                                   tap->dotted_name);
+                   tap->ir_capture_value = w;
                    break;
            default:
                    return JIM_ERR;
@@ -518,7 +509,7 @@ static int jim_newtap_ir_param(struct jim_nvp *n, struct jim_getopt_info *goi,
 
 static int jim_newtap_cmd(struct jim_getopt_info *goi)
 {
-       struct jtag_tap *pTap;
+       struct jtag_tap *tap;
        int x;
        int e;
        struct jim_nvp *n;
@@ -531,11 +522,12 @@ 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 },
        };
 
-       pTap = calloc(1, sizeof(struct jtag_tap));
-       if (!pTap) {
+       tap = calloc(1, sizeof(struct jtag_tap));
+       if (!tap) {
                Jim_SetResultFormatted(goi->interp, "no memory");
                return JIM_ERR;
        }
@@ -545,30 +537,30 @@ static int jim_newtap_cmd(struct jim_getopt_info *goi)
         * */
        if (goi->argc < 3) {
                Jim_SetResultFormatted(goi->interp, "Missing CHIP TAP OPTIONS ....");
-               free(pTap);
+               free(tap);
                return JIM_ERR;
        }
 
        const char *tmp;
        jim_getopt_string(goi, &tmp, NULL);
-       pTap->chip = strdup(tmp);
+       tap->chip = strdup(tmp);
 
        jim_getopt_string(goi, &tmp, NULL);
-       pTap->tapname = strdup(tmp);
+       tap->tapname = strdup(tmp);
 
        /* name + dot + name + null */
-       x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
+       x = strlen(tap->chip) + 1 + strlen(tap->tapname) + 1;
        cp = malloc(x);
-       sprintf(cp, "%s.%s", pTap->chip, pTap->tapname);
-       pTap->dotted_name = cp;
+       sprintf(cp, "%s.%s", tap->chip, tap->tapname);
+       tap->dotted_name = cp;
 
        LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
-               pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
+               tap->chip, tap->tapname, tap->dotted_name, goi->argc);
 
        if (!transport_is_jtag()) {
                /* SWD doesn't require any JTAG tap parameters */
-               pTap->enabled = true;
-               jtag_tap_init(pTap);
+               tap->enabled = true;
+               jtag_tap_init(tap);
                return JIM_OK;
        }
 
@@ -576,62 +568,65 @@ static int jim_newtap_cmd(struct jim_getopt_info *goi)
         * that the default.  The "-ircapture" and "-irmask" options are only
         * needed to cope with nonstandard TAPs, or to specify more bits.
         */
-       pTap->ir_capture_mask = 0x03;
-       pTap->ir_capture_value = 0x01;
+       tap->ir_capture_mask = 0x03;
+       tap->ir_capture_value = 0x01;
 
        while (goi->argc) {
                e = jim_getopt_nvp(goi, opts, &n);
                if (e != JIM_OK) {
                        jim_getopt_nvp_unknown(goi, opts, 0);
                        free(cp);
-                       free(pTap);
+                       free(tap);
                        return e;
                }
                LOG_DEBUG("Processing option: %s", n->name);
                switch (n->value) {
                    case NTAP_OPT_ENABLED:
-                           pTap->disabled_after_reset = false;
+                           tap->disabled_after_reset = false;
                            break;
                    case NTAP_OPT_DISABLED:
-                           pTap->disabled_after_reset = true;
+                           tap->disabled_after_reset = true;
                            break;
                    case NTAP_OPT_EXPECTED_ID:
-                           e = jim_newtap_expected_id(n, goi, pTap);
-                           if (JIM_OK != e) {
+                           e = jim_newtap_expected_id(n, goi, tap);
+                           if (e != JIM_OK) {
                                    free(cp);
-                                   free(pTap);
+                                   free(tap);
                                    return e;
                            }
                            break;
                    case NTAP_OPT_IRLEN:
                    case NTAP_OPT_IRMASK:
                    case NTAP_OPT_IRCAPTURE:
-                           e = jim_newtap_ir_param(n, goi, pTap);
-                           if (JIM_OK != e) {
+                           e = jim_newtap_ir_param(n, goi, tap);
+                           if (e != JIM_OK) {
                                    free(cp);
-                                   free(pTap);
+                                   free(tap);
                                    return e;
                            }
                            break;
                    case NTAP_OPT_VERSION:
-                           pTap->ignore_version = true;
+                           tap->ignore_version = true;
+                           break;
+                   case NTAP_OPT_BYPASS:
+                           tap->ignore_bypass = true;
                            break;
                }       /* switch (n->value) */
        }       /* while (goi->argc) */
 
        /* default is enabled-after-reset */
-       pTap->enabled = !pTap->disabled_after_reset;
+       tap->enabled = !tap->disabled_after_reset;
 
        /* Did all the required option bits get cleared? */
-       if (pTap->ir_length != 0) {
-               jtag_tap_init(pTap);
+       if (tap->ir_length != 0) {
+               jtag_tap_init(tap);
                return JIM_OK;
        }
 
        Jim_SetResultFormatted(goi->interp,
                "newtap: %s missing IR length",
-               pTap->dotted_name);
-       jtag_tap_free(pTap);
+               tap->dotted_name);
+       jtag_tap_free(tap);
        return JIM_ERR;
 }
 
@@ -640,7 +635,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;
 
@@ -769,7 +764,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,7 +806,7 @@ 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);
@@ -886,6 +881,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
                        "['-enable'|'-disable'] "
                        "['-expected_id' number] "
                        "['-ignore-version'] "
+                       "['-ignore-bypass'] "
                        "['-ircapture' number] "
                        "['-mask' number]",
        },
@@ -1040,14 +1036,14 @@ COMMAND_HANDLER(handle_jtag_rclk_command)
                unsigned khz = 0;
                COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz);
 
-               retval = jtag_config_rclk(khz);
-               if (ERROR_OK != retval)
+               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);
-       if (ERROR_OK != retval)
+       int cur_khz = adapter_get_speed_khz();
+       retval = adapter_get_speed_readable(&cur_khz);
+       if (retval != ERROR_OK)
                return retval;
 
        if (cur_khz)
@@ -1122,7 +1118,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]);
 
@@ -1130,7 +1126,7 @@ COMMAND_HANDLER(handle_irscan_command)
                }
                uint64_t value;
                retval = parse_u64(CMD_ARGV[i * 2 + 1], &value);
-               if (ERROR_OK != retval)
+               if (retval != ERROR_OK)
                        goto error_return;
 
                int field_size = tap->ir_length;