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

   1
   2
   3 #include <stdarg.h>
   4 #include <stdio.h>
   5 #include <stdlib.h>
   6 #include <string.h>
   7
   8 #include <unistd.h>
   9 #include <fcntl.h>
  10 #include <sys/types.h>
  11 #include <sys/stat.h>
  12 #include <sys/mman.h>
  13
  14
  15 #include "stlink-common.h"
  16
  17 void D(stlink_t *sl, char *txt) {
  18     if (sl->verbose > 1)
  19         fputs(txt, stderr);
  20 }
  21
  22 void DD(stlink_t *sl, char *format, ...) {
  23     if (sl->verbose > 0) {
  24         va_list list;
  25         va_start(list, format);
  26         vfprintf(stderr, format, list);
  27         va_end(list);
  28     }
  29 }
  30
  31
  32
  33 /* FPEC flash controller interface, pm0063 manual
  34  */
  35
  36 #define FLASH_REGS_ADDR 0x40022000
  37 #define FLASH_REGS_SIZE 0x28
  38
  39 #define FLASH_ACR (FLASH_REGS_ADDR + 0x00)
  40 #define FLASH_KEYR (FLASH_REGS_ADDR + 0x04)
  41 #define FLASH_SR (FLASH_REGS_ADDR + 0x0c)
  42 #define FLASH_CR (FLASH_REGS_ADDR + 0x10)
  43 #define FLASH_AR (FLASH_REGS_ADDR + 0x14)
  44 #define FLASH_OBR (FLASH_REGS_ADDR + 0x1c)
  45 #define FLASH_WRPR (FLASH_REGS_ADDR + 0x20)
  46
  47 #define FLASH_RDPTR_KEY 0x00a5
  48 #define FLASH_KEY1 0x45670123
  49 #define FLASH_KEY2 0xcdef89ab
  50
  51 #define FLASH_SR_BSY 0
  52 #define FLASH_SR_EOP 5
  53
  54 #define FLASH_CR_PG 0
  55 #define FLASH_CR_PER 1
  56 #define FLASH_CR_MER 2
  57 #define FLASH_CR_STRT 6
  58 #define FLASH_CR_LOCK 7
  59
  60 void write_uint32(unsigned char* buf, uint32_t ui) {
  61     if (!is_bigendian()) { // le -> le (don't swap)
  62         buf[0] = ((unsigned char*) &ui)[0];
  63         buf[1] = ((unsigned char*) &ui)[1];
  64         buf[2] = ((unsigned char*) &ui)[2];
  65         buf[3] = ((unsigned char*) &ui)[3];
  66     } else {
  67         buf[0] = ((unsigned char*) &ui)[3];
  68         buf[1] = ((unsigned char*) &ui)[2];
  69         buf[2] = ((unsigned char*) &ui)[1];
  70         buf[3] = ((unsigned char*) &ui)[0];
  71     }
  72 }
  73
  74 void write_uint16(unsigned char* buf, uint16_t ui) {
  75     if (!is_bigendian()) { // le -> le (don't swap)
  76         buf[0] = ((unsigned char*) &ui)[0];
  77         buf[1] = ((unsigned char*) &ui)[1];
  78     } else {
  79         buf[0] = ((unsigned char*) &ui)[1];
  80         buf[1] = ((unsigned char*) &ui)[0];
  81     }
  82 }
  83
  84 uint32_t read_uint32(const unsigned char *c, const int pt) {
  85     uint32_t ui;
  86     char *p = (char *) &ui;
  87
  88     if (!is_bigendian()) { // le -> le (don't swap)
  89         p[0] = c[pt];
  90         p[1] = c[pt + 1];
  91         p[2] = c[pt + 2];
  92         p[3] = c[pt + 3];
  93     } else {
  94         p[0] = c[pt + 3];
  95         p[1] = c[pt + 2];
  96         p[2] = c[pt + 1];
  97         p[3] = c[pt];
  98     }
  99     return ui;
 100 }
 101
 102 static uint32_t __attribute__((unused)) read_flash_rdp(stlink_t *sl) {
 103     stlink_read_mem32(sl, FLASH_WRPR, sizeof (uint32_t));
 104     return (*(uint32_t*) sl->q_buf) & 0xff;
 105 }
 106
 107 static inline uint32_t read_flash_wrpr(stlink_t *sl) {
 108     stlink_read_mem32(sl, FLASH_WRPR, sizeof (uint32_t));
 109     return *(uint32_t*) sl->q_buf;
 110 }
 111
 112 static inline uint32_t read_flash_obr(stlink_t *sl) {
 113     stlink_read_mem32(sl, FLASH_OBR, sizeof (uint32_t));
 114     return *(uint32_t*) sl->q_buf;
 115 }
 116
 117 static inline uint32_t read_flash_cr(stlink_t *sl) {
 118     stlink_read_mem32(sl, FLASH_CR, sizeof (uint32_t));
 119     return *(uint32_t*) sl->q_buf;
 120 }
 121
 122 static inline unsigned int is_flash_locked(stlink_t *sl) {
 123     /* return non zero for true */
 124     return read_flash_cr(sl) & (1 << FLASH_CR_LOCK);
 125 }
 126
 127 static void unlock_flash(stlink_t *sl) {
 128     /* the unlock sequence consists of 2 write cycles where
 129        2 key values are written to the FLASH_KEYR register.
 130        an invalid sequence results in a definitive lock of
 131        the FPEC block until next reset.
 132      */
 133
 134     write_uint32(sl->q_buf, FLASH_KEY1);
 135     stlink_write_mem32(sl, FLASH_KEYR, sizeof (uint32_t));
 136
 137     write_uint32(sl->q_buf, FLASH_KEY2);
 138     stlink_write_mem32(sl, FLASH_KEYR, sizeof (uint32_t));
 139 }
 140
 141 static int unlock_flash_if(stlink_t *sl) {
 142     /* unlock flash if already locked */
 143
 144     if (is_flash_locked(sl)) {
 145         unlock_flash(sl);
 146         if (is_flash_locked(sl))
 147             return -1;
 148     }
 149
 150     return 0;
 151 }
 152
 153 static void lock_flash(stlink_t *sl) {
 154     /* write to 1 only. reset by hw at unlock sequence */
 155
 156     const uint32_t n = read_flash_cr(sl) | (1 << FLASH_CR_LOCK);
 157
 158     write_uint32(sl->q_buf, n);
 159     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 160 }
 161
 162 static void set_flash_cr_pg(stlink_t *sl) {
 163     const uint32_t n = 1 << FLASH_CR_PG;
 164     write_uint32(sl->q_buf, n);
 165     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 166 }
 167
 168 static void __attribute__((unused)) clear_flash_cr_pg(stlink_t *sl) {
 169     const uint32_t n = read_flash_cr(sl) & ~(1 << FLASH_CR_PG);
 170     write_uint32(sl->q_buf, n);
 171     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 172 }
 173
 174 static void set_flash_cr_per(stlink_t *sl) {
 175     const uint32_t n = 1 << FLASH_CR_PER;
 176     write_uint32(sl->q_buf, n);
 177     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 178 }
 179
 180 static void __attribute__((unused)) clear_flash_cr_per(stlink_t *sl) {
 181     const uint32_t n = read_flash_cr(sl) & ~(1 << FLASH_CR_PER);
 182     write_uint32(sl->q_buf, n);
 183     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 184 }
 185
 186 static void set_flash_cr_mer(stlink_t *sl) {
 187     const uint32_t n = 1 << FLASH_CR_MER;
 188     write_uint32(sl->q_buf, n);
 189     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 190 }
 191
 192 static void __attribute__((unused)) clear_flash_cr_mer(stlink_t *sl) {
 193     const uint32_t n = read_flash_cr(sl) & ~(1 << FLASH_CR_MER);
 194     write_uint32(sl->q_buf, n);
 195     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 196 }
 197
 198 static void set_flash_cr_strt(stlink_t *sl) {
 199     /* assume come on the flash_cr_per path */
 200     const uint32_t n = (1 << FLASH_CR_PER) | (1 << FLASH_CR_STRT);
 201     write_uint32(sl->q_buf, n);
 202     stlink_write_mem32(sl, FLASH_CR, sizeof (uint32_t));
 203 }
 204
 205 static inline uint32_t read_flash_acr(stlink_t *sl) {
 206     stlink_read_mem32(sl, FLASH_ACR, sizeof (uint32_t));
 207     return *(uint32_t*) sl->q_buf;
 208 }
 209
 210 static inline uint32_t read_flash_sr(stlink_t *sl) {
 211     stlink_read_mem32(sl, FLASH_SR, sizeof (uint32_t));
 212     return *(uint32_t*) sl->q_buf;
 213 }
 214
 215 static inline unsigned int is_flash_busy(stlink_t *sl) {
 216     return read_flash_sr(sl) & (1 << FLASH_SR_BSY);
 217 }
 218
 219 static void wait_flash_busy(stlink_t *sl) {
 220     /* todo: add some delays here */
 221     while (is_flash_busy(sl))
 222         ;
 223 }
 224
 225 static inline unsigned int is_flash_eop(stlink_t *sl) {
 226     return read_flash_sr(sl) & (1 << FLASH_SR_EOP);
 227 }
 228
 229 static void __attribute__((unused)) clear_flash_sr_eop(stlink_t *sl) {
 230     const uint32_t n = read_flash_sr(sl) & ~(1 << FLASH_SR_EOP);
 231     write_uint32(sl->q_buf, n);
 232     stlink_write_mem32(sl, FLASH_SR, sizeof (uint32_t));
 233 }
 234
 235 static void __attribute__((unused)) wait_flash_eop(stlink_t *sl) {
 236     /* todo: add some delays here */
 237     while (is_flash_eop(sl) == 0)
 238         ;
 239 }
 240
 241 static inline void write_flash_ar(stlink_t *sl, uint32_t n) {
 242     write_uint32(sl->q_buf, n);
 243     stlink_write_mem32(sl, FLASH_AR, sizeof (uint32_t));
 244 }
 245
 246 #if 0 /* todo */
 247
 248 static void disable_flash_read_protection(stlink_t *sl) {
 249     /* erase the option byte area */
 250     /* rdp = 0x00a5; */
 251     /* reset */
 252 }
 253 #endif /* todo */
 254
 255
 256 // Delegates to the backends...
 257
 258 void stlink_close(stlink_t *sl) {
 259     D(sl, "\n*** stlink_close ***\n");
 260     sl->backend->close(sl);
 261
 262     free(sl);
 263 }
 264
 265 void stlink_exit_debug_mode(stlink_t *sl) {
 266     D(sl, "\n*** stlink_exit_debug_mode ***\n");
 267     sl->backend->exit_debug_mode(sl);
 268 }
 269
 270 void stlink_enter_swd_mode(stlink_t *sl) {
 271     D(sl, "\n*** stlink_enter_swd_mode ***\n");
 272     sl->backend->enter_swd_mode(sl);
 273 }
 274
 275 // Force the core into the debug mode -> halted state.
 276 void stlink_force_debug(stlink_t *sl) {
 277     D(sl, "\n*** stlink_force_debug_mode ***\n");
 278     sl->backend->force_debug(sl);
 279 }
 280
 281 void stlink_exit_dfu_mode(stlink_t *sl) {
 282     D(sl, "\n*** stlink_exit_dfu_mode ***\n");
 283     sl->backend->exit_dfu_mode(sl);
 284 }
 285
 286 uint32_t stlink_core_id(stlink_t *sl) {
 287     D(sl, "\n*** stlink_core_id ***\n");
 288     sl->backend->core_id(sl);
 289     if (sl->verbose > 2)
 290         stlink_print_data(sl);
 291     DD(sl, "core_id = 0x%08x\n", sl->core_id);
 292     return sl->core_id;
 293 }
 294
 295 uint16_t stlink_chip_id(stlink_t *sl) {
 296     stlink_read_mem32(sl, 0xE0042000, 4);
 297     uint32_t chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
 298             (sl->q_buf[3] << 24);
 299     return chip_id;
 300 }
 301
 302 void stlink_reset(stlink_t *sl) {
 303     D(sl, "\n*** stlink_reset ***\n");
 304     sl->backend->reset(sl);
 305
 306 }
 307
 308 void stlink_run(stlink_t *sl) {
 309     D(sl, "\n*** stlink_run ***\n");
 310     sl->backend->run(sl);
 311 }
 312
 313 void stlink_status(stlink_t *sl) {
 314     D(sl, "\n*** stlink_status ***\n");
 315     sl->backend->status(sl);
 316     stlink_core_stat(sl);
 317 }
 318
 319 /**
 320  * Decode the version bits, originally from -sg, verified with usb
 321  * @param sl stlink context, assumed to contain valid data in the buffer
 322  * @param slv output parsed version object
 323  */
 324 void _parse_version(stlink_t *sl, stlink_version_t *slv) {
 325     uint32_t b0 = sl->q_buf[0]; //lsb
 326     uint32_t b1 = sl->q_buf[1];
 327     uint32_t b2 = sl->q_buf[2];
 328     uint32_t b3 = sl->q_buf[3];
 329     uint32_t b4 = sl->q_buf[4];
 330     uint32_t b5 = sl->q_buf[5]; //msb
 331
 332     // b0 b1                       || b2 b3  | b4 b5
 333     // 4b        | 6b     | 6b     || 2B     | 2B
 334     // stlink_v  | jtag_v | swim_v || st_vid | stlink_pid
 335
 336     slv->stlink_v = (b0 & 0xf0) >> 4;
 337     slv->jtag_v = ((b0 & 0x0f) << 2) | ((b1 & 0xc0) >> 6);
 338     slv->swim_v = b1 & 0x3f;
 339     slv->st_vid = (b3 << 8) | b2;
 340     slv->stlink_pid = (b5 << 8) | b4;
 341     return;
 342 }
 343
 344 void stlink_version(stlink_t *sl) {
 345     D(sl, "*** looking up stlink version\n");
 346     stlink_version_t slv;
 347     sl->backend->version(sl);
 348     _parse_version(sl, &slv);
 349
 350     DD(sl, "st vid         = 0x%04x (expect 0x%04x)\n", slv.st_vid, USB_ST_VID);
 351     DD(sl, "stlink pid     = 0x%04x\n", slv.stlink_pid);
 352     DD(sl, "stlink version = 0x%x\n", slv.stlink_v);
 353     DD(sl, "jtag version   = 0x%x\n", slv.jtag_v);
 354     DD(sl, "swim version   = 0x%x\n", slv.swim_v);
 355     if (slv.jtag_v == 0) {
 356         DD(sl, "    notice: the firmware doesn't support a jtag/swd interface\n");
 357     }
 358     if (slv.swim_v == 0) {
 359         DD(sl, "    notice: the firmware doesn't support a swim interface\n");
 360     }
 361 }
 362
 363 void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 364     D(sl, "\n*** stlink_write_mem32 ***\n");
 365     if (len % 4 != 0) {
 366         fprintf(stderr, "Error: Data length doesn't have a 32 bit alignment: +%d byte.\n", len % 4);
 367         return;
 368     }
 369     sl->backend->write_mem32(sl, addr, len);
 370 }
 371
 372 void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 373     D(sl, "\n*** stlink_read_mem32 ***\n");
 374     if (len % 4 != 0) { // !!! never ever: fw gives just wrong values
 375         fprintf(stderr, "Error: Data length doesn't have a 32 bit alignment: +%d byte.\n",
 376                 len % 4);
 377         return;
 378     }
 379     sl->backend->read_mem32(sl, addr, len);
 380 }
 381
 382 void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len) {
 383     D(sl, "\n*** stlink_write_mem8 ***\n");
 384     sl->backend->write_mem8(sl, addr, len);
 385 }
 386
 387 void stlink_read_all_regs(stlink_t *sl, reg *regp) {
 388     D(sl, "\n*** stlink_read_all_regs ***\n");
 389     sl->backend->read_all_regs(sl, regp);
 390 }
 391
 392 void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx) {
 393     D(sl, "\n*** stlink_write_reg\n");
 394     sl->backend->write_reg(sl, reg, idx);
 395 }
 396
 397 void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp) {
 398     D(sl, "\n*** stlink_read_reg\n");
 399     DD(sl, " (%d) ***\n", r_idx);
 400
 401     if (r_idx > 20 || r_idx < 0) {
 402         fprintf(stderr, "Error: register index must be in [0..20]\n");
 403         return;
 404     }
 405
 406     sl->backend->read_reg(sl, r_idx, regp);
 407 }
 408
 409 unsigned int is_core_halted(stlink_t *sl) {
 410     /* return non zero if core is halted */
 411     stlink_status(sl);
 412     return sl->q_buf[0] == STLINK_CORE_HALTED;
 413 }
 414
 415 void stlink_step(stlink_t *sl) {
 416     D(sl, "\n*** stlink_step ***\n");
 417     sl->backend->step(sl);
 418 }
 419
 420 int stlink_current_mode(stlink_t *sl) {
 421     int mode = sl->backend->current_mode(sl);
 422     switch (mode) {
 423         case STLINK_DEV_DFU_MODE:
 424             DD(sl, "stlink current mode: dfu\n");
 425             return mode;
 426         case STLINK_DEV_DEBUG_MODE:
 427             DD(sl, "stlink current mode: debug (jtag or swd)\n");
 428             return mode;
 429         case STLINK_DEV_MASS_MODE:
 430             DD(sl, "stlink current mode: mass\n");
 431             return mode;
 432     }
 433     DD(sl, "stlink mode: unknown!\n");
 434     return STLINK_DEV_UNKNOWN_MODE;
 435 }
 436
 437
 438
 439
 440 // End of delegates....  Common code below here...
 441
 442 // Endianness
 443 // http://www.ibm.com/developerworks/aix/library/au-endianc/index.html
 444 // const int i = 1;
 445 // #define is_bigendian() ( (*(char*)&i) == 0 )
 446
 447 inline unsigned int is_bigendian(void) {
 448     static volatile const unsigned int i = 1;
 449     return *(volatile const char*) &i == 0;
 450 }
 451
 452 uint16_t read_uint16(const unsigned char *c, const int pt) {
 453     uint32_t ui;
 454     char *p = (char *) &ui;
 455
 456     if (!is_bigendian()) { // le -> le (don't swap)
 457         p[0] = c[pt];
 458         p[1] = c[pt + 1];
 459     } else {
 460         p[0] = c[pt + 1];
 461         p[1] = c[pt];
 462     }
 463     return ui;
 464 }
 465
 466 // same as above with entrypoint.
 467
 468 void stlink_run_at(stlink_t *sl, stm32_addr_t addr) {
 469     stlink_write_reg(sl, addr, 15); /* pc register */
 470
 471     stlink_run(sl);
 472
 473     while (is_core_halted(sl) == 0)
 474         usleep(3000000);
 475 }
 476
 477 void stlink_core_stat(stlink_t *sl) {
 478     if (sl->q_len <= 0)
 479         return;
 480
 481     stlink_print_data(sl);
 482
 483     switch (sl->q_buf[0]) {
 484         case STLINK_CORE_RUNNING:
 485             sl->core_stat = STLINK_CORE_RUNNING;
 486             DD(sl, "  core status: running\n");
 487             return;
 488         case STLINK_CORE_HALTED:
 489             sl->core_stat = STLINK_CORE_HALTED;
 490             DD(sl, "  core status: halted\n");
 491             return;
 492         default:
 493             sl->core_stat = STLINK_CORE_STAT_UNKNOWN;
 494             fprintf(stderr, "  core status: unknown\n");
 495     }
 496 }
 497
 498 void stlink_print_data(stlink_t * sl) {
 499     if (sl->q_len <= 0 || sl->verbose < 2)
 500         return;
 501     if (sl->verbose > 2)
 502         fprintf(stdout, "data_len = %d 0x%x\n", sl->q_len, sl->q_len);
 503
 504     for (int i = 0; i < sl->q_len; i++) {
 505         if (i % 16 == 0) {
 506             /*
 507                                     if (sl->q_data_dir == Q_DATA_OUT)
 508                                             fprintf(stdout, "\n<- 0x%08x ", sl->q_addr + i);
 509                                     else
 510                                             fprintf(stdout, "\n-> 0x%08x ", sl->q_addr + i);
 511              */
 512         }
 513         fprintf(stdout, " %02x", (unsigned int) sl->q_buf[i]);
 514     }
 515     fputs("\n\n", stdout);
 516 }
 517
 518 /* memory mapped file */
 519
 520 typedef struct mapped_file {
 521     uint8_t* base;
 522     size_t len;
 523 } mapped_file_t;
 524
 525 #define MAPPED_FILE_INITIALIZER { NULL, 0 }
 526
 527 static int map_file(mapped_file_t* mf, const char* path) {
 528     int error = -1;
 529     struct stat st;
 530
 531     const int fd = open(path, O_RDONLY);
 532     if (fd == -1) {
 533         fprintf(stderr, "open(%s) == -1\n", path);
 534         return -1;
 535     }
 536
 537     if (fstat(fd, &st) == -1) {
 538         fprintf(stderr, "fstat() == -1\n");
 539         goto on_error;
 540     }
 541
 542     mf->base = (uint8_t*) mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, fd, 0);
 543     if (mf->base == MAP_FAILED) {
 544         fprintf(stderr, "mmap() == MAP_FAILED\n");
 545         goto on_error;
 546     }
 547
 548     mf->len = st.st_size;
 549
 550     /* success */
 551     error = 0;
 552
 553 on_error:
 554     close(fd);
 555
 556     return error;
 557 }
 558
 559 static void unmap_file(mapped_file_t * mf) {
 560     munmap((void*) mf->base, mf->len);
 561     mf->base = (unsigned char*) MAP_FAILED;
 562     mf->len = 0;
 563 }
 564
 565 static int check_file(stlink_t* sl, mapped_file_t* mf, stm32_addr_t addr) {
 566     size_t off;
 567
 568     for (off = 0; off < mf->len; off += sl->flash_pgsz) {
 569         size_t aligned_size;
 570
 571         /* adjust last page size */
 572         size_t cmp_size = sl->flash_pgsz;
 573         if ((off + sl->flash_pgsz) > mf->len)
 574             cmp_size = mf->len - off;
 575
 576         aligned_size = cmp_size;
 577         if (aligned_size & (4 - 1))
 578             aligned_size = (cmp_size + 4) & ~(4 - 1);
 579
 580         stlink_read_mem32(sl, addr + off, aligned_size);
 581
 582         if (memcmp(sl->q_buf, mf->base + off, cmp_size))
 583             return -1;
 584     }
 585
 586     return 0;
 587 }
 588
 589 int stlink_fwrite_sram
 590 (stlink_t * sl, const char* path, stm32_addr_t addr) {
 591     /* write the file in sram at addr */
 592
 593     int error = -1;
 594     size_t off;
 595     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 596
 597     if (map_file(&mf, path) == -1) {
 598         fprintf(stderr, "map_file() == -1\n");
 599         return -1;
 600     }
 601
 602     /* check addr range is inside the sram */
 603     if (addr < sl->sram_base) {
 604         fprintf(stderr, "addr too low\n");
 605         goto on_error;
 606     } else if ((addr + mf.len) < addr) {
 607         fprintf(stderr, "addr overruns\n");
 608         goto on_error;
 609     } else if ((addr + mf.len) > (sl->sram_base + sl->sram_size)) {
 610         fprintf(stderr, "addr too high\n");
 611         goto on_error;
 612     } else if ((addr & 3) || (mf.len & 3)) {
 613         /* todo */
 614         fprintf(stderr, "unaligned addr or size\n");
 615         goto on_error;
 616     }
 617
 618     /* do the copy by 1k blocks */
 619     for (off = 0; off < mf.len; off += 1024) {
 620         size_t size = 1024;
 621         if ((off + size) > mf.len)
 622             size = mf.len - off;
 623
 624         memcpy(sl->q_buf, mf.base + off, size);
 625
 626         /* round size if needed */
 627         if (size & 3)
 628             size += 2;
 629
 630         stlink_write_mem32(sl, addr + off, size);
 631     }
 632
 633     /* check the file ha been written */
 634     if (check_file(sl, &mf, addr) == -1) {
 635         fprintf(stderr, "check_file() == -1\n");
 636         goto on_error;
 637     }
 638
 639     /* success */
 640     error = 0;
 641
 642 on_error:
 643     unmap_file(&mf);
 644     return error;
 645 }
 646
 647 int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size) {
 648     /* read size bytes from addr to file */
 649
 650     int error = -1;
 651     size_t off;
 652
 653     const int fd = open(path, O_RDWR | O_TRUNC | O_CREAT, 00700);
 654     if (fd == -1) {
 655         fprintf(stderr, "open(%s) == -1\n", path);
 656         return -1;
 657     }
 658
 659     /* do the copy by 1k blocks */
 660     for (off = 0; off < size; off += 1024) {
 661         size_t read_size = 1024;
 662         if ((off + read_size) > size)
 663             read_size = off + read_size;
 664
 665         /* round size if needed */
 666         if (read_size & 3)
 667             read_size = (read_size + 4) & ~(3);
 668
 669         stlink_read_mem32(sl, addr + off, read_size);
 670
 671         if (write(fd, sl->q_buf, read_size) != (ssize_t) read_size) {
 672             fprintf(stderr, "write() != read_size\n");
 673             goto on_error;
 674         }
 675     }
 676
 677     /* success */
 678     error = 0;
 679
 680 on_error:
 681     close(fd);
 682
 683     return error;
 684 }
 685
 686 int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size) {
 687     /* write the buffer right after the loader */
 688     memcpy(sl->q_buf, buf, size);
 689     stlink_write_mem8(sl, fl->buf_addr, size);
 690     return 0;
 691 }
 692
 693 int stlink_erase_flash_page(stlink_t *sl, stm32_addr_t page) {
 694     /* page an addr in the page to erase */
 695
 696     /* wait for ongoing op to finish */
 697     wait_flash_busy(sl);
 698
 699     /* unlock if locked */
 700     unlock_flash_if(sl);
 701
 702     /* set the page erase bit */
 703     set_flash_cr_per(sl);
 704
 705     /* select the page to erase */
 706     write_flash_ar(sl, page);
 707
 708     /* start erase operation, reset by hw with bsy bit */
 709     set_flash_cr_strt(sl);
 710
 711     /* wait for completion */
 712     wait_flash_busy(sl);
 713
 714     /* relock the flash */
 715     lock_flash(sl);
 716
 717     /* todo: verify the erased page */
 718
 719     return 0;
 720 }
 721
 722 int stlink_erase_flash_mass(stlink_t *sl) {
 723     /* wait for ongoing op to finish */
 724     wait_flash_busy(sl);
 725
 726     /* unlock if locked */
 727     unlock_flash_if(sl);
 728
 729     /* set the mass erase bit */
 730     set_flash_cr_mer(sl);
 731
 732     /* start erase operation, reset by hw with bsy bit */
 733     set_flash_cr_strt(sl);
 734
 735     /* wait for completion */
 736     wait_flash_busy(sl);
 737
 738     /* relock the flash */
 739     lock_flash(sl);
 740
 741     /* todo: verify the erased memory */
 742
 743     return 0;
 744 }
 745
 746 int init_flash_loader(stlink_t *sl, flash_loader_t* fl) {
 747     size_t size;
 748
 749     /* allocate the loader in sram */
 750     if (write_loader_to_sram(sl, &fl->loader_addr, &size) == -1) {
 751         fprintf(stderr, "write_loader_to_sram() == -1\n");
 752         return -1;
 753     }
 754
 755     /* allocate a one page buffer in sram right after loader */
 756     fl->buf_addr = fl->loader_addr + size;
 757
 758     return 0;
 759 }
 760
 761 int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size) {
 762     /* from openocd, contrib/loaders/flash/stm32.s */
 763     static const uint8_t loader_code[] = {
 764         0x08, 0x4c, /* ldr      r4, STM32_FLASH_BASE */
 765         0x1c, 0x44, /* add      r4, r3 */
 766         /* write_half_word: */
 767         0x01, 0x23, /* movs     r3, #0x01 */
 768         0x23, 0x61, /* str      r3, [r4, #STM32_FLASH_CR_OFFSET] */
 769         0x30, 0xf8, 0x02, 0x3b, /* ldrh r3, [r0], #0x02 */
 770         0x21, 0xf8, 0x02, 0x3b, /* strh r3, [r1], #0x02 */
 771         /* busy: */
 772         0xe3, 0x68, /* ldr      r3, [r4, #STM32_FLASH_SR_OFFSET] */
 773         0x13, 0xf0, 0x01, 0x0f, /* tst  r3, #0x01 */
 774         0xfb, 0xd0, /* beq      busy */
 775         0x13, 0xf0, 0x14, 0x0f, /* tst  r3, #0x14 */
 776         0x01, 0xd1, /* bne      exit */
 777         0x01, 0x3a, /* subs     r2, r2, #0x01 */
 778         0xf0, 0xd1, /* bne      write_half_word */
 779         /* exit: */
 780         0x00, 0xbe, /* bkpt     #0x00 */
 781         0x00, 0x20, 0x02, 0x40, /* STM32_FLASH_BASE: .word 0x40022000 */
 782     };
 783
 784     memcpy(sl->q_buf, loader_code, sizeof (loader_code));
 785     stlink_write_mem32(sl, sl->sram_base, sizeof (loader_code));
 786
 787     *addr = sl->sram_base;
 788     *size = sizeof (loader_code);
 789
 790     /* success */
 791     return 0;
 792 }
 793
 794 int stlink_fcheck_flash(stlink_t *sl, const char* path, stm32_addr_t addr) {
 795     /* check the contents of path are at addr */
 796
 797     int res;
 798     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 799
 800     if (map_file(&mf, path) == -1)
 801         return -1;
 802
 803     res = check_file(sl, &mf, addr);
 804
 805     unmap_file(&mf);
 806
 807     return res;
 808 }
 809
 810 // The stlink_fwrite_flash should not muck with mmapped files inside itself,
 811 // and should use this function instead. (Hell, what's the reason behind mmap
 812 // there?!) But, as it is not actually used anywhere, nobody cares.
 813
 814 #define WRITE_BLOCK_SIZE 0x40
 815
 816 int stlink_write_flash(stlink_t *sl, stm32_addr_t addr, uint8_t* base, unsigned len) {
 817     size_t off;
 818     flash_loader_t fl;
 819
 820     /* check addr range is inside the flash */
 821     if (addr < sl->flash_base) {
 822         fprintf(stderr, "addr too low\n");
 823         return -1;
 824     } else if ((addr + len) < addr) {
 825         fprintf(stderr, "addr overruns\n");
 826         return -1;
 827     } else if ((addr + len) > (sl->flash_base + sl->flash_size)) {
 828         fprintf(stderr, "addr too high\n");
 829         return -1;
 830     } else if ((addr & 1) || (len & 1)) {
 831         fprintf(stderr, "unaligned addr or size\n");
 832         return -1;
 833     }
 834
 835     /* flash loader initialization */
 836     if (init_flash_loader(sl, &fl) == -1) {
 837         fprintf(stderr, "init_flash_loader() == -1\n");
 838         return -1;
 839     }
 840
 841     /* write each page. above WRITE_BLOCK_SIZE fails? */
 842     for (off = 0; off < len; off += WRITE_BLOCK_SIZE) {
 843         /* adjust last write size */
 844         size_t size = WRITE_BLOCK_SIZE;
 845         if ((off + WRITE_BLOCK_SIZE) > len)
 846             size = len - off;
 847
 848         if (run_flash_loader(sl, &fl, addr + off, base + off, size) == -1) {
 849             fprintf(stderr, "run_flash_loader(0x%zx) == -1\n", addr + off);
 850             return -1;
 851         }
 852     }
 853
 854     for (off = 0; off < len; off += sl->flash_pgsz) {
 855         size_t aligned_size;
 856
 857         /* adjust last page size */
 858         size_t cmp_size = sl->flash_pgsz;
 859         if ((off + sl->flash_pgsz) > len)
 860             cmp_size = len - off;
 861
 862         aligned_size = cmp_size;
 863         if (aligned_size & (4 - 1))
 864             aligned_size = (cmp_size + 4) & ~(4 - 1);
 865
 866         stlink_read_mem32(sl, addr + off, aligned_size);
 867
 868         if (memcmp(sl->q_buf, base + off, cmp_size))
 869             return -1;
 870     }
 871
 872     return 0;
 873 }
 874
 875 int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr) {
 876     /* write the file in flash at addr */
 877
 878     int error = -1;
 879     size_t off;
 880     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 881     flash_loader_t fl;
 882
 883     if (map_file(&mf, path) == -1) {
 884         fprintf(stderr, "map_file() == -1\n");
 885         return -1;
 886     }
 887
 888     /* check addr range is inside the flash */
 889     if (addr < sl->flash_base) {
 890         fprintf(stderr, "addr too low\n");
 891         goto on_error;
 892     } else if ((addr + mf.len) < addr) {
 893         fprintf(stderr, "addr overruns\n");
 894         goto on_error;
 895     } else if ((addr + mf.len) > (sl->flash_base + sl->flash_size)) {
 896         fprintf(stderr, "addr too high\n");
 897         goto on_error;
 898     } else if ((addr & 1) || (mf.len & 1)) {
 899         /* todo */
 900         fprintf(stderr, "unaligned addr or size\n");
 901         goto on_error;
 902     }
 903
 904     /* erase each page. todo: mass erase faster? */
 905     for (off = 0; off < mf.len; off += sl->flash_pgsz) {
 906         /* addr must be an addr inside the page */
 907         if (stlink_erase_flash_page(sl, addr + off) == -1) {
 908             fprintf(stderr, "erase_flash_page(0x%zx) == -1\n", addr + off);
 909             goto on_error;
 910         }
 911     }
 912
 913     /* flash loader initialization */
 914     if (init_flash_loader(sl, &fl) == -1) {
 915         fprintf(stderr, "init_flash_loader() == -1\n");
 916         goto on_error;
 917     }
 918
 919     /* write each page. above WRITE_BLOCK_SIZE fails? */
 920 #define WRITE_BLOCK_SIZE 0x40
 921     for (off = 0; off < mf.len; off += WRITE_BLOCK_SIZE) {
 922         /* adjust last write size */
 923         size_t size = WRITE_BLOCK_SIZE;
 924         if ((off + WRITE_BLOCK_SIZE) > mf.len)
 925             size = mf.len - off;
 926
 927         if (run_flash_loader(sl, &fl, addr + off, mf.base + off, size) == -1) {
 928             fprintf(stderr, "run_flash_loader(0x%zx) == -1\n", addr + off);
 929             goto on_error;
 930         }
 931     }
 932
 933     /* check the file ha been written */
 934     if (check_file(sl, &mf, addr) == -1) {
 935         fprintf(stderr, "check_file() == -1\n");
 936         goto on_error;
 937     }
 938
 939     /* success */
 940     error = 0;
 941
 942 on_error:
 943     unmap_file(&mf);
 944     return error;
 945 }
 946
 947 int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size) {
 948     const size_t count = size / sizeof (uint16_t);
 949
 950     if (write_buffer_to_sram(sl, fl, buf, size) == -1) {
 951         fprintf(stderr, "write_buffer_to_sram() == -1\n");
 952         return -1;
 953     }
 954
 955     /* setup core */
 956     stlink_write_reg(sl, fl->buf_addr, 0); /* source */
 957     stlink_write_reg(sl, target, 1); /* target */
 958     stlink_write_reg(sl, count, 2); /* count (16 bits half words) */
 959     stlink_write_reg(sl, 0, 3); /* flash bank 0 (input) */
 960     stlink_write_reg(sl, fl->loader_addr, 15); /* pc register */
 961
 962     /* unlock and set programming mode */
 963     unlock_flash_if(sl);
 964     set_flash_cr_pg(sl);
 965
 966     /* run loader */
 967     stlink_run(sl);
 968
 969     while (is_core_halted(sl) == 0)
 970         ;
 971
 972     lock_flash(sl);
 973
 974     /* not all bytes have been written */
 975     reg rr;
 976     stlink_read_reg(sl, 2, &rr);
 977     if (rr.r[2] != 0) {
 978         fprintf(stderr, "write error, count == %u\n", rr.r[2]);
 979         return -1;
 980     }
 981
 982     return 0;
 983 }