git.sur5r.net Git - openocd/blob - src/server/telnet_server.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  25  ***************************************************************************/
  26
  27 #ifndef TELNET_SERVER_H
  28 #define TELNET_SERVER_H
  29
  30 #include <server/server.h>
  31
  32 #define TELNET_BUFFER_SIZE (1024)
  33
  34 #define TELNET_OPTION_MAX_SIZE (128)
  35 #define TELNET_LINE_HISTORY_SIZE (128)
  36 #define TELNET_LINE_MAX_SIZE (256)
  37
  38 enum telnet_states {
  39         TELNET_STATE_DATA,
  40         TELNET_STATE_IAC,
  41         TELNET_STATE_SB,
  42         TELNET_STATE_SE,
  43         TELNET_STATE_WILL,
  44         TELNET_STATE_WONT,
  45         TELNET_STATE_DO,
  46         TELNET_STATE_DONT,
  47         TELNET_STATE_ESCAPE,
  48 };
  49
  50 struct telnet_connection {
  51         char *prompt;
  52         enum telnet_states state;
  53         char line[TELNET_LINE_MAX_SIZE];
  54         int line_size;
  55         int line_cursor;
  56         char option[TELNET_OPTION_MAX_SIZE];
  57         int option_size;
  58         char last_escape;
  59         char *history[TELNET_LINE_HISTORY_SIZE];
  60         int next_history;
  61         int current_history;
  62         int closed;
  63 };
  64
  65 struct telnet_service {
  66         char *banner;
  67 };
  68
  69 int telnet_init(char *banner);
  70 int telnet_register_commands(struct command_context *command_context);
  71
  72 #endif  /* TELNET_SERVER_H */