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
  74 // cortex m3 technical reference manual
  75 #define CM3_REG_CPUID 0xE000ED00
  76 #define CM3_REG_FP_CTRL 0xE0002000
  77 #define CM3_REG_FP_COMP0 0xE0002008
  78
  79 /* Enough space to hold both a V2 command or a V1 command packaged as generic scsi*/
  80 #define C_BUF_LEN 32
  81
  82     typedef struct {
  83         uint32_t r[16];
  84         uint32_t xpsr;
  85         uint32_t main_sp;
  86         uint32_t process_sp;
  87         uint32_t rw;
  88         uint32_t rw2;
  89     } reg;
  90
  91     typedef uint32_t stm32_addr_t;
  92
  93     typedef struct _cortex_m3_cpuid_ {
  94         uint16_t implementer_id;
  95         uint16_t variant;
  96         uint16_t part;
  97         uint8_t revision;
  98     } cortex_m3_cpuid_t;
  99
 100     typedef struct stlink_version_ {
 101         uint32_t stlink_v;
 102         uint32_t jtag_v;
 103         uint32_t swim_v;
 104         uint32_t st_vid;
 105         uint32_t stlink_pid;
 106     } stlink_version_t;
 107
 108     typedef struct flash_loader {
 109         stm32_addr_t loader_addr; /* loader sram adddr */
 110         stm32_addr_t buf_addr; /* buffer sram address */
 111     } flash_loader_t;
 112
 113     enum transport_type {
 114         TRANSPORT_TYPE_ZERO = 0,
 115         TRANSPORT_TYPE_LIBSG,
 116         TRANSPORT_TYPE_LIBUSB,
 117         TRANSPORT_TYPE_INVALID
 118     };
 119
 120     typedef struct _stlink stlink_t;
 121
 122     typedef struct _stlink_backend {
 123         void (*close) (stlink_t * sl);
 124         void (*exit_debug_mode) (stlink_t * sl);
 125         void (*enter_swd_mode) (stlink_t * sl);
 126         void (*enter_jtag_mode) (stlink_t * stl);
 127         void (*exit_dfu_mode) (stlink_t * stl);
 128         void (*core_id) (stlink_t * stl);
 129         void (*reset) (stlink_t * stl);
 130         void (*run) (stlink_t * stl);
 131         void (*status) (stlink_t * stl);
 132         void (*version) (stlink_t *sl);
 133         void (*read_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 134         void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 135         void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
 136         void (*read_all_regs) (stlink_t *sl, reg * regp);
 137         void (*read_reg) (stlink_t *sl, int r_idx, reg * regp);
 138         void (*write_reg) (stlink_t *sl, uint32_t reg, int idx);
 139         void (*step) (stlink_t * stl);
 140         int (*current_mode) (stlink_t * stl);
 141         void (*force_debug) (stlink_t *sl);
 142     } stlink_backend_t;
 143
 144     struct _stlink {
 145         struct _stlink_backend *backend;
 146         void *backend_data;
 147
 148         // Room for the command header
 149         unsigned char c_buf[C_BUF_LEN];
 150         // Data transferred from or to device
 151         unsigned char q_buf[Q_BUF_LEN];
 152         int q_len;
 153
 154         // transport layer verboseness: 0 for no debug info, 10 for lots
 155         int verbose;
 156         uint32_t core_id;
 157         int core_stat;
 158
 159
 160
 161         /* medium density stm32 flash settings */
 162 #define STM32_FLASH_BASE 0x08000000
 163 #define STM32_FLASH_SIZE (128 * 1024)
 164 #define STM32_FLASH_PGSZ 1024
 165         stm32_addr_t flash_base;
 166         size_t flash_size;
 167         size_t flash_pgsz;
 168
 169         /* in flash system memory */
 170 #define STM32_SYSTEM_BASE 0x1ffff000
 171 #define STM32_SYSTEM_SIZE (2 * 1024)
 172         stm32_addr_t sys_base;
 173         size_t sys_size;
 174
 175         /* sram settings */
 176 #define STM32_SRAM_BASE 0x20000000
 177 #define STM32_SRAM_SIZE (8 * 1024)
 178 #define STM32L_SRAM_SIZE (16 * 1024)
 179         stm32_addr_t sram_base;
 180         size_t sram_size;
 181
 182         struct stlink_version_ version;
 183     };
 184
 185     //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
 186
 187     // delegated functions...
 188     void stlink_enter_swd_mode(stlink_t *sl);
 189     void stlink_enter_jtag_mode(stlink_t *sl);
 190     void stlink_exit_debug_mode(stlink_t *sl);
 191     void stlink_exit_dfu_mode(stlink_t *sl);
 192     void stlink_close(stlink_t *sl);
 193     uint32_t stlink_core_id(stlink_t *sl);
 194     void stlink_reset(stlink_t *sl);
 195     void stlink_run(stlink_t *sl);
 196     void stlink_status(stlink_t *sl);
 197     void stlink_version(stlink_t *sl);
 198     void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 199     void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 200     void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
 201     void stlink_read_all_regs(stlink_t *sl, reg *regp);
 202     void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp);
 203     void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
 204     void stlink_step(stlink_t *sl);
 205     int stlink_current_mode(stlink_t *sl);
 206     void stlink_force_debug(stlink_t *sl);
 207
 208
 209     // unprocessed
 210     int stlink_erase_flash_mass(stlink_t* sl);
 211     int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, unsigned length);
 212     int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr);
 213
 214     // PUBLIC
 215     uint16_t stlink_chip_id(stlink_t *sl);
 216     void stlink_cpu_id(stlink_t *sl, cortex_m3_cpuid_t *cpuid);
 217
 218     // privates, publics, the rest....
 219     // TODO sort what is private, and what is not
 220     int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t page);
 221     uint16_t read_uint16(const unsigned char *c, const int pt);
 222     void stlink_core_stat(stlink_t *sl);
 223     void stlink_print_data(stlink_t *sl);
 224     unsigned int is_bigendian(void);
 225     uint32_t read_uint32(const unsigned char *c, const int pt);
 226     void write_uint32(unsigned char* buf, uint32_t ui);
 227     void write_uint16(unsigned char* buf, uint16_t ui);
 228     unsigned int is_core_halted(stlink_t *sl);
 229     int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size);
 230     int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size);
 231     int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size);
 232     int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size);
 233
 234
 235
 236 #include "stlink-sg.h"
 237 #include "stlink-usb.h"
 238
 239
 240
 241 #ifdef  __cplusplus
 242 }
 243 #endif
 244
 245 #endif  /* STLINK_COMMON_H */
 246