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 ***************************************************************************/
32 #include <jtag/driver.h>
33 #include <jtag/jtag.h>
34 #include <jtag/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>
45 #include <server/httpd.h>
52 #define OPENOCD_VERSION \
53 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
55 /* Give TELNET a way to find out what version this is */
56 COMMAND_HANDLER(handle_version_command
)
59 return ERROR_COMMAND_SYNTAX_ERROR
;
61 command_print(CMD_CTX
, OPENOCD_VERSION
);
66 static int log_target_callback_event_handler(struct target
*target
, enum target_event event
, void *priv
)
70 case TARGET_EVENT_GDB_START
:
73 case TARGET_EVENT_GDB_END
:
76 case TARGET_EVENT_HALTED
:
79 /* do not display information when debugger caused the halt */
80 target_arch_state(target
);
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 retval
= command_run_line(CMD_CTX
, "target init");
115 if (ERROR_OK
!= retval
)
118 if ((retval
= adapter_init(CMD_CTX
)) != ERROR_OK
)
120 /* we must be able to set up the debug adapter */
124 LOG_DEBUG("Debug Adapter init complete");
126 /* "transport init" verifies the expected devices are present;
127 * for JTAG, it checks the list of configured TAPs against
128 * what's discoverable, possibly with help from the platform's
129 * JTAG event handlers. (which require COMMAND_EXEC)
131 command_context_mode(CMD_CTX
, COMMAND_EXEC
);
133 retval
= command_run_line(CMD_CTX
, "transport init");
134 if (ERROR_OK
!= retval
)
137 LOG_DEBUG("Examining targets...");
138 if (target_examine() != ERROR_OK
)
139 LOG_DEBUG("target examination failed");
141 command_context_mode(CMD_CTX
, COMMAND_CONFIG
);
143 if (command_run_line(CMD_CTX
, "flash init") != ERROR_OK
)
146 if (command_run_line(CMD_CTX
, "mflash init") != ERROR_OK
)
149 if (command_run_line(CMD_CTX
, "nand init") != ERROR_OK
)
152 if (command_run_line(CMD_CTX
, "pld init") != ERROR_OK
)
154 command_context_mode(CMD_CTX
, COMMAND_EXEC
);
156 /* initialize telnet subsystem */
157 gdb_target_add_all(all_targets
);
159 target_register_event_callback(log_target_callback_event_handler
, CMD_CTX
);
164 COMMAND_HANDLER(handle_add_script_search_dir_command
)
167 return ERROR_COMMAND_SYNTAX_ERROR
;
169 add_script_search_dir(CMD_ARGV
[0]);
174 static const struct command_registration openocd_command_handlers
[] = {
177 .handler
= &handle_version_command
,
179 .help
= "show program version",
183 .handler
= &handle_noinit_command
,
184 .mode
= COMMAND_CONFIG
,
185 .help
= "Prevent 'init' from being called at startup.",
189 .handler
= &handle_init_command
,
191 .help
= "Initializes configured targets and servers. "
192 "Changes command mode from CONFIG to EXEC. "
193 "Unless 'noinit' is called, this command is "
194 "called automatically at the end of startup.",
198 .name
= "add_script_search_dir",
199 .handler
= &handle_add_script_search_dir_command
,
201 .help
= "dir to search for config files and scripts",
204 COMMAND_REGISTRATION_DONE
207 static int openocd_register_commands(struct command_context
*cmd_ctx
)
209 return register_commands(cmd_ctx
, NULL
, openocd_command_handlers
);
212 struct command_context
*global_cmd_ctx
;
214 /* NB! this fn can be invoked outside this file for non PC hosted builds
215 * NB! do not change to 'static'!!!!
217 struct command_context
*setup_command_handler(Jim_Interp
*interp
)
220 LOG_DEBUG("log_init: complete");
222 const char *startup
= openocd_startup_tcl
;
223 struct command_context
*cmd_ctx
= command_init(startup
, interp
);
225 /* register subsystem commands */
226 typedef int (*command_registrant_t
)(struct command_context
*cmd_ctx
);
227 static const command_registrant_t command_registrants
[] = {
228 &openocd_register_commands
,
229 &server_register_commands
,
230 &gdb_register_commands
,
231 &log_register_commands
,
232 &transport_register_commands
,
233 &interface_register_commands
,
234 &target_register_commands
,
235 &flash_register_commands
,
236 &nand_register_commands
,
237 &pld_register_commands
,
238 &mflash_register_commands
,
241 for (unsigned i
= 0; NULL
!= command_registrants
[i
]; i
++)
243 int retval
= (*command_registrants
[i
])(cmd_ctx
);
244 if (ERROR_OK
!= retval
)
246 command_done(cmd_ctx
);
250 LOG_DEBUG("command registration: complete");
252 LOG_OUTPUT(OPENOCD_VERSION
"\n"
253 "Licensed under GNU GPL v2\n");
255 global_cmd_ctx
= cmd_ctx
;
260 /* normally this is the main() function entry, but if OpenOCD is linked
261 * into application, then this fn will not be invoked, but rather that
262 * application will have it's own implementation of main(). */
263 int openocd_main(int argc
, char *argv
[])
267 /* initialize commandline interface */
268 struct command_context
*cmd_ctx
;
270 cmd_ctx
= setup_command_handler(NULL
);
272 if (util_init(cmd_ctx
) != ERROR_OK
)
275 if (ioutil_init(cmd_ctx
) != ERROR_OK
)
278 LOG_OUTPUT("For bug reports, read\n\t"
279 "http://openocd.berlios.de/doc/doxygen/bugs.html"
282 command_context_mode(cmd_ctx
, COMMAND_CONFIG
);
283 command_set_output_handler(cmd_ctx
, configuration_output_handler
, NULL
);
285 if (parse_cmdline_args(cmd_ctx
, argc
, argv
) != ERROR_OK
)
288 if (server_preinit() != ERROR_OK
)
291 ret
= parse_config_file(cmd_ctx
);
295 if (httpd_start(cmd_ctx
) != ERROR_OK
)
298 ret
= server_init(cmd_ctx
);
304 ret
= command_run_line(cmd_ctx
, "init");
309 /* handle network connections */
311 server_loop(cmd_ctx
);
317 unregister_all_commands(cmd_ctx
, NULL
);
319 /* free commandline interface */
320 command_done(cmd_ctx
);