jtag/adapter: move 'usb location' code in adapter.c
[openocd.git] / src / jtag / adapter.c
index cf579ede069d773746955fa28cd76dbf327c17c5..47a1d794b3bcfd65b86f1363de5b481e2126b620 100644 (file)
@@ -1,41 +1,22 @@
-/***************************************************************************
- *   Copyright (C) 2005 by Dominic Rath                                    *
- *   Dominic.Rath@gmx.de                                                   *
- *                                                                         *
- *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
- *   oyvind.harboe@zylin.com                                               *
- *                                                                         *
- *   Copyright (C) 2009 SoftPLC Corporation                                *
- *       http://softplc.com                                                *
- *   dick@softplc.com                                                      *
- *                                                                         *
- *   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/>. *
- ***************************************************************************/
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+/*
+ * Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>
+ * Copyright (C) 2007-2010 Øyvind Harboe <oyvind.harboe@zylin.com>
+ * Copyright (C) 2009 SoftPLC Corporation, http://softplc.com, Dick Hollenbeck <dick@softplc.com>
+ * Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>
+ * Copyright (C) 2018 Pengutronix, Oleksij Rempel <kernel@pengutronix.de>
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include "adapter.h"
 #include "jtag.h"
 #include "minidriver.h"
 #include "interface.h"
 #include "interfaces.h"
 #include <transport/transport.h>
-#include <jtag/drivers/jtag_usb_common.h>
 
 #ifdef HAVE_STRINGS_H
 #include <strings.h>
 struct adapter_driver *adapter_driver;
 const char * const jtag_only[] = { "jtag", NULL };
 
+/**
+ * Adapter configuration
+ */
+static struct {
+       char *usb_location;
+} adapter_config;
+
+/*
+ * 1 char: bus
+ * 2 * 7 chars: max 7 ports
+ * 1 char: test for overflow
+ * ------
+ * 16 chars
+ */
+#define USB_MAX_LOCATION_LENGTH         16
+
+#ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
+static void adapter_usb_set_location(const char *location)
+{
+       if (strnlen(location, USB_MAX_LOCATION_LENGTH) == USB_MAX_LOCATION_LENGTH)
+               LOG_WARNING("usb location string is too long!!");
+
+       free(adapter_config.usb_location);
+
+       adapter_config.usb_location = strndup(location, USB_MAX_LOCATION_LENGTH);
+}
+#endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */
+
+const char *adapter_usb_get_location(void)
+{
+       return adapter_config.usb_location;
+}
+
+bool adapter_usb_location_equal(uint8_t dev_bus, uint8_t *port_path, size_t path_len)
+{
+       size_t path_step, string_length;
+       char *ptr, *loc;
+       bool equal = false;
+
+       if (!adapter_usb_get_location())
+               return equal;
+
+       /* strtok need non const char */
+       loc = strndup(adapter_usb_get_location(), USB_MAX_LOCATION_LENGTH);
+       string_length = strnlen(loc, USB_MAX_LOCATION_LENGTH);
+
+       ptr = strtok(loc, "-");
+       if (!ptr) {
+               LOG_WARNING("no '-' in usb path\n");
+               goto done;
+       }
+
+       string_length -= strnlen(ptr, string_length);
+       /* check bus mismatch */
+       if (atoi(ptr) != dev_bus)
+               goto done;
+
+       path_step = 0;
+       while (path_step < path_len) {
+               ptr = strtok(NULL, ".");
+
+               /* no more tokens in path */
+               if (!ptr)
+                       break;
+
+               /* path mismatch at some step */
+               if (path_step < path_len && atoi(ptr) != port_path[path_step])
+                       break;
+
+               path_step++;
+               string_length -= strnlen(ptr, string_length) + 1;
+       };
+
+       /* walked the full path, all elements match */
+       if (path_step == path_len && !string_length)
+               equal = true;
+
+done:
+       free(loc);
+       return equal;
+}
+
 static int jim_adapter_name(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
 {
-       Jim_GetOptInfo goi;
-       Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
+       struct jim_getopt_info goi;
+       jim_getopt_setup(&goi, interp, argc-1, argv + 1);
 
        /* return the name of the interface */
        /* TCL code might need to know the exact type... */
@@ -62,7 +125,7 @@ static int jim_adapter_name(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
                return JIM_ERR;
        }
        const char *name = adapter_driver ? adapter_driver->name : NULL;
-       Jim_SetResultString(goi.interp, name ? : "undefined", -1);
+       Jim_SetResultString(goi.interp, name ? name : "undefined", -1);
        return JIM_OK;
 }
 
@@ -91,7 +154,7 @@ COMMAND_HANDLER(handle_adapter_list_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        command_print(CMD, "The following debug adapters are available:");
-       for (unsigned i = 0; NULL != adapter_drivers[i]; i++) {
+       for (unsigned i = 0; adapter_drivers[i]; i++) {
                const char *name = adapter_drivers[i]->name;
                command_print(CMD, "%u: %s", i + 1, name);
        }
@@ -113,14 +176,14 @@ COMMAND_HANDLER(handle_adapter_driver_command)
        if (CMD_ARGC != 1 || CMD_ARGV[0][0] == '\0')
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       for (unsigned i = 0; NULL != adapter_drivers[i]; i++) {
+       for (unsigned i = 0; adapter_drivers[i]; i++) {
                if (strcmp(CMD_ARGV[0], adapter_drivers[i]->name) != 0)
                        continue;
 
-               if (NULL != adapter_drivers[i]->commands) {
+               if (adapter_drivers[i]->commands) {
                        retval = register_commands(CMD_CTX, NULL,
                                        adapter_drivers[i]->commands);
-                       if (ERROR_OK != retval)
+                       if (retval != ERROR_OK)
                                return retval;
                }
 
@@ -394,13 +457,13 @@ COMMAND_HANDLER(handle_adapter_speed_command)
                COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz);
 
                retval = jtag_config_khz(khz);
-               if (ERROR_OK != retval)
+               if (retval != ERROR_OK)
                        return retval;
        }
 
        int cur_speed = jtag_get_speed_khz();
        retval = jtag_get_speed_readable(&cur_speed);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        if (cur_speed)
@@ -501,9 +564,9 @@ COMMAND_HANDLER(handle_adapter_reset_de_assert)
 COMMAND_HANDLER(handle_usb_location_command)
 {
        if (CMD_ARGC == 1)
-               jtag_usb_set_location(CMD_ARGV[0]);
+               adapter_usb_set_location(CMD_ARGV[0]);
 
-       command_print(CMD, "adapter usb location: %s", jtag_usb_get_location());
+       command_print(CMD, "adapter usb location: %s", adapter_usb_get_location());
 
        return ERROR_OK;
 }
@@ -584,7 +647,7 @@ static const struct command_registration adapter_command_handlers[] = {
                .handler = adapter_transports_command,
                .mode = COMMAND_CONFIG,
                .help = "Declare transports the adapter supports.",
-               .usage = "transport ... ",
+               .usage = "transport ...",
        },
        {
                .name = "usb",

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)