Remove whitespace that occurs after '('.
[fw/openocd] / src / openocd.c
index ac8e2fea0d1122628544fe3426658555d7f399ba..2e886e34ce3f620f02e5f4cdd3221db356c4e8df 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 (2007-06-14 12:00 CEST)"
-
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include "log.h"
-#include "types.h"
 #include "jtag.h"
 #include "configuration.h"
-#include "interpreter.h"
 #include "xsvf.h"
+#include "svf.h"
 #include "target.h"
 #include "flash.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 " (" PKGBLDDATE ") " RELSTR PKGBLDREV
+
+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 */
-int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
+       if (argc != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
        command_print(cmd_ctx, OPENOCD_VERSION);
 
        return ERROR_OK;
 }
 
-int main(int argc, char *argv[])
+static void exit_handler(void)
 {
-       /* initialize commandline interface */
-       command_context_t *cmd_ctx, *cfg_cmd_ctx;
-       cmd_ctx = command_init();
+       jtag_interface_quit();
+}
+
+static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
+{
+       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_s *cmd_ctx);
+
+/* 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)
+{
+
+       if (argc != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       int retval;
+       static int initialized = 0;
+       if (initialized)
+               return ERROR_OK;
+
+       initialized = 1;
+
+       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() == ERROR_OK)
+               {
+                       LOG_DEBUG("jtag examine complete");
+               }
+       }
+
+       if (flash_init_drivers(cmd_ctx) != ERROR_OK)
+               return ERROR_FAIL;
+       LOG_DEBUG("flash init complete");
+
+       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)
+               return ERROR_FAIL;
+       LOG_DEBUG("pld init complete");
+
+       /* initialize tcp server */
+       server_init();
+
+       /* 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;
+}
+
+command_context_t *global_cmd_ctx;
+
+/* NB! this fn can be invoked outside this file for non PC hosted builds */
+command_context_t *setup_command_handler(void)
+{
+       command_context_t *cmd_ctx;
+
+       global_cmd_ctx = cmd_ctx = command_init();
 
        register_command(cmd_ctx, NULL, "version", handle_version_command,
                                         COMMAND_EXEC, "show OpenOCD version");
-       
+
        /* 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);
-       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;
-       DEBUG("log init complete");
-       
-       INFO( OPENOCD_VERSION );
-
-       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 EXIT_FAILURE;
+       {
+               exit(-1);
+       }
+       LOG_DEBUG("log init complete");
 
-       if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       
-       command_done(cfg_cmd_ctx);
+       LOG_OUTPUT(OPENOCD_VERSION "\n" );
 
-       command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
+       register_command(cmd_ctx, NULL, "init", handle_init_command,
+                                        COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
 
-       if (jtag_init(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-       DEBUG("jtag init complete");
+       return cmd_ctx;
+}
 
-       if (target_init(cmd_ctx) != ERROR_OK)
+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 */
+       command_context_t *cmd_ctx;
+
+       cmd_ctx = setup_command_handler();
+
+#if BUILD_IOUTIL
+       if (ioutil_init(cmd_ctx) != ERROR_OK)
+       {
                return EXIT_FAILURE;
-       DEBUG("target init complete");
+       }
+#endif
+
+       LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
+
+       print_version();
 
-       if (flash_init(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;
-       DEBUG("flash init complete");
 
-       if (nand_init(cmd_ctx) != ERROR_OK)
+       ret = parse_config_file(cmd_ctx);
+       if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
                return EXIT_FAILURE;
-       DEBUG("NAND init complete");
 
-       if (pld_init(cmd_ctx) != ERROR_OK)
+#if BUILD_HTTPD
+       if (httpd_start() != ERROR_OK)
                return EXIT_FAILURE;
-       DEBUG("pld init complete");
+#endif
 
-       /* initialize tcp server */
-       server_init();
-       
-       /* initialize telnet subsystem */
-       telnet_init("Open On-Chip Debugger");
-       gdb_init();
+       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);
+       }
 
-       /* handle network connections */
-       server_loop(cmd_ctx);
-       
        /* shut server down */
        server_quit();
-       
+
+#if BUILD_HTTPD
+       httpd_stop();
+#endif
+
+       unregister_all_commands(cmd_ctx);
+
        /* free commandline interface */
        command_done(cmd_ctx);
-       
+
+
        return EXIT_SUCCESS;
 }