reduce patch problems by moving $xxx expansion into seperate fn
[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
65
66
67
68 void print_version()
69 {
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         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
75         LOG_OUTPUT( "$URL$\n");
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         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
81 }
82
83
84
85
86
87
88
89
90
91 /* Give TELNET a way to find out what version this is */
92 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
93 {
94         command_print(cmd_ctx, OPENOCD_VERSION);
95
96         return ERROR_OK;
97 }
98
99 void exit_handler(void)
100 {
101         /* close JTAG interface */
102         if (jtag && jtag->quit)
103                 jtag->quit();
104 }
105
106 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
107 {
108         switch (event)
109         {
110                 case TARGET_EVENT_HALTED:
111                         target_arch_state(target);
112                         break;
113                 default:
114                         break;
115         }
116
117         return ERROR_OK;
118 }
119
120 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
121 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
122 {
123         int retval;
124         static int initialized=0;
125         if (initialized)
126                 return ERROR_OK;
127         
128         initialized=1;
129         
130         atexit(exit_handler);
131         
132         if (target_init(cmd_ctx) != ERROR_OK)
133                 return ERROR_FAIL;
134         LOG_DEBUG("target init complete");
135
136         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
137         {
138                 /* we must be able to set up the jtag interface */
139                 return retval;
140         }
141         LOG_DEBUG("jtag interface init complete");
142
143         /* Try to initialize & examine the JTAG chain at this point, but
144          * continue startup regardless */
145         if (jtag_init(cmd_ctx) == ERROR_OK)
146         {
147                 LOG_DEBUG("jtag init complete");
148                 if (target_examine() == ERROR_OK)
149                 {
150                         LOG_DEBUG("jtag examine complete");
151                 }
152         }
153         
154         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
155                 return ERROR_FAIL;
156         LOG_DEBUG("flash init complete");
157
158         if (nand_init(cmd_ctx) != ERROR_OK)
159                 return ERROR_FAIL;
160         LOG_DEBUG("NAND init complete");
161
162         if (pld_init(cmd_ctx) != ERROR_OK)
163                 return ERROR_FAIL;
164         LOG_DEBUG("pld init complete");
165
166         /* initialize tcp server */
167         server_init();
168
169         /* initialize telnet subsystem */
170         telnet_init("Open On-Chip Debugger");
171         gdb_init();
172         tcl_init(); /* allows tcl to just connect without going thru telnet */
173
174         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
175         
176         return ERROR_OK;
177 }
178
179 command_context_t *global_cmd_ctx;
180
181 command_context_t *setup_command_handler(void)
182 {
183         command_context_t *cmd_ctx;
184         
185         global_cmd_ctx = cmd_ctx = command_init();
186         
187         register_command(cmd_ctx, NULL, "version", handle_version_command,
188                                          COMMAND_EXEC, "show OpenOCD version");
189         
190         /* register subsystem commands */
191         server_register_commands(cmd_ctx);
192         telnet_register_commands(cmd_ctx);
193         gdb_register_commands(cmd_ctx);
194         tcl_register_commands(cmd_ctx); /* tcl server commands */
195         log_register_commands(cmd_ctx);
196         jtag_register_commands(cmd_ctx);
197         xsvf_register_commands(cmd_ctx);
198         target_register_commands(cmd_ctx);
199         flash_register_commands(cmd_ctx);
200         nand_register_commands(cmd_ctx);
201         pld_register_commands(cmd_ctx);
202         
203         if (log_init(cmd_ctx) != ERROR_OK)
204         {
205                 exit(-1);
206         }
207         LOG_DEBUG("log init complete");
208
209         LOG_OUTPUT( OPENOCD_VERSION "\n" );
210         
211         register_command(cmd_ctx, NULL, "init", handle_init_command,
212                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
213
214         return cmd_ctx;
215 }
216
217 /* normally this is the main() function entry, but if OpenOCD is linked
218  * into application, then this fn will not be invoked, but rather that
219  * application will have it's own implementation of main(). */
220 int openocd_main(int argc, char *argv[])
221 {
222         /* initialize commandline interface */
223         command_context_t *cmd_ctx;
224
225         cmd_ctx = setup_command_handler();
226         
227         LOG_OUTPUT( "\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
228
229         print_version();
230         
231         command_context_mode(cmd_ctx, COMMAND_CONFIG);
232         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
233
234         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
235                 return EXIT_FAILURE;
236         
237         if (parse_config_file(cmd_ctx) != ERROR_OK)
238                 return EXIT_FAILURE;
239
240         command_context_mode(cmd_ctx, COMMAND_EXEC);
241         if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
242                 return EXIT_FAILURE;
243         
244         /* handle network connections */
245         server_loop(cmd_ctx);
246
247         /* shut server down */
248         server_quit();
249
250         unregister_all_commands(cmd_ctx);
251         
252         /* free commandline interface */
253         command_done(cmd_ctx);
254
255         return EXIT_SUCCESS;
256 }