src/server: usage/help/doc updates
[fw/openocd] / src / server / telnet_server.c
index 73579e4ba0be40430c485e21592576e790870a02..6f26f0ac3ca29fee55a276ade1e5cec26809c15b 100644 (file)
@@ -2,6 +2,12 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   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     *
 #include "config.h"
 #endif
 
-#include "replacements.h"
-
 #include "telnet_server.h"
+#include <target/target_request.h>
 
-#include "server.h"
-#include "log.h"
-#include "command.h"
-#include "target.h"
-#include "target_request.h"
-
-#include <stdlib.h>
-#include <unistd.h>
-#include <errno.h>
-#include <string.h>
-#include <ctype.h>
-
-static unsigned short telnet_port = 0;
-
-int handle_exit_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_telnet_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static unsigned short telnet_port = 4444;
 
 static char *negotiate =
                "\xFF\xFB\x03"          /* IAC WILL Suppress Go Ahead */
@@ -54,9 +44,9 @@ static char *negotiate =
  * we write to it, we will fail. Subsequent write operations will
  * succeed. Shudder!
  */
-int telnet_write(connection_t *connection, const void *data, int len)
+int telnet_write(struct connection *connection, const void *data, int len)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
        if (t_con->closed)
                return ERROR_SERVER_REMOTE_CLOSED;
 
@@ -68,15 +58,15 @@ int telnet_write(connection_t *connection, const void *data, int len)
        return ERROR_SERVER_REMOTE_CLOSED;
 }
 
-int telnet_prompt(connection_t *connection)
+int telnet_prompt(struct connection *connection)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
 
        telnet_write(connection, "\r", 1); /* the prompt is always placed at the line beginning */
        return telnet_write(connection, t_con->prompt, strlen(t_con->prompt));
 }
 
