openocd.c: review scope of symbols
[openocd.git] / src / openocd.c
index 226a7310ad6fd1b3b6f266bd908c2b9861228845..623bd0c1625d0403e2ef294d25fe4ba31993f6b2 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,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 Richard Missenden                                  *
 #include "config.h"
 #endif
 
-#include "log.h"
-#include "types.h"
-#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 "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>
+#include "openocd.h"
+#include <jtag/driver.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/core.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>
-#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 */
-}
+               "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
 
 /* 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)
-{
-       /* close JTAG interface */
-       if (jtag && jtag->quit)
-               jtag->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)
        {
                case TARGET_EVENT_GDB_START:
-                       target->display=0;
+                       target->display = 0;
                        break;
                case TARGET_EVENT_GDB_END:
-                       target->display=1;
+                       target->display = 1;
                        break;
                case TARGET_EVENT_HALTED:
                        if (target->display)
@@ -116,132 +87,173 @@ 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;
-       static int initialized=0;
+       static int initialized = 0;
        if (initialized)
                return ERROR_OK;
 
-       initialized=1;
-
-       atexit(exit_handler);
+       initialized = 1;
 
-       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 = adapter_init(CMD_CTX)) != ERROR_OK)
        {
-               /* we must be able to set up the jtag interface */
+               /* 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("Debug Adapter init complete");
+
+       /* 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 command_context_t *setup_command_handler(void)
+COMMAND_HANDLER(handle_add_script_search_dir_command)
 {
-       command_context_t *cmd_ctx;
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       global_cmd_ctx = cmd_ctx = command_init();
+       add_script_search_dir(CMD_ARGV[0]);
 
-       register_command(cmd_ctx, NULL, "version", handle_version_command,
-                                        COMMAND_EXEC, "show OpenOCD version");
+       return ERROR_OK;
+}
 
-       /* 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)
+static const struct command_registration openocd_command_handlers[] = {
        {
-               exit(-1);
-       }
-       LOG_DEBUG("log init complete");
-
-       LOG_OUTPUT( OPENOCD_VERSION "\n" );
+               .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.",
+
+       },
+       {
+               .name = "add_script_search_dir",
+               .handler = &handle_add_script_search_dir_command,
+               .mode = COMMAND_ANY,
+               .help = "dir to search for config files and scripts",
 
-       register_command(cmd_ctx, NULL, "init", handle_init_command,
-                                        COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
-       return cmd_ctx;
+static int openocd_register_commands(struct command_context *cmd_ctx)
+{
+       return register_commands(cmd_ctx, NULL, openocd_command_handlers);
 }
 
-int httpd_start(void);
-void httpd_stop(void);
-
+struct command_context *global_cmd_ctx;
 
-#if !BUILD_HTTPD
-/* implementations of OpenOCD that uses multithreading needs to know when
- * OpenOCD is sleeping. No-op in vanilla OpenOCD
- */
-void openocd_sleep_prelude(void)
+/* NB! this fn can be invoked outside this file for non PC hosted builds */
+static struct command_context *setup_command_handler(Jim_Interp *interp)
 {
-}
+       log_init();
+       LOG_DEBUG("log_init: complete");
 
-void openocd_sleep_postlude(void)
-{
-}
-#endif
+       const char *startup = openocd_startup_tcl;
+       struct command_context *cmd_ctx = command_init(startup, interp);
+
+       /* register subsystem commands */
+       typedef int (*command_registrant_t)(struct command_context *cmd_ctx);
+       static const command_registrant_t command_registrants[] = {
+               &openocd_register_commands,
+               &server_register_commands,
+               &gdb_register_commands,
+               &log_register_commands,
+               &interface_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++)
+       {
+               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"
+                       "Licensed under GNU GPL v2\n");
+
+       global_cmd_ctx = cmd_ctx;
 
+       return cmd_ctx;
+}
 
 /* normally this is the main() function entry, but if OpenOCD is linked
  * into application, then this fn will not be invoked, but rather that
@@ -251,20 +263,16 @@ 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
-
-       LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
 
-       print_version();
+       LOG_OUTPUT("For bug reports, read\n\t"
+               "http://openocd.berlios.de/doc/doxygen/bugs.html"
+               "\n");
 
        command_context_mode(cmd_ctx, COMMAND_CONFIG);
        command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
@@ -272,37 +280,41 @@ int openocd_main(int argc, char *argv[])
        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) && (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;
+
+       ret = server_init(cmd_ctx);
+       if (ERROR_OK != ret)
                return EXIT_FAILURE;
-#endif
 
-       if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
+       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);
 
+       adapter_quit();
 
-       return EXIT_SUCCESS;
+       return ret;
 }

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)