1 /***************************************************************************
3 * Copyright (C) 2010 by David Brownell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the
17 * Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 ***************************************************************************/
23 * Utilities to support ARM "Serial Wire Debug" (SWD), a low pin-count debug
24 * link protocol used in cases where JTAG is not wanted. This is coupled to
25 * recent versions of ARM's "CoreSight" debug framework. This specific code
26 * is a transport level interface, with "target/arm_adi_v5.[hc]" code
27 * understanding operation semantics, shared with the JTAG transport.
29 * Single-DAP support only.
31 * for details, see "ARM IHI 0031A"
32 * ARM Debug Interface v5 Architecture Specification
33 * especially section 5.3 for SWD protocol
35 * On many chips (most current Cortex-M3 parts) SWD is a run-time alternative
36 * to JTAG. Boards may support one or both. There are also SWD-only chips,
37 * (using SW-DP not SWJ-DP).
39 * Even boards that also support JTAG can benefit from SWD support, because
40 * usually there's no way to access the SWO trace view mechanism in JTAG mode.
41 * That is, trace access may require SWD support.
50 #include "arm_adi_v5.h"
51 #include <helper/time_support.h>
53 #include <transport/transport.h>
54 #include <jtag/interface.h>
58 /* YUK! - but this is currently a global.... */
59 extern struct jtag_interface
*jtag_interface
;
62 static void swd_finish_read(struct adiv5_dap
*dap
)
64 const struct swd_driver
*swd
= jtag_interface
->swd
;
65 if (dap
->last_read
!= NULL
) {
66 swd
->read_reg(swd_cmd(true, false, DP_RDBUFF
), dap
->last_read
, 0);
67 dap
->last_read
= NULL
;
71 static int swd_queue_dp_write(struct adiv5_dap
*dap
, unsigned reg
,
73 static int swd_queue_dp_read(struct adiv5_dap
*dap
, unsigned reg
,
76 static void swd_clear_sticky_errors(struct adiv5_dap
*dap
)
78 const struct swd_driver
*swd
= jtag_interface
->swd
;
81 swd
->write_reg(swd_cmd(false, false, DP_ABORT
),
82 STKCMPCLR
| STKERRCLR
| WDERRCLR
| ORUNERRCLR
, 0);
85 static int swd_run_inner(struct adiv5_dap
*dap
)
87 const struct swd_driver
*swd
= jtag_interface
->swd
;
92 if (retval
!= ERROR_OK
) {
94 dap
->do_reconnect
= true;
100 static int swd_connect(struct adiv5_dap
*dap
)
105 /* FIXME validate transport config ... is the
106 * configured DAP present (check IDCODE)?
107 * Is *only* one DAP configured?
112 /* Note, debugport_init() does setup too */
113 jtag_interface
->swd
->switch_seq(JTAG_TO_SWD
);
115 /* Make sure we don't try to perform any other accesses before the DPIDR read. */
116 dap
->do_reconnect
= false;
119 swd_queue_dp_read(dap
, DP_IDCODE
, &idcode
);
121 /* force clear all sticky faults */
122 swd_clear_sticky_errors(dap
);
124 status
= swd_run_inner(dap
);
126 if (status
== ERROR_OK
) {
127 LOG_INFO("SWD IDCODE %#8.8" PRIx32
, idcode
);
128 dap
->do_reconnect
= false;
130 dap
->do_reconnect
= true;
135 static inline int check_sync(struct adiv5_dap
*dap
)
137 return do_sync
? swd_run_inner(dap
) : ERROR_OK
;
140 static int swd_check_reconnect(struct adiv5_dap
*dap
)
142 if (dap
->do_reconnect
)
143 return swd_connect(dap
);
148 static int swd_queue_ap_abort(struct adiv5_dap
*dap
, uint8_t *ack
)
150 const struct swd_driver
*swd
= jtag_interface
->swd
;
153 swd
->write_reg(swd_cmd(false, false, DP_ABORT
),
154 DAPABORT
| STKCMPCLR
| STKERRCLR
| WDERRCLR
| ORUNERRCLR
, 0);
155 return check_sync(dap
);
158 /** Select the DP register bank matching bits 7:4 of reg. */
159 static void swd_queue_dp_bankselect(struct adiv5_dap
*dap
, unsigned reg
)
161 if (reg
== DP_SELECT
)
164 uint32_t select_dp_bank
= (reg
& 0x000000F0) >> 4;
165 uint32_t sel
= select_dp_bank
166 | (dap
->select
& (DP_SELECT_APSEL
| DP_SELECT_APBANK
));
168 if (sel
== dap
->select
)
173 swd_queue_dp_write(dap
, DP_SELECT
, sel
);
176 static int swd_queue_dp_read(struct adiv5_dap
*dap
, unsigned reg
,
179 const struct swd_driver
*swd
= jtag_interface
->swd
;
182 int retval
= swd_check_reconnect(dap
);
183 if (retval
!= ERROR_OK
)
186 swd_queue_dp_bankselect(dap
, reg
);
187 swd
->read_reg(swd_cmd(true, false, reg
), data
, 0);
189 return check_sync(dap
);
192 static int swd_queue_dp_write(struct adiv5_dap
*dap
, unsigned reg
,
195 const struct swd_driver
*swd
= jtag_interface
->swd
;
198 int retval
= swd_check_reconnect(dap
);
199 if (retval
!= ERROR_OK
)
202 swd_finish_read(dap
);
203 swd_queue_dp_bankselect(dap
, reg
);
204 swd
->write_reg(swd_cmd(false, false, reg
), data
, 0);
206 return check_sync(dap
);
209 /** Select the AP register bank matching bits 7:4 of reg. */
210 static void swd_queue_ap_bankselect(struct adiv5_ap
*ap
, unsigned reg
)
212 struct adiv5_dap
*dap
= ap
->dap
;
213 uint32_t sel
= ((uint32_t)ap
->ap_num
<< 24)
215 | (dap
->select
& DP_SELECT_DPBANK
);
217 if (sel
== dap
->select
)
222 swd_queue_dp_write(dap
, DP_SELECT
, sel
);
225 static int swd_queue_ap_read(struct adiv5_ap
*ap
, unsigned reg
,
228 const struct swd_driver
*swd
= jtag_interface
->swd
;
231 struct adiv5_dap
*dap
= ap
->dap
;
233 int retval
= swd_check_reconnect(dap
);
234 if (retval
!= ERROR_OK
)
237 swd_queue_ap_bankselect(ap
, reg
);
238 swd
->read_reg(swd_cmd(true, true, reg
), dap
->last_read
, ap
->memaccess_tck
);
239 dap
->last_read
= data
;
241 return check_sync(dap
);
244 static int swd_queue_ap_write(struct adiv5_ap
*ap
, unsigned reg
,
247 const struct swd_driver
*swd
= jtag_interface
->swd
;
250 struct adiv5_dap
*dap
= ap
->dap
;
252 int retval
= swd_check_reconnect(dap
);
253 if (retval
!= ERROR_OK
)
256 swd_finish_read(dap
);
257 swd_queue_ap_bankselect(ap
, reg
);
258 swd
->write_reg(swd_cmd(false, true, reg
), data
, ap
->memaccess_tck
);
260 return check_sync(dap
);
263 /** Executes all queued DAP operations. */
264 static int swd_run(struct adiv5_dap
*dap
)
266 swd_finish_read(dap
);
267 return swd_run_inner(dap
);
270 const struct dap_ops swd_dap_ops
= {
271 .queue_dp_read
= swd_queue_dp_read
,
272 .queue_dp_write
= swd_queue_dp_write
,
273 .queue_ap_read
= swd_queue_ap_read
,
274 .queue_ap_write
= swd_queue_ap_write
,
275 .queue_ap_abort
= swd_queue_ap_abort
,
280 * This represents the bits which must be sent out on TMS/SWDIO to
281 * switch a DAP implemented using an SWJ-DP module into SWD mode.
282 * These bits are stored (and transmitted) LSB-first.
284 * See the DAP-Lite specification, section 2.2.5 for information
285 * about making the debug link select SWD or JTAG. (Similar info
286 * is in a few other ARM documents.)
288 static const uint8_t jtag2swd_bitseq
[] = {
289 /* More than 50 TCK/SWCLK cycles with TMS/SWDIO high,
290 * putting both JTAG and SWD logic into reset state.
292 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
293 /* Switching sequence enables SWD and disables JTAG
294 * NOTE: bits in the DP's IDCODE may expose the need for
295 * an old/obsolete/deprecated sequence (0xb6 0xed).
298 /* More than 50 TCK/SWCLK cycles with TMS/SWDIO high,
299 * putting both JTAG and SWD logic into reset state.
301 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
305 * Put the debug link into SWD mode, if the target supports it.
306 * The link's initial mode may be either JTAG (for example,
307 * with SWJ-DP after reset) or SWD.
309 * @param target Enters SWD mode (if possible).
311 * Note that targets using the JTAG-DP do not support SWD, and that
312 * some targets which could otherwise support it may have have been
313 * configured to disable SWD signaling
315 * @return ERROR_OK or else a fault code.
317 int dap_to_swd(struct target
*target
)
319 struct arm
*arm
= target_to_arm(target
);
323 LOG_ERROR("SWD mode is not available");
327 LOG_DEBUG("Enter SWD mode");
329 /* REVISIT it's ugly to need to make calls to a "jtag"
330 * subsystem if the link may not be in JTAG mode...
333 retval
= jtag_add_tms_seq(8 * sizeof(jtag2swd_bitseq
),
334 jtag2swd_bitseq
, TAP_INVALID
);
335 if (retval
== ERROR_OK
)
336 retval
= jtag_execute_queue();
338 /* set up the DAP's ops vector for SWD mode. */
339 arm
->dap
->ops
= &swd_dap_ops
;
344 COMMAND_HANDLER(handle_swd_wcr
)
347 struct target
*target
= get_current_target(CMD_CTX
);
348 struct arm
*arm
= target_to_arm(target
);
349 struct adiv5_dap
*dap
= arm
->dap
;
351 unsigned trn
, scale
= 0;
354 /* no-args: just dump state */
356 /*retval = swd_queue_dp_read(dap, DP_WCR, &wcr); */
357 retval
= dap_queue_dp_read(dap
, DP_WCR
, &wcr
);
358 if (retval
== ERROR_OK
)
360 if (retval
!= ERROR_OK
) {
361 LOG_ERROR("can't read WCR?");
365 command_print(CMD_CTX
,
366 "turnaround=%" PRIu32
", prescale=%" PRIu32
,
368 WCR_TO_PRESCALE(wcr
));
371 case 2: /* TRN and prescale */
372 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[1], scale
);
374 LOG_ERROR("prescale %d is too big", scale
);
379 case 1: /* TRN only */
380 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], trn
);
381 if (trn
< 1 || trn
> 4) {
382 LOG_ERROR("turnaround %d is invalid", trn
);
386 wcr
= ((trn
- 1) << 8) | scale
;
389 * then, re-init adapter with new TRN
391 LOG_ERROR("can't yet modify WCR");
394 default: /* too many arguments */
395 return ERROR_COMMAND_SYNTAX_ERROR
;
399 static const struct command_registration swd_commands
[] = {
402 * Set up SWD and JTAG targets identically, unless/until
403 * infrastructure improves ... meanwhile, ignore all
404 * JTAG-specific stuff like IR length for SWD.
406 * REVISIT can we verify "just one SWD DAP" here/early?
409 .jim_handler
= jim_jtag_newtap
,
410 .mode
= COMMAND_CONFIG
,
411 .help
= "declare a new SWD DAP"
415 .handler
= handle_swd_wcr
,
417 .help
= "display or update DAP's WCR register",
418 .usage
= "turnaround (1..4), prescale (0..7)",
421 /* REVISIT -- add a command for SWV trace on/off */
422 COMMAND_REGISTRATION_DONE
425 static const struct command_registration swd_handlers
[] = {
429 .help
= "SWD command group",
430 .chain
= swd_commands
,
432 COMMAND_REGISTRATION_DONE
435 static int swd_select(struct command_context
*ctx
)
439 retval
= register_commands(ctx
, NULL
, swd_handlers
);
441 if (retval
!= ERROR_OK
)
444 const struct swd_driver
*swd
= jtag_interface
->swd
;
446 /* be sure driver is in SWD mode; start
447 * with hardware default TRN (1), it can be changed later
449 if (!swd
|| !swd
->read_reg
|| !swd
->write_reg
|| !swd
->init
) {
450 LOG_DEBUG("no SWD driver?");
454 retval
= swd
->init();
455 if (retval
!= ERROR_OK
) {
456 LOG_DEBUG("can't init SWD driver");
460 /* force DAP into SWD mode (not JTAG) */
461 /*retval = dap_to_swd(target);*/
463 if (ctx
->current_target
) {
464 /* force DAP into SWD mode (not JTAG) */
465 struct target
*target
= get_current_target(ctx
);
466 retval
= dap_to_swd(target
);
472 static int swd_init(struct command_context
*ctx
)
474 struct target
*target
= get_current_target(ctx
);
475 struct arm
*arm
= target_to_arm(target
);
476 struct adiv5_dap
*dap
= arm
->dap
;
477 /* Force the DAP's ops vector for SWD mode.
478 * messy - is there a better way? */
479 arm
->dap
->ops
= &swd_dap_ops
;
481 return swd_connect(dap
);
484 static struct transport swd_transport
= {
486 .select
= swd_select
,
490 static void swd_constructor(void) __attribute__((constructor
));
491 static void swd_constructor(void)
493 transport_register(&swd_transport
);
496 /** Returns true if the current debug session
497 * is using SWD as its transport.
499 bool transport_is_swd(void)
501 return get_current_transport() == &swd_transport
;
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)