openocd.c 19.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
/***************************************************************************
 *   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
	static int initialized=0;
	if (initialized)
		return ERROR_OK;
	
	initialized=1;
	
	atexit(exit_handler);
111
	
112
113
114
115
	if (target_init(cmd_ctx) != ERROR_OK)
		return ERROR_FAIL;
	LOG_DEBUG("target init complete");

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

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
157
158
Jim_Interp *interp;

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

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

177
178
179
180
181
182
	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
183
	/* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
184
	return result;
oharboe's avatar
oharboe committed
185
186
}

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

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

213
	e = Jim_GetLong(interp, argv[2], &l);
oharboe's avatar
oharboe committed
214
	width = l;
215
	if (e != JIM_OK) {
oharboe's avatar
oharboe committed
216
217
218
		return e;
	}
	
219
	e = Jim_GetLong(interp, argv[3], &l);
oharboe's avatar
oharboe committed
220
	addr = l;
221
	if (e != JIM_OK) {
oharboe's avatar
oharboe committed
222
223
		return e;
	}
224
	e = Jim_GetLong(interp, argv[4], &l);
oharboe's avatar
oharboe committed
225
	len = l;
226
	if (e != JIM_OK) {
oharboe's avatar
oharboe committed
227
228
		return e;
	}
229
230
231
232
233
234
235
236
237
238
239
240
241
242
	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
243
	}
244
245
246
	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
247
248
		return JIM_ERR;
	}
249
250
251
	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
252
253
254
		return JIM_ERR;
	}
	/* absurd transfer size? */
255
256
257
	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
258
259
260
		return JIM_ERR;
	}		
		
261
	if ((width == 1) ||
oharboe's avatar
oharboe committed
262
		((width == 2) && ((addr & 1) == 0)) ||
263
		((width == 4) && ((addr & 3) == 0))) {
oharboe's avatar
oharboe committed
264
265
266
		/* all is well */
	} else {
		char buf[100];
267
268
269
		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
270
271
272
		return JIM_ERR;
	}

273
274
275
276
277
278
279
280
281
282
283
284
	context = Jim_GetAssocData(interp, "context");
	if (context == NULL)
	{
		LOG_ERROR("mem2array: no command context");
		return JIM_ERR;
	}
	target = get_current_target(context);
	if (target == NULL)
	{
		LOG_ERROR("mem2array: no current target");
		return JIM_ERR;
	}
oharboe's avatar
oharboe committed
285
286
287
288
289
290
291
	
	/* Transfer loop */

	/* index counter */
	n = 0;
	/* assume ok */
	e = JIM_OK;
292
	while (len) {
oharboe's avatar
oharboe committed
293
294
295
		/* Slurp... in buffer size chunks */
		
		count = len; /* in objects.. */
296
		if (count > (sizeof(buffer)/width)) {
oharboe's avatar
oharboe committed
297
298
299
			count = (sizeof(buffer)/width);
		}
		
300
301
		retval = target->type->read_memory( target, addr, width, count, buffer );
		if (retval != ERROR_OK) {
oharboe's avatar
oharboe committed
302
			/* BOO !*/
303
304
305
			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
306
307
308
309
			e = JIM_ERR;
			len = 0;
		} else {
			v = 0; /* shut up gcc */
310
311
312
313
314
315
316
317
318
319
320
			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
321
				}
322
				new_int_array_element(interp, varname, n, v);
oharboe's avatar
oharboe committed
323
324
325
326
			}
			len -= count;
		}
	}
327
328
	
	Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
oharboe's avatar
oharboe committed
329
330
331
332

	return JIM_OK;
}

oharboe's avatar
oharboe committed
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
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;
367
	command_context_t *context;
oharboe's avatar
oharboe committed
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
	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;
	}

450
451
452
453
454
455
456
457
458
459
460
461
	context = Jim_GetAssocData(interp, "context");
	if (context == NULL)
	{
		LOG_ERROR("array2mem: no command context");
		return JIM_ERR;
	}
	target = get_current_target(context);
	if (target == NULL)
	{
		LOG_ERROR("array2mem: no current target");
		return JIM_ERR;
	}
