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