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

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)