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