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