Revive tclapi.c from r1650:
[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 "log.h"
32 #include "types.h"
33 #include "jtag.h"
34 #include "configuration.h"
35 #include "xsvf.h"
36 #include "svf.h"
37 #include "target.h"
38 #include "flash.h"
39 #include "nand.h"
40 #include "pld.h"
41 #include "mflash.h"
42
43 #include "command.h"
44 #include "tclapi.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
60 #define OPENOCD_VERSION \
61 "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") " RELSTR PKGBLDREV
62
63 static void print_version(void)
64 {
65 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
66 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
67 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
68 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
69 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
70 LOG_OUTPUT("$URL$\n");
71 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
72 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
73 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
74 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
75 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
76 }
77
78 /* Give TELNET a way to find out what version this is */
79 static int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
80 {
81 if (argc!=0)
82 return ERROR_COMMAND_SYNTAX_ERROR;
83
84 command_print(cmd_ctx, OPENOCD_VERSION);
85
86 return ERROR_OK;
87 }
88
89 static void exit_handler(void)
90 {
91 /* close JTAG interface */
92 if (jtag && jtag->quit)
93 jtag->quit();
94 }
95
96 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
97 {
98 switch (event)
99 {
100 case TARGET_EVENT_GDB_START:
101 target->display=0;
102 break;
103 case TARGET_EVENT_GDB_END:
104 target->display=1;
105 break;
106 case TARGET_EVENT_HALTED:
107 if (target->display)
108 {
109 /* do not display information when debugger caused the halt */
110 target_arch_state(target);
111 }
112 break;
113 default:
114 break;
115 }
116
117 return ERROR_OK;
118 }
119
120 int ioutil_init(struct command_context_s *cmd_ctx);
121
122 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
123 static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
124 {
125
126 if (argc!=0)
127 return ERROR_COMMAND_SYNTAX_ERROR;
128
129 int retval;
130 static int initialized=0;
131 if (initialized)
132 return ERROR_OK;
133
134 initialized=1;
135
136 atexit(exit_handler);
137
138 if (target_init(cmd_ctx) != ERROR_OK)
139 return ERROR_FAIL;
140 LOG_DEBUG("target init complete");
141
142 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
143 {
144 /* we must be able to set up the jtag interface */
145 return retval;
146 }
147 LOG_DEBUG("jtag interface init complete");
148
149 /* Try to initialize & examine the JTAG chain at this point, but
150 * continue startup regardless */
151 if (jtag_init(cmd_ctx) == ERROR_OK)
152 {
153 LOG_DEBUG("jtag init complete");
154 if (target_examine() == ERROR_OK)
155 {
156 LOG_DEBUG("jtag examine complete");
157 }
158 }
159
160 if (flash_init_drivers(cmd_ctx) != ERROR_OK)
161 return ERROR_FAIL;
162 LOG_DEBUG("flash init complete");
163
164 if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
165 return ERROR_FAIL;
166 LOG_DEBUG("mflash init complete");
167
168 if (nand_init(cmd_ctx) != ERROR_OK)
169 return ERROR_FAIL;
170 LOG_DEBUG("NAND init complete");
171
172 if (pld_init(cmd_ctx) != ERROR_OK)
173 return ERROR_FAIL;
174 LOG_DEBUG("pld init complete");
175
176 /* initialize tcp server */
177 server_init();
178
179 /* initialize telnet subsystem */
180 telnet_init("Open On-Chip Debugger");
181 gdb_init();
182 tcl_init(); /* allows tcl to just connect without going thru telnet */
183
184 target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
185
186 return ERROR_OK;
187 }
188
189 command_context_t *global_cmd_ctx;
190
191 /* NB! this fn can be invoked outside this file for non PC hosted builds */
192 command_context_t *setup_command_handler(void)
193 {
194 command_context_t *cmd_ctx;
195
196 global_cmd_ctx = cmd_ctx = command_init();
197
198 register_command(cmd_ctx, NULL, "version", handle_version_command,
199 COMMAND_EXEC, "show OpenOCD version");
200
201 /* register subsystem commands */
202 server_register_commands(cmd_ctx);
203 telnet_register_commands(cmd_ctx);
204 gdb_register_commands(cmd_ctx);
205 tcl_register_commands(cmd_ctx); /* tcl server commands */
206 tclapi_register_commands(cmd_ctx); /* misc tcl commands */
207 log_register_commands(cmd_ctx);
208 jtag_register_commands(cmd_ctx);
209 xsvf_register_commands(cmd_ctx);
210 svf_register_commands(cmd_ctx);
211 target_register_commands(cmd_ctx);
212 flash_register_commands(cmd_ctx);
213 nand_register_commands(cmd_ctx);
214 pld_register_commands(cmd_ctx);
215 mflash_register_commands(cmd_ctx);
216
217 if (log_init(cmd_ctx) != ERROR_OK)
218 {
219 exit(-1);
220 }
221 LOG_DEBUG("log init complete");
222
223 LOG_OUTPUT( OPENOCD_VERSION "\n" );
224
225 register_command(cmd_ctx, NULL, "init", handle_init_command,
226 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
227
228 return cmd_ctx;
229 }
230
231 int httpd_start(void);
232 void httpd_stop(void);
233
234
235 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
236 /* implementations of OpenOCD that uses multithreading needs to know when
237 * OpenOCD is sleeping. No-op in vanilla OpenOCD
238 */
239 void openocd_sleep_prelude(void)
240 {
241 }
242
243 void openocd_sleep_postlude(void)
244 {
245 }
246 #endif
247
248
249 /* normally this is the main() function entry, but if OpenOCD is linked
250 * into application, then this fn will not be invoked, but rather that
251 * application will have it's own implementation of main(). */
252 int openocd_main(int argc, char *argv[])
253 {
254 int ret;
255
256 /* initialize commandline interface */
257 command_context_t *cmd_ctx;
258
259 cmd_ctx = setup_command_handler();
260
261 #if BUILD_IOUTIL
262 if (ioutil_init(cmd_ctx) != ERROR_OK)
263 {
264 return EXIT_FAILURE;
265 }
266 #endif
267
268 LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
269
270 print_version();
271
272 command_context_mode(cmd_ctx, COMMAND_CONFIG);
273 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
274
275 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
276 return EXIT_FAILURE;
277
278 ret = parse_config_file(cmd_ctx);
279 if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
280 return EXIT_FAILURE;
281
282 #if BUILD_HTTPD
283 if (httpd_start()!=ERROR_OK)
284 return EXIT_FAILURE;
285 #endif
286
287 if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
288 {
289 command_context_mode(cmd_ctx, COMMAND_EXEC);
290 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
291 return EXIT_FAILURE;
292
293 /* handle network connections */
294 server_loop(cmd_ctx);
295 }
296
297 /* shut server down */
298 server_quit();
299
300 #if BUILD_HTTPD
301 httpd_stop();
302 #endif
303
304 unregister_all_commands(cmd_ctx);
305
306 /* free commandline interface */
307 command_done(cmd_ctx);
308
309
310 return EXIT_SUCCESS;
311 }