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