Set empty usage field for commands that do not need parameters
[openocd.git] / src / jtag / adapter.c
index b262a9a769d7918eaac0c04cd021f528dd302fea..24706f5624e5fb145a45bfef8e0b311673ad421e 100644 (file)
  *   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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -35,6 +34,8 @@
 #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>
  */
 
 extern struct jtag_interface *jtag_interface;
+const char * const jtag_only[] = { "jtag", NULL };
 
-
-
-static int
-jim_adapter_name(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+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);
@@ -67,7 +66,6 @@ jim_adapter_name(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return JIM_OK;
 }
 
-
 static int default_khz(int khz, int *jtag_speed)
 {
        LOG_ERROR("Translation from khz to jtag_speed not implemented");
@@ -92,14 +90,32 @@ static int default_srst_asserted(int *srst_asserted)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(interface_transport_command)
+{
+       char **transports;
+       int retval;
+
+       retval = CALL_COMMAND_HANDLER(transport_list_parse, &transports);
+       if (retval != ERROR_OK)
+               return retval;
+
+       retval = allow_transports(CMD_CTX, (const char **)transports);
+
+       if (retval != ERROR_OK) {
+               for (unsigned i = 0; transports[i]; i++)
+                       free(transports[i]);
+               free(transports);
+       }
+       return retval;
+}
+
 COMMAND_HANDLER(handle_interface_list_command)
 {
        if (strcmp(CMD_NAME, "interface_list") == 0 && CMD_ARGC > 0)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        command_print(CMD_CTX, "The following debug interfaces are available:");
-       for (unsigned i = 0; NULL != jtag_interfaces[i]; i++)
-       {
+       for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) {
                const char *name = jtag_interfaces[i]->name;
                command_print(CMD_CTX, "%u: %s", i + 1, name);
        }
@@ -109,9 +125,10 @@ COMMAND_HANDLER(handle_interface_list_command)
 
 COMMAND_HANDLER(handle_interface_command)
 {
+       int retval;
+
        /* check whether the interface is already configured */
-       if (jtag_interface)
-       {
+       if (jtag_interface) {
                LOG_WARNING("Interface already configured, ignoring");
                return ERROR_OK;
        }
@@ -120,14 +137,12 @@ COMMAND_HANDLER(handle_interface_command)
        if (CMD_ARGC != 1 || CMD_ARGV[0][0] == '\0')
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       for (unsigned i = 0; NULL != jtag_interfaces[i]; i++)
-       {
+       for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) {
                if (strcmp(CMD_ARGV[0], jtag_interfaces[i]->name) != 0)
                        continue;
 
-               if (NULL != jtag_interfaces[i]->commands)
-               {
-                       int retval = register_commands(CMD_CTX, NULL,
+               if (NULL != jtag_interfaces[i]->commands) {
+                       retval = register_commands(CMD_CTX, NULL,
                                        jtag_interfaces[i]->commands);
                        if (ERROR_OK != retval)
                                return retval;
@@ -135,6 +150,19 @@ COMMAND_HANDLER(handle_interface_command)
 
                jtag_interface = jtag_interfaces[i];
 
+               /* LEGACY SUPPORT ... adapter drivers  must declare what
+                * transports they allow.  Until they all do so, assume
+                * the legacy drivers are JTAG-only
+                */
+               if (!jtag_interface->transports)
+                       LOG_WARNING("Adapter driver '%s' did not declare "
+                               "which transports it allows; assuming "
+                               "legacy JTAG-only", jtag_interface->name);
+               retval = allow_transports(CMD_CTX, jtag_interface->transports
+                                               ? jtag_interface->transports : jtag_only);
+                       if (ERROR_OK != retval)
+                               return retval;
+
                if (jtag_interface->khz == NULL)
                        jtag_interface->khz = default_khz;
                if (jtag_interface->speed_div == NULL)
@@ -150,7 +178,8 @@ COMMAND_HANDLER(handle_interface_command)
        /* no valid interface was found (i.e. the configuration option,
         * didn't match one of the compiled-in interfaces
         */
-       LOG_ERROR("The specified debug interface was not found (%s)", CMD_ARGV[0]);
+       LOG_ERROR("The specified debug interface was not found (%s)",
+                               CMD_ARGV[0]);
        CALL_COMMAND_HANDLER(handle_interface_list_command);
        return ERROR_JTAG_INVALID_INTERFACE;
 }
@@ -182,7 +211,7 @@ COMMAND_HANDLER(handle_reset_config_command)
                if (mask & m) {
                        LOG_ERROR("extra reset_config %s spec (%s)",
                                        "gating", *CMD_ARGV);
-                       return ERROR_INVALID_ARGUMENTS;
+                       return ERROR_COMMAND_SYNTAX_ERROR;
                }
                if (m)
                        goto next;
@@ -202,7 +231,7 @@ COMMAND_HANDLER(handle_reset_config_command)
                if (mask & m) {
                        LOG_ERROR("extra reset_config %s spec (%s)",
                                        "signal", *CMD_ARGV);
-                       return ERROR_INVALID_ARGUMENTS;
+                       return ERROR_COMMAND_SYNTAX_ERROR;
                }
                if (m)
                        goto next;
@@ -222,7 +251,7 @@ COMMAND_HANDLER(handle_reset_config_command)
                if (mask & m) {
                        LOG_ERROR("extra reset_config %s spec (%s)",
                                        "combination", *CMD_ARGV);
-                       return ERROR_INVALID_ARGUMENTS;
+                       return ERROR_COMMAND_SYNTAX_ERROR;
                }
                if (m)
                        goto next;
@@ -238,13 +267,13 @@ COMMAND_HANDLER(handle_reset_config_command)
                if (mask & m) {
                        LOG_ERROR("extra reset_config %s spec (%s)",
                                        "trst_type", *CMD_ARGV);
-                       return ERROR_INVALID_ARGUMENTS;
+                       return ERROR_COMMAND_SYNTAX_ERROR;
                }
                if (m)
                        goto next;
 
                /* srst_type (NOP without HAS_SRST) */
-               m |= RESET_SRST_PUSH_PULL;
+               m = RESET_SRST_PUSH_PULL;
                if (strcmp(*CMD_ARGV, "srst_push_pull") == 0)
                        tmp |= RESET_SRST_PUSH_PULL;
                else if (strcmp(*CMD_ARGV, "srst_open_drain") == 0)
@@ -254,14 +283,30 @@ COMMAND_HANDLER(handle_reset_config_command)
                if (mask & m) {
                        LOG_ERROR("extra reset_config %s spec (%s)",
                                        "srst_type", *CMD_ARGV);
-                       return ERROR_INVALID_ARGUMENTS;
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+               }
+               if (m)
+                       goto next;
+
+               /* connect_type - only valid when srst_nogate */
+               m = RESET_CNCT_UNDER_SRST;
+               if (strcmp(*CMD_ARGV, "connect_assert_srst") == 0)
+                       tmp |= RESET_CNCT_UNDER_SRST;
+               else if (strcmp(*CMD_ARGV, "connect_deassert_srst") == 0)
+                       /* connect normally - default */;
+               else
+                       m = 0;
+               if (mask & m) {
+                       LOG_ERROR("extra reset_config %s spec (%s)",
+                                       "connect_type", *CMD_ARGV);
+                       return ERROR_COMMAND_SYNTAX_ERROR;
                }
                if (m)
                        goto next;
 
                /* caller provided nonsense; fail */
                LOG_ERROR("unknown reset_config flag (%s)", *CMD_ARGV);
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
 next:
                /* Remember the bits which were specified (mask)
@@ -281,42 +326,41 @@ next:
        } else
                new_cfg = jtag_get_reset_config();
 
-
        /*
         * Display the (now-)current reset mode
         */
-       char *modes[5];
+       char *modes[6];
 
        /* minimal JTAG has neither SRST nor TRST (so that's the default) */
        switch (new_cfg & (RESET_HAS_TRST | RESET_HAS_SRST)) {
-       case RESET_HAS_SRST:
-               modes[0] = "srst_only";
-               break;
-       case RESET_HAS_TRST:
-               modes[0] = "trst_only";
-               break;
-       case RESET_TRST_AND_SRST:
-               modes[0] = "trst_and_srst";
-               break;
-       default:
-               modes[0] = "none";
-               break;
+               case RESET_HAS_SRST:
+                       modes[0] = "srst_only";
+                       break;
+               case RESET_HAS_TRST:
+                       modes[0] = "trst_only";
+                       break;
+               case RESET_TRST_AND_SRST:
+                       modes[0] = "trst_and_srst";
+                       break;
+               default:
+                       modes[0] = "none";
+                       break;
        }
 
        /* normally SRST and TRST are decoupled; but bugs happen ... */
        switch (new_cfg & (RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST)) {
-       case RESET_SRST_PULLS_TRST:
-               modes[1] = "srst_pulls_trst";
-               break;
-       case RESET_TRST_PULLS_SRST:
-               modes[1] = "trst_pulls_srst";
-               break;
-       case RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST:
-               modes[1] = "combined";
-               break;
-       default:
-               modes[1] = "separate";
-               break;
+               case RESET_SRST_PULLS_TRST:
+                       modes[1] = "srst_pulls_trst";
+                       break;
+               case RESET_TRST_PULLS_SRST:
+                       modes[1] = "trst_pulls_srst";
+                       break;
+               case RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST:
+                       modes[1] = "combined";
+                       break;
+               default:
+                       modes[1] = "separate";
+                       break;
        }
 
        /* TRST-less connectors include Altera, Xilinx, and minimal JTAG */
@@ -339,14 +383,20 @@ next:
                        modes[4] = " srst_push_pull";
                else
                        modes[4] = " srst_open_drain";
+
+               if (new_cfg & RESET_CNCT_UNDER_SRST)
+                       modes[5] = " connect_assert_srst";
+               else
+                       modes[5] = " connect_deassert_srst";
        } else {
                modes[2] = "";
                modes[4] = "";
+               modes[5] = "";
        }
 
-       command_print(CMD_CTX, "%s %s%s%s%s",
+       command_print(CMD_CTX, "%s %s%s%s%s%s",
                        modes[0], modes[1],
-                       modes[2], modes[3], modes[4]);
+                       modes[2], modes[3], modes[4], modes[5]);
 
        return ERROR_OK;
 }
@@ -355,8 +405,7 @@ COMMAND_HANDLER(handle_adapter_nsrst_delay_command)
 {
        if (CMD_ARGC > 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
-       if (CMD_ARGC == 1)
-       {
+       if (CMD_ARGC == 1) {
                unsigned delay;
                COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay);
 
@@ -366,14 +415,27 @@ COMMAND_HANDLER(handle_adapter_nsrst_delay_command)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(handle_adapter_nsrst_assert_width_command)
+{
+       if (CMD_ARGC > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       if (CMD_ARGC == 1) {
+               unsigned width;
+               COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], width);
+
+               jtag_set_nsrst_assert_width(width);
+       }
+       command_print(CMD_CTX, "adapter_nsrst_assert_width: %u", jtag_get_nsrst_assert_width());
+       return ERROR_OK;
+}
+
 COMMAND_HANDLER(handle_adapter_khz_command)
 {
        if (CMD_ARGC > 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        int retval = ERROR_OK;
-       if (CMD_ARGC == 1)
-       {
+       if (CMD_ARGC == 1) {
                unsigned khz = 0;
                COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz);
 
@@ -388,14 +450,61 @@ COMMAND_HANDLER(handle_adapter_khz_command)
                return retval;
 
        if (cur_speed)
-               command_print(CMD_CTX, "%d kHz", cur_speed);
+               command_print(CMD_CTX, "adapter speed: %d kHz", cur_speed);
        else
-               command_print(CMD_CTX, "RCLK - adaptive");
+               command_print(CMD_CTX, "adapter speed: RCLK - adaptive");
 
        return retval;
 }
 
+#ifndef HAVE_JTAG_MINIDRIVER_H
+#ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
+COMMAND_HANDLER(handle_usb_location_command)
+{
+       if (CMD_ARGC == 1)
+               jtag_usb_set_location(CMD_ARGV[0]);
+
+       command_print(CMD_CTX, "adapter usb location: %s", jtag_usb_get_location());
+
+       return ERROR_OK;
+}
+#endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */
+
+static const struct command_registration adapter_usb_command_handlers[] = {
+#ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
+       {
+               .name = "location",
+               .handler = &handle_usb_location_command,
+               .mode = COMMAND_CONFIG,
+               .help = "set the USB bus location of the USB device",
+               .usage = "<bus>-port[.port]...",
+       },
+#endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */
+       COMMAND_REGISTRATION_DONE
+};
+#endif /* MINIDRIVER */
+
+static const struct command_registration adapter_command_handlers[] = {
+#ifndef HAVE_JTAG_MINIDRIVER_H
+       {
+               .name = "usb",
+               .mode = COMMAND_ANY,
+               .help = "usb adapter command group",
+               .usage = "",
+               .chain = adapter_usb_command_handlers,
+       },
+#endif /* MINIDRIVER */
+       COMMAND_REGISTRATION_DONE
+};
+
 static const struct command_registration interface_command_handlers[] = {
+       {
+               .name = "adapter",
+               .mode = COMMAND_ANY,
+               .help = "adapter command group",
+               .usage = "",
+               .chain = adapter_command_handlers,
+       },
        {
                .name = "adapter_khz",
                .handler = handle_adapter_khz_command,
@@ -420,6 +529,13 @@ static const struct command_registration interface_command_handlers[] = {
                .help = "delay after deasserting SRST in ms",
                .usage = "[milliseconds]",
        },
+       {
+               .name = "adapter_nsrst_assert_width",
+               .handler = handle_adapter_nsrst_assert_width_command,
+               .mode = COMMAND_ANY,
+               .help = "delay after asserting SRST in ms",
+               .usage = "[milliseconds]",
+       },
        {
                .name = "interface",
                .handler = handle_interface_command,
@@ -427,11 +543,19 @@ static const struct command_registration interface_command_handlers[] = {
                .help = "Select a debug adapter interface (driver)",
                .usage = "driver_name",
        },
+       {
+               .name = "interface_transports",
+               .handler = interface_transport_command,
+               .mode = COMMAND_CONFIG,
+               .help = "Declare transports the interface supports.",
+               .usage = "transport ... ",
+       },
        {
                .name = "interface_list",
                .handler = handle_interface_list_command,
                .mode = COMMAND_ANY,
                .help = "List all built-in debug adapter interfaces (drivers)",
+               .usage = "",
        },
        {
                .name = "reset_config",
@@ -442,7 +566,8 @@ static const struct command_registration interface_command_handlers[] = {
                        "[srst_pulls_trst|trst_pulls_srst|combined|separate] "
                        "[srst_gates_jtag|srst_nogate] "
                        "[trst_push_pull|trst_open_drain] "
-                       "[srst_push_pull|srst_open_drain]",
+                       "[srst_push_pull|srst_open_drain] "
+                       "[connect_deassert_srst|connect_assert_srst]",
        },
        COMMAND_REGISTRATION_DONE
 };

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)