X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fjtag%2Fdrivers%2Fremote_bitbang.c;h=53d2151fdce7bf57c149ce35a13b6127938eec92;hp=f7b88303ba570dd853c4be45fb5eca6dcfc7e7d4;hb=HEAD;hpb=87c90393fedc8bb278d189aa53bcd93f4892012b
diff --git a/src/jtag/drivers/remote_bitbang.c b/src/jtag/drivers/remote_bitbang.c
index f7b88303ba..53d2151fdc 100644
--- a/src/jtag/drivers/remote_bitbang.c
+++ b/src/jtag/drivers/remote_bitbang.c
@@ -1,19 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
/***************************************************************************
* Copyright (C) 2011 by Richard Uhler *
* ruhler@mit.edu *
* *
- * 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 . *
+ * Copyright (C) 2021 by Manuel Wick *
***************************************************************************/
#ifdef HAVE_CONFIG_H
@@ -23,6 +14,7 @@
#ifndef _WIN32
#include
#include
+#include
#endif
#include "helper/system.h"
#include "helper/replacements.h"
@@ -36,41 +28,97 @@ static char *remote_bitbang_host;
static char *remote_bitbang_port;
static int remote_bitbang_fd;
+static uint8_t remote_bitbang_send_buf[512];
+static unsigned int remote_bitbang_send_buf_used;
+
+static bool use_remote_sleep;
/* Circular buffer. When start == end, the buffer is empty. */
-static char remote_bitbang_buf[64];
-static unsigned remote_bitbang_start;
-static unsigned remote_bitbang_end;
+static char remote_bitbang_recv_buf[256];
+static unsigned int remote_bitbang_recv_buf_start;
+static unsigned int remote_bitbang_recv_buf_end;
-static int remote_bitbang_buf_full(void)
+static bool remote_bitbang_recv_buf_full(void)
{
- return remote_bitbang_end ==
- ((remote_bitbang_start + sizeof(remote_bitbang_buf) - 1) %
- sizeof(remote_bitbang_buf));
+ return remote_bitbang_recv_buf_end ==
+ ((remote_bitbang_recv_buf_start + sizeof(remote_bitbang_recv_buf) - 1) %
+ sizeof(remote_bitbang_recv_buf));
}
-/* Read any incoming data, placing it into the buffer. */
-static int remote_bitbang_fill_buf(void)
+static bool remote_bitbang_recv_buf_empty(void)
{
- socket_nonblock(remote_bitbang_fd);
- while (!remote_bitbang_buf_full()) {
- unsigned contiguous_available_space;
- if (remote_bitbang_end >= remote_bitbang_start) {
- contiguous_available_space = sizeof(remote_bitbang_buf) -
- remote_bitbang_end;
- if (remote_bitbang_start == 0)
- contiguous_available_space -= 1;
- } else {
- contiguous_available_space = remote_bitbang_start -
- remote_bitbang_end - 1;
+ return remote_bitbang_recv_buf_start == remote_bitbang_recv_buf_end;
+}
+
+static unsigned int remote_bitbang_recv_buf_contiguous_available_space(void)
+{
+ if (remote_bitbang_recv_buf_end >= remote_bitbang_recv_buf_start) {
+ unsigned int space = sizeof(remote_bitbang_recv_buf) -
+ remote_bitbang_recv_buf_end;
+ if (remote_bitbang_recv_buf_start == 0)
+ space -= 1;
+ return space;
+ } else {
+ return remote_bitbang_recv_buf_start -
+ remote_bitbang_recv_buf_end - 1;
+ }
+}
+
+static int remote_bitbang_flush(void)
+{
+ if (remote_bitbang_send_buf_used <= 0)
+ return ERROR_OK;
+
+ unsigned int offset = 0;
+ while (offset < remote_bitbang_send_buf_used) {
+ ssize_t written = write_socket(remote_bitbang_fd, remote_bitbang_send_buf + offset,
+ remote_bitbang_send_buf_used - offset);
+ if (written < 0) {
+ log_socket_error("remote_bitbang_putc");
+ remote_bitbang_send_buf_used = 0;
+ return ERROR_FAIL;
}
+ offset += written;
+ }
+ remote_bitbang_send_buf_used = 0;
+ return ERROR_OK;
+}
+
+enum block_bool {
+ NO_BLOCK,
+ BLOCK
+};
+
+/* Read any incoming data, placing it into the buffer. */
+static int remote_bitbang_fill_buf(enum block_bool block)
+{
+ if (remote_bitbang_recv_buf_empty()) {
+ /* If the buffer is empty, reset it to 0 so we get more
+ * contiguous space. */
+ remote_bitbang_recv_buf_start = 0;
+ remote_bitbang_recv_buf_end = 0;
+ }
+
+ if (block == BLOCK) {
+ if (remote_bitbang_flush() != ERROR_OK)
+ return ERROR_FAIL;
+ socket_block(remote_bitbang_fd);
+ }
+
+ bool first = true;
+ while (!remote_bitbang_recv_buf_full()) {
+ unsigned int contiguous_available_space =
+ remote_bitbang_recv_buf_contiguous_available_space();
ssize_t count = read_socket(remote_bitbang_fd,
- remote_bitbang_buf + remote_bitbang_end,
+ remote_bitbang_recv_buf + remote_bitbang_recv_buf_end,
contiguous_available_space);
+ if (first && block == BLOCK)
+ socket_nonblock(remote_bitbang_fd);
+ first = false;
if (count > 0) {
- remote_bitbang_end += count;
- if (remote_bitbang_end == sizeof(remote_bitbang_buf))
- remote_bitbang_end = 0;
+ remote_bitbang_recv_buf_end += count;
+ if (remote_bitbang_recv_buf_end == sizeof(remote_bitbang_recv_buf))
+ remote_bitbang_recv_buf_end = 0;
} else if (count == 0) {
return ERROR_OK;
} else if (count < 0) {
@@ -90,20 +138,23 @@ static int remote_bitbang_fill_buf(void)
return ERROR_OK;
}
-static int remote_bitbang_putc(int c)
+typedef enum {
+ NO_FLUSH,
+ FLUSH_SEND_BUF
+} flush_bool_t;
+
+static int remote_bitbang_queue(int c, flush_bool_t flush)
{
- char buf = c;
- ssize_t count = write_socket(remote_bitbang_fd, &buf, sizeof(buf));
- if (count < 0) {
- log_socket_error("remote_bitbang_putc");
- return ERROR_FAIL;
- }
+ remote_bitbang_send_buf[remote_bitbang_send_buf_used++] = c;
+ if (flush == FLUSH_SEND_BUF ||
+ remote_bitbang_send_buf_used >= ARRAY_SIZE(remote_bitbang_send_buf))
+ return remote_bitbang_flush();
return ERROR_OK;
}
static int remote_bitbang_quit(void)
{
- if (remote_bitbang_putc('Q') == ERROR_FAIL)
+ if (remote_bitbang_queue('Q', FLUSH_SEND_BUF) == ERROR_FAIL)
return ERROR_FAIL;
if (close_socket(remote_bitbang_fd) != 0) {
@@ -132,66 +183,105 @@ static bb_value_t char_to_int(int c)
}
}
-/* Get the next read response. */
-static bb_value_t remote_bitbang_rread(void)
-{
- /* Enable blocking access. */
- socket_block(remote_bitbang_fd);
- char c;
- ssize_t count = read_socket(remote_bitbang_fd, &c, 1);
- if (count == 1) {
- return char_to_int(c);
- } else {
- remote_bitbang_quit();
- LOG_ERROR("read_socket: count=%d", (int) count);
- log_socket_error("read_socket");
- return BB_ERROR;
- }
-}
-
static int remote_bitbang_sample(void)
{
- if (remote_bitbang_fill_buf() != ERROR_OK)
+ if (remote_bitbang_fill_buf(NO_BLOCK) != ERROR_OK)
return ERROR_FAIL;
- assert(!remote_bitbang_buf_full());
- return remote_bitbang_putc('R');
+ assert(!remote_bitbang_recv_buf_full());
+ return remote_bitbang_queue('R', NO_FLUSH);
}
static bb_value_t remote_bitbang_read_sample(void)
{
- if (remote_bitbang_start != remote_bitbang_end) {
- int c = remote_bitbang_buf[remote_bitbang_start];
- remote_bitbang_start =
- (remote_bitbang_start + 1) % sizeof(remote_bitbang_buf);
- return char_to_int(c);
+ if (remote_bitbang_recv_buf_empty()) {
+ if (remote_bitbang_fill_buf(BLOCK) != ERROR_OK)
+ return BB_ERROR;
}
- return remote_bitbang_rread();
+ assert(!remote_bitbang_recv_buf_empty());
+ int c = remote_bitbang_recv_buf[remote_bitbang_recv_buf_start];
+ remote_bitbang_recv_buf_start =
+ (remote_bitbang_recv_buf_start + 1) % sizeof(remote_bitbang_recv_buf);
+ return char_to_int(c);
}
static int remote_bitbang_write(int tck, int tms, int tdi)
{
char c = '0' + ((tck ? 0x4 : 0x0) | (tms ? 0x2 : 0x0) | (tdi ? 0x1 : 0x0));
- return remote_bitbang_putc(c);
+ return remote_bitbang_queue(c, NO_FLUSH);
}
static int remote_bitbang_reset(int trst, int srst)
{
char c = 'r' + ((trst ? 0x2 : 0x0) | (srst ? 0x1 : 0x0));
- return remote_bitbang_putc(c);
+ /* Always flush the send buffer on reset, because the reset call need not be
+ * followed by jtag_execute_queue(). */
+ return remote_bitbang_queue(c, FLUSH_SEND_BUF);
+}
+
+static int remote_bitbang_sleep(unsigned int microseconds)
+{
+ if (!use_remote_sleep) {
+ jtag_sleep(microseconds);
+ return ERROR_OK;
+ }
+
+ int tmp;
+ unsigned int ms = microseconds / 1000;
+ unsigned int us = microseconds % 1000;
+
+ for (unsigned int i = 0; i < ms; i++) {
+ tmp = remote_bitbang_queue('Z', NO_FLUSH);
+ if (tmp != ERROR_OK)
+ return tmp;
+ }
+
+ for (unsigned int i = 0; i < us; i++) {
+ tmp = remote_bitbang_queue('z', NO_FLUSH);
+ if (tmp != ERROR_OK)
+ return tmp;
+ }
+
+ return remote_bitbang_flush();
}
static int remote_bitbang_blink(int on)
{
char c = on ? 'B' : 'b';
- return remote_bitbang_putc(c);
+ return remote_bitbang_queue(c, FLUSH_SEND_BUF);
+}
+
+static void remote_bitbang_swdio_drive(bool is_output)
+{
+ char c = is_output ? 'O' : 'o';
+ if (remote_bitbang_queue(c, FLUSH_SEND_BUF) == ERROR_FAIL)
+ LOG_ERROR("Error setting direction for swdio");
+}
+
+static int remote_bitbang_swdio_read(void)
+{
+ if (remote_bitbang_queue('c', FLUSH_SEND_BUF) != ERROR_FAIL)
+ return remote_bitbang_read_sample();
+ else
+ return BB_ERROR;
+}
+
+static int remote_bitbang_swd_write(int swclk, int swdio)
+{
+ char c = 'd' + ((swclk ? 0x2 : 0x0) | (swdio ? 0x1 : 0x0));
+ return remote_bitbang_queue(c, NO_FLUSH);
}
static struct bitbang_interface remote_bitbang_bitbang = {
- .buf_size = sizeof(remote_bitbang_buf) - 1,
+ .buf_size = sizeof(remote_bitbang_recv_buf) - 1,
.sample = &remote_bitbang_sample,
.read_sample = &remote_bitbang_read_sample,
.write = &remote_bitbang_write,
+ .swdio_read = &remote_bitbang_swdio_read,
+ .swdio_drive = &remote_bitbang_swdio_drive,
+ .swd_write = &remote_bitbang_swd_write,
.blink = &remote_bitbang_blink,
+ .sleep = &remote_bitbang_sleep,
+ .flush = &remote_bitbang_flush,
};
static int remote_bitbang_init_tcp(void)
@@ -216,7 +306,7 @@ static int remote_bitbang_init_tcp(void)
If socket(2) (or connect(2)) fails, we (close the socket
and) try the next address. */
- for (rp = result; rp != NULL ; rp = rp->ai_next) {
+ for (rp = result; rp ; rp = rp->ai_next) {
fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
if (fd == -1)
continue;
@@ -227,9 +317,16 @@ static int remote_bitbang_init_tcp(void)
close(fd);
}
+ /* We work hard to collapse the writes into the minimum number, so when
+ * we write something we want to get it to the other end of the
+ * connection as fast as possible. */
+ int one = 1;
+ /* On Windows optval has to be a const char *. */
+ setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (const char *)&one, sizeof(one));
+
freeaddrinfo(result); /* No longer needed */
- if (rp == NULL) { /* No address succeeded */
+ if (!rp) { /* No address succeeded */
log_socket_error("Failed to connect");
return ERROR_FAIL;
}
@@ -239,7 +336,7 @@ static int remote_bitbang_init_tcp(void)
static int remote_bitbang_init_unix(void)
{
- if (remote_bitbang_host == NULL) {
+ if (!remote_bitbang_host) {
LOG_ERROR("host/socket not specified");
return ERROR_FAIL;
}
@@ -268,11 +365,11 @@ static int remote_bitbang_init(void)
{
bitbang_interface = &remote_bitbang_bitbang;
- remote_bitbang_start = 0;
- remote_bitbang_end = 0;
+ remote_bitbang_recv_buf_start = 0;
+ remote_bitbang_recv_buf_end = 0;
LOG_INFO("Initializing remote_bitbang driver");
- if (remote_bitbang_port == NULL)
+ if (!remote_bitbang_port)
remote_bitbang_fd = remote_bitbang_init_unix();
else
remote_bitbang_fd = remote_bitbang_init_tcp();
@@ -280,6 +377,8 @@ static int remote_bitbang_init(void)
if (remote_bitbang_fd < 0)
return remote_bitbang_fd;
+ socket_nonblock(remote_bitbang_fd);
+
LOG_INFO("remote_bitbang driver initialized");
return ERROR_OK;
}
@@ -306,9 +405,21 @@ COMMAND_HANDLER(remote_bitbang_handle_remote_bitbang_host_command)
return ERROR_COMMAND_SYNTAX_ERROR;
}
-static const struct command_registration remote_bitbang_command_handlers[] = {
+static const char * const remote_bitbang_transports[] = { "jtag", "swd", NULL };
+
+COMMAND_HANDLER(remote_bitbang_handle_remote_bitbang_use_remote_sleep_command)
+{
+ if (CMD_ARGC != 1)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ COMMAND_PARSE_ON_OFF(CMD_ARGV[0], use_remote_sleep);
+
+ return ERROR_OK;
+}
+
+static const struct command_registration remote_bitbang_subcommand_handlers[] = {
{
- .name = "remote_bitbang_port",
+ .name = "port",
.handler = remote_bitbang_handle_remote_bitbang_port_command,
.mode = COMMAND_CONFIG,
.help = "Set the port to use to connect to the remote jtag.\n"
@@ -316,23 +427,57 @@ static const struct command_registration remote_bitbang_command_handlers[] = {
.usage = "port_number",
},
{
- .name = "remote_bitbang_host",
+ .name = "host",
.handler = remote_bitbang_handle_remote_bitbang_host_command,
.mode = COMMAND_CONFIG,
.help = "Set the host to use to connect to the remote jtag.\n"
" if port is 0 or unset, this is the name of the unix socket to use.",
.usage = "host_name",
},
- COMMAND_REGISTRATION_DONE,
+ {
+ .name = "use_remote_sleep",
+ .handler = remote_bitbang_handle_remote_bitbang_use_remote_sleep_command,
+ .mode = COMMAND_CONFIG,
+ .help = "Rather than executing sleep locally, include delays in the "
+ "instruction stream for the remote host.",
+ .usage = "(on|off)",
+ },
+ COMMAND_REGISTRATION_DONE
};
+static const struct command_registration remote_bitbang_command_handlers[] = {
+ {
+ .name = "remote_bitbang",
+ .mode = COMMAND_ANY,
+ .help = "perform remote_bitbang management",
+ .chain = remote_bitbang_subcommand_handlers,
+ .usage = "",
+ },
+ COMMAND_REGISTRATION_DONE
+};
+
+static int remote_bitbang_execute_queue(struct jtag_command *cmd_queue)
+{
+ /* safety: the send buffer must be empty, no leftover characters from
+ * previous transactions */
+ assert(remote_bitbang_send_buf_used == 0);
+
+ /* process the JTAG command queue */
+ int ret = bitbang_execute_queue(cmd_queue);
+ if (ret != ERROR_OK)
+ return ret;
+
+ /* flush not-yet-sent characters, if any */
+ return remote_bitbang_flush();
+}
+
static struct jtag_interface remote_bitbang_interface = {
- .execute_queue = &bitbang_execute_queue,
+ .execute_queue = &remote_bitbang_execute_queue,
};
struct adapter_driver remote_bitbang_adapter_driver = {
.name = "remote_bitbang",
- .transports = jtag_only,
+ .transports = remote_bitbang_transports,
.commands = remote_bitbang_command_handlers,
.init = &remote_bitbang_init,
@@ -340,4 +485,5 @@ struct adapter_driver remote_bitbang_adapter_driver = {
.reset = &remote_bitbang_reset,
.jtag_ops = &remote_bitbang_interface,
+ .swd_ops = &bitbang_swd,
};