aaa45314e8922ef12c75d03c1ef02e80eebb80a9
[fw/openocd] / 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         command_context_mode(CMD_CTX, COMMAND_CONFIG);
139         if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
140                 return ERROR_FAIL;
141
142         if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
143                 return ERROR_FAIL;
144
145         if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
146                 return ERROR_FAIL;
147
148         if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
149                 return ERROR_FAIL;
150         command_context_mode(CMD_CTX, COMMAND_EXEC);
151
152         /* initialize telnet subsystem */
153         gdb_target_add_all(all_targets);
154
155         target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
156
157         return ERROR_OK;
158 }
159
160 static const struct command_registration openocd_command_handlers[] = {
161         {
162                 .name = "version",
163                 .handler = &handle_version_command,
164                 .mode = COMMAND_ANY,
165                 .help = "show program version",
166         },
167         {
168                 .name = "noinit",
169                 .handler = &handle_noinit_command,
170                 .mode = COMMAND_CONFIG,
171                 .help = "Prevent 'init' from being called at startup.",
172         },
173         {
174                 .name = "init",
175                 .handler = &handle_init_command,
176                 .mode = COMMAND_CONFIG,
177                 .help = "Initializes configured targets and servers.  "
178                         "Changes command mode from CONFIG to EXEC.  "
179                         "Unless 'noinit' is called, this command is "
180                         "called automatically at the end of startup.",
181
182         },
183         COMMAND_REGISTRATION_DONE
184 };
185
186 struct command_context *global_cmd_ctx;
187
188 /* NB! this fn can be invoked outside this file for non PC hosted builds */
189 struct command_context *setup_command_handler(Jim_Interp *interp)
190 {
191         log_init();
192         LOG_DEBUG("log_init: complete");
193
194         struct command_context *cmd_ctx;
195
196         global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl, interp);
197
198         register_commands(cmd_ctx, NULL, openocd_command_handlers);
199         /* register subsystem commands */
200         server_register_commands(cmd_ctx);
201         gdb_register_commands(cmd_ctx);
202         log_register_commands(cmd_ctx);
203         jtag_register_commands(cmd_ctx);
204         xsvf_register_commands(cmd_ctx);
205         svf_register_commands(cmd_ctx);
206         target_register_commands(cmd_ctx);
207         flash_register_commands(cmd_ctx);
208         nand_register_commands(cmd_ctx);
209         pld_register_commands(cmd_ctx);
210         mflash_register_commands(cmd_ctx);
211
212         LOG_DEBUG("command registration: complete");
213
214         LOG_OUTPUT(OPENOCD_VERSION "\n");
215
216         return cmd_ctx;
217 }
218
219 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
220 /* implementations of OpenOCD that uses multithreading needs to know when
221  * OpenOCD is sleeping. No-op in vanilla OpenOCD
222  */
223 void openocd_sleep_prelude(void)
224 {
225 }
226
227 void openocd_sleep_postlude(void)
228 {
229 }
230 #endif
231
232
233 /* normally this is the main() function entry, but if OpenOCD is linked
234  * into application, then this fn will not be invoked, but rather that
235  * application will have it's own implementation of main(). */
236 int openocd_main(int argc, char *argv[])
237 {
238         int ret;
239
240         /* initialize commandline interface */
241         struct command_context *cmd_ctx;
242
243         cmd_ctx = setup_command_handler(NULL);
244
245 #if BUILD_IOUTIL
246         if (ioutil_init(cmd_ctx) != ERROR_OK)
247         {
248                 return EXIT_FAILURE;
249         }
250 #endif
251
252         LOG_OUTPUT("For bug reports, read\n\t"
253                 "http://openocd.berlios.de/doc/doxygen/bugs.html"
254                 "\n");
255
256
257         command_context_mode(cmd_ctx, COMMAND_CONFIG);
258         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
259
260         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
261                 return EXIT_FAILURE;
262
263         ret = parse_config_file(cmd_ctx);
264         if (ret != ERROR_OK)
265                 return EXIT_FAILURE;
266
267 #if BUILD_HTTPD
268         if (httpd_start(cmd_ctx) != ERROR_OK)
269                 return EXIT_FAILURE;
270 #endif
271
272         ret = server_init(cmd_ctx);
273         if (ERROR_OK != ret)
274                 return EXIT_FAILURE;
275
276         if (init_at_startup)
277         {
278                 ret = command_run_line(cmd_ctx, "init");
279                 if (ERROR_OK != ret)
280                         ret = EXIT_FAILURE;
281         }
282
283         /* handle network connections */
284         if (ERROR_OK == ret)
285                 server_loop(cmd_ctx);
286
287         server_quit();
288
289 #if BUILD_HTTPD
290         httpd_stop();
291 #endif
292
293         unregister_all_commands(cmd_ctx, NULL);
294
295         /* free commandline interface */
296         command_done(cmd_ctx);
297
298         jtag_interface_quit();
299
300         return ret;
301 }