src/openocd.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 Richard Missenden                                  *
   9  *   richard.missenden@googlemail.com                                      *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include "openocd.h"
  32 #include <jtag/driver.h>
  33 #include <jtag/jtag.h>
  34 #include <jtag/transport.h>
  35 #include <helper/ioutil.h>
  36 #include <helper/util.h>
  37 #include <helper/configuration.h>
  38 #include <flash/nor/core.h>
  39 #include <flash/nand/core.h>
  40 #include <pld/pld.h>
  41 #include <flash/mflash.h>
  42
  43 #include <server/server.h>
  44 #include <server/gdb_server.h>
  45 #include <server/httpd.h>
  46
  47 #ifdef HAVE_STRINGS_H
  48 #include <strings.h>
  49 #endif
  50
  51
  52 #define OPENOCD_VERSION \
  53                 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
  54
  55 /* Give scripts and TELNET a way to find out what version this is */
  56 static int jim_version_command(Jim_Interp *interp, int argc,
  57                 Jim_Obj * const *argv)
  58 {
  59         if (argc > 2)
  60         {
  61                 return JIM_ERR;
  62         }
  63         const char *str = "";
  64         char * version_str;
  65         version_str = OPENOCD_VERSION;
  66
  67         if (argc == 2)
  68                 str = Jim_GetString(argv[1], NULL);
  69
  70         if (strcmp("git", str) == 0)
  71         {
  72                 version_str = GITVERSION;
  73         }
  74
  75         Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
  76
  77         return JIM_OK;
  78 }
  79
  80 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
  81 {
  82         switch (event)
  83         {
  84                 case TARGET_EVENT_GDB_START:
  85                         target->display = 0;
  86                         break;
  87                 case TARGET_EVENT_GDB_END:
  88                         target->display = 1;
  89                         break;
  90                 case TARGET_EVENT_HALTED:
  91                         if (target->display)
  92                         {
  93                                 /* do not display information when debugger caused the halt */
  94                                 target_arch_state(target);
  95                         }
  96                         break;
  97                 default:
  98                         break;
  99         }
 100
 101         return ERROR_OK;
 102 }
 103
 104 static bool init_at_startup = true;
 105
 106 COMMAND_HANDLER(handle_noinit_command)
 107 {
 108         if (CMD_ARGC != 0)
 109                 return ERROR_COMMAND_SYNTAX_ERROR;
 110         init_at_startup = false;
 111         return ERROR_OK;
 112 }
 113
 114 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 115 COMMAND_HANDLER(handle_init_command)
 116 {
 117
 118         if (CMD_ARGC != 0)
 119                 return ERROR_COMMAND_SYNTAX_ERROR;
 120
 121         int retval;
 122         static int initialized = 0;
 123         if (initialized)
 124                 return ERROR_OK;
 125
 126         initialized = 1;
 127
 128         retval = command_run_line(CMD_CTX, "target init");
 129         if (ERROR_OK != retval)
 130                 return ERROR_FAIL;
 131
 132         if ((retval = adapter_init(CMD_CTX)) != ERROR_OK)
 133         {
 134                 /* we must be able to set up the debug adapter */
 135                 return retval;
 136         }
 137
 138         LOG_DEBUG("Debug Adapter init complete");
 139
 140         /* "transport init" verifies the expected devices are present;
 141          * for JTAG, it checks the list of configured TAPs against
 142          * what's discoverable, possibly with help from the platform's
 143          * JTAG event handlers.  (which require COMMAND_EXEC)
 144          */
 145         command_context_mode(CMD_CTX, COMMAND_EXEC);
 146
 147         retval = command_run_line(CMD_CTX, "transport init");
 148         if (ERROR_OK != retval)
 149                 return ERROR_FAIL;
 150
 151         LOG_DEBUG("Examining targets...");
 152         if (target_examine() != ERROR_OK)
 153                 LOG_DEBUG("target examination failed");
 154
 155         command_context_mode(CMD_CTX, COMMAND_CONFIG);
 156
 157         if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
 158                 return ERROR_FAIL;
 159
 160         if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
 161                 return ERROR_FAIL;
 162
 163         if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
 164                 return ERROR_FAIL;
 165
 166         if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
 167                 return ERROR_FAIL;
 168         command_context_mode(CMD_CTX, COMMAND_EXEC);
 169
 170         /* initialize telnet subsystem */
 171         gdb_target_add_all(all_targets);
 172
 173         target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 174
 175         return ERROR_OK;
 176 }
 177
 178 COMMAND_HANDLER(handle_add_script_search_dir_command)
 179 {
 180         if (CMD_ARGC != 1)
 181                 return ERROR_COMMAND_SYNTAX_ERROR;
 182
 183         add_script_search_dir(CMD_ARGV[0]);
 184
 185         return ERROR_OK;
 186 }
 187
 188
 189 static int jim_stacktrace_command(Jim_Interp *interp, int argc,
 190                 Jim_Obj * const *argv)
 191 {
 192         if (argc != 1)
 193         {
 194                 return JIM_ERR;
 195         }
 196         Jim_Obj * stacktrace = Jim_DuplicateObj(interp, interp->stackTrace);
 197
 198         /* insert actual error site at beginning of list*/
 199         Jim_Obj *procname = Jim_NewStringObj(interp, "", -1); /* Uhhh... don't know this one. */
 200         Jim_ListInsertElements(interp, stacktrace, 0, 1, &procname);
 201         Jim_Obj *filename = Jim_NewStringObj(interp, interp->errorFileName, -1);
 202         Jim_ListInsertElements(interp, stacktrace, 1, 1, &filename);
 203         Jim_Obj *line = Jim_NewIntObj(interp, interp->errorLine);
 204         Jim_ListInsertElements(interp, stacktrace, 2, 1, &line);
 205
 206         Jim_SetResult(interp, stacktrace);
 207
 208         return JIM_OK;
 209 }
 210
 211 static const struct command_registration openocd_command_handlers[] = {
 212         {
 213                 .name = "version",
 214                 .jim_handler = jim_version_command,
 215                 .mode = COMMAND_ANY,
 216                 .help = "show program version",
 217         },
 218         {
 219                 .name = "noinit",
 220                 .handler = &handle_noinit_command,
 221                 .mode = COMMAND_CONFIG,
 222                 .help = "Prevent 'init' from being called at startup.",
 223         },
 224         {
 225                 .name = "init",
 226                 .handler = &handle_init_command,
 227                 .mode = COMMAND_ANY,
 228                 .help = "Initializes configured targets and servers.  "
 229                         "Changes command mode from CONFIG to EXEC.  "
 230                         "Unless 'noinit' is called, this command is "
 231                         "called automatically at the end of startup.",
 232
 233         },
 234         {
 235                 .name = "add_script_search_dir",
 236                 .handler = &handle_add_script_search_dir_command,
 237                 .mode = COMMAND_ANY,
 238                 .help = "dir to search for config files and scripts",
 239
 240         },
 241         {
 242                 .name = "stacktrace",
 243                 .jim_handler = jim_stacktrace_command,
 244                 .mode = COMMAND_ANY,
 245                 .help = "returns the stacktrace as a list of triples: proc, file, line."
 246                 "The stack trace is reset when a new stack trace is being built after "
 247                 "a new failure has occurred.",
 248         },
 249         COMMAND_REGISTRATION_DONE
 250 };
 251
 252 static int openocd_register_commands(struct command_context *cmd_ctx)
 253 {
 254         return register_commands(cmd_ctx, NULL, openocd_command_handlers);
 255 }
 256
 257 struct command_context *global_cmd_ctx;
 258
 259 /* NB! this fn can be invoked outside this file for non PC hosted builds
 260  * NB! do not change to 'static'!!!!
 261  */
 262 struct command_context *setup_command_handler(Jim_Interp *interp)
 263 {
 264         log_init();
 265         LOG_DEBUG("log_init: complete");
 266
 267         const char *startup = openocd_startup_tcl;
 268         struct command_context *cmd_ctx = command_init(startup, interp);
 269
 270         /* register subsystem commands */
 271         typedef int (*command_registrant_t)(struct command_context *cmd_ctx);
 272         static const command_registrant_t command_registrants[] = {
 273                 &openocd_register_commands,
 274                 &server_register_commands,
 275                 &gdb_register_commands,
 276                 &log_register_commands,
 277                 &transport_register_commands,
 278                 &interface_register_commands,
 279                 &target_register_commands,
 280                 &flash_register_commands,
 281                 &nand_register_commands,
 282                 &pld_register_commands,
 283                 &mflash_register_commands,
 284                 NULL
 285         };
 286         for (unsigned i = 0; NULL != command_registrants[i]; i++)
 287         {
 288                 int retval = (*command_registrants[i])(cmd_ctx);
 289                 if (ERROR_OK != retval)
 290                 {
 291                         command_done(cmd_ctx);
 292                         return NULL;
 293                 }
 294         }
 295         LOG_DEBUG("command registration: complete");
 296
 297         LOG_OUTPUT(OPENOCD_VERSION "\n"
 298                         "Licensed under GNU GPL v2\n");
 299
 300         global_cmd_ctx = cmd_ctx;
 301
 302         return cmd_ctx;
 303 }
 304
 305 /* normally this is the main() function entry, but if OpenOCD is linked
 306  * into application, then this fn will not be invoked, but rather that
 307  * application will have it's own implementation of main(). */
 308 int openocd_main(int argc, char *argv[])
 309 {
 310         int ret;
 311
 312         /* initialize commandline interface */
 313         struct command_context *cmd_ctx;
 314
 315         cmd_ctx = setup_command_handler(NULL);
 316
 317         if (util_init(cmd_ctx) != ERROR_OK)
 318                 return EXIT_FAILURE;
 319
 320         if (ioutil_init(cmd_ctx) != ERROR_OK)
 321                 return EXIT_FAILURE;
 322
 323         LOG_OUTPUT("For bug reports, read\n\t"
 324                 "http://openocd.berlios.de/doc/doxygen/bugs.html"
 325                 "\n");
 326
 327         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 328         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 329
 330         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 331                 return EXIT_FAILURE;
 332
 333         if (server_preinit() != ERROR_OK)
 334                 return EXIT_FAILURE;
 335
 336         ret = parse_config_file(cmd_ctx);
 337         if (ret != ERROR_OK)
 338                 return EXIT_FAILURE;
 339
 340         if (httpd_start(cmd_ctx) != ERROR_OK)
 341                 return EXIT_FAILURE;
 342
 343         ret = server_init(cmd_ctx);
 344         if (ERROR_OK != ret)
 345                 return EXIT_FAILURE;
 346
 347         if (init_at_startup)
 348         {
 349                 ret = command_run_line(cmd_ctx, "init");
 350                 if (ERROR_OK != ret)
 351                         ret = EXIT_FAILURE;
 352         }
 353
 354         /* handle network connections */
 355         if (ERROR_OK == ret)
 356                 server_loop(cmd_ctx);
 357
 358         server_quit();
 359
 360         httpd_stop();
 361
 362         unregister_all_commands(cmd_ctx, NULL);
 363
 364         /* free commandline interface */
 365         command_done(cmd_ctx);
 366
 367         adapter_quit();
 368
 369         return ret;
 370 }