remove flash.h from tree
[fw/openocd] / src / openocd.c
index 7384065aff0463229700bc7ba00f291030174bda..e500ba6081a9182dbea9d91127e77ea28411e8f3 100644 (file)
 #include "config.h"
 #endif
 
-#include "jtag.h"
-#include "configuration.h"
-#include "xsvf.h"
-#include "svf.h"
-#include "target.h"
-#include "flash.h"
-#include "nand.h"
-#include "pld.h"
-#include "mflash.h"
-
-#include "server.h"
-#include "telnet_server.h"
-#include "gdb_server.h"
-#include "tcl_server.h"
+#include "openocd.h"
+#include <jtag/jtag.h>
+#include <helper/ioutil.h>
+#include <helper/configuration.h>
+#include <xsvf/xsvf.h>
+#include <svf/svf.h>
+#include <flash/nor/core.h>
+#include <flash/nand.h>
+#include <pld/pld.h>
+#include <flash/mflash.h>
+
+#include <server/server.h>
+#include <server/gdb_server.h>
+#include <server/httpd.h>
 
 #ifdef HAVE_STRINGS_H
 #include <strings.h>
 #define OPENOCD_VERSION \
                "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
 
-static void print_version(void)
-{
-       /* 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 */
-}
-
 /* Give TELNET a way to find out what version this is */
-static int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_version_command)
 {
-       if (argc != 0)
+       if (CMD_ARGC != 0)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       command_print(cmd_ctx, OPENOCD_VERSION);
+       command_print(CMD_CTX, OPENOCD_VERSION);
 
        return ERROR_OK;
 }
 
-static void exit_handler(void)
-{
-       jtag_interface_quit();
-}
 
-static int log_target_callback_event_handler(struct target_s *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)
        {
@@ -106,13 +87,21 @@ static int log_target_callback_event_handler(struct target_s *target, enum targe
        return ERROR_OK;
 }
 
-int ioutil_init(struct command_context_s *cmd_ctx);
+static bool init_at_startup = true;
+
+COMMAND_HANDLER(handle_noinit_command)
+{
+       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! :-) */
-static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_init_command)
 {
 
-       if (argc != 0)
+       if (CMD_ARGC != 0)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        int retval;
@@ -122,118 +111,131 @@ static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        initialized = 1;
 
-       atexit(exit_handler);
-
-       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)
+       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)
+       /* Try to initialize & examine the JTAG chain at this point,
+        * but continue startup regardless.  Note that platforms
+        * need to be able to provide JTAG event handlers that use
+        * a variety of JTAG operations in order to do that...
+        */
+       command_context_mode(CMD_CTX, COMMAND_EXEC);
+       if (command_run_line(CMD_CTX, "jtag init") == ERROR_OK)
        {
-               LOG_DEBUG("jtag init complete");
-               if (target_examine() == ERROR_OK)
-               {
-                       LOG_DEBUG("jtag examine complete");
-               }
+               LOG_DEBUG("Examining targets...");
+               if (target_examine() != ERROR_OK)
+                       LOG_DEBUG("target examination failed");
        }
+       else
+               LOG_WARNING("jtag initialization failed; try 'jtag init' again.");
+       command_context_mode(CMD_CTX, COMMAND_CONFIG);
 
-       if (flash_init_drivers(cmd_ctx) != ERROR_OK)
+       if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("flash init complete");
 
-       if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
+       if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("mflash init complete");
 
-       if (nand_init(cmd_ctx) != ERROR_OK)
+       if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("NAND init complete");
 
-       if (pld_init(cmd_ctx) != ERROR_OK)
+       if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
                return ERROR_FAIL;
-       LOG_DEBUG("pld init complete");
-
-       /* initialize tcp server */
-       server_init();
+       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);
+       target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 
        return ERROR_OK;
 }
 
