- fix tcl_port typo in docs
[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
43 #include "command.h"
44 #include "server.h"
45 #include "telnet_server.h"
46 #include "gdb_server.h"
47 #include "tcl_server.h"
48
49 #include <sys/time.h>
50 #include <sys/types.h>
51 #include <strings.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55 #include <unistd.h>
56 #include <errno.h>
57
58 #ifdef _WIN32
59 #include <malloc.h>
60 #else
61 #include <alloca.h>
62 #endif
63
64 #include "replacements.h"
65
66 void print_version(void)
67 {
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         /* 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         LOG_OUTPUT("$URL$\n");
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         /* 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 }
80
81 /* Give TELNET a way to find out what version this is */
82 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
83 {
84         command_print(cmd_ctx, OPENOCD_VERSION);
85
86         return ERROR_OK;
87 }
88
89 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_HALTED:
101                         target_arch_state(target);
102                         break;
103                 default:
104                         break;
105         }
106
107         return ERROR_OK;
108 }
109
110 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
111 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
112 {
113         int retval;
114         static int initialized=0;
115         if (initialized)
116                 return ERROR_OK;
117         
118         initialized=1;
119         
120         atexit(exit_handler);
121         
122         if (target_init(cmd_ctx) != ERROR_OK)
123                 return ERROR_FAIL;
124         LOG_DEBUG("target init complete");
125
126         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
127         {
128                 /* we must be able to set up the jtag interface */
129                 return retval;
130         }
131         LOG_DEBUG("jtag interface init complete");
132
133         /* Try to initialize & examine the JTAG chain at this point, but
134          * continue startup regardless */
135         if (jtag_init(cmd_ctx) == ERROR_OK)
136         {
137                 LOG_DEBUG("jtag init complete");
138                 if (target_examine() == ERROR_OK)
139                 {
140                         LOG_DEBUG("jtag examine complete");
141                 }
142         }
143         
144         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
145                 return ERROR_FAIL;
146         LOG_DEBUG("flash init complete");
147
148         if (nand_init(cmd_ctx) != ERROR_OK)
149                 return ERROR_FAIL;
150         LOG_DEBUG("NAND init complete");
151
152         if (pld_init(cmd_ctx) != ERROR_OK)
153                 return ERROR_FAIL;
154         LOG_DEBUG("pld init complete");
155
156         /* initialize tcp server */
157         server_init();
158
159         /* initialize telnet subsystem */
160         telnet_init("Open On-Chip Debugger");
161         gdb_init();
162         tcl_init(); /* allows tcl to just connect without going thru telnet */
163
164         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
165         
166         return ERROR_OK;
167 }
168
169 command_context_t *global_cmd_ctx;
170
171 command_context_t *setup_command_handler(void)
172 {
173         command_context_t *cmd_ctx;
174         
175         global_cmd_ctx = cmd_ctx = command_init();
176         
177         register_command(cmd_ctx, NULL, "version", handle_version_command,
178                                          COMMAND_EXEC, "show OpenOCD version");
179         
180         /* register subsystem commands */
181         server_register_commands(cmd_ctx);
182         telnet_register_commands(cmd_ctx);
183         gdb_register_commands(cmd_ctx);
184         tcl_register_commands(cmd_ctx); /* tcl server commands */
185         log_register_commands(cmd_ctx);
186         jtag_register_commands(cmd_ctx);
187         xsvf_register_commands(cmd_ctx);
188         target_register_commands(cmd_ctx);
189         flash_register_commands(cmd_ctx);
190         nand_register_commands(cmd_ctx);
191         pld_register_commands(cmd_ctx);
192         
193         if (log_init(cmd_ctx) != ERROR_OK)
194         {
195                 exit(-1);
196         }
197         LOG_DEBUG("log init complete");
198
199         LOG_OUTPUT( OPENOCD_VERSION "\n" );
200         
201         register_command(cmd_ctx, NULL, "init", handle_init_command,
202                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
203
204         return cmd_ctx;
205 }
206
207 /* normally this is the main() function entry, but if OpenOCD is linked
208  * into application, then this fn will not be invoked, but rather that
209  * application will have it's own implementation of main(). */
210 int openocd_main(int argc, char *argv[])
211 {
212         int ret;
213
214         /* initialize commandline interface */
215         command_context_t *cmd_ctx;
216
217         cmd_ctx = setup_command_handler();
218         
219         LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
220
221         print_version();
222         
223         command_context_mode(cmd_ctx, COMMAND_CONFIG);
224         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
225
226         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
227                 return EXIT_FAILURE;
228         
229         ret = parse_config_file(cmd_ctx);
230         if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
231                 return EXIT_FAILURE;
232
233         if (ret != ERROR_COMMAND_CLOSE_CONNECTION) 
234         {
235                 command_context_mode(cmd_ctx, COMMAND_EXEC);
236                 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
237                         return EXIT_FAILURE;
238         
239                 /* handle network connections */
240                 server_loop(cmd_ctx);
241         }
242
243         /* shut server down */
244         server_quit();
245
246         unregister_all_commands(cmd_ctx);
247         
248         /* free commandline interface */
249         command_done(cmd_ctx);
250
251         return EXIT_SUCCESS;
252 }