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 "openocd.h"
  32 #include "jtag.h"
  33 #include "configuration.h"
  34 #include "xsvf.h"
  35 #include "svf.h"
  36 #include "nand.h"
  37 #include "pld.h"
  38 #include "mflash.h"
  39
  40 #include "server.h"
  41 #include "gdb_server.h"
  42 #include "httpd.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 (CMD_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 static bool init_at_startup = true;
  95
  96 COMMAND_HANDLER(handle_noinit_command)
  97 {
  98         if (CMD_ARGC != 0)
  99                 return ERROR_COMMAND_SYNTAX_ERROR;
 100         init_at_startup = false;
 101         return ERROR_OK;
 102 }
 103
 104 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 105 COMMAND_HANDLER(handle_init_command)
 106 {
 107
 108         if (CMD_ARGC != 0)
 109                 return ERROR_COMMAND_SYNTAX_ERROR;
 110
 111         int retval;
 112         static int initialized = 0;
 113         if (initialized)
 114                 return ERROR_OK;
 115
 116         initialized = 1;
 117
 118         atexit(exit_handler);
 119
 120         command_context_mode(CMD_CTX, COMMAND_EXEC);
 121
 122         if (target_init(CMD_CTX) != ERROR_OK)
 123                 return ERROR_FAIL;
 124         LOG_DEBUG("target init complete");
 125
 126         if ((retval = jtag_interface_init(CMD_CTX)) != ERROR_OK)
 127         {
 128                 /* we must be able to set up the jtag interface */
 129                 return retval;
 130         }
 131         LOG_DEBUG("jtag interface init complete");
 132
 133         /* Try to initialize & examine the JTAG chain at this point, but
 134          * continue startup regardless */
 135         if (jtag_init(CMD_CTX) == ERROR_OK)
 136         {
 137                 LOG_DEBUG("jtag init complete");
 138                 if (target_examine() == ERROR_OK)
 139                 {
 140                         LOG_DEBUG("jtag examine complete");
 141                 }
 142         }
 143
 144         if (flash_init_drivers(CMD_CTX) != ERROR_OK)
 145                 return ERROR_FAIL;
 146         LOG_DEBUG("flash init complete");
 147
 148         if (mflash_init_drivers(CMD_CTX) != ERROR_OK)
 149                 return ERROR_FAIL;
 150         LOG_DEBUG("mflash init complete");
 151
 152         if (nand_init(CMD_CTX) != ERROR_OK)
 153                 return ERROR_FAIL;
 154         LOG_DEBUG("NAND init complete");
 155
 156         if (pld_init(CMD_CTX) != ERROR_OK)
 157                 return ERROR_FAIL;
 158         LOG_DEBUG("pld init complete");
 159
 160         /* initialize telnet subsystem */
 161         gdb_target_add_all(all_targets);
 162
 163         target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 164
 165         return ERROR_OK;
 166 }
 167
 168 static const struct command_registration openocd_command_handlers[] = {
 169         {
 170                 .name = "version",
 171                 .handler = &handle_version_command,
 172                 .mode = COMMAND_ANY,
 173                 .help = "show program version",
 174         },
 175         {
 176                 .name = "noinit",
 177                 .handler = &handle_noinit_command,
 178                 .mode = COMMAND_CONFIG,
 179                 .help = "Prevent 'init' from being called at startup.",
 180         },
 181         {
 182                 .name = "init",
 183                 .handler = &handle_init_command,
 184                 .mode = COMMAND_CONFIG,
 185                 .help = "Initializes configured targets and servers.  "
 186                         "Changes command mode from CONFIG to EXEC.  "
 187                         "Unless 'noinit' is called, this command is "
 188                         "called automatically at the end of startup.",
 189
 190         },
 191         COMMAND_REGISTRATION_DONE
 192 };
 193
 194 struct command_context *global_cmd_ctx;
 195
 196 /* NB! this fn can be invoked outside this file for non PC hosted builds */
 197 struct command_context *setup_command_handler(void)
 198 {
 199         log_init();
 200         LOG_DEBUG("log_init: complete");
 201
 202         struct command_context *cmd_ctx;
 203
 204         global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl);
 205
 206         register_commands(cmd_ctx, NULL, openocd_command_handlers);
 207         /* register subsystem commands */
 208         server_register_commands(cmd_ctx);
 209         gdb_register_commands(cmd_ctx);
 210         log_register_commands(cmd_ctx);
 211         jtag_register_commands(cmd_ctx);
 212         xsvf_register_commands(cmd_ctx);
 213         svf_register_commands(cmd_ctx);
 214         target_register_commands(cmd_ctx);
 215         flash_register_commands(cmd_ctx);
 216         nand_register_commands(cmd_ctx);
 217         pld_register_commands(cmd_ctx);
 218         mflash_register_commands(cmd_ctx);
 219
 220         LOG_DEBUG("command registration: complete");
 221
 222         LOG_OUTPUT(OPENOCD_VERSION "\n");
 223
 224         return cmd_ctx;
 225 }
 226
 227 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
 228 /* implementations of OpenOCD that uses multithreading needs to know when
 229  * OpenOCD is sleeping. No-op in vanilla OpenOCD
 230  */
 231 void openocd_sleep_prelude(void)
 232 {
 233 }
 234
 235 void openocd_sleep_postlude(void)
 236 {
 237 }
 238 #endif
 239
 240
 241 /* normally this is the main() function entry, but if OpenOCD is linked
 242  * into application, then this fn will not be invoked, but rather that
 243  * application will have it's own implementation of main(). */
 244 int openocd_main(int argc, char *argv[])
 245 {
 246         int ret;
 247
 248         /* initialize commandline interface */
 249         struct command_context *cmd_ctx;
 250
 251         cmd_ctx = setup_command_handler();
 252
 253 #if BUILD_IOUTIL
 254         if (ioutil_init(cmd_ctx) != ERROR_OK)
 255         {
 256                 return EXIT_FAILURE;
 257         }
 258 #endif
 259
 260         LOG_OUTPUT("For bug reports, read\n\t"
 261                 "http://openocd.berlios.de/doc/doxygen/bugs.html"
 262                 "\n");
 263
 264
 265         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 266         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 267
 268         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 269                 return EXIT_FAILURE;
 270
 271         ret = parse_config_file(cmd_ctx);
 272         if (ret != ERROR_OK)
 273                 return EXIT_FAILURE;
 274
 275 #if BUILD_HTTPD
 276         if (httpd_start(cmd_ctx) != ERROR_OK)
 277                 return EXIT_FAILURE;
 278 #endif
 279
 280         ret = server_init();
 281         if (ERROR_OK != ret)
 282                 return EXIT_FAILURE;
 283
 284         if (init_at_startup)
 285         {
 286                 ret = command_run_line(cmd_ctx, "init");
 287                 if (ERROR_OK != ret)
 288                         ret = EXIT_FAILURE;
 289         }
 290
 291         /* handle network connections */
 292         if (ERROR_OK == ret)
 293                 server_loop(cmd_ctx);
 294
 295         server_quit();
 296
 297 #if BUILD_HTTPD
 298         httpd_stop();
 299 #endif
 300
 301         unregister_all_commands(cmd_ctx, NULL);
 302
 303         /* free commandline interface */
 304         command_done(cmd_ctx);
 305
 306         return ret;
 307 }