refactor command registration
[openocd.git] / src / openocd.c
index 3c7816eabb4c12a0edb0b4cd517de5ce1a333fd1..8e8ceac45eb8ece54df1b877b6438d1ae2e1631f 100644 (file)
@@ -2,6 +2,12 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜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     *
  *   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 "openocd.h"
 #include "jtag.h"
 #include "configuration.h"
-#include "interpreter.h"
 #include "xsvf.h"
-#include "target.h"
-#include "flash.h"
+#include "svf.h"
 #include "nand.h"
 #include "pld.h"
+#include "mflash.h"
 
-#include "command.h"
 #include "server.h"
 #include "telnet_server.h"
 #include "gdb_server.h"
+#include "tcl_server.h"
 
-#include <sys/time.h>
-#include <sys/types.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 OPENOCD_VERSION \
+               "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
 
 /* 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_HANDLER(handle_version_command)
 {
-       command_print(cmd_ctx, OPENOCD_VERSION);
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       command_print(CMD_CTX, OPENOCD_VERSION);
 
        return ERROR_OK;
 }
 
-static int daemon_startup = 0;
+static void exit_handler(void)
+{
+       jtag_interface_quit();
+}
 
-int handle_daemon_startup_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+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;
 }
 
+int ioutil_init(struct command_context *cmd_ctx);
 
-void exit_handler(void)
+/* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
+COMMAND_HANDLER(handle_init_command)
 {
-       /* close JTAG interface */
-       if (jtag && jtag->quit)
-               jtag->quit();
-}
 
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-/* 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)
-{
-       static int initialized=0;
+       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);
+       initialized = 1;
 
-       /* FIX!!! this should happen *after* target_init(), but
-        * for now there are target initialisations that talk
-        * to JTAG whereas that *should* happen during target_examine()
-        */
-       if (jtag_init(cmd_ctx) != ERROR_OK)
-               return ERROR_FAIL;
-       LOG_DEBUG("jtag init complete");
+       atexit(exit_handler);
 
-       if (target_init(cmd_ctx) != ERROR_OK)
+       if (target_init(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("target init complete");
 
-       if (target_examine(cmd_ctx) != ERROR_OK)
-               return ERROR_FAIL;
-       LOG_DEBUG("target examine complete");
-       
-       if (flash_init_drivers(cmd_ctx) != ERROR_OK)
+       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() == 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)
+       if (mflash_init_drivers(CMD_CTX) != ERROR_OK)
+               return ERROR_FAIL;
+       LOG_DEBUG("mflash init complete");
+
+       if (nand_init(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("NAND init complete");
 
-       if (pld_init(cmd_ctx) != ERROR_OK)
+       if (pld_init(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("pld init complete");
 
@@ -129,95 +152,137 @@ int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
        /* initialize telnet subsystem */
        telnet_init("Open On-Chip Debugger");
        gdb_init();
+       tcl_init(); /* allows tcl to just connect without going thru telnet */
+
+       target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 
        return ERROR_OK;
 }
 
+struct command_context *global_cmd_ctx;
 
-/* implementations of OpenOCD that uses multithreading needs to lock OpenOCD while calling
- * OpenOCD fn's. No-op in vanilla OpenOCD
- */
-void lockBigLock()
-{
-}
-void unlockBigLock()
-{
-}
-
+/// src/hello.c gives a simple example for writing new command modules
+int hello_register_commands(struct command_context *cmd_ctx);
 
-int main(int argc, char *argv[])
+/* NB! this fn can be invoked outside this file for non PC hosted builds */
+struct command_context *setup_command_handler(void)
 {
-       /* initialize commandline interface */
-       command_context_t *cmd_ctx, *cfg_cmd_ctx;
-       cmd_ctx = command_init();
+       struct command_context *cmd_ctx;
+
+       global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl);
 
        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 */
+       hello_register_commands(cmd_ctx);
        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);
+       svf_register_commands(cmd_ctx);
        target_register_commands(cmd_ctx);
        flash_register_commands(cmd_ctx);
        nand_register_commands(cmd_ctx);
        pld_register_commands(cmd_ctx);
-       
+       mflash_register_commands(cmd_ctx);
+
        if (log_init(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
+       {
+               exit(-1);
+       }
        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 */
+
+       LOG_OUTPUT(OPENOCD_VERSION "\n");
 
        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 cmd_ctx;
+}
+
+int httpd_start(void);
+void httpd_stop(void);
+
+
+#if !BUILD_HTTPD && !BUILD_ECOSBOARD
+/* implementations of OpenOCD that uses multithreading needs to know when
+ * OpenOCD is sleeping. No-op in vanilla OpenOCD
+ */
+void openocd_sleep_prelude(void)
+{
+}
+
+void openocd_sleep_postlude(void)
+{
+}
+#endif
+
+
+/* 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[])
+{
+       int ret;
+
+       /* initialize commandline interface */
+       struct command_context *cmd_ctx;
+
+       cmd_ctx = setup_command_handler();
+
+#if BUILD_IOUTIL
+       if (ioutil_init(cmd_ctx) != ERROR_OK)
+       {
                return EXIT_FAILURE;
+       }
+#endif
+
+       LOG_OUTPUT("For bug reports, read\n\t"
+               "http://openocd.berlios.de/doc/doxygen/bugs.html"
+               "\n");
 
-       if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
+
+       command_context_mode(cmd_ctx, COMMAND_CONFIG);
+       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
+
+       if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
                return EXIT_FAILURE;
-       
-       command_done(cfg_cmd_ctx);
 
-       if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
+       ret = parse_config_file(cmd_ctx);
+       if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION))
                return EXIT_FAILURE;
-       
-       if (daemon_startup)
-               command_run_line(cmd_ctx, "reset");
 
-       /* handle network connections */
-       server_loop(cmd_ctx);
+#if BUILD_HTTPD
+       if (httpd_start() != ERROR_OK)
+               return EXIT_FAILURE;
+#endif
+
+       if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
+       {
+               command_context_mode(cmd_ctx, COMMAND_EXEC);
+               if (command_run_line(cmd_ctx, "init") != ERROR_OK)
+                       return EXIT_FAILURE;
+
+               /* handle network connections */
+               server_loop(cmd_ctx);
+       }
 
        /* shut server down */
        server_quit();
 
+#if BUILD_HTTPD
+       httpd_stop();
+#endif
+
+       unregister_all_commands(cmd_ctx, NULL);
+
        /* free commandline interface */
        command_done(cmd_ctx);
 
+
        return EXIT_SUCCESS;
 }
-

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)