openocd.c 22.6 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
/***************************************************************************
 *   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 "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"
oharboe's avatar
oharboe committed
41
#include "tcl_server.h"
42
43
44
45
46
47
48
49
50
51

#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>

ntfreak's avatar
ntfreak committed
52
53
54
55
56
57
#ifdef _WIN32
#include <malloc.h>
#else
#include <alloca.h>
#endif

oharboe's avatar
oharboe committed
58
59
60
61
#ifdef __ECOS
/* Jim is provied by eCos */
#include <cyg/jimtcl/jim.h>
#else
oharboe's avatar
oharboe committed
62
63
#define JIM_EMBEDDED
#include "jim.h"
oharboe's avatar
oharboe committed
64
65
#endif

ntfreak's avatar
ntfreak committed
66
#include "replacements.h"
oharboe's avatar
oharboe committed
67

oharboe's avatar
oharboe committed
68

69
70
71
72
73
74
75
76
/* 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;
}

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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;
}

93
94
95
96
97
98
99
void exit_handler(void)
{
	/* close JTAG interface */
	if (jtag && jtag->quit)
		jtag->quit();
}

100
101
102
/* 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)
{
103
	int retval;
104
105
106
107
108
109
110
111
112
	static int initialized=0;
	if (initialized)
		return ERROR_OK;
	
	initialized=1;
	
	command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);

	atexit(exit_handler);
113
	
114
115
116
117
	if (target_init(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("target init complete");

118
119
120
121
122
123
124
125
	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
126
	 * continue startup regardless */
127
128
129
130
131
132
133
134
	if (jtag_init(cmd_ctx) == ERROR_OK)
	{
		LOG_DEBUG("jtag init complete");
		if (target_examine(cmd_ctx) == ERROR_OK)
		{
			LOG_DEBUG("jtag examine complete");
		}
	}
135
	
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
	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();
154
	tcl_init(); /* allows tcl to just connect without going thru telnet */
155
156
157
158

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
159
160
161
Jim_Interp *interp;
command_context_t *active_cmd_ctx;

