Tcl exception codes cleanup, shutdown command amendments
[openocd.git] / src / openocd.c
index 5439ece08c91f83fdf682566ea260355f8e97add..4d4dc2c83d1a9dd4156dc5b80cc7063192d1dc01 100644 (file)
@@ -2,6 +2,12 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007-2010 Ã˜yvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 Richard Missenden                                  *
+ *   richard.missenden@googlemail.com                                      *
+ *                                                                         *
  *   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     *
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 "openocd.h"
+#include <jtag/driver.h>
+#include <jtag/jtag.h>
+#include <transport/transport.h>
+#include <helper/ioutil.h>
+#include <helper/util.h>
+#include <helper/configuration.h>
+#include <flash/nor/core.h>
+#include <flash/nand/core.h>
+#include <pld/pld.h>
+#include <flash/mflash.h>
+
+#include <server/server.h>
+#include <server/gdb_server.h>
+
+#ifdef HAVE_STRINGS_H
 #include <strings.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <errno.h>
+#endif
 
-#define JIM_EMBEDDED
-#include "jim.h"
+#define OPENOCD_VERSION        \
+       "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
 
+static const char openocd_startup_tcl[] = {
+#include "startup_tcl.inc"
+0 /* Terminate with zero */
+};
 
-/* 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)
+/* Give scripts and TELNET a way to find out what version this is */
+static int jim_version_command(Jim_Interp *interp, int argc,
+       Jim_Obj * const *argv)
 {
-       command_print(cmd_ctx, OPENOCD_VERSION);
+       if (argc > 2)
+               return JIM_ERR;
+       const char *str = "";
+       char *version_str;
+       version_str = OPENOCD_VERSION;
 
-       return ERROR_OK;
-}
+       if (argc == 2)
+               str = Jim_GetString(argv[1], NULL);
 
-static int daemon_startup = 0;
+       if (strcmp("git", str) == 0)
+               version_str = GITVERSION;
 
-int handle_daemon_startup_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+       Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
+
+       return JIM_OK;
+}
+
+static int log_target_callback_event_handler(struct target *target,
+       enum target_event event,
+       void *priv)
 {
-       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);
+       switch (event) {
+               case TARGET_EVENT_GDB_START:
+                       target->display = 0;
+                       break;
+               case TARGET_EVENT_GDB_END:
+                       target->display = 1;
+                       break;
+               case TARGET_EVENT_HALTED:
+                       if (target->display) {
+                               /* do not display information when debugger caused the halt */
+                               target_arch_state(target);
+                       }
+                       break;
+               default:
+                       break;
+       }
 
        return ERROR_OK;
 }
 
+static bool init_at_startup = true;
 
-void exit_handler(void)
+COMMAND_HANDLER(handle_noinit_command)
 {
-       /* close JTAG interface */
-       if (jtag && jtag->quit)
-               jtag->quit();
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       init_at_startup = false;
+       return ERROR_OK;
 }
 
-
 /* 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)
+COMMAND_HANDLER(handle_init_command)
 {
+
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
        int retval;
-       static int initialized=0;
+       static int initialized;
        if (initialized)
                return ERROR_OK;
-       
-       initialized=1;
-       
-       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 
-       atexit(exit_handler);
+       initialized = 1;
 
-       
-       if (target_init(cmd_ctx) != ERROR_OK)
+       retval = command_run_line(CMD_CTX, "target init");
+       if (ERROR_OK != retval)
                return ERROR_FAIL;
-       LOG_DEBUG("target init complete");
 
-       if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
-       {
-               /* we must be able to set up the jtag interface */
+       retval = adapter_init(CMD_CTX);
+       if (retval != ERROR_OK) {
+               /* we must be able to set up the debug adapter */
                return retval;
        }
-       LOG_DEBUG("jtag interface init complete");
 
-       /* Try to initialize & examine the JTAG chain at this point, but
-        * continue startup regardless
+       LOG_DEBUG("Debug Adapter init complete");
+
+       /* "transport init" verifies the expected devices are present;
+        * for JTAG, it checks the list of configured TAPs against
+        * what's discoverable, possibly with help from the platform's
+        * JTAG event handlers.  (which require COMMAND_EXEC)
         */
-       if (jtag_init(cmd_ctx) == ERROR_OK)
-       {
-               LOG_DEBUG("jtag init complete");
-               if (target_examine(cmd_ctx) == ERROR_OK)
-               {
-                       LOG_DEBUG("jtag examine complete");
-               }
-       }
+       command_context_mode(CMD_CTX, COMMAND_EXEC);
+
+       retval = command_run_line(CMD_CTX, "transport init");
+       if (ERROR_OK != retval)
+               return ERROR_FAIL;
+
+       LOG_DEBUG("Examining targets...");
+       if (target_examine() != ERROR_OK)
+               LOG_DEBUG("target examination failed");
 
