jtag/adapter: add connect_[de]assert_srst to reset_config usage
[openocd.git] / src / openocd.c
index ff35f87..048ce85 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 Richard Missenden                                  *
 #endif
 
 #include "openocd.h"
-#include "jtag.h"
-#include "configuration.h"
-#include "xsvf.h"
-#include "svf.h"
-#include "nand.h"
-#include "pld.h"
-#include "mflash.h"
-
-#include "server.h"
-#include "gdb_server.h"
-#include "httpd.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>
 #endif
 
+#define OPENOCD_VERSION        \
+       "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
 
-#define OPENOCD_VERSION \
-               "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
-
-/* Give TELNET a way to find out what version this is */
-COMMAND_HANDLER(handle_version_command)
+/* 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)
 {
-       if (CMD_ARGC != 0)
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       if (argc > 2)
+               return JIM_ERR;
+       const char *str = "";
+       char *version_str;
+       version_str = OPENOCD_VERSION;
 
-       command_print(CMD_CTX, OPENOCD_VERSION);
+       if (argc == 2)
+               str = Jim_GetString(argv[1], NULL);
 
-       return ERROR_OK;
-}
+       if (strcmp("git", str) == 0)
+               version_str = GITVERSION;
+
+       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)
+static int log_target_callback_event_handler(struct target *target,
+       enum target_event event,
+       void *priv)
 {
-       switch (event)
-       {
+       switch (event) {
                case TARGET_EVENT_GDB_START:
                        target->display = 0;
                        break;
@@ -72,8 +83,7 @@ static int log_target_callback_event_handler(struct target *target, enum target_
                        target->display = 1;
                        break;
                case TARGET_EVENT_HALTED:
-                       if (target->display)
-                       {
+                       if (target->display) {
                                /* do not display information when debugger caused the halt */
                                target_arch_state(target);
                        }
@@ -85,8 +95,6 @@ static int log_target_callback_event_handler(struct target *target, enum target_
        return ERROR_OK;
 }
 
-int ioutil_init(struct command_context *cmd_ctx);
-
 static bool init_at_startup = true;
 
 COMMAND_HANDLER(handle_noinit_command)
@@ -105,41 +113,44 @@ COMMAND_HANDLER(handle_init_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        int retval;
-       static int initialized = 0;
+       static int initialized;
        if (initialized)
                return ERROR_OK;
 
        initialized = 1;
 
-       command_context_mode(CMD_CTX, COMMAND_EXEC);
-
-       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 */
-       if (jtag_init(CMD_CTX) == ERROR_OK)
-       {
-               LOG_DEBUG("jtag init complete");
-               if (target_examine() == ERROR_OK)
-               {
-                       LOG_DEBUG("jtag examine complete");
-               }
-       }
+       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)
+        */
+       command_context_mode(CMD_CTX, COMMAND_EXEC);
 
-       if (flash_init_drivers(CMD_CTX) != ERROR_OK)
+       retval = command_run_line(CMD_CTX, "transport init");
+       if (ERROR_OK != retval)
                return ERROR_FAIL;
-       LOG_DEBUG("flash init complete");
+
+       LOG_DEBUG("Examining targets...");
+       if (target_examine() != ERROR_OK)
+               LOG_DEBUG("target examination failed");
 
        command_context_mode(CMD_CTX, COMMAND_CONFIG);
+
+       if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
+               return ERROR_FAIL;
+
        if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
                return ERROR_FAIL;
 
