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  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23 #ifndef TELNET_SERVER_H
  24 #define TELNET_SERVER_H
  25
  26 #include "server.h"
  27
  28 #define TELNET_BUFFER_SIZE (1024)
  29
  30 #define TELNET_OPTION_MAX_SIZE (128)
  31 #define TELNET_LINE_HISTORY_SIZE (128)
  32 #define TELNET_LINE_MAX_SIZE (256)
  33
  34 enum telnet_states
  35 {
  36         TELNET_STATE_DATA,
  37         TELNET_STATE_IAC,
  38         TELNET_STATE_SB,
  39         TELNET_STATE_SE,
  40         TELNET_STATE_WILL,
  41         TELNET_STATE_WONT,
  42         TELNET_STATE_DO,
  43         TELNET_STATE_DONT,
  44         TELNET_STATE_ESCAPE,
  45 };
  46
  47 typedef struct telnet_connection_s
  48 {
  49         char *prompt;
  50         enum telnet_states state;
  51         char line[TELNET_LINE_MAX_SIZE];
  52         int line_size;
  53         int line_cursor;
  54         char option[TELNET_OPTION_MAX_SIZE];
  55         int option_size;
  56         char last_escape;
  57         char *history[TELNET_LINE_HISTORY_SIZE];
  58         int next_history;
  59         int current_history;
  60         int closed;
  61 } telnet_connection_t;
  62
  63 typedef struct telnet_service_s
  64 {
  65         char *banner;
  66 } telnet_service_t;
  67
  68 extern int telnet_init(char *banner);
  69 extern int telnet_register_commands(command_context_t *command_context);
  70
  71 #endif /* TELNET_SERVER_H */