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 #define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV
  28
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #include "log.h"
  34 #include "types.h"
  35 #include "jtag.h"
  36 #include "configuration.h"
  37 #include "xsvf.h"
  38 #include "svf.h"
  39 #include "target.h"
  40 #include "flash.h"
  41 #include "nand.h"
  42 #include "pld.h"
  43 #include "mflash.h"
  44
  45 #include "command.h"
  46 #include "server.h"
  47 #include "telnet_server.h"
  48 #include "gdb_server.h"
  49 #include "tcl_server.h"
  50
  51 #include <sys/time.h>
  52 #include <sys/types.h>
  53 #include <strings.h>
  54 #include <stdio.h>
  55 #include <stdlib.h>
  56 #include <string.h>
  57 #include <unistd.h>
  58 #include <errno.h>
  59
  60 #ifdef _WIN32
  61 #include <malloc.h>
  62 #else
  63 #include <alloca.h>
  64 #endif
  65
  66 #include "replacements.h"
  67
  68 void print_version(void)
  69 {
  70         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
  71         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
  72         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
  73         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
  74         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
  75         LOG_OUTPUT("$URL$\n");
  76         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
  77         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
  78         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
  79         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
  80         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
  81 }
  82
  83 /* Give TELNET a way to find out what version this is */
  84 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
  85 {
  86         if (argc!=0)
  87                 return ERROR_COMMAND_SYNTAX_ERROR;
  88
  89         command_print(cmd_ctx, OPENOCD_VERSION);
  90
  91         return ERROR_OK;
  92 }
  93
  94 void exit_handler(void)
  95 {
  96         /* close JTAG interface */
  97         if (jtag && jtag->quit)
  98                 jtag->quit();
  99 }
 100
 101 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
 102 {
 103         switch (event)
 104         {
 105                 case TARGET_EVENT_GDB_START:
 106                         target->display=0;
 107                         break;
 108                 case TARGET_EVENT_GDB_END:
 109                         target->display=1;
 110                         break;
 111                 case TARGET_EVENT_HALTED:
 112                         if (target->display)
 113                         {
 114                                 /* do not display information when debugger caused the halt */
 115                                 target_arch_state(target);
 116                         }
 117                         break;
 118                 default:
 119                         break;
 120         }
 121
 122         return ERROR_OK;
 123 }
 124
 125 int ioutil_init(struct command_context_s *cmd_ctx);
 126
 127 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 128 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 129 {
 130
 131         if (argc!=0)
 132                 return ERROR_COMMAND_SYNTAX_ERROR;
 133
 134         int retval;
 135         static int initialized=0;
 136         if (initialized)
 137                 return ERROR_OK;
 138
 139         initialized=1;
 140
 141         atexit(exit_handler);
 142
 143         if (target_init(cmd_ctx) != ERROR_OK)
 144                 return ERROR_FAIL;
 145         LOG_DEBUG("target init complete");
 146
 147         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
 148         {
 149                 /* we must be able to set up the jtag interface */
 150                 return retval;
 151         }
 152         LOG_DEBUG("jtag interface init complete");
 153
 154         /* Try to initialize & examine the JTAG chain at this point, but
 155          * continue startup regardless */
 156         if (jtag_init(cmd_ctx) == ERROR_OK)
 157         {
 158                 LOG_DEBUG("jtag init complete");
 159                 if (target_examine() == ERROR_OK)
 160                 {
 161                         LOG_DEBUG("jtag examine complete");
 162                 }
 163         }
 164
 165         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
 166                 return ERROR_FAIL;
 167         LOG_DEBUG("flash init complete");
 168
 169         if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
 170                 return ERROR_FAIL;
 171         LOG_DEBUG("mflash init complete");
 172
 173         if (nand_init(cmd_ctx) != ERROR_OK)
 174                 return ERROR_FAIL;
 175         LOG_DEBUG("NAND init complete");
 176
 177         if (pld_init(cmd_ctx) != ERROR_OK)
 178                 return ERROR_FAIL;
 179         LOG_DEBUG("pld init complete");
 180
 181         /* initialize tcp server */
 182         server_init();
 183
 184         /* initialize telnet subsystem */
 185         telnet_init("Open On-Chip Debugger");
 186         gdb_init();
 187         tcl_init(); /* allows tcl to just connect without going thru telnet */
 188
 189         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
 190
 191         return ERROR_OK;
 192 }
 193
 194 command_context_t *global_cmd_ctx;
 195
 196 command_context_t *setup_command_handler(void)
 197 {
 198         command_context_t *cmd_ctx;
 199
 200         global_cmd_ctx = cmd_ctx = command_init();
 201
 202         register_command(cmd_ctx, NULL, "version", handle_version_command,
 203                                          COMMAND_EXEC, "show OpenOCD version");
 204
 205         /* register subsystem commands */
 206         server_register_commands(cmd_ctx);
 207         telnet_register_commands(cmd_ctx);
 208         gdb_register_commands(cmd_ctx);
 209         tcl_register_commands(cmd_ctx); /* tcl server commands */
 210         log_register_commands(cmd_ctx);
 211         jtag_register_commands(cmd_ctx);
 212         xsvf_register_commands(cmd_ctx);
 213         svf_register_commands(cmd_ctx);
 214         target_register_commands(cmd_ctx);
 215         flash_register_commands(cmd_ctx);
 216         nand_register_commands(cmd_ctx);
 217         pld_register_commands(cmd_ctx);
 218         mflash_register_commands(cmd_ctx);
 219
 220         if (log_init(cmd_ctx) != ERROR_OK)
 221         {
 222                 exit(-1);
 223         }
 224         LOG_DEBUG("log init complete");
 225
 226         LOG_OUTPUT( OPENOCD_VERSION "\n" );
 227
 228         register_command(cmd_ctx, NULL, "init", handle_init_command,
 229                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
 230
 231         return cmd_ctx;
 232 }
 233
 234 int httpd_start(void);
 235 void httpd_stop(void);
 236
 237 /* normally this is the main() function entry, but if OpenOCD is linked
 238  * into application, then this fn will not be invoked, but rather that
 239  * application will have it's own implementation of main(). */
 240 int openocd_main(int argc, char *argv[])
 241 {
 242         int ret;
 243
 244         /* initialize commandline interface */
 245         command_context_t *cmd_ctx;
 246
 247         cmd_ctx = setup_command_handler();
 248
 249 #if BUILD_IOUTIL
 250         if (ioutil_init(cmd_ctx) != ERROR_OK)
 251         {
 252                 return EXIT_FAILURE;
 253         }
 254 #endif
 255
 256         LOG_OUTPUT("\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
 257
 258         print_version();
 259
 260         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 261         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 262
 263         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 264                 return EXIT_FAILURE;
 265
 266         ret = parse_config_file(cmd_ctx);
 267         if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
 268                 return EXIT_FAILURE;
 269
 270 #if BUILD_HTTPD
 271         if (httpd_start()!=ERROR_OK)
 272                 return EXIT_FAILURE;
 273 #endif
 274
 275         if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
 276         {
 277                 command_context_mode(cmd_ctx, COMMAND_EXEC);
 278                 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
 279                         return EXIT_FAILURE;
 280
 281                 /* handle network connections */
 282                 server_loop(cmd_ctx);
 283         }
 284
 285         /* shut server down */
 286         server_quit();
 287
 288 #if BUILD_HTTPD
 289         httpd_stop();
 290 #endif
 291
 292         unregister_all_commands(cmd_ctx);
 293
 294         /* free commandline interface */
 295         command_done(cmd_ctx);
 296
 297
 298         return EXIT_SUCCESS;
 299 }