2 * Copyright (c) 2010 by David Brownell
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * Infrastructure for specifying and managing the transport protocol
25 * used in a given debug or programming session.
27 * Examples of "debug-capable" transports are JTAG or SWD.
28 * Additionally, JTAG supports boundary scan testing.
30 * Examples of "programming-capable" transports include SPI or UART;
31 * those are used (often mediated by a ROM bootloader) for ISP style
32 * programming, to perform an initial load of code into flash, or
33 * sometimes into SRAM. Target code could use "variant" options to
34 * decide how to use such protocols. For example, Cortex-M3 cores
35 * from TI/Luminary and from NXP use different protocols for for
36 * UART or SPI based firmware loading.
38 * As a rule, there are protocols layered on top of the transport.
39 * For example, different chip families use JTAG in different ways
40 * for debugging. Also, each family that supports programming over
41 * a UART link for initial firmware loading tends to define its own
42 * messaging and error handling.
45 #include <helper/log.h>
46 #include <transport/transport.h>
48 extern struct command_context
*global_cmd_ctx
;
50 /*-----------------------------------------------------------------------*/
53 * Infrastructure internals
56 /** List of transports known to OpenOCD. */
57 static struct transport
*transport_list
;
60 * NULL-terminated Vector of names of transports which the
61 * currently selected debug adapter supports. This is declared
62 * by the time that adapter is fully set up.
64 static const char **allowed_transports
;
66 /** * The transport being used for the current OpenOCD session. */
67 static struct transport
*session
;
69 static int transport_select(struct command_context
*ctx
, const char *name
)
71 /* name may only identify a known transport;
72 * caller guarantees session's transport isn't yet set.*/
73 for (struct transport
*t
= transport_list
; t
; t
= t
->next
) {
74 if (strcmp(t
->name
, name
) == 0) {
75 int retval
= t
->select(ctx
);
76 /* select() registers commands specific to this
77 * transport, and may also reset the link, e.g.
78 * forcing it to JTAG or SWD mode.
80 if (retval
== ERROR_OK
)
83 LOG_ERROR("Error selecting '%s' as transport", t
->name
);
88 LOG_ERROR("No transport named '%s' is available.", name
);
93 * Called by debug adapter drivers, or affiliated Tcl config scripts,
94 * to declare the set of transports supported by an adapter. When
95 * there is only one member of that set, it is automatically selected.
97 int allow_transports(struct command_context
*ctx
, const char **vector
)
99 /* NOTE: caller is required to provide only a list
100 * of *valid* transport names
102 * REVISIT should we validate that? and insist there's
103 * at least one non-NULL element in that list?
105 * ... allow removals, e.g. external strapping prevents use
106 * of one transport; C code should be definitive about what
107 * can be used when all goes well.
109 if (allowed_transports
!= NULL
|| session
) {
110 LOG_ERROR("Can't modify the set of allowed transports.");
114 allowed_transports
= vector
;
116 /* autoselect if there's no choice ... */
118 LOG_INFO("only one transport option; autoselect '%s'", vector
[0]);
119 return transport_select(ctx
, vector
[0]);
126 * Used to verify corrrect adapter driver initialization.
128 * @returns true iff the adapter declared one or more transports.
130 bool transports_are_declared(void)
132 return allowed_transports
!= NULL
;
136 * Registers a transport. There are general purpose transports
137 * (such as JTAG), as well as relatively proprietary ones which are
138 * specific to a given chip (or chip family).
140 * Code implementing a transport needs to register it before it can
141 * be selected and then activated. This is a dynamic process, so
142 * that chips (and families) can define transports as needed (without
143 * nneeding error-prone static tables).
145 * @param new_transport the transport being registered. On a
146 * successful return, this memory is owned by the transport framework.
148 * @returns ERROR_OK on success, else a fault code.
150 int transport_register(struct transport
*new_transport
)
154 for (t
= transport_list
; t
; t
= t
->next
) {
155 if (strcmp(t
->name
, new_transport
->name
) == 0) {
156 LOG_ERROR("transport name already used");
161 if (!new_transport
->select
|| !new_transport
->init
)
162 LOG_ERROR("invalid transport %s", new_transport
->name
);
164 /* splice this into the list */
165 new_transport
->next
= transport_list
;
166 transport_list
= new_transport
;
167 LOG_DEBUG("register '%s'", new_transport
->name
);
173 * Returns the transport currently being used by this debug or
174 * programming session.
176 * @returns handle to the read-only transport entity.
178 struct transport
*get_current_transport(void)
180 /* REVISIT -- constify */
184 /*-----------------------------------------------------------------------*/
187 * Infrastructure for Tcl interface to transports.
191 * Makes and stores a copy of a set of transports passed as
192 * parameters to a command.
194 * @param vector where the resulting copy is stored, as an argv-style
195 * NULL-terminated vector.
197 COMMAND_HELPER(transport_list_parse
, char ***vector
)
200 unsigned n
= CMD_ARGC
;
206 return ERROR_COMMAND_SYNTAX_ERROR
;
208 /* our return vector must be NULL terminated */
209 argv
= (char **) calloc(n
+ 1, sizeof(char *));
213 for (unsigned i
= 0; i
< n
; i
++) {
216 for (t
= transport_list
; t
; t
= t
->next
) {
217 if (strcmp(t
->name
, CMD_ARGV
[i
]) != 0)
219 argv
[j
++] = strdup(CMD_ARGV
[i
]);
223 LOG_ERROR("no such transport '%s'", CMD_ARGV
[i
]);
232 for (unsigned i
= 0; i
< n
; i
++)
238 COMMAND_HANDLER(handle_transport_init
)
240 LOG_DEBUG("%s", __func__
);
242 LOG_ERROR("session's transport is not selected.");
244 /* no session transport configured, print transports then fail */
245 const char **vector
= allowed_transports
;
247 LOG_ERROR("allow transport '%s'", *vector
);
253 return session
->init(CMD_CTX
);
256 COMMAND_HANDLER(handle_transport_list
)
259 return ERROR_COMMAND_SYNTAX_ERROR
;
261 command_print(CMD_CTX
, "The following transports are available:");
263 for (struct transport
*t
= transport_list
; t
; t
= t
->next
)
264 command_print(CMD_CTX
, "\t%s", t
->name
);
270 * Implements the Tcl "transport select" command, choosing the
271 * transport to be used in this debug session from among the
272 * set supported by the debug adapter being used. Return value
273 * is scriptable (allowing "if swd then..." etc).
275 static int jim_transport_select(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
278 case 1: /* return/display */
280 LOG_ERROR("session's transport is not selected.");
283 Jim_SetResultString(interp
, session
->name
, -1);
289 /* can't change session's transport after-the-fact */
290 LOG_ERROR("session's transport is already selected.");
294 /* Is this transport supported by our debug adapter?
295 * Example, "JTAG-only" means SWD is not supported.
297 * NOTE: requires adapter to have been set up, with
298 * transports declared via C.
300 if (!allowed_transports
) {
301 LOG_ERROR("Debug adapter doesn't support any transports?");
305 for (unsigned i
= 0; allowed_transports
[i
]; i
++) {
307 if (strcmp(allowed_transports
[i
], argv
[1]->bytes
) == 0)
308 return transport_select(global_cmd_ctx
, argv
[1]->bytes
);
311 LOG_ERROR("Debug adapter doesn't support '%s' transport", argv
[1]->bytes
);
315 Jim_WrongNumArgs(interp
, 1, argv
, "[too many parameters]");
320 static const struct command_registration transport_commands
[] = {
323 .handler
= handle_transport_init
,
324 /* this would be COMMAND_CONFIG ... except that
325 * it needs to trigger event handlers that may
326 * require COMMAND_EXEC ...
329 .help
= "Initialize this session's transport",
334 .handler
= handle_transport_list
,
336 .help
= "list all built-in transports",
341 .jim_handler
= jim_transport_select
,
343 .help
= "Select this session's transport",
344 .usage
= "[transport_name]",
346 COMMAND_REGISTRATION_DONE
349 static const struct command_registration transport_group
[] = {
353 .help
= "Transport command group",
354 .chain
= transport_commands
,
357 COMMAND_REGISTRATION_DONE
360 int transport_register_commands(struct command_context
*ctx
)
362 return register_commands(ctx
, NULL
, transport_group
);
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)