X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fopenocd.c;h=048ce8524809e319579a68f163cec12bdb829b0e;hp=8c99af07c475591805d291abca20cb157bf7ea59;hb=5914310f88161967cd1759e536f8069b9b15bdde;hpb=0f1163e823c6ca3c2a81fa296157f5dde0635fea diff --git a/src/openocd.c b/src/openocd.c index 8c99af07c4..048ce85248 100644 --- a/src/openocd.c +++ b/src/openocd.c @@ -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 * @@ -28,64 +28,54 @@ #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 +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include #ifdef HAVE_STRINGS_H #include #endif +#define OPENOCD_VERSION \ + "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")" -#define OPENOCD_VERSION \ - "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")" - -static void print_version(void) +/* 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) { - /* 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 */ -} + if (argc > 2) + return JIM_ERR; + const char *str = ""; + char *version_str; + version_str = OPENOCD_VERSION; -/* Give TELNET a way to find out what version this is */ -COMMAND_HANDLER(handle_version_command) -{ - if (argc != 0) - return ERROR_COMMAND_SYNTAX_ERROR; + if (argc == 2) + str = Jim_GetString(argv[1], NULL); - command_print(cmd_ctx, OPENOCD_VERSION); + if (strcmp("git", str) == 0) + version_str = GITVERSION; - return ERROR_OK; -} + Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1)); -static void exit_handler(void) -{ - jtag_interface_quit(); + return JIM_OK; } -static int log_target_callback_event_handler(struct target *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) - { + switch (event) { case TARGET_EVENT_GDB_START: target->display = 0; break; @@ -93,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); } @@ -106,137 +95,209 @@ static int log_target_callback_event_handler(struct target *target, enum target_ 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! :-) */ 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; if (initialized) return ERROR_OK; 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) - { - /* 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 */ - if (jtag_init(cmd_ctx) == ERROR_OK) - { - LOG_DEBUG("jtag init complete"); - if (target_examine() == ERROR_OK) - { - LOG_DEBUG("jtag examine complete"); - } - } + 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 (flash_init_drivers(cmd_ctx) != ERROR_OK) + retval = command_run_line(CMD_CTX, "transport init"); + if (ERROR_OK != retval) return ERROR_FAIL; - LOG_DEBUG("flash init complete"); - if (mflash_init_drivers(cmd_ctx) != ERROR_OK) + 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) return ERROR_FAIL; - LOG_DEBUG("mflash init complete"); - if (nand_init(cmd_ctx) != ERROR_OK) + if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK) return ERROR_FAIL; - LOG_DEBUG("NAND init complete"); - if (pld_init(cmd_ctx) != ERROR_OK) + if (command_run_line(CMD_CTX, "nand init") != ERROR_OK) return ERROR_FAIL; - LOG_DEBUG("pld init complete"); - /* initialize tcp server */ - server_init(); + if (command_run_line(CMD_CTX, "pld init") != ERROR_OK) + return ERROR_FAIL; + 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; +COMMAND_HANDLER(handle_add_script_search_dir_command) +{ + if (CMD_ARGC != 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + add_script_search_dir(CMD_ARGV[0]); -/// src/hello.c gives a simple example for writing new command modules -int hello_register_commands(struct command_context_s *cmd_ctx); + return ERROR_OK; +} -/* NB! this fn can be invoked outside this file for non PC hosted builds */ -command_context_t *setup_command_handler(void) +static const struct command_registration openocd_command_handlers[] = { + { + .name = "version", + .jim_handler = jim_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.", + .usage = "" + }, + { + .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.", + .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 = "" + }, + COMMAND_REGISTRATION_DONE +}; + +static int openocd_register_commands(struct command_context *cmd_ctx) { - command_context_t *cmd_ctx; + return register_commands(cmd_ctx, NULL, openocd_command_handlers); +} - global_cmd_ctx = cmd_ctx = command_init(); +struct command_context *global_cmd_ctx; - register_command(cmd_ctx, NULL, "version", handle_version_command, - COMMAND_EXEC, "show OpenOCD version"); +/* 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(); + LOG_DEBUG("log_init: complete"); + + const char *startup = openocd_startup_tcl; + struct command_context *cmd_ctx = command_init(startup, interp); /* register subsystem commands */ - hello_register_commands(cmd_ctx); - 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) - { - exit(-1); + 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, + &transport_register_commands, + &interface_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("log init complete"); + LOG_DEBUG("command registration: complete"); - LOG_OUTPUT(OPENOCD_VERSION "\n"); + LOG_OUTPUT(OPENOCD_VERSION "\n" + "Licensed under GNU GPL v2\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 +/** 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(). */ -void openocd_sleep_prelude(void) +static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx) { -} + int ret; -void openocd_sleep_postlude(void) -{ -} -#endif + 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) + return EXIT_FAILURE; + + ret = server_init(cmd_ctx); + if (ERROR_OK != ret) + return EXIT_FAILURE; + + if (init_at_startup) { + ret = command_run_line(cmd_ctx, "init"); + if (ERROR_OK != ret) + return EXIT_FAILURE; + } + + server_loop(cmd_ctx); + + server_quit(); + + 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 @@ -246,61 +307,32 @@ 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) - { + if (util_init(cmd_ctx) != ERROR_OK) return EXIT_FAILURE; - } -#endif - print_version(); + if (ioutil_init(cmd_ctx) != ERROR_OK) + return EXIT_FAILURE; LOG_OUTPUT("For bug reports, read\n\t" - "http://openocd.berlios.de/doc/doxygen/bugs.html" + "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); - if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK) - return EXIT_FAILURE; - - ret = parse_config_file(cmd_ctx); - if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION)) - return EXIT_FAILURE; - -#if BUILD_HTTPD - if (httpd_start() != ERROR_OK) - return EXIT_FAILURE; -#endif - - 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); - } - - /* shut server down */ - server_quit(); - -#if BUILD_HTTPD - httpd_stop(); -#endif + /* Start the executable meat that can evolve into thread in future. */ + ret = openocd_thread(argc, argv, cmd_ctx); - 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; }