oharboe's avatar
oharboe committed
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
	
	/* 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;
}

oharboe's avatar
oharboe committed
510
511
512


/* find full path to file */
ntfreak's avatar
ntfreak committed
513
static int Jim_Command_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
oharboe's avatar
oharboe committed
514
{
515
	if (argc != 2)
oharboe's avatar
oharboe committed
516
		return JIM_ERR;
oharboe's avatar
oharboe committed
517
	const char *file = Jim_GetString(argv[1], NULL);
518
519
	char *full_path = find_file(file);
	if (full_path == NULL)
oharboe's avatar
oharboe committed
520
		return JIM_ERR;
521
522
523
	Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
	free(full_path);
	
oharboe's avatar
oharboe committed
524
525
526
527
	Jim_SetResult(interp, result);
	return JIM_OK;
}

ntfreak's avatar
ntfreak committed
528
static int Jim_Command_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
529
{
530
	if (argc != 2)
531
		return JIM_ERR;
532
	const char *str = Jim_GetString(argv[1], NULL);
533
534
535
	LOG_USER("%s", str);
	return JIM_OK;
}
oharboe's avatar
oharboe committed
536

oharboe's avatar
oharboe committed
537
538


ntfreak's avatar
ntfreak committed
539
static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
oharboe's avatar
oharboe committed
540
541
542
{
	size_t nbytes;
	const char *ptr;
543
544
	Jim_Interp *interp;
	command_context_t *context;
oharboe's avatar
oharboe committed
545
546
547

	/* make it a char easier to read code */
	ptr = _ptr;
548
	interp = cookie;
oharboe's avatar
oharboe committed
549
	nbytes = size * n;
550
	if (ptr == NULL || interp == NULL || nbytes == 0) {
oharboe's avatar
oharboe committed
551
552
553
		return 0;
	}

554
555
556
557
	context = Jim_GetAssocData(interp, "context");
	if (context == NULL)
	{
		LOG_ERROR("openocd_jim_fwrite: no command context");
558
		/* TODO: Where should this go? */		
oharboe's avatar
oharboe committed
559
560
561
562
		return n;
	}

	/* do we have to chunk it? */
563
564
	if (ptr[nbytes] == 0)
	{
oharboe's avatar
oharboe committed
565
		/* no it is a C style string */
566
		command_output_text(context, ptr);
oharboe's avatar
oharboe committed
567
		return strlen(ptr);
oharboe's avatar
oharboe committed
568
569
	}
	/* GRR we must chunk - not null terminated */
570
	while (nbytes) {
oharboe's avatar
oharboe committed
571
572
573
574
		char chunk[128+1];
		int x;

		x = nbytes;
575
		if (x > 128) {
oharboe's avatar
oharboe committed
576
577
578
			x = 128;
		}
		/* copy it */
579
		memcpy(chunk, ptr, x);
oharboe's avatar
oharboe committed
580
581
582
		/* terminate it */
		chunk[n] = 0;
		/* output it */
583
		command_output_text(context, chunk);
oharboe's avatar
oharboe committed
584
585
586
587
588
589
590
		ptr += x;
		nbytes -= x;
	}
	
	return n;
}

591
static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
oharboe's avatar
oharboe committed
592
593
594
595
596
{
	/* TCL wants to read... tell him no */
	return 0;
}

ntfreak's avatar
ntfreak committed
597
static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
oharboe's avatar
oharboe committed
598
599
600
{
	char *cp;
	int n;
601
602
603
	Jim_Interp *interp;
	command_context_t *context;

oharboe's avatar
oharboe committed
604
	n = -1;
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
	interp = cookie;
	if (interp == NULL)
		return n;

	context = Jim_GetAssocData(interp, "context");
	if (context == NULL)
	{
		LOG_ERROR("openocd_jim_vfprintf: no command context");
		return n;
	}

	cp = alloc_vprintf(fmt, ap);
	if (cp)
	{
		command_output_text(context, cp);
		n = strlen(cp);
		free(cp);
oharboe's avatar
oharboe committed
622
623
624
625
	}
	return n;
}

ntfreak's avatar
ntfreak committed
626
static int openocd_jim_fflush(void *cookie)
oharboe's avatar
oharboe committed
627
628
629
630
631
{
	/* nothing to flush */
	return 0;
}

ntfreak's avatar
ntfreak committed
632
static char* openocd_jim_fgets(char *s, int size, void *cookie)
oharboe's avatar
oharboe committed
633
634
635
636
637
638
{
	/* not supported */
	errno = ENOTSUP;
	return NULL;
}

