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/driver.h>
  33 #include <jtag/jtag.h>
  34 #include <helper/ioutil.h>
  35 #include <helper/configuration.h>
  36 #include <xsvf/xsvf.h>
  37 #include <svf/svf.h>
  38 #include <flash/nor/core.h>
  39 #include <flash/nand/core.h>
  40 #include <pld/pld.h>
  41 #include <flash/mflash.h>
  42
  43 #include <server/server.h>
  44 #include <server/gdb_server.h>
  45 #include <server/httpd.h>
  46
  47 #ifdef HAVE_STRINGS_H
  48 #include <strings.h>
  49 #endif
  50
  51
  52 #define OPENOCD_VERSION \
  53                 "Open On-Chip Debugger " VERSION RELSTR " (" PKGBLDDATE ")"
  54
  55 /* Give TELNET a way to find out what version this is */
  56 COMMAND_HANDLER(handle_version_command)
  57 {
  58         if (CMD_ARGC != 0)
  59                 return ERROR_COMMAND_SYNTAX_ERROR;
  60
  61         command_print(CMD_CTX, OPENOCD_VERSION);
  62
  63         return ERROR_OK;
  64 }
  65
  66 static int log_target_callback_event_handler(struct target *target, enum target_event event, void *priv)
  67 {
  68         switch (event)
  69         {
  70                 case TARGET_EVENT_GDB_START:
  71                         target->display = 0;
  72                         break;
  73                 case TARGET_EVENT_GDB_END:
  74                         target->display = 1;
  75                         break;
  76                 case TARGET_EVENT_HALTED:
  77                         if (target->display)
  78                         {
  79                                 /* do not display information when debugger caused the halt */
  80                                 target_arch_state(target);
  81                         }
  82                         break;
  83                 default:
  84                         break;
  85         }
  86
  87         return ERROR_OK;
  88 }
  89
  90 static bool init_at_startup = true;
  91
  92 COMMAND_HANDLER(handle_noinit_command)
  93 {
  94         if (CMD_ARGC != 0)
  95                 return ERROR_COMMAND_SYNTAX_ERROR;
  96         init_at_startup = false;
  97         return ERROR_OK;
  98 }
  99
 100 /* OpenOCD can't really handle failure of this command. Patches welcome! :-) */
 101 COMMAND_HANDLER(handle_init_command)
 102 {
 103
 104         if (CMD_ARGC != 0)
 105                 return ERROR_COMMAND_SYNTAX_ERROR;
 106
 107         int retval;
 108         static int initialized = 0;
 109         if (initialized)
 110                 return ERROR_OK;
 111
 112         initialized = 1;
 113
 114         retval = command_run_line(CMD_CTX, "target init");
 115         if (ERROR_OK != retval)
 116                 return ERROR_FAIL;
 117
 118         if ((retval = adapter_init(CMD_CTX)) != ERROR_OK)
 119         {
 120                 /* we must be able to set up the debug adapter */
 121                 return retval;
 122         }
 123         LOG_DEBUG("Debug Adapter init complete");
 124
 125         /* Try to initialize & examine the JTAG chain at this point,
 126          * but continue startup regardless.  Note that platforms
 127          * need to be able to provide JTAG event handlers that use
 128          * a variety of JTAG operations in order to do that...
 129          */
 130         command_context_mode(CMD_CTX, COMMAND_EXEC);
 131         if (command_run_line(CMD_CTX, "jtag init") == ERROR_OK)
 132         {
 133                 LOG_DEBUG("Examining targets...");
 134                 if (target_examine() != ERROR_OK)
 135                         LOG_DEBUG("target examination failed");
 136         }
 137         else
 138                 LOG_WARNING("jtag initialization failed; try 'jtag init' again.");
 139         command_context_mode(CMD_CTX, COMMAND_CONFIG);
 140
 141         if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
 142                 return ERROR_FAIL;
 143
 144         if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
 145                 return ERROR_FAIL;
 146
 147         if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
 148                 return ERROR_FAIL;
 149
 150         if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
 151                 return ERROR_FAIL;
 152         command_context_mode(CMD_CTX, COMMAND_EXEC);
 153
 154         /* initialize telnet subsystem */
 155         gdb_target_add_all(all_targets);
 156
 157         target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 158
 159         return ERROR_OK;
 160 }
 161
 162 COMMAND_HANDLER(handle_add_script_search_dir_command)
 163 {
 164         if (CMD_ARGC != 1)
 165                 return ERROR_COMMAND_SYNTAX_ERROR;
 166
 167         add_script_search_dir(CMD_ARGV[0]);
 168
 169         return ERROR_OK;
 170 }
 171
 172 static const struct command_registration openocd_command_handlers[] = {
 173         {
 174                 .name = "version",
 175                 .handler = &handle_version_command,
 176                 .mode = COMMAND_ANY,
 177                 .help = "show program version",
 178         },
 179         {
 180                 .name = "noinit",
 181                 .handler = &handle_noinit_command,
 182                 .mode = COMMAND_CONFIG,
 183                 .help = "Prevent 'init' from being called at startup.",
 184         },
 185         {
 186                 .name = "init",
 187                 .handler = &handle_init_command,
 188                 .mode = COMMAND_ANY,
 189                 .help = "Initializes configured targets and servers.  "
 190                         "Changes command mode from CONFIG to EXEC.  "
 191                         "Unless 'noinit' is called, this command is "
 192                         "called automatically at the end of startup.",
 193
 194         },
 195         {
 196                 .name = "add_script_search_dir",
 197                 .handler = &handle_add_script_search_dir_command,
 198                 .mode = COMMAND_ANY,
 199                 .help = "dir to search for config files and scripts",
 200
 201         },
 202         COMMAND_REGISTRATION_DONE
 203 };
 204
 205 static int openocd_register_commands(struct command_context *cmd_ctx)
 206 {
 207         return register_commands(cmd_ctx, NULL, openocd_command_handlers);
 208 }
 209
 210 struct command_context *global_cmd_ctx;
 211
 212 /* NB! this fn can be invoked outside this file for non PC hosted builds */
 213 struct command_context *setup_command_handler(Jim_Interp *interp)
 214 {
 215         log_init();
 216         LOG_DEBUG("log_init: complete");
 217
 218         const char *startup = openocd_startup_tcl;
 219         struct command_context *cmd_ctx = command_init(startup, interp);
 220
 221         /* register subsystem commands */
 222         typedef int (*command_registrant_t)(struct command_context *cmd_ctx);
 223         static const command_registrant_t command_registrants[] = {
 224                 &openocd_register_commands,
 225                 &server_register_commands,
 226                 &gdb_register_commands,
 227                 &log_register_commands,
 228                 &interface_register_commands,
 229                 &jtag_register_commands,
 230                 &xsvf_register_commands,
 231                 &svf_register_commands,
 232                 &target_register_commands,
 233                 &flash_register_commands,
 234                 &nand_register_commands,
 235                 &pld_register_commands,
 236                 &mflash_register_commands,
 237                 NULL
 238         };
 239         for (unsigned i = 0; NULL != command_registrants[i]; i++)
 240         {
 241                 int retval = (*command_registrants[i])(cmd_ctx);
 242                 if (ERROR_OK != retval)
 243                 {
 244                         command_done(cmd_ctx);
 245                         return NULL;
 246                 }
 247         }
 248         LOG_DEBUG("command registration: complete");
 249
 250         LOG_OUTPUT(OPENOCD_VERSION "\n"
 251                         "Licensed under GNU GPL v2\n");
 252
 253         global_cmd_ctx = cmd_ctx;
 254
 255         return cmd_ctx;
 256 }
 257
 258 /* normally this is the main() function entry, but if OpenOCD is linked
 259  * into application, then this fn will not be invoked, but rather that
 260  * application will have it's own implementation of main(). */
 261 int openocd_main(int argc, char *argv[])
 262 {
 263         int ret;
 264
 265         /* initialize commandline interface */
 266         struct command_context *cmd_ctx;
 267
 268         cmd_ctx = setup_command_handler(NULL);
 269
 270         if (ioutil_init(cmd_ctx) != ERROR_OK)
 271                 return EXIT_FAILURE;
 272
 273         LOG_OUTPUT("For bug reports, read\n\t"
 274                 "http://openocd.berlios.de/doc/doxygen/bugs.html"
 275                 "\n");
 276
 277         command_context_mode(cmd_ctx, COMMAND_CONFIG);
 278         command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 279
 280         if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
 281                 return EXIT_FAILURE;
 282
 283         if (server_preinit() != ERROR_OK)
 284                 return EXIT_FAILURE;
 285
 286         ret = parse_config_file(cmd_ctx);
 287         if (ret != ERROR_OK)
 288                 return EXIT_FAILURE;
 289
 290         if (httpd_start(cmd_ctx) != ERROR_OK)
 291                 return EXIT_FAILURE;
 292
 293         ret = server_init(cmd_ctx);
 294         if (ERROR_OK != ret)
 295                 return EXIT_FAILURE;
 296
 297         if (init_at_startup)
 298         {
 299                 ret = command_run_line(cmd_ctx, "init");
 300                 if (ERROR_OK != ret)
 301                         ret = EXIT_FAILURE;
 302         }
 303
 304         /* handle network connections */
 305         if (ERROR_OK == ret)
 306                 server_loop(cmd_ctx);
 307
 308         server_quit();
 309
 310         httpd_stop();
 311
 312         unregister_all_commands(cmd_ctx, NULL);
 313
 314         /* free commandline interface */
 315         command_done(cmd_ctx);
 316
 317         adapter_quit();
 318
 319         return ret;
 320 }