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