2 * File: stlink-common.h
3 * Bulk import from stlink-hw.h
5 * This should contain all the common top level stlink interfaces, regardless
6 * of how the backend does the work....
9 #ifndef STLINK_COMMON_H
10 #define STLINK_COMMON_H
18 // Max data transfer size.
19 // 6kB = max mem32_read block, 8kB sram
20 //#define Q_BUF_LEN 96
21 #define Q_BUF_LEN (1024 * 100)
23 // st-link vendor cmd's
24 #define USB_ST_VID 0x0483
25 #define USB_STLINK_PID 0x3744
26 #define USB_STLINK_32L_PID 0x3748
28 // STLINK_DEBUG_RESETSYS, etc:
29 #define STLINK_OK 0x80
30 #define STLINK_FALSE 0x81
31 #define STLINK_CORE_RUNNING 0x80
32 #define STLINK_CORE_HALTED 0x81
33 #define STLINK_CORE_STAT_UNKNOWN -1
35 #define STLINK_GET_VERSION 0xf1
36 #define STLINK_GET_CURRENT_MODE 0xf5
37 #define STLINK_GET_TARGET_VOLTAGE 0xF7
39 #define STLINK_DEBUG_COMMAND 0xF2
40 #define STLINK_DFU_COMMAND 0xF3
41 #define STLINK_DFU_EXIT 0x07
42 // enter dfu could be 0x08?
44 // STLINK_GET_CURRENT_MODE
45 #define STLINK_DEV_DFU_MODE 0x00
46 #define STLINK_DEV_MASS_MODE 0x01
47 #define STLINK_DEV_DEBUG_MODE 0x02
48 #define STLINK_DEV_UNKNOWN_MODE -1
51 #define STLINK_DEBUG_ENTER 0x20
52 #define STLINK_DEBUG_EXIT 0x21
53 #define STLINK_DEBUG_READCOREID 0x22
54 #define STLINK_DEBUG_GETSTATUS 0x01
55 #define STLINK_DEBUG_FORCEDEBUG 0x02
56 #define STLINK_DEBUG_RESETSYS 0x03
57 #define STLINK_DEBUG_READALLREGS 0x04
58 #define STLINK_DEBUG_READREG 0x05
59 #define STLINK_DEBUG_WRITEREG 0x06
60 #define STLINK_DEBUG_READMEM_32BIT 0x07
61 #define STLINK_DEBUG_WRITEMEM_32BIT 0x08
62 #define STLINK_DEBUG_RUNCORE 0x09
63 #define STLINK_DEBUG_STEPCORE 0x0a
64 #define STLINK_DEBUG_SETFP 0x0b
65 #define STLINK_DEBUG_WRITEMEM_8BIT 0x0d
66 #define STLINK_DEBUG_CLEARFP 0x0e
67 #define STLINK_DEBUG_WRITEDEBUGREG 0x0f
68 #define STLINK_DEBUG_ENTER_SWD 0xa3
69 #define STLINK_DEBUG_ENTER_JTAG 0x00
71 // TODO - possible poor names...
72 #define STLINK_SWD_ENTER 0x30
73 #define STLINK_SWD_READCOREID 0x32 // TBD
74 #define STLINK_JTAG_WRITEDEBUG_32BIT 0x35
75 #define STLINK_JTAG_READDEBUG_32BIT 0x36
76 #define STLINK_JTAG_DRIVE_NRST 0x3c
77 #define STLINK_JTAG_DRIVE_NRST 0x3c
79 // cortex m3 technical reference manual
80 #define CM3_REG_CPUID 0xE000ED00
81 #define CM3_REG_FP_CTRL 0xE0002000
82 #define CM3_REG_FP_COMP0 0xE0002008
85 // TODO clean this up...
86 #define STM32VL_CORE_ID 0x1ba01477
87 #define STM32L_CORE_ID 0x2ba01477
88 #define STM32F3_CORE_ID 0x2ba01477
89 #define STM32F4_CORE_ID 0x2ba01477
90 #define STM32F0_CORE_ID 0xbb11477
91 #define CORE_M3_R1 0x1BA00477
92 #define CORE_M3_R2 0x4BA00477
93 #define CORE_M4_R0 0x2BA01477
96 * Chip IDs are explained in the appropriate programming manual for the
97 * DBGMCU_IDCODE register (0xE0042000)
99 // stm32 chipids, only lower 12 bits..
100 #define STM32_CHIPID_F1_MEDIUM 0x410
101 #define STM32_CHIPID_F2 0x411
102 #define STM32_CHIPID_F1_LOW 0x412
103 #define STM32_CHIPID_F3 0x422
104 #define STM32_CHIPID_F37x 0x432
105 #define STM32_CHIPID_F4 0x413
106 #define STM32_CHIPID_F4_LP 0x423
107 #define STM32_CHIPID_F1_HIGH 0x414
108 #define STM32_CHIPID_L1_MEDIUM 0x416
109 #define STM32_CHIPID_L1_MEDIUM_PLUS 0x427
111 * 0x436 is actually assigned to some L1 chips that are called "Medium-Plus"
112 * and some that are called "High". 0x427 is assigned to the other "Medium-
113 * plus" chips. To make it a bit simpler we just call 427 MEDIUM_PLUS and
116 #define STM32_CHIPID_L1_HIGH 0x436
117 #define STM32_CHIPID_F1_CONN 0x418
118 #define STM32_CHIPID_F1_VL_MEDIUM 0x420
119 #define STM32_CHIPID_F1_VL_HIGH 0x428
120 #define STM32_CHIPID_F1_XL 0x430
121 #define STM32_CHIPID_F0 0x440
122 #define STM32_CHIPID_F0_SMALL 0x444
124 // Constant STM32 memory map figures
125 #define STM32_FLASH_BASE 0x08000000
126 #define STM32_SRAM_BASE 0x20000000
128 /* Cortex™-M3 Technical Reference Manual */
129 /* Debug Halting Control and Status Register */
130 #define DHCSR 0xe000edf0
131 #define DCRSR 0xe000edf4
132 #define DCRDR 0xe000edf8
133 #define DBGKEY 0xa05f0000
135 /* Enough space to hold both a V2 command or a V1 command packaged as generic scsi*/
138 typedef struct chip_params_ {
141 uint32_t flash_size_reg;
142 uint32_t flash_pagesize;
144 uint32_t bootrom_base, bootrom_size;
148 // These maps are from a combination of the Programming Manuals, and
149 // also the Reference manuals. (flash size reg is normally in ref man)
150 static const chip_params_t devices[] = {
152 .chip_id = STM32_CHIPID_F1_MEDIUM,
153 .description = "F1 Medium-density device",
154 .flash_size_reg = 0x1ffff7e0,
155 .flash_pagesize = 0x400,
157 .bootrom_base = 0x1ffff000,
158 .bootrom_size = 0x800
161 .chip_id = STM32_CHIPID_F2,
162 .description = "F2 device",
163 .flash_size_reg = 0, /* no flash size reg found in the docs! */
164 .flash_pagesize = 0x20000,
165 .sram_size = 0x20000,
166 .bootrom_base = 0x1fff0000,
167 .bootrom_size = 0x7800
170 .chip_id = STM32_CHIPID_F1_LOW,
171 .description = "F1 Low-density device",
172 .flash_size_reg = 0x1ffff7e0,
173 .flash_pagesize = 0x400,
175 .bootrom_base = 0x1ffff000,
176 .bootrom_size = 0x800
179 .chip_id = STM32_CHIPID_F4,
180 .description = "F4 device",
181 .flash_size_reg = 0x1FFF7A10, //RM0090 error same as unique ID
182 .flash_pagesize = 0x4000,
183 .sram_size = 0x30000,
184 .bootrom_base = 0x1fff0000,
185 .bootrom_size = 0x7800
188 .chip_id = STM32_CHIPID_F4_LP,
189 .description = "F4 device (low power)",
190 .flash_size_reg = 0x1FFF7A10,
191 .flash_pagesize = 0x4000,
192 .sram_size = 0x10000,
193 .bootrom_base = 0x1fff0000,
194 .bootrom_size = 0x7800
197 .chip_id = STM32_CHIPID_F1_HIGH,
198 .description = "F1 High-density device",
199 .flash_size_reg = 0x1ffff7e0,
200 .flash_pagesize = 0x800,
201 .sram_size = 0x10000,
202 .bootrom_base = 0x1ffff000,
203 .bootrom_size = 0x800
206 // This ignores the EEPROM! (and uses the page erase size,
207 // not the sector write protection...)
208 .chip_id = STM32_CHIPID_L1_MEDIUM,
209 .description = "L1 Med-density device",
210 .flash_size_reg = 0x1ff8004c,
211 .flash_pagesize = 0x100,
213 .bootrom_base = 0x1ff00000,
214 .bootrom_size = 0x1000
217 .chip_id = STM32_CHIPID_L1_MEDIUM_PLUS,
218 .description = "L1 Medium-Plus-density device",
219 .flash_size_reg = 0x1ff800cc,
220 .flash_pagesize = 0x100,
221 .sram_size = 0x8000,/*Not completely clear if there are some with 48K*/
222 .bootrom_base = 0x1ff00000,
223 .bootrom_size = 0x1000
226 .chip_id = STM32_CHIPID_L1_HIGH,
227 .description = "L1 High-density device",
228 .flash_size_reg = 0x1ff800cc,
229 .flash_pagesize = 0x100,
230 .sram_size = 0xC000, /*Not completely clear if there are some with 32K*/
231 .bootrom_base = 0x1ff00000,
232 .bootrom_size = 0x1000
236 .chip_id = STM32_CHIPID_F1_CONN,
237 .description = "F1 Connectivity line device",
238 .flash_size_reg = 0x1ffff7e0,
239 .flash_pagesize = 0x800,
240 .sram_size = 0x10000,
241 .bootrom_base = 0x1fffb000,
242 .bootrom_size = 0x4800
245 .chip_id = STM32_CHIPID_F1_VL_MEDIUM,
246 .description = "F1 Medium-density Value Line device",
247 .flash_size_reg = 0x1ffff7e0,
248 .flash_pagesize = 0x400,
250 .bootrom_base = 0x1ffff000,
251 .bootrom_size = 0x800
254 // This is STK32F303VCT6 device from STM32 F3 Discovery board.
255 // Support based on DM00043574.pdf (RM0316) document.
256 .chip_id = STM32_CHIPID_F3,
257 .description = "F3 device",
258 .flash_size_reg = 0x1ffff7cc,
259 .flash_pagesize = 0x800,
261 .bootrom_base = 0x1ffff000,
262 .bootrom_size = 0x800
265 // This is STK32F373VCT6 device from STM32 F373 eval board
266 // Support based on 303 above (37x and 30x have same memory map)
267 .chip_id = STM32_CHIPID_F37x,
268 .description = "F3 device",
269 .flash_size_reg = 0x1ffff7cc,
270 .flash_pagesize = 0x800,
272 .bootrom_base = 0x1ffff000,
273 .bootrom_size = 0x800
276 .chip_id = STM32_CHIPID_F1_VL_HIGH,
277 .description = "F1 High-density value line device",
278 .flash_size_reg = 0x1ffff7e0,
279 .flash_pagesize = 0x800,
281 .bootrom_base = 0x1ffff000,
282 .bootrom_size = 0x800
285 .chip_id = STM32_CHIPID_F1_XL,
286 .description = "F1 XL-density device",
287 .flash_size_reg = 0x1ffff7e0,
288 .flash_pagesize = 0x800,
289 .sram_size = 0x18000,
290 .bootrom_base = 0x1fffe000,
291 .bootrom_size = 0x1800
294 //Use this as an example for mapping future chips:
295 //RM0091 document was used to find these paramaters
296 .chip_id = STM32_CHIPID_F0,
297 .description = "F0 device",
298 .flash_size_reg = 0x1ffff7cc, // "Flash size data register" (pg735)
299 .flash_pagesize = 0x400, // Page sizes listed in Table 4
300 .sram_size = 0x2000, // "SRAM" byte size in hex from Table 2
301 .bootrom_base = 0x1fffec00, // "System memory" starting address from Table 2
302 .bootrom_size = 0xC00 // "System memory" byte size in hex from Table 2
305 //Use this as an example for mapping future chips:
306 //RM0091 document was used to find these paramaters
307 .chip_id = STM32_CHIPID_F0_SMALL,
308 .description = "F0 small device",
309 .flash_size_reg = 0x1ffff7cc, // "Flash size data register" (pg735)
310 .flash_pagesize = 0x400, // Page sizes listed in Table 4
311 .sram_size = 0x1000, // "SRAM" byte size in hex from Table 2
312 .bootrom_base = 0x1fffec00, // "System memory" starting address from Table 2
313 .bootrom_size = 0xC00 // "System memory" byte size in hex from Table 2
333 typedef uint32_t stm32_addr_t;
335 typedef struct _cortex_m3_cpuid_ {
336 uint16_t implementer_id;
342 typedef struct stlink_version_ {
350 typedef struct flash_loader {
351 stm32_addr_t loader_addr; /* loader sram adddr */
352 stm32_addr_t buf_addr; /* buffer sram address */
355 enum transport_type {
356 TRANSPORT_TYPE_ZERO = 0,
357 TRANSPORT_TYPE_LIBSG,
358 TRANSPORT_TYPE_LIBUSB,
359 TRANSPORT_TYPE_INVALID
362 typedef struct _stlink stlink_t;
364 typedef struct _stlink_backend {
365 void (*close) (stlink_t * sl);
366 void (*exit_debug_mode) (stlink_t * sl);
367 void (*enter_swd_mode) (stlink_t * sl);
368 void (*enter_jtag_mode) (stlink_t * stl);
369 void (*exit_dfu_mode) (stlink_t * stl);
370 void (*core_id) (stlink_t * stl);
371 void (*reset) (stlink_t * stl);
372 void (*jtag_reset) (stlink_t * stl, int value);
373 void (*run) (stlink_t * stl);
374 void (*status) (stlink_t * stl);
375 void (*version) (stlink_t *sl);
376 uint32_t (*read_debug32) (stlink_t *sl, uint32_t addr);
377 void (*read_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
378 void (*write_debug32) (stlink_t *sl, uint32_t addr, uint32_t data);
379 void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
380 void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
381 void (*read_all_regs) (stlink_t *sl, reg * regp);
382 void (*read_reg) (stlink_t *sl, int r_idx, reg * regp);
383 void (*read_all_unsupported_regs) (stlink_t *sl, reg *regp);
384 void (*read_unsupported_reg) (stlink_t *sl, int r_idx, reg *regp);
385 void (*write_unsupported_reg) (stlink_t *sl, uint32_t value, int idx, reg *regp);
386 void (*write_reg) (stlink_t *sl, uint32_t reg, int idx);
387 void (*step) (stlink_t * stl);
388 int (*current_mode) (stlink_t * stl);
389 void (*force_debug) (stlink_t *sl);
390 uint32_t (*target_voltage) (stlink_t *sl);
394 struct _stlink_backend *backend;
397 // Room for the command header
398 unsigned char c_buf[C_BUF_LEN];
399 // Data transferred from or to device
400 unsigned char q_buf[Q_BUF_LEN];
403 // transport layer verboseness: 0 for no debug info, 10 for lots
409 #define STM32_FLASH_PGSZ 1024
410 #define STM32L_FLASH_PGSZ 256
412 #define STM32F4_FLASH_PGSZ 16384
413 #define STM32F4_FLASH_SIZE (128 * 1024 * 8)
415 stm32_addr_t flash_base;
420 #define STM32_SRAM_SIZE (8 * 1024)
421 #define STM32L_SRAM_SIZE (16 * 1024)
422 stm32_addr_t sram_base;
426 stm32_addr_t sys_base;
429 struct stlink_version_ version;
432 //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
434 // delegated functions...
435 void stlink_enter_swd_mode(stlink_t *sl);
436 void stlink_enter_jtag_mode(stlink_t *sl);
437 void stlink_exit_debug_mode(stlink_t *sl);
438 void stlink_exit_dfu_mode(stlink_t *sl);
439 void stlink_close(stlink_t *sl);
440 uint32_t stlink_core_id(stlink_t *sl);
441 void stlink_reset(stlink_t *sl);
442 void stlink_jtag_reset(stlink_t *sl, int value);
443 void stlink_run(stlink_t *sl);
444 void stlink_status(stlink_t *sl);
445 void stlink_version(stlink_t *sl);
446 uint32_t stlink_read_debug32(stlink_t *sl, uint32_t addr);
447 void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
448 void stlink_write_debug32(stlink_t *sl, uint32_t addr, uint32_t data);
449 void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
450 void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
451 void stlink_read_all_regs(stlink_t *sl, reg *regp);
452 void stlink_read_all_unsupported_regs(stlink_t *sl, reg *regp);
453 void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp);
454 void stlink_read_unsupported_reg(stlink_t *sl, int r_idx, reg *regp);
455 void stlink_write_unsupported_reg(stlink_t *sl, uint32_t value, int r_idx, reg *regp);
456 void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
457 void stlink_step(stlink_t *sl);
458 int stlink_current_mode(stlink_t *sl);
459 void stlink_force_debug(stlink_t *sl);
460 int stlink_target_voltage(stlink_t *sl);
464 int stlink_erase_flash_mass(stlink_t* sl);
465 int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, uint32_t length);
466 int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr);
467 int stlink_fwrite_sram(stlink_t *sl, const char* path, stm32_addr_t addr);
468 int stlink_verify_write_flash(stlink_t *sl, stm32_addr_t address, uint8_t *data, uint32_t length);
471 uint32_t stlink_chip_id(stlink_t *sl);
472 void stlink_cpu_id(stlink_t *sl, cortex_m3_cpuid_t *cpuid);
474 // privates, publics, the rest....
475 // TODO sort what is private, and what is not
476 int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t flashaddr);
477 uint32_t stlink_calculate_pagesize(stlink_t *sl, uint32_t flashaddr);
478 uint16_t read_uint16(const unsigned char *c, const int pt);
479 void stlink_core_stat(stlink_t *sl);
480 void stlink_print_data(stlink_t *sl);
481 unsigned int is_bigendian(void);
482 uint32_t read_uint32(const unsigned char *c, const int pt);
483 void write_uint32(unsigned char* buf, uint32_t ui);
484 void write_uint16(unsigned char* buf, uint16_t ui);
485 unsigned int is_core_halted(stlink_t *sl);
486 int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size);
487 int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size);
488 int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size);
489 int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size);
490 int stlink_load_device_params(stlink_t *sl);
494 #include "stlink-sg.h"
495 #include "stlink-usb.h"
503 #endif /* STLINK_COMMON_H */