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