armv7m: remove magic numbers for number of core registers
[openocd.git] / src / openocd.c
index b6dc010e5844f3f27a4239ce19d3a7390db62db9..71e047f40e9705224f4f2d409ed8d8b308d89a11 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                                  *
@@ -21,7 +21,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #endif
 
 #include "openocd.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 <xsvf/xsvf.h>
-#include <svf/svf.h>
-#include <flash/flash.h>
-#include <flash/nand.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>
 #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));
 
-static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
+       return JIM_OK;
+}
+
+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;
@@ -74,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);
                        }
@@ -105,7 +113,7 @@ COMMAND_HANDLER(handle_init_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        int retval;
-       static int initialized = 0;
+       static int initialized;
        if (initialized)
                return ERROR_OK;
 
@@ -115,27 +123,29 @@ COMMAND_HANDLER(handle_init_command)
        if (ERROR_OK != retval)
                return ERROR_FAIL;
 
-       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.  Note that platforms
-        * need to be able to provide JTAG event handlers that use
-        * a variety of JTAG operations in order to do that...
+       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 (command_run_line(CMD_CTX, "jtag init") == ERROR_OK)
-       {
-               LOG_DEBUG("Examining targets...");
-               if (target_examine() != ERROR_OK)
-                       LOG_DEBUG("target examination failed");
-       }
-       else
-               LOG_WARNING("jtag initialization failed; try 'jtag init' again.");
+
+       retval = command_run_line(CMD_CTX, "transport init");
+       if (ERROR_OK != retval)
+               return ERROR_FAIL;
+
+       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)
@@ -159,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",
        },
@@ -171,6 +191,7 @@ 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",
@@ -180,19 +201,28 @@ static const struct command_registration openocd_command_handlers[] = {
                        "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
 };
 
-int openocd_register_commands(struct command_context *cmd_ctx)
+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();
@@ -202,15 +232,14 @@ struct command_context *setup_command_handler(Jim_Interp *interp)
        struct command_context *cmd_ctx = command_init(startup, interp);
 
        /* register subsystem commands */
-       typedef int (*command_registrant_t)(struct command_context *cmd_ctx);
-       command_registrant_t command_registrants[] = {
+       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,
-               &jtag_register_commands,
-               &xsvf_register_commands,
-               &svf_register_commands,
+               &transport_register_commands,
+               &interface_register_commands,
                &target_register_commands,
                &flash_register_commands,
                &nand_register_commands,
@@ -218,82 +247,92 @@ struct command_context *setup_command_handler(Jim_Interp *interp)
                &mflash_register_commands,
                NULL
        };
-       for (unsigned i = 0; NULL != command_registrants[i]; i++)
-       {
+       for (unsigned i = 0; NULL != command_registrants[i]; i++) {
                int retval = (*command_registrants[i])(cmd_ctx);
-               if (ERROR_OK != retval)
-               {
+               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;
 }
 
-/* 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[])
+/** 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().
+ */
+static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
 {
        int ret;
 
-       /* initialize commandline interface */
-       struct command_context *cmd_ctx;
-
-       cmd_ctx = setup_command_handler(NULL);
-
-       if (ioutil_init(cmd_ctx) != ERROR_OK)
+       if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
                return EXIT_FAILURE;
 
-       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);
-
-       if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
+       if (server_preinit() != ERROR_OK)
                return EXIT_FAILURE;
 
        ret = parse_config_file(cmd_ctx);
        if (ret != ERROR_OK)
                return EXIT_FAILURE;
 
-       if (httpd_start(cmd_ctx) != ERROR_OK)
-               return EXIT_FAILURE;
-
        ret = server_init(cmd_ctx);
        if (ERROR_OK != ret)
                return EXIT_FAILURE;
 
-       if (init_at_startup)
-       {
+       if (init_at_startup) {
                ret = command_run_line(cmd_ctx, "init");
                if (ERROR_OK != ret)
-                       ret = EXIT_FAILURE;
+                       return EXIT_FAILURE;
        }
 
-       /* handle network connections */
-       if (ERROR_OK == ret)
-               server_loop(cmd_ctx);
+       server_loop(cmd_ctx);
 
        server_quit();
 
-       httpd_stop();
+       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
+ * 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(NULL);
+
+       if (util_init(cmd_ctx) != ERROR_OK)
+               return EXIT_FAILURE;
+
+       if (ioutil_init(cmd_ctx) != ERROR_OK)
+               return EXIT_FAILURE;
+
+       LOG_OUTPUT("For bug reports, read\n\t"
+               "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);
+
+       /* 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;
 }

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)