put instructions on how to report bugs onto the users radar
[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  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program; if not, write to the                         *
20  *   Free Software Foundation, Inc.,                                       *
21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
22  ***************************************************************************/
23
24 #define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV
25
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "log.h"
31 #include "types.h"
32 #include "jtag.h"
33 #include "configuration.h"
34 #include "xsvf.h"
35 #include "target.h"
36 #include "flash.h"
37 #include "nand.h"
38 #include "pld.h"
39
40 #include "command.h"
41 #include "server.h"
42 #include "telnet_server.h"
43 #include "gdb_server.h"
44 #include "tcl_server.h"
45
46 #include <sys/time.h>
47 #include <sys/types.h>
48 #include <strings.h>
49 #include <stdio.h>
50 #include <stdlib.h>
51 #include <string.h>
52 #include <unistd.h>
53 #include <errno.h>
54
55 #ifdef _WIN32
56 #include <malloc.h>
57 #else
58 #include <alloca.h>
59 #endif
60
61 #include "replacements.h"
62
63
64 /* Give TELNET a way to find out what version this is */
65 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
66 {
67         command_print(cmd_ctx, OPENOCD_VERSION);
68
69         return ERROR_OK;
70 }
71
72
73 void exit_handler(void)
74 {
75         /* close JTAG interface */
76         if (jtag && jtag->quit)
77                 jtag->quit();
78 }
79
80 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
81 {
82         switch (event)
83         {
84                 case TARGET_EVENT_HALTED:
85                         target_arch_state(target);
86                         break;
87                 default:
88                         break;
89         }
90
91         return ERROR_OK;
92 }
93
94
95
96 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
97 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
98 {
99         int retval;
100         static int initialized=0;
101         if (initialized)
102                 return ERROR_OK;
103         
104         initialized=1;
105         
106         atexit(exit_handler);
107         
108         if (target_init(cmd_ctx) != ERROR_OK)
109                 return ERROR_FAIL;
110         LOG_DEBUG("target init complete");
111
112         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
113         {
114                 /* we must be able to set up the jtag interface */
115                 return retval;
116         }
117         LOG_DEBUG("jtag interface init complete");
118
119         /* Try to initialize & examine the JTAG chain at this point, but
120          * continue startup regardless */
121         if (jtag_init(cmd_ctx) == ERROR_OK)
122         {
123                 LOG_DEBUG("jtag init complete");
124                 if (target_examine() == ERROR_OK)
125                 {
126                         LOG_DEBUG("jtag examine complete");
127                 }
128         }
129         
130         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
131                 return ERROR_FAIL;
132         LOG_DEBUG("flash init complete");
133
134         if (nand_init(cmd_ctx) != ERROR_OK)
135                 return ERROR_FAIL;
136         LOG_DEBUG("NAND init complete");
137
138         if (pld_init(cmd_ctx) != ERROR_OK)
139                 return ERROR_FAIL;
140         LOG_DEBUG("pld init complete");
141
142         /* initialize tcp server */
143         server_init();
144
145         /* initialize telnet subsystem */
146         telnet_init("Open On-Chip Debugger");
147         gdb_init();
148         tcl_init(); /* allows tcl to just connect without going thru telnet */
149
150         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
151
152         
153         
154         return ERROR_OK;
155 }
156
157 command_context_t *global_cmd_ctx;
158
159 command_context_t *setup_command_handler(void)
160 {
161         command_context_t *cmd_ctx;
162         
163         global_cmd_ctx = cmd_ctx = command_init();
164         
165         register_command(cmd_ctx, NULL, "version", handle_version_command,
166                                          COMMAND_EXEC, "show OpenOCD version");
167         
168         /* register subsystem commands */
169         server_register_commands(cmd_ctx);
170         telnet_register_commands(cmd_ctx);
171         gdb_register_commands(cmd_ctx);
172         tcl_register_commands(cmd_ctx); /* tcl server commands */
173         log_register_commands(cmd_ctx);
174         jtag_register_commands(cmd_ctx);
175         xsvf_register_commands(cmd_ctx);
176         target_register_commands(cmd_ctx);
177         flash_register_commands(cmd_ctx);
178         nand_register_commands(cmd_ctx);
179         pld_register_commands(cmd_ctx);
180         
181         if (log_init(cmd_ctx) != ERROR_OK)
182         {
183                 exit(-1);
184         }
185         LOG_DEBUG("log init complete");
186
187         LOG_OUTPUT( OPENOCD_VERSION "\n" );
188         
189         register_command(cmd_ctx, NULL, "init", handle_init_command,
190                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
191
192         return cmd_ctx;
193 }
194
195 /* normally this is the main() function entry, but if OpenOCD is linked
196  * into application, then this fn will not be invoked, but rather that
197  * application will have it's own implementation of main(). */
198 int openocd_main(int argc, char *argv[])
199 {
200         /* initialize commandline interface */
201         command_context_t *cmd_ctx;
202
203         cmd_ctx = setup_command_handler();
204         
205         LOG_OUTPUT( "\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
206
207         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
208         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
209         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
210         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
211         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
212         LOG_OUTPUT( "$URL$\n");
213         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
214         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
215         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
216         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
217         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
218
219         command_context_mode(cmd_ctx, COMMAND_CONFIG);
220         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
221
222         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
223                 return EXIT_FAILURE;
224         
225         if (parse_config_file(cmd_ctx) != ERROR_OK)
226                 return EXIT_FAILURE;
227
228         command_context_mode(cmd_ctx, COMMAND_EXEC);
229         if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
230                 return EXIT_FAILURE;
231         
232         /* handle network connections */
233         server_loop(cmd_ctx);
234
235         /* shut server down */
236         server_quit();
237
238         unregister_all_commands(cmd_ctx);
239         
240         /* free commandline interface */
241         command_done(cmd_ctx);
242
243         return EXIT_SUCCESS;
244 }