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