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 STM32F3_CORE_ID 0x2ba01477
  88 #define STM32F4_CORE_ID 0x2ba01477
  89 #define STM32F0_CORE_ID 0xbb11477
  90 #define CORE_M3_R1 0x1BA00477
  91 #define CORE_M3_R2 0x4BA00477
  92 #define CORE_M4_R0 0x2BA01477
  93
  94 /*
  95  * Chip IDs are explained in the appropriate programming manual for the
  96  * DBGMCU_IDCODE register (0xE0042000)
  97  */
  98 // stm32 chipids, only lower 12 bits..
  99 #define STM32_CHIPID_F1_MEDIUM 0x410
 100 #define STM32_CHIPID_F2 0x411
 101 #define STM32_CHIPID_F1_LOW 0x412
 102 #define STM32_CHIPID_F3 0x422
 103 #define STM32_CHIPID_F37x 0x432
 104 #define STM32_CHIPID_F4 0x413
 105 #define STM32_CHIPID_F1_HIGH 0x414
 106 #define STM32_CHIPID_L1_MEDIUM 0x416
 107 #define STM32_CHIPID_L1_MEDIUM_PLUS 0x427
 108 /*
 109  * 0x436 is actually assigned to some L1 chips that are called "Medium-Plus"
 110  * and some that are called "High".  0x427 is assigned to the other "Medium-
 111  * plus" chips.  To make it a bit simpler we just call 427 MEDIUM_PLUS and
 112  * 0x436 HIGH.
 113  */
 114 #define STM32_CHIPID_L1_HIGH 0x436
 115 #define STM32_CHIPID_F1_CONN 0x418
 116 #define STM32_CHIPID_F1_VL_MEDIUM 0x420
 117 #define STM32_CHIPID_F1_VL_HIGH 0x428
 118 #define STM32_CHIPID_F1_XL 0x430
 119 #define STM32_CHIPID_F0 0x440
 120 #define STM32_CHIPID_F0_SMALL 0x444
 121
 122 // Constant STM32 memory map figures
 123 #define STM32_FLASH_BASE 0x08000000
 124 #define STM32_SRAM_BASE 0x20000000
 125
 126 /* Cortex™-M3 Technical Reference Manual */
 127 /* Debug Halting Control and Status Register */
 128 #define DHCSR 0xe000edf0
 129 #define DCRSR 0xe000edf4
 130 #define DCRDR 0xe000edf8
 131 #define DBGKEY 0xa05f0000
 132
 133 /* Enough space to hold both a V2 command or a V1 command packaged as generic scsi*/
 134 #define C_BUF_LEN 32
 135
 136     typedef struct chip_params_ {
 137         uint32_t chip_id;
 138         char* description;
 139         uint32_t flash_size_reg;
 140         uint32_t flash_pagesize;
 141         uint32_t sram_size;
 142         uint32_t bootrom_base, bootrom_size;
 143     } chip_params_t;
 144
 145
 146 // These maps are from a combination of the Programming Manuals, and
 147 // also the Reference manuals.  (flash size reg is normally in ref man)
 148 static const chip_params_t devices[] = {
 149         { // table 2, PM0063
 150             .chip_id = STM32_CHIPID_F1_MEDIUM,
 151             .description = "F1 Medium-density device",
 152             .flash_size_reg = 0x1ffff7e0,
 153                     .flash_pagesize = 0x400,
 154                     .sram_size = 0x5000,
 155                     .bootrom_base = 0x1ffff000,
 156                     .bootrom_size = 0x800
 157         },
 158         {  // table 1, PM0059
 159             .chip_id = STM32_CHIPID_F2,
 160                     .description = "F2 device",
 161                     .flash_size_reg = 0, /* no flash size reg found in the docs! */
 162                     .flash_pagesize = 0x20000,
 163                     .sram_size = 0x20000,
 164                     .bootrom_base = 0x1fff0000,
 165                     .bootrom_size = 0x7800
 166         },
 167         { // PM0063
 168             .chip_id = STM32_CHIPID_F1_LOW,
 169                     .description = "F1 Low-density device",
 170                     .flash_size_reg = 0x1ffff7e0,
 171                     .flash_pagesize = 0x400,
 172                     .sram_size = 0x2800,
 173                     .bootrom_base = 0x1ffff000,
 174                     .bootrom_size = 0x800
 175         },
 176         {
 177             .chip_id = STM32_CHIPID_F4,
 178                     .description = "F4 device",
 179                     .flash_size_reg = 0x1FFF7A10,  //RM0090 error same as unique ID
 180                     .flash_pagesize = 0x4000,
 181                     .sram_size = 0x30000,
 182                     .bootrom_base = 0x1fff0000,
 183                     .bootrom_size = 0x7800
 184         },
 185         {
 186             .chip_id = STM32_CHIPID_F1_HIGH,
 187                     .description = "F1 High-density device",
 188                     .flash_size_reg = 0x1ffff7e0,
 189                     .flash_pagesize = 0x800,
 190                     .sram_size = 0x10000,
 191                     .bootrom_base = 0x1ffff000,
 192                     .bootrom_size = 0x800
 193         },
 194         {
 195           // This ignores the EEPROM! (and uses the page erase size,
 196           // not the sector write protection...)
 197             .chip_id = STM32_CHIPID_L1_MEDIUM,
 198                     .description = "L1 Med-density device",
 199                     .flash_size_reg = 0x1ff8004c,
 200                     .flash_pagesize = 0x100,
 201                     .sram_size = 0x4000,
 202                     .bootrom_base = 0x1ff00000,
 203                     .bootrom_size = 0x1000
 204         },
 205         {
 206             .chip_id = STM32_CHIPID_L1_MEDIUM_PLUS,
 207                     .description = "L1 Medium-Plus-density device",
 208                     .flash_size_reg = 0x1ff800cc,
 209                     .flash_pagesize = 0x100,
 210                     .sram_size = 0x8000,/*Not completely clear if there are some with 48K*/
 211                     .bootrom_base = 0x1ff00000,
 212                     .bootrom_size = 0x1000
 213         },
 214         {
 215             .chip_id = STM32_CHIPID_L1_HIGH,
 216                     .description = "L1 High-density device",
 217                     .flash_size_reg = 0x1ff800cc,
 218                     .flash_pagesize = 0x100,
 219                     .sram_size = 0xC000, /*Not completely clear if there are some with 32K*/
 220                     .bootrom_base = 0x1ff00000,
 221                     .bootrom_size = 0x1000
 222         },
 223
 224         {
 225             .chip_id = STM32_CHIPID_F1_CONN,
 226                     .description = "F1 Connectivity line device",
 227                     .flash_size_reg = 0x1ffff7e0,
 228                     .flash_pagesize = 0x800,
 229                     .sram_size = 0x10000,
 230                     .bootrom_base = 0x1fffb000,
 231                     .bootrom_size = 0x4800
 232         },
 233         {
 234             .chip_id = STM32_CHIPID_F1_VL_MEDIUM,
 235                     .description = "F1 Medium-density Value Line device",
 236                     .flash_size_reg = 0x1ffff7e0,
 237                     .flash_pagesize = 0x400,
 238                     .sram_size = 0x2000,
 239                     .bootrom_base = 0x1ffff000,
 240                     .bootrom_size = 0x800
 241         },
 242         {
 243             // This is STK32F303VCT6 device from STM32 F3 Discovery board.
 244             // Support based on DM00043574.pdf (RM0316) document.
 245             .chip_id = STM32_CHIPID_F3,
 246                     .description = "F3 device",
 247                     .flash_size_reg = 0x1ffff7cc,
 248                     .flash_pagesize = 0x800,
 249                     .sram_size = 0xa000,
 250                     .bootrom_base = 0x1ffff000,
 251                     .bootrom_size = 0x800
 252         },
 253         {
 254             // This is STK32F373VCT6 device from STM32 F373 eval board
 255             // Support based on 303 above (37x and 30x have same memory map)
 256             .chip_id = STM32_CHIPID_F37x,
 257                     .description = "F3 device",
 258                     .flash_size_reg = 0x1ffff7cc,
 259                     .flash_pagesize = 0x800,
 260                     .sram_size = 0xa000,
 261                     .bootrom_base = 0x1ffff000,
 262                     .bootrom_size = 0x800
 263         },
 264         {
 265             .chip_id = STM32_CHIPID_F1_VL_HIGH,
 266                     .description = "F1 High-density value line device",
 267                     .flash_size_reg = 0x1ffff7e0,
 268                     .flash_pagesize = 0x800,
 269                     .sram_size = 0x8000,
 270                     .bootrom_base = 0x1ffff000,
 271                     .bootrom_size = 0x800
 272         },
 273         {
 274             .chip_id = STM32_CHIPID_F1_XL,
 275                     .description = "F1 XL-density device",
 276                     .flash_size_reg = 0x1ffff7e0,
 277                     .flash_pagesize = 0x800,
 278                     .sram_size = 0x18000,
 279                     .bootrom_base = 0x1fffe000,
 280                     .bootrom_size = 0x1800
 281         },
 282         {
 283             //Use this as an example for mapping future chips:
 284             //RM0091 document was used to find these paramaters
 285             .chip_id = STM32_CHIPID_F0,
 286                     .description = "F0 device",
 287                     .flash_size_reg = 0x1ffff7cc,       // "Flash size data register" (pg735)
 288                     .flash_pagesize = 0x400,            // Page sizes listed in Table 4
 289                     .sram_size = 0x2000,                // "SRAM" byte size in hex from Table 2
 290                     .bootrom_base = 0x1fffec00,         // "System memory" starting address from Table 2
 291                     .bootrom_size = 0xC00               // "System memory" byte size in hex from Table 2
 292         },
 293         {
 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_SMALL,
 297                     .description = "F0 small device",
 298                     .flash_size_reg = 0x1ffff7cc,       // "Flash size data register" (pg735)
 299                     .flash_pagesize = 0x400,            // Page sizes listed in Table 4
 300                     .sram_size = 0x1000,                // "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
 303         },
 304  };
 305
 306
 307     typedef struct {
 308         uint32_t r[16];
 309         uint32_t s[32];
 310         uint32_t xpsr;
 311         uint32_t main_sp;
 312         uint32_t process_sp;
 313         uint32_t rw;
 314         uint32_t rw2;
 315         uint8_t control;
 316         uint8_t faultmask;
 317         uint8_t basepri;
 318         uint8_t primask;
 319         uint32_t fpscr;
 320     } reg;
 321
 322     typedef uint32_t stm32_addr_t;
 323
 324     typedef struct _cortex_m3_cpuid_ {
 325         uint16_t implementer_id;
 326         uint16_t variant;
 327         uint16_t part;
 328         uint8_t revision;
 329     } cortex_m3_cpuid_t;
 330
 331     typedef struct stlink_version_ {
 332         uint32_t stlink_v;
 333         uint32_t jtag_v;
 334         uint32_t swim_v;
 335         uint32_t st_vid;
 336         uint32_t stlink_pid;
 337     } stlink_version_t;
 338
 339     typedef struct flash_loader {
 340         stm32_addr_t loader_addr; /* loader sram adddr */
 341         stm32_addr_t buf_addr; /* buffer sram address */
 342     } flash_loader_t;
 343
 344     enum transport_type {
 345         TRANSPORT_TYPE_ZERO = 0,
 346         TRANSPORT_TYPE_LIBSG,
 347         TRANSPORT_TYPE_LIBUSB,
 348         TRANSPORT_TYPE_INVALID
 349     };
 350
 351     typedef struct _stlink stlink_t;
 352
 353     typedef struct _stlink_backend {
 354         void (*close) (stlink_t * sl);
 355         void (*exit_debug_mode) (stlink_t * sl);
 356         void (*enter_swd_mode) (stlink_t * sl);
 357         void (*enter_jtag_mode) (stlink_t * stl);
 358         void (*exit_dfu_mode) (stlink_t * stl);
 359         void (*core_id) (stlink_t * stl);
 360         void (*reset) (stlink_t * stl);
 361         void (*jtag_reset) (stlink_t * stl, int value);
 362         void (*run) (stlink_t * stl);
 363         void (*status) (stlink_t * stl);
 364         void (*version) (stlink_t *sl);
 365         uint32_t (*read_debug32) (stlink_t *sl, uint32_t addr);
 366         void (*read_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 367         void (*write_debug32) (stlink_t *sl, uint32_t addr, uint32_t data);
 368         void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 369         void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
 370         void (*read_all_regs) (stlink_t *sl, reg * regp);
 371         void (*read_reg) (stlink_t *sl, int r_idx, reg * regp);
 372         void (*read_all_unsupported_regs) (stlink_t *sl, reg *regp);
 373         void (*read_unsupported_reg) (stlink_t *sl, int r_idx, reg *regp);
 374         void (*write_unsupported_reg) (stlink_t *sl, uint32_t value, int idx, reg *regp);
 375         void (*write_reg) (stlink_t *sl, uint32_t reg, int idx);
 376         void (*step) (stlink_t * stl);
 377         int (*current_mode) (stlink_t * stl);
 378         void (*force_debug) (stlink_t *sl);
 379     } stlink_backend_t;
 380
 381     struct _stlink {
 382         struct _stlink_backend *backend;
 383         void *backend_data;
 384
 385         // Room for the command header
 386         unsigned char c_buf[C_BUF_LEN];
 387         // Data transferred from or to device
 388         unsigned char q_buf[Q_BUF_LEN];
 389         int q_len;
 390
 391         // transport layer verboseness: 0 for no debug info, 10 for lots
 392         int verbose;
 393         uint32_t core_id;
 394         uint32_t chip_id;
 395         int core_stat;
 396
 397 #define STM32_FLASH_PGSZ 1024
 398 #define STM32L_FLASH_PGSZ 256
 399
 400 #define STM32F4_FLASH_PGSZ 16384
 401 #define STM32F4_FLASH_SIZE (128 * 1024 * 8)
 402
 403         stm32_addr_t flash_base;
 404         size_t flash_size;
 405         size_t flash_pgsz;
 406
 407         /* sram settings */
 408 #define STM32_SRAM_SIZE (8 * 1024)
 409 #define STM32L_SRAM_SIZE (16 * 1024)
 410         stm32_addr_t sram_base;
 411         size_t sram_size;
 412
 413         // bootloader
 414         stm32_addr_t sys_base;
 415         size_t sys_size;
 416
 417         struct stlink_version_ version;
 418     };
 419
 420     //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
 421
 422     // delegated functions...
 423     void stlink_enter_swd_mode(stlink_t *sl);
 424     void stlink_enter_jtag_mode(stlink_t *sl);
 425     void stlink_exit_debug_mode(stlink_t *sl);
 426     void stlink_exit_dfu_mode(stlink_t *sl);
 427     void stlink_close(stlink_t *sl);
 428     uint32_t stlink_core_id(stlink_t *sl);
 429     void stlink_reset(stlink_t *sl);
 430     void stlink_jtag_reset(stlink_t *sl, int value);
 431     void stlink_run(stlink_t *sl);
 432     void stlink_status(stlink_t *sl);
 433     void stlink_version(stlink_t *sl);
 434     uint32_t stlink_read_debug32(stlink_t *sl, uint32_t addr);
 435     void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 436     void stlink_write_debug32(stlink_t *sl, uint32_t addr, uint32_t data);
 437     void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 438     void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
 439     void stlink_read_all_regs(stlink_t *sl, reg *regp);
 440     void stlink_read_all_unsupported_regs(stlink_t *sl, reg *regp);
 441     void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp);
 442     void stlink_read_unsupported_reg(stlink_t *sl, int r_idx, reg *regp);
 443     void stlink_write_unsupported_reg(stlink_t *sl, uint32_t value, int r_idx, reg *regp);
 444     void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
 445     void stlink_step(stlink_t *sl);
 446     int stlink_current_mode(stlink_t *sl);
 447     void stlink_force_debug(stlink_t *sl);
 448
 449
 450     // unprocessed
 451     int stlink_erase_flash_mass(stlink_t* sl);
 452     int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, uint32_t length);
 453     int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr);
 454     int stlink_fwrite_sram(stlink_t *sl, const char* path, stm32_addr_t addr);
 455     int stlink_verify_write_flash(stlink_t *sl, stm32_addr_t address, uint8_t *data, uint32_t length);
 456
 457     // PUBLIC
 458     uint32_t stlink_chip_id(stlink_t *sl);
 459     void stlink_cpu_id(stlink_t *sl, cortex_m3_cpuid_t *cpuid);
 460
 461     // privates, publics, the rest....
 462     // TODO sort what is private, and what is not
 463     int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t flashaddr);
 464     uint32_t stlink_calculate_pagesize(stlink_t *sl, uint32_t flashaddr);
 465     uint16_t read_uint16(const unsigned char *c, const int pt);
 466     void stlink_core_stat(stlink_t *sl);
 467     void stlink_print_data(stlink_t *sl);
 468     unsigned int is_bigendian(void);
 469     uint32_t read_uint32(const unsigned char *c, const int pt);
 470     void write_uint32(unsigned char* buf, uint32_t ui);
 471     void write_uint16(unsigned char* buf, uint16_t ui);
 472     unsigned int is_core_halted(stlink_t *sl);
 473     int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size);
 474     int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size);
 475     int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size);
 476     int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size);
 477     int stlink_load_device_params(stlink_t *sl);
 478
 479
 480
 481 #include "stlink-sg.h"
 482 #include "stlink-usb.h"
 483
 484
 485
 486 #ifdef  __cplusplus
 487 }
 488 #endif
 489
 490 #endif  /* STLINK_COMMON_H */
 491