-       
-       if (flash_init_drivers(cmd_ctx) != ERROR_OK)
+       command_context_mode(CMD_CTX, COMMAND_CONFIG);
+
+       if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("flash init complete");
 
-       if (nand_init(cmd_ctx) != ERROR_OK)
+       if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("NAND init complete");
 
-       if (pld_init(cmd_ctx) != ERROR_OK)
+       if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("pld init complete");
 
-       /* initialize tcp server */
-       server_init();
+       if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
+               return ERROR_FAIL;
+       command_context_mode(CMD_CTX, COMMAND_EXEC);
 
        /* initialize telnet subsystem */
-       telnet_init("Open On-Chip Debugger");
-       gdb_init();
-       tcl_init(); /* allows tcl to just connect without going thru telnet */
+       gdb_target_add_all(all_targets);
+
+       target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 
        return ERROR_OK;
 }
 
-
-/* implementations of OpenOCD that uses multithreading needs to lock OpenOCD while calling
- * OpenOCD fn's. No-op in vanilla OpenOCD
- */
-void lockBigLock()
-{
-}
-void unlockBigLock()
+COMMAND_HANDLER(handle_add_script_search_dir_command)
 {
-}
-
-
-
-
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-Jim_Interp *interp;
-command_context_t *active_cmd_ctx;
+       add_script_search_dir(CMD_ARGV[0]);
 
-static int
-new_int_array_element( Jim_Interp * interp, 
-                                          const char *varname, 
-                                          int idx, 
-                                          u32 val )
-{
-       char *namebuf;
-       Jim_Obj *nameObjPtr, *valObjPtr;
-       int result;
-
-       namebuf = alloca( strlen(varname) + 30 );
-       sprintf( namebuf, "%s(%d)", varname, idx );
-
-
-    nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
-    valObjPtr = Jim_NewIntObj(interp, val );
-    Jim_IncrRefCount(nameObjPtr);
-    Jim_IncrRefCount(valObjPtr);
-    result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
-    Jim_DecrRefCount(interp, nameObjPtr);
-    Jim_DecrRefCount(interp, valObjPtr);
-       // printf( "%s = 0%08x\n", namebuf, val );
-    return result;
+       return ERROR_OK;
 }
 
-static int
-Jim_Command_mem2array( Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static const struct command_registration openocd_command_handlers[] = {
+       {
+               .name = "version",
+               .jim_handler = jim_version_command,
+               .mode = COMMAND_ANY,
+               .help = "show program version",
+       },
+       {
+               .name = "noinit",
+               .handler = &handle_noinit_command,
+               .mode = COMMAND_CONFIG,
+               .help = "Prevent 'init' from being called at startup.",
+               .usage = ""
+       },
+       {
+               .name = "init",
+               .handler = &handle_init_command,
+               .mode = COMMAND_ANY,
+               .help = "Initializes configured targets and servers.  "
+                       "Changes command mode from CONFIG to EXEC.  "
+                       "Unless 'noinit' is called, this command is "
+                       "called automatically at the end of startup.",
+               .usage = ""
+       },
+       {
+               .name = "add_script_search_dir",
+               .handler = &handle_add_script_search_dir_command,
+               .mode = COMMAND_ANY,
+               .help = "dir to search for config files and scripts",
+               .usage = "<directory>"
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static int openocd_register_commands(struct command_context *cmd_ctx)
 {
-       target_t *target;
-       long l;
-       u32 width;
-       u32 endian;
-       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 receive the data
-        * argv[2] = desired width
-        * argv[3] = memory address 
-        * argv[4] = length in bytes to read
-        */
-       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),
-                                                  "mem2array: zero width read?", NULL );
-               return JIM_ERR;
-       }
-       if( (addr + (len * width)) < addr ){
-               Jim_SetResult(interp, 
-                                         Jim_NewEmptyStringObj(interp));
-               Jim_AppendStrings( interp, Jim_GetResult(interp),
-                                                  "mem2array: 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),
-                                                  "mem2array: 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, 
-                                "mem2array 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);
-               }
-               
-               retval = target->type->read_memory( target, 
-                                                                                       addr, 
-                                                                                       width, 
-                                                                                       count,
-                                                                                       buffer );
-
-               if( retval != ERROR_OK ){
-                       /* BOO !*/
-                       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 );
-                       e = JIM_ERR;
-                       len = 0;
-               } else {
-                       v = 0; /* shut up gcc */
-                       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;
-                               }
-                               new_int_array_element( interp, varname, n, v );
-                       }
-                       len -= count;
-               }
-       }
-       Jim_SetResult(interp, 
-                                 Jim_NewEmptyStringObj(interp));
-
-       return JIM_OK;
+       return register_commands(cmd_ctx, NULL, openocd_command_handlers);
 }
 