ntfreak's avatar
ntfreak committed
162
static int new_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 val)
oharboe's avatar
oharboe committed
163
164
165
166
167
{
	char *namebuf;
	Jim_Obj *nameObjPtr, *valObjPtr;
	int result;

168
	namebuf = alloc_printf("%s(%d)", varname, idx);
oharboe's avatar
oharboe committed
169
170
	if (!namebuf)
		return JIM_ERR;
171
172
173
	
	nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
	valObjPtr = Jim_NewIntObj(interp, val);
oharboe's avatar
oharboe committed
174
175
176
177
178
179
	if (!nameObjPtr || !valObjPtr)
	{
		free(namebuf);
		return JIM_ERR;
	}

180
181
182
183
184
185
	Jim_IncrRefCount(nameObjPtr);
	Jim_IncrRefCount(valObjPtr);
	result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
	Jim_DecrRefCount(interp, nameObjPtr);
	Jim_DecrRefCount(interp, valObjPtr);
	free(namebuf);
oharboe's avatar
oharboe committed
186
	/* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
187
	return result;
oharboe's avatar
oharboe committed
188
189
}

ntfreak's avatar
ntfreak committed
190
static int Jim_Command_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
oharboe's avatar
oharboe committed
191
192
193
194
195
196
197
198
199
200
{
	target_t *target;
	long l;
	u32 width;
	u32 len;
	u32 addr;
	u32 count;
	u32 v;
	const char *varname;
	u8 buffer[4096];
201
	int  i, n, e, retval;
oharboe's avatar
oharboe committed
202
203
204
205

	/* argv[1] = name of array to receive the data
	 * argv[2] = desired width
	 * argv[3] = memory address 
oharboe's avatar
oharboe committed
206
	 * argv[4] = count of times to read
oharboe's avatar
oharboe committed
207
	 */
208
209
	if (argc != 5) {
		Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
oharboe's avatar
oharboe committed
210
211
		return JIM_ERR;
	}
212
	varname = Jim_GetString(argv[1], &len);
oharboe's avatar
oharboe committed
213
214
	/* given "foo" get space for worse case "foo(%d)" .. add 20 */

215
	e = Jim_GetLong(interp, argv[2], &l);
oharboe's avatar
oharboe committed
216
	width = l;
217
	if (e != JIM_OK) {
oharboe's avatar
oharboe committed
218
219
220
		return e;
	}
	
221
	e = Jim_GetLong(interp, argv[3], &l);
oharboe's avatar
oharboe committed
222
	addr = l;
223
	if (e != JIM_OK) {
oharboe's avatar
oharboe committed
224
225
		return e;
	}
226
	e = Jim_GetLong(interp, argv[4], &l);
oharboe's avatar
oharboe committed
227
	len = l;
228
	if (e != JIM_OK) {
oharboe's avatar
oharboe committed
229
230
		return e;
	}
231
232
233
234
235
236
237
238
239
240
241
242
243
244
	switch (width) {
		case 8:
			width = 1;
			break;
		case 16:
			width = 2;
			break;
		case 32:
			width = 4;
			break;
		default:
			Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
			Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
			return JIM_ERR;
oharboe's avatar
oharboe committed
245
	}
246
247
248
	if (len == 0) {
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
oharboe's avatar
oharboe committed
249
250
		return JIM_ERR;
	}
251
252
253
	if ((addr + (len * width)) < addr) {
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
oharboe's avatar
oharboe committed
254
255
256
		return JIM_ERR;
	}
	/* absurd transfer size? */
257
258
259
	if (len > 65536) {
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
oharboe's avatar
oharboe committed
260
261
262
		return JIM_ERR;
	}		
		
263
	if ((width == 1) ||
oharboe's avatar
oharboe committed
264
		((width == 2) && ((addr & 1) == 0)) ||
265
		((width == 4) && ((addr & 3) == 0))) {
oharboe's avatar
oharboe committed
266
267
268
		/* all is well */
	} else {
		char buf[100];
269
270
271
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		sprintf(buf, "mem2array address: 0x%08x is not aligned for %d byte reads", addr, width); 
		Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
oharboe's avatar
oharboe committed
272
273
274
		return JIM_ERR;
	}

275
	target = get_current_target(active_cmd_ctx);
oharboe's avatar
oharboe committed
276
277
278
279
280
281
282
	
	/* Transfer loop */

	/* index counter */
	n = 0;
	/* assume ok */
	e = JIM_OK;
283
	while (len) {
oharboe's avatar
oharboe committed
284
285
286
		/* Slurp... in buffer size chunks */
		
		count = len; /* in objects.. */
287
		if (count > (sizeof(buffer)/width)) {
oharboe's avatar
oharboe committed
288
289
290
			count = (sizeof(buffer)/width);
		}
		
291
292
		retval = target->type->read_memory( target, addr, width, count, buffer );
		if (retval != ERROR_OK) {
oharboe's avatar
oharboe committed
293
			/* BOO !*/
294
295
296
			LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
			Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
			Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
oharboe's avatar
oharboe committed
297
298
299
300
			e = JIM_ERR;
			len = 0;
		} else {
			v = 0; /* shut up gcc */
301
302
303
304
305
306
307
308
309
310
311
			for (i = 0 ;i < count ;i++, n++) {
				switch (width) {
					case 4:
						v = target_buffer_get_u32(target, &buffer[i*width]);
						break;
					case 2:
						v = target_buffer_get_u16(target, &buffer[i*width]);
						break;
					case 1:
						v = buffer[i] & 0x0ff;
						break;
oharboe's avatar
oharboe committed
312
				}
313
				new_int_array_element(interp, varname, n, v);
oharboe's avatar
oharboe committed
314
315
316
317
			}
			len -= count;
		}
	}
318
319
	
	Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
oharboe's avatar
oharboe committed
320
321
322
323

	return JIM_OK;
}

oharboe's avatar
oharboe committed
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
static int get_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 *val)
{
	char *namebuf;
	Jim_Obj *nameObjPtr, *valObjPtr;
	int result;
	long l;

	namebuf = alloc_printf("%s(%d)", varname, idx);
	if (!namebuf)
		return JIM_ERR;

	nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
	if (!nameObjPtr)
	{
		free(namebuf);
		return JIM_ERR;
	}

	Jim_IncrRefCount(nameObjPtr);
	valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
	Jim_DecrRefCount(interp, nameObjPtr);
	free(namebuf);
	if (valObjPtr == NULL)
		return JIM_ERR;

	result = Jim_GetLong(interp, valObjPtr, &l);
	/* printf("%s(%d) => 0%08x\n", varname, idx, val); */
	*val = l;
	return result;
}

