* 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 *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
-#define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV
-
#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 <sys/time.h>
-#include <sys/types.h>
+#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 <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>
+
+#ifdef HAVE_STRINGS_H
#include <strings.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <errno.h>
-
-#define JIM_EMBEDDED
-#include "jim.h"
+#endif
+#define OPENOCD_VERSION \
+ "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
-/* 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)
+/* 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)
{
- command_print(cmd_ctx, OPENOCD_VERSION);
+ if (argc > 2)
+ return JIM_ERR;
+ const char *str = "";
+ char *version_str;
+ version_str = OPENOCD_VERSION;
- return ERROR_OK;
-}
+ if (argc == 2)
+ str = Jim_GetString(argv[1], NULL);
+
+ if (strcmp("git", str) == 0)
+ version_str = GITVERSION;
-static int daemon_startup = 0;
+ Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
-int handle_daemon_startup_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+ return JIM_OK;
+}
+
+static int log_target_callback_event_handler(struct target *target,
+ enum target_event event,
+ void *priv)
{
- if (argc==0)
- return ERROR_OK;
- if (argc > 1 )
- return ERROR_COMMAND_SYNTAX_ERROR;
-
- daemon_startup = strcmp("reset", args[0])==0;
-
- 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;
}
+static bool init_at_startup = true;
-void exit_handler(void)
+COMMAND_HANDLER(handle_noinit_command)
{
- /* close JTAG interface */
- if (jtag && jtag->quit)
- jtag->quit();
+ 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! :-) */
-int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_init_command)
{
+
+ 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;
-
- command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
- 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)
- {
- /* 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
+ 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)
*/
- if (jtag_init(cmd_ctx) == ERROR_OK)
- {
- LOG_DEBUG("jtag init complete");
- if (target_examine(cmd_ctx) == ERROR_OK)
- {
- LOG_DEBUG("jtag examine complete");
- }
- }
+ 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 (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 (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();
+ gdb_target_add_all(all_targets);
+
+ target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
return ERROR_OK;
}
-
-/* implementations of OpenOCD that uses multithreading needs to lock OpenOCD while calling
- * OpenOCD fn's. No-op in vanilla OpenOCD
- */
-void lockBigLock()
+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;
}
-void unlockBigLock()
+
+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 = "<directory>"
+ },
+ 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 subsystem commands */
+ 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");
-Jim_Interp *interp;
-command_context_t *active_cmd_ctx;
+ LOG_OUTPUT(OPENOCD_VERSION "\n"
+ "Licensed under GNU GPL v2\n");
-static void tcl_output(void *privData, const char *file, int line,
- const char *function, const char *string)
-{
- Jim_Obj *tclOutput=(Jim_Obj *)privData;
+ global_cmd_ctx = cmd_ctx;
- Jim_AppendString(interp, tclOutput, string, strlen(string));
+ return cmd_ctx;
}
-/* try to execute as Jim command, otherwise fall back to standard command.
-
- Note that even if the Jim command caused an error, then we succeeded
- to execute it, hence this fn pretty much always returns ERROR_OK.
-
+/** 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().
*/
-int jim_command(command_context_t *context, char *line)
+static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
{
- int retval=ERROR_OK;
- active_cmd_ctx=context;
- int retcode=Jim_Eval(interp, line);
- active_cmd_ctx=NULL;
-
- const char *result;
- int reslen;
- result = Jim_GetString(Jim_GetResult(interp), &reslen);
- if (retcode == JIM_ERR) {
- int len, i;
-
- LOG_USER_N("Runtime error, file \"%s\", line %d:" JIM_NL,
- interp->errorFileName, interp->errorLine);
- LOG_USER_N(" %s" JIM_NL,
- Jim_GetString(interp->result, NULL));
- Jim_ListLength(interp, interp->stackTrace, &len);
- for (i = 0; i < len; i+= 3) {
- Jim_Obj *objPtr;
- const char *proc, *file, *line;
-
- Jim_ListIndex(interp, interp->stackTrace, i, &objPtr, JIM_NONE);
- proc = Jim_GetString(objPtr, NULL);
- Jim_ListIndex(interp, interp->stackTrace, i+1, &objPtr,
- JIM_NONE);
- file = Jim_GetString(objPtr, NULL);
- Jim_ListIndex(interp, interp->stackTrace, i+2, &objPtr,
- JIM_NONE);
- line = Jim_GetString(objPtr, NULL);
- LOG_USER_N("In procedure '%s' called at file \"%s\", line %s" JIM_NL,
- proc, file, line);
- }
- } else if (retcode == JIM_EXIT) {
- // ignore.
- //exit(Jim_GetExitCode(interp));
- } else {
- if (reslen) {
- int i;
- char buff[256+1];
- for (i=0; i<reslen; i+=256)
- {
- int chunk;
- chunk=reslen-i;
- if (chunk>256)
- chunk=256;
- strncpy(buff, result, chunk);
- buff[chunk]=0;
- LOG_USER_N("%s", buff);
- }
- LOG_USER_N("%s", "\n");
- }
- }
- return retval;
-}
+ int ret;
-static int startLoop=0;
-
-static int
-Jim_Command_openocd_ignore(Jim_Interp *interp,
- int argc,
- Jim_Obj *const *argv,
- int ignore)
-{
- int retval;
- char *cmd = (char*)Jim_GetString(argv[1], NULL);
-
- lockBigLock();
-
- Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
-
- if (startLoop)
- {
- // We don't know whether or not the telnet/gdb server is running...
- target_call_timer_callbacks_now();
- }
-
- log_add_callback(tcl_output, tclOutput);
- retval=command_run_line_internal(active_cmd_ctx, cmd);
-
- if (startLoop)
- {
- target_call_timer_callbacks_now();
- }
- log_remove_callback(tcl_output, tclOutput);
-
- Jim_SetResult(interp, tclOutput);
- unlockBigLock();
-
- return (ignore||(retval==ERROR_OK))?JIM_OK:JIM_ERR;
-}
+ if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
+ return EXIT_FAILURE;
-static int
-Jim_Command_openocd(Jim_Interp *interp,
- int argc,
- Jim_Obj *const *argv)
-{
- return Jim_Command_openocd_ignore(interp, argc, argv, 1);
-}
+ if (server_preinit() != ERROR_OK)
+ return EXIT_FAILURE;
-static int
-Jim_Command_openocd_throw(Jim_Interp *interp,
- int argc,
- Jim_Obj *const *argv)
-{
- return Jim_Command_openocd_ignore(interp, argc, argv, 0);
-}
-
+ 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;
+ }
-/* find full path to file */
-static int
-Jim_Command_find(Jim_Interp *interp,
- int argc,
- Jim_Obj *const *argv)
-{
- if (argc!=2)
- return JIM_ERR;
- char *file = (char*)Jim_GetString(argv[1], NULL);
- char *full_path=find_file(file);
- if (full_path==NULL)
- return JIM_ERR;
- Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
- free(full_path);
-
- Jim_SetResult(interp, result);
- return JIM_OK;
-}
+ server_loop(cmd_ctx);
+ server_quit();
-void initJim(void)
-{
- Jim_InitEmbedded();
-
- /* Create an interpreter */
- interp = Jim_CreateInterp();
- /* Add all the Jim core commands */
- Jim_RegisterCoreCommands(interp);
- Jim_CreateCommand(interp, "openocd", Jim_Command_openocd, NULL, NULL);
- Jim_CreateCommand(interp, "openocd_throw", Jim_Command_openocd_throw, NULL, NULL);
- Jim_CreateCommand(interp, "find", Jim_Command_find, NULL, NULL);
+ return ret;
}
-int main(int argc, char *argv[])
+/* 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[])
{
- initJim();
-
+ int ret;
+
/* initialize commandline interface */
- command_context_t *cmd_ctx, *cfg_cmd_ctx;
- cmd_ctx = command_init();
-
- register_command(cmd_ctx, NULL, "version", handle_version_command,
- COMMAND_EXEC, "show OpenOCD version");
- register_command(cmd_ctx, NULL, "daemon_startup", handle_daemon_startup_command, COMMAND_CONFIG,
- "deprecated - use \"init\" and \"reset\" at end of startup script instead");
-
- /* 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;
- LOG_DEBUG("log init complete");
-
- LOG_OUTPUT( OPENOCD_VERSION "\n" );
-
-
- /* 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 */
-
- register_command(cmd_ctx, NULL, "init", handle_init_command,
- COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
-
- 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;
+ struct command_context *cmd_ctx;
- Jim_Eval(interp, "source [find tcl/commands.tcl]");
+ cmd_ctx = setup_command_handler(NULL);
- if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
+ if (util_init(cmd_ctx) != ERROR_OK)
return EXIT_FAILURE;
-
- command_done(cfg_cmd_ctx);
- if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
+ if (ioutil_init(cmd_ctx) != ERROR_OK)
return EXIT_FAILURE;
-
- if (daemon_startup)
- command_run_line(cmd_ctx, "reset");
+ LOG_OUTPUT("For bug reports, read\n\t"
+ "http://openocd.sourceforge.net/doc/doxygen/bugs.html"
+ "\n");
- startLoop=1;
+ command_context_mode(cmd_ctx, COMMAND_CONFIG);
+ command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
- /* handle network connections */
- server_loop(cmd_ctx);
+ /* Start the executable meat that can evolve into thread in future. */
+ ret = openocd_thread(argc, argv, cmd_ctx);
- /* shut server down */
- server_quit();
+ unregister_all_commands(cmd_ctx, NULL);
- unregister_all_commands(cmd_ctx);
-
/* free commandline interface */
command_done(cmd_ctx);
- return EXIT_SUCCESS;
-}
+ adapter_quit();
+ return ret;
+}
Code Review / openocd.git / blobdiff