git.sur5r.net Git - openocd/blob - src/target/adi_v5_swd.c

   1 /***************************************************************************
   2  *
   3  *   Copyright (C) 2010 by David Brownell
   4  *
   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.
   9  *
  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.
  14  *
  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  ***************************************************************************/
  20
  21 /**
  22  * @file
  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.
  28  *
  29  * Single-DAP support only.
  30  *
  31  * for details, see "ARM IHI 0031A"
  32  * ARM Debug Interface v5 Architecture Specification
  33  * especially section 5.3 for SWD protocol
  34  *
  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).
  38  *
  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.
  42  *
  43  */
  44
  45 #ifdef HAVE_CONFIG_H
  46 #include "config.h"
  47 #endif
  48
  49 #include "arm.h"
  50 #include "arm_adi_v5.h"
  51 #include <helper/time_support.h>
  52
  53 #include <transport/transport.h>
  54 #include <jtag/interface.h>
  55
  56 #include <jtag/swd.h>
  57
  58 /* YUK! - but this is currently a global.... */
  59 extern struct jtag_interface *jtag_interface;
  60 static bool do_sync;
  61
  62 static void swd_finish_read(struct adiv5_dap *dap)
  63 {
  64         const struct swd_driver *swd = jtag_interface->swd;
  65         if (dap->last_read != NULL) {
  66                 swd->read_reg(dap, swd_cmd(true, false, DP_RDBUFF), dap->last_read);
  67                 dap->last_read = NULL;
  68         }
  69 }
  70
  71 static int swd_queue_dp_write(struct adiv5_dap *dap, unsigned reg,
  72                 uint32_t data);
  73
  74 static void swd_clear_sticky_errors(struct adiv5_dap *dap)
  75 {
  76         const struct swd_driver *swd = jtag_interface->swd;
  77         assert(swd);
  78
  79         swd->write_reg(dap, swd_cmd(false,  false, DP_ABORT),
  80                 STKCMPCLR | STKERRCLR | WDERRCLR | ORUNERRCLR);
  81 }
  82
  83 static int swd_run_inner(struct adiv5_dap *dap)
  84 {
  85         const struct swd_driver *swd = jtag_interface->swd;
  86
  87         int retval = swd->run(dap);
  88
  89         if (retval != ERROR_OK) {
  90                 /* fault response */
  91                 swd_clear_sticky_errors(dap);
  92         }
  93
  94         return retval;
  95 }
  96
  97 static inline int check_sync(struct adiv5_dap *dap)
  98 {
  99         return do_sync ? swd_run_inner(dap) : ERROR_OK;
 100 }
 101
 102 static int swd_queue_ap_abort(struct adiv5_dap *dap, uint8_t *ack)
 103 {
 104         const struct swd_driver *swd = jtag_interface->swd;
 105         assert(swd);
 106
 107         swd->write_reg(dap, swd_cmd(false,  false, DP_ABORT),
 108                 DAPABORT | STKCMPCLR | STKERRCLR | WDERRCLR | ORUNERRCLR);
 109         return check_sync(dap);
 110 }
 111
 112 /** Select the DP register bank matching bits 7:4 of reg. */
 113 static void swd_queue_dp_bankselect(struct adiv5_dap *dap, unsigned reg)
 114 {
 115         uint32_t select_dp_bank = (reg & 0x000000F0) >> 4;
 116
 117         if (reg == DP_SELECT)
 118                 return;
 119
 120         if (select_dp_bank == dap->dp_bank_value)
 121                 return;
 122
 123         dap->dp_bank_value = select_dp_bank;
 124         select_dp_bank |= dap->ap_current | dap->ap_bank_value;
 125
 126         swd_queue_dp_write(dap, DP_SELECT, select_dp_bank);
 127 }
 128
 129 static int swd_queue_dp_read(struct adiv5_dap *dap, unsigned reg,
 130                 uint32_t *data)
 131 {
 132         const struct swd_driver *swd = jtag_interface->swd;
 133         assert(swd);
 134
 135         swd_queue_dp_bankselect(dap, reg);
 136         swd->read_reg(dap, swd_cmd(true,  false, reg), data);
 137
 138         return check_sync(dap);
 139 }
 140
 141
 142 static int swd_queue_dp_write(struct adiv5_dap *dap, unsigned reg,
 143                 uint32_t data)
 144 {
 145         const struct swd_driver *swd = jtag_interface->swd;
 146         assert(swd);
 147
 148         swd_finish_read(dap);
 149         swd_queue_dp_bankselect(dap, reg);
 150         swd->write_reg(dap, swd_cmd(false,  false, reg), data);
 151
 152         return check_sync(dap);
 153 }
 154
 155 /** Select the AP register bank matching bits 7:4 of reg. */
 156 static void swd_queue_ap_bankselect(struct adiv5_dap *dap, unsigned reg)
 157 {
 158         uint32_t select_ap_bank = reg & 0x000000F0;
 159
 160         if (select_ap_bank == dap->ap_bank_value)
 161                 return;
 162
 163         dap->ap_bank_value = select_ap_bank;
 164         select_ap_bank |= dap->ap_current | dap->dp_bank_value;
 165
 166         swd_queue_dp_write(dap, DP_SELECT, select_ap_bank);
 167 }
 168
 169 static int swd_queue_ap_read(struct adiv5_dap *dap, unsigned reg,
 170                 uint32_t *data)
 171 {
 172         const struct swd_driver *swd = jtag_interface->swd;
 173         assert(swd);
 174
 175         swd_queue_ap_bankselect(dap, reg);
 176         swd->read_reg(dap, swd_cmd(true,  true, reg), dap->last_read);
 177         dap->last_read = data;
 178
 179         return check_sync(dap);
 180 }
 181
 182 static int swd_queue_ap_write(struct adiv5_dap *dap, unsigned reg,
 183                 uint32_t data)
 184 {
 185         const struct swd_driver *swd = jtag_interface->swd;
 186         assert(swd);
 187
 188         swd_finish_read(dap);
 189         swd_queue_ap_bankselect(dap, reg);
 190         swd->write_reg(dap, swd_cmd(false,  true, reg), data);
 191
 192         return check_sync(dap);
 193 }
 194
 195 /** Executes all queued DAP operations. */
 196 static int swd_run(struct adiv5_dap *dap)
 197 {
 198         swd_finish_read(dap);
 199         return swd_run_inner(dap);
 200 }
 201
 202 const struct dap_ops swd_dap_ops = {
 203         .is_swd = true,
 204
 205         .queue_dp_read = swd_queue_dp_read,
 206         .queue_dp_write = swd_queue_dp_write,
 207         .queue_ap_read = swd_queue_ap_read,
 208         .queue_ap_write = swd_queue_ap_write,
 209         .queue_ap_abort = swd_queue_ap_abort,
 210         .run = swd_run,
 211 };
 212
 213 /*
 214  * This represents the bits which must be sent out on TMS/SWDIO to
 215  * switch a DAP implemented using an SWJ-DP module into SWD mode.
 216  * These bits are stored (and transmitted) LSB-first.
 217  *
 218  * See the DAP-Lite specification, section 2.2.5 for information
 219  * about making the debug link select SWD or JTAG.  (Similar info
 220  * is in a few other ARM documents.)
 221  */
 222 static const uint8_t jtag2swd_bitseq[] = {
 223         /* More than 50 TCK/SWCLK cycles with TMS/SWDIO high,
 224          * putting both JTAG and SWD logic into reset state.
 225          */
 226         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
 227         /* Switching sequence enables SWD and disables JTAG
 228          * NOTE: bits in the DP's IDCODE may expose the need for
 229          * an old/obsolete/deprecated sequence (0xb6 0xed).
 230          */
 231         0x9e, 0xe7,
 232         /* More than 50 TCK/SWCLK cycles with TMS/SWDIO high,
 233          * putting both JTAG and SWD logic into reset state.
 234          */
 235         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
 236 };
 237
 238 /**
 239  * Put the debug link into SWD mode, if the target supports it.
 240  * The link's initial mode may be either JTAG (for example,
 241  * with SWJ-DP after reset) or SWD.
 242  *
 243  * @param target Enters SWD mode (if possible).
 244  *
 245  * Note that targets using the JTAG-DP do not support SWD, and that
 246  * some targets which could otherwise support it may have have been
 247  * configured to disable SWD signaling
 248  *
 249  * @return ERROR_OK or else a fault code.
 250  */
 251 int dap_to_swd(struct target *target)
 252 {
 253         struct arm *arm = target_to_arm(target);
 254         int retval;
 255
 256         LOG_DEBUG("Enter SWD mode");
 257
 258         /* REVISIT it's ugly to need to make calls to a "jtag"
 259          * subsystem if the link may not be in JTAG mode...
 260          */
 261
 262         retval =  jtag_add_tms_seq(8 * sizeof(jtag2swd_bitseq),
 263                         jtag2swd_bitseq, TAP_INVALID);
 264         if (retval == ERROR_OK)
 265                 retval = jtag_execute_queue();
 266
 267         /* set up the DAP's ops vector for SWD mode. */
 268         arm->dap->ops = &swd_dap_ops;
 269
 270         return retval;
 271 }
 272
 273 COMMAND_HANDLER(handle_swd_wcr)
 274 {
 275         int retval;
 276         struct target *target = get_current_target(CMD_CTX);
 277         struct arm *arm = target_to_arm(target);
 278         struct adiv5_dap *dap = arm->dap;
 279         uint32_t wcr;
 280         unsigned trn, scale = 0;
 281
 282         switch (CMD_ARGC) {
 283         /* no-args: just dump state */
 284         case 0:
 285                 /*retval = swd_queue_dp_read(dap, DP_WCR, &wcr); */
 286                 retval = dap_queue_dp_read(dap, DP_WCR, &wcr);
 287                 if (retval == ERROR_OK)
 288                         dap->ops->run(dap);
 289                 if (retval != ERROR_OK) {
 290                         LOG_ERROR("can't read WCR?");
 291                         return retval;
 292                 }
 293
 294                 command_print(CMD_CTX,
 295                         "turnaround=%" PRIu32 ", prescale=%" PRIu32,
 296                         WCR_TO_TRN(wcr),
 297                         WCR_TO_PRESCALE(wcr));
 298         return ERROR_OK;
 299
 300         case 2:         /* TRN and prescale */
 301                 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], scale);
 302                 if (scale > 7) {
 303                         LOG_ERROR("prescale %d is too big", scale);
 304                         return ERROR_FAIL;
 305                 }
 306                 /* FALL THROUGH */
 307
 308         case 1:         /* TRN only */
 309                 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], trn);
 310                 if (trn < 1 || trn > 4) {
 311                         LOG_ERROR("turnaround %d is invalid", trn);
 312                         return ERROR_FAIL;
 313                 }
 314
 315                 wcr = ((trn - 1) << 8) | scale;
 316                 /* FIXME
 317                  * write WCR ...
 318                  * then, re-init adapter with new TRN
 319                  */
 320                 LOG_ERROR("can't yet modify WCR");
 321                 return ERROR_FAIL;
 322
 323         default:        /* too many arguments */
 324                 return ERROR_COMMAND_SYNTAX_ERROR;
 325         }
 326 }
 327
 328 static const struct command_registration swd_commands[] = {
 329         {
 330                 /*
 331                  * Set up SWD and JTAG targets identically, unless/until
 332                  * infrastructure improves ...  meanwhile, ignore all
 333                  * JTAG-specific stuff like IR length for SWD.
 334                  *
 335                  * REVISIT can we verify "just one SWD DAP" here/early?
 336                  */
 337                 .name = "newdap",
 338                 .jim_handler = jim_jtag_newtap,
 339                 .mode = COMMAND_CONFIG,
 340                 .help = "declare a new SWD DAP"
 341         },
 342         {
 343                 .name = "wcr",
 344                 .handler = handle_swd_wcr,
 345                 .mode = COMMAND_ANY,
 346                 .help = "display or update DAP's WCR register",
 347                 .usage = "turnaround (1..4), prescale (0..7)",
 348         },
 349
 350         /* REVISIT -- add a command for SWV trace on/off */
 351         COMMAND_REGISTRATION_DONE
 352 };
 353
 354 static const struct command_registration swd_handlers[] = {
 355         {
 356                 .name = "swd",
 357                 .mode = COMMAND_ANY,
 358                 .help = "SWD command group",
 359                 .chain = swd_commands,
 360         },
 361         COMMAND_REGISTRATION_DONE
 362 };
 363
 364 static int swd_select(struct command_context *ctx)
 365 {
 366         int retval;
 367
 368         retval = register_commands(ctx, NULL, swd_handlers);
 369
 370         if (retval != ERROR_OK)
 371                 return retval;
 372
 373         const struct swd_driver *swd = jtag_interface->swd;
 374
 375          /* be sure driver is in SWD mode; start
 376           * with hardware default TRN (1), it can be changed later
 377           */
 378         if (!swd || !swd->read_reg || !swd->write_reg || !swd->init) {
 379                 LOG_DEBUG("no SWD driver?");
 380                 return ERROR_FAIL;
 381         }
 382
 383         retval = swd->init();
 384         if (retval != ERROR_OK) {
 385                 LOG_DEBUG("can't init SWD driver");
 386                 return retval;
 387         }
 388
 389         /* force DAP into SWD mode (not JTAG) */
 390         /*retval = dap_to_swd(target);*/
 391
 392         if (ctx->current_target) {
 393                 /* force DAP into SWD mode (not JTAG) */
 394                 struct target *target = get_current_target(ctx);
 395                 retval = dap_to_swd(target);
 396         }
 397
 398         return retval;
 399 }
 400
 401 static int swd_init(struct command_context *ctx)
 402 {
 403         struct target *target = get_current_target(ctx);
 404         struct arm *arm = target_to_arm(target);
 405         struct adiv5_dap *dap = arm->dap;
 406         uint32_t idcode;
 407         int status;
 408
 409         /* Force the DAP's ops vector for SWD mode.
 410          * messy - is there a better way? */
 411         arm->dap->ops = &swd_dap_ops;
 412
 413         /* FIXME validate transport config ... is the
 414          * configured DAP present (check IDCODE)?
 415          * Is *only* one DAP configured?
 416          *
 417          * MUST READ IDCODE
 418          */
 419
 420  /* Note, debugport_init() does setup too */
 421
 422         swd_queue_dp_read(dap, DP_IDCODE, &idcode);
 423
 424         /* force clear all sticky faults */
 425         swd_clear_sticky_errors(dap);
 426
 427         status = swd_run(dap);
 428
 429         if (status == ERROR_OK)
 430                 LOG_INFO("SWD IDCODE %#8.8" PRIx32, idcode);
 431
 432         return status;
 433 }
 434
 435 static struct transport swd_transport = {
 436         .name = "swd",
 437         .select = swd_select,
 438         .init = swd_init,
 439 };
 440
 441 static void swd_constructor(void) __attribute__((constructor));
 442 static void swd_constructor(void)
 443 {
 444         transport_register(&swd_transport);
 445 }
 446
 447 /** Returns true if the current debug session
 448  * is using SWD as its transport.
 449  */
 450 bool transport_is_swd(void)
 451 {
 452         return get_current_transport() == &swd_transport;
 453 }