src/flash/nor/virtual: handle null pointers
[openocd.git] / 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, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
24
25 #ifndef OPENOCD_SERVER_TELNET_SERVER_H
26 #define OPENOCD_SERVER_TELNET_SERVER_H
27
28 #include <server/server.h>
29
30 #define TELNET_BUFFER_SIZE (10*1024)
31
32 #define TELNET_LINE_HISTORY_SIZE (128)
33 #define TELNET_LINE_MAX_SIZE (10*256)
34
35 enum telnet_states {
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 struct telnet_connection {
48 char *prompt;
49 bool prompt_visible;
50 enum telnet_states state;
51 char line[TELNET_LINE_MAX_SIZE];
52 size_t line_size;
53 size_t line_cursor;
54 char last_escape;
55 char *history[TELNET_LINE_HISTORY_SIZE];
56 size_t next_history;
57 size_t current_history;
58 bool closed;
59 };
60
61 struct telnet_service {
62 char *banner;
63 };
64
65 int telnet_init(char *banner);
66 int telnet_register_commands(struct command_context *command_context);
67 void telnet_service_free(void);
68
69 #endif /* OPENOCD_SERVER_TELNET_SERVER_H */