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
  27     // STLINK_DEBUG_RESETSYS, etc:
  28 #define STLINK_OK                       0x80
  29 #define STLINK_FALSE                    0x81
  30 #define STLINK_CORE_RUNNING             0x80
  31 #define STLINK_CORE_HALTED              0x81
  32 #define STLINK_CORE_STAT_UNKNOWN        -1
  33
  34 #define STLINK_GET_VERSION              0xf1
  35 #define STLINK_GET_CURRENT_MODE 0xf5
  36
  37 #define STLINK_DEBUG_COMMAND            0xF2
  38 #define STLINK_DFU_COMMAND              0xF3
  39 #define STLINK_DFU_EXIT         0x07
  40
  41     // STLINK_GET_CURRENT_MODE
  42 #define STLINK_DEV_DFU_MODE             0x00
  43 #define STLINK_DEV_MASS_MODE            0x01
  44 #define STLINK_DEV_DEBUG_MODE           0x02
  45 #define STLINK_DEV_UNKNOWN_MODE -1
  46
  47     // jtag mode cmds
  48 #define STLINK_DEBUG_ENTER              0x20
  49 #define STLINK_DEBUG_EXIT               0x21
  50 #define STLINK_DEBUG_READCOREID 0x22
  51 #define STLINK_DEBUG_GETSTATUS          0x01
  52 #define STLINK_DEBUG_FORCEDEBUG 0x02
  53 #define STLINK_DEBUG_RESETSYS           0x03
  54 #define STLINK_DEBUG_READALLREGS        0x04
  55 #define STLINK_DEBUG_READREG            0x05
  56 #define STLINK_DEBUG_WRITEREG           0x06
  57 #define STLINK_DEBUG_READMEM_32BIT      0x07
  58 #define STLINK_DEBUG_WRITEMEM_32BIT     0x08
  59 #define STLINK_DEBUG_RUNCORE            0x09
  60 #define STLINK_DEBUG_STEPCORE           0x0a
  61 #define STLINK_DEBUG_SETFP              0x0b
  62 #define STLINK_DEBUG_WRITEMEM_8BIT      0x0d
  63 #define STLINK_DEBUG_CLEARFP            0x0e
  64 #define STLINK_DEBUG_WRITEDEBUGREG      0x0f
  65 #define STLINK_DEBUG_ENTER_SWD          0xa3
  66 #define STLINK_DEBUG_ENTER_JTAG 0x00
  67
  68     typedef struct {
  69         uint32_t r[16];
  70         uint32_t xpsr;
  71         uint32_t main_sp;
  72         uint32_t process_sp;
  73         uint32_t rw;
  74         uint32_t rw2;
  75     } reg;
  76
  77     typedef uint32_t stm32_addr_t;
  78
  79     typedef struct flash_loader {
  80         stm32_addr_t loader_addr; /* loader sram adddr */
  81         stm32_addr_t buf_addr; /* buffer sram address */
  82     } flash_loader_t;
  83
  84     enum transport_type {
  85         TRANSPORT_TYPE_ZERO = 0,
  86         TRANSPORT_TYPE_LIBSG,
  87         TRANSPORT_TYPE_LIBUSB,
  88         TRANSPORT_TYPE_INVALID
  89     };
  90
  91     typedef struct _stlink stlink_t;
  92
  93     typedef struct _stlink_backend {
  94         void (*close) (stlink_t * sl);
  95         void (*exit_debug_mode) (stlink_t * sl);
  96         void (*enter_swd_mode) (stlink_t * sl);
  97         void (*enter_jtag_mode) (stlink_t * stl);
  98         void (*exit_dfu_mode) (stlink_t * stl);
  99         void (*core_id) (stlink_t * stl);
 100         void (*reset) (stlink_t * stl);
 101         void (*run) (stlink_t * stl);
 102         void (*status) (stlink_t * stl);
 103         void (*version) (stlink_t * stl);
 104         void (*read_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 105         void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 106         void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
 107         void (*read_all_regs) (stlink_t *sl, reg* regp);
 108         void (*read_reg) (stlink_t *sl, int r_idx, reg* regp);
 109         void (*write_reg) (stlink_t *sl, uint32_t reg, int idx);
 110         void (*step) (stlink_t * stl);
 111         int (*current_mode) (stlink_t * stl);
 112     } stlink_backend_t;
 113
 114     struct _stlink {
 115         struct _stlink_backend *backend;
 116         void *backend_data;
 117
 118         // Data transferred from or to device
 119         unsigned char q_buf[Q_BUF_LEN];
 120         int q_len;
 121
 122         // transport layer verboseness: 0 for no debug info, 10 for lots
 123         int verbose;
 124         uint32_t core_id;
 125         int core_stat;
 126
 127
 128
 129         /* medium density stm32 flash settings */
 130 #define STM32_FLASH_BASE 0x08000000
 131 #define STM32_FLASH_SIZE (128 * 1024)
 132 #define STM32_FLASH_PGSZ 1024
 133         stm32_addr_t flash_base;
 134         size_t flash_size;
 135         size_t flash_pgsz;
 136
 137         /* in flash system memory */
 138 #define STM32_SYSTEM_BASE 0x1ffff000
 139 #define STM32_SYSTEM_SIZE (2 * 1024)
 140         stm32_addr_t sys_base;
 141         size_t sys_size;
 142
 143         /* sram settings */
 144 #define STM32_SRAM_BASE 0x20000000
 145 #define STM32_SRAM_SIZE (8 * 1024)
 146         stm32_addr_t sram_base;
 147         size_t sram_size;
 148
 149     };
 150
 151     // some quick and dirty logging...
 152     void D(stlink_t *sl, char *txt);
 153     void DD(stlink_t *sl, char *format, ...);
 154
 155     //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
 156
 157     // delegated functions...
 158     void stlink_enter_swd_mode(stlink_t *sl);
 159     void stlink_enter_jtag_mode(stlink_t *sl);
 160     void stlink_exit_debug_mode(stlink_t *sl);
 161     void stlink_exit_dfu_mode(stlink_t *sl);
 162     void stlink_close(stlink_t *sl);
 163     void stlink_core_id(stlink_t *sl);
 164     void stlink_reset(stlink_t *sl);
 165     void stlink_run(stlink_t *sl);
 166     void stlink_status(stlink_t *sl);
 167     void stlink_version(stlink_t *sl);
 168     void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 169     void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 170     void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
 171     void stlink_read_all_regs(stlink_t *sl, reg *regp);
 172     void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp);
 173     void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
 174     void stlink_step(stlink_t *sl);
 175     int stlink_current_mode(stlink_t *sl);
 176
 177
 178     // unprocessed
 179     void stlink_force_debug(stlink_t *sl);
 180
 181     int stlink_erase_flash_mass(stlink_t* sl);
 182     int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, unsigned length);
 183
 184     // privates, publics, the rest....
 185     // TODO sort what is private, and what is not
 186     int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t page);
 187     uint16_t read_uint16(const unsigned char *c, const int pt);
 188     void stlink_core_stat(stlink_t *sl);
 189     void stlink_print_data(stlink_t *sl);
 190     unsigned int is_bigendian(void);
 191     uint32_t read_uint32(const unsigned char *c, const int pt);
 192     void write_uint32(unsigned char* buf, uint32_t ui);
 193     void write_uint16(unsigned char* buf, uint16_t ui);
 194     unsigned int is_core_halted(stlink_t *sl);
 195     int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size);
 196     int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size);
 197     int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size);
 198     int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size);
 199
 200
 201
 202 #include "stlink-sg.h"
 203 #include "stlink-usb.h"
 204
 205
 206
 207 #ifdef  __cplusplus
 208 }
 209 #endif
 210
 211 #endif  /* STLINK_COMMON_H */
 212