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     enum transport_type {
  80         TRANSPORT_TYPE_ZERO = 0,
  81         TRANSPORT_TYPE_LIBSG,
  82         TRANSPORT_TYPE_LIBUSB,
  83         TRANSPORT_TYPE_INVALID
  84     };
  85
  86     typedef struct _stlink stlink_t;
  87
  88     typedef struct _stlink_backend {
  89         void (*close) (stlink_t* sl);
  90         void (*exit_debug_mode) (stlink_t *sl);
  91         void (*enter_swd_mode) (stlink_t *sl);
  92         void (*enter_jtag_mode) (stlink_t *stl);
  93         void (*exit_dfu_mode) (stlink_t *stl);
  94         void (*core_id) (stlink_t *stl);
  95         void (*reset) (stlink_t *stl);
  96         void (*run) (stlink_t *stl);
  97         void (*status) (stlink_t *stl);
  98         void (*version) (stlink_t *stl);
  99         void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
 100         void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
 101     } stlink_backend_t;
 102
 103     struct _stlink {
 104         struct _stlink_backend *backend;
 105         void *backend_data;
 106
 107         // Data transferred from or to device
 108         unsigned char q_buf[Q_BUF_LEN];
 109         int q_len;
 110
 111         // transport layer verboseness: 0 for no debug info, 10 for lots
 112         int verbose;
 113         uint32_t core_id;
 114         int core_stat;
 115
 116
 117
 118         /* medium density stm32 flash settings */
 119 #define STM32_FLASH_BASE 0x08000000
 120 #define STM32_FLASH_SIZE (128 * 1024)
 121 #define STM32_FLASH_PGSZ 1024
 122         stm32_addr_t flash_base;
 123         size_t flash_size;
 124         size_t flash_pgsz;
 125
 126         /* in flash system memory */
 127 #define STM32_SYSTEM_BASE 0x1ffff000
 128 #define STM32_SYSTEM_SIZE (2 * 1024)
 129         stm32_addr_t sys_base;
 130         size_t sys_size;
 131
 132         /* sram settings */
 133 #define STM32_SRAM_BASE 0x20000000
 134 #define STM32_SRAM_SIZE (8 * 1024)
 135         stm32_addr_t sram_base;
 136         size_t sram_size;
 137
 138     };
 139
 140     // some quick and dirty logging...
 141     void D(stlink_t *sl, char *txt);
 142     void DD(stlink_t *sl, char *format, ...);
 143
 144     //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
 145
 146     // delegated functions...
 147     void stlink_enter_swd_mode(stlink_t *sl);
 148     void stlink_enter_jtag_mode(stlink_t *sl);
 149     void stlink_exit_debug_mode(stlink_t *sl);
 150     void stlink_exit_dfu_mode(stlink_t *sl);
 151     void stlink_close(stlink_t *sl);
 152     void stlink_core_id(stlink_t *sl);
 153     void stlink_reset(stlink_t *sl);
 154     void stlink_run(stlink_t *sl);
 155     void stlink_status(stlink_t *sl);
 156     void stlink_version(stlink_t *sl);
 157     void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 158     void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
 159
 160
 161     // unprocessed
 162     int stlink_current_mode(stlink_t *sl);
 163     void stlink_force_debug(stlink_t *sl);
 164     void stlink_step(stlink_t *sl);
 165     void stlink_read_all_regs(stlink_t *sl);
 166     void stlink_read_reg(stlink_t *sl, int r_idx);
 167     void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
 168     void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 169
 170     int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t page);
 171     int stlink_erase_flash_mass(stlink_t* sl);
 172     int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, unsigned length);
 173
 174     // privates....
 175     uint16_t read_uint16(const unsigned char *c, const int pt);
 176     void stlink_core_stat(stlink_t *sl);
 177     void stlink_print_data(stlink_t *sl);
 178     unsigned int is_bigendian(void);
 179
 180
 181 #include "stlink-sg.h"
 182 #include "stlink-usb.h"
 183
 184
 185
 186 #ifdef  __cplusplus
 187 }
 188 #endif
 189
 190 #endif  /* STLINK_COMMON_H */
 191