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