armv7m_trace: stop getting traces from adapter at exit
[fw/openocd] / src / target / armv7m_trace.c
index b1bbb31c5ad75fa13811f658dc7c8e09738f2384..10f14221d43b927cb9652efea1d4199ac1587730 100644 (file)
@@ -10,6 +10,9 @@
  *   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 <target/armv7m.h>
 #include <target/cortex_m.h>
 #include <target/armv7m_trace.h>
+#include <jtag/interface.h>
+
+#define TRACE_BUF_SIZE 4096
+
+static int armv7m_poll_trace(void *target)
+{
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       uint8_t buf[TRACE_BUF_SIZE];
+       size_t size = sizeof(buf);
+       int retval;
+
+       retval = adapter_poll_trace(buf, &size);
+       if (retval != ERROR_OK || !size)
+               return retval;
+
+       target_call_trace_callbacks(target, size, buf);
+
+       switch (armv7m->trace_config.internal_channel) {
+       case TRACE_INTERNAL_CHANNEL_FILE:
+               if (armv7m->trace_config.trace_file != NULL) {
+                       if (fwrite(buf, 1, size, armv7m->trace_config.trace_file) == size)
+                               fflush(armv7m->trace_config.trace_file);
+                       else {
+                               LOG_ERROR("Error writing to the trace destination file");
+                               return ERROR_FAIL;
+                       }
+               }
+               break;
+       case TRACE_INTERNAL_CHANNEL_TCP:
+               if (armv7m->trace_config.trace_service != NULL) {
+                       /* broadcast to all service connections */
+                       struct connection *connection = armv7m->trace_config.trace_service->connections;
+                       retval = ERROR_OK;
+                       while (connection) {
+                               if (connection_write(connection, buf, size) != (int) size)
+                                       retval = ERROR_FAIL;
+
+                               connection = connection->next;
+                       }
+
+                       if (retval != ERROR_OK) {
+                               LOG_ERROR("Error streaming the trace to TCP/IP port");
+                               return ERROR_FAIL;
+                       }
+               }
+               break;
+       case TRACE_INTERNAL_CHANNEL_TCL_ONLY:
+               /* nothing to do :
+                * the trace data is sent to TCL by calling the target_call_trace_callbacks
+                **/
+               break;
+       default:
+               LOG_ERROR("unsupported trace internal channel");
+               return ERROR_FAIL;
+       }
+
+       return ERROR_OK;
+}
 
 int armv7m_trace_tpiu_config(struct target *target)
 {
        struct armv7m_common *armv7m = target_to_armv7m(target);
        struct armv7m_trace_config *trace_config = &armv7m->trace_config;
-       int prescaler;
+       uint16_t prescaler;
        int retval;
 
-       if (!trace_config->trace_freq) {
-               LOG_ERROR("Trace port frequency is 0, can't enable TPIU");
-               return ERROR_FAIL;
+       target_unregister_timer_callback(armv7m_poll_trace, target);
+
+       retval = adapter_config_trace(trace_config->config_type == TRACE_CONFIG_TYPE_INTERNAL,
+               trace_config->pin_protocol, trace_config->port_size,
+               &trace_config->trace_freq, trace_config->traceclkin_freq, &prescaler);
+
+       if (retval != ERROR_OK)
+               return retval;
+
+       if (trace_config->config_type == TRACE_CONFIG_TYPE_EXTERNAL) {
+               prescaler = trace_config->traceclkin_freq / trace_config->trace_freq;
+
+               if (trace_config->traceclkin_freq % trace_config->trace_freq) {
+                       prescaler++;
+
+                       int trace_freq = trace_config->traceclkin_freq / prescaler;
+                       LOG_INFO("Can not obtain %u trace port frequency from %u "
+                               "TRACECLKIN frequency, using %u instead",
+                               trace_config->trace_freq, trace_config->traceclkin_freq,
+                               trace_freq);
+
+                       trace_config->trace_freq = trace_freq;
+               }
        }
 
-       if (trace_config->traceclkin_freq % trace_config->trace_freq) {
-               LOG_ERROR("Can not calculate an integer divisor to get %u trace port frequency from %u TRACECLKIN frequency",
-                         trace_config->trace_freq, trace_config->traceclkin_freq);
+       if (!trace_config->trace_freq) {
+               LOG_ERROR("Trace port frequency is 0, can't enable TPIU");
                return ERROR_FAIL;
        }
 
-       prescaler = trace_config->traceclkin_freq / trace_config->trace_freq;
-
        retval = target_write_u32(target, TPIU_CSPSR, 1 << trace_config->port_size);
        if (retval != ERROR_OK)
                return retval;
@@ -65,6 +143,10 @@ int armv7m_trace_tpiu_config(struct target *target)
        if (retval != ERROR_OK)
                return retval;
 
+       if (trace_config->config_type == TRACE_CONFIG_TYPE_INTERNAL)
+               target_register_timer_callback(armv7m_poll_trace, 1,
+               TARGET_TIMER_TYPE_PERIODIC, target);
+
        target_call_event_callbacks(target, TARGET_EVENT_TRACE_CONFIG);
 
        return ERROR_OK;
@@ -100,11 +182,71 @@ int armv7m_trace_itm_config(struct target *target)
        return ERROR_OK;
 }
 
-static void close_trace_file(struct armv7m_common *armv7m)
+static void close_trace_channel(struct armv7m_common *armv7m)
+{
+       switch (armv7m->trace_config.internal_channel) {
+       case TRACE_INTERNAL_CHANNEL_FILE:
+               if (armv7m->trace_config.trace_file)
+                       fclose(armv7m->trace_config.trace_file);
+               armv7m->trace_config.trace_file = NULL;
+               break;
+       case TRACE_INTERNAL_CHANNEL_TCP:
+               if (armv7m->trace_config.trace_service)
+                       remove_service(armv7m->trace_config.trace_service->name, armv7m->trace_config.trace_service->port);
+               armv7m->trace_config.trace_service = NULL;
+               break;
+       case TRACE_INTERNAL_CHANNEL_TCL_ONLY:
+               /* nothing to do:
+                * the trace polling is disabled in the beginning of armv7m_trace_tpiu_config
+                **/
+               break;
+       default:
+               LOG_ERROR("unsupported trace internal channel");
+       }
+}
+
+static int trace_new_connection(struct connection *connection)
 {
-       if (armv7m->trace_config.trace_file)
-               fclose(armv7m->trace_config.trace_file);
-       armv7m->trace_config.trace_file = NULL;
+       /* nothing to do */
+       return ERROR_OK;
+}
+
+static int trace_input(struct connection *connection)
+{
+       /* create a dummy buffer to check if the connection is still active */
+       const int buf_len = 100;
+       unsigned char buf[buf_len];
+       int bytes_read = connection_read(connection, buf, buf_len);
+
+       if (bytes_read == 0)
+               return ERROR_SERVER_REMOTE_CLOSED;
+       else if (bytes_read == -1) {
+               LOG_ERROR("error during read: %s", strerror(errno));
+               return ERROR_SERVER_REMOTE_CLOSED;
+       }
+
+       return ERROR_OK;
+}
+
+static int trace_connection_closed(struct connection *connection)
+{
+       /* nothing to do, no connection->priv to free */
+       return ERROR_OK;
+}
+
+extern struct command_context *global_cmd_ctx;
+
+int armv7m_trace_tpiu_exit(struct target *target)
+{
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+
+       if (global_cmd_ctx->mode == COMMAND_CONFIG ||
+               armv7m->trace_config.config_type == TRACE_CONFIG_TYPE_DISABLED)
+               return ERROR_OK;
+
+       close_trace_channel(armv7m);
+       armv7m->trace_config.config_type = TRACE_CONFIG_TYPE_DISABLED;
+       return armv7m_trace_tpiu_config(target);
 }
 
 COMMAND_HANDLER(handle_tpiu_config_command)
@@ -118,9 +260,9 @@ COMMAND_HANDLER(handle_tpiu_config_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        if (!strcmp(CMD_ARGV[cmd_idx], "disable")) {
                if (CMD_ARGC == cmd_idx + 1) {
-                       close_trace_file(armv7m);
+                       close_trace_channel(armv7m);
 
-                       armv7m->trace_config.config_type = DISABLED;
+                       armv7m->trace_config.config_type = TRACE_CONFIG_TYPE_DISABLED;
                        if (CMD_CTX->mode == COMMAND_EXEC)
                                return armv7m_trace_tpiu_config(target);
                        else
@@ -128,19 +270,36 @@ COMMAND_HANDLER(handle_tpiu_config_command)
                }
        } else if (!strcmp(CMD_ARGV[cmd_idx], "external") ||
                   !strcmp(CMD_ARGV[cmd_idx], "internal")) {
-               close_trace_file(armv7m);
+               close_trace_channel(armv7m);
 
-               armv7m->trace_config.config_type = EXTERNAL;
+               armv7m->trace_config.config_type = TRACE_CONFIG_TYPE_EXTERNAL;
                if (!strcmp(CMD_ARGV[cmd_idx], "internal")) {
                        cmd_idx++;
                        if (CMD_ARGC == cmd_idx)
                                return ERROR_COMMAND_SYNTAX_ERROR;
 
-                       armv7m->trace_config.config_type = INTERNAL;
-                       armv7m->trace_config.trace_file = fopen(CMD_ARGV[cmd_idx], "ab");
-                       if (!armv7m->trace_config.trace_file) {
-                               LOG_ERROR("Can't open trace destination file");
-                               return ERROR_FAIL;
+                       armv7m->trace_config.config_type = TRACE_CONFIG_TYPE_INTERNAL;
+                       armv7m->trace_config.internal_channel = TRACE_INTERNAL_CHANNEL_TCL_ONLY;
+
+                       if (strcmp(CMD_ARGV[cmd_idx], "-") != 0) {
+                               if (CMD_ARGV[cmd_idx][0] == ':') {
+                                       armv7m->trace_config.internal_channel = TRACE_INTERNAL_CHANNEL_TCP;
+
+                                       int ret = add_service("armv7m_trace", &(CMD_ARGV[cmd_idx][1]),
+                                                       CONNECTION_LIMIT_UNLIMITED, trace_new_connection, trace_input,
+                                                       trace_connection_closed, NULL, &armv7m->trace_config.trace_service);
+                                       if (ret != ERROR_OK) {
+                                               LOG_ERROR("Can't configure trace TCP port");
+                                               return ERROR_FAIL;
+                                       }
+                               } else {
+                                       armv7m->trace_config.internal_channel = TRACE_INTERNAL_CHANNEL_FILE;
+                                       armv7m->trace_config.trace_file = fopen(CMD_ARGV[cmd_idx], "ab");
+                                       if (!armv7m->trace_config.trace_file) {
+                                               LOG_ERROR("Can't open trace destination file");
+                                               return ERROR_FAIL;
+                                       }
+                               }
                        }
                }
                cmd_idx++;
@@ -148,7 +307,7 @@ COMMAND_HANDLER(handle_tpiu_config_command)
                        return ERROR_COMMAND_SYNTAX_ERROR;
 
                if (!strcmp(CMD_ARGV[cmd_idx], "sync")) {
-                       armv7m->trace_config.pin_protocol = SYNC;
+                       armv7m->trace_config.pin_protocol = TPIU_PIN_PROTOCOL_SYNC;
 
                        cmd_idx++;
                        if (CMD_ARGC == cmd_idx)
@@ -157,9 +316,9 @@ COMMAND_HANDLER(handle_tpiu_config_command)
                        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[cmd_idx], armv7m->trace_config.port_size);
                } else {
                        if (!strcmp(CMD_ARGV[cmd_idx], "manchester"))
-                               armv7m->trace_config.pin_protocol = ASYNC_MANCHESTER;
+                               armv7m->trace_config.pin_protocol = TPIU_PIN_PROTOCOL_ASYNC_MANCHESTER;
                        else if (!strcmp(CMD_ARGV[cmd_idx], "uart"))
-                               armv7m->trace_config.pin_protocol = ASYNC_UART;
+                               armv7m->trace_config.pin_protocol = TPIU_PIN_PROTOCOL_ASYNC_UART;
                        else
                                return ERROR_COMMAND_SYNTAX_ERROR;
 
@@ -181,7 +340,7 @@ COMMAND_HANDLER(handle_tpiu_config_command)
                        COMMAND_PARSE_NUMBER(uint, CMD_ARGV[cmd_idx], armv7m->trace_config.trace_freq);
                        cmd_idx++;
                } else {
-                       if (armv7m->trace_config.config_type != INTERNAL) {
+                       if (armv7m->trace_config.config_type != TRACE_CONFIG_TYPE_INTERNAL) {
                                LOG_ERROR("Trace port frequency can't be omitted in external capture mode");
                                return ERROR_COMMAND_SYNTAX_ERROR;
                        }
@@ -251,7 +410,7 @@ static const struct command_registration tpiu_command_handlers[] = {
                .mode = COMMAND_ANY,
                .help = "Configure TPIU features",
                .usage = "(disable | "
-               "((external | internal <filename>) "
+               "((external | internal (<filename> | <:port> | -)) "
                "(sync <port width> | ((manchester | uart) <formatter enable>)) "
                "<TRACECLKIN freq> [<trace freq>]))",
        },