transport: make 'transport select' auto-select the first available transport if not set
[openocd.git] / src / transport / transport.c
index 3e6722111369d767f9ceb2e32f210c93990acf24..c973e1c3a9ff783f344ee608ef5663ffd5583a4e 100644 (file)
@@ -13,7 +13,7 @@
 
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifdef HAVE_CONFIG_H
  */
 
 #include <helper/log.h>
-
 #include <transport/transport.h>
 
 extern struct command_context *global_cmd_ctx;
 
-
 /*-----------------------------------------------------------------------*/
 
 /*
@@ -63,18 +61,18 @@ static struct transport *transport_list;
  * currently selected debug adapter supports.  This is declared
  * by the time that adapter is fully set up.
  */
-static const char **allowed_transports;
+static const char * const *allowed_transports;
 
 /** * The transport being used for the current OpenOCD session.  */
 static struct transport *session;
 
-static  int transport_select(struct command_context *ctx, const char *name)
+static int transport_select(struct command_context *ctx, const char *name)
 {
        /* name may only identify a known transport;
         * caller guarantees session's transport isn't yet set.*/
        for (struct transport *t = transport_list; t; t = t->next) {
-                       if (strcmp(t->name, name) == 0) {
-                               int retval = t->select(ctx);
+               if (strcmp(t->name, name) == 0) {
+                       int retval = t->select(ctx);
                        /* select() registers commands specific to this
                         * transport, and may also reset the link, e.g.
                         * forcing it to JTAG or SWD mode.
@@ -82,8 +80,7 @@ static  int transport_select(struct command_context *ctx, const char *name)
                        if (retval == ERROR_OK)
                                session = t;
                        else
-                               LOG_ERROR("Error selecting '%s' as "
-                                       "transport", t->name);
+                               LOG_ERROR("Error selecting '%s' as transport", t->name);
                        return retval;
                }
        }
@@ -97,7 +94,7 @@ static  int transport_select(struct command_context *ctx, const char *name)
  * to declare the set of transports supported by an adapter.  When
  * there is only one member of that set, it is automatically selected.
  */
-int allow_transports(struct command_context *ctx, const char **vector)
+int allow_transports(struct command_context *ctx, const char * const *vector)
 {
        /* NOTE:  caller is required to provide only a list
         * of *valid* transport names
@@ -114,25 +111,16 @@ int allow_transports(struct command_context *ctx, const char **vector)
                return ERROR_FAIL;
        }
 
-
        allowed_transports = vector;
 
        /* autoselect if there's no choice ... */
        if (!vector[1]) {
-               LOG_INFO("only one transport option; autoselect '%s'",
-                               vector[0]);
-               return transport_select(ctx, vector [0]);
-       } else {
-               /* guard against user config errors */
-               LOG_WARNING("must select a transport.");
-               while (*vector) {
-                       LOG_DEBUG("allow transport '%s'", *vector);
-                       vector++;
-               }
-               return ERROR_OK;
+               LOG_INFO("only one transport option; autoselect '%s'", vector[0]);
+               return transport_select(ctx, vector[0]);
        }
-}
 
+       return ERROR_OK;
+}
 
 /**
  * Used to verify corrrect adapter driver initialization.
@@ -170,9 +158,8 @@ int transport_register(struct transport *new_transport)
                }
        }
 
-       if (!new_transport->select || !new_transport->init) {
+       if (!new_transport->select || !new_transport->init)
                LOG_ERROR("invalid transport %s", new_transport->name);
-       }
 
        /* splice this into the list */
        new_transport->next = transport_list;
@@ -190,12 +177,10 @@ int transport_register(struct transport *new_transport)
  */
 struct transport *get_current_transport(void)
 {
-
        /* REVISIT -- constify */
        return session;
 }
 
-
 /*-----------------------------------------------------------------------*/
 
 /*
@@ -221,7 +206,7 @@ COMMAND_HELPER(transport_list_parse, char ***vector)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        /* our return vector must be NULL terminated */
-       argv = (char **) calloc(n + 1, sizeof(char *));
+       argv = calloc(n + 1, sizeof(char *));
        if (argv == NULL)
                return ERROR_FAIL;
 
@@ -254,7 +239,15 @@ COMMAND_HANDLER(handle_transport_init)
 {
        LOG_DEBUG("%s", __func__);
        if (!session) {
-               LOG_ERROR("session's transport is not selected.");
+               LOG_ERROR("session transport was not selected. Use 'transport select <transport>'");
+
+               /* no session transport configured, print transports then fail */
+               LOG_ERROR("Transports available:");
+               const char * const *vector = allowed_transports;
+               while (*vector) {
+                       LOG_ERROR("%s", *vector);
+                       vector++;
+               }
                return ERROR_FAIL;
        }
 
@@ -280,49 +273,65 @@ COMMAND_HANDLER(handle_transport_list)
  * set supported by the debug adapter being used.  Return value
  * is scriptable (allowing "if swd then..." etc).
  */
-static int jim_transport_select(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static int jim_transport_select(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
 {
+       int res;
        switch (argc) {
-       case 1:                 /* return/display */
-               if (!session) {
-                       LOG_ERROR("session's transport is not selected.");
-                       return JIM_ERR;
-               } else {
+               case 1: /* autoselect if necessary, then return/display current config */
+                       if (!session) {
+                               if (!allowed_transports) {
+                                       LOG_ERROR("Debug adapter does not support any transports? Check config file order.");
+                                       return JIM_ERR;
+                               }
+                               LOG_INFO("auto-selecting first available session transport \"%s\". "
+                                        "To override use 'transport select <transport>'.", allowed_transports[0]);
+                               res = transport_select(global_cmd_ctx, allowed_transports[0]);
+                               if (res != JIM_OK)
+                                       return res;
+                       }
                        Jim_SetResultString(interp, session->name, -1);
                        return JIM_OK;
-               }
-               break;
-       case 2:                 /* assign */
-       if (session) {
-               /* can't change session's transport after-the-fact */
-               LOG_ERROR("session's transport is already selected.");
-               return JIM_ERR;
-       }
-
-       /* Is this transport supported by our debug adapter?
-        * Example, "JTAG-only" means SWD is not supported.
-        *
-        * NOTE:  requires adapter to have been set up, with
-        * transports declared via C.
-        */
-       if (!allowed_transports) {
-               LOG_ERROR("Debug adapter doesn't support any transports?");
-               return JIM_ERR;
-       }
-
-       for (unsigned i = 0; allowed_transports[i]; i++) {
-
-               if (strcmp(allowed_transports[i], argv[1]->bytes) == 0)
-               return transport_select(global_cmd_ctx, argv[1]->bytes);
-       }
-
-               LOG_ERROR("Debug adapter doesn't support '%s' "
-                       "transport", argv[1]->bytes);
-               return JIM_ERR;
-               break;
-       default:
-               Jim_WrongNumArgs(interp, 1, argv, "[too many parameters]");
-               return JIM_ERR;
+                       break;
+               case 2: /* assign */
+                       if (session) {
+                               if (!strcmp(session->name, argv[1]->bytes)) {
+                                       LOG_WARNING("Transport \"%s\" was already selected", session->name);
+                                       Jim_SetResultString(interp, session->name, -1);
+                                       return JIM_OK;
+                               } else {
+                                       LOG_ERROR("Can't change session's transport after the initial selection was made");
+                                       return JIM_ERR;
+                               }
+                       }
+
+                       /* Is this transport supported by our debug adapter?
+                        * Example, "JTAG-only" means SWD is not supported.
+                        *
+                        * NOTE:  requires adapter to have been set up, with
+                        * transports declared via C.
+                        */
+                       if (!allowed_transports) {
+                               LOG_ERROR("Debug adapter doesn't support any transports?");
+                               return JIM_ERR;
+                       }
+
+                       for (unsigned i = 0; allowed_transports[i]; i++) {
+
+                               if (strcmp(allowed_transports[i], argv[1]->bytes) == 0) {
+                                       if (transport_select(global_cmd_ctx, argv[1]->bytes) == ERROR_OK) {
+                                               Jim_SetResultString(interp, session->name, -1);
+                                               return JIM_OK;
+                                       }
+                                       return JIM_ERR;
+                               }
+                       }
+
+                       LOG_ERROR("Debug adapter doesn't support '%s' transport", argv[1]->bytes);
+                       return JIM_ERR;
+                       break;
+               default:
+                       Jim_WrongNumArgs(interp, 1, argv, "[too many parameters]");
+                       return JIM_ERR;
        }
 }
 
@@ -366,7 +375,6 @@ static const struct command_registration transport_group[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-
 int transport_register_commands(struct command_context *ctx)
 {
        return register_commands(ctx, NULL, transport_group);

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)