ccace082f39587a5d7322add926f9a8215cb0587
[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 /* Give TELNET a way to find out what version this is */
64 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
65 {
66         command_print(cmd_ctx, OPENOCD_VERSION);
67
68         return ERROR_OK;
69 }
70
71 void exit_handler(void)
72 {
73         /* close JTAG interface */
74         if (jtag && jtag->quit)
75                 jtag->quit();
76 }
77
78 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
79 {
80         switch (event)
81         {
82                 case TARGET_EVENT_HALTED:
83                         target_arch_state(target);
84                         break;
85                 default:
86                         break;
87         }
88
89         return ERROR_OK;
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() == 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         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
147         
148         return ERROR_OK;
149 }
150
151 command_context_t *global_cmd_ctx;
152
153 command_context_t *setup_command_handler(void)
154 {
155         command_context_t *cmd_ctx;
156         
157         global_cmd_ctx = cmd_ctx = command_init();
158         
159         register_command(cmd_ctx, NULL, "version", handle_version_command,
160                                          COMMAND_EXEC, "show OpenOCD version");
161         
162         /* register subsystem commands */
163         server_register_commands(cmd_ctx);
164         telnet_register_commands(cmd_ctx);
165         gdb_register_commands(cmd_ctx);
166         tcl_register_commands(cmd_ctx); /* tcl server commands */
167         log_register_commands(cmd_ctx);
168         jtag_register_commands(cmd_ctx);
169         xsvf_register_commands(cmd_ctx);
170         target_register_commands(cmd_ctx);
171         flash_register_commands(cmd_ctx);
172         nand_register_commands(cmd_ctx);
173         pld_register_commands(cmd_ctx);
174         
175         if (log_init(cmd_ctx) != ERROR_OK)
176         {
177                 exit(-1);
178         }
179         LOG_DEBUG("log init complete");
180
181         LOG_OUTPUT( OPENOCD_VERSION "\n" );
182         
183         register_command(cmd_ctx, NULL, "init", handle_init_command,
184                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
185
186         return cmd_ctx;
187 }
188
189 /* normally this is the main() function entry, but if OpenOCD is linked
190  * into application, then this fn will not be invoked, but rather that
191  * application will have it's own implementation of main(). */
192 int openocd_main(int argc, char *argv[])
193 {
194         /* initialize commandline interface */
195         command_context_t *cmd_ctx;
196
197         cmd_ctx = setup_command_handler();
198         
199         LOG_OUTPUT( "\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
200
201         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
202         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
203         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
204         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
205         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
206         LOG_OUTPUT( "$URL$\n");
207         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
208         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
209         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
210         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
211         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
212
213         command_context_mode(cmd_ctx, COMMAND_CONFIG);
214         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
215
216         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
217                 return EXIT_FAILURE;
218         
219         if (parse_config_file(cmd_ctx) != ERROR_OK)
220                 return EXIT_FAILURE;
221
222         command_context_mode(cmd_ctx, COMMAND_EXEC);
223         if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
224                 return EXIT_FAILURE;
225         
226         /* handle network connections */
227         server_loop(cmd_ctx);
228
229         /* shut server down */
230         server_quit();
231
232         unregister_all_commands(cmd_ctx);
233         
234         /* free commandline interface */
235         command_done(cmd_ctx);
236
237         return EXIT_SUCCESS;
238 }