openocd.c 11.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   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.             *
 ***************************************************************************/

#define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV

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

#include "log.h"
#include "types.h"
#include "jtag.h"
#include "configuration.h"
#include "interpreter.h"
#include "xsvf.h"
#include "target.h"
#include "flash.h"
#include "nand.h"
#include "pld.h"

#include "command.h"
#include "server.h"
#include "telnet_server.h"
#include "gdb_server.h"

#include <sys/time.h>
#include <sys/types.h>
#include <strings.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>

oharboe's avatar
oharboe committed
52
53
54
55
#define JIM_EMBEDDED
#include "jim.h"


56
57
58
59
60
61
62
63
/* Give TELNET a way to find out what version this is */
int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	command_print(cmd_ctx, OPENOCD_VERSION);

	return ERROR_OK;
}

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
static int daemon_startup = 0;

int handle_daemon_startup_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	if (argc==0)
		return ERROR_OK;
	if (argc > 1 )
		return ERROR_COMMAND_SYNTAX_ERROR;
	
	daemon_startup = strcmp("reset", args[0])==0;
	
	command_print(cmd_ctx, OPENOCD_VERSION);

	return ERROR_OK;
}


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

88
89
90
91

/* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
92
	int retval;
93
94
95
96
97
98
99
100
101
102
	static int initialized=0;
	if (initialized)
		return ERROR_OK;
	
	initialized=1;
	
	command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);

	atexit(exit_handler);

103
	
104
105
106
107
	if (target_init(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("target init complete");

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
	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
	 * continue startup regardless
	 */
	if (jtag_init(cmd_ctx) == ERROR_OK)
	{
		LOG_DEBUG("jtag init complete");
		if (target_examine(cmd_ctx) == ERROR_OK)
		{
			LOG_DEBUG("jtag examine complete");
		}
	}

