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 void 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 }
 293
 294 uint16_t stlink_chip_id(stlink_t *sl) {
 295     stlink_read_mem32(sl, 0xE0042000, 4);
 296     uint32_t chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
 297             (sl->q_buf[3] << 24);
 298     return chip_id;
 299 }
 300
 301 void stlink_reset(stlink_t *sl) {
 302     D(sl, "\n*** stlink_reset ***\n");
 303     sl->backend->reset(sl);
 304
 305 }
 306
 307 void stlink_run(stlink_t *sl) {
 308     D(sl, "\n*** stlink_run ***\n");
 309     sl->backend->run(sl);
 310 }
 311
 312 void stlink_status(stlink_t *sl) {
 313     D(sl, "\n*** stlink_status ***\n");
 314     sl->backend->status(sl);
 315     stlink_core_stat(sl);
 316 }
 317
 318 /**
 319  * Decode the version bits, originally from -sg, verified with usb
 320  * @param sl stlink context, assumed to contain valid data in the buffer
 321  * @param slv output parsed version object
 322  */
 323 void _parse_version(stlink_t *sl, stlink_version_t *slv) {
 324     uint32_t b0 = sl->q_buf[0]; //lsb
 325     uint32_t b1 = sl->q_buf[1];
 326     uint32_t b2 = sl->q_buf[2];
 327     uint32_t b3 = sl->q_buf[3];
 328     uint32_t b4 = sl->q_buf[4];
 329     uint32_t b5 = sl->q_buf[5]; //msb
 330
 331     // b0 b1                       || b2 b3  | b4 b5
 332     // 4b        | 6b     | 6b     || 2B     | 2B
 333     // stlink_v  | jtag_v | swim_v || st_vid | stlink_pid
 334
 335     slv->stlink_v = (b0 & 0xf0) >> 4;
 336     slv->jtag_v = ((b0 & 0x0f) << 2) | ((b1 & 0xc0) >> 6);
 337     slv->swim_v = b1 & 0x3f;
 338     slv->st_vid = (b3 << 8) | b2;
 339     slv->stlink_pid = (b5 << 8) | b4;
 340     return;
 341 }
 342
 343 void stlink_version(stlink_t *sl) {
 344     D(sl, "*** looking up stlink version\n");
 345     stlink_version_t slv;
 346     sl->backend->version(sl);
 347     _parse_version(sl, &slv);
 348
 349     DD(sl, "st vid         = 0x%04x (expect 0x%04x)\n", slv.st_vid, USB_ST_VID);
 350     DD(sl, "stlink pid     = 0x%04x\n", slv.stlink_pid);
 351     DD(sl, "stlink version = 0x%x\n", slv.stlink_v);
 352     DD(sl, "jtag version   = 0x%x\n", slv.jtag_v);
 353     DD(sl, "swim version   = 0x%x\n", slv.swim_v);
 354     if (slv.jtag_v == 0) {
 355         DD(sl, "    notice: the firmware doesn't support a jtag/swd interface\n");
 356     }
 357     if (slv.swim_v == 0) {
 358         DD(sl, "    notice: the firmware doesn't support a swim interface\n");
 359     }
 360 }
 361
 362 void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 363     D(sl, "\n*** stlink_write_mem32 ***\n");
 364     if (len % 4 != 0) {
 365         fprintf(stderr, "Error: Data length doesn't have a 32 bit alignment: +%d byte.\n", len % 4);
 366         return;
 367     }
 368     sl->backend->write_mem32(sl, addr, len);
 369 }
 370
 371 void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 372     D(sl, "\n*** stlink_read_mem32 ***\n");
 373     if (len % 4 != 0) { // !!! never ever: fw gives just wrong values
 374         fprintf(stderr, "Error: Data length doesn't have a 32 bit alignment: +%d byte.\n",
 375                 len % 4);
 376         return;
 377     }
 378     sl->backend->read_mem32(sl, addr, len);
 379 }
 380
 381 void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len) {
 382     D(sl, "\n*** stlink_write_mem8 ***\n");
 383     sl->backend->write_mem8(sl, addr, len);
 384 }
 385
 386 void stlink_read_all_regs(stlink_t *sl, reg *regp) {
 387     D(sl, "\n*** stlink_read_all_regs ***\n");
 388     sl->backend->read_all_regs(sl, regp);
 389 }
 390
 391 void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx) {
 392     D(sl, "\n*** stlink_write_reg\n");
 393     sl->backend->write_reg(sl, reg, idx);
 394 }
 395
 396 void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp) {
 397     D(sl, "\n*** stlink_read_reg\n");
 398     DD(sl, " (%d) ***\n", r_idx);
 399
 400     if (r_idx > 20 || r_idx < 0) {
 401         fprintf(stderr, "Error: register index must be in [0..20]\n");
 402         return;
 403     }
 404
 405     sl->backend->read_reg(sl, r_idx, regp);
 406 }
 407
 408 unsigned int is_core_halted(stlink_t *sl) {
 409     /* return non zero if core is halted */
 410     stlink_status(sl);
 411     return sl->q_buf[0] == STLINK_CORE_HALTED;
 412 }
 413
 414 void stlink_step(stlink_t *sl) {
 415     D(sl, "\n*** stlink_step ***\n");
 416     sl->backend->step(sl);
 417 }
 418
 419 int stlink_current_mode(stlink_t *sl) {
 420     int mode = sl->backend->current_mode(sl);
 421     switch (mode) {
 422         case STLINK_DEV_DFU_MODE:
 423             DD(sl, "stlink current mode: dfu\n");
 424             return mode;
 425         case STLINK_DEV_DEBUG_MODE:
 426             DD(sl, "stlink current mode: debug (jtag or swd)\n");
 427             return mode;
 428         case STLINK_DEV_MASS_MODE:
 429             DD(sl, "stlink current mode: mass\n");
 430             return mode;
 431     }
 432     DD(sl, "stlink mode: unknown!\n");
 433     return STLINK_DEV_UNKNOWN_MODE;
 434 }
 435
 436
 437
 438
 439 // End of delegates....  Common code below here...
 440
 441 // Endianness
 442 // http://www.ibm.com/developerworks/aix/library/au-endianc/index.html
 443 // const int i = 1;
 444 // #define is_bigendian() ( (*(char*)&i) == 0 )
 445
 446 inline unsigned int is_bigendian(void) {
 447     static volatile const unsigned int i = 1;
 448     return *(volatile const char*) &i == 0;
 449 }
 450
 451 uint16_t read_uint16(const unsigned char *c, const int pt) {
 452     uint32_t ui;
 453     char *p = (char *) &ui;
 454
 455     if (!is_bigendian()) { // le -> le (don't swap)
 456         p[0] = c[pt];
 457         p[1] = c[pt + 1];
 458     } else {
 459         p[0] = c[pt + 1];
 460         p[1] = c[pt];
 461     }
 462     return ui;
 463 }
 464
 465 // same as above with entrypoint.
 466
 467 void stlink_run_at(stlink_t *sl, stm32_addr_t addr) {
 468     stlink_write_reg(sl, addr, 15); /* pc register */
 469
 470     stlink_run(sl);
 471
 472     while (is_core_halted(sl) == 0)
 473         usleep(3000000);
 474 }
 475
 476 void stlink_core_stat(stlink_t *sl) {
 477     if (sl->q_len <= 0)
 478         return;
 479
 480     stlink_print_data(sl);
 481
 482     switch (sl->q_buf[0]) {
 483         case STLINK_CORE_RUNNING:
 484             sl->core_stat = STLINK_CORE_RUNNING;
 485             DD(sl, "  core status: running\n");
 486             return;
 487         case STLINK_CORE_HALTED:
 488             sl->core_stat = STLINK_CORE_HALTED;
 489             DD(sl, "  core status: halted\n");
 490             return;
 491         default:
 492             sl->core_stat = STLINK_CORE_STAT_UNKNOWN;
 493             fprintf(stderr, "  core status: unknown\n");
 494     }
 495 }
 496
 497 void stlink_print_data(stlink_t * sl) {
 498     if (sl->q_len <= 0 || sl->verbose < 2)
 499         return;
 500     if (sl->verbose > 2)
 501         fprintf(stdout, "data_len = %d 0x%x\n", sl->q_len, sl->q_len);
 502
 503     for (int i = 0; i < sl->q_len; i++) {
 504         if (i % 16 == 0) {
 505             /*
 506                                     if (sl->q_data_dir == Q_DATA_OUT)
 507                                             fprintf(stdout, "\n<- 0x%08x ", sl->q_addr + i);
 508                                     else
 509                                             fprintf(stdout, "\n-> 0x%08x ", sl->q_addr + i);
 510              */
 511         }
 512         fprintf(stdout, " %02x", (unsigned int) sl->q_buf[i]);
 513     }
 514     fputs("\n\n", stdout);
 515 }
 516
 517 /* memory mapped file */
 518
 519 typedef struct mapped_file {
 520     uint8_t* base;
 521     size_t len;
 522 } mapped_file_t;
 523
 524 #define MAPPED_FILE_INITIALIZER { NULL, 0 }
 525
 526 static int map_file(mapped_file_t* mf, const char* path) {
 527     int error = -1;
 528     struct stat st;
 529
 530     const int fd = open(path, O_RDONLY);
 531     if (fd == -1) {
 532         fprintf(stderr, "open(%s) == -1\n", path);
 533         return -1;
 534     }
 535
 536     if (fstat(fd, &st) == -1) {
 537         fprintf(stderr, "fstat() == -1\n");
 538         goto on_error;
 539     }
 540
 541     mf->base = (uint8_t*) mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, fd, 0);
 542     if (mf->base == MAP_FAILED) {
 543         fprintf(stderr, "mmap() == MAP_FAILED\n");
 544         goto on_error;
 545     }
 546
 547     mf->len = st.st_size;
 548
 549     /* success */
 550     error = 0;
 551
 552 on_error:
 553     close(fd);
 554
 555     return error;
 556 }
 557
 558 static void unmap_file(mapped_file_t * mf) {
 559     munmap((void*) mf->base, mf->len);
 560     mf->base = (unsigned char*) MAP_FAILED;
 561     mf->len = 0;
 562 }
 563
 564 static int check_file(stlink_t* sl, mapped_file_t* mf, stm32_addr_t addr) {
 565     size_t off;
 566
 567     for (off = 0; off < mf->len; off += sl->flash_pgsz) {
 568         size_t aligned_size;
 569
 570         /* adjust last page size */
 571         size_t cmp_size = sl->flash_pgsz;
 572         if ((off + sl->flash_pgsz) > mf->len)
 573             cmp_size = mf->len - off;
 574
 575         aligned_size = cmp_size;
 576         if (aligned_size & (4 - 1))
 577             aligned_size = (cmp_size + 4) & ~(4 - 1);
 578
 579         stlink_read_mem32(sl, addr + off, aligned_size);
 580
 581         if (memcmp(sl->q_buf, mf->base + off, cmp_size))
 582             return -1;
 583     }
 584
 585     return 0;
 586 }
 587
 588 int stlink_fwrite_sram
 589 (stlink_t * sl, const char* path, stm32_addr_t addr) {
 590     /* write the file in sram at addr */
 591
 592     int error = -1;
 593     size_t off;
 594     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 595
 596     if (map_file(&mf, path) == -1) {
 597         fprintf(stderr, "map_file() == -1\n");
 598         return -1;
 599     }
 600
 601     /* check addr range is inside the sram */
 602     if (addr < sl->sram_base) {
 603         fprintf(stderr, "addr too low\n");
 604         goto on_error;
 605     } else if ((addr + mf.len) < addr) {
 606         fprintf(stderr, "addr overruns\n");
 607         goto on_error;
 608     } else if ((addr + mf.len) > (sl->sram_base + sl->sram_size)) {
 609         fprintf(stderr, "addr too high\n");
 610         goto on_error;
 611     } else if ((addr & 3) || (mf.len & 3)) {
 612         /* todo */
 613         fprintf(stderr, "unaligned addr or size\n");
 614         goto on_error;
 615     }
 616
 617     /* do the copy by 1k blocks */
 618     for (off = 0; off < mf.len; off += 1024) {
 619         size_t size = 1024;
 620         if ((off + size) > mf.len)
 621             size = mf.len - off;
 622
 623         memcpy(sl->q_buf, mf.base + off, size);
 624
 625         /* round size if needed */
 626         if (size & 3)
 627             size += 2;
 628
 629         stlink_write_mem32(sl, addr + off, size);
 630     }
 631
 632     /* check the file ha been written */
 633     if (check_file(sl, &mf, addr) == -1) {
 634         fprintf(stderr, "check_file() == -1\n");
 635         goto on_error;
 636     }
 637
 638     /* success */
 639     error = 0;
 640
 641 on_error:
 642     unmap_file(&mf);
 643     return error;
 644 }
 645
 646 int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size) {
 647     /* read size bytes from addr to file */
 648
 649     int error = -1;
 650     size_t off;
 651
 652     const int fd = open(path, O_RDWR | O_TRUNC | O_CREAT, 00700);
 653     if (fd == -1) {
 654         fprintf(stderr, "open(%s) == -1\n", path);
 655         return -1;
 656     }
 657
 658     /* do the copy by 1k blocks */
 659     for (off = 0; off < size; off += 1024) {
 660         size_t read_size = 1024;
 661         if ((off + read_size) > size)
 662             read_size = off + read_size;
 663
 664         /* round size if needed */
 665         if (read_size & 3)
 666             read_size = (read_size + 4) & ~(3);
 667
 668         stlink_read_mem32(sl, addr + off, read_size);
 669
 670         if (write(fd, sl->q_buf, read_size) != (ssize_t) read_size) {
 671             fprintf(stderr, "write() != read_size\n");
 672             goto on_error;
 673         }
 674     }
 675
 676     /* success */
 677     error = 0;
 678
 679 on_error:
 680     close(fd);
 681
 682     return error;
 683 }
 684
 685 int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size) {
 686     /* write the buffer right after the loader */
 687     memcpy(sl->q_buf, buf, size);
 688     stlink_write_mem8(sl, fl->buf_addr, size);
 689     return 0;
 690 }
 691
 692 int stlink_erase_flash_page(stlink_t *sl, stm32_addr_t page) {
 693     /* page an addr in the page to erase */
 694
 695     /* wait for ongoing op to finish */
 696     wait_flash_busy(sl);
 697
 698     /* unlock if locked */
 699     unlock_flash_if(sl);
 700
 701     /* set the page erase bit */
 702     set_flash_cr_per(sl);
 703
 704     /* select the page to erase */
 705     write_flash_ar(sl, page);
 706
 707     /* start erase operation, reset by hw with bsy bit */
 708     set_flash_cr_strt(sl);
 709
 710     /* wait for completion */
 711     wait_flash_busy(sl);
 712
 713     /* relock the flash */
 714     lock_flash(sl);
 715
 716     /* todo: verify the erased page */
 717
 718     return 0;
 719 }
 720
 721 int stlink_erase_flash_mass(stlink_t *sl) {
 722     /* wait for ongoing op to finish */
 723     wait_flash_busy(sl);
 724
 725     /* unlock if locked */
 726     unlock_flash_if(sl);
 727
 728     /* set the mass erase bit */
 729     set_flash_cr_mer(sl);
 730
 731     /* start erase operation, reset by hw with bsy bit */
 732     set_flash_cr_strt(sl);
 733
 734     /* wait for completion */
 735     wait_flash_busy(sl);
 736
 737     /* relock the flash */
 738     lock_flash(sl);
 739
 740     /* todo: verify the erased memory */
 741
 742     return 0;
 743 }
 744
 745 int init_flash_loader(stlink_t *sl, flash_loader_t* fl) {
 746     size_t size;
 747
 748     /* allocate the loader in sram */
 749     if (write_loader_to_sram(sl, &fl->loader_addr, &size) == -1) {
 750         fprintf(stderr, "write_loader_to_sram() == -1\n");
 751         return -1;
 752     }
 753
 754     /* allocate a one page buffer in sram right after loader */
 755     fl->buf_addr = fl->loader_addr + size;
 756
 757     return 0;
 758 }
 759
 760 int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size) {
 761     /* from openocd, contrib/loaders/flash/stm32.s */
 762     static const uint8_t loader_code[] = {
 763         0x08, 0x4c, /* ldr      r4, STM32_FLASH_BASE */
 764         0x1c, 0x44, /* add      r4, r3 */
 765         /* write_half_word: */
 766         0x01, 0x23, /* movs     r3, #0x01 */
 767         0x23, 0x61, /* str      r3, [r4, #STM32_FLASH_CR_OFFSET] */
 768         0x30, 0xf8, 0x02, 0x3b, /* ldrh r3, [r0], #0x02 */
 769         0x21, 0xf8, 0x02, 0x3b, /* strh r3, [r1], #0x02 */
 770         /* busy: */
 771         0xe3, 0x68, /* ldr      r3, [r4, #STM32_FLASH_SR_OFFSET] */
 772         0x13, 0xf0, 0x01, 0x0f, /* tst  r3, #0x01 */
 773         0xfb, 0xd0, /* beq      busy */
 774         0x13, 0xf0, 0x14, 0x0f, /* tst  r3, #0x14 */
 775         0x01, 0xd1, /* bne      exit */
 776         0x01, 0x3a, /* subs     r2, r2, #0x01 */
 777         0xf0, 0xd1, /* bne      write_half_word */
 778         /* exit: */
 779         0x00, 0xbe, /* bkpt     #0x00 */
 780         0x00, 0x20, 0x02, 0x40, /* STM32_FLASH_BASE: .word 0x40022000 */
 781     };
 782
 783     memcpy(sl->q_buf, loader_code, sizeof (loader_code));
 784     stlink_write_mem32(sl, sl->sram_base, sizeof (loader_code));
 785
 786     *addr = sl->sram_base;
 787     *size = sizeof (loader_code);
 788
 789     /* success */
 790     return 0;
 791 }
 792
 793 int stlink_fcheck_flash(stlink_t *sl, const char* path, stm32_addr_t addr) {
 794     /* check the contents of path are at addr */
 795
 796     int res;
 797     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 798
 799     if (map_file(&mf, path) == -1)
 800         return -1;
 801
 802     res = check_file(sl, &mf, addr);
 803
 804     unmap_file(&mf);
 805
 806     return res;
 807 }
 808
 809 // The stlink_fwrite_flash should not muck with mmapped files inside itself,
 810 // and should use this function instead. (Hell, what's the reason behind mmap
 811 // there?!) But, as it is not actually used anywhere, nobody cares.
 812
 813 #define WRITE_BLOCK_SIZE 0x40
 814
 815 int stlink_write_flash(stlink_t *sl, stm32_addr_t addr, uint8_t* base, unsigned len) {
 816     size_t off;
 817     flash_loader_t fl;
 818
 819     /* check addr range is inside the flash */
 820     if (addr < sl->flash_base) {
 821         fprintf(stderr, "addr too low\n");
 822         return -1;
 823     } else if ((addr + len) < addr) {
 824         fprintf(stderr, "addr overruns\n");
 825         return -1;
 826     } else if ((addr + len) > (sl->flash_base + sl->flash_size)) {
 827         fprintf(stderr, "addr too high\n");
 828         return -1;
 829     } else if ((addr & 1) || (len & 1)) {
 830         fprintf(stderr, "unaligned addr or size\n");
 831         return -1;
 832     }
 833
 834     /* flash loader initialization */
 835     if (init_flash_loader(sl, &fl) == -1) {
 836         fprintf(stderr, "init_flash_loader() == -1\n");
 837         return -1;
 838     }
 839
 840     /* write each page. above WRITE_BLOCK_SIZE fails? */
 841     for (off = 0; off < len; off += WRITE_BLOCK_SIZE) {
 842         /* adjust last write size */
 843         size_t size = WRITE_BLOCK_SIZE;
 844         if ((off + WRITE_BLOCK_SIZE) > len)
 845             size = len - off;
 846
 847         if (run_flash_loader(sl, &fl, addr + off, base + off, size) == -1) {
 848             fprintf(stderr, "run_flash_loader(0x%zx) == -1\n", addr + off);
 849             return -1;
 850         }
 851     }
 852
 853     for (off = 0; off < len; off += sl->flash_pgsz) {
 854         size_t aligned_size;
 855
 856         /* adjust last page size */
 857         size_t cmp_size = sl->flash_pgsz;
 858         if ((off + sl->flash_pgsz) > len)
 859             cmp_size = len - off;
 860
 861         aligned_size = cmp_size;
 862         if (aligned_size & (4 - 1))
 863             aligned_size = (cmp_size + 4) & ~(4 - 1);
 864
 865         stlink_read_mem32(sl, addr + off, aligned_size);
 866
 867         if (memcmp(sl->q_buf, base + off, cmp_size))
 868             return -1;
 869     }
 870
 871     return 0;
 872 }
 873
 874 int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr) {
 875     /* write the file in flash at addr */
 876
 877     int error = -1;
 878     size_t off;
 879     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 880     flash_loader_t fl;
 881
 882     if (map_file(&mf, path) == -1) {
 883         fprintf(stderr, "map_file() == -1\n");
 884         return -1;
 885     }
 886
 887     /* check addr range is inside the flash */
 888     if (addr < sl->flash_base) {
 889         fprintf(stderr, "addr too low\n");
 890         goto on_error;
 891     } else if ((addr + mf.len) < addr) {
 892         fprintf(stderr, "addr overruns\n");
 893         goto on_error;
 894     } else if ((addr + mf.len) > (sl->flash_base + sl->flash_size)) {
 895         fprintf(stderr, "addr too high\n");
 896         goto on_error;
 897     } else if ((addr & 1) || (mf.len & 1)) {
 898         /* todo */
 899         fprintf(stderr, "unaligned addr or size\n");
 900         goto on_error;
 901     }
 902
 903     /* erase each page. todo: mass erase faster? */
 904     for (off = 0; off < mf.len; off += sl->flash_pgsz) {
 905         /* addr must be an addr inside the page */
 906         if (stlink_erase_flash_page(sl, addr + off) == -1) {
 907             fprintf(stderr, "erase_flash_page(0x%zx) == -1\n", addr + off);
 908             goto on_error;
 909         }
 910     }
 911
 912     /* flash loader initialization */
 913     if (init_flash_loader(sl, &fl) == -1) {
 914         fprintf(stderr, "init_flash_loader() == -1\n");
 915         goto on_error;
 916     }
 917
 918     /* write each page. above WRITE_BLOCK_SIZE fails? */
 919 #define WRITE_BLOCK_SIZE 0x40
 920     for (off = 0; off < mf.len; off += WRITE_BLOCK_SIZE) {
 921         /* adjust last write size */
 922         size_t size = WRITE_BLOCK_SIZE;
 923         if ((off + WRITE_BLOCK_SIZE) > mf.len)
 924             size = mf.len - off;
 925
 926         if (run_flash_loader(sl, &fl, addr + off, mf.base + off, size) == -1) {
 927             fprintf(stderr, "run_flash_loader(0x%zx) == -1\n", addr + off);
 928             goto on_error;
 929         }
 930     }
 931
 932     /* check the file ha been written */
 933     if (check_file(sl, &mf, addr) == -1) {
 934         fprintf(stderr, "check_file() == -1\n");
 935         goto on_error;
 936     }
 937
 938     /* success */
 939     error = 0;
 940
 941 on_error:
 942     unmap_file(&mf);
 943     return error;
 944 }
 945
 946 int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size) {
 947     const size_t count = size / sizeof (uint16_t);
 948
 949     if (write_buffer_to_sram(sl, fl, buf, size) == -1) {
 950         fprintf(stderr, "write_buffer_to_sram() == -1\n");
 951         return -1;
 952     }
 953
 954     /* setup core */
 955     stlink_write_reg(sl, fl->buf_addr, 0); /* source */
 956     stlink_write_reg(sl, target, 1); /* target */
 957     stlink_write_reg(sl, count, 2); /* count (16 bits half words) */
 958     stlink_write_reg(sl, 0, 3); /* flash bank 0 (input) */
 959     stlink_write_reg(sl, fl->loader_addr, 15); /* pc register */
 960
 961     /* unlock and set programming mode */
 962     unlock_flash_if(sl);
 963     set_flash_cr_pg(sl);
 964
 965     /* run loader */
 966     stlink_run(sl);
 967
 968     while (is_core_halted(sl) == 0)
 969         ;
 970
 971     lock_flash(sl);
 972
 973     /* not all bytes have been written */
 974     reg rr;
 975     stlink_read_reg(sl, 2, &rr);
 976     if (rr.r[2] != 0) {
 977         fprintf(stderr, "write error, count == %u\n", rr.r[2]);
 978         return -1;
 979     }
 980
 981     return 0;
 982 }