ARMv7-M: make DAP commands verify target is an ARMv7-M
[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/jtag.h>
33 #include <helper/ioutil.h>
34 #include <helper/configuration.h>
35 #include <xsvf/xsvf.h>
36 #include <svf/svf.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 = jtag_interface_init(CMD_CTX)) != ERROR_OK)
118 {
119 /* we must be able to set up the jtag interface */
120 return retval;
121 }
122 LOG_DEBUG("jtag interface init complete");
123
124 /* Try to initialize & examine the JTAG chain at this point,
125 * but continue startup regardless. Note that platforms
126 * need to be able to provide JTAG event handlers that use
127 * a variety of JTAG operations in order to do that...
128 */
129 command_context_mode(CMD_CTX, COMMAND_EXEC);
130 if (command_run_line(CMD_CTX, "jtag init") == ERROR_OK)
131 {
132 LOG_DEBUG("Examining targets...");
133 if (target_examine() != ERROR_OK)
134 LOG_DEBUG("target examination failed");
135 }
136 else
137 LOG_WARNING("jtag initialization failed; try 'jtag init' again.");
138 command_context_mode(CMD_CTX, COMMAND_CONFIG);
139
140 if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
141 return ERROR_FAIL;
142
143 if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
144 return ERROR_FAIL;
145
146 if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
147 return ERROR_FAIL;
148
149 if (command_run_line(CMD_CTX, "pld init") != ERROR_OK)
150 return ERROR_FAIL;
151 command_context_mode(CMD_CTX, COMMAND_EXEC);
152
153 /* initialize telnet subsystem */
154 gdb_target_add_all(all_targets);
155
156 target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
157
158 return ERROR_OK;
159 }
160
161 static const struct command_registration openocd_command_handlers[] = {
162 {
163 .name = "version",
164 .handler = &handle_version_command,
165 .mode = COMMAND_ANY,
166 .help = "show program version",
167 },
168 {
169 .name = "noinit",
170 .handler = &handle_noinit_command,
171 .mode = COMMAND_CONFIG,
172 .help = "Prevent 'init' from being called at startup.",
173 },
174 {
175 .name = "init",
176 .handler = &handle_init_command,
177 .mode = COMMAND_ANY,
178 .help = "Initializes configured targets and servers. "
179 "Changes command mode from CONFIG to EXEC. "
180 "Unless 'noinit' is called, this command is "
181 "called automatically at the end of startup.",
182
183 },
184 COMMAND_REGISTRATION_DONE
185 };
186
187 int openocd_register_commands(struct command_context *cmd_ctx)
188 {
189 return register_commands(cmd_ctx, NULL, openocd_command_handlers);
190 }
191
192 struct command_context *global_cmd_ctx;
193
194 /* NB! this fn can be invoked outside this file for non PC hosted builds */
195 struct command_context *setup_command_handler(Jim_Interp *interp)
196 {
197 log_init();
198 LOG_DEBUG("log_init: complete");
199
200 const char *startup = openocd_startup_tcl;
201 struct command_context *cmd_ctx = command_init(startup, interp);
202
203 /* register subsystem commands */
204 typedef int (*command_registrant_t)(struct command_context *cmd_ctx);
205 command_registrant_t command_registrants[] = {
206 &openocd_register_commands,
207 &server_register_commands,
208 &gdb_register_commands,
209 &log_register_commands,
210 &jtag_register_commands,
211 &xsvf_register_commands,
212 &svf_register_commands,
213 &target_register_commands,
214 &flash_register_commands,
215 &nand_register_commands,
216 &pld_register_commands,
217 &mflash_register_commands,
218 NULL
219 };
220 for (unsigned i = 0; NULL != command_registrants[i]; i++)
221 {
222 int retval = (*command_registrants[i])(cmd_ctx);
223 if (ERROR_OK != retval)
224 {
225 command_done(cmd_ctx);
226 return NULL;
227 }
228 }
229 LOG_DEBUG("command registration: complete");
230
231 LOG_OUTPUT(OPENOCD_VERSION "\n");
232
233 global_cmd_ctx = cmd_ctx;
234
235 return cmd_ctx;
236 }
237
238 /* normally this is the main() function entry, but if OpenOCD is linked
239 * into application, then this fn will not be invoked, but rather that
240 * application will have it's own implementation of main(). */
241 int openocd_main(int argc, char *argv[])
242 {
243 int ret;
244
245 /* initialize commandline interface */
246 struct command_context *cmd_ctx;
247
248 cmd_ctx = setup_command_handler(NULL);
249
250 if (ioutil_init(cmd_ctx) != ERROR_OK)
251 return EXIT_FAILURE;
252
253 LOG_OUTPUT("For bug reports, read\n\t"
254 "http://openocd.berlios.de/doc/doxygen/bugs.html"
255 "\n");
256
257 command_context_mode(cmd_ctx, COMMAND_CONFIG);
258 command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
259
260 if (parse_cmdline_args(cmd_ctx, argc, argv) != ERROR_OK)
261 return EXIT_FAILURE;
262
263 if (server_preinit() != ERROR_OK)
264 return EXIT_FAILURE;
265
266 ret = parse_config_file(cmd_ctx);
267 if (ret != ERROR_OK)
268 return EXIT_FAILURE;
269
270 if (httpd_start(cmd_ctx) != ERROR_OK)
271 return EXIT_FAILURE;
272
273 ret = server_init(cmd_ctx);
274 if (ERROR_OK != ret)
275 return EXIT_FAILURE;
276
277 if (init_at_startup)
278 {
279 ret = command_run_line(cmd_ctx, "init");
280 if (ERROR_OK != ret)
281 ret = EXIT_FAILURE;
282 }
283
284 /* handle network connections */
285 if (ERROR_OK == ret)
286 server_loop(cmd_ctx);
287
288 server_quit();
289
290 httpd_stop();
291
292 unregister_all_commands(cmd_ctx, NULL);
293
294 /* free commandline interface */
295 command_done(cmd_ctx);
296
297 jtag_interface_quit();
298
299 return ret;
300 }