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