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 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include "jtag.h"
  32 #include "configuration.h"
  33 #include "xsvf.h"
  34 #include "svf.h"
  35 #include "nand.h"
  36 #include "pld.h"
  37 #include "mflash.h"
  38
  39 #include "server.h"
  40 #include "telnet_server.h"
  41 #include "gdb_server.h"
  42 #include "tcl_server.h"
  43
  44 #ifdef HAVE_STRINGS_H
  45 #include <strings.h>
  46 #endif
  47
  48
  49 #define OPENOCD_VERSION \
  50                 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
  51
  52 /* Give TELNET a way to find out what version this is */
  53 COMMAND_HANDLER(handle_version_command)
  54 {
  55         if (argc != 0)
  56                 return ERROR_COMMAND_SYNTAX_ERROR;
  57
  58         command_print(cmd_ctx, OPENOCD_VERSION);
  59
  60         return ERROR_OK;
  61 }
  62
  63 static void exit_handler(void)
  64 {
  65         jtag_interface_quit();
  66 }
  67
  68 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
  69 {
  70         switch (event)
  71         {
  72                 case TARGET_EVENT_GDB_START:
  73                         target->display = 0;
  74                         break;
  75                 case TARGET_EVENT_GDB_END:
  76                         target->display = 1;
  77                         break;
  78                 case TARGET_EVENT_HALTED:
  79                         if (target->display)
  80                         {
  81                                 /* do not display information when debugger caused the halt */
  82                                 target_arch_state(target);
  83                         }
  84                         break;
  85                 default:
  86                         break;
  87         }
  88
  89         return ERROR_OK;
  90 }
  91
  92 int ioutil_init(struct command_context *cmd_ctx);
  93
  94 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
  95 COMMAND_HANDLER(handle_init_command)
  96 {
  97
  98         if (argc != 0)
  99                 return ERROR_COMMAND_SYNTAX_ERROR;
 100
 101         int retval;
 102         static int initialized = 0;
 103         if (initialized)
 104                 return ERROR_OK;
 105
 106         initialized = 1;
 107
 108         atexit(exit_handler);
 109
 110         if (target_init(cmd_ctx) != ERROR_OK)
 111                 return ERROR_FAIL;
 112         LOG_DEBUG("target init complete");
 113
 114         if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
 115         {
 116                 /* we must be able to set up the jtag interface */
 117                 return retval;
 118         }
 119         LOG_DEBUG("jtag interface init complete");
 120
 121         /* Try to initialize & examine the JTAG chain at this point, but
 122          * continue startup regardless */
 123         if (jtag_init(cmd_ctx) == ERROR_OK)
 124         {
 125                 LOG_DEBUG("jtag init complete");
 126                 if (target_examine() == ERROR_OK)
 127                 {
 128                         LOG_DEBUG("jtag examine complete");
 129                 }
 130         }
 131
 132         if (flash_init_drivers(cmd_ctx) != ERROR_OK)
 133                 return ERROR_FAIL;
 134         LOG_DEBUG("flash init complete");
 135
 136         if (mflash_init_drivers(cmd_ctx) != ERROR_OK)
 137                 return ERROR_FAIL;
 138         LOG_DEBUG("mflash init complete");
 139
 140         if (nand_init(cmd_ctx) != ERROR_OK)
 141                 return ERROR_FAIL;
 142         LOG_DEBUG("NAND init complete");
 143
 144         if (pld_init(cmd_ctx) != ERROR_OK)
 145                 return ERROR_FAIL;
 146         LOG_DEBUG("pld init complete");
 147
 148         /* initialize tcp server */
 149         server_init();
 150
 151         /* initialize telnet subsystem */
 152         telnet_init("Open On-Chip Debugger");
 153         gdb_init();
 154         tcl_init(); /* allows tcl to just connect without going thru telnet */
 155
 156         target_register_event_callback(log_target_callback_event_handler, cmd_ctx);
 157
 158         return ERROR_OK;
 159 }
 160
 161 struct command_context *global_cmd_ctx;
 162
 163 /// src/hello.c gives a simple example for writing new command modules
 164 int hello_register_commands(struct command_context *cmd_ctx);
 165
 166 /* NB! this fn can be invoked outside this file for non PC hosted builds */
 167 struct command_context *setup_command_handler(void)
 168 {
 169         struct command_context *cmd_ctx;
 170
 171         global_cmd_ctx = cmd_ctx = command_init();
 172
 173         register_command(cmd_ctx, NULL, "version", handle_version_command,
 174                                          COMMAND_EXEC, "show OpenOCD version");
 175
 176         /* register subsystem commands */
 177         hello_register_commands(cmd_ctx);
 178         server_register_commands(cmd_ctx);
 179         telnet_register_commands(cmd_ctx);
 180         gdb_register_commands(cmd_ctx);
 181         tcl_register_commands(cmd_ctx); /* tcl server commands */
 182         log_register_commands(cmd_ctx);
 183         jtag_register_commands(cmd_ctx);
 184         xsvf_register_commands(cmd_ctx);
 185         svf_register_commands(cmd_ctx);
 186         target_register_commands(cmd_ctx);
 187         flash_register_commands(cmd_ctx);
 188         nand_register_commands(cmd_ctx);
 189         pld_register_commands(cmd_ctx);
 190         mflash_register_commands(cmd_ctx);
 191
 192         if (log_init(cmd_ctx) != ERROR_OK)
 193         {
 194                 exit(-1);
 195         }
 196         LOG_DEBUG("log init complete");
 197
 198         LOG_OUTPUT(OPENOCD_VERSION "\n");
 199
 200         register_command(cmd_ctx, NULL, "init", handle_init_command,
 201                                          COMMAND_ANY, "initializes target and servers - nop on subsequent invocations");
 202
 203         return cmd_ctx;
 204 }
 205
 206 int httpd_start(void);
 207 void httpd_stop(void);
 208
 209
 210 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
 211 /* implementations of OpenOCD that uses multithreading needs to know when
 212  * OpenOCD is sleeping. No-op in vanilla OpenOCD
 213  */
 214 void openocd_sleep_prelude(void)
 215 {
 216 }
 217
 218 void openocd_sleep_postlude(void)
 219 {
 220 }
 221 #endif
 222
 223
 224 /* normally this is the main() function entry, but if OpenOCD is linked
 225  * into application, then this fn will not be invoked, but rather that
 226  * application will have it's own implementation of main(). */
 227 int openocd_main(int argc, char *argv[])
 228 {
 229         int ret;
 230
 231         /* initialize commandline interface */
 232         struct command_context *cmd_ctx;
 233
 234         cmd_ctx = setup_command_handler();
 235
 236 #if BUILD_IOUTIL
 237         if (ioutil_init(cmd_ctx) != ERROR_OK)
 238         {
 239                 return EXIT_FAILURE;
 240         }
 241 #endif
 242
 243         LOG_OUTPUT("For bug reports, read\n\t"
 244                 "http://openocd.berlios.de/doc/doxygen/bugs.html"
 245                 "\n");
 246
 247
 248         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 249         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 250
 251         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 252                 return EXIT_FAILURE;
 253
 254         ret = parse_config_file(cmd_ctx);
 255         if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION))
 256                 return EXIT_FAILURE;
 257
 258 #if BUILD_HTTPD
 259         if (httpd_start() != ERROR_OK)
 260                 return EXIT_FAILURE;
 261 #endif
 262
 263         if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
 264         {
 265                 command_context_mode(cmd_ctx, COMMAND_EXEC);
 266                 if (command_run_line(cmd_ctx, "init") != ERROR_OK)
 267                         return EXIT_FAILURE;
 268
 269                 /* handle network connections */
 270                 server_loop(cmd_ctx);
 271         }
 272
 273         /* shut server down */
 274         server_quit();
 275
 276 #if BUILD_HTTPD
 277         httpd_stop();
 278 #endif
 279
 280         unregister_all_commands(cmd_ctx);
 281
 282         /* free commandline interface */
 283         command_done(cmd_ctx);
 284
 285
 286         return EXIT_SUCCESS;
 287 }