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