Charles Hardin ckhardin at gmail.com
[fw/openocd] / src / openocd.c
index 793dbbc6813f4a8f40af04ec75f15292a30ee125..a3b0fe181eed2c088f85cc73fff8307f11a6927f 100644 (file)
@@ -28,7 +28,6 @@
 #include "types.h"
 #include "jtag.h"
 #include "configuration.h"
-#include "interpreter.h"
 #include "xsvf.h"
 #include "target.h"
 #include "flash.h"
 
 #include "replacements.h"
 
-int launchTarget(struct command_context_s *cmd_ctx)
-{
-       int retval;
-       /* Try to examine & validate jtag chain, though this may require a reset first
-        * in which case we continue setup */
-       jtag_init(cmd_ctx);
-
-       /* try to examine target at this point. If it fails, perhaps a reset will
-        * bring it up later on via a telnet/gdb session */
-       target_examine(cmd_ctx);
-
-       retval=flash_init_drivers(cmd_ctx);
-       if (retval!=ERROR_OK)
-               return retval;
-       LOG_DEBUG("flash init complete");
-
-       retval=nand_init(cmd_ctx);
-       if (retval!=ERROR_OK)
-               return retval;
-       LOG_DEBUG("NAND init complete");
-
-       retval=pld_init(cmd_ctx);
-       if (retval!=ERROR_OK)
-               return retval;
-       LOG_DEBUG("pld init complete");
-       return retval;
-}
 
 /* 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)
@@ -135,8 +107,6 @@ int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
        
        initialized=1;
        
-       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
-
        atexit(exit_handler);
        
        if (target_init(cmd_ctx) != ERROR_OK)
@@ -194,16 +164,24 @@ static int new_int_array_element(Jim_Interp * interp, const char *varname, int i
        int result;
 
        namebuf = alloc_printf("%s(%d)", varname, idx);
+       if (!namebuf)
+               return JIM_ERR;
        
        nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
        valObjPtr = Jim_NewIntObj(interp, val);
+       if (!nameObjPtr || !valObjPtr)
+       {
+               free(namebuf);
+               return JIM_ERR;
+       }
+
        Jim_IncrRefCount(nameObjPtr);
        Jim_IncrRefCount(valObjPtr);
        result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
        Jim_DecrRefCount(interp, nameObjPtr);
        Jim_DecrRefCount(interp, valObjPtr);
        free(namebuf);
-       /* printf( "%s = 0%08x\n", namebuf, val ); */
+       /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
        return result;
 }
 
@@ -223,7 +201,7 @@ static int Jim_Command_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *a
        /* argv[1] = name of array to receive the data
         * argv[2] = desired width
         * argv[3] = memory address 
-        * argv[4] = length in bytes to read
+        * argv[4] = count of times to read
         */
        if (argc != 5) {
                Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
@@ -309,7 +287,6 @@ static int Jim_Command_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *a
                }
                
                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);
@@ -342,44 +319,204 @@ static int Jim_Command_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *a
        return JIM_OK;
 }
 
-static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
-{              
-       Jim_Obj *tclOutput=(Jim_Obj *)privData;
+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_AppendString(interp, tclOutput, string, strlen(string));
+       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;
+}
+
+
+static int openocd_retval; 
+
 /* 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. */
 int jim_command(command_context_t *context, char *line)
 {
        int retval=ERROR_OK;
-       int retcode=Jim_Eval(interp, line);
+       int retcode;
+
+       active_cmd_ctx = context;
+       openocd_retval=ERROR_OK;
+       retcode = Jim_Eval(interp, line);
        
+       if (retcode == JIM_ERR) {
+               if (openocd_retval!=ERROR_COMMAND_CLOSE_CONNECTION)
+               {
+                       /* We do not print the connection closed error message */
+                       Jim_PrintErrorMessage(interp);
+               }
+               if (openocd_retval==ERROR_OK)
+               {
+                       /* It wasn't a low level OpenOCD command that failed */
+                       return ERROR_FAIL; 
+               }
+           return openocd_retval;
+       } 
        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) {
+       if (retcode == JIM_EXIT) {
                /* ignore. */
        /* exit(Jim_GetExitCode(interp)); */
        } else {
@@ -392,7 +529,7 @@ int jim_command(command_context_t *context, char *line)
                                chunk = reslen - i;
                                if (chunk > 256)
                                        chunk = 256;
-                               strncpy(buff, result, chunk);
+                       strncpy(buff, result+i, chunk);
                                buff[chunk] = 0; 
                                LOG_USER_N("%s", buff);
                        }
@@ -402,51 +539,12 @@ int jim_command(command_context_t *context, char *line)
        return retval;
 }
 
