src/openocd.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Ø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.h"
  33 #include "ioutil.h"
  34 #include "configuration.h"
  35 #include "xsvf.h"
  36 #include "svf.h"
  37 #include "nand.h"
  38 #include "pld.h"
  39 #include "mflash.h"
  40
  41 #include "server.h"
  42 #include "gdb_server.h"
  43 #include "httpd.h"
  44
  45 #ifdef HAVE_STRINGS_H
  46 #include <strings.h>
  47 #endif
  48
  49
  50 #define OPENOCD_VERSION \
  51                 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
  52
  53 /* Give TELNET a way to find out what version this is */
  54 COMMAND_HANDLER(handle_version_command)
  55 {
  56         if (CMD_ARGC != 0)
  57                 return ERROR_COMMAND_SYNTAX_ERROR;
  58
  59         command_print(CMD_CTX, OPENOCD_VERSION);
  60
  61         return ERROR_OK;
  62 }
  63
  64
  65 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
  66 {
  67         switch (event)
  68         {
  69                 case TARGET_EVENT_GDB_START:
  70                         target->display = 0;
  71                         break;
  72                 case TARGET_EVENT_GDB_END:
  73                         target->display = 1;
  74                         break;
  75                 case TARGET_EVENT_HALTED:
  76                         if (target->display)
  77                         {
  78                                 /* do not display information when debugger caused the halt */
  79                                 target_arch_state(target);
  80                         }
  81                         break;
  82                 default:
  83                         break;
  84         }
  85
  86         return ERROR_OK;
  87 }
  88
  89 static bool init_at_startup = true;
  90
  91 COMMAND_HANDLER(handle_noinit_command)
  92 {
  93         if (CMD_ARGC != 0)
  94                 return ERROR_COMMAND_SYNTAX_ERROR;
  95         init_at_startup = false;
  96         return ERROR_OK;
  97 }
  98
  99 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 100 COMMAND_HANDLER(handle_init_command)
 101 {
 102
 103         if (CMD_ARGC != 0)
 104                 return ERROR_COMMAND_SYNTAX_ERROR;
 105
 106         int retval;
 107         static int initialized = 0;
 108         if (initialized)
 109                 return ERROR_OK;
 110
 111         initialized = 1;
 112
 113         retval = command_run_line(CMD_CTX, "target init");
 114         if (ERROR_OK != retval)
 115                 return ERROR_FAIL;
 116
 117         if ((retval = jtag_interface_init(CMD_CTX)) != ERROR_OK)
 118         {
 119                 /* we must be able to set up the jtag interface */
 120                 return retval;
 121         }
 122         LOG_DEBUG("jtag interface init complete");
 123
 124         /* Try to initialize & examine the JTAG chain at this point, but
 125          * continue startup regardless */
 126         if (command_run_line(CMD_CTX, "jtag init") == ERROR_OK)
 127         {
 128                 command_context_mode(CMD_CTX, COMMAND_EXEC);
 129                 LOG_DEBUG("Examining targets...");
 130                 if (target_examine() != ERROR_OK)
 131                         LOG_DEBUG("target examination failed");
 132                 command_context_mode(CMD_CTX, COMMAND_CONFIG);
 133         }
 134         else
 135                 LOG_WARNING("jtag initialization failed; try 'jtag init' again.");
 136
 137         if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
 138                 return ERROR_FAIL;
 139
 140         if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
 141                 return ERROR_FAIL;
 142
 143         if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
 144                 return ERROR_FAIL;
 145
 146         if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
 147                 return ERROR_FAIL;
 148         command_context_mode(CMD_CTX, COMMAND_EXEC);
 149
 150         /* initialize telnet subsystem */
 151         gdb_target_add_all(all_targets);
 152
 153         target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 154
 155         return ERROR_OK;
 156 }
 157
 158 static const struct command_registration openocd_command_handlers[] = {
 159         {
 160                 .name = "version",
 161                 .handler = &handle_version_command,
 162                 .mode = COMMAND_ANY,
 163                 .help = "show program version",
 164         },
 165         {
 166                 .name = "noinit",
 167                 .handler = &handle_noinit_command,
 168                 .mode = COMMAND_CONFIG,
 169                 .help = "Prevent 'init' from being called at startup.",
 170         },
 171         {
 172                 .name = "init",
 173                 .handler = &handle_init_command,
 174                 .mode = COMMAND_CONFIG,
 175                 .help = "Initializes configured targets and servers.  "
 176                         "Changes command mode from CONFIG to EXEC.  "
 177                         "Unless 'noinit' is called, this command is "
 178                         "called automatically at the end of startup.",
 179
 180         },
 181         COMMAND_REGISTRATION_DONE
 182 };
 183
 184 struct command_context *global_cmd_ctx;
 185
 186 /* NB! this fn can be invoked outside this file for non PC hosted builds */
 187 struct command_context *setup_command_handler(Jim_Interp *interp)
 188 {
 189         log_init();
 190         LOG_DEBUG("log_init: complete");
 191
 192         struct command_context *cmd_ctx;
 193
 194         global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl, interp);
 195
 196         register_commands(cmd_ctx, NULL, openocd_command_handlers);
 197         /* register subsystem commands */
 198         server_register_commands(cmd_ctx);
 199         gdb_register_commands(cmd_ctx);
 200         log_register_commands(cmd_ctx);
 201         jtag_register_commands(cmd_ctx);
 202         xsvf_register_commands(cmd_ctx);
 203         svf_register_commands(cmd_ctx);
 204         target_register_commands(cmd_ctx);
 205         flash_register_commands(cmd_ctx);
 206         nand_register_commands(cmd_ctx);
 207         pld_register_commands(cmd_ctx);
 208         mflash_register_commands(cmd_ctx);
 209
 210         LOG_DEBUG("command registration: complete");
 211
 212         LOG_OUTPUT(OPENOCD_VERSION "\n");
 213
 214         return cmd_ctx;
 215 }
 216
 217 /* normally this is the main() function entry, but if OpenOCD is linked
 218  * into application, then this fn will not be invoked, but rather that
 219  * application will have it's own implementation of main(). */
 220 int openocd_main(int argc, char *argv[])
 221 {
 222         int ret;
 223
 224         /* initialize commandline interface */
 225         struct command_context *cmd_ctx;
 226
 227         cmd_ctx = setup_command_handler(NULL);
 228
 229         if (ioutil_init(cmd_ctx) != ERROR_OK)
 230                 return EXIT_FAILURE;
 231
 232         LOG_OUTPUT("For bug reports, read\n\t"
 233                 "http://openocd.berlios.de/doc/doxygen/bugs.html"
 234                 "\n");
 235
 236
 237         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 238         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 239
 240         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 241                 return EXIT_FAILURE;
 242
 243         ret = parse_config_file(cmd_ctx);
 244         if (ret != ERROR_OK)
 245                 return EXIT_FAILURE;
 246
 247 #if BUILD_HTTPD
 248         if (httpd_start(cmd_ctx) != ERROR_OK)
 249                 return EXIT_FAILURE;
 250 #endif
 251
 252         ret = server_init(cmd_ctx);
 253         if (ERROR_OK != ret)
 254                 return EXIT_FAILURE;
 255
 256         if (init_at_startup)
 257         {
 258                 ret = command_run_line(cmd_ctx, "init");
 259                 if (ERROR_OK != ret)
 260                         ret = EXIT_FAILURE;
 261         }
 262
 263         /* handle network connections */
 264         if (ERROR_OK == ret)
 265                 server_loop(cmd_ctx);
 266
 267         server_quit();
 268
 269 #if BUILD_HTTPD
 270         httpd_stop();
 271 #endif
 272
 273         unregister_all_commands(cmd_ctx, NULL);
 274
 275         /* free commandline interface */
 276         command_done(cmd_ctx);
 277
 278         jtag_interface_quit();
 279
 280         return ret;
 281 }