127
	
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
	if (flash_init_drivers(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("flash init complete");

	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();

	return ERROR_OK;
}


151
152
153
154
155
156
157
158
159
160
/* implementations of OpenOCD that uses multithreading needs to lock OpenOCD while calling
 * OpenOCD fn's. No-op in vanilla OpenOCD
 */
void lockBigLock()
{
}
void unlockBigLock()
{
}

oharboe's avatar
oharboe committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181




Jim_Interp *interp;
command_context_t *active_cmd_ctx;

static void tcl_output(void *privData, const char *file, int line, 
		const char *function, const char *string)
{		
	Jim_Obj *tclOutput=(Jim_Obj *)privData;

	Jim_AppendString(interp, tclOutput, string, strlen(string));
}

/* try to execute as Jim command, otherwise fall back to standard command.

	Note that even if the Jim command caused an error, then we succeeded
	to execute it, hence this fn pretty much always returns ERROR_OK. 

 */
182
183
int jim_command(command_context_t *context, char *line)
{
oharboe's avatar
oharboe committed
184
	int retval=ERROR_OK;
oharboe's avatar
oharboe committed
185
186
187
	/* FIX!!!! in reality there is only one cmd_ctx handler, but consider
	what might happen here if there are multiple handlers w/reentrant callback
	fn's... shudder!  */
oharboe's avatar
oharboe committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
	active_cmd_ctx=context;
	int retcode=Jim_Eval(interp, line);
	
	const char *result;
	int reslen;
    result = Jim_GetString(Jim_GetResult(interp), &reslen);
    if (retcode == JIM_ERR) {
	    int len, i;
	
	    LOG_USER_N("Runtime error, file \"%s\", line %d:" JIM_NL,
	            interp->errorFileName, interp->errorLine);
	    LOG_USER_N("    %s" JIM_NL,
	            Jim_GetString(interp->result, NULL));
	    Jim_ListLength(interp, interp->stackTrace, &len);
	    for (i = 0; i < len; i+= 3) {
	        Jim_Obj *objPtr;
	        const char *proc, *file, *line;
	
	        Jim_ListIndex(interp, interp->stackTrace, i, &objPtr, JIM_NONE);
	        proc = Jim_GetString(objPtr, NULL);
	        Jim_ListIndex(interp, interp->stackTrace, i+1, &objPtr,
	                JIM_NONE);
	        file = Jim_GetString(objPtr, NULL);
	        Jim_ListIndex(interp, interp->stackTrace, i+2, &objPtr,
	                JIM_NONE);
	        line = Jim_GetString(objPtr, NULL);
	        LOG_USER_N("In procedure '%s' called at file \"%s\", line %s" JIM_NL,
	                proc, file, line);
	    }
    } else if (retcode == JIM_EXIT) {
    	// ignore.
        //exit(Jim_GetExitCode(interp));
    } else {
        if (reslen) {
        	int i;
        	char buff[256+1];
        	for (i=0; i<reslen; i+=256)
        	{
        		int chunk;
        		chunk=reslen-i;
        		if (chunk>256)
        			chunk=256;
        		strncpy(buff, result, chunk);
        		buff[chunk]=0; 
            	LOG_USER_N("%s", buff);
        	}
        	LOG_USER_N("%s", "\n");
        }
    }
	return retval;
}

static int startLoop=0;

static int
Jim_Command_openocd_ignore(Jim_Interp *interp, 
                                   int argc,
                                   Jim_Obj *const *argv,
                                   int ignore)
{
	int retval;
    char *cmd = (char*)Jim_GetString(argv[1], NULL);

	lockBigLock();
	
    Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
    
    if (startLoop)
    {
    	// We don't know whether or not the telnet/gdb server is running...
    	target_call_timer_callbacks_now();
    }
	
	log_add_callback(tcl_output, tclOutput);
    retval=command_run_line_internal(active_cmd_ctx, cmd);
    
    if (startLoop)
    {
    	target_call_timer_callbacks_now();
    }
	log_remove_callback(tcl_output, tclOutput);
    
	Jim_SetResult(interp, tclOutput);
    unlockBigLock();
        
    return (ignore||(retval==ERROR_OK))?JIM_OK:JIM_ERR;
}

static int
Jim_Command_openocd(Jim_Interp *interp, 
                                   int argc,
                                   Jim_Obj *const *argv)
{
	return Jim_Command_openocd_ignore(interp, argc, argv, 1); 
}

static int
Jim_Command_openocd_throw(Jim_Interp *interp, 
                                   int argc,
                                   Jim_Obj *const *argv)
{
	return Jim_Command_openocd_ignore(interp, argc, argv, 0); 
}
  



/* find full path to file */
static int
Jim_Command_find(Jim_Interp *interp, 
                                   int argc,
                                   Jim_Obj *const *argv)
{
	if (argc!=2)
		return JIM_ERR;
	char *file = (char*)Jim_GetString(argv[1], NULL);
	char *full_path=find_file(file);
	if (full_path==NULL)
		return JIM_ERR;
    Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
    free(full_path);
    
	Jim_SetResult(interp, result);
	return JIM_OK;
}

314
315
316
317
318
319
320
321
322
323
324
static int
Jim_Command_echo(Jim_Interp *interp, 
                                   int argc,
                                   Jim_Obj *const *argv)
{
	if (argc!=2)
		return JIM_ERR;
	char *str = (char*)Jim_GetString(argv[1], NULL);
	LOG_USER("%s", str);
	return JIM_OK;
}
oharboe's avatar
oharboe committed
325
326
327
328
329
330
331
332
333
334
335
336

void initJim(void)
{
    Jim_InitEmbedded();
  
    /* Create an interpreter */
    interp = Jim_CreateInterp();
    /* Add all the Jim core commands */
    Jim_RegisterCoreCommands(interp);
    Jim_CreateCommand(interp, "openocd", Jim_Command_openocd, NULL, NULL);
    Jim_CreateCommand(interp, "openocd_throw", Jim_Command_openocd_throw, NULL, NULL);
    Jim_CreateCommand(interp, "find", Jim_Command_find, NULL, NULL);
337
    Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
338
}
339

340
341
int main(int argc, char *argv[])
{
oharboe's avatar
oharboe committed
342
343
	initJim();
	
344
345
346
347
348
349
	/* initialize commandline interface */
	command_context_t *cmd_ctx, *cfg_cmd_ctx;
	cmd_ctx = command_init();

	register_command(cmd_ctx, NULL, "version", handle_version_command,
					 COMMAND_EXEC, "show OpenOCD version");
350
351
352
	register_command(cmd_ctx, NULL, "daemon_startup", handle_daemon_startup_command, COMMAND_CONFIG, 
			"deprecated - use \"init\" and \"reset\" at end of startup script instead");
	
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
	/* register subsystem commands */
	server_register_commands(cmd_ctx);
	telnet_register_commands(cmd_ctx);
	gdb_register_commands(cmd_ctx);
	log_register_commands(cmd_ctx);
	jtag_register_commands(cmd_ctx);
	interpreter_register_commands(cmd_ctx);
	xsvf_register_commands(cmd_ctx);
	target_register_commands(cmd_ctx);
	flash_register_commands(cmd_ctx);
	nand_register_commands(cmd_ctx);
	pld_register_commands(cmd_ctx);
	
	if (log_init(cmd_ctx) != ERROR_OK)
		return EXIT_FAILURE;
368
	LOG_DEBUG("log init complete");
oharboe's avatar
oharboe committed
369

370
	LOG_OUTPUT( OPENOCD_VERSION "\n" );
371
372
373
374
375
376
377
	
	
	/* 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 */
378
	LOG_OUTPUT( "$URL$\n");
379
380
381
382
383
	/* 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 */
384

385
386
387
	register_command(cmd_ctx, NULL, "init", handle_init_command,
					 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");

388
389
390
391
392
393
394
	cfg_cmd_ctx = copy_command_context(cmd_ctx);
	cfg_cmd_ctx->mode = COMMAND_CONFIG;
	command_set_output_handler(cfg_cmd_ctx, configuration_output_handler, NULL);
	
	if (parse_cmdline_args(cfg_cmd_ctx, argc, argv) != ERROR_OK)
		return EXIT_FAILURE;

oharboe's avatar
oharboe committed
395
396
    Jim_Eval(interp, "source [find tcl/commands.tcl]");

397
398
399
400
401
	if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
		return EXIT_FAILURE;
	
	command_done(cfg_cmd_ctx);

402
	if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
403
		return EXIT_FAILURE;
404
405
406
	
	if (daemon_startup)
		command_run_line(cmd_ctx, "reset");
407

oharboe's avatar
oharboe committed
408
409
410

	startLoop=1;

411
412
413
414
415
416
	/* handle network connections */
	server_loop(cmd_ctx);

	/* shut server down */
	server_quit();

417
418
	unregister_all_commands(cmd_ctx);
	
419
420
421
422
423
	/* free commandline interface */
	command_done(cmd_ctx);

	return EXIT_SUCCESS;
}
424