openocd.c 8.5 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
6
7
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008 Richard Missenden                                  *
 *   richard.missenden@googlemail.com                                      *
 *                                                                         *
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "jtag.h"
#include "configuration.h"
#include "xsvf.h"
34
#include "svf.h"
35
36
37
38
#include "target.h"
#include "flash.h"
#include "nand.h"
#include "pld.h"
39
#include "mflash.h"
40
41
42
43

#include "server.h"
#include "telnet_server.h"
#include "gdb_server.h"
oharboe's avatar
oharboe committed
44
#include "tcl_server.h"
45

46
#ifdef HAVE_STRINGS_H
47
#include <strings.h>
48
#endif
49

50
51
52
53

#define OPENOCD_VERSION \
		"Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") " RELSTR PKGBLDREV

54
static void print_version(void)
55
56
57
58
59
60
{
	/* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
61
	LOG_OUTPUT("$URL$\n");
62
63
64
65
66
67
68
	/* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
	/* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
}

69
/* Give TELNET a way to find out what version this is */
70
static int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
71
{
oharboe's avatar
oharboe committed
72
73
74
	if (argc!=0)
		return ERROR_COMMAND_SYNTAX_ERROR;

75
76
77
78
79
	command_print(cmd_ctx, OPENOCD_VERSION);

	return ERROR_OK;
}

80
static void exit_handler(void)
81
82
83
84
85
86
{
	/* close JTAG interface */
	if (jtag && jtag->quit)
		jtag->quit();
}

87
88
89
90
static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
{
	switch (event)
	{
91
92
93
94
95
96
		case TARGET_EVENT_GDB_START:
			target->display=0;
			break;
		case TARGET_EVENT_GDB_END:
			target->display=1;
			break;
97
		case TARGET_EVENT_HALTED:
98
99
100
101
102
			if (target->display)
			{
				/* do not display information when debugger caused the halt */
				target_arch_state(target);
			}
103
104
105
106
107
108
109
110
			break;
		default:
			break;
	}

	return ERROR_OK;
}

111
112
int ioutil_init(struct command_context_s *cmd_ctx);

113
/* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
114
static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
115
{
oharboe's avatar
oharboe committed
116
117
118
119

	if (argc!=0)
		return ERROR_COMMAND_SYNTAX_ERROR;

120
	int retval;
121
122
123
	static int initialized=0;
	if (initialized)
		return ERROR_OK;
124

125
	initialized=1;
126

127
	atexit(exit_handler);
128

129
130
131
132
	if (target_init(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("target init complete");

133
134
135
136
137
138
139
140
	if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
	{
		/* we must be able to set up the jtag interface */
		return retval;
	}
	LOG_DEBUG("jtag interface init complete");

	/* Try to initialize & examine the JTAG chain at this point, but
141
	 * continue startup regardless */
142
143
144
	if (jtag_init(cmd_ctx) == ERROR_OK)
	{
		LOG_DEBUG("jtag init complete");
ntfreak's avatar
ntfreak committed
145
		if (target_examine() == ERROR_OK)
146
147
148
149
		{
			LOG_DEBUG("jtag examine complete");
		}
	}
150