@@ -158,10 +169,20 @@ COMMAND_HANDLER(handle_init_command)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(handle_add_script_search_dir_command)
+{
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       add_script_search_dir(CMD_ARGV[0]);
+
+       return ERROR_OK;
+}
+
 static const struct command_registration openocd_command_handlers[] = {
        {
                .name = "version",
-               .handler = &handle_version_command,
+               .jim_handler = jim_version_command,
                .mode = COMMAND_ANY,
                .help = "show program version",
        },
@@ -170,66 +191,113 @@ static const struct command_registration openocd_command_handlers[] = {
                .handler = &handle_noinit_command,
                .mode = COMMAND_CONFIG,
                .help = "Prevent 'init' from being called at startup.",
+               .usage = ""
        },
        {
                .name = "init",
                .handler = &handle_init_command,
-               .mode = COMMAND_CONFIG,
+               .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)
+{
+       return register_commands(cmd_ctx, NULL, openocd_command_handlers);
+}
+
 struct command_context *global_cmd_ctx;
 
-/* NB! this fn can be invoked outside this file for non PC hosted builds */
+/* NB! this fn can be invoked outside this file for non PC hosted builds
+ * NB! do not change to 'static'!!!!
+ */
 struct command_context *setup_command_handler(Jim_Interp *interp)
 {
        log_init();
        LOG_DEBUG("log_init: complete");
 
-       struct command_context *cmd_ctx;
-
-       global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl, interp);
+       const char *startup = openocd_startup_tcl;
+       struct command_context *cmd_ctx = command_init(startup, interp);
 
-       register_commands(cmd_ctx, NULL, openocd_command_handlers);
        /* register subsystem commands */
-       server_register_commands(cmd_ctx);
-       gdb_register_commands(cmd_ctx);
-       log_register_commands(cmd_ctx);
-       jtag_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);
-
+       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");
+       LOG_OUTPUT(OPENOCD_VERSION "\n"
+               "Licensed under GNU GPL v2\n");
+
+       global_cmd_ctx = cmd_ctx;
 
        return cmd_ctx;
 }
 
-#if !BUILD_HTTPD && !BUILD_ECOSBOARD
-/* implementations of OpenOCD that uses multithreading needs to know when
- * OpenOCD is sleeping. No-op in vanilla OpenOCD
+/** 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().
  */
-void openocd_sleep_prelude(void)
+static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
 {
-}
+       int ret;
 
-void openocd_sleep_postlude(void)
-{
-}
-#endif
+       if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
+               return EXIT_FAILURE;
 
+       if (server_preinit() != ERROR_OK)
+               return EXIT_FAILURE;
+
+       ret = parse_config_file(cmd_ctx);
+       if (ret != ERROR_OK)
+               return EXIT_FAILURE;
+
+       ret = server_init(cmd_ctx);
+       if (ERROR_OK != ret)
+               return EXIT_FAILURE;
+
+       if (init_at_startup) {
+               ret = command_run_line(cmd_ctx, "init");
+               if (ERROR_OK != ret)
+                       return EXIT_FAILURE;
+       }
+
+       server_loop(cmd_ctx);
+
+       server_quit();
+
+       return ret;
+}
 
 /* normally this is the main() function entry, but if OpenOCD is linked
  * into application, then this fn will not be invoked, but rather that
@@ -243,60 +311,28 @@ int openocd_main(int argc, char *argv[])
 
        cmd_ctx = setup_command_handler(NULL);
 
-#if BUILD_IOUTIL
+       if (util_init(cmd_ctx) != ERROR_OK)
+               return EXIT_FAILURE;
+
        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"
+               "http://openocd.sourceforge.net/doc/doxygen/bugs.html"
                "\n");
 
-
        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;
-
-       ret = parse_config_file(cmd_ctx);
-       if (ret != ERROR_OK)
-               return EXIT_FAILURE;
-
-#if BUILD_HTTPD
-       if (httpd_start(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-#endif
-
-       ret = server_init(cmd_ctx);
-       if (ERROR_OK != ret)
-               return EXIT_FAILURE;
-
-       if (init_at_startup)
-       {
-               ret = command_run_line(cmd_ctx, "init");
-               if (ERROR_OK != ret)
-                       ret = EXIT_FAILURE;
-       }
-
-       /* handle network connections */
-       if (ERROR_OK == ret)
-               server_loop(cmd_ctx);
-
-       server_quit();
-
-#if BUILD_HTTPD
-       httpd_stop();
-#endif
+       /* Start the executable meat that can evolve into thread in future. */
+       ret = openocd_thread(argc, argv, cmd_ctx);
 
        unregister_all_commands(cmd_ctx, NULL);
 
        /* free commandline interface */
        command_done(cmd_ctx);
 
-       jtag_interface_quit();
+       adapter_quit();
 
        return ret;
 }