1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 Richard Missenden *
9 * richard.missenden@googlemail.com *
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. *
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. *
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 ***************************************************************************/
34 #include "configuration.h"
46 #include "telnet_server.h"
47 #include "gdb_server.h"
48 #include "tcl_server.h"
51 #include <sys/types.h>
60 #define OPENOCD_VERSION \
61 "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") " RELSTR PKGBLDREV
63 static void print_version(void)
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 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
70 LOG_OUTPUT("$URL$\n");
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 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
78 /* Give TELNET a way to find out what version this is */
79 static int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
82 return ERROR_COMMAND_SYNTAX_ERROR;
84 command_print(cmd_ctx, OPENOCD_VERSION);
89 static void exit_handler(void)
91 /* close JTAG interface */
92 if (jtag && jtag->quit)
96 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
100 case TARGET_EVENT_GDB_START:
103 case TARGET_EVENT_GDB_END:
106 case TARGET_EVENT_HALTED:
109 /* do not display information when debugger caused the halt */
110 target_arch_state(target);
120 int ioutil_init(struct command_context_s *cmd_ctx);
122 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
123 static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
127 return ERROR_COMMAND_SYNTAX_ERROR;
130 static int initialized=0;
136 atexit(exit_handler);
138 if (target_init(cmd_ctx) != ERROR_OK)
140 LOG_DEBUG("target init complete");
142 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
144 /* we must be able to set up the jtag interface */
147 LOG_DEBUG("jtag interface init complete");
149 /* Try to initialize & examine the JTAG chain at this point, but
150 * continue startup regardless */
151 if (jtag_init(cmd_ctx) == ERROR_OK)
153 LOG_DEBUG("jtag init complete");
154 if (target_examine() == ERROR_OK)
156 LOG_DEBUG("jtag examine complete");
160 if (flash_init_drivers(cmd_ctx) != ERROR_OK)
162 LOG_DEBUG("flash init complete");
164 if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
166 LOG_DEBUG("mflash init complete");
168 if (nand_init(cmd_ctx) != ERROR_OK)
170 LOG_DEBUG("NAND init complete");
172 if (pld_init(cmd_ctx) != ERROR_OK)
174 LOG_DEBUG("pld init complete");
176 /* initialize tcp server */
179 /* initialize telnet subsystem */
180 telnet_init("Open On-Chip Debugger");
182 tcl_init(); /* allows tcl to just connect without going thru telnet */
184 target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
189 command_context_t *global_cmd_ctx;
191 /* NB! this fn can be invoked outside this file for non PC hosted builds */
192 command_context_t *setup_command_handler(void)
194 command_context_t *cmd_ctx;
196 global_cmd_ctx = cmd_ctx = command_init();
198 register_command(cmd_ctx, NULL, "version", handle_version_command,
199 COMMAND_EXEC, "show OpenOCD version");
201 /* register subsystem commands */
202 server_register_commands(cmd_ctx);
203 telnet_register_commands(cmd_ctx);
204 gdb_register_commands(cmd_ctx);
205 tcl_register_commands(cmd_ctx); /* tcl server commands */
206 tclapi_register_commands(cmd_ctx); /* misc tcl commands */
207 log_register_commands(cmd_ctx);
208 jtag_register_commands(cmd_ctx);
209 xsvf_register_commands(cmd_ctx);
210 svf_register_commands(cmd_ctx);
211 target_register_commands(cmd_ctx);
212 flash_register_commands(cmd_ctx);
213 nand_register_commands(cmd_ctx);
214 pld_register_commands(cmd_ctx);
215 mflash_register_commands(cmd_ctx);
217 if (log_init(cmd_ctx) != ERROR_OK)
221 LOG_DEBUG("log init complete");
223 LOG_OUTPUT( OPENOCD_VERSION "\n" );
225 register_command(cmd_ctx, NULL, "init", handle_init_command,
226 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
231 int httpd_start(void);
232 void httpd_stop(void);
235 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
236 /* implementations of OpenOCD that uses multithreading needs to know when
237 * OpenOCD is sleeping. No-op in vanilla OpenOCD
239 void openocd_sleep_prelude(void)
243 void openocd_sleep_postlude(void)
249 /* normally this is the main() function entry, but if OpenOCD is linked
250 * into application, then this fn will not be invoked, but rather that
251 * application will have it's own implementation of main(). */
252 int openocd_main(int argc, char *argv[])
256 /* initialize commandline interface */
257 command_context_t *cmd_ctx;
259 cmd_ctx = setup_command_handler();
262 if (ioutil_init(cmd_ctx) != ERROR_OK)
268 LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
272 command_context_mode(cmd_ctx, COMMAND_CONFIG);
273 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
275 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
278 ret = parse_config_file(cmd_ctx);
279 if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
283 if (httpd_start()!=ERROR_OK)
287 if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
289 command_context_mode(cmd_ctx, COMMAND_EXEC);
290 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
293 /* handle network connections */
294 server_loop(cmd_ctx);
297 /* shut server down */
304 unregister_all_commands(cmd_ctx);
306 /* free commandline interface */
307 command_done(cmd_ctx);