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

   1 /*
   2  * File:   stlink-common.h
   3  * Bulk import from stlink-hw.h
   4  *
   5  * This should contain all the common top level stlink interfaces, regardless
   6  * of how the backend does the work....
   7  */
   8
   9 #ifndef STLINK_COMMON_H
  10 #define STLINK_COMMON_H
  11
  12 #ifdef  __cplusplus
  13 extern "C" {
  14 #endif
  15
  16 #include <stdint.h>
  17
  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)
  22
  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
  27
  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
  34
  35 #define STLINK_GET_VERSION              0xf1
  36 #define STLINK_GET_CURRENT_MODE 0xf5
  37
  38 #define STLINK_DEBUG_COMMAND            0xF2
  39 #define STLINK_DFU_COMMAND              0xF3
  40 #define STLINK_DFU_EXIT         0x07
  41     // enter dfu could be 0x08?
  42
  43     // STLINK_GET_CURRENT_MODE
  44 #define STLINK_DEV_DFU_MODE             0x00
  45 #define STLINK_DEV_MASS_MODE            0x01
  46 #define STLINK_DEV_DEBUG_MODE           0x02
  47 #define STLINK_DEV_UNKNOWN_MODE -1
  48
  49     // jtag mode cmds
  50 #define STLINK_DEBUG_ENTER              0x20
  51 #define STLINK_DEBUG_EXIT               0x21
  52 #define STLINK_DEBUG_READCOREID 0x22
  53 #define STLINK_DEBUG_GETSTATUS          0x01
  54 #define STLINK_DEBUG_FORCEDEBUG 0x02
  55 #define STLINK_DEBUG_RESETSYS           0x03
  56 #define STLINK_DEBUG_READALLREGS        0x04
  57 #define STLINK_DEBUG_READREG            0x05
  58 #define STLINK_DEBUG_WRITEREG           0x06
  59 #define STLINK_DEBUG_READMEM_32BIT      0x07
  60 #define STLINK_DEBUG_WRITEMEM_32BIT     0x08
  61 #define STLINK_DEBUG_RUNCORE            0x09
  62 #define STLINK_DEBUG_STEPCORE           0x0a
  63 #define STLINK_DEBUG_SETFP              0x0b
  64 #define STLINK_DEBUG_WRITEMEM_8BIT      0x0d
  65 #define STLINK_DEBUG_CLEARFP            0x0e
  66 #define STLINK_DEBUG_WRITEDEBUGREG      0x0f
  67 #define STLINK_DEBUG_ENTER_SWD          0xa3
  68 #define STLINK_DEBUG_ENTER_JTAG 0x00
  69
  70     // TODO - possible poor names...
  71 #define STLINK_SWD_ENTER 0x30
  72 #define STLINK_SWD_READCOREID 0x32  // TBD
  73 #define STLINK_JTAG_WRITEDEBUG_32BIT 0x35
  74 #define STLINK_JTAG_READDEBUG_32BIT 0x36
  75 #define STLINK_JTAG_DRIVE_NRST 0x3c
  76 #define STLINK_JTAG_DRIVE_NRST 0x3c
  77
  78 // cortex m3 technical reference manual
  79 #define CM3_REG_CPUID 0xE000ED00
  80 #define CM3_REG_FP_CTRL 0xE0002000
  81 #define CM3_REG_FP_COMP0 0xE0002008
  82
  83 /* cortex core ids */
  84     // TODO clean this up...
  85 #define STM32VL_CORE_ID 0x1ba01477
  86 #define STM32L_CORE_ID 0x2ba01477
  87 #define STM32F4_CORE_ID 0x2ba01477
  88 #define CORE_M3_R1 0x1BA00477
  89 #define CORE_M3_R2 0x4BA00477
  90 #define CORE_M4_R0 0x2BA01477
  91
  92 /*
  93  * Chip IDs are explained in the appropriate programming manual for the
  94  * DBGMCU_IDCODE register (0xE0042000)
  95  */
  96 // stm32 chipids, only lower 12 bits..
  97 #define STM32_CHIPID_F1_MEDIUM 0x410
  98 #define STM32_CHIPID_F2 0x411
  99 #define STM32_CHIPID_F1_LOW 0x412
 100 #define STM32_CHIPID_F4 0x413
 101 #define STM32_CHIPID_F1_HIGH 0x414
 102 #define STM32_CHIPID_L1_MEDIUM 0x416
 103 #define STM32_CHIPID_L1_HIGH 0x436
 104 #define STM32_CHIPID_F1_CONN 0x418
 105 #define STM32_CHIPID_F1_VL_MEDIUM 0x420
 106 #define STM32_CHIPID_F1_VL_HIGH 0x428
 107 #define STM32_CHIPID_F1_XL 0x430
 108
 109 // Constant STM32 memory map figures
 110 #define STM32_FLASH_BASE 0x08000000
 111 #define STM32_SRAM_BASE 0x20000000
 112
 113 /* Cortex™-M3 Technical Reference Manual */
 114 /* Debug Halting Control and Status Register */
 115 #define DHCSR 0xe000edf0
 116 #define DBGKEY 0xa05f0000
 117
 118 /* Enough space to hold both a V2 command or a V1 command packaged as generic scsi*/
 119 #define C_BUF_LEN 32
 120
 121     typedef struct chip_params_ {
 122         uint32_t chip_id;
 123         char* description;
 124         uint32_t flash_size_reg;
 125         uint32_t flash_pagesize;
 126         uint32_t sram_size;
 127         uint32_t bootrom_base, bootrom_size;
 128     } chip_params_t;
 129
 130
 131     // These maps are from a combination of the Programming Manuals, and
 132     // also the Reference manuals.  (flash size reg is normally in ref man)
 133  static const chip_params_t devices[] = {
 134         { // table 2, PM0063
 135             .chip_id = 0x410,
 136             .description = "F1 Medium-density device",
 137             .flash_size_reg = 0x1ffff7e0,
 138                     .flash_pagesize = 0x400,
 139                     .sram_size = 0x5000,
 140                     .bootrom_base = 0x1ffff000,
 141                     .bootrom_size = 0x800
 142         },
 143         {  // table 1, PM0059
 144             .chip_id = 0x411,
 145                     .description = "F2 device",
 146                     .flash_size_reg = 0, /* no flash size reg found in the docs! */
 147                     .flash_pagesize = 0x20000,
 148                     .sram_size = 0x20000,
 149                     .bootrom_base = 0x1fff0000,
 150                     .bootrom_size = 0x7800
 151         },
 152         { // PM0063
 153             .chip_id = 0x412,
 154                     .description = "F1 Low-density device",
 155                     .flash_size_reg = 0x1ffff7e0,
 156                     .flash_pagesize = 0x400,
 157                     .sram_size = 0x2800,
 158                     .bootrom_base = 0x1ffff000,
 159                     .bootrom_size = 0x800
 160         },
 161         {
 162             .chip_id = 0x413,
 163                     .description = "F4 device",
 164                     .flash_size_reg = 0x1FFF7A10,  //RM0090 error same as unique ID
 165                     .flash_pagesize = 0x4000,
 166                     .sram_size = 0x30000,
 167                     .bootrom_base = 0x1fff0000,
 168                     .bootrom_size = 0x7800
 169         },
 170         {
 171             .chip_id = 0x414,
 172                     .description = "F1 High-density device",
 173                     .flash_size_reg = 0x1ffff7e0,
 174                     .flash_pagesize = 0x800,
 175                     .sram_size = 0x10000,
 176                     .bootrom_base = 0x1ffff000,
 177                     .bootrom_size = 0x800
 178         },
 179         {
 180           // This ignores the EEPROM! (and uses the page erase size,
 181           // not the sector write protection...)
 182             .chip_id = 0x416,
 183                     .description = "L1 Med-density device",
 184                     .flash_size_reg = 0x1ff8004c,
 185                     .flash_pagesize = 0x100,
 186                     .sram_size = 0x4000,
 187                     .bootrom_base = 0x1ff00000,
 188                     .bootrom_size = 0x1000
 189         },
 190         {
 191             .chip_id = 0x418,
 192                     .description = "F1 Connectivity line device",
 193                     .flash_size_reg = 0x1ffff7e0,
 194                     .flash_pagesize = 0x800,
 195                     .sram_size = 0x10000,
 196                     .bootrom_base = 0x1fffb000,
 197                     .bootrom_size = 0x4800
 198         },
 199         {
 200             .chip_id = 0x420,
 201                     .description = "F1 Medium-density Value Line device",
 202                     .flash_size_reg = 0x1ffff7e0,
 203                     .flash_pagesize = 0x400,
 204                     .sram_size = 0x2000,
 205                     .bootrom_base = 0x1ffff000,
 206                     .bootrom_size = 0x800
 207         },
 208         {
 209             .chip_id = 0x428,
 210                     .description = "F1 High-density value line device",
 211                     .flash_size_reg = 0x1ffff7e0,
 212                     .flash_pagesize = 0x800,
 213                     .sram_size = 0x8000,
 214                     .bootrom_base = 0x1ffff000,
 215                     .bootrom_size = 0x800
 216         },
 217         {
 218             .chip_id = 0x430,
 219                     .description = "F1 XL-density device",
 220                     .flash_size_reg = 0x1ffff7e0,
 221                     .flash_pagesize = 0x800,
 222                     .sram_size = 0x18000,
 223                     .bootrom_base = 0x1fffe000,
 224                     .bootrom_size = 0x1800
 225         },
 226         {
 227           // This ignores the EEPROM! (and uses the page erase size,
 228           // not the sector write protection...)
 229             .chip_id = 0x436,
 230                     .description = "L1 High-density device",
 231                     .flash_size_reg = 0x1ff8004c,
 232                     .flash_pagesize = 0x100,
 233                     .sram_size = 0xc000,
 234                     .bootrom_base = 0x1ff00000,
 235                     .bootrom_size = 0x1000
 236         },
 237  };
 238
 239
 240     typedef struct {
 241         uint32_t r[16];
 242         uint32_t xpsr;
 243         uint32_t main_sp;
 244         uint32_t process_sp;
 245         uint32_t rw;
 246         uint32_t rw2;
 247     } reg;
 248
 249     typedef uint32_t stm32_addr_t;
 250
 251     typedef struct _cortex_m3_cpuid_ {
 252         uint16_t implementer_id;
 253         uint16_t variant;
 254         uint16_t part;
 255         uint8_t revision;
 256     } cortex_m3_cpuid_t;
 257
 258     typedef struct stlink_version_ {
 259         uint32_t stlink_v;
 260         uint32_t jtag_v;
 261         uint32_t swim_v;
 262         uint32_t st_vid;
 263         uint32_t stlink_pid;
 264     } stlink_version_t;
 265
 266     typedef struct flash_loader {
 267         stm32_addr_t loader_addr; /* loader sram adddr */
 268         stm32_addr_t buf_addr; /* buffer sram address */
 269     } flash_loader_t;
 270
 271     enum transport_type {
 272         TRANSPORT_TYPE_ZERO = 0,
 273         TRANSPORT_TYPE_LIBSG,
 274         TRANSPORT_TYPE_LIBUSB,
 275         TRANSPORT_TYPE_INVALID
 276     };
 277
 278     typedef struct _stlink stlink_t;
 279
 280     typedef struct _stlink_backend {
 281         void (*close) (stlink_t * sl);
 282         void (*exit_debug_mode) (stlink_t * sl);
 283         void (*enter_swd_mode) (stlink_t * sl);
 284         void (*enter_jtag_mode) (stlink_t * stl);
 285         void (*exit_dfu_mode) (stlink_t * stl);
 286         void (*core_id) (stlink_t * stl);
 287         void (*reset) (stlink_t * stl);
 288         void (*jtag_reset) (stlink_t * stl, int value);
 289         void (*run) (stlink_t * stl);
 290         void (*status) (stlink_t * stl);
 291         void (*version) (stlink_t *sl);
 292         uint32_t (*read_debug32) (stlink_t *sl, uint32_t addr);
 293         void (*read_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 294         void (*write_debug32) (stlink_t *sl, uint32_t addr, uint32_t data);
 295         void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 296         void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
 297         void (*read_all_regs) (stlink_t *sl, reg * regp);
 298         void (*read_reg) (stlink_t *sl, int r_idx, reg * regp);
 299         void (*write_reg) (stlink_t *sl, uint32_t reg, int idx);
 300         void (*step) (stlink_t * stl);
 301         int (*current_mode) (stlink_t * stl);
 302         void (*force_debug) (stlink_t *sl);
 303     } stlink_backend_t;
 304
 305     struct _stlink {
 306         struct _stlink_backend *backend;
 307         void *backend_data;
 308
 309         // Room for the command header
 310         unsigned char c_buf[C_BUF_LEN];
 311         // Data transferred from or to device
 312         unsigned char q_buf[Q_BUF_LEN];
 313         int q_len;
 314
 315         // transport layer verboseness: 0 for no debug info, 10 for lots
 316         int verbose;
 317         uint32_t core_id;
 318         uint32_t chip_id;
 319         int core_stat;
 320
 321 #define STM32_FLASH_PGSZ 1024
 322 #define STM32L_FLASH_PGSZ 256
 323
 324 #define STM32F4_FLASH_PGSZ 16384
 325 #define STM32F4_FLASH_SIZE (128 * 1024 * 8)
 326
 327         stm32_addr_t flash_base;
 328         size_t flash_size;
 329         size_t flash_pgsz;
 330
 331         /* sram settings */
 332 #define STM32_SRAM_SIZE (8 * 1024)
 333 #define STM32L_SRAM_SIZE (16 * 1024)
 334         stm32_addr_t sram_base;
 335         size_t sram_size;
 336
 337         // bootloader
 338         stm32_addr_t sys_base;
 339         size_t sys_size;
 340
 341         struct stlink_version_ version;
 342     };
 343
 344     //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
 345
 346     // delegated functions...
 347     void stlink_enter_swd_mode(stlink_t *sl);
 348     void stlink_enter_jtag_mode(stlink_t *sl);
 349     void stlink_exit_debug_mode(stlink_t *sl);
 350     void stlink_exit_dfu_mode(stlink_t *sl);
 351     void stlink_close(stlink_t *sl);
 352     uint32_t stlink_core_id(stlink_t *sl);
 353     void stlink_reset(stlink_t *sl);
 354     void stlink_jtag_reset(stlink_t *sl, int value);
 355     void stlink_run(stlink_t *sl);
 356     void stlink_status(stlink_t *sl);
 357     void stlink_version(stlink_t *sl);
 358     uint32_t stlink_read_debug32(stlink_t *sl, uint32_t addr);
 359     void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 360     void stlink_write_debug32(stlink_t *sl, uint32_t addr, uint32_t data);
 361     void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 362     void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
 363     void stlink_read_all_regs(stlink_t *sl, reg *regp);
 364     void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp);
 365     void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
 366     void stlink_step(stlink_t *sl);
 367     int stlink_current_mode(stlink_t *sl);
 368     void stlink_force_debug(stlink_t *sl);
 369
 370
 371     // unprocessed
 372     int stlink_erase_flash_mass(stlink_t* sl);
 373     int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, unsigned length);
 374     int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr);
 375     int stlink_fwrite_sram(stlink_t *sl, const char* path, stm32_addr_t addr);
 376     int stlink_verify_write_flash(stlink_t *sl, stm32_addr_t address, uint8_t *data, unsigned length);
 377
 378     // PUBLIC
 379     uint32_t stlink_chip_id(stlink_t *sl);
 380     void stlink_cpu_id(stlink_t *sl, cortex_m3_cpuid_t *cpuid);
 381
 382     // privates, publics, the rest....
 383     // TODO sort what is private, and what is not
 384     int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t flashaddr);
 385     uint32_t stlink_calculate_pagesize(stlink_t *sl, uint32_t flashaddr);
 386     uint16_t read_uint16(const unsigned char *c, const int pt);
 387     void stlink_core_stat(stlink_t *sl);
 388     void stlink_print_data(stlink_t *sl);
 389     unsigned int is_bigendian(void);
 390     uint32_t read_uint32(const unsigned char *c, const int pt);
 391     void write_uint32(unsigned char* buf, uint32_t ui);
 392     void write_uint16(unsigned char* buf, uint16_t ui);
 393     unsigned int is_core_halted(stlink_t *sl);
 394     int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size);
 395     int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size);
 396     int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size);
 397     int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size);
 398     int stlink_load_device_params(stlink_t *sl);
 399
 400
 401
 402 #include "stlink-sg.h"
 403 #include "stlink-usb.h"
 404
 405
 406
 407 #ifdef  __cplusplus
 408 }
 409 #endif
 410
 411 #endif  /* STLINK_COMMON_H */
 412