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