-int telnet_outputline(connection_t *connection, const char *line)
+int telnet_outputline(struct connection *connection, const char *line)
 {
        int len;
 
@@ -92,8 +82,8 @@ int telnet_outputline(connection_t *connection, const char *line)
                telnet_write(connection, line, len);
                if (line_end)
                {
-                       telnet_write(connection, "\r\n\0", 3);
-                       line += len+1;
+                       telnet_write(connection, "\r\n", 2);
+                       line += len + 1;
                }
                else
                {
@@ -104,18 +94,18 @@ int telnet_outputline(connection_t *connection, const char *line)
        return ERROR_OK;
 }
 
-int telnet_output(struct command_context_s *cmd_ctx, char* line)
+int telnet_output(struct command_context *cmd_ctx, const char* line)
 {
-       connection_t *connection = cmd_ctx->output_handler_priv;
+       struct connection *connection = cmd_ctx->output_handler_priv;
 
        return telnet_outputline(connection, line);
 }
 
-void telnet_log_callback(void *priv, const char *file, int line,
+void telnet_log_callback(void *priv, const char *file, unsigned line,
                const char *function, const char *string)
 {
-       connection_t *connection = priv;
-       telnet_connection_t *t_con = connection->priv;
+       struct connection *connection = priv;
+       struct telnet_connection *t_con = connection->priv;
        int i;
 
        /* if there is no prompt, simply output the message */
@@ -127,8 +117,8 @@ void telnet_log_callback(void *priv, const char *file, int line,
 
        /* clear the command line */
        telnet_write(connection, "\r", 1);
-       for (i = strlen(t_con->prompt) + t_con->line_size; i>0; i-=16)
-               telnet_write(connection, "                ", i>16 ? 16 : i);
+       for (i = strlen(t_con->prompt) + t_con->line_size; i > 0; i -= 16)
+               telnet_write(connection, "                ", i > 16 ? 16 : i);
        telnet_write(connection, "\r", 1);
 
        /* output the message */
@@ -137,28 +127,14 @@ void telnet_log_callback(void *priv, const char *file, int line,
        /* put the command line to its previous state */
        telnet_prompt(connection);
        telnet_write(connection, t_con->line, t_con->line_size);
-       for (i=t_con->line_size; i>t_con->line_cursor; i--)
+       for (i = t_con->line_size; i > t_con->line_cursor; i--)
                telnet_write(connection, "\b", 1);
 }
 
-int telnet_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
+int telnet_new_connection(struct connection *connection)
 {
-       switch (event)
-       {
-               case TARGET_EVENT_HALTED:
-                       target_arch_state(target);
-                       break;
-               default:
-                       break;
-       }
-
-       return ERROR_OK;
-}
-
-int telnet_new_connection(connection_t *connection)
-{
-       telnet_connection_t *telnet_connection = malloc(sizeof(telnet_connection_t));
-       telnet_service_t *telnet_service = connection->service->priv;
+       struct telnet_connection *telnet_connection = malloc(sizeof(struct telnet_connection));
+       struct telnet_service *telnet_service = connection->service->priv;
        int i;
 
        connection->priv = telnet_connection;
@@ -181,7 +157,7 @@ int telnet_new_connection(connection_t *connection)
        if (telnet_service->banner)
        {
                telnet_write(connection, telnet_service->banner, strlen(telnet_service->banner));
-               telnet_write(connection, "\r\n\0", 3);
+               telnet_write(connection, "\r\n", 2);
        }
 
        telnet_prompt(connection);
@@ -194,16 +170,12 @@ int telnet_new_connection(connection_t *connection)
        telnet_connection->next_history = 0;
        telnet_connection->current_history = 0;
 
-       target_register_event_callback(telnet_target_callback_event_handler, connection->cmd_ctx);
-
        log_add_callback(telnet_log_callback, connection);
 
-
-
        return ERROR_OK;
 }
 
-void telnet_clear_line(connection_t *connection, telnet_connection_t *t_con)
+void telnet_clear_line(struct connection *connection, struct telnet_connection *t_con)
 {
        /* move to end of line */
        if (t_con->line_cursor < t_con->line_size)
@@ -220,13 +192,13 @@ void telnet_clear_line(connection_t *connection, telnet_connection_t *t_con)
        t_con->line_cursor = 0;
 }
 
-int telnet_input(connection_t *connection)
+int telnet_input(struct connection *connection)
 {
        int bytes_read;
-       char buffer[TELNET_BUFFER_SIZE];
-       char *buf_p;
-       telnet_connection_t *t_con = connection->priv;
-       command_context_t *command_context = connection->cmd_ctx;
+       unsigned char buffer[TELNET_BUFFER_SIZE];
+       unsigned char *buf_p;
+       struct telnet_connection *t_con = connection->priv;
+       struct command_context *command_context = connection->cmd_ctx;
 
        bytes_read = read_socket(connection->fd, buffer, TELNET_BUFFER_SIZE);
 
@@ -234,7 +206,7 @@ int telnet_input(connection_t *connection)
                return ERROR_SERVER_REMOTE_CLOSED;
        else if (bytes_read == -1)
        {
-               ERROR("error during read: %s", strerror(errno));
+               LOG_ERROR("error during read: %s", strerror(errno));
                return ERROR_SERVER_REMOTE_CLOSED;
        }
 
@@ -244,7 +216,7 @@ int telnet_input(connection_t *connection)
                switch (t_con->state)
                {
                        case TELNET_STATE_DATA:
-                               if (*buf_p == '\xff')
+                               if (*buf_p == 0xff)
                                {
                                        t_con->state = TELNET_STATE_IAC;
                                }
@@ -351,7 +323,9 @@ int telnet_input(connection_t *connection)
                                                        t_con->line_size = 0;
 
                                                        t_con->line_cursor = -1; /* to supress prompt in log callback during command execution */
+
                                                        retval = command_run_line(command_context, t_con->line);
+
                                                        t_con->line_cursor = 0;
 
                                                        if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
@@ -413,7 +387,7 @@ int telnet_input(connection_t *connection)
                                                }
                                                else
                                                {
-                                                       DEBUG("unhandled nonprintable: %2.2x", *buf_p);
+                                                       LOG_DEBUG("unhandled nonprintable: %2.2x", *buf_p);
                                                }
                                        }
                                }
@@ -421,16 +395,16 @@ int telnet_input(connection_t *connection)
                        case TELNET_STATE_IAC:
                                switch (*buf_p)
                                {
-                                       case '\xfe':
+                                       case 0xfe:
                                                t_con->state = TELNET_STATE_DONT;
                                                break;
-                                       case '\xfd':
+                                       case 0xfd:
                                                t_con->state = TELNET_STATE_DO;
                                                break;
-                                       case '\xfc':
+                                       case 0xfc:
                                                t_con->state = TELNET_STATE_WONT;
                                                break;
-                                       case '\xfb':
+                                       case 0xfb:
                                                t_con->state = TELNET_STATE_WILL;
                                                break;
                                }
@@ -546,13 +520,13 @@ int telnet_input(connection_t *connection)
                                }
                                else
                                {
-                                       ERROR("BUG: unexpected value in t_con->last_escape");
+                                       LOG_ERROR("BUG: unexpected value in t_con->last_escape");
                                        t_con->state = TELNET_STATE_DATA;
                                }
 
                                break;
                        default:
-                               ERROR("unknown telnet state");
+                               LOG_ERROR("unknown telnet state");
                                exit(-1);
                }
 
@@ -563,9 +537,9 @@ int telnet_input(connection_t *connection)
        return ERROR_OK;
 }
 
