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 "telnet_server.h"
42 #include "gdb_server.h"
43 #include "tcl_server.h"
51 #define OPENOCD_VERSION \
52 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
54 /* Give TELNET a way to find out what version this is */
55 COMMAND_HANDLER(handle_version_command
)
58 return ERROR_COMMAND_SYNTAX_ERROR
;
60 command_print(CMD_CTX
, OPENOCD_VERSION
);
65 static void exit_handler(void)
67 jtag_interface_quit();
70 static int log_target_callback_event_handler(struct target
*target
, enum target_event event
, void *priv
)
74 case TARGET_EVENT_GDB_START
:
77 case TARGET_EVENT_GDB_END
:
80 case TARGET_EVENT_HALTED
:
83 /* do not display information when debugger caused the halt */
84 target_arch_state(target
);
94 int ioutil_init(struct command_context
*cmd_ctx
);
96 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
97 COMMAND_HANDLER(handle_init_command
)
101 return ERROR_COMMAND_SYNTAX_ERROR
;
104 static int initialized
= 0;
110 atexit(exit_handler
);
112 command_context_mode(CMD_CTX
, COMMAND_EXEC
);
114 if (target_init(CMD_CTX
) != ERROR_OK
)
116 LOG_DEBUG("target init complete");
118 if ((retval
= jtag_interface_init(CMD_CTX
)) != ERROR_OK
)
120 /* we must be able to set up the jtag interface */
123 LOG_DEBUG("jtag interface init complete");
125 /* Try to initialize & examine the JTAG chain at this point, but
126 * continue startup regardless */
127 if (jtag_init(CMD_CTX
) == ERROR_OK
)
129 LOG_DEBUG("jtag init complete");
130 if (target_examine() == ERROR_OK
)
132 LOG_DEBUG("jtag examine complete");
136 if (flash_init_drivers(CMD_CTX
) != ERROR_OK
)
138 LOG_DEBUG("flash init complete");
140 if (mflash_init_drivers(CMD_CTX
) != ERROR_OK
)
142 LOG_DEBUG("mflash init complete");
144 if (nand_init(CMD_CTX
) != ERROR_OK
)
146 LOG_DEBUG("NAND init complete");
148 if (pld_init(CMD_CTX
) != ERROR_OK
)
150 LOG_DEBUG("pld init complete");
152 /* initialize tcp server */
155 /* initialize telnet subsystem */
156 telnet_init("Open On-Chip Debugger");
158 tcl_init(); /* allows tcl to just connect without going thru telnet */
160 target_register_event_callback(log_target_callback_event_handler
, CMD_CTX
);
165 static const struct command_registration openocd_command_handlers
[] = {
168 .handler
= &handle_version_command
,
169 .mode
= COMMAND_EXEC
,
170 .help
= "show program version",
174 .handler
= &handle_init_command
,
176 .help
= "Initializes configured targets and servers. "
177 "If called more than once, does nothing.",
179 COMMAND_REGISTRATION_DONE
182 struct command_context
*global_cmd_ctx
;
184 /* NB! this fn can be invoked outside this file for non PC hosted builds */
185 struct command_context
*setup_command_handler(void)
188 LOG_DEBUG("log_init: complete");
190 struct command_context
*cmd_ctx
;
192 global_cmd_ctx
= cmd_ctx
= command_init(openocd_startup_tcl
);
194 register_commands(cmd_ctx
, NULL
, openocd_command_handlers
);
195 /* register subsystem commands */
196 server_register_commands(cmd_ctx
);
197 telnet_register_commands(cmd_ctx
);
198 gdb_register_commands(cmd_ctx
);
199 tcl_register_commands(cmd_ctx
); /* tcl server commands */
200 log_register_commands(cmd_ctx
);
201 jtag_register_commands(cmd_ctx
);
202 xsvf_register_commands(cmd_ctx
);
203 svf_register_commands(cmd_ctx
);
204 target_register_commands(cmd_ctx
);
205 flash_register_commands(cmd_ctx
);
206 nand_register_commands(cmd_ctx
);
207 pld_register_commands(cmd_ctx
);
208 mflash_register_commands(cmd_ctx
);
210 LOG_DEBUG("command registration: complete");
212 LOG_OUTPUT(OPENOCD_VERSION
"\n");
217 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
218 /* implementations of OpenOCD that uses multithreading needs to know when
219 * OpenOCD is sleeping. No-op in vanilla OpenOCD
221 void openocd_sleep_prelude(void)
225 void openocd_sleep_postlude(void)
231 /* normally this is the main() function entry, but if OpenOCD is linked
232 * into application, then this fn will not be invoked, but rather that
233 * application will have it's own implementation of main(). */
234 int openocd_main(int argc
, char *argv
[])
238 /* initialize commandline interface */
239 struct command_context
*cmd_ctx
;
241 cmd_ctx
= setup_command_handler();
244 if (ioutil_init(cmd_ctx
) != ERROR_OK
)
250 LOG_OUTPUT("For bug reports, read\n\t"
251 "http://openocd.berlios.de/doc/doxygen/bugs.html"
255 command_context_mode(cmd_ctx
, COMMAND_CONFIG
);
256 command_set_output_handler(cmd_ctx
, configuration_output_handler
, NULL
);
258 if (parse_cmdline_args(cmd_ctx
, argc
, argv
) != ERROR_OK
)
261 ret
= parse_config_file(cmd_ctx
);
262 if ((ret
!= ERROR_OK
) && (ret
!= ERROR_COMMAND_CLOSE_CONNECTION
))
266 if (httpd_start(cmd_ctx
) != ERROR_OK
)
270 if (ret
!= ERROR_COMMAND_CLOSE_CONNECTION
)
272 if (command_run_line(cmd_ctx
, "init") != ERROR_OK
)
275 /* handle network connections */
276 server_loop(cmd_ctx
);
279 /* shut server down */
286 unregister_all_commands(cmd_ctx
, NULL
);
288 /* free commandline interface */
289 command_done(cmd_ctx
);