Fix some problems with the bin2char utility
[openocd.git] / src / openocd.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007-2010 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 Richard Missenden *
9 * richard.missenden@googlemail.com *
10 * *
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. *
15 * *
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. *
20 * *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
25 ***************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "openocd.h"
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>
40 #include <pld/pld.h>
41 #include <flash/mflash.h>
42
43 #include <server/server.h>
44 #include <server/gdb_server.h>
45
46 #ifdef HAVE_STRINGS_H
47 #include <strings.h>
48 #endif
49
50 #define OPENOCD_VERSION \
51 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
52
53 static const char openocd_startup_tcl[] = {
54 #include "startup_tcl.inc"
55 0 /* Terminate with zero */
56 };
57
58 /* Give scripts and TELNET a way to find out what version this is */
59 static int jim_version_command(Jim_Interp *interp, int argc,
60 Jim_Obj * const *argv)
61 {
62 if (argc > 2)
63 return JIM_ERR;
64 const char *str = "";
65 char *version_str;
66 version_str = OPENOCD_VERSION;
67
68 if (argc == 2)
69 str = Jim_GetString(argv[1], NULL);
70
71 if (strcmp("git", str) == 0)
72 version_str = GITVERSION;
73
74 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
75
76 return JIM_OK;
77 }
78
79 static int log_target_callback_event_handler(struct target *target,
80 enum target_event event,
81 void *priv)
82 {
83 switch (event) {
84 case TARGET_EVENT_GDB_START:
85 target->display = 0;
86 break;
87 case TARGET_EVENT_GDB_END:
88 target->display = 1;
89 break;
90 case TARGET_EVENT_HALTED:
91 if (target->display) {
92 /* do not display information when debugger caused the halt */
93 target_arch_state(target);
94 }
95 break;
96 default:
97 break;
98 }
99
100 return ERROR_OK;
101 }
102
103 static bool init_at_startup = true;
104
105 COMMAND_HANDLER(handle_noinit_command)
106 {
107 if (CMD_ARGC != 0)
108 return ERROR_COMMAND_SYNTAX_ERROR;
109 init_at_startup = false;
110 return ERROR_OK;
111 }
112
113 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
114 COMMAND_HANDLER(handle_init_command)
115 {
116
117 if (CMD_ARGC != 0)
118 return ERROR_COMMAND_SYNTAX_ERROR;
119
120 int retval;
121 static int initialized;
122 if (initialized)
123 return ERROR_OK;
124
125 initialized = 1;
126
127 retval = command_run_line(CMD_CTX, "target init");
128 if (ERROR_OK != retval)
129 return ERROR_FAIL;
130
131 retval = adapter_init(CMD_CTX);
132 if (retval != ERROR_OK) {
133 /* we must be able to set up the debug adapter */
134 return retval;
135 }
136
137 LOG_DEBUG("Debug Adapter init complete");
138
139 /* "transport init" verifies the expected devices are present;
140 * for JTAG, it checks the list of configured TAPs against
141 * what's discoverable, possibly with help from the platform's
142 * JTAG event handlers. (which require COMMAND_EXEC)
143 */
144 command_context_mode(CMD_CTX, COMMAND_EXEC);
145
146 retval = command_run_line(CMD_CTX, "transport init");
147 if (ERROR_OK != retval)
148 return ERROR_FAIL;
149
150 LOG_DEBUG("Examining targets...");
151 if (target_examine() != ERROR_OK)
152 LOG_DEBUG("target examination failed");
153
154 command_context_mode(CMD_CTX, COMMAND_CONFIG);
155
156 if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
157 return ERROR_FAIL;
158
159 if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
160 return ERROR_FAIL;
161
162 if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
163 return ERROR_FAIL;
164
165 if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
166 return ERROR_FAIL;
167 command_context_mode(CMD_CTX, COMMAND_EXEC);
168
169 /* initialize telnet subsystem */
170 gdb_target_add_all(all_targets);
171
172 target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
173
174 return ERROR_OK;
175 }
176
177 COMMAND_HANDLER(handle_add_script_search_dir_command)
178 {
179 if (CMD_ARGC != 1)
180 return ERROR_COMMAND_SYNTAX_ERROR;
181
182 add_script_search_dir(CMD_ARGV[0]);
183
184 return ERROR_OK;
185 }
186
187 static const struct command_registration openocd_command_handlers[] = {
188 {
189 .name = "version",
190 .jim_handler = jim_version_command,
191 .mode = COMMAND_ANY,
192 .help = "show program version",
193 },
194 {
195 .name = "noinit",
196 .handler = &handle_noinit_command,
197 .mode = COMMAND_CONFIG,
198 .help = "Prevent 'init' from being called at startup.",
199 .usage = ""
200 },
201 {
202 .name = "init",
203 .handler = &handle_init_command,
204 .mode = COMMAND_ANY,
205 .help = "Initializes configured targets and servers. "
206 "Changes command mode from CONFIG to EXEC. "
207 "Unless 'noinit' is called, this command is "
208 "called automatically at the end of startup.",
209 .usage = ""
210 },
211 {
212 .name = "add_script_search_dir",
213 .handler = &handle_add_script_search_dir_command,
214 .mode = COMMAND_ANY,
215 .help = "dir to search for config files and scripts",
216 .usage = "<directory>"
217 },
218 COMMAND_REGISTRATION_DONE
219 };
220
221 static int openocd_register_commands(struct command_context *cmd_ctx)
222 {
223 return register_commands(cmd_ctx, NULL, openocd_command_handlers);
224 }
225
226 struct command_context *global_cmd_ctx;
227
228 /* NB! this fn can be invoked outside this file for non PC hosted builds
229 * NB! do not change to 'static'!!!!
230 */
231 struct command_context *setup_command_handler(Jim_Interp *interp)
232 {
233 log_init();
234 LOG_DEBUG("log_init: complete");
235
236 struct command_context *cmd_ctx = command_init(openocd_startup_tcl, interp);
237
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,
252 NULL
253 };
254 for (unsigned i = 0; NULL != command_registrants[i]; i++) {
255 int retval = (*command_registrants[i])(cmd_ctx);
256 if (ERROR_OK != retval) {
257 command_done(cmd_ctx);
258 return NULL;
259 }
260 }
261 LOG_DEBUG("command registration: complete");
262
263 LOG_OUTPUT(OPENOCD_VERSION "\n"
264 "Licensed under GNU GPL v2\n");
265
266 global_cmd_ctx = cmd_ctx;
267
268 return cmd_ctx;
269 }
270
271 /** OpenOCD runtime meat that can become single-thread in future. It parse
272 * commandline, reads configuration, sets up the target and starts server loop.
273 * Commandline arguments are passed into this function from openocd_main().
274 */
275 static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
276 {
277 int ret;
278
279 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
280 return EXIT_FAILURE;
281
282 if (server_preinit() != ERROR_OK)
283 return EXIT_FAILURE;
284
285 ret = parse_config_file(cmd_ctx);
286 if (ret != ERROR_OK)
287 return EXIT_FAILURE;
288
289 ret = server_init(cmd_ctx);
290 if (ERROR_OK != ret)
291 return EXIT_FAILURE;
292
293 if (init_at_startup) {
294 ret = command_run_line(cmd_ctx, "init");
295 if (ERROR_OK != ret)
296 return EXIT_FAILURE;
297 }
298
299 server_loop(cmd_ctx);
300
301 server_quit();
302
303 return ret;
304 }
305
306 /* normally this is the main() function entry, but if OpenOCD is linked
307 * into application, then this fn will not be invoked, but rather that
308 * application will have it's own implementation of main(). */
309 int openocd_main(int argc, char *argv[])
310 {
311 int ret;
312
313 /* initialize commandline interface */
314 struct command_context *cmd_ctx;
315
316 cmd_ctx = setup_command_handler(NULL);
317
318 if (util_init(cmd_ctx) != ERROR_OK)
319 return EXIT_FAILURE;
320
321 if (ioutil_init(cmd_ctx) != ERROR_OK)
322 return EXIT_FAILURE;
323
324 LOG_OUTPUT("For bug reports, read\n\t"
325 "http://openocd.sourceforge.net/doc/doxygen/bugs.html"
326 "\n");
327
328 command_context_mode(cmd_ctx, COMMAND_CONFIG);
329 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
330
331 /* Start the executable meat that can evolve into thread in future. */
332 ret = openocd_thread(argc, argv, cmd_ctx);
333
334 unregister_all_commands(cmd_ctx, NULL);
335
336 /* free commandline interface */
337 command_done(cmd_ctx);
338
339 adapter_quit();
340
341 return ret;
342 }