oharboe's avatar
oharboe committed
639
640
641
642
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
643
644
645
	/* 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);
646
647
648
    if (Jim_IsShared(helptext))
        helptext = Jim_DuplicateObj(interp, helptext);
    
oharboe's avatar
oharboe committed
649
650
651
652
653
654
655
656
	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
657
658
}

659
extern unsigned const char startup_tcl[];
oharboe's avatar
oharboe committed
660

oharboe's avatar
oharboe committed
661
void initJim(void)
662
{
663
	Jim_CreateCommand(interp, "openocd_find", Jim_Command_find, NULL, NULL);
664
665
	Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
	Jim_CreateCommand(interp, "mem2array", Jim_Command_mem2array, NULL, NULL );
oharboe's avatar
oharboe committed
666
667
	Jim_CreateCommand(interp, "array2mem", Jim_Command_array2mem, NULL, NULL );

oharboe's avatar
oharboe committed
668
	/* Set Jim's STDIO */
669
670
671
	interp->cookie_stdin = interp;
	interp->cookie_stdout = interp;
	interp->cookie_stderr = interp;
672
673
674
675
676
	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
677
678
679
	
	add_default_dirs();
	
680
	if (Jim_Eval(interp, startup_tcl)==JIM_ERR)
681
	{
682
683
		LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
		Jim_PrintErrorMessage(interp);
684
685
		exit(-1);
	}
oharboe's avatar
oharboe committed
686
687
}

688
command_context_t *setup_command_handler(void)
oharboe's avatar
oharboe committed
689
690
{
	command_context_t *cmd_ctx;
oharboe's avatar
oharboe committed
691
	
692
	cmd_ctx = command_init();
oharboe's avatar
oharboe committed
693
	
694
695
	register_command(cmd_ctx, NULL, "version", handle_version_command,
					 COMMAND_EXEC, "show OpenOCD version");
696
697
698
	register_command(cmd_ctx, NULL, "daemon_startup", handle_daemon_startup_command, COMMAND_CONFIG, 
			"deprecated - use \"init\" and \"reset\" at end of startup script instead");
	
699
700
701
702
	/* register subsystem commands */
	server_register_commands(cmd_ctx);
	telnet_register_commands(cmd_ctx);
	gdb_register_commands(cmd_ctx);
703
	tcl_register_commands(cmd_ctx); /* tcl server commands */
704
705
706
707
708
709
710
711
712
	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
713
714
715
	{
		exit(-1);
	}
716
	LOG_DEBUG("log init complete");
oharboe's avatar
oharboe committed
717

718
	LOG_OUTPUT( OPENOCD_VERSION "\n" );
719
	
720
721
722
	register_command(cmd_ctx, NULL, "init", handle_init_command,
					 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");

oharboe's avatar
oharboe committed
723
724
725
	return cmd_ctx;
}

726
727
728
/* 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
729
730
731
732
int openocd_main(int argc, char *argv[])
{
#ifdef JIM_EMBEDDED
	Jim_InitEmbedded();
733
734
735
736
	/* Create an interpreter */
	interp = Jim_CreateInterp();
	/* Add all the Jim core commands */
	Jim_RegisterCoreCommands(interp);
oharboe's avatar
oharboe committed
737
#endif
738
	
oharboe's avatar
oharboe committed
739
740
741
742
743
744
	initJim();
	
	/* initialize commandline interface */
	command_context_t *cmd_ctx;
	cmd_ctx=setup_command_handler();
	
oharboe's avatar
oharboe committed
745
746
747
748
749
750
751
752
753
754
755
756
	/* 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 */

757
758
	command_context_mode(cmd_ctx, COMMAND_CONFIG);
	command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
759

760
	if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
761
762
		return EXIT_FAILURE;
	
763
	if (parse_config_file(cmd_ctx) != ERROR_OK)
764
765
		return EXIT_FAILURE;

766
	command_context_mode(cmd_ctx, COMMAND_EXEC);
767
	if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
768
		return EXIT_FAILURE;
769
770
771
	
	if (daemon_startup)
		command_run_line(cmd_ctx, "reset");
ntfreak's avatar
ntfreak committed
772
	
773
774
775
776
777
778
	/* handle network connections */
	server_loop(cmd_ctx);

	/* shut server down */
	server_quit();

779
780
	unregister_all_commands(cmd_ctx);
	
781
782
783
784
785
	/* free commandline interface */
	command_done(cmd_ctx);

	return EXIT_SUCCESS;
}