1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
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. *
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. *
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 ***************************************************************************/
35 #include "minidriver.h"
36 #include "interface.h"
37 #include "interfaces.h"
38 #include "transport.h"
46 * Holds support for configuring debug adapters from TCl scripts.
49 extern struct jtag_interface
*jtag_interface
;
54 jim_adapter_name(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
57 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
59 /* return the name of the interface */
60 /* TCL code might need to know the exact type... */
61 /* FUTURE: we allow this as a means to "set" the interface. */
63 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
66 const char *name
= jtag_interface
? jtag_interface
->name
: NULL
;
67 Jim_SetResultString(goi
.interp
, name
? : "undefined", -1);
72 static int default_khz(int khz
, int *jtag_speed
)
74 LOG_ERROR("Translation from khz to jtag_speed not implemented");
78 static int default_speed_div(int speed
, int *khz
)
80 LOG_ERROR("Translation from jtag_speed to khz not implemented");
84 static int default_power_dropout(int *dropout
)
86 *dropout
= 0; /* by default we can't detect power dropout */
90 static int default_srst_asserted(int *srst_asserted
)
92 *srst_asserted
= 0; /* by default we can't detect srst asserted */
96 const char *jtag_only
[] = { "jtag", NULL
, };
99 COMMAND_HANDLER(interface_transport_command
)
104 retval
= CALL_COMMAND_HANDLER(transport_list_parse
, &transports
);
105 if (retval
!= ERROR_OK
) {
109 retval
= allow_transports(CMD_CTX
, (const char **)transports
);
111 if (retval
!= ERROR_OK
) {
112 for (unsigned i
= 0; transports
[i
]; i
++)
119 COMMAND_HANDLER(handle_interface_list_command
)
121 if (strcmp(CMD_NAME
, "interface_list") == 0 && CMD_ARGC
> 0)
122 return ERROR_COMMAND_SYNTAX_ERROR
;
124 command_print(CMD_CTX
, "The following debug interfaces are available:");
125 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
127 const char *name
= jtag_interfaces
[i
]->name
;
128 command_print(CMD_CTX
, "%u: %s", i
+ 1, name
);
134 COMMAND_HANDLER(handle_interface_command
)
138 /* check whether the interface is already configured */
141 LOG_WARNING("Interface already configured, ignoring");
145 /* interface name is a mandatory argument */
146 if (CMD_ARGC
!= 1 || CMD_ARGV
[0][0] == '\0')
147 return ERROR_COMMAND_SYNTAX_ERROR
;
149 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
151 if (strcmp(CMD_ARGV
[0], jtag_interfaces
[i
]->name
) != 0)
154 if (NULL
!= jtag_interfaces
[i
]->commands
)
156 retval
= register_commands(CMD_CTX
, NULL
,
157 jtag_interfaces
[i
]->commands
);
158 if (ERROR_OK
!= retval
)
162 jtag_interface
= jtag_interfaces
[i
];
164 /* LEGACY SUPPORT ... adapter drivers must declare what
165 * transports they allow. Until they all do so, assume
166 * the legacy drivers are JTAG-only
168 if (!jtag_interface
->transports
)
169 LOG_WARNING("Adapter driver '%s' did not declare "
170 "which transports it allows; assuming "
171 "legacy JTAG-only", jtag_interface
->name
);
172 retval
= allow_transports(CMD_CTX
,
173 jtag_interface
->transports
175 if (ERROR_OK
!= retval
)
178 if (jtag_interface
->khz
== NULL
)
179 jtag_interface
->khz
= default_khz
;
180 if (jtag_interface
->speed_div
== NULL
)
181 jtag_interface
->speed_div
= default_speed_div
;
182 if (jtag_interface
->power_dropout
== NULL
)
183 jtag_interface
->power_dropout
= default_power_dropout
;
184 if (jtag_interface
->srst_asserted
== NULL
)
185 jtag_interface
->srst_asserted
= default_srst_asserted
;
190 /* no valid interface was found (i.e. the configuration option,
191 * didn't match one of the compiled-in interfaces
193 LOG_ERROR("The specified debug interface was not found (%s)",
195 CALL_COMMAND_HANDLER(handle_interface_list_command
);
196 return ERROR_JTAG_INVALID_INTERFACE
;
199 COMMAND_HANDLER(handle_reset_config_command
)
204 /* Original versions cared about the order of these tokens:
205 * reset_config signals [combination [trst_type [srst_type]]]
206 * They also clobbered the previous configuration even on error.
208 * Here we don't care about the order, and only change values
209 * which have been explicitly specified.
211 for (; CMD_ARGC
; CMD_ARGC
--, CMD_ARGV
++) {
216 m
= RESET_SRST_NO_GATING
;
217 if (strcmp(*CMD_ARGV
, "srst_gates_jtag") == 0)
218 /* default: don't use JTAG while SRST asserted */;
219 else if (strcmp(*CMD_ARGV
, "srst_nogate") == 0)
220 tmp
= RESET_SRST_NO_GATING
;
224 LOG_ERROR("extra reset_config %s spec (%s)",
225 "gating", *CMD_ARGV
);
226 return ERROR_INVALID_ARGUMENTS
;
232 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
233 if (strcmp(*CMD_ARGV
, "none") == 0)
235 else if (strcmp(*CMD_ARGV
, "trst_only") == 0)
236 tmp
= RESET_HAS_TRST
;
237 else if (strcmp(*CMD_ARGV
, "srst_only") == 0)
238 tmp
= RESET_HAS_SRST
;
239 else if (strcmp(*CMD_ARGV
, "trst_and_srst") == 0)
240 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
244 LOG_ERROR("extra reset_config %s spec (%s)",
245 "signal", *CMD_ARGV
);
246 return ERROR_INVALID_ARGUMENTS
;
251 /* combination (options for broken wiring) */
252 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
253 if (strcmp(*CMD_ARGV
, "separate") == 0)
254 /* separate reset lines - default */;
255 else if (strcmp(*CMD_ARGV
, "srst_pulls_trst") == 0)
256 tmp
|= RESET_SRST_PULLS_TRST
;
257 else if (strcmp(*CMD_ARGV
, "trst_pulls_srst") == 0)
258 tmp
|= RESET_TRST_PULLS_SRST
;
259 else if (strcmp(*CMD_ARGV
, "combined") == 0)
260 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
264 LOG_ERROR("extra reset_config %s spec (%s)",
265 "combination", *CMD_ARGV
);
266 return ERROR_INVALID_ARGUMENTS
;
271 /* trst_type (NOP without HAS_TRST) */
272 m
= RESET_TRST_OPEN_DRAIN
;
273 if (strcmp(*CMD_ARGV
, "trst_open_drain") == 0)
274 tmp
|= RESET_TRST_OPEN_DRAIN
;
275 else if (strcmp(*CMD_ARGV
, "trst_push_pull") == 0)
276 /* push/pull from adapter - default */;
280 LOG_ERROR("extra reset_config %s spec (%s)",
281 "trst_type", *CMD_ARGV
);
282 return ERROR_INVALID_ARGUMENTS
;
287 /* srst_type (NOP without HAS_SRST) */
288 m
|= RESET_SRST_PUSH_PULL
;
289 if (strcmp(*CMD_ARGV
, "srst_push_pull") == 0)
290 tmp
|= RESET_SRST_PUSH_PULL
;
291 else if (strcmp(*CMD_ARGV
, "srst_open_drain") == 0)
292 /* open drain from adapter - default */;
296 LOG_ERROR("extra reset_config %s spec (%s)",
297 "srst_type", *CMD_ARGV
);
298 return ERROR_INVALID_ARGUMENTS
;
303 /* caller provided nonsense; fail */
304 LOG_ERROR("unknown reset_config flag (%s)", *CMD_ARGV
);
305 return ERROR_INVALID_ARGUMENTS
;
308 /* Remember the bits which were specified (mask)
309 * and their new values (new_cfg).
315 /* clear previous values of those bits, save new values */
317 int old_cfg
= jtag_get_reset_config();
321 jtag_set_reset_config(new_cfg
);
323 new_cfg
= jtag_get_reset_config();
327 * Display the (now-)current reset mode
331 /* minimal JTAG has neither SRST nor TRST (so that's the default) */
332 switch (new_cfg
& (RESET_HAS_TRST
| RESET_HAS_SRST
)) {
334 modes
[0] = "srst_only";
337 modes
[0] = "trst_only";
339 case RESET_TRST_AND_SRST
:
340 modes
[0] = "trst_and_srst";
347 /* normally SRST and TRST are decoupled; but bugs happen ... */
348 switch (new_cfg
& (RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
)) {
349 case RESET_SRST_PULLS_TRST
:
350 modes
[1] = "srst_pulls_trst";
352 case RESET_TRST_PULLS_SRST
:
353 modes
[1] = "trst_pulls_srst";
355 case RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
:
356 modes
[1] = "combined";
359 modes
[1] = "separate";
363 /* TRST-less connectors include Altera, Xilinx, and minimal JTAG */
364 if (new_cfg
& RESET_HAS_TRST
) {
365 if (new_cfg
& RESET_TRST_OPEN_DRAIN
)
366 modes
[3] = " trst_open_drain";
368 modes
[3] = " trst_push_pull";
372 /* SRST-less connectors include TI-14, Xilinx, and minimal JTAG */
373 if (new_cfg
& RESET_HAS_SRST
) {
374 if (new_cfg
& RESET_SRST_NO_GATING
)
375 modes
[2] = " srst_nogate";
377 modes
[2] = " srst_gates_jtag";
379 if (new_cfg
& RESET_SRST_PUSH_PULL
)
380 modes
[4] = " srst_push_pull";
382 modes
[4] = " srst_open_drain";
388 command_print(CMD_CTX
, "%s %s%s%s%s",
390 modes
[2], modes
[3], modes
[4]);
395 COMMAND_HANDLER(handle_adapter_nsrst_delay_command
)
398 return ERROR_COMMAND_SYNTAX_ERROR
;
402 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], delay
);
404 jtag_set_nsrst_delay(delay
);
406 command_print(CMD_CTX
, "adapter_nsrst_delay: %u", jtag_get_nsrst_delay());
410 COMMAND_HANDLER(handle_adapter_nsrst_assert_width_command
)
413 return ERROR_COMMAND_SYNTAX_ERROR
;
417 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], width
);
419 jtag_set_nsrst_assert_width(width
);
421 command_print(CMD_CTX
, "adapter_nsrst_assert_width: %u", jtag_get_nsrst_assert_width());
427 COMMAND_HANDLER(handle_adapter_khz_command
)
430 return ERROR_COMMAND_SYNTAX_ERROR
;
432 int retval
= ERROR_OK
;
436 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], khz
);
438 retval
= jtag_config_khz(khz
);
439 if (ERROR_OK
!= retval
)
443 int cur_speed
= jtag_get_speed_khz();
444 retval
= jtag_get_speed_readable(&cur_speed
);
445 if (ERROR_OK
!= retval
)
449 command_print(CMD_CTX
, "%d kHz", cur_speed
);
451 command_print(CMD_CTX
, "RCLK - adaptive");
456 static const struct command_registration interface_command_handlers
[] = {
458 .name
= "adapter_khz",
459 .handler
= handle_adapter_khz_command
,
461 .help
= "With an argument, change to the specified maximum "
462 "jtag speed. For JTAG, 0 KHz signifies adaptive "
464 "With or without argument, display current setting.",
468 .name
= "adapter_name",
470 .jim_handler
= jim_adapter_name
,
471 .help
= "Returns the name of the currently "
472 "selected adapter (driver)",
475 .name
= "adapter_nsrst_delay",
476 .handler
= handle_adapter_nsrst_delay_command
,
478 .help
= "delay after deasserting SRST in ms",
479 .usage
= "[milliseconds]",
482 .name
= "adapter_nsrst_assert_width",
483 .handler
= handle_adapter_nsrst_assert_width_command
,
485 .help
= "delay after asserting SRST in ms",
486 .usage
= "[milliseconds]",
490 .handler
= handle_interface_command
,
491 .mode
= COMMAND_CONFIG
,
492 .help
= "Select a debug adapter interface (driver)",
493 .usage
= "driver_name",
496 .name
= "interface_transports",
497 .handler
= interface_transport_command
,
498 .mode
= COMMAND_CONFIG
,
499 .help
= "Declare transports the interface supports.",
500 .usage
= "transport ... ",
503 .name
= "interface_list",
504 .handler
= handle_interface_list_command
,
506 .help
= "List all built-in debug adapter interfaces (drivers)",
509 .name
= "reset_config",
510 .handler
= handle_reset_config_command
,
512 .help
= "configure adapter reset behavior",
513 .usage
= "[none|trst_only|srst_only|trst_and_srst] "
514 "[srst_pulls_trst|trst_pulls_srst|combined|separate] "
515 "[srst_gates_jtag|srst_nogate] "
516 "[trst_push_pull|trst_open_drain] "
517 "[srst_push_pull|srst_open_drain]",
519 COMMAND_REGISTRATION_DONE
523 * Register the commands which deal with arbitrary debug adapter drivers.
525 * @todo Remove internal assumptions that all debug adapters use JTAG for
526 * transport. Various types and data structures are not named generically.
528 int interface_register_commands(struct command_context
*ctx
)
530 return register_commands(ctx
, NULL
, interface_command_handlers
);
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)