refactor command registration
[openocd.git] / src / openocd.c
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 Richard Missenden *
9 * richard.missenden@googlemail.com *
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
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "openocd.h"
32 #include "jtag.h"
33 #include "configuration.h"
34 #include "xsvf.h"
35 #include "svf.h"
36 #include "nand.h"
37 #include "pld.h"
38 #include "mflash.h"
39
40 #include "server.h"
41 #include "telnet_server.h"
42 #include "gdb_server.h"
43 #include "tcl_server.h"
44
45 #ifdef HAVE_STRINGS_H
46 #include <strings.h>
47 #endif
48
49
50 #define OPENOCD_VERSION \
51 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
52
53 /* Give TELNET a way to find out what version this is */
54 COMMAND_HANDLER(handle_version_command)
55 {
56 if (CMD_ARGC != 0)
57 return ERROR_COMMAND_SYNTAX_ERROR;
58
59 command_print(CMD_CTX, OPENOCD_VERSION);
60
61 return ERROR_OK;
62 }
63
64 static void exit_handler(void)
65 {
66 jtag_interface_quit();
67 }
68
69 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
70 {
71 switch (event)
72 {
73 case TARGET_EVENT_GDB_START:
74 target->display = 0;
75 break;
76 case TARGET_EVENT_GDB_END:
77 target->display = 1;
78 break;
79 case TARGET_EVENT_HALTED:
80 if (target->display)
81 {
82 /* do not display information when debugger caused the halt */
83 target_arch_state(target);
84 }
85 break;
86 default:
87 break;
88 }
89
90 return ERROR_OK;
91 }
92
93 int ioutil_init(struct command_context *cmd_ctx);
94
95 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
96 COMMAND_HANDLER(handle_init_command)
97 {
98
99 if (CMD_ARGC != 0)
100 return ERROR_COMMAND_SYNTAX_ERROR;
101
102 int retval;
103 static int initialized = 0;
104 if (initialized)
105 return ERROR_OK;
106
107 initialized = 1;
108
109 atexit(exit_handler);
110
111 if (target_init(CMD_CTX) != ERROR_OK)
112 return ERROR_FAIL;
113 LOG_DEBUG("target init complete");
114
115 if ((retval = jtag_interface_init(CMD_CTX)) != ERROR_OK)
116 {
117 /* we must be able to set up the jtag interface */
118 return retval;
119 }
120 LOG_DEBUG("jtag interface init complete");
121
122 /* Try to initialize & examine the JTAG chain at this point, but
123 * continue startup regardless */
124 if (jtag_init(CMD_CTX) == ERROR_OK)
125 {
126 LOG_DEBUG("jtag init complete");
127 if (target_examine() == ERROR_OK)
128 {
129 LOG_DEBUG("jtag examine complete");
130 }
131 }
132
133 if (flash_init_drivers(CMD_CTX) != ERROR_OK)
134 return ERROR_FAIL;
135 LOG_DEBUG("flash init complete");
136
137 if (mflash_init_drivers(CMD_CTX) != ERROR_OK)
138 return ERROR_FAIL;
139 LOG_DEBUG("mflash init complete");
140
141 if (nand_init(CMD_CTX) != ERROR_OK)
142 return ERROR_FAIL;
143 LOG_DEBUG("NAND init complete");
144
145 if (pld_init(CMD_CTX) != ERROR_OK)
146 return ERROR_FAIL;
147 LOG_DEBUG("pld init complete");
148
149 /* initialize tcp server */
150 server_init();
151
152 /* initialize telnet subsystem */
153 telnet_init("Open On-Chip Debugger");
154 gdb_init();
155 tcl_init(); /* allows tcl to just connect without going thru telnet */
156
157 target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
158
159 return ERROR_OK;
160 }
161
162 struct command_context *global_cmd_ctx;
163
164 /// src/hello.c gives a simple example for writing new command modules
165 int hello_register_commands(struct command_context *cmd_ctx);
166
167 /* NB! this fn can be invoked outside this file for non PC hosted builds */
168 struct command_context *setup_command_handler(void)
169 {
170 struct command_context *cmd_ctx;
171
172 global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl);
173
174 register_command(cmd_ctx, NULL, "version", handle_version_command,
175 COMMAND_EXEC, "show OpenOCD version");
176
177 /* register subsystem commands */
178 hello_register_commands(cmd_ctx);
179 server_register_commands(cmd_ctx);
180 telnet_register_commands(cmd_ctx);
181 gdb_register_commands(cmd_ctx);
182 tcl_register_commands(cmd_ctx); /* tcl server commands */
183 log_register_commands(cmd_ctx);
184 jtag_register_commands(cmd_ctx);
185 xsvf_register_commands(cmd_ctx);
186 svf_register_commands(cmd_ctx);
187 target_register_commands(cmd_ctx);
188 flash_register_commands(cmd_ctx);
189 nand_register_commands(cmd_ctx);
190 pld_register_commands(cmd_ctx);
191 mflash_register_commands(cmd_ctx);
192
193 if (log_init(cmd_ctx) != ERROR_OK)
194 {
195 exit(-1);
196 }
197 LOG_DEBUG("log init complete");
198
199 LOG_OUTPUT(OPENOCD_VERSION "\n");
200
201 register_command(cmd_ctx, NULL, "init", handle_init_command,
202 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
203
204 return cmd_ctx;
205 }
206
207 int httpd_start(void);
208 void httpd_stop(void);
209
210
211 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
212 /* implementations of OpenOCD that uses multithreading needs to know when
213 * OpenOCD is sleeping. No-op in vanilla OpenOCD
214 */
215 void openocd_sleep_prelude(void)
216 {
217 }
218
219 void openocd_sleep_postlude(void)
220 {
221 }
222 #endif
223
224
225 /* normally this is the main() function entry, but if OpenOCD is linked
226 * into application, then this fn will not be invoked, but rather that
227 * application will have it's own implementation of main(). */
228 int openocd_main(int argc, char *argv[])
229 {
230 int ret;
231
232 /* initialize commandline interface */
233 struct command_context *cmd_ctx;
234
235 cmd_ctx = setup_command_handler();
236
237 #if BUILD_IOUTIL
238 if (ioutil_init(cmd_ctx) != ERROR_OK)
239 {
240 return EXIT_FAILURE;
241 }
242 #endif
243
244 LOG_OUTPUT("For bug reports, read\n\t"
245 "http://openocd.berlios.de/doc/doxygen/bugs.html"
246 "\n");
247
248
249 command_context_mode(cmd_ctx, COMMAND_CONFIG);
250 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
251
252 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
253 return EXIT_FAILURE;
254
255 ret = parse_config_file(cmd_ctx);
256 if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION))
257 return EXIT_FAILURE;
258
259 #if BUILD_HTTPD
260 if (httpd_start() != ERROR_OK)
261 return EXIT_FAILURE;
262 #endif
263
264 if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
265 {
266 command_context_mode(cmd_ctx, COMMAND_EXEC);
267 if (command_run_line(cmd_ctx, "init") != ERROR_OK)
268 return EXIT_FAILURE;
269
270 /* handle network connections */
271 server_loop(cmd_ctx);
272 }
273
274 /* shut server down */
275 server_quit();
276
277 #if BUILD_HTTPD
278 httpd_stop();
279 #endif
280
281 unregister_all_commands(cmd_ctx, NULL);
282
283 /* free commandline interface */
284 command_done(cmd_ctx);
285
286
287 return EXIT_SUCCESS;
288 }