-command_context_t *global_cmd_ctx;
+static const struct command_registration openocd_command_handlers[] = {
+       {
+               .name = "version",
+               .handler = &handle_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.",
+       },
+       {
+               .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.",
+
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+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 */
-command_context_t *setup_command_handler(void)
+struct command_context *setup_command_handler(Jim_Interp *interp)
 {
-       command_context_t *cmd_ctx;
+       log_init();
+       LOG_DEBUG("log_init: complete");
 
-       global_cmd_ctx = cmd_ctx = command_init();
-
-       register_command(cmd_ctx, NULL, "version", handle_version_command,
-                                        COMMAND_EXEC, "show OpenOCD version");
+       const char *startup = openocd_startup_tcl;
+       struct command_context *cmd_ctx = command_init(startup, interp);
 
        /* 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);
-       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)
+       typedef int (*command_registrant_t)(struct command_context *cmd_ctx);
+       command_registrant_t command_registrants[] = {
+               &openocd_register_commands,
+               &server_register_commands,
+               &gdb_register_commands,
+               &log_register_commands,
+               &jtag_register_commands,
+               &xsvf_register_commands,
+               &svf_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++)
        {
-               exit(-1);
+               int retval = (*command_registrants[i])(cmd_ctx);
+               if (ERROR_OK != retval)
+               {
+                       command_done(cmd_ctx);
+                       return NULL;
+               }
        }
-       LOG_DEBUG("log init complete");
+       LOG_DEBUG("command registration: complete");
 
        LOG_OUTPUT(OPENOCD_VERSION "\n");
 
-       register_command(cmd_ctx, NULL, "init", handle_init_command,
-                                        COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
+       global_cmd_ctx = cmd_ctx;
 
        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(). */
@@ -242,18 +244,12 @@ int openocd_main(int argc, char *argv[])
        int ret;
 
        /* initialize commandline interface */
-       command_context_t *cmd_ctx;
+       struct command_context *cmd_ctx;
 
-       cmd_ctx = setup_command_handler();
+       cmd_ctx = setup_command_handler(NULL);
 
-#if BUILD_IOUTIL
        if (ioutil_init(cmd_ctx) != ERROR_OK)
-       {
                return EXIT_FAILURE;
-       }
-#endif
-
-       print_version();
 
        LOG_OUTPUT("For bug reports, read\n\t"
                "http://openocd.berlios.de/doc/doxygen/bugs.html"
@@ -267,36 +263,37 @@ int openocd_main(int argc, char *argv[])
                return EXIT_FAILURE;
 
        ret = parse_config_file(cmd_ctx);
-       if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION))
+       if (ret != ERROR_OK)
                return EXIT_FAILURE;
 
-#if BUILD_HTTPD
-       if (httpd_start() != ERROR_OK)
+       if (httpd_start(cmd_ctx) != ERROR_OK)
                return EXIT_FAILURE;
-#endif
 
-       if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
+       ret = server_init(cmd_ctx);
+       if (ERROR_OK != ret)
+               return EXIT_FAILURE;
+
+       if (init_at_startup)
        {
-               command_context_mode(cmd_ctx, COMMAND_EXEC);
-               if (command_run_line(cmd_ctx, "init") != ERROR_OK)
-                       return EXIT_FAILURE;
+               ret = command_run_line(cmd_ctx, "init");
+               if (ERROR_OK != ret)
+                       ret = EXIT_FAILURE;
+       }
 
-               /* handle network connections */
+       /* handle network connections */
+       if (ERROR_OK == ret)
                server_loop(cmd_ctx);
-       }
 
-       /* shut server down */
        server_quit();
 
-#if BUILD_HTTPD
        httpd_stop();
-#endif
 
-       unregister_all_commands(cmd_ctx);
+       unregister_all_commands(cmd_ctx, NULL);
 
        /* free commandline interface */
        command_done(cmd_ctx);
 
+       jtag_interface_quit();
 
-       return EXIT_SUCCESS;
+       return ret;
 }