-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. 
+struct command_context *global_cmd_ctx;
 
+/* NB! this fn can be invoked outside this file for non PC hosted builds
+ * NB! do not change to 'static'!!!!
  */
-int jim_command(command_context_t *context, char *line)
+struct command_context *setup_command_handler(Jim_Interp *interp)
 {
-       int retval=ERROR_OK;
-       /* 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!  */
-       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;
-}
+       log_init();
+       LOG_DEBUG("log_init: complete");
 
-static int
-Jim_Command_openocd(Jim_Interp *interp, 
-                                   int argc,
-                                   Jim_Obj *const *argv)
-{
-       return Jim_Command_openocd_ignore(interp, argc, argv, 1); 
-}
+       struct command_context *cmd_ctx = command_init(openocd_startup_tcl, interp);
 
-static int
-Jim_Command_openocd_throw(Jim_Interp *interp, 
-                                   int argc,
-                                   Jim_Obj *const *argv)
-{
-       return Jim_Command_openocd_ignore(interp, argc, argv, 0); 
-}
-  
+       /* register subsystem commands */
+       typedef int (*command_registrant_t)(struct command_context *cmd_ctx_value);
+       static const command_registrant_t command_registrants[] = {
+               &openocd_register_commands,
+               &server_register_commands,
+               &gdb_register_commands,
+               &log_register_commands,
+               &transport_register_commands,
+               &interface_register_commands,
+               &target_register_commands,
+               &flash_register_commands,
+               &nand_register_commands,
+               &pld_register_commands,
+               &mflash_register_commands,
+               NULL
+       };
+       for (unsigned i = 0; NULL != command_registrants[i]; i++) {
+               int retval = (*command_registrants[i])(cmd_ctx);
+               if (ERROR_OK != retval) {
+                       command_done(cmd_ctx);
+                       return NULL;
+               }
+       }
+       LOG_DEBUG("command registration: complete");
 
+       LOG_OUTPUT(OPENOCD_VERSION "\n"
+               "Licensed under GNU GPL v2\n");
 
+       global_cmd_ctx = cmd_ctx;
 
-/* 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;
+       return cmd_ctx;
 }
 
-static int
-Jim_Command_echo(Jim_Interp *interp, 
-                                   int argc,
-                                   Jim_Obj *const *argv)
+/** OpenOCD runtime meat that can become single-thread in future. It parse
+ * commandline, reads configuration, sets up the target and starts server loop.
+ * Commandline arguments are passed into this function from openocd_main().
+ */
+static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
 {
-       if (argc!=2)
-               return JIM_ERR;
-       char *str = (char*)Jim_GetString(argv[1], NULL);
-       LOG_USER("%s", str);
-       return JIM_OK;
-}
+       int ret;
 
-static size_t
-openocd_jim_fwrite( const void *_ptr, size_t size, size_t n, void *cookie )
-{
-       size_t nbytes;
-       const char *ptr;
+       if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
+               return ERROR_FAIL;
 
-       /* make it a char easier to read code */
-       ptr = _ptr;
+       if (server_preinit() != ERROR_OK)
+               return ERROR_FAIL;
 
-       nbytes = size * n;
-       if( nbytes == 0 ){
-               return 0;
-       }
+       ret = parse_config_file(cmd_ctx);
+       if (ret == ERROR_COMMAND_CLOSE_CONNECTION)
+               return ERROR_OK;
+       else if (ret != ERROR_OK)
+               return ERROR_FAIL;
 
-       if( !active_cmd_ctx ){
-               /* FIXME: Where should this go? */              
-               return n;
-       }
+       ret = server_init(cmd_ctx);
+       if (ERROR_OK != ret)
+               return ERROR_FAIL;
 
-       
-       /* do we have to chunk it? */
-       if( ptr[ nbytes ] == 0 ){
-               /* no it is a C style string */
-               command_output_text( active_cmd_ctx, ptr );
-               return;
+       if (init_at_startup) {
+               ret = command_run_line(cmd_ctx, "init");
+               if (ERROR_OK != ret)
+                       return ERROR_FAIL;
        }
-       /* GRR we must chunk - not null terminated */
-       while( nbytes ){
-               char chunk[128+1];
-               int x;
-
-               x = nbytes;
-               if( x > 128 ){
-                       x = 128;
-               }
-               /* copy it */
-               memcpy( chunk, ptr, x );
-               /* terminate it */
-               chunk[n] = 0;
-               /* output it */
-               command_output_text( active_cmd_ctx, chunk );
-               ptr += x;
-               nbytes -= x;
-       }
-       
-       return n;
-}
 
-static size_t
-openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie )
-{
-       /* TCL wants to read... tell him no */
-       return 0;
-}
+       ret = server_loop(cmd_ctx);
 
