moved ioutil init to the right spot: before config scripts
[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 #define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #include "log.h"
34 #include "types.h"
35 #include "jtag.h"
36 #include "configuration.h"
37 #include "xsvf.h"
38 #include "target.h"
39 #include "flash.h"
40 #include "nand.h"
41 #include "pld.h"
42 #include "mflash.h"
43
44 #include "command.h"
45 #include "server.h"
46 #include "telnet_server.h"
47 #include "gdb_server.h"
48 #include "tcl_server.h"
49
50 #include <sys/time.h>
51 #include <sys/types.h>
52 #include <strings.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <unistd.h>
57 #include <errno.h>
58
59 #ifdef _WIN32
60 #include <malloc.h>
61 #else
62 #include <alloca.h>
63 #endif
64
65 #include "replacements.h"
66
67 void print_version(void)
68 {
69         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
70         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
71         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
72         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
73         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
74         LOG_OUTPUT("$URL$\n");
75         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
76         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
77         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
78         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
79         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
80 }
81
82 /* Give TELNET a way to find out what version this is */
83 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
84 {
85         if (argc!=0)
86                 return ERROR_COMMAND_SYNTAX_ERROR;
87
88         command_print(cmd_ctx, OPENOCD_VERSION);
89
90         return ERROR_OK;
91 }
92
93 void exit_handler(void)
94 {
95         /* close JTAG interface */
96         if (jtag && jtag->quit)
97                 jtag->quit();
98 }
99
100 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
101 {
102         switch (event)
103         {
104                 case TARGET_EVENT_GDB_START:
105                         target->display=0;
106                         break;
107                 case TARGET_EVENT_GDB_END:
108                         target->display=1;
109                         break;
110                 case TARGET_EVENT_HALTED:
111                         if (target->display)
112                         {
113                                 /* do not display information when debugger caused the halt */
114                                 target_arch_state(target);
115                         }
116                         break;
117                 default:
118                         break;
119         }
120
121         return ERROR_OK;
122 }
123
124 int ioutil_init(struct command_context_s *cmd_ctx);
125
126 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
127 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
128 {
129
130         if (argc!=0)
131                 return ERROR_COMMAND_SYNTAX_ERROR;
132
133         int retval;
134         static int initialized=0;
135         if (initialized)
136                 return ERROR_OK;
137
138         initialized=1;
139
140         atexit(exit_handler);
141
142         if (target_init(cmd_ctx) != ERROR_OK)
143                 return ERROR_FAIL;
144         LOG_DEBUG("target init complete");
145
146         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
147         {
148                 /* we must be able to set up the jtag interface */
149                 return retval;
150         }
151         LOG_DEBUG("jtag interface init complete");
152
153         /* Try to initialize & examine the JTAG chain at this point, but
154          * continue startup regardless */
155         if (jtag_init(cmd_ctx) == ERROR_OK)
156         {
157                 LOG_DEBUG("jtag init complete");
158                 if (target_examine() == ERROR_OK)
159                 {
160                         LOG_DEBUG("jtag examine complete");
161                 }
162         }
163
164         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
165                 return ERROR_FAIL;
166         LOG_DEBUG("flash init complete");
167
168         if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
169                 return ERROR_FAIL;
170         LOG_DEBUG("mflash init complete");
171
172         if (nand_init(cmd_ctx) != ERROR_OK)
173                 return ERROR_FAIL;
174         LOG_DEBUG("NAND init complete");
175
176         if (pld_init(cmd_ctx) != ERROR_OK)
177                 return ERROR_FAIL;
178         LOG_DEBUG("pld init complete");
179
180         /* initialize tcp server */
181         server_init();
182
183         /* initialize telnet subsystem */
184         telnet_init("Open On-Chip Debugger");
185         gdb_init();
186         tcl_init(); /* allows tcl to just connect without going thru telnet */
187
188         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
189
190         return ERROR_OK;
191 }
192
193 command_context_t *global_cmd_ctx;
194
195 command_context_t *setup_command_handler(void)
196 {
197         command_context_t *cmd_ctx;
198
199         global_cmd_ctx = cmd_ctx = command_init();
200
201         register_command(cmd_ctx, NULL, "version", handle_version_command,
202                                          COMMAND_EXEC, "show OpenOCD version");
203
204         /* register subsystem commands */
205         server_register_commands(cmd_ctx);
206         telnet_register_commands(cmd_ctx);
207         gdb_register_commands(cmd_ctx);
208         tcl_register_commands(cmd_ctx); /* tcl server commands */
209         log_register_commands(cmd_ctx);
210         jtag_register_commands(cmd_ctx);
211         xsvf_register_commands(cmd_ctx);
212         target_register_commands(cmd_ctx);
213         flash_register_commands(cmd_ctx);
214         nand_register_commands(cmd_ctx);
215         pld_register_commands(cmd_ctx);
216         mflash_register_commands(cmd_ctx);
217
218         if (log_init(cmd_ctx) != ERROR_OK)
219         {
220                 exit(-1);
221         }
222         LOG_DEBUG("log init complete");
223
224         LOG_OUTPUT( OPENOCD_VERSION "\n" );
225
226         register_command(cmd_ctx, NULL, "init", handle_init_command,
227                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
228
229         return cmd_ctx;
230 }
231
232 int httpd_start(void);
233 void httpd_stop(void);
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         command_context_t *cmd_ctx;
244
245         cmd_ctx = setup_command_handler();
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("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
255
256         print_version();
257
258         command_context_mode(cmd_ctx, COMMAND_CONFIG);
259         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
260
261         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
262                 return EXIT_FAILURE;
263
264         ret = parse_config_file(cmd_ctx);
265         if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
266                 return EXIT_FAILURE;
267
268 #if BUILD_HTTPD
269         if (httpd_start()!=ERROR_OK)
270                 return EXIT_FAILURE;
271 #endif
272
273         if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
274         {
275                 command_context_mode(cmd_ctx, COMMAND_EXEC);
276                 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
277                         return EXIT_FAILURE;
278
279                 /* handle network connections */
280                 server_loop(cmd_ctx);
281         }
282
283         /* shut server down */
284         server_quit();
285
286 #if BUILD_HTTPD
287         httpd_stop();
288 #endif
289
290         unregister_all_commands(cmd_ctx);
291
292         /* free commandline interface */
293         command_done(cmd_ctx);
294
295
296         return EXIT_SUCCESS;
297 }