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 static int log_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
  78 {
  79         switch (event)
  80         {
  81                 case TARGET_EVENT_HALTED:
  82                         target_arch_state(target);
  83                         break;
  84                 default:
  85                         break;
  86         }
  87
  88         return ERROR_OK;
  89 }
  90
  91
  92
  93 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
  94 int handle_init_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
  95 {
  96         int retval;
  97         static int initialized=0;
  98         if (initialized)
  99                 return ERROR_OK;
 100
 101         initialized=1;
 102
 103         atexit(exit_handler);
 104
 105         if (target_init(cmd_ctx) != ERROR_OK)
 106                 return ERROR_FAIL;
 107         LOG_DEBUG("target init complete");
 108
 109         if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
 110         {
 111                 /* we must be able to set up the jtag interface */
 112                 return retval;
 113         }
 114         LOG_DEBUG("jtag interface init complete");
 115
 116         /* Try to initialize & examine the JTAG chain at this point, but
 117          * continue startup regardless */
 118         if (jtag_init(cmd_ctx) == ERROR_OK)
 119         {
 120                 LOG_DEBUG("jtag init complete");
 121                 if (target_examine(cmd_ctx) == ERROR_OK)
 122                 {
 123                         LOG_DEBUG("jtag examine complete");
 124                 }
 125         }
 126
 127         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
 128                 return ERROR_FAIL;
 129         LOG_DEBUG("flash init complete");
 130
 131         if (nand_init(cmd_ctx) != ERROR_OK)
 132                 return ERROR_FAIL;
 133         LOG_DEBUG("NAND init complete");
 134
 135         if (pld_init(cmd_ctx) != ERROR_OK)
 136                 return ERROR_FAIL;
 137         LOG_DEBUG("pld init complete");
 138
 139         /* initialize tcp server */
 140         server_init();
 141
 142         /* initialize telnet subsystem */
 143         telnet_init("Open On-Chip Debugger");
 144         gdb_init();
 145         tcl_init(); /* allows tcl to just connect without going thru telnet */
 146
 147         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
 148
 149
 150
 151         return ERROR_OK;
 152 }
 153
 154 command_context_t *global_cmd_ctx;
 155
 156 command_context_t *setup_command_handler(void)
 157 {
 158         command_context_t *cmd_ctx;
 159
 160         global_cmd_ctx = cmd_ctx = command_init();
 161
 162         register_command(cmd_ctx, NULL, "version", handle_version_command,
 163                                          COMMAND_EXEC, "show OpenOCD version");
 164
 165         /* register subsystem commands */
 166         server_register_commands(cmd_ctx);
 167         telnet_register_commands(cmd_ctx);
 168         gdb_register_commands(cmd_ctx);
 169         tcl_register_commands(cmd_ctx); /* tcl server commands */
 170         log_register_commands(cmd_ctx);
 171         jtag_register_commands(cmd_ctx);
 172         xsvf_register_commands(cmd_ctx);
 173         target_register_commands(cmd_ctx);
 174         flash_register_commands(cmd_ctx);
 175         nand_register_commands(cmd_ctx);
 176         pld_register_commands(cmd_ctx);
 177
 178         if (log_init(cmd_ctx) != ERROR_OK)
 179         {
 180                 exit(-1);
 181         }
 182         LOG_DEBUG("log init complete");
 183
 184         LOG_OUTPUT( OPENOCD_VERSION "\n" );
 185
 186         register_command(cmd_ctx, NULL, "init", handle_init_command,
 187                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
 188
 189         return cmd_ctx;
 190 }
 191
 192 /* normally this is the main() function entry, but if OpenOCD is linked
 193  * into application, then this fn will not be invoked, but rather that
 194  * application will have it's own implementation of main(). */
 195 int openocd_main(int argc, char *argv[])
 196 {
 197         /* initialize commandline interface */
 198         command_context_t *cmd_ctx;
 199
 200         cmd_ctx = setup_command_handler();
 201
 202         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 203         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 204         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 205         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 206         /* DANGER!!! make sure that the line below does not appear in a patch, do not remove */
 207         LOG_OUTPUT( "$URL$\n");
 208         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 209         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 210         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 211         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 212         /* DANGER!!! make sure that the line above does not appear in a patch, do not remove */
 213
 214         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 215         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 216
 217         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 218                 return EXIT_FAILURE;
 219
 220         if (parse_config_file(cmd_ctx) != ERROR_OK)
 221                 return EXIT_FAILURE;
 222
 223         command_context_mode(cmd_ctx, COMMAND_EXEC);
 224         if (command_run_line(cmd_ctx, "init")!=ERROR_OK)
 225                 return EXIT_FAILURE;
 226
 227         /* handle network connections */
 228         server_loop(cmd_ctx);
 229
 230         /* shut server down */
 231         server_quit();
 232
 233         unregister_all_commands(cmd_ctx);
 234
 235         /* free commandline interface */
 236         command_done(cmd_ctx);
 237
 238         return EXIT_SUCCESS;
 239 }