static int Jim_Command_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
	target_t *target;
	long l;
	u32 width;
	u32 len;
	u32 addr;
	u32 count;
	u32 v;
	const char *varname;
	u8 buffer[4096];
	int  i, n, e, retval;

	/* argv[1] = name of array to get the data
	 * argv[2] = desired width
	 * argv[3] = memory address 
	 * argv[4] = count to write
	 */
	if (argc != 5) {
		Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
		return JIM_ERR;
	}
	varname = Jim_GetString(argv[1], &len);
	/* given "foo" get space for worse case "foo(%d)" .. add 20 */

	e = Jim_GetLong(interp, argv[2], &l);
	width = l;
	if (e != JIM_OK) {
		return e;
	}
	
	e = Jim_GetLong(interp, argv[3], &l);
	addr = l;
	if (e != JIM_OK) {
		return e;
	}
	e = Jim_GetLong(interp, argv[4], &l);
	len = l;
	if (e != JIM_OK) {
		return e;
	}
	switch (width) {
		case 8:
			width = 1;
			break;
		case 16:
			width = 2;
			break;
		case 32:
			width = 4;
			break;
		default:
			Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
			Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
			return JIM_ERR;
	}
	if (len == 0) {
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: zero width read?", NULL);
		return JIM_ERR;
	}
	if ((addr + (len * width)) < addr) {
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: addr + len - wraps to zero?", NULL);
		return JIM_ERR;
	}
	/* absurd transfer size? */
	if (len > 65536) {
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: absurd > 64K item request", NULL);
		return JIM_ERR;
	}		
		
	if ((width == 1) ||
		((width == 2) && ((addr & 1) == 0)) ||
		((width == 4) && ((addr & 3) == 0))) {
		/* all is well */
	} else {
		char buf[100];
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads", addr, width); 
		Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
		return JIM_ERR;
	}

	target = get_current_target(active_cmd_ctx);
	
	/* Transfer loop */

	/* index counter */
	n = 0;
	/* assume ok */
	e = JIM_OK;
	while (len) {
		/* Slurp... in buffer size chunks */
		
		count = len; /* in objects.. */
		if (count > (sizeof(buffer)/width)) {
			count = (sizeof(buffer)/width);
		}

		v = 0; /* shut up gcc */
		for (i = 0 ;i < count ;i++, n++) {
			get_int_array_element(interp, varname, n, &v);
			switch (width) {
			case 4:
				target_buffer_set_u32(target, &buffer[i*width], v);
				break;
			case 2:
				target_buffer_set_u16(target, &buffer[i*width], v);
				break;
			case 1:
				buffer[i] = v & 0x0ff;
				break;
			}
		}
		len -= count;

		retval = target->type->write_memory(target, addr, width, count, buffer);
		if (retval != ERROR_OK) {
			/* BOO !*/
			LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
			Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
			Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
			e = JIM_ERR;
			len = 0;
		}
	}
	
	Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));

	return JIM_OK;
}

