Store the masked chip_id in the stlink structure. Should fix unexpected
[fw/stlink] / src / stlink-common.h
index 32ea444523648a254ca65d2ee8f1d1d7be805556..a1442f366cd3ab0738e9522c0aa9921dc3cbe2d7 100644 (file)
@@ -18,11 +18,12 @@ extern "C" {
     // Max data transfer size.
     // 6kB = max mem32_read block, 8kB sram
     //#define Q_BUF_LEN        96
-#define Q_BUF_LEN      1024 * 100
+#define Q_BUF_LEN                      (1024 * 100)
 
     // st-link vendor cmd's
 #define USB_ST_VID                     0x0483
 #define USB_STLINK_PID                 0x3744
+#define USB_STLINK_32L_PID             0x3748
 
     // STLINK_DEBUG_RESETSYS, etc:
 #define STLINK_OK                      0x80
@@ -37,6 +38,7 @@ extern "C" {
 #define STLINK_DEBUG_COMMAND           0xF2
 #define STLINK_DFU_COMMAND             0xF3
 #define STLINK_DFU_EXIT                0x07
+    // enter dfu could be 0x08?
 
     // STLINK_GET_CURRENT_MODE
 #define STLINK_DEV_DFU_MODE            0x00
@@ -64,7 +66,168 @@ extern "C" {
 #define STLINK_DEBUG_WRITEDEBUGREG     0x0f
 #define STLINK_DEBUG_ENTER_SWD         0xa3
 #define STLINK_DEBUG_ENTER_JTAG        0x00
+    
+    // TODO - possible poor names...
+#define STLINK_SWD_ENTER 0x30
+#define STLINK_SWD_READCOREID 0x32  // TBD
+#define STLINK_JTAG_WRITEDEBUG_32BIT 0x35
+#define STLINK_JTAG_READDEBUG_32BIT 0x36
+#define STLINK_JTAG_DRIVE_NRST 0x3c
+#define STLINK_JTAG_DRIVE_NRST 0x3c
+
+// cortex m3 technical reference manual
+#define CM3_REG_CPUID 0xE000ED00
+#define CM3_REG_FP_CTRL 0xE0002000
+#define CM3_REG_FP_COMP0 0xE0002008
+
+/* cortex core ids */
+#define STM32VL_CORE_ID 0x1ba01477
+#define STM32L_CORE_ID 0x2ba01477
+#define STM32F4_CORE_ID 0x2ba01477
+    
+// stm32 chipids, only lower 12 bits..
+#define STM32_CHIPID_F1_MEDIUM 0x410
+#define STM32_CHIPID_F2 0x411
+#define STM32_CHIPID_F1_LOW 0x412
+#define STM32_CHIPID_F4 0x413
+#define STM32_CHIPID_F1_HIGH 0x414
+#define STM32_CHIPID_L1_MEDIUM 0x416
+#define STM32_CHIPID_F1_CONN 0x418
+#define STM32_CHIPID_F1_VL_MEDIUM 0x420
+#define STM32_CHIPID_F1_VL_HIGH 0x428
+#define STM32_CHIPID_F1_XL 0x430
+
+// Constant STM32 memory map figures
+#define STM32_FLASH_BASE 0x08000000
+#define STM32_SRAM_BASE 0x20000000
 
+/*
+ * Chip IDs are explained in the appropriate programming manual for the
+ * DBGMCU_IDCODE register (0xE0042000)
+ */
+#define CORE_M3_R1 0x1BA00477
+#define CORE_M3_R2 0x4BA00477
+#define CORE_M4_R0 0x2BA01477
+
+/* using chip id for F4 ident, since core id is same as F1 */
+#define STM32F4_CHIP_ID 0x413
+
+/* Cortex™-M3 Technical Reference Manual */
+/* Debug Halting Control and Status Register */
+#define DHCSR 0xe000edf0
+#define DBGKEY 0xa05f0000
+
+/* Enough space to hold both a V2 command or a V1 command packaged as generic scsi*/
+#define C_BUF_LEN 32
+
+    typedef struct chip_params_ {
+       uint32_t chip_id;
+       char* description;
+        uint32_t flash_size_reg;
+       uint32_t flash_pagesize;
+       uint32_t sram_size;
+       uint32_t bootrom_base, bootrom_size;
+    } chip_params_t;
+    
+    
+    // These maps are from a combination of the Programming Manuals, and 
+    // also the Reference manuals.  (flash size reg is normally in ref man)
+ static const chip_params_t devices[] = {
+        { // table 2, PM0063
+            .chip_id = 0x410,
+            .description = "F1 Medium-density device",
+            .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x400,
+                    .sram_size = 0x5000,
+                    .bootrom_base = 0x1ffff000,
+                    .bootrom_size = 0x800
+        },
+        {  // table 1, PM0059
+            .chip_id = 0x411,
+                    .description = "F2 device",
+                    .flash_size_reg = 0, /* no flash size reg found in the docs! */
+                    .flash_pagesize = 0x20000,
+                    .sram_size = 0x20000,
+                    .bootrom_base = 0x1fff0000,
+                    .bootrom_size = 0x7800
+        },
+        { // PM0063
+            .chip_id = 0x412,
+                    .description = "F1 Low-density device",
+                    .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x400,
+                    .sram_size = 0x2800,
+                    .bootrom_base = 0x1ffff000,
+                    .bootrom_size = 0x800
+        },
+        {
+            .chip_id = 0x413,
+                    .description = "F4 device",
+                    .flash_size_reg = 0x1FFF7A10,  //RM0090 error same as unique ID
+                    .flash_pagesize = 0x4000,
+                    .sram_size = 0x30000,
+                    .bootrom_base = 0x1fff0000,
+                    .bootrom_size = 0x7800
+        },
+        {
+            .chip_id = 0x414,
+                    .description = "F1 High-density device",
+                    .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x800,
+                    .sram_size = 0x10000,
+                    .bootrom_base = 0x1ffff000,
+                    .bootrom_size = 0x800
+        },
+        {
+          // This ignores the EEPROM! (and uses the page erase size,
+          // not the sector write protection...)
+            .chip_id = 0x416,
+                    .description = "L1 Med-density device",
+                    .flash_size_reg = 0x1ff8004c,
+                    .flash_pagesize = 0x100,
+                    .sram_size = 0x4000,
+                    .bootrom_base = 0x1ff00000,
+                    .bootrom_size = 0x1000
+        },
+        {
+            .chip_id = 0x418,
+                    .description = "F1 Connectivity line device",
+                    .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x800,
+                    .sram_size = 0x10000,
+                    .bootrom_base = 0x1fffb000,
+                    .bootrom_size = 0x4800
+        },
+        {
+            .chip_id = 0x420,
+                    .description = "F1 Medium-density Value Line device",
+                    .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x400,
+                    .sram_size = 0x2000,
+                    .bootrom_base = 0x1ffff000,
+                    .bootrom_size = 0x800
+        },
+        {
+            .chip_id = 0x428,
+                    .description = "F1 High-density value line device",
+                    .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x800,
+                    .sram_size = 0x8000,
+                    .bootrom_base = 0x1ffff000,
+                    .bootrom_size = 0x800
+        },
+        {
+            .chip_id = 0x430,
+                    .description = "F1 XL-density device",
+                    .flash_size_reg = 0x1ffff7e0,
+                    .flash_pagesize = 0x800,
+                    .sram_size = 0x18000,
+                    .bootrom_base = 0x1fffe000,
+                    .bootrom_size = 0x1800
+        }
+ };
+
+    
     typedef struct {
         uint32_t r[16];
         uint32_t xpsr;
@@ -75,6 +238,26 @@ extern "C" {
     } reg;
 
     typedef uint32_t stm32_addr_t;
+    
+    typedef struct _cortex_m3_cpuid_ {
+        uint16_t implementer_id;
+        uint16_t variant;
+        uint16_t part;
+        uint8_t revision;
+    } cortex_m3_cpuid_t;
+
+    typedef struct stlink_version_ {
+        uint32_t stlink_v;
+        uint32_t jtag_v;
+        uint32_t swim_v;
+        uint32_t st_vid;
+        uint32_t stlink_pid;
+    } stlink_version_t;
+
+    typedef struct flash_loader {
+        stm32_addr_t loader_addr; /* loader sram adddr */
+        stm32_addr_t buf_addr; /* buffer sram address */
+    } flash_loader_t;
 
     enum transport_type {
         TRANSPORT_TYPE_ZERO = 0,
@@ -84,26 +267,38 @@ extern "C" {
     };
 
     typedef struct _stlink stlink_t;
-    
+
     typedef struct _stlink_backend {
-        void (*close) (stlink_t* sl);
-        void (*exit_debug_mode) (stlink_t *sl);
-        void (*enter_swd_mode) (stlink_t *sl);
-        void (*enter_jtag_mode) (stlink_t *stl);
-        void (*exit_dfu_mode) (stlink_t *stl);
-        void (*core_id) (stlink_t *stl);
-        void (*reset) (stlink_t *stl);
-        void (*run) (stlink_t *stl);
-        void (*status) (stlink_t *stl);
-        void (*version) (stlink_t *stl);
+        void (*close) (stlink_t * sl);
+        void (*exit_debug_mode) (stlink_t * sl);
+        void (*enter_swd_mode) (stlink_t * sl);
+        void (*enter_jtag_mode) (stlink_t * stl);
+        void (*exit_dfu_mode) (stlink_t * stl);
+        void (*core_id) (stlink_t * stl);
+        void (*reset) (stlink_t * stl);
+        void (*jtag_reset) (stlink_t * stl, int value);
+        void (*run) (stlink_t * stl);
+        void (*status) (stlink_t * stl);
+        void (*version) (stlink_t *sl);
+        uint32_t (*read_debug32) (stlink_t *sl, uint32_t addr);
+        void (*read_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
+        void (*write_debug32) (stlink_t *sl, uint32_t addr, uint32_t data);
         void (*write_mem32) (stlink_t *sl, uint32_t addr, uint16_t len);
         void (*write_mem8) (stlink_t *sl, uint32_t addr, uint16_t len);
+        void (*read_all_regs) (stlink_t *sl, reg * regp);
+        void (*read_reg) (stlink_t *sl, int r_idx, reg * regp);
+        void (*write_reg) (stlink_t *sl, uint32_t reg, int idx);
+        void (*step) (stlink_t * stl);
+        int (*current_mode) (stlink_t * stl);
+        void (*force_debug) (stlink_t *sl);
     } stlink_backend_t;
 
     struct _stlink {
         struct _stlink_backend *backend;
         void *backend_data;
 
+        // Room for the command header
+        unsigned char c_buf[C_BUF_LEN];
         // Data transferred from or to device
         unsigned char q_buf[Q_BUF_LEN];
         int q_len;
@@ -111,71 +306,87 @@ extern "C" {
         // transport layer verboseness: 0 for no debug info, 10 for lots
         int verbose;
         uint32_t core_id;
+        uint32_t chip_id;
         int core_stat;
 
-        
-        
-        /* medium density stm32 flash settings */
-#define STM32_FLASH_BASE 0x08000000
-#define STM32_FLASH_SIZE (128 * 1024)
 #define STM32_FLASH_PGSZ 1024
+#define STM32L_FLASH_PGSZ 256
+
+#define STM32F4_FLASH_PGSZ 16384
+#define STM32F4_FLASH_SIZE (128 * 1024 * 8)
+
         stm32_addr_t flash_base;
         size_t flash_size;
         size_t flash_pgsz;
 
-        /* in flash system memory */
-#define STM32_SYSTEM_BASE 0x1ffff000
-#define STM32_SYSTEM_SIZE (2 * 1024)
-        stm32_addr_t sys_base;
-        size_t sys_size;
-
         /* sram settings */
-#define STM32_SRAM_BASE 0x20000000
 #define STM32_SRAM_SIZE (8 * 1024)
+#define STM32L_SRAM_SIZE (16 * 1024)
         stm32_addr_t sram_base;
         size_t sram_size;
+        
+        // bootloader
+        stm32_addr_t sys_base;
+        size_t sys_size;
 
+        struct stlink_version_ version;
     };
 
-    // some quick and dirty logging...
-    void D(stlink_t *sl, char *txt);
-    void DD(stlink_t *sl, char *format, ...);
-
     //stlink_t* stlink_quirk_open(const char *dev_name, const int verbose);
-    
+
     // delegated functions...
     void stlink_enter_swd_mode(stlink_t *sl);
     void stlink_enter_jtag_mode(stlink_t *sl);
     void stlink_exit_debug_mode(stlink_t *sl);
     void stlink_exit_dfu_mode(stlink_t *sl);
     void stlink_close(stlink_t *sl);
-    void stlink_core_id(stlink_t *sl);
+    uint32_t stlink_core_id(stlink_t *sl);
     void stlink_reset(stlink_t *sl);
+    void stlink_jtag_reset(stlink_t *sl, int value);
     void stlink_run(stlink_t *sl);
     void stlink_status(stlink_t *sl);
     void stlink_version(stlink_t *sl);
+    uint32_t stlink_read_debug32(stlink_t *sl, uint32_t addr);
+    void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
+    void stlink_write_debug32(stlink_t *sl, uint32_t addr, uint32_t data);
     void stlink_write_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
     void stlink_write_mem8(stlink_t *sl, uint32_t addr, uint16_t len);
-    
-
-    // unprocessed
+    void stlink_read_all_regs(stlink_t *sl, reg *regp);
+    void stlink_read_reg(stlink_t *sl, int r_idx, reg *regp);
+    void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
+    void stlink_step(stlink_t *sl);
     int stlink_current_mode(stlink_t *sl);
     void stlink_force_debug(stlink_t *sl);
-    void stlink_step(stlink_t *sl);
-    void stlink_read_all_regs(stlink_t *sl);
-    void stlink_read_reg(stlink_t *sl, int r_idx);
-    void stlink_write_reg(stlink_t *sl, uint32_t reg, int idx);
-    void stlink_read_mem32(stlink_t *sl, uint32_t addr, uint16_t len);
 
-    int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t page);
+
+    // unprocessed
     int stlink_erase_flash_mass(stlink_t* sl);
     int stlink_write_flash(stlink_t* sl, stm32_addr_t address, uint8_t* data, unsigned length);
-
-    // privates....
+    int stlink_fwrite_flash(stlink_t *sl, const char* path, stm32_addr_t addr);
+    int stlink_verify_write_flash(stlink_t *sl, stm32_addr_t address, uint8_t *data, unsigned length);
+    
+    // PUBLIC
+    uint32_t stlink_chip_id(stlink_t *sl);
+    void stlink_cpu_id(stlink_t *sl, cortex_m3_cpuid_t *cpuid);
+
+    // privates, publics, the rest....
+    // TODO sort what is private, and what is not
+    int stlink_erase_flash_page(stlink_t* sl, stm32_addr_t flashaddr);
+    uint32_t stlink_calculate_pagesize(stlink_t *sl, uint32_t flashaddr);
     uint16_t read_uint16(const unsigned char *c, const int pt);
     void stlink_core_stat(stlink_t *sl);
     void stlink_print_data(stlink_t *sl);
     unsigned int is_bigendian(void);
+    uint32_t read_uint32(const unsigned char *c, const int pt);
+    void write_uint32(unsigned char* buf, uint32_t ui);
+    void write_uint16(unsigned char* buf, uint16_t ui);
+    unsigned int is_core_halted(stlink_t *sl);
+    int write_buffer_to_sram(stlink_t *sl, flash_loader_t* fl, const uint8_t* buf, size_t size);
+    int write_loader_to_sram(stlink_t *sl, stm32_addr_t* addr, size_t* size);
+    int stlink_fread(stlink_t* sl, const char* path, stm32_addr_t addr, size_t size);
+    int run_flash_loader(stlink_t *sl, flash_loader_t* fl, stm32_addr_t target, const uint8_t* buf, size_t size);
+    int stlink_load_device_params(stlink_t *sl);
+
 
 
 #include "stlink-sg.h"