nand: factor init to 'nand init'
[openocd.git] / src / openocd.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ė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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "openocd.h"
32 #include "jtag.h"
33 #include "configuration.h"
34 #include "xsvf.h"
35 #include "svf.h"
36 #include "nand.h"
37 #include "pld.h"
38 #include "mflash.h"
39
40 #include "server.h"
41 #include "gdb_server.h"
42 #include "httpd.h"
43
44 #ifdef HAVE_STRINGS_H
45 #include <strings.h>
46 #endif
47
48
49 #define OPENOCD_VERSION \
50 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
51
52 /* Give TELNET a way to find out what version this is */
53 COMMAND_HANDLER(handle_version_command)
54 {
55 if (CMD_ARGC != 0)
56 return ERROR_COMMAND_SYNTAX_ERROR;
57
58 command_print(CMD_CTX, OPENOCD_VERSION);
59
60 return ERROR_OK;
61 }
62
63
64 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
65 {
66 switch (event)
67 {
68 case TARGET_EVENT_GDB_START:
69 target->display = 0;
70 break;
71 case TARGET_EVENT_GDB_END:
72 target->display = 1;
73 break;
74 case TARGET_EVENT_HALTED:
75 if (target->display)
76 {
77 /* do not display information when debugger caused the halt */
78 target_arch_state(target);
79 }
80 break;
81 default:
82 break;
83 }
84
85 return ERROR_OK;
86 }
87
88 int ioutil_init(struct command_context *cmd_ctx);
89
90 static bool init_at_startup = true;
91
92 COMMAND_HANDLER(handle_noinit_command)
93 {
94 if (CMD_ARGC != 0)
95 return ERROR_COMMAND_SYNTAX_ERROR;
96 init_at_startup = false;
97 return ERROR_OK;
98 }
99
100 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
101 COMMAND_HANDLER(handle_init_command)
102 {
103
104 if (CMD_ARGC != 0)
105 return ERROR_COMMAND_SYNTAX_ERROR;
106
107 int retval;
108 static int initialized = 0;
109 if (initialized)
110 return ERROR_OK;
111
112 initialized = 1;
113
114 command_context_mode(CMD_CTX, COMMAND_EXEC);
115
116 if (target_init(CMD_CTX) != ERROR_OK)
117 return ERROR_FAIL;
118 LOG_DEBUG("target init complete");
119
120 if ((retval = jtag_interface_init(CMD_CTX)) != ERROR_OK)
121 {
122 /* we must be able to set up the jtag interface */
123 return retval;
124 }
125 LOG_DEBUG("jtag interface init complete");
126
127 /* Try to initialize & examine the JTAG chain at this point, but
128 * continue startup regardless */
129 if (jtag_init(CMD_CTX) == ERROR_OK)
130 {
131 LOG_DEBUG("jtag init complete");
132 if (target_examine() == ERROR_OK)
133 {
134 LOG_DEBUG("jtag examine complete");
135 }
136 }
137
138 if (flash_init_drivers(CMD_CTX) != ERROR_OK)
139 return ERROR_FAIL;
140 LOG_DEBUG("flash init complete");
141
142 if (mflash_init_drivers(CMD_CTX) != ERROR_OK)
143 return ERROR_FAIL;
144 LOG_DEBUG("mflash init complete");
145
146 command_context_mode(CMD_CTX, COMMAND_CONFIG);
147 if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
148 return ERROR_FAIL;
149
150 if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
151 return ERROR_FAIL;
152 command_context_mode(CMD_CTX, COMMAND_EXEC);
153
154 /* initialize telnet subsystem */
155 gdb_target_add_all(all_targets);
156
157 target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
158
159 return ERROR_OK;
160 }
161
162 static const struct command_registration openocd_command_handlers[] = {
163 {
164 .name = "version",
165 .handler = &handle_version_command,
166 .mode = COMMAND_ANY,
167 .help = "show program version",
168 },
169 {
170 .name = "noinit",
171 .handler = &handle_noinit_command,
172 .mode = COMMAND_CONFIG,
173 .help = "Prevent 'init' from being called at startup.",
174 },
175 {
176 .name = "init",
177 .handler = &handle_init_command,
178 .mode = COMMAND_CONFIG,
179 .help = "Initializes configured targets and servers. "
180 "Changes command mode from CONFIG to EXEC. "
181 "Unless 'noinit' is called, this command is "
182 "called automatically at the end of startup.",
183
184 },
185 COMMAND_REGISTRATION_DONE
186 };
187
188 struct command_context *global_cmd_ctx;
189
190 /* NB! this fn can be invoked outside this file for non PC hosted builds */
191 struct command_context *setup_command_handler(Jim_Interp *interp)
192 {
193 log_init();
194 LOG_DEBUG("log_init: complete");
195
196 struct command_context *cmd_ctx;
197
198 global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl, interp);
199
200 register_commands(cmd_ctx, NULL, openocd_command_handlers);
201 /* register subsystem commands */
202 server_register_commands(cmd_ctx);
203 gdb_register_commands(cmd_ctx);
204 log_register_commands(cmd_ctx);
205 jtag_register_commands(cmd_ctx);
206 xsvf_register_commands(cmd_ctx);
207 svf_register_commands(cmd_ctx);
208 target_register_commands(cmd_ctx);
209 flash_register_commands(cmd_ctx);
210 nand_register_commands(cmd_ctx);
211 pld_register_commands(cmd_ctx);
212 mflash_register_commands(cmd_ctx);
213
214 LOG_DEBUG("command registration: complete");
215
216 LOG_OUTPUT(OPENOCD_VERSION "\n");
217
218 return cmd_ctx;
219 }
220
221 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
222 /* implementations of OpenOCD that uses multithreading needs to know when
223 * OpenOCD is sleeping. No-op in vanilla OpenOCD
224 */
225 void openocd_sleep_prelude(void)
226 {
227 }
228
229 void openocd_sleep_postlude(void)
230 {
231 }
232 #endif
233
234
235 /* normally this is the main() function entry, but if OpenOCD is linked
236 * into application, then this fn will not be invoked, but rather that
237 * application will have it's own implementation of main(). */
238 int openocd_main(int argc, char *argv[])
239 {
240 int ret;
241
242 /* initialize commandline interface */
243 struct command_context *cmd_ctx;
244
245 cmd_ctx = setup_command_handler(NULL);
246
247 #if BUILD_IOUTIL
248 if (ioutil_init(cmd_ctx) != ERROR_OK)
249 {
250 return EXIT_FAILURE;
251 }
252 #endif
253
254 LOG_OUTPUT("For bug reports, read\n\t"
255 "http://openocd.berlios.de/doc/doxygen/bugs.html"
256 "\n");
257
258
259 command_context_mode(cmd_ctx, COMMAND_CONFIG);
260 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
261
262 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
263 return EXIT_FAILURE;
264
265 ret = parse_config_file(cmd_ctx);
266 if (ret != ERROR_OK)
267 return EXIT_FAILURE;
268
269 #if BUILD_HTTPD
270 if (httpd_start(cmd_ctx) != ERROR_OK)
271 return EXIT_FAILURE;
272 #endif
273
274 ret = server_init(cmd_ctx);
275 if (ERROR_OK != ret)
276 return EXIT_FAILURE;
277
278 if (init_at_startup)
279 {
280 ret = command_run_line(cmd_ctx, "init");
281 if (ERROR_OK != ret)
282 ret = EXIT_FAILURE;
283 }
284
285 /* handle network connections */
286 if (ERROR_OK == ret)
287 server_loop(cmd_ctx);
288
289 server_quit();
290
291 #if BUILD_HTTPD
292 httpd_stop();
293 #endif
294
295 unregister_all_commands(cmd_ctx, NULL);
296
297 /* free commandline interface */
298 command_done(cmd_ctx);
299
300 jtag_interface_quit();
301
302 return ret;
303 }