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 ***************************************************************************/
33 #include "configuration.h"
41 #include "gdb_server.h"
49 #define OPENOCD_VERSION \
50 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
52 /* Give TELNET a way to find out what version this is */
53 COMMAND_HANDLER(handle_version_command)
56 return ERROR_COMMAND_SYNTAX_ERROR;
58 command_print(CMD_CTX, OPENOCD_VERSION);
64 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
68 case TARGET_EVENT_GDB_START:
71 case TARGET_EVENT_GDB_END:
74 case TARGET_EVENT_HALTED:
77 /* do not display information when debugger caused the halt */
78 target_arch_state(target);
88 int ioutil_init(struct command_context *cmd_ctx);
90 static bool init_at_startup = true;
92 COMMAND_HANDLER(handle_noinit_command)
95 return ERROR_COMMAND_SYNTAX_ERROR;
96 init_at_startup = false;
100 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
101 COMMAND_HANDLER(handle_init_command)
105 return ERROR_COMMAND_SYNTAX_ERROR;
108 static int initialized = 0;
114 command_context_mode(CMD_CTX, COMMAND_EXEC);
116 if (target_init(CMD_CTX) != ERROR_OK)
118 LOG_DEBUG("target init complete");
120 if ((retval = jtag_interface_init(CMD_CTX)) != ERROR_OK)
122 /* we must be able to set up the jtag interface */
125 LOG_DEBUG("jtag interface init complete");
127 /* Try to initialize & examine the JTAG chain at this point, but
128 * continue startup regardless */
129 if (jtag_init(CMD_CTX) == ERROR_OK)
131 LOG_DEBUG("jtag init complete");
132 if (target_examine() == ERROR_OK)
134 LOG_DEBUG("jtag examine complete");
138 if (flash_init_drivers(CMD_CTX) != ERROR_OK)
140 LOG_DEBUG("flash init complete");
142 if (mflash_init_drivers(CMD_CTX) != ERROR_OK)
144 LOG_DEBUG("mflash init complete");
146 if (nand_init(CMD_CTX) != ERROR_OK)
148 LOG_DEBUG("NAND init complete");
150 command_context_mode(CMD_CTX, COMMAND_CONFIG);
151 if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
153 command_context_mode(CMD_CTX, COMMAND_EXEC);
155 /* initialize telnet subsystem */
156 gdb_target_add_all(all_targets);
158 target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
163 static const struct command_registration openocd_command_handlers[] = {
166 .handler = &handle_version_command,
168 .help = "show program version",
172 .handler = &handle_noinit_command,
173 .mode = COMMAND_CONFIG,
174 .help = "Prevent 'init' from being called at startup.",
178 .handler = &handle_init_command,
179 .mode = COMMAND_CONFIG,
180 .help = "Initializes configured targets and servers. "
181 "Changes command mode from CONFIG to EXEC. "
182 "Unless 'noinit' is called, this command is "
183 "called automatically at the end of startup.",
186 COMMAND_REGISTRATION_DONE
189 struct command_context *global_cmd_ctx;
191 /* NB! this fn can be invoked outside this file for non PC hosted builds */
192 struct command_context *setup_command_handler(Jim_Interp *interp)
195 LOG_DEBUG("log_init: complete");
197 struct command_context *cmd_ctx;
199 global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl, interp);
201 register_commands(cmd_ctx, NULL, openocd_command_handlers);
202 /* register subsystem commands */
203 server_register_commands(cmd_ctx);
204 gdb_register_commands(cmd_ctx);
205 log_register_commands(cmd_ctx);
206 jtag_register_commands(cmd_ctx);
207 xsvf_register_commands(cmd_ctx);
208 svf_register_commands(cmd_ctx);
209 target_register_commands(cmd_ctx);
210 flash_register_commands(cmd_ctx);
211 nand_register_commands(cmd_ctx);
212 pld_register_commands(cmd_ctx);
213 mflash_register_commands(cmd_ctx);
215 LOG_DEBUG("command registration: complete");
217 LOG_OUTPUT(OPENOCD_VERSION "\n");
222 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
223 /* implementations of OpenOCD that uses multithreading needs to know when
224 * OpenOCD is sleeping. No-op in vanilla OpenOCD
226 void openocd_sleep_prelude(void)
230 void openocd_sleep_postlude(void)
236 /* normally this is the main() function entry, but if OpenOCD is linked
237 * into application, then this fn will not be invoked, but rather that
238 * application will have it's own implementation of main(). */
239 int openocd_main(int argc, char *argv[])
243 /* initialize commandline interface */
244 struct command_context *cmd_ctx;
246 cmd_ctx = setup_command_handler(NULL);
249 if (ioutil_init(cmd_ctx) != ERROR_OK)
255 LOG_OUTPUT("For bug reports, read\n\t"
256 "http://openocd.berlios.de/doc/doxygen/bugs.html"
260 command_context_mode(cmd_ctx, COMMAND_CONFIG);
261 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
263 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
266 ret = parse_config_file(cmd_ctx);
271 if (httpd_start(cmd_ctx) != ERROR_OK)
275 ret = server_init(cmd_ctx);
281 ret = command_run_line(cmd_ctx, "init");
286 /* handle network connections */
288 server_loop(cmd_ctx);
296 unregister_all_commands(cmd_ctx, NULL);
298 /* free commandline interface */
299 command_done(cmd_ctx);
301 jtag_interface_quit();