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, see <http://www.gnu.org/licenses/>. *
  23  ***************************************************************************/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include "config.h"
  27 #endif
  28
  29 #include "openocd.h"
  30 #include <jtag/driver.h>
  31 #include <jtag/jtag.h>
  32 #include <transport/transport.h>
  33 #include <helper/ioutil.h>
  34 #include <helper/util.h>
  35 #include <helper/configuration.h>
  36 #include <flash/nor/core.h>
  37 #include <flash/nand/core.h>
  38 #include <pld/pld.h>
  39 #include <target/arm_cti.h>
  40 #include <target/arm_adi_v5.h>
  41
  42 #include <server/server.h>
  43 #include <server/gdb_server.h>
  44
  45 #ifdef HAVE_STRINGS_H
  46 #include <strings.h>
  47 #endif
  48
  49 #ifdef PKGBLDDATE
  50 #define OPENOCD_VERSION \
  51         "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
  52 #else
  53 #define OPENOCD_VERSION \
  54         "Open On-Chip Debugger " VERSION RELSTR
  55 #endif
  56
  57 static const char openocd_startup_tcl[] = {
  58 #include "startup_tcl.inc"
  59 0 /* Terminate with zero */
  60 };
  61
  62 /* Give scripts and TELNET a way to find out what version this is */
  63 static int jim_version_command(Jim_Interp *interp, int argc,
  64         Jim_Obj * const *argv)
  65 {
  66         if (argc > 2)
  67                 return JIM_ERR;
  68         const char *str = "";
  69         char *version_str;
  70         version_str = OPENOCD_VERSION;
  71
  72         if (argc == 2)
  73                 str = Jim_GetString(argv[1], NULL);
  74
  75         if (strcmp("git", str) == 0)
  76                 version_str = GITVERSION;
  77
  78         Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
  79
  80         return JIM_OK;
  81 }
  82
  83 static int log_target_callback_event_handler(struct target *target,
  84         enum target_event event,
  85         void *priv)
  86 {
  87         switch (event) {
  88                 case TARGET_EVENT_GDB_START:
  89                         target->verbose_halt_msg = false;
  90                         break;
  91                 case TARGET_EVENT_GDB_END:
  92                         target->verbose_halt_msg = true;
  93                         break;
  94                 case TARGET_EVENT_HALTED:
  95                         if (target->verbose_halt_msg) {
  96                                 /* do not display information when debugger caused the halt */
  97                                 target_arch_state(target);
  98                         }
  99                         break;
 100                 default:
 101                         break;
 102         }
 103
 104         return ERROR_OK;
 105 }
 106
 107 static bool init_at_startup = true;
 108
 109 COMMAND_HANDLER(handle_noinit_command)
 110 {
 111         if (CMD_ARGC != 0)
 112                 return ERROR_COMMAND_SYNTAX_ERROR;
 113         init_at_startup = false;
 114         return ERROR_OK;
 115 }
 116
 117 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 118 COMMAND_HANDLER(handle_init_command)
 119 {
 120
 121         if (CMD_ARGC != 0)
 122                 return ERROR_COMMAND_SYNTAX_ERROR;
 123
 124         int retval;
 125         static int initialized;
 126         if (initialized)
 127                 return ERROR_OK;
 128
 129         initialized = 1;
 130
 131         retval = command_run_line(CMD_CTX, "target init");
 132         if (ERROR_OK != retval)
 133                 return ERROR_FAIL;
 134
 135         retval = adapter_init(CMD_CTX);
 136         if (retval != ERROR_OK) {
 137                 /* we must be able to set up the debug adapter */
 138                 return retval;
 139         }
 140
 141         LOG_DEBUG("Debug Adapter init complete");
 142
 143         /* "transport init" verifies the expected devices are present;
 144          * for JTAG, it checks the list of configured TAPs against
 145          * what's discoverable, possibly with help from the platform's
 146          * JTAG event handlers.  (which require COMMAND_EXEC)
 147          */
 148         command_context_mode(CMD_CTX, COMMAND_EXEC);
 149
 150         retval = command_run_line(CMD_CTX, "transport init");
 151         if (ERROR_OK != retval)
 152                 return ERROR_FAIL;
 153
 154         retval = command_run_line(CMD_CTX, "dap init");
 155         if (ERROR_OK != retval)
 156                 return ERROR_FAIL;
 157
 158         LOG_DEBUG("Examining targets...");
 159         if (target_examine() != ERROR_OK)
 160                 LOG_DEBUG("target examination failed");
 161
 162         command_context_mode(CMD_CTX, COMMAND_CONFIG);
 163
 164         if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
 165                 return ERROR_FAIL;
 166
 167         if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
 168                 return ERROR_FAIL;
 169
 170         if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
 171                 return ERROR_FAIL;
 172         command_context_mode(CMD_CTX, COMMAND_EXEC);
 173
 174         /* initialize telnet subsystem */
 175         gdb_target_add_all(all_targets);
 176
 177         target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 178
 179         return ERROR_OK;
 180 }
 181
 182 COMMAND_HANDLER(handle_add_script_search_dir_command)
 183 {
 184         if (CMD_ARGC != 1)
 185                 return ERROR_COMMAND_SYNTAX_ERROR;
 186
 187         add_script_search_dir(CMD_ARGV[0]);
 188
 189         return ERROR_OK;
 190 }
 191
 192 static const struct command_registration openocd_command_handlers[] = {
 193         {
 194                 .name = "version",
 195                 .jim_handler = jim_version_command,
 196                 .mode = COMMAND_ANY,
 197                 .help = "show program version",
 198         },
 199         {
 200                 .name = "noinit",
 201                 .handler = &handle_noinit_command,
 202                 .mode = COMMAND_CONFIG,
 203                 .help = "Prevent 'init' from being called at startup.",
 204                 .usage = ""
 205         },
 206         {
 207                 .name = "init",
 208                 .handler = &handle_init_command,
 209                 .mode = COMMAND_ANY,
 210                 .help = "Initializes configured targets and servers.  "
 211                         "Changes command mode from CONFIG to EXEC.  "
 212                         "Unless 'noinit' is called, this command is "
 213                         "called automatically at the end of startup.",
 214                 .usage = ""
 215         },
 216         {
 217                 .name = "add_script_search_dir",
 218                 .handler = &handle_add_script_search_dir_command,
 219                 .mode = COMMAND_ANY,
 220                 .help = "dir to search for config files and scripts",
 221                 .usage = "<directory>"
 222         },
 223         COMMAND_REGISTRATION_DONE
 224 };
 225
 226 static int openocd_register_commands(struct command_context *cmd_ctx)
 227 {
 228         return register_commands(cmd_ctx, NULL, openocd_command_handlers);
 229 }
 230
 231 struct command_context *global_cmd_ctx;
 232
 233 static struct command_context *setup_command_handler(Jim_Interp *interp)
 234 {
 235         log_init();
 236         LOG_DEBUG("log_init: complete");
 237
 238         struct command_context *cmd_ctx = command_init(openocd_startup_tcl, interp);
 239
 240         /* register subsystem commands */
 241         typedef int (*command_registrant_t)(struct command_context *cmd_ctx_value);
 242         static const command_registrant_t command_registrants[] = {
 243                 &openocd_register_commands,
 244                 &server_register_commands,
 245                 &gdb_register_commands,
 246                 &log_register_commands,
 247                 &transport_register_commands,
 248                 &interface_register_commands,
 249                 &target_register_commands,
 250                 &flash_register_commands,
 251                 &nand_register_commands,
 252                 &pld_register_commands,
 253                 &cti_register_commands,
 254                 &dap_register_commands,
 255                 NULL
 256         };
 257         for (unsigned i = 0; NULL != command_registrants[i]; i++) {
 258                 int retval = (*command_registrants[i])(cmd_ctx);
 259                 if (ERROR_OK != retval) {
 260                         command_done(cmd_ctx);
 261                         return NULL;
 262                 }
 263         }
 264         LOG_DEBUG("command registration: complete");
 265
 266         LOG_OUTPUT(OPENOCD_VERSION "\n"
 267                 "Licensed under GNU GPL v2\n");
 268
 269         global_cmd_ctx = cmd_ctx;
 270
 271         return cmd_ctx;
 272 }
 273
 274 /** OpenOCD runtime meat that can become single-thread in future. It parse
 275  * commandline, reads configuration, sets up the target and starts server loop.
 276  * Commandline arguments are passed into this function from openocd_main().
 277  */
 278 static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ctx)
 279 {
 280         int ret;
 281
 282         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 283                 return ERROR_FAIL;
 284
 285         if (server_preinit() != ERROR_OK)
 286                 return ERROR_FAIL;
 287
 288         ret = parse_config_file(cmd_ctx);
 289         if (ret == ERROR_COMMAND_CLOSE_CONNECTION) {
 290                 server_quit(); /* gdb server may be initialized by -c init */
 291                 return ERROR_OK;
 292         } else if (ret != ERROR_OK) {
 293                 server_quit(); /* gdb server may be initialized by -c init */
 294                 return ERROR_FAIL;
 295         }
 296
 297         ret = server_init(cmd_ctx);
 298         if (ERROR_OK != ret)
 299                 return ERROR_FAIL;
 300
 301         if (init_at_startup) {
 302                 ret = command_run_line(cmd_ctx, "init");
 303                 if (ERROR_OK != ret) {
 304                         server_quit();
 305                         return ERROR_FAIL;
 306                 }
 307         }
 308
 309         ret = server_loop(cmd_ctx);
 310
 311         int last_signal = server_quit();
 312         if (last_signal != ERROR_OK)
 313                 return last_signal;
 314
 315         if (ret != ERROR_OK)
 316                 return ERROR_FAIL;
 317         return ERROR_OK;
 318 }
 319
 320 /* normally this is the main() function entry, but if OpenOCD is linked
 321  * into application, then this fn will not be invoked, but rather that
 322  * application will have it's own implementation of main(). */
 323 int openocd_main(int argc, char *argv[])
 324 {
 325         int ret;
 326
 327         /* initialize commandline interface */
 328         struct command_context *cmd_ctx;
 329
 330         cmd_ctx = setup_command_handler(NULL);
 331
 332         if (util_init(cmd_ctx) != ERROR_OK)
 333                 return EXIT_FAILURE;
 334
 335         if (ioutil_init(cmd_ctx) != ERROR_OK)
 336                 return EXIT_FAILURE;
 337
 338         LOG_OUTPUT("For bug reports, read\n\t"
 339                 "http://openocd.org/doc/doxygen/bugs.html"
 340                 "\n");
 341
 342         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 343         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 344
 345         server_host_os_entry();
 346
 347         /* Start the executable meat that can evolve into thread in future. */
 348         ret = openocd_thread(argc, argv, cmd_ctx);
 349
 350         flash_free_all_banks();
 351         gdb_service_free();
 352         server_free();
 353
 354         unregister_all_commands(cmd_ctx, NULL);
 355
 356         /* free all DAP and CTI objects */
 357         dap_cleanup_all();
 358         arm_cti_cleanup_all();
 359
 360         adapter_quit();
 361
 362         server_host_os_close();
 363
 364         /* Shutdown commandline interface */
 365         command_exit(cmd_ctx);
 366
 367         free_config();
 368
 369         if (ERROR_FAIL == ret)
 370                 return EXIT_FAILURE;
 371         else if (ERROR_OK != ret)
 372                 exit_on_signal(ret);
 373
 374         return ret;
 375 }