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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef TELNET_SERVER_H
  27 #define TELNET_SERVER_H
  28
  29 #include "server.h"
  30
  31 #define TELNET_BUFFER_SIZE (1024)
  32
  33 #define TELNET_OPTION_MAX_SIZE (128)
  34 #define TELNET_LINE_HISTORY_SIZE (128)
  35 #define TELNET_LINE_MAX_SIZE (256)
  36
  37 enum telnet_states
  38 {
  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 typedef struct telnet_connection_s
  51 {
  52         char *prompt;
  53         enum telnet_states state;
  54         char line[TELNET_LINE_MAX_SIZE];
  55         int line_size;
  56         int line_cursor;
  57         char option[TELNET_OPTION_MAX_SIZE];
  58         int option_size;
  59         char last_escape;
  60         char *history[TELNET_LINE_HISTORY_SIZE];
  61         int next_history;
  62         int current_history;
  63         int closed;
  64 } telnet_connection_t;
  65
  66 typedef struct telnet_service_s
  67 {
  68         char *banner;
  69 } telnet_service_t;
  70
  71 extern int telnet_init(char *banner);
  72 extern int telnet_register_commands(command_context_t *command_context);
  73
  74 #endif /* TELNET_SERVER_H */