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