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