-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);
-       
-       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);
-       
-       return (ignore||(retval==ERROR_OK))?JIM_OK:JIM_ERR;
-}
-
-static int Jim_Command_openocd(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       return Jim_Command_openocd_ignore(interp, argc, argv, 1); 
-}
-
-static int Jim_Command_openocd_throw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       return Jim_Command_openocd_ignore(interp, argc, argv, 0); 
-}
-
 /* find full path to file */
 static int Jim_Command_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        if (argc != 2)
                return JIM_ERR;
-       char *file = (char*)Jim_GetString(argv[1], NULL);
+       const char *file = Jim_GetString(argv[1], NULL);
        char *full_path = find_file(file);
        if (full_path == NULL)
                return JIM_ERR;
@@ -466,6 +564,8 @@ static int Jim_Command_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return JIM_OK;
 }
 
+
+
 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
 {
        size_t nbytes;
@@ -548,14 +648,35 @@ static char* openocd_jim_fgets(char *s, int size, void *cookie)
        return NULL;
 }
 
-void initJim(void)
+void add_jim(const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
 {
-       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, name, cmd, NULL, NULL);
+       
+       /* 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);
+    if (Jim_IsShared(helptext))
+        helptext = Jim_DuplicateObj(interp, helptext);
+    
+       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);
+}
+
+extern unsigned const char startup_tcl[];
+
+void initJim(void)
+{      
+       Jim_CreateCommand(interp, "openocd_find", Jim_Command_find, NULL, NULL);
        Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
        Jim_CreateCommand(interp, "mem2array", Jim_Command_mem2array, NULL, NULL );
-       
+       Jim_CreateCommand(interp, "array2mem", Jim_Command_array2mem, NULL, NULL );
+
        /* Set Jim's STDIO */
        interp->cookie_stdin = NULL;
        interp->cookie_stdout = NULL;
@@ -565,12 +686,15 @@ void initJim(void)
        interp->cb_vfprintf = openocd_jim_vfprintf;
        interp->cb_fflush = openocd_jim_fflush;
        interp->cb_fgets = openocd_jim_fgets;
-}
-
-/* after command line parsing */
-void initJim2(void)
-{
-       Jim_Eval(interp, "source [find tcl/commands.tcl]");
+       
+       add_default_dirs();
+       
+       if (Jim_Eval(interp, startup_tcl)==JIM_ERR)
+       {
+               LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
+               Jim_PrintErrorMessage(interp);
+               exit(-1);
+       }
 }
 
 command_context_t *setup_command_handler(void)
@@ -578,7 +702,7 @@ command_context_t *setup_command_handler(void)
        command_context_t *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, 
@@ -591,7 +715,6 @@ command_context_t *setup_command_handler(void)
        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);
@@ -607,18 +730,6 @@ command_context_t *setup_command_handler(void)
        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");
 
@@ -644,33 +755,34 @@ int openocd_main(int argc, char *argv[])
        command_context_t *cmd_ctx;
        cmd_ctx=setup_command_handler();
        
-       command_context_t *cfg_cmd_ctx;
-       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);
-       
-       active_cmd_ctx=cfg_cmd_ctx;
-       
-       if (parse_cmdline_args(cfg_cmd_ctx, argc, argv) != ERROR_OK)
-               return EXIT_FAILURE;
+       /* 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 */
 
-       initJim2();
+       command_context_mode(cmd_ctx, COMMAND_CONFIG);
+       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 
-       if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
+       if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
                return EXIT_FAILURE;
        
-       active_cmd_ctx=cmd_ctx;
-       
-       command_done(cfg_cmd_ctx);
+       if (parse_config_file(cmd_ctx) != ERROR_OK)
+               return EXIT_FAILURE;
 
+       command_context_mode(cmd_ctx, COMMAND_EXEC);
        if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
                return EXIT_FAILURE;
        
        if (daemon_startup)
                command_run_line(cmd_ctx, "reset");
        
-       startLoop=1;
-
        /* handle network connections */
        server_loop(cmd_ctx);