ntfreak's avatar
ntfreak committed
489
static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
oharboe's avatar
oharboe committed
490
491
492
493
494
495
{		
	Jim_Obj *tclOutput=(Jim_Obj *)privData;

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

496
497
static int openocd_retval; 

oharboe's avatar
oharboe committed
498
/* try to execute as Jim command, otherwise fall back to standard command.
499
500
 * 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. */
501
502
int jim_command(command_context_t *context, char *line)
{
oharboe's avatar
oharboe committed
503
	int retval=ERROR_OK;
504
505
506
	int retcode;

	active_cmd_ctx = context;
507
	openocd_retval=ERROR_OK;
508
	retcode = Jim_Eval(interp, line);
oharboe's avatar
oharboe committed
509
	
510
	if (retcode == JIM_ERR) {
511
512
513
514
		if (openocd_retval!=ERROR_COMMAND_CLOSE_CONNECTION)
		{
			/* We do not print the connection closed error message */
			Jim_PrintErrorMessage(interp);
oharboe's avatar
oharboe committed
515
		}
516
517
518
519
520
521
		if (openocd_retval==ERROR_OK)
		{
			/* It wasn't a low level OpenOCD command that failed */
			return ERROR_FAIL; 
		}
	    return openocd_retval;
oharboe's avatar
oharboe committed
522
523
524
525
526
527
	} 
	const char *result;
	int reslen;
	result = Jim_GetString(Jim_GetResult(interp), &reslen);
		
	if (retcode == JIM_EXIT) {
528
529
530
531
532
533
534
535
536
537
538
539
		/* 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;
oharboe's avatar
oharboe committed
540
        		strncpy(buff, result+i, chunk);
541
542
543
544
545
546
				buff[chunk] = 0; 
				LOG_USER_N("%s", buff);
			}
			LOG_USER_N("%s", "\n");
		}
	}
oharboe's avatar
oharboe committed
547
548
549
	return retval;
}

550
int startLoop = 0;
oharboe's avatar
oharboe committed
551

ntfreak's avatar
ntfreak committed
552
static int Jim_Command_openocd_ignore(Jim_Interp *interp, int argc, Jim_Obj *const *argv, int ignore)
oharboe's avatar
oharboe committed
553
554
{
	int retval;
555
556
557
558
559
560
561
562
563
	char *cmd = (char*)Jim_GetString(argv[1], NULL);
	
	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();
	}
oharboe's avatar
oharboe committed
564
565
	
	log_add_callback(tcl_output, tclOutput);
566
	retval=command_run_line_internal(active_cmd_ctx, cmd);
567

568
569
	/* we need to be able to get at the retval, so we store in a global variable */
	openocd_retval=retval;
570
571
572
573
574
	
	if (startLoop)
	{
		target_call_timer_callbacks_now();
	}
oharboe's avatar
oharboe committed
575
	log_remove_callback(tcl_output, tclOutput);
576
	
oharboe's avatar
oharboe committed
577
	Jim_SetResult(interp, tclOutput);
578
579
	
	return (ignore||(retval==ERROR_OK))?JIM_OK:JIM_ERR;
oharboe's avatar
oharboe committed
580
581
}

ntfreak's avatar
ntfreak committed
582
static int Jim_Command_openocd(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
oharboe's avatar
oharboe committed
583
584
585
586
{
	return Jim_Command_openocd_ignore(interp, argc, argv, 1); 
}

ntfreak's avatar
ntfreak committed
587
static int Jim_Command_openocd_throw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
oharboe's avatar
oharboe committed
588
589
590
591
592
{
	return Jim_Command_openocd_ignore(interp, argc, argv, 0); 
}

/* find full path to file */
ntfreak's avatar
ntfreak committed
593
static int Jim_Command_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
oharboe's avatar
oharboe committed
594
{
595
	if (argc != 2)
oharboe's avatar
oharboe committed
596
		return JIM_ERR;
oharboe's avatar
oharboe committed
597
	const char *file = Jim_GetString(argv[1], NULL);
598
599
	char *full_path = find_file(file);
	if (full_path == NULL)
oharboe's avatar
oharboe committed
600
		return JIM_ERR;
601
602
603
	Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
	free(full_path);
	
oharboe's avatar
oharboe committed
604
605
606
607
	Jim_SetResult(interp, result);
	return JIM_OK;
}

ntfreak's avatar
ntfreak committed
608
static int Jim_Command_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
609
{
610
	if (argc != 2)
611
612
613
614
615
		return JIM_ERR;
	char *str = (char*)Jim_GetString(argv[1], NULL);
	LOG_USER("%s", str);
	return JIM_OK;
}
oharboe's avatar
oharboe committed
616

oharboe's avatar
oharboe committed
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
static int Jim_Command_script(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
	int retval;
	const char *file;
	char *full_path;

	if (argc != 2)
	{
		Jim_WrongNumArgs(interp, 1, argv, "file name missing");
		return JIM_ERR;
	}

	/* Run a tcl script file */
	file = Jim_GetString(argv[1], NULL);
	full_path = find_file(file);
	if (full_path == NULL)
	{
		Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
		Jim_AppendStrings(interp, Jim_GetResult(interp), "script: could not open file", file, NULL);
		return JIM_ERR;
	}
	retval = Jim_EvalFile(interp, full_path);
	free(full_path);
	/* convert a return to ok */
	if (retval == JIM_RETURN)
		return JIM_OK;
	return retval;
}


ntfreak's avatar
ntfreak committed
647
static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
oharboe's avatar
oharboe committed
648
649
650
651
652
653
654
655
{
	size_t nbytes;
	const char *ptr;

	/* make it a char easier to read code */
	ptr = _ptr;

	nbytes = size * n;
656
	if (nbytes == 0) {
oharboe's avatar
oharboe committed
657
658
659
		return 0;
	}

660
661
	if (!active_cmd_ctx) {
		/* TODO: Where should this go? */		
oharboe's avatar
oharboe committed
662
663
664
665
		return n;
	}

	/* do we have to chunk it? */
666
	if (ptr[nbytes] == 0) {
oharboe's avatar
oharboe committed
667
		/* no it is a C style string */
668
		command_output_text(active_cmd_ctx, ptr);
oharboe's avatar
oharboe committed
669
		return strlen(ptr);
oharboe's avatar
oharboe committed
670
671
	}
	/* GRR we must chunk - not null terminated */
672
	while (nbytes) {
oharboe's avatar
oharboe committed
673
674
675
676
		char chunk[128+1];
		int x;

		x = nbytes;
677
		if (x > 128) {
oharboe's avatar
oharboe committed
678
679
680
			x = 128;
		}
		/* copy it */
681
		memcpy(chunk, ptr, x);
oharboe's avatar
oharboe committed
682
683
684
		/* terminate it */
		chunk[n] = 0;
		/* output it */
685
		command_output_text(active_cmd_ctx, chunk);
oharboe's avatar
oharboe committed
686
687
688
689
690
691
692
		ptr += x;
		nbytes -= x;
	}
	
	return n;
}

ntfreak's avatar
ntfreak committed
693
static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie )
oharboe's avatar
oharboe committed
694
695
696
697
698
{
	/* TCL wants to read... tell him no */
	return 0;
}

ntfreak's avatar
ntfreak committed
699
static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
oharboe's avatar
oharboe committed
700
701
702
703
704
{
	char *cp;
	int n;
	
	n = -1;
705
706
707
708
	if (active_cmd_ctx) {
		cp = alloc_vprintf(fmt, ap);
		if (cp) {
			command_output_text(active_cmd_ctx, cp);
oharboe's avatar
oharboe committed
709
710
711
712
713
714
715
			n = strlen(cp);
			free(cp);
		}
	}
	return n;
}

ntfreak's avatar
ntfreak committed
716
static int openocd_jim_fflush(void *cookie)
oharboe's avatar
oharboe committed
717
718
719
720
721
{
	/* nothing to flush */
	return 0;
}

ntfreak's avatar
ntfreak committed
722
static char* openocd_jim_fgets(char *s, int size, void *cookie)
oharboe's avatar
oharboe committed
723
724
725
726
727
728
{
	/* not supported */
	errno = ENOTSUP;
	return NULL;
}

oharboe's avatar
oharboe committed
729
730
731
732
void add_jim(const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
{
	Jim_CreateCommand(interp, name, cmd, NULL, NULL);
	
oharboe's avatar
oharboe committed
733
734
735
	/* FIX!!! it would be prettier to invoke add_help_text... 
	accumulate help text in Tcl helptext list.  */
    Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
736
737
738
    if (Jim_IsShared(helptext))
        helptext = Jim_DuplicateObj(interp, helptext);
    
oharboe's avatar
oharboe committed
739
740
741
742
743
744
745
746
	Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
	
	Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
	Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
	
	Jim_ListAppendElement(interp, cmd_entry, cmd_list);
	Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
	Jim_ListAppendElement(interp, helptext, cmd_entry);
oharboe's avatar
oharboe committed
747
748
}

749
extern unsigned const char startup_tcl[];
oharboe's avatar
oharboe committed
750

oharboe's avatar
oharboe committed
751
void initJim(void)
752
{	
753
754
755
756
	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);
	Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
oharboe's avatar
oharboe committed
757
	Jim_CreateCommand(interp, "script", Jim_Command_script, NULL, NULL);
758
	Jim_CreateCommand(interp, "mem2array", Jim_Command_mem2array, NULL, NULL );
oharboe's avatar
oharboe committed
759
760
	Jim_CreateCommand(interp, "array2mem", Jim_Command_array2mem, NULL, NULL );

oharboe's avatar
oharboe committed
761
	/* Set Jim's STDIO */
762
	interp->cookie_stdin = NULL;
oharboe's avatar
oharboe committed
763
764
	interp->cookie_stdout = NULL;
	interp->cookie_stderr = NULL;
765
766
767
768
769
	interp->cb_fwrite = openocd_jim_fwrite;
	interp->cb_fread = openocd_jim_fread ;
	interp->cb_vfprintf = openocd_jim_vfprintf;
	interp->cb_fflush = openocd_jim_fflush;
	interp->cb_fgets = openocd_jim_fgets;
oharboe's avatar
oharboe committed
770
771
772
	
	add_default_dirs();
	
773
	if (Jim_Eval(interp, startup_tcl)==JIM_ERR)
774
	{
775
776
		LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
		Jim_PrintErrorMessage(interp);
777
778
		exit(-1);
	}
oharboe's avatar
oharboe committed
779
780
}

781
command_context_t *setup_command_handler(void)
oharboe's avatar
oharboe committed
782
783
{
	command_context_t *cmd_ctx;
oharboe's avatar
oharboe committed
784
	
785
	cmd_ctx = command_init();
oharboe's avatar
oharboe committed
786
	
787
788
	register_command(cmd_ctx, NULL, "version", handle_version_command,
					 COMMAND_EXEC, "show OpenOCD version");
789
790
791
	register_command(cmd_ctx, NULL, "daemon_startup", handle_daemon_startup_command, COMMAND_CONFIG, 
			"deprecated - use \"init\" and \"reset\" at end of startup script instead");
	
792
793
794
795
	/* register subsystem commands */
	server_register_commands(cmd_ctx);
	telnet_register_commands(cmd_ctx);
	gdb_register_commands(cmd_ctx);
796
	tcl_register_commands(cmd_ctx); /* tcl server commands */
797
798
799
800
801
802
803
804
805
	log_register_commands(cmd_ctx);
	jtag_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)
oharboe's avatar
oharboe committed
806
807
808
	{
		exit(-1);
	}
809
	LOG_DEBUG("log init complete");
oharboe's avatar
oharboe committed
810

811
	LOG_OUTPUT( OPENOCD_VERSION "\n" );
812
813
	
	
814
815
816
	register_command(cmd_ctx, NULL, "init", handle_init_command,
					 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");

oharboe's avatar
oharboe committed
817
818
819
	return cmd_ctx;
}

820
821
822
/* 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
823
824
825
826
int openocd_main(int argc, char *argv[])
{
#ifdef JIM_EMBEDDED
	Jim_InitEmbedded();
827
828
829
830
	/* Create an interpreter */
	interp = Jim_CreateInterp();
	/* Add all the Jim core commands */
	Jim_RegisterCoreCommands(interp);
oharboe's avatar
oharboe committed
831
#endif
832
	
oharboe's avatar
oharboe committed
833
834
835
836
837
838
	initJim();
	
	/* initialize commandline interface */
	command_context_t *cmd_ctx;
	cmd_ctx=setup_command_handler();
	
oharboe's avatar
oharboe committed
839
840
841
842
843
844
845
846
847
848
849
850
	/* 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 */
	LOG_OUTPUT( "$URL$\n");
	/* 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 */

oharboe's avatar
oharboe committed
851
	command_context_t *cfg_cmd_ctx;
852
853
854
855
	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);
	
oharboe's avatar
oharboe committed
856
857
	active_cmd_ctx=cfg_cmd_ctx;
	
858

859
860
861
	if (parse_cmdline_args(cfg_cmd_ctx, argc, argv) != ERROR_OK)
		return EXIT_FAILURE;
	
862
863
864
	if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
		return EXIT_FAILURE;
	
oharboe's avatar
oharboe committed
865
866
	active_cmd_ctx=cmd_ctx;
	
867
868
	command_done(cfg_cmd_ctx);

869
	if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
870
		return EXIT_FAILURE;
871
872
873
	
	if (daemon_startup)
		command_run_line(cmd_ctx, "reset");
ntfreak's avatar
ntfreak committed
874
	
oharboe's avatar
oharboe committed
875
876
	startLoop=1;

877
878
879
880
881
882
	/* handle network connections */
	server_loop(cmd_ctx);

	/* shut server down */
	server_quit();

883
884
	unregister_all_commands(cmd_ctx);
	
885
886
887
888
889
	/* free commandline interface */
	command_done(cmd_ctx);

	return EXIT_SUCCESS;
}