git.gag.com Git - fw/stlink/blob - src/stlink-usb.c

   1 #include <assert.h>
   2 #include <stdio.h>
   3 #include <stdlib.h>
   4 #include <string.h>
   5 #include <stdint.h>
   6 #include <time.h>
   7 #include <sys/types.h>
   8 #include <libusb-1.0/libusb.h>
   9 #include "stlink-common.h"
  10 #include "stlink-usb.h"
  11
  12 void _stlink_usb_close(stlink_t* sl) {
  13     struct stlink_libusb * const handle = sl->backend_data;
  14     // maybe we couldn't even get the usb device?
  15     if (handle != NULL) {
  16         if (handle->req_trans != NULL)
  17             libusb_free_transfer(handle->req_trans);
  18
  19         if (handle->rep_trans != NULL)
  20             libusb_free_transfer(handle->rep_trans);
  21
  22         if (handle->usb_handle != NULL)
  23             libusb_close(handle->usb_handle);
  24
  25         libusb_exit(handle->libusb_ctx);
  26         free(handle);
  27     }
  28 }
  29
  30
  31 struct trans_ctx {
  32 #define TRANS_FLAGS_IS_DONE (1 << 0)
  33 #define TRANS_FLAGS_HAS_ERROR (1 << 1)
  34     volatile unsigned long flags;
  35 };
  36
  37 static void on_trans_done(struct libusb_transfer * trans) {
  38     struct trans_ctx * const ctx = trans->user_data;
  39
  40     if (trans->status != LIBUSB_TRANSFER_COMPLETED)
  41         ctx->flags |= TRANS_FLAGS_HAS_ERROR;
  42
  43     ctx->flags |= TRANS_FLAGS_IS_DONE;
  44 }
  45
  46 int submit_wait(struct stlink_libusb *slu, struct libusb_transfer * trans) {
  47     struct timeval start;
  48     struct timeval now;
  49     struct timeval diff;
  50     struct trans_ctx trans_ctx;
  51     enum libusb_error error;
  52
  53     trans_ctx.flags = 0;
  54
  55     /* brief intrusion inside the libusb interface */
  56     trans->callback = on_trans_done;
  57     trans->user_data = &trans_ctx;
  58
  59     if ((error = libusb_submit_transfer(trans))) {
  60         printf("libusb_submit_transfer(%d)\n", error);
  61         return -1;
  62     }
  63
  64     gettimeofday(&start, NULL);
  65
  66     while (trans_ctx.flags == 0) {
  67         struct timeval timeout;
  68         timeout.tv_sec = 3;
  69         timeout.tv_usec = 0;
  70         if (libusb_handle_events_timeout(slu->libusb_ctx, &timeout)) {
  71             printf("libusb_handle_events()\n");
  72             return -1;
  73         }
  74
  75         gettimeofday(&now, NULL);
  76         timersub(&now, &start, &diff);
  77         if (diff.tv_sec >= 3) {
  78             printf("libusb_handle_events() timeout\n");
  79             return -1;
  80         }
  81     }
  82
  83     if (trans_ctx.flags & TRANS_FLAGS_HAS_ERROR) {
  84         printf("libusb_handle_events() | has_error\n");
  85         return -1;
  86     }
  87
  88     return 0;
  89 }
  90
  91 ssize_t send_recv(struct stlink_libusb* handle,
  92         unsigned char* txbuf, size_t txsize,
  93         unsigned char* rxbuf, size_t rxsize) {
  94     /* note: txbuf and rxbuf can point to the same area */
  95
  96     libusb_fill_bulk_transfer(handle->req_trans, handle->usb_handle,
  97             handle->ep_req,
  98             txbuf, txsize,
  99             NULL, NULL,
 100             0
 101             );
 102
 103     printf("submit_wait(req)\n");
 104
 105     if (submit_wait(handle, handle->req_trans)) return -1;
 106
 107     /* send_only */
 108     if (rxsize == 0) return 0;
 109
 110     /* read the response */
 111
 112     libusb_fill_bulk_transfer(handle->rep_trans, handle->usb_handle,
 113             handle->ep_rep, rxbuf, rxsize, NULL, NULL, 0);
 114
 115     printf("submit_wait(rep)\n");
 116
 117     if (submit_wait(handle, handle->rep_trans)) return -1;
 118
 119     return handle->rep_trans->actual_length;
 120 }
 121
 122 static inline int send_only
 123 (struct stlink_libusb* handle, unsigned char* txbuf, size_t txsize) {
 124     return send_recv(handle, txbuf, txsize, NULL, 0);
 125 }
 126
 127
 128 // KARL - fixme, common code! (or, one per backend)
 129 // candidate for common code...
 130
 131
 132 static int is_stlink_device(libusb_device * dev) {
 133     struct libusb_device_descriptor desc;
 134
 135     if (libusb_get_device_descriptor(dev, &desc))
 136         return 0;
 137
 138     printf("device: 0x%04x, 0x%04x\n", desc.idVendor, desc.idProduct);
 139
 140     if (desc.idVendor != USB_ST_VID)
 141         return 0;
 142
 143     if (desc.idProduct != USB_STLINK_32L_PID)
 144         return 0;
 145
 146     return 1;
 147 }
 148
 149 void _stlink_usb_version(stlink_t *sl) {
 150     struct stlink_libusb * const slu = sl->backend_data;
 151     unsigned char* const buf = sl->q_buf;
 152     ssize_t size;
 153
 154     memset(buf, 0, sizeof (sl->q_buf));
 155     buf[0] = STLINK_GET_VERSION;
 156     buf[1] = 0x80;
 157
 158     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 6);
 159     if (size == -1) {
 160         printf("[!] send_recv\n");
 161         return;
 162     }
 163
 164 #if 1 /* DEBUG */
 165     {
 166         ssize_t i;
 167         for (i = 0; i < size; ++i) printf("%02x", buf[i]);
 168         printf("\n");
 169     }
 170 #endif /* DEBUG */
 171 }
 172
 173 void _stlink_usb_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 174     struct stlink_libusb * const slu = sl->backend_data;
 175     unsigned char* const buf = sl->q_buf;
 176     unsigned char *cmd_buf = sl->c_buf;
 177
 178     memset(cmd_buf, 0, STLINK_CMD_SIZE);
 179     cmd_buf[0] = STLINK_DEBUG_COMMAND;
 180     cmd_buf[1] =  STLINK_DEBUG_WRITEMEM_32BIT;
 181     write_uint32(cmd_buf + 2, addr);
 182     write_uint16(cmd_buf + 6, len);
 183     send_only(slu, cmd_buf, STLINK_CMD_SIZE);
 184
 185 #if Q_BUF_LEN < UINT16_MAX
 186     assert(len < sizeof(sl->q_buf));  // makes a compiler warning? always true?
 187 #endif
 188     assert((len & 3) == 0);
 189     send_only(slu, buf, len);
 190
 191 }
 192
 193 void _stlink_usb_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len) {
 194     struct stlink_libusb * const slu = sl->backend_data;
 195     unsigned char* const buf = sl->q_buf;
 196     unsigned char *cmd_buf = sl->c_buf;
 197
 198     memset(cmd_buf, 0, STLINK_CMD_SIZE);
 199     cmd_buf[0] = STLINK_DEBUG_COMMAND;
 200     cmd_buf[1] =  STLINK_DEBUG_WRITEMEM_8BIT;
 201     write_uint32(cmd_buf + 2, addr);
 202     write_uint16(cmd_buf + 6, len);
 203     send_only(slu, cmd_buf, STLINK_CMD_SIZE);
 204
 205 #if Q_BUF_LEN < UINT16_MAX
 206     assert(len < sizeof(sl->q_buf));  // makes a compiler warning? always true?
 207 #endif
 208     send_only(slu, buf, len);
 209 }
 210
 211
 212 int _stlink_usb_current_mode(stlink_t * sl) {
 213     struct stlink_libusb * const slu = sl->backend_data;
 214     unsigned char* const buf = sl->q_buf;
 215     ssize_t size;
 216     memset(buf, 0, sizeof (sl->q_buf));
 217     buf[0] = STLINK_GET_CURRENT_MODE;
 218     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 2);
 219     if (size == -1) {
 220         printf("[!] send_recv\n");
 221         return -1;
 222     }
 223     return sl->q_buf[0];
 224 }
 225
 226 void _stlink_usb_core_id(stlink_t * sl) {
 227     struct stlink_libusb * const slu = sl->backend_data;
 228     unsigned char* const buf = sl->q_buf;
 229     ssize_t size;
 230
 231     memset(buf, 0, sizeof (sl->q_buf));
 232     buf[0] = STLINK_DEBUG_COMMAND;
 233     buf[1] = STLINK_DEBUG_READCOREID;
 234
 235     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 4);
 236     if (size == -1) {
 237         printf("[!] send_recv\n");
 238         return;
 239     }
 240
 241     sl->core_id = read_uint32(buf, 0);
 242 }
 243
 244 void _stlink_usb_status(stlink_t * sl) {
 245     struct stlink_libusb * const slu = sl->backend_data;
 246     unsigned char* const buf = sl->q_buf;
 247     ssize_t size;
 248
 249     memset(buf, 0, sizeof (sl->q_buf));
 250
 251     buf[0] = STLINK_DEBUG_COMMAND;
 252     buf[1] = STLINK_DEBUG_GETSTATUS;
 253
 254     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 2);
 255     if (size == -1) {
 256         printf("[!] send_recv\n");
 257         return;
 258     }
 259
 260     /* todo: stlink_core_stat */
 261
 262     // FIXME - decode into sl->core_stat
 263 #if 1 /* DEBUG */
 264     printf("status == 0x%x\n", buf[0]);
 265 #endif /* DEBUG */
 266
 267 }
 268
 269 void _stlink_usb_force_debug(stlink_t *sl) {
 270     struct stlink_libusb *slu = sl->backend_data;
 271     unsigned char* const buf = sl->q_buf;
 272     ssize_t size;
 273
 274     memset(buf, 0, sizeof (sl->q_buf));
 275
 276     buf[0] = STLINK_DEBUG_COMMAND;
 277     buf[1] = STLINK_DEBUG_FORCEDEBUG;
 278     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 2);
 279     if (size == -1) {
 280         printf("[!] send_recv\n");
 281         return;
 282     }
 283 }
 284
 285
 286 void _stlink_usb_enter_swd_mode(stlink_t * sl) {
 287     struct stlink_libusb * const slu = sl->backend_data;
 288     unsigned char* const buf = sl->q_buf;
 289     ssize_t size;
 290
 291     memset(buf, 0, sizeof (sl->q_buf));
 292
 293     buf[0] = STLINK_DEBUG_COMMAND;
 294     buf[1] = STLINK_SWD_ENTER;
 295     buf[2] = STLINK_DEBUG_ENTER_SWD;
 296
 297     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 2);
 298     if (size == -1) {
 299         printf("[!] send_recv\n");
 300         return;
 301     }
 302 }
 303
 304 void _stlink_usb_exit_dfu_mode(stlink_t* sl) {
 305     struct stlink_libusb * const slu = sl->backend_data;
 306     unsigned char* const buf = sl->q_buf;
 307     ssize_t size;
 308
 309     memset(buf, 0, sizeof (sl->q_buf));
 310     buf[0] = STLINK_DFU_COMMAND;
 311     buf[1] = STLINK_DFU_EXIT;
 312
 313     size = send_only(slu, buf, 16);
 314     if (size == -1) {
 315         printf("[!] send_recv\n");
 316         return;
 317     }
 318 }
 319
 320 /**
 321  * TODO - not convinced this does anything...
 322  * @param sl
 323  */
 324 void _stlink_usb_reset(stlink_t * sl) {
 325     struct stlink_libusb * const slu = sl->backend_data;
 326     unsigned char* const buf = sl->q_buf;
 327     ssize_t size;
 328
 329     memset(buf, 0, sizeof (sl->q_buf));
 330     buf[0] = STLINK_DEBUG_COMMAND;
 331     buf[1] = STLINK_DEBUG_RESETSYS;
 332
 333     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, sizeof (sl->q_buf));
 334     if (size == -1) {
 335         printf("[!] send_recv\n");
 336         return;
 337     }
 338 }
 339
 340
 341 void _stlink_usb_step(stlink_t* sl) {
 342     struct stlink_libusb * const slu = sl->backend_data;
 343     unsigned char* const buf = sl->q_buf;
 344     ssize_t size;
 345
 346     memset(buf, 0, sizeof (sl->q_buf));
 347     buf[0] = STLINK_DEBUG_COMMAND;
 348     buf[1] = STLINK_DEBUG_STEPCORE;
 349
 350     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 2);
 351     if (size == -1) {
 352         printf("[!] send_recv\n");
 353         return;
 354     }
 355 }
 356
 357 /**
 358  * This seems to do a good job of restarting things from the beginning?
 359  * @param sl
 360  */
 361 void _stlink_usb_run(stlink_t* sl) {
 362     struct stlink_libusb * const slu = sl->backend_data;
 363     unsigned char* const buf = sl->q_buf;
 364     ssize_t size;
 365
 366     memset(buf, 0, sizeof (sl->q_buf));
 367     buf[0] = STLINK_DEBUG_COMMAND;
 368     buf[1] = STLINK_DEBUG_RUNCORE;
 369
 370     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, 2);
 371     if (size == -1) {
 372         printf("[!] send_recv\n");
 373         return;
 374     }
 375
 376 }
 377
 378 void _stlink_usb_exit_debug_mode(stlink_t *sl) {
 379     struct stlink_libusb * const slu = sl->backend_data;
 380     unsigned char* const buf = sl->q_buf;
 381     ssize_t size;
 382
 383     memset(buf, 0, sizeof (sl->q_buf));
 384     buf[0] = STLINK_DEBUG_COMMAND;
 385     buf[1] = STLINK_DEBUG_EXIT;
 386
 387     size = send_only(slu, buf, 16);
 388     if (size == -1) {
 389         printf("[!] send_only\n");
 390         return;
 391     }
 392 }
 393
 394 void _stlink_usb_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 395     struct stlink_libusb * const slu = sl->backend_data;
 396     unsigned char* const buf = sl->q_buf;
 397     ssize_t size;
 398
 399 #if Q_BUF_LEN < UINT16_MAX
 400     assert(len < sizeof(sl->q_buf));
 401 #endif
 402
 403     memset(buf, 0, sizeof (sl->q_buf));
 404     buf[0] = STLINK_DEBUG_COMMAND;
 405     buf[1] = STLINK_DEBUG_READMEM_32BIT;
 406     write_uint32(buf + 2, addr);
 407     /* windows usb logs show only one byte is used for length ... */
 408     // Presumably, this is because usb transfers can't be 16 bits worth of bytes long...
 409     assert (len < 256);
 410     buf[6] = (uint8_t) len;
 411
 412     size = send_recv(slu, buf, STLINK_CMD_SIZE, buf, len);
 413     if (size == -1) {
 414         printf("[!] send_recv\n");
 415         return;
 416     }
 417
 418     sl->q_len = (size_t) size;
 419
 420     stlink_print_data(sl);
 421 }
 422
 423 void _stlink_usb_read_all_regs(stlink_t *sl, reg *regp) {
 424     struct stlink_libusb * const slu = sl->backend_data;
 425     unsigned char* const buf = sl->q_buf;
 426     unsigned char* const cmd_buf = sl->c_buf;
 427     ssize_t size;
 428     int i;
 429
 430     memset(cmd_buf, 0, STLINK_CMD_SIZE);
 431     cmd_buf[0] = STLINK_DEBUG_COMMAND;
 432     cmd_buf[1] = STLINK_DEBUG_READALLREGS;
 433     size = send_recv(slu, cmd_buf, STLINK_CMD_SIZE, buf, 84);
 434     if (size == -1) {
 435         printf("[!] send_recv\n");
 436         return;
 437     }
 438     sl->q_len = (size_t) size;
 439     stlink_print_data(sl);
 440     for(i=0; i<16; i++)
 441         regp->r[i]= read_uint32(sl->q_buf, i*4);
 442     regp->xpsr       = read_uint32(sl->q_buf, 64);
 443     regp->main_sp    = read_uint32(sl->q_buf, 68);
 444     regp->process_sp = read_uint32(sl->q_buf, 72);
 445     regp->rw         = read_uint32(sl->q_buf, 76);
 446     regp->rw2        = read_uint32(sl->q_buf, 80);
 447     if (sl->verbose < 2)
 448         return;
 449
 450     DD(sl, "xpsr       = 0x%08x\n", read_uint32(sl->q_buf, 64));
 451     DD(sl, "main_sp    = 0x%08x\n", read_uint32(sl->q_buf, 68));
 452     DD(sl, "process_sp = 0x%08x\n", read_uint32(sl->q_buf, 72));
 453     DD(sl, "rw         = 0x%08x\n", read_uint32(sl->q_buf, 76));
 454     DD(sl, "rw2        = 0x%08x\n", read_uint32(sl->q_buf, 80));
 455 }
 456
 457 void _stlink_usb_read_reg(stlink_t *sl, int r_idx, reg *regp) {
 458     struct stlink_libusb * const slu = sl->backend_data;
 459     unsigned char* const buf = sl->q_buf;
 460     unsigned char* const cmd_buf = sl->c_buf;
 461     ssize_t size;
 462     uint32_t r;
 463
 464     memset(cmd_buf, 0, STLINK_CMD_SIZE);
 465     cmd_buf[0] = STLINK_DEBUG_COMMAND;
 466     cmd_buf[1] = STLINK_DEBUG_READREG;
 467     cmd_buf[2] = (uint8_t) r_idx;
 468     size = send_recv(slu, cmd_buf, STLINK_CMD_SIZE, buf, 4);
 469     if (size == -1) {
 470         printf("[!] send_recv\n");
 471         return;
 472     }
 473     sl->q_len = (size_t) size;
 474     stlink_print_data(sl);
 475     r = read_uint32(sl->q_buf, 0);
 476     DD(sl, "r_idx (%2d) = 0x%08x\n", r_idx, r);
 477
 478     switch (r_idx) {
 479     case 16:
 480         regp->xpsr = r;
 481         break;
 482     case 17:
 483         regp->main_sp = r;
 484         break;
 485     case 18:
 486         regp->process_sp = r;
 487         break;
 488     case 19:
 489         regp->rw = r; //XXX ?(primask, basemask etc.)
 490         break;
 491     case 20:
 492         regp->rw2 = r; //XXX ?(primask, basemask etc.)
 493         break;
 494     default:
 495         regp->r[r_idx] = r;
 496     }
 497 }
 498
 499 void _stlink_usb_write_reg(stlink_t *sl, uint32_t reg, int idx) {
 500     struct stlink_libusb * const slu = sl->backend_data;
 501     unsigned char* const buf = sl->q_buf;
 502     unsigned char *cmd_buf = sl->c_buf;
 503     ssize_t size;
 504
 505     memset(cmd_buf, 0, STLINK_CMD_SIZE);
 506     cmd_buf[0] = STLINK_DEBUG_COMMAND;
 507     cmd_buf[1] = STLINK_DEBUG_WRITEREG;
 508     cmd_buf[2] = idx;
 509     write_uint32(cmd_buf + 3, reg);
 510     size = send_recv(slu, cmd_buf, STLINK_CMD_SIZE, buf, 2);
 511     if (size == -1) {
 512         printf("[!] send_recv\n");
 513         return;
 514     }
 515     sl->q_len = (size_t) size;
 516     stlink_print_data(sl);
 517 }
 518
 519 stlink_backend_t _stlink_usb_backend = {
 520     _stlink_usb_close,
 521     _stlink_usb_exit_debug_mode,
 522     _stlink_usb_enter_swd_mode,
 523     NULL,  // no enter_jtag_mode here...
 524     _stlink_usb_exit_dfu_mode,
 525     _stlink_usb_core_id,
 526     _stlink_usb_reset,
 527     _stlink_usb_run,
 528     _stlink_usb_status,
 529     _stlink_usb_version,
 530     _stlink_usb_read_mem32,
 531     _stlink_usb_write_mem32,
 532     _stlink_usb_write_mem8,
 533     _stlink_usb_read_all_regs,
 534     _stlink_usb_read_reg,
 535     _stlink_usb_write_reg,
 536     _stlink_usb_step,
 537     _stlink_usb_current_mode,
 538     _stlink_usb_force_debug
 539 };
 540
 541
 542 stlink_t* stlink_open_usb(const char *dev_name, const int verbose) {
 543     stlink_t* sl = NULL;
 544     struct stlink_libusb* slu = NULL;
 545
 546     sl = malloc(sizeof (stlink_t));
 547     slu = malloc(sizeof (struct stlink_libusb));
 548     if (sl == NULL) goto on_error;
 549     if (slu == NULL) goto on_error;
 550
 551     sl->verbose = verbose;
 552
 553     if (slu->libusb_ctx != NULL) {
 554         fprintf(stderr, "reopening with an existing context? undefined behaviour!\n");
 555         goto on_error;
 556     } else {
 557         if (libusb_init(&(slu->libusb_ctx))) {
 558             fprintf(stderr, "failed to init libusb context, wrong version of libraries?\n");
 559             goto on_error;
 560         }
 561     }
 562
 563     int error = -1;
 564
 565     libusb_device** devs = NULL;
 566     libusb_device* dev;
 567     ssize_t i;
 568     ssize_t count;
 569     int config;
 570
 571     count = libusb_get_device_list(slu->libusb_ctx, &devs);
 572     if (count < 0) {
 573         printf("libusb_get_device_list\n");
 574         goto on_libusb_error;
 575     }
 576
 577     for (i = 0; i < count; ++i) {
 578         dev = devs[i];
 579         if (is_stlink_device(dev)) break;
 580     }
 581     if (i == count) return NULL;
 582
 583     if (libusb_open(dev, &(slu->usb_handle))) {
 584         printf("libusb_open()\n");
 585         goto on_libusb_error;
 586     }
 587
 588     if (libusb_get_configuration(slu->usb_handle, &config)) {
 589         /* this may fail for a previous configured device */
 590         printf("libusb_get_configuration()\n");
 591         goto on_libusb_error;
 592     }
 593
 594     if (config != 1) {
 595         printf("setting new configuration (%d -> 1)\n", config);
 596         if (libusb_set_configuration(slu->usb_handle, 1)) {
 597             /* this may fail for a previous configured device */
 598             printf("libusb_set_configuration()\n");
 599             goto on_libusb_error;
 600         }
 601     }
 602
 603     if (libusb_claim_interface(slu->usb_handle, 0)) {
 604         printf("libusb_claim_interface()\n");
 605         goto on_libusb_error;
 606     }
 607
 608     slu->req_trans = libusb_alloc_transfer(0);
 609     if (slu->req_trans == NULL) {
 610         printf("libusb_alloc_transfer\n");
 611         goto on_libusb_error;
 612     }
 613
 614     slu->rep_trans = libusb_alloc_transfer(0);
 615     if (slu->rep_trans == NULL) {
 616         printf("libusb_alloc_transfer\n");
 617         goto on_libusb_error;
 618     }
 619
 620     slu->ep_rep = 1 /* ep rep */ | LIBUSB_ENDPOINT_IN;
 621     slu->ep_req = 2 /* ep req */ | LIBUSB_ENDPOINT_OUT;
 622
 623     /* libusb_reset_device(slu->usb_handle); */
 624
 625     /* success */
 626     error = 0;
 627
 628 on_libusb_error:
 629     if (devs != NULL) {
 630         libusb_free_device_list(devs, 1);
 631         fprintf(stderr, "freed libusb device list\n");
 632     }
 633
 634     if (error == -1) {
 635         stlink_close(sl);
 636         return NULL;
 637     }
 638
 639     sl->backend = &_stlink_usb_backend;
 640     sl->backend_data = slu;
 641     /* success */
 642     return sl;
 643
 644 on_error:
 645     if (sl != NULL) free(sl);
 646     if (slu != NULL) free(slu);
 647     return 0;
 648 }
 649