X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fopenocd.c;h=2c27fc421465eefd26788c3c9c5d13653f02b124;hp=6b1fa0800afeed70aacb126d2b18b71958f529db;hb=d31803d3d9bc4750ff34d14cffb809c916401d1e;hpb=98da554bbd560fa5af0c639140fe34e211bf38da diff --git a/src/openocd.c b/src/openocd.c index 6b1fa0800a..2c27fc4214 100644 --- a/src/openocd.c +++ b/src/openocd.c @@ -2,6 +2,12 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007-2010 Ø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 * @@ -18,122 +24,326 @@ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ -#define OPENOCD_VERSION "Open On-Chip Debugger (2007-03-30 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 "target.h" -#include "flash.h" -#include "nand.h" -#include "pld.h" - -#include "command.h" -#include "server.h" -#include "telnet_server.h" -#include "gdb_server.h" - -#include -#include +#include "openocd.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#ifdef HAVE_STRINGS_H #include -#include -#include -#include -#include -#include - -/* 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) +#endif + + +#define OPENOCD_VERSION \ + "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")" + +/* 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 (argc > 2) + { + return JIM_ERR; + } + const char *str = ""; + char * version_str; + version_str = OPENOCD_VERSION; + + if (argc == 2) + str = Jim_GetString(argv[1], NULL); + + if (strcmp("git", str) == 0) + { + version_str = GITVERSION; + } + + Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1)); + + return JIM_OK; +} + +static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv) { - command_print(cmd_ctx, OPENOCD_VERSION); + 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 main(int argc, char *argv[]) +static bool init_at_startup = true; + +COMMAND_HANDLER(handle_noinit_command) { - /* initialize commandline interface */ - command_context_t *cmd_ctx, *cfg_cmd_ctx; - cmd_ctx = command_init(); + 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 (CMD_ARGC != 0) + return ERROR_COMMAND_SYNTAX_ERROR; + + int retval; + static int initialized = 0; + if (initialized) + return ERROR_OK; + + initialized = 1; + + retval = command_run_line(CMD_CTX, "target init"); + if (ERROR_OK != retval) + return ERROR_FAIL; + + if ((retval = adapter_init(CMD_CTX)) != ERROR_OK) + { + /* we must be able to set up the debug adapter */ + return retval; + } + + 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); + + 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) + return ERROR_FAIL; + + if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK) + return ERROR_FAIL; + + if (command_run_line(CMD_CTX, "nand init") != ERROR_OK) + return ERROR_FAIL; + + if (command_run_line(CMD_CTX, "pld init") != ERROR_OK) + return ERROR_FAIL; + command_context_mode(CMD_CTX, COMMAND_EXEC); + + /* initialize telnet subsystem */ + gdb_target_add_all(all_targets); + + target_register_event_callback(log_target_callback_event_handler, CMD_CTX); + + 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", + .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.", + }, + { + .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", + + }, + COMMAND_REGISTRATION_DONE +}; + +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! 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_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); - log_register_commands(cmd_ctx); - jtag_register_commands(cmd_ctx); - interpreter_register_commands(cmd_ctx); - xsvf_register_commands(cmd_ctx); - target_register_commands(cmd_ctx); - flash_register_commands(cmd_ctx); - nand_register_commands(cmd_ctx); - pld_register_commands(cmd_ctx); - - if (log_init(cmd_ctx) != ERROR_OK) - return EXIT_FAILURE; - DEBUG("log init complete"); - - INFO( OPENOCD_VERSION ); + 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("command registration: complete"); - 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; + LOG_OUTPUT(OPENOCD_VERSION "\n" + "Licensed under GNU GPL v2\n"); - if (parse_config_file(cfg_cmd_ctx) != ERROR_OK) - return EXIT_FAILURE; - - command_done(cfg_cmd_ctx); + global_cmd_ctx = cmd_ctx; - command_set_output_handler(cmd_ctx, configuration_output_handler, NULL); + return cmd_ctx; +} - if (jtag_init(cmd_ctx) != ERROR_OK) - return EXIT_FAILURE; - DEBUG("jtag init complete"); +/** 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; - if (target_init(cmd_ctx) != ERROR_OK) + if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK) return EXIT_FAILURE; - DEBUG("target init complete"); - if (flash_init(cmd_ctx) != ERROR_OK) + if (server_preinit() != 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) return EXIT_FAILURE; - DEBUG("NAND init complete"); - if (pld_init(cmd_ctx) != ERROR_OK) + ret = server_init(cmd_ctx); + if (ERROR_OK != ret) return EXIT_FAILURE; - DEBUG("pld init complete"); - /* initialize tcp server */ - server_init(); - - /* initialize telnet subsystem */ - telnet_init("Open On-Chip Debugger"); - gdb_init(); + ret = command_run_line(cmd_ctx, "init_targets"); + if (ERROR_OK != ret) + ret = EXIT_FAILURE; + + if (init_at_startup) + { + ret = command_run_line(cmd_ctx, "init"); + if (ERROR_OK != ret) + return EXIT_FAILURE; + } - /* handle network connections */ server_loop(cmd_ctx); - - /* shut server down */ + 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 + * 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); - - return EXIT_SUCCESS; + + adapter_quit(); + + return ret; }