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_GDB_START:
 110                         target->display=0;
 111                         break;
 112                 case TARGET_EVENT_GDB_END:
 113                         target->display=1;
 114                         break;
 115                 case TARGET_EVENT_HALTED:
 116                         if (target->display)
 117                         {
 118                                 /* do not display information when debugger caused the halt */
 119                                 target_arch_state(target);
 120                         }
 121                         break;
 122                 default:
 123                         break;
 124         }
 125
 126         return ERROR_OK;
 127 }
 128
 129 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 130 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 131 {
 132         int retval;
 133         static int initialized=0;
 134         if (initialized)
 135                 return ERROR_OK;
 136
 137         initialized=1;
 138
 139         atexit(exit_handler);
 140
 141         if (target_init(cmd_ctx) != ERROR_OK)
 142                 return ERROR_FAIL;
 143         LOG_DEBUG("target init complete");
 144
 145         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
 146         {
 147                 /* we must be able to set up the jtag interface */
 148                 return retval;
 149         }
 150         LOG_DEBUG("jtag interface init complete");
 151
 152         /* Try to initialize & examine the JTAG chain at this point, but
 153          * continue startup regardless */
 154         if (jtag_init(cmd_ctx) == ERROR_OK)
 155         {
 156                 LOG_DEBUG("jtag init complete");
 157                 if (target_examine() == ERROR_OK)
 158                 {
 159                         LOG_DEBUG("jtag examine complete");
 160                 }
 161         }
 162
 163         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
 164                 return ERROR_FAIL;
 165         LOG_DEBUG("flash init complete");
 166
 167         if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
 168                 return ERROR_FAIL;
 169         LOG_DEBUG("mflash init complete");
 170
 171         if (nand_init(cmd_ctx) != ERROR_OK)
 172                 return ERROR_FAIL;
 173         LOG_DEBUG("NAND init complete");
 174
 175         if (pld_init(cmd_ctx) != ERROR_OK)
 176                 return ERROR_FAIL;
 177         LOG_DEBUG("pld init complete");
 178
 179         /* initialize tcp server */
 180         server_init();
 181
 182         /* initialize telnet subsystem */
 183         telnet_init("Open On-Chip Debugger");
 184         gdb_init();
 185         tcl_init(); /* allows tcl to just connect without going thru telnet */
 186
 187         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
 188
 189         return ERROR_OK;
 190 }
 191
 192 command_context_t *global_cmd_ctx;
 193
 194 command_context_t *setup_command_handler(void)
 195 {
 196         command_context_t *cmd_ctx;
 197
 198         global_cmd_ctx = cmd_ctx = command_init();
 199
 200         register_command(cmd_ctx, NULL, "version", handle_version_command,
 201                                          COMMAND_EXEC, "show OpenOCD version");
 202
 203         /* register subsystem commands */
 204         server_register_commands(cmd_ctx);
 205         telnet_register_commands(cmd_ctx);
 206         gdb_register_commands(cmd_ctx);
 207         tcl_register_commands(cmd_ctx); /* tcl server commands */
 208         log_register_commands(cmd_ctx);
 209         jtag_register_commands(cmd_ctx);
 210         xsvf_register_commands(cmd_ctx);
 211         target_register_commands(cmd_ctx);
 212         flash_register_commands(cmd_ctx);
 213         nand_register_commands(cmd_ctx);
 214         pld_register_commands(cmd_ctx);
 215         mflash_register_commands(cmd_ctx);
 216
 217         if (log_init(cmd_ctx) != ERROR_OK)
 218         {
 219                 exit(-1);
 220         }
 221         LOG_DEBUG("log init complete");
 222
 223         LOG_OUTPUT( OPENOCD_VERSION "\n" );
 224
 225         register_command(cmd_ctx, NULL, "init", handle_init_command,
 226                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
 227
 228         return cmd_ctx;
 229 }
 230
 231 /* normally this is the main() function entry, but if OpenOCD is linked
 232  * into application, then this fn will not be invoked, but rather that
 233  * application will have it's own implementation of main(). */
 234 int openocd_main(int argc, char *argv[])
 235 {
 236         int ret;
 237
 238         /* initialize commandline interface */
 239         command_context_t *cmd_ctx;
 240
 241         cmd_ctx = setup_command_handler();
 242
 243         LOG_OUTPUT( "\n\nBUGS? Read http://svn.berlios.de/svnroot/repos/openocd/trunk/BUGS\n\n\n");
 244
 245         print_version();
 246
 247         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 248         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 249
 250         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 251                 return EXIT_FAILURE;
 252
 253         ret = parse_config_file(cmd_ctx);
 254         if ( (ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION) )
 255                 return EXIT_FAILURE;
 256
 257         if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
 258         {
 259                 command_context_mode(cmd_ctx, COMMAND_EXEC);
 260                 if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
 261                         return EXIT_FAILURE;
 262
 263                 /* handle network connections */
 264                 server_loop(cmd_ctx);
 265         }
 266
 267         /* shut server down */
 268         server_quit();
 269
 270         unregister_all_commands(cmd_ctx);
 271
 272         /* free commandline interface */
 273         command_done(cmd_ctx);
 274
 275         return EXIT_SUCCESS;
 276 }