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