1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV
30 #include "configuration.h"
31 #include "interpreter.h"
40 #include "telnet_server.h"
41 #include "gdb_server.h"
42 #include "tcl_server.h"
45 #include <sys/types.h>
60 /* Jim is provied by eCos */
61 #include <cyg/jimtcl/jim.h>
67 #include "replacements.h"
69 int launchTarget(struct command_context_s *cmd_ctx)
72 /* Try to examine & validate jtag chain, though this may require a reset first
73 * in which case we continue setup */
76 /* try to examine target at this point. If it fails, perhaps a reset will
77 * bring it up later on via a telnet/gdb session */
78 target_examine(cmd_ctx);
80 retval=flash_init_drivers(cmd_ctx);
83 LOG_DEBUG("flash init complete");
85 retval=nand_init(cmd_ctx);
88 LOG_DEBUG("NAND init complete");
90 retval=pld_init(cmd_ctx);
93 LOG_DEBUG("pld init complete");
97 /* Give TELNET a way to find out what version this is */
98 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
100 command_print(cmd_ctx, OPENOCD_VERSION);
105 static int daemon_startup = 0;
107 int handle_daemon_startup_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
112 return ERROR_COMMAND_SYNTAX_ERROR;
114 daemon_startup = strcmp("reset", args[0])==0;
116 command_print(cmd_ctx, OPENOCD_VERSION);
121 void exit_handler(void)
123 /* close JTAG interface */
124 if (jtag && jtag->quit)
128 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
129 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
132 static int initialized=0;
138 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
140 atexit(exit_handler);
142 if (target_init(cmd_ctx) != ERROR_OK)
144 LOG_DEBUG("target init complete");
146 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
148 /* we must be able to set up the jtag interface */
151 LOG_DEBUG("jtag interface init complete");
153 /* Try to initialize & examine the JTAG chain at this point, but
154 * continue startup regardless
156 if (jtag_init(cmd_ctx) == ERROR_OK)
158 LOG_DEBUG("jtag init complete");
159 if (target_examine(cmd_ctx) == ERROR_OK)
161 LOG_DEBUG("jtag examine complete");
165 if (flash_init_drivers(cmd_ctx) != ERROR_OK)
167 LOG_DEBUG("flash init complete");
169 if (nand_init(cmd_ctx) != ERROR_OK)
171 LOG_DEBUG("NAND init complete");
173 if (pld_init(cmd_ctx) != ERROR_OK)
175 LOG_DEBUG("pld init complete");
177 /* initialize tcp server */
180 /* initialize telnet subsystem */
181 telnet_init("Open On-Chip Debugger");
183 tcl_init(); /* allows tcl to just connect without going thru telnet */
190 command_context_t *active_cmd_ctx;
192 static int new_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 val)
195 Jim_Obj *nameObjPtr, *valObjPtr;
198 namebuf = alloc_printf("%s(%d)", varname, idx );
200 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
201 valObjPtr = Jim_NewIntObj(interp, val );
202 Jim_IncrRefCount(nameObjPtr);
203 Jim_IncrRefCount(valObjPtr);
204 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
205 Jim_DecrRefCount(interp, nameObjPtr);
206 Jim_DecrRefCount(interp, valObjPtr);
208 // printf( "%s = 0%08x\n", namebuf, val );
212 static int Jim_Command_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
225 /* argv[1] = name of array to receive the data
226 * argv[2] = desired width
227 * argv[3] = memory address
228 * argv[4] = length in bytes to read
231 Jim_WrongNumArgs( interp, 1, argv, "varname width addr nelems" );
234 varname = Jim_GetString( argv[1], &len );
235 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
237 e = Jim_GetLong( interp, argv[2], &l );
243 e = Jim_GetLong( interp, argv[3], &l );
248 e = Jim_GetLong( interp, argv[4], &l );
264 Jim_SetResult(interp,
265 Jim_NewEmptyStringObj(interp));
266 Jim_AppendStrings( interp, Jim_GetResult(interp),
267 "Invalid width param, must be 8/16/32", NULL );
271 Jim_SetResult(interp,
272 Jim_NewEmptyStringObj(interp));
273 Jim_AppendStrings( interp, Jim_GetResult(interp),
274 "mem2array: zero width read?", NULL );
277 if( (addr + (len * width)) < addr ){
278 Jim_SetResult(interp,
279 Jim_NewEmptyStringObj(interp));
280 Jim_AppendStrings( interp, Jim_GetResult(interp),
281 "mem2array: addr + len - wraps to zero?", NULL );
284 /* absurd transfer size? */
286 Jim_SetResult(interp,
287 Jim_NewEmptyStringObj(interp));
288 Jim_AppendStrings( interp, Jim_GetResult(interp),
289 "mem2array: absurd > 64K item request", NULL );
294 ((width == 2) && ((addr & 1) == 0)) ||
295 ((width == 4) && ((addr & 3) == 0)) ){
299 Jim_SetResult(interp,
300 Jim_NewEmptyStringObj(interp));
302 "mem2array address: 0x%08x is not aligned for %d byte reads",
305 Jim_AppendStrings( interp, Jim_GetResult(interp),
310 target = get_current_target( active_cmd_ctx );
320 /* Slurp... in buffer size chunks */
322 count = len; /* in objects.. */
323 if( count > (sizeof(buffer)/width)){
324 count = (sizeof(buffer)/width);
327 retval = target->type->read_memory( target,
333 if( retval != ERROR_OK ){
335 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed",
336 addr, width, count );
337 Jim_SetResult(interp,
338 Jim_NewEmptyStringObj(interp));
339 Jim_AppendStrings( interp, Jim_GetResult(interp),
340 "mem2array: cannot read memory", NULL );
344 v = 0; /* shut up gcc */
345 for( i = 0 ; i < count ; i++, n++ ){
348 v = target_buffer_get_u32( target, &buffer[i*width] );
351 v = target_buffer_get_u16( target, &buffer[i*width] );
354 v = buffer[i] & 0x0ff;
357 new_int_array_element( interp, varname, n, v );
362 Jim_SetResult(interp,
363 Jim_NewEmptyStringObj(interp));
368 static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
370 Jim_Obj *tclOutput=(Jim_Obj *)privData;
372 Jim_AppendString(interp, tclOutput, string, strlen(string));
375 /* try to execute as Jim command, otherwise fall back to standard command.
377 Note that even if the Jim command caused an error, then we succeeded
378 to execute it, hence this fn pretty much always returns ERROR_OK.
381 int jim_command(command_context_t *context, char *line)
384 /* FIX!!!! in reality there is only one cmd_ctx handler, but consider
385 what might happen here if there are multiple handlers w/reentrant callback
387 active_cmd_ctx=context;
388 int retcode=Jim_Eval(interp, line);
392 result = Jim_GetString(Jim_GetResult(interp), &reslen);
393 if (retcode == JIM_ERR) {
396 LOG_USER_N("Runtime error, file \"%s\", line %d:" JIM_NL,
397 interp->errorFileName, interp->errorLine);
398 LOG_USER_N(" %s" JIM_NL,
399 Jim_GetString(interp->result, NULL));
400 Jim_ListLength(interp, interp->stackTrace, &len);
401 for (i = 0; i < len; i+= 3) {
403 const char *proc, *file, *line;
405 Jim_ListIndex(interp, interp->stackTrace, i, &objPtr, JIM_NONE);
406 proc = Jim_GetString(objPtr, NULL);
407 Jim_ListIndex(interp, interp->stackTrace, i+1, &objPtr,
409 file = Jim_GetString(objPtr, NULL);
410 Jim_ListIndex(interp, interp->stackTrace, i+2, &objPtr,
412 line = Jim_GetString(objPtr, NULL);
413 LOG_USER_N("In procedure '%s' called at file \"%s\", line %s" JIM_NL,
416 } else if (retcode == JIM_EXIT) {
418 //exit(Jim_GetExitCode(interp));
423 for (i=0; i<reslen; i+=256)
429 strncpy(buff, result, chunk);
431 LOG_USER_N("%s", buff);
433 LOG_USER_N("%s", "\n");
441 static int Jim_Command_openocd_ignore(Jim_Interp *interp, int argc, Jim_Obj *const *argv, int ignore)
444 char *cmd = (char*)Jim_GetString(argv[1], NULL);
446 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
450 // We don't know whether or not the telnet/gdb server is running...
451 target_call_timer_callbacks_now();
454 log_add_callback(tcl_output, tclOutput);
455 retval=command_run_line_internal(active_cmd_ctx, cmd);
459 target_call_timer_callbacks_now();
461 log_remove_callback(tcl_output, tclOutput);
463 Jim_SetResult(interp, tclOutput);
465 return (ignore||(retval==ERROR_OK))?JIM_OK:JIM_ERR;
468 static int Jim_Command_openocd(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
470 return Jim_Command_openocd_ignore(interp, argc, argv, 1);
473 static int Jim_Command_openocd_throw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
475 return Jim_Command_openocd_ignore(interp, argc, argv, 0);
478 /* find full path to file */
479 static int Jim_Command_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
483 char *file = (char*)Jim_GetString(argv[1], NULL);
484 char *full_path=find_file(file);
487 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
490 Jim_SetResult(interp, result);
494 static int Jim_Command_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
498 char *str = (char*)Jim_GetString(argv[1], NULL);
503 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
508 /* make it a char easier to read code */
516 if( !active_cmd_ctx ){
517 /* FIXME: Where should this go? */
521 /* do we have to chunk it? */
522 if( ptr[ nbytes ] == 0 ){
523 /* no it is a C style string */
524 command_output_text( active_cmd_ctx, ptr );
527 /* GRR we must chunk - not null terminated */
537 memcpy( chunk, ptr, x );
541 command_output_text( active_cmd_ctx, chunk );
549 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie )
551 /* TCL wants to read... tell him no */
555 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
561 if( active_cmd_ctx ){
562 cp = alloc_vprintf( fmt, ap );
564 command_output_text( active_cmd_ctx, cp );
572 static int openocd_jim_fflush(void *cookie)
574 /* nothing to flush */
578 static char* openocd_jim_fgets(char *s, int size, void *cookie)
587 Jim_CreateCommand(interp, "openocd", Jim_Command_openocd, NULL, NULL);
588 Jim_CreateCommand(interp, "openocd_throw", Jim_Command_openocd_throw, NULL, NULL);
589 Jim_CreateCommand(interp, "find", Jim_Command_find, NULL, NULL);
590 Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
591 Jim_CreateCommand(interp, "mem2array", Jim_Command_mem2array, NULL, NULL );
593 /* Set Jim's STDIO */
594 interp->cookie_stdin = NULL;
595 interp->cookie_stdout = NULL;
596 interp->cookie_stderr = NULL;
597 interp->cb_fwrite = openocd_jim_fwrite;
598 interp->cb_fread = openocd_jim_fread ;
599 interp->cb_vfprintf = openocd_jim_vfprintf;
600 interp->cb_fflush = openocd_jim_fflush;
601 interp->cb_fgets = openocd_jim_fgets;
604 /* after command line parsing */
607 Jim_Eval(interp, "source [find tcl/commands.tcl]");
610 command_context_t *setup_command_handler()
612 command_context_t *cmd_ctx;
614 cmd_ctx = command_init();
616 register_command(cmd_ctx, NULL, "version", handle_version_command,
617 COMMAND_EXEC, "show OpenOCD version");
618 register_command(cmd_ctx, NULL, "daemon_startup", handle_daemon_startup_command, COMMAND_CONFIG,
619 "deprecated - use \"init\" and \"reset\" at end of startup script instead");
621 /* register subsystem commands */
622 server_register_commands(cmd_ctx);
623 telnet_register_commands(cmd_ctx);
624 gdb_register_commands(cmd_ctx);
625 tcl_register_commands(cmd_ctx); /* tcl server commands */
626 log_register_commands(cmd_ctx);
627 jtag_register_commands(cmd_ctx);
628 interpreter_register_commands(cmd_ctx);
629 xsvf_register_commands(cmd_ctx);
630 target_register_commands(cmd_ctx);
631 flash_register_commands(cmd_ctx);
632 nand_register_commands(cmd_ctx);
633 pld_register_commands(cmd_ctx);
635 if (log_init(cmd_ctx) != ERROR_OK)
639 LOG_DEBUG("log init complete");
641 LOG_OUTPUT( OPENOCD_VERSION "\n" );
644 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
645 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
646 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
647 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
648 /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
649 LOG_OUTPUT( "$URL$\n");
650 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
651 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
652 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
653 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
654 /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
656 register_command(cmd_ctx, NULL, "init", handle_init_command,
657 COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
663 normally this is the main() function entry, but if OpenOCD is linked
664 into application, then this fn will not be invoked, but rather that
665 application will have it's own implementation of main().
667 int openocd_main(int argc, char *argv[])
671 /* Create an interpreter */
672 interp = Jim_CreateInterp();
673 /* Add all the Jim core commands */
674 Jim_RegisterCoreCommands(interp);
679 /* initialize commandline interface */
680 command_context_t *cmd_ctx;
681 cmd_ctx=setup_command_handler();
683 command_context_t *cfg_cmd_ctx;
684 cfg_cmd_ctx = copy_command_context(cmd_ctx);
685 cfg_cmd_ctx->mode = COMMAND_CONFIG;
686 command_set_output_handler(cfg_cmd_ctx, configuration_output_handler, NULL);
688 if (parse_cmdline_args(cfg_cmd_ctx, argc, argv) != ERROR_OK)
693 if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
696 command_done(cfg_cmd_ctx);
698 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
702 command_run_line(cmd_ctx, "reset");
706 /* handle network connections */
707 server_loop(cmd_ctx);
709 /* shut server down */
712 unregister_all_commands(cmd_ctx);
714 /* free commandline interface */
715 command_done(cmd_ctx);