* 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 *
* 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. *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
***************************************************************************/
-#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 "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 "tcl_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 <target/arm_cti.h>
+#include <target/arm_adi_v5.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>
-
-#ifdef _WIN32
-#include <malloc.h>
-#else
-#include <alloca.h>
#endif
-#ifdef __ECOS
-/* Jim is provied by eCos */
-#include <cyg/jimtcl/jim.h>
+#ifdef PKGBLDDATE
+#define OPENOCD_VERSION \
+ "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
#else
-#define JIM_EMBEDDED
-#include "jim.h"
+#define OPENOCD_VERSION \
+ "Open On-Chip Debugger " VERSION RELSTR
#endif
-#include "replacements.h"
+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 */
-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);
-
- return ERROR_OK;
-}
+ if (argc > 2)
+ return JIM_ERR;
+ const char *str = "";
+ char *version_str;
+ version_str = OPENOCD_VERSION;
-static int daemon_startup = 0;
+ if (argc == 2)
+ str = Jim_GetString(argv[1], NULL);
-int handle_daemon_startup_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
-{
- 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);
+ if (strcmp("git", str) == 0)
+ version_str = GITVERSION;
- return ERROR_OK;
-}
+ Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
-void exit_handler(void)
-{
- /* close JTAG interface */
- if (jtag && jtag->quit)
- jtag->quit();
+ return JIM_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)
+static int log_target_callback_event_handler(struct target *target,
+ enum target_event event,
+ void *priv)
{
- int retval;
- static int initialized=0;
- if (initialized)
- return ERROR_OK;
-
- initialized=1;
-
- command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
-
- atexit(exit_handler);
-
- if (target_init(cmd_ctx) != ERROR_OK)
- 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 */
- 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(cmd_ctx) == ERROR_OK)
- {
- LOG_DEBUG("jtag examine complete");
- }
+ switch (event) {
+ case TARGET_EVENT_GDB_START:
+ target->verbose_halt_msg = false;
+ break;
+ case TARGET_EVENT_GDB_END:
+ target->verbose_halt_msg = true;
+ break;
+ case TARGET_EVENT_HALTED:
+ if (target->verbose_halt_msg) {
+ /* do not display information when debugger caused the halt */
+ target_arch_state(target);
+ }
+ break;
+ default:
+ break;
}
-
- if (flash_init_drivers(cmd_ctx) != ERROR_OK)
- return ERROR_FAIL;
- LOG_DEBUG("flash init complete");
-
- if (nand_init(cmd_ctx) != ERROR_OK)
- return ERROR_FAIL;
- LOG_DEBUG("NAND init complete");
-
- if (pld_init(cmd_ctx) != ERROR_OK)
- return ERROR_FAIL;
- LOG_DEBUG("pld init complete");
-
- /* initialize tcp server */
- server_init();
-
- /* initialize telnet subsystem */
- telnet_init("Open On-Chip Debugger");
- gdb_init();
- tcl_init(); /* allows tcl to just connect without going thru telnet */
return ERROR_OK;
}
-Jim_Interp *interp;
-command_context_t *active_cmd_ctx;
+static bool init_at_startup = true;
-static int new_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 val)
+COMMAND_HANDLER(handle_noinit_command)
{
- char *namebuf;
- Jim_Obj *nameObjPtr, *valObjPtr;
- int result;
-
- namebuf = alloc_printf("%s(%d)", varname, idx);
- if (!namebuf)
- return JIM_ERR;
-
- nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
- valObjPtr = Jim_NewIntObj(interp, val);
- if (!nameObjPtr || !valObjPtr)
- {
- free(namebuf);
- return JIM_ERR;
- }
-
- Jim_IncrRefCount(nameObjPtr);
- Jim_IncrRefCount(valObjPtr);
- result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
- Jim_DecrRefCount(interp, nameObjPtr);
- Jim_DecrRefCount(interp, valObjPtr);
- free(namebuf);
- /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
- return result;
+ if (CMD_ARGC != 0)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+ init_at_startup = false;
+ return ERROR_OK;
}
-static int Jim_Command_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+/* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
+COMMAND_HANDLER(handle_init_command)
{
- target_t *target;
- long l;
- u32 width;
- u32 len;
- u32 addr;
- u32 count;
- u32 v;
- const char *varname;
- u8 buffer[4096];
- int i, n, e, retval;
-
- /* argv[1] = name of array to receive the data
- * argv[2] = desired width
- * argv[3] = memory address
- * argv[4] = count of times to read
- */
- if (argc != 5) {
- Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
- return JIM_ERR;
- }
- varname = Jim_GetString(argv[1], &len);
- /* given "foo" get space for worse case "foo(%d)" .. add 20 */
- e = Jim_GetLong(interp, argv[2], &l);
- width = l;
- if (e != JIM_OK) {
- return e;
- }
-
- e = Jim_GetLong(interp, argv[3], &l);
- addr = l;
- if (e != JIM_OK) {
- return e;
- }
- e = Jim_GetLong(interp, argv[4], &l);
- len = l;
- if (e != JIM_OK) {
- return e;
- }
- switch (width) {
- case 8:
- width = 1;
- break;
- case 16:
- width = 2;
- break;
- case 32:
- width = 4;
- break;
- default:
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
- return JIM_ERR;
- }
- if (len == 0) {
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
- return JIM_ERR;
- }
- if ((addr + (len * width)) < addr) {
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
- return JIM_ERR;
- }
- /* absurd transfer size? */
- if (len > 65536) {
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
- return JIM_ERR;
- }
-
- if ((width == 1) ||
- ((width == 2) && ((addr & 1) == 0)) ||
- ((width == 4) && ((addr & 3) == 0))) {
- /* all is well */
- } else {
- char buf[100];
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- sprintf(buf, "mem2array address: 0x%08x is not aligned for %d byte reads", addr, width);
- Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
- return JIM_ERR;
- }
-
- target = get_current_target(active_cmd_ctx);
-
- /* Transfer loop */
-
- /* index counter */
- n = 0;
- /* assume ok */
- e = JIM_OK;
- while (len) {
- /* Slurp... in buffer size chunks */
-
- count = len; /* in objects.. */
- if (count > (sizeof(buffer)/width)) {
- count = (sizeof(buffer)/width);
- }
-
- retval = target->type->read_memory( target, addr, width, count, buffer );
- if (retval != ERROR_OK) {
- /* BOO !*/
- LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
- e = JIM_ERR;
- len = 0;
- } else {
- v = 0; /* shut up gcc */
- for (i = 0 ;i < count ;i++, n++) {
- switch (width) {
- case 4:
- v = target_buffer_get_u32(target, &buffer[i*width]);
- break;
- case 2:
- v = target_buffer_get_u16(target, &buffer[i*width]);
- break;
- case 1:
- v = buffer[i] & 0x0ff;
- break;
- }
- new_int_array_element(interp, varname, n, v);
- }
- len -= count;
- }
- }
-
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+ if (CMD_ARGC != 0)
+ return ERROR_COMMAND_SYNTAX_ERROR;
- return JIM_OK;
-}
+ int retval;
+ static int initialized;
+ if (initialized)
+ return ERROR_OK;
-static int get_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 *val)
-{
- char *namebuf;
- Jim_Obj *nameObjPtr, *valObjPtr;
- int result;
- long l;
+ initialized = 1;
- namebuf = alloc_printf("%s(%d)", varname, idx);
- if (!namebuf)
- return JIM_ERR;
+ retval = command_run_line(CMD_CTX, "target init");
+ if (ERROR_OK != retval)
+ return ERROR_FAIL;
- nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
- if (!nameObjPtr)
- {
- free(namebuf);
- return JIM_ERR;
+ retval = adapter_init(CMD_CTX);
+ if (retval != ERROR_OK) {
+ /* we must be able to set up the debug adapter */
+ return retval;
}
- Jim_IncrRefCount(nameObjPtr);
- valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
- Jim_DecrRefCount(interp, nameObjPtr);
- free(namebuf);
- if (valObjPtr == NULL)
- return JIM_ERR;
-
- result = Jim_GetLong(interp, valObjPtr, &l);
- /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
- *val = l;
- return result;
-}
+ LOG_DEBUG("Debug Adapter init complete");
-static int Jim_Command_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
- target_t *target;
- long l;
- u32 width;
- u32 len;
- u32 addr;
- u32 count;
- u32 v;
- const char *varname;
- u8 buffer[4096];
- int i, n, e, retval;
-
- /* argv[1] = name of array to get the data
- * argv[2] = desired width
- * argv[3] = memory address
- * argv[4] = count to write
+ /* "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 (argc != 5) {
- Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
- return JIM_ERR;
- }
- varname = Jim_GetString(argv[1], &len);
- /* given "foo" get space for worse case "foo(%d)" .. add 20 */
+ command_context_mode(CMD_CTX, COMMAND_EXEC);
- e = Jim_GetLong(interp, argv[2], &l);
- width = l;
- if (e != JIM_OK) {
- return e;
- }
-
- e = Jim_GetLong(interp, argv[3], &l);
- addr = l;
- if (e != JIM_OK) {
- return e;
- }
- e = Jim_GetLong(interp, argv[4], &l);
- len = l;
- if (e != JIM_OK) {
- return e;
- }
- switch (width) {
- case 8:
- width = 1;
- break;
- case 16:
- width = 2;
- break;
- case 32:
- width = 4;
- break;
- default:
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
- return JIM_ERR;
- }
- if (len == 0) {
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: zero width read?", NULL);
- return JIM_ERR;
- }
- if ((addr + (len * width)) < addr) {
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: addr + len - wraps to zero?", NULL);
- return JIM_ERR;
- }
- /* absurd transfer size? */
- if (len > 65536) {
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: absurd > 64K item request", NULL);
- return JIM_ERR;
- }
-
- if ((width == 1) ||
- ((width == 2) && ((addr & 1) == 0)) ||
- ((width == 4) && ((addr & 3) == 0))) {
- /* all is well */
- } else {
- char buf[100];
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads", addr, width);
- Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
- return JIM_ERR;
- }
+ retval = command_run_line(CMD_CTX, "transport init");
+ if (ERROR_OK != retval)
+ return ERROR_FAIL;
- target = get_current_target(active_cmd_ctx);
-
- /* Transfer loop */
-
- /* index counter */
- n = 0;
- /* assume ok */
- e = JIM_OK;
- while (len) {
- /* Slurp... in buffer size chunks */
-
- count = len; /* in objects.. */
- if (count > (sizeof(buffer)/width)) {
- count = (sizeof(buffer)/width);
- }
+ retval = command_run_line(CMD_CTX, "dap init");
+ if (ERROR_OK != retval)
+ return ERROR_FAIL;
- v = 0; /* shut up gcc */
- for (i = 0 ;i < count ;i++, n++) {
- get_int_array_element(interp, varname, n, &v);
- switch (width) {
- case 4:
- target_buffer_set_u32(target, &buffer[i*width], v);
- break;
- case 2:
- target_buffer_set_u16(target, &buffer[i*width], v);
- break;
- case 1:
- buffer[i] = v & 0x0ff;
- break;
- }
- }
- len -= count;
-
- retval = target->type->write_memory(target, addr, width, count, buffer);
- if (retval != ERROR_OK) {
- /* BOO !*/
- LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
- e = JIM_ERR;
- len = 0;
- }
- }
-
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
+ LOG_DEBUG("Examining targets...");
+ if (target_examine() != ERROR_OK)
+ LOG_DEBUG("target examination failed");
- return JIM_OK;
-}
+ command_context_mode(CMD_CTX, COMMAND_CONFIG);
-static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
-{
- Jim_Obj *tclOutput=(Jim_Obj *)privData;
+ if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
+ return ERROR_FAIL;
- Jim_AppendString(interp, tclOutput, string, strlen(string));
-}
+ if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
+ return ERROR_FAIL;
-static int openocd_retval;
+ if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
+ return ERROR_FAIL;
-/* 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. */
-int jim_command(command_context_t *context, char *line)
-{
- int retval=ERROR_OK;
- int retcode;
-
- active_cmd_ctx = context;
- openocd_retval=ERROR_OK;
- retcode = Jim_Eval(interp, line);
-
- if (retcode == JIM_ERR) {
- if (openocd_retval!=ERROR_COMMAND_CLOSE_CONNECTION)
- {
- /* We do not print the connection closed error message */
- Jim_PrintErrorMessage(interp);
- }
- if (openocd_retval==ERROR_OK)
- {
- /* It wasn't a low level OpenOCD command that failed */
- return ERROR_FAIL;
- }
- return openocd_retval;
- }
- const char *result;
- int reslen;
- result = Jim_GetString(Jim_GetResult(interp), &reslen);
-
- 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+i, chunk);
- buff[chunk] = 0;
- LOG_USER_N("%s", buff);
- }
- LOG_USER_N("%s", "\n");
- }
- }
- return retval;
-}
+ if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
+ return ERROR_FAIL;
+ command_context_mode(CMD_CTX, COMMAND_EXEC);
-int startLoop = 0;
+ /* initialize telnet subsystem */
+ gdb_target_add_all(all_targets);
-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);
-
- 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);
-
- /* we need to be able to get at the retval, so we store in a global variable */
- openocd_retval=retval;
-
- if (startLoop)
- {
- target_call_timer_callbacks_now();
- }
- log_remove_callback(tcl_output, tclOutput);
-
- Jim_SetResult(interp, tclOutput);
-
- return (ignore||(retval==ERROR_OK))?JIM_OK:JIM_ERR;
-}
+ target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
-static int Jim_Command_openocd(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
- return Jim_Command_openocd_ignore(interp, argc, argv, 1);
+ return ERROR_OK;
}
-static int Jim_Command_openocd_throw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+COMMAND_HANDLER(handle_add_script_search_dir_command)
{
- return Jim_Command_openocd_ignore(interp, argc, argv, 0);
-}
+ if (CMD_ARGC != 1)
+ return ERROR_COMMAND_SYNTAX_ERROR;
-/* 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;
- const char *file = 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;
-}
+ add_script_search_dir(CMD_ARGV[0]);
-static int Jim_Command_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
- if (argc != 2)
- return JIM_ERR;
- char *str = (char*)Jim_GetString(argv[1], NULL);
- LOG_USER("%s", str);
- return JIM_OK;
+ return ERROR_OK;
}
-static int Jim_Command_script(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
- int retval;
- const char *file;
- char *full_path;
-
- if (argc != 2)
+static const struct command_registration openocd_command_handlers[] = {
{
- Jim_WrongNumArgs(interp, 1, argv, "file name missing");
- return JIM_ERR;
- }
-
- /* Run a tcl script file */
- file = Jim_GetString(argv[1], NULL);
- full_path = find_file(file);
- if (full_path == NULL)
+ .name = "version",
+ .jim_handler = jim_version_command,
+ .mode = COMMAND_ANY,
+ .help = "show program version",
+ },
{
- Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
- Jim_AppendStrings(interp, Jim_GetResult(interp), "script: could not open file", file, NULL);
- return JIM_ERR;
- }
- retval = Jim_EvalFile(interp, full_path);
- free(full_path);
- /* convert a return to ok */
- if (retval == JIM_RETURN)
- return JIM_OK;
- return retval;
+ .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;
-static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
+/* 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)
{
- size_t nbytes;
- const char *ptr;
-
- /* make it a char easier to read code */
- ptr = _ptr;
+ log_init();
+ LOG_DEBUG("log_init: complete");
- nbytes = size * n;
- if (nbytes == 0) {
- return 0;
- }
-
- if (!active_cmd_ctx) {
- /* TODO: Where should this go? */
- return n;
- }
+ struct command_context *cmd_ctx = command_init(openocd_startup_tcl, interp);
- /* do we have to chunk it? */
- if (ptr[nbytes] == 0) {
- /* no it is a C style string */
- command_output_text(active_cmd_ctx, ptr);
- return strlen(ptr);
- }
- /* GRR we must chunk - not null terminated */
- while (nbytes) {
- char chunk[128+1];
- int x;
-
- x = nbytes;
- if (x > 128) {
- x = 128;
+ /* 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,
+ &cti_register_commands,
+ &dap_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;
}
- /* copy it */
- memcpy(chunk, ptr, x);
- /* terminate it */
- chunk[n] = 0;
- /* output it */
- command_output_text(active_cmd_ctx, chunk);
- ptr += x;
- nbytes -= x;
}
-
- return n;
-}
+ LOG_DEBUG("command registration: complete");
-static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie )
-{
- /* TCL wants to read... tell him no */
- return 0;
-}
+ LOG_OUTPUT(OPENOCD_VERSION "\n"
+ "Licensed under GNU GPL v2\n");
-static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
-{
- char *cp;
- int n;
-
- n = -1;
- if (active_cmd_ctx) {
- cp = alloc_vprintf(fmt, ap);
- if (cp) {
- command_output_text(active_cmd_ctx, cp);
- n = strlen(cp);
- free(cp);
- }
- }
- return n;
-}
+ global_cmd_ctx = cmd_ctx;
-static int openocd_jim_fflush(void *cookie)
-{
- /* nothing to flush */
- return 0;
+ return cmd_ctx;
}
-static char* openocd_jim_fgets(char *s, int size, void *cookie)
+/** 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)
{
- /* not supported */
- errno = ENOTSUP;
- return NULL;
-}
+ int ret;
-void add_jim(const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
-{
- Jim_CreateCommand(interp, name, cmd, NULL, NULL);
-
- /* FIX!!! it would be prettier to invoke add_help_text...
- accumulate help text in Tcl helptext list. */
- Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
- if (Jim_IsShared(helptext))
- helptext = Jim_DuplicateObj(interp, helptext);
-
- Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
-
- Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
- Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
-
- Jim_ListAppendElement(interp, cmd_entry, cmd_list);
- Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
- Jim_ListAppendElement(interp, helptext, cmd_entry);
-}
+ if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
+ return ERROR_FAIL;
-extern unsigned const char startup_tcl[];
-
-void initJim(void)
-{
- 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);
- Jim_CreateCommand(interp, "echo", Jim_Command_echo, NULL, NULL);
- Jim_CreateCommand(interp, "script", Jim_Command_script, NULL, NULL);
- Jim_CreateCommand(interp, "mem2array", Jim_Command_mem2array, NULL, NULL );
- Jim_CreateCommand(interp, "array2mem", Jim_Command_array2mem, NULL, NULL );
-
- /* Set Jim's STDIO */
- interp->cookie_stdin = NULL;
- interp->cookie_stdout = NULL;
- interp->cookie_stderr = NULL;
- interp->cb_fwrite = openocd_jim_fwrite;
- interp->cb_fread = openocd_jim_fread ;
- interp->cb_vfprintf = openocd_jim_vfprintf;
- interp->cb_fflush = openocd_jim_fflush;
- interp->cb_fgets = openocd_jim_fgets;
-
- add_default_dirs();
-
- if (Jim_Eval(interp, startup_tcl)==JIM_ERR)
- {
- LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
- Jim_PrintErrorMessage(interp);
- exit(-1);
+ 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;
}
-}
-command_context_t *setup_command_handler(void)
-{
- command_context_t *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);
- tcl_register_commands(cmd_ctx); /* tcl server commands */
- log_register_commands(cmd_ctx);
- jtag_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)
- {
- exit(-1);
+ ret = server_init(cmd_ctx);
+ if (ERROR_OK != ret)
+ return ERROR_FAIL;
+
+ if (init_at_startup) {
+ ret = command_run_line(cmd_ctx, "init");
+ if (ERROR_OK != ret) {
+ server_quit();
+ return ERROR_FAIL;
+ }
}
- LOG_DEBUG("log init complete");
- LOG_OUTPUT( OPENOCD_VERSION "\n" );
-
-
- register_command(cmd_ctx, NULL, "init", handle_init_command,
- COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
+ ret = server_loop(cmd_ctx);
- return 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
* application will have it's own implementation of main(). */
int openocd_main(int argc, char *argv[])
{
-#ifdef JIM_EMBEDDED
- Jim_InitEmbedded();
- /* Create an interpreter */
- interp = Jim_CreateInterp();
- /* Add all the Jim core commands */
- Jim_RegisterCoreCommands(interp);
-#endif
-
- initJim();
-
+ int ret;
+
/* initialize commandline interface */
- command_context_t *cmd_ctx;
- cmd_ctx=setup_command_handler();
-
- /* 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 */
-
- command_context_t *cfg_cmd_ctx;
- 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);
-
- active_cmd_ctx=cfg_cmd_ctx;
-
-
- if (parse_cmdline_args(cfg_cmd_ctx, argc, argv) != ERROR_OK)
- return EXIT_FAILURE;
-
- if (parse_config_file(cfg_cmd_ctx) != ERROR_OK)
+ struct command_context *cmd_ctx;
+
+ cmd_ctx = setup_command_handler(NULL);
+
+ if (util_init(cmd_ctx) != ERROR_OK)
return EXIT_FAILURE;
-
- active_cmd_ctx=cmd_ctx;
-
- 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");
-
- startLoop=1;
- /* handle network connections */
- server_loop(cmd_ctx);
+ LOG_OUTPUT("For bug reports, read\n\t"
+ "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);
+
+ /* Start the executable meat that can evolve into thread in future. */
+ ret = openocd_thread(argc, argv, cmd_ctx);
- /* shut server down */
- server_quit();
+ flash_free_all_banks();
+ gdb_service_free();
+ server_free();
- unregister_all_commands(cmd_ctx);
-
- /* free commandline interface */
- command_done(cmd_ctx);
+ unregister_all_commands(cmd_ctx, NULL);
+
+ /* free all DAP and CTI objects */
+ dap_cleanup_all();
+ arm_cti_cleanup_all();
+
+ adapter_quit();
+
+ /* Shutdown commandline interface */
+ command_exit(cmd_ctx);
+
+ free_config();
+
+ if (ERROR_FAIL == ret)
+ return EXIT_FAILURE;
+ else if (ERROR_OK != ret)
+ exit_on_signal(ret);
- return EXIT_SUCCESS;
+ return ret;
}
Code Review / openocd.git / blobdiff