git.gag.com Git - fw/openocd/blob - src/jtag/drivers/stlink_usb.c

   1 /***************************************************************************
   2  *   SWIM contributions by Ake Rehnman                                     *
   3  *   Copyright (C) 2017  Ake Rehnman                                       *
   4  *   ake.rehnman(at)gmail.com                                              *
   5  *                                                                         *
   6  *   Copyright (C) 2011-2012 by Mathias Kuester                            *
   7  *   Mathias Kuester <kesmtp@freenet.de>                                   *
   8  *                                                                         *
   9  *   Copyright (C) 2012 by Spencer Oliver                                  *
  10  *   spen@spen-soft.co.uk                                                  *
  11  *                                                                         *
  12  *   This code is based on https://github.com/texane/stlink                *
  13  *                                                                         *
  14  *   This program is free software; you can redistribute it and/or modify  *
  15  *   it under the terms of the GNU General Public License as published by  *
  16  *   the Free Software Foundation; either version 2 of the License, or     *
  17  *   (at your option) any later version.                                   *
  18  *                                                                         *
  19  *   This program is distributed in the hope that it will be useful,       *
  20  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  21  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  22  *   GNU General Public License for more details.                          *
  23  *                                                                         *
  24  *   You should have received a copy of the GNU General Public License     *
  25  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  26  ***************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 /* project specific includes */
  33 #include <helper/binarybuffer.h>
  34 #include <helper/bits.h>
  35 #include <jtag/interface.h>
  36 #include <jtag/hla/hla_layout.h>
  37 #include <jtag/hla/hla_transport.h>
  38 #include <jtag/hla/hla_interface.h>
  39 #include <jtag/swim.h>
  40 #include <target/target.h>
  41 #include <transport/transport.h>
  42
  43 #include <target/cortex_m.h>
  44
  45 #include "libusb_helper.h"
  46
  47 #ifdef HAVE_LIBUSB1
  48 #define USE_LIBUSB_ASYNCIO
  49 #endif
  50
  51 #define STLINK_SERIAL_LEN 24
  52
  53 #define ENDPOINT_IN  0x80
  54 #define ENDPOINT_OUT 0x00
  55
  56 #define STLINK_WRITE_TIMEOUT 1000
  57 #define STLINK_READ_TIMEOUT 1000
  58
  59 #define STLINK_RX_EP          (1|ENDPOINT_IN)
  60 #define STLINK_TX_EP          (2|ENDPOINT_OUT)
  61 #define STLINK_TRACE_EP       (3|ENDPOINT_IN)
  62
  63 #define STLINK_V2_1_TX_EP     (1|ENDPOINT_OUT)
  64 #define STLINK_V2_1_TRACE_EP  (2|ENDPOINT_IN)
  65
  66 #define STLINK_SG_SIZE        (31)
  67 #define STLINK_DATA_SIZE      (4096)
  68 #define STLINK_CMD_SIZE_V2    (16)
  69 #define STLINK_CMD_SIZE_V1    (10)
  70
  71 #define STLINK_V1_PID         (0x3744)
  72 #define STLINK_V2_PID         (0x3748)
  73 #define STLINK_V2_1_PID       (0x374B)
  74 #define STLINK_V2_1_NO_MSD_PID  (0x3752)
  75 #define STLINK_V3_USBLOADER_PID (0x374D)
  76 #define STLINK_V3E_PID          (0x374E)
  77 #define STLINK_V3S_PID          (0x374F)
  78 #define STLINK_V3_2VCP_PID      (0x3753)
  79
  80 /*
  81  * ST-Link/V1, ST-Link/V2 and ST-Link/V2.1 are full-speed USB devices and
  82  * this limits the bulk packet size and the 8bit read/writes to max 64 bytes.
  83  * STLINK-V3 is a high speed USB 2.0 and the limit is 512 bytes from FW V3J6.
  84  */
  85 #define STLINK_MAX_RW8          (64)
  86 #define STLINKV3_MAX_RW8        (512)
  87
  88 /* "WAIT" responses will be retried (with exponential backoff) at
  89  * most this many times before failing to caller.
  90  */
  91 #define MAX_WAIT_RETRIES 8
  92
  93 enum stlink_jtag_api_version {
  94         STLINK_JTAG_API_V1 = 1,
  95         STLINK_JTAG_API_V2,
  96         STLINK_JTAG_API_V3,
  97 };
  98
  99 enum stlink_mode {
 100         STLINK_MODE_UNKNOWN = 0,
 101         STLINK_MODE_DFU,
 102         STLINK_MODE_MASS,
 103         STLINK_MODE_DEBUG_JTAG,
 104         STLINK_MODE_DEBUG_SWD,
 105         STLINK_MODE_DEBUG_SWIM
 106 };
 107
 108 /** */
 109 struct stlink_usb_version {
 110         /** */
 111         int stlink;
 112         /** */
 113         int jtag;
 114         /** */
 115         int swim;
 116         /** jtag api version supported */
 117         enum stlink_jtag_api_version jtag_api;
 118         /** one bit for each feature supported. See macros STLINK_F_* */
 119         uint32_t flags;
 120 };
 121
 122 /** */
 123 struct stlink_usb_handle_s {
 124         /** */
 125         struct libusb_device_handle *fd;
 126         /** */
 127         struct libusb_transfer *trans;
 128         /** */
 129         uint8_t rx_ep;
 130         /** */
 131         uint8_t tx_ep;
 132         /** */
 133         uint8_t trace_ep;
 134         /** */
 135         uint8_t cmdbuf[STLINK_SG_SIZE];
 136         /** */
 137         uint8_t cmdidx;
 138         /** */
 139         uint8_t direction;
 140         /** */
 141         uint8_t databuf[STLINK_DATA_SIZE];
 142         /** */
 143         uint32_t max_mem_packet;
 144         /** */
 145         enum stlink_mode st_mode;
 146         /** */
 147         struct stlink_usb_version version;
 148         /** */
 149         uint16_t vid;
 150         /** */
 151         uint16_t pid;
 152         /** */
 153         struct {
 154                 /** whether SWO tracing is enabled or not */
 155                 bool enabled;
 156                 /** trace module source clock */
 157                 uint32_t source_hz;
 158         } trace;
 159         /** reconnect is needed next time we try to query the
 160          * status */
 161         bool reconnect_pending;
 162 };
 163
 164 #define STLINK_SWIM_ERR_OK             0x00
 165 #define STLINK_SWIM_BUSY               0x01
 166 #define STLINK_DEBUG_ERR_OK            0x80
 167 #define STLINK_DEBUG_ERR_FAULT         0x81
 168 #define STLINK_SWD_AP_WAIT             0x10
 169 #define STLINK_SWD_AP_FAULT            0x11
 170 #define STLINK_SWD_AP_ERROR            0x12
 171 #define STLINK_SWD_AP_PARITY_ERROR     0x13
 172 #define STLINK_JTAG_GET_IDCODE_ERROR   0x09
 173 #define STLINK_JTAG_WRITE_ERROR        0x0c
 174 #define STLINK_JTAG_WRITE_VERIF_ERROR  0x0d
 175 #define STLINK_SWD_DP_WAIT             0x14
 176 #define STLINK_SWD_DP_FAULT            0x15
 177 #define STLINK_SWD_DP_ERROR            0x16
 178 #define STLINK_SWD_DP_PARITY_ERROR     0x17
 179
 180 #define STLINK_SWD_AP_WDATA_ERROR      0x18
 181 #define STLINK_SWD_AP_STICKY_ERROR     0x19
 182 #define STLINK_SWD_AP_STICKYORUN_ERROR 0x1a
 183
 184 #define STLINK_BAD_AP_ERROR            0x1d
 185
 186 #define STLINK_CORE_RUNNING            0x80
 187 #define STLINK_CORE_HALTED             0x81
 188 #define STLINK_CORE_STAT_UNKNOWN       -1
 189
 190 #define STLINK_GET_VERSION             0xF1
 191 #define STLINK_DEBUG_COMMAND           0xF2
 192 #define STLINK_DFU_COMMAND             0xF3
 193 #define STLINK_SWIM_COMMAND            0xF4
 194 #define STLINK_GET_CURRENT_MODE        0xF5
 195 #define STLINK_GET_TARGET_VOLTAGE      0xF7
 196
 197 #define STLINK_DEV_DFU_MODE            0x00
 198 #define STLINK_DEV_MASS_MODE           0x01
 199 #define STLINK_DEV_DEBUG_MODE          0x02
 200 #define STLINK_DEV_SWIM_MODE           0x03
 201 #define STLINK_DEV_BOOTLOADER_MODE     0x04
 202 #define STLINK_DEV_UNKNOWN_MODE        -1
 203
 204 #define STLINK_DFU_EXIT                0x07
 205
 206 /*
 207         STLINK_SWIM_ENTER_SEQ
 208         1.3ms low then 750Hz then 1.5kHz
 209
 210         STLINK_SWIM_GEN_RST
 211         STM8 DM pulls reset pin low 50us
 212
 213         STLINK_SWIM_SPEED
 214         uint8_t (0=low|1=high)
 215
 216         STLINK_SWIM_WRITEMEM
 217         uint16_t length
 218         uint32_t address
 219
 220         STLINK_SWIM_RESET
 221         send syncronization seq (16us low, response 64 clocks low)
 222 */
 223 #define STLINK_SWIM_ENTER                  0x00
 224 #define STLINK_SWIM_EXIT                   0x01
 225 #define STLINK_SWIM_READ_CAP               0x02
 226 #define STLINK_SWIM_SPEED                  0x03
 227 #define STLINK_SWIM_ENTER_SEQ              0x04
 228 #define STLINK_SWIM_GEN_RST                0x05
 229 #define STLINK_SWIM_RESET                  0x06
 230 #define STLINK_SWIM_ASSERT_RESET           0x07
 231 #define STLINK_SWIM_DEASSERT_RESET         0x08
 232 #define STLINK_SWIM_READSTATUS             0x09
 233 #define STLINK_SWIM_WRITEMEM               0x0a
 234 #define STLINK_SWIM_READMEM                0x0b
 235 #define STLINK_SWIM_READBUF                0x0c
 236
 237 #define STLINK_DEBUG_GETSTATUS             0x01
 238 #define STLINK_DEBUG_FORCEDEBUG            0x02
 239 #define STLINK_DEBUG_APIV1_RESETSYS        0x03
 240 #define STLINK_DEBUG_APIV1_READALLREGS     0x04
 241 #define STLINK_DEBUG_APIV1_READREG         0x05
 242 #define STLINK_DEBUG_APIV1_WRITEREG        0x06
 243 #define STLINK_DEBUG_READMEM_32BIT         0x07
 244 #define STLINK_DEBUG_WRITEMEM_32BIT        0x08
 245 #define STLINK_DEBUG_RUNCORE               0x09
 246 #define STLINK_DEBUG_STEPCORE              0x0a
 247 #define STLINK_DEBUG_APIV1_SETFP           0x0b
 248 #define STLINK_DEBUG_READMEM_8BIT          0x0c
 249 #define STLINK_DEBUG_WRITEMEM_8BIT         0x0d
 250 #define STLINK_DEBUG_APIV1_CLEARFP         0x0e
 251 #define STLINK_DEBUG_APIV1_WRITEDEBUGREG   0x0f
 252 #define STLINK_DEBUG_APIV1_SETWATCHPOINT   0x10
 253
 254 #define STLINK_DEBUG_ENTER_JTAG_RESET      0x00
 255 #define STLINK_DEBUG_ENTER_SWD_NO_RESET    0xa3
 256 #define STLINK_DEBUG_ENTER_JTAG_NO_RESET   0xa4
 257
 258 #define STLINK_DEBUG_APIV1_ENTER           0x20
 259 #define STLINK_DEBUG_EXIT                  0x21
 260 #define STLINK_DEBUG_READCOREID            0x22
 261
 262 #define STLINK_DEBUG_APIV2_ENTER           0x30
 263 #define STLINK_DEBUG_APIV2_READ_IDCODES    0x31
 264 #define STLINK_DEBUG_APIV2_RESETSYS        0x32
 265 #define STLINK_DEBUG_APIV2_READREG         0x33
 266 #define STLINK_DEBUG_APIV2_WRITEREG        0x34
 267 #define STLINK_DEBUG_APIV2_WRITEDEBUGREG   0x35
 268 #define STLINK_DEBUG_APIV2_READDEBUGREG    0x36
 269
 270 #define STLINK_DEBUG_APIV2_READALLREGS     0x3A
 271 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
 272 #define STLINK_DEBUG_APIV2_DRIVE_NRST      0x3C
 273
 274 #define STLINK_DEBUG_APIV2_GETLASTRWSTATUS2 0x3E
 275
 276 #define STLINK_DEBUG_APIV2_START_TRACE_RX  0x40
 277 #define STLINK_DEBUG_APIV2_STOP_TRACE_RX   0x41
 278 #define STLINK_DEBUG_APIV2_GET_TRACE_NB    0x42
 279 #define STLINK_DEBUG_APIV2_SWD_SET_FREQ    0x43
 280 #define STLINK_DEBUG_APIV2_JTAG_SET_FREQ   0x44
 281 #define STLINK_DEBUG_APIV2_READ_DAP_REG    0x45
 282 #define STLINK_DEBUG_APIV2_WRITE_DAP_REG   0x46
 283 #define STLINK_DEBUG_APIV2_READMEM_16BIT   0x47
 284 #define STLINK_DEBUG_APIV2_WRITEMEM_16BIT  0x48
 285
 286 #define STLINK_DEBUG_APIV2_INIT_AP         0x4B
 287 #define STLINK_DEBUG_APIV2_CLOSE_AP_DBG    0x4C
 288
 289 #define STLINK_APIV3_SET_COM_FREQ           0x61
 290 #define STLINK_APIV3_GET_COM_FREQ           0x62
 291
 292 #define STLINK_APIV3_GET_VERSION_EX         0xFB
 293
 294 #define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW   0x00
 295 #define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH  0x01
 296 #define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
 297
 298 #define STLINK_DEBUG_PORT_ACCESS            0xffff
 299
 300 #define STLINK_TRACE_SIZE               4096
 301 #define STLINK_TRACE_MAX_HZ             2000000
 302
 303 #define STLINK_V3_MAX_FREQ_NB               10
 304
 305 #define REQUEST_SENSE        0x03
 306 #define REQUEST_SENSE_LENGTH 18
 307
 308 /*
 309  * Map the relevant features, quirks and workaround for specific firmware
 310  * version of stlink
 311  */
 312 #define STLINK_F_HAS_TRACE              BIT(0)
 313 #define STLINK_F_HAS_SWD_SET_FREQ       BIT(1)
 314 #define STLINK_F_HAS_JTAG_SET_FREQ      BIT(2)
 315 #define STLINK_F_HAS_MEM_16BIT          BIT(3)
 316 #define STLINK_F_HAS_GETLASTRWSTATUS2   BIT(4)
 317 #define STLINK_F_HAS_DAP_REG            BIT(5)
 318 #define STLINK_F_QUIRK_JTAG_DP_READ     BIT(6)
 319 #define STLINK_F_HAS_AP_INIT            BIT(7)
 320 #define STLINK_F_HAS_DPBANKSEL          BIT(8)
 321 #define STLINK_F_HAS_RW8_512BYTES       BIT(9)
 322
 323 /* aliases */
 324 #define STLINK_F_HAS_TARGET_VOLT        STLINK_F_HAS_TRACE
 325
 326 struct speed_map {
 327         int speed;
 328         int speed_divisor;
 329 };
 330
 331 /* SWD clock speed */
 332 static const struct speed_map stlink_khz_to_speed_map_swd[] = {
 333         {4000, 0},
 334         {1800, 1}, /* default */
 335         {1200, 2},
 336         {950,  3},
 337         {480,  7},
 338         {240, 15},
 339         {125, 31},
 340         {100, 40},
 341         {50,  79},
 342         {25, 158},
 343         {15, 265},
 344         {5,  798}
 345 };
 346
 347 /* JTAG clock speed */
 348 static const struct speed_map stlink_khz_to_speed_map_jtag[] = {
 349         {9000,  4},
 350         {4500,  8},
 351         {2250, 16},
 352         {1125, 32}, /* default */
 353         {562,  64},
 354         {281, 128},
 355         {140, 256}
 356 };
 357
 358 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size);
 359 static int stlink_swim_status(void *handle);
 360 void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size);
 361 static int stlink_get_com_freq(void *handle, bool is_jtag, struct speed_map *map);
 362 static int stlink_speed(void *handle, int khz, bool query);
 363
 364 /** */
 365 static unsigned int stlink_usb_block(void *handle)
 366 {
 367         struct stlink_usb_handle_s *h = handle;
 368
 369         assert(handle != NULL);
 370
 371         if (h->version.flags & STLINK_F_HAS_RW8_512BYTES)
 372                 return STLINKV3_MAX_RW8;
 373         else
 374                 return STLINK_MAX_RW8;
 375 }
 376
 377
 378
 379 #ifdef USE_LIBUSB_ASYNCIO
 380
 381 static LIBUSB_CALL void sync_transfer_cb(struct libusb_transfer *transfer)
 382 {
 383         int *completed = transfer->user_data;
 384         *completed = 1;
 385         /* caller interprets result and frees transfer */
 386 }
 387
 388
 389 static void sync_transfer_wait_for_completion(struct libusb_transfer *transfer)
 390 {
 391         int r, *completed = transfer->user_data;
 392
 393         /* Assuming a single libusb context exists.  There no existing interface into this
 394          * module to pass a libusb context.
 395          */
 396         struct libusb_context *ctx = NULL;
 397
 398         while (!*completed) {
 399                 r = libusb_handle_events_completed(ctx, completed);
 400                 if (r < 0) {
 401                         if (r == LIBUSB_ERROR_INTERRUPTED)
 402                                 continue;
 403                         libusb_cancel_transfer(transfer);
 404                         continue;
 405                 }
 406         }
 407 }
 408
 409
 410 static int transfer_error_status(const struct libusb_transfer *transfer)
 411 {
 412         int r = 0;
 413
 414         switch (transfer->status) {
 415                 case LIBUSB_TRANSFER_COMPLETED:
 416                         r = 0;
 417                         break;
 418                 case LIBUSB_TRANSFER_TIMED_OUT:
 419                         r = LIBUSB_ERROR_TIMEOUT;
 420                         break;
 421                 case LIBUSB_TRANSFER_STALL:
 422                         r = LIBUSB_ERROR_PIPE;
 423                         break;
 424                 case LIBUSB_TRANSFER_OVERFLOW:
 425                         r = LIBUSB_ERROR_OVERFLOW;
 426                         break;
 427                 case LIBUSB_TRANSFER_NO_DEVICE:
 428                         r = LIBUSB_ERROR_NO_DEVICE;
 429                         break;
 430                 case LIBUSB_TRANSFER_ERROR:
 431                 case LIBUSB_TRANSFER_CANCELLED:
 432                         r = LIBUSB_ERROR_IO;
 433                         break;
 434                 default:
 435                         r = LIBUSB_ERROR_OTHER;
 436                         break;
 437         }
 438
 439         return r;
 440 }
 441
 442 struct jtag_xfer {
 443         int ep;
 444         uint8_t *buf;
 445         size_t size;
 446         /* Internal */
 447         int retval;
 448         int completed;
 449         size_t transfer_size;
 450         struct libusb_transfer *transfer;
 451 };
 452
 453 static int jtag_libusb_bulk_transfer_n(
 454                 struct libusb_device_handle *dev_handle,
 455                 struct jtag_xfer *transfers,
 456                 size_t n_transfers,
 457                 int timeout)
 458 {
 459         int retval = 0;
 460         int returnval = ERROR_OK;
 461
 462
 463         for (size_t i = 0; i < n_transfers; ++i) {
 464                 transfers[i].retval = 0;
 465                 transfers[i].completed = 0;
 466                 transfers[i].transfer_size = 0;
 467                 transfers[i].transfer = libusb_alloc_transfer(0);
 468
 469                 if (transfers[i].transfer == NULL) {
 470                         for (size_t j = 0; j < i; ++j)
 471                                 libusb_free_transfer(transfers[j].transfer);
 472
 473                         LOG_DEBUG("ERROR, failed to alloc usb transfers");
 474                         for (size_t k = 0; k < n_transfers; ++k)
 475                                 transfers[k].retval = LIBUSB_ERROR_NO_MEM;
 476                         return ERROR_FAIL;
 477                 }
 478         }
 479
 480         for (size_t i = 0; i < n_transfers; ++i) {
 481                 libusb_fill_bulk_transfer(
 482                                 transfers[i].transfer,
 483                                 dev_handle,
 484                                 transfers[i].ep, transfers[i].buf, transfers[i].size,
 485                                 sync_transfer_cb, &transfers[i].completed, timeout);
 486                 transfers[i].transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
 487
 488                 retval = libusb_submit_transfer(transfers[i].transfer);
 489                 if (retval < 0) {
 490                         LOG_DEBUG("ERROR, failed to submit transfer %zu, error %d", i, retval);
 491
 492                         /* Probably no point continuing to submit transfers once a submission fails.
 493                          * As a result, tag all remaining transfers as errors.
 494                          */
 495                         for (size_t j = i; j < n_transfers; ++j)
 496                                 transfers[j].retval = retval;
 497
 498                         returnval = ERROR_FAIL;
 499                         break;
 500                 }
 501         }
 502
 503         /* Wait for every submitted USB transfer to complete.
 504         */
 505         for (size_t i = 0; i < n_transfers; ++i) {
 506                 if (transfers[i].retval == 0) {
 507                         sync_transfer_wait_for_completion(transfers[i].transfer);
 508
 509                         retval = transfer_error_status(transfers[i].transfer);
 510                         if (retval) {
 511                                 returnval = ERROR_FAIL;
 512                                 transfers[i].retval = retval;
 513                                 LOG_DEBUG("ERROR, transfer %zu failed, error %d", i, retval);
 514                         } else {
 515                                 /* Assuming actual_length is only valid if there is no transfer error.
 516                                  */
 517                                 transfers[i].transfer_size = transfers[i].transfer->actual_length;
 518                         }
 519                 }
 520
 521                 libusb_free_transfer(transfers[i].transfer);
 522                 transfers[i].transfer = NULL;
 523         }
 524
 525         return returnval;
 526 }
 527
 528 #endif
 529
 530
 531 /** */
 532 static int stlink_usb_xfer_v1_get_status(void *handle)
 533 {
 534         struct stlink_usb_handle_s *h = handle;
 535         int tr, ret;
 536
 537         assert(handle != NULL);
 538
 539         /* read status */
 540         memset(h->cmdbuf, 0, STLINK_SG_SIZE);
 541
 542         ret = jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)h->cmdbuf, 13,
 543                                     STLINK_READ_TIMEOUT, &tr);
 544         if (ret || tr != 13)
 545                 return ERROR_FAIL;
 546
 547         uint32_t t1;
 548
 549         t1 = buf_get_u32(h->cmdbuf, 0, 32);
 550
 551         /* check for USBS */
 552         if (t1 != 0x53425355)
 553                 return ERROR_FAIL;
 554         /*
 555          * CSW status:
 556          * 0 success
 557          * 1 command failure
 558          * 2 phase error
 559          */
 560         if (h->cmdbuf[12] != 0)
 561                 return ERROR_FAIL;
 562
 563         return ERROR_OK;
 564 }
 565
 566 #ifdef USE_LIBUSB_ASYNCIO
 567 static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
 568 {
 569         struct stlink_usb_handle_s *h = handle;
 570
 571         assert(handle != NULL);
 572
 573         size_t n_transfers = 0;
 574         struct jtag_xfer transfers[2];
 575
 576         memset(transfers, 0, sizeof(transfers));
 577
 578         transfers[0].ep = h->tx_ep;
 579         transfers[0].buf = h->cmdbuf;
 580         transfers[0].size = cmdsize;
 581
 582         ++n_transfers;
 583
 584         if (h->direction == h->tx_ep && size) {
 585                 transfers[1].ep = h->tx_ep;
 586                 transfers[1].buf = (uint8_t *)buf;
 587                 transfers[1].size = size;
 588
 589                 ++n_transfers;
 590         } else if (h->direction == h->rx_ep && size) {
 591                 transfers[1].ep = h->rx_ep;
 592                 transfers[1].buf = (uint8_t *)buf;
 593                 transfers[1].size = size;
 594
 595                 ++n_transfers;
 596         }
 597
 598         return jtag_libusb_bulk_transfer_n(
 599                         h->fd,
 600                         transfers,
 601                         n_transfers,
 602                         STLINK_WRITE_TIMEOUT);
 603 }
 604 #else
 605 static int stlink_usb_xfer_rw(void *handle, int cmdsize, const uint8_t *buf, int size)
 606 {
 607         struct stlink_usb_handle_s *h = handle;
 608         int tr, ret;
 609
 610         assert(handle != NULL);
 611
 612         ret = jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)h->cmdbuf,
 613                                      cmdsize, STLINK_WRITE_TIMEOUT, &tr);
 614         if (ret || tr != cmdsize)
 615                 return ERROR_FAIL;
 616
 617         if (h->direction == h->tx_ep && size) {
 618                 ret = jtag_libusb_bulk_write(h->fd, h->tx_ep, (char *)buf,
 619                                              size, STLINK_WRITE_TIMEOUT, &tr);
 620                 if (ret || tr != size) {
 621                         LOG_DEBUG("bulk write failed");
 622                         return ERROR_FAIL;
 623                 }
 624         } else if (h->direction == h->rx_ep && size) {
 625                 ret = jtag_libusb_bulk_read(h->fd, h->rx_ep, (char *)buf,
 626                                             size, STLINK_READ_TIMEOUT, &tr);
 627                 if (ret || tr != size) {
 628                         LOG_DEBUG("bulk read failed");
 629                         return ERROR_FAIL;
 630                 }
 631         }
 632
 633         return ERROR_OK;
 634 }
 635 #endif
 636
 637 /** */
 638 static int stlink_usb_xfer_v1_get_sense(void *handle)
 639 {
 640         int res;
 641         struct stlink_usb_handle_s *h = handle;
 642
 643         assert(handle != NULL);
 644
 645         stlink_usb_init_buffer(handle, h->rx_ep, 16);
 646
 647         h->cmdbuf[h->cmdidx++] = REQUEST_SENSE;
 648         h->cmdbuf[h->cmdidx++] = 0;
 649         h->cmdbuf[h->cmdidx++] = 0;
 650         h->cmdbuf[h->cmdidx++] = 0;
 651         h->cmdbuf[h->cmdidx++] = REQUEST_SENSE_LENGTH;
 652
 653         res = stlink_usb_xfer_rw(handle, REQUEST_SENSE_LENGTH, h->databuf, 16);
 654
 655         if (res != ERROR_OK)
 656                 return res;
 657
 658         if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK)
 659                 return ERROR_FAIL;
 660
 661         return ERROR_OK;
 662 }
 663
 664 /*
 665         transfers block in cmdbuf
 666         <size> indicates number of bytes in the following
 667         data phase.
 668         Ignore the (eventual) error code in the received packet.
 669 */
 670 static int stlink_usb_xfer_noerrcheck(void *handle, const uint8_t *buf, int size)
 671 {
 672         int err, cmdsize = STLINK_CMD_SIZE_V2;
 673         struct stlink_usb_handle_s *h = handle;
 674
 675         assert(handle != NULL);
 676
 677         if (h->version.stlink == 1) {
 678                 cmdsize = STLINK_SG_SIZE;
 679                 /* put length in bCBWCBLength */
 680                 h->cmdbuf[14] = h->cmdidx-15;
 681         }
 682
 683         err = stlink_usb_xfer_rw(handle, cmdsize, buf, size);
 684
 685         if (err != ERROR_OK)
 686                 return err;
 687
 688         if (h->version.stlink == 1) {
 689                 if (stlink_usb_xfer_v1_get_status(handle) != ERROR_OK) {
 690                         /* check csw status */
 691                         if (h->cmdbuf[12] == 1) {
 692                                 LOG_DEBUG("get sense");
 693                                 if (stlink_usb_xfer_v1_get_sense(handle) != ERROR_OK)
 694                                         return ERROR_FAIL;
 695                         }
 696                         return ERROR_FAIL;
 697                 }
 698         }
 699
 700         return ERROR_OK;
 701 }
 702
 703 /**
 704     Converts an STLINK status code held in the first byte of a response
 705     to an openocd error, logs any error/wait status as debug output.
 706 */
 707 static int stlink_usb_error_check(void *handle)
 708 {
 709         struct stlink_usb_handle_s *h = handle;
 710
 711         assert(handle != NULL);
 712
 713         if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
 714                 switch (h->databuf[0]) {
 715                         case STLINK_SWIM_ERR_OK:
 716                                 return ERROR_OK;
 717                         case STLINK_SWIM_BUSY:
 718                                 return ERROR_WAIT;
 719                         default:
 720                                 LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h->databuf[0]);
 721                                 return ERROR_FAIL;
 722                 }
 723         }
 724
 725         /* TODO: no error checking yet on api V1 */
 726         if (h->version.jtag_api == STLINK_JTAG_API_V1)
 727                 h->databuf[0] = STLINK_DEBUG_ERR_OK;
 728
 729         switch (h->databuf[0]) {
 730                 case STLINK_DEBUG_ERR_OK:
 731                         return ERROR_OK;
 732                 case STLINK_DEBUG_ERR_FAULT:
 733                         LOG_DEBUG("SWD fault response (0x%x)", STLINK_DEBUG_ERR_FAULT);
 734                         return ERROR_FAIL;
 735                 case STLINK_SWD_AP_WAIT:
 736                         LOG_DEBUG("wait status SWD_AP_WAIT (0x%x)", STLINK_SWD_AP_WAIT);
 737                         return ERROR_WAIT;
 738                 case STLINK_SWD_DP_WAIT:
 739                         LOG_DEBUG("wait status SWD_DP_WAIT (0x%x)", STLINK_SWD_DP_WAIT);
 740                         return ERROR_WAIT;
 741                 case STLINK_JTAG_GET_IDCODE_ERROR:
 742                         LOG_DEBUG("STLINK_JTAG_GET_IDCODE_ERROR");
 743                         return ERROR_FAIL;
 744                 case STLINK_JTAG_WRITE_ERROR:
 745                         LOG_DEBUG("Write error");
 746                         return ERROR_FAIL;
 747                 case STLINK_JTAG_WRITE_VERIF_ERROR:
 748                         LOG_DEBUG("Write verify error, ignoring");
 749                         return ERROR_OK;
 750                 case STLINK_SWD_AP_FAULT:
 751                         /* git://git.ac6.fr/openocd commit 657e3e885b9ee10
 752                          * returns ERROR_OK with the comment:
 753                          * Change in error status when reading outside RAM.
 754                          * This fix allows CDT plugin to visualize memory.
 755                          */
 756                         LOG_DEBUG("STLINK_SWD_AP_FAULT");
 757                         return ERROR_FAIL;
 758                 case STLINK_SWD_AP_ERROR:
 759                         LOG_DEBUG("STLINK_SWD_AP_ERROR");
 760                         return ERROR_FAIL;
 761                 case STLINK_SWD_AP_PARITY_ERROR:
 762                         LOG_DEBUG("STLINK_SWD_AP_PARITY_ERROR");
 763                         return ERROR_FAIL;
 764                 case STLINK_SWD_DP_FAULT:
 765                         LOG_DEBUG("STLINK_SWD_DP_FAULT");
 766                         return ERROR_FAIL;
 767                 case STLINK_SWD_DP_ERROR:
 768                         LOG_DEBUG("STLINK_SWD_DP_ERROR");
 769                         return ERROR_FAIL;
 770                 case STLINK_SWD_DP_PARITY_ERROR:
 771                         LOG_DEBUG("STLINK_SWD_DP_PARITY_ERROR");
 772                         return ERROR_FAIL;
 773                 case STLINK_SWD_AP_WDATA_ERROR:
 774                         LOG_DEBUG("STLINK_SWD_AP_WDATA_ERROR");
 775                         return ERROR_FAIL;
 776                 case STLINK_SWD_AP_STICKY_ERROR:
 777                         LOG_DEBUG("STLINK_SWD_AP_STICKY_ERROR");
 778                         return ERROR_FAIL;
 779                 case STLINK_SWD_AP_STICKYORUN_ERROR:
 780                         LOG_DEBUG("STLINK_SWD_AP_STICKYORUN_ERROR");
 781                         return ERROR_FAIL;
 782                 case STLINK_BAD_AP_ERROR:
 783                         LOG_DEBUG("STLINK_BAD_AP_ERROR");
 784                         return ERROR_FAIL;
 785                 default:
 786                         LOG_DEBUG("unknown/unexpected STLINK status code 0x%x", h->databuf[0]);
 787                         return ERROR_FAIL;
 788         }
 789 }
 790
 791 /*
 792  * Wrapper around stlink_usb_xfer_noerrcheck()
 793  * to check the error code in the received packet
 794  */
 795 static int stlink_usb_xfer_errcheck(void *handle, const uint8_t *buf, int size)
 796 {
 797         int retval;
 798
 799         assert(size > 0);
 800
 801         retval = stlink_usb_xfer_noerrcheck(handle, buf, size);
 802         if (retval != ERROR_OK)
 803                 return retval;
 804
 805         return stlink_usb_error_check(handle);
 806 }
 807
 808 /** Issue an STLINK command via USB transfer, with retries on any wait status responses.
 809
 810     Works for commands where the STLINK_DEBUG status is returned in the first
 811     byte of the response packet. For SWIM a SWIM_READSTATUS is requested instead.
 812
 813     Returns an openocd result code.
 814 */
 815 static int stlink_cmd_allow_retry(void *handle, const uint8_t *buf, int size)
 816 {
 817         int retries = 0;
 818         int res;
 819         struct stlink_usb_handle_s *h = handle;
 820
 821         while (1) {
 822                 if ((h->st_mode != STLINK_MODE_DEBUG_SWIM) || !retries) {
 823                         res = stlink_usb_xfer_noerrcheck(handle, buf, size);
 824                         if (res != ERROR_OK)
 825                                 return res;
 826                 }
 827
 828                 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
 829                         res = stlink_swim_status(handle);
 830                         if (res != ERROR_OK)
 831                                 return res;
 832                 }
 833
 834                 res = stlink_usb_error_check(handle);
 835                 if (res == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
 836                         unsigned int delay_us = (1<<retries++) * 1000;
 837                         LOG_DEBUG("stlink_cmd_allow_retry ERROR_WAIT, retry %d, delaying %u microseconds", retries, delay_us);
 838                         usleep(delay_us);
 839                         continue;
 840                 }
 841                 return res;
 842         }
 843 }
 844
 845 /** */
 846 static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
 847 {
 848         struct stlink_usb_handle_s *h = handle;
 849         int tr, ret;
 850
 851         assert(handle != NULL);
 852
 853         assert(h->version.flags & STLINK_F_HAS_TRACE);
 854
 855         ret = jtag_libusb_bulk_read(h->fd, h->trace_ep, (char *)buf, size,
 856                                     STLINK_READ_TIMEOUT, &tr);
 857         if (ret || tr != size) {
 858                 LOG_ERROR("bulk trace read failed");
 859                 return ERROR_FAIL;
 860         }
 861
 862         return ERROR_OK;
 863 }
 864
 865 /*
 866         this function writes transfer length in
 867         the right place in the cb
 868 */
 869 static void stlink_usb_set_cbw_transfer_datalength(void *handle, uint32_t size)
 870 {
 871         struct stlink_usb_handle_s *h = handle;
 872
 873         buf_set_u32(h->cmdbuf+8, 0, 32, size);
 874 }
 875
 876 static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint32_t size)
 877 {
 878         struct stlink_usb_handle_s *h = handle;
 879
 880         /* fill the send buffer */
 881         strcpy((char *)h->cmdbuf, "USBC");
 882         h->cmdidx += 4;
 883         /* csw tag not used */
 884         buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, 0);
 885         h->cmdidx += 4;
 886         /* cbw data transfer length (in the following data phase in or out) */
 887         buf_set_u32(h->cmdbuf+h->cmdidx, 0, 32, size);
 888         h->cmdidx += 4;
 889         /* cbw flags */
 890         h->cmdbuf[h->cmdidx++] = (direction == h->rx_ep ? ENDPOINT_IN : ENDPOINT_OUT);
 891         h->cmdbuf[h->cmdidx++] = 0; /* lun */
 892         /* cdb clength (is filled in at xfer) */
 893         h->cmdbuf[h->cmdidx++] = 0;
 894 }
 895
 896 /** */
 897 static void stlink_usb_init_buffer(void *handle, uint8_t direction, uint32_t size)
 898 {
 899         struct stlink_usb_handle_s *h = handle;
 900
 901         h->direction = direction;
 902
 903         h->cmdidx = 0;
 904
 905         memset(h->cmdbuf, 0, STLINK_SG_SIZE);
 906         memset(h->databuf, 0, STLINK_DATA_SIZE);
 907
 908         if (h->version.stlink == 1)
 909                 stlink_usb_xfer_v1_create_cmd(handle, direction, size);
 910 }
 911
 912 /** */
 913 static int stlink_usb_version(void *handle)
 914 {
 915         int res;
 916         uint32_t flags;
 917         uint16_t version;
 918         uint8_t v, x, y, jtag, swim, msd, bridge = 0;
 919         char v_str[5 * (1 + 3) + 1]; /* VvJjMmBbSs */
 920         char *p;
 921         struct stlink_usb_handle_s *h = handle;
 922
 923         assert(handle != NULL);
 924
 925         stlink_usb_init_buffer(handle, h->rx_ep, 6);
 926
 927         h->cmdbuf[h->cmdidx++] = STLINK_GET_VERSION;
 928
 929         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 6);
 930
 931         if (res != ERROR_OK)
 932                 return res;
 933
 934         version = be_to_h_u16(h->databuf);
 935         v = (version >> 12) & 0x0f;
 936         x = (version >> 6) & 0x3f;
 937         y = version & 0x3f;
 938
 939         h->vid = le_to_h_u16(h->databuf + 2);
 940         h->pid = le_to_h_u16(h->databuf + 4);
 941
 942         switch (h->pid) {
 943         case STLINK_V2_1_PID:
 944         case STLINK_V2_1_NO_MSD_PID:
 945                 if ((x <= 22 && y == 7) || (x >= 25 && y >= 7 && y <= 12)) {
 946                         /* MxSy : STM8 V2.1 - SWIM only */
 947                         msd = x;
 948                         swim = y;
 949                         jtag = 0;
 950                 } else {
 951                         /* JxMy : STM32 V2.1 - JTAG/SWD only */
 952                         jtag = x;
 953                         msd = y;
 954                         swim = 0;
 955                 }
 956                 break;
 957         default:
 958                 jtag = x;
 959                 swim = y;
 960                 msd = 0;
 961                 break;
 962         }
 963
 964         /* STLINK-V3 requires a specific command */
 965         if (v == 3 && x == 0 && y == 0) {
 966                 stlink_usb_init_buffer(handle, h->rx_ep, 16);
 967
 968                 h->cmdbuf[h->cmdidx++] = STLINK_APIV3_GET_VERSION_EX;
 969
 970                 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 12);
 971                 if (res != ERROR_OK)
 972                         return res;
 973
 974                 v = h->databuf[0];
 975                 swim = h->databuf[1];
 976                 jtag = h->databuf[2];
 977                 msd  = h->databuf[3];
 978                 bridge = h->databuf[4];
 979                 h->vid = le_to_h_u16(h->databuf + 8);
 980                 h->pid = le_to_h_u16(h->databuf + 10);
 981         }
 982
 983         h->version.stlink = v;
 984         h->version.jtag = jtag;
 985         h->version.swim = swim;
 986
 987         flags = 0;
 988         switch (h->version.stlink) {
 989         case 1:
 990                 /* ST-LINK/V1 from J11 switch to api-v2 (and support SWD) */
 991                 if (h->version.jtag >= 11)
 992                         h->version.jtag_api = STLINK_JTAG_API_V2;
 993                 else
 994                         h->version.jtag_api = STLINK_JTAG_API_V1;
 995
 996                 break;
 997         case 2:
 998                 /* all ST-LINK/V2 and ST-Link/V2.1 use api-v2 */
 999                 h->version.jtag_api = STLINK_JTAG_API_V2;
1000
1001                 /* API for trace from J13 */
1002                 /* API for target voltage from J13 */
1003                 if (h->version.jtag >= 13)
1004                         flags |= STLINK_F_HAS_TRACE;
1005
1006                 /* preferred API to get last R/W status from J15 */
1007                 if (h->version.jtag >= 15)
1008                         flags |= STLINK_F_HAS_GETLASTRWSTATUS2;
1009
1010                 /* API to set SWD frequency from J22 */
1011                 if (h->version.jtag >= 22)
1012                         flags |= STLINK_F_HAS_SWD_SET_FREQ;
1013
1014                 /* API to set JTAG frequency from J24 */
1015                 /* API to access DAP registers from J24 */
1016                 if (h->version.jtag >= 24) {
1017                         flags |= STLINK_F_HAS_JTAG_SET_FREQ;
1018                         flags |= STLINK_F_HAS_DAP_REG;
1019                 }
1020
1021                 /* Quirk for read DP in JTAG mode (V2 only) from J24, fixed in J32 */
1022                 if (h->version.jtag >= 24 && h->version.jtag < 32)
1023                         flags |= STLINK_F_QUIRK_JTAG_DP_READ;
1024
1025                 /* API to read/write memory at 16 bit from J26 */
1026                 if (h->version.jtag >= 26)
1027                         flags |= STLINK_F_HAS_MEM_16BIT;
1028
1029                 /* API required to init AP before any AP access from J28 */
1030                 if (h->version.jtag >= 28)
1031                         flags |= STLINK_F_HAS_AP_INIT;
1032
1033                 /* Banked regs (DPv1 & DPv2) support from V2J32 */
1034                 if (h->version.jtag >= 32)
1035                         flags |= STLINK_F_HAS_DPBANKSEL;
1036
1037                 break;
1038         case 3:
1039                 /* all STLINK-V3 use api-v3 */
1040                 h->version.jtag_api = STLINK_JTAG_API_V3;
1041
1042                 /* STLINK-V3 is a superset of ST-LINK/V2 */
1043
1044                 /* API for trace */
1045                 /* API for target voltage */
1046                 flags |= STLINK_F_HAS_TRACE;
1047
1048                 /* preferred API to get last R/W status */
1049                 flags |= STLINK_F_HAS_GETLASTRWSTATUS2;
1050
1051                 /* API to access DAP registers */
1052                 flags |= STLINK_F_HAS_DAP_REG;
1053
1054                 /* API to read/write memory at 16 bit */
1055                 flags |= STLINK_F_HAS_MEM_16BIT;
1056
1057                 /* API required to init AP before any AP access */
1058                 flags |= STLINK_F_HAS_AP_INIT;
1059
1060                 /* Banked regs (DPv1 & DPv2) support from V3J2 */
1061                 if (h->version.jtag >= 2)
1062                         flags |= STLINK_F_HAS_DPBANKSEL;
1063
1064                 /* 8bit read/write max packet size 512 bytes from V3J6 */
1065                 if (h->version.jtag >= 6)
1066                         flags |= STLINK_F_HAS_RW8_512BYTES;
1067
1068                 break;
1069         default:
1070                 break;
1071         }
1072         h->version.flags = flags;
1073
1074         p = v_str;
1075         p += sprintf(p, "V%d", v);
1076         if (jtag || !msd)
1077                 p += sprintf(p, "J%d", jtag);
1078         if (msd)
1079                 p += sprintf(p, "M%d", msd);
1080         if (bridge)
1081                 p += sprintf(p, "B%d", bridge);
1082         if (swim || !msd)
1083                 sprintf(p, "S%d", swim);
1084
1085         LOG_INFO("STLINK %s (API v%d) VID:PID %04X:%04X",
1086                 v_str,
1087                 h->version.jtag_api,
1088                 h->vid,
1089                 h->pid);
1090
1091         return ERROR_OK;
1092 }
1093
1094 static int stlink_usb_check_voltage(void *handle, float *target_voltage)
1095 {
1096         struct stlink_usb_handle_s *h = handle;
1097         uint32_t adc_results[2];
1098
1099         /* no error message, simply quit with error */
1100         if (!(h->version.flags & STLINK_F_HAS_TARGET_VOLT))
1101                 return ERROR_COMMAND_NOTFOUND;
1102
1103         stlink_usb_init_buffer(handle, h->rx_ep, 8);
1104
1105         h->cmdbuf[h->cmdidx++] = STLINK_GET_TARGET_VOLTAGE;
1106
1107         int result = stlink_usb_xfer_noerrcheck(handle, h->databuf, 8);
1108
1109         if (result != ERROR_OK)
1110                 return result;
1111
1112         /* convert result */
1113         adc_results[0] = le_to_h_u32(h->databuf);
1114         adc_results[1] = le_to_h_u32(h->databuf + 4);
1115
1116         *target_voltage = 0;
1117
1118         if (adc_results[0])
1119                 *target_voltage = 2 * ((float)adc_results[1]) * (float)(1.2 / adc_results[0]);
1120
1121         LOG_INFO("Target voltage: %f", (double)*target_voltage);
1122
1123         return ERROR_OK;
1124 }
1125
1126 static int stlink_usb_set_swdclk(void *handle, uint16_t clk_divisor)
1127 {
1128         struct stlink_usb_handle_s *h = handle;
1129
1130         assert(handle != NULL);
1131
1132         if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
1133                 return ERROR_COMMAND_NOTFOUND;
1134
1135         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1136
1137         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1138         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_SWD_SET_FREQ;
1139         h_u16_to_le(h->cmdbuf+h->cmdidx, clk_divisor);
1140         h->cmdidx += 2;
1141
1142         int result = stlink_cmd_allow_retry(handle, h->databuf, 2);
1143
1144         if (result != ERROR_OK)
1145                 return result;
1146
1147         return ERROR_OK;
1148 }
1149
1150 static int stlink_usb_set_jtagclk(void *handle, uint16_t clk_divisor)
1151 {
1152         struct stlink_usb_handle_s *h = handle;
1153
1154         assert(handle != NULL);
1155
1156         if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
1157                 return ERROR_COMMAND_NOTFOUND;
1158
1159         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1160
1161         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1162         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_JTAG_SET_FREQ;
1163         h_u16_to_le(h->cmdbuf+h->cmdidx, clk_divisor);
1164         h->cmdidx += 2;
1165
1166         int result = stlink_cmd_allow_retry(handle, h->databuf, 2);
1167
1168         if (result != ERROR_OK)
1169                 return result;
1170
1171         return ERROR_OK;
1172 }
1173
1174 /** */
1175 static int stlink_usb_current_mode(void *handle, uint8_t *mode)
1176 {
1177         int res;
1178         struct stlink_usb_handle_s *h = handle;
1179
1180         assert(handle != NULL);
1181
1182         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1183
1184         h->cmdbuf[h->cmdidx++] = STLINK_GET_CURRENT_MODE;
1185
1186         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
1187
1188         if (res != ERROR_OK)
1189                 return res;
1190
1191         *mode = h->databuf[0];
1192
1193         return ERROR_OK;
1194 }
1195
1196 /** */
1197 static int stlink_usb_mode_enter(void *handle, enum stlink_mode type)
1198 {
1199         int rx_size = 0;
1200         struct stlink_usb_handle_s *h = handle;
1201
1202         assert(handle != NULL);
1203
1204         /* on api V2 we are able the read the latest command
1205          * status
1206          * TODO: we need the test on api V1 too
1207          */
1208         if (h->version.jtag_api != STLINK_JTAG_API_V1)
1209                 rx_size = 2;
1210
1211         stlink_usb_init_buffer(handle, h->rx_ep, rx_size);
1212
1213         switch (type) {
1214                 case STLINK_MODE_DEBUG_JTAG:
1215                         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1216                         if (h->version.jtag_api == STLINK_JTAG_API_V1)
1217                                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
1218                         else
1219                                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
1220                         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_JTAG_NO_RESET;
1221                         break;
1222                 case STLINK_MODE_DEBUG_SWD:
1223                         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1224                         if (h->version.jtag_api == STLINK_JTAG_API_V1)
1225                                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_ENTER;
1226                         else
1227                                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_ENTER;
1228                         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_ENTER_SWD_NO_RESET;
1229                         break;
1230                 case STLINK_MODE_DEBUG_SWIM:
1231                         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1232                         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ENTER;
1233                         /* swim enter does not return any response or status */
1234                         return stlink_usb_xfer_noerrcheck(handle, h->databuf, 0);
1235                 case STLINK_MODE_DFU:
1236                 case STLINK_MODE_MASS:
1237                 default:
1238                         return ERROR_FAIL;
1239         }
1240
1241         return stlink_cmd_allow_retry(handle, h->databuf, rx_size);
1242 }
1243
1244 /** */
1245 static int stlink_usb_mode_leave(void *handle, enum stlink_mode type)
1246 {
1247         int res;
1248         struct stlink_usb_handle_s *h = handle;
1249
1250         assert(handle != NULL);
1251
1252         /* command with no reply, use a valid endpoint but zero size */
1253         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1254
1255         switch (type) {
1256                 case STLINK_MODE_DEBUG_JTAG:
1257                 case STLINK_MODE_DEBUG_SWD:
1258                         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1259                         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_EXIT;
1260                         break;
1261                 case STLINK_MODE_DEBUG_SWIM:
1262                         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1263                         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_EXIT;
1264                         break;
1265                 case STLINK_MODE_DFU:
1266                         h->cmdbuf[h->cmdidx++] = STLINK_DFU_COMMAND;
1267                         h->cmdbuf[h->cmdidx++] = STLINK_DFU_EXIT;
1268                         break;
1269                 case STLINK_MODE_MASS:
1270                 default:
1271                         return ERROR_FAIL;
1272         }
1273
1274         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 0);
1275
1276         if (res != ERROR_OK)
1277                 return res;
1278
1279         return ERROR_OK;
1280 }
1281
1282 static int stlink_usb_assert_srst(void *handle, int srst);
1283
1284 static enum stlink_mode stlink_get_mode(enum hl_transports t)
1285 {
1286         switch (t) {
1287         case HL_TRANSPORT_SWD:
1288                 return STLINK_MODE_DEBUG_SWD;
1289         case HL_TRANSPORT_JTAG:
1290                 return STLINK_MODE_DEBUG_JTAG;
1291         default:
1292                 return STLINK_MODE_UNKNOWN;
1293         }
1294 }
1295
1296 /** */
1297 static int stlink_usb_init_mode(void *handle, bool connect_under_reset, int initial_interface_speed)
1298 {
1299         int res;
1300         uint8_t mode;
1301         enum stlink_mode emode;
1302         struct stlink_usb_handle_s *h = handle;
1303
1304         assert(handle != NULL);
1305
1306         res = stlink_usb_current_mode(handle, &mode);
1307
1308         if (res != ERROR_OK)
1309                 return res;
1310
1311         LOG_DEBUG("MODE: 0x%02X", mode);
1312
1313         /* try to exit current mode */
1314         switch (mode) {
1315                 case STLINK_DEV_DFU_MODE:
1316                         emode = STLINK_MODE_DFU;
1317                         break;
1318                 case STLINK_DEV_DEBUG_MODE:
1319                         emode = STLINK_MODE_DEBUG_SWD;
1320                         break;
1321                 case STLINK_DEV_SWIM_MODE:
1322                         emode = STLINK_MODE_DEBUG_SWIM;
1323                         break;
1324                 case STLINK_DEV_BOOTLOADER_MODE:
1325                 case STLINK_DEV_MASS_MODE:
1326                 default:
1327                         emode = STLINK_MODE_UNKNOWN;
1328                         break;
1329         }
1330
1331         if (emode != STLINK_MODE_UNKNOWN) {
1332                 res = stlink_usb_mode_leave(handle, emode);
1333
1334                 if (res != ERROR_OK)
1335                         return res;
1336         }
1337
1338         res = stlink_usb_current_mode(handle, &mode);
1339
1340         if (res != ERROR_OK)
1341                 return res;
1342
1343         /* we check the target voltage here as an aid to debugging connection problems.
1344          * the stlink requires the target Vdd to be connected for reliable debugging.
1345          * this cmd is supported in all modes except DFU
1346          */
1347         if (mode != STLINK_DEV_DFU_MODE) {
1348
1349                 float target_voltage;
1350
1351                 /* check target voltage (if supported) */
1352                 res = stlink_usb_check_voltage(h, &target_voltage);
1353
1354                 if (res != ERROR_OK) {
1355                         if (res != ERROR_COMMAND_NOTFOUND)
1356                                 LOG_ERROR("voltage check failed");
1357                         /* attempt to continue as it is not a catastrophic failure */
1358                 } else {
1359                         /* check for a sensible target voltage, operating range is 1.65-5.5v
1360                          * according to datasheet */
1361                         if (target_voltage < 1.5)
1362                                 LOG_ERROR("target voltage may be too low for reliable debugging");
1363                 }
1364         }
1365
1366         LOG_DEBUG("MODE: 0x%02X", mode);
1367
1368         /* set selected mode */
1369         emode = h->st_mode;
1370
1371         if (emode == STLINK_MODE_UNKNOWN) {
1372                 LOG_ERROR("selected mode (transport) not supported");
1373                 return ERROR_FAIL;
1374         }
1375
1376         /* set the speed before entering the mode, as the chip discovery phase should be done at this speed too */
1377         if (emode == STLINK_MODE_DEBUG_JTAG) {
1378                 if (h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ) {
1379                         stlink_dump_speed_map(stlink_khz_to_speed_map_jtag, ARRAY_SIZE(stlink_khz_to_speed_map_jtag));
1380                         stlink_speed(h, initial_interface_speed, false);
1381                 }
1382         } else if (emode == STLINK_MODE_DEBUG_SWD) {
1383                 if (h->version.flags & STLINK_F_HAS_SWD_SET_FREQ) {
1384                         stlink_dump_speed_map(stlink_khz_to_speed_map_swd, ARRAY_SIZE(stlink_khz_to_speed_map_swd));
1385                         stlink_speed(h, initial_interface_speed, false);
1386                 }
1387         }
1388
1389         if (h->version.jtag_api == STLINK_JTAG_API_V3) {
1390                 struct speed_map map[STLINK_V3_MAX_FREQ_NB];
1391
1392                 stlink_get_com_freq(h, (emode == STLINK_MODE_DEBUG_JTAG), map);
1393                 stlink_dump_speed_map(map, ARRAY_SIZE(map));
1394                 stlink_speed(h, initial_interface_speed, false);
1395         }
1396
1397         /* preliminary SRST assert:
1398          * We want SRST is asserted before activating debug signals (mode_enter).
1399          * As the required mode has not been set, the adapter may not know what pin to use.
1400          * Tested firmware STLINK v2 JTAG v29 API v2 SWIM v0 uses T_NRST pin by default
1401          * Tested firmware STLINK v2 JTAG v27 API v2 SWIM v6 uses T_NRST pin by default
1402          * after power on, SWIM_RST stays unchanged */
1403         if (connect_under_reset && emode != STLINK_MODE_DEBUG_SWIM)
1404                 stlink_usb_assert_srst(handle, 0);
1405                 /* do not check the return status here, we will
1406                    proceed and enter the desired mode below
1407                    and try asserting srst again. */
1408
1409         res = stlink_usb_mode_enter(handle, emode);
1410         if (res != ERROR_OK)
1411                 return res;
1412
1413         /* assert SRST again: a little bit late but now the adapter knows for sure what pin to use */
1414         if (connect_under_reset) {
1415                 res = stlink_usb_assert_srst(handle, 0);
1416                 if (res != ERROR_OK)
1417                         return res;
1418         }
1419
1420         res = stlink_usb_current_mode(handle, &mode);
1421
1422         if (res != ERROR_OK)
1423                 return res;
1424
1425         LOG_DEBUG("MODE: 0x%02X", mode);
1426
1427         return ERROR_OK;
1428 }
1429
1430 /* request status from last swim request */
1431 static int stlink_swim_status(void *handle)
1432 {
1433         struct stlink_usb_handle_s *h = handle;
1434         int res;
1435
1436         stlink_usb_init_buffer(handle, h->rx_ep, 4);
1437         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1438         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READSTATUS;
1439         /* error is checked by the caller */
1440         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
1441         if (res != ERROR_OK)
1442                 return res;
1443         return ERROR_OK;
1444 }
1445 /*
1446         the purpose of this function is unknown...
1447         capabilites? anyway for swim v6 it returns
1448         0001020600000000
1449 */
1450 __attribute__((unused))
1451 static int stlink_swim_cap(void *handle, uint8_t *cap)
1452 {
1453         struct stlink_usb_handle_s *h = handle;
1454         int res;
1455
1456         stlink_usb_init_buffer(handle, h->rx_ep, 8);
1457         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1458         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READ_CAP;
1459         h->cmdbuf[h->cmdidx++] = 0x01;
1460         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 8);
1461         if (res != ERROR_OK)
1462                 return res;
1463         memcpy(cap, h->databuf, 8);
1464         return ERROR_OK;
1465 }
1466
1467 /*      debug dongle assert/deassert sreset line */
1468 static int stlink_swim_assert_reset(void *handle, int reset)
1469 {
1470         struct stlink_usb_handle_s *h = handle;
1471         int res;
1472
1473         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1474         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1475         if (!reset)
1476                 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ASSERT_RESET;
1477         else
1478                 h->cmdbuf[h->cmdidx++] = STLINK_SWIM_DEASSERT_RESET;
1479         res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1480         if (res != ERROR_OK)
1481                 return res;
1482         return ERROR_OK;
1483 }
1484
1485 /*
1486         send swim enter seq
1487         1.3ms low then 750Hz then 1.5kHz
1488 */
1489 static int stlink_swim_enter(void *handle)
1490 {
1491         struct stlink_usb_handle_s *h = handle;
1492         int res;
1493
1494         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1495         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1496         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_ENTER_SEQ;
1497         res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1498         if (res != ERROR_OK)
1499                 return res;
1500         return ERROR_OK;
1501 }
1502
1503 /*      switch high/low speed swim */
1504 static int stlink_swim_speed(void *handle, int speed)
1505 {
1506         struct stlink_usb_handle_s *h = handle;
1507         int res;
1508
1509         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1510         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1511         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_SPEED;
1512         if (speed)
1513                 h->cmdbuf[h->cmdidx++] = 1;
1514         else
1515                 h->cmdbuf[h->cmdidx++] = 0;
1516         res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1517         if (res != ERROR_OK)
1518                 return res;
1519         return ERROR_OK;
1520 }
1521
1522 /*
1523         initiate srst from swim.
1524         nrst is pulled low for 50us.
1525 */
1526 static int stlink_swim_generate_rst(void *handle)
1527 {
1528         struct stlink_usb_handle_s *h = handle;
1529         int res;
1530
1531         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1532         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1533         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_GEN_RST;
1534         res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1535         if (res != ERROR_OK)
1536                 return res;
1537         return ERROR_OK;
1538 }
1539
1540 /*
1541         send resyncronize sequence
1542         swim is pulled low for 16us
1543         reply is 64 clks low
1544 */
1545 static int stlink_swim_resync(void *handle)
1546 {
1547         struct stlink_usb_handle_s *h = handle;
1548         int res;
1549
1550         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1551         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1552         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_RESET;
1553         res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1554         if (res != ERROR_OK)
1555                 return res;
1556         return ERROR_OK;
1557 }
1558
1559 static int stlink_swim_writebytes(void *handle, uint32_t addr, uint32_t len, const uint8_t *data)
1560 {
1561         struct stlink_usb_handle_s *h = handle;
1562         int res;
1563         unsigned int i;
1564         unsigned int datalen = 0;
1565         int cmdsize = STLINK_CMD_SIZE_V2;
1566
1567         if (len > STLINK_DATA_SIZE)
1568                 return ERROR_FAIL;
1569
1570         if (h->version.stlink == 1)
1571                 cmdsize = STLINK_SG_SIZE;
1572
1573         stlink_usb_init_buffer(handle, h->tx_ep, 0);
1574         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1575         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_WRITEMEM;
1576         h_u16_to_be(h->cmdbuf+h->cmdidx, len);
1577         h->cmdidx += 2;
1578         h_u32_to_be(h->cmdbuf+h->cmdidx, addr);
1579         h->cmdidx += 4;
1580         for (i = 0; i < len; i++) {
1581                 if (h->cmdidx == cmdsize)
1582                         h->databuf[datalen++] = *(data++);
1583                 else
1584                         h->cmdbuf[h->cmdidx++] = *(data++);
1585         }
1586         if (h->version.stlink == 1)
1587                 stlink_usb_set_cbw_transfer_datalength(handle, datalen);
1588
1589         res = stlink_cmd_allow_retry(handle, h->databuf, datalen);
1590         if (res != ERROR_OK)
1591                 return res;
1592         return ERROR_OK;
1593 }
1594
1595 static int stlink_swim_readbytes(void *handle, uint32_t addr, uint32_t len, uint8_t *data)
1596 {
1597         struct stlink_usb_handle_s *h = handle;
1598         int res;
1599
1600         if (len > STLINK_DATA_SIZE)
1601                 return ERROR_FAIL;
1602
1603         stlink_usb_init_buffer(handle, h->rx_ep, 0);
1604         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1605         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READMEM;
1606         h_u16_to_be(h->cmdbuf+h->cmdidx, len);
1607         h->cmdidx += 2;
1608         h_u32_to_be(h->cmdbuf+h->cmdidx, addr);
1609         h->cmdidx += 4;
1610         res = stlink_cmd_allow_retry(handle, h->databuf, 0);
1611         if (res != ERROR_OK)
1612                 return res;
1613
1614         stlink_usb_init_buffer(handle, h->rx_ep, len);
1615         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_COMMAND;
1616         h->cmdbuf[h->cmdidx++] = STLINK_SWIM_READBUF;
1617         res = stlink_usb_xfer_noerrcheck(handle, data, len);
1618         if (res != ERROR_OK)
1619                 return res;
1620
1621         return ERROR_OK;
1622 }
1623
1624 /** */
1625 static int stlink_usb_idcode(void *handle, uint32_t *idcode)
1626 {
1627         int res, offset;
1628         struct stlink_usb_handle_s *h = handle;
1629
1630         assert(handle != NULL);
1631
1632         /* there is no swim read core id cmd */
1633         if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
1634                 *idcode = 0;
1635                 return ERROR_OK;
1636         }
1637
1638         stlink_usb_init_buffer(handle, h->rx_ep, 12);
1639
1640         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1641         if (h->version.jtag_api == STLINK_JTAG_API_V1) {
1642                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READCOREID;
1643
1644                 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
1645                 offset = 0;
1646         } else {
1647                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READ_IDCODES;
1648
1649                 res = stlink_usb_xfer_errcheck(handle, h->databuf, 12);
1650                 offset = 4;
1651         }
1652
1653         if (res != ERROR_OK)
1654                 return res;
1655
1656         *idcode = le_to_h_u32(h->databuf + offset);
1657
1658         LOG_DEBUG("IDCODE: 0x%08" PRIX32, *idcode);
1659
1660         return ERROR_OK;
1661 }
1662
1663 static int stlink_usb_v2_read_debug_reg(void *handle, uint32_t addr, uint32_t *val)
1664 {
1665         struct stlink_usb_handle_s *h = handle;
1666         int res;
1667
1668         assert(handle != NULL);
1669
1670         stlink_usb_init_buffer(handle, h->rx_ep, 8);
1671
1672         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1673         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READDEBUGREG;
1674         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1675         h->cmdidx += 4;
1676
1677         res = stlink_cmd_allow_retry(handle, h->databuf, 8);
1678         if (res != ERROR_OK)
1679                 return res;
1680
1681         *val = le_to_h_u32(h->databuf + 4);
1682         return ERROR_OK;
1683 }
1684
1685 static int stlink_usb_write_debug_reg(void *handle, uint32_t addr, uint32_t val)
1686 {
1687         struct stlink_usb_handle_s *h = handle;
1688
1689         assert(handle != NULL);
1690
1691         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1692
1693         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1694         if (h->version.jtag_api == STLINK_JTAG_API_V1)
1695                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEDEBUGREG;
1696         else
1697                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEDEBUGREG;
1698         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
1699         h->cmdidx += 4;
1700         h_u32_to_le(h->cmdbuf+h->cmdidx, val);
1701         h->cmdidx += 4;
1702
1703         return stlink_cmd_allow_retry(handle, h->databuf, 2);
1704 }
1705
1706 /** */
1707 static int stlink_usb_trace_read(void *handle, uint8_t *buf, size_t *size)
1708 {
1709         struct stlink_usb_handle_s *h = handle;
1710
1711         assert(handle != NULL);
1712
1713         if (h->trace.enabled && (h->version.flags & STLINK_F_HAS_TRACE)) {
1714                 int res;
1715
1716                 stlink_usb_init_buffer(handle, h->rx_ep, 10);
1717
1718                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1719                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GET_TRACE_NB;
1720
1721                 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
1722                 if (res != ERROR_OK)
1723                         return res;
1724
1725                 size_t bytes_avail = le_to_h_u16(h->databuf);
1726                 *size = bytes_avail < *size ? bytes_avail : *size - 1;
1727
1728                 if (*size > 0) {
1729                         res = stlink_usb_read_trace(handle, buf, *size);
1730                         if (res != ERROR_OK)
1731                                 return res;
1732                         return ERROR_OK;
1733                 }
1734         }
1735         *size = 0;
1736         return ERROR_OK;
1737 }
1738
1739 static enum target_state stlink_usb_v2_get_status(void *handle)
1740 {
1741         int result;
1742         uint32_t status;
1743
1744         result = stlink_usb_v2_read_debug_reg(handle, DCB_DHCSR, &status);
1745         if  (result != ERROR_OK)
1746                 return TARGET_UNKNOWN;
1747
1748         if (status & S_HALT)
1749                 return TARGET_HALTED;
1750         else if (status & S_RESET_ST)
1751                 return TARGET_RESET;
1752
1753         return TARGET_RUNNING;
1754 }
1755
1756 /** */
1757 static enum target_state stlink_usb_state(void *handle)
1758 {
1759         int res;
1760         struct stlink_usb_handle_s *h = handle;
1761
1762         assert(handle != NULL);
1763
1764         if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
1765                 res = stlink_usb_mode_enter(handle, h->st_mode);
1766                 if (res != ERROR_OK)
1767                         return TARGET_UNKNOWN;
1768
1769                 res = stlink_swim_resync(handle);
1770                 if (res != ERROR_OK)
1771                         return TARGET_UNKNOWN;
1772
1773                 return ERROR_OK;
1774         }
1775
1776         if (h->reconnect_pending) {
1777                 LOG_INFO("Previous state query failed, trying to reconnect");
1778                 res = stlink_usb_mode_enter(handle, h->st_mode);
1779                 if (res != ERROR_OK)
1780                         return TARGET_UNKNOWN;
1781
1782                 h->reconnect_pending = false;
1783         }
1784
1785         if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1786                 res = stlink_usb_v2_get_status(handle);
1787                 if (res == TARGET_UNKNOWN)
1788                         h->reconnect_pending = true;
1789                 return res;
1790         }
1791
1792         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1793
1794         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1795         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_GETSTATUS;
1796
1797         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 2);
1798
1799         if (res != ERROR_OK)
1800                 return TARGET_UNKNOWN;
1801
1802         if (h->databuf[0] == STLINK_CORE_RUNNING)
1803                 return TARGET_RUNNING;
1804         if (h->databuf[0] == STLINK_CORE_HALTED)
1805                 return TARGET_HALTED;
1806
1807         h->reconnect_pending = true;
1808
1809         return TARGET_UNKNOWN;
1810 }
1811
1812 static int stlink_usb_assert_srst(void *handle, int srst)
1813 {
1814         struct stlink_usb_handle_s *h = handle;
1815
1816         assert(handle != NULL);
1817
1818         if (h->st_mode == STLINK_MODE_DEBUG_SWIM)
1819                 return stlink_swim_assert_reset(handle, srst);
1820
1821         if (h->version.stlink == 1)
1822                 return ERROR_COMMAND_NOTFOUND;
1823
1824         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1825
1826         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1827         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_DRIVE_NRST;
1828         h->cmdbuf[h->cmdidx++] = srst;
1829
1830         return stlink_cmd_allow_retry(handle, h->databuf, 2);
1831 }
1832
1833 /** */
1834 static void stlink_usb_trace_disable(void *handle)
1835 {
1836         int res = ERROR_OK;
1837         struct stlink_usb_handle_s *h = handle;
1838
1839         assert(handle != NULL);
1840
1841         assert(h->version.flags & STLINK_F_HAS_TRACE);
1842
1843         LOG_DEBUG("Tracing: disable");
1844
1845         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1846         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1847         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX;
1848         res = stlink_usb_xfer_errcheck(handle, h->databuf, 2);
1849
1850         if (res == ERROR_OK)
1851                 h->trace.enabled = false;
1852 }
1853
1854
1855 /** */
1856 static int stlink_usb_trace_enable(void *handle)
1857 {
1858         int res;
1859         struct stlink_usb_handle_s *h = handle;
1860
1861         assert(handle != NULL);
1862
1863         if (h->version.flags & STLINK_F_HAS_TRACE) {
1864                 stlink_usb_init_buffer(handle, h->rx_ep, 10);
1865
1866                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1867                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_START_TRACE_RX;
1868                 h_u16_to_le(h->cmdbuf+h->cmdidx, (uint16_t)STLINK_TRACE_SIZE);
1869                 h->cmdidx += 2;
1870                 h_u32_to_le(h->cmdbuf+h->cmdidx, h->trace.source_hz);
1871                 h->cmdidx += 4;
1872
1873                 res = stlink_usb_xfer_errcheck(handle, h->databuf, 2);
1874
1875                 if (res == ERROR_OK)  {
1876                         h->trace.enabled = true;
1877                         LOG_DEBUG("Tracing: recording at %" PRIu32 "Hz", h->trace.source_hz);
1878                 }
1879         } else {
1880                 LOG_ERROR("Tracing is not supported by this version.");
1881                 res = ERROR_FAIL;
1882         }
1883
1884         return res;
1885 }
1886
1887 /** */
1888 static int stlink_usb_reset(void *handle)
1889 {
1890         struct stlink_usb_handle_s *h = handle;
1891         int retval;
1892
1893         assert(handle != NULL);
1894
1895         if (h->st_mode == STLINK_MODE_DEBUG_SWIM)
1896                 return stlink_swim_generate_rst(handle);
1897
1898         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1899
1900         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1901
1902         if (h->version.jtag_api == STLINK_JTAG_API_V1)
1903                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_RESETSYS;
1904         else
1905                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_RESETSYS;
1906
1907         retval = stlink_cmd_allow_retry(handle, h->databuf, 2);
1908         if (retval != ERROR_OK)
1909                 return retval;
1910
1911         if (h->trace.enabled) {
1912                 stlink_usb_trace_disable(h);
1913                 return stlink_usb_trace_enable(h);
1914         }
1915
1916         return ERROR_OK;
1917 }
1918
1919 /** */
1920 static int stlink_usb_run(void *handle)
1921 {
1922         int res;
1923         struct stlink_usb_handle_s *h = handle;
1924
1925         assert(handle != NULL);
1926
1927         if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1928                 res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
1929
1930                 return res;
1931         }
1932
1933         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1934
1935         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1936         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_RUNCORE;
1937
1938         return stlink_cmd_allow_retry(handle, h->databuf, 2);
1939 }
1940
1941 /** */
1942 static int stlink_usb_halt(void *handle)
1943 {
1944         int res;
1945         struct stlink_usb_handle_s *h = handle;
1946
1947         assert(handle != NULL);
1948
1949         if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1950                 res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
1951
1952                 return res;
1953         }
1954
1955         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1956
1957         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1958         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_FORCEDEBUG;
1959
1960         return stlink_cmd_allow_retry(handle, h->databuf, 2);
1961 }
1962
1963 /** */
1964 static int stlink_usb_step(void *handle)
1965 {
1966         struct stlink_usb_handle_s *h = handle;
1967
1968         assert(handle != NULL);
1969
1970         if (h->version.jtag_api != STLINK_JTAG_API_V1) {
1971                 /* TODO: this emulates the v1 api, it should really use a similar auto mask isr
1972                  * that the Cortex-M3 currently does. */
1973                 stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_MASKINTS|C_DEBUGEN);
1974                 stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_STEP|C_MASKINTS|C_DEBUGEN);
1975                 return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
1976         }
1977
1978         stlink_usb_init_buffer(handle, h->rx_ep, 2);
1979
1980         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1981         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_STEPCORE;
1982
1983         return stlink_cmd_allow_retry(handle, h->databuf, 2);
1984 }
1985
1986 /** */
1987 static int stlink_usb_read_regs(void *handle)
1988 {
1989         int res;
1990         struct stlink_usb_handle_s *h = handle;
1991
1992         assert(handle != NULL);
1993
1994         stlink_usb_init_buffer(handle, h->rx_ep, 88);
1995
1996         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
1997         if (h->version.jtag_api == STLINK_JTAG_API_V1) {
1998
1999                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READALLREGS;
2000                 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 84);
2001                 /* regs data from offset 0 */
2002         } else {
2003                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READALLREGS;
2004                 res = stlink_usb_xfer_errcheck(handle, h->databuf, 88);
2005                 /* status at offset 0, regs data from offset 4 */
2006         }
2007
2008         return res;
2009 }
2010
2011 /** */
2012 static int stlink_usb_read_reg(void *handle, int num, uint32_t *val)
2013 {
2014         int res;
2015         struct stlink_usb_handle_s *h = handle;
2016
2017         assert(handle != NULL);
2018
2019         stlink_usb_init_buffer(handle, h->rx_ep, h->version.jtag_api == STLINK_JTAG_API_V1 ? 4 : 8);
2020
2021         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2022         if (h->version.jtag_api == STLINK_JTAG_API_V1)
2023                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_READREG;
2024         else
2025                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READREG;
2026         h->cmdbuf[h->cmdidx++] = num;
2027
2028         if (h->version.jtag_api == STLINK_JTAG_API_V1) {
2029                 res = stlink_usb_xfer_noerrcheck(handle, h->databuf, 4);
2030                 if (res != ERROR_OK)
2031                         return res;
2032                 *val = le_to_h_u32(h->databuf);
2033                 return ERROR_OK;
2034         } else {
2035                 res = stlink_cmd_allow_retry(handle, h->databuf, 8);
2036                 if (res != ERROR_OK)
2037                         return res;
2038                 *val = le_to_h_u32(h->databuf + 4);
2039                 return ERROR_OK;
2040         }
2041 }
2042
2043 /** */
2044 static int stlink_usb_write_reg(void *handle, int num, uint32_t val)
2045 {
2046         struct stlink_usb_handle_s *h = handle;
2047
2048         assert(handle != NULL);
2049
2050         stlink_usb_init_buffer(handle, h->rx_ep, 2);
2051
2052         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2053         if (h->version.jtag_api == STLINK_JTAG_API_V1)
2054                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV1_WRITEREG;
2055         else
2056                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEREG;
2057         h->cmdbuf[h->cmdidx++] = num;
2058         h_u32_to_le(h->cmdbuf+h->cmdidx, val);
2059         h->cmdidx += 4;
2060
2061         return stlink_cmd_allow_retry(handle, h->databuf, 2);
2062 }
2063
2064 static int stlink_usb_get_rw_status(void *handle)
2065 {
2066         struct stlink_usb_handle_s *h = handle;
2067
2068         assert(handle != NULL);
2069
2070         if (h->version.jtag_api == STLINK_JTAG_API_V1)
2071                 return ERROR_OK;
2072
2073         stlink_usb_init_buffer(handle, h->rx_ep, 2);
2074
2075         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2076         if (h->version.flags & STLINK_F_HAS_GETLASTRWSTATUS2) {
2077                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS2;
2078                 return stlink_usb_xfer_errcheck(handle, h->databuf, 12);
2079         } else {
2080                 h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GETLASTRWSTATUS;
2081                 return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
2082         }
2083 }
2084
2085 /** */
2086 static int stlink_usb_read_mem8(void *handle, uint32_t addr, uint16_t len,
2087                           uint8_t *buffer)
2088 {
2089         int res;
2090         uint16_t read_len = len;
2091         struct stlink_usb_handle_s *h = handle;
2092
2093         assert(handle != NULL);
2094
2095         /* max 8 bit read/write is 64 bytes or 512 bytes for v3 */
2096         if (len > stlink_usb_block(h)) {
2097                 LOG_DEBUG("max buffer (%d) length exceeded", stlink_usb_block(h));
2098                 return ERROR_FAIL;
2099         }
2100
2101         stlink_usb_init_buffer(handle, h->rx_ep, read_len);
2102
2103         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2104         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_8BIT;
2105         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2106         h->cmdidx += 4;
2107         h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2108         h->cmdidx += 2;
2109
2110         /* we need to fix read length for single bytes */
2111         if (read_len == 1)
2112                 read_len++;
2113
2114         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, read_len);
2115
2116         if (res != ERROR_OK)
2117                 return res;
2118
2119         memcpy(buffer, h->databuf, len);
2120
2121         return stlink_usb_get_rw_status(handle);
2122 }
2123
2124 /** */
2125 static int stlink_usb_write_mem8(void *handle, uint32_t addr, uint16_t len,
2126                            const uint8_t *buffer)
2127 {
2128         int res;
2129         struct stlink_usb_handle_s *h = handle;
2130
2131         assert(handle != NULL);
2132
2133         /* max 8 bit read/write is 64 bytes or 512 bytes for v3 */
2134         if (len > stlink_usb_block(h)) {
2135                 LOG_DEBUG("max buffer length (%d) exceeded", stlink_usb_block(h));
2136                 return ERROR_FAIL;
2137         }
2138
2139         stlink_usb_init_buffer(handle, h->tx_ep, len);
2140
2141         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2142         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_8BIT;
2143         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2144         h->cmdidx += 4;
2145         h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2146         h->cmdidx += 2;
2147
2148         res = stlink_usb_xfer_noerrcheck(handle, buffer, len);
2149
2150         if (res != ERROR_OK)
2151                 return res;
2152
2153         return stlink_usb_get_rw_status(handle);
2154 }
2155
2156 /** */
2157 static int stlink_usb_read_mem16(void *handle, uint32_t addr, uint16_t len,
2158                           uint8_t *buffer)
2159 {
2160         int res;
2161         struct stlink_usb_handle_s *h = handle;
2162
2163         assert(handle != NULL);
2164
2165         if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2166                 return ERROR_COMMAND_NOTFOUND;
2167
2168         /* data must be a multiple of 2 and half-word aligned */
2169         if (len % 2 || addr % 2) {
2170                 LOG_DEBUG("Invalid data alignment");
2171                 return ERROR_TARGET_UNALIGNED_ACCESS;
2172         }
2173
2174         stlink_usb_init_buffer(handle, h->rx_ep, len);
2175
2176         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2177         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READMEM_16BIT;
2178         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2179         h->cmdidx += 4;
2180         h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2181         h->cmdidx += 2;
2182
2183         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, len);
2184
2185         if (res != ERROR_OK)
2186                 return res;
2187
2188         memcpy(buffer, h->databuf, len);
2189
2190         return stlink_usb_get_rw_status(handle);
2191 }
2192
2193 /** */
2194 static int stlink_usb_write_mem16(void *handle, uint32_t addr, uint16_t len,
2195                            const uint8_t *buffer)
2196 {
2197         int res;
2198         struct stlink_usb_handle_s *h = handle;
2199
2200         assert(handle != NULL);
2201
2202         if (!(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2203                 return ERROR_COMMAND_NOTFOUND;
2204
2205         /* data must be a multiple of 2 and half-word aligned */
2206         if (len % 2 || addr % 2) {
2207                 LOG_DEBUG("Invalid data alignment");
2208                 return ERROR_TARGET_UNALIGNED_ACCESS;
2209         }
2210
2211         stlink_usb_init_buffer(handle, h->tx_ep, len);
2212
2213         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2214         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITEMEM_16BIT;
2215         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2216         h->cmdidx += 4;
2217         h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2218         h->cmdidx += 2;
2219
2220         res = stlink_usb_xfer_noerrcheck(handle, buffer, len);
2221
2222         if (res != ERROR_OK)
2223                 return res;
2224
2225         return stlink_usb_get_rw_status(handle);
2226 }
2227
2228 /** */
2229 static int stlink_usb_read_mem32(void *handle, uint32_t addr, uint16_t len,
2230                           uint8_t *buffer)
2231 {
2232         int res;
2233         struct stlink_usb_handle_s *h = handle;
2234
2235         assert(handle != NULL);
2236
2237         /* data must be a multiple of 4 and word aligned */
2238         if (len % 4 || addr % 4) {
2239                 LOG_DEBUG("Invalid data alignment");
2240                 return ERROR_TARGET_UNALIGNED_ACCESS;
2241         }
2242
2243         stlink_usb_init_buffer(handle, h->rx_ep, len);
2244
2245         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2246         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_READMEM_32BIT;
2247         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2248         h->cmdidx += 4;
2249         h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2250         h->cmdidx += 2;
2251
2252         res = stlink_usb_xfer_noerrcheck(handle, h->databuf, len);
2253
2254         if (res != ERROR_OK)
2255                 return res;
2256
2257         memcpy(buffer, h->databuf, len);
2258
2259         return stlink_usb_get_rw_status(handle);
2260 }
2261
2262 /** */
2263 static int stlink_usb_write_mem32(void *handle, uint32_t addr, uint16_t len,
2264                            const uint8_t *buffer)
2265 {
2266         int res;
2267         struct stlink_usb_handle_s *h = handle;
2268
2269         assert(handle != NULL);
2270
2271         /* data must be a multiple of 4 and word aligned */
2272         if (len % 4 || addr % 4) {
2273                 LOG_DEBUG("Invalid data alignment");
2274                 return ERROR_TARGET_UNALIGNED_ACCESS;
2275         }
2276
2277         stlink_usb_init_buffer(handle, h->tx_ep, len);
2278
2279         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2280         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_WRITEMEM_32BIT;
2281         h_u32_to_le(h->cmdbuf+h->cmdidx, addr);
2282         h->cmdidx += 4;
2283         h_u16_to_le(h->cmdbuf+h->cmdidx, len);
2284         h->cmdidx += 2;
2285
2286         res = stlink_usb_xfer_noerrcheck(handle, buffer, len);
2287
2288         if (res != ERROR_OK)
2289                 return res;
2290
2291         return stlink_usb_get_rw_status(handle);
2292 }
2293
2294 static uint32_t stlink_max_block_size(uint32_t tar_autoincr_block, uint32_t address)
2295 {
2296         uint32_t max_tar_block = (tar_autoincr_block - ((tar_autoincr_block - 1) & address));
2297         if (max_tar_block == 0)
2298                 max_tar_block = 4;
2299         return max_tar_block;
2300 }
2301
2302 static int stlink_usb_read_mem(void *handle, uint32_t addr, uint32_t size,
2303                 uint32_t count, uint8_t *buffer)
2304 {
2305         int retval = ERROR_OK;
2306         uint32_t bytes_remaining;
2307         int retries = 0;
2308         struct stlink_usb_handle_s *h = handle;
2309
2310         /* calculate byte count */
2311         count *= size;
2312
2313         /* switch to 8 bit if stlink does not support 16 bit memory read */
2314         if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2315                 size = 1;
2316
2317         while (count) {
2318
2319                 bytes_remaining = (size != 1) ?
2320                                 stlink_max_block_size(h->max_mem_packet, addr) : stlink_usb_block(h);
2321
2322                 if (count < bytes_remaining)
2323                         bytes_remaining = count;
2324
2325                 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
2326                         retval = stlink_swim_readbytes(handle, addr, bytes_remaining, buffer);
2327                         if (retval != ERROR_OK)
2328                                 return retval;
2329                 } else
2330                 /*
2331                  * all stlink support 8/32bit memory read/writes and only from
2332                  * stlink V2J26 there is support for 16 bit memory read/write.
2333                  * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
2334                  * as 8bit access.
2335                  */
2336                 if (size != 1) {
2337
2338                         /* When in jtag mode the stlink uses the auto-increment functionality.
2339                          * However it expects us to pass the data correctly, this includes
2340                          * alignment and any page boundaries. We already do this as part of the
2341                          * adi_v5 implementation, but the stlink is a hla adapter and so this
2342                          * needs implementing manually.
2343                          * currently this only affects jtag mode, according to ST they do single
2344                          * access in SWD mode - but this may change and so we do it for both modes */
2345
2346                         /* we first need to check for any unaligned bytes */
2347                         if (addr & (size - 1)) {
2348
2349                                 uint32_t head_bytes = size - (addr & (size - 1));
2350                                 retval = stlink_usb_read_mem8(handle, addr, head_bytes, buffer);
2351                                 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2352                                         usleep((1<<retries++) * 1000);
2353                                         continue;
2354                                 }
2355                                 if (retval != ERROR_OK)
2356                                         return retval;
2357                                 buffer += head_bytes;
2358                                 addr += head_bytes;
2359                                 count -= head_bytes;
2360                                 bytes_remaining -= head_bytes;
2361                         }
2362
2363                         if (bytes_remaining & (size - 1))
2364                                 retval = stlink_usb_read_mem(handle, addr, 1, bytes_remaining, buffer);
2365                         else if (size == 2)
2366                                 retval = stlink_usb_read_mem16(handle, addr, bytes_remaining, buffer);
2367                         else
2368                                 retval = stlink_usb_read_mem32(handle, addr, bytes_remaining, buffer);
2369                 } else
2370                         retval = stlink_usb_read_mem8(handle, addr, bytes_remaining, buffer);
2371
2372                 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2373                         usleep((1<<retries++) * 1000);
2374                         continue;
2375                 }
2376                 if (retval != ERROR_OK)
2377                         return retval;
2378
2379                 buffer += bytes_remaining;
2380                 addr += bytes_remaining;
2381                 count -= bytes_remaining;
2382         }
2383
2384         return retval;
2385 }
2386
2387 static int stlink_usb_write_mem(void *handle, uint32_t addr, uint32_t size,
2388                 uint32_t count, const uint8_t *buffer)
2389 {
2390         int retval = ERROR_OK;
2391         uint32_t bytes_remaining;
2392         int retries = 0;
2393         struct stlink_usb_handle_s *h = handle;
2394
2395         /* calculate byte count */
2396         count *= size;
2397
2398         /* switch to 8 bit if stlink does not support 16 bit memory read */
2399         if (size == 2 && !(h->version.flags & STLINK_F_HAS_MEM_16BIT))
2400                 size = 1;
2401
2402         while (count) {
2403
2404                 bytes_remaining = (size != 1) ?
2405                                 stlink_max_block_size(h->max_mem_packet, addr) : stlink_usb_block(h);
2406
2407                 if (count < bytes_remaining)
2408                         bytes_remaining = count;
2409
2410                 if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
2411                         retval = stlink_swim_writebytes(handle, addr, bytes_remaining, buffer);
2412                         if (retval != ERROR_OK)
2413                                 return retval;
2414                 } else
2415                 /*
2416                  * all stlink support 8/32bit memory read/writes and only from
2417                  * stlink V2J26 there is support for 16 bit memory read/write.
2418                  * Honour 32 bit and, if possible, 16 bit too. Otherwise, handle
2419                  * as 8bit access.
2420                  */
2421                 if (size != 1) {
2422
2423                         /* When in jtag mode the stlink uses the auto-increment functionality.
2424                          * However it expects us to pass the data correctly, this includes
2425                          * alignment and any page boundaries. We already do this as part of the
2426                          * adi_v5 implementation, but the stlink is a hla adapter and so this
2427                          * needs implementing manually.
2428                          * currently this only affects jtag mode, according to ST they do single
2429                          * access in SWD mode - but this may change and so we do it for both modes */
2430
2431                         /* we first need to check for any unaligned bytes */
2432                         if (addr & (size - 1)) {
2433
2434                                 uint32_t head_bytes = size - (addr & (size - 1));
2435                                 retval = stlink_usb_write_mem8(handle, addr, head_bytes, buffer);
2436                                 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2437                                         usleep((1<<retries++) * 1000);
2438                                         continue;
2439                                 }
2440                                 if (retval != ERROR_OK)
2441                                         return retval;
2442                                 buffer += head_bytes;
2443                                 addr += head_bytes;
2444                                 count -= head_bytes;
2445                                 bytes_remaining -= head_bytes;
2446                         }
2447
2448                         if (bytes_remaining & (size - 1))
2449                                 retval = stlink_usb_write_mem(handle, addr, 1, bytes_remaining, buffer);
2450                         else if (size == 2)
2451                                 retval = stlink_usb_write_mem16(handle, addr, bytes_remaining, buffer);
2452                         else
2453                                 retval = stlink_usb_write_mem32(handle, addr, bytes_remaining, buffer);
2454
2455                 } else
2456                         retval = stlink_usb_write_mem8(handle, addr, bytes_remaining, buffer);
2457                 if (retval == ERROR_WAIT && retries < MAX_WAIT_RETRIES) {
2458                         usleep((1<<retries++) * 1000);
2459                         continue;
2460                 }
2461                 if (retval != ERROR_OK)
2462                         return retval;
2463
2464                 buffer += bytes_remaining;
2465                 addr += bytes_remaining;
2466                 count -= bytes_remaining;
2467         }
2468
2469         return retval;
2470 }
2471
2472 /** */
2473 static int stlink_usb_override_target(const char *targetname)
2474 {
2475         return !strcmp(targetname, "cortex_m");
2476 }
2477
2478 static int stlink_speed_swim(void *handle, int khz, bool query)
2479 {
2480         int retval;
2481
2482         /*
2483                         we only have low and high speed...
2484                         before changing speed the SWIM_CSR HS bit
2485                         must be updated
2486          */
2487         if (!query) {
2488                 retval = stlink_swim_speed(handle, (khz < SWIM_FREQ_HIGH) ? 0 : 1);
2489                 if (retval != ERROR_OK)
2490                         LOG_ERROR("Unable to set adapter speed");
2491         }
2492
2493         return (khz < SWIM_FREQ_HIGH) ? SWIM_FREQ_LOW : SWIM_FREQ_HIGH;
2494 }
2495
2496 static int stlink_match_speed_map(const struct speed_map *map, unsigned int map_size, int khz, bool query)
2497 {
2498         unsigned int i;
2499         int speed_index = -1;
2500         int speed_diff = INT_MAX;
2501         int last_valid_speed = -1;
2502         bool match = true;
2503
2504         for (i = 0; i < map_size; i++) {
2505                 if (!map[i].speed)
2506                         continue;
2507                 last_valid_speed = i;
2508                 if (khz == map[i].speed) {
2509                         speed_index = i;
2510                         break;
2511                 } else {
2512                         int current_diff = khz - map[i].speed;
2513                         /* get abs value for comparison */
2514                         current_diff = (current_diff > 0) ? current_diff : -current_diff;
2515                         if ((current_diff < speed_diff) && khz >= map[i].speed) {
2516                                 speed_diff = current_diff;
2517                                 speed_index = i;
2518                         }
2519                 }
2520         }
2521
2522         if (speed_index == -1) {
2523                 /* this will only be here if we cannot match the slow speed.
2524                  * use the slowest speed we support.*/
2525                 speed_index = last_valid_speed;
2526                 match = false;
2527         } else if (i == map_size)
2528                 match = false;
2529
2530         if (!match && query) {
2531                 LOG_INFO("Unable to match requested speed %d kHz, using %d kHz",
2532                                 khz, map[speed_index].speed);
2533         }
2534
2535         return speed_index;
2536 }
2537
2538 static int stlink_speed_swd(void *handle, int khz, bool query)
2539 {
2540         int speed_index;
2541         struct stlink_usb_handle_s *h = handle;
2542
2543         /* old firmware cannot change it */
2544         if (!(h->version.flags & STLINK_F_HAS_SWD_SET_FREQ))
2545                 return khz;
2546
2547         speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_swd,
2548                 ARRAY_SIZE(stlink_khz_to_speed_map_swd), khz, query);
2549
2550         if (!query) {
2551                 int result = stlink_usb_set_swdclk(h, stlink_khz_to_speed_map_swd[speed_index].speed_divisor);
2552                 if (result != ERROR_OK) {
2553                         LOG_ERROR("Unable to set adapter speed");
2554                         return khz;
2555                 }
2556         }
2557
2558         return stlink_khz_to_speed_map_swd[speed_index].speed;
2559 }
2560
2561 static int stlink_speed_jtag(void *handle, int khz, bool query)
2562 {
2563         int speed_index;
2564         struct stlink_usb_handle_s *h = handle;
2565
2566         /* old firmware cannot change it */
2567         if (!(h->version.flags & STLINK_F_HAS_JTAG_SET_FREQ))
2568                 return khz;
2569
2570         speed_index = stlink_match_speed_map(stlink_khz_to_speed_map_jtag,
2571                 ARRAY_SIZE(stlink_khz_to_speed_map_jtag), khz, query);
2572
2573         if (!query) {
2574                 int result = stlink_usb_set_jtagclk(h, stlink_khz_to_speed_map_jtag[speed_index].speed_divisor);
2575                 if (result != ERROR_OK) {
2576                         LOG_ERROR("Unable to set adapter speed");
2577                         return khz;
2578                 }
2579         }
2580
2581         return stlink_khz_to_speed_map_jtag[speed_index].speed;
2582 }
2583
2584 void stlink_dump_speed_map(const struct speed_map *map, unsigned int map_size)
2585 {
2586         unsigned int i;
2587
2588         LOG_DEBUG("Supported clock speeds are:");
2589         for (i = 0; i < map_size; i++)
2590                 if (map[i].speed)
2591                         LOG_DEBUG("%d kHz", map[i].speed);
2592 }
2593
2594 static int stlink_get_com_freq(void *handle, bool is_jtag, struct speed_map *map)
2595 {
2596         struct stlink_usb_handle_s *h = handle;
2597         int i;
2598
2599         if (h->version.jtag_api != STLINK_JTAG_API_V3) {
2600                 LOG_ERROR("Unknown command");
2601                 return 0;
2602         }
2603
2604         stlink_usb_init_buffer(handle, h->rx_ep, 16);
2605
2606         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2607         h->cmdbuf[h->cmdidx++] = STLINK_APIV3_GET_COM_FREQ;
2608         h->cmdbuf[h->cmdidx++] = is_jtag ? 1 : 0;
2609
2610         int res = stlink_usb_xfer_errcheck(handle, h->databuf, 52);
2611
2612         int size = h->databuf[8];
2613
2614         if (size > STLINK_V3_MAX_FREQ_NB)
2615                 size = STLINK_V3_MAX_FREQ_NB;
2616
2617         for (i = 0; i < size; i++) {
2618                 map[i].speed = le_to_h_u32(&h->databuf[12 + 4 * i]);
2619                 map[i].speed_divisor = i;
2620         }
2621
2622         /* set to zero all the next entries */
2623         for (i = size; i < STLINK_V3_MAX_FREQ_NB; i++)
2624                 map[i].speed = 0;
2625
2626         return res;
2627 }
2628
2629 static int stlink_set_com_freq(void *handle, bool is_jtag, unsigned int frequency)
2630 {
2631         struct stlink_usb_handle_s *h = handle;
2632
2633         if (h->version.jtag_api != STLINK_JTAG_API_V3) {
2634                 LOG_ERROR("Unknown command");
2635                 return 0;
2636         }
2637
2638         stlink_usb_init_buffer(handle, h->rx_ep, 16);
2639
2640         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
2641         h->cmdbuf[h->cmdidx++] = STLINK_APIV3_SET_COM_FREQ;
2642         h->cmdbuf[h->cmdidx++] = is_jtag ? 1 : 0;
2643         h->cmdbuf[h->cmdidx++] = 0;
2644
2645         h_u32_to_le(&h->cmdbuf[4], frequency);
2646
2647         return stlink_usb_xfer_errcheck(handle, h->databuf, 8);
2648 }
2649
2650 static int stlink_speed_v3(void *handle, bool is_jtag, int khz, bool query)
2651 {
2652         struct stlink_usb_handle_s *h = handle;
2653         int speed_index;
2654         struct speed_map map[STLINK_V3_MAX_FREQ_NB];
2655
2656         stlink_get_com_freq(h, is_jtag, map);
2657
2658         speed_index = stlink_match_speed_map(map, ARRAY_SIZE(map), khz, query);
2659
2660         if (!query) {
2661                 int result = stlink_set_com_freq(h, is_jtag, map[speed_index].speed);
2662                 if (result != ERROR_OK) {
2663                         LOG_ERROR("Unable to set adapter speed");
2664                         return khz;
2665                 }
2666         }
2667         return map[speed_index].speed;
2668 }
2669
2670 static int stlink_speed(void *handle, int khz, bool query)
2671 {
2672         struct stlink_usb_handle_s *h = handle;
2673
2674         if (!handle)
2675                 return khz;
2676
2677         switch (h->st_mode) {
2678         case STLINK_MODE_DEBUG_SWIM:
2679                 return stlink_speed_swim(handle, khz, query);
2680         case STLINK_MODE_DEBUG_SWD:
2681                 if (h->version.jtag_api == STLINK_JTAG_API_V3)
2682                         return stlink_speed_v3(handle, false, khz, query);
2683                 else
2684                         return stlink_speed_swd(handle, khz, query);
2685                 break;
2686         case STLINK_MODE_DEBUG_JTAG:
2687                 if (h->version.jtag_api == STLINK_JTAG_API_V3)
2688                         return stlink_speed_v3(handle, true, khz, query);
2689                 else
2690                         return stlink_speed_jtag(handle, khz, query);
2691                 break;
2692         default:
2693                 break;
2694         }
2695
2696         return khz;
2697 }
2698
2699 /** */
2700 static int stlink_usb_close(void *handle)
2701 {
2702         int res;
2703         uint8_t mode;
2704         enum stlink_mode emode;
2705         struct stlink_usb_handle_s *h = handle;
2706
2707         if (h && h->fd)
2708                 res = stlink_usb_current_mode(handle, &mode);
2709         else
2710                 res = ERROR_FAIL;
2711         /* do not exit if return code != ERROR_OK,
2712            it prevents us from closing jtag_libusb */
2713
2714         if (res == ERROR_OK) {
2715                 /* try to exit current mode */
2716                 switch (mode) {
2717                         case STLINK_DEV_DFU_MODE:
2718                                 emode = STLINK_MODE_DFU;
2719                                 break;
2720                         case STLINK_DEV_DEBUG_MODE:
2721                                 emode = STLINK_MODE_DEBUG_SWD;
2722                                 break;
2723                         case STLINK_DEV_SWIM_MODE:
2724                                 emode = STLINK_MODE_DEBUG_SWIM;
2725                                 break;
2726                         case STLINK_DEV_BOOTLOADER_MODE:
2727                         case STLINK_DEV_MASS_MODE:
2728                         default:
2729                                 emode = STLINK_MODE_UNKNOWN;
2730                                 break;
2731                 }
2732
2733                 if (emode != STLINK_MODE_UNKNOWN)
2734                         stlink_usb_mode_leave(handle, emode);
2735                         /* do not check return code, it prevent
2736                         us from closing jtag_libusb */
2737         }
2738
2739         if (h && h->fd)
2740                 jtag_libusb_close(h->fd);
2741
2742         free(h);
2743
2744         return ERROR_OK;
2745 }
2746
2747 /* Compute ST-Link serial number from the device descriptor
2748  * this function will help to work-around a bug in old ST-Link/V2 DFU
2749  * the buggy DFU returns an incorrect serial in the USB descriptor
2750  * example for the following serial "57FF72067265575742132067"
2751  *  - the correct descriptor serial is:
2752  *    0x32, 0x03, 0x35, 0x00, 0x37, 0x00, 0x46, 0x00, 0x46, 0x00, 0x37, 0x00, 0x32, 0x00 ...
2753  *    this contains the length (0x32 = 50), the type (0x3 = DT_STRING) and the serial in unicode format
2754  *    the serial part is: 0x0035, 0x0037, 0x0046, 0x0046, 0x0037, 0x0032 ... >>  57FF72 ...
2755  *    this format could be read correctly by 'libusb_get_string_descriptor_ascii'
2756  *    so this case is managed by libusb_helper::string_descriptor_equal
2757  *  - the buggy DFU is not doing any unicode conversion and returns a raw serial data in the descriptor
2758  *    0x1a, 0x03, 0x57, 0x00, 0xFF, 0x00, 0x72, 0x00 ...
2759  *            >>    57          FF          72       ...
2760  *    based on the length (0x1a = 26) we could easily decide if we have to fixup the serial
2761  *    and then we have just to convert the raw data into printable characters using sprintf
2762  */
2763 char *stlink_usb_get_alternate_serial(libusb_device_handle *device,
2764                 struct libusb_device_descriptor *dev_desc)
2765 {
2766         int usb_retval;
2767         unsigned char desc_serial[(STLINK_SERIAL_LEN + 1) * 2];
2768
2769         if (dev_desc->iSerialNumber == 0)
2770                 return NULL;
2771
2772         /* get the LANGID from String Descriptor Zero */
2773         usb_retval = libusb_get_string_descriptor(device, 0, 0, desc_serial,
2774                         sizeof(desc_serial));
2775
2776         if (usb_retval < LIBUSB_SUCCESS) {
2777                 LOG_ERROR("libusb_get_string_descriptor() failed: %s(%d)",
2778                                 libusb_error_name(usb_retval), usb_retval);
2779                 return NULL;
2780         } else if (usb_retval < 4) {
2781                 /* the size should be least 4 bytes to contain a minimum of 1 supported LANGID */
2782                 LOG_ERROR("could not get the LANGID");
2783                 return NULL;
2784         }
2785
2786         uint32_t langid = desc_serial[2] | (desc_serial[3] << 8);
2787
2788         /* get the serial */
2789         usb_retval = libusb_get_string_descriptor(device, dev_desc->iSerialNumber,
2790                         langid, desc_serial, sizeof(desc_serial));
2791
2792         unsigned char len = desc_serial[0];
2793
2794         if (usb_retval < LIBUSB_SUCCESS) {
2795                 LOG_ERROR("libusb_get_string_descriptor() failed: %s(%d)",
2796                                 libusb_error_name(usb_retval), usb_retval);
2797                 return NULL;
2798         } else if (desc_serial[1] != LIBUSB_DT_STRING || len > usb_retval) {
2799                 LOG_ERROR("invalid string in ST-LINK USB serial descriptor");
2800                 return NULL;
2801         }
2802
2803         if (len == ((STLINK_SERIAL_LEN + 1) * 2)) {
2804                 /* good ST-Link adapter, this case is managed by
2805                  * libusb::libusb_get_string_descriptor_ascii */
2806                 return NULL;
2807         } else if (len != ((STLINK_SERIAL_LEN / 2 + 1) * 2)) {
2808                 LOG_ERROR("unexpected serial length (%d) in descriptor", len);
2809                 return NULL;
2810         }
2811
2812         /* else (len == 26) => buggy ST-Link */
2813
2814         char *alternate_serial = malloc((STLINK_SERIAL_LEN + 1) * sizeof(char));
2815         if (alternate_serial == NULL)
2816                 return NULL;
2817
2818         for (unsigned int i = 0; i < STLINK_SERIAL_LEN; i += 2)
2819                 sprintf(alternate_serial + i, "%02X", desc_serial[i + 2]);
2820
2821         alternate_serial[STLINK_SERIAL_LEN] = '\0';
2822
2823         return alternate_serial;
2824 }
2825
2826 /** */
2827 static int stlink_usb_open(struct hl_interface_param_s *param, enum stlink_mode mode, void **fd)
2828 {
2829         int err, retry_count = 1;
2830         struct stlink_usb_handle_s *h;
2831
2832         LOG_DEBUG("stlink_usb_open");
2833
2834         h = calloc(1, sizeof(struct stlink_usb_handle_s));
2835
2836         if (h == 0) {
2837                 LOG_DEBUG("malloc failed");
2838                 return ERROR_FAIL;
2839         }
2840
2841         h->st_mode = mode;
2842
2843         for (unsigned i = 0; param->vid[i]; i++) {
2844                 LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x serial: %s",
2845                           h->st_mode, param->vid[i], param->pid[i],
2846                           param->serial ? param->serial : "");
2847         }
2848
2849         /*
2850           On certain host USB configurations(e.g. MacBook Air)
2851           STLINKv2 dongle seems to have its FW in a funky state if,
2852           after plugging it in, you try to use openocd with it more
2853           then once (by launching and closing openocd). In cases like
2854           that initial attempt to read the FW info via
2855           stlink_usb_version will fail and the device has to be reset
2856           in order to become operational.
2857          */
2858         do {
2859                 if (jtag_libusb_open(param->vid, param->pid, param->serial,
2860                                 &h->fd, stlink_usb_get_alternate_serial) != ERROR_OK) {
2861                         LOG_ERROR("open failed");
2862                         goto error_open;
2863                 }
2864
2865                 jtag_libusb_set_configuration(h->fd, 0);
2866
2867                 if (libusb_claim_interface(h->fd, 0) != ERROR_OK) {
2868                         LOG_DEBUG("claim interface failed");
2869                         goto error_open;
2870                 }
2871
2872                 /* RX EP is common for all versions */
2873                 h->rx_ep = STLINK_RX_EP;
2874
2875                 uint16_t pid;
2876                 if (jtag_libusb_get_pid(libusb_get_device(h->fd), &pid) != ERROR_OK) {
2877                         LOG_DEBUG("libusb_get_pid failed");
2878                         goto error_open;
2879                 }
2880
2881                 /* wrap version for first read */
2882                 switch (pid) {
2883                         case STLINK_V1_PID:
2884                                 h->version.stlink = 1;
2885                                 h->tx_ep = STLINK_TX_EP;
2886                                 break;
2887                         case STLINK_V3_USBLOADER_PID:
2888                         case STLINK_V3E_PID:
2889                         case STLINK_V3S_PID:
2890                         case STLINK_V3_2VCP_PID:
2891                                 h->version.stlink = 3;
2892                                 h->tx_ep = STLINK_V2_1_TX_EP;
2893                                 h->trace_ep = STLINK_V2_1_TRACE_EP;
2894                                 break;
2895                         case STLINK_V2_1_PID:
2896                         case STLINK_V2_1_NO_MSD_PID:
2897                                 h->version.stlink = 2;
2898                                 h->tx_ep = STLINK_V2_1_TX_EP;
2899                                 h->trace_ep = STLINK_V2_1_TRACE_EP;
2900                                 break;
2901                         default:
2902                         /* fall through - we assume V2 to be the default version*/
2903                         case STLINK_V2_PID:
2904                                 h->version.stlink = 2;
2905                                 h->tx_ep = STLINK_TX_EP;
2906                                 h->trace_ep = STLINK_TRACE_EP;
2907                                 break;
2908                 }
2909
2910                 /* get the device version */
2911                 err = stlink_usb_version(h);
2912
2913                 if (err == ERROR_OK) {
2914                         break;
2915                 } else if (h->version.stlink == 1 ||
2916                            retry_count == 0) {
2917                         LOG_ERROR("read version failed");
2918                         goto error_open;
2919                 } else {
2920                         err = libusb_release_interface(h->fd, 0);
2921                         if (err != ERROR_OK) {
2922                                 LOG_ERROR("release interface failed");
2923                                 goto error_open;
2924                         }
2925
2926                         err = libusb_reset_device(h->fd);
2927                         if (err != ERROR_OK) {
2928                                 LOG_ERROR("reset device failed");
2929                                 goto error_open;
2930                         }
2931
2932                         jtag_libusb_close(h->fd);
2933                         /*
2934                           Give the device one second to settle down and
2935                           reenumerate.
2936                          */
2937                         usleep(1 * 1000 * 1000);
2938                         retry_count--;
2939                 }
2940         } while (1);
2941
2942         /* check if mode is supported */
2943         err = ERROR_OK;
2944
2945         switch (h->st_mode) {
2946                 case STLINK_MODE_DEBUG_SWD:
2947                         if (h->version.jtag_api == STLINK_JTAG_API_V1)
2948                                 err = ERROR_FAIL;
2949                         /* fall-through */
2950                 case STLINK_MODE_DEBUG_JTAG:
2951                         if (h->version.jtag == 0)
2952                                 err = ERROR_FAIL;
2953                         break;
2954                 case STLINK_MODE_DEBUG_SWIM:
2955                         if (h->version.swim == 0)
2956                                 err = ERROR_FAIL;
2957                         break;
2958                 default:
2959                         err = ERROR_FAIL;
2960                         break;
2961         }
2962
2963         if (err != ERROR_OK) {
2964                 LOG_ERROR("mode (transport) not supported by device");
2965                 goto error_open;
2966         }
2967
2968         /* initialize the debug hardware */
2969         err = stlink_usb_init_mode(h, param->connect_under_reset, param->initial_interface_speed);
2970
2971         if (err != ERROR_OK) {
2972                 LOG_ERROR("init mode failed (unable to connect to the target)");
2973                 goto error_open;
2974         }
2975
2976         if (h->st_mode == STLINK_MODE_DEBUG_SWIM) {
2977                 err = stlink_swim_enter(h);
2978                 if (err != ERROR_OK) {
2979                         LOG_ERROR("stlink_swim_enter_failed (unable to connect to the target)");
2980                         goto error_open;
2981                 }
2982                 *fd = h;
2983                 h->max_mem_packet = STLINK_DATA_SIZE;
2984                 return ERROR_OK;
2985         }
2986
2987         /* get cpuid, so we can determine the max page size
2988          * start with a safe default */
2989         h->max_mem_packet = (1 << 10);
2990
2991         uint8_t buffer[4];
2992         err = stlink_usb_read_mem32(h, CPUID, 4, buffer);
2993         if (err == ERROR_OK) {
2994                 uint32_t cpuid = le_to_h_u32(buffer);
2995                 int i = (cpuid >> 4) & 0xf;
2996                 if (i == 4 || i == 3) {
2997                         /* Cortex-M3/M4 has 4096 bytes autoincrement range */
2998                         h->max_mem_packet = (1 << 12);
2999                 }
3000         }
3001
3002         LOG_DEBUG("Using TAR autoincrement: %" PRIu32, h->max_mem_packet);
3003
3004         *fd = h;
3005
3006         return ERROR_OK;
3007
3008 error_open:
3009         stlink_usb_close(h);
3010
3011         return ERROR_FAIL;
3012 }
3013
3014 static int stlink_usb_hl_open(struct hl_interface_param_s *param, void **fd)
3015 {
3016         return stlink_usb_open(param, stlink_get_mode(param->transport), fd);
3017 }
3018
3019 int stlink_config_trace(void *handle, bool enabled,
3020                 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
3021                 unsigned int *trace_freq, unsigned int traceclkin_freq,
3022                 uint16_t *prescaler)
3023 {
3024         struct stlink_usb_handle_s *h = handle;
3025         uint16_t presc;
3026
3027         if (enabled && (!(h->version.flags & STLINK_F_HAS_TRACE) ||
3028                         pin_protocol != TPIU_PIN_PROTOCOL_ASYNC_UART)) {
3029                 LOG_ERROR("The attached ST-LINK version doesn't support this trace mode");
3030                 return ERROR_FAIL;
3031         }
3032
3033         if (!enabled) {
3034                 stlink_usb_trace_disable(h);
3035                 return ERROR_OK;
3036         }
3037
3038         if (*trace_freq > STLINK_TRACE_MAX_HZ) {
3039                 LOG_ERROR("ST-LINK doesn't support SWO frequency higher than %u",
3040                           STLINK_TRACE_MAX_HZ);
3041                 return ERROR_FAIL;
3042         }
3043
3044         stlink_usb_trace_disable(h);
3045
3046         if (!*trace_freq)
3047                 *trace_freq = STLINK_TRACE_MAX_HZ;
3048
3049         presc = traceclkin_freq / *trace_freq;
3050
3051         if (traceclkin_freq % *trace_freq > 0)
3052                 presc++;
3053
3054         if (presc > TPIU_ACPR_MAX_SWOSCALER) {
3055                 LOG_ERROR("SWO frequency is not suitable. Please choose a different "
3056                         "frequency.");
3057                 return ERROR_FAIL;
3058         }
3059
3060         *prescaler = presc;
3061         h->trace.source_hz = *trace_freq;
3062
3063         return stlink_usb_trace_enable(h);
3064 }
3065
3066 /** */
3067 static int stlink_usb_init_access_port(void *handle, unsigned char ap_num)
3068 {
3069         struct stlink_usb_handle_s *h = handle;
3070
3071         assert(handle != NULL);
3072
3073         if (!(h->version.flags & STLINK_F_HAS_AP_INIT))
3074                 return ERROR_COMMAND_NOTFOUND;
3075
3076         LOG_DEBUG_IO("init ap_num = %d", ap_num);
3077         stlink_usb_init_buffer(handle, h->rx_ep, 16);
3078         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3079         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_INIT_AP;
3080         h->cmdbuf[h->cmdidx++] = ap_num;
3081
3082         return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
3083 }
3084
3085 /** */
3086 static int stlink_usb_close_access_port(void *handle, unsigned char ap_num)
3087 {
3088         struct stlink_usb_handle_s *h = handle;
3089
3090         assert(handle != NULL);
3091
3092         if (!(h->version.flags & STLINK_F_HAS_AP_INIT))
3093                 return ERROR_COMMAND_NOTFOUND;
3094
3095         LOG_DEBUG_IO("close ap_num = %d", ap_num);
3096         stlink_usb_init_buffer(handle, h->rx_ep, 16);
3097         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3098         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_CLOSE_AP_DBG;
3099         h->cmdbuf[h->cmdidx++] = ap_num;
3100
3101         return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
3102 }
3103
3104 /** */
3105 static int stlink_read_dap_register(void *handle, unsigned short dap_port,
3106                         unsigned short addr, uint32_t *val)
3107 {
3108         struct stlink_usb_handle_s *h = handle;
3109         int retval;
3110
3111         assert(handle != NULL);
3112
3113         if (!(h->version.flags & STLINK_F_HAS_DAP_REG))
3114                 return ERROR_COMMAND_NOTFOUND;
3115
3116         stlink_usb_init_buffer(handle, h->rx_ep, 16);
3117         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3118         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_READ_DAP_REG;
3119         h_u16_to_le(&h->cmdbuf[2], dap_port);
3120         h_u16_to_le(&h->cmdbuf[4], addr);
3121
3122         retval = stlink_usb_xfer_errcheck(handle, h->databuf, 8);
3123         *val = le_to_h_u32(h->databuf + 4);
3124         LOG_DEBUG_IO("dap_port_read = %d, addr =  0x%x, value = 0x%x", dap_port, addr, *val);
3125         return retval;
3126 }
3127
3128 /** */
3129 static int stlink_write_dap_register(void *handle, unsigned short dap_port,
3130                         unsigned short addr, uint32_t val)
3131 {
3132         struct stlink_usb_handle_s *h = handle;
3133
3134         assert(handle != NULL);
3135
3136         if (!(h->version.flags & STLINK_F_HAS_DAP_REG))
3137                 return ERROR_COMMAND_NOTFOUND;
3138
3139         LOG_DEBUG_IO("dap_write port = %d, addr = 0x%x, value = 0x%x", dap_port, addr, val);
3140         stlink_usb_init_buffer(handle, h->rx_ep, 16);
3141         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
3142         h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_WRITE_DAP_REG;
3143         h_u16_to_le(&h->cmdbuf[2], dap_port);
3144         h_u16_to_le(&h->cmdbuf[4], addr);
3145         h_u32_to_le(&h->cmdbuf[6], val);
3146         return stlink_usb_xfer_errcheck(handle, h->databuf, 2);
3147 }
3148
3149 /** */
3150 struct hl_layout_api_s stlink_usb_layout_api = {
3151         /** */
3152         .open = stlink_usb_hl_open,
3153         /** */
3154         .close = stlink_usb_close,
3155         /** */
3156         .idcode = stlink_usb_idcode,
3157         /** */
3158         .state = stlink_usb_state,
3159         /** */
3160         .reset = stlink_usb_reset,
3161         /** */
3162         .assert_srst = stlink_usb_assert_srst,
3163         /** */
3164         .run = stlink_usb_run,
3165         /** */
3166         .halt = stlink_usb_halt,
3167         /** */
3168         .step = stlink_usb_step,
3169         /** */
3170         .read_regs = stlink_usb_read_regs,
3171         /** */
3172         .read_reg = stlink_usb_read_reg,
3173         /** */
3174         .write_reg = stlink_usb_write_reg,
3175         /** */
3176         .read_mem = stlink_usb_read_mem,
3177         /** */
3178         .write_mem = stlink_usb_write_mem,
3179         /** */
3180         .write_debug_reg = stlink_usb_write_debug_reg,
3181         /** */
3182         .override_target = stlink_usb_override_target,
3183         /** */
3184         .speed = stlink_speed,
3185         /** */
3186         .config_trace = stlink_config_trace,
3187         /** */
3188         .poll_trace = stlink_usb_trace_read,
3189 };
3190
3191 /*****************************************************************************
3192  * DAP direct interface
3193  */
3194
3195 static struct stlink_usb_handle_s *stlink_dap_handle;
3196 static struct hl_interface_param_s stlink_dap_param;
3197 static DECLARE_BITMAP(opened_ap, DP_APSEL_MAX + 1);
3198 static int stlink_dap_error = ERROR_OK;
3199
3200 static int stlink_dap_op_queue_dp_read(struct adiv5_dap *dap, unsigned reg,
3201                 uint32_t *data);
3202
3203 /** */
3204 static int stlink_dap_record_error(int error)
3205 {
3206         if (stlink_dap_error == ERROR_OK)
3207                 stlink_dap_error = error;
3208         return ERROR_OK;
3209 }
3210
3211 /** */
3212 static int stlink_dap_get_and_clear_error(void)
3213 {
3214         int retval = stlink_dap_error;
3215         stlink_dap_error = ERROR_OK;
3216         return retval;
3217 }
3218
3219 /** */
3220 static int stlink_dap_open_ap(unsigned short apsel)
3221 {
3222         int retval;
3223
3224         /* nothing to do on old versions */
3225         if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT))
3226                 return ERROR_OK;
3227
3228         if (apsel > DP_APSEL_MAX)
3229                 return ERROR_FAIL;
3230
3231         if (test_bit(apsel, opened_ap))
3232                 return ERROR_OK;
3233
3234         retval = stlink_usb_init_access_port(stlink_dap_handle, apsel);
3235         if (retval != ERROR_OK)
3236                 return retval;
3237
3238         LOG_DEBUG("AP %d enabled", apsel);
3239         set_bit(apsel, opened_ap);
3240         return ERROR_OK;
3241 }
3242
3243 /** */
3244 static int stlink_dap_closeall_ap(void)
3245 {
3246         int retval, apsel;
3247
3248         /* nothing to do on old versions */
3249         if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT))
3250                 return ERROR_OK;
3251
3252         for (apsel = 0; apsel <= DP_APSEL_MAX; apsel++) {
3253                 if (!test_bit(apsel, opened_ap))
3254                         continue;
3255                 retval = stlink_usb_close_access_port(stlink_dap_handle, apsel);
3256                 if (retval != ERROR_OK)
3257                         return retval;
3258                 clear_bit(apsel, opened_ap);
3259         }
3260         return ERROR_OK;
3261 }
3262
3263 /** */
3264 static int stlink_dap_reinit_interface(void)
3265 {
3266         int retval;
3267
3268         /*
3269          * On JTAG only, it should be enough to call stlink_usb_reset(). But on
3270          * some firmware version it does not work as expected, and there is no
3271          * equivalent for SWD.
3272          * At least for now, to reset the interface quit from JTAG/SWD mode then
3273          * select the mode again.
3274          */
3275
3276         if (!stlink_dap_handle->reconnect_pending) {
3277                 stlink_dap_handle->reconnect_pending = true;
3278                 stlink_usb_mode_leave(stlink_dap_handle, stlink_dap_handle->st_mode);
3279         }
3280
3281         retval = stlink_usb_mode_enter(stlink_dap_handle, stlink_dap_handle->st_mode);
3282         if (retval != ERROR_OK)
3283                 return retval;
3284
3285         stlink_dap_handle->reconnect_pending = false;
3286         /* on new FW, calling mode-leave closes all the opened AP; reopen them! */
3287         if (stlink_dap_handle->version.flags & STLINK_F_HAS_AP_INIT)
3288                 for (int apsel = 0; apsel <= DP_APSEL_MAX; apsel++)
3289                         if (test_bit(apsel, opened_ap)) {
3290                                 clear_bit(apsel, opened_ap);
3291                                 stlink_dap_open_ap(apsel);
3292                         }
3293         return ERROR_OK;
3294 }
3295
3296 /** */
3297 static int stlink_dap_op_connect(struct adiv5_dap *dap)
3298 {
3299         uint32_t idcode;
3300         int retval;
3301
3302         LOG_INFO("stlink_dap_op_connect(%sconnect)", dap->do_reconnect ? "re" : "");
3303
3304         /* Check if we should reset srst already when connecting, but not if reconnecting. */
3305         if (!dap->do_reconnect) {
3306                 enum reset_types jtag_reset_config = jtag_get_reset_config();
3307
3308                 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
3309                         if (jtag_reset_config & RESET_SRST_NO_GATING)
3310                                 adapter_assert_reset();
3311                         else
3312                                 LOG_WARNING("\'srst_nogate\' reset_config option is required");
3313                 }
3314         }
3315
3316         dap->do_reconnect = false;
3317         dap_invalidate_cache(dap);
3318
3319         retval = dap_dp_init(dap);
3320         if (retval != ERROR_OK) {
3321                 dap->do_reconnect = true;
3322                 return retval;
3323         }
3324
3325         retval = stlink_usb_idcode(stlink_dap_handle, &idcode);
3326         if (retval == ERROR_OK)
3327                 LOG_INFO("%s %#8.8" PRIx32,
3328                         (stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG) ? "JTAG IDCODE" : "SWD DPIDR",
3329                         idcode);
3330         else
3331                 dap->do_reconnect = true;
3332
3333         return retval;
3334 }
3335
3336 /** */
3337 static int stlink_dap_check_reconnect(struct adiv5_dap *dap)
3338 {
3339         int retval;
3340
3341         if (!dap->do_reconnect)
3342                 return ERROR_OK;
3343
3344         retval = stlink_dap_reinit_interface();
3345         if (retval != ERROR_OK)
3346                 return retval;
3347
3348         return stlink_dap_op_connect(dap);
3349 }
3350
3351 /** */
3352 static int stlink_dap_op_send_sequence(struct adiv5_dap *dap, enum swd_special_seq seq)
3353 {
3354         /* Ignore the request */
3355         return ERROR_OK;
3356 }
3357
3358 /** */
3359 static int stlink_dap_op_queue_dp_read(struct adiv5_dap *dap, unsigned reg,
3360                 uint32_t *data)
3361 {
3362         uint32_t dummy;
3363         int retval;
3364
3365         if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_DPBANKSEL))
3366                 if (reg & 0x000000F0) {
3367                         LOG_ERROR("Banked DP registers not supported in current STLink FW");
3368                         return ERROR_COMMAND_NOTFOUND;
3369                 }
3370
3371         retval = stlink_dap_check_reconnect(dap);
3372         if (retval != ERROR_OK)
3373                 return retval;
3374
3375         data = data ? : &dummy;
3376         if (stlink_dap_handle->version.flags & STLINK_F_QUIRK_JTAG_DP_READ
3377                 && stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG) {
3378                 /* Quirk required in JTAG. Read RDBUFF to get the data */
3379                 retval = stlink_read_dap_register(stlink_dap_handle,
3380                                         STLINK_DEBUG_PORT_ACCESS, reg, &dummy);
3381                 if (retval == ERROR_OK)
3382                         retval = stlink_read_dap_register(stlink_dap_handle,
3383                                                 STLINK_DEBUG_PORT_ACCESS, DP_RDBUFF, data);
3384         } else {
3385                 retval = stlink_read_dap_register(stlink_dap_handle,
3386                                         STLINK_DEBUG_PORT_ACCESS, reg, data);
3387         }
3388
3389         return stlink_dap_record_error(retval);
3390 }
3391
3392 /** */
3393 static int stlink_dap_op_queue_dp_write(struct adiv5_dap *dap, unsigned reg,
3394                 uint32_t data)
3395 {
3396         int retval;
3397
3398         if (!(stlink_dap_handle->version.flags & STLINK_F_HAS_DPBANKSEL))
3399                 if (reg & 0x000000F0) {
3400                         LOG_ERROR("Banked DP registers not supported in current STLink FW");
3401                         return ERROR_COMMAND_NOTFOUND;
3402                 }
3403
3404         if (reg == DP_SELECT && (data & DP_SELECT_DPBANK) != 0) {
3405                 /* ignored if STLINK_F_HAS_DPBANKSEL, not properly managed otherwise */
3406                 LOG_DEBUG("Ignoring DPBANKSEL while write SELECT");
3407                 data &= ~DP_SELECT_DPBANK;
3408         }
3409
3410         retval = stlink_dap_check_reconnect(dap);
3411         if (retval != ERROR_OK)
3412                 return retval;
3413
3414         /* ST-Link does not like that we set CORUNDETECT */
3415         if (reg == DP_CTRL_STAT)
3416                 data &= ~CORUNDETECT;
3417
3418         retval = stlink_write_dap_register(stlink_dap_handle,
3419                                 STLINK_DEBUG_PORT_ACCESS, reg, data);
3420         return stlink_dap_record_error(retval);
3421 }
3422
3423 /** */
3424 static int stlink_dap_op_queue_ap_read(struct adiv5_ap *ap, unsigned reg,
3425                 uint32_t *data)
3426 {
3427         struct adiv5_dap *dap = ap->dap;
3428         uint32_t dummy;
3429         int retval;
3430
3431         retval = stlink_dap_check_reconnect(dap);
3432         if (retval != ERROR_OK)
3433                 return retval;
3434
3435         if (reg != AP_REG_IDR) {
3436                 retval = stlink_dap_open_ap(ap->ap_num);
3437                 if (retval != ERROR_OK)
3438                         return retval;
3439         }
3440         data = data ? : &dummy;
3441         retval = stlink_read_dap_register(stlink_dap_handle, ap->ap_num, reg,
3442                                  data);
3443         dap->stlink_flush_ap_write = false;
3444         return stlink_dap_record_error(retval);
3445 }
3446
3447 /** */
3448 static int stlink_dap_op_queue_ap_write(struct adiv5_ap *ap, unsigned reg,
3449                 uint32_t data)
3450 {
3451         struct adiv5_dap *dap = ap->dap;
3452         int retval;
3453
3454         retval = stlink_dap_check_reconnect(dap);
3455         if (retval != ERROR_OK)
3456                 return retval;
3457
3458         retval = stlink_dap_open_ap(ap->ap_num);
3459         if (retval != ERROR_OK)
3460                 return retval;
3461
3462         retval = stlink_write_dap_register(stlink_dap_handle, ap->ap_num, reg,
3463                                 data);
3464         dap->stlink_flush_ap_write = true;
3465         return stlink_dap_record_error(retval);
3466 }
3467
3468 /** */
3469 static int stlink_dap_op_queue_ap_abort(struct adiv5_dap *dap, uint8_t *ack)
3470 {
3471         LOG_WARNING("stlink_dap_op_queue_ap_abort()");
3472         return ERROR_OK;
3473 }
3474
3475 /** */
3476 static int stlink_dap_op_run(struct adiv5_dap *dap)
3477 {
3478         uint32_t ctrlstat, pwrmask;
3479         int retval, saved_retval;
3480
3481         /* Here no LOG_DEBUG. This is called continuously! */
3482
3483         /*
3484          * ST-Link returns immediately after a DAP write, without waiting for it
3485          * to complete.
3486          * Run a dummy read to DP_RDBUFF, as suggested in
3487          * http://infocenter.arm.com/help/topic/com.arm.doc.faqs/ka16363.html
3488          */
3489         if (dap->stlink_flush_ap_write) {
3490                 dap->stlink_flush_ap_write = false;
3491                 retval = stlink_dap_op_queue_dp_read(dap, DP_RDBUFF, NULL);
3492                 if (retval != ERROR_OK) {
3493                         dap->do_reconnect = true;
3494                         return retval;
3495                 }
3496         }
3497
3498         saved_retval = stlink_dap_get_and_clear_error();
3499
3500         retval = stlink_dap_op_queue_dp_read(dap, DP_CTRL_STAT, &ctrlstat);
3501         if (retval != ERROR_OK) {
3502                 dap->do_reconnect = true;
3503                 return retval;
3504         }
3505         retval = stlink_dap_get_and_clear_error();
3506         if (retval != ERROR_OK) {
3507                 LOG_ERROR("Fail reading CTRL/STAT register. Force reconnect");
3508                 dap->do_reconnect = true;
3509                 return retval;
3510         }
3511
3512         if (ctrlstat & SSTICKYERR) {
3513                 if (stlink_dap_handle->st_mode == STLINK_MODE_DEBUG_JTAG)
3514                         retval = stlink_dap_op_queue_dp_write(dap, DP_CTRL_STAT,
3515                                         ctrlstat & (dap->dp_ctrl_stat | SSTICKYERR));
3516                 else
3517                         retval = stlink_dap_op_queue_dp_write(dap, DP_ABORT, STKERRCLR);
3518                 if (retval != ERROR_OK) {
3519                         dap->do_reconnect = true;
3520                         return retval;
3521                 }
3522                 retval = stlink_dap_get_and_clear_error();
3523                 if (retval != ERROR_OK) {
3524                         dap->do_reconnect = true;
3525                         return retval;
3526                 }
3527         }
3528
3529         /* check for power lost */
3530         pwrmask = dap->dp_ctrl_stat & (CDBGPWRUPREQ | CSYSPWRUPREQ);
3531         if ((ctrlstat & pwrmask) != pwrmask)
3532                 dap->do_reconnect = true;
3533
3534         return saved_retval;
3535 }
3536
3537 /** */
3538 static void stlink_dap_op_quit(struct adiv5_dap *dap)
3539 {
3540         int retval;
3541
3542         retval = stlink_dap_closeall_ap();
3543         if (retval != ERROR_OK)
3544                 LOG_ERROR("Error closing APs");
3545 }
3546
3547 static int stlink_swim_op_srst(void)
3548 {
3549         return stlink_usb_reset(stlink_dap_handle);
3550 }
3551
3552 static int stlink_swim_op_read_mem(uint32_t addr, uint32_t size,
3553                                                                    uint32_t count, uint8_t *buffer)
3554 {
3555         return stlink_usb_read_mem(stlink_dap_handle, addr, size, count, buffer);
3556 }
3557
3558 static int stlink_swim_op_write_mem(uint32_t addr, uint32_t size,
3559                                                                         uint32_t count, const uint8_t *buffer)
3560 {
3561         return stlink_usb_write_mem(stlink_dap_handle, addr, size, count, buffer);
3562 }
3563
3564 static int stlink_swim_op_reconnect(void)
3565 {
3566         return stlink_usb_state(stlink_dap_handle);
3567 }
3568
3569 static int stlink_dap_config_trace(bool enabled,
3570                 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
3571                 unsigned int *trace_freq, unsigned int traceclkin_freq,
3572                 uint16_t *prescaler)
3573 {
3574         return stlink_config_trace(stlink_dap_handle, enabled, pin_protocol,
3575                                                            port_size, trace_freq, traceclkin_freq,
3576                                                            prescaler);
3577 }
3578
3579 static int stlink_dap_trace_read(uint8_t *buf, size_t *size)
3580 {
3581         return stlink_usb_trace_read(stlink_dap_handle, buf, size);
3582 }
3583
3584 /** */
3585 COMMAND_HANDLER(stlink_dap_serial_command)
3586 {
3587         LOG_DEBUG("stlink_dap_serial_command");
3588
3589         if (CMD_ARGC != 1) {
3590                 LOG_ERROR("Expected exactly one argument for \"st-link serial <serial-number>\".");
3591                 return ERROR_COMMAND_SYNTAX_ERROR;
3592         }
3593
3594         if (stlink_dap_param.serial) {
3595                 LOG_WARNING("Command \"st-link serial\" already used. Replacing previous value");
3596                 free((void *)stlink_dap_param.serial);
3597         }
3598
3599         stlink_dap_param.serial = strdup(CMD_ARGV[0]);
3600         return ERROR_OK;
3601 }
3602
3603 /** */
3604 COMMAND_HANDLER(stlink_dap_vid_pid)
3605 {
3606         unsigned int i, max_usb_ids = HLA_MAX_USB_IDS;
3607
3608         if (CMD_ARGC > max_usb_ids * 2) {
3609                 LOG_WARNING("ignoring extra IDs in vid_pid "
3610                         "(maximum is %d pairs)", max_usb_ids);
3611                 CMD_ARGC = max_usb_ids * 2;
3612         }
3613         if (CMD_ARGC < 2 || (CMD_ARGC & 1)) {
3614                 LOG_WARNING("incomplete vid_pid configuration directive");
3615                 return ERROR_COMMAND_SYNTAX_ERROR;
3616         }
3617         for (i = 0; i < CMD_ARGC; i += 2) {
3618                 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i], stlink_dap_param.vid[i / 2]);
3619                 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], stlink_dap_param.pid[i / 2]);
3620         }
3621
3622         /* null termination */
3623         stlink_dap_param.vid[i / 2] = stlink_dap_param.pid[i / 2] = 0;
3624
3625         return ERROR_OK;
3626 }
3627
3628 /** */
3629 static const struct command_registration stlink_dap_subcommand_handlers[] = {
3630         {
3631                 .name = "serial",
3632                 .handler = stlink_dap_serial_command,
3633                 .mode = COMMAND_CONFIG,
3634                 .help = "set the serial number of the adapter",
3635                 .usage = "<serial_number>",
3636         },
3637         {
3638                 .name = "vid_pid",
3639                 .handler = stlink_dap_vid_pid,
3640                 .mode = COMMAND_CONFIG,
3641                 .help = "USB VID and PID of the adapter",
3642                 .usage = "(vid pid)+",
3643         },
3644         COMMAND_REGISTRATION_DONE
3645 };
3646
3647 /** */
3648 static const struct command_registration stlink_dap_command_handlers[] = {
3649         {
3650                 .name = "st-link",
3651                 .mode = COMMAND_ANY,
3652                 .help = "perform st-link management",
3653                 .chain = stlink_dap_subcommand_handlers,
3654                 .usage = "",
3655         },
3656         COMMAND_REGISTRATION_DONE
3657 };
3658
3659 /** */
3660 static int stlink_dap_init(void)
3661 {
3662         enum reset_types jtag_reset_config = jtag_get_reset_config();
3663         enum stlink_mode mode;
3664         int retval;
3665
3666         LOG_DEBUG("stlink_dap_init()");
3667
3668         if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
3669                 if (jtag_reset_config & RESET_SRST_NO_GATING)
3670                         stlink_dap_param.connect_under_reset = true;
3671                 else
3672                         LOG_WARNING("\'srst_nogate\' reset_config option is required");
3673         }
3674
3675         if (transport_is_dapdirect_swd())
3676                 mode = STLINK_MODE_DEBUG_SWD;
3677         else if (transport_is_dapdirect_jtag())
3678                 mode = STLINK_MODE_DEBUG_JTAG;
3679         else if (transport_is_swim())
3680                 mode = STLINK_MODE_DEBUG_SWIM;
3681         else {
3682                 LOG_ERROR("Unsupported transport");
3683                 return ERROR_FAIL;
3684         }
3685
3686         retval = stlink_usb_open(&stlink_dap_param, mode, (void **)&stlink_dap_handle);
3687         if (retval != ERROR_OK)
3688                 return retval;
3689
3690         if ((mode != STLINK_MODE_DEBUG_SWIM) &&
3691                 !(stlink_dap_handle->version.flags & STLINK_F_HAS_DAP_REG)) {
3692                 LOG_ERROR("ST-Link version does not support DAP direct transport");
3693                 return ERROR_FAIL;
3694         }
3695         return ERROR_OK;
3696 }
3697
3698 /** */
3699 static int stlink_dap_quit(void)
3700 {
3701         LOG_DEBUG("stlink_dap_quit()");
3702
3703         free((void *)stlink_dap_param.serial);
3704         stlink_dap_param.serial = NULL;
3705
3706         return stlink_usb_close(stlink_dap_handle);
3707 }
3708
3709 /** */
3710 static int stlink_dap_reset(int req_trst, int req_srst)
3711 {
3712         LOG_DEBUG("stlink_dap_reset(%d)", req_srst);
3713         return stlink_usb_assert_srst(stlink_dap_handle,
3714                 req_srst ? STLINK_DEBUG_APIV2_DRIVE_NRST_LOW
3715                                  : STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH);
3716 }
3717
3718 /** */
3719 static int stlink_dap_speed(int speed)
3720 {
3721         if (speed == 0) {
3722                 LOG_ERROR("RTCK not supported. Set nonzero adapter_khz.");
3723                 return ERROR_JTAG_NOT_IMPLEMENTED;
3724         }
3725
3726         stlink_dap_param.initial_interface_speed = speed;
3727         stlink_speed(stlink_dap_handle, speed, false);
3728         return ERROR_OK;
3729 }
3730
3731 /** */
3732 static int stlink_dap_khz(int khz, int *jtag_speed)
3733 {
3734         if (khz == 0) {
3735                 LOG_ERROR("RCLK not supported");
3736                 return ERROR_FAIL;
3737         }
3738
3739         *jtag_speed = stlink_speed(stlink_dap_handle, khz, true);
3740         return ERROR_OK;
3741 }
3742
3743 /** */
3744 static int stlink_dap_speed_div(int speed, int *khz)
3745 {
3746         *khz = speed;
3747         return ERROR_OK;
3748 }
3749
3750 static const struct dap_ops stlink_dap_ops = {
3751         .connect = stlink_dap_op_connect,
3752         .send_sequence = stlink_dap_op_send_sequence,
3753         .queue_dp_read = stlink_dap_op_queue_dp_read,
3754         .queue_dp_write = stlink_dap_op_queue_dp_write,
3755         .queue_ap_read = stlink_dap_op_queue_ap_read,
3756         .queue_ap_write = stlink_dap_op_queue_ap_write,
3757         .queue_ap_abort = stlink_dap_op_queue_ap_abort,
3758         .run = stlink_dap_op_run,
3759         .sync = NULL, /* optional */
3760         .quit = stlink_dap_op_quit, /* optional */
3761 };
3762
3763 static const struct swim_driver stlink_swim_ops = {
3764         .srst = stlink_swim_op_srst,
3765         .read_mem = stlink_swim_op_read_mem,
3766         .write_mem = stlink_swim_op_write_mem,
3767         .reconnect = stlink_swim_op_reconnect,
3768 };
3769
3770 static const char *const stlink_dap_transport[] = { "dapdirect_jtag", "dapdirect_swd", "swim", NULL };
3771
3772 struct adapter_driver stlink_dap_adapter_driver = {
3773         .name = "st-link",
3774         .transports = stlink_dap_transport,
3775         .commands = stlink_dap_command_handlers,
3776
3777         .init = stlink_dap_init,
3778         .quit = stlink_dap_quit,
3779         .reset = stlink_dap_reset,
3780         .speed = stlink_dap_speed,
3781         .khz = stlink_dap_khz,
3782         .speed_div = stlink_dap_speed_div,
3783         .config_trace = stlink_dap_config_trace,
3784         .poll_trace = stlink_dap_trace_read,
3785
3786         .dap_jtag_ops = &stlink_dap_ops,
3787         .dap_swd_ops = &stlink_dap_ops,
3788         .swim_ops = &stlink_swim_ops,
3789 };