jtag: add connect_type reset_config mode flag
[openocd.git] / src / jtag / adapter.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007-2010 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2009 SoftPLC Corporation *
9 * http://softplc.com *
10 * dick@softplc.com *
11 * *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
14 * *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
19 * *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
24 * *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
29 ***************************************************************************/
30
31 #ifdef HAVE_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #include "jtag.h"
36 #include "minidriver.h"
37 #include "interface.h"
38 #include "interfaces.h"
39 #include <transport/transport.h>
40
41 #ifdef HAVE_STRINGS_H
42 #include <strings.h>
43 #endif
44
45 /**
46 * @file
47 * Holds support for configuring debug adapters from TCl scripts.
48 */
49
50 extern struct jtag_interface *jtag_interface;
51 const char *jtag_only[] = { "jtag", NULL };
52
53 static int jim_adapter_name(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
54 {
55 Jim_GetOptInfo goi;
56 Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
57
58 /* return the name of the interface */
59 /* TCL code might need to know the exact type... */
60 /* FUTURE: we allow this as a means to "set" the interface. */
61 if (goi.argc != 0) {
62 Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)");
63 return JIM_ERR;
64 }
65 const char *name = jtag_interface ? jtag_interface->name : NULL;
66 Jim_SetResultString(goi.interp, name ? : "undefined", -1);
67 return JIM_OK;
68 }
69
70 static int default_khz(int khz, int *jtag_speed)
71 {
72 LOG_ERROR("Translation from khz to jtag_speed not implemented");
73 return ERROR_FAIL;
74 }
75
76 static int default_speed_div(int speed, int *khz)
77 {
78 LOG_ERROR("Translation from jtag_speed to khz not implemented");
79 return ERROR_FAIL;
80 }
81
82 static int default_power_dropout(int *dropout)
83 {
84 *dropout = 0; /* by default we can't detect power dropout */
85 return ERROR_OK;
86 }
87
88 static int default_srst_asserted(int *srst_asserted)
89 {
90 *srst_asserted = 0; /* by default we can't detect srst asserted */
91 return ERROR_OK;
92 }
93
94 COMMAND_HANDLER(interface_transport_command)
95 {
96 char **transports;
97 int retval;
98
99 retval = CALL_COMMAND_HANDLER(transport_list_parse, &transports);
100 if (retval != ERROR_OK)
101 return retval;
102
103 retval = allow_transports(CMD_CTX, (const char **)transports);
104
105 if (retval != ERROR_OK) {
106 for (unsigned i = 0; transports[i]; i++)
107 free(transports[i]);
108 free(transports);
109 }
110 return retval;
111 }
112
113 COMMAND_HANDLER(handle_interface_list_command)
114 {
115 if (strcmp(CMD_NAME, "interface_list") == 0 && CMD_ARGC > 0)
116 return ERROR_COMMAND_SYNTAX_ERROR;
117
118 command_print(CMD_CTX, "The following debug interfaces are available:");
119 for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) {
120 const char *name = jtag_interfaces[i]->name;
121 command_print(CMD_CTX, "%u: %s", i + 1, name);
122 }
123
124 return ERROR_OK;
125 }
126
127 COMMAND_HANDLER(handle_interface_command)
128 {
129 int retval;
130
131 /* check whether the interface is already configured */
132 if (jtag_interface) {
133 LOG_WARNING("Interface already configured, ignoring");
134 return ERROR_OK;
135 }
136
137 /* interface name is a mandatory argument */
138 if (CMD_ARGC != 1 || CMD_ARGV[0][0] == '\0')
139 return ERROR_COMMAND_SYNTAX_ERROR;
140
141 for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) {
142 if (strcmp(CMD_ARGV[0], jtag_interfaces[i]->name) != 0)
143 continue;
144
145 if (NULL != jtag_interfaces[i]->commands) {
146 retval = register_commands(CMD_CTX, NULL,
147 jtag_interfaces[i]->commands);
148 if (ERROR_OK != retval)
149 return retval;
150 }
151
152 jtag_interface = jtag_interfaces[i];
153
154 /* LEGACY SUPPORT ... adapter drivers must declare what
155 * transports they allow. Until they all do so, assume
156 * the legacy drivers are JTAG-only
157 */
158 if (!jtag_interface->transports)
159 LOG_WARNING("Adapter driver '%s' did not declare "
160 "which transports it allows; assuming "
161 "legacy JTAG-only", jtag_interface->name);
162 retval = allow_transports(CMD_CTX, jtag_interface->transports
163 ? jtag_interface->transports : jtag_only);
164 if (ERROR_OK != retval)
165 return retval;
166
167 if (jtag_interface->khz == NULL)
168 jtag_interface->khz = default_khz;
169 if (jtag_interface->speed_div == NULL)
170 jtag_interface->speed_div = default_speed_div;
171 if (jtag_interface->power_dropout == NULL)
172 jtag_interface->power_dropout = default_power_dropout;
173 if (jtag_interface->srst_asserted == NULL)
174 jtag_interface->srst_asserted = default_srst_asserted;
175
176 return ERROR_OK;
177 }
178
179 /* no valid interface was found (i.e. the configuration option,
180 * didn't match one of the compiled-in interfaces
181 */
182 LOG_ERROR("The specified debug interface was not found (%s)",
183 CMD_ARGV[0]);
184 CALL_COMMAND_HANDLER(handle_interface_list_command);
185 return ERROR_JTAG_INVALID_INTERFACE;
186 }
187
188 COMMAND_HANDLER(handle_reset_config_command)
189 {
190 int new_cfg = 0;
191 int mask = 0;
192
193 /* Original versions cared about the order of these tokens:
194 * reset_config signals [combination [trst_type [srst_type]]]
195 * They also clobbered the previous configuration even on error.
196 *
197 * Here we don't care about the order, and only change values
198 * which have been explicitly specified.
199 */
200 for (; CMD_ARGC; CMD_ARGC--, CMD_ARGV++) {
201 int tmp = 0;
202 int m;
203
204 /* gating */
205 m = RESET_SRST_NO_GATING;
206 if (strcmp(*CMD_ARGV, "srst_gates_jtag") == 0)
207 /* default: don't use JTAG while SRST asserted */;
208 else if (strcmp(*CMD_ARGV, "srst_nogate") == 0)
209 tmp = RESET_SRST_NO_GATING;
210 else
211 m = 0;
212 if (mask & m) {
213 LOG_ERROR("extra reset_config %s spec (%s)",
214 "gating", *CMD_ARGV);
215 return ERROR_COMMAND_SYNTAX_ERROR;
216 }
217 if (m)
218 goto next;
219
220 /* signals */
221 m = RESET_HAS_TRST | RESET_HAS_SRST;
222 if (strcmp(*CMD_ARGV, "none") == 0)
223 tmp = RESET_NONE;
224 else if (strcmp(*CMD_ARGV, "trst_only") == 0)
225 tmp = RESET_HAS_TRST;
226 else if (strcmp(*CMD_ARGV, "srst_only") == 0)
227 tmp = RESET_HAS_SRST;
228 else if (strcmp(*CMD_ARGV, "trst_and_srst") == 0)
229 tmp = RESET_HAS_TRST | RESET_HAS_SRST;
230 else
231 m = 0;
232 if (mask & m) {
233 LOG_ERROR("extra reset_config %s spec (%s)",
234 "signal", *CMD_ARGV);
235 return ERROR_COMMAND_SYNTAX_ERROR;
236 }
237 if (m)
238 goto next;
239
240 /* combination (options for broken wiring) */
241 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
242 if (strcmp(*CMD_ARGV, "separate") == 0)
243 /* separate reset lines - default */;
244 else if (strcmp(*CMD_ARGV, "srst_pulls_trst") == 0)
245 tmp |= RESET_SRST_PULLS_TRST;
246 else if (strcmp(*CMD_ARGV, "trst_pulls_srst") == 0)
247 tmp |= RESET_TRST_PULLS_SRST;
248 else if (strcmp(*CMD_ARGV, "combined") == 0)
249 tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
250 else
251 m = 0;
252 if (mask & m) {
253 LOG_ERROR("extra reset_config %s spec (%s)",
254 "combination", *CMD_ARGV);
255 return ERROR_COMMAND_SYNTAX_ERROR;
256 }
257 if (m)
258 goto next;
259
260 /* trst_type (NOP without HAS_TRST) */
261 m = RESET_TRST_OPEN_DRAIN;
262 if (strcmp(*CMD_ARGV, "trst_open_drain") == 0)
263 tmp |= RESET_TRST_OPEN_DRAIN;
264 else if (strcmp(*CMD_ARGV, "trst_push_pull") == 0)
265 /* push/pull from adapter - default */;
266 else
267 m = 0;
268 if (mask & m) {
269 LOG_ERROR("extra reset_config %s spec (%s)",
270 "trst_type", *CMD_ARGV);
271 return ERROR_COMMAND_SYNTAX_ERROR;
272 }
273 if (m)
274 goto next;
275
276 /* srst_type (NOP without HAS_SRST) */
277 m |= RESET_SRST_PUSH_PULL;
278 if (strcmp(*CMD_ARGV, "srst_push_pull") == 0)
279 tmp |= RESET_SRST_PUSH_PULL;
280 else if (strcmp(*CMD_ARGV, "srst_open_drain") == 0)
281 /* open drain from adapter - default */;
282 else
283 m = 0;
284 if (mask & m) {
285 LOG_ERROR("extra reset_config %s spec (%s)",
286 "srst_type", *CMD_ARGV);
287 return ERROR_COMMAND_SYNTAX_ERROR;
288 }
289 if (m)
290 goto next;
291
292 /* connect_type - only valid when srst_nogate */
293 m = RESET_CNCT_UNDER_SRST;
294 if (strcmp(*CMD_ARGV, "connect_assert_srst") == 0)
295 tmp |= RESET_CNCT_UNDER_SRST;
296 else if (strcmp(*CMD_ARGV, "connect_deassert_srst") == 0)
297 /* connect normally - default */;
298 else
299 m = 0;
300 if (mask & m) {
301 LOG_ERROR("extra reset_config %s spec (%s)",
302 "connect_type", *CMD_ARGV);
303 return ERROR_COMMAND_SYNTAX_ERROR;
304 }
305 if (m)
306 goto next;
307
308 /* caller provided nonsense; fail */
309 LOG_ERROR("unknown reset_config flag (%s)", *CMD_ARGV);
310 return ERROR_COMMAND_SYNTAX_ERROR;
311
312 next:
313 /* Remember the bits which were specified (mask)
314 * and their new values (new_cfg).
315 */
316 mask |= m;
317 new_cfg |= tmp;
318 }
319
320 /* clear previous values of those bits, save new values */
321 if (mask) {
322 int old_cfg = jtag_get_reset_config();
323
324 old_cfg &= ~mask;
325 new_cfg |= old_cfg;
326 jtag_set_reset_config(new_cfg);
327 } else
328 new_cfg = jtag_get_reset_config();
329
330 /*
331 * Display the (now-)current reset mode
332 */
333 char *modes[6];
334
335 /* minimal JTAG has neither SRST nor TRST (so that's the default) */
336 switch (new_cfg & (RESET_HAS_TRST | RESET_HAS_SRST)) {
337 case RESET_HAS_SRST:
338 modes[0] = "srst_only";
339 break;
340 case RESET_HAS_TRST:
341 modes[0] = "trst_only";
342 break;
343 case RESET_TRST_AND_SRST:
344 modes[0] = "trst_and_srst";
345 break;
346 default:
347 modes[0] = "none";
348 break;
349 }
350
351 /* normally SRST and TRST are decoupled; but bugs happen ... */
352 switch (new_cfg & (RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST)) {
353 case RESET_SRST_PULLS_TRST:
354 modes[1] = "srst_pulls_trst";
355 break;
356 case RESET_TRST_PULLS_SRST:
357 modes[1] = "trst_pulls_srst";
358 break;
359 case RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST:
360 modes[1] = "combined";
361 break;
362 default:
363 modes[1] = "separate";
364 break;
365 }
366
367 /* TRST-less connectors include Altera, Xilinx, and minimal JTAG */
368 if (new_cfg & RESET_HAS_TRST) {
369 if (new_cfg & RESET_TRST_OPEN_DRAIN)
370 modes[3] = " trst_open_drain";
371 else
372 modes[3] = " trst_push_pull";
373 } else
374 modes[3] = "";
375
376 /* SRST-less connectors include TI-14, Xilinx, and minimal JTAG */
377 if (new_cfg & RESET_HAS_SRST) {
378 if (new_cfg & RESET_SRST_NO_GATING)
379 modes[2] = " srst_nogate";
380 else
381 modes[2] = " srst_gates_jtag";
382
383 if (new_cfg & RESET_SRST_PUSH_PULL)
384 modes[4] = " srst_push_pull";
385 else
386 modes[4] = " srst_open_drain";
387
388 if (new_cfg & RESET_CNCT_UNDER_SRST)
389 modes[5] = " connect_assert_srst";
390 else
391 modes[5] = " connect_deassert_srst";
392 } else {
393 modes[2] = "";
394 modes[4] = "";
395 modes[5] = "";
396 }
397
398 command_print(CMD_CTX, "%s %s%s%s%s%s",
399 modes[0], modes[1],
400 modes[2], modes[3], modes[4], modes[5]);
401
402 return ERROR_OK;
403 }
404
405 COMMAND_HANDLER(handle_adapter_nsrst_delay_command)
406 {
407 if (CMD_ARGC > 1)
408 return ERROR_COMMAND_SYNTAX_ERROR;
409 if (CMD_ARGC == 1) {
410 unsigned delay;
411 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay);
412
413 jtag_set_nsrst_delay(delay);
414 }
415 command_print(CMD_CTX, "adapter_nsrst_delay: %u", jtag_get_nsrst_delay());
416 return ERROR_OK;
417 }
418
419 COMMAND_HANDLER(handle_adapter_nsrst_assert_width_command)
420 {
421 if (CMD_ARGC > 1)
422 return ERROR_COMMAND_SYNTAX_ERROR;
423 if (CMD_ARGC == 1) {
424 unsigned width;
425 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], width);
426
427 jtag_set_nsrst_assert_width(width);
428 }
429 command_print(CMD_CTX, "adapter_nsrst_assert_width: %u", jtag_get_nsrst_assert_width());
430 return ERROR_OK;
431 }
432
433 COMMAND_HANDLER(handle_adapter_khz_command)
434 {
435 if (CMD_ARGC > 1)
436 return ERROR_COMMAND_SYNTAX_ERROR;
437
438 int retval = ERROR_OK;
439 if (CMD_ARGC == 1) {
440 unsigned khz = 0;
441 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz);
442
443 retval = jtag_config_khz(khz);
444 if (ERROR_OK != retval)
445 return retval;
446 }
447
448 int cur_speed = jtag_get_speed_khz();
449 retval = jtag_get_speed_readable(&cur_speed);
450 if (ERROR_OK != retval)
451 return retval;
452
453 if (cur_speed)
454 command_print(CMD_CTX, "adapter speed: %d kHz", cur_speed);
455 else
456 command_print(CMD_CTX, "adapter speed: RCLK - adaptive");
457
458 return retval;
459 }
460
461 static const struct command_registration interface_command_handlers[] = {
462 {
463 .name = "adapter_khz",
464 .handler = handle_adapter_khz_command,
465 .mode = COMMAND_ANY,
466 .help = "With an argument, change to the specified maximum "
467 "jtag speed. For JTAG, 0 KHz signifies adaptive "
468 " clocking. "
469 "With or without argument, display current setting.",
470 .usage = "[khz]",
471 },
472 {
473 .name = "adapter_name",
474 .mode = COMMAND_ANY,
475 .jim_handler = jim_adapter_name,
476 .help = "Returns the name of the currently "
477 "selected adapter (driver)",
478 },
479 {
480 .name = "adapter_nsrst_delay",
481 .handler = handle_adapter_nsrst_delay_command,
482 .mode = COMMAND_ANY,
483 .help = "delay after deasserting SRST in ms",
484 .usage = "[milliseconds]",
485 },
486 {
487 .name = "adapter_nsrst_assert_width",
488 .handler = handle_adapter_nsrst_assert_width_command,
489 .mode = COMMAND_ANY,
490 .help = "delay after asserting SRST in ms",
491 .usage = "[milliseconds]",
492 },
493 {
494 .name = "interface",
495 .handler = handle_interface_command,
496 .mode = COMMAND_CONFIG,
497 .help = "Select a debug adapter interface (driver)",
498 .usage = "driver_name",
499 },
500 {
501 .name = "interface_transports",
502 .handler = interface_transport_command,
503 .mode = COMMAND_CONFIG,
504 .help = "Declare transports the interface supports.",
505 .usage = "transport ... ",
506 },
507 {
508 .name = "interface_list",
509 .handler = handle_interface_list_command,
510 .mode = COMMAND_ANY,
511 .help = "List all built-in debug adapter interfaces (drivers)",
512 },
513 {
514 .name = "reset_config",
515 .handler = handle_reset_config_command,
516 .mode = COMMAND_ANY,
517 .help = "configure adapter reset behavior",
518 .usage = "[none|trst_only|srst_only|trst_and_srst] "
519 "[srst_pulls_trst|trst_pulls_srst|combined|separate] "
520 "[srst_gates_jtag|srst_nogate] "
521 "[trst_push_pull|trst_open_drain] "
522 "[srst_push_pull|srst_open_drain]",
523 },
524 COMMAND_REGISTRATION_DONE
525 };
526
527 /**
528 * Register the commands which deal with arbitrary debug adapter drivers.
529 *
530 * @todo Remove internal assumptions that all debug adapters use JTAG for
531 * transport. Various types and data structures are not named generically.
532 */
533 int interface_register_commands(struct command_context *ctx)
534 {
535 return register_commands(ctx, NULL, interface_command_handlers);
536 }