151
152
153
154
	if (flash_init_drivers(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("flash init complete");

155
156
157
158
	if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("mflash init complete");

159
160
161
162
163
164
165
166
167
168
169
170
171
172
	if (nand_init(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("NAND init complete");

	if (pld_init(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("pld init complete");

	/* initialize tcp server */
	server_init();

	/* initialize telnet subsystem */
	telnet_init("Open On-Chip Debugger");
	gdb_init();
173
	tcl_init(); /* allows tcl to just connect without going thru telnet */
174

175
	target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
176

177
178
179
	return ERROR_OK;
}

180
181
command_context_t *global_cmd_ctx;

oharboe's avatar
oharboe committed
182
183
/* NB! this fn can be invoked outside this file for non PC hosted builds */
command_context_t *setup_command_handler(void)
oharboe's avatar
oharboe committed
184
185
{
	command_context_t *cmd_ctx;
186

187
	global_cmd_ctx = cmd_ctx = command_init();
188

189
190
	register_command(cmd_ctx, NULL, "version", handle_version_command,
					 COMMAND_EXEC, "show OpenOCD version");
191

192
193
194
195
	/* register subsystem commands */
	server_register_commands(cmd_ctx);
	telnet_register_commands(cmd_ctx);
	gdb_register_commands(cmd_ctx);
196
	tcl_register_commands(cmd_ctx); /* tcl server commands */
197
198
199
	log_register_commands(cmd_ctx);
	jtag_register_commands(cmd_ctx);
	xsvf_register_commands(cmd_ctx);
200
	svf_register_commands(cmd_ctx);
201
202
203
204
	target_register_commands(cmd_ctx);
	flash_register_commands(cmd_ctx);
	nand_register_commands(cmd_ctx);
	pld_register_commands(cmd_ctx);
205
206
	mflash_register_commands(cmd_ctx);

207
	if (log_init(cmd_ctx) != ERROR_OK)
oharboe's avatar
oharboe committed
208
209
210
	{
		exit(-1);
	}
211
	LOG_DEBUG("log init complete");
oharboe's avatar
oharboe committed
212

213
	LOG_OUTPUT( OPENOCD_VERSION "\n" );
214

215
216
217
	register_command(cmd_ctx, NULL, "init", handle_init_command,
					 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");

oharboe's avatar
oharboe committed
218
219
220
	return cmd_ctx;
}

221
222
223
int httpd_start(void);
void httpd_stop(void);

224

oharboe's avatar
oharboe committed
225
#if !BUILD_HTTPD && !BUILD_ECOSBOARD
226
227
228
229
230
231
232
233
234
235
236
237
238
/* implementations of OpenOCD that uses multithreading needs to know when
 * OpenOCD is sleeping. No-op in vanilla OpenOCD
 */
void openocd_sleep_prelude(void)
{
}

void openocd_sleep_postlude(void)
{
}
#endif


239
240
241
/* normally this is the main() function entry, but if OpenOCD is linked
 * into application, then this fn will not be invoked, but rather that
 * application will have it's own implementation of main(). */
oharboe's avatar
oharboe committed
242
243
int openocd_main(int argc, char *argv[])
{
244
245
	int ret;

oharboe's avatar
oharboe committed
246
247
	/* initialize commandline interface */
	command_context_t *cmd_ctx;
248
249

	cmd_ctx = setup_command_handler();
250

251
252
253
254
255
256
257
#if BUILD_IOUTIL
	if (ioutil_init(cmd_ctx) != ERROR_OK)
	{
		return EXIT_FAILURE;
	}
#endif

258
	LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
259

260
	print_version();
261

262
263
	command_context_mode(cmd_ctx, COMMAND_CONFIG);
	command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
264

265
	if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
266
		return EXIT_FAILURE;
267

268
269
	ret = parse_config_file(cmd_ctx);
	if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
270
271
		return EXIT_FAILURE;

272
273
274
275
276
#if BUILD_HTTPD
	if (httpd_start()!=ERROR_OK)
		return EXIT_FAILURE;
#endif

277
	if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
278
279
280
281
	{
		command_context_mode(cmd_ctx, COMMAND_EXEC);
		if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
			return EXIT_FAILURE;
282

283
284
285
		/* handle network connections */
		server_loop(cmd_ctx);
	}
286
287
288
289

	/* shut server down */
	server_quit();

290
291
292
293
#if BUILD_HTTPD
	httpd_stop();
#endif

294
	unregister_all_commands(cmd_ctx);
295

296
297
298
	/* free commandline interface */
	command_done(cmd_ctx);

299

300
301
	return EXIT_SUCCESS;
}