rtt_server: Add option for a message when client connects

[openocd.git] / src / server / rtt_server.c

diff --git a/src/server/rtt_server.c b/src/server/rtt_server.c
index d49e4d00071672a753d7c781a9a1dfbc47adaa00..97691534751caf1e29c44023d8cc8f87b7040ea7 100644 (file)
--- a/src/server/rtt_server.c
+++ b/src/server/rtt_server.c
@@ -1,20 +1,13 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /*
  * Copyright (C) 2016-2017 by Marc Schink <dev@zapb.de>
- *
- * 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/>.
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include <stdint.h>
 #include <rtt/rtt.h>
 
@@ -32,6 +25,7 @@
 
 struct rtt_service {
        unsigned int channel;
+       char *hello_message;
 };
 
 static int read_callback(unsigned int channel, const uint8_t *buffer,
@@ -72,6 +66,9 @@ static int rtt_new_connection(struct connection *connection)
        if (ret != ERROR_OK)
                return ret;
 
+       if (service->hello_message)
+               connection_write(connection, service->hello_message, strlen(service->hello_message));
+
        return ERROR_OK;
 }
 
@@ -110,23 +107,45 @@ static int rtt_input(struct connection *connection)
        return ERROR_OK;
 }
 
+static const struct service_driver rtt_service_driver = {
+       .name = "rtt",
+       .new_connection_during_keep_alive_handler = NULL,
+       .new_connection_handler = rtt_new_connection,
+       .input_handler = rtt_input,
+       .connection_closed_handler = rtt_connection_closed,
+       .keep_client_alive_handler = NULL,
+};
+
 COMMAND_HANDLER(handle_rtt_start_command)
 {
        int ret;
        struct rtt_service *service;
 
-       if (CMD_ARGC != 2)
+       if (CMD_ARGC < 2 || CMD_ARGC > 3)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       service = malloc(sizeof(struct rtt_service));
+       service = calloc(1, sizeof(struct rtt_service));
 
        if (!service)
                return ERROR_FAIL;
 
        COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], service->channel);
 
-       ret = add_service("rtt", CMD_ARGV[0], CONNECTION_LIMIT_UNLIMITED,
-               rtt_new_connection, rtt_input, rtt_connection_closed, service);
+       if (CMD_ARGC >= 3) {
+               const char *hello_message = CMD_ARGV[2];
+               size_t hello_length = strlen(hello_message);
+
+               service->hello_message = malloc(hello_length + 2);
+               if (!service->hello_message) {
+                       LOG_ERROR("Out of memory");
+                       free(service);
+                       return ERROR_FAIL;
+               }
+               strcpy(service->hello_message, hello_message);
+               service->hello_message[hello_length] = '\n';
+               service->hello_message[hello_length + 1] = '\0';
+       }
+       ret = add_service(&rtt_service_driver, CMD_ARGV[0], CONNECTION_LIMIT_UNLIMITED, service);
 
        if (ret != ERROR_OK) {
                free(service);
@@ -152,7 +171,7 @@ static const struct command_registration rtt_server_subcommand_handlers[] = {
                .handler = handle_rtt_start_command,
                .mode = COMMAND_ANY,
                .help = "Start a RTT server",
-               .usage = "<port> <channel>"
+               .usage = "<port> <channel> [message]"
        },
        {
                .name = "stop",