src/openocd.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #define OPENOCD_VERSION "Open On-Chip Debugger " VERSION " (" PKGBLDDATE ") svn:" PKGBLDREV
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include "log.h"
  28 #include "types.h"
  29 #include "jtag.h"
  30 #include "configuration.h"
  31 #include "xsvf.h"
  32 #include "target.h"
  33 #include "flash.h"
  34 #include "nand.h"
  35 #include "pld.h"
  36
  37 #include "command.h"
  38 #include "server.h"
  39 #include "telnet_server.h"
  40 #include "gdb_server.h"
  41 #include "tcl_server.h"
  42
  43 #include <sys/time.h>
  44 #include <sys/types.h>
  45 #include <strings.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49 #include <unistd.h>
  50 #include <errno.h>
  51
  52 #ifdef _WIN32
  53 #include <malloc.h>
  54 #else
  55 #include <alloca.h>
  56 #endif
  57
  58 #include "replacements.h"
  59
  60
  61 /* Give TELNET a way to find out what version this is */
  62 int handle_version_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
  63 {
  64         command_print(cmd_ctx, OPENOCD_VERSION);
  65
  66         return ERROR_OK;
  67 }
  68
  69
  70 void exit_handler(void)
  71 {
  72         /* close JTAG interface */
  73         if (jtag && jtag->quit)
  74                 jtag->quit();
  75 }
  76
  77 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
  78 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
  79 {
  80         int retval;
  81         static int initialized=0;
  82         if (initialized)
  83                 return ERROR_OK;
  84
  85         initialized=1;
  86
  87         atexit(exit_handler);
  88
  89         if (target_init(cmd_ctx) != ERROR_OK)
  90                 return ERROR_FAIL;
  91         LOG_DEBUG("target init complete");
  92
  93         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
  94         {
  95                 /* we must be able to set up the jtag interface */
  96                 return retval;
  97         }
  98         LOG_DEBUG("jtag interface init complete");
  99
 100         /* Try to initialize & examine the JTAG chain at this point, but
 101          * continue startup regardless */
 102         if (jtag_init(cmd_ctx) == ERROR_OK)
 103         {
 104                 LOG_DEBUG("jtag init complete");
 105                 if (target_examine(cmd_ctx) == ERROR_OK)
 106                 {
 107                         LOG_DEBUG("jtag examine complete");
 108                 }
 109         }
 110
 111         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
 112                 return ERROR_FAIL;
 113         LOG_DEBUG("flash init complete");
 114
 115         if (nand_init(cmd_ctx) != ERROR_OK)
 116                 return ERROR_FAIL;
 117         LOG_DEBUG("NAND init complete");
 118
 119         if (pld_init(cmd_ctx) != ERROR_OK)
 120                 return ERROR_FAIL;
 121         LOG_DEBUG("pld init complete");
 122
 123         /* initialize tcp server */
 124         server_init();
 125
 126         /* initialize telnet subsystem */
 127         telnet_init("Open On-Chip Debugger");
 128         gdb_init();
 129         tcl_init(); /* allows tcl to just connect without going thru telnet */
 130
 131         return ERROR_OK;
 132 }
 133
 134 command_context_t *setup_command_handler(void)
 135 {
 136         command_context_t *cmd_ctx;
 137
 138         cmd_ctx = command_init();
 139
 140         register_command(cmd_ctx, NULL, "version", handle_version_command,
 141                                          COMMAND_EXEC, "show OpenOCD version");
 142
 143         /* register subsystem commands */
 144         server_register_commands(cmd_ctx);
 145         telnet_register_commands(cmd_ctx);
 146         gdb_register_commands(cmd_ctx);
 147         tcl_register_commands(cmd_ctx); /* tcl server commands */
 148         log_register_commands(cmd_ctx);
 149         jtag_register_commands(cmd_ctx);
 150         xsvf_register_commands(cmd_ctx);
 151         target_register_commands(cmd_ctx);
 152         flash_register_commands(cmd_ctx);
 153         nand_register_commands(cmd_ctx);
 154         pld_register_commands(cmd_ctx);
 155
 156         if (log_init(cmd_ctx) != ERROR_OK)
 157         {
 158                 exit(-1);
 159         }
 160         LOG_DEBUG("log init complete");
 161
 162         LOG_OUTPUT( OPENOCD_VERSION "\n" );
 163
 164         register_command(cmd_ctx, NULL, "init", handle_init_command,
 165                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
 166
 167         return cmd_ctx;
 168 }
 169
 170 /* normally this is the main() function entry, but if OpenOCD is linked
 171  * into application, then this fn will not be invoked, but rather that
 172  * application will have it's own implementation of main(). */
 173 int openocd_main(int argc, char *argv[])
 174 {
 175         /* initialize commandline interface */
 176         command_context_t *cmd_ctx;
 177
 178         cmd_ctx = setup_command_handler();
 179
 180         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 181         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 182         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 183         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 184         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 185         LOG_OUTPUT( "$URL$\n");
 186         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 187         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 188         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 189         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 190         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 191
 192         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 193         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 194
 195         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 196                 return EXIT_FAILURE;
 197
 198         if (parse_config_file(cmd_ctx) != ERROR_OK)
 199                 return EXIT_FAILURE;
 200
 201         command_context_mode(cmd_ctx, COMMAND_EXEC);
 202         if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
 203                 return EXIT_FAILURE;
 204
 205         /* handle network connections */
 206         server_loop(cmd_ctx);
 207
 208         /* shut server down */
 209         server_quit();
 210
 211         unregister_all_commands(cmd_ctx);
 212
 213         /* free commandline interface */
 214         command_done(cmd_ctx);
 215
 216         return EXIT_SUCCESS;
 217 }