+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
/***************************************************************************
* 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 *
* 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 *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * 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. *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#endif
#include "openocd.h"
-#include "jtag.h"
-#include "ioutil.h"
-#include "configuration.h"
-#include "xsvf.h"
-#include "svf.h"
-#include "nand.h"
-#include "pld.h"
-#include "mflash.h"
-
-#include "server.h"
-#include "gdb_server.h"
-#include "httpd.h"
+#include <jtag/adapter.h>
+#include <jtag/jtag.h>
+#include <transport/transport.h>
+#include <helper/util.h>
+#include <helper/configuration.h>
+#include <flash/nor/core.h>
+#include <flash/nand/core.h>
+#include <pld/pld.h>
+#include <target/arm_cti.h>
+#include <target/arm_adi_v5.h>
+#include <target/arm_tpiu_swo.h>
+#include <rtt/rtt.h>
+
+#include <server/server.h>
+#include <server/gdb_server.h>
+#include <server/rtt_server.h>
#ifdef HAVE_STRINGS_H
#include <strings.h>
#endif
+#ifdef PKGBLDDATE
+#define OPENOCD_VERSION \
+ "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
+#else
+#define OPENOCD_VERSION \
+ "Open On-Chip Debugger " VERSION RELSTR
+#endif
-#define OPENOCD_VERSION \
- "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
+static const char openocd_startup_tcl[] = {
+#include "startup_tcl.inc"
+0 /* Terminate with zero */
+};
-/* 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;
+ target->verbose_halt_msg = false;
break;
case TARGET_EVENT_GDB_END:
- target->display = 1;
+ target->verbose_halt_msg = true;
break;
case TARGET_EVENT_HALTED:
- if (target->display)
- {
+ if (target->verbose_halt_msg) {
/* do not display information when debugger caused the halt */
target_arch_state(target);
}
return ERROR_COMMAND_SYNTAX_ERROR;
int retval;
- static int initialized = 0;
+ static int initialized;
if (initialized)
return ERROR_OK;
initialized = 1;
+ bool save_poll_mask = jtag_poll_mask();
+
retval = command_run_line(CMD_CTX, "target init");
- if (ERROR_OK != retval)
+ if (retval != ERROR_OK)
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 */
- if (command_run_line(CMD_CTX, "jtag init") == ERROR_OK)
- {
- command_context_mode(CMD_CTX, COMMAND_EXEC);
- LOG_DEBUG("Examining targets...");
- if (target_examine() != ERROR_OK)
- LOG_DEBUG("target examination failed");
- command_context_mode(CMD_CTX, COMMAND_CONFIG);
- }
- else
- LOG_WARNING("jtag initialization failed; try 'jtag init' again.");
+ LOG_DEBUG("Debug Adapter init complete");
- if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
+ /* "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 (retval != ERROR_OK)
+ return ERROR_FAIL;
+
+ retval = command_run_line(CMD_CTX, "dap init");
+ if (retval != ERROR_OK)
return ERROR_FAIL;
- if (command_run_line(CMD_CTX, "mflash init") != 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;
if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
return ERROR_FAIL;
command_context_mode(CMD_CTX, COMMAND_EXEC);
+ /* in COMMAND_EXEC, after target_examine(), only tpiu or only swo */
+ if (command_run_line(CMD_CTX, "tpiu init") != ERROR_OK)
+ return ERROR_FAIL;
+
+ jtag_poll_unmask(save_poll_mask);
+
/* initialize telnet subsystem */
gdb_target_add_all(all_targets);
target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
+ if (command_run_line(CMD_CTX, "_run_post_init_commands") != ERROR_OK)
+ return ERROR_FAIL;
+
+ 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",
},
.handler = &handle_noinit_command,
.mode = COMMAND_CONFIG,
.help = "Prevent 'init' from being called at startup.",
+ .usage = ""
},
{
.name = "init",
.handler = &handle_init_command,
- .mode = COMMAND_CONFIG,
+ .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);
+}
+
+/*
+ * TODO: to be removed after v0.12.0
+ * workaround for syntax change of "expr" in jimtcl 0.81
+ * replace "expr" with openocd version that prints the deprecated msg
+ */
+struct jim_scriptobj {
+ void *token;
+ Jim_Obj *filename_obj;
+ int len;
+ int subst_flags;
+ int in_use;
+ int firstline;
+ int linenr;
+ int missing;
+};
+
+static int jim_expr_command(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
+{
+ if (argc == 2)
+ return Jim_EvalExpression(interp, argv[1]);
+
+ if (argc > 2) {
+ Jim_Obj *obj = Jim_ConcatObj(interp, argc - 1, argv + 1);
+ Jim_IncrRefCount(obj);
+ const char *s = Jim_String(obj);
+ struct jim_scriptobj *script = Jim_GetIntRepPtr(interp->currentScriptObj);
+ if (interp->currentScriptObj == interp->emptyObj ||
+ strcmp(interp->currentScriptObj->typePtr->name, "script") ||
+ script->subst_flags ||
+ script->filename_obj == interp->emptyObj)
+ LOG_WARNING("DEPRECATED! use 'expr { %s }' not 'expr %s'", s, s);
+ else
+ LOG_WARNING("DEPRECATED! (%s:%d) use 'expr { %s }' not 'expr %s'",
+ Jim_String(script->filename_obj), script->linenr, s, s);
+ int retcode = Jim_EvalExpression(interp, obj);
+ Jim_DecrRefCount(interp, obj);
+ return retcode;
+ }
+ Jim_WrongNumArgs(interp, 1, argv, "expression ?...?");
+ return JIM_ERR;
+}
+
+static const struct command_registration expr_handler[] = {
+ {
+ .name = "expr",
+ .jim_handler = jim_expr_command,
+ .mode = COMMAND_ANY,
+ .help = "",
+ .usage = "",
},
COMMAND_REGISTRATION_DONE
};
+static int workaround_for_jimtcl_expr(struct command_context *cmd_ctx)
+{
+ return register_commands(cmd_ctx, NULL, expr_handler);
+}
+
struct command_context *global_cmd_ctx;
-/* NB! this fn can be invoked outside this file for non PC hosted builds */
-struct command_context *setup_command_handler(Jim_Interp *interp)
+static struct command_context *setup_command_handler(Jim_Interp *interp)
{
log_init();
LOG_DEBUG("log_init: complete");
- struct command_context *cmd_ctx;
-
- global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl, interp);
+ struct command_context *cmd_ctx = command_init(openocd_startup_tcl, interp);
- register_commands(cmd_ctx, NULL, openocd_command_handlers);
/* register subsystem commands */
- server_register_commands(cmd_ctx);
- gdb_register_commands(cmd_ctx);
- 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);
-
+ typedef int (*command_registrant_t)(struct command_context *cmd_ctx_value);
+ static const command_registrant_t command_registrants[] = {
+ &workaround_for_jimtcl_expr,
+ &openocd_register_commands,
+ &server_register_commands,
+ &gdb_register_commands,
+ &log_register_commands,
+ &rtt_server_register_commands,
+ &transport_register_commands,
+ &adapter_register_commands,
+ &target_register_commands,
+ &flash_register_commands,
+ &nand_register_commands,
+ &pld_register_commands,
+ &cti_register_commands,
+ &dap_register_commands,
+ &arm_tpiu_swo_register_commands,
+ NULL
+ };
+ for (unsigned i = 0; command_registrants[i]; i++) {
+ int retval = (*command_registrants[i])(cmd_ctx);
+ if (retval != ERROR_OK) {
+ 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;
}
+/** 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 (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
+ return ERROR_FAIL;
+
+ if (server_preinit() != ERROR_OK)
+ return ERROR_FAIL;
+
+ ret = parse_config_file(cmd_ctx);
+ if (ret == ERROR_COMMAND_CLOSE_CONNECTION) {
+ server_quit(); /* gdb server may be initialized by -c init */
+ return ERROR_OK;
+ } else if (ret != ERROR_OK) {
+ server_quit(); /* gdb server may be initialized by -c init */
+ return ERROR_FAIL;
+ }
+
+ ret = server_init(cmd_ctx);
+ if (ret != ERROR_OK)
+ return ERROR_FAIL;
+
+ if (init_at_startup) {
+ ret = command_run_line(cmd_ctx, "init");
+ if (ret != ERROR_OK) {
+ server_quit();
+ return ERROR_FAIL;
+ }
+ }
+
+ ret = server_loop(cmd_ctx);
+
+ int last_signal = server_quit();
+ if (last_signal != ERROR_OK)
+ return last_signal;
+
+ if (ret != ERROR_OK)
+ return ERROR_FAIL;
+ return ERROR_OK;
+}
+
/* 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(). */
cmd_ctx = setup_command_handler(NULL);
- if (ioutil_init(cmd_ctx) != ERROR_OK)
+ if (util_init(cmd_ctx) != ERROR_OK)
+ return EXIT_FAILURE;
+
+ if (rtt_init() != ERROR_OK)
return EXIT_FAILURE;
LOG_OUTPUT("For bug reports, read\n\t"
- "http://openocd.berlios.de/doc/doxygen/bugs.html"
+ "http://openocd.org/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;
+ server_host_os_entry();
- ret = parse_config_file(cmd_ctx);
- if (ret != ERROR_OK)
- return EXIT_FAILURE;
+ /* Start the executable meat that can evolve into thread in future. */
+ ret = openocd_thread(argc, argv, cmd_ctx);
-#if BUILD_HTTPD
- if (httpd_start(cmd_ctx) != ERROR_OK)
- return EXIT_FAILURE;
-#endif
+ flash_free_all_banks();
+ gdb_service_free();
+ arm_tpiu_swo_cleanup_all();
+ server_free();
- ret = server_init(cmd_ctx);
- if (ERROR_OK != ret)
- return EXIT_FAILURE;
+ unregister_all_commands(cmd_ctx, NULL);
+ help_del_all_commands(cmd_ctx);
- if (init_at_startup)
- {
- ret = command_run_line(cmd_ctx, "init");
- if (ERROR_OK != ret)
- ret = EXIT_FAILURE;
- }
+ /* free all DAP and CTI objects */
+ arm_cti_cleanup_all();
+ dap_cleanup_all();
- /* handle network connections */
- if (ERROR_OK == ret)
- server_loop(cmd_ctx);
+ adapter_quit();
- server_quit();
+ server_host_os_close();
-#if BUILD_HTTPD
- httpd_stop();
-#endif
+ /* Shutdown commandline interface */
+ command_exit(cmd_ctx);
- unregister_all_commands(cmd_ctx, NULL);
+ rtt_exit();
+ free_config();
- /* free commandline interface */
- command_done(cmd_ctx);
+ log_exit();
- jtag_interface_quit();
+ if (ret == ERROR_FAIL)
+ return EXIT_FAILURE;
+ else if (ret != ERROR_OK)
+ exit_on_signal(ret);
return ret;
}
projects / fw / openocd / blobdiff