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, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
32 #include <jtag/driver.h>
33 #include <jtag/jtag.h>
34 #include <transport/transport.h>
35 #include <helper/ioutil.h>
36 #include <helper/util.h>
37 #include <helper/configuration.h>
38 #include <flash/nor/core.h>
39 #include <flash/nand/core.h>
41 #include <flash/mflash.h>
43 #include <server/server.h>
44 #include <server/gdb_server.h>
50 #define OPENOCD_VERSION \
51 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
53 /* Give scripts and TELNET a way to find out what version this is */
54 static int jim_version_command(Jim_Interp
*interp
, int argc
,
55 Jim_Obj
* const *argv
)
63 version_str
= OPENOCD_VERSION
;
66 str
= Jim_GetString(argv
[1], NULL
);
68 if (strcmp("git", str
) == 0)
70 version_str
= GITVERSION
;
73 Jim_SetResult(interp
, Jim_NewStringObj(interp
, version_str
, -1));
78 static int log_target_callback_event_handler(struct target
*target
, enum target_event event
, void *priv
)
82 case TARGET_EVENT_GDB_START
:
85 case TARGET_EVENT_GDB_END
:
88 case TARGET_EVENT_HALTED
:
91 /* do not display information when debugger caused the halt */
92 target_arch_state(target
);
102 static bool init_at_startup
= true;
104 COMMAND_HANDLER(handle_noinit_command
)
107 return ERROR_COMMAND_SYNTAX_ERROR
;
108 init_at_startup
= false;
112 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
113 COMMAND_HANDLER(handle_init_command
)
117 return ERROR_COMMAND_SYNTAX_ERROR
;
120 static int initialized
= 0;
126 retval
= command_run_line(CMD_CTX
, "target init");
127 if (ERROR_OK
!= retval
)
130 if ((retval
= adapter_init(CMD_CTX
)) != ERROR_OK
)
132 /* we must be able to set up the debug adapter */
136 LOG_DEBUG("Debug Adapter init complete");
138 /* "transport init" verifies the expected devices are present;
139 * for JTAG, it checks the list of configured TAPs against
140 * what's discoverable, possibly with help from the platform's
141 * JTAG event handlers. (which require COMMAND_EXEC)
143 command_context_mode(CMD_CTX
, COMMAND_EXEC
);
145 retval
= command_run_line(CMD_CTX
, "transport init");
146 if (ERROR_OK
!= retval
)
149 LOG_DEBUG("Examining targets...");
150 if (target_examine() != ERROR_OK
)
151 LOG_DEBUG("target examination failed");
153 command_context_mode(CMD_CTX
, COMMAND_CONFIG
);
155 if (command_run_line(CMD_CTX
, "flash init") != ERROR_OK
)
158 if (command_run_line(CMD_CTX
, "mflash init") != ERROR_OK
)
161 if (command_run_line(CMD_CTX
, "nand init") != ERROR_OK
)
164 if (command_run_line(CMD_CTX
, "pld init") != ERROR_OK
)
166 command_context_mode(CMD_CTX
, COMMAND_EXEC
);
168 /* initialize telnet subsystem */
169 gdb_target_add_all(all_targets
);
171 target_register_event_callback(log_target_callback_event_handler
, CMD_CTX
);
176 COMMAND_HANDLER(handle_add_script_search_dir_command
)
179 return ERROR_COMMAND_SYNTAX_ERROR
;
181 add_script_search_dir(CMD_ARGV
[0]);
186 static const struct command_registration openocd_command_handlers
[] = {
189 .jim_handler
= jim_version_command
,
191 .help
= "show program version",
195 .handler
= &handle_noinit_command
,
196 .mode
= COMMAND_CONFIG
,
197 .help
= "Prevent 'init' from being called at startup.",
202 .handler
= &handle_init_command
,
204 .help
= "Initializes configured targets and servers. "
205 "Changes command mode from CONFIG to EXEC. "
206 "Unless 'noinit' is called, this command is "
207 "called automatically at the end of startup.",
211 .name
= "add_script_search_dir",
212 .handler
= &handle_add_script_search_dir_command
,
214 .help
= "dir to search for config files and scripts",
215 .usage
= "<directory>"
217 COMMAND_REGISTRATION_DONE
220 static int openocd_register_commands(struct command_context
*cmd_ctx
)
222 return register_commands(cmd_ctx
, NULL
, openocd_command_handlers
);
225 struct command_context
*global_cmd_ctx
;
227 /* NB! this fn can be invoked outside this file for non PC hosted builds
228 * NB! do not change to 'static'!!!!
230 struct command_context
*setup_command_handler(Jim_Interp
*interp
)
233 LOG_DEBUG("log_init: complete");
235 const char *startup
= openocd_startup_tcl
;
236 struct command_context
*cmd_ctx
= command_init(startup
, interp
);
238 /* register subsystem commands */
239 typedef int (*command_registrant_t
)(struct command_context
*cmd_ctx_value
);
240 static const command_registrant_t command_registrants
[] = {
241 &openocd_register_commands
,
242 &server_register_commands
,
243 &gdb_register_commands
,
244 &log_register_commands
,
245 &transport_register_commands
,
246 &interface_register_commands
,
247 &target_register_commands
,
248 &flash_register_commands
,
249 &nand_register_commands
,
250 &pld_register_commands
,
251 &mflash_register_commands
,
254 for (unsigned i
= 0; NULL
!= command_registrants
[i
]; i
++)
256 int retval
= (*command_registrants
[i
])(cmd_ctx
);
257 if (ERROR_OK
!= retval
)
259 command_done(cmd_ctx
);
263 LOG_DEBUG("command registration: complete");
265 LOG_OUTPUT(OPENOCD_VERSION
"\n"
266 "Licensed under GNU GPL v2\n");
268 global_cmd_ctx
= cmd_ctx
;
273 /** OpenOCD runtime meat that can become single-thread in future. It parse
274 * commandline, reads configuration, sets up the target and starts server loop.
275 * Commandline arguments are passed into this function from openocd_main().
277 static int openocd_thread(int argc
, char *argv
[], struct command_context
*cmd_ctx
)
281 if (parse_cmdline_args(cmd_ctx
, argc
, argv
) != ERROR_OK
)
284 if (server_preinit() != ERROR_OK
)
287 ret
= parse_config_file(cmd_ctx
);
291 ret
= server_init(cmd_ctx
);
297 ret
= command_run_line(cmd_ctx
, "init");
302 server_loop(cmd_ctx
);
309 /* normally this is the main() function entry, but if OpenOCD is linked
310 * into application, then this fn will not be invoked, but rather that
311 * application will have it's own implementation of main(). */
312 int openocd_main(int argc
, char *argv
[])
316 /* initialize commandline interface */
317 struct command_context
*cmd_ctx
;
319 cmd_ctx
= setup_command_handler(NULL
);
321 if (util_init(cmd_ctx
) != ERROR_OK
)
324 if (ioutil_init(cmd_ctx
) != ERROR_OK
)
327 LOG_OUTPUT("For bug reports, read\n\t"
328 "http://openocd.sourceforge.net/doc/doxygen/bugs.html"
331 command_context_mode(cmd_ctx
, COMMAND_CONFIG
);
332 command_set_output_handler(cmd_ctx
, configuration_output_handler
, NULL
);
334 /* Start the executable meat that can evolve into thread in future. */
335 ret
= openocd_thread(argc
, argv
, cmd_ctx
);
337 unregister_all_commands(cmd_ctx
, NULL
);
339 /* free commandline interface */
340 command_done(cmd_ctx
);