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

   1 #define DEBUG_FLASH 0
   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 #include "uglylogging.h"
  17
  18 #define LOG_TAG __FILE__
  19 #define DLOG(format, args...)         ugly_log(UDEBUG, LOG_TAG, format, ## args)
  20 #define ILOG(format, args...)         ugly_log(UINFO, LOG_TAG, format, ## args)
  21 #define WLOG(format, args...)         ugly_log(UWARN, LOG_TAG, format, ## args)
  22 #define fatal(format, args...)        ugly_log(UFATAL, LOG_TAG, format, ## args)
  23
  24 /* todo: stm32l15xxx flash memory, pm0062 manual */
  25
  26 /* stm32f FPEC flash controller interface, pm0063 manual */
  27 // TODO - all of this needs to be abstracted out....
  28 #define FLASH_REGS_ADDR 0x40022000
  29 #define FLASH_REGS_SIZE 0x28
  30
  31 #define FLASH_ACR (FLASH_REGS_ADDR + 0x00)
  32 #define FLASH_KEYR (FLASH_REGS_ADDR + 0x04)
  33 #define FLASH_SR (FLASH_REGS_ADDR + 0x0c)
  34 #define FLASH_CR (FLASH_REGS_ADDR + 0x10)
  35 #define FLASH_AR (FLASH_REGS_ADDR + 0x14)
  36 #define FLASH_OBR (FLASH_REGS_ADDR + 0x1c)
  37 #define FLASH_WRPR (FLASH_REGS_ADDR + 0x20)
  38
  39 #define FLASH_RDPTR_KEY 0x00a5
  40 #define FLASH_KEY1 0x45670123
  41 #define FLASH_KEY2 0xcdef89ab
  42
  43 #define FLASH_SR_BSY 0
  44 #define FLASH_SR_EOP 5
  45
  46 #define FLASH_CR_PG 0
  47 #define FLASH_CR_PER 1
  48 #define FLASH_CR_MER 2
  49 #define FLASH_CR_STRT 6
  50 #define FLASH_CR_LOCK 7
  51
  52
  53 //32L = 32F1 same CoreID as 32F4!
  54 #define STM32L_FLASH_REGS_ADDR ((uint32_t)0x40023c00)
  55 #define STM32L_FLASH_ACR (STM32L_FLASH_REGS_ADDR + 0x00)
  56 #define STM32L_FLASH_PECR (STM32L_FLASH_REGS_ADDR + 0x04)
  57 #define STM32L_FLASH_PDKEYR (STM32L_FLASH_REGS_ADDR + 0x08)
  58 #define STM32L_FLASH_PEKEYR (STM32L_FLASH_REGS_ADDR + 0x0c)
  59 #define STM32L_FLASH_PRGKEYR (STM32L_FLASH_REGS_ADDR + 0x10)
  60 #define STM32L_FLASH_OPTKEYR (STM32L_FLASH_REGS_ADDR + 0x14)
  61 #define STM32L_FLASH_SR (STM32L_FLASH_REGS_ADDR + 0x18)
  62 #define STM32L_FLASH_OBR (STM32L_FLASH_REGS_ADDR + 0x0c)
  63 #define STM32L_FLASH_WRPR (STM32L_FLASH_REGS_ADDR + 0x20)
  64
  65
  66 //STM32F4
  67 #define FLASH_F4_REGS_ADDR ((uint32_t)0x40023c00)
  68 #define FLASH_F4_KEYR (FLASH_F4_REGS_ADDR + 0x04)
  69 #define FLASH_F4_OPT_KEYR (FLASH_F4_REGS_ADDR + 0x08)
  70 #define FLASH_F4_SR (FLASH_F4_REGS_ADDR + 0x0c)
  71 #define FLASH_F4_CR (FLASH_F4_REGS_ADDR + 0x10)
  72 #define FLASH_F4_OPT_CR (FLASH_F4_REGS_ADDR + 0x14)
  73 #define FLASH_F4_CR_STRT 16
  74 #define FLASH_F4_CR_LOCK 31
  75 #define FLASH_F4_CR_SER 1
  76 #define FLASH_F4_CR_SNB 3
  77 #define FLASH_F4_CR_SNB_MASK 0x38
  78 #define FLASH_F4_SR_BSY 16
  79
  80
  81 void write_uint32(unsigned char* buf, uint32_t ui) {
  82     if (!is_bigendian()) { // le -> le (don't swap)
  83         buf[0] = ((unsigned char*) &ui)[0];
  84         buf[1] = ((unsigned char*) &ui)[1];
  85         buf[2] = ((unsigned char*) &ui)[2];
  86         buf[3] = ((unsigned char*) &ui)[3];
  87     } else {
  88         buf[0] = ((unsigned char*) &ui)[3];
  89         buf[1] = ((unsigned char*) &ui)[2];
  90         buf[2] = ((unsigned char*) &ui)[1];
  91         buf[3] = ((unsigned char*) &ui)[0];
  92     }
  93 }
  94
  95 void write_uint16(unsigned char* buf, uint16_t ui) {
  96     if (!is_bigendian()) { // le -> le (don't swap)
  97         buf[0] = ((unsigned char*) &ui)[0];
  98         buf[1] = ((unsigned char*) &ui)[1];
  99     } else {
 100         buf[0] = ((unsigned char*) &ui)[1];
 101         buf[1] = ((unsigned char*) &ui)[0];
 102     }
 103 }
 104
 105 uint32_t read_uint32(const unsigned char *c, const int pt) {
 106     uint32_t ui;
 107     char *p = (char *) &ui;
 108
 109     if (!is_bigendian()) { // le -> le (don't swap)
 110         p[0] = c[pt + 0];
 111         p[1] = c[pt + 1];
 112         p[2] = c[pt + 2];
 113         p[3] = c[pt + 3];
 114     } else {
 115         p[0] = c[pt + 3];
 116         p[1] = c[pt + 2];
 117         p[2] = c[pt + 1];
 118         p[3] = c[pt + 0];
 119     }
 120     return ui;
 121 }
 122
 123 static uint32_t __attribute__((unused)) read_flash_rdp(stlink_t *sl) {
 124     return stlink_read_debug32(sl, FLASH_WRPR) & 0xff;
 125 }
 126
 127 static inline uint32_t read_flash_wrpr(stlink_t *sl) {
 128     return stlink_read_debug32(sl, FLASH_WRPR);
 129 }
 130
 131 static inline uint32_t read_flash_obr(stlink_t *sl) {
 132     return stlink_read_debug32(sl, FLASH_OBR);
 133 }
 134
 135 static inline uint32_t read_flash_cr(stlink_t *sl) {
 136         uint32_t res;
 137         if(sl->chip_id==STM32F4_CHIP_ID)
 138                 res = stlink_read_debug32(sl, FLASH_F4_CR);
 139         else
 140                 res = stlink_read_debug32(sl, FLASH_CR);
 141 #if DEBUG_FLASH
 142         fprintf(stdout, "CR:0x%x\n", res);
 143 #endif
 144         return res;
 145 }
 146
 147 static inline unsigned int is_flash_locked(stlink_t *sl) {
 148     /* return non zero for true */
 149         if(sl->chip_id==STM32F4_CHIP_ID)
 150                 return read_flash_cr(sl) & (1 << FLASH_F4_CR_LOCK);
 151         else
 152                 return read_flash_cr(sl) & (1 << FLASH_CR_LOCK);
 153 }
 154
 155 static void unlock_flash(stlink_t *sl) {
 156     /* the unlock sequence consists of 2 write cycles where
 157        2 key values are written to the FLASH_KEYR register.
 158        an invalid sequence results in a definitive lock of
 159        the FPEC block until next reset.
 160      */
 161     if(sl->chip_id==STM32F4_CHIP_ID) {
 162         stlink_write_debug32(sl, FLASH_F4_KEYR, FLASH_KEY1);
 163                 stlink_write_debug32(sl, FLASH_F4_KEYR, FLASH_KEY2);
 164     }
 165         else {
 166         stlink_write_debug32(sl, FLASH_KEYR, FLASH_KEY1);
 167                 stlink_write_debug32(sl, FLASH_KEYR, FLASH_KEY2);
 168         }
 169
 170 }
 171
 172 static int unlock_flash_if(stlink_t *sl) {
 173     /* unlock flash if already locked */
 174
 175     if (is_flash_locked(sl)) {
 176         unlock_flash(sl);
 177         if (is_flash_locked(sl)) {
 178             WLOG("Failed to unlock flash!\n");
 179             return -1;
 180         }
 181     }
 182     ILOG("Successfully unlocked flash\n");
 183     return 0;
 184 }
 185
 186 static void lock_flash(stlink_t *sl) {
 187     if(sl->chip_id==STM32F4_CHIP_ID) {
 188         const uint32_t n = read_flash_cr(sl) | (1 << FLASH_F4_CR_LOCK);
 189         stlink_write_debug32(sl, FLASH_F4_CR, n);
 190     }
 191     else {
 192         /* write to 1 only. reset by hw at unlock sequence */
 193         const uint32_t n = read_flash_cr(sl) | (1 << FLASH_CR_LOCK);
 194         stlink_write_debug32(sl, FLASH_CR, n);
 195     }
 196 }
 197
 198
 199 static void set_flash_cr_pg(stlink_t *sl) {
 200     if(sl->chip_id==STM32F4_CHIP_ID) {
 201                 uint32_t x = read_flash_cr(sl);
 202                 x |= (1 << FLASH_CR_PG);
 203         stlink_write_debug32(sl, FLASH_F4_CR, x);
 204     }
 205     else {
 206         const uint32_t n = 1 << FLASH_CR_PG;
 207         stlink_write_debug32(sl, FLASH_CR, n);
 208     }
 209 }
 210
 211 static void __attribute__((unused)) clear_flash_cr_pg(stlink_t *sl) {
 212     const uint32_t n = read_flash_cr(sl) & ~(1 << FLASH_CR_PG);
 213     if(sl->chip_id==STM32F4_CHIP_ID)
 214         stlink_write_debug32(sl, FLASH_F4_CR, n);
 215     else
 216         stlink_write_debug32(sl, FLASH_CR, n);
 217 }
 218
 219 static void set_flash_cr_per(stlink_t *sl) {
 220     const uint32_t n = 1 << FLASH_CR_PER;
 221     stlink_write_debug32(sl, FLASH_CR, n);
 222 }
 223
 224 static void __attribute__((unused)) clear_flash_cr_per(stlink_t *sl) {
 225     const uint32_t n = read_flash_cr(sl) & ~(1 << FLASH_CR_PER);
 226     stlink_write_debug32(sl, FLASH_CR, n);
 227 }
 228
 229 static void set_flash_cr_mer(stlink_t *sl) {
 230     const uint32_t n = 1 << FLASH_CR_MER;
 231     stlink_write_debug32(sl, FLASH_CR, n);
 232 }
 233
 234 static void __attribute__((unused)) clear_flash_cr_mer(stlink_t *sl) {
 235     const uint32_t n = read_flash_cr(sl) & ~(1 << FLASH_CR_MER);
 236     stlink_write_debug32(sl, FLASH_CR, n);
 237 }
 238
 239 static void set_flash_cr_strt(stlink_t *sl) {
 240         if(sl->chip_id == STM32F4_CHIP_ID)
 241         {
 242                 uint32_t x = read_flash_cr(sl);
 243                 x |= (1 << FLASH_F4_CR_STRT);
 244                 stlink_write_debug32(sl, FLASH_F4_CR, x);
 245         }
 246         else {
 247                 /* assume come on the flash_cr_per path */
 248             const uint32_t n = (1 << FLASH_CR_PER) | (1 << FLASH_CR_STRT);
 249             stlink_write_debug32(sl, FLASH_CR, n);
 250         }
 251 }
 252
 253 static inline uint32_t read_flash_acr(stlink_t *sl) {
 254     return stlink_read_debug32(sl, FLASH_ACR);
 255 }
 256
 257 static inline uint32_t read_flash_sr(stlink_t *sl) {
 258         uint32_t res;
 259         if(sl->chip_id==STM32F4_CHIP_ID)
 260                 res = stlink_read_debug32(sl, FLASH_F4_SR);
 261         else
 262                 res = stlink_read_debug32(sl, FLASH_SR);
 263     //fprintf(stdout, "SR:0x%x\n", *(uint32_t*) sl->q_buf);
 264     return res;
 265 }
 266
 267 static inline unsigned int is_flash_busy(stlink_t *sl) {
 268         if(sl->chip_id==STM32F4_CHIP_ID)
 269                 return read_flash_sr(sl) & (1 << FLASH_F4_SR_BSY);
 270         else
 271                 return read_flash_sr(sl) & (1 << FLASH_SR_BSY);
 272 }
 273
 274 static void wait_flash_busy(stlink_t *sl) {
 275     /* todo: add some delays here */
 276     while (is_flash_busy(sl))
 277         ;
 278 }
 279
 280 static inline unsigned int is_flash_eop(stlink_t *sl) {
 281     return read_flash_sr(sl) & (1 << FLASH_SR_EOP);
 282 }
 283
 284 static void __attribute__((unused)) clear_flash_sr_eop(stlink_t *sl) {
 285     const uint32_t n = read_flash_sr(sl) & ~(1 << FLASH_SR_EOP);
 286     stlink_write_debug32(sl, FLASH_SR, n);
 287 }
 288
 289 static void __attribute__((unused)) wait_flash_eop(stlink_t *sl) {
 290     /* todo: add some delays here */
 291     while (is_flash_eop(sl) == 0)
 292         ;
 293 }
 294
 295 static inline void write_flash_ar(stlink_t *sl, uint32_t n) {
 296     stlink_write_debug32(sl, FLASH_AR, n);
 297 }
 298
 299 static inline void write_flash_cr_psiz(stlink_t *sl, uint32_t n) {
 300     uint32_t x = read_flash_cr(sl);
 301     x &= ~(0x03 << 8);
 302     x |= (n << 8);
 303 #if DEBUG_FLASH
 304     fprintf(stdout, "PSIZ:0x%x 0x%x\n", x, n);
 305 #endif
 306     stlink_write_debug32(sl, FLASH_F4_CR, x);
 307 }
 308
 309
 310 static inline void write_flash_cr_snb(stlink_t *sl, uint32_t n) {
 311     uint32_t x = read_flash_cr(sl);
 312     x &= ~FLASH_F4_CR_SNB_MASK;
 313     x |= (n << FLASH_F4_CR_SNB);
 314     x |= (1 << FLASH_F4_CR_SER);
 315 #if DEBUG_FLASH
 316     fprintf(stdout, "SNB:0x%x 0x%x\n", x, n);
 317 #endif
 318     stlink_write_debug32(sl, FLASH_F4_CR, x);
 319 }
 320
 321 #if 0 /* todo */
 322
 323 static void disable_flash_read_protection(stlink_t *sl) {
 324     /* erase the option byte area */
 325     /* rdp = 0x00a5; */
 326     /* reset */
 327 }
 328 #endif /* todo */
 329
 330
 331 // Delegates to the backends...
 332
 333 void stlink_close(stlink_t *sl) {
 334     DLOG("*** stlink_close ***\n");
 335     sl->backend->close(sl);
 336     free(sl);
 337 }
 338
 339 void stlink_exit_debug_mode(stlink_t *sl) {
 340     DLOG("*** stlink_exit_debug_mode ***\n");
 341     stlink_write_debug32(sl, DHCSR, DBGKEY);
 342     sl->backend->exit_debug_mode(sl);
 343 }
 344
 345 void stlink_enter_swd_mode(stlink_t *sl) {
 346     DLOG("*** stlink_enter_swd_mode ***\n");
 347     sl->backend->enter_swd_mode(sl);
 348 }
 349
 350 // Force the core into the debug mode -> halted state.
 351 void stlink_force_debug(stlink_t *sl) {
 352     DLOG("*** stlink_force_debug_mode ***\n");
 353     sl->backend->force_debug(sl);
 354 }
 355
 356 void stlink_exit_dfu_mode(stlink_t *sl) {
 357     DLOG("*** stlink_exit_dfu_mode ***\n");
 358     sl->backend->exit_dfu_mode(sl);
 359 }
 360
 361 uint32_t stlink_core_id(stlink_t *sl) {
 362     DLOG("*** stlink_core_id ***\n");
 363     sl->backend->core_id(sl);
 364     if (sl->verbose > 2)
 365         stlink_print_data(sl);
 366     DLOG("core_id = 0x%08x\n", sl->core_id);
 367     return sl->core_id;
 368 }
 369
 370 uint32_t stlink_chip_id(stlink_t *sl) {
 371     uint32_t chip_id = stlink_read_debug32(sl, 0xE0042000);
 372     return chip_id;
 373 }
 374
 375 /**
 376  * Cortex m3 tech ref manual, CPUID register description
 377  * @param sl stlink context
 378  * @param cpuid pointer to the result object
 379  */
 380 void stlink_cpu_id(stlink_t *sl, cortex_m3_cpuid_t *cpuid) {
 381     uint32_t raw = stlink_read_debug32(sl, CM3_REG_CPUID);
 382     cpuid->implementer_id = (raw >> 24) & 0x7f;
 383     cpuid->variant = (raw >> 20) & 0xf;
 384     cpuid->part = (raw >> 4) & 0xfff;
 385     cpuid->revision = raw & 0xf;
 386     return;
 387 }
 388
 389 /**
 390  * reads and decodes the flash parameters, as dynamically as possible
 391  * @param sl
 392  * @return 0 for success, or -1 for unsupported core type.
 393  */
 394 int stlink_load_device_params(stlink_t *sl) {
 395     ILOG("Loading device parameters....\n");
 396     const chip_params_t *params = NULL;
 397
 398     sl->core_id = stlink_core_id(sl);
 399     uint32_t chip_id = stlink_chip_id(sl);
 400
 401     /* Fix chip_id for F4 rev A errata */
 402     if (((chip_id & 0xFFF) == 0x411) && (sl->core_id == CORE_M4_R0)) {
 403       chip_id = 0x413;
 404     }
 405
 406     sl->chip_id = chip_id;
 407         for(size_t i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
 408                 if(devices[i].chip_id == (chip_id & 0xFFF)) {
 409                         params = &devices[i];
 410                         break;
 411                 }
 412         }
 413     if (params == NULL) {
 414         WLOG("unknown chip id! %#x\n", chip_id);
 415         return -1;
 416     }
 417
 418     // These are fixed...
 419     sl->flash_base = STM32_FLASH_BASE;
 420     sl->sram_base = STM32_SRAM_BASE;
 421
 422     // read flash size from hardware, if possible...
 423     if ((chip_id & 0xFFF) == STM32_CHIPID_F2) {
 424         sl->flash_size = 0; // FIXME - need to work this out some other way, just set to max possible?
 425     } else if ((chip_id & 0xFFF) == STM32_CHIPID_F4) {
 426                 sl->flash_size = 0x100000;                      //todo: RM0090 error; size register same address as unique ID
 427     } else {
 428         uint32_t flash_size = stlink_read_debug32(sl, params->flash_size_reg) & 0xffff;
 429         sl->flash_size = flash_size * 1024;
 430     }
 431     sl->flash_pgsz = params->flash_pagesize;
 432     sl->sram_size = params->sram_size;
 433     sl->sys_base = params->bootrom_base;
 434     sl->sys_size = params->bootrom_size;
 435
 436     ILOG("Device connected is: %s, id %#x\n", params->description, chip_id);
 437     // TODO make note of variable page size here.....
 438     ILOG("SRAM size: %#x bytes (%d KiB), Flash: %#x bytes (%d KiB) in pages of %zd bytes\n",
 439         sl->sram_size, sl->sram_size / 1024, sl->flash_size, sl->flash_size / 1024,
 440         sl->flash_pgsz);
 441     return 0;
 442 }
 443
 444 void stlink_reset(stlink_t *sl) {
 445     DLOG("*** stlink_reset ***\n");
 446     sl->backend->reset(sl);
 447 }
 448
 449 void stlink_jtag_reset(stlink_t *sl, int value) {
 450     DLOG("*** stlink_jtag_reset ***\n");
 451     sl->backend->jtag_reset(sl, value);
 452 }
 453
 454 void stlink_run(stlink_t *sl) {
 455     DLOG("*** stlink_run ***\n");
 456     sl->backend->run(sl);
 457 }
 458
 459 void stlink_status(stlink_t *sl) {
 460     DLOG("*** stlink_status ***\n");
 461     sl->backend->status(sl);
 462     stlink_core_stat(sl);
 463 }
 464
 465 /**
 466  * Decode the version bits, originally from -sg, verified with usb
 467  * @param sl stlink context, assumed to contain valid data in the buffer
 468  * @param slv output parsed version object
 469  */
 470 void _parse_version(stlink_t *sl, stlink_version_t *slv) {
 471     uint32_t b0 = sl->q_buf[0]; //lsb
 472     uint32_t b1 = sl->q_buf[1];
 473     uint32_t b2 = sl->q_buf[2];
 474     uint32_t b3 = sl->q_buf[3];
 475     uint32_t b4 = sl->q_buf[4];
 476     uint32_t b5 = sl->q_buf[5]; //msb
 477
 478     // b0 b1                       || b2 b3  | b4 b5
 479     // 4b        | 6b     | 6b     || 2B     | 2B
 480     // stlink_v  | jtag_v | swim_v || st_vid | stlink_pid
 481
 482     slv->stlink_v = (b0 & 0xf0) >> 4;
 483     slv->jtag_v = ((b0 & 0x0f) << 2) | ((b1 & 0xc0) >> 6);
 484     slv->swim_v = b1 & 0x3f;
 485     slv->st_vid = (b3 << 8) | b2;
 486     slv->stlink_pid = (b5 << 8) | b4;
 487     return;
 488 }
 489
 490 void stlink_version(stlink_t *sl) {
 491     DLOG("*** looking up stlink version\n");
 492     sl->backend->version(sl);
 493     _parse_version(sl, &sl->version);
 494
 495     DLOG("st vid         = 0x%04x (expect 0x%04x)\n", sl->version.st_vid, USB_ST_VID);
 496     DLOG("stlink pid     = 0x%04x\n", sl->version.stlink_pid);
 497     DLOG("stlink version = 0x%x\n", sl->version.stlink_v);
 498     DLOG("jtag version   = 0x%x\n", sl->version.jtag_v);
 499     DLOG("swim version   = 0x%x\n", sl->version.swim_v);
 500     if (sl->version.jtag_v == 0) {
 501         DLOG("    notice: the firmware doesn't support a jtag/swd interface\n");
 502     }
 503     if (sl->version.swim_v == 0) {
 504         DLOG("    notice: the firmware doesn't support a swim interface\n");
 505     }
 506 }
 507
 508 uint32_t stlink_read_debug32(stlink_t *sl, uint32_t addr) {
 509     uint32_t data = sl->backend->read_debug32(sl, addr);
 510     DLOG("*** stlink_read_debug32 %x is %#x\n", data, addr);
 511     return data;
 512 }
 513
 514 void stlink_write_debug32(stlink_t *sl, uint32_t addr, uint32_t data) {
 515     DLOG("*** stlink_write_debug32 %x to %#x\n", data, addr);
 516     sl->backend->write_debug32(sl, addr, data);
 517 }
 518
 519 void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 520     DLOG("*** stlink_write_mem32 %u bytes to %#x\n", len, addr);
 521     if (len % 4 != 0) {
 522         fprintf(stderr, "Error: Data length doesn't have a 32 bit alignment: +%d byte.\n", len % 4);
 523         return;
 524     }
 525     sl->backend->write_mem32(sl, addr, len);
 526 }
 527
 528 void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len) {
 529     DLOG("*** stlink_read_mem32 ***\n");
 530     if (len % 4 != 0) { // !!! never ever: fw gives just wrong values
 531         fprintf(stderr, "Error: Data length doesn't have a 32 bit alignment: +%d byte.\n",
 532                 len % 4);
 533         return;
 534     }
 535     sl->backend->read_mem32(sl, addr, len);
 536 }
 537
 538 void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len) {
 539     DLOG("*** stlink_write_mem8 ***\n");
 540     sl->backend->write_mem8(sl, addr, len);
 541 }
 542
 543 void stlink_read_all_regs(stlink_t *sl, reg *regp) {
 544     DLOG("*** stlink_read_all_regs ***\n");
 545     sl->backend->read_all_regs(sl, regp);
 546 }
 547
 548 void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx) {
 549     DLOG("*** stlink_write_reg\n");
 550     sl->backend->write_reg(sl, reg, idx);
 551 }
 552
 553 void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp) {
 554     DLOG("*** stlink_read_reg\n");
 555     DLOG(" (%d) ***\n", r_idx);
 556
 557     if (r_idx > 20 || r_idx < 0) {
 558         fprintf(stderr, "Error: register index must be in [0..20]\n");
 559         return;
 560     }
 561
 562     sl->backend->read_reg(sl, r_idx, regp);
 563 }
 564
 565 unsigned int is_core_halted(stlink_t *sl) {
 566     /* return non zero if core is halted */
 567     stlink_status(sl);
 568     return sl->q_buf[0] == STLINK_CORE_HALTED;
 569 }
 570
 571 void stlink_step(stlink_t *sl) {
 572     DLOG("*** stlink_step ***\n");
 573     sl->backend->step(sl);
 574 }
 575
 576 int stlink_current_mode(stlink_t *sl) {
 577     int mode = sl->backend->current_mode(sl);
 578     switch (mode) {
 579         case STLINK_DEV_DFU_MODE:
 580             DLOG("stlink current mode: dfu\n");
 581             return mode;
 582         case STLINK_DEV_DEBUG_MODE:
 583             DLOG("stlink current mode: debug (jtag or swd)\n");
 584             return mode;
 585         case STLINK_DEV_MASS_MODE:
 586             DLOG("stlink current mode: mass\n");
 587             return mode;
 588     }
 589     DLOG("stlink mode: unknown!\n");
 590     return STLINK_DEV_UNKNOWN_MODE;
 591 }
 592
 593
 594
 595
 596 // End of delegates....  Common code below here...
 597
 598 // Endianness
 599 // http://www.ibm.com/developerworks/aix/library/au-endianc/index.html
 600 // const int i = 1;
 601 // #define is_bigendian() ( (*(char*)&i) == 0 )
 602
 603 inline unsigned int is_bigendian(void) {
 604     static volatile const unsigned int i = 1;
 605     return *(volatile const char*) &i == 0;
 606 }
 607
 608 uint16_t read_uint16(const unsigned char *c, const int pt) {
 609     uint32_t ui;
 610     char *p = (char *) &ui;
 611
 612     if (!is_bigendian()) { // le -> le (don't swap)
 613         p[0] = c[pt + 0];
 614         p[1] = c[pt + 1];
 615     } else {
 616         p[0] = c[pt + 1];
 617         p[1] = c[pt + 0];
 618     }
 619     return ui;
 620 }
 621
 622 // same as above with entrypoint.
 623
 624 void stlink_run_at(stlink_t *sl, stm32_addr_t addr) {
 625     stlink_write_reg(sl, addr, 15); /* pc register */
 626
 627     stlink_run(sl);
 628
 629     while (is_core_halted(sl) == 0)
 630         usleep(3000000);
 631 }
 632
 633 void stlink_core_stat(stlink_t *sl) {
 634     if (sl->q_len <= 0)
 635         return;
 636
 637     switch (sl->q_buf[0]) {
 638         case STLINK_CORE_RUNNING:
 639             sl->core_stat = STLINK_CORE_RUNNING;
 640             DLOG("  core status: running\n");
 641             return;
 642         case STLINK_CORE_HALTED:
 643             sl->core_stat = STLINK_CORE_HALTED;
 644             DLOG("  core status: halted\n");
 645             return;
 646         default:
 647             sl->core_stat = STLINK_CORE_STAT_UNKNOWN;
 648             fprintf(stderr, "  core status: unknown\n");
 649     }
 650 }
 651
 652 void stlink_print_data(stlink_t * sl) {
 653     if (sl->q_len <= 0 || sl->verbose < UDEBUG)
 654         return;
 655     if (sl->verbose > 2)
 656         fprintf(stdout, "data_len = %d 0x%x\n", sl->q_len, sl->q_len);
 657
 658     for (int i = 0; i < sl->q_len; i++) {
 659         if (i % 16 == 0) {
 660             /*
 661                                     if (sl->q_data_dir == Q_DATA_OUT)
 662                                             fprintf(stdout, "\n<- 0x%08x ", sl->q_addr + i);
 663                                     else
 664                                             fprintf(stdout, "\n-> 0x%08x ", sl->q_addr + i);
 665              */
 666         }
 667         fprintf(stdout, " %02x", (unsigned int) sl->q_buf[i]);
 668     }
 669     fputs("\n\n", stdout);
 670 }
 671
 672 /* memory mapped file */
 673
 674 typedef struct mapped_file {
 675     uint8_t* base;
 676     size_t len;
 677 } mapped_file_t;
 678
 679 #define MAPPED_FILE_INITIALIZER { NULL, 0 }
 680
 681 static int map_file(mapped_file_t* mf, const char* path) {
 682     int error = -1;
 683     struct stat st;
 684
 685     const int fd = open(path, O_RDONLY);
 686     if (fd == -1) {
 687         fprintf(stderr, "open(%s) == -1\n", path);
 688         return -1;
 689     }
 690
 691     if (fstat(fd, &st) == -1) {
 692         fprintf(stderr, "fstat() == -1\n");
 693         goto on_error;
 694     }
 695
 696     mf->base = (uint8_t*) mmap(NULL, st.st_size, PROT_READ, MAP_SHARED, fd, 0);
 697     if (mf->base == MAP_FAILED) {
 698         fprintf(stderr, "mmap() == MAP_FAILED\n");
 699         goto on_error;
 700     }
 701
 702     mf->len = st.st_size;
 703
 704     /* success */
 705     error = 0;
 706
 707 on_error:
 708     close(fd);
 709
 710     return error;
 711 }
 712
 713 static void unmap_file(mapped_file_t * mf) {
 714     munmap((void*) mf->base, mf->len);
 715     mf->base = (unsigned char*) MAP_FAILED;
 716     mf->len = 0;
 717 }
 718
 719 static int check_file(stlink_t* sl, mapped_file_t* mf, stm32_addr_t addr) {
 720     size_t off;
 721
 722     for (off = 0; off < mf->len; off += sl->flash_pgsz) {
 723         size_t aligned_size;
 724
 725         /* adjust last page size */
 726         size_t cmp_size = sl->flash_pgsz;
 727         if ((off + sl->flash_pgsz) > mf->len)
 728             cmp_size = mf->len - off;
 729
 730         aligned_size = cmp_size;
 731         if (aligned_size & (4 - 1))
 732             aligned_size = (cmp_size + 4) & ~(4 - 1);
 733
 734         stlink_read_mem32(sl, addr + off, aligned_size);
 735
 736         if (memcmp(sl->q_buf, mf->base + off, cmp_size))
 737             return -1;
 738     }
 739
 740     return 0;
 741 }
 742
 743 int stlink_fwrite_sram
 744 (stlink_t * sl, const char* path, stm32_addr_t addr) {
 745     /* write the file in sram at addr */
 746
 747     int error = -1;
 748     size_t off;
 749     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
 750
 751     if (map_file(&mf, path) == -1) {
 752         fprintf(stderr, "map_file() == -1\n");
 753         return -1;
 754     }
 755
 756     /* check addr range is inside the sram */
 757     if (addr < sl->sram_base) {
 758         fprintf(stderr, "addr too low\n");
 759         goto on_error;
 760     } else if ((addr + mf.len) < addr) {
 761         fprintf(stderr, "addr overruns\n");
 762         goto on_error;
 763     } else if ((addr + mf.len) > (sl->sram_base + sl->sram_size)) {
 764         fprintf(stderr, "addr too high\n");
 765         goto on_error;
 766     } else if ((addr & 3) || (mf.len & 3)) {
 767         /* todo */
 768         fprintf(stderr, "unaligned addr or size\n");
 769         goto on_error;
 770     }
 771
 772     /* do the copy by 1k blocks */
 773     for (off = 0; off < mf.len; off += 1024) {
 774         size_t size = 1024;
 775         if ((off + size) > mf.len)
 776             size = mf.len - off;
 777
 778         memcpy(sl->q_buf, mf.base + off, size);
 779
 780         /* round size if needed */
 781         if (size & 3)
 782             size += 2;
 783
 784         stlink_write_mem32(sl, addr + off, size);
 785     }
 786
 787     /* check the file ha been written */
 788     if (check_file(sl, &mf, addr) == -1) {
 789         fprintf(stderr, "check_file() == -1\n");
 790         goto on_error;
 791     }
 792
 793     /* success */
 794     error = 0;
 795
 796 on_error:
 797     unmap_file(&mf);
 798     return error;
 799 }
 800
 801 int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size) {
 802     /* read size bytes from addr to file */
 803
 804     int error = -1;
 805     size_t off;
 806     int num_zero = 0;
 807
 808     const int fd = open(path, O_RDWR | O_TRUNC | O_CREAT, 00700);
 809     if (fd == -1) {
 810         fprintf(stderr, "open(%s) == -1\n", path);
 811         return -1;
 812     }
 813
 814     /* do the copy by 1k blocks */
 815     for (off = 0; off < size; off += 1024) {
 816         size_t read_size = 1024;
 817         size_t rounded_size;
 818         size_t index;
 819         if ((off + read_size) > size)
 820           read_size = size - off;
 821
 822         /* round size if needed */
 823         rounded_size = read_size;
 824         if (rounded_size & 3)
 825           rounded_size = (rounded_size + 4) & ~(3);
 826
 827         stlink_read_mem32(sl, addr + off, rounded_size);
 828
 829         for(index = 0; index < read_size; index ++) {
 830             if (sl->q_buf[index] == 0)
 831                 num_zero ++;
 832             else
 833                 num_zero = 0;
 834         }
 835         if (write(fd, sl->q_buf, read_size) != (ssize_t) read_size) {
 836             fprintf(stderr, "write() != read_size\n");
 837             goto on_error;
 838         }
 839     }
 840
 841     /* Ignore NULL Bytes at end of file */
 842     ftruncate(fd, size - num_zero);
 843
 844     /* success */
 845     error = 0;
 846
 847 on_error:
 848     close(fd);
 849
 850     return error;
 851 }
 852
 853 int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size) {
 854     /* write the buffer right after the loader */
 855     memcpy(sl->q_buf, buf, size);
 856     stlink_write_mem8(sl, fl->buf_addr, size);
 857     return 0;
 858 }
 859
 860 uint32_t calculate_F4_sectornum(uint32_t flashaddr){
 861     flashaddr &= ~STM32_FLASH_BASE;     //Page now holding the actual flash address
 862     if (flashaddr<0x4000) return (0);
 863     else if(flashaddr<0x8000) return(1);
 864     else if(flashaddr<0xc000) return(2);
 865     else if(flashaddr<0x10000) return(3);
 866     else if(flashaddr<0x20000) return(4);
 867     else return(flashaddr/0x20000)+4;
 868
 869 }
 870
 871 uint32_t stlink_calculate_pagesize(stlink_t *sl, uint32_t flashaddr){
 872         if(sl->chip_id == STM32F4_CHIP_ID) {
 873                 uint32_t sector=calculate_F4_sectornum(flashaddr);
 874                 if (sector<4) sl->flash_pgsz=0x4000;
 875                 else if(sector<5) sl->flash_pgsz=0x10000;
 876                 else sl->flash_pgsz=0x20000;
 877         }
 878         return (sl->flash_pgsz);
 879 }
 880
 881 /**
 882  * Erase a page of flash, assumes sl is fully populated with things like chip/core ids
 883  * @param sl stlink context
 884  * @param flashaddr an address in the flash page to erase
 885  * @return 0 on success -ve on failure
 886  */
 887 int stlink_erase_flash_page(stlink_t *sl, stm32_addr_t flashaddr)
 888 {
 889   ILOG("Erasing flash page at addr: %#x\n", flashaddr);
 890   if (sl->chip_id == STM32F4_CHIP_ID)
 891   {
 892     /* wait for ongoing op to finish */
 893     wait_flash_busy(sl);
 894
 895     /* unlock if locked */
 896     unlock_flash_if(sl);
 897
 898     /* select the page to erase */
 899     // calculate the actual page from the address
 900     uint32_t sector=calculate_F4_sectornum(flashaddr);
 901
 902     fprintf(stderr, "EraseFlash - Sector:0x%x Size:0x%x\n", sector, stlink_calculate_pagesize(sl, flashaddr));
 903     write_flash_cr_snb(sl, sector);
 904
 905     /* start erase operation */
 906     set_flash_cr_strt(sl);
 907
 908     /* wait for completion */
 909     wait_flash_busy(sl);
 910
 911     /* relock the flash */
 912     //todo: fails to program if this is in
 913     lock_flash(sl);
 914 #if DEBUG_FLASH
 915         fprintf(stdout, "Erase Final CR:0x%x\n", read_flash_cr(sl));
 916 #endif
 917   }
 918   else if (sl->core_id == STM32L_CORE_ID)
 919   {
 920
 921     uint32_t val;
 922
 923     /* disable pecr protection */
 924     stlink_write_debug32(sl, STM32L_FLASH_PEKEYR, 0x89abcdef);
 925     stlink_write_debug32(sl, STM32L_FLASH_PEKEYR, 0x02030405);
 926
 927     /* check pecr.pelock is cleared */
 928     val = stlink_read_debug32(sl, STM32L_FLASH_PECR);
 929     if (val & (1 << 0))
 930     {
 931       WLOG("pecr.pelock not clear (%#x)\n", val);
 932       return -1;
 933     }
 934
 935     /* unlock program memory */
 936     stlink_write_debug32(sl, STM32L_FLASH_PRGKEYR, 0x8c9daebf);
 937     stlink_write_debug32(sl, STM32L_FLASH_PRGKEYR, 0x13141516);
 938
 939     /* check pecr.prglock is cleared */
 940     val = stlink_read_debug32(sl, STM32L_FLASH_PECR);
 941     if (val & (1 << 1))
 942     {
 943       WLOG("pecr.prglock not clear (%#x)\n", val);
 944       return -1;
 945     }
 946
 947     /* unused: unlock the option byte block */
 948 #if 0
 949     stlink_write_debug32(sl, STM32L_FLASH_OPTKEYR, 0xfbead9c8);
 950     stlink_write_debug32(sl, STM32L_FLASH_OPTKEYR, 0x24252627);
 951
 952     /* check pecr.optlock is cleared */
 953     val = stlink_read_debug32(sl, STM32L_FLASH_PECR);
 954     if (val & (1 << 2))
 955     {
 956       fprintf(stderr, "pecr.prglock not clear\n");
 957       return -1;
 958     }
 959 #endif
 960
 961     /* set pecr.{erase,prog} */
 962     val |= (1 << 9) | (1 << 3);
 963     stlink_write_debug32(sl, STM32L_FLASH_PECR, val);
 964
 965 #if 0 /* fix_to_be_confirmed */
 966
 967     /* wait for sr.busy to be cleared
 968        MP: Test shows that busy bit is not set here. Perhaps, PM0062 is
 969        wrong and we do not need to wait here for clearing the busy bit.
 970        TEXANE: ok, if experience says so and it works for you, we comment
 971        it. If someone has a problem, please drop an email.
 972      */
 973     while ((stlink_read_debug32(sl, STM32L_FLASH_SR) & (1 << 0)) != 0)
 974     {
 975     }
 976
 977 #endif /* fix_to_be_confirmed */
 978
 979     /* write 0 to the first word of the page to be erased */
 980     stlink_write_debug32(sl, flashaddr, 0);
 981
 982     /* MP: It is better to wait for clearing the busy bit after issuing
 983     page erase command, even though PM0062 recommends to wait before it.
 984     Test shows that a few iterations is performed in the following loop
 985     before busy bit is cleared.*/
 986     while ((stlink_read_debug32(sl, STM32L_FLASH_SR) & (1 << 0)) != 0)
 987     {
 988     }
 989
 990     /* reset lock bits */
 991     val = stlink_read_debug32(sl, STM32L_FLASH_PECR)
 992         | (1 << 0) | (1 << 1) | (1 << 2);
 993     stlink_write_debug32(sl, STM32L_FLASH_PECR, val);
 994   }
 995   else if (sl->core_id == STM32VL_CORE_ID)
 996   {
 997     /* wait for ongoing op to finish */
 998     wait_flash_busy(sl);
 999
1000     /* unlock if locked */
1001     unlock_flash_if(sl);
1002
1003     /* set the page erase bit */
1004     set_flash_cr_per(sl);
1005
1006     /* select the page to erase */
1007     write_flash_ar(sl, flashaddr);
1008
1009     /* start erase operation, reset by hw with bsy bit */
1010     set_flash_cr_strt(sl);
1011
1012     /* wait for completion */
1013     wait_flash_busy(sl);
1014
1015     /* relock the flash */
1016     lock_flash(sl);
1017   }
1018
1019   else {
1020     WLOG("unknown coreid: %x\n", sl->core_id);
1021     return -1;
1022   }
1023
1024   /* todo: verify the erased page */
1025
1026   return 0;
1027 }
1028
1029 int stlink_erase_flash_mass(stlink_t *sl) {
1030     /* wait for ongoing op to finish */
1031     wait_flash_busy(sl);
1032
1033     /* unlock if locked */
1034     unlock_flash_if(sl);
1035
1036     /* set the mass erase bit */
1037     set_flash_cr_mer(sl);
1038
1039     /* start erase operation, reset by hw with bsy bit */
1040     set_flash_cr_strt(sl);
1041
1042     /* wait for completion */
1043     wait_flash_busy(sl);
1044
1045     /* relock the flash */
1046     lock_flash(sl);
1047
1048     /* todo: verify the erased memory */
1049
1050     return 0;
1051 }
1052
1053 int init_flash_loader(stlink_t *sl, flash_loader_t* fl) {
1054     size_t size;
1055
1056     /* allocate the loader in sram */
1057     if (write_loader_to_sram(sl, &fl->loader_addr, &size) == -1) {
1058         WLOG("Failed to write flash loader to sram!\n");
1059         return -1;
1060     }
1061
1062     /* allocate a one page buffer in sram right after loader */
1063     fl->buf_addr = fl->loader_addr + size;
1064     ILOG("Successfully loaded flash loader in sram\n");
1065     return 0;
1066 }
1067
1068 int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size) {
1069     /* from openocd, contrib/loaders/flash/stm32.s */
1070     static const uint8_t loader_code_stm32vl[] = {
1071         0x08, 0x4c, /* ldr      r4, STM32_FLASH_BASE */
1072         0x1c, 0x44, /* add      r4, r3 */
1073         /* write_half_word: */
1074         0x01, 0x23, /* movs     r3, #0x01 */
1075         0x23, 0x61, /* str      r3, [r4, #STM32_FLASH_CR_OFFSET] */
1076         0x30, 0xf8, 0x02, 0x3b, /* ldrh r3, [r0], #0x02 */
1077         0x21, 0xf8, 0x02, 0x3b, /* strh r3, [r1], #0x02 */
1078         /* busy: */
1079         0xe3, 0x68, /* ldr      r3, [r4, #STM32_FLASH_SR_OFFSET] */
1080         0x13, 0xf0, 0x01, 0x0f, /* tst  r3, #0x01 */
1081         0xfb, 0xd0, /* beq      busy */
1082         0x13, 0xf0, 0x14, 0x0f, /* tst  r3, #0x14 */
1083         0x01, 0xd1, /* bne      exit */
1084         0x01, 0x3a, /* subs     r2, r2, #0x01 */
1085         0xf0, 0xd1, /* bne      write_half_word */
1086         /* exit: */
1087         0x00, 0xbe, /* bkpt     #0x00 */
1088         0x00, 0x20, 0x02, 0x40, /* STM32_FLASH_BASE: .word 0x40022000 */
1089     };
1090
1091     static const uint8_t loader_code_stm32l[] = {
1092
1093       /* openocd.git/contrib/loaders/flash/stm32lx.S
1094          r0, input, dest addr
1095          r1, input, source addr
1096          r2, input, word count
1097          r3, output, word count
1098        */
1099
1100       0x00, 0x23,
1101       0x04, 0xe0,
1102
1103       0x51, 0xf8, 0x04, 0xcb,
1104       0x40, 0xf8, 0x04, 0xcb,
1105       0x01, 0x33,
1106
1107       0x93, 0x42,
1108       0xf8, 0xd3,
1109       0x00, 0xbe
1110     };
1111
1112     const uint8_t* loader_code;
1113     size_t loader_size;
1114
1115     if (sl->core_id == STM32L_CORE_ID) /* stm32l */
1116     {
1117       loader_code = loader_code_stm32l;
1118       loader_size = sizeof(loader_code_stm32l);
1119     }
1120     else if (sl->core_id == STM32VL_CORE_ID)
1121     {
1122       loader_code = loader_code_stm32vl;
1123       loader_size = sizeof(loader_code_stm32vl);
1124     }
1125     else
1126     {
1127       WLOG("unknown coreid, not sure what flash loader to use, aborting!: %x\n", sl->core_id);
1128       return -1;
1129     }
1130
1131     memcpy(sl->q_buf, loader_code, loader_size);
1132     stlink_write_mem32(sl, sl->sram_base, loader_size);
1133
1134     *addr = sl->sram_base;
1135     *size = loader_size;
1136
1137     /* success */
1138     return 0;
1139 }
1140
1141 int stlink_fcheck_flash(stlink_t *sl, const char* path, stm32_addr_t addr) {
1142     /* check the contents of path are at addr */
1143
1144     int res;
1145     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
1146
1147     if (map_file(&mf, path) == -1)
1148         return -1;
1149
1150     res = check_file(sl, &mf, addr);
1151
1152     unmap_file(&mf);
1153
1154     return res;
1155 }
1156
1157 /**
1158  * Verify addr..addr+len is binary identical to base...base+len
1159  * @param sl stlink context
1160  * @param address stm device address
1161  * @param data host side buffer to check against
1162  * @param length how much
1163  * @return 0 for success, -ve for failure
1164  */
1165 int stlink_verify_write_flash(stlink_t *sl, stm32_addr_t address, uint8_t *data, unsigned length) {
1166     size_t off;
1167     if ((sl->chip_id & 0xFFF) == STM32_CHIPID_F4) {
1168         DLOG("(FIXME)Skipping verification for F4, not enough ram (yet)\n");
1169         return 0;
1170     }
1171     ILOG("Starting verification of write complete\n");
1172     for (off = 0; off < length; off += sl->flash_pgsz) {
1173         size_t aligned_size;
1174
1175         /* adjust last page size */
1176         size_t cmp_size = sl->flash_pgsz;
1177         if ((off + sl->flash_pgsz) > length)
1178             cmp_size = length - off;
1179
1180         aligned_size = cmp_size;
1181         if (aligned_size & (4 - 1))
1182             aligned_size = (cmp_size + 4) & ~(4 - 1);
1183
1184         stlink_read_mem32(sl, address + off, aligned_size);
1185
1186         if (memcmp(sl->q_buf, data + off, cmp_size)) {
1187             WLOG("Verification of flash failed at offset: %zd\n", off);
1188             return -1;
1189         }
1190     }
1191     ILOG("Flash written and verified! jolly good!\n");
1192     return 0;
1193
1194 }
1195
1196 int stlink_write_flash(stlink_t *sl, stm32_addr_t addr, uint8_t* base, unsigned len) {
1197     size_t off;
1198     flash_loader_t fl;
1199     ILOG("Attempting to write %d (%#x) bytes to stm32 address: %u (%#x)\n",
1200         len, len, addr, addr);
1201     /* check addr range is inside the flash */
1202     stlink_calculate_pagesize(sl, addr);
1203     if (addr < sl->flash_base) {
1204         WLOG("addr too low %#x < %#x\n", addr, sl->flash_base);
1205         return -1;
1206     } else if ((addr + len) < addr) {
1207         WLOG("addr overruns\n");
1208         return -1;
1209     } else if ((addr + len) > (sl->flash_base + sl->flash_size)) {
1210         WLOG("addr too high\n");
1211         return -1;
1212     } else if ((addr & 1) || (len & 1)) {
1213         WLOG("unaligned addr or size\n");
1214         return -1;
1215     } else if (addr & (sl->flash_pgsz - 1)) {
1216         WLOG("addr not a multiple of pagesize, not supported\n");
1217         return -1;
1218     }
1219
1220     // Make sure we've loaded the context with the chip details
1221     stlink_core_id(sl);
1222     /* erase each page */
1223     int page_count = 0;
1224     for (off = 0; off < len; off += stlink_calculate_pagesize(sl, addr + off)) {
1225         /* addr must be an addr inside the page */
1226         if (stlink_erase_flash_page(sl, addr + off) == -1) {
1227             WLOG("Failed to erase_flash_page(%#zx) == -1\n", addr + off);
1228             return -1;
1229         }
1230         page_count++;
1231     }
1232     ILOG("Finished erasing %d pages of %d (%#x) bytes\n",
1233         page_count, sl->flash_pgsz, sl->flash_pgsz);
1234
1235     if (sl->chip_id == STM32F4_CHIP_ID) {
1236         /* todo: check write operation */
1237
1238         /* First unlock the cr */
1239         unlock_flash_if(sl);
1240
1241         /* set parallelisim to 32 bit*/
1242         write_flash_cr_psiz(sl, 2);
1243
1244         /* set programming mode */
1245         set_flash_cr_pg(sl);
1246
1247 #define PROGRESS_CHUNK_SIZE 0x1000
1248         /* write a word in program memory */
1249         for (off = 0; off < len; off += sizeof(uint32_t)) {
1250                 uint32_t data;
1251                 if (sl->verbose >= 1) {
1252                         if ((off & (PROGRESS_CHUNK_SIZE - 1)) == 0) {
1253                                 /* show progress. writing procedure is slow
1254                                            and previous errors are misleading */
1255                                 const uint32_t pgnum = (off / PROGRESS_CHUNK_SIZE)+1;
1256                                 const uint32_t pgcount = len / PROGRESS_CHUNK_SIZE;
1257                                 fprintf(stdout, "Writing %ukB chunk %u out of %u\n", PROGRESS_CHUNK_SIZE/1024, pgnum, pgcount);
1258                         }
1259                 }
1260
1261                 write_uint32((unsigned char*) &data, *(uint32_t*) (base + off));
1262                 stlink_write_debug32(sl, addr + off, data);
1263
1264                 /* wait for sr.busy to be cleared */
1265             wait_flash_busy(sl);
1266
1267         }
1268         /* Relock flash */
1269         lock_flash(sl);
1270
1271 #if 0 /* todo: debug mode */
1272         fprintf(stdout, "Final CR:0x%x\n", read_flash_cr(sl));
1273 #endif
1274
1275
1276
1277     }   //STM32F4END
1278
1279     else if (sl->core_id == STM32L_CORE_ID)    {
1280         /* use fast word write. todo: half page. */
1281         uint32_t val;
1282
1283 #if 0 /* todo: check write operation */
1284
1285         uint32_t nwrites = sl->flash_pgsz;
1286
1287         redo_write:
1288
1289 #endif /* todo: check write operation */
1290
1291         /* disable pecr protection */
1292         stlink_write_debug32(sl, STM32L_FLASH_PEKEYR, 0x89abcdef);
1293         stlink_write_debug32(sl, STM32L_FLASH_PEKEYR, 0x02030405);
1294
1295         /* check pecr.pelock is cleared */
1296         val = stlink_read_debug32(sl, STM32L_FLASH_PECR);
1297         if (val & (1 << 0)) {
1298                 fprintf(stderr, "pecr.pelock not clear\n");
1299                 return -1;
1300         }
1301
1302         /* unlock program memory */
1303         stlink_write_debug32(sl, STM32L_FLASH_PRGKEYR, 0x8c9daebf);
1304         stlink_write_debug32(sl, STM32L_FLASH_PRGKEYR, 0x13141516);
1305
1306         /* check pecr.prglock is cleared */
1307         val = stlink_read_debug32(sl, STM32L_FLASH_PECR);
1308         if (val & (1 << 1)) {
1309                 fprintf(stderr, "pecr.prglock not clear\n");
1310                 return -1;
1311         }
1312
1313         /* write a word in program memory */
1314         for (off = 0; off < len; off += sizeof(uint32_t)) {
1315                 uint32_t data;
1316                 if (sl->verbose >= 1) {
1317                         if ((off & (sl->flash_pgsz - 1)) == 0) {
1318                                 /* show progress. writing procedure is slow
1319                                    and previous errors are misleading */
1320                                 const uint32_t pgnum = off / sl->flash_pgsz;
1321                                 const uint32_t pgcount = len / sl->flash_pgsz;
1322                                 fprintf(stdout, "%u pages written out of %u\n", pgnum, pgcount);
1323                         }
1324                 }
1325
1326                 write_uint32((unsigned char*) &data, *(uint32_t*) (base + off));
1327                 stlink_write_debug32(sl, addr + off, data);
1328
1329                 /* wait for sr.busy to be cleared */
1330                 while ((stlink_read_debug32(sl, STM32L_FLASH_SR) & (1 << 0)) != 0) {
1331                 }
1332
1333 #if 0 /* todo: check redo write operation */
1334
1335                 /* check written bytes. todo: should be on a per page basis. */
1336                 data = stlink_read_debug32(sl, addr + off);
1337                 if (data == *(uint32_t*)(base + off)) {
1338                         /* re erase the page and redo the write operation */
1339                         uint32_t page;
1340                         uint32_t val;
1341
1342                         /* fail if successive write count too low */
1343                         if (nwrites < sl->flash_pgsz) {
1344                                 fprintf(stderr, "writes operation failure count too high, aborting\n");
1345                                 return -1;
1346                         }
1347
1348                         nwrites = 0;
1349
1350                         /* assume addr aligned */
1351                         if (off % sl->flash_pgsz) off &= ~(sl->flash_pgsz - 1);
1352                         page = addr + off;
1353
1354                         fprintf(stderr, "invalid write @0x%x(0x%x): 0x%x != 0x%x. retrying.\n",
1355                                         page, addr + off, read_uint32(base + off, 0), read_uint32(sl->q_buf, 0));
1356
1357                         /* reset lock bits */
1358                         val = stlink_read_debug32(sl, STM32L_FLASH_PECR)
1359                              | (1 << 0) | (1 << 1) | (1 << 2);
1360                         stlink_write_debug32(sl, STM32L_FLASH_PECR, val);
1361
1362                         stlink_erase_flash_page(sl, page);
1363
1364                         goto redo_write;
1365                 }
1366
1367                 /* increment successive writes counter */
1368                 ++nwrites;
1369
1370 #endif /* todo: check redo write operation */
1371         }
1372         /* reset lock bits */
1373         val = stlink_read_debug32(sl, STM32L_FLASH_PECR)
1374              | (1 << 0) | (1 << 1) | (1 << 2);
1375         stlink_write_debug32(sl, STM32L_FLASH_PECR, val);
1376     } else if (sl->core_id == STM32VL_CORE_ID) {
1377         ILOG("Starting Flash write for VL core id\n");
1378         /* flash loader initialization */
1379         if (init_flash_loader(sl, &fl) == -1) {
1380             WLOG("init_flash_loader() == -1\n");
1381             return -1;
1382         }
1383
1384         /* write each page. above WRITE_BLOCK_SIZE fails? */
1385 #define WRITE_BLOCK_SIZE 0x40
1386         int write_block_count = 0;
1387         for (off = 0; off < len; off += WRITE_BLOCK_SIZE) {
1388             ILOG("Writing flash block %d of size %d (%#x)\n", write_block_count,
1389                 WRITE_BLOCK_SIZE, WRITE_BLOCK_SIZE);
1390             /* adjust last write size */
1391             size_t size = WRITE_BLOCK_SIZE;
1392             if ((off + WRITE_BLOCK_SIZE) > len) size = len - off;
1393
1394             /* unlock and set programming mode */
1395             unlock_flash_if(sl);
1396             set_flash_cr_pg(sl);
1397             //DLOG("Finished setting flash cr pg, running loader!\n");
1398             if (run_flash_loader(sl, &fl, addr + off, base + off, size) == -1) {
1399                 WLOG("run_flash_loader(%#zx) failed! == -1\n", addr + off);
1400                 return -1;
1401             }
1402             lock_flash(sl);
1403             DLOG("Finished writing block %d\n", write_block_count++);
1404         }
1405     } else {
1406         WLOG("unknown coreid, not sure how to write: %x\n", sl->core_id);
1407         return -1;
1408     }
1409
1410     return stlink_verify_write_flash(sl, addr, base, len);
1411 }
1412
1413 /**
1414  * Write the given binary file into flash at address "addr"
1415  * @param sl
1416  * @param path readable file path, should be binary image
1417  * @param addr where to start writing
1418  * @return 0 on success, -ve on failure.
1419  */
1420 int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr) {
1421     /* write the file in flash at addr */
1422     int err;
1423     unsigned int num_zero = 0, index;
1424     mapped_file_t mf = MAPPED_FILE_INITIALIZER;
1425     if (map_file(&mf, path) == -1) {
1426         WLOG("map_file() == -1\n");
1427         return -1;
1428     }
1429     for(index = 0; index < mf.len; index ++) {
1430         if (mf.base[index] == 0)
1431             num_zero ++;
1432         else
1433             num_zero = 0;
1434     }
1435     if(num_zero != 0) {
1436         ILOG("Ignoring %d bytes of Zeros at end of file\n",num_zero);
1437         mf.len -= num_zero;
1438     }
1439     err = stlink_write_flash(sl, addr, mf.base, mf.len);
1440     unmap_file(&mf);
1441     return err;
1442 }
1443
1444 int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size) {
1445
1446     reg rr;
1447     DLOG("Running flash loader, write address:%#x, size: %zd\n", target, size);
1448     // FIXME This can never return -1
1449     if (write_buffer_to_sram(sl, fl, buf, size) == -1) {
1450         // IMPOSSIBLE!
1451         WLOG("write_buffer_to_sram() == -1\n");
1452         return -1;
1453     }
1454
1455     if (sl->core_id == STM32L_CORE_ID) {
1456
1457       size_t count = size / sizeof(uint32_t);
1458       if (size % sizeof(uint32_t)) ++count;
1459
1460       /* setup core */
1461       stlink_write_reg(sl, target, 0); /* target */
1462       stlink_write_reg(sl, fl->buf_addr, 1); /* source */
1463       stlink_write_reg(sl, count, 2); /* count (32 bits words) */
1464       stlink_write_reg(sl, 0, 3); /* output count */
1465       stlink_write_reg(sl, fl->loader_addr, 15); /* pc register */
1466
1467     } else if (sl->core_id == STM32VL_CORE_ID) {
1468
1469       size_t count = size / sizeof(uint16_t);
1470       if (size % sizeof(uint16_t)) ++count;
1471
1472       /* setup core */
1473       stlink_write_reg(sl, fl->buf_addr, 0); /* source */
1474       stlink_write_reg(sl, target, 1); /* target */
1475       stlink_write_reg(sl, count, 2); /* count (16 bits half words) */
1476       stlink_write_reg(sl, 0, 3); /* flash bank 0 (input) */
1477       stlink_write_reg(sl, fl->loader_addr, 15); /* pc register */
1478
1479     } else {
1480       fprintf(stderr, "unknown coreid: 0x%x\n", sl->core_id);
1481       return -1;
1482     }
1483
1484     /* run loader */
1485     stlink_run(sl);
1486
1487     /* wait until done (reaches breakpoint) */
1488     while (is_core_halted(sl) == 0) ;
1489
1490     /* check written byte count */
1491     if (sl->core_id == STM32L_CORE_ID) {
1492
1493       size_t count = size / sizeof(uint32_t);
1494       if (size % sizeof(uint32_t)) ++count;
1495
1496       stlink_read_reg(sl, 3, &rr);
1497       if (rr.r[3] != count) {
1498         fprintf(stderr, "write error, count == %u\n", rr.r[3]);
1499         return -1;
1500       }
1501
1502     } else if (sl->core_id == STM32VL_CORE_ID) {
1503
1504       stlink_read_reg(sl, 2, &rr);
1505       if (rr.r[2] != 0) {
1506         fprintf(stderr, "write error, count == %u\n", rr.r[2]);
1507         return -1;
1508       }
1509
1510     } else {
1511
1512       fprintf(stderr, "unknown coreid: 0x%x\n", sl->core_id);
1513       return -1;
1514
1515     }
1516
1517     return 0;
1518 }