-int telnet_connection_closed(connection_t *connection)
+int telnet_connection_closed(struct connection *connection)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
        int i;
 
        log_remove_callback(telnet_log_callback, connection);
@@ -595,17 +569,15 @@ int telnet_connection_closed(connection_t *connection)
        }
        else
        {
-               ERROR("BUG: connection->priv == NULL");
+               LOG_ERROR("BUG: connection->priv == NULL");
        }
 
-       target_unregister_event_callback(telnet_target_callback_event_handler, connection->cmd_ctx);
-
        return ERROR_OK;
 }
 
-int telnet_set_prompt(connection_t *connection, char *prompt)
+int telnet_set_prompt(struct connection *connection, char *prompt)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
 
        if (t_con->prompt != NULL)
                free(t_con->prompt);
@@ -617,44 +589,53 @@ int telnet_set_prompt(connection_t *connection, char *prompt)
 
 int telnet_init(char *banner)
 {
-       telnet_service_t *telnet_service = malloc(sizeof(telnet_service_t));
+       struct telnet_service *telnet_service = malloc(sizeof(struct telnet_service));
 
        if (telnet_port == 0)
        {
-               WARNING("no telnet port specified, using default port 4444");
-               telnet_port = 4444;
+               LOG_INFO("telnet port disabled");
+               free(telnet_service);
+               return ERROR_OK;
        }
 
        telnet_service->banner = banner;
 
-       add_service("telnet", CONNECTION_TELNET, telnet_port, 1, telnet_new_connection, telnet_input, telnet_connection_closed, telnet_service);
+       add_service("telnet", CONNECTION_TCP, telnet_port, 1, telnet_new_connection, telnet_input, telnet_connection_closed, telnet_service);
 
        return ERROR_OK;
 }
 
-int telnet_register_commands(command_context_t *command_context)
+/* daemon configuration command telnet_port */
+COMMAND_HANDLER(handle_telnet_port_command)
 {
-       register_command(command_context, NULL, "exit", handle_exit_command,
-                                        COMMAND_EXEC, "exit telnet session");
-
-       register_command(command_context, NULL, "telnet_port", handle_telnet_port_command,
-                                        COMMAND_CONFIG, "");
-
-       return ERROR_OK;
+       return CALL_COMMAND_HANDLER(server_port_command, &telnet_port);
 }
 
-/* daemon configuration command telnet_port */
-int handle_telnet_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_exit_command)
 {
-       if (argc == 0)
-               return ERROR_OK;
-
-       telnet_port = strtoul(args[0], NULL, 0);
-
-       return ERROR_OK;
+       return ERROR_COMMAND_CLOSE_CONNECTION;
 }
 
-int handle_exit_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static const struct command_registration telnet_command_handlers[] = {
+       {
+               .name = "exit",
+               .handler = handle_exit_command,
+               .mode = COMMAND_EXEC,
+               .help = "exit telnet session",
+       },
+       {
+               .name = "telnet_port",
+               .handler = handle_telnet_port_command,
+               .mode = COMMAND_ANY,
+               .help = "Specify port on which to listen "
+                       "for incoming telnet connections.  "
+                       "No arguments reports telnet port; zero disables.",
+               .usage = "[port_num]",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+int telnet_register_commands(struct command_context *cmd_ctx)
 {
-       return ERROR_COMMAND_CLOSE_CONNECTION;
+       return register_commands(cmd_ctx, NULL, telnet_command_handlers);
 }