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