refactor command registration
[openocd.git] / src / openocd.c
index 8fa40f06a5202aeecb4b12115c4a676ede24f1b1..8e8ceac45eb8ece54df1b877b6438d1ae2e1631f 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 "openocd.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"
 
 
 #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;
 }
@@ -82,7 +66,7 @@ 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 +90,13 @@ 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);
+int ioutil_init(struct command_context *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)
+COMMAND_HANDLER(handle_init_command)
 {
 
-       if (argc != 0)
+       if (CMD_ARGC != 0)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        int retval;
@@ -124,11 +108,11 @@ static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        atexit(exit_handler);
 
-       if (target_init(cmd_ctx) != ERROR_OK)
+       if (target_init(CMD_CTX) != ERROR_OK)
                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;
@@ -137,7 +121,7 @@ static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        /* Try to initialize & examine the JTAG chain at this point, but
         * continue startup regardless */
-       if (jtag_init(cmd_ctx) == ERROR_OK)
+       if (jtag_init(CMD_CTX) == ERROR_OK)
        {
                LOG_DEBUG("jtag init complete");
                if (target_examine() == ERROR_OK)
@@ -146,19 +130,19 @@ static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, cha
                }
        }
 
-       if (flash_init_drivers(cmd_ctx) != ERROR_OK)
+       if (flash_init_drivers(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("flash init complete");
 
-       if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
+       if (mflash_init_drivers(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("mflash init complete");
 
-       if (nand_init(cmd_ctx) != ERROR_OK)
+       if (nand_init(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("NAND init complete");
 
-       if (pld_init(cmd_ctx) != ERROR_OK)
+       if (pld_init(CMD_CTX) != ERROR_OK)
                return ERROR_FAIL;
        LOG_DEBUG("pld init complete");
 
@@ -170,24 +154,28 @@ static int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, cha
        gdb_init();
        tcl_init(); /* allows tcl to just connect without going thru telnet */
 
-       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;
+struct command_context *global_cmd_ctx;
+
+/// src/hello.c gives a simple example for writing new command modules
+int hello_register_commands(struct command_context *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(void)
 {
-       command_context_t *cmd_ctx;
+       struct command_context *cmd_ctx;
 
-       global_cmd_ctx = cmd_ctx = command_init();
+       global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl);
 
        register_command(cmd_ctx, NULL, "version", handle_version_command,
                                         COMMAND_EXEC, "show OpenOCD version");
 
        /* register subsystem commands */
+       hello_register_commands(cmd_ctx);
        server_register_commands(cmd_ctx);
        telnet_register_commands(cmd_ctx);
        gdb_register_commands(cmd_ctx);
@@ -242,7 +230,7 @@ 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();
 
@@ -253,9 +241,10 @@ int openocd_main(int argc, char *argv[])
        }
 #endif
 
-       LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
+       LOG_OUTPUT("For bug reports, read\n\t"
+               "http://openocd.berlios.de/doc/doxygen/bugs.html"
+               "\n");
 
-       print_version();
 
        command_context_mode(cmd_ctx, COMMAND_CONFIG);
        command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
@@ -289,7 +278,7 @@ int openocd_main(int argc, char *argv[])
        httpd_stop();
 #endif
 
-       unregister_all_commands(cmd_ctx);
+       unregister_all_commands(cmd_ctx, NULL);
 
        /* free commandline interface */
        command_done(cmd_ctx);

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)