improve command handling examples
[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 "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 "telnet_server.h"
42 #include "gdb_server.h"
43 #include "tcl_server.h"
44 #include "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 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 (CMD_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 static const struct command_registration openocd_command_handlers[] = {
164 {
165 .name = "version",
166 .handler = &handle_version_command,
167 .mode = COMMAND_EXEC,
168 .help = "show program version",
169 },
170 {
171 .name = "init",
172 .handler = &handle_init_command,
173 .mode = COMMAND_ANY,
174 .help = "Initializes configured targets and servers. "
175 "If called more than once, does nothing.",
176 },
177 COMMAND_REGISTRATION_DONE
178 };
179
180 struct command_context *global_cmd_ctx;
181
182 /* NB! this fn can be invoked outside this file for non PC hosted builds */
183 struct command_context *setup_command_handler(void)
184 {
185 struct command_context *cmd_ctx;
186
187 global_cmd_ctx = cmd_ctx = command_init(openocd_startup_tcl);
188
189 register_commands(cmd_ctx, NULL, openocd_command_handlers);
190 /* register subsystem commands */
191 server_register_commands(cmd_ctx);
192 telnet_register_commands(cmd_ctx);
193 gdb_register_commands(cmd_ctx);
194 tcl_register_commands(cmd_ctx); /* tcl server commands */
195 log_register_commands(cmd_ctx);
196 jtag_register_commands(cmd_ctx);
197 xsvf_register_commands(cmd_ctx);
198 svf_register_commands(cmd_ctx);
199 target_register_commands(cmd_ctx);
200 flash_register_commands(cmd_ctx);
201 nand_register_commands(cmd_ctx);
202 pld_register_commands(cmd_ctx);
203 mflash_register_commands(cmd_ctx);
204
205 if (log_init(cmd_ctx) != ERROR_OK)
206 {
207 exit(-1);
208 }
209 LOG_DEBUG("log init complete");
210
211 LOG_OUTPUT(OPENOCD_VERSION "\n");
212
213 return cmd_ctx;
214 }
215
216 #if !BUILD_HTTPD && !BUILD_ECOSBOARD
217 /* implementations of OpenOCD that uses multithreading needs to know when
218 * OpenOCD is sleeping. No-op in vanilla OpenOCD
219 */
220 void openocd_sleep_prelude(void)
221 {
222 }
223
224 void openocd_sleep_postlude(void)
225 {
226 }
227 #endif
228
229
230 /* normally this is the main() function entry, but if OpenOCD is linked
231 * into application, then this fn will not be invoked, but rather that
232 * application will have it's own implementation of main(). */
233 int openocd_main(int argc, char *argv[])
234 {
235 int ret;
236
237 /* initialize commandline interface */
238 struct command_context *cmd_ctx;
239
240 cmd_ctx = setup_command_handler();
241
242 #if BUILD_IOUTIL
243 if (ioutil_init(cmd_ctx) != ERROR_OK)
244 {
245 return EXIT_FAILURE;
246 }
247 #endif
248
249 LOG_OUTPUT("For bug reports, read\n\t"
250 "http://openocd.berlios.de/doc/doxygen/bugs.html"
251 "\n");
252
253
254 command_context_mode(cmd_ctx, COMMAND_CONFIG);
255 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
256
257 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
258 return EXIT_FAILURE;
259
260 ret = parse_config_file(cmd_ctx);
261 if ((ret != ERROR_OK) && (ret != ERROR_COMMAND_CLOSE_CONNECTION))
262 return EXIT_FAILURE;
263
264 #if BUILD_HTTPD
265 if (httpd_start(cmd_ctx) != ERROR_OK)
266 return EXIT_FAILURE;
267 #endif
268
269 if (ret != ERROR_COMMAND_CLOSE_CONNECTION)
270 {
271 command_context_mode(cmd_ctx, COMMAND_EXEC);
272 if (command_run_line(cmd_ctx, "init") != ERROR_OK)
273 return EXIT_FAILURE;
274
275 /* handle network connections */
276 server_loop(cmd_ctx);
277 }
278
279 /* shut server down */
280 server_quit();
281
282 #if BUILD_HTTPD
283 httpd_stop();
284 #endif
285
286 unregister_all_commands(cmd_ctx, NULL);
287
288 /* free commandline interface */
289 command_done(cmd_ctx);
290
291
292 return EXIT_SUCCESS;
293 }

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)