+       int last_signal = server_quit();
+       if (last_signal != ERROR_OK)
+               return last_signal;
 
-static int
-openocd_jim_vfprintf( void *cookie, const char *fmt, va_list ap )
-{
-       char *cp;
-       int n;
-       
-       n = -1;
-       if( active_cmd_ctx ){
-               cp = alloc_vprintf( fmt, ap );
-               if( cp ){
-                       command_output_text( active_cmd_ctx, cp );
-                       n = strlen(cp);
-                       free(cp);
-               }
-       }
-       return n;
-}
-
-static int
-openocd_jim_fflush( void *cookie )
-{
-       /* nothing to flush */
-       return 0;
-}
-
-static char  *
-openocd_jim_fgets( char *s, int size, void *cookie )
-{
-       /* not supported */
-       errno = ENOTSUP;
-       return NULL;
+       if (ret != ERROR_OK)
+               return ERROR_FAIL;
+       return ERROR_OK;
 }
 
-
-
-void initJim(void)
+/* 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(). */
+int openocd_main(int argc, char *argv[])
 {
-    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);
-    Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
-    Jim_CreateCommand(interp, "mem2array", Jim_Command_mem2array, NULL, NULL );
-
-       /* Set Jim's STDIO */
-       interp->cookie_stdin  = NULL;
-       interp->cookie_stdout = NULL;
-       interp->cookie_stderr = NULL;
-       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;
-}
+       int ret;
 
-int main(int argc, char *argv[])
-{
-       initJim();
-       
        /* 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");
-       register_command(cmd_ctx, NULL, "daemon_startup", handle_daemon_startup_command, COMMAND_CONFIG, 
-                       "deprecated - use \"init\" and \"reset\" at end of startup script instead");
-       
-       /* register subsystem commands */
-       server_register_commands(cmd_ctx);
-       telnet_register_commands(cmd_ctx);
-       gdb_register_commands(cmd_ctx);
-       tcl_register_commands(cmd_ctx); /* tcl server commands */
-       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;
-       LOG_DEBUG("log init complete");
-
-       LOG_OUTPUT( OPENOCD_VERSION "\n" );
-       
-       
-       /* 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 */
-
-       register_command(cmd_ctx, NULL, "init", handle_init_command,
-                                        COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
-
-       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;
+       struct command_context *cmd_ctx;
 
-    Jim_Eval(interp, "source [find tcl/commands.tcl]");
+       cmd_ctx = setup_command_handler(NULL);
 
-       if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
+       if (util_init(cmd_ctx) != ERROR_OK)
                return EXIT_FAILURE;
-       
-       command_done(cfg_cmd_ctx);
 
-       if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
+       if (ioutil_init(cmd_ctx) != ERROR_OK)
                return EXIT_FAILURE;
-       
-       if (daemon_startup)
-               command_run_line(cmd_ctx, "reset");
 
+       LOG_OUTPUT("For bug reports, read\n\t"
+               "http://openocd.sourceforge.net/doc/doxygen/bugs.html"
+               "\n");
 
-       startLoop=1;
+       command_context_mode(cmd_ctx, COMMAND_CONFIG);
+       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 
-       /* handle network connections */
-       server_loop(cmd_ctx);
+       /* Start the executable meat that can evolve into thread in future. */
+       ret = openocd_thread(argc, argv, cmd_ctx);
 
-       /* shut server down */
-       server_quit();
+       unregister_all_commands(cmd_ctx, NULL);
 
-       unregister_all_commands(cmd_ctx);
-       
        /* free commandline interface */
        command_done(cmd_ctx);
 
-       return EXIT_SUCCESS;
-}
-
+       adapter_quit();
 
-/*
- * Local Variables: **
- * tab-width: 4 **
- * c-basic-offset: 4 **
- * End: **
- */
+       if (ERROR_FAIL == ret)
+               return EXIT_FAILURE;
+       else if (ERROR_OK != ret)
+               exit_on_signal(ret);
 
+       return ret;
+}

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)