openocd.c 8.52 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
6
7
 *   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

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

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
COMMAND_HANDLER(handle_version_command)
71
{
zwelch's avatar
zwelch committed
72
	if (argc != 0)
oharboe's avatar
oharboe committed
73
74
		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
	jtag_interface_quit();
83
84
}

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

	return ERROR_OK;
}

109
110
int ioutil_init(struct command_context_s *cmd_ctx);

111
/* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
112
COMMAND_HANDLER(handle_init_command)
113
{
oharboe's avatar
oharboe committed
114

zwelch's avatar
zwelch committed
115
	if (argc != 0)
oharboe's avatar
oharboe committed
116
117
		return ERROR_COMMAND_SYNTAX_ERROR;

118
	int retval;
zwelch's avatar
zwelch committed
119
	static int initialized = 0;
120
121
	if (initialized)
		return ERROR_OK;
122

zwelch's avatar
zwelch committed
123
	initialized = 1;
124

125
	atexit(exit_handler);
126

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

zwelch's avatar
zwelch committed
131
	if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
132
133
134
135
136
137
138
	{
		/* 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
139
	 * continue startup regardless */
140
141
142
	if (jtag_init(cmd_ctx) == ERROR_OK)
	{
		LOG_DEBUG("jtag init complete");
ntfreak's avatar
ntfreak committed
143
		if (target_examine() == ERROR_OK)
144
145
146
147
		{
			LOG_DEBUG("jtag examine complete");
		}
	}
148

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

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

157
158
159
160
161
162
163
164
165
166
167
168
169
170
	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();
171
	tcl_init(); /* allows tcl to just connect without going thru telnet */
172

173
	target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
174

175
176
177
	return ERROR_OK;
}

178
179
command_context_t *global_cmd_ctx;

180
181
182
/// src/hello.c gives a simple example for writing new command modules
int hello_register_commands(struct command_context_s *cmd_ctx);

oharboe's avatar
oharboe committed
183
184
/* 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
185
186
{
	command_context_t *cmd_ctx;
187

188
	global_cmd_ctx = cmd_ctx = command_init();
189

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

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

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

215
	LOG_OUTPUT(OPENOCD_VERSION "\n");
216

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

oharboe's avatar
oharboe committed
220
221
222
	return cmd_ctx;
}

223
224
225
int httpd_start(void);
void httpd_stop(void);

226

oharboe's avatar
oharboe committed
227
#if !BUILD_HTTPD && !BUILD_ECOSBOARD
228
229
230
231
232
233
234
235
236
237
238
239
240
/* 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


241
242
243
/* 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
244
245
int openocd_main(int argc, char *argv[])
{
246
247
	int ret;

oharboe's avatar
oharboe committed
248
249
	/* initialize commandline interface */
	command_context_t *cmd_ctx;
250
251

	cmd_ctx = setup_command_handler();
252

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

260
	print_version();
261

262
263
264
	LOG_OUTPUT("For bug reports, read\n\t"
		"http://openocd.berlios.de/doc/doxygen/bugs.html"
		"\n");
265
266


267
268
	command_context_mode(cmd_ctx, COMMAND_CONFIG);
	command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
269

270
	if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
271
		return EXIT_FAILURE;
272

273
	ret = parse_config_file(cmd_ctx);
274
	if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION))
275
276
		return EXIT_FAILURE;

277
#if BUILD_HTTPD
zwelch's avatar
zwelch committed
278
	if (httpd_start() != ERROR_OK)
279
280
281
		return EXIT_FAILURE;
#endif

282
	if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
283
284
	{
		command_context_mode(cmd_ctx, COMMAND_EXEC);
zwelch's avatar
zwelch committed
285
		if (command_run_line(cmd_ctx, "init") != ERROR_OK)
286
			return EXIT_FAILURE;
287

288
289
290
		/* handle network connections */
		server_loop(cmd_ctx);
	}
291
292
293
294

	/* shut server down */
	server_quit();

295
296
297
298
#if BUILD_HTTPD
	httpd_stop();
#endif

299
	unregister_all_commands(cmd_ctx);
300

301
302
303
	/* free commandline interface */
	command_done(cmd_ctx);

304

305
306
	return EXIT_SUCCESS;
}