1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Ø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, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
30 #include <jtag/adapter.h>
31 #include <jtag/jtag.h>
32 #include <transport/transport.h>
33 #include <helper/util.h>
34 #include <helper/configuration.h>
35 #include <flash/nor/core.h>
36 #include <flash/nand/core.h>
38 #include <target/arm_cti.h>
39 #include <target/arm_adi_v5.h>
40 #include <target/arm_tpiu_swo.h>
43 #include <server/server.h>
44 #include <server/gdb_server.h>
45 #include <server/rtt_server.h>
52 #define OPENOCD_VERSION \
53 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
55 #define OPENOCD_VERSION \
56 "Open On-Chip Debugger " VERSION RELSTR
59 static const char openocd_startup_tcl[] = {
60 #include "startup_tcl.inc"
61 0 /* Terminate with zero */
64 /* Give scripts and TELNET a way to find out what version this is */
65 static int jim_version_command(Jim_Interp *interp, int argc,
66 Jim_Obj * const *argv)
72 version_str = OPENOCD_VERSION;
75 str = Jim_GetString(argv[1], NULL);
77 if (strcmp("git", str) == 0)
78 version_str = GITVERSION;
80 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
85 static int log_target_callback_event_handler(struct target *target,
86 enum target_event event,
90 case TARGET_EVENT_GDB_START:
91 target->verbose_halt_msg = false;
93 case TARGET_EVENT_GDB_END:
94 target->verbose_halt_msg = true;
96 case TARGET_EVENT_HALTED:
97 if (target->verbose_halt_msg) {
98 /* do not display information when debugger caused the halt */
99 target_arch_state(target);
109 static bool init_at_startup = true;
111 COMMAND_HANDLER(handle_noinit_command)
114 return ERROR_COMMAND_SYNTAX_ERROR;
115 init_at_startup = false;
119 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
120 COMMAND_HANDLER(handle_init_command)
124 return ERROR_COMMAND_SYNTAX_ERROR;
127 static int initialized;
133 retval = command_run_line(CMD_CTX, "target init");
134 if (retval != ERROR_OK)
137 retval = adapter_init(CMD_CTX);
138 if (retval != ERROR_OK) {
139 /* we must be able to set up the debug adapter */
143 LOG_DEBUG("Debug Adapter init complete");
145 /* "transport init" verifies the expected devices are present;
146 * for JTAG, it checks the list of configured TAPs against
147 * what's discoverable, possibly with help from the platform's
148 * JTAG event handlers. (which require COMMAND_EXEC)
150 command_context_mode(CMD_CTX, COMMAND_EXEC);
152 retval = command_run_line(CMD_CTX, "transport init");
153 if (retval != ERROR_OK)
156 retval = command_run_line(CMD_CTX, "dap init");
157 if (retval != ERROR_OK)
160 LOG_DEBUG("Examining targets...");
161 if (target_examine() != ERROR_OK)
162 LOG_DEBUG("target examination failed");
164 command_context_mode(CMD_CTX, COMMAND_CONFIG);
166 if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
169 if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
172 if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
174 command_context_mode(CMD_CTX, COMMAND_EXEC);
176 /* in COMMAND_EXEC, after target_examine(), only tpiu or only swo */
177 if (command_run_line(CMD_CTX, "tpiu init") != ERROR_OK)
180 /* initialize telnet subsystem */
181 gdb_target_add_all(all_targets);
183 target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
185 if (command_run_line(CMD_CTX, "_run_post_init_commands") != ERROR_OK)
191 COMMAND_HANDLER(handle_add_script_search_dir_command)
194 return ERROR_COMMAND_SYNTAX_ERROR;
196 add_script_search_dir(CMD_ARGV[0]);
201 static const struct command_registration openocd_command_handlers[] = {
204 .jim_handler = jim_version_command,
206 .help = "show program version",
210 .handler = &handle_noinit_command,
211 .mode = COMMAND_CONFIG,
212 .help = "Prevent 'init' from being called at startup.",
217 .handler = &handle_init_command,
219 .help = "Initializes configured targets and servers. "
220 "Changes command mode from CONFIG to EXEC. "
221 "Unless 'noinit' is called, this command is "
222 "called automatically at the end of startup.",
226 .name = "add_script_search_dir",
227 .handler = &handle_add_script_search_dir_command,
229 .help = "dir to search for config files and scripts",
230 .usage = "<directory>"
232 COMMAND_REGISTRATION_DONE
235 static int openocd_register_commands(struct command_context *cmd_ctx)
237 return register_commands(cmd_ctx, NULL, openocd_command_handlers);
241 * TODO: to be removed after v0.12.0
242 * workaround for syntax change of "expr" in jimtcl 0.81
243 * replace "expr" with openocd version that prints the deprecated msg
245 struct jim_scriptobj {
247 Jim_Obj *filename_obj;
256 static int jim_expr_command(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
259 return Jim_EvalExpression(interp, argv[1]);
262 Jim_Obj *obj = Jim_ConcatObj(interp, argc - 1, argv + 1);
263 Jim_IncrRefCount(obj);
264 const char *s = Jim_String(obj);
265 struct jim_scriptobj *script = Jim_GetIntRepPtr(interp->currentScriptObj);
266 if (interp->currentScriptObj == interp->emptyObj ||
267 strcmp(interp->currentScriptObj->typePtr->name, "script") ||
268 script->subst_flags ||
269 script->filename_obj == interp->emptyObj)
270 LOG_WARNING("DEPRECATED! use 'expr { %s }' not 'expr %s'", s, s);
272 LOG_WARNING("DEPRECATED! (%s:%d) use 'expr { %s }' not 'expr %s'",
273 Jim_String(script->filename_obj), script->linenr, s, s);
274 int retcode = Jim_EvalExpression(interp, obj);
275 Jim_DecrRefCount(interp, obj);
279 Jim_WrongNumArgs(interp, 1, argv, "expression ?...?");
283 static const struct command_registration expr_handler[] = {
286 .jim_handler = jim_expr_command,
291 COMMAND_REGISTRATION_DONE
294 static int workaround_for_jimtcl_expr(struct command_context *cmd_ctx)
296 return register_commands(cmd_ctx, NULL, expr_handler);
299 struct command_context *global_cmd_ctx;
301 static struct command_context *setup_command_handler(Jim_Interp *interp)
304 LOG_DEBUG("log_init: complete");
306 struct command_context *cmd_ctx = command_init(openocd_startup_tcl, interp);
308 /* register subsystem commands */
309 typedef int (*command_registrant_t)(struct command_context *cmd_ctx_value);
310 static const command_registrant_t command_registrants[] = {
311 &workaround_for_jimtcl_expr,
312 &openocd_register_commands,
313 &server_register_commands,
314 &gdb_register_commands,
315 &log_register_commands,
316 &rtt_server_register_commands,
317 &transport_register_commands,
318 &adapter_register_commands,
319 &target_register_commands,
320 &flash_register_commands,
321 &nand_register_commands,
322 &pld_register_commands,
323 &cti_register_commands,
324 &dap_register_commands,
325 &arm_tpiu_swo_register_commands,
328 for (unsigned i = 0; command_registrants[i]; i++) {
329 int retval = (*command_registrants[i])(cmd_ctx);
330 if (retval != ERROR_OK) {
331 command_done(cmd_ctx);
335 LOG_DEBUG("command registration: complete");
337 LOG_OUTPUT(OPENOCD_VERSION "\n"
338 "Licensed under GNU GPL v2\n");
340 global_cmd_ctx = cmd_ctx;
345 /** OpenOCD runtime meat that can become single-thread in future. It parse
346 * commandline, reads configuration, sets up the target and starts server loop.
347 * Commandline arguments are passed into this function from openocd_main().
349 static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
353 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
356 if (server_preinit() != ERROR_OK)
359 ret = parse_config_file(cmd_ctx);
360 if (ret == ERROR_COMMAND_CLOSE_CONNECTION) {
361 server_quit(); /* gdb server may be initialized by -c init */
363 } else if (ret != ERROR_OK) {
364 server_quit(); /* gdb server may be initialized by -c init */
368 ret = server_init(cmd_ctx);
372 if (init_at_startup) {
373 ret = command_run_line(cmd_ctx, "init");
374 if (ret != ERROR_OK) {
380 ret = server_loop(cmd_ctx);
382 int last_signal = server_quit();
383 if (last_signal != ERROR_OK)
391 /* normally this is the main() function entry, but if OpenOCD is linked
392 * into application, then this fn will not be invoked, but rather that
393 * application will have it's own implementation of main(). */
394 int openocd_main(int argc, char *argv[])
398 /* initialize commandline interface */
399 struct command_context *cmd_ctx;
401 cmd_ctx = setup_command_handler(NULL);
403 if (util_init(cmd_ctx) != ERROR_OK)
406 if (rtt_init() != ERROR_OK)
409 LOG_OUTPUT("For bug reports, read\n\t"
410 "http://openocd.org/doc/doxygen/bugs.html"
413 command_context_mode(cmd_ctx, COMMAND_CONFIG);
414 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
416 server_host_os_entry();
418 /* Start the executable meat that can evolve into thread in future. */
419 ret = openocd_thread(argc, argv, cmd_ctx);
421 flash_free_all_banks();
423 arm_tpiu_swo_cleanup_all();
426 unregister_all_commands(cmd_ctx, NULL);
427 help_del_all_commands(cmd_ctx);
429 /* free all DAP and CTI objects */
430 arm_cti_cleanup_all();
435 server_host_os_close();
437 /* Shutdown commandline interface */
438 command_exit(cmd_ctx);
445 if (ret == ERROR_FAIL)
447 else if (ret != ERROR_OK)