tcl config script example
[openocd.git] / src / openocd.c
index fac385a1f11b6fbf3126428e8826abc5a9f8cf4b..e24eb9a7cd717aee536eedc416886c0e26783726 100644 (file)
 #include <unistd.h>
 #include <errno.h>
 
+#define JIM_EMBEDDED
+#include "jim.h"
+
+
 /* 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)
 {
@@ -57,6 +61,23 @@ int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **
        return ERROR_OK;
 }
 
+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;
+}
+
+
 void exit_handler(void)
 {
        /* close JTAG interface */
@@ -64,15 +85,259 @@ void exit_handler(void)
                jtag->quit();
 }
 
+
+/* 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)
+{
+       int retval;
+       static int initialized=0;
+       if (initialized)
+               return ERROR_OK;
+       
+       initialized=1;
+       
+       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
+
+       atexit(exit_handler);
+
+       
+       if (target_init(cmd_ctx) != ERROR_OK)
+               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 */
+               return retval;
+       }
+       LOG_DEBUG("jtag interface init complete");
+
+       /* Try to initialize & examine the JTAG chain at this point, but
+        * continue startup regardless
+        */
+       if (jtag_init(cmd_ctx) == ERROR_OK)
+       {
+               LOG_DEBUG("jtag init complete");
+               if (target_examine(cmd_ctx) == ERROR_OK)
+               {
+                       LOG_DEBUG("jtag examine complete");
+               }
+       }
+
+       
+       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();
+
+       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()
+{
+}
+
+
+
+
+
+Jim_Interp *interp;
+command_context_t *active_cmd_ctx;
+
+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. 
+
+ */
+int jim_command(command_context_t *context, char *line)
+{
+       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;
+}
+
+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);
+       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;
+}
+
+
+void initJim(void)
+{
+    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);
+}
+
 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);
@@ -88,10 +353,25 @@ int main(int argc, char *argv[])
        
        if (log_init(cmd_ctx) != ERROR_OK)
                return EXIT_FAILURE;
-       DEBUG("log init complete");
+       LOG_DEBUG("log init complete");
+
+       LOG_OUTPUT( OPENOCD_VERSION "\n" );
+       
        
-       OUTPUT( OPENOCD_VERSION "\n" );
-       OUTPUT( "$URL$\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;
@@ -100,46 +380,21 @@ int main(int argc, char *argv[])
        if (parse_cmdline_args(cfg_cmd_ctx, argc, argv) != ERROR_OK)
                return EXIT_FAILURE;
 
+    Jim_Eval(interp, "source [find tcl/commands.tcl]");
+
        if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
                return EXIT_FAILURE;
        
        command_done(cfg_cmd_ctx);
 
-       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
-
-       atexit(exit_handler);
-
-       if (jtag_init(cmd_ctx) != ERROR_OK)
+       if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
                return EXIT_FAILURE;
-       DEBUG("jtag init complete");
-
-       if (target_init(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       DEBUG("target init complete");
-
-       if (flash_init_drivers(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       DEBUG("flash init complete");
-
-       if (nand_init(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       DEBUG("NAND init complete");
-
-       if (pld_init(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       DEBUG("pld init complete");
-
-       /* initialize tcp server */
-       server_init();
+       
+       if (daemon_startup)
+               command_run_line(cmd_ctx, "reset");
 
-       /* initialize telnet subsystem */
-       telnet_init("Open On-Chip Debugger");
-       gdb_init();
 
-       /* call any target resets */
-       if (target_init_reset(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       DEBUG("target init reset complete");
+       startLoop=1;
 
        /* handle network connections */
        server_loop(cmd_ctx);
@@ -147,6 +402,8 @@ int main(int argc, char *argv[])
        /* shut server down */
        server_quit();
 
+       unregister_all_commands(cmd_ctx);
+       
        /* free commandline interface */
        command_done(